Support Django 5.0 #438

adamchainz · 2023-10-13T22:19:25Z

Builds on #424, which should be merged first. Add support for Django 5.0.

adamchainz · 2023-10-13T22:23:31Z

Currently there are three test failures:

FAILED django_countries/tests/test_admin_filters.py::TestCountryFilter::test_choices - AssertionError: False != True
FAILED django_countries/tests/test_fields.py::TestModelForm::test_translated_choices - AssertionError: 'Afghanistan' != 'Afganio'
FAILED django_countries/tests/test_widgets.py::TestCountrySelectWidget::test_render - AssertionError: 0 != 1 : Found 0 instances of '<option value="AU">

The latter two cases are caused by Django’s changes to handling choices. It seems that part of this change means that Django iterates over the Countries class at field initialization, rather than lazily when required. This means that the translations are done once rather than on-demand.

One option is to instead use a no-argument callable, which will always be called later. I tried adding __call__ to Countries but that didn’t work, I suspect a wrapping function will be required.

adamchainz · 2023-10-14T10:39:51Z

I think we can stop using LazyTypedChoiceField / LazyTypedMultipleChoiceField and all related classes on Django 5.0, since a callable for choices is treated lazily by Django. But unfortunately there’s a bug with that laziness, which I’ve reported upstream: https://code.djangoproject.com/ticket/34899 .

adamchainz · 2023-11-08T14:08:33Z

