Release History

v20.0.26 (2020-07-07)

Bugfixes - 20.0.26

  • 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 behaviour 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)

Bugfixes - 20.0.25

  • 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)

Features - 20.0.24

  • 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 Wheels - 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 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)

Bugfixes - 20.0.24

  • Do not generate/overwrite .gitignore if it already exists at destination path - by @gaborbernat. (#1862)

  • Improve error message for no .dist-info inside the app-data copy seeder - by @gaborbernat. (#1867)

Improved Documentation - 20.0.24

v20.0.23 (2020-06-12)

Bugfixes - 20.0.23

v20.0.22 (2020-06-12)

Bugfixes - 20.0.22

  • 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)

Features - 20.0.21

  • 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)

Bugfixes - 20.0.21

  • Fix virtualenv fails sometimes when run concurrently, --clear-app-data conflicts with clear flag when abbreviation is turned on. To bypass this while allowing abbreviated flags on the command line we had to move it to reset-app-data - by @gaborbernat. (#1824)

  • Upgrade embedded setuptools to 46.4.0 from 46.1.3 on Python 3.5+, and pip from 20.1 to 20.1.1 - by @gaborbernat. (#1827)

  • Seeder pip now correctly handles --extra-search-dir - by @frenzymadness. (#1834)

v20.0.20 (2020-05-04)

Bugfixes - 20.0.20

  • 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)

Bugfixes - 20.0.19

  • 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)

Bugfixes - 20.0.18

  • 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)

Features - 20.0.17

  • 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)

Bugfixes - 20.0.16

  • 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)

Features - 20.0.15

v20.0.14 (2020-03-25)

Features - 20.0.14

  • 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)

Bugfixes - 20.0.14

  • Fix discovery of interpreter by name from PATH that does not match a spec format - by @gaborbernat. (#1746)

v20.0.13 (2020-03-19)

Bugfixes - 20.0.13

  • 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)

Bugfixes - 20.0.12

v20.0.11 (2020-03-18)

Features - 20.0.11

  • 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)

