Skip to content

gh-141081: Don't create .gitignore in site-packages#142745

Closed
hugovk wants to merge 1 commit intopython:mainfrom
hugovk:3.15-fix-gitignore-pip
Closed

gh-141081: Don't create .gitignore in site-packages#142745
hugovk wants to merge 1 commit intopython:mainfrom
hugovk:3.15-fix-gitignore-pip

Conversation

@hugovk
Copy link
Member

@hugovk hugovk commented Dec 15, 2025 •
edited
Loading

The buildbot failures:

test_with_pip (test.test_venv.EnsurePipTest.test_with_pip) ... FAIL

======================================================================
FAIL: test_with_pip (test.test_venv.EnsurePipTest.test_with_pip)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/home/buildbot/buildarea/3.x.itamaro-centos-aws.nogil/build/Lib/test/test_venv.py", line 1047, in test_with_pip
    self.do_test_with_pip(False)
    ~~~~~~~~~~~~~~~~~~~~~^^^^^^^
  File "/home/buildbot/buildarea/3.x.itamaro-centos-aws.nogil/build/Lib/test/test_venv.py", line 1023, in do_test_with_pip
    self.assert_pip_not_installed()
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^
  File "/home/buildbot/buildarea/3.x.itamaro-centos-aws.nogil/build/Lib/test/test_venv.py", line 906, in assert_pip_not_installed
    self.assertEqual(out.strip(), "OK")
    ~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^
AssertionError: '' != 'OK'
+ OK

The problem was that when pip uninstalls itself, it removes its own files, and then tries to remove empty directories like __pycache__. But __pycache__ contains our .gitignore so the dir removal fails.

Instead, let's not add .gitignore in site-packages dirs, and let the package managers handle those.

Debian and Ubuntu use dist-packages rather than site-packages -- should we include that as well?

@hugovk
Copy link
Member Author

hugovk commented Dec 15, 2025

!buildbot AMD64

@bedevere-bot
Copy link

bedevere-bot commented Dec 15, 2025

🤖 New build scheduled with the buildbot fleet by @hugovk for commit 6686ca6 🤖

Results will be shown at:

https://buildbot.python.org/all/#/grid?branch=refs%2Fpull%2F142745%2Fmerge

The command will test the builders whose names match following regular expression: AMD64

The builders matched are:

  • AMD64 Fedora Rawhide Refleaks PR
  • AMD64 Arch Linux TraceRefs PR
  • AMD64 Windows Server 2022 NoGIL PR
  • AMD64 RHEL8 FIPS No Builtin Hashes PR
  • AMD64 CentOS9 FIPS Only Blake2 Builtin Hash PR
  • AMD64 Ubuntu Shared PR
  • AMD64 RHEL8 LTO + PGO PR
  • AMD64 Fedora Rawhide LTO PR
  • AMD64 CentOS9 NoGIL Refleaks PR
  • AMD64 RHEL8 FIPS Only Blake2 Builtin Hash PR
  • AMD64 Alpine Linux PR
  • AMD64 CentOS9 FIPS No Builtin Hashes PR
  • AMD64 Arch Linux Asan PR
  • AMD64 Debian root PR
  • AMD64 Arch Linux Usan PR
  • AMD64 Fedora Rawhide NoGIL refleaks PR
  • AMD64 CentOS9 NoGIL PR
  • AMD64 CentOS9 PR
  • AMD64 RHEL8 Refleaks PR
  • AMD64 Windows PGO NoGIL PR
  • AMD64 Windows11 Non-Debug PR
  • AMD64 RHEL8 LTO PR
  • AMD64 Arch Linux Usan Function PR
  • AMD64 CentOS9 LTO PR
  • AMD64 Arch Linux Asan Debug PR
  • AMD64 Fedora Rawhide Clang Installed PR
  • AMD64 Windows11 Bigmem PR
  • AMD64 Alpine Linux NoGIL PR
  • AMD64 Ubuntu PR
  • AMD64 CentOS9 Refleaks PR
  • AMD64 CentOS9 LTO + PGO PR
  • AMD64 Windows11 Refleaks PR
  • AMD64 Fedora Stable LTO PR
  • AMD64 Fedora Stable Clang Installed PR
  • AMD64 FreeBSD14 PR
  • AMD64 FreeBSD15 PR
  • AMD64 Fedora Rawhide NoGIL PR
  • AMD64 Fedora Stable Refleaks PR
  • AMD64 Fedora Stable LTO + PGO PR
  • AMD64 RHEL8 PR
  • AMD64 Fedora Rawhide Clang PR
  • AMD64 Windows10 PR
  • AMD64 FreeBSD PR
  • AMD64 Arch Linux Valgrind PR
  • AMD64 Windows PGO PR
  • AMD64 Fedora Stable PR
  • AMD64 FreeBSD Refleaks PR
  • AMD64 Android PR
  • AMD64 Fedora Stable Clang PR
  • AMD64 Fedora Rawhide PR
  • AMD64 Arch Linux Perf PR
  • AMD64 Fedora Rawhide LTO + PGO PR

