Merge pull request #68 from peopledoc/Fix-unhashable-ModelChoiceIteratorValue-on-django3

Fix how choice value is retrieved on the get_filters() for django3

Author: pleasedontbelong

demoproject/filter/forms.py

@@ -14,7 +14,7 @@ class UserListForm(gf.FilteredForm):
 
     def get_order_by_choices(self):
         return [
-            ("date_joined", _(u"date joined")),
-            ("last_login", _(u"last login")),
-            ("last_name", _(u"Name")),
+            ("date_joined", _("date joined")),
+            ("last_login", _("last login")),
+            ("last_name", _("Name")),
         ]

django_genericfilters/tests/test_templatetags.py

@@ -57,7 +57,7 @@ def test_tag_update_query_string(self):
                     }
                 )
             ),
-            u"/fake?page=2",
+            "/fake?page=2",
         )
 
     def test_is_checkbox(self):

django_genericfilters/tests/test_views.py

@@ -445,6 +445,30 @@ def test_filtered_list_view__modelchoice__none(self):
             str(view.form_valid(view.form).query),
         )
 
+    def test_filtered_list_view__modelchoice_unhashable(self):
+        """
+        On Django3, the ModelChoiceIteratorValue is not hashable
+        causing an error on get_filters() method
+        """
+        peopleA = People.objects.create(name="fakeA")
+
+        view = views.FilteredListView(
+            qs_filter_fields={"city": "city", "people": "parent"},
+            filter_fields=["parent"],
+            form_class=self.Form,
+            model=Something,
+        )
+        data = {"parent": peopleA.pk}
+        setup_view(view, RequestFactory().get("/fake", data))
+        assert view.form.is_valid()
+        filters = view.get_filters()
+        # assert peopleA is selected on the filter choices
+        assert peopleA.pk == next(
+            getattr(f.value, "value", f.value)
+            for f in filters[0].choices
+            if f.is_selected
+        )
+
     def test_filtered_list_view__multiplemodelchoice(self):
         """
         FIXED : filtered fields has HiddenWidget widgets that cannot handle

django_genericfilters/views.py

@@ -205,7 +205,6 @@ def get_filters(self):
         template.
         """
         filters = []
-
         if hasattr(self, "filter_fields"):
             for field in self.filter_fields:
                 new_filter = Munch()
@@ -228,7 +227,8 @@ def get_filters(self):
                             "pk",
                             self.form.cleaned_data[field],
                         )
-                        if value == yesno.get(choice[0], choice[0]):
+                        choice_value = getattr(choice[0], "value", choice[0])
+                        if value == yesno.get(choice_value, choice_value):
                             new_choice.is_selected = True
                             selected = True
                         else:

docs/conf.py

@@ -25,40 +25,44 @@
 
 doc_dir = os.path.dirname(os.path.abspath(__file__))
 project_dir = os.path.dirname(doc_dir)
-version_filename = os.path.join(project_dir, 'VERSION')
+version_filename = os.path.join(project_dir, "VERSION")
 
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
+# sys.path.insert(0, os.path.abspath('.'))
 
 # -- General configuration -----------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+# needs_sphinx = '1.0'
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.autosummary',
-              'sphinx.ext.doctest', 'sphinx.ext.coverage',
-              'sphinx.ext.viewcode']
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.doctest",
+    "sphinx.ext.coverage",
+    "sphinx.ext.viewcode",
+]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix of source filenames.
-source_suffix = '.txt'
+source_suffix = ".txt"
 
 # The encoding of source files.
-#source_encoding = 'utf-8-sig'
+# source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = u'django-generic-filters'
-copyright = u'2013, Novapost'
+project = "django-generic-filters"
+copyright = "2013, Novapost"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -71,176 +75,181 @@
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
-language = 'en'
+language = "en"
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-#today = ''
+# today = ''
 # Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
+# today_fmt = '%B %d, %Y'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['_build']
+exclude_patterns = ["_build"]
 
 # The reST default role (used for this markup: `text`) to use for all documents.
