Gecko [ fernandoquevedodop.com ]

Name	Size	Permission
2to3.html	70.96 KB	-rw-r--r--
__future__.html	20.75 KB	-rw-r--r--
__main__.html	44.87 KB	-rw-r--r--
_thread.html	30.39 KB	-rw-r--r--
abc.html	46.87 KB	-rw-r--r--
aifc.html	35.56 KB	-rw-r--r--
allos.html	34.33 KB	-rw-r--r--
archiving.html	17 KB	-rw-r--r--
argparse.html	300.89 KB	-rw-r--r--
array.html	37.28 KB	-rw-r--r--
ast.html	293.08 KB	-rw-r--r--
asynchat.html	37.41 KB	-rw-r--r--
asyncio-api-index.html	27.68 KB	-rw-r--r--
asyncio-dev.html	36.1 KB	-rw-r--r--
asyncio-eventloop.html	204.43 KB	-rw-r--r--
asyncio-exceptions.html	17.11 KB	-rw-r--r--
asyncio-future.html	38.23 KB	-rw-r--r--
asyncio-llapi-index.html	61.97 KB	-rw-r--r--
asyncio-platforms.html	21.77 KB	-rw-r--r--
asyncio-policy.html	39.56 KB	-rw-r--r--
asyncio-protocol.html	118.33 KB	-rw-r--r--
asyncio-queue.html	31.86 KB	-rw-r--r--
asyncio-stream.html	69.98 KB	-rw-r--r--
asyncio-subprocess.html	49.25 KB	-rw-r--r--
asyncio-sync.html	42.79 KB	-rw-r--r--
asyncio-task.html	109.14 KB	-rw-r--r--
asyncio.html	17.31 KB	-rw-r--r--
asyncore.html	49.36 KB	-rw-r--r--
atexit.html	22.87 KB	-rw-r--r--
audioop.html	46 KB	-rw-r--r--
audit_events.html	72.85 KB	-rw-r--r--
base64.html	48.09 KB	-rw-r--r--
bdb.html	66 KB	-rw-r--r--
binary.html	15.97 KB	-rw-r--r--
binascii.html	36.3 KB	-rw-r--r--
binhex.html	15.97 KB	-rw-r--r--
bisect.html	43.38 KB	-rw-r--r--
builtins.html	14.87 KB	-rw-r--r--
bz2.html	50.68 KB	-rw-r--r--
calendar.html	69.35 KB	-rw-r--r--
cgi.html	59.95 KB	-rw-r--r--
cgitb.html	19.96 KB	-rw-r--r--
chunk.html	22.21 KB	-rw-r--r--
cmath.html	43.89 KB	-rw-r--r--
cmd.html	50.42 KB	-rw-r--r--
code.html	35.38 KB	-rw-r--r--
codecs.html	157.96 KB	-rw-r--r--
codeop.html	18.26 KB	-rw-r--r--
collections.abc.html	79.17 KB	-rw-r--r--
collections.html	189.43 KB	-rw-r--r--
colorsys.html	17.31 KB	-rw-r--r--
compileall.html	50.68 KB	-rw-r--r--
concurrency.html	24.15 KB	-rw-r--r--
concurrent.futures.html	79.03 KB	-rw-r--r--
concurrent.html	11.56 KB	-rw-r--r--
configparser.html	159.4 KB	-rw-r--r--
constants.html	22.41 KB	-rw-r--r--
contextlib.html	117.2 KB	-rw-r--r--
contextvars.html	38.38 KB	-rw-r--r--
copy.html	17.92 KB	-rw-r--r--
copyreg.html	18.63 KB	-rw-r--r--
crypt.html	28.29 KB	-rw-r--r--
crypto.html	13.93 KB	-rw-r--r--
csv.html	82.89 KB	-rw-r--r--
ctypes.html	295.49 KB	-rw-r--r--
curses.ascii.html	32.04 KB	-rw-r--r--
curses.html	221.24 KB	-rw-r--r--
curses.panel.html	22.16 KB	-rw-r--r--
custominterp.html	11.85 KB	-rw-r--r--
dataclasses.html	113.16 KB	-rw-r--r--
datatypes.html	31.82 KB	-rw-r--r--
datetime.html	374.92 KB	-rw-r--r--
dbm.html	51.16 KB	-rw-r--r--
debug.html	17 KB	-rw-r--r--
decimal.html	270.12 KB	-rw-r--r--
development.html	32.34 KB	-rw-r--r--
devmode.html	31.72 KB	-rw-r--r--
dialog.html	43.03 KB	-rw-r--r--
difflib.html	111.99 KB	-rw-r--r--
dis.html	136.07 KB	-rw-r--r--
distribution.html	13.67 KB	-rw-r--r--
distutils.html	14.73 KB	-rw-r--r--
doctest.html	199.32 KB	-rw-r--r--
email.charset.html	31.92 KB	-rw-r--r--
email.compat32-message.html	97.74 KB	-rw-r--r--
email.contentmanager.html	37.02 KB	-rw-r--r--
email.encoders.html	18.47 KB	-rw-r--r--
email.errors.html	24.45 KB	-rw-r--r--
email.examples.html	60.49 KB	-rw-r--r--
email.generator.html	48.79 KB	-rw-r--r--
email.header.html	37.61 KB	-rw-r--r--
email.headerregistry.html	66.26 KB	-rw-r--r--
email.html	30.75 KB	-rw-r--r--
email.iterators.html	18.23 KB	-rw-r--r--
email.message.html	99.75 KB	-rw-r--r--
email.mime.html	44.89 KB	-rw-r--r--
email.parser.html	57.39 KB	-rw-r--r--
email.policy.html	84.24 KB	-rw-r--r--
email.utils.html	42.57 KB	-rw-r--r--
ensurepip.html	23.9 KB	-rw-r--r--
enum.html	151 KB	-rw-r--r--
errno.html	60.17 KB	-rw-r--r--
exceptions.html	108.44 KB	-rw-r--r--
faulthandler.html	31.5 KB	-rw-r--r--
fcntl.html	36.67 KB	-rw-r--r--
filecmp.html	32.08 KB	-rw-r--r--
fileformats.html	13.52 KB	-rw-r--r--
fileinput.html	40.37 KB	-rw-r--r--
filesys.html	16.78 KB	-rw-r--r--
fnmatch.html	21.02 KB	-rw-r--r--
fractions.html	35.29 KB	-rw-r--r--
frameworks.html	16.15 KB	-rw-r--r--
ftplib.html	71.97 KB	-rw-r--r--
functional.html	12.19 KB	-rw-r--r--
functions.html	260.33 KB	-rw-r--r--
functools.html	92.96 KB	-rw-r--r--
gc.html	40.97 KB	-rw-r--r--
getopt.html	29.4 KB	-rw-r--r--
getpass.html	16.01 KB	-rw-r--r--
gettext.html	98.02 KB	-rw-r--r--
glob.html	27.2 KB	-rw-r--r--
graphlib.html	34.82 KB	-rw-r--r--
grp.html	16.03 KB	-rw-r--r--
gzip.html	45.65 KB	-rw-r--r--
hashlib.html	93.19 KB	-rw-r--r--
heapq.html	42.43 KB	-rw-r--r--
hmac.html	24.74 KB	-rw-r--r--
html.entities.html	14.91 KB	-rw-r--r--
html.html	14.81 KB	-rw-r--r--
html.parser.html	47.7 KB	-rw-r--r--
http.client.html	85.63 KB	-rw-r--r--
http.cookiejar.html	113.94 KB	-rw-r--r--
http.cookies.html	47.64 KB	-rw-r--r--
http.html	45.52 KB	-rw-r--r--
http.server.html	73.05 KB	-rw-r--r--
i18n.html	13.44 KB	-rw-r--r--
idle.html	77.18 KB	-rw-r--r--
imaplib.html	87.08 KB	-rw-r--r--
imghdr.html	17.94 KB	-rw-r--r--
imp.html	54.32 KB	-rw-r--r--
importlib.html	239.96 KB	-rw-r--r--
importlib.metadata.html	43.14 KB	-rw-r--r--
index.html	75.06 KB	-rw-r--r--
inspect.html	168.74 KB	-rw-r--r--
internet.html	29.89 KB	-rw-r--r--
intro.html	13.81 KB	-rw-r--r--
io.html	154.15 KB	-rw-r--r--
ipaddress.html	137.75 KB	-rw-r--r--
ipc.html	12.6 KB	-rw-r--r--
itertools.html	153.27 KB	-rw-r--r--
json.html	98.9 KB	-rw-r--r--
keyword.html	14.88 KB	-rw-r--r--
language.html	16.71 KB	-rw-r--r--
linecache.html	18.09 KB	-rw-r--r--
locale.html	77.35 KB	-rw-r--r--
logging.config.html	100.3 KB	-rw-r--r--
logging.handlers.html	146.28 KB	-rw-r--r--
logging.html	169.67 KB	-rw-r--r--
lzma.html	66.89 KB	-rw-r--r--
mailbox.html	176.34 KB	-rw-r--r--
mailcap.html	20.86 KB	-rw-r--r--
markup.html	22.31 KB	-rw-r--r--
marshal.html	24.43 KB	-rw-r--r--
math.html	85.82 KB	-rw-r--r--
mimetypes.html	40.27 KB	-rw-r--r--
mm.html	11.16 KB	-rw-r--r--
mmap.html	55.53 KB	-rw-r--r--
modulefinder.html	23.67 KB	-rw-r--r--
modules.html	15.88 KB	-rw-r--r--
msilib.html	78.38 KB	-rw-r--r--
msvcrt.html	29.22 KB	-rw-r--r--
multiprocessing.html	405.24 KB	-rw-r--r--
multiprocessing.shared_memory....	60 KB	-rw-r--r--
netdata.html	20.24 KB	-rw-r--r--
netrc.html	20.39 KB	-rw-r--r--
nis.html	16.76 KB	-rw-r--r--
nntplib.html	84.93 KB	-rw-r--r--
numbers.html	45.67 KB	-rw-r--r--
numeric.html	19.29 KB	-rw-r--r--
operator.html	107.32 KB	-rw-r--r--
optparse.html	256.96 KB	-rw-r--r--
os.html	594.39 KB	-rw-r--r--
os.path.html	65.54 KB	-rw-r--r--
ossaudiodev.html	56.35 KB	-rw-r--r--
pathlib.html	170.01 KB	-rw-r--r--
pdb.html	68.67 KB	-rw-r--r--
persistence.html	19.13 KB	-rw-r--r--
pickle.html	154.45 KB	-rw-r--r--
pickletools.html	22.92 KB	-rw-r--r--
pipes.html	21.7 KB	-rw-r--r--
pkgutil.html	42.76 KB	-rw-r--r--
platform.html	45.08 KB	-rw-r--r--
plistlib.html	30.06 KB	-rw-r--r--
poplib.html	41.42 KB	-rw-r--r--
posix.html	20.96 KB	-rw-r--r--
pprint.html	55.35 KB	-rw-r--r--
profile.html	84.63 KB	-rw-r--r--
pty.html	23.7 KB	-rw-r--r--
pwd.html	16.84 KB	-rw-r--r--
py_compile.html	29 KB	-rw-r--r--
pyclbr.html	24.06 KB	-rw-r--r--
pydoc.html	19.59 KB	-rw-r--r--
pyexpat.html	104.38 KB	-rw-r--r--
python.html	22.46 KB	-rw-r--r--
queue.html	43.39 KB	-rw-r--r--
quopri.html	18.64 KB	-rw-r--r--
random.html	86.31 KB	-rw-r--r--
re.html	214.24 KB	-rw-r--r--
readline.html	50.19 KB	-rw-r--r--
reprlib.html	30.85 KB	-rw-r--r--
resource.html	48.26 KB	-rw-r--r--
rlcompleter.html	18.06 KB	-rw-r--r--
runpy.html	30.99 KB	-rw-r--r--
sched.html	27.04 KB	-rw-r--r--
secrets.html	30.2 KB	-rw-r--r--
security_warnings.html	16.21 KB	-rw-r--r--
select.html	74.58 KB	-rw-r--r--
selectors.html	41.91 KB	-rw-r--r--
shelve.html	36.54 KB	-rw-r--r--
shlex.html	61.03 KB	-rw-r--r--
shutil.html	100.13 KB	-rw-r--r--
signal.html	95.39 KB	-rw-r--r--
site.html	38.16 KB	-rw-r--r--
smtpd.html	44.09 KB	-rw-r--r--
smtplib.html	81.4 KB	-rw-r--r--
sndhdr.html	16.4 KB	-rw-r--r--
socket.html	256.95 KB	-rw-r--r--
socketserver.html	91.95 KB	-rw-r--r--
spwd.html	16.71 KB	-rw-r--r--
sqlite3.html	225.51 KB	-rw-r--r--
ssl.html	328.83 KB	-rw-r--r--
stat.html	57.79 KB	-rw-r--r--
statistics.html	123.22 KB	-rw-r--r--
stdtypes.html	615.43 KB	-rw-r--r--
string.html	108.03 KB	-rw-r--r--
stringprep.html	24.94 KB	-rw-r--r--
struct.html	70.58 KB	-rw-r--r--
subprocess.html	199.03 KB	-rw-r--r--
sunau.html	39.84 KB	-rw-r--r--
superseded.html	26.21 KB	-rw-r--r--
symtable.html	33.26 KB	-rw-r--r--
sys.html	198.83 KB	-rw-r--r--
sysconfig.html	39.81 KB	-rw-r--r--
syslog.html	27.36 KB	-rw-r--r--
tabnanny.html	16.18 KB	-rw-r--r--
tarfile.html	161.92 KB	-rw-r--r--
telnetlib.html	38.21 KB	-rw-r--r--
tempfile.html	58.39 KB	-rw-r--r--
termios.html	22.86 KB	-rw-r--r--
test.html	222.85 KB	-rw-r--r--
text.html	16.8 KB	-rw-r--r--
textwrap.html	48.83 KB	-rw-r--r--
threading.html	128.33 KB	-rw-r--r--
time.html	107.46 KB	-rw-r--r--
timeit.html	52.63 KB	-rw-r--r--
tk.html	28.08 KB	-rw-r--r--
tkinter.colorchooser.html	14.49 KB	-rw-r--r--
tkinter.dnd.html	17.09 KB	-rw-r--r--
tkinter.font.html	22.21 KB	-rw-r--r--
tkinter.html	106.85 KB	-rw-r--r--
tkinter.messagebox.html	20.09 KB	-rw-r--r--
tkinter.scrolledtext.html	14.52 KB	-rw-r--r--
tkinter.tix.html	59.69 KB	-rw-r--r--
tkinter.ttk.html	138.37 KB	-rw-r--r--
token.html	45.73 KB	-rw-r--r--
tokenize.html	39.86 KB	-rw-r--r--
trace.html	38.85 KB	-rw-r--r--
traceback.html	75.61 KB	-rw-r--r--
tracemalloc.html	122.33 KB	-rw-r--r--
tty.html	14.46 KB	-rw-r--r--
turtle.html	271.71 KB	-rw-r--r--
types.html	64.85 KB	-rw-r--r--
typing.html	315.69 KB	-rw-r--r--
unicodedata.html	27.3 KB	-rw-r--r--
unittest.html	310.01 KB	-rw-r--r--
unittest.mock-examples.html	177.75 KB	-rw-r--r--
unittest.mock.html	363.51 KB	-rw-r--r--
unix.html	13.46 KB	-rw-r--r--
urllib.error.html	18.56 KB	-rw-r--r--
urllib.html	12.92 KB	-rw-r--r--
urllib.parse.html	104.65 KB	-rw-r--r--
urllib.request.html	208.87 KB	-rw-r--r--
urllib.robotparser.html	22.63 KB	-rw-r--r--
uu.html	18.2 KB	-rw-r--r--
uuid.html	42.88 KB	-rw-r--r--
venv.html	90.43 KB	-rw-r--r--
warnings.html	69.13 KB	-rw-r--r--
wave.html	36.12 KB	-rw-r--r--
weakref.html	73.36 KB	-rw-r--r--
webbrowser.html	33.98 KB	-rw-r--r--
windows.html	12.32 KB	-rw-r--r--
winreg.html	89.48 KB	-rw-r--r--
winsound.html	26.3 KB	-rw-r--r--
wsgiref.html	111.52 KB	-rw-r--r--
xdrlib.html	42.07 KB	-rw-r--r--
xml.dom.html	114.66 KB	-rw-r--r--
xml.dom.minidom.html	49.6 KB	-rw-r--r--
xml.dom.pulldom.html	30.06 KB	-rw-r--r--
xml.etree.elementtree.html	186.49 KB	-rw-r--r--
xml.html	22.34 KB	-rw-r--r--
xml.sax.handler.html	55.78 KB	-rw-r--r--
xml.sax.html	31.74 KB	-rw-r--r--
xml.sax.reader.html	56.23 KB	-rw-r--r--
xml.sax.utils.html	22.28 KB	-rw-r--r--
xmlrpc.client.html	79.73 KB	-rw-r--r--
xmlrpc.html	11.9 KB	-rw-r--r--
xmlrpc.server.html	63.56 KB	-rw-r--r--
zipapp.html	52.45 KB	-rw-r--r--
zipfile.html	116.59 KB	-rw-r--r--
zipimport.html	33.76 KB	-rw-r--r--
zlib.html	42.29 KB	-rw-r--r--
zoneinfo.html	57.25 KB	-rw-r--r--

