Skip to content

Commit

Permalink
[3.13] pythongh-121607: Edited source file import recipe to make it m…
Browse files Browse the repository at this point in the history
…ore clear (pythonGH-121519) (python#124080)

pythongh-121607: Edited source file import recipe to make it more clear (pythonGH-121519)
(cherry picked from commit 3880917)

Co-authored-by: Chris Barker <[email protected]>
Co-authored-by: Brett Cannon <[email protected]>
Co-authored-by: Peter Bierma <[email protected]>
  • Loading branch information
4 people authored Sep 24, 2024
1 parent 6867604 commit e9b00cc
Showing 1 changed file with 25 additions and 12 deletions.
37 changes: 25 additions & 12 deletions Doc/library/importlib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1584,20 +1584,34 @@ Note that if ``name`` is a submodule (contains a dot),
Importing a source file directly
''''''''''''''''''''''''''''''''

To import a Python source file directly, use the following recipe::
This recipe should be used with caution: it is an approximation of an import
statement where the file path is specified directly, rather than
:data:`sys.path` being searched. Alternatives should first be considered first,
such as modifying :data:`sys.path` when a proper module is required, or using
:func:`runpy.run_path` when the global namespace resulting from running a Python
file is appropriate.

import importlib.util
import sys
To import a Python source file directly from a path, use the following recipe::

import importlib.util
import sys

# For illustrative purposes.
import tokenize
file_path = tokenize.__file__
module_name = tokenize.__name__

spec = importlib.util.spec_from_file_location(module_name, file_path)
module = importlib.util.module_from_spec(spec)
sys.modules[module_name] = module
spec.loader.exec_module(module)
def import_from_path(module_name, file_path):
spec = importlib.util.spec_from_file_location(module_name, file_path)
module = importlib.util.module_from_spec(spec)
sys.modules[module_name] = module
spec.loader.exec_module(module)
return module


# For illustrative purposes only (use of `json` is arbitrary).
import json
file_path = json.__file__
module_name = json.__name__

# Similar outcome as `import json`.
json = import_from_path(module_name, file_path)


Implementing lazy imports
Expand All @@ -1623,7 +1637,6 @@ The example below shows how to implement lazy imports::
False



Setting up an importer
''''''''''''''''''''''

Expand Down

0 comments on commit e9b00cc

Please sign in to comment.