最佳实践：在 KeyError 上，为自定义消息打印或引发 KeyError？答案

【问题标题】：Best practice: On KeyError, print or raise KeyError for a custom message?最佳实践：在 KeyError 上，为自定义消息打印或引发 KeyError？
【发布时间】：2020-11-13 21:14:22
【问题描述】：

假设我有一个dict 喜欢：

envs = {
    "prod": "PRODSERVERNAME",
    "test": "TESTSERVERNAME",
    "dev": "DEVSERVERNAME"
}

我想更改KeyError 返回的消息，我在有关该主题的网络文章中看到的是打印出新消息，例如：

try:
    server = envs[env]
except KeyError:
    print(
        f'No environment found for "{env}"; env must be one of the following: {", ".join(envs.keys())}'
        )

在我看来，我仍然想抛出适当的错误（在这种情况下，要抛出 KeyError），只是提供有关该错误的更多有用/具体信息。有了这个假设（如果有最佳实践，请纠正我），我会像这样实现这个意图：

try:
    server = envs[env]
except KeyError:
    raise KeyError(
        f'No environment found for "{env}"; env must be one of the following: {", ".join(envs.keys())}'
        )

但是除了一个错误只是抛出相同类型的错误似乎充其量是不优雅的，最坏的情况是笨拙。

我的问题是：处理这种情况的适当方法是什么？是否有任何我可能遗漏的与此主题相关的最佳实践的文档？

提前致谢。

【问题讨论】：

提出一个更具体的自定义异常可能更惯用。例如raise MissingEnvVar(env)
你检查stackoverflow.com/q/6062576/12744275了吗？
我的经验法则是，如果你不能真正处理错误并恢复，那么就不要抓住它。
您可以创建一个更具体的异常，如 Ross 提出的，使用类 class MoreSpecificError(Exception) 并使用 self.message 定义将在错误时打印的消息
@FlavioMoraes Exception.message 已弃用。

标签： python python-3.x

【解决方案1】：

我会说这是一个偏好问题。您的代码可以正常工作并且可以按原样阅读。这只是你尝试完成的事情。

在这种特定情况下，您并不想处理KeyError，而是在缺少一个 env var 时引发自定义异常。所以就去做吧。

class CustomException(KeyError):
    def __init__(self, missing, allowed):
        self.value = f"No environment found for {missing}; env must be one of the following: {allowed}"

    def __str__(self):
        return repr(self.value)


server = envs.get(env)
if not server:
    raise CustomException('a', ', '.join(['a', 'b', 'c']))

【讨论】：

谢谢@Tom；我以前从未创建过自定义异常，所以这很有帮助。