webdevqa.jp.net

カスタムPythonエラーコードとエラーメッセージを含む例外

class AppError(Exception):
    pass

class MissingInputError(AppError):
    pass

class ValidationError(AppError):
    pass

...

def validate(self):
    """ Validate Input and save it """

    params = self.__params

    if 'key' in params:
        self.__validateKey(escape(params['key'][0]))
    else:
        raise MissingInputError

    if 'svc' in params:
        self.__validateService(escape(params['svc'][0]))
    else:
        raise MissingInputError

    if 'dt' in params:
        self.__validateDate(escape(params['dt'][0]))
    else:
        raise MissingInputError


def __validateMulti(self, m):
    """ Validate Multiple Days Request"""

    if m not in Input.__validDays:
        raise ValidationError

    self.__dCast = int(m)

validate()および__validateMulti()は、渡された入力パラメーターを検証および保存するクラスのメソッドです。コードで明らかなように、一部の入力パラメーターが欠落しているか、一部の検証が失敗すると、カスタム例外が発生します。

次のように、アプリ固有のカスタムエラーコードとエラーメッセージを定義したいと思います。

エラー1100:「キーパラメータが見つかりません。入力を確認してください。」

エラー1101:「日付パラメーターが見つかりません。入力を確認してください」

...

エラー2100:「Multiple Dayパラメーターは無効です。許容値は2、5、および7です。」

同じことをユーザーに報告します。

  1. カスタム例外でこれらのエラーコードとエラーメッセージを定義するにはどうすればよいですか?
  2. どのエラーコード/メッセージを表示するかを知る方法で例外を発生/トラップするにはどうすればよいですか?

(PS:これはPython 2.4.3)のためです。


BastienLéonardはこれについて言及しています SOコメント あなたはしない常に新しい__init__または__str__を定義する必要があります;デフォルトでは、引数はself.argsに配置され、__str__によって出力されます。

したがって、私が好む解決策:

class AppError(Exception): pass

class MissingInputError(AppError):

    # define the error codes & messages here
    em = {1101: "Some error here. Please verify.", \
          1102: "Another here. Please verify.", \
          1103: "One more here. Please verify.", \
          1104: "That was idiotic. Please verify."}

使用法:

try:
    # do something here that calls
    # raise MissingInputError(1101)

except MissingInputError, e
    print "%d: %s" % (e.args[0], e.em[e.args[0]])
36
Sam

特別なコードを使用したカスタムExceptionクラスの簡単な例を次に示します。

class ErrorWithCode(Exception):
    def __init__(self, code):
        self.code = code
    def __str__(self):
        return repr(self.code)

try:
    raise ErrorWithCode(1000)
except ErrorWithCode as e:
    print("Received error with code:", e.code)

argsの使用方法について尋ねていたので、追加の例を示します...

class ErrorWithArgs(Exception):
    def __init__(self, *args):
        # *args is used to get a list of the parameters passed in
        self.args = [a for a in args]

try:
    raise ErrorWithArgs(1, "text", "some more text")
except ErrorWithArgs as e:
    print("%d: %s - %s" % (e.args[0], e.args[1], e.args[2]))
64
Bryan

これは、事前定義されたエラーコードを使用して作成したカスタム例外の例です。

class CustomError(Exception):
"""
Custom Exception
"""

  def __init__(self, error_code, message='', *args, **kwargs):

      # Raise a separate exception in case the error code passed isn't specified in the ErrorCodes enum
      if not isinstance(error_code, ErrorCodes):
          msg = 'Error code passed in the error_code param must be of type {0}'
          raise CustomError(ErrorCodes.ERR_INCORRECT_ERRCODE, msg, ErrorCodes.__class__.__name__)

      # Storing the error code on the exception object
      self.error_code = error_code

      # storing the traceback which provides useful information about where the exception occurred
      self.traceback = sys.exc_info()

      # Prefixing the error code to the exception message
      try:
          msg = '[{0}] {1}'.format(error_code.name, message.format(*args, **kwargs))
      except (IndexError, KeyError):
          msg = '[{0}] {1}'.format(error_code.name, message)

      super().__init__(msg)


# Error codes for all module exceptions
@unique
class ErrorCodes(Enum):
    ERR_INCORRECT_ERRCODE = auto()      # error code passed is not specified in enum ErrorCodes
    ERR_SITUATION_1 = auto()            # description of situation 1
    ERR_SITUATION_2 = auto()            # description of situation 2
    ERR_SITUATION_3 = auto()            # description of situation 3
    ERR_SITUATION_4 = auto()            # description of situation 4
    ERR_SITUATION_5 = auto()            # description of situation 5
    ERR_SITUATION_6 = auto()            # description of situation 6

列挙型ErrorCodesは、エラーコードを定義するために使用されます。例外は、渡されたエラーコードが例外メッセージの前に付加されるように作成されます。

1