Códigos de salida en Python

Recibí un mensaje que decía script xyz.py returned exit code 0. ¿Qué significa esto?

¿Qué significan los códigos de salida en Python? ¿Cuántos hay? ¿Cuáles son importantes?

Lo que estás buscando en el script son las llamadas a sys.exit(). El argumento de ese método se devuelve al entorno como el código de salida.

Es bastante probable que el script nunca llame al método de salida, y que 0 es el código de salida predeterminado.

De la documentación parasys.exit :

El argumento opcional arg puede ser un número entero que proporciona el estado de salida (predeterminado a cero) u otro tipo de objeto. Si es un número entero, cero se considera "terminación exitosa" y cualquier valor distinto de cero se considera "terminación anormal" por shells y similares. La mayoría de los sistemas requieren que esté en el rango de 0 a 127 y, de lo contrario, producen resultados indefinidos. Algunos sistemas tienen una convención para asignar significados específicos a códigos de salida específicos, pero estos generalmente están subdesarrollados; Los programas Unix generalmente usan 2 para errores de sintaxis de línea de comando y 1 para todos los demás tipos de errores.

Un ejemplo donde se usan códigos de salida son los scripts de shell. En bash puede verificar la variable especial $?para el último estado de salida:

me@mini:~$ python -c ""; echo $?
0
me@mini:~$ python -c "import sys; sys.exit(0)"; echo $?
0
me@mini:~$ python -c "import sys; sys.exit(43)"; echo $?
43

Personalmente trato de usar los códigos de salida que encuentro en /usr/include/asm-generic/errno.h(en un sistema Linux), pero no sé si esto es lo correcto.

Para el registro, puede usar los códigos de salida estándar POSIX definidos aquí .

Ejemplo:

import sys, os

try:
    config()
except:
    sys.exit(os.EX_CONFIG) 
try:
    do_stuff()
except:
    sys.exit(os.EX_SOFTWARE)
sys.exit(os.EX_OK) # code 0, all ok

Hay un errno módulo que define los códigos de salida estándar:

Por ejemplo, el permiso denegado es el código de error 13 :

import errno, sys

if can_access_resource():
    do_something()
else:
    sys.exit(errno.EACCES)

Los códigos de salida de 0 generalmente significan "aquí no hay nada malo". Sin embargo, si el programador del script no siguió la convención, es posible que deba consultar la fuente para ver qué significa. Por lo general, se devuelve un valor distinto de cero como un código de error.

La respuesta es "Depende de lo que signifique el código de salida cero"

Sin embargo, en la mayoría de los casos, esto significa "Todo está bien"

Me gusta POSIX:

Entonces, en el shell, escribiría:

python script.py && echo 'OK' || echo 'Not OK'

Si mi script de Python llama sys.exit(0) al shell, devuelve 'OK'

Si mi script de Python llama sys.exit(1) (o cualquier número entero distinto de cero), el shell devuelve 'No está bien'

Es su trabajo ser inteligente con el shell y leer la documentación (o la fuente) de su script para ver qué significan los códigos de salida.

Los comandos del sistema operativo tienen códigos de salida. Busque códigos de salida de Linux para ver material sobre esto. El shell utiliza los códigos de salida para decidir si el programa funcionó, tuvo problemas o falló. Hay algunos esfuerzos para crear códigos de salida estándar (o al menos de uso común). Vea esta publicación de Advanced Shell Script .

Recomiendo un apagado limpio con la salida (0) incorporada en lugar de usar sys.exit ()

No estoy seguro si este es un buen consejo.

La misma documentación mencionada dice:

El módulo del sitio (que se importa automáticamente durante el inicio, excepto si se da la opción de línea de comandos -S) agrega varias constantes al espacio de nombres incorporado. Son útiles para el intérprete interactivo y no deben usarse en programas .

Luego:

salida (código = Ninguno)

Objetos que, cuando se imprimen, imprimen un mensaje como "Use quit () o Ctrl-D (es decir, EOF) para salir", y cuando se le llama, levanta SystemExit con el código de salida especificado.

Si lo comparamos con la documentación de sys.exit () , está utilizando el mismo mecanismo que está generando una SystemExitexcepción.

Si desea utilizar de forma portátil los códigos de salida POSIX estándar , consulte el exitstatuspaquete en PyPI.

Instala el paquete:

$ pip install exitstatus

Use en su código:

import sys
from exitstatus import ExitStatus

sys.exit(ExitStatus.success)

Los códigos de salida solo tienen el significado asignado por el autor del script. La tradición de Unix es que el código de salida 0 significa 'éxito', cualquier otra cosa es fracaso. La única forma de asegurarse de lo que significan los códigos de salida para un script determinado es examinar el script en sí.

Los códigos de salida en muchos lenguajes de programación dependen de los programadores. Por lo tanto, debe mirar el código fuente de su programa (o manual). Cero generalmente significa "todo salió bien".

Siguiendo los códigos de salida de Unix 0 - para éxito / OK, 1 - sin éxito / error. Simplemente puede usar exit(0)o exit(1)llamar sin importar el sysmódulo.

Para permitir que se ejecuten controladores de excepciones y otras cosas, recomiendo un apagado limpio con el exit(0)incorporado en lugar de usar el sys.exit()que finaliza el proceso abruptamente.