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.

Sign up for GitHub

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

Jump to bottom

3.4.5: build warnings #190

Closed
kloczek opened this issue Jan 22, 2024 · 1 comment · May be fixed by #191
Closed

3.4.5: build warnings #190

kloczek opened this issue Jan 22, 2024 · 1 comment · May be fixed by #191
Labels
bug

Comments

@kloczek
Copy link
Contributor

kloczek commented Jan 22, 2024

Describe the bug

Looks like build shows some warnings.

Here is build output: 
+ /usr/bin/python3 -sBm build -w --no-isolation
* Getting build dependencies for wheel...
running egg_info
creating sphinx_tabs.egg-info
writing sphinx_tabs.egg-info/PKG-INFO
writing dependency_links to sphinx_tabs.egg-info/dependency_links.txt
writing requirements to sphinx_tabs.egg-info/requires.txt
writing top-level names to sphinx_tabs.egg-info/top_level.txt
writing manifest file 'sphinx_tabs.egg-info/SOURCES.txt'
reading manifest file 'sphinx_tabs.egg-info/SOURCES.txt'
reading manifest template 'MANIFEST.in'
warning: no previously-included files found matching 'docs'
warning: no previously-included files matching '*' found under directory 'docs'
warning: no previously-included files found matching 'tests'
warning: no previously-included files found matching 'images'
warning: no previously-included files matching '*' found under directory 'images'
warning: no previously-included files found matching '.pre-commit-config.yaml'
warning: no previously-included files found matching '.readthedocs.yml'
warning: no previously-included files found matching 'pylint.cfg'
warning: no previously-included files found matching 'tox.ini'
warning: no previously-included files found matching 'codecov.yml'
adding license file 'LICENSE'
writing manifest file 'sphinx_tabs.egg-info/SOURCES.txt'
* Building wheel...
running bdist_wheel
running build
running build_py
creating build
creating build/lib
creating build/lib/sphinx_tabs
copying sphinx_tabs/__init__.py -> build/lib/sphinx_tabs
copying sphinx_tabs/tabs.py -> build/lib/sphinx_tabs
running egg_info
writing sphinx_tabs.egg-info/PKG-INFO
writing dependency_links to sphinx_tabs.egg-info/dependency_links.txt
writing requirements to sphinx_tabs.egg-info/requires.txt
writing top-level names to sphinx_tabs.egg-info/top_level.txt
reading manifest file 'sphinx_tabs.egg-info/SOURCES.txt'
reading manifest template 'MANIFEST.in'
warning: no previously-included files found matching 'docs'
warning: no previously-included files matching '*' found under directory 'docs'
warning: no previously-included files found matching 'tests'
warning: no previously-included files found matching 'images'
warning: no previously-included files matching '*' found under directory 'images'
warning: no previously-included files found matching '.pre-commit-config.yaml'
warning: no previously-included files found matching '.readthedocs.yml'
warning: no previously-included files found matching 'pylint.cfg'
warning: no previously-included files found matching 'tox.ini'
warning: no previously-included files found matching 'codecov.yml'
adding license file 'LICENSE'
writing manifest file 'sphinx_tabs.egg-info/SOURCES.txt'
creating build/lib/sphinx_tabs/static
copying sphinx_tabs/static/tabs.css -> build/lib/sphinx_tabs/static
copying sphinx_tabs/static/tabs.js -> build/lib/sphinx_tabs/static
installing to build/bdist.linux-x86_64/wheel
running install
running install_lib
creating build/bdist.linux-x86_64
creating build/bdist.linux-x86_64/wheel
creating build/bdist.linux-x86_64/wheel/sphinx_tabs
copying build/lib/sphinx_tabs/__init__.py -> build/bdist.linux-x86_64/wheel/sphinx_tabs
copying build/lib/sphinx_tabs/tabs.py -> build/bdist.linux-x86_64/wheel/sphinx_tabs
creating build/bdist.linux-x86_64/wheel/sphinx_tabs/static
copying build/lib/sphinx_tabs/static/tabs.css -> build/bdist.linux-x86_64/wheel/sphinx_tabs/static
copying build/lib/sphinx_tabs/static/tabs.js -> build/bdist.linux-x86_64/wheel/sphinx_tabs/static
running install_egg_info
Copying sphinx_tabs.egg-info to build/bdist.linux-x86_64/wheel/sphinx_tabs-3.4.5-py3.8.egg-info
running install_scripts
creating build/bdist.linux-x86_64/wheel/sphinx_tabs-3.4.5.dist-info/WHEEL
creating '/home/tkloczko/rpmbuild/BUILD/sphinx-tabs-3.4.5/dist/.tmp-rn1h7h21/sphinx_tabs-3.4.5-py3-none-any.whl' and adding 'build/bdist.linux-x86_64/wheel' to it
adding 'sphinx_tabs/__init__.py'
adding 'sphinx_tabs/tabs.py'
adding 'sphinx_tabs/static/tabs.css'
adding 'sphinx_tabs/static/tabs.js'
adding 'sphinx_tabs-3.4.5.dist-info/LICENSE'
adding 'sphinx_tabs-3.4.5.dist-info/METADATA'
adding 'sphinx_tabs-3.4.5.dist-info/WHEEL'
adding 'sphinx_tabs-3.4.5.dist-info/top_level.txt'
adding 'sphinx_tabs-3.4.5.dist-info/RECORD'
removing build/bdist.linux-x86_64/wheel
/usr/lib/python3.8/site-packages/setuptools/command/build_py.py:207: _Warning: Package 'sphinx_tabs.static' is absent from the `packages` configuration.
!!

        ********************************************************************************
        ############################
        # Package would be ignored #
        ############################
        Python recognizes 'sphinx_tabs.static' 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 'sphinx_tabs.static' 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 'sphinx_tabs.static' to be distributed and are
        already explicitly excluding 'sphinx_tabs.static' 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)