Code Editor : venv.html

<!DOCTYPE html>

<title>venv — Creation of virtual environments &#8212; Python 3.10.12 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
 
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
 <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?2022.1" />
 
 <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
 <script src="../_static/jquery.js"></script>
 <script src="../_static/underscore.js"></script>
 <script src="../_static/doctools.js"></script>
 
 <script src="../_static/sidebar.js"></script>
 
 <link rel="search" type="application/opensearchdescription+xml"
 title="Search within Python 3.10.12 documentation"
 href="../_static/opensearch.xml"/>
 <link rel="author" title="About these documents" href="../about.html" />
 <link rel="index" title="Index" href="../genindex.html" />
 <link rel="search" title="Search" href="../search.html" />
 <link rel="copyright" title="Copyright" href="../copyright.html" />
 <link rel="next" title="zipapp — Manage executable Python zip archives" href="zipapp.html" />
 <link rel="prev" title="ensurepip — Bootstrapping the pip installer" href="ensurepip.html" />
 <link rel="canonical" href="file:///usr/share/doc/python3.10/html/library/venv.html" />

</head>
<body>
<div class="mobile-nav">
 <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"
 aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />
 <label for="menuToggler" class="toggler__label">
 
 </label>
 <nav class="nav-content" role="navigation">
 <a href="https://www.python.org/" class="nav-logo">
 <img src="../_static/py.svg" alt="Logo"/>
 </a>
 <div class="version_switcher_placeholder"></div>
 <form role="search" class="search" action="../search.html" method="get">
 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">
 <path fill-rule="nonzero"
 d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z" fill="#444"></path>
 </svg>
 <input type="text" name="q" aria-label="Quick search"/>
 <input type="submit" value="Go"/>
 </form>
 </nav>
 <div class="menu-wrapper">
 <nav class="menu" role="navigation" aria-label="main navigation">
 <div class="language_switcher_placeholder"></div>
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate">venv</code> — Creation of virtual environments</a><ul>
<li><a class="reference internal" href="#creating-virtual-environments">Creating virtual environments</a></li>
<li><a class="reference internal" href="#how-venvs-work">How venvs work</a></li>
<li><a class="reference internal" href="#api">API</a></li>
<li><a class="reference internal" href="#an-example-of-extending-envbuilder">An example of extending <code class="docutils literal notranslate">EnvBuilder</code></a></li>
</ul>
</li>
</ul>

<div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 accesskey="I">index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="zipapp.html" title="zipapp — Manage executable Python zip archives"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="ensurepip.html" title="ensurepip — Bootstrapping the pip installer"
 accesskey="P">previous</a> |</li>

<li><img src="../_static/py.svg" alt="python logo" style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li class="switchers">
 <div class="language_switcher_placeholder"></div>
 <div class="version_switcher_placeholder"></div>
 </li>
 <li>
 
 </li>
 <li id="cpython-language-and-version">
 <a href="../index.html">3.10.12 Documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="distribution.html" accesskey="U">Software Packaging and Distribution</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate">venv</code> — Creation of virtual environments</a></li>
 <li class="right">

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="module-venv">
<h1><a class="reference internal" href="#module-venv" title="venv: Creation of virtual environments."><code class="xref py py-mod docutils literal notranslate">venv</code></a> — Creation of virtual environments<a class="headerlink" href="#module-venv" title="Permalink to this headline">¶</a></h1>
<div class="versionadded">
New in version 3.3.
</div>
Source code: <a class="reference external" href="https://github.com/python/cpython/tree/3.10/Lib/venv/">Lib/venv/</a>
<hr class="docutils" id="index-0" />
The <code class="xref py py-mod docutils literal notranslate">venv</code> module supports creating lightweight “virtual environments”,
each with their own independent set of Python packages installed in
their <a class="reference internal" href="site.html#module-site" title="site: Module responsible for site-specific configuration."><code class="xref py py-mod docutils literal notranslate">site</code></a> directories.
A virtual environment is created on top of an existing
Python installation, known as the virtual environment’s “base” Python, and may
optionally be isolated from the packages in the base environment,
so only those explicitly installed in the virtual environment are available.
When used from within a virtual environment, common installation tools such as
<a class="reference external" href="https://pypi.org/project/pip/">pip</a> will install Python packages into a virtual environment
without needing to be told to do so explicitly.
See <a class="pep reference external" href="https://www.python.org/dev/peps/pep-0405">PEP 405</a> for more background on Python virtual environments.
<div class="admonition seealso">
See also
<a class="reference external" href="https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/#creating-a-virtual-environment">Python Packaging User Guide: Creating and using virtual environments</a>
</div>
<section id="creating-virtual-environments">
<h2>Creating virtual environments<a class="headerlink" href="#creating-virtual-environments" title="Permalink to this headline">¶</a></h2>
Creation of <a class="reference internal" href="#venv-def">virtual environments</a> is done by executing the
command <code class="docutils literal notranslate">venv</code>:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>python -m venv /path/to/new/virtual/environment
</pre></div>
</div>
Running this command creates the target directory (creating any parent
directories that don’t exist already) and places a <code class="docutils literal notranslate">pyvenv.cfg</code> file in it
with a <code class="docutils literal notranslate">home</code> key pointing to the Python installation from which the command
was run (a common name for the target directory is <code class="docutils literal notranslate">.venv</code>). It also creates
a <code class="docutils literal notranslate">bin</code> (or <code class="docutils literal notranslate">Scripts</code> on Windows) subdirectory containing a copy/symlink
of the Python binary/binaries (as appropriate for the platform or arguments
used at environment creation time). It also creates an (initially empty)
<code class="docutils literal notranslate">lib/pythonX.Y/site-packages</code> subdirectory (on Windows, this is
<code class="docutils literal notranslate">Lib\site-packages</code>). If an existing directory is specified, it will be
re-used.
<div class="deprecated">
Deprecated since version 3.6: <code class="docutils literal notranslate">pyvenv</code> was the recommended tool for creating virtual environments for
Python 3.3 and 3.4, and is
<a class="reference internal" href="../whatsnew/3.6.html#whatsnew36-venv">deprecated in Python 3.6</a>.
</div>
<div class="versionchanged">
Changed in version 3.5: The use of <code class="docutils literal notranslate">venv</code> is now recommended for creating virtual environments.
</div>
On Windows, invoke the <code class="docutils literal notranslate">venv</code> command as follows:
<div class="highlight-none notranslate"><div class="highlight"><pre>c:\&gt;c:\Python35\python -m venv c:\path\to\myenv
</pre></div>
</div>
Alternatively, if you configured the <code class="docutils literal notranslate">PATH</code> and <code class="docutils literal notranslate">PATHEXT</code> variables for
your <a class="reference internal" href="../using/windows.html#using-on-windows">Python installation</a>:
<div class="highlight-none notranslate"><div class="highlight"><pre>c:\&gt;python -m venv c:\path\to\myenv
</pre></div>
</div>
The command, if run with <code class="docutils literal notranslate">-h</code>, will show the available options:
<div class="highlight-none notranslate"><div class="highlight"><pre>usage: venv [-h] [--system-site-packages] [--symlinks | --copies] [--clear]
 [--upgrade] [--without-pip] [--prompt PROMPT] [--upgrade-deps]
 ENV_DIR [ENV_DIR ...]

Creates virtual Python environments in one or more target directories.

positional arguments:
  ENV_DIR               A directory to create the environment in.

optional arguments:
  -h, --help            show this help message and exit
  --system-site-packages
                        Give the virtual environment access to the system
                        site-packages dir.
  --symlinks            Try to use symlinks rather than copies, when symlinks
                        are not the default for the platform.
  --copies              Try to use copies rather than symlinks, even when
                        symlinks are the default for the platform.
  --clear               Delete the contents of the environment directory if it
                        already exists, before environment creation.
  --upgrade             Upgrade the environment directory to use this version
                        of Python, assuming Python has been upgraded in-place.
  --without-pip         Skips installing or upgrading pip in the virtual
                        environment (pip is bootstrapped by default)
  --prompt PROMPT       Provides an alternative prompt prefix for this
                        environment.
  --upgrade-deps        Upgrade core dependencies: pip setuptools to the
                        latest version in PyPI

Once an environment has been created, you may wish to activate it, e.g. by
sourcing an activate script in its bin directory.
</pre></div>
</div>
<div class="versionchanged">
Changed in version 3.9: Add <code class="docutils literal notranslate">--upgrade-deps</code> option to upgrade pip + setuptools to the latest on PyPI
</div>
<div class="versionchanged">
Changed in version 3.4: Installs pip by default, added the <code class="docutils literal notranslate">--without-pip</code> and <code class="docutils literal notranslate">--copies</code>
options
</div>
<div class="versionchanged">
Changed in version 3.4: In earlier versions, if the target directory already existed, an error was
raised, unless the <code class="docutils literal notranslate">--clear</code> or <code class="docutils literal notranslate">--upgrade</code> option was provided.
</div>
<div class="admonition note">
Note
While symlinks are supported on Windows, they are not recommended. Of
particular note is that double-clicking <code class="docutils literal notranslate">python.exe</code> in File Explorer
will resolve the symlink eagerly and ignore the virtual environment.
</div>
<div class="admonition note">
Note
On Microsoft Windows, it may be required to enable the <code class="docutils literal notranslate">Activate.ps1</code>
script by setting the execution policy for the user. You can do this by
issuing the following PowerShell command:
PS C:&gt; Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
See <a class="reference external" href="https://go.microsoft.com/fwlink/?LinkID=135170">About Execution Policies</a>
for more information.
</div>
The created <code class="docutils literal notranslate">pyvenv.cfg</code> file also includes the
<code class="docutils literal notranslate">include-system-site-packages</code> key, set to <code class="docutils literal notranslate">true</code> if <code class="docutils literal notranslate">venv</code> is
run with the <code class="docutils literal notranslate">--system-site-packages</code> option, <code class="docutils literal notranslate">false</code> otherwise.
Unless the <code class="docutils literal notranslate">--without-pip</code> option is given, <a class="reference internal" href="ensurepip.html#module-ensurepip" title="ensurepip: Bootstrapping the &quot;pip&quot; installer into an existing Python installation or virtual environment."><code class="xref py py-mod docutils literal notranslate">ensurepip</code></a> will be
invoked to bootstrap <code class="docutils literal notranslate">pip</code> into the virtual environment.
Multiple paths can be given to <code class="docutils literal notranslate">venv</code>, in which case an identical virtual
environment will be created, according to the given options, at each provided
path.
</section>
<section id="how-venvs-work">
<h2>How venvs work<a class="headerlink" href="#how-venvs-work" title="Permalink to this headline">¶</a></h2>
When a Python interpreter is running from a virtual environment,
<a class="reference internal" href="sys.html#sys.prefix" title="sys.prefix"><code class="xref py py-data docutils literal notranslate">sys.prefix</code></a> and <a class="reference internal" href="sys.html#sys.exec_prefix" title="sys.exec_prefix"><code class="xref py py-data docutils literal notranslate">sys.exec_prefix</code></a>
point to the directories of the virtual environment,
whereas <a class="reference internal" href="sys.html#sys.base_prefix" title="sys.base_prefix"><code class="xref py py-data docutils literal notranslate">sys.base_prefix</code></a> and <a class="reference internal" href="sys.html#sys.base_exec_prefix" title="sys.base_exec_prefix"><code class="xref py py-data docutils literal notranslate">sys.base_exec_prefix</code></a>
point to those of the base Python used to create the environment.
It is sufficient to check
<code class="docutils literal notranslate">sys.prefix == sys.base_prefix</code> to determine if the current interpreter is
running from a virtual environment.
A virtual environment may be “activated” using a script in its binary directory
(<code class="docutils literal notranslate">bin</code> on POSIX; <code class="docutils literal notranslate">Scripts</code> on Windows).
This will prepend that directory to your <code class="xref std std-envvar docutils literal notranslate">PATH</code>, so that running
python will invoke the environment’s Python interpreter
and you can run installed scripts without having to use their full path.
The invocation of the activation script is platform-specific
(<code class="samp docutils literal notranslate">&lt;venv&gt;</code> must be replaced by the path to the directory
containing the virtual environment):
<table class="docutils align-default">
<colgroup>
<col style="width: 17%" />
<col style="width: 16%" />
<col style="width: 67%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head">Platform</th>
<th class="head">Shell</th>
<th class="head">Command to activate virtual environment</th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td rowspan="4">POSIX</td>
<td>bash/zsh</td>
<td><code class="samp docutils literal notranslate">$ source &lt;venv&gt;/bin/activate</code></td>
</tr>
<tr class="row-odd"><td>fish</td>
<td><code class="samp docutils literal notranslate">$ source &lt;venv&gt;/bin/activate.fish</code></td>
</tr>
<tr class="row-even"><td>csh/tcsh</td>
<td><code class="samp docutils literal notranslate">$ source &lt;venv&gt;/bin/activate.csh</code></td>
</tr>
<tr class="row-odd"><td>PowerShell</td>
<td><code class="samp docutils literal notranslate">$ &lt;venv&gt;/bin/Activate.ps1</code></td>
</tr>
<tr class="row-even"><td rowspan="2">Windows</td>
<td>cmd.exe</td>
<td><code class="samp docutils literal notranslate">C:\&gt; &lt;venv&gt;\Scripts\activate.bat</code></td>
</tr>
<tr class="row-odd"><td>PowerShell</td>
<td><code class="samp docutils literal notranslate">PS C:\&gt; &lt;venv&gt;\Scripts\Activate.ps1</code></td>
</tr>
</tbody>
</table>
<div class="versionadded">
New in version 3.4: fish and csh activation scripts.
</div>
<div class="versionadded">
New in version 3.8: PowerShell activation scripts installed under POSIX for PowerShell Core
support.
</div>
You don’t specifically need to activate a virtual environment,
as you can just specify the full path to that environment’s
Python interpreter when invoking Python.
Furthermore, all scripts installed in the environment
should be runnable without activating it.
In order to achieve this, scripts installed into virtual environments have
a “shebang” line which points to the environment’s Python interpreter,
i.e. <code class="samp docutils literal notranslate">#!/&lt;path-to-venv&gt;/bin/python</code>.
This means that the script will run with that interpreter regardless of the
value of <code class="xref std std-envvar docutils literal notranslate">PATH</code>. On Windows, “shebang” line processing is supported if
you have the <a class="reference internal" href="../using/windows.html#launcher">Python Launcher for Windows</a> installed. Thus, double-clicking an installed
script in a Windows Explorer window should run it with the correct interpreter
without the environment needing to be activated or on the <code class="xref std std-envvar docutils literal notranslate">PATH</code>.
When a virtual environment has been activated, the <code class="xref std std-envvar docutils literal notranslate">VIRTUAL_ENV</code>
environment variable is set to the path of the environment.
Since explicitly activating a virtual environment is not required to use it,
<code class="xref std std-envvar docutils literal notranslate">VIRTUAL_ENV</code> cannot be relied upon to determine
whether a virtual environment is being used.
<div class="admonition warning">
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 <code class="docutils literal notranslate">requirements.txt</code>, you can invoke <code class="docutils literal notranslate">pip install -r
requirements.txt</code> using the environment’s <code class="docutils literal notranslate">pip</code> 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.
</div>
You can deactivate a virtual environment by typing <code class="docutils literal notranslate">deactivate</code> in your shell.
The exact mechanism is platform-specific and is an internal implementation
detail (typically, a script or shell function will be used).
</section>
<section id="api">
<h2>API<a class="headerlink" href="#api" title="Permalink to this headline">¶</a></h2>
The high-level method described above makes use of a simple API which provides
mechanisms for third-party virtual environment creators to customize environment
creation according to their needs, the <a class="reference internal" href="#venv.EnvBuilder" title="venv.EnvBuilder"><code class="xref py py-class docutils literal notranslate">EnvBuilder</code></a> class.
<dl class="py class">
<dt class="sig sig-object py" id="venv.EnvBuilder">
class venv.EnvBuilder(system_site_packages=False, clear=False, symlinks=False, upgrade=False, with_pip=False, prompt=None, upgrade_deps=False)<a class="headerlink" href="#venv.EnvBuilder" title="Permalink to this definition">¶</a></dt>
<dd>The <a class="reference internal" href="#venv.EnvBuilder" title="venv.EnvBuilder"><code class="xref py py-class docutils literal notranslate">EnvBuilder</code></a> class accepts the following keyword arguments on
instantiation:
<ul class="simple">
<li><code class="docutils literal notranslate">system_site_packages</code> – a Boolean value indicating that the system Python
site-packages should be available to the environment (defaults to <code class="docutils literal notranslate">False</code>).</li>
<li><code class="docutils literal notranslate">clear</code> – a Boolean value which, if true, will delete the contents of
any existing target directory, before creating the environment.</li>
<li><code class="docutils literal notranslate">symlinks</code> – a Boolean value indicating whether to attempt to symlink the
Python binary rather than copying.</li>
<li><code class="docutils literal notranslate">upgrade</code> – a Boolean value which, if true, will upgrade an existing
environment with the running Python - for use when that Python has been
upgraded in-place (defaults to <code class="docutils literal notranslate">False</code>).</li>
<li><code class="docutils literal notranslate">with_pip</code> – a Boolean value which, if true, ensures pip is
installed in the virtual environment. This uses <a class="reference internal" href="ensurepip.html#module-ensurepip" title="ensurepip: Bootstrapping the &quot;pip&quot; installer into an existing Python installation or virtual environment."><code class="xref py py-mod docutils literal notranslate">ensurepip</code></a> with
the <code class="docutils literal notranslate">--default-pip</code> option.</li>
<li><code class="docutils literal notranslate">prompt</code> – a String to be used after virtual environment is activated
(defaults to <code class="docutils literal notranslate">None</code> which means directory name of the environment would
be used). If the special string <code class="docutils literal notranslate">&quot;.&quot;</code> is provided, the basename of the
current directory is used as the prompt.</li>
<li><code class="docutils literal notranslate">upgrade_deps</code> – Update the base venv modules to the latest on PyPI</li>
</ul>
<div class="versionchanged">
Changed in version 3.4: Added the <code class="docutils literal notranslate">with_pip</code> parameter
</div>
<div class="versionadded">
New in version 3.6: Added the <code class="docutils literal notranslate">prompt</code> parameter
</div>
<div class="versionadded">
New in version 3.9: Added the <code class="docutils literal notranslate">upgrade_deps</code> parameter
</div>
Creators of third-party virtual environment tools will be free to use the
provided <a class="reference internal" href="#venv.EnvBuilder" title="venv.EnvBuilder"><code class="xref py py-class docutils literal notranslate">EnvBuilder</code></a> class as a base class.
The returned env-builder is an object which has a method, <code class="docutils literal notranslate">create</code>:
<dl class="py method">
<dt class="sig sig-object py" id="venv.EnvBuilder.create">
create(env_dir)<a class="headerlink" href="#venv.EnvBuilder.create" title="Permalink to this definition">¶</a></dt>
<dd>Create a virtual environment by specifying the target directory
(absolute or relative to the current directory) which is to contain the
virtual environment. The <code class="docutils literal notranslate">create</code> method will either create the
environment in the specified directory, or raise an appropriate
exception.
The <code class="docutils literal notranslate">create</code> method of the <a class="reference internal" href="#venv.EnvBuilder" title="venv.EnvBuilder"><code class="xref py py-class docutils literal notranslate">EnvBuilder</code></a> class illustrates the
hooks available for subclass customization:
<div class="highlight-python notranslate"><div class="highlight"><pre>def create(self, env_dir):
 &quot;&quot;&quot;
 Create a virtualized Python environment in a directory.
 env_dir is the target directory to create an environment in.
 &quot;&quot;&quot;
 env_dir = os.path.abspath(env_dir)
 context = self.ensure_directories(env_dir)
 self.create_configuration(context)
 self.setup_python(context)
 self.setup_scripts(context)
 self.post_setup(context)