-#default_role = None
+# default_role = None
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
+# add_function_parentheses = True
 
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
-#add_module_names = True
+# add_module_names = True
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
-#show_authors = False
+# show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+# modindex_common_prefix = []
 
 
 # -- Options for HTML output ---------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default'
+html_theme = "default"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-#html_theme_options = {}
+# html_theme_options = {}
 
 # Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
+# html_theme_path = []
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-#html_title = None
+# html_title = None
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
-#html_short_title = None
+# html_short_title = None
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-#html_logo = None
+# html_logo = None
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-#html_favicon = None
+# html_favicon = None
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
+# html_last_updated_fmt = '%b %d, %Y'
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
-#html_use_smartypants = True
+# html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
 html_sidebars = {
-    '**': ['globaltoc.html',
-           'relations.html',
-           'sourcelink.html',
-           'searchbox.html'],
+    "**": ["globaltoc.html", "relations.html", "sourcelink.html", "searchbox.html"],
 }
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
-#html_additional_pages = {}
+# html_additional_pages = {}
 
 # If false, no module index is generated.
-#html_domain_indices = True
+# html_domain_indices = True
 
 # If false, no index is generated.
-#html_use_index = True
+# html_use_index = True
 
 # If true, the index is split into individual pages for each letter.
-#html_split_index = False
+# html_split_index = False
 
 # If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
+# html_show_sourcelink = True
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
+# html_show_sphinx = True
 
 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
+# html_show_copyright = True
 
 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
 # base URL from which the finished HTML is served.
-#html_use_opensearch = ''
+# html_use_opensearch = ''
 
 # This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
+# html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'django-generic-filtersdoc'
+htmlhelp_basename = "django-generic-filtersdoc"
 
 
 # -- Options for LaTeX output --------------------------------------------------
 
 latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
-#'papersize': 'letterpaper',
-
-# The font size ('10pt', '11pt' or '12pt').
-#'pointsize': '10pt',
-
-# Additional stuff for the LaTeX preamble.
-#'preamble': '',
+    # The paper size ('letterpaper' or 'a4paper').
+    #'papersize': 'letterpaper',
+    # The font size ('10pt', '11pt' or '12pt').
+    #'pointsize': '10pt',
+    # Additional stuff for the LaTeX preamble.
+    #'preamble': '',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ('index', 'django-generic-filters.tex', u'django-generic-filters Documentation',
-   u'Novapost', 'manual'),
+    (
+        "index",
+        "django-generic-filters.tex",
+        "django-generic-filters Documentation",
+        "Novapost",
+        "manual",
+    ),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
-#latex_logo = None
+# latex_logo = None
 
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
-#latex_use_parts = False
+# latex_use_parts = False
 
 # If true, show page references after internal links.
-#latex_show_pagerefs = False
+# latex_show_pagerefs = False
 
 # If true, show URL addresses after external links.
-#latex_show_urls = False
+# latex_show_urls = False
 
 # Documents to append as an appendix to all manuals.
-#latex_appendices = []
+# latex_appendices = []
 
 # If false, no module index is generated.
-#latex_domain_indices = True
+# latex_domain_indices = True
 
 
 # -- Options for manual page output --------------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'django-generic-filters', u'django-generic-filters Documentation',
-     [u'Novapost'], 1)
+    (
+        "index",
+        "django-generic-filters",
+        "django-generic-filters Documentation",
+        ["Novapost"],
+        1,
+    )
 ]
 
 # If true, show URL addresses after external links.
-#man_show_urls = False
+# man_show_urls = False
 
 
 # -- Options for Texinfo output ------------------------------------------------
@@ -249,16 +258,22 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('index', 'django-generic-filters', u'django-generic-filters Documentation',
-   u'Novapost', 'django-generic-filters', 'One line description of project.',
-   'Miscellaneous'),
+    (
+        "index",
+        "django-generic-filters",
+        "django-generic-filters Documentation",
+        "Novapost",
+        "django-generic-filters",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]
 
 # Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
+# texinfo_appendices = []
 
 # If false, no module index is generated.
-#texinfo_domain_indices = True
+# texinfo_domain_indices = True
 
 # How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
+# texinfo_show_urls = 'footnote'