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

data subfolder not part of package manifest? #99

Open
kdeldycke opened this issue Jul 30, 2024 · 1 comment
Open

data subfolder not part of package manifest? #99

kdeldycke opened this issue Jul 30, 2024 · 1 comment

Comments

@kdeldycke
Copy link

I am trying to make a standalone executable of my Meta Package Manager project, which depends on cyclonedx-python-lib for SBOM export, itself depending on license-expression.

For this I use Nuitka which worked well up until I introduced a dependency on license-expression.

Nuitka complains of missing data/scancode-licensedb-index.json file. I reported this issue upstream and proposed a fix so that Nuitka can automatically embed the missing file: Nuitka/Nuitka#3033

That being said, Nuitka is generally capable of guessing which data file to include, if the Python module has been properly built and declared in package metadata. Which probably means the data subfolder has not been part of the manifest.

@stefan6419846
Copy link

python -m build . correctly bundles the data directory inside the wheel, thus it seems to be specific to your build process or to Nuitka. Nevertheless, calling the mentioned command does indeed issue a warning:

/tmp/build-env-0qs1n52v/lib/python3.10/site-packages/setuptools/command/build_py.py:218: _Warning: Package 'license_expression.data' is absent from the `packages` configuration.
!!

        ********************************************************************************
        ############################
        # Package would be ignored #
        ############################
        Python recognizes 'license_expression.data' 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 'license_expression.data' 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 'license_expression.data' to be distributed and are
        already explicitly excluding 'license_expression.data' 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.
        ********************************************************************************

!!
  check.warn(importable)

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

No branches or pull requests

2 participants