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

Fix template file inclusion in Python package #731

Merged
merged 1 commit into from
Mar 27, 2024
Merged

Conversation

cottsay
Copy link
Member

@cottsay cottsay commented Mar 22, 2024

The setuptools documentation states that package_data is used for finer-grained control over the inclusion of package data as an alternative to include_package_data/MANIFEST.in. After correcting the glob patterns in package_data, the latter mechanisms are no longer needed.

Docs: https://setuptools.pypa.io/en/latest/userguide/datafiles.html#configuration-options

Should alleviate warnings like this:

/usr/lib/python3.12/site-packages/setuptools/command/build_py.py:201: _Warning: Package 'bloom.generators.rpm.templates.cmake' is absent from the `packages` configuration.
!!

        ********************************************************************************
        ############################
        # Package would be ignored #
        ############################
        Python recognizes 'bloom.generators.rpm.templates.cmake' as an importable package[^1],
        but it is absent from setuptools' `packages` configuration.

        This leads to an ambiguous overall configuration. If you want to distribute this
        package, please make sure that 'bloom.generators.rpm.templates.cmake' is explicitly added
        to the `packages` configuration field.

        Alternatively, you can also rely on setuptools' discovery methods
        (for example by using `find_namespace_packages(...)`/`find_namespace:`
        instead of `find_packages(...)`/`find:`).

        You can read more about "package discovery" on setuptools documentation page:

        - https://setuptools.pypa.io/en/latest/userguide/package_discovery.html

        If you don't want 'bloom.generators.rpm.templates.cmake' to be distributed and are
        already explicitly excluding 'bloom.generators.rpm.templates.cmake' via
        `find_namespace_packages(...)/find_namespace` or `find_packages(...)/find`,
        you can try to use `exclude_package_data`, or `include-package-data=False` in
        combination with a more fine grained `package-data` configuration.

        You can read more about "package data files" on setuptools documentation page:

        - https://setuptools.pypa.io/en/latest/userguide/datafiles.html


        [^1]: For Python, any directory (with suitable naming) can be imported,
              even if it does not contain any `.py` files.
              On the other hand, currently there is no concept of package data
              directory, all directories are treated like packages.
        ********************************************************************************

!!

The setuptools documentation states that `package_data` is used for
finer-grained control over the inclusion of package data as an
alternative to `include_package_data`/`MANIFEST.in`. After correcting
the glob patterns in `package_data`, the latter mechanisms are no longer
needed.
@cottsay cottsay self-assigned this Mar 22, 2024
@cottsay cottsay added the bug label Mar 22, 2024
Copy link
Contributor

@nuclearsandwich nuclearsandwich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! Thanks for the cleanup!

@cottsay cottsay merged commit 311c635 into master Mar 27, 2024
15 checks passed
@cottsay cottsay deleted the cottsay/package-data branch March 27, 2024 16:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants