import logging import os import re import site import sys from typing import List, Optional logger = logging.getLogger(__name__) _INCLUDE_SYSTEM_SITE_PACKAGES_REGEX = re.compile( r"include-system-site-packages\s*=\s*(?P<value>true|false)" ) def _running_under_venv() -> bool: """Checks if sys.base_prefix and sys.prefix match. This handles PEP 405 compliant virtual environments. """ return sys.prefix != getattr(sys, "base_prefix", sys.prefix) def _running_under_legacy_virtualenv() -> bool: """Checks if sys.real_prefix is set. This handles virtual environments created with pypa's virtualenv. """ # pypa/virtualenv case return hasattr(sys, "real_prefix") def running_under_virtualenv() -> bool: """True if we're running inside a virtual environment, False otherwise.""" return _running_under_venv() or _running_under_legacy_virtualenv() def _get_pyvenv_cfg_lines() -> Optional[List[str]]: """Reads {sys.prefix}/pyvenv.cfg and returns its contents as list of lines Returns None, if it could not read/access the file. """ pyvenv_cfg_file = os.path.join(sys.prefix, "pyvenv.cfg") try: # Although PEP 405 does not specify, the built-in venv module always # writes with UTF-8. (pypa/pip#8717) with open(pyvenv_cfg_file, encoding="utf-8") as f: return f.read().splitlines() # avoids trailing newlines except OSError: return None def _no_global_under_venv() -> bool: """Check `{sys.prefix}/pyvenv.cfg` for system site-packages inclusion PEP 405 specifies that when system site-packages are not supposed to be visible from a virtual environment, `pyvenv.cfg` must contain the following line: include-system-site-packages = false Additionally, log a warning if accessing the file fails. """ cfg_lines = _get_pyvenv_cfg_lines() if cfg_lines is None: # We're not in a "sane" venv, so assume there is no system # site-packages access (since that's PEP 405's default state). logger.warning( "Could not access 'pyvenv.cfg' despite a virtual environment " "being active. Assuming global site-packages is not accessible " "in this environment." ) return True for line in cfg_lines: match = _INCLUDE_SYSTEM_SITE_PACKAGES_REGEX.match(line) if match is not None and match.group("value") == "false": return True return False def _no_global_under_legacy_virtualenv() -> bool: """Check if "no-global-site-packages.txt" exists beside site.py This mirrors logic in pypa/virtualenv for determining whether system site-packages are visible in the virtual environment. """ site_mod_dir = os.path.dirname(os.path.abspath(site.__file__)) no_global_site_packages_file = os.path.join( site_mod_dir, "no-global-site-packages.txt", ) return os.path.exists(no_global_site_packages_file) def virtualenv_no_global() -> bool: """Returns a boolean, whether running in venv with no system site-packages.""" # PEP 405 compliance needs to be checked first since virtualenv >=20 would # return True for both checks, but is only able to use the PEP 405 config. if _running_under_venv(): return _no_global_under_venv() if _running_under_legacy_virtualenv(): return _no_global_under_legacy_virtualenv() return False
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
__pycache__ | Folder | 0755 |
|
|
__init__.py | File | 0 B | 0644 |
|
_jaraco_text.py | File | 3.27 KB | 0644 |
|
_log.py | File | 1015 B | 0644 |
|
appdirs.py | File | 1.63 KB | 0644 |
|
compat.py | File | 2.34 KB | 0644 |
|
compatibility_tags.py | File | 6.13 KB | 0644 |
|
datetime.py | File | 242 B | 0644 |
|
deprecation.py | File | 3.62 KB | 0644 |
|
direct_url_helpers.py | File | 3.12 KB | 0644 |
|
egg_link.py | File | 2.41 KB | 0644 |
|
encoding.py | File | 1.14 KB | 0644 |
|
entrypoints.py | File | 2.99 KB | 0644 |
|
filesystem.py | File | 4.83 KB | 0644 |
|
filetypes.py | File | 716 B | 0644 |
|
glibc.py | File | 3.65 KB | 0644 |
|
hashes.py | File | 4.86 KB | 0644 |
|
logging.py | File | 11.33 KB | 0644 |
|
misc.py | File | 22.98 KB | 0644 |
|
packaging.py | File | 2.06 KB | 0644 |
|
retry.py | File | 1.36 KB | 0644 |
|
setuptools_build.py | File | 4.33 KB | 0644 |
|
subprocess.py | File | 8.78 KB | 0644 |
|
temp_dir.py | File | 9.09 KB | 0644 |
|
unpacking.py | File | 11.67 KB | 0644 |
|
urls.py | File | 1.56 KB | 0644 |
|
virtualenv.py | File | 3.38 KB | 0644 |
|
wheel.py | File | 4.39 KB | 0644 |
|