精华内容
下载资源
问答
  • Python代码书写规范

    2018-12-29 16:03:00
    Python 编码规范代码编排1 缩进。4个空格的缩进(编辑器都可以完成此功能),不要使用Tap,更不能混合使用Tap和空格。2 每行最大长度79,换行可以使用反斜杠,最好使用圆括号。换行点要在操作符的后边敲回车。3...

    Python 编码规范

    一 代码编排
    1 缩进。4个空格的缩进(编辑器都可以完成此功能),不要使用Tap,更不能混合使用Tap和空格。
    2 每行最大长度79,换行可以使用反斜杠,最好使用圆括号。换行点要在操作符的后边敲回车。
    3 类和top-level函数定义之间空两行;类中的方法定义之间空一行;函数内逻辑无关段落之间空一行;其他地方尽量不要再空行。

    二 文档编排
    1 模块内容的顺序:模块说明和docstring—import—globals&constants—其他定义。其中import部分,又按标准、三方和自己编写顺序依次排放,之间空一行。
    2 不要在一句import中多个库,比如import os, sys不推荐。
    3 如果采用from XX import XX引用库,可以省略‘module.’,都是可能出现命名冲突,这时就要采用import XX。

    三 空格的使用
    总体原则,避免不必要的空格。
    1 各种右括号前不要加空格。
    2 逗号、冒号、分号前不要加空格。
    3 函数的左括号前不要加空格。如Func(1)。
    4 序列的左括号前不要加空格。如list[2]。
    5 操作符左右各加一个空格,不要为了对齐增加空格。
    6 函数默认参数使用的赋值符左右省略空格。
    7 不要将多句语句写在同一行,尽管使用‘;’允许。
    8 if/for/while语句中,即使执行语句只有一句,也必须另起一行。

    四 注释
    总体原则,错误的注释不如没有注释。所以当一段代码发生变化时,第一件事就是要修改注释!
    注释必须使用英文,最好是完整的句子,首字母大写,句后要有结束符,结束符后跟两个空格,开始下一句。如果是短语,可以省略结束符。
    1 块注释,在一段代码前增加的注释。在‘#’后加一空格。段落之间以只有‘#’的行间隔。

    2 行注释,在一句代码后加注释。比如:x = x + 1 # Increment x
    但是这种方式尽量少使用。
    3 避免无谓的注释。

    五 文档描述
    1 为所有的共有模块、函数、类、方法写docstrings;非共有的没有必要,但是可以写注释(在def的下一行)。
    2 如果docstring要换行,参考如下例子,详见PEP 257

    """Return a foobang
    
    Optional plotz says to frobnicate the bizbaz first.
    
    """

    六 命名规范
    总体原则,新编代码必须按下面命名风格进行,现有库的编码尽量保持风格。
    1 尽量单独使用小写字母‘l’,大写字母‘O’等容易混淆的字母。
    2 模块命名尽量短小,使用全部小写的方式,可以使用下划线。
    3 包命名尽量短小,使用全部小写的方式,不可以使用下划线。
    4 类的命名使用CapWords的方式,模块内部使用的类采用_CapWords的方式。
    5 异常命名使用CapWords+Error后缀的方式。
    6 全局变量尽量只在模块内有效,类似C语言中的static。实现方法有两种,一是__all__机制;二是前缀一个下划线。
    7 函数命名使用全部小写的方式,可以使用下划线。
    8 常量命名使用全部大写的方式,可以使用下划线。
    9 类的属性(方法和变量)命名使用全部小写的方式,可以使用下划线。
    9 类的属性有3种作用域public、non-public和subclass API,可以理解成C++中的public、private、protected,non-public属性前,前缀一条下划线。
    11 类的属性若与关键字名字冲突,后缀一下划线,尽量不要使用缩略等其他方式。
    12 为避免与子类属性命名冲突,在类的一些属性前,前缀两条下划线。比如:类Foo中声明__a,访问时,只能通过Foo._Foo__a,避免歧义。如果子类也叫Foo,那就无能为力了。
    13 类的方法第一个参数必须是self,而静态方法第一个参数必须是cls。

    七 编码建议
    1 编码中考虑到其他python实现的效率等问题,比如运算符‘+’在CPython(Python)中效率很高,都是Jython中却非常低,所以应该采用.join()的方式。
    2 尽可能使用‘is’‘is not’取代‘==’,比如if x is not None 要优于if x。
    3 使用基于类的异常,每个模块或包都有自己的异常类,此异常类继承自Exception。
    4 异常中不要使用裸露的except,except后跟具体的exceptions。
    5 异常中try的代码尽可能少。比如:

    try:
    value = collection[key]
    except KeyError:
    return key_not_found(key)
    else:
    return handle_value(value)

    要优于

    try:
    # Too broad!
    return handle_value(collection[key])
    except KeyError:
    # Will also catch KeyError raised by handle_value()
    return key_not_found(key)

    6 使用startswith() and endswith()代替切片进行序列前缀或后缀的检查。比如

    Yes: if foo.startswith(‘bar’):优于
    No: if foo[:3] == ‘bar’:
    7 使用isinstance()比较对象的类型。比如
    Yes: if isinstance(obj, int): 优于
    No: if type(obj) is type(1):
    8 判断序列空或不空,有如下规则
    Yes: if not seq:
    if seq:
    优于
    No: if len(seq)
    if not len(seq)
    9 字符串不要以空格收尾。
    10 二进制数据判断使用 if boolvalue的方式。

    转载于:https://www.cnblogs.com/jt925/p/10196495.html

    展开全文
  • Python代码书写规范与基本使⽤
  • Q:代码等于号两边要不要空格,有影响吗A:没有影响,要习惯空格,这样更加规范美观,有辨识度,如:a = 0b = input("输入你的问题")Q:单引号、双引号、三引号的区别A:正常使用单引号和双引号都是可以的...

    Q:代码等于号两边要不要空格,有影响吗

    A:没有影响,要习惯空格,这样更加规范美观,有辨识度,如:

    a = 0

    b = input("输入你的问题")

    Q:单引号、双引号、三引号的区别

    A:正常使用单引号和双引号都是可以的,三引号表达的是换行字符串,会将引号内的所有内容打印出来,如:

    print("""你好啊

    天气真好""")

    Q:直接输入了内容不能够运行,如直接输入 你好啊,天气真好,点击运行,结果报错

    A:python代码是需要有执行的,你好啊,天气真好并不是一个执行操作

    Q:代码一直运行中

    A:检查一下终端是不是可以输入,如果代码内有输入操作的话,代码会一直显示运行中,需要

    等待输入内容

    Q:else后面不可以加条件

    A:else表达的就是其它所有情况,不可以加条件,加条件的话使用的是elif

    Q:if和else一定要同时出现吗

    A:不一定,它们都可以单独使用,else也可以和循环一起使用,表达循环外的所有情况

    Q:int(input())输入小数为何报错

    A:input输出的是字符串类型,类浮点数字符串如"1.5"中的小数点是无法被int函数识别转换

    的,所以会报错,int只能转换纯整数字符串

    Q:数据的运算

    A:整数和浮点数是可以直接加减乘除的,字符串如果用加法的话会拼在一起形成一个新的字符

    串,用乘法会多次打印如,"2"*7会得到"2222222",字符串是没有减法和除法的

    Q:input里面要不要加print

    A:不需要,input括号内的内容可以理解为是问题,在运行的时候就会把问题打印出来,如果

    加上print的话,就会打印none,这里涉及到返回值的问题,目前不需要纠结

    展开全文
  • Q:代码等于号两边要不要空格,有影响吗 A:没有影响,要习惯空格,这样更加规范美观,有辨识度,如: ...A:python代码是需要有执行的,你好啊,天气真好并不是一个执行操作 Q:代码一直运行中 A:检查一

    Q:代码等于号两边要不要空格,有影响吗
    A:没有影响,要习惯空格,这样更加规范美观,有辨识度,如:
    a = 0
    b = input(‘输入你的问题’)

    Q:单引号、双引号、三引号的区别
    A:正常使用单引号和双引号都是可以的,三引号表达的是换行字符串,会将引号内的所有内容打印出来,如:
    print(’’‘你好啊
    天气真好’’’)

    Q:直接输入了内容不能够运行,如直接输入 你好啊,天气真好,点击运行,结果报错
    A:python代码是需要有执行的,你好啊,天气真好并不是一个执行操作

    Q:代码一直运行中
    A:检查一下终端是不是可以输入,如果代码内有输入操作的话,代码会一直显示运行中,需要
    等待输入内容

    Q:else后面不可以加条件
    A:else表达的就是其它所有情况,不可以加条件,加条件的话使用的是elif

    Q:if和else一定要同时出现吗
    A:不一定,它们都可以单独使用,else也可以和循环一起使用,表达循环外的所有情况

    Q:int(input())输入小数为何报错
    A:input输出的是字符串类型,类浮点数字符串如’1.5’中的小数点是无法被int函数识别转换
    的,所以会报错,int只能转换纯整数字符串

    Q:数据的运算
    A:整数和浮点数是可以直接加减乘除的,字符串如果用加法的话会拼在一起形成一个新的字符
    串,用乘法会多次打印如,‘2’*7会得到’2222222’,字符串是没有减法和除法的

    Q:input里面要不要加print
    A:不需要,input括号内的内容可以理解为是问题,在运行的时候就会把问题打印出来,如果
    加上print的话,就会打印none,这里涉及到返回值的问题,目前不需要纠结

    Q:常见的一些报错类型
    A:
    SyntaxError: unexpected EOF while parsing
    #语法错误,多了无法解析的符号,检查一下是否多了或者少了括号
    SyntaxError: invalid character in identifier
    #语法错误有无效标识符,检查一下中文符号
    IndexError: list index out of range
    #索引错误,超出索引范围,检查一下列表是否为空
    TypeError: must be str, not int
    #数据类型错误,该数据不是正确的数据类型,比如字符串和数字直接拼接,检查一下数据类型
    IndentationError: expected an indented block
    #缩进错误,检查一下代码的缩进是否正确
    KeyError: ‘fond’
    #键错误,字典中没有该的key对应的值,检查一下键名或者字典数据是否正确
    ValueError: substring not found
    #值错误,输入的数据类型跟要求的不符合
    NameError: name ‘a’ is not defined
    #未初始化对象,变量没有被定义
    AttributeError: ‘tuple’ object has no attribute ‘remove’
    #属性错误,该对象没有这个属性、方法,检查一下数据类型
    SystemExit
    #解释器请求退出,出现在exit()函数后
    IOError
    #输入/输出操作失败
    ImportError
    #导入模块/对象失败,检查一下模块是否能够正常使用
    UnicodeDecodeError/UnicodeEncodeError/UnicodeTranslateError
    #Unicode 解码/编码/转换/时的错误

    展开全文
  • Q:代码等于号两边要不要空格,有影响吗A:没有影响,要习惯空格,这样更加规范美观,有辨识度,如:a = 0b = input('输入你的问题')Q:单引号、双引号、三引号的区别A:正常使用单引号和双引号都是可以的,三引号...

    Q:代码等于号两边要不要空格,有影响吗

    A:没有影响,要习惯空格,这样更加规范美观,有辨识度,如:

    a = 0

    b = input('输入你的问题')

    Q:单引号、双引号、三引号的区别

    A:正常使用单引号和双引号都是可以的,三引号表达的是换行字符串,会将引号内的所有内容打印出来,如:

    print('''你好啊

    天气真好''')

    Q:直接输入了内容不能够运行,如直接输入 你好啊,天气真好,点击运行,结果报错

    A:python代码是需要有执行的,你好啊,天气真好并不是一个执行操作

    Q:代码一直运行中

    A:检查一下终端是不是可以输入,如果代码内有输入操作的话,代码会一直显示运行中,需要

    等待输入内容

    Q:else后面不可以加条件

    A:else表达的就是其它所有情况,不可以加条件,加条件的话使用的是elif

    Q:if和else一定要同时出现吗

    A:不一定,它们都可以单独使用,else也可以和循环一起使用,表达循环外的所有情况

    Q:int(input())输入小数为何报错

    A:input输出的是字符串类型,类浮点数字符串如'1.5'中的小数点是无法被int函数识别转换

    的,所以会报错,int只能转换纯整数字符串

    Q:数据的运算

    A:整数和浮点数是可以直接加减乘除的,字符串如果用加法的话会拼在一起形成一个新的字符

    串,用乘法会多次打印如,'2'*7会得到'2222222',字符串是没有减法和除法的

    Q:input里面要不要加print

    A:不需要,input括号内的内容可以理解为是问题,在运行的时候就会把问题打印出来,如果

    加上print的话,就会打印none,这里涉及到返回值的问题,目前不需要纠结

    展开全文
  • python代码编写规范

    2020-08-08 08:38:24
    python程序是通过依靠代码块的缩进来体现代码块之间的逻辑关系。 对于with块、类定义、函数定义、选择结构、循环结构以及异常处理结构来说,行尾的冒号以及下一行的缩进表示一个代码块的开始,缩进结束则表示一个...
  • 现在来看看Python中有哪些编程规范。 1 编码 无特殊情况,建议Python脚本程序一律使用 UTF-8 编码,并且在文件头部必须加入#-*-coding:utf-8-*-标识,声明文件编码方式,程序文件编码要和声明编码保持一致。 2 代码...
  • python 代码规范

    2019-10-03 10:21:44
    Python注释(多行注释和单行注释)用法详解 Python单行注释 Python 中使用井号(‘#’)作为单行注释的符号,语法格式为: [root@kube python]# cat demo.py # -*- coding:utf-8 -*- #python script 注释#...
  • Python代码规范

    2018-12-20 10:57:42
    Python 代码规范 1 分号 不要在行尾加分号, 也不要用分号将两条命令放在同一行。 2 行长度 每行不超过80个字符 可以超过80个字符的情况:  (1)长的导入模块语句  (2)注释里的URL 不要使用反斜杠连接行. 事实上 ...
  • Python代码注释规范

    2019-03-02 11:24:30
    写代码过程中,注释还是十分重要的,一个规范Python代码,最好有一套自己的规范,这样别人阅读时也能清晰明了。 第1行:可以在Unix/Linux/Mac中运行 第2行:utf-8编码,# -*- coding: utf-8 -*- 第4行:文档...
  • Q:代码等于号两边要不要空格,有影响吗? A:没有影响,要习惯空格,这样更加规范美观,有辨识度,如: a = 0 b = input('输入你的问题') Q:单引号、双引号、三引号的区别 A:正常使用单引号和双引号都是...
  • Python是当今最流行的语言之一。相对较新的领域如数据科学、人工智能、...对此,小编整理了一份适合所有Python学习者的资料:Python代码整洁之道。 写出 Pythonic 代码 谈到规范首先想到就是 Python 有名的 PEP8 代码
  • python书写规范和基本使用,
  • 为什么要强调 书写规范 ?这其实并不关乎“美丑”,...如今,不管什么方向的同学都要进行“写代码”这项工作,可惜的是,很多朋友并没有意识到:花费1小时了解代码书写规范,可以为自己节省 100+ 小时的写代码的时间。
  • python书写规范

    2020-07-28 17:15:26
    与None比较要用 is 或者 is not is 比较的是地址 == 比较的是值 优先使用安全的dict.get(key) 在key不存在时会返回None ...使用推导式代替重复的逻辑操作构造序列 odd_num_list = [i for i in range(100) if i ...
  • Python代码规范和命名规范 前言 Python 学习之旅,先来看看 Python 的代码规范,让自己先有个意识,而且在往后的学习中慢慢养成习惯 一、简明概述 1、编码 如无特殊情况, 文件一律使用 UTF-8 编码 如...
  • 一、 指定response返回的格式类型是json 我们客户端(浏览器)的request对象发送到服务器端,服务器做出响应,把response对象发送给客户端。我们也不能把response就认为是我们看到的五颜六色的页面,那只是response...
  • Python编程格式规范

    千次阅读 2020-07-30 13:35:39
    本文就是介绍Python语言常见的基本的书写规范。 本文主要从编码、缩进/空格/空行、命名、注释等几个方面来说书写格式需要注意的地方。 1.编码 如果没有特殊的编码要求,建议在文件头部加一行# -*- encoding: utf-8 -...
  • 今天就来推荐3个利器,python界广泛认同的代码风格规范PEP8和两个超牛的工具pylint和black,分别用于代码风格规范检测和自动优化。 更多Python视频、源码、资料加群683380553免费获取 1、代码风格规范PEP8 首先讲...

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 10,644
精华内容 4,257
关键字:

python代码书写规范

python 订阅