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

running setup.py bdist_wheel results in build/, docs/ and testing/ in the wheel #503

Closed
smoser opened this issue Nov 1, 2024 · 1 comment · Fixed by #502
Closed

running setup.py bdist_wheel results in build/, docs/ and testing/ in the wheel #503

smoser opened this issue Nov 1, 2024 · 1 comment · Fixed by #502
Assignees
Labels
priority: p2 Moderately-important priority. Fix may not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.

Comments

@smoser
Copy link
Contributor

smoser commented Nov 1, 2024

Thanks for stopping by to let us know something could be better!

Environment details

  • Programming language: python
  • OS: ubuntu 24.04
  • Language runtime version: 3.12
  • Package version: git

Steps to reproduce

  1. Run setup.py bdist_wheel with pip-installed versions of setuptools, wheel
  2. look at created wheel, it will have testing/, docs/ and build/ directories in it.

Attached do-build.sh.txt will recreate.

Example trimmed outputt:

% sh  /tmp/do-build.sh.txt
$ mkdir -p /tmp/tmp.0J6yfGbozE/venv
$ python3 -m venv /tmp/tmp.0J6yfGbozE/venv
$ which pip
/tmp/tmp.0J6yfGbozE/venv/bin/pip

installing build deps into /tmp/tmp.0J6yfGbozE/venv
pip=/tmp/tmp.0J6yfGbozE/venv/bin/pip python3=/tmp/tmp.0J6yfGbozE/venv/bin/python3
$ pip install setuptools build wheel
Collecting setuptools
  Using cached setuptools-75.3.0-py3-none-any.whl.metadata (6.9 kB)
Collecting build
  Using cached build-1.2.2.post1-py3-none-any.whl.metadata (6.5 kB)
...
Successfully installed build-1.2.2.post1 packaging-24.1 pyproject_hooks-1.2.0 setuptools-75.3.0 wheel-0.44.0

$ rm -Rf dist/

building with /tmp/tmp.0J6yfGbozE/venv/bin/python3
$ /tmp/tmp.0J6yfGbozE/venv/bin/python3 setup.py bdist_wheel
...
adding 'testing/constraints-3.9.txt'
adding 'proto_plus-1.25.0.dist-info/LICENSE'
adding 'proto_plus-1.25.0.dist-info/METADATA'
adding 'proto_plus-1.25.0.dist-info/WHEEL'
adding 'proto_plus-1.25.0.dist-info/top_level.txt'
adding 'proto_plus-1.25.0.dist-info/RECORD'
removing build/bdist.linux-x86_64/wheel

built dist/proto_plus-1.25.0-py3-none-any.whl
-rw-rw-r-- 1 smoser smoser 230125 Nov  1 17:08 dist/proto_plus-1.25.0-py3-none-any.whl

...

FAIL: your wheel has docs/ testing/ build/

The second run will contain build/, docs/ and testing/ (from a dirty directory). The first will only contain docs and testing.

Here is a full list of the created wheel.
unzip-wheel.txt

@smoser smoser added priority: p2 Moderately-important priority. Fix may not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. labels Nov 1, 2024
@smoser
Copy link
Contributor Author

smoser commented Nov 1, 2024

I unsuccessfully tried #502 .

@parthea parthea self-assigned this Jan 22, 2025
@parthea parthea added status: investigating The issue is under investigation, which is determined to be non-trivial. and removed status: investigating The issue is under investigation, which is determined to be non-trivial. labels Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: p2 Moderately-important priority. Fix may not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants