在 Python 中手动引发(抛出)异常

Manually raising (throwing) an exception in Python

提问人:TIMEX 提问时间:1/13/2010 最后编辑:Mateen UlhaqTIMEX 更新时间:3/13/2023 访问量:2983121

问:

如何在 Python 中引发异常,以便以后可以通过块捕获它?except

Python 异常

评论


答:

578赞 Gabriel Hurley 1/13/2010 #1

不要这样做。养一个光秃秃的绝对是正确的做法;请看亚伦·霍尔(Aaron Hall)的精彩回答Exception

没有比这更 Pythonic 的了:

raise Exception("I know Python!")

替换为要引发的特定类型的异常。Exception

如果您想了解更多信息,请参阅 Python 的 raise 语句文档

评论

115赞 Dawood ibn Kareem 1/22/2015
不,拜托!这消除了具体说明您捕获的内容的可能性。这完全是错误的方法。看看 Aaron Hall 的精彩答案,而不是这个。在这样的时候,我希望我能给每个答案投不止一个反对票。
50赞 Dawood ibn Kareem 2/16/2015
@PeterR同样可怕的是,它的反对票如此之少。对于任何读到这个答案的人,永远不要这样做!正确答案是亚伦·霍尔(Aaron Hall)的答案。
18赞 Dinei 2/24/2017
@CharlieParker 有。这是亚伦·霍尔(Aaron Hall)回答的第一部分。
13赞 Daniel F. 4/13/2018
@codeforester也许是因为它在回答这个问题。
13赞 ctpenrose 10/20/2018
这个答案仍然存在,因为许多有经验的开发人员不同意使用专门的异常类。我希望我能对评论投反对票。
4183赞 Russia Must Remove Putin 6/6/2014 #2

如何在 Python 中手动抛出/引发异常?

使用语义上适合您的问题的最具体的 Exception 构造函数

在您的信息中要具体,例如:

raise ValueError('A very specific bad thing happened.')

不要引发一般异常

避免提出通用 .要捕获它,您必须捕获所有其他更具体的异常,这些异常是它的子类。Exception

问题 1:隐藏 bug

raise Exception('I know Python!') # Don't! If you catch, likely to hide bugs.

例如:

def demo_bad_catch():
    try:
        raise ValueError('Represents a hidden bug, do not catch this')
        raise Exception('This is the exception you expect to handle')
    except Exception as error:
        print('Caught this error: ' + repr(error))

>>> demo_bad_catch()
Caught this error: ValueError('Represents a hidden bug, do not catch this',)

问题 2:无法捕获

更具体的渔获量不会捕捉到一般的例外:

def demo_no_catch():
    try:
        raise Exception('general exceptions not caught by specific handling')
    except ValueError as e:
        print('we will not catch exception: Exception')
 

>>> demo_no_catch()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "<stdin>", line 3, in demo_no_catch
Exception: general exceptions not caught by specific handling

最佳实践:声明raise

相反,请使用语义上适合您的问题的最具体的 Exception 构造函数

raise ValueError('A very specific bad thing happened')

这也方便地允许将任意数量的参数传递给构造函数:

raise ValueError('A very specific bad thing happened', 'foo', 'bar', 'baz') 

这些参数由对象上的属性访问。例如:argsException

try:
    some_code_that_may_raise_our_value_error()
except ValueError as err:
    print(err.args)

指纹

('message', 'foo', 'bar', 'baz')    

在 Python 2.5 中,添加了一个实际属性,以支持鼓励用户对 Exceptions 进行子类化并停止使用 ,但 message 的引入和最初弃用 args 已被撤回messageBaseExceptionargs

最佳实践:条款except

例如,在 except 子句中,您可能希望记录发生了特定类型的错误,然后重新引发。在保留堆栈跟踪的同时执行此操作的最佳方法是使用裸 raise 语句。例如:

logger = logging.getLogger(__name__)

try:
    do_something_in_app_that_breaks_easily()
except AppError as error:
    logger.error(error)
    raise                 # just this!
    # raise AppError      # Don't do this, you'll lose the stack trace!

不要修改你的错误...但如果你坚持。

您可以使用 保留堆栈跟踪(和错误值),但这更容易出错,并且在 Python 2 和 3 之间存在兼容性问题,更喜欢使用裸来重新提升。sys.exc_info()raise

