Python如何通过Context Manager强制对象实例化?

时间:2016-10-28 09:22:05

标签: python contextmanager

我想通过类上下文管理器强制对象实例化。所以不可能直接实例化。

我实现了这个解决方案,但从技术上讲,用户仍然可以实例化对象。

class HessioFile:
    """
    Represents a pyhessio file instance
    """
    def __init__(self, filename=None, from_context_manager=False):
        if not from_context_manager:
            raise HessioError('HessioFile can be only use with context manager')

上下文管理员:

@contextmanager
def open(filename):
    """
    ...
    """
    hessfile = HessioFile(filename, from_context_manager=True)

有更好的解决方案吗?

4 个答案:

答案 0 :(得分:2)

我不知道。通常,如果它存在于python中,您可以找到一种方法来调用它。一个上下文管理器本质上是一个资源管理方案......如果你的类在管理器之外没有用例,也许上下文管理可以集成到类的方法中?我建议从标准库中查看atexit模块。它允许您以与上下文管理器处理清理相同的方式注册清理函数,但您可以将其捆绑到您的类中,以便每个实例都具有已注册的清理函数。可能有帮助。

值得注意的是,没有多少努力会阻止人们使用您的代码做出愚蠢的事情。您最好的选择通常是让人们尽可能轻松地使用您的代码进行智能操作。

答案 1 :(得分:2)

如果您认为客户将遵循基本的python编码原则,那么可以保证,如果您不在上下文中,则不会调用您的类中的任何方法。

您的客户端不应显式调用__enter__,因此,如果调用了__enter__,则您知道您的客户端使用了with语句,因此位于上下文(__exit__将被称为。)

您只需要具有一个布尔变量,可以帮助您记住是处于上下文内部还是外部。

class Obj:
    def __init__(self):
        self.inside_context = False

    def __enter__(self):
        self.inside_context = True
        print("Entering context.")
        return self

    def __exit__(self, *exc):
        print("Exiting context.")
        self.inside_context = False

    def some_stuff(self, name):
        if not self.inside_context:
            raise Exception("This method should be called from inside context.")
        print("Doing some stuff with", name)

    def some_other_stuff(self, name):
        if not self.inside_context:
            raise Exception("This method should be called from inside context.")
        print("Doing some other stuff with", name)


with Obj() as inst_a:
    inst_a.some_stuff("A")
    inst_a.some_other_stuff("A")

inst_b = Obj()
with inst_b:
    inst_b.some_stuff("B")
    inst_b.some_other_stuff("B")

inst_c = Obj()
try:
    inst_c.some_stuff("c")
except Exception:
    print("Instance C couldn't do stuff.")
try:
    inst_c.some_other_stuff("c")
except Exception:
    print("Instance C couldn't do some other stuff.")

这将打印:

Entering context.
Doing some stuff with A
Doing some other stuff with A
Exiting context.
Entering context.
Doing some stuff with B
Doing some other stuff with B
Exiting context.
Instance C couldn't do stuff.
Instance C couldn't do some other stuff.

由于您可能有很多想“保护”从外部上下文中调用的方法,因此您可以编写装饰器以避免重复相同的代码来测试布尔值:

def raise_if_outside_context(method):
    def decorator(self, *args, **kwargs):
        if not self.inside_context:
            raise Exception("This method should be called from inside context.")
        return method(self, *args, **kwargs)
    return decorator

然后将您的方法更改为:

@raise_if_outside_context
def some_other_stuff(self, name):
    print("Doing some other stuff with", name)

答案 2 :(得分:0)

您可以想到尝试并执行此操作的hacky方法(例如检查调用堆栈以禁止直接调用您的对象,在__enter__之前设置的布尔属性允许对实例进行其他操作)但最终会变得混乱,无法理解并向其他人解释。

无论如何,你还应该确定,如果需要,人们总能找到绕过它的方法。如果你想做一些愚蠢的事情,它可以让你做到这一点;负责任的成年人吧?

如果您需要执行,最好将其作为文档通知提供。这样,如果用户选择直接实例化并触发不需要的行为,那么他们就不遵守您的代码的指导原则。

答案 3 :(得分:0)

我建议采用以下方法:

class MainClass:
    def __init__(self, *args, **kwargs):
        self._class = _MainClass(*args, **kwargs)

    def __enter__(self):
        print('entering...')
        return self._class

    def __exit__(self, exc_type, exc_val, exc_tb):
        # Teardown code
        print('running exit code...')
        pass


# This class should not be instantiated directly!!
class _MainClass:
    def __init__(self, attribute1, attribute2):
        self.attribute1 = attribute1
        self.attribute2 = attribute2
        ...

    def method(self):
        # execute code
        if self.attribute1 == "error":
            raise Exception
        print(self.attribute1)
        print(self.attribute2)


with MainClass('attribute1', 'attribute2') as main_class:
    main_class.method()
print('---')
with MainClass('error', 'attribute2') as main_class:
    main_class.method()

这将输出:

entering...
attribute1
attribute2
running exit code...
---
entering...
running exit code...
Traceback (most recent call last):
  File "scratch_6.py", line 34, in <module>
    main_class.method()
  File "scratch_6.py", line 25, in method
    raise Exception
Exception