Bugfixes - 20.0.11

  • Support Python 3 Framework distributed via XCode in macOs Catalina and before - by @gaborbernat. (#1663)

  • Fix Windows Store Python support, do not allow creation via symlink as that’s not going to work by design - by @gaborbernat. (#1709)

  • Fix throws AttributeError on Windows when virtual environment was created via cross python mechanism - by @gaborbernat. (#1710)

  • Fix --no-pip, --no-setuptools, --no-wheel not being respected - by @gaborbernat. (#1712)

  • Allow missing .py files if a compiled .pyc version is available - by @tucked. (#1714)

  • Do not fail if the distutils/setuptools patch happens on a C-extension loader (such as zipimporter on Python 3.7 or earlier) - by @gaborbernat. (#1715)

  • Support Python 2 implementations that require the landmark files and to be in platform standard library instead of the standard library path of the virtual environment (notably some RHEL ones, such as the Docker image amazonlinux:1) - by @gaborbernat. (#1719)

  • Allow the test suite to pass even when called with the system Python - to help repackaging of the tool for Linux distributions - by @gaborbernat. (#1721)

  • Also generate pipx.y console script beside pip-x.y to be compatible with how pip installs itself - by @gaborbernat. (#1723)

  • Automatically create the application data folder if it does not exists - by @gaborbernat. (#1728)

Improved Documentation - 20.0.11

v20.0.10 (2020-03-10)

Bugfixes - 20.0.10

  • 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)

Improved Documentation - 20.0.10

  • Document requirements (pip + index server) when installing via pip under the installation section - by @gaborbernat. (#1618)

  • Document installing from non PEP-518 systems - @gaborbernat. (#1619)

  • Document installing latest unreleased version from Github - @gaborbernat. (#1620)

v20.0.9 (2020-03-08)

Bugfixes - 20.0.9

  • 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)

Bugfixes - 20.0.8

  • 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)

Bugfixes - 20.0.7

v20.0.6 (2020-02-26)

Bugfixes - 20.0.6

  • 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)

Features - 20.0.5

  • 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)

Bugfixes - 20.0.5

  • Add macOs Python 2 Framework support (now we test it with the CI via brew) - by @gaborbernat (#1561)

  • Fix losing of when the pypy executable is a symlink - by @asottile (#1614)

  • Discover python interpreter in a case insensitive manner - by @PrajwalM2212 (#1624)

  • Fix cross interpreter support when the host python sets sys.base_executable based on __PYVENV_LAUNCHER__ - by @cjolowicz (#1643)

v20.0.4 (2020-02-14)

Features - 20.0.4

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

Bugfixes - 20.0.4

  • Allow the use of / as pathname component separator on Windows - by vphilippon (#1582)

  • Lower minimal version of six required to 1.9 - by ssbarnea (#1606)

v20.0.3 (2020-02-12)

Bugfixes - 20.0.3

  • 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)

Improved Documentation - 20.0.3

v20.0.2 (2020-02-11)

Features - 20.0.2

  • 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 behaviour 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)

Bugfixes - 20.0.2

  • Support long path names for generated virtual environment console entry points (such as pip) when using the app-data seeder - by @gaborbernat. (#997)

  • Improve python discovery mechanism:

    • do not fail if there are executables that fail to query (e.g. for not having execute access to it) on the PATH,

    • beside the prefix folder also try with the platform dependent binary folder within that,

    by @gaborbernat. (#1545)

  • When copying (either files or trees) do not copy the permission bits, last access time, last modification time, and flags as access to these might be forbidden (for example in case of the macOs Framework Python) and these are not needed for the user to use the virtual environment - by @gaborbernat. (#1561)

  • While discovering a python executables interpreters that cannot be queried are now displayed with info level rather than warning, so now they’re no longer shown by default (these can be just executables to which we don’t have access or that are broken, don’t warn if it’s not the target Python we want) - by @gaborbernat. (#1574)

  • The app-data seeder no longer symlinks the packages on UNIX and copies on Windows. Instead by default always copies, however now has the symlink-app-data flag allowing users to request this less robust but faster method - by @gaborbernat. (#1575)

Improved Documentation - 20.0.2

v20.0.1 (2020-02-10)

Features - 20.0.1

  • upgrade embedded setuptools to 45.2.0 from 45.1.0 for Python 3.4+ - by @gaborbernat. (#1554)

Bugfixes - 20.0.1

  • Virtual environments created via relative path on Windows creates bad console executables - by @gaborbernat. (#1552)

  • Seems sometimes venvs created set their base executable to themselves; we accept these without question, so we handle virtual environments as system pythons causing issues - by @gaborbernat. (#1553)

v20.0.0. (2020-02-10)

Improved Documentation - 20.0.0.

  • Fixes typos, repeated words and inconsistent heading spacing. Rephrase parts of the development documentation and CLI documentation. Expands shorthands like env var and config to their full forms. Uses descriptions from respective documentation, for projects listed in related links - by @pradyunsg. (#1540)

v20.0.0b2 (2020-02-04)

Features - 20.0.0b2

  • Improve base executable discovery mechanism:

    • print at debug level why we refuse some candidates,

    • when no candidates match exactly, instead of hard failing fallback to the closest match where the priority of matching attributes is: python implementation, major version, minor version, architecture, patch version, release level and serial (this is to facilitate things to still work when the OS upgrade replace/upgrades the system python with a never version, than what the virtualenv host python was created with),

    • always resolve system_executable information during the interpreter discovery, and the discovered environment is the system interpreter instead of the venv/virtualenv (this happened before lazily the first time we accessed, and caused reporting that the created virtual environment is of type of the virtualenv host python version, instead of the system pythons version - these two can differ if the OS upgraded the system python underneath and the virtualenv host was created via copy),

    by @gaborbernat. (#1515)

  • Generate bash and fish activators on Windows too (as these can be available with git bash, cygwin or mysys2) - by @gaborbernat. (#1527)

  • Upgrade the bundled wheel package from 0.34.0 to 0.34.2 - by @gaborbernat. (#1531)

Bugfixes - 20.0.0b2

  • Bash activation script should have no extensions instead of .sh (this fixes the virtualenvwrapper integration) - by @gaborbernat. (#1508)

  • Show less information when we run with a single verbosity (-v):

    • no longer shows accepted interpreters information (as the last proposed one is always the accepted one),

    • do not display the str_spec attribute for PythonSpec as these can be deduced from the other attributes,

    • for the app-data seeder do not show the type of lock, only the path to the app data directory,

    By @gaborbernat. (#1510)

  • Fixed cannot discover a python interpreter that has already been discovered under a different path (such is the case when we have multiple symlinks to the same interpreter) - by @gaborbernat. (#1512)

  • Support relative paths for -p - by @gaborbernat. (#1514)

  • Creating virtual environments in parallel fail with cannot acquire lock within app data - by @gaborbernat. (#1516)

  • pth files were not processed under Debian CPython2 interpreters - by @gaborbernat. (#1517)

  • Fix prompt not displayed correctly with upcoming fish 3.10 due to us not preserving $pipestatus - by @krobelus. (#1530)

  • Stable order within pyenv.cfg and add include-system-site-packages only for creators that reference a global Python - by user:gaborbernat. (#1535)

Improved Documentation - 20.0.0b2

  • Create the first iteration of the new documentation - by @gaborbernat. (#1465)

  • Project readme is now of type MarkDown instead of reStructuredText - by @gaborbernat. (#1531)

v20.0.0b1 (2020-01-28)

  • First public release of the rewrite. Everything is brand new and just added.

  • --download defaults to False


The current virtualenv is the second iteration of implementation. From version 0.8 all the way to 16.7.9 we numbered the first iteration. Version 20.0.0b1 is a complete rewrite of the package, and as such this release history starts from there. The old changelog is still available in the legacy branch documentation.