在 python 中区分从类（或文件）内部和外部访问类属性

Question

让我们有一个 Python 中的示例类 Foo：

class Foo:
    bar = 'bar'
    def access_bar(self):
        return self.bar  

例如，我可以在直接访问Foo().bar 时打印警告，但同时在调用Foo().access_bar()（从类中访问该属性）时不打印此警告吗？

我尝试实现__getattribute__ 方法，但没有成功区分这些情况。

我知道这是一个很奇怪的问题，但请不要像“你不应该需要这个”那样回答我。

Answer 1

这是您问题的“真实”答案，您可能不应该这样做：

import inspect


class Foo:
    bar = 'bar'

    def access_bar(self):
        return self.bar

    def __getattribute__(self, item):
        if item == 'bar':
            code = inspect.currentframe().f_back.f_code
            if not (start_lineno <= code.co_firstlineno <= end_lineno
                    and code.co_filename == __file__):
                print('Warning: accessing bar directly')
        return super().__getattribute__(item)


lines, start_lineno = inspect.getsourcelines(Foo)
end_lineno = start_lineno + len(lines) - 1

print(1, Foo().bar)
print(2, Foo().access_bar())

如果您这样做，重要的是文件中只有一个名为 Foo 的类，否则 inspect.getsourcelines(Foo) 可能不会给出正确的结果。

Answer 2

您可以将bar 设为允许控制访问而不向外部显示方法调用的属性，并将您的属性设为私有：

class Foo:
    __bar = 'bar'
    @property
    def bar(self):
        print("direct access")
        return Foo.__bar
    def access_bar(self):
        return self.__bar

f = Foo()

print("warn",f.bar)
print("OK",f.access_bar())

打印：

direct access
warn bar
OK bar

Answer 3

我建议将值存储在受保护的（一个前导下划线）或私有（两个下划线）属性中，并使bar 成为可以安全访问的属性，相当于您问题中的access_bar。这就是在 Python 中通常完成此类事情的方式。

class Foo:
    _bar = 'bar'

    @property
    def bar(self):
        # do extra things here
        return self._bar

用户仍然可以编写foo._bar 或foo._Foo__bar（用于私有属性）以在没有任何警告的情况下从外部获取该属性，但如果他们知道围绕前导下划线的约定，他们可能会对此感到有些不舒服，并且请注意风险。

Answer 4

这是改进Alex's answer 的另一种尝试，方法是添加一个元类以便它也适用于类属性，并取消inspect 模块，而是向__getattribute__ 函数本身添加一个警告标志。

class FooType(type):
    def __getattribute__(self, item):
        if item == "bar":
            print("Warning: accessing bar directly from class")
        return item.__getattribute__(self, item)

class Foo(object, metaclass=FooType):
    bar = 'bar'

    def access_bar(self):
        return self.__getattribute__('bar', warn=False)

    def __getattribute__(self, item, warn=True):
        if item == 'bar' and warn:
            print('Warning: accessing bar directly from instance')
        return super().__getattribute__(item)


print(Foo.bar)
#Warning: accessing bar directly from class
#bar

print(Foo().bar)
#Warning: accessing bar directly from instance
#bar

print(Foo().access_bar())
#bar