Refactor collect_package_data to make logic clearer #120
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
This is a preliminary refactoring for fixing python/typeshed#11254. The idea is that the new class `PackageData` encapsulates all data concerning packages and their contents. This allows us later to find the top-level non-namespace packages, instead of just the top-level packages as we are doing now.
Avasam
reviewed
Jan 11, 2024
Comment on lines
+233
to
+242
| elif entry.is_file() and entry.suffix == ".pyi": | ||
| pkg_name = entry.stem | ||
| # Module -> package transformation is done while copying. | ||
| package_data[pkg_name] = ["__init__.pyi"] | ||
| stub_files = ["__init__.pyi"] | ||
| elif entry.is_dir(): | ||
| pkg_name = entry.name | ||
| stub_files = find_stub_files(str(entry)) | ||
| else: | ||
| if entry.name == TESTS_NAMESPACE: | ||
| continue | ||
| pkg_name = entry.name + SUFFIX | ||
| package_data[pkg_name] = find_stub_files(str(entry)) | ||
| package_data[pkg_name].append(META) | ||
| raise ValueError(f"Only stub files are allowed, not {entry.name!r}") | ||
| package_data[pkg_name + SUFFIX] = [*stub_files, META] |
There was a problem hiding this comment.
Maybe you won't wanna do that now, but since you're touching this area of code I'll mention it:
With #112 (setuptools v69) , the stub_files logic could become unnecessary.
According to https://setuptools.pypa.io/en/stable/userguide/miscellaneous.html#controlling-files-in-the-distribution this is an opt-out feature, so you shouldn't need to add anything new either.
There was a problem hiding this comment.
Let's punt this to a separate PR to keep this as a simple refactoring.
Avasam
approved these changes
Jan 29, 2024
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.
Depends on #119