python开发过程中注意编码规范~-CSDN博客

---

一、 代码编排

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、protectednon-public属性前前缀一条下划线。
11 类的属性若与关键字名字冲突后缀一下划线尽量不要使用缩略等其他方式。
12 为避免与子类属性命名冲突在类的一些属性前前缀两条下划线。比如类Foo中声明__a,访问时只能通过Foo._Foo__a避免歧义。如果子类也叫Foo那就无能为力了。
13 类的方法第一个参数必须是self而静态方法第一个参数必须是cls。

七 编码建议

1 编码中考虑到其他python实现的效率等问题比如运算符‘+‘在CPythonPython中效率很高都是Jython中却非常低所以应该采用.join()的方式。
2 尽可能使用‘is’‘is not’取代‘=='比如if x is not None 要优于if x。
3 使用基于类的异常每个模块或包都有自己的异常类此异常类继承自Exception。
4 异常中不要使用裸露的exceptexcept后跟具体的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的方式。

以上就是在pytho开发过程中的一些注意的点

---

关于Python技术储备

学好 Python 不论是就业还是做副业赚钱都不错但要学会 Python 还是要有一个学习规划。最后大家分享一份全套的 Python 学习资料给那些想学习 Python 的小伙伴们一点帮助

CSDN大礼包《Python入门资料&实战源码&安装工具】免费领取安全链接放心点击

一、Python所有方向的学习路线

Python所有方向的技术点做的整理形成各个领域的知识点汇总它的用处就在于你可以按照上面的知识点去找对应的学习资源保证自己学得较为全面。

二、Python基础学习视频

② 路线对应学习视频

还有很多适合0基础入门的学习视频有了这些视频轻轻松松上手Python~在这里插入图片描述

③练习题

每节视频课后都有对应的练习题哦可以检验学习成果哈哈

因篇幅有限仅展示部分资料

三、精品Python学习书籍

当我学到一定基础有自己的理解能力的时候会去阅读一些前辈整理的书籍或者手写的笔记资料这些笔记详细记载了他们对一些技术点的理解这些理解是比较独到可以学到不一样的思路。

四、Python工具包+项目源码合集

①Python工具包

学习Python常用的开发软件都在这里了每个都有详细的安装教程保证你可以安装成功哦

②Python实战案例

光学理论是没用的要学会跟着一起敲代码动手实操才能将自己的所学运用到实际当中去这时候可以搞点实战案例来学习。100+实战案例源码等你来拿

③Python小游戏源码

如果觉得上面的实战案例有点枯燥可以试试自己用Python编写小游戏让你的学习过程中增添一点趣味

五、面试资料

我们学习Python必然是为了找到高薪的工作下面这些面试题是来自阿里、腾讯、字节等一线互联网大厂最新的面试资料并且有阿里大佬给出了权威的解答刷完这一套面试资料相信大家都能找到满意的工作。

六、Python兼职渠道

而且学会Python以后还可以在各大兼职平台接单赚钱各种兼职渠道+兼职注意事项+如何和客户沟通我都整理成文档了。


这份完整版的Python全套学习资料已经上传CSDN朋友们如果需要可以微信扫描下方CSDN官方认证二维码免费领取【保证100%免费】