在现代Python中声明自定义异常类的正确方法是什么?我的主要目标是遵循其他异常类所具有的任何标准,以便(例如)我在异常中包含的任何额外字符串都由捕捉到异常的任何工具打印出来。

我所说的“现代Python”是指在Python2.5中运行,但对于Python2.6和Python3.*的工作方式来说是“正确的”。我所说的“自定义”是指一个异常对象,它可以包含有关错误原因的额外数据:一个字符串,也可能是与异常相关的其他任意对象。

我被Python 2.6.2中的以下弃用警告绊倒了:

>>> class MyError(Exception):
...     def __init__(self, message):
...         self.message = message
... 
>>> MyError("foo")
_sandbox.py:3: DeprecationWarning: BaseException.message has been deprecated as of Python 2.6

BaseException对名为message的属性具有特殊含义,这似乎很疯狂。我从PEP-352中了解到,这个属性在2.5中确实有特殊的含义,他们正试图贬低它,所以我想这个名字(以及这个名字)现在被禁止了?呃。

我还模糊地意识到Exception有一些神奇的参数参数,但我从未知道如何使用它;我在网上发现的许多讨论都表明,他们试图在Python 3中取消args。

更新:两个答案建议重写__init__和__str__/__unicode__/__repr_。这似乎需要很多打字,是吗?


当前回答

尝试此示例

class InvalidInputError(Exception):
    def __init__(self, msg):
        self.msg = msg
    def __str__(self):
        return repr(self.msg)

inp = int(input("Enter a number between 1 to 10:"))
try:
    if type(inp) != int or inp not in list(range(1,11)):
        raise InvalidInputError
except InvalidInputError:
    print("Invalid input entered")

其他回答

“在现代Python中声明自定义异常的正确方法是什么?”

这很好,除非您的异常确实是一种更具体的异常:

class MyException(Exception):
    pass

或者更好(也许完美),而不是传递一个docstring:

class MyException(Exception):
    """Raise for my specific kind of exception"""

子类化异常子类

从文档中

例外所有内置的、非系统退出的异常都是从该类派生的。所有用户定义的异常也应由此派生班

这意味着,如果您的异常是一种更具体的异常类型,请将该异常子类化,而不是泛型异常(结果将是您仍然按照文档的建议从异常派生)。此外,您至少可以提供一个docstring(不必强制使用pass关键字):

class MyAppValueError(ValueError):
    '''Raise when my specific value is wrong'''

使用自定义__init__设置您自己创建的属性。避免将dict作为位置参数传递,代码的未来用户将感谢您。如果使用不推荐的消息属性,则自行分配该属性将避免出现不推荐的警告:

class MyAppValueError(ValueError):
    '''Raise when a specific subset of values in context of app is wrong'''
    def __init__(self, message, foo, *args):
        self.message = message # without this you may get DeprecationWarning
        # Special attribute you desire with your Error, 
        # perhaps the value that caused the error?:
        self.foo = foo         
        # allow users initialize misc. arguments as any other builtin Error
        super(MyAppValueError, self).__init__(message, foo, *args) 

真的没有必要编写自己的__str__或__repr_。内置的非常好,您的合作继承确保您使用它们。

对顶级答案的批评

也许我错过了这个问题,但为什么不呢

class MyException(Exception):
    pass

同样,上面提到的问题是,为了捕获异常,您必须对其进行专门命名(如果在其他地方创建,则将其导入)或捕获异常(但您可能没有准备好处理所有类型的异常,您应该只捕获准备好处理的异常)。与下面的批评类似,但另外,这不是通过super进行初始化的方法,如果访问message属性,您将收到DeprecationWarning:

编辑:要覆盖某些内容(或传递额外的参数),请执行以下操作:

class ValidationError(Exception):
    def __init__(self, message, errors):

        # Call the base class constructor with the parameters it needs
        super(ValidationError, self).__init__(message)

        # Now for your custom code...
        self.errors = errors

