¿Qué error generar cuando el estado de la clase no es válido?

Question

En una clase de Python, ¿qué tipo de error debo plantear desde un método de instancia cuando se deben cambiar algunos de los otros atributos de la clase antes de ejecutar ese método?

Vengo de un fondo de C# donde usaría InvalidOperationException, "la excepción que se produce cuando una llamada de método no es válida para el estado actual del objeto", pero no pude encontrar un equivalente built-in exception in Python.

He estado planteando ValueError ("se produce cuando una función o función incorporada recibe un argumento que tiene el tipo correcto pero un valor inapropiado") cuando el problema es con los parámetros de la función. Supongo que técnicamente es un valor inválido para el parámetro self; ¿Es esa la forma correcta de tratarlo? Por ejemplo, ¿esto es idiomático: raise ValueError("self.foo must be set before running self.bar()")?

Answer 1

ValueError es lo mejor que puedo plantear en este caso. Para python, debería preferir usar el built-in exception types antes que crear el suyo. Solo debe crear nuevos tipos de excepciones cuando espera que tenga que atraparlos y comportarse de manera muy diferente de lo que se comportaría al capturar los tipos integrados. En este caso, la situación no debería surgir; no espera detectar esto porque indicaría un error al usar la clase en cuestión. Para esto, no vale la pena crear un nuevo tipo solo para que tenga otro nombre, para eso sirve la cadena de mensajes que pasas al ValueError().

¿Es posible reestructurar su clase para que tal estado inválido no sea posible?

Answer 2

class InvalidOperationException(Exception): 
    pass 

SYS_STATE = 1 

def something_being_run(): 
    if SYS_STATE < 2: 
     raise InvalidOperationException 

¿Algo así te refieres? No veo ninguna razón por la que no deba hacer una excepción de subclase para crear sus propios tipos de Excepción, pero podría ser el viejo Oracle PL/SQL Dev en mi caso ...

Answer 3

Creo que la forma pitónica no es dejar el objeto en un estado en el que una llamada a un método no se bloquee a pesar de estar en un estado erróneo. Estos son los errores más difíciles de encontrar, ya que el punto donde el programa finalmente se desploma no es donde ocurrió el error.

por ejemplo.

class PseudoTuple(object): 
    """ 
The sum method of PseudoTuple will raise an AttributeError if either x or y have 
not been set 
""" 
    def setX(self, x): 
     self.x = x 

    def setY(self, y): 
     self.y = y 

    def sum(self): 
     """ 
In the documentation it should be made clear that x and y need to have been set 
for sum to work properly 
""" 
     return self.x + self.y 

class AnotherPseudoTuple(PseudoTuple): 
    """ 
For AnotherPseudoTuple sum will now raise a TypeError if x and y have not been 
properly set 
""" 
    def __init__(self, x=None, y=None): 
     self.x = x 
     self.y = y 

Lo que no se debe hacer es algo así como

class BadPseudoTuple(PseudoTuple): 
    """ 
In BadPseudoTuple -1 is used to indicate an invalid state 
""" 
    def __init__(self, x=-1, y=-1): 
     self.x = x 
     self.y = y 

    def sum(self): 
     if self.x == -1 or self.y == -1: 
      raise SomeException("BadPseudoTuple in invalid state") 
     else: 
      return self.x + self.y 

Creo que esto viene bajo el lema Pythonic de:

Es más fácil pedir perdón que es para obtener el permiso

Si el estado excepcional es algo que puede ser se espera que suceda durante el curso normal de la ejecución en lugar de ser un error del usuario al hacer un uso incorrecto de la clase, entonces parece razonable que deba crear su propia excepción. StopIteration y los iteradores son un ejemplo de esto.

Answer 4

Creo que deberías plantear un ValueError cuando el problema está con los parámetros de la función, como lo estás haciendo, y un AttributeError cuando el problema es con un atributo que se debe establecer.

Además, podría subclasificar el AttributeError para hacer una excepción más específica, pero no lo veo necesario. La excepción AttributeError con su mensaje de error es lo suficientemente clara.

Answer 5

ValueError está bien para mí, pero creo que AssertionError es más apropiado. Básicamente, viola la afirmación hecha por el diseñador de API.

Answer 6

Encuentro RuntimeError la más adecuada de todas las excepciones incorporadas para señalar el estado no válido.

ver este ejemplo de la forma en que se utiliza en CPython:

Python 2.7.10 (default, Jul 13 2015, 12:05:58) 
[GCC 4.2.1 Compatible Apple LLVM 6.1.0 (clang-602.0.53)] on darwin 
Type "help", "copyright", "credits" or "license" for more information. 
>>> from threading import Thread 
>>> Thread().join() 
Traceback (most recent call last): 
    File "<stdin>", line 1, in <module> 
    File "/usr/local/Cellar/python/2.7.10_2/Frameworks/Python.framework/Versions/2.7/lib/python2.7/threading.py", line 938, in join 
    raise RuntimeError("cannot join thread before it is started") 
RuntimeError: cannot join thread before it is started 

Es importante notar que incluso la propia aplicación CPython no es coherente sobre el uso de tipos de excepciones específicas entre las bibliotecas. A veces se usa ValueError, sin embargo, en mi opinión, su descripción de la documentación de Python muestra que su uso está reservado para otras situaciones. RuntimeError es una excepción más general y se debe usar cuando un fragmento de código no se puede comportar correctamente si se le dio una entrada adecuada, que es algo similar a la situación cuando un objeto está en un estado no válido.