]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-124113: Clarify venv target directory reuse (#151419)
authorHarjoth Khara <harjoth.khara@gmail.com>
Mon, 22 Jun 2026 14:05:03 +0000 (07:05 -0700)
committerGitHub <noreply@github.com>
Mon, 22 Jun 2026 14:05:03 +0000 (15:05 +0100)
* gh-124113: Clarify venv target directory reuse

* gh-124113: Refine venv reuse wording

* gh-124113: State that --clear also deletes non-venv files

Doc/library/venv.rst

index 8bb267d5a0b9588d7cd7050e116ee0915b46ae05..1ad2401fe2f3f3135db7ed697abbdd979d7e2c24 100644 (file)
@@ -77,6 +77,9 @@ containing a copy or symlink of the Python executable
 It also creates a :file:`lib/pythonX.Y/site-packages` subdirectory
 (on Windows, this is :file:`Lib\\site-packages`).
 If an existing directory is specified, it will be re-used.
+Reusing an existing directory does not leave it unchanged: ``venv`` may create,
+update, or replace files in the target directory. Use a dedicated directory for
+the virtual environment, and avoid placing project files directly inside it.
 
 .. versionchanged:: 3.5
    The use of ``venv`` is now recommended for creating virtual environments.
@@ -126,7 +129,9 @@ The command, if run with ``-h``, will show the available options::
 
 .. option:: --clear
 
-   Delete the contents of the environment directory if it already exists, before environment creation.
+   Delete all contents of the environment directory if it already exists,
+   including files that were not created by ``venv``,
+   before environment creation.
 
 .. option:: --upgrade