</pre></div>
</div>
Each of the methods <a class="reference internal" href="#venv.EnvBuilder.ensure_directories" title="venv.EnvBuilder.ensure_directories"><code class="xref py py-meth docutils literal notranslate">ensure_directories()</code></a>,
<a class="reference internal" href="#venv.EnvBuilder.create_configuration" title="venv.EnvBuilder.create_configuration"><code class="xref py py-meth docutils literal notranslate">create_configuration()</code></a>, <a class="reference internal" href="#venv.EnvBuilder.setup_python" title="venv.EnvBuilder.setup_python"><code class="xref py py-meth docutils literal notranslate">setup_python()</code></a>,
<a class="reference internal" href="#venv.EnvBuilder.setup_scripts" title="venv.EnvBuilder.setup_scripts"><code class="xref py py-meth docutils literal notranslate">setup_scripts()</code></a> and <a class="reference internal" href="#venv.EnvBuilder.post_setup" title="venv.EnvBuilder.post_setup"><code class="xref py py-meth docutils literal notranslate">post_setup()</code></a> can be overridden.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="venv.EnvBuilder.ensure_directories">
ensure_directories(env_dir)<a class="headerlink" href="#venv.EnvBuilder.ensure_directories" title="Permalink to this definition">¶</a></dt>
<dd>Creates the environment directory and all necessary subdirectories that
don’t already exist, and returns a context object. This context object
is just a holder for attributes (such as paths) for use by the other
methods. If the <a class="reference internal" href="#venv.EnvBuilder" title="venv.EnvBuilder"><code class="xref py py-class docutils literal notranslate">EnvBuilder</code></a> is created with the arg
<code class="docutils literal notranslate">clear=True</code>, contents of the environment directory will be cleared
and then all necessary subdirectories will be recreated.
The returned context object is a <a class="reference internal" href="types.html#types.SimpleNamespace" title="types.SimpleNamespace"><code class="xref py py-class docutils literal notranslate">types.SimpleNamespace</code></a> with the
following attributes:
<ul class="simple">
<li><code class="docutils literal notranslate">env_dir</code> - The location of the virtual environment. Used for
<code class="docutils literal notranslate">__VENV_DIR__</code> in activation scripts (see <a class="reference internal" href="#venv.EnvBuilder.install_scripts" title="venv.EnvBuilder.install_scripts"><code class="xref py py-meth docutils literal notranslate">install_scripts()</code></a>).</li>
<li><code class="docutils literal notranslate">env_name</code> - The name of the virtual environment. Used for
<code class="docutils literal notranslate">__VENV_NAME__</code> in activation scripts (see <a class="reference internal" href="#venv.EnvBuilder.install_scripts" title="venv.EnvBuilder.install_scripts"><code class="xref py py-meth docutils literal notranslate">install_scripts()</code></a>).</li>
<li><code class="docutils literal notranslate">prompt</code> - The prompt to be used by the activation scripts. Used for
<code class="docutils literal notranslate">__VENV_PROMPT__</code> in activation scripts (see <a class="reference internal" href="#venv.EnvBuilder.install_scripts" title="venv.EnvBuilder.install_scripts"><code class="xref py py-meth docutils literal notranslate">install_scripts()</code></a>).</li>
<li><code class="docutils literal notranslate">executable</code> - The underlying Python executable used by the virtual
environment. This takes into account the case where a virtual environment
is created from another virtual environment.</li>
<li><code class="docutils literal notranslate">inc_path</code> - The include path for the virtual environment.</li>
<li><code class="docutils literal notranslate">lib_path</code> - The purelib path for the virtual environment.</li>
<li><code class="docutils literal notranslate">bin_path</code> - The script path for the virtual environment.</li>
<li><code class="docutils literal notranslate">bin_name</code> - The name of the script path relative to the virtual
environment location. Used for <code class="docutils literal notranslate">__VENV_BIN_NAME__</code> in activation
scripts (see <a class="reference internal" href="#venv.EnvBuilder.install_scripts" title="venv.EnvBuilder.install_scripts"><code class="xref py py-meth docutils literal notranslate">install_scripts()</code></a>).</li>
<li><code class="docutils literal notranslate">env_exe</code> - The name of the Python interpreter in the virtual
environment. Used for <code class="docutils literal notranslate">__VENV_PYTHON__</code> in activation scripts
(see <a class="reference internal" href="#venv.EnvBuilder.install_scripts" title="venv.EnvBuilder.install_scripts"><code class="xref py py-meth docutils literal notranslate">install_scripts()</code></a>).</li>
<li><code class="docutils literal notranslate">env_exec_cmd</code> - The name of the Python interpreter, taking into
account filesystem redirections. This can be used to run Python in
the virtual environment.</li>
</ul>
<div class="versionchanged">
Changed in version 3.12: The attribute <code class="docutils literal notranslate">lib_path</code> was added to the context, and the context
object was documented.
</div>
<div class="versionchanged">
Changed in version 3.11: The venv
<a class="reference internal" href="sysconfig.html#installation-paths">sysconfig installation scheme</a>
is used to construct the paths of the created directories.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="venv.EnvBuilder.create_configuration">
create_configuration(context)<a class="headerlink" href="#venv.EnvBuilder.create_configuration" title="Permalink to this definition">¶</a></dt>
<dd>Creates the <code class="docutils literal notranslate">pyvenv.cfg</code> configuration file in the environment.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="venv.EnvBuilder.setup_python">
setup_python(context)<a class="headerlink" href="#venv.EnvBuilder.setup_python" title="Permalink to this definition">¶</a></dt>
<dd>Creates a copy or symlink to the Python executable in the environment.
On POSIX systems, if a specific executable <code class="docutils literal notranslate">python3.x</code> was used,
symlinks to <code class="docutils literal notranslate">python</code> and <code class="docutils literal notranslate">python3</code> will be created pointing to that
executable, unless files with those names already exist.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="venv.EnvBuilder.setup_scripts">
setup_scripts(context)<a class="headerlink" href="#venv.EnvBuilder.setup_scripts" title="Permalink to this definition">¶</a></dt>
<dd>Installs activation scripts appropriate to the platform into the virtual
environment.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="venv.EnvBuilder.upgrade_dependencies">
upgrade_dependencies(context)<a class="headerlink" href="#venv.EnvBuilder.upgrade_dependencies" title="Permalink to this definition">¶</a></dt>
<dd>Upgrades the core venv dependency packages (currently <code class="docutils literal notranslate">pip</code> and
<code class="docutils literal notranslate">setuptools</code>) in the environment. This is done by shelling out to the
<code class="docutils literal notranslate">pip</code> executable in the environment.
<div class="versionadded">
New in version 3.9.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="venv.EnvBuilder.post_setup">
post_setup(context)<a class="headerlink" href="#venv.EnvBuilder.post_setup" title="Permalink to this definition">¶</a></dt>
<dd>A placeholder method which can be overridden in third party
implementations to pre-install packages in the virtual environment or
perform other post-creation steps.
</dd></dl>

