migrate packaging to pyproject.toml #9056
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
deronnax
force-pushed
the
migrate_setuppy_to_pryoject.toml
branch
from
6344069 to
42d468b
Compare
|
OK, it's almost ready except:
|
deronnax
force-pushed
the
migrate_setuppy_to_pryoject.toml
branch
from
8c65e6d to
6e67258
Compare
This is unrelated to your PR and I fixed it with #9129 |
deronnax
force-pushed
the
migrate_setuppy_to_pryoject.toml
branch
from
6e67258 to
b16826c
Compare
|
Wow. It works indeed. Thank you so much. |
auvipy
requested changes
Oct 6, 2023
|
Sure. A vague estimation of when it would become envisageable ? |
deronnax
changed the title
|
To merge after #9210, I hope. |
Viicos
reviewed
Feb 27, 2024
it was automatically migrated but flake8 doesn't support the pyproject.toml format
zip-safe is deprecated and doesn't do anything. exclude 'tests*' is already the default behaviour
deronnax
force-pushed
the
migrate_setuppy_to_pryoject.toml
branch
from
12a5a0b to
cf25dcd
Compare
|
watch-out: this PR is intended to be squash-merged |
|
So... this is a good example of a nice little pr that's a bit stalled. I don't really have any extra bandwidth to keep this moving, given existing commitments. Should we be having a discussion about getting the project into jazzband.co so that we've got a lower barrier of entry for new maintainers? |
|
Hey, that's a very interesting decision that is (way) beyond the scope of my humble little PR. Maybe let's open a dedicated issue ou GitHub discussion? |
deronnax
force-pushed
the
migrate_setuppy_to_pryoject.toml
branch
from
05958fb to
c8030fc
Compare
Viicos
reviewed
Oct 16, 2024
|
@tomchristie that's ready to merge (let's not forget to squash merge). |
auvipy
requested changes
Oct 17, 2024
deronnax
force-pushed
the
migrate_setuppy_to_pryoject.toml
branch
from
2dfb5ed to
1278968
Compare
|
@deronnax Id be happy to see a release, tho someone else would need to take the lead on it. |
auvipy
reviewed
Nov 17, 2024
pyproject.toml
Outdated
Comment on lines
53
to
54
| [tool.setuptools.packages.find] | ||
| namespaces = false |
There was a problem hiding this comment.
Is there a reason you're disabling namespaces? I believe you can also just specify the packages directly since there is only one:
Suggested change
| [tool.setuptools.packages.find] | |
| namespaces = false | |
| packages = ["rest_framework"] |
There was a problem hiding this comment.
I disabled them because they were disabled originally, using find_packages in the setup.py instead of find_namespace_packages. I tried your suggestion but it broke the CI, so I reverted it.
There was a problem hiding this comment.
I see, thanks for trying. It appears I misunderstood the default behavior for nested packages.
You'd need to try the following:
Suggested change
| [tool.setuptools.packages.find] | |
| namespaces = false | |
| [tool.setuptools.packages.find] | |
| include = ["rest_framework*"] |
I used the build module to build a wheel and with my original suggestion it was warning that the sub-packages were not being included, but with the include statement it worked as intended and bundled the sub-packages.
Do you mind running that by the CI?
There was a problem hiding this comment.
sure. But as it is changing the behavior, even if it works, I would like it in a separate PR :)
There was a problem hiding this comment.
Well what you used doesn't match the original either, since you're missing the exclude so I'd just switch to the new style using include and you can leave off the namespace disabling or turn it off if you really prefer it to be off. I just don't think it needs to be off.
thanks to @terencehonles Co-authored-by: Terence Honles <[email protected]>
Co-authored-by: Terence Honles <[email protected]>
This reverts commit ea10c54.
|
@auvipy can you give a deadline at which you would have done this study? I think (and some other) that's it's pretty important PR and it should not get spiraled into oblivion. |
Co-authored-by: Terence Honles <[email protected]>
pyproject.toml
Outdated
Comment on lines
53
to
54
| [tool.setuptools.packages.find] | ||
| namespaces = false |
There was a problem hiding this comment.
Well what you used doesn't match the original either, since you're missing the exclude so I'd just switch to the new style using include and you can leave off the namespace disabling or turn it off if you really prefer it to be off. I just don't think it needs to be off.
|
So I followed the steps in the --- dist-content-before.txt 2025-01-20 19:49:07
+++ dist-content-after.txt 2025-01-20 19:49:52
@@ -8,9 +8,9 @@
djangorestframework-3.15.2/djangorestframework.egg-info/PKG-INFO
djangorestframework-3.15.2/djangorestframework.egg-info/SOURCES.txt
djangorestframework-3.15.2/djangorestframework.egg-info/dependency_links.txt
-djangorestframework-3.15.2/djangorestframework.egg-info/not-zip-safe
djangorestframework-3.15.2/djangorestframework.egg-info/requires.txt
djangorestframework-3.15.2/djangorestframework.egg-info/top_level.txt
+djangorestframework-3.15.2/pyproject.toml
djangorestframework-3.15.2/rest_framework/
djangorestframework-3.15.2/rest_framework/__init__.py
djangorestframework-3.15.2/rest_framework/apps.py
\ No newline at end of file
@@ -519,10 +519,10 @@
3553 10-14-2024 17:56 rest_framework/response.py
2144 03-18-2024 22:59 rest_framework/reverse.py
13923 10-14-2024 17:56 rest_framework/routers.py
- 67302 01-20-2025 19:45 rest_framework/serializers.py
+ 67224 01-20-2025 19:32 rest_framework/serializers.py
7950 10-14-2024 17:56 rest_framework/settings.py
2547 03-18-2024 22:59 rest_framework/status.py
- 14823 01-20-2025 19:45 rest_framework/test.py
+ 14688 01-20-2025 19:32 rest_framework/test.py
8067 03-18-2024 22:59 rest_framework/throttling.py
4401 10-14-2024 17:56 rest_framework/urlpatterns.py
615 03-18-2024 22:59 rest_framework/urls.py
\ No newline at end of file
@@ -733,10 +733,10 @@
5867 10-14-2024 17:56 rest_framework/utils/serializer_helpers.py
1086 10-14-2024 17:56 rest_framework/utils/timezone.py
1052 03-18-2024 22:59 rest_framework/utils/urls.py
- 1537 01-20-2025 19:46 djangorestframework-3.15.2.dist-info/LICENSE.md
- 11118 01-20-2025 19:46 djangorestframework-3.15.2.dist-info/METADATA
- 91 01-20-2025 19:46 djangorestframework-3.15.2.dist-info/WHEEL
- 15 01-20-2025 19:46 djangorestframework-3.15.2.dist-info/top_level.txt
- 25567 01-20-2025 19:46 djangorestframework-3.15.2.dist-info/RECORD
+ 1537 01-20-2025 19:38 djangorestframework-3.15.2.dist-info/LICENSE.md
+ 10889 01-20-2025 19:38 djangorestframework-3.15.2.dist-info/METADATA
+ 91 01-20-2025 19:38 djangorestframework-3.15.2.dist-info/WHEEL
+ 15 01-20-2025 19:38 djangorestframework-3.15.2.dist-info/top_level.txt
+ 25567 01-20-2025 19:38 djangorestframework-3.15.2.dist-info/RECORD
--------- -------
- 3180103 242 files
\ No newline at end of file
+ 3179661 242 files
\ No newline at end of fileFrom what I can tell the differences are down to:
Here is a diff of the METADATA file (I've replaced Tom's email by --- dist/master/djangorestframework-3.15.2.dist-info/METADATA 2025-01-20 19:46:50
+++ dist/pyproject-toml/djangorestframework-3.15.2.dist-info/METADATA 2025-01-20 20:02:22
@@ -2,10 +2,9 @@
Name: djangorestframework
Version: 3.15.2
Summary: Web APIs for Django, made easy.
-Home-page: https://www.django-rest-framework.org/
-Author: Tom
-Author-email: [redacted]
+Author-email: Tom <[redacted]>
License: BSD
+Project-URL: Homepage, https://www.django-rest-framework.org/
Project-URL: Funding, https://fund.django-rest-framework.org/topics/funding/
Project-URL: Source, https://github.com/encode/django-rest-framework
Project-URL: Changelog, https://www.django-rest-framework.org/community/release-notes/
@@ -33,17 +32,6 @@
License-File: LICENSE.md
Requires-Dist: django>=4.2
Requires-Dist: backports.zoneinfo; python_version < "3.9"
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: license
-Dynamic: project-url
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
# [Django REST framework][docs]Overall, looks good to me, but would be nice to for someone to sense check my findings. If we really want to be exhaustive in testing this, we could push a release to Test PyPI. Before
After
|
|
@auvipy did you have time to take a closer look? Is my previous message helpful to review what's going on and what's changed? |
|
We can defer this until 3.16 release |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Just an initiative of my own.
Don't forget to squash merge the PR.