防止类在 Python 中直接实例化

Posted 2023-02-25

【中文标题】防止类在 Python 中直接实例化

【英文标题】：Preventing a class from direct instantiation in Python

【发布时间】：2011-12-20 19:15:22

【问题描述】：

我有一个超类，其方法调用仅在其子类中定义的其他方法。这就是为什么当我创建我的超类的一个实例并调用它的方法时，它找不到该方法并引发错误。

这是一个例子：

class SuperClass(object):

  def method_one(self):
    value = self.subclass_method()
    print value


class SubClassOne(SuperClass):

  def subclass_method(self):
    return 'subclass 1'


class SubClassTwo(SuperClass):

  def subclass_method(self):
    return 'nubclass 2'


s1 = SubClassOne()
s1.method_one()

s2 = SubClassTwo()
s2.method_one()

c = SuperClass()
c.method_one()

# Results:
# subclass 1
# nubclass 2
# Traceback (most recent call last):
#   File "abst.py", line 28, in <module>
#     c.method_one()
#   File "abst.py", line 4, in method_one
#     value = self.subclass_method()
# AttributeError: 'SuperClass' object has no attribute 'subclass_method'

我正在考虑在创建新实例时更改超类的 init 并验证对象的类型。如果对象属于超类，则会引发错误。但是，我不太确定这是否是 Pythonic 的方式。

有什么建议吗？

【问题讨论】：

Pythonic 的方式是编写好的文档来解释如何使用你的类。

@chown：这实际上在 C++ 中很常见。他所做的本质上是调用虚方法。如果它们是问题的正确解决方案，它们本质上没有任何问题。

我同意它不是 Pythonic

@chown 您似乎暗示使用抽象类的模式是“一般来说是非编程的”，这是大多数 OO 程序员不同意的。如果BaseClass 定义subclass_method 以引发NotImplementedError，除了稍微更好的错误消息之外，这会有什么不同？

@chown 抽象类的使用几乎不是“百万分之一的场景”。它是面向对象编程的核心部分。 Python 不需要将类正式声明为抽象的；您所要做的就是不实现需要子类实现的方法。但这是完全相同的模式。您声称在基类中引用未实现的抽象方法是“一般来说是非编程的”，但在每种 OO 语言中一直都这样做（并且鼓励）。 OP 所追求的只是一种检测抽象类滥用的方法。

【参考方案1】：

您说的是抽象基类，而 Python 语言本身并不支持它们。

但是，在标准库中，您可以使用一个模块来帮助您。查看abc 文档。

【讨论】：

其实在 Python 上实现他的方法还有很多，但我只是导入 abc 模块并将我的类设置为抽象类。我注意到即使我的类是抽象的，我仍然可以在其中实现方法，这非常好。

用 abc 模块创建的抽象类仍然可以被实例化，所以它不能解决问题。仅当类中有未实现的抽象方法时才阻止实例化。为了简单地防止实例化，请使用以下向构造函数添加检查的解决方案之一。

【参考方案2】：

您的方法是典型的framework pattern。

使用 __init__ 验证 type(self) is not SuperClass 是确保 SuperClass 未被直接实例化的合理方法。

另一种常见的方法是提供在调用时raise NotImplementedError 的存根方法。这更可靠，因为它还验证子类是否覆盖了预期的方法。

【参考方案3】：

这是我可能会做的：

class SuperClass(object):
    def __init__(self):
        if type(self) == SuperClass:
            raise Exception("<SuperClass> must be subclassed.")
        # assert(type(self) == SuperClass)

class SubClass(SuperClass):
    def __init__(self):
        SuperClass.__init__(self)

subC = SubClassOne()
supC = SuperClass() # This line should throw an exception

运行时（抛出异常！）：

[ 18:32 jon@hozbox ~/so/python ]$ ./preventing-direct-instantiation.py
Traceback (most recent call last):
  File "./preventing-direct-instantiation.py", line 15, in <module>
    supC = SuperClass()
  File "./preventing-direct-instantiation.py", line 7, in __init__
    raise Exception("<SuperClass> must be subclassed.")
Exception: <SuperClass> must be subclassed.

---

编辑（来自 cmets）：

[ 20:13 jon@hozbox ~/SO/python ]$ cat preventing-direct-instantiation.py 
#!/usr/bin/python

class SuperClass(object):
    def __init__(self):
        if type(self) == SuperClass:
            raise Exception("<SuperClass> must be subclassed.")

class SubClassOne(SuperClass):
    def __init__(self):
        SuperClass.__init__(self)

class SubSubClass(SubClassOne):
    def __init__(self):
        SubClassOne.__init__(self)

class SubClassTwo(SubClassOne, SuperClass):
    def __init__(self):
        SubClassOne.__init__(self)
        SuperClass.__init__(self)

subC = SubClassOne()

try:
    supC = SuperClass()
except Exception, e:
    print "FAILED: supC = SuperClass() - %s" % e
else:
    print "SUCCESS: supC = SuperClass()"

try:
    subSubC = SubSubClass()
except Exception, e:
    print "FAILED: subSubC = SubSubClass() - %s" % e
else:
    print "SUCCESS: subSubC = SubSubClass()"

try:
    subC2 = SubClassTwo()
except Exception, e:
    print "FAILED: subC2 = SubClassTwo() - %s" % e
else:
    print "SUCCESS: subC2 = SubClassTwo()"

打印：

[ 20:12 jon@hozbox ~/SO/python ]$ ./preventing-direct-instantiation.py 
FAILED: supC = SuperClass() - <SuperClass> must be subclassed.
SUCCESS: subSubC = SubSubClass()
SUCCESS: subC2 = SubClassTwo()

【讨论】：

不是说这不是很酷，但我认为它确切地说明了为什么你不应该尝试做这种事情。我很确定这两个示例都因多重继承而失败。

@sdolan 我刚刚测试过，它实际上与class SubSubClass(SubClassOne): 一起工作，并从其__init__ 调用SubClassOne.__init__(self)！

【参考方案4】：

我将覆盖基类中的__new__()，如果它是基类，则根本无法实例化。

class BaseClass:    # Py3

    def __new__(cls, *args, **kwargs):
        if cls is BaseClass:
            raise TypeError(f"only children of 'cls.__name__' may be instantiated")
        return object.__new__(cls, *args, **kwargs)

这比在__init__() 中更好地分离关注点，并且“快速失败”。

【讨论】：

abc 模块可能适用于 90% 的情况，但这种技术在其他一些情况下很有用。我遇到过一些： 1.) 你想要一个可重用的 mixin 类，但它实际上没有抽象方法，所以 ABCMeta 不会阻止它被实例化； 2.）您正在定义一个“基”类或 mixin，它实际上是其他东西的子类，但您不希望它可以直接实例化。

这确实很有用。我想补充一点，如果BaseClass继承了VeryBaseClass，那么返回VeryBaseClass.__new__()而不是object.__new__()

同样在这种情况下，请注意，如果您覆盖__init__ 以及覆盖__new__，那么您不能将额外的参数传递给__new__，您必须只调用return object.__new__(cls)。

@cfchou 一个更动态的实现：return super().__new__(cls, *args, **kwargs)