【Effective Python】2-Pythonic-遵循 PEP 8 风格指南

2023-10-06 13:30

本文主要是介绍【Effective Python】2-Pythonic-遵循 PEP 8 风格指南,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

2-Pythonic-遵循 PEP 8 风格指南

PEP 8 的意义

《Python Enhancement Proposal 8》又叫 PEP 8,它是针对 Python 代码格式而编制的风格指南。
链接:https://www.python.org/dev/peps/pep-0008/

  • 主要作用:
    • 有利于编写更加通俗易懂的代码。
    • 有利于多人协作,有利于修改。

几条重要的规则

命名
  • 函数、变量以及属性应该用小写字母来拼写。
def sum_a_+_b(int a, int b):...
  • 与异常,应该以每个单词首字母大写的形式来命名。
class SmallCar():...
#
CapitalizedWord
  • 模块级别的常量,应该全部采用大写字母来拼写,各单词下划线连接。
ALL_CAPS
  • 受保护的实例属性,应该以单个下划线开头。
_leading_underscore
  • 私有的实例属性,应该以两个下划线开头。
__double_leading_underscore
空白
  • 在变量赋值的时候,赋值符号的左侧和右侧应该各自写上一个空格。
  • 文件中的函数之间应该用两个空格隔开。
  • 同一个类中各方法之间应该用一个空格隔开。
  • 对于占据多行的长表达式来说,除了首行之外的其余各行都应该在通常的缩进级别之上再加4个空格。
表达式和语句
  • 不要用 if len(a) == 0 来判断 a 列表是否为空值。
if not a: # 判断 a 是空...
if a: # 判断 a 不空...
  • 采用内联形式的否定词,而不是把否定词放到整个表达式前面。
if a is not b: # 推荐
if not a is b: # 不推荐
  • 不要编写单行的 if 语句、for 循环、while 循环及 except 复合语句。

  • import

    • import 语句总是放在文件开头。
    • import 语句根据顺序分为三个部分:
      • 标准库模块
      • 第三方模块
      • 自用模块
    • 在每一模块中,按照字母顺序排列。

Pylint 流行的 Python 源码静态分析工具。
它可以自动检测受测代码是否符合 PEP 8 的风格。

这篇关于【Effective Python】2-Pythonic-遵循 PEP 8 风格指南的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/153177

相关文章

Python FastMCP构建MCP服务端与客户端的详细步骤

《PythonFastMCP构建MCP服务端与客户端的详细步骤》MCP(Multi-ClientProtocol)是一种用于构建可扩展服务的通信协议框架,本文将使用FastMCP搭建一个支持St... 目录简介环境准备服务端实现(server.py)客户端实现(client.py)运行效果扩展方向常见问题结

详解如何使用Python构建从数据到文档的自动化工作流

《详解如何使用Python构建从数据到文档的自动化工作流》这篇文章将通过真实工作场景拆解,为大家展示如何用Python构建自动化工作流,让工具代替人力完成这些数字苦力活,感兴趣的小伙伴可以跟随小编一起... 目录一、Excel处理:从数据搬运工到智能分析师二、PDF处理:文档工厂的智能生产线三、邮件自动化:

Python实现自动化Word文档样式复制与内容生成

《Python实现自动化Word文档样式复制与内容生成》在办公自动化领域,高效处理Word文档的样式和内容复制是一个常见需求,本文将展示如何利用Python的python-docx库实现... 目录一、为什么需要自动化 Word 文档处理二、核心功能实现:样式与表格的深度复制1. 表格复制(含样式与内容)2

python获取cmd环境变量值的实现代码

《python获取cmd环境变量值的实现代码》:本文主要介绍在Python中获取命令行(cmd)环境变量的值,可以使用标准库中的os模块,需要的朋友可以参考下... 前言全局说明在执行py过程中,总要使用到系统环境变量一、说明1.1 环境:Windows 11 家庭版 24H2 26100.4061

Python中文件读取操作漏洞深度解析与防护指南

《Python中文件读取操作漏洞深度解析与防护指南》在Web应用开发中,文件操作是最基础也最危险的功能之一,这篇文章将全面剖析Python环境中常见的文件读取漏洞类型,成因及防护方案,感兴趣的小伙伴可... 目录引言一、静态资源处理中的路径穿越漏洞1.1 典型漏洞场景1.2 os.path.join()的陷

Python数据分析与可视化的全面指南(从数据清洗到图表呈现)

《Python数据分析与可视化的全面指南(从数据清洗到图表呈现)》Python是数据分析与可视化领域中最受欢迎的编程语言之一,凭借其丰富的库和工具,Python能够帮助我们快速处理、分析数据并生成高质... 目录一、数据采集与初步探索二、数据清洗的七种武器1. 缺失值处理策略2. 异常值检测与修正3. 数据

Python中bisect_left 函数实现高效插入与有序列表管理

《Python中bisect_left函数实现高效插入与有序列表管理》Python的bisect_left函数通过二分查找高效定位有序列表插入位置,与bisect_right的区别在于处理重复元素时... 目录一、bisect_left 基本介绍1.1 函数定义1.2 核心功能二、bisect_left 与

Python使用Tkinter打造一个完整的桌面应用

《Python使用Tkinter打造一个完整的桌面应用》在Python生态中,Tkinter就像一把瑞士军刀,它没有花哨的特效,却能快速搭建出实用的图形界面,作为Python自带的标准库,无需安装即可... 目录一、界面搭建:像搭积木一样组合控件二、菜单系统:给应用装上“控制中枢”三、事件驱动:让界面“活”

VSCode设置python SDK路径的实现步骤

《VSCode设置pythonSDK路径的实现步骤》本文主要介绍了VSCode设置pythonSDK路径的实现步骤,包括命令面板切换、settings.json配置、环境变量及虚拟环境处理,具有一定... 目录一、通过命令面板快速切换(推荐方法)二、通过 settings.json 配置(项目级/全局)三、

Python struct.unpack() 用法及常见错误详解

《Pythonstruct.unpack()用法及常见错误详解》struct.unpack()是Python中用于将二进制数据(字节序列)解析为Python数据类型的函数,通常与struct.pa... 目录一、函数语法二、格式字符串详解三、使用示例示例 1:解析整数和浮点数示例 2:解析字符串示例 3:解