Python 语言-第一章编程基础加餐之变量命名规范

1.4 变量名命名规范

• 变量名大小写敏感

• 变量名字中可以包含英文、下划线、数字，但是不能以数字开头

• python 变量命名一般采用蛇形命名法，如果变量名由两个单词组成，那么使用下划线来连接这两个单词

• 不同风格命名的变量代表不同的类型

  • 模块(module)命名风格

    • 模块尽量使用小写命名，首字母保持小写，尽量不要用下划线(除非多个单词，且数量不多的情况)

    • 示例：

      import decoder
      import html_parser
      

    • 不推荐命名：

      import Decoder
      

  • 类(class)的命名

    • 类名使用驼峰(CamelCase)命名风格，首字母大写，私有类可用一个下划线开头

    • 示例：

      class Farm():
      pass
      class AnimalFarm():
      pass
      class _PrivateFarm():
      pass
      

  • 函数(function)的命名

    • 函数名一律小写，如有多个单词，用下划线隔开

    • 示例：

      def run():
      pass
      def run_with_env():
      pass
      

  • 变量(variable)的命名

    • 变量名尽量小写, 如有多个单词，用下划线隔开

  • 常量(constant)的命名

    • 一个符号来代表常量，比如光速、π等，采用全部大写，如有多个单词，使用下划线隔开

    • 示例：

      MAX_CLIENT = 100
      
      MAX_CONNECTION = 1000
      
      CONNECTION_TIMEOUT = 600
      

• 下划线开头的特殊命名

  • 单下划线开头的命名

    • 如果类变量以单下划线“_”开头，代表这个变量不能被直接访问

    • 使用单下划线(one underline)开头的方法，则表示该方法不是AP的一部分,不要直接访问(虽然语法上访问也没有什么问题)。

  • 双下划线开头的命名

    • 以双下划线(two underlines)开头的类变量，表示为类的私有成员，不能被导入和其他类变量访问

    • 对于类中的方法，使用双下划线开头开头表示子类不能覆写该方法，一般情况不要使用这种方式

  • 双下划线开头并且双下划线结尾的命名

    • 魔法方法：以双下划线开头和双下划线结尾的变量是Python的专用标识，有其特殊的身份。一般称这样的方法为“魔法方法”(magic method)

    • 魔法方法是 python 内置方法，不需要主动调用，存在的目的是为了给 python 的解释器进行调用

  • 还有些属性只在末尾加了但下划线这仅仅是为了与 python 保留关键字冲突,没有特殊含义