python中定义函数时前后下划线

原创

mob649e815f494b 2024-09-16 05:24:33 ©著作权

文章标签 下划线 Python python 文章分类 Python 后端开发

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

Python中定义函数时前后下划线的使用

在Python编程中，"下划线"（underscore）是一个非常重要的符号，尤其是在定义函数和类属性时。一个函数或变量前后的下划线数目不同，表示了不同的含义。本文将深入探讨这些表示法的含义，并通过代码示例帮助大家理解其使用场景。

一、单下划线的使用

以单下划线开头（_single_leading_underscore）

这种表示法是为了指示某个变量或方法是“内部使用”的，虽然这并不是真正的私有。

class MyClass:
    def __init__(self):
        self._internal_variable = 42

    def _internal_method(self):
        print("This is an internal method.")

obj = MyClass()
print(obj._internal_variable)  # 可以访问，虽不推荐
obj._internal_method()          # 可以调用，虽不推荐

以单下划线结尾（single_trailing_underscore_）

当变量名称与Python保留字冲突时，可以使用这种形式。

class MyClass:
    def __init__(self):
        self.class_ = "This is a class variable"

obj = MyClass()
print(obj.class_)  # 正常访问

二、双下划线的使用

以双下划线开头和结尾（double_leading_and_trailing_underscore）
- 这种形式用于Python内置方法，称为“魔法方法”或“特殊方法”。这类方法不应由用户自定义，通常是Python自身使用的。
```
class MyClass:
    def __init__(self):
        self.value = 0

    def __str__(self):
        return f"MyClass with value: {self.value}"

obj = MyClass()
print(obj)  # 输出: MyClass with value: 0
```

以双下划线开头（__double_leading_underscore）

这会导致类的属性名称被重命名，以防止在子类中意外覆盖。这是实现“名字改编”的方式，提供一种不易被子类覆盖的手段。

class BaseClass:
    def __init__(self):
        self.__private_variable = 10

class DerivedClass(BaseClass):
    def __init__(self):
        super().__init__()
        self.__private_variable = 20  # 不会影响BaseClass的__private_variable

obj = DerivedClass()
# 由于名字改编，BaseClass中的__private_variable无法直接访问

三、状态图

在设计Python类和函数时，考虑到不同用户对属性的可访问性，这可以使用状态图表达。

stateDiagram
    [*] --> Public
    Public --> Private
    Private --> Internal
    Public --> Protected
    Internal --> [*]
    Protected --> [*]

如上图所示，状态图表示了不同修饰符下的状态转变，以及每种状态的可访问性。

四、流程图

在使用不同的下划线修饰符时，以下流程图可以帮助我们理解每种变量或函数的用法和访问权限。

flowchart TD
    A[开始] --> B{变量类型}
    B -->|单下划线开头| C[内部使用]
    B -->|单下划线结尾| D[避免命名冲突]
    B -->|双下划线开头| E[名字改编]
    B -->|双下划线开头与结尾| F[魔法方法]
    C --> G[可访问，建议内部使用]
    D --> H[正常访问]
    E --> I[避免被子类覆盖]
    F --> J[内部使用，不建议自定义]