Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support Python 3.12 #873

Closed
wants to merge 6 commits into from
Closed

Conversation

max-muoto
Copy link

@max-muoto max-muoto commented Nov 4, 2023

pkg_resources is no longer accessible by default in Python 3.12, which means this library is incompatible with Python 3.12. This PR moves from using pkg_resources to importlib.metadata which is the intended way of replacing the metadata API of pgk_resources. See here.

Since pkg_resources is only included in Python 3.8+, this PR also drops support for early versions of Python. If support for these older versions is something that we want to keep, I'm happy to go and add in conditional logic to use a backport for older versions to maintain compatibility, but as 3.7 is now in end-of-life I assumed we might want to drop support now.

Fixes #874.

Joel Lefkowitz and others added 2 commits July 20, 2023 15:29
* Add sample code to handle Base64 fields in drf-extra-fields project

* Fix format for .rst

* Update answer to the easier version as suggested in Hipo/drf-extra-fields#66 (comment)

* update readme.rst

`permission_classes` expects tuple but list was provided

* url from DEFAULT_API_URL now works

fix a bug: url from swagger_settings.DEFAULT_API_URL is not working

* Check for allow_null attribute

* Add utf-8 support for generated formats

* Added `many` support to example code.

* serialize pytz object as a string

* simplify if condition

* handle errors rendering with TemplateHTMLRenderer

This change fixes an `OPTIONS` request to the API page which will return
a successful response, but the `TemplateHTMLRender` will not be prepared
to render it since there is no template name provided in either the view
or response [1].

[1]: https://github.com/encode/django-rest-framework/blob/f0a5b958a134e8cd94e3ef3263e8fa623ac9b82f/rest_framework/renderers.py#L178-L189

* Allow specifying response as a reference

* [readme] Fix missing re_path import

* fix map source mapping

* Remove universal wheel, python 2 is unsupported

* Inline allow_unicode parameter

* Update changelog

* Update changelog typos

* Add cspell

* Fix old spelling errors

* Add ref_name to UserSerializer after removing suffix typo

* Set permission classes to a tuple

* Update chagnelog

* Add prepublish twine check

* Fix action version syntax

* Fix indentation in README.rst code blocks

* Add twine to publish dependencies

* Specify toxenv explicitly

* Specify all tox targets

* Add py prefix to toxenvs

* Update changelog

* Update changelog

* Declare Django 3.2 support in README, classifiers

This commit will make sure that `Django :: 3.2` will show up in the
classifiers list on PyPI: https://pypi.org/project/drf-yasg/

(The magic happens because we parse the README to get supported Django):
https://github.com/DavidCain/drf-yasg/blob/ee29412d3cdb311/setup.py#L36

3.2 support should already exist
================================
A closed pull request, axnsan12#735,
noted support for Django 3.2 in both `tox.ini`, and the README.

That PR was closed in favor of
axnsan12#741, which edited `tox.ini`
and switched to GitHub Actions.

axnsan12#735 (comment)

This project has been testing on Django 3.2 for a long time (about a
year). I think we can declare it supported it the README!

* Fix `pip install` command for contributors on zsh

On `zsh` (a popular shell, and the default for macOS), install fails:

    $ pip install -U -e .[validation]
    zsh: no matches found: .[validation]

Quote the arguments so that `bash` or `zsh` will succeed.

* Dont use NullBooleanField if drf version >= 3.14.0

* Swap back BooleanField and NullBooleanField

* Update changelog

* Update README to use path instead of re_path in example

* Run tests with latest dependencies

- Django 4.0 & 4.1
- DRF 3.13 & 3.14
- Python 3.10

* Add python 3.10 in GH actions matrix

* Fix RecursiveField

* Change github actions runner from ubuntu-latest to ubuntu-20.04

* Change github actions runner from ubuntu-latest to ubuntu-20.04

* Remove python 3.6 tests since swagger-spec-validator no longer supports it

* Use a string literal for python versions such as "3.10"

* Add python 3.10 compatibility to README.md

* Update changelog

* Fix: Provide enums support for schema.

* Fix: Tests for Python 3.11.

* Refactoring: Removed old version code.

* Fix: Linting is now working.

* Fix: Provide usage of Enums as dict keys.

* Fix: Docs build with latest sphinx versions.

* keep path parameters in their given order

* Fix: Action build docs with latest tox version.

* Fix: Update python version for dj-master branch.

Django master branch bumped minimal python version
to Python 3.10. In latest version was added check for uniq basename.

