]> granicus.if.org Git - python/commitdiff
bpo-33095: Add reference to isolated mode in -m and script option (GH-7764)
authorXtreak <tir.karthi@gmail.com>
Sat, 14 Sep 2019 00:35:44 +0000 (01:35 +0100)
committerNick Coghlan <ncoghlan@gmail.com>
Sat, 14 Sep 2019 00:35:44 +0000 (10:35 +1000)
Attempt to make isolated mode easier to discover via additional inline documentation.

Co-Authored-By: Julien Palard <julien@palard.fr>
Doc/using/cmdline.rst

index d04c3b61dd5b1a0532c7dfaa5f632fba1d317f2f..457a7fcb6d9e3f82b1590ac0f2bddcf8869a574c 100644 (file)
@@ -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::