Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions Lib/test/test_venv.py
Original file line number Diff line number Diff line change
Expand Up @@ -663,6 +663,34 @@ def test_unoverwritable_fails(self):
self.assertRaises((ValueError, OSError), venv.create, self.env_dir)
self.clear_directory(self.env_dir)

@unittest.skipUnless(can_symlink(), 'Needs symlinks')
def test_clear_symlink_not_followed(self):
# gh-158068: venv --clear must not wipe the contents of a directory
# that env_dir merely points to via a symlink.
target = os.path.join(self.env_dir, 'target')
os.mkdir(target)
keep = os.path.join(target, 'keep')
with open(keep, 'wb') as f:
f.write(b'Still here?')
link = os.path.join(self.env_dir, 'link')
os.symlink(target, link)

with self.assertRaises(ValueError):
venv.create(link, clear=True)
# The symlink target and its content are left untouched.
self.assertTrue(os.path.islink(link))
self.assertTrue(os.path.exists(keep))

def test_clear_file_not_removed(self):
# gh-158068: venv --clear must not treat a regular file as env_dir.
target = os.path.join(self.env_dir, 'afile')
with open(target, 'wb') as f:
f.write(b'Still here?')

with self.assertRaises(ValueError):
venv.create(target, clear=True)
self.assertTrue(os.path.isfile(target))

def test_upgrade(self):
"""
Test upgrading an existing environment directory.
Expand Down
7 changes: 5 additions & 2 deletions Lib/venv/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -149,8 +149,11 @@ def create_if_needed(d):
if os.pathsep in os.fspath(env_dir):
raise ValueError(f'Refusing to create a venv in {env_dir} because '
f'it contains the PATH separator {os.pathsep}.')
if os.path.exists(env_dir) and self.clear:
self.clear_directory(env_dir)
if self.clear:
if os.path.islink(env_dir) or os.path.isfile(env_dir):
raise ValueError('Unable to create directory %r' % env_dir)
if os.path.exists(env_dir):
self.clear_directory(env_dir)
context = types.SimpleNamespace()
context.env_dir = env_dir
context.env_name = os.path.split(env_dir)[1]
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
:mod:`venv` no longer clears the target directory when it is a symlink or a
regular file. Previously ``venv --clear`` followed a symlink and could delete
the contents of the linked directory. It now raises :exc:`ValueError` before
removing anything.
Loading