Kiedy powinienem podklasować wyjątek w Pythonie?

W moim kodzie jest około siedmiu miejsc, w których zgłaszam wyjątek. Wszystkie te wyjątki są traktowane tak samo: wydrukuj błąd do pliku dziennika, przywróć domyślny stan oprogramowania i zakończ.

Podczas przeglądu kodu mój starszy inżynier, którego bardzo cenię, powiedział, że powinienem podklasować wszystkie te wyjątki. Jego argumentem jest to, że w przyszłości możemy chcieć traktować wyjątki inaczej i będzie to łatwiejsze.

Moim argumentem jest to, że obecnie zaśmieci on tylko nasz kod, a ponieważ nie wiemy, czy kiedykolwiek będziemy obchodzić się z wyjątkami inaczej, powinniśmy zostawić kod zwięzły i, jeśli i kiedy nadejdzie czas, wtedy i tylko wtedy powinniśmy podtyp .

Chciałbym usłyszeć każdy argument w każdej sprawie.

Masz rację

Argument za twoją stroną jest już wspomniany przez Roberta Harveya: nie dodawaj niepotrzebnego teraz kodu, zwłaszcza, że ​​łatwo go później dodać.

Twój recenzent też ma rację

Z drugiej strony punkt recenzenta jest również zrozumiały:

• Zwracanie kodu generycznego Exception()nie jest zbyt pomocne dla osoby dzwoniącej: chociaż opis wyjątku wskazuje człowiekowi, co się dzieje, leczenie wyjątków inaczej programowo może być niemożliwe. Deweloper używający Twojego kodu może niechętnie zmieniać rodzaje wyjątków , w tym ze strachu (uzasadnionego lub nie) przed zniszczeniem czegoś.

  Pamiętaj, że dodanie niestandardowych wyjątków w tej chwili nie jest takie trudne :

  class MyCustomException(Exception):
      pass

  to wszystko czego potrzebujesz. To tylko dwa wiersze kodu (biorąc pod uwagę, że nie musisz nawet tworzyć osobnego pliku, jeśli umieścisz niestandardowe wyjątki w jednym pliku).

• Sam kod wygląda lepiej, jest bardziej czytelny.

  if price < self.PriceMinValue:
      raise OutOfRangeException("The price is inferior to zero.")

  wygląda nieco bardziej czytelnie w porównaniu do:

  if price < self.PriceMinValue:
      raise Exception("The price is inferior to zero.")

  ze względu na wskazanie rodzaju wyjątku:

  • W drugim fragmencie kodu muszę przeczytać opis i zgadnąć, że cena jest poza zakresem (a może nie? Może są przypadki, w których cena może być ujemna, np. Rabaty?)

  • W pierwszym fragmencie kodu rzut oka na typ daje natychmiastową informację o błędzie. Wygląda na to, że istnieje zestaw dozwolonych wartości ceny, a bieżąca wartość jest poza tym zestawem.

Więc?

Więc:

• Oba podejścia są prawidłowe. Jeśli nie podklasujesz wyjątków, kiedy nie potrzebujesz niestandardowych typów, masz rację. Kiedy wykonujesz podklasę wyjątków, ponieważ nic nie kosztuje, a może być przydatne później, masz rację.

• Bądź spójny ze swoim zespołem. Jeśli Twój zespół intensywnie korzysta z wyjątków niestandardowych, skorzystaj z nich.