edits

python · hauntsaninja · Jan 19, 2021 · Jan 18, 2021 · Jan 18, 2021 · Jan 18, 2021
commit 01c90a77a8a7da0229a78fbe37d2ecb5998722ff
diff --git a/docs/source/command_line.rst b/docs/source/command_line.rst
@@ -110,9 +110,10 @@ imports.
     passed on the command line, the ``MYPYPATH`` environment variable,
     and the :confval:`mypy_path` config option.
 
-    This flag also affects how mypy determines fully qualified module names for
-    files, modules and packages explicitly passed on the command line. See
-    :ref:`Mapping file paths to modules <mapping-paths-to-modules>` for details.
+    This flag affects how mypy finds modules and packages explicitly passed on
+    the command line. It also affects how mypy determines fully qualified module
+    names for files passed on the command line. See :ref:`Mapping file paths to
+    modules <mapping-paths-to-modules>` for details.
 
 .. option:: --explicit-package-bases
 

diff --git a/docs/source/running_mypy.rst b/docs/source/running_mypy.rst
@@ -366,40 +366,45 @@ How mypy determines fully qualified module names depends on if the options
 :option:`--namespace-packages <mypy --namespace-packages>` and
 :option:`--explicit-package-bases <mypy --explicit-package-bases>` are set.
 
-First, if :option:`--namespace-packages <mypy --namespace-packages>` is off,
-mypy will rely solely upon the presence of ``__init__.py[i]`` files to determine
-the fully qualified module name. That is, mypy will crawl up the directory tree
-for as long as it continues to find ``__init__.py`` (or ``__init__.pyi``) files.
-
-Second, if :option:`--namespace-packages <mypy --namespace-packages>` is on, but
-:option:`--explicit-package-bases <mypy --explicit-package-bases>` is off, mypy
-will allow for the possibility that directories without ``__init__.py[i]`` are
-packages. Specifically, mypy will look at all parent directories of the file and
-use the location of the highest ``__init__.py[i]`` in the directory tree to
-determine the top-level package.
-
-For example, say your directory tree consists solely of ``pkg/__init__.py`` and
-``pkg/a/b/c/d/mod.py``. When determining ``mod.py``'s fully qualified module
-name, mypy will look at ``pkg/__init__.py`` and conclude that the associated
-module name is ``pkg.a.b.c.d.mod``.
-
-You'll notice that that method still relies on ``__init__.py``. If you can't put
-an ``__init__.py`` in your top-level package, but still wish to pass paths (as
-opposed to packages or modules using the ``-p`` or ``-m`` flags),
-:option:`--explicit-package-bases <mypy --explicit-package-bases>` provides a
-solution.
-
-Third, with :option:`--explicit-package-bases <mypy --explicit-package-bases>`,
-mypy will locate the nearest parent directory that is a member of the
-``MYPYPATH`` environment variable, the :confval:`mypy_path` config or is the
-current working directory. mypy will then use the relative path to determine the
-fully qualified module name.
-
-For example, say your directory tree consists solely of
-``src/namespace_pkg/mod.py``. If you run the command following command, mypy
-will correctly associate ``mod.py`` with ``namespace_pkg.mod``::
-
-    $ MYPYPATH=src mypy --namespace-packages --explicit-package-bases .
+1. If :option:`--namespace-packages <mypy --namespace-packages>` is off,
+   mypy will rely solely upon the presence of ``__init__.py[i]`` files to
+   determine the fully qualified module name. That is, mypy will crawl up the
+   directory tree for as long as it continues to find ``__init__.py`` (or
+   ``__init__.pyi``) files.
+
+   For example, if your directory tree consists of ``pkg/subpkg/mod.py``, mypy
+   would require ``pkg/__init__.py`` and ``pkg/subpkg/__init__.py`` to exist in
+   order correctly associate ``mod.py`` with ``pkg.subpkg.mod``
+
+2. If :option:`--namespace-packages <mypy --namespace-packages>` is on, but
+   :option:`--explicit-package-bases <mypy --explicit-package-bases>` is off,
+   mypy will allow for the possibility that directories without
+   ``__init__.py[i]`` are packages. Specifically, mypy will look at all parent
+   directories of the file and use the location of the highest
+   ``__init__.py[i]`` in the directory tree to determine the top-level package.
+
+   For example, say your directory tree consists solely of ``pkg/__init__.py``
+   and ``pkg/a/b/c/d/mod.py``. When determining ``mod.py``'s fully qualified
+   module name, mypy will look at ``pkg/__init__.py`` and conclude that the
+   associated module name is ``pkg.a.b.c.d.mod``.
+
+3. You'll notice that the above case still relies on ``__init__.py``. If
+   you can't put an ``__init__.py`` in your top-level package, but still wish to
+   pass paths (as opposed to packages or modules using the ``-p`` or ``-m``
+   flags), :option:`--explicit-package-bases <mypy --explicit-package-bases>`
+   provides a solution.
+
+   With :option:`--explicit-package-bases <mypy --explicit-package-bases>`, mypy
+   will locate the nearest parent directory that is a member of the ``MYPYPATH``
+   environment variable, the :confval:`mypy_path` config or is the current
+   working directory. mypy will then use the relative path to determine the
 def get_explicit_package_bases(options: Options) -> Optional[List[str]]: 
 def get_explicit_package_bases(options: Options) -> Optional[List[str]]: 
+   fully qualified module name.
+
+   For example, say your directory tree consists solely of
+   ``src/namespace_pkg/mod.py``. If you run the command following command, mypy
+   will correctly associate ``mod.py`` with ``namespace_pkg.mod``::
+
+       $ MYPYPATH=src mypy --namespace-packages --explicit-package-bases .
 
 If you pass a file not ending in ``.py[i]``, the module name assumed is
 ``__main__`` (matching the behavior of the Python interpreter), unless