[3.9] gh-113659: Skip hidden .pth files (GH-113660) (GH-114146)

(cherry picked from commit 74208ed0c4)

Co-authored-by: Łukasz Langa <lukasz@langa.pl>
This commit is contained in:
Serhiy Storchaka 2024-01-17 16:28:17 +02:00 committed by GitHub
parent dd068eaf48
commit 8fc8c45b67
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 50 additions and 1 deletions

View file

@ -74,6 +74,7 @@ import os
import builtins import builtins
import _sitebuiltins import _sitebuiltins
import io import io
import stat
# Prefixes for site-packages; add additional prefixes like /usr/local here # Prefixes for site-packages; add additional prefixes like /usr/local here
PREFIXES = [sys.prefix, sys.exec_prefix] PREFIXES = [sys.prefix, sys.exec_prefix]
@ -156,6 +157,13 @@ def addpackage(sitedir, name, known_paths):
else: else:
reset = False reset = False
fullname = os.path.join(sitedir, name) fullname = os.path.join(sitedir, name)
try:
st = os.lstat(fullname)
except OSError:
return
if ((getattr(st, 'st_flags', 0) & stat.UF_HIDDEN) or
(getattr(st, 'st_file_attributes', 0) & stat.FILE_ATTRIBUTE_HIDDEN)):
return
try: try:
f = io.TextIOWrapper(io.open_code(fullname)) f = io.TextIOWrapper(io.open_code(fullname))
except OSError: except OSError:
@ -203,7 +211,8 @@ def addsitedir(sitedir, known_paths=None):
names = os.listdir(sitedir) names = os.listdir(sitedir)
except OSError: except OSError:
return return
names = [name for name in names if name.endswith(".pth")] names = [name for name in names
if name.endswith(".pth") and not name.startswith(".")]
for name in sorted(names): for name in sorted(names):
addpackage(sitedir, name, known_paths) addpackage(sitedir, name, known_paths)
if reset: if reset:

View file

@ -16,6 +16,7 @@ import glob
import os import os
import re import re
import shutil import shutil
import stat
import subprocess import subprocess
import sys import sys
import sysconfig import sysconfig
@ -185,6 +186,44 @@ class HelperFunctionsTests(unittest.TestCase):
finally: finally:
pth_file.cleanup() pth_file.cleanup()
def test_addsitedir_dotfile(self):
pth_file = PthFile('.dotfile')
pth_file.cleanup(prep=True)
try:
pth_file.create()
site.addsitedir(pth_file.base_dir, set())
self.assertNotIn(site.makepath(pth_file.good_dir_path)[0], sys.path)
self.assertIn(pth_file.base_dir, sys.path)
finally:
pth_file.cleanup()
@unittest.skipUnless(hasattr(os, 'chflags'), 'test needs os.chflags()')
def test_addsitedir_hidden_flags(self):
pth_file = PthFile()
pth_file.cleanup(prep=True)
try:
pth_file.create()
st = os.stat(pth_file.file_path)
os.chflags(pth_file.file_path, st.st_flags | stat.UF_HIDDEN)
site.addsitedir(pth_file.base_dir, set())
self.assertNotIn(site.makepath(pth_file.good_dir_path)[0], sys.path)
self.assertIn(pth_file.base_dir, sys.path)
finally:
pth_file.cleanup()
@unittest.skipUnless(sys.platform == 'win32', 'test needs Windows')
def test_addsitedir_hidden_file_attribute(self):
pth_file = PthFile()
pth_file.cleanup(prep=True)
try:
pth_file.create()
subprocess.check_call(['attrib', '+H', pth_file.file_path])
site.addsitedir(pth_file.base_dir, set())
self.assertNotIn(site.makepath(pth_file.good_dir_path)[0], sys.path)
self.assertIn(pth_file.base_dir, sys.path)
finally:
pth_file.cleanup()
# This tests _getuserbase, hence the double underline # This tests _getuserbase, hence the double underline
# to distinguish from a test for getuserbase # to distinguish from a test for getuserbase
def test__getuserbase(self): def test__getuserbase(self):

View file

@ -0,0 +1 @@
Skip ``.pth`` files with names starting with a dot or hidden file attribute.