languages/cpython
languages/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython synced 2024-10-14 16:37:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

gh-88452: Add a warning about non-portability of environments. (GH-98155)

Browse source
This commit is contained in:
Vinay Sajip 2022-10-10 19:27:52 +01:00 committed by GitHub
parent 553d3c1017
commit 6a757da080
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
Doc/library/venv.rst
View file

@ -85,6 +85,19 @@ Creating virtual environments
without there needing to be any reference to its virtual environment in
``PATH``.
.. warning:: Because scripts installed in environments should not expect the
environment to be activated, their shebang lines contain the absolute paths
to their environment's interpreters. Because of this, environments are
inherently non-portable, in the general case. You should always have a
simple means of recreating an environment (for example, if you have a
requirements file ``requirements.txt``, you can invoke ``pip install -r
requirements.txt`` using the environment's ``pip`` to install all of the
packages needed by the environment). If for any reason you need to move the
environment to a new location, you should recreate it at the desired
location and delete the one at the old location. If you move an environment
because you moved a parent directory of it, you should recreate the
environment in its new location. Otherwise, software installed into the
environment may not work as expected.
.. _venv-api: