Python代码规范与命名规则

1、模块

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

# 不推荐的模块名
import Decoder

2、类名

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

class AnimalFarm(Farm):
    pass

class _PrivateFarm(Farm):
    pass
  • 将相关的类和顶级函数放在同一个模块里. 不像Java, 没必要限制一个类一个模块.

3、函数

  • 函数名一律小写,如有多个单词,用下划线隔开
def run():
    pass

def run_with_env():
    pass
  • 私有函数在函数前加一个下划线_
class Person():

    def _private_func():
        pass

4、变量名

  • 变量名尽量小写, 如有多个单词,用下划线隔开
if __name__ == ‘__main__‘:
    count = 0
    school_name = ‘‘
  • 常量采用全大写,如有多个单词,使用下划线隔开
MAX_CLIENT = 100
MAX_CONNECTION = 1000
CONNECTION_TIMEOUT = 600

5、常量

  • 常量使用以下划线分隔的大写命名
MAX_OVERFLOW = 100

Class FooBar:

    def foo_bar(self, print_):
        print(print_)

原文地址:https://www.cnblogs.com/miaosha5s/p/8987344.html

时间: 2024-10-07 09:47:46

Python代码规范与命名规则的相关文章

零基础如何学好python?Python代码规范之命名规范

目录 1.模块 模块尽量使用小写命名,首字母保持小写,尽量不要用下划线(除非多个单词,且数量不多的情况) 1 ''' 2 在学习过程中有什么不懂得可以加我的 3 python学习交流扣扣qun,934109170 4 群里有不错的学习教程.开发工具与电子书籍. 5 与你分享python企业当下人才需求及怎么从零基础学习好python,和学习什么内容. 6 ''' 7 # 正确的模块名 8 import decoder 9 import html_parser 10 11 # 不推荐的模块名 12

Python代码规范

一:背景 用于规范化ocp python开发,对于使用python开发的程序使用统一的风格,便于代码的维护 二:python风格规范 分号:不要在行尾加分号,也不要用分号将两条命令放在同一行 括号:宁缺毋滥的使用括号.除非是用于实现行连接,否则不要在返回语句或者条件语句中使用括号,不过在元组两边使用括号是允许的 缩进:用4个空格来代替缩进代码.绝对不要用tab,也不要tab和空格混用.对于行连接的情况,你应该要么垂直对齐换行的元素,或者使用4空格的悬进式缩进(这时第一行不应该有参数) 空行:顶级

python代码规范 自动优化工具Black

自动优化工具Black 在众多代码格式化工具中,Black算是比较新的一个,它***的特点是可配置项比较少,个人认为这对于新手来说是件好事,因为我们不必过多考虑如何设置Black,让 Black 自己做决定就好. 1).安装与使用 与pylint类似,直接pip install black即可完成该模块的安装,不过black依赖于Python 3.6+,但它仍然可以格式化Python2的代码. 在使用方面black默认读取指定python文件并对其进行代码规范格式化,然后输出到原文件. l = 

Python代码规范(PEP8)问题及解决

安装了PyCharm,写代码过程中总是看到有波浪线,百度了下找到了这篇文章. 原文链接https://blog.csdn.net/Jason_Lewis/article/details/75386598 最近刚刚接触Python,为了养成好习惯,尽量保证自己写的代码符合PEP8代码规范,下面是过程中报出的警告及解决方法,英文有些翻译不太准确见谅,会不断更新: PEP 8: module level import not at top of file 解决:import不在文件的最上面,可能引用之

[Python3] 喝下忘情水,学习 Python 中常用的命名规则

1. 可用于"起名"的元素 字母.数字.下划线和"其它" 上面的"其它"包括中文.俄文等等 虽然 Python 支持"其它",但推荐只用字母.数字和下划线"起名" 字母打头为佳并且大小写敏感 慎用下划线打头 不能用数字打头,不能用纯数字"起名" 名字中不能有空格 Python 中的"关键字"不能用于"起名" 个人觉得没必要去记它们,若非要看,可以试

老李分享:pep8 python代码规范

什么是PEPPEP是 Python Enhancement Proposal 的缩写,翻译过来就是 Python增强建议书 . PEP8 译者:本文基于 2013-08-02 最后修改的 PEP8 版本翻译,若要查看英文原文,请参考PEP8简介 本文档给出的编码约定,来源于 Python 主发行版标准库中的代码.Python 的 C 语言实现所使用的 C 语言风格指南,请参考PEP7. 本文档与 PEP 257(文档字符串规范)都来自于 Guido1) 的 Python Style Guido

Python 代码规范

命名 module_name, package_name, ClassName, method_name, ExceptionName, function_name, GLOBAL_VAR_NAME, instance_var_name, function_parameter_name, local_var_name. 应该避免的名称 单字符名称, 除了计数器和迭代器. 包/模块名中的连字符(-) 双下划线开头并结尾的名称(Python保留, 例如__init__) 命名约定 所谓"内部(Int

MAAB建模规范(命名规则)

1 必须按如下规则对文件进行命名: 1. 格式:filename=name.extension: 2. 文件名唯一: 3. name :不能以数字#下划线开头,不能以下划雖尾:不能连续使用多于JTF划线:不能有空格:可用/小字母(a-z),大写字母(A-Z) ,数字(0-9) ,下划线(_). 4. extension :不能有空格:可用/J泻字母(a-z),大写字母(A-Z),数字(0-9). 5. 规贝: By Task > Modeling Standards for MAAB > Na

编码规范之命名规则---变量名定义规则

个人也是大众的良好风格 1.书写风格:驼峰式 int netWork 类似的帕斯卡命名法 总共有三种 http://baike.baidu.com/view/8042085.htm?fr=aladdin#3 2.前缀: 全局带g 结构体.类内成员带m 指针类型带p 带数据类型前缀的为匈牙利式 3.结构体定义 typedef struct NetWork_Param_{ int num; SocketInfo m_SocketInfo;}NetWork_Param; 4.其他细节 http://w