kennethreitz/pipenv
1
0
Fork 0
mirror of https://github.com/kennethreitz/pipenv.git synced 2026-06-05 22:50:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Refactor all relevant settings to use get_from_env

Browse Source
This commit is contained in:
Micah Smith
2022-10-27 17:50:01 -04:00
parent d1adb504be
commit cd15007e4d
1 changed files with 39 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files
pipenv/environments.py
+39 -41
View File
@@ -120,14 +120,12 @@ class Setting:
#: Location for Pipenv to store it's package cache.
#: Default is to use appdir's user cache directory.
self.PIPENV_CACHE_DIR = os.environ.get(
"PIPENV_CACHE_DIR", user_cache_dir("pipenv")
self.PIPENV_CACHE_DIR = get_from_env(
"CACHE_DIR", default=user_cache_dir("pipenv")
)
# Tells Pipenv which Python to default to, when none is provided.
self.PIPENV_DEFAULT_PYTHON_VERSION = os.environ.get(
"PIPENV_DEFAULT_PYTHON_VERSION"
)
self.PIPENV_DEFAULT_PYTHON_VERSION = get_from_env("DEFAULT_PYTHON_VERSION")
"""Use this Python version when creating new virtual environments by default.
This can be set to a version string, e.g. ``3.9``, or a path. Default is to use
@@ -136,38 +134,38 @@ class Setting:
this configuration.
"""
self.PIPENV_DONT_LOAD_ENV = bool(os.environ.get("PIPENV_DONT_LOAD_ENV"))
self.PIPENV_DONT_LOAD_ENV = bool(get_from_env("DONT_LOAD_ENV"))
"""If set, Pipenv does not load the ``.env`` file.
Default is to load ``.env`` for ``run`` and ``shell`` commands.
"""
self.PIPENV_DONT_USE_PYENV = bool(os.environ.get("PIPENV_DONT_USE_PYENV"))
self.PIPENV_DONT_USE_PYENV = bool(get_from_env("DONT_USE_PYENV"))
"""If set, Pipenv does not attempt to install Python with pyenv.
Default is to install Python automatically via pyenv when needed, if possible.
"""
self.PIPENV_DONT_USE_ASDF = bool(os.environ.get("PIPENV_DONT_USE_ASDF"))
self.PIPENV_DONT_USE_ASDF = bool(get_from_env("DONT_USE_ASDF"))
"""If set, Pipenv does not attempt to install Python with asdf.
Default is to install Python automatically via asdf when needed, if possible.
"""
self.PIPENV_DOTENV_LOCATION = os.environ.get("PIPENV_DOTENV_LOCATION")
self.PIPENV_DOTENV_LOCATION = get_from_env("DOTENV_LOCATION")
"""If set, Pipenv loads the ``.env`` file at the specified location.
Default is to load ``.env`` from the project root, if found.
"""
self.PIPENV_EMULATOR = os.environ.get("PIPENV_EMULATOR", "")
self.PIPENV_EMULATOR = get_from_env("EMULATOR", default="")
"""If set, the terminal emulator's name for ``pipenv shell`` to use.
Default is to detect emulators automatically. This should be set if your
emulator, e.g. Cmder, cannot be detected correctly.
"""
self.PIPENV_IGNORE_VIRTUALENVS = bool(os.environ.get("PIPENV_IGNORE_VIRTUALENVS"))
self.PIPENV_IGNORE_VIRTUALENVS = bool(get_from_env("IGNORE_VIRTUALENVS"))
"""If set, Pipenv will always assign a virtual environment for this project.
By default, Pipenv tries to detect whether it is run inside a virtual
@@ -176,7 +174,7 @@ class Setting:
"""
self.PIPENV_INSTALL_TIMEOUT = int(
os.environ.get("PIPENV_INSTALL_TIMEOUT", 60 * 15)
get_from_env("INSTALL_TIMEOUT", default=60 * 15)
)
"""Max number of seconds to wait for package installation.
@@ -184,14 +182,14 @@ class Setting:
"""
# NOTE: +1 because of a temporary bug in Pipenv.
self.PIPENV_MAX_DEPTH = int(os.environ.get("PIPENV_MAX_DEPTH", "3")) + 1
self.PIPENV_MAX_DEPTH = int(get_from_env("PIPENV_MAX_DEPTH", default=3)) + 1
"""Maximum number of directories to recursively search for a Pipfile.
Default is 3. See also ``PIPENV_NO_INHERIT``.
"""
self.PIPENV_MAX_RETRIES = int(
os.environ.get("PIPENV_MAX_RETRIES", "1" if PIPENV_IS_CI else "0")
self.PIPENV_MAX_RETRIES = (
int(get_from_env("MAX_RETRIES", default=1)) if PIPENV_IS_CI else 0
)
"""Specify how many retries Pipenv should attempt for network requests.
@@ -207,7 +205,7 @@ class Setting:
if self.PIPENV_NO_INHERIT:
self.PIPENV_MAX_DEPTH = 2
self.PIPENV_NOSPIN = bool(os.environ.get("PIPENV_NOSPIN"))
self.PIPENV_NOSPIN = bool(get_from_env("NOSPIN", check_for_negation=False))
"""If set, disable terminal spinner.
This can make the logs cleaner. Automatically set on Windows, and in CI
@@ -217,14 +215,16 @@ class Setting:
self.PIPENV_NOSPIN = True
pipenv_spinner = "dots" if not os.name == "nt" else "bouncingBar"
self.PIPENV_SPINNER = os.environ.get("PIPENV_SPINNER", pipenv_spinner)
self.PIPENV_SPINNER = get_from_env(
"SPINNER", check_for_negation=False, default=pipenv_spinner
)
"""Sets the default spinner type.
Spinners are identical to the ``node.js`` spinners and can be found at
https://github.com/sindresorhus/cli-spinners
"""
pipenv_pipfile = os.environ.get("PIPENV_PIPFILE")
pipenv_pipfile = get_from_env("PIPFILE", check_for_negation=False)
if pipenv_pipfile:
if not os.path.isfile(pipenv_pipfile):
raise RuntimeError("Given PIPENV_PIPFILE is not found!")
@@ -245,20 +245,20 @@ class Setting:
See also ``PIPENV_MAX_DEPTH``.
"""
self.PIPENV_PYPI_MIRROR = os.environ.get("PIPENV_PYPI_MIRROR")
self.PIPENV_PYPI_MIRROR = get_from_env("PYPI_MIRROR", check_for_negation=False)
"""If set, tells pipenv to override PyPI index urls with a mirror.
Default is to not mirror PyPI, i.e. use the real one, pypi.org. The
``--pypi-mirror`` command line flag overwrites this.
"""
self.PIPENV_QUIET = bool(os.environ.get("PIPENV_QUIET"))
self.PIPENV_QUIET = bool(get_from_env("QUIET", check_for_negation=False))
"""If set, makes Pipenv quieter.
Default is unset, for normal verbosity. ``PIPENV_VERBOSE`` overrides this.
"""
self.PIPENV_SHELL_EXPLICIT = os.environ.get("PIPENV_SHELL")
self.PIPENV_SHELL_EXPLICIT = get_from_env("SHELL", check_for_negation=False)
"""An absolute path to the preferred shell for ``pipenv shell``.
Default is to detect automatically what shell is currently in use.
@@ -266,19 +266,19 @@ class Setting:
# Hack because PIPENV_SHELL is actually something else. Internally this
# variable is called PIPENV_SHELL_EXPLICIT instead.
self.PIPENV_SHELL_FANCY = bool(os.environ.get("PIPENV_SHELL_FANCY"))
self.PIPENV_SHELL_FANCY = bool(get_from_env("SHELL_FANCY"))
"""If set, always use fancy mode when invoking ``pipenv shell``.
Default is to use the compatibility shell if possible.
"""
self.PIPENV_TIMEOUT = int(os.environ.get("PIPENV_TIMEOUT", 120))
self.PIPENV_TIMEOUT = int(get_from_env("TIMEOUT", default=120))
"""Max number of seconds Pipenv will wait for virtualenv creation to complete.
Default is 120 seconds, an arbitrary number that seems to work.
"""
self.PIPENV_VENV_IN_PROJECT = os.environ.get("PIPENV_VENV_IN_PROJECT")
self.PIPENV_VENV_IN_PROJECT = get_from_env("VENV_IN_PROJECT")
if self.PIPENV_VENV_IN_PROJECT is not None:
if self.PIPENV_VENV_IN_PROJECT.lower() in TRUE_VALUES:
self.PIPENV_VENV_IN_PROJECT = True
@@ -288,25 +288,25 @@ class Setting:
self.PIPENV_VENV_IN_PROJECT = None
""" When set True, will create or use the ``.venv`` in your project directory.
When Set False, will ignore the .venv in your project directory even if it exists.
Default is None will use the .venv of project directory should it exist, otherwise
If unset (default), will use the .venv of project directory should it exist, otherwise
will create new virtual environments in a global location.
"""
self.PIPENV_VERBOSE = bool(os.environ.get("PIPENV_VERBOSE"))
self.PIPENV_VERBOSE = bool(get_from_env("VERBOSE", check_for_negation=False))
"""If set, makes Pipenv more wordy.
Default is unset, for normal verbosity. This takes precedence over
``PIPENV_QUIET``.
"""
self.PIPENV_YES = bool(os.environ.get("PIPENV_YES"))
self.PIPENV_YES = bool(get_from_env("YES"))
"""If set, Pipenv automatically assumes "yes" at all prompts.
Default is to prompt the user for an answer if the current command line session
if interactive.
"""
self.PIPENV_SKIP_LOCK = bool(os.environ.get("PIPENV_SKIP_LOCK", False))
self.PIPENV_SKIP_LOCK = bool(get_from_env("SKIP_LOCK"))
"""If set, Pipenv won't lock dependencies automatically.
This might be desirable if a project has large number of dependencies,
@@ -319,33 +319,32 @@ class Setting:
NOTE: This only affects the ``install`` and ``uninstall`` commands.
"""
self.PIP_EXISTS_ACTION = os.environ.get("PIP_EXISTS_ACTION", "w")
self.PIP_EXISTS_ACTION = get_from_env(
"EXISTS_ACTION", prefix="PIP", check_for_negation=False, default="w"
)
"""Specifies the value for pip's --exists-action option
Defaults to ``(w)ipe``
"""
self.PIPENV_RESOLVE_VCS = os.environ.get(
"PIPENV_RESOLVE_VCS"
) is None or _is_env_truthy("PIPENV_RESOLVE_VCS")
self.PIPENV_RESOLVE_VCS = bool(get_from_env("RESOLVE_VCS", default=True))
"""Tells Pipenv whether to resolve all VCS dependencies in full.
As of Pipenv 2018.11.26, only editable VCS dependencies were resolved in full.
To retain this behavior and avoid handling any conflicts that arise from the new
approach, you may set this to '0', 'off', or 'false'.
approach, you may disable this.
"""
self.PIPENV_CUSTOM_VENV_NAME = os.getenv("PIPENV_CUSTOM_VENV_NAME", None)
self.PIPENV_CUSTOM_VENV_NAME = get_from_env("CUSTOM_VENV_NAME")
"""Tells Pipenv whether to name the venv something other than the default dir name."""
self.PIPENV_PYUP_API_KEY = os.environ.get("PIPENV_PYUP_API_KEY", None)
self.PIPENV_PYUP_API_KEY = get_from_env("PYUP_API_KEY")
# Internal, support running in a different Python from sys.executable.
self.PIPENV_PYTHON = os.environ.get("PIPENV_PYTHON")
self.PIPENV_PYTHON = get_from_env("PYTHON")
# Internal, overwrite all index funcitonality.
self.PIPENV_TEST_INDEX = os.environ.get("PIPENV_TEST_INDEX")
self.PIPENV_TEST_INDEX = get_from_env("TEST_INDEX")
# Internal, tells Pipenv about the surrounding environment.
self.PIPENV_USE_SYSTEM = False
@@ -366,9 +365,8 @@ class Setting:
# Internal, consolidated verbosity representation as an integer. The default
# level is 0, increased for wordiness and decreased for terseness.
verbosity = os.environ.get("PIPENV_VERBOSITY", "")
try:
self.PIPENV_VERBOSITY = int(verbosity)
self.PIPENV_VERBOSITY = int(get_from_env("VERBOSITY"))
except (ValueError, TypeError):
if self.PIPENV_VERBOSE:
self.PIPENV_VERBOSITY = 1
@@ -407,7 +405,7 @@ def is_in_virtualenv():
pipenv_active = os.environ.get("PIPENV_ACTIVE", False)
virtual_env = bool(os.environ.get("VIRTUAL_ENV"))
ignore_virtualenvs = bool(os.environ.get("PIPENV_IGNORE_VIRTUALENVS", False))
ignore_virtualenvs = bool(get_from_env("IGNORE_VIRTUALENVS"))
return virtual_env and not (pipenv_active or ignore_virtualenvs)