Ręczne podnoszenie (rzucanie) wyjątku w Pythonie

Jak ręcznie wyrzucić / podnieść wyjątek w Pythonie?

Użyj najbardziej specyficznego konstruktora WYJĄTKÓW, który semantycznie pasuje do twojego problemu .

Bądź konkretny w swojej wiadomości, np.:

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

Nie podnoś ogólnych WYJĄTKÓW

Unikaj wprowadzania ogólnego wyjątku. Aby go złapać, musisz złapać wszystkie inne bardziej szczegółowe wyjątki, które go podklasują.

Problem 1: ukrywanie błędów

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

Dla przykład:

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',)

Problem 2: nie złapie

A bardziej szczegółowe połowy nie wyławiają ogólnego wyjątku:

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

Najlepsze praktyki: raise oświadczenie

Zamiast tego użyj najbardziej specyficznego konstruktora WYJĄTKÓW, który semantycznie pasuje do twojego problemu .

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

, który również umożliwia przekazanie dowolnej liczby argumentów do konstruktora:

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

Te argumenty są dostępne przez atrybut args na wyjątku obiekt. Na przykład:

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

Druki

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

W Pythonie 2.5, atrybut message został dodany do BaseException, aby zachęcić użytkowników do podklasowania wyjątków i zaprzestania używania args, ale wprowadzenie message i oryginalna deprecacja args została wycofana .

Najlepsze praktyki: except klauzula

Gdy wewnątrz klauzuli except możesz na przykład zapisać, że wystąpił określony typ błędu, a następnie ponownie podnieść. Na najlepszym sposobem, aby to zrobić, zachowując ślad stosu, jest użycie instrukcji bare raise. Na przykład:

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!

Nie modyfikuj swoich błędów... ale skoro nalegasz.

Możesz zachować stacktrace (i wartość błędu) za pomocą sys.exc_info(), ale jest to o wiele bardziej podatne na błędy i ma problemy ze zgodnością pomiędzy Pythonem 2 i 3, wolisz użyć gołego raise do ponownego podniesienia.

Aby wyjaśnić - sys.exc_info() zwraca typ, wartość i traceback.

type, value, traceback = sys.exc_info()

    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]

Jeśli chcesz, możesz zmodyfikować to, co dzieje się z nowym raise - np. ustawiając nowe args dla instancji:

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

I zachowaliśmy cały ślad podczas modyfikacji args. Zauważ, że jest to Nie najlepsza praktyka i jest to nieprawidłowa składnia w Pythonie 3 (co znacznie utrudnia zachowanie kompatybilności).

>>> 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>

W Python 3:

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

Ponownie: unikaj ręcznego manipulowania tracebackami. Jest mniej wydajny i bardziej podatny na błędy. A jeśli używasz wątków i sys.exc_info, możesz nawet uzyskać niewłaściwy traceback (zwłaszcza jeśli używasz obsługi wyjątków do sterowania przepływem - czego osobiście chciałbym uniknąć.)

Python 3, łańcuchowanie WYJĄTKÓW

W Pythonie 3 można łączyć wyjątki, które zachowują Pakiety znaków:

    raise RuntimeError('specific message') from error

Be świadomy:

• this does allow changing the error type raised, and
• to jest Nie kompatybilne z Pythonem 2.

Przestarzałe Metody:

Mogą one łatwo ukryć, a nawet dostać się do kodu produkcyjnego. Chcesz podnieść wyjątek, a ich wykonanie spowoduje wyjątek, ale nie ten zamierzony!

Ważne w Pythonie 2, ale nie w Pythonie 3 jest następujące:

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

Tylko ważne w znacznie starszych wersjach Pythona (2.4 i niższe), możesz nadal widzieć ludzi podnoszących ciągi:

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

We wszystkich nowoczesnych wersjach spowoduje to wywołanie TypeError, ponieważ nie podnosisz typu BaseException. Jeśli nie sprawdzasz WŁAŚCIWEGO wyjątku i nie masz recenzenta, który byłby świadomy problemu, może on wejść do produkcji.

Przykładowe Użycie

Zgłaszam wyjątki, aby ostrzec konsumentów o moim API, jeśli go używają niepoprawnie:

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)))

Twórz własne typy błędów, gdy apropos

"nie jest to jednak żaden problem, ponieważ nie jest to możliwe.]}

Możesz tworzyć własne typy błędów, jeśli chcesz wskazać, że coś jest nie tak z Twoją aplikacją, po prostu podklasuj odpowiedni punkt w hierarchii WYJĄTKÓW:

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

I użycie:

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