runpy — Locating and executing Python modules

Вихідний код: Lib/runpy.py

---

Модуль runpy використовується для пошуку та запуску модулів Python без їх попереднього імпорту. Його головне використання полягає в реалізації перемикача командного рядка -m, який дозволяє розташовувати сценарії за допомогою простору імен модуля Python, а не файлової системи.

Зауважте, що це не модуль пісочниці – весь код виконується в поточному процесі, і будь-які побічні ефекти (такі як кешований імпорт інших модулів) залишаться на місці після повернення функцій.

Крім того, не гарантується коректна робота будь-яких функцій і класів, визначених виконуваним кодом після повернення функції runpy. Якщо це обмеження неприйнятне для певного випадку використання, importlib, швидше за все, буде більш прийнятним вибором, ніж цей модуль.

Модуль runpy забезпечує дві функції:

runpy.run_module(mod_name, init_globals=None, run_name=None, alter_sys=False)

Execute the code of the specified module and return the resulting module’s globals dictionary. The module’s code is first located using the standard import mechanism (refer to PEP 302 for details) and then executed in a fresh module namespace.

The mod_name argument should be an absolute module name. If the module name refers to a package rather than a normal module, then that package is imported and the __main__ submodule within that package is then executed and the resulting module globals dictionary returned.

The optional dictionary argument init_globals may be used to pre-populate the module’s globals dictionary before the code is executed. init_globals will not be modified. If any of the special global variables below are defined in init_globals, those definitions are overridden by run_module().

The special global variables __name__, __spec__, __file__, __cached__, __loader__ and __package__ are set in the globals dictionary before the module code is executed. (Note that this is a minimal set of variables - other variables may be set implicitly as an interpreter implementation detail.)

__name__ встановлено на run_name, якщо цей необов’язковий аргумент не є None, на mod_name + '.__main__, якщо названий модуль є пакетом, і на аргумент mod_name в іншому випадку .

__spec__ will be set appropriately for the actually imported module (that is, __spec__.name will always be mod_name or mod_name + '.__main__', never run_name).

__file__, __cached__, __loader__ і __package__ встановлені як звичайні на основі специфікації модуля.

Якщо вказано аргумент alter_sys і він має значення True, тоді sys.argv[0] оновлюється значенням __file__ і sys.modules[__name__] оновлюється тимчасовим об’єктом модуля для модуля, що виконується. І sys.argv[0], і sys.modules[__name__] відновлюються до своїх початкових значень перед поверненням функції.

Note that this manipulation of sys is not thread-safe. Other threads may see the partially initialised module, as well as the altered list of arguments. It is recommended that the sys module be left alone when invoking this function from threaded code.

Дивись також

Опція -m пропонує еквівалентні функції з командного рядка.

Змінено в версії 3.1: Added ability to execute packages by looking for a __main__ submodule.

Змінено в версії 3.2: Додано глобальну змінну __cached__ (див. PEP 3147).

Змінено в версії 3.4: Оновлено, щоб скористатися перевагами функції специфікації модуля, доданої PEP 451. Це дозволяє правильно встановити __cached__ для модулів, що запускаються таким чином, а також гарантує, що справжня назва модуля завжди доступна як __spec__.name.

Змінено в версії 3.12: The setting of __cached__, __loader__, and __package__ are deprecated. See ModuleSpec for alternatives.

runpy.run_path(path_name, init_globals=None, run_name=None)

Execute the code at the named filesystem location and return the resulting module’s globals dictionary. As with a script name supplied to the CPython command line, file_path may refer to a Python source file, a compiled bytecode file or a valid sys.path entry containing a __main__ module (e.g. a zipfile containing a top-level __main__.py file).

For a simple script, the specified code is simply executed in a fresh module namespace. For a valid sys.path entry (typically a zipfile or directory), the entry is first added to the beginning of sys.path. The function then looks for and executes a __main__ module using the updated path. Note that there is no special protection against invoking an existing __main__ entry located elsewhere on sys.path if there is no such module at the specified location.

The optional dictionary argument init_globals may be used to pre-populate the module’s globals dictionary before the code is executed. init_globals will not be modified. If any of the special global variables below are defined in init_globals, those definitions are overridden by run_path().

The special global variables __name__, __spec__, __file__, __cached__, __loader__ and __package__ are set in the globals dictionary before the module code is executed. (Note that this is a minimal set of variables - other variables may be set implicitly as an interpreter implementation detail.)

__name__ встановлено на run_name, якщо цей необов’язковий аргумент не є None, і на ' <run_path> '' в іншому випадку.

If file_path directly references a script file (whether as source or as precompiled byte code), then __file__ will be set to file_path, and __spec__, __cached__, __loader__ and __package__ will all be set to None.

If file_path is a reference to a valid sys.path entry, then __spec__ will be set appropriately for the imported __main__ module (that is, __spec__.name will always be __main__). __file__, __cached__, __loader__ and __package__ will be set as normal based on the module spec.

A number of alterations are also made to the sys module. Firstly, sys.path may be altered as described above. sys.argv[0] is updated with the value of file_path and sys.modules[__name__] is updated with a temporary module object for the module being executed. All modifications to items in sys are reverted before the function returns.

Note that, unlike run_module(), the alterations made to sys are not optional in this function as these adjustments are essential to allowing the execution of sys.path entries. As the thread-safety limitations still apply, use of this function in threaded code should be either serialised with the import lock or delegated to a separate process.

Дивись також

Параметри інтерфейсу для еквівалентної функції в командному рядку (python path/to/script).

Added in version 3.2.

Змінено в версії 3.4: Updated to take advantage of the module spec feature added by PEP 451. This allows __cached__ to be set correctly in the case where __main__ is imported from a valid sys.path entry rather than being executed directly.

Змінено в версії 3.12: The setting of __cached__, __loader__, and __package__ are deprecated.

Дивись також

PEP 338 – Виконання модулів як скриптів

PEP написав і реалізував Нік Коглан.

PEP 366 – Явний відносний імпорт основного модуля

PEP написав і реалізував Нік Коглан.

PEP 451 – Тип ModuleSpec для системи імпорту

PEP написав і реалізував Ерік Сноу

Командний рядок і середовище - деталі командного рядка CPython

Функція importlib.import_module()