在使用API时使函数不可访问

  • 本文关键字:访问 函数 API python
  • 更新时间 :
  • 英文 :


我正在为我的网站开发API,我将发布API作为Python的包。如何使函数不能从类对象访问?我尝试过使用classmethod,但似乎不起作用,我仍然可以从外部Python文件访问该函数。

main.py

class MyClass:
def __init__(self):
self.my_var = 5

@classmethod
def dont_access_me(self) -> str:
return 'Dont Access Me'

秒.py

from main import MyClass
instance = MyClass()
print(instance.dont_access_me()) # valid

Python并没有真正的私有方法。

但是,如果您希望表明用户不应使用此函数,并且用户不能期望此函数在API的未来版本中存在或具有相同的签名,则通常的做法是在方法前面加下划线。

如果你有:

class MyClass:
def __init__(self):
self.my_var = 5
def amethod(self):
rslt = self._dont_access_me()
def _dont_access_me(self) -> str:
return 'Dont Access Me'
instance = MyClass()

然后用户知道,他们可以使用。

instance.amethod(),但不应使用instance._dont_access_me()

类方法与大多数其他编程语言中的方法完全不同。它们用于可以在没有实例的情况下调用的方法,但是,如果您有一个实例,也可以调用它们。

例如:

class AClass:
instance_count = 0
def __init__(self):
cls = self.__class__
cls.instance_count += 1
self.idx = cls.instance_count
@classmethod
def statistics(cls):
print("So far %d objects were instantiated" %
cls.instance_count)

a = AClass()
b = AClass()
AClass.statistics()
# However you can also access a classmethod if you have an instance
a.statistics()

不能使类方法真正私有。在这个问题中有一个很好的讨论:为什么Python';s';private';方法实际上不是私有的?

我不确定这是否是您想要的,但您可以将其作为一个私有方法,类似于以下内容:

def _dont_access_me(self):
return 'Dont Access Me'

从技术上讲,它仍然可以访问,但它至少让用户知道它是作为一种专用方法

最新更新