The fix ( django/django#17370 ) was merged and released in Django 5.0b1. I have updated the code to use the new callable choices support and made the Lazy* classes no-ops on Django 5.0+.

I also added a fix for the admin change:

The django.contrib.admin.AllValuesFieldListFilter, ChoicesFieldListFilter, RelatedFieldListFilter, and RelatedOnlyFieldListFilter admin filters now handle multi-valued query parameters.

Everything is passing now.

tox.ini

django_countries/fields.py

washeck · 2023-11-28T10:50:55Z

@SmileyChris can this please be merged and released? It is blocking upgrade to Django 5.0 (I am testing RC1 now). Thank you.

adamchainz · 2023-11-28T10:54:57Z

You can install my commit from the Git repo with this specification for Pip:

django-countries @ git+https://github.com/SmileyChris/django-countries@58f258402072a18756a15daa81325428382bd946

(or with the appropriate syntax for Poetry etc.)

That’s what I’ve done for testing my client’s project on Django 5.0 RC1.

washeck · 2023-11-28T10:59:50Z

Yes, that's what I'm doing (django_5.0 branch from your fork) and it's working so I think it would be good to issue the release before Django 5.0 is released and people start upgrading. Thanks you for the PR.

claudep · 2023-12-12T14:36:36Z

tox.ini

@@ -36,10 +36,10 @@ deps =
    pyuca,legacy: pyuca
    legacy: Django==3.2.*
    previous: Django==4.0.*
-    latest: Django==4.1.*
+    latest: Django~=5.0b1


I guess this could be updated. Then @SmileyChris, please push this or give someone the commit bit so the project is not blocked when you are out of time!

kribot · 2023-12-16T06:30:05Z

I did install from pip using the above command, but I still have the below issue in django 5. Am I missing something ? @adamchainz would you have any idea ? It seems we are quite a few to have this issue.

\django_countries\fields.py", line 22, in <module>
    _entry_points = importlib.metadata.entry_points().get(
                    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
AttributeError: 'EntryPoints' object has no attribute 'get'

foutrelis · 2023-12-20T12:26:09Z

django_countries/filters.py

@@ -22,8 +23,12 @@ def choices(self, changelist):
            "display": _("All"),
        }
        for lookup, title in self.lookup_choices(changelist):
+            if django.VERSION >= (5, 0):
+                selected = force_str(lookup) in value


I had to change this line so it works when no country is selected in the CountryFilter list_filter I'm using, otherwise it'll throw a TypeError exception that argument of type 'NoneType' is not iterable

Suggested change

selected = force_str(lookup) in value

selected = value and force_str(lookup) in value

@adamchainz any objection to this?

zyv · 2023-12-25T17:21:32Z

Any new on when this is going to be released? Django 5 it out for a while and after I tried to upgrade, my admin pages got broken. Here is a corresponding Django ticket:

https://code.djangoproject.com/ticket/35046

KlemenS189 · 2024-01-08T11:37:21Z

Any chance this could be released? It's blocking our upgrade to Django 5.0.
Thanks.

JulianTenschert · 2024-01-08T18:05:34Z

I did install from pip using the above command, but I still have the below issue in django 5. Am I missing something ? @adamchainz would you have any idea ? It seems we are quite a few to have this issue.
\django_countries\fields.py", line 22, in <module>
    _entry_points = importlib.metadata.entry_points().get(
                    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
AttributeError: 'EntryPoints' object has no attribute 'get'

It looks like @adamchainz' code works with Python < 3.10 perfectly. However, the code doesn't work with Python 3.12.

If I understand correctly, the importlib.metadata API has been changed since Python 3.10.

Other projects had the same issue, e.g. ewels/rich-click#140.

I've modified Adam's code to make it work with Python 3.10 and above: JulianTenschert@f085ab1. This works well.

andriijas · 2024-03-13T10:17:59Z

@SmileyChris Whats needed to move forward with this?
How can we help?

Thanks

co-authored-by: Julian Tenschert <[email protected]>

adamchainz · 2024-03-16T22:04:58Z

I just squashed @JulianTenschert ’s commit into mine to make merging or installing from git easier.

claudep · 2024-03-23T13:01:33Z

Thanks for your efforts, however I think the current situation is not sustainable in the longer term. If anyone has direct contacts with Chris personally or someone else at Lincoln Loop, it would be very nice to push a bit so as to unblock this package and put it in a co-maintainership situation (by Jazzband adoption or any other mean).

MarcoGlauser · 2024-03-25T05:15:25Z

Hey everyone,
I managed to get in contact with SmileyChris and he gave me contributor access to the repo. I'm currently trying to familiarize myself with the state of the project.
@adamchainz Thank you for creating this PR and keeping it alive. What is the current state of the PR?
Does it still rely on the Django 4.2 PR or have they been combined in the meantime?
Does it also address the python 3.12 fixes?

From my side, this PR takes priority and after I will look into updating the test matrix to test all currently supported django and python combination instead of only the latest.

adamchainz · 2024-03-25T06:26:37Z

I did not combine the Django 4.2 PR into this one, but I did merge in the Python 3.12 fix. Thank you for taking over the project!

SmileyChris · 2024-03-27T03:28:22Z

Sorry I've been so absent! I finally got things polished up -- I had to fix transifex not pulling in changes due to their api changes, and some tox updates for 4 but it's done, and I pushed 7.6!

foutrelis · 2024-04-01T11:17:46Z

One small follow-up fix is needed: #460

Without this check even a trivial use of CountryFilter will raise an exception:

  File "/usr/local/lib/python3.12/site-packages/django_countries/filters.py", line 27, in choices
    selected = force_str(lookup) in value
               ^^^^^^^^^^^^^^^^^^^^^^^^^^

Exception Type: TypeError at /admin/country_test/person/
Exception Value: argument of type 'NoneType' is not iterable

Test on Django 4.2

50ac1b1

adamchainz force-pushed the django_5.0 branch from d60d8f1 to 85dd434 Compare November 8, 2023 14:07

adamchainz force-pushed the django_5.0 branch 3 times, most recently from 91efae7 to b01ed85 Compare November 8, 2023 14:24

adamchainz commented Nov 8, 2023

View reviewed changes

tox.ini Show resolved Hide resolved

django_countries/fields.py Show resolved Hide resolved

adamchainz force-pushed the django_5.0 branch from b01ed85 to 58f2584 Compare November 9, 2023 15:10

nijel mentioned this pull request Dec 8, 2023

chore(deps): update dependency django to v5 WeblateOrg/website#1720

Merged

1 task

washeck mentioned this pull request Dec 11, 2023

Django 5.0 breakage #447

Closed

claudep reviewed Dec 12, 2023

View reviewed changes

foutrelis reviewed Dec 20, 2023

View reviewed changes

zyv mentioned this pull request Dec 25, 2023

Update widgets.py to support Django 5.0 #450

Closed

zyv added a commit to zyv/pilot_log that referenced this pull request Dec 25, 2023

django(conf): add workaround for SmileyChris/django-countries#438

4fae259

adamchainz mentioned this pull request Jan 24, 2024

Test on Django 4.2 #424

Merged

Support Django 5.0

04662d1

co-authored-by: Julian Tenschert <[email protected]>

adamchainz force-pushed the django_5.0 branch from 58f2584 to 04662d1 Compare March 16, 2024 22:04

SmileyChris merged commit 4d3d7b5 into SmileyChris:main Mar 27, 2024
4 checks passed

adamchainz deleted the django_5.0 branch June 29, 2024 20:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support Django 5.0 #438

Support Django 5.0 #438

adamchainz commented Oct 13, 2023

adamchainz commented Oct 13, 2023

adamchainz commented Oct 14, 2023

adamchainz commented Nov 8, 2023

washeck commented Nov 28, 2023

adamchainz commented Nov 28, 2023

washeck commented Nov 28, 2023

claudep Dec 12, 2023

kribot commented Dec 16, 2023 •

edited

Loading

foutrelis Dec 20, 2023

MarcoGlauser Mar 25, 2024 •

edited

Loading

zyv commented Dec 25, 2023

KlemenS189 commented Jan 8, 2024

JulianTenschert commented Jan 8, 2024 •

edited

Loading

andriijas commented Mar 13, 2024

adamchainz commented Mar 16, 2024

claudep commented Mar 23, 2024

MarcoGlauser commented Mar 25, 2024 •

edited

Loading

adamchainz commented Mar 25, 2024 •

edited

Loading

SmileyChris commented Mar 27, 2024

foutrelis commented Apr 1, 2024

	selected = force_str(lookup) in value
	selected = value and force_str(lookup) in value

Support Django 5.0 #438

Support Django 5.0 #438

Conversation

adamchainz commented Oct 13, 2023

adamchainz commented Oct 13, 2023

adamchainz commented Oct 14, 2023

adamchainz commented Nov 8, 2023

washeck commented Nov 28, 2023

adamchainz commented Nov 28, 2023

washeck commented Nov 28, 2023

claudep Dec 12, 2023

Choose a reason for hiding this comment

kribot commented Dec 16, 2023 • edited Loading

foutrelis Dec 20, 2023

Choose a reason for hiding this comment

MarcoGlauser Mar 25, 2024 • edited Loading

Choose a reason for hiding this comment

zyv commented Dec 25, 2023

KlemenS189 commented Jan 8, 2024

JulianTenschert commented Jan 8, 2024 • edited Loading

andriijas commented Mar 13, 2024

adamchainz commented Mar 16, 2024

claudep commented Mar 23, 2024

MarcoGlauser commented Mar 25, 2024 • edited Loading

adamchainz commented Mar 25, 2024 • edited Loading

SmileyChris commented Mar 27, 2024

foutrelis commented Apr 1, 2024

kribot commented Dec 16, 2023 •

edited

Loading

MarcoGlauser Mar 25, 2024 •

edited

Loading

JulianTenschert commented Jan 8, 2024 •

edited

Loading

MarcoGlauser commented Mar 25, 2024 •

edited

Loading

adamchainz commented Mar 25, 2024 •

edited

Loading