virtualenv

Avoid deprecation warning from py-filelock argument - by @ofek . ( #2237 )

Upgrade embedded setuptools to 61.1.0 from 58.3.0 - by @gaborbernat . ( #2240 )

Drop the runtime dependency of backports.entry-points-selectable - by @hroncok . ( #2246 )

Fish: PATH variables should not be quoted when being set - by @d3dave . ( #2248 )

v20.10.0 (2021-11-01)

If a "venv" install scheme exists in sysconfig , virtualenv now uses it to create new virtual environments. This allows Python distributors, such as Fedora, to patch/replace the default install scheme without affecting the paths in new virtual environments. A similar technique was proposed to Python, for the venv module - by hroncok ( #2208 )

The activated virtualenv prompt is now always wrapped in parentheses. This affects venvs created with the --prompt attribute, and matches virtualenv’s behavior on par with venv. ( #2224 )

Special-case --prompt . to the name of the current directory - by @rkm . ( #2220 )

Add libffi-8.dll to pypy windows #2218 - by @mattip

Fixed a bug where while creating a venv on top of an existing one, without cleaning, when seeded wheel version mismatch occurred, multiple .dist-info directories may be present, confounding entrypoint discovery - by @arcivanov ( #2185 )

Bump embed setuptools from 58.0.4 to 58.1.0 - by @gaborbernat . ( #2195 )

Upgrade embedded pip to 21.2.3 from 21.2.2 and wheel to 0.37.0 from 0.36.2 - by @gaborbernat . ( #2168 )

v20.7.1 (2021-08-09)

Fix unpacking dictionary items in PythonInfo.install_path ( #2165 )

v20.7.0 (2021-07-31)

upgrade embedded pip to 21.2.2 from 21.1.3 and setuptools to 57.4.0 from 57.1.0 - by @gaborbernat ( #2159 )

Support Python interpreters without distutils (fallback to syconfig in these cases) - by @gaborbernat . ( #1910 )

v20.5.0 (2021-07-13)

Plugins now use ‘selectable’ entry points - by @jaraco . ( #2093 )

add libffi-7.dll to the hard-coded list of dlls for PyPy ( #2141 )

Use the better maintained platformdirs instead of appdirs - by @gaborbernat . ( #2142 )

Upgrade embedded pip to 21.1.2 and setuptools to 57.0.0 - by @gaborbernat . ( #2123 )

v20.4.6 (2021-05-05)

Fix site.getsitepackages() broken on python2 on debian - by @freundTech . ( #2105 )

v20.4.5 (2021-05-05)

Bump pip to 21.1.1 from 21.0.1 - by @gaborbernat . ( #2104 )

Fix site.getsitepackages() ignoring --system-site-packages on python2 - by @freundTech . ( #2106 )

v20.4.4 (2021-04-20)

Built in discovery class is always preferred over plugin supplied classes. ( #2087 )

Upgrade embedded setuptools to 56.0.0 by @gaborbernat . ( #2094 )

v20.4.3 (2021-03-16)

Bump embedded setuptools from 52.0.0 to 54.1.2 - by @gaborbernat ( #2069 )

Fix PyPy3 stdlib on Windows is incorrect - by @gaborbernat . ( #2071 )

v20.4.2 (2021-02-01)

Running virtualenv --upgrade-embed-wheels crashes - by @gaborbernat . ( #2058 )

v20.4.1 (2021-01-31)

Bump embedded pip and setuptools packages to latest upstream supported ( 21.0.1 and 52.0.0 ) - by @gaborbernat . ( #2060 )

v20.4.0 (2021-01-19)

On the programmatic API allow passing in the environment variable dictionary to use, defaults to os.environ if not specified - by @gaborbernat . ( #2054 )

Bump embed pip to 20.3.3 , setuptools to 51.1.1 and wheel to 0.36.2 - by @gaborbernat . ( #2036 )

Allow unfunctioning of pydoc to fail freely so that virtualenvs can be activated under Zsh with set -e (since otherwise unset -f and unfunction exit with 1 if the function does not exist in Zsh) - by @d125q . ( #2049 )

Drop cached python information if the system executable is no longer present (for example when the executable is a shim and the mapped executable is replaced - such is the case with pyenv) - by @gaborbernat . ( #2050 )

v20.3.0 (2021-01-10)

The builtin discovery takes now a --try-first-with argument and is first attempted as valid interpreters. One can use this to force discovery of a given python executable when the discovery order/mechanism raises errors - by @gaborbernat . ( #2046 )

Bump pip to 20.3.1 , setuptools to 51.0.0 and wheel to 0.36.1 - by @gaborbernat . ( #2029 )

v20.2.1 (2020-11-23)

No significant changes.

v20.2.0 (2020-11-21)

Optionally skip VCS ignore directive for entire virtualenv directory, using option no-vcs-ignore , by default False . ( #2003 )

Add --read-only-app-data option to allow for creation based on an existing app data cache which is non-writable. This may be useful (for example) to produce a docker image where the app-data is pre-populated.

ENV \ VIRTUALENV_OVERRIDE_APP_DATA = /opt/virtualenv/cache \ VIRTUALENV_SYMLINK_APP_DATA = 1 RUN virtualenv venv && rm -rf venv ENV VIRTUALENV_READ_ONLY_APP_DATA = 1 USER nobody # this virtualenv has symlinks into the read-only app-data cache RUN virtualenv /tmp/venv

Patch by @asottile . ( #2009 )

The python specification can now take one or more values, first found is used to create the virtual environment - by @gaborbernat . ( #1995 )

v20.0.35 (2020-10-15)

Bump embedded setuptools from 50.3.0 to 50.3.1 - by @gaborbernat . ( #1982 )

After importing virtualenv passing cwd to a subprocess calls breaks with invalid directory - by @gaborbernat . ( #1983 )

v20.0.34 (2020-10-12)

Align with venv module when creating virtual environments with builtin creator on Windows 3.7 and later - by @gaborbernat . ( #1782 )

Handle Cygwin path conversion in the activation script - by @davidcoghlan . ( #1969 )

v20.0.33 (2020-10-04)

Fix None type error in cygwin if POSIX path in dest - by @danyeaw . ( #1962 )

Fix Python 3.4 incompatibilities (added back to the CI) - by @gaborbernat . ( #1963 )

v20.0.32 (2020-10-01)

For activation scripts always use UNIX line endings (unless it’s BATCH shell related) - by @saytosid . ( #1818 )

Upgrade embedded pip to 20.2.1 and setuptools to 49.4.0 - by @gaborbernat . ( #1918 )

Avoid spawning new windows when doing seed package upgrades in the background on Windows - by @gaborbernat . ( #1928 )

Fix a bug that reading and writing on the same file may cause race on multiple processes. ( #1938 )

Upgrade embedded setuptools to 50.2.0 and pip to 20.2.3 - by @gaborbernat . ( #1939 )

Provide correct path for bash activator in cygwin or msys2 - by @danyeaw . ( #1940 )

Relax importlib requirement to allow version<3 - by @usamasadiq ( #1953 )

pth files were not processed on CPython2 if $PYTHONPATH was pointing to site-packages/ - by @navytux . ( #1959 ) ( #1960 )

v20.0.31 (2020-08-17)

Upgrade embedded pip to 20.2.1 , setuptools to 49.6.0 and wheel to 0.35.1 - by @gaborbernat . ( #1918 )

v20.0.30 (2020-08-04)

Upgrade pip to 20.2.1 and setuptools to 49.2.1 - by @gaborbernat . ( #1915 )

v20.0.29 (2020-07-31)

Upgrade embedded pip from version 20.1.2 to 20.2 - by @gaborbernat . ( #1909 )

v20.0.28 (2020-07-24)

Fix test suite failing if run from system Python - by @gaborbernat . ( #1882 )

Provide setup_logging flag to python API so that users can bypass logging handling if their application already performs this - by @gaborbernat . ( #1896 )

Use \n instead if \r\n as line separator for report (because Python already performs this transformation automatically upon write to the logging pipe) - by @gaborbernat . ( #1905 )

v20.0.27 (2020-07-15)

No longer preimport threading to fix support for gpython and gevent - by @navytux . ( #1897 )

Upgrade setuptools from 49.2.0 on Python 3.5+ - by @gaborbernat . ( #1898 )

v20.0.26 (2020-07-07)

Bump dependency distutils >= 0.3.1 - by @gaborbernat . ( #1880 )

Improve periodic update handling:

better logging output while running and enable logging on background process call ( _VIRTUALENV_PERIODIC_UPDATE_INLINE may be used to debug behavior inline)

fallback to unverified context when querying the PyPi for release date,

stop downloading wheels once we reach the embedded version,

by @gaborbernat . ( #1883 )

Do not print error message if the application exists with SystemExit(0) - by @gaborbernat . ( #1885 )

Upgrade embedded setuptools from 47.3.1 to 49.1.0 for Python 3.5+ - by @gaborbernat . ( #1887 )

v20.0.25 (2020-06-23)

Fix that when the app-data seeders image creation fails the exception is silently ignored. Avoid two virtual environment creations to step on each others toes by using a lock while creating the base images. By @gaborbernat . ( #1869 )

v20.0.24 (2020-06-22)

Ensure that the seeded packages do not get too much out of date:

add a CLI flag that triggers upgrade of embedded wheels under upgrade-embed-wheels

periodically (once every 14 days) upgrade the embedded wheels in a background process, and use them if they have been released for more than 28 days (can be disabled via no-periodic-update )

More details under Wheel acquisition - by @gaborbernat . ( #1821 )

Upgrade embed wheel content:

ship wheels for Python 3.9 and 3.10

upgrade setuptools for Python 3.5+ from 47.1.1 to 47.3.1

by @gaborbernat . ( #1841 )

Display the installed seed package versions in the final summary output, for example:

created virtual environment CPython3.8.3.final.0-64 in 350ms creator CPython3Posix(dest=/x, clear=True, global=False) seeder FromAppData(download=False, pip=bundle, setuptools=bundle, wheel=bundle, via=copy, app_data_dir=/y/virtualenv) added seed packages: pip==20.1.1, setuptools==47.3.1, wheel==0.34.2

by @gaborbernat . ( #1864 )

Fix typo in setup.cfg - by @RowdyHowell . ( #1857 )

v20.0.22 (2020-06-12)

Relax importlib.resources requirement to also allow version 2 - by @asottile . ( #1846 )

Upgrade embedded setuptools to 44.1.1 for python 2 and 47.1.1 for python3.5+ - by @gaborbernat . ( #1855 )

v20.0.21 (2020-05-20)

Generate ignore file for version control systems to avoid tracking virtual environments by default. Users should remove these files if still want to track. For now we support only git by @gaborbernat . ( #1806 )

Fix download fails with python 3.4 - by @gaborbernat . ( #1809 )

Fixes older CPython2 versions use _get_makefile_filename instead of get_makefile_filename on sysconfig - by @ianw . ( #1810 )

Fix download is True by default - by @gaborbernat . ( #1813 )

Fail app-data seed operation when wheel download fails and better error message - by @gaborbernat . ( #1814 )

v20.0.19 (2020-05-03)

Fix generating a Python 2 environment from Python 3 creates invalid python activator - by @gaborbernat . ( #1776 )

Fix pinning seed packages via app-data seeder raised Invalid Requirement - by @gaborbernat . ( #1779 )

Do not stop interpreter discovery if we fail to find the system interpreter for a executable during discovery - by @gaborbernat . ( #1781 )

On CPython2 POSIX platforms ensure syconfig.get_makefile_filename exists within the virtual environment (this is used by some c-extension based libraries - e.g. numpy - for building) - by @gaborbernat . ( #1783 )

Better handling of options copies and symlinks . Introduce priority of where the option is set to follow the order: CLI, env var, file, hardcoded. If both set at same level prefers copy over symlink. - by @gaborbernat . ( #1784 )

Upgrade pip for Python 2.7 and 3.5+ from 20.0.2 to 20.1 - by @gaborbernat . ( #1793 )

Fix CPython is not discovered from Windows registry, and discover pythons from Windows registry in decreasing order by version - by @gaborbernat . ( #1796 )

Fix symlink detection for creators - by @asottile ( #1803 )

v20.0.18 (2020-04-16)

Importing setuptools before cli_run could cause our python information query to fail due to setuptools patching distutils.dist.Distribution - by @gaborbernat . ( #1771 )

v20.0.17 (2020-04-09)

Extend environment variables checked for configuration to also check aliases (e.g. setting either VIRTUALENV_COPIES or VIRTUALENV_ALWAYS_COPY will work) - by @gaborbernat . ( #1763 )

v20.0.16 (2020-04-04)

Allow seed wheel files inside the extra-search-dir folders that do not have Requires-Python metadata specified, these are considered compatible with all python versions - by @gaborbernat . ( #1757 )

v20.0.15 (2020-03-27)

Upgrade embedded setuptools to 46.1.3 from 46.1.1 - by @gaborbernat . ( #1752 )

v20.0.14 (2020-03-25)

Remove PYVENV_LAUNCHER on macOs for Python 3.7.(<8) and 3.8.(<3) on interpreter startup via pth file, this pulls in the upstream patch - by @gaborbernat . ( #1704 )

Upgrade embedded setuptools for Python 3.5+ to 46.1.1 , for Python 2.7 to 44.1.0 - by @gaborbernat . ( #1745 )

Do not fail when the pyc files is missing for the host Python 2 - by @gaborbernat . ( #1738 )

Support broken Packaging pythons that put the include headers under distutils pattern rather than sysconfig one - by @gaborbernat . ( #1739 )

v20.0.12 (2020-03-19)

Fix relative path discovery of interpreters - by @gaborbernat . ( #1734 )

v20.0.11 (2020-03-18)

Improve error message when the host python does not satisfy invariants needed to create virtual environments (now we print which host files are incompatible/missing and for which creators when no supported creator can be matched, however we found creators that can describe the given Python interpreter - will still print no supported creator for Jython, however print exactly what host files do not allow creation of virtual environments in case of CPython/PyPy) - by @gaborbernat . ( #1716 )

Fix acquiring python information might be altered by distutils configuration files generating incorrect layout virtual environments - by @gaborbernat . ( #1663 )

Upgrade embedded setuptools to 46.0.0 from 45.3.0 on Python 3.5+ - by @gaborbernat . ( #1702 )

pythonw.exe works as python.exe on Windows - by @gaborbernat . ( #1686 )

Handle legacy loaders for virtualenv import hooks used to patch distutils configuration load - by @gaborbernat . ( #1690 )

Support for python 2 platforms that store landmark files in platstdlib over stdlib (e.g. RHEL) - by @gaborbernat . ( #1694 )

Upgrade embedded setuptools to 45.3.0 from 45.2.0 for Python 3.5+ - by @gaborbernat . ( #1699 )

v20.0.8 (2020-03-04)

Having distutils configuration files that set prefix and install_scripts cause installation of packages in the wrong location - by @gaborbernat . ( #1663 )

Fix PYTHONPATH being overridden on Python 2 — by @jd . ( #1673 )

Fix list configuration value parsing from config file or environment variable - by @gaborbernat . ( #1674 )

Fix Batch activation script shell prompt to display environment name by default - by @spetafree . ( #1679 )

Fix startup on Python 2 is slower for virtualenv - this was due to setuptools calculating it’s working set distribution - by @gaborbernat . ( #1682 )

Fix entry points are not populated for editable installs on Python 2 due to setuptools working set being calculated before easy_install.pth runs - by @gaborbernat . ( #1684 )

Fix attr: import fails for setuptools - by @gaborbernat . ( #1685 )

v20.0.7 (2020-02-26)

Disable distutils fixup for python 3 until pypa/pip #7778 is fixed and released - by @gaborbernat . ( #1669 )

v20.0.6 (2020-02-26)

Fix global site package always being added with bundled macOs python framework builds - by @gaborbernat . ( #1561 )

Fix generated scripts use host version info rather than target - by @gaborbernat . ( #1600 )

Fix circular prefix reference with single elements (accept these as if they were system executables, print a info about them referencing themselves) - by @gaborbernat . ( #1632 )

Handle the case when the application data folder is read-only:

the application data folder is now controllable via app-data ,

clear-app-data now cleans the entire application data folder, not just the app-data seeder path,

check if the application data path passed in does not exist or is read-only, and fallback to a temporary directory,

temporary directory application data is automatically cleaned up at the end of execution,

symlink-app-data is always False when the application data is temporary

by @gaborbernat . ( #1640 )

Fix PyPy 2 builtin modules are imported from standard library, rather than from builtin - by @gaborbernat . ( #1652 )

Fix creation of entry points when path contains spaces - by @nsoranzo . ( #1660 )

Fix relative paths for the zipapp (for python 3.7+ ) - by @gaborbernat . ( #1666 )

v20.0.5 (2020-02-21)

Also create pythonX.X executables when creating pypy virtualenvs - by @asottile ( #1612 )

Fail with better error message if trying to install source with unsupported setuptools , allow setuptools-scm >= 2 and move to legacy setuptools-scm format to support better older platforms ( CentOS 7 and such) - by @gaborbernat . ( #1621 )

Report of the created virtual environment is now split across four short lines rather than one long - by @gaborbernat ( #1641 )

When aliasing interpreters, use relative symlinks - by @asottile . ( #1596 )

On Python 2 with Apple Framework builds the global site package is no longer added when the system-site-packages is not specified - by @gaborbernat . ( #1561 )

Fix system python discovery mechanism when prefixes contain relative parts (e.g. .. ) by resolving paths within the python information query - by @gaborbernat . ( #1583 )

Expose a programmatic API as from virtualenv import cli_run - by @gaborbernat . ( #1585 )

Fix app-data seeder injects a extra .dist-info.virtualenv path that breaks importlib.metadata , now we inject an extra .virtualenv - by @gaborbernat . ( #1589 )

Print out a one line message about the created virtual environment when no verbose is set, this can now be silenced to get back the original behavior via the quiet flag - by @pradyunsg . ( #1557 )

Allow virtualenv’s app data cache to be overridden by VIRTUALENV_OVERRIDE_APP_DATA - by @asottile . ( #1559 )

Passing in the virtual environment name/path is now required (no longer defaults to venv ) - by @gaborbernat . ( #1568 )

Add a CLI flag with-traceback that allows displaying the stacktrace of the virtualenv when a failure occurs

• by @gaborbernat . ( #1572 )