[tools] Simplify static file handling in report-converter #4423
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
…3.12 The report-converter package shows setuptools warnings during build about missing packages when using Python 3.12. This is due to stricter package discovery checks introduced in setuptools 61.0.0 [1], which now warns about directories that could be packages but aren't explicitly configured. While we could address this with explicit package_data configuration, the package already has a correct MANIFEST.in file that handles static file inclusion. This change: - Removes redundant package_data configuration from setup.py - Relies on the existing MANIFEST.in pattern for static files - Uses find_namespace_packages() to properly handle package structure - Keeps include_package_data=True to ensure MANIFEST.in is respected This approach is more maintainable as: 1. All static file patterns are managed in one place (MANIFEST.in) 2. New static files are automatically included if they follow the existing directory structure 3. setuptools will warn us if files specified in MANIFEST.in are missing The change makes the package compatible with Python 3.12's stricter package discovery while maintaining a clean and maintainable solution for static file handling. [1] https://setuptools.pypa.io/en/latest/history.html#v61-0-0 [2] https://setuptools.pypa.io/en/latest/userguide/package_discovery.html
bruntib
approved these changes
Jan 13, 2025
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.
The report-converter package shows setuptools warnings during build about missing packages when using Python 3.12. This is due to stricter package discovery checks introduced in setuptools 61.0.0 [1], which now warns about directories that could be packages but aren't explicitly configured.
While we could address this with explicit package_data configuration, the package already has a correct MANIFEST.in file that handles static file inclusion.
This change:
This approach is more maintainable as:
The change makes the package compatible with Python 3.12's stricter package discovery while maintaining a clean and maintainable solution for static file handling.
I assume this is the intention: to include these static files in the package; please verify!
Fixes #4422
[1] https://setuptools.pypa.io/en/latest/history.html#v61-0-0
[2] https://setuptools.pypa.io/en/latest/userguide/package_discovery.html