@hugovk
Copy link
Member Author

hugovk commented Dec 15, 2025

!buildbot PPC64LE Fedora Stable

@bedevere-bot
Copy link

bedevere-bot commented Dec 15, 2025

🤖 New build scheduled with the buildbot fleet by @hugovk for commit 6686ca6 🤖

Results will be shown at:

https://buildbot.python.org/all/#/grid?branch=refs%2Fpull%2F142745%2Fmerge

The command will test the builders whose names match following regular expression: PPC64LE Fedora Stable

The builders matched are:

  • PPC64LE Fedora Stable LTO + PGO PR
  • PPC64LE Fedora Stable PR
  • PPC64LE Fedora Stable Clang PR
  • PPC64LE Fedora Stable Clang Installed PR
  • PPC64LE Fedora Stable Refleaks PR
  • PPC64LE Fedora Stable LTO PR

@hugovk
Copy link
Member Author

hugovk commented Dec 15, 2025

!buildbot x86-64 macOS

@bedevere-bot
Copy link

bedevere-bot commented Dec 15, 2025

🤖 New build scheduled with the buildbot fleet by @hugovk for commit 6686ca6 🤖

Results will be shown at:

https://buildbot.python.org/all/#/grid?branch=refs%2Fpull%2F142745%2Fmerge

The command will test the builders whose names match following regular expression: x86-64 macOS

The builders matched are:

  • x86-64 macOS PR
  • x86-64 MacOS Intel ASAN NoGIL PR
  • x86-64 MacOS Intel NoGIL PR

@hugovk hugovk changed the title Don't create .gitignore in site-packages as these are managed by package installers, not Git gh-141081: Don't create .gitignore in site-packages as these are managed by package installers, not Git Dec 15, 2025
@bedevere-app bedevere-app bot mentioned this pull request Dec 15, 2025
Open
@hugovk hugovk marked this pull request as ready for review December 15, 2025 13:16
@hugovk hugovk mentioned this pull request Dec 15, 2025
Merged
@hugovk hugovk changed the title gh-141081: Don't create .gitignore in site-packages as these are managed by package installers, not Git gh-141081: Don't create .gitignore in site-packages Dec 15, 2025
encukou
encukou reviewed Dec 15, 2025
View reviewed changes
Lib/importlib/_bootstrap_external.py
gitignore_content = b'# Created by CPython\n*\n'
# Don't create in site-packages as these are managed
# by package installers, not Git
if 'site-packages' not in parent:
Copy link
Member

@encukou encukou Dec 15, 2025

Choose a reason for hiding this comment

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

Doesn't this assume that sysconfig.get_path('purelib') is named site-packages?
Users can configure this in site.py; Ubuntu uses dist-packages instead.

Copy link
Member Author

@hugovk hugovk Dec 15, 2025

Choose a reason for hiding this comment

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

It does, let's change to use sysconfig.get_path('purelib'). Should we also check sysconfig.get_path('platlib')?

  • platlib: directory for site-specific, platform-specific files.
  • purelib: directory for site-specific, non-platform-specific files (‘pure’ Python).

https://docs.python.org/3/library/sysconfig.html#installation-paths

Copy link
Member

@encukou encukou Dec 15, 2025

Choose a reason for hiding this comment

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

Maybe?

More generally: how can you tell what “manages” a given directory? I don't really have an answer, I'm afraid.

@brettcannon brettcannon removed their request for review December 15, 2025 18:58
@hugovk hugovk marked this pull request as draft December 15, 2025 19:27
@hugovk
Copy link
Member Author

hugovk commented Dec 16, 2025

Closing, the original PR has been reverted for now, let's continue in the issue.

@hugovk hugovk closed this Dec 16, 2025
@hugovk hugovk deleted the 3.15-fix-gitignore-pip branch December 16, 2025 06:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@encukou encukou encukou left review comments

@ericsnowcurrently ericsnowcurrently Awaiting requested review from ericsnowcurrently ericsnowcurrently is a code owner

@ncoghlan ncoghlan Awaiting requested review from ncoghlan ncoghlan is a code owner

@warsaw warsaw Awaiting requested review from warsaw warsaw is a code owner

@brettcannon brettcannon Awaiting requested review from brettcannon brettcannon will be requested when the pull request is marked ready for review brettcannon is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@hugovk @bedevere-bot @encukou