python编码规范

简介: python编码规范

前言


python的代码编写基本上都要遵循PEP8的风格。


正文


1.命名


函数、变量及属性都应该用小写单词拼写,只见用_连接,不遵循驼峰命名法

类与异常应该首字母大写,不要用_连接

受保护的实例属性,应以单下划线开头

实例的私有属性,应以双下划线开头

模块级别的变量单词都要大写,中间以单下划线隔开

变量要尽可能有意义


2.空白


和语法相关的每一层缩进都用4个空格表示

赋值时等号两边都要有一个空格

每一行所占用的字符数应不超过79,实际操作中应当尽量不让代码编辑器的行滚动条显示出来

在使用函数进行函数式编程时,函数之间要空两行

在类中的函数,函数之间应该空一行

函数与类是同一个级别,则他们之间应该空两行

对于超出每行规定的字符数的长表达式,应当敲回车缩进,通常除了首行其余各行都要在原来的基础上再次缩进4个空格


3.语句


判断变量是否为None、False或True时不要用==,要用is,例如,if a is None

import语句应放在句首,导入时要尽量使用绝对导入不要使用相对导入,并且导入时最好指定相应的模块的某一具体功能,例如,from datetime import datetime

模块导入时应根据标准库模块、第三方模块以及自用模块进行分类

检测容器不为空时,应使用if 容器名,例如,lists = [] if lists

采用内联形式的否定词,不要把否定词放在整个表达式的前面,例如,应该if a is not None 而不是 if not a is None


4.注释


对某些重要的代码块的功能说明,应使用单行注释

对整个模块功能的说明应使用多行注释

对类或函数的功能及使用方法的详细说明应使用文档字符串

python的注释尽量使用英文


5.并发


I/O密集型,像web应用这样的场景应该使用多线程编程

计算密集型,像计算圆周率等场景应该使用多进程编程,尽可能利用多核CPU优势

   当然在编写代码时你的某些编辑器如pycharm会帮助你检测代码规范,只要认真遵循一般不会出什么问题。我们编写代码不仅是要实现某种功能,就尽管它是核心,但是你的代码在以后极有可能会交给别人去维护,所以你写的代码应当尽可能地让人看懂,避免给别人留坑。


相关文章
|
3天前
|
算法 IDE API
Python编码规范与代码可读性提升策略####
本文探讨了Python编码规范的重要性,并深入分析了如何通过遵循PEP 8等标准来提高代码的可读性和可维护性。文章首先概述了Python编码规范的基本要求,包括命名约定、缩进风格、注释使用等,接着详细阐述了这些规范如何影响代码的理解和维护。此外,文章还提供了一些实用的技巧和建议,帮助开发者在日常开发中更好地应用这些规范,从而编写出更加清晰、简洁且易于理解的Python代码。 ####
|
3月前
|
安全 搜索推荐 开发者
"揭秘Python编写的艺术境界:不规范代码的悲剧,规范之美让你事半功倍!"
【8月更文挑战第21天】编写高质量Python代码需遵循规范以提升可读性和可维护性。例如,变量命名应采用小写字母加下划线(如`user_name`而非`uName`),函数命名清晰并避免硬编码(如使用`calculate_circle_area`替代`area_of_circle`并定义精确π值)。此外,添加有意义的注释(如解释冒泡排序逻辑),合理排版(如明确函数参数与返回值),以及适当异常处理(确保文件操作安全),都是良好实践。遵循这些规范能显著提高代码质量和团队协作效率。
36 0
|
6月前
|
Python
在Python Web开发过程中:PEP 8编码规范中的一些关键规则是什么?
**PEP 8是Python代码风格指南,关键规则包括:使用4空格缩进,行最大长度79字符,函数间留2空行,每导入独占一行,运算符两侧各空一格,小写下划线命名函数,注释清晰简洁,统一引号风格,括号内不加空格,多行列表/参数末尾即使单元素也加逗号,提升代码一致性与可维护性。**
32 3
软件工程——程序编码(程序编码总原则、5个好程序标准、源程序文档化)
当工程规模很大时,而又没有完全合适的语言,可编一个专用的语言
|
程序员 Python
Python编码规范:标识符
Python编码规范:标识符
113 0
|
XML 分布式计算 算法
说说Python编码规范
说说Python编码规范
208 0
|
Java Android开发
java开发的格式与书写规范
java开发的格式与书写规范
311 0
java开发的格式与书写规范
|
Java
Java编码规范
  本文讲述了Java语言的编码规范,也是我多年书写java代码的总结。其中借鉴了oracle官方的java规范,并且结合现代互联网企业对java代码的要求,以及自己在代码书写过程中的感悟。尽量做到使代码美观,易读,易维护。由于美观,易读的代码有很多种形式,所以我只介绍我使用的形式。其实对于公司或者
7455 1
|
编解码 JSON 数据安全/隐私保护