Skip to content

Commit

Permalink
pythongh-89427: Provide the original prompt value for VIRTUAL_ENV_PRO…
Browse files Browse the repository at this point in the history
…MPT (pythonGH-106726)

This improves the implementation in pythongh-106643.

Previously, venv passed "(<prompt>) " to the activation scripts, but we want
to provide the original value so that users can inspect it in the
$VIRTUAL_ENV_PROMPT env var.

Note: Lib/venv/scripts/common/Activate.ps1 surrounded the prompt value with
parens a second time, so no change was necessary in that file.
  • Loading branch information
jimporter authored and aisk committed Feb 11, 2024
1 parent 80e0ade commit 3b1d13f
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 10 deletions.
8 changes: 4 additions & 4 deletions Lib/test/test_venv.py
Expand Up @@ -169,7 +169,7 @@ def test_config_file_command_key(self):
('--clear', 'clear', True),
('--upgrade', 'upgrade', True),
('--upgrade-deps', 'upgrade_deps', True),
('--prompt', 'prompt', True),
('--prompt="foobar"', 'prompt', 'foobar'),
('--without-scm-ignore-files', 'scm_ignore_files', frozenset()),
]
for opt, attr, value in options:
Expand Down Expand Up @@ -201,15 +201,15 @@ def test_prompt(self):
self.run_with_capture(builder.create, self.env_dir)
context = builder.ensure_directories(self.env_dir)
data = self.get_text_file_contents('pyvenv.cfg')
self.assertEqual(context.prompt, '(%s) ' % env_name)
self.assertEqual(context.prompt, env_name)
self.assertNotIn("prompt = ", data)

rmtree(self.env_dir)
builder = venv.EnvBuilder(prompt='My prompt')
self.run_with_capture(builder.create, self.env_dir)
context = builder.ensure_directories(self.env_dir)
data = self.get_text_file_contents('pyvenv.cfg')
self.assertEqual(context.prompt, '(My prompt) ')
self.assertEqual(context.prompt, 'My prompt')
self.assertIn("prompt = 'My prompt'\n", data)

rmtree(self.env_dir)
Expand All @@ -218,7 +218,7 @@ def test_prompt(self):
self.run_with_capture(builder.create, self.env_dir)
context = builder.ensure_directories(self.env_dir)
data = self.get_text_file_contents('pyvenv.cfg')
self.assertEqual(context.prompt, '(%s) ' % cwd)
self.assertEqual(context.prompt, cwd)
self.assertIn("prompt = '%s'\n" % cwd, data)

def test_upgrade_dependencies(self):
Expand Down
3 changes: 1 addition & 2 deletions Lib/venv/__init__.py
Expand Up @@ -129,8 +129,7 @@ def create_if_needed(d):
context = types.SimpleNamespace()
context.env_dir = env_dir
context.env_name = os.path.split(env_dir)[1]
prompt = self.prompt if self.prompt is not None else context.env_name
context.prompt = '(%s) ' % prompt
context.prompt = self.prompt if self.prompt is not None else context.env_name
create_if_needed(env_dir)
executable = sys._base_executable
if not executable: # see gh-96861
Expand Down
2 changes: 1 addition & 1 deletion Lib/venv/scripts/common/activate
Expand Up @@ -66,7 +66,7 @@ fi

if [ -z "${VIRTUAL_ENV_DISABLE_PROMPT:-}" ] ; then
_OLD_VIRTUAL_PS1="${PS1:-}"
PS1="__VENV_PROMPT__${PS1:-}"
PS1="(__VENV_PROMPT__) ${PS1:-}"
export PS1
fi

Expand Down
2 changes: 1 addition & 1 deletion Lib/venv/scripts/nt/activate.bat
Expand Up @@ -16,7 +16,7 @@ if defined _OLD_VIRTUAL_PROMPT set PROMPT=%_OLD_VIRTUAL_PROMPT%
if defined _OLD_VIRTUAL_PYTHONHOME set PYTHONHOME=%_OLD_VIRTUAL_PYTHONHOME%

set _OLD_VIRTUAL_PROMPT=%PROMPT%
set PROMPT=__VENV_PROMPT__%PROMPT%
set PROMPT=(__VENV_PROMPT__) %PROMPT%

if defined PYTHONHOME set _OLD_VIRTUAL_PYTHONHOME=%PYTHONHOME%
set PYTHONHOME=
Expand Down
2 changes: 1 addition & 1 deletion Lib/venv/scripts/posix/activate.csh
Expand Up @@ -19,7 +19,7 @@ setenv VIRTUAL_ENV_PROMPT "__VENV_PROMPT__"
set _OLD_VIRTUAL_PROMPT="$prompt"

if (! "$?VIRTUAL_ENV_DISABLE_PROMPT") then
set prompt = "__VENV_PROMPT__$prompt"
set prompt = "(__VENV_PROMPT__) $prompt"
endif

alias pydoc python -m pydoc
Expand Down
2 changes: 1 addition & 1 deletion Lib/venv/scripts/posix/activate.fish
Expand Up @@ -57,7 +57,7 @@ if test -z "$VIRTUAL_ENV_DISABLE_PROMPT"
set -l old_status $status

# Output the venv prompt; color taken from the blue of the Python logo.
printf "%s%s%s" (set_color 4B8BBE) "__VENV_PROMPT__" (set_color normal)
printf "%s(%s)%s " (set_color 4B8BBE) "__VENV_PROMPT__" (set_color normal)

# Restore the return status of the previous command.
echo "exit $old_status" | .
Expand Down

0 comments on commit 3b1d13f

Please sign in to comment.