* Feature: Migrate to PyYAML for yaml generator. (axnsan12#845)

* Feature: Migrate to PyYAML for yaml generator.

Closes axnsan12#833

* Chore: Update swagger ui and redoc dependencies.

* Fix: Remove required coreapi dependency. (axnsan12#854)

* Feature: Migrate to PyYAML for yaml generator.

Closes axnsan12#833

* Chore: Update swagger ui and redoc dependencies.

* Fix: Remove required coreapi dependency.

* Update Changelog

* Feature: Add ``drf_yasg.inspectors.query.DrfAPICompatInspector``. (axnsan12#857)

* Feature: Provide to override default renderers via settings.

* Feature: Enable tests for django 4.2.

* Docs: Add information how to override ``DEFAULT_SPEC_RENDERERS``.

* Feature: Add ``drf_yasg.inspectors.query.DrfAPICompatInspector``.

This inspector should be main and replace ``CoreAPICompatInspector`` in the future.

* [fix] Fixed map source mapping (axnsan12#859)

* Tests: Improve test coverage 95.91% -> 98.30%. (axnsan12#862)

* Update Changelog

* Add python3.6 to the actions matrix but exclude it from tests

---------

Co-authored-by: Terry <[email protected]>
Co-authored-by: Sumit Singh <[email protected]>
Co-authored-by: Core-Chan <[email protected]>
Co-authored-by: Krista Mae Rectra <[email protected]>
Co-authored-by: mmurashov <[email protected]>
Co-authored-by: Christoph Beckmann <[email protected]>
Co-authored-by: MilanPecov <[email protected]>
Co-authored-by: Terence D. Honles <[email protected]>
Co-authored-by: Cristi Vîjdea <[email protected]>
Co-authored-by: Max Vorobev <[email protected]>
Co-authored-by: Damien Ramelet <[email protected]>
Co-authored-by: Petr Dlouhý <[email protected]>
Co-authored-by: gopackgo90 <[email protected]>
Co-authored-by: David Cain <[email protected]>
Co-authored-by: Amir Andohkosh <[email protected]>
Co-authored-by: Nikolaos Michas <[email protected]>
Co-authored-by: Ignacio Orlandini <[email protected]>
Co-authored-by: Sergey Klyuykov <[email protected]>
Co-authored-by: Gagan Deep <[email protected]>
@max-muoto max-muoto force-pushed the support-python-3.12 branch from 4b39694 to 6457dc2 Compare November 4, 2023 23:44
@max-muoto max-muoto marked this pull request as ready for review November 4, 2023 23:44
@max-muoto
Copy link
Author

@JoelLefkowitz Not sure who the best person to ping on this is, but would love to hear thoughts on this.

@JoelLefkowitz
Copy link
Collaborator

@max-muoto thanks for the PR I've approved the unit test run and I'll have a look at the changes

@max-muoto
Copy link
Author

max-muoto commented Nov 5, 2023 via email

@JoelLefkowitz
Copy link
Collaborator

@max-muoto Id like to keep the support for python 3.6 and 3.7 since a lot of our users are tied to those versions and compatibility is a priority. Could you add them back? Looks like the tox command is failing for python 3.12, could you try running it locally and see why? Thank you!

@max-muoto
Copy link
Author

@max-muoto Id like to keep the support for python 3.6 and 3.7 since a lot of our users are tied to those versions and compatibility is a priority. Could you add them back? Looks like the tox command is failing for python 3.12, could you try running it locally and see why? Thank you!

Sounds good, I'll make sure we keep support there. Let me give it a try locally!

@max-muoto
Copy link
Author

@JoelLefkowitz 3.12 failures seem to be coming from usage of https://github.com/Yelp/swagger_spec_validator which appears to be unmaintained. Any ideas on potential workarounds here? Not sure how deep drf-yasg relies on this library.

@max-muoto
Copy link
Author

They have the same issue around pgk_resources usage.

@JoelLefkowitz
Copy link
Collaborator

@max-muoto It says here setuptools isn't available by default anymore python/cpython#95299. I've added it to the dependencies list and the python3.12 tests are now passing. I'm going to update the PR target to the release branch. Looks like flake8 is failing in the python 3.8 runs, could you take a look please?
Thank you

@Morette
Copy link

Morette commented Aug 1, 2024

can someone get back to this?
I just raised this bug that this PR apparently fix

#888

@max-muoto
Copy link
Author

Closing this PR since I was able to find a workaround here, but if someone else has the time to take to get this out that would be great! Apologies here.

@max-muoto max-muoto closed this Sep 7, 2024
@cclauss
Copy link
Contributor

cclauss commented Oct 16, 2024

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Python 3.12 Support
4 participants