pypa / pypa/setuptools

[BUG] (minor) .pyc files present in recent setuptools releases sdists

Open
#3,449 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug Needs Triage
Dominant language
Python
Stars
2.9k
Forks
1.4k
Avg merge
1d 1h
Merged PRs (30d)
1

Description

setuptools version

63.2.0

Python version

n/a

OS

Gentoo Linux

Additional environment information

No response

Description

Not a big deal but just noticed that there are some .pyc files found in the tools/ directory of the generated sdist:

$ tar -tf /tmp/dist/setuptools-63.2.0.tar.gz  | grep __pycache__
setuptools-63.2.0/tools/__pycache__/
setuptools-63.2.0/tools/__pycache__/finalize.cpython-310.pyc
setuptools-63.2.0/tools/__pycache__/generate_validation_code.cpython-310.pyc
setuptools-63.2.0/tools/__pycache__/ppc64le-patch.cpython-310.pyc
setuptools-63.2.0/tools/__pycache__/vendored.cpython-310.pyc
Expected behavior

No .pyc files there ;-).

How to Reproduce
wget https://files.pythonhosted.org/packages/0a/ba/52611dc8278828eb9ec339e6914a0f865f9e2af967214905927835dfac0a/setuptools-63.2.0.tar.gz
tar -tf setuptools-63.2.0.tar.gz | grep __pycache__
Output
$ tar -tf setuptools-63.2.0.tar.gz | grep __pycache__
setuptools-63.2.0/tools/__pycache__/
setuptools-63.2.0/tools/__pycache__/finalize.cpython-310.pyc
setuptools-63.2.0/tools/__pycache__/generate_validation_code.cpython-310.pyc
setuptools-63.2.0/tools/__pycache__/ppc64le-patch.cpython-310.pyc
setuptools-63.2.0/tools/__pycache__/vendored.cpython-310.pyc

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the issue with the provided wget and tar commands, then inspect how the tools/ directory is collected into the generated source distribution. Confirm the fix by rebuilding or examining a setuptools source archive and verifying that it contains no tools/pycache or .pyc files.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.