发布于2021-07-18 20:14 阅读(757) 评论(0) 点赞(29) 收藏(2)
一千个读者有一千个哈姆莱特。 -- 莎士比亚
一千个程序员有一千套编码规范。 -- 不吃西红柿
作者:不吃西红柿
简介:CSDN博客专家、蓝桥签约作者、大数据&Python领域优质创作者。
【求点赞、求收藏、求评论】
Python 编码规范重要性的原因用一句话来概括就是:统一的编码规范可以提高开发效率。
无论你是 编程者,还是 阅读者,好的规范能让你的效率事半功倍,甚至机器在运行时,提高程序运行的效率。今天西红柿就带你盘一盘python的编码规范。
ps.python的代码编写基本上都要遵循PEP8的风格
不要在行尾加分号, 也不要用分号将两条命令放在同一行。
module_name, package_name, ClassName, method_name
应该避免的名称
命名约定
每行不超过80个字符
以下情况除外:
不要使用反斜杠连接行。
Python会将 圆括号, 中括号和花括号中的行隐式的连接起来 , 你可以利用这个特点. 如果需要, 你可以在表达式外围增加一对额外的圆括号。
推荐:
- foo_bar(self, width, height, color='black', design=None, x='foo',
- emphasis=None, highlight=0)
-
- if (width == 0 and height == 0 and
- color == 'red' and emphasis == 'strong'):
如果一个文本字符串在一行放不下, 可以使用圆括号来实现隐式行连接:
- x = ('这是一个非常长非常长非常长非常长 '
- '非常长非常长非常长非常长非常长非常长的字符串')
用4个空格来缩进代码
绝对不要用tab, 也不要tab和空格混用. 对于行连接的情况, 你应该要么垂直对齐换行的元素(见 :ref:`行长度 <line_length>` 部分的示例), 或者使用4空格的悬挂式缩进(这时第一行不应该有参数):
- # 与起始变量对齐
- foo = long_function_name(var_one, var_two,
- var_three, var_four)
- # 字典中与起始值对齐
- foo = {
- long_dictionary_key: value1 +
- value2,
- ...
- }
顶级定义之间空两行, 方法定义之间空一行
顶级定义之间空两行, 比如函数或者类定义. 方法定义, 类定义与第一个方法之间, 都应该空一行. 函数或方法中, 某些地方要是你觉得合适, 就空一行.
按照标准的排版规范来使用标点两边的空格
括号内不要有空格.
按照标准的排版规范来使用标点两边的空格
正确示范: spam(ham[1], {eggs: 2}, [])
错误示范: spam( ham[ 1 ], { eggs: 2 }, [ ] )
类应该在其定义下有一个用于描述该类的文档字符串. 如果你的类有公共属性(Attributes), 那么文档中应该有一个属性(Attributes)段. 并且应该遵守和函数参数相同的格式.
- class SampleClass(object):
- """Summary of class here.
- Longer class information....
- Longer class information....
- Attributes:
- likes_spam: A boolean indicating if we like SPAM or not.
- eggs: An integer count of the eggs we have laid.
- """
-
- def __init__(self, likes_spam=False):
- """Inits SampleClass with blah."""
- self.likes_spam = likes_spam
- self.eggs = 0
-
- def public_method(self):
- """Performs operation blah."""
最需要写注释的是代码中那些技巧性的部分. 如果你在下次 代码审查 的时候必须解释一下, 那么你应该现在就给它写注释. 对于复杂的操作, 应该在其操作开始前写上若干行注释. 对于不是一目了然的代码, 应在其行尾添加注释.
# We use a weighted dictionary search to find out where i is in # the array. We extrapolate position based on the largest num # in the array and the array size and then do binary search to # get the exact number. if i & (i-1) == 0: # true iff i is a power of 2为了提高可读性, 注释应该至少离开代码2个空格.
另一方面, 绝不要描述代码. 假设阅读代码的人比你更懂Python, 他只是不知道你的代码要做什么.
# BAD COMMENT: Now go through the b array and make sure whenever i occurs # the next element is i+1
- 正确示范:
- x = a + b
- x = '%s, %s!' % (imperative, expletive)
- x = '{}, {}!'.format(imperative, expletive)
- x = 'name: %s; score: %d' % (name, n)
- x = 'name: {}; score: {}'.format(name, n)
- 错误示范:
- x = '%s%s' % (a, b) # use + in this case
- x = '{}{}'.format(a, b) # use + in this case
- x = imperative + ', ' + expletive + '!'
- x = 'name: ' + name + '; score: ' + str(n)
每个导入应该独占一行
- 正确示范:
- import os
- import sys
- 错误示范:
- import os, sys
导入总应该放在文件顶部, 位于模块注释和文档字符串之后, 模块全局变量和常量之前. 导入应该按照从最通用到最不通用的顺序分组:
【求评论、求点赞、求收藏】
原文链接:https://blog.csdn.net/weixin_39032019/article/details/118417259
作者:想要飞翔的天使
链接:http://www.pythonpdf.com/blog/article/66/b6f380b1a71dd715e502/
来源:编程知识网
任何形式的转载都请注明出处,如有侵权 一经发现 必将追究其法律责任
昵称:
评论内容:(最多支持255个字符)
投诉与举报,广告合作请联系vgs_info@163.com或QQ3083709327
免责声明:网站文章均由用户上传,仅供读者学习交流使用,禁止用做商业用途。若文章涉及色情,反动,侵权等违法信息,请向我们举报,一经核实我们会立即删除!