]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.7] bpo-33095: Add reference to isolated mode in -m and script option (GH-7764...
authorJulien Palard <julien@palard.fr>
Mon, 16 Sep 2019 12:30:33 +0000 (14:30 +0200)
committerGitHub <noreply@github.com>
Mon, 16 Sep 2019 12:30:33 +0000 (14:30 +0200)
Attempt to make isolated mode easier to discover via additional inline documentation.

Co-Authored-By: Julien Palard <julien@palard.fr>.
(cherry picked from commit bdd6945d4dbd1fe6a7fcff95f7d6908db7d791a1)

Co-authored-by: Xtreak <tir.karthi@gmail.com>
Doc/using/cmdline.rst

index dca89eceeda98a11f35bc61f21b9469279d6481b..6a60bc4954c625e384fad5d1ea3d1d1f0ed6e85f 100644 (file)
@@ -100,6 +100,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::
 
@@ -119,6 +124,7 @@ source.
    .. versionchanged:: 3.4
       namespace packages are also supported
 
+.. _cmdarg-dash:
 
 .. describe:: -
 
@@ -130,6 +136,8 @@ source.
    :data:`sys.path`.
 
 
+.. _cmdarg-script:
+
 .. describe:: <script>
 
    Execute the Python code contained in *script*, which must be a filesystem
@@ -148,6 +156,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.
+
    .. seealso::
       :func:`runpy.run_path`
          Equivalent functionality directly available to Python code