Successfully built sphinx_tabs-3.4.5-py3-none-any.whl

Reproduce the bug

I'm packaging your module as an rpm package so I'm using the typical PEP517 based build, install and test cycle used on building packages from non-root account.

  • python3 -sBm build -w --no-isolation

List your environment

List of installed modules in build env: 
Package                       Version
----------------------------- -------
alabaster                     0.7.16
Babel                         2.14.0
beautifulsoup4                4.12.2
build                         1.0.3
charset-normalizer            3.3.2
cppclean                      0.13
distro                        1.9.0
dnf                           4.18.2
docutils                      0.20.1
exceptiongroup                1.1.3
gpg                           1.23.2
idna                          3.6
imagesize                     1.4.1
importlib-metadata            7.0.1
iniconfig                     2.0.0
installer                     0.7.0
Jinja2                        3.1.3
libdnf                        0.72.0
MarkupSafe                    2.1.3
packaging                     23.2
pluggy                        1.3.0
Pygments                      2.17.2
pyproject_hooks               1.0.0
pytest                        7.4.4
pytest-datadir                1.5.0
pytest-regressions            2.5.0
python-dateutil               2.8.2
pytz                          2023.3
PyYAML                        6.0.1
requests                      2.31.0
setuptools                    69.0.3
six                           1.16.0
snowballstemmer               2.2.0
soupsieve                     2.5
Sphinx                        7.1.2
sphinxcontrib-applehelp       1.0.4
sphinxcontrib-devhelp         1.0.5
sphinxcontrib-htmlhelp        2.0.5
sphinxcontrib-jsmath          1.0.1
sphinxcontrib-qthelp          1.0.7
sphinxcontrib-serializinghtml 1.1.10
tomli                         2.0.1
urllib3                       1.26.18
wheel                         0.42.0
zipp                          3.17.0

Please let me know if you need more details or want me to perform some diagnostics.
@kloczek kloczek added the bug label Jan 22, 2024
@agoose77 agoose77 mentioned this issue Jan 22, 2024
Open
@kloczek
Copy link
Contributor Author

kloczek commented Nov 10, 2024

I think that this ticket can be closed now.

@kloczek kloczek closed this as completed Nov 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore: use hatch to build package executablebooks/sphinx-tabs
1 participant
@kloczek