这样,您就可以将错误消息的dict传递给第二个参数,然后使用e.errors进行处理

它还需要正好传入两个参数(除了self)。这是一个有趣的限制,未来的用户可能不会理解。

直接地说,这违反了利斯科夫的可替代性。

我将演示这两个错误:

>>> ValidationError('foo', 'bar', 'baz').message

Traceback (most recent call last):
  File "<pyshell#10>", line 1, in <module>
    ValidationError('foo', 'bar', 'baz').message
TypeError: __init__() takes exactly 3 arguments (4 given)

>>> ValidationError('foo', 'bar').message
__main__:1: DeprecationWarning: BaseException.message has been deprecated as of Python 2.6
'foo'

对比:

>>> MyAppValueError('foo', 'FOO', 'bar').message
'foo'

截至Python 3.8(2018,https://docs.python.org/dev/whatsnew/3.8.html),建议的方法仍然是:

class CustomExceptionName(Exception):
    """Exception raised when very uncommon things happen"""
    pass

请不要忘记记录,为什么需要自定义异常!

如果需要,这是处理具有更多数据的异常的方法:

class CustomExceptionName(Exception):
    """Still an exception raised when uncommon things happen"""
    def __init__(self, message, payload=None):
        self.message = message
        self.payload = payload # you could add more args
    def __str__(self):
        return str(self.message) # __str__() obviously expects a string to be returned, so make sure not to send any other data types

并像这样获取它们:

try:
    raise CustomExceptionName("Very bad mistake.", "Forgot upgrading from Python 1")
except CustomExceptionName as error:
    print(str(error)) # Very bad mistake
    print("Detail: {}".format(error.payload)) # Detail: Forgot upgrading from Python 1

有效负载=无对使其可酸洗很重要。在转储之前,必须调用error__reduce_()。加载将按预期工作。

如果需要将大量数据传输到某个外部结构,您可能应该研究如何使用pythons return语句找到解决方案。对我来说,这似乎更清晰/更像蟒蛇。高级异常在Java中大量使用,当使用框架并必须捕获所有可能的错误时,这有时会很烦人。

要正确定义自己的异常,您应该遵循以下几个最佳实践:

定义从Exception继承的基类。这将允许轻松捕捉与项目相关的任何异常:类MyProjectError(异常):“”“MyProject异常的基类。”“”在单独的模块中组织异常类(例如exceptions.py)通常是一个好主意。要创建特定异常,请将基本异常类子类化。类CustomError(MyProjectError):“”“MyProject的自定义异常类。”“”您还可以子类化自定义异常类以创建层次结构。若要向自定义异常添加对额外参数的支持,请使用可变数量的参数定义__init__()方法。调用基类的__init__(),向其传递任何位置参数(请记住BaseException/Exception需要任意数量的位置参数)。为实例存储额外参数,例如:类CustomError(MyProjectError):定义__init__(self,*args,**kwargs):super()__init__(*参数)self.fo=kwargs.get('fo')要使用额外的参数引发此类异常,可以使用:raise CustomError(“发生了一些错误”,foo='fo')

这种设计遵循Liskov替换原则,因为您可以用派生异常类的实例替换基本异常类的一个实例。此外,它还允许您使用与父类相同的参数创建派生类的实例。

尝试此示例

class InvalidInputError(Exception):
    def __init__(self, msg):
        self.msg = msg
    def __str__(self):
        return repr(self.msg)

inp = int(input("Enter a number between 1 to 10:"))
try:
    if type(inp) != int or inp not in list(range(1,11)):
        raise InvalidInputError
except InvalidInputError:
    print("Invalid input entered")

为了实现最大程度的自定义,为了定义自定义错误,您可能需要定义一个继承自Exception类的中间类,如下所示:

class BaseCustomException(Exception):
    def __init__(self, msg):
        self.msg = msg

    def __repr__(self):
        return self.msg


class MyCustomError(BaseCustomException):
    """raise my custom error"""