解释 - 返回类型、值和回溯。sys.exc_info()

type, value, traceback = sys.exc_info()

这是 Python 2 中的语法 - 请注意,这与 Python 3 不兼容:

raise AppError, error, sys.exc_info()[2] # avoid this.
# Equivalently, as error *is* the second object:
raise sys.exc_info()[0], sys.exc_info()[1], sys.exc_info()[2]

如果需要,您可以修改新加注时发生的情况 - 例如,为实例设置新加注:args

def error():
    raise ValueError('oops!')

def catch_error_modify_message():
    try:
        error()
    except ValueError:
        error_type, error_instance, traceback = sys.exc_info()
        error_instance.args = (error_instance.args[0] + ' <modification>',)
        raise error_type, error_instance, traceback

我们在修改参数时保留了整个回溯。请注意,这不是最佳实践,它是 Python 3 中的无效语法(使得保持兼容性变得更加困难)。

>>> catch_error_modify_message()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "<stdin>", line 3, in catch_error_modify_message
  File "<stdin>", line 2, in error
ValueError: oops! <modification>

Python 3 中:

raise error.with_traceback(sys.exc_info()[2])

再次:避免手动操作回溯。它的效率较低,更容易出错。如果你使用的是线程,你甚至可能会得到错误的回溯(特别是如果你对控制流使用异常处理 - 我个人倾向于避免这种情况。sys.exc_info

Python 3,异常链接

在 Python 3 中,您可以链接 Exceptions,以保留回溯:

raise RuntimeError('specific message') from error

请注意:

  • 确实允许更改引发的错误类型,并且
  • 这与 Python 2 兼容。

不推荐使用的方法:

这些可以很容易地隐藏甚至进入生产代码。你想引发一个异常,这样做会引发一个异常,但不是预期的那个!

在 Python 2 中有效,但在 Python 3 中无效,如下所示:

raise ValueError, 'message' # Don't do this, it's deprecated!

仅在旧版本的 Python(2.4 及更低版本)中有效,您可能仍然会看到有人提出字符串:

raise 'message' # really really wrong. don't do this.

在所有现代版本中,这实际上会引发一个 ,因为你没有引发一个类型。如果您没有检查正确的异常,并且没有了解该问题的审阅者,则它可能会进入生产环境。TypeErrorBaseException

用法示例

我提出异常,以警告我的 API 的使用者,如果他们错误地使用它:

def api_func(foo):
    '''foo should be either 'baz' or 'bar'. returns something very useful.'''
    if foo not in _ALLOWED_ARGS:
        raise ValueError('{foo} wrong, use "baz" or "bar"'.format(foo=repr(foo)))

创建自己的错误类型,当

“我想故意犯一个错误,这样它就会进入例外”

您可以创建自己的错误类型,如果要指示应用程序存在特定问题,只需在异常层次结构中对适当的点进行子类化:

class MyAppLookupError(LookupError):
    '''raise this when there's a lookup error for my app'''

和用法:

if important_key not in resource_dict and not ok_to_be_missing:
    raise MyAppLookupError('resource is missing, and that is not ok.')

评论

0赞 Sharath BJ 1/15/2021
try: raise ValueError('error') except ValueError as e: print('we will catch exception: Exception',str(e)) #is 最佳解决方案
1赞 Russia Must Remove Putin 1/16/2021
@SharathBJ您提出 a 并将其报告为 type,则会造成不必要的精度损失。 至少会为您报告类型。ValueErrorExceptionrepr(e)
0赞 Gabriel Staples 2/6/2021
显示在引发异常时可以传入消息的官方文档在哪里?前任:raise TypeError("my message")
1赞 Russia Must Remove Putin 2/6/2021
@GabrielStaples这里是关于实例化参数的文档: docs.python.org/3/library/exceptions.html#BaseException.args
0赞 Gabriel Staples 2/6/2021
@AaronHall,啊,我明白了。我没有意识到异常类型,例如 ,是对类构造函数的调用!现在有道理了。因此,该消息是错误类型类的常见构造函数参数。TypeError
45赞 Evgeni Sergeev 5/19/2015 #3

对于需要抛出异常以响应某些意外情况的常见情况,并且您从未打算捕获,而只是为了快速失败,以便在发生异常时能够从那里进行调试 - 最合乎逻辑的似乎是:AssertionError

if 0 < distance <= RADIUS:
    #Do something.
elif RADIUS < distance:
    #Do something.
else:
    raise AssertionError("Unexpected value of 'distance'!", distance)

评论

28赞 Two-Bit Alchemist 9/17/2015
这是一个更好的情况,因为断言没有问题(因为这里没有断言)——问题出在值上。在这种情况下,如果您真的想要一个,请写 .但是您不应该以这种方式进行错误检查,因为断言可以关闭 ()。ValueErrorAssertionErrorAssertionErrorassert distance > 0, 'Distance must be positive'python -O
1赞 Evgeni Sergeev 9/17/2015
@Two-BitAlchemist 好点子。当我写上面的简单例子时,这个想法在简化中丢失了。在许多类似情况下,它是一种与特定值无关的条件。相反,它的意思是“控制流永远不应该到达这里”。
2赞 Evgeni Sergeev 9/17/2015
@Two-BitAlchemist 断言可以关闭,是的,但是您根本不应该使用它们来检查错误?
0赞 Two-Bit Alchemist 9/18/2015
嗯,这要看情况。我不会让这是我打算分发的程序中唯一的错误检查。另一方面,我可以为我的同事制作一个程序,并告诉他们,如果他们使用 .-O
1赞 Evgeni Sergeev 9/21/2015
@Two-BitAlchemist 对我来说,断言的作用本身不是错误检查(这是测试的目的),而是它们在代码中设置了某些错误无法通过的围栏。因此,跟踪和隔离错误变得更加容易,这将不可避免地发生。这只是需要很少努力的好习惯,而测试需要大量的精力和时间。
101赞 N Randhawa 11/9/2016 #4

在 Python 3 中,有四种不同的语法用于引发异常:

  1. 引发异常
  2. 引发异常 (args)
  3. 从original_exception引发异常 (args)

1. 引发异常 vs. 2.引发异常 (args)

如果用于引发异常,则在打印异常对象时将打印 - 如以下示例所示。raise exception (args)args

# Raise exception (args)
try:
    raise ValueError("I have raised an Exception")
except ValueError as exp:
    print("Error", exp)     # Output -> Error I have raised an Exception


# Raise exception
try:
    raise ValueError
except ValueError as exp:
    print("Error", exp)     # Output -> Error

3. 声明提升

没有任何参数的语句将重新引发最后一个异常。raise

如果需要在捕获异常后执行某些操作,然后想要重新引发异常,这将非常有用。但是,如果之前没有任何异常,则该语句会引发异常。raiseTypeError

def somefunction():
    print("some cleaning")

a = 10
b = 0
result = None

try:
    result = a / b
    print(result)

except Exception:            # Output ->
    somefunction()           # Some cleaning
    raise                    # Traceback (most recent call last):
                             # File "python", line 9, in <module>
                             # ZeroDivisionError: division by zero

4. 从original_exception引发异常 (args)

此语句用于创建异常链接,其中为响应另一个异常而引发的异常可以包含原始异常的详细信息 - 如以下示例所示。

class MyCustomException(Exception):
    pass

a = 10
b = 0
reuslt = None
try:
    try:
        result = a / b

    except ZeroDivisionError as exp:
        print("ZeroDivisionError -- ",exp)
        raise MyCustomException("Zero Division ") from exp

except MyCustomException as exp:
    print("MyException",exp)
    print(exp.__cause__)

输出:

ZeroDivisionError --  division by zero
MyException Zero Division
division by zero

评论

15赞 Gloweye 6/28/2019
请注意,PEP8 更喜欢exception(args)exception (args)
11赞 cg909 4/5/2020
还有一种说法是,当前处于活动状态的异常已得到处理,不再具有意义。否则,如果在块内引发异常且未处理,则两个异常的回溯将显示为消息“在处理上述异常期间,发生了另一个异常”raise exception(args) from Noneexcept
22赞 Anant Prakash 3/29/2017 #5

首先阅读现有的答案,这只是一个附录。

请注意,可以引发带或不带参数的异常。

例:

raise SystemExit

退出程序,但您可能想知道发生了什么。所以你可以使用它。

raise SystemExit("program exited")

这将在关闭程序之前将“program exited”打印为标准错误。

评论

4赞 burny 10/1/2019
这难道不是违反OOP范式吗?我假设,第一种情况抛出类引用,第二种情况抛出 SystemExit 的实例。难道不是更好的选择吗?为什么第一个甚至有效?raise SystemExit()
0赞 ptim 8/9/2021
python.org/dev/peps/pep-3109 对此进行了讨论
5赞 markemus 12/4/2018 #6

请注意:有时您确实希望处理一般异常。如果要处理一堆文件并记录错误,则可能需要捕获文件发生的任何错误,将其记录下来,然后继续处理其余文件。在这种情况下,一个

try:
    foo()
except Exception as e:
    print(e) # Print out handled error

阻止是一个很好的方法。不过,您仍然需要特定的例外情况,以便了解它们的含义。raise

5赞 Rehan Haider 2/27/2019 #7

引发异常的另一种方法是使用 assert。您可以使用 assert 来验证是否满足条件。如果没有,那么它会提高.有关更多详细信息,请查看此处AssertionError

def avg(marks):
    assert len(marks) != 0, "List is empty."
    return sum(marks)/len(marks)

mark2 = [55,88,78,90,79]
print("Average of mark2:", avg(mark2))

mark1 = []
print("Average of mark1:", avg(mark1))

评论

6赞 cowbert 9/25/2020
不是万无一失的,因为当解释器被优化 (-O) 标志激活时,CPython 中的断言会被忽略;如果你想真正控制程序流“嘿,这种情况不应该发生,但如果它是真的,那就终止”,手动raise AssertionError()
0赞 qwr 11/6/2023
断言用于调试。如果是可能的用户输入,请引发 ValueError。
0赞 Grasshopper 3/31/2020 #8

为此,您应该学习 Python 的 raise 语句。

它应该保存在 try 块内。

例-

try:
    raise TypeError            # Replace TypeError by any other error if you want
except TypeError:
    print('TypeError raised')

评论

1赞 Brian 10/21/2020
你能给出一个理由来解释为什么你的榜样是好的吗?我已经阅读了这个问题的所有答案,我真的很好奇。
0赞 qwr 11/6/2023
除非你有充分的理由,否则最好一揽子尝试/除非有错误。
2赞 LuisAFK 6/9/2021 #9

您可能还希望引发自定义异常。例如,如果你正在编写一个库,那么为模块创建一个基异常类,然后更具体地自定义子异常是一个非常好的做法。

你可以像这样实现:

class MyModuleBaseClass(Exception):
    pass

class MoreSpecificException(MyModuleBaseClass):
    pass


# To raise custom exceptions, you can just
# use the raise keyword
raise MoreSpecificException
raise MoreSpecificException('message')

如果您对自定义基类不感兴趣,则可以从普通的异常类(如 、 等)继承自定义异常类。ExceptionTypeErrorValueError

1赞 U13-Forward 9/12/2021 #10

如果你不关心要引发哪个错误,你可以用它来引发一个:assertAssertionError

>>> assert False, "Manually raised error"
Traceback (most recent call last):
  File "<pyshell#24>", line 1, in <module>
    assert False, "Manually raised error"
AssertionError: Manually raised error
>>> 

关键字会引发 if 条件为 。在本例中,我们直接指定,因此它引发了错误,但要让它具有我们希望它引发的文本,我们添加一个逗号并指定我们想要的错误文本。在这种情况下,我写了,这用该文本提出了它。assertAssertionErrorFalseFalseManually raised error

评论

0赞 qwr 11/6/2023
当解释器运行优化时,断言将被禁用,因此不应用于控制流。查看对 Rehan Haider 回答的评论
-3赞 error 1044 12/9/2021 #11

如果您不关心引发的异常,请执行以下操作:

def crash(): return 0/0

它不允许您向用户抛出特定消息,但会使 python interpriter 崩溃。

对于更高级的 python,使用 python 的用户可能会认为表达式将在编译时计算(python 被编译),但 python 编译器不会在运行时计算表达式。 如果我们看一下 python 的 dissasembely 模块显示的内容,我们可以看到字节码。dis

              2 LOAD_CONST               1 (0)
              4 LOAD_CONST               1 (0)
              6 BINARY_OP               11 (/)

因此,本质上的 python 会将常量 0 推到堆栈上,然后将另一个 0 推送到堆栈上,然后运行二进制运算符进行除法。

虽然这个函数很没用,不应该在生产代码中使用,但它仍然会让 python interpriter 崩溃。