<div class="versionchanged">
Changed in version 3.7.2: Windows now uses redirector scripts for <code class="docutils literal notranslate">python[w].exe</code> instead of
copying the actual binaries. In 3.7.2 only <a class="reference internal" href="#venv.EnvBuilder.setup_python" title="venv.EnvBuilder.setup_python"><code class="xref py py-meth docutils literal notranslate">setup_python()</code></a> does
nothing unless running from a build in the source tree.
</div>
<div class="versionchanged">
Changed in version 3.7.3: Windows copies the redirector scripts as part of <a class="reference internal" href="#venv.EnvBuilder.setup_python" title="venv.EnvBuilder.setup_python"><code class="xref py py-meth docutils literal notranslate">setup_python()</code></a>
instead of <a class="reference internal" href="#venv.EnvBuilder.setup_scripts" title="venv.EnvBuilder.setup_scripts"><code class="xref py py-meth docutils literal notranslate">setup_scripts()</code></a>. This was not the case in 3.7.2.
When using symlinks, the original executables will be linked.
</div>
In addition, <a class="reference internal" href="#venv.EnvBuilder" title="venv.EnvBuilder"><code class="xref py py-class docutils literal notranslate">EnvBuilder</code></a> provides this utility method that can be
called from <a class="reference internal" href="#venv.EnvBuilder.setup_scripts" title="venv.EnvBuilder.setup_scripts"><code class="xref py py-meth docutils literal notranslate">setup_scripts()</code></a> or <a class="reference internal" href="#venv.EnvBuilder.post_setup" title="venv.EnvBuilder.post_setup"><code class="xref py py-meth docutils literal notranslate">post_setup()</code></a> in subclasses to
assist in installing custom scripts into the virtual environment.
<dl class="py method">
<dt class="sig sig-object py" id="venv.EnvBuilder.install_scripts">
install_scripts(context, path)<a class="headerlink" href="#venv.EnvBuilder.install_scripts" title="Permalink to this definition">¶</a></dt>
<dd>path is the path to a directory that should contain subdirectories
“common”, “posix”, “nt”, each containing scripts destined for the bin
directory in the environment. The contents of “common” and the
directory corresponding to <a class="reference internal" href="os.html#os.name" title="os.name"><code class="xref py py-data docutils literal notranslate">os.name</code></a> are copied after some text
replacement of placeholders:
<ul class="simple">
<li><code class="docutils literal notranslate">__VENV_DIR__</code> is replaced with the absolute path of the environment
directory.</li>
<li><code class="docutils literal notranslate">__VENV_NAME__</code> is replaced with the environment name (final path
segment of environment directory).</li>
<li><code class="docutils literal notranslate">__VENV_PROMPT__</code> is replaced with the prompt (the environment
name surrounded by parentheses and with a following space)</li>
<li><code class="docutils literal notranslate">__VENV_BIN_NAME__</code> is replaced with the name of the bin directory
(either <code class="docutils literal notranslate">bin</code> or <code class="docutils literal notranslate">Scripts</code>).</li>
<li><code class="docutils literal notranslate">__VENV_PYTHON__</code> is replaced with the absolute path of the
environment’s executable.</li>
</ul>
The directories are allowed to exist (for when an existing environment
is being upgraded).
</dd></dl>

