upstream/ipython Files · IPython/utils/module_paths.py

ipython_directive: Adjust doc examples for reproducibility....

ipython_directive: Adjust doc examples for reproducibility. Before this change, building the documentation twice in a row in an environment configured for reproducible bulids would result in discrepancies such as: diff -ru /gnu/store/...-python-ipython-documentation-8.2.0/share/doc/python-ipython-documentation-8.2.0/html/sphinxext.html /gnu/store/...-python-ipython-documentation-8.2.0-check/share/doc/python-ipython-documentation-8.2.0/html/sphinxext.html --- /gnu/store/...-python-ipython-documentation-8.2.0/share/doc/python-ipython-documentation-8.2.0/html/sphinxext.html 1969-12-31 19:00:01.000000000 -0500 +++ /gnu/store/...-python-ipython-documentation-8.2.0-check/share/doc/python-ipython-documentation-8.2.0/html/sphinxext.html 1969-12-31 19:00:01.000000000 -0500 @@ -682,7 +682,7 @@ In [2]: import datetime ...: datetime.datetime.now() ...: -Out[2]: datetime.datetime(2022, 4, 17, 3, 21, 14, 978155) +Out[2]: datetime.datetime(2022, 4, 17, 3, 37, 37, 115081) </pre></div> </div> It supports IPython construct that plain @@ -690,7 +690,7 @@ <div class="highlight-ipython notranslate"><div class="highlight"><pre>In [3]: import time In [4]: %timeit time.sleep(0.05) -50.2 ms +- 104 us per loop (mean +- std. dev. of 7 runs, 10 loops each) +50.1 ms +- 8.86 us per loop (mean +- std. dev. of 7 runs, 10 loops each) </pre></div> </div> This will also support top-level async when using IPython 7.0+ * IPython/sphinxext/ipython_directive.py: Use a fixed date string in the datetime example, and replace the %timeit example by %pdoc, whole output is static.

Nikita Kniazev - - Load All Authors

File last commit:

r27075:d0c8b31d


                r27687:71d665c4

Download file

             module_paths.py
        
                    71 lines
            
             | 2.3 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / utils / module_paths.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      """Utility functions for finding modules

      Utility functions for finding modules on sys.path.

      """

      #-----------------------------------------------------------------------------

      # Copyright (c) 2011, the IPython Development Team.

      #

      # Distributed under the terms of the Modified BSD License.

      #

      # The full license is in the file COPYING.txt, distributed with this software.

      #-----------------------------------------------------------------------------

      #-----------------------------------------------------------------------------

      # Imports

      #-----------------------------------------------------------------------------

      # Stdlib imports

      import importlib

      import os

      import sys

      # Third-party imports

      # Our own imports

      #-----------------------------------------------------------------------------

      # Globals and constants

      #-----------------------------------------------------------------------------

      #-----------------------------------------------------------------------------

      # Local utilities

      #-----------------------------------------------------------------------------

      #-----------------------------------------------------------------------------

      # Classes and functions

      #-----------------------------------------------------------------------------

      def find_mod(module_name):

          """

          Find module `module_name` on sys.path, and return the path to module `module_name`.

            - If `module_name` refers to a module directory, then return path to __init__ file.

              - If `module_name` is a directory without an __init__file, return None.

            - If module is missing or does not have a `.py` or `.pyw` extension, return None.

              - Note that we are not interested in running bytecode.

            - Otherwise, return the fill path of the module.

          Parameters

          ----------

          module_name : str

          Returns

          -------

          module_path : str

              Path to module `module_name`, its __init__.py, or None,

              depending on above conditions.

          """

          spec = importlib.util.find_spec(module_name)

          module_path = spec.origin

          if module_path is None:

              if spec.loader in sys.meta_path:

                  return spec.loader

              return None

          else:

              split_path = module_path.split(".")

              if split_path[-1] in ["py", "pyw"]:

                  return module_path

              else:

                  return None

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

				"""Utility functions for finding modules

				Utility functions for finding modules on sys.path.

				"""
				#-----------------------------------------------------------------------------
				# Copyright (c) 2011, the IPython Development Team.
				#
				# Distributed under the terms of the Modified BSD License.
				#
				# The full license is in the file COPYING.txt, distributed with this software.
				#-----------------------------------------------------------------------------

				#-----------------------------------------------------------------------------
				# Imports
				#-----------------------------------------------------------------------------

				# Stdlib imports
				import importlib
				import os
				import sys

				# Third-party imports

				# Our own imports


				#-----------------------------------------------------------------------------
				# Globals and constants
				#-----------------------------------------------------------------------------

				#-----------------------------------------------------------------------------
				# Local utilities
				#-----------------------------------------------------------------------------

				#-----------------------------------------------------------------------------
				# Classes and functions
				#-----------------------------------------------------------------------------

				def find_mod(module_name):
				"""
				Find module `module_name` on sys.path, and return the path to module `module_name`.

				- If `module_name` refers to a module directory, then return path to __init__ file.
				- If `module_name` is a directory without an __init__file, return None.
				- If module is missing or does not have a `.py` or `.pyw` extension, return None.
				- Note that we are not interested in running bytecode.
				- Otherwise, return the fill path of the module.

				Parameters
				----------
				module_name : str

				Returns
				-------
				module_path : str
				Path to module `module_name`, its __init__.py, or None,
				depending on above conditions.
				"""
				spec = importlib.util.find_spec(module_name)
				module_path = spec.origin
				if module_path is None:
				if spec.loader in sys.meta_path:
				return spec.loader
				return None
				else:
				split_path = module_path.split(".")
				if split_path[-1] in ["py", "pyw"]:
				return module_path
				else:
				return None