python 类中的私有函数用什么修饰

原创

mob64ca12f0cf8f 2023-11-19 10:21:05 ©著作权

文章标签 Python 外部调用序列图 文章分类 Python 后端开发

©著作权归作者所有：来自51CTO博客作者mob64ca12f0cf8f的原创作品，请联系作者获取转载授权，否则将追究法律责任

私有函数在Python类中的修饰

Python是一种面向对象的编程语言，类是它的核心概念之一。在Python中，我们可以通过定义类来创建对象，类中的函数被称为方法。有时候，我们希望某些方法只能在类的内部使用，而不能被外部调用，这时就可以使用私有函数。

私有函数的定义

私有函数是指以双下划线（__）开头的函数。在Python中，双下划线开头的方法会被解释器重命名，使其无法直接访问。这种命名方式被称为名称修饰（name mangling），其目的是为了防止子类意外地重写父类的方法。

class MyClass:
    def __private_function(self):
        print("This is a private function.")

    def public_function(self):
        print("This is a public function.")
        self.__private_function()

obj = MyClass()
obj.public_function()  # Output: This is a public function.
obj.__private_function()  # Error: AttributeError: 'MyClass' object has no attribute '__private_function'

在上面的例子中，__private_function()是一个私有函数，只能在类的内部使用。外部无法直接调用这个函数，否则会抛出AttributeError异常。

私有函数的作用

私有函数有以下几个作用：

封装数据：私有函数可以帮助我们封装类的内部细节，将一些具体的实现逻辑隐藏起来，只暴露给外部的公共接口。这样可以提高代码的可维护性和安全性。
避免函数重写：私有函数使用名称修饰后，子类无法直接重写它。这样可以确保父类的核心逻辑不被子类意外地修改，保持代码的稳定性。
提供内部工具函数：私有函数可以作为类的内部工具函数，被其他方法调用，从而提高代码的重用性和可读性。

私有函数的调用

虽然私有函数无法在类的外部直接调用，但我们可以通过公共函数来调用私有函数。这样，私有函数就可以在类的内部被使用，而外部无法访问。

class MyClass:
    def __private_function(self):
        print("This is a private function.")

    def public_function(self):
        print("This is a public function.")
        self.__private_function()

obj = MyClass()
obj.public_function()  # Output: This is a public function. This is a private function.

在上面的例子中，public_function()是一个公共函数，它可以被外部调用。在这个函数内部，我们调用了私有函数__private_function()，这样就可以间接地使用私有函数。

序列图

为了更好地理解私有函数的调用过程，我们可以使用序列图来进行可视化展示。下面是一个序列图示例：

sequenceDiagram
    participant External as External
    participant MyClass as MyClass
    External->MyClass: obj.public_function()
    MyClass->MyClass: __private_function()
    MyClass-->External: Output: This is a private function.

在序列图中，External代表外部调用者，MyClass代表类对象。当外部调用者调用obj.public_function()时，内部会调用__private_function()来完成一些具体的操作。最后，输出结果返回给外部调用者。