</dd></dl>

There is also a module-level convenience function:
<dl class="py function">
<dt class="sig sig-object py" id="venv.create">
venv.create(env_dir, system_site_packages=False, clear=False, symlinks=False, with_pip=False, prompt=None, upgrade_deps=False)<a class="headerlink" href="#venv.create" title="Permalink to this definition">¶</a></dt>
<dd>Create an <a class="reference internal" href="#venv.EnvBuilder" title="venv.EnvBuilder"><code class="xref py py-class docutils literal notranslate">EnvBuilder</code></a> with the given keyword arguments, and call its
<a class="reference internal" href="#venv.EnvBuilder.create" title="venv.EnvBuilder.create"><code class="xref py py-meth docutils literal notranslate">create()</code></a> method with the env_dir argument.
<div class="versionadded">
New in version 3.3.
</div>
<div class="versionchanged">
Changed in version 3.4: Added the <code class="docutils literal notranslate">with_pip</code> parameter
</div>
<div class="versionchanged">
Changed in version 3.6: Added the <code class="docutils literal notranslate">prompt</code> parameter
</div>
<div class="versionchanged">
Changed in version 3.9: Added the <code class="docutils literal notranslate">upgrade_deps</code> parameter
</div>
</dd></dl>

</section>
<section id="an-example-of-extending-envbuilder">
<h2>An example of extending <code class="docutils literal notranslate">EnvBuilder</code><a class="headerlink" href="#an-example-of-extending-envbuilder" title="Permalink to this headline">¶</a></h2>
The following script shows how to extend <a class="reference internal" href="#venv.EnvBuilder" title="venv.EnvBuilder"><code class="xref py py-class docutils literal notranslate">EnvBuilder</code></a> by implementing a
subclass which installs setuptools and pip into a created virtual environment:
<div class="highlight-python notranslate"><div class="highlight"><pre>import os
import os.path
from subprocess import Popen, PIPE
import sys
from threading import Thread
from urllib.parse import urlparse
from urllib.request import urlretrieve
import venv

class ExtendedEnvBuilder(venv.EnvBuilder):
 &quot;&quot;&quot;
 This builder installs setuptools and pip so that you can pip or
 easy_install other packages into the created virtual environment.

:param nodist: If true, setuptools and pip are not installed into the
 created virtual environment.
 :param nopip: If true, pip is not installed into the created
 virtual environment.
 :param progress: If setuptools or pip are installed, the progress of the
 installation can be monitored by passing a progress
 callable. If specified, it is called with two
 arguments: a string indicating some progress, and a
 context indicating where the string is coming from.
 The context argument can have one of three values:
 &#39;main&#39;, indicating that it is called from virtualize()
 itself, and &#39;stdout&#39; and &#39;stderr&#39;, which are obtained
 by reading lines from the output streams of a subprocess
 which is used to install the app.

If a callable is not specified, default progress
 information is output to sys.stderr.
 &quot;&quot;&quot;

