summaryrefslogtreecommitdiffstats
path: root/Doc/using/cmdline.rst
diff options
context:
space:
mode:
authorXtreak <tir.karthi@gmail.com>2019-09-14 00:35:44 (GMT)
committerNick Coghlan <ncoghlan@gmail.com>2019-09-14 00:35:44 (GMT)
commitbdd6945d4dbd1fe6a7fcff95f7d6908db7d791a1 (patch)
treebb5bffa0000019f20f67c342d613cb5e1b7838ca /Doc/using/cmdline.rst
parentbf169915ecdd42329726104278eb723a7dda2736 (diff)
downloadcpython-bdd6945d4dbd1fe6a7fcff95f7d6908db7d791a1.zip
cpython-bdd6945d4dbd1fe6a7fcff95f7d6908db7d791a1.tar.gz
cpython-bdd6945d4dbd1fe6a7fcff95f7d6908db7d791a1.tar.bz2
bpo-33095: Add reference to isolated mode in -m and script option (GH-7764)
Attempt to make isolated mode easier to discover via additional inline documentation. Co-Authored-By: Julien Palard <julien@palard.fr>
Diffstat (limited to 'Doc/using/cmdline.rst')
-rw-r--r--Doc/using/cmdline.rst13
1 files changed, 13 insertions, 0 deletions
diff --git a/Doc/using/cmdline.rst b/Doc/using/cmdline.rst
index d04c3b6..457a7fc 100644
--- a/Doc/using/cmdline.rst
+++ b/Doc/using/cmdline.rst
@@ -101,6 +101,11 @@ source.
first element will be set to ``"-m"``). As with the :option:`-c` option,
the current directory will be added to the start of :data:`sys.path`.
+ :option:`-I` option can be used to run the script in isolated mode where
+ :data:`sys.path` contains neither the current directory nor the user's
+ site-packages directory. All :envvar:`PYTHON*` environment variables are
+ ignored, too.
+
Many standard library modules contain code that is invoked on their execution
as a script. An example is the :mod:`timeit` module::
@@ -121,6 +126,7 @@ source.
.. versionchanged:: 3.4
namespace packages are also supported
+.. _cmdarg-dash:
.. describe:: -
@@ -133,6 +139,8 @@ source.
.. audit-event:: cpython.run_stdin "" ""
+.. _cmdarg-script:
+
.. describe:: <script>
Execute the Python code contained in *script*, which must be a filesystem
@@ -151,6 +159,11 @@ source.
added to the start of :data:`sys.path` and the ``__main__.py`` file in
that location is executed as the :mod:`__main__` module.
+ :option:`-I` option can be used to run the script in isolated mode where
+ :data:`sys.path` contains neither the script's directory nor the user's
+ site-packages directory. All :envvar:`PYTHON*` environment variables are
+ ignored, too.
+
.. audit-event:: cpython.run_file filename
.. seealso::