A pesar de que esta pregunta ha sido formulada y respondida varias veces (por ejemplo, aquí , aquí , aquí y aquí ), en mi opinión, ninguna respuesta existente captura de manera completa o concisa todas las implicaciones de la -m
bandera. Por lo tanto, lo siguiente intentará mejorar lo que vino antes.
Introducción (TLDR)
El -m
comando hace muchas cosas, no todas necesariamente serán necesarias todo el tiempo. En resumen: (1) permite scripts de Python que se ejecutan a través de modulename en lugar de nombre de archivo (2) permite elegir un directorio para agregar a sys.path
de import
resolución y (3) permite a los scripts de Python con las importaciones en relación a ejecutar desde la línea de comandos .
Preliminares
Para explicar la -m
bandera, primero debemos aclarar un poco la terminología.
Primero, la unidad organizativa primaria de Python se conoce como módulo . Los módulos vienen en uno de dos sabores: módulos de código y módulos de paquete. Un módulo de código es cualquier archivo que contiene código ejecutable de Python. Un módulo de paquete es un directorio que contiene otros módulos (módulos de código o módulos de paquete). El tipo más común de módulos de código son *.py
archivos, mientras que el tipo más común de módulos de paquete son directorios que contienen un __init__.py
archivo.
En segundo lugar, todos los módulos pueden identificarse de manera única de dos maneras distintas: <modulename>
y <filename>
. Los módulos se identifican con mayor frecuencia por el nombre del módulo en el código Python (por ejemplo, import <modulename>
) y por el nombre del archivo en la línea de comando (por ejemplo, python <filename>
). Todos los intérpretes de Python pueden convertir nombres de módulos en nombres de archivos mediante un conjunto de reglas bien definidas. Estas reglas dependen de la sys.path
variable y, por lo tanto, el mapeo se puede modificar cambiando este valor (para más información sobre cómo se hace, consulte PEP 302 ).
En tercer lugar, todos los módulos (tanto el código como el paquete) se pueden ejecutar (con lo que queremos decir que el intérprete de Python evaluará el código asociado con el módulo). Dependiendo del método de ejecución y del tipo de módulo, qué código se evalúa y cuándo puede cambiar bastante. Por ejemplo, si uno ejecuta un módulo de paquete a través de python <filename>
entonces <filename>/__init__.py
será evaluado seguido por <filename>/__main__.py
. Por otro lado, si uno ejecuta ese mismo módulo de paquete a través de import <modulename>
entonces, solo __init__.py
se ejecutarán los paquetes .
Desarrollo histórico de -m
La bandera -m se introdujo por primera vez en Python 2.4.1 . Inicialmente, su único propósito era proporcionar un medio alternativo para identificar un módulo de Python para ejecutar. Es decir, si supiéramos tanto el <filename>
y <modulename>
para un módulo, los siguientes dos comandos son equivalentes: python <filename> <args>
y python -m <modulename> <args>
. Además, de acuerdo con PEP 338, esta iteración -m
solo funcionaba con nombres de módulos de nivel superior (es decir, módulos que se podían encontrar directamente en sys.path sin ningún paquete intermedio).
Con la finalización de PEP 338, la -m
funcionalidad se amplió para admitir <modulename>
representaciones más allá de los nombres de módulos de nivel superior. Esto significaba nombres como http.server
ahora totalmente compatibles. Esta mejora también significó que todos los paquetes en un módulo ahora se cargaron (es decir, __init__.py
se evaluaron todos los archivos de paquete ), junto con el módulo en sí.
La mejora de características principales final -m
vino con PEP 366 . Con esta actualización -m
ganó la capacidad de admitir no solo importaciones absolutas sino también importaciones relativas explícitas. Esto se logró modificando la __package__
variable para el módulo nombrado en el -m
comando.
Casos de uso
Hay dos casos de uso notables para el indicador -m:
Para ejecutar módulos desde la línea de comandos para los cuales uno puede no conocer su nombre de archivo. Este caso de uso aprovecha el hecho de que el intérprete de Python sabe cómo convertir nombres de módulos a nombres de archivos. Esto es particularmente ventajoso cuando se quiere ejecutar módulos stdlib o módulos de terceros desde la línea de comandos. Por ejemplo, muy pocas personas conocen el nombre del archivo para el http.server
módulo, pero la mayoría de las personas sí conoce el nombre del módulo, por lo que podemos ejecutarlo desde la línea de comandos python -m http.server
.
Para ejecutar un paquete local que contenga importaciones absolutas sin necesidad de instalarlo. Este caso de uso se detalla en PEP 338 y aprovecha el hecho de que el directorio de trabajo actual se agrega en sys.path
lugar del directorio del módulo. Este caso de uso es muy similar al uso pip install -e .
para instalar un paquete en modo desarrollo / edición.
Deficiencias
Con todas las mejoras realizadas a lo -m
largo de los años, todavía tiene una deficiencia importante: solo puede ejecutar módulos de código escritos en python (es decir, * .py). Por ejemplo, si -m
se usa para ejecutar un módulo de código compilado en C, se generará el siguiente error No code object available for <modulename>
(consulte aquí para obtener más detalles).
Comparaciones detalladas
Efectos de la ejecución del módulo a través del comando python (es decir, python <filename>
):
sys.path
se modifica para incluir el directorio final en <filename>
__name__
se establece en '__main__'
__package__
se establece en None
__init__.py
no se evalúa para ningún paquete (incluido el suyo para módulos de paquete)
__main__.py
se evalúa para módulos de paquete; El código se evalúa para los módulos de código.
Efectos de la ejecución del módulo a través de la declaración de importación (es decir, import <modulename>
):
sys.path
se no modificadas en forma alguna
__name__
se establece en la forma absoluta de <modulename>
__package__
se establece en el paquete primario inmediato en <modulename>
__init__.py
se evalúa para todos los paquetes (incluido el suyo para los módulos de paquete)
__main__.py
se no evaluado para los módulos del paquete; el código se evalúa para los módulos de código
Efectos de la ejecución del módulo a través de la bandera -m (es decir, python -m <modulename>
):
sys.path
se modifica para incluir el directorio actual
__name__
se establece en '__main__'
__package__
se establece en el paquete primario inmediato en <modulename>
__init__.py
se evalúa para todos los paquetes (incluido el suyo para los módulos de paquete)
__main__.py
se evalúa para módulos de paquete; el código se evalúa para los módulos de código
Conclusión
La -m
bandera es, en su forma más simple, un medio para ejecutar scripts de Python desde la línea de comandos utilizando nombres de módulos en lugar de nombres de archivos. Además, -m
proporciona una funcionalidad adicional que combina el poder de las import
declaraciones (por ejemplo, soporte para importaciones relativas explícitas y __init__
evaluación automática de paquetes ) con la conveniencia de la línea de comandos de Python.
-m
parece buscarmymod1
en la ruta de la biblioteca predeterminada. Ejemplo:python -m SimpleHTTPServer
funciona, mientras quepython SimpleHTTPServer
falla concan't open file 'SimpleHTTPServer': [Errno 2] No such file or directory
.