def __init__(self, *args, **kwargs):
 self.nodist = kwargs.pop(&#39;nodist&#39;, False)
 self.nopip = kwargs.pop(&#39;nopip&#39;, False)
 self.progress = kwargs.pop(&#39;progress&#39;, None)
 self.verbose = kwargs.pop(&#39;verbose&#39;, False)
 super().__init__(*args, **kwargs)

def post_setup(self, context):
 &quot;&quot;&quot;
 Set up any packages which need to be pre-installed into the
 virtual environment being created.

def reader(self, stream, context):
 &quot;&quot;&quot;
 Read lines from a subprocess&#39; output stream and either pass to a progress
 callable (if specified) or write progress information to sys.stderr.
 &quot;&quot;&quot;
 progress = self.progress
 while True:
 s = stream.readline()
 if not s:
 break
 if progress is not None:
 progress(s, context)
 else:
 if not self.verbose:
 sys.stderr.write(&#39;.&#39;)
 else:
 sys.stderr.write(s.decode(&#39;utf-8&#39;))
 sys.stderr.flush()
 stream.close()

def install_script(self, context, name, url):
 _, _, path, _, _, _ = urlparse(url)
 fn = os.path.split(path)[-1]
 binpath = context.bin_path
 distpath = os.path.join(binpath, fn)
 # Download script into the virtual environment&#39;s binaries folder
 urlretrieve(url, distpath)
 progress = self.progress
 if self.verbose:
 term = &#39;\n&#39;
 else:
 term = &#39;&#39;
 if progress is not None:
 progress(&#39;Installing %s ...%s&#39; % (name, term), &#39;main&#39;)
 else:
 sys.stderr.write(&#39;Installing %s ...%s&#39; % (name, term))
 sys.stderr.flush()
 # Install in the virtual environment
 args = [context.env_exe, fn]
 p = Popen(args, stdout=PIPE, stderr=PIPE, cwd=binpath)
 t1 = Thread(target=self.reader, args=(p.stdout, &#39;stdout&#39;))
 t1.start()
 t2 = Thread(target=self.reader, args=(p.stderr, &#39;stderr&#39;))
 t2.start()
 p.wait()
 t1.join()
 t2.join()
 if progress is not None:
 progress(&#39;done.&#39;, &#39;main&#39;)
 else:
 sys.stderr.write(&#39;done.\n&#39;)
 # Clean up - no longer needed
 os.unlink(distpath)

def install_setuptools(self, context):
 &quot;&quot;&quot;
 Install setuptools in the virtual environment.

:param context: The information for the virtual environment
 creation request being processed.
 &quot;&quot;&quot;
 url = &#39;https://bitbucket.org/pypa/setuptools/downloads/ez_setup.py&#39;
 self.install_script(context, &#39;setuptools&#39;, url)
 # clear up the setuptools archive which gets downloaded
 pred = lambda o: o.startswith(&#39;setuptools-&#39;) and o.endswith(&#39;.tar.gz&#39;)
 files = filter(pred, os.listdir(context.bin_path))
 for f in files:
 f = os.path.join(context.bin_path, f)
 os.unlink(f)

def install_pip(self, context):
 &quot;&quot;&quot;
 Install pip in the virtual environment.

def main(args=None):
 compatible = True
 if sys.version_info &lt; (3, 3):
 compatible = False
 elif not hasattr(sys, &#39;base_prefix&#39;):
 compatible = False
 if not compatible:
 raise ValueError(&#39;This script is only for use with &#39;
 &#39;Python 3.3 or later&#39;)
 else:
 import argparse

parser = argparse.ArgumentParser(prog=__name__,
 description=&#39;Creates virtual Python &#39;
 &#39;environments in one or &#39;
 &#39;more target &#39;
 &#39;directories.&#39;)
 parser.add_argument(&#39;dirs&#39;, metavar=&#39;ENV_DIR&#39;, nargs=&#39;+&#39;,
 help=&#39;A directory in which to create the &#39;
 &#39;virtual environment.&#39;)
 parser.add_argument(&#39;--no-setuptools&#39;, default=False,
 action=&#39;store_true&#39;, dest=&#39;nodist&#39;,
 help=&quot;Don&#39;t install setuptools or pip in the &quot;
 &quot;virtual environment.&quot;)
 parser.add_argument(&#39;--no-pip&#39;, default=False,
 action=&#39;store_true&#39;, dest=&#39;nopip&#39;,
 help=&quot;Don&#39;t install pip in the virtual &quot;
 &quot;environment.&quot;)
 parser.add_argument(&#39;--system-site-packages&#39;, default=False,
 action=&#39;store_true&#39;, dest=&#39;system_site&#39;,
 help=&#39;Give the virtual environment access to the &#39;
 &#39;system site-packages dir.&#39;)
 if os.name == &#39;nt&#39;:
 use_symlinks = False
 else:
 use_symlinks = True
 parser.add_argument(&#39;--symlinks&#39;, default=use_symlinks,
 action=&#39;store_true&#39;, dest=&#39;symlinks&#39;,
 help=&#39;Try to use symlinks rather than copies, &#39;
 &#39;when symlinks are not the default for &#39;
 &#39;the platform.&#39;)
 parser.add_argument(&#39;--clear&#39;, default=False, action=&#39;store_true&#39;,
 dest=&#39;clear&#39;, help=&#39;Delete the contents of the &#39;
 &#39;virtual environment &#39;
 &#39;directory if it already &#39;
 &#39;exists, before virtual &#39;
 &#39;environment creation.&#39;)
 parser.add_argument(&#39;--upgrade&#39;, default=False, action=&#39;store_true&#39;,
 dest=&#39;upgrade&#39;, help=&#39;Upgrade the virtual &#39;
 &#39;environment directory to &#39;
 &#39;use this version of &#39;
 &#39;Python, assuming Python &#39;
 &#39;has been upgraded &#39;
 &#39;in-place.&#39;)
 parser.add_argument(&#39;--verbose&#39;, default=False, action=&#39;store_true&#39;,
 dest=&#39;verbose&#39;, help=&#39;Display the output &#39;
 &#39;from the scripts which &#39;
 &#39;install setuptools and pip.&#39;)
 options = parser.parse_args(args)
 if options.upgrade and options.clear:
 raise ValueError(&#39;you cannot supply --upgrade and --clear together.&#39;)
 builder = ExtendedEnvBuilder(system_site_packages=options.system_site,
 clear=options.clear,
 symlinks=options.symlinks,
 upgrade=options.upgrade,
 nodist=options.nodist,
 nopip=options.nopip,
 verbose=options.verbose)
 for d in options.dirs:
 builder.create(d)

if __name__ == &#39;__main__&#39;:
 rc = 1
 try:
 main()
 rc = 0
 except Exception as e:
 print(&#39;Error: %s&#39; % e, file=sys.stderr)
 sys.exit(rc)
</pre></div>
</div>
This script is also available for download <a class="reference external" href="https://gist.github.com/vsajip/4673395">online</a>.
</section>
</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate">venv</code> — Creation of virtual environments</a><ul>
<li><a class="reference internal" href="#creating-virtual-environments">Creating virtual environments</a></li>
<li><a class="reference internal" href="#how-venvs-work">How venvs work</a></li>
<li><a class="reference internal" href="#api">API</a></li>
<li><a class="reference internal" href="#an-example-of-extending-envbuilder">An example of extending <code class="docutils literal notranslate">EnvBuilder</code></a></li>
</ul>
</li>
</ul>

<h4>Previous topic</h4>
 <a href="ensurepip.html"
 title="previous chapter"><code class="xref py py-mod docutils literal notranslate">ensurepip</code> — Bootstrapping the <code class="docutils literal notranslate">pip</code> installer</a>
 <h4>Next topic</h4>
 <a href="zipapp.html"
 title="next chapter"><code class="xref py py-mod docutils literal notranslate">zipapp</code> — Manage executable Python zip archives</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../bugs.html">Report a Bug</a></li>
 <li>
 <a href="https://github.com/python/cpython/blob/3.10/Doc/library/venv.rst"
 rel="nofollow">Show Source
 </a>
 </li>
 </ul>
 </div>
 </div>
 </div>
 <div class="clearer"></div>
 </div> 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 >index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="zipapp.html" title="zipapp — Manage executable Python zip archives"
 >next</a> |</li>
 <li class="right" >
 <a href="ensurepip.html" title="ensurepip — Bootstrapping the pip installer"
 >previous</a> |</li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="distribution.html" >Software Packaging and Distribution</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate">venv</code> — Creation of virtual environments</a></li>
 <li class="right">

<div class="inline-search" role="search">
 <form class="inline-search" action="../search.html" method="get">
 <input placeholder="Quick search" aria-label="Quick search" type="text" name="q" />
 <input type="submit" value="Go" />
 <input type="hidden" name="check_keywords" value="yes" />
 <input type="hidden" name="area" value="default" />
 </form>
 </div>
 |
 </li>
 
 </ul>
 </div> 
 <div class="footer">
 &copy; <a href="../copyright.html">Copyright</a> 2001-2026, Python Software Foundation.
 
 This page is licensed under the Python Software Foundation License Version 2.
 
 Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.
 
 See <a href="/license.html">History and License</a> for more information.

The Python Software Foundation is a non-profit corporation.
<a href="https://www.python.org/psf/donations/">Please donate.</a>

Last updated on January 26, 2026.
 <a href="/bugs.html">Found a bug</a>?

Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.2.
 </div>

</body>
</html>

${this.title}

Code Editor : venv.html