在类的每个方法中捕获相同的异常

Question

我是一名初学者，正在开发一个简单的基于卡片的 GUI。用 Python 编写。有一个基类，其中包括所有卡片的词汇表，例如_cards = {'card1_ID': card1, 'card2_ID': card2}。 GUI 上的卡片由其唯一 ID 引用。

由于我计划使代码对其他初学者可用，我想明确告知他们是否提供了不存在的卡 ID（而不是抛出 KeyError）。现在我有大量重复的 try-expect 子句让我怀疑：

部分代码，一行方法无需try-catch：

def shift(self, card_ID, amount):
        """Moves the card by the given amount of pixels.
            :param amount: the horizontal and vertical amount of shifting in pixels; tuple"""

        try:
            self._cards[card_ID].shift(amount)
        except KeyError:
            raise ValueError("Invaild card ID")


    def align(self, card_ID, horizontal, vertical):
        """Aligns the card to the given position."""

        try:
            card = self._cards[card_ID]
            card.align(horizontal, vertical)
        except KeyError:
            raise ValueError("Invaild card ID") 


    def invert(self, card_ID):
        """Inverts the card's colour"""

        try:
            self._cards[card_ID].invert()
        except KeyError:
            raise ValueError("Invaild card ID")

这是一种公认​​的做法吗？有没有更好的方法在类的每个方法中捕获这个 KeyError ？

Answer 1

您可以考虑将您的卡片集合变成您自己的集合类型，以提供您需要的自定义例外。如果您将 dict 用于您的卡片收藏，您可以使用如下自定义行为创建自己的 dict：

class CardsCollection(dict):
    '''A dict-like collection of cards'''
    def __getitem__(self, key):
        try:
            # first try default behavior
            super().__self__(key)
        except KeyError:
            # it didn't work! 
            raise ValueError("Invalid card ID: {!r}".format(key))

现在您可以像这样执行各种方法：

    def align(self, card_ID, horizontal, vertical):
        """Aligns the card to the given position."""
            card = self._cards[card_ID]
            card.align(horizontal, vertical)
etc. etc. 

...只需确保将您的类用于您的._cards 属性。

_cards = CardsCollection(card1_ID = card1, card2_ID = card2)

或：

_cards = CardsCollection({'card1_ID': card1, 'card2_ID': card2})

这样做的好处是，您的 UI 类不会为保存数据的对象提供某种自定义或不寻常的接口（即getcard()）。这里的界面与Python data model一致。因此，如果出于某种原因，您决定要对另一个对象类使用相同的 UI，那么您已经使用了经过验证的 API，它可以翻译几乎所有以与 Python 一致的方式编写的内容数据模型。

Answer 2

你总是可以使用装饰器函数来得到你想要的。 This link 是学习装饰器是什么以及如何使用它们的绝佳教程。在您的情况下，我将给出一个使用装饰器的示例解决方案。

基本上，您只需创建一个函数，该函数将函数作为参数并返回对其执行特殊操作的包装器。可能适合您的解决方案的一个如下所示：

def catch_invalid_card_exception(func):
    def wrapper(*args, **kwargs):    
        try:
            return func(*args, **kwargs)
        except KeyError:
            raise ValueError("Invalid card ID") # Not "invaild" ;)
    return wrapper

...然后你可以像这样装饰你的函数/方法：

@catch_invalid_card_exception
def shift(self, card_ID, amount):
    """Moves the card by the given amount of pixels.
        :param amount: the horizontal and vertical amount of shifting in pixels; tuple"""
    self._cards[card_ID].shift(amount)

@catch_invalid_card_exception
def align(self, card_ID, horizontal, vertical):
    """Aligns the card to the given position."""
    card = self._cards[card_ID]
    card.align(horizontal, vertical)

@catch_invalid_card_exception
def invert(self, card_ID):
    """Inverts the card's colour"""
    self._cards[card_ID].invert()

...这实际上只是语法糖：

def shift(self, card_ID, amount):
    # ...
shift = catch_invalid_card_exception(shift)

def align(self, card_ID, horizontal, vertical):
    # ...
align = catch_invalid_card_exception(align)

def invert(self, card_ID):
    # ...
invert = catch_invalid_card_exception(invert)

Answer 3

将卡片的实际获取从 id 提取到一个单独的方法中，并在那里使用 try/except，然后从其他任何地方调用该方法。

def get_card(self, card_id):
    try:
        return self._cards[card_ID]
    except KeyError:
        raise ValueError("Invaild card ID")

def invert(self, card_id):
    return self.get_card(card_id).invert()

...

Answer 4

您可以使用装饰器来删除一些重复的样板。

from functools import wraps

def replace_keyerror(func):
    """Catches KeyError and replaces it with ValueError"""

    @wraps(func)
    def inner(*args, **kwargs):
        try:
            func(*args, **kwargs)
        except KeyError:
            raise ValueError("Invaild card ID")
    return inner

然后你会这样使用它：

@replace_keyerror
def align(self, card_ID, horizontal, vertical):
"""Aligns the card to the given position."""
    card = self._cards[card_ID]
    card.align(horizontal, vertical)

@replace_keyerror
def invert(self, card_ID):
    """Inverts the card's colour"""
    self._cards[card_ID].invert()