Skip to content
SRE运维进阶之路SRE运维进阶之路
github icon
    • 1 Python 简介

      • 1.1 初识Python
        • 1.2 Python 代码规范
          • 简明概述
            • 代码格式
              • import 语句
                • 空格
                  • 换行
                    • docstring
                    • 注释
                      • 块注释
                        • 行注释
                          • 建议
                            • 文档注释(Docstring)
                            • 命名规范
                              • 模块
                                • 类名
                                  • 函数
                                    • 变量名
                                      • 常量
                                    • 1.3 Python 虚拟环境
                                      • 1.4 使用 vscode 打造 python 开发环境
                                        • 1.5 pypi 配置国内镜像
                                        • 2 Python 基础

                                          • 2.1 Python基础语法
                                            • 2.2 程序控制
                                              • 2.3 Python数据类型

                                                • 2.3.1 数值型
                                                  • 2.3.2 字符串 str
                                                    • 2.3.3 字节序列
                                                      • 2.3.4 列表 list & 元组 tuple
                                                        • 2.3.5 集合 set & 字典 dict
                                                      • 3 高级特性

                                                        • 3.1 线性结构特征 可迭代 & 切片
                                                          • 3.2 列表、集合、字典解析式
                                                            • 3.3 生成器
                                                              • 3.4 迭代器
                                                              • 4 函数

                                                                • 4.1 函数的定义 & 调用 & 返回值
                                                                  • 4.2 函数参数
                                                                    • 4.3 作用域
                                                                      • 4.4 递归函数
                                                                      • 5 函数式编程

                                                                        • 5.1 高阶函数
                                                                          • 5.2 返回函数
                                                                            • 5.3 匿名函数
                                                                              • 5.4 装饰器
                                                                                • 5.5 偏函数
                                                                                • 6 模块

                                                                                  • 6.1 Python 模块常用的几种安装方式
                                                                                    • 6.2 Python 的 setup.py 详解
                                                                                    • 7 IO编程

                                                                                      • 7.1 操作文件和目录
                                                                                        • 7.2 序列化和反序列化
                                                                                        • 8 异常、调试和测试

                                                                                          • 8.1 异常处理
                                                                                          • 9 面向对象编程

                                                                                            • 9.1 类、实例和封装
                                                                                              • 9.2 访问控制和属性装饰器
                                                                                                • 9.3 继承、多态和Mixin
                                                                                                • 10 进程和线程

                                                                                                  • 10.1 多进程
                                                                                                    • 10.2 多线程
                                                                                                      • 10.2 线程同步
                                                                                                      • 11 网络编程

                                                                                                        • 11.1 SocketServer
                                                                                                          • 11.2 TCP 编程
                                                                                                          • 11 魔术方法
                                                                                                            • 17 IO 模型
                                                                                                              • python 实际工作中的实例
                                                                                                              • 前端学习笔记

                                                                                                                1.2 Python 代码规范

                                                                                                                author iconClaycalendar icon2021年6月8日category icon
                                                                                                                • Python
                                                                                                                timer icon大约 7 分钟

                                                                                                                此页内容
                                                                                                                • 简明概述
                                                                                                                  • 代码格式
                                                                                                                  • import 语句
                                                                                                                  • 空格
                                                                                                                  • 换行
                                                                                                                  • docstring
                                                                                                                • 注释
                                                                                                                  • 块注释
                                                                                                                  • 行注释
                                                                                                                  • 建议
                                                                                                                  • 文档注释(Docstring)
                                                                                                                • 命名规范
                                                                                                                  • 模块
                                                                                                                  • 类名
                                                                                                                  • 函数
                                                                                                                  • 变量名
                                                                                                                  • 常量

                                                                                                                # 1.2 Python 代码规范

                                                                                                                转载自:草根学 Python | TwoWater

                                                                                                                # 简明概述

                                                                                                                # 代码格式

                                                                                                                # 缩进

                                                                                                                • 统一使用 4 个空格进行缩进

                                                                                                                # 行宽

                                                                                                                每行代码尽量不超过 80 个字符(在特殊情况下可以略微超过 80 ,但最长不得超过 120)

                                                                                                                理由:

                                                                                                                • 这在查看 side-by-side 的 diff 时很有帮助
                                                                                                                • 方便在控制台下查看代码
                                                                                                                • 太长可能是设计有缺陷

                                                                                                                # 引号

                                                                                                                简单说,自然语言使用双引号,机器标示使用单引号,因此 代码里 多数应该使用 单引号

                                                                                                                • 自然语言使用双引号 "..." 例如错误信息;很多情况还是 unicode,使用u"你好世界"
                                                                                                                • 机器标识使用单引号 '...' 例如 dict 里的 key
                                                                                                                • 正则表达式使用原生的双引号 r"..."
                                                                                                                • 文档字符串 (docstring)使用三个双引号 """......"""

                                                                                                                # 空行

                                                                                                                • 模块级函数和类定义之间空两行;
                                                                                                                • 类成员函数之间空一行;
                                                                                                                class A:
                                                                                                                
                                                                                                                    def __init__(self):
                                                                                                                        pass
                                                                                                                
                                                                                                                    def hello(self):
                                                                                                                        pass
                                                                                                                
                                                                                                                
                                                                                                                def main():
                                                                                                                    pass
                                                                                                                
                                                                                                                1
                                                                                                                2
                                                                                                                3
                                                                                                                4
                                                                                                                5
                                                                                                                6
                                                                                                                7
                                                                                                                8
                                                                                                                9
                                                                                                                10
                                                                                                                11
                                                                                                                • 可以使用多个空行分隔多组相关的函数
                                                                                                                • 函数中可以使用空行分隔出逻辑相关的代码

                                                                                                                # import 语句

                                                                                                                • import 语句应该分行书写
                                                                                                                # 正确的写法
                                                                                                                import os
                                                                                                                import sys
                                                                                                                
                                                                                                                # 不推荐的写法
                                                                                                                import sys,os
                                                                                                                
                                                                                                                # 正确的写法
                                                                                                                from subprocess import Popen, PIPE
                                                                                                                
                                                                                                                1
                                                                                                                2
                                                                                                                3
                                                                                                                4
                                                                                                                5
                                                                                                                6
                                                                                                                7
                                                                                                                8
                                                                                                                9
                                                                                                                • import语句应该使用 absolute import
                                                                                                                # 正确的写法
                                                                                                                from foo.bar import Bar
                                                                                                                
                                                                                                                # 不推荐的写法
                                                                                                                from ..bar import Bar
                                                                                                                
                                                                                                                1
                                                                                                                2
                                                                                                                3
                                                                                                                4
                                                                                                                5
                                                                                                                • import语句应该放在文件头部,置于模块说明及docstring之后,于全局变量之前;
                                                                                                                • import语句应该按照顺序排列,每组之间用一个空行分隔
                                                                                                                import os
                                                                                                                import sys
                                                                                                                
                                                                                                                import msgpack
                                                                                                                import zmq
                                                                                                                
                                                                                                                import foo
                                                                                                                
                                                                                                                1
                                                                                                                2
                                                                                                                3
                                                                                                                4
                                                                                                                5
                                                                                                                6
                                                                                                                7
                                                                                                                • 导入其他模块的类定义时,可以使用相对导入
                                                                                                                from myclass import MyClass
                                                                                                                
                                                                                                                1
                                                                                                                • 如果发生命名冲突,则可使用命名空间
                                                                                                                import bar
                                                                                                                import foo.bar
                                                                                                                
                                                                                                                bar.Bar()
                                                                                                                foo.bar.Bar()
                                                                                                                
                                                                                                                1
                                                                                                                2
                                                                                                                3
                                                                                                                4
                                                                                                                5

                                                                                                                # 空格

                                                                                                                • 在二元运算符两边各空一格[=,-,+=,==,>,in,is not, and]:
                                                                                                                # 正确的写法
                                                                                                                i = i + 1
                                                                                                                submitted += 1
                                                                                                                x = x * 2 - 1
                                                                                                                hypot2 = x * x + y * y
                                                                                                                c = (a + b) * (a - b)
                                                                                                                
                                                                                                                # 不推荐的写法
                                                                                                                i=i+1
                                                                                                                submitted +=1
                                                                                                                x = x*2 - 1
                                                                                                                hypot2 = x*x + y*y
                                                                                                                c = (a+b) * (a-b)
                                                                                                                
                                                                                                                1
                                                                                                                2
                                                                                                                3
                                                                                                                4
                                                                                                                5
                                                                                                                6
                                                                                                                7
                                                                                                                8
                                                                                                                9
                                                                                                                10
                                                                                                                11
                                                                                                                12
                                                                                                                13
                                                                                                                • 函数的参数列表中,,之后要有空格
                                                                                                                # 正确的写法
                                                                                                                def complex(real, imag):
                                                                                                                    pass
                                                                                                                
                                                                                                                # 不推荐的写法
                                                                                                                def complex(real,imag):
                                                                                                                    pass
                                                                                                                
                                                                                                                1
                                                                                                                2
                                                                                                                3
                                                                                                                4
                                                                                                                5
                                                                                                                6
                                                                                                                7
                                                                                                                • 函数的参数列表中,默认值等号两边不要添加空格
                                                                                                                # 正确的写法
                                                                                                                def complex(real, imag=0.0):
                                                                                                                    pass
                                                                                                                
                                                                                                                # 不推荐的写法
                                                                                                                def complex(real, imag = 0.0):
                                                                                                                    pass
                                                                                                                
                                                                                                                1
                                                                                                                2
                                                                                                                3
                                                                                                                4
                                                                                                                5
                                                                                                                6
                                                                                                                7
                                                                                                                • 左括号之后,右括号之前不要加多余的空格
                                                                                                                # 正确的写法
                                                                                                                spam(ham[1], {eggs: 2})
                                                                                                                
                                                                                                                # 不推荐的写法
                                                                                                                spam( ham[1], { eggs : 2 } )
                                                                                                                
                                                                                                                1
                                                                                                                2
                                                                                                                3
                                                                                                                4
                                                                                                                5
                                                                                                                • 字典对象的左括号之前不要多余的空格
                                                                                                                # 正确的写法
                                                                                                                dict['key'] = list[index]
                                                                                                                
                                                                                                                # 不推荐的写法
                                                                                                                dict ['key'] = list [index]
                                                                                                                
                                                                                                                1
                                                                                                                2
                                                                                                                3
                                                                                                                4
                                                                                                                5
                                                                                                                • 不要为对齐赋值语句而使用的额外空格
                                                                                                                # 正确的写法
                                                                                                                x = 1
                                                                                                                y = 2
                                                                                                                long_variable = 3
                                                                                                                
                                                                                                                # 不推荐的写法
                                                                                                                x             = 1
                                                                                                                y             = 2
                                                                                                                long_variable = 3
                                                                                                                
                                                                                                                1
                                                                                                                2
                                                                                                                3
                                                                                                                4
                                                                                                                5
                                                                                                                6
                                                                                                                7
                                                                                                                8
                                                                                                                9

                                                                                                                # 换行

                                                                                                                Python 支持括号内的换行。这时有两种情况。

                                                                                                                1. 第二行缩进到括号的起始处
                                                                                                                foo = long_function_name(var_one, var_two,
                                                                                                                                         var_three, var_four)
                                                                                                                
                                                                                                                1
                                                                                                                2
                                                                                                                1. 第二行缩进 4 个空格,适用于起始括号就换行的情形
                                                                                                                def long_function_name(
                                                                                                                        var_one, var_two, var_three,
                                                                                                                        var_four):
                                                                                                                    print(var_one)
                                                                                                                
                                                                                                                1
                                                                                                                2
                                                                                                                3
                                                                                                                4

                                                                                                                使用反斜杠\换行,二元运算符+ .等应出现在行末;长字符串也可以用此法换行

                                                                                                                session.query(MyTable).\
                                                                                                                        filter_by(id=1).\
                                                                                                                        one()
                                                                                                                
                                                                                                                print 'Hello, '\
                                                                                                                      '%s %s!' %\
                                                                                                                      ('Harry', 'Potter')
                                                                                                                
                                                                                                                1
                                                                                                                2
                                                                                                                3
                                                                                                                4
                                                                                                                5
                                                                                                                6
                                                                                                                7

                                                                                                                禁止复合语句,即一行中包含多个语句:

                                                                                                                # 正确的写法
                                                                                                                do_first()
                                                                                                                do_second()
                                                                                                                do_third()
                                                                                                                
                                                                                                                # 不推荐的写法
                                                                                                                do_first();do_second();do_third();
                                                                                                                
                                                                                                                1
                                                                                                                2
                                                                                                                3
                                                                                                                4
                                                                                                                5
                                                                                                                6
                                                                                                                7

                                                                                                                if/for/while一定要换行:

                                                                                                                # 正确的写法
                                                                                                                if foo == 'blah':
                                                                                                                    do_blah_thing()
                                                                                                                
                                                                                                                # 不推荐的写法
                                                                                                                if foo == 'blah': do_blash_thing()
                                                                                                                
                                                                                                                1
                                                                                                                2
                                                                                                                3
                                                                                                                4
                                                                                                                5
                                                                                                                6

                                                                                                                # docstring

                                                                                                                docstring 的规范中最其本的两点:

                                                                                                                1. 所有的公共模块、函数、类、方法,都应该写 docstring 。私有方法不一定需要,但应该在 def 后提供一个块注释来说明。
                                                                                                                2. docstring 的结束"""应该独占一行,除非此 docstring 只有一行。
                                                                                                                """Return a foobar
                                                                                                                Optional plotz says to frobnicate the bizbaz first.
                                                                                                                """
                                                                                                                
                                                                                                                """Oneline docstring"""
                                                                                                                
                                                                                                                1
                                                                                                                2
                                                                                                                3
                                                                                                                4
                                                                                                                5

                                                                                                                # 注释

                                                                                                                # 块注释

                                                                                                                “#”号后空一格,段落件用空行分开(同样需要“#”号)

                                                                                                                # 块注释
                                                                                                                # 块注释
                                                                                                                #
                                                                                                                # 块注释
                                                                                                                # 块注释
                                                                                                                
                                                                                                                1
                                                                                                                2
                                                                                                                3
                                                                                                                4
                                                                                                                5

                                                                                                                # 行注释

                                                                                                                至少使用两个空格和语句分开,注意不要使用无意义的注释

                                                                                                                # 正确的写法
                                                                                                                x = x + 1  # 边框加粗一个像素
                                                                                                                
                                                                                                                # 不推荐的写法(无意义的注释)
                                                                                                                x = x + 1 # x加1
                                                                                                                
                                                                                                                1
                                                                                                                2
                                                                                                                3
                                                                                                                4
                                                                                                                5

                                                                                                                # 建议

                                                                                                                • 在代码的关键部分(或比较复杂的地方), 能写注释的要尽量写注释
                                                                                                                • 比较重要的注释段, 使用多个等号隔开, 可以更加醒目, 突出重要性
                                                                                                                app = create_app(name, options)
                                                                                                                
                                                                                                                
                                                                                                                # =====================================
                                                                                                                # 请勿在此处添加 get post等app路由行为 !!!
                                                                                                                # =====================================
                                                                                                                
                                                                                                                
                                                                                                                if __name__ == '__main__':
                                                                                                                    app.run()
                                                                                                                
                                                                                                                1
                                                                                                                2
                                                                                                                3
                                                                                                                4
                                                                                                                5
                                                                                                                6
                                                                                                                7
                                                                                                                8
                                                                                                                9
                                                                                                                10

                                                                                                                # 文档注释(Docstring)

                                                                                                                作为文档的Docstring一般出现在模块头部、函数和类的头部,这样在python中可以通过对象的__doc__对象获取文档. 编辑器和IDE也可以根据Docstring给出自动提示.

                                                                                                                • 文档注释以 """ 开头和结尾, 首行不换行, 如有多行, 末行必需换行, 以下是Google的docstring风格示例
                                                                                                                # -*- coding: utf-8 -*-
                                                                                                                """Example docstrings.
                                                                                                                
                                                                                                                This module demonstrates documentation as specified by the `Google Python
                                                                                                                Style Guide`_. Docstrings may extend over multiple lines. Sections are created
                                                                                                                with a section header and a colon followed by a block of indented text.
                                                                                                                
                                                                                                                Example:
                                                                                                                    Examples can be given using either the ``Example`` or ``Examples``
                                                                                                                    sections. Sections support any reStructuredText formatting, including
                                                                                                                    literal blocks::
                                                                                                                
                                                                                                                        $ python example_google.py
                                                                                                                
                                                                                                                Section breaks are created by resuming unindented text. Section breaks
                                                                                                                are also implicitly created anytime a new section starts.
                                                                                                                """
                                                                                                                
                                                                                                                1
                                                                                                                2
                                                                                                                3
                                                                                                                4
                                                                                                                5
                                                                                                                6
                                                                                                                7
                                                                                                                8
                                                                                                                9
                                                                                                                10
                                                                                                                11
                                                                                                                12
                                                                                                                13
                                                                                                                14
                                                                                                                15
                                                                                                                16
                                                                                                                17
                                                                                                                • 不要在文档注释复制函数定义原型, 而是具体描述其具体内容, 解释具体参数和返回值等
                                                                                                                #  不推荐的写法(不要写函数原型等废话)
                                                                                                                def function(a, b):
                                                                                                                    """function(a, b) -> list"""
                                                                                                                    ... ...
                                                                                                                
                                                                                                                
                                                                                                                #  正确的写法
                                                                                                                def function(a, b):
                                                                                                                    """计算并返回a到b范围内数据的平均值"""
                                                                                                                    ... ...
                                                                                                                
                                                                                                                1
                                                                                                                2
                                                                                                                3
                                                                                                                4
                                                                                                                5
                                                                                                                6
                                                                                                                7
                                                                                                                8
                                                                                                                9
                                                                                                                10
                                                                                                                • 对函数参数、返回值等的说明采用numpy标准, 如下所示
                                                                                                                def func(arg1, arg2):
                                                                                                                    """在这里写函数的一句话总结(如: 计算平均值).
                                                                                                                
                                                                                                                    这里是具体描述.
                                                                                                                
                                                                                                                    参数
                                                                                                                    ----------
                                                                                                                    arg1 : int
                                                                                                                        arg1的具体描述
                                                                                                                    arg2 : int
                                                                                                                        arg2的具体描述
                                                                                                                
                                                                                                                    返回值
                                                                                                                    -------
                                                                                                                    int
                                                                                                                        返回值的具体描述
                                                                                                                
                                                                                                                    参看
                                                                                                                    --------
                                                                                                                    otherfunc : 其它关联函数等...
                                                                                                                
                                                                                                                    示例
                                                                                                                    --------
                                                                                                                    示例使用doctest格式, 在`>>>`后的代码可以被文档测试工具作为测试用例自动运行
                                                                                                                
                                                                                                                    >>> a=[1,2,3]
                                                                                                                    >>> print [x + 3 for x in a]
                                                                                                                    [4, 5, 6]
                                                                                                                    """
                                                                                                                
                                                                                                                1
                                                                                                                2
                                                                                                                3
                                                                                                                4
                                                                                                                5
                                                                                                                6
                                                                                                                7
                                                                                                                8
                                                                                                                9
                                                                                                                10
                                                                                                                11
                                                                                                                12
                                                                                                                13
                                                                                                                14
                                                                                                                15
                                                                                                                16
                                                                                                                17
                                                                                                                18
                                                                                                                19
                                                                                                                20
                                                                                                                21
                                                                                                                22
                                                                                                                23
                                                                                                                24
                                                                                                                25
                                                                                                                26
                                                                                                                27
                                                                                                                28
                                                                                                                29
                                                                                                                • 文档注释不限于中英文, 但不要中英文混用
                                                                                                                • 文档注释不是越长越好, 通常一两句话能把情况说清楚即可
                                                                                                                • 模块、公有类、公有方法, 能写文档注释的, 应该尽量写文档注释

                                                                                                                # 命名规范

                                                                                                                # 模块

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

                                                                                                                # 类名

                                                                                                                • 类名使用驼峰(CamelCase)命名风格,首字母大写,私有类可用一个下划线开头
                                                                                                                class Farm():
                                                                                                                    pass
                                                                                                                
                                                                                                                class AnimalFarm(Farm):
                                                                                                                    pass
                                                                                                                
                                                                                                                class _PrivateFarm(Farm):
                                                                                                                    pass
                                                                                                                
                                                                                                                1
                                                                                                                2
                                                                                                                3
                                                                                                                4
                                                                                                                5
                                                                                                                6
                                                                                                                7
                                                                                                                8
                                                                                                                • 将相关的类和顶级函数放在同一个模块里. 不像Java, 没必要限制一个类一个模块.

                                                                                                                # 函数

                                                                                                                • 函数名一律小写,如有多个单词,用下划线隔开
                                                                                                                def run():
                                                                                                                    pass
                                                                                                                
                                                                                                                def run_with_env():
                                                                                                                    pass
                                                                                                                
                                                                                                                1
                                                                                                                2
                                                                                                                3
                                                                                                                4
                                                                                                                5
                                                                                                                • 私有函数在函数前加一个下划线_
                                                                                                                class Person():
                                                                                                                
                                                                                                                    def _private_func():
                                                                                                                        pass
                                                                                                                
                                                                                                                1
                                                                                                                2
                                                                                                                3
                                                                                                                4

                                                                                                                # 变量名

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

                                                                                                                # 常量

                                                                                                                • 常量使用以下划线分隔的大写命名
                                                                                                                MAX_OVERFLOW = 100
                                                                                                                
                                                                                                                Class FooBar:
                                                                                                                
                                                                                                                    def foo_bar(self, print_):
                                                                                                                        print(print_)
                                                                                                                
                                                                                                                1
                                                                                                                2
                                                                                                                3
                                                                                                                4
                                                                                                                5
                                                                                                                6
                                                                                                                edit icon编辑此页open in new window
                                                                                                                上次编辑于: 2021/6/8 07:36:45
                                                                                                                贡献者: clay-wangzhi
                                                                                                                上一页
                                                                                                                1.1 初识Python
                                                                                                                下一页
                                                                                                                1.3 Python 虚拟环境
                                                                                                                备案号:冀ICP备2021007336号
                                                                                                                Copyright © 2023 Clay