【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

相关文章

JDK21对虚拟线程的几种用法实践指南

《JDK21对虚拟线程的几种用法实践指南》虚拟线程是Java中的一种轻量级线程,由JVM管理,特别适合于I/O密集型任务,:本文主要介绍JDK21对虚拟线程的几种用法,文中通过代码介绍的非常详细,... 目录一、参考官方文档二、什么是虚拟线程三、几种用法1、Thread.ofVirtual().start(

从基础到高级详解Go语言中错误处理的实践指南

《从基础到高级详解Go语言中错误处理的实践指南》Go语言采用了一种独特而明确的错误处理哲学,与其他主流编程语言形成鲜明对比,本文将为大家详细介绍Go语言中错误处理详细方法,希望对大家有所帮助... 目录1 Go 错误处理哲学与核心机制1.1 错误接口设计1.2 错误与异常的区别2 错误创建与检查2.1 基础

Python版本信息获取方法详解与实战

《Python版本信息获取方法详解与实战》在Python开发中,获取Python版本号是调试、兼容性检查和版本控制的重要基础操作,本文详细介绍了如何使用sys和platform模块获取Python的主... 目录1. python版本号获取基础2. 使用sys模块获取版本信息2.1 sys模块概述2.1.1

一文详解Python如何开发游戏

《一文详解Python如何开发游戏》Python是一种非常流行的编程语言,也可以用来开发游戏模组,:本文主要介绍Python如何开发游戏的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下... 目录一、python简介二、Python 开发 2D 游戏的优劣势优势缺点三、Python 开发 3D

Python函数作用域与闭包举例深度解析

《Python函数作用域与闭包举例深度解析》Python函数的作用域规则和闭包是编程中的关键概念,它们决定了变量的访问和生命周期,:本文主要介绍Python函数作用域与闭包的相关资料,文中通过代码... 目录1. 基础作用域访问示例1:访问全局变量示例2:访问外层函数变量2. 闭包基础示例3:简单闭包示例4

Python实现字典转字符串的五种方法

《Python实现字典转字符串的五种方法》本文介绍了在Python中如何将字典数据结构转换为字符串格式的多种方法,首先可以通过内置的str()函数进行简单转换;其次利用ison.dumps()函数能够... 目录1、使用json模块的dumps方法:2、使用str方法:3、使用循环和字符串拼接:4、使用字符

Python版本与package版本兼容性检查方法总结

《Python版本与package版本兼容性检查方法总结》:本文主要介绍Python版本与package版本兼容性检查方法的相关资料,文中提供四种检查方法,分别是pip查询、conda管理、PyP... 目录引言为什么会出现兼容性问题方法一:用 pip 官方命令查询可用版本方法二:conda 管理包环境方法

基于Python开发Windows自动更新控制工具

《基于Python开发Windows自动更新控制工具》在当今数字化时代,操作系统更新已成为计算机维护的重要组成部分,本文介绍一款基于Python和PyQt5的Windows自动更新控制工具,有需要的可... 目录设计原理与技术实现系统架构概述数学建模工具界面完整代码实现技术深度分析多层级控制理论服务层控制注

pycharm跑python项目易出错的问题总结

《pycharm跑python项目易出错的问题总结》:本文主要介绍pycharm跑python项目易出错问题的相关资料,当你在PyCharm中运行Python程序时遇到报错,可以按照以下步骤进行排... 1. 一定不要在pycharm终端里面创建环境安装别人的项目子模块等,有可能出现的问题就是你不报错都安装

使用Java填充Word模板的操作指南

《使用Java填充Word模板的操作指南》本文介绍了Java填充Word模板的实现方法,包括文本、列表和复选框的填充,首先通过Word域功能设置模板变量,然后使用poi-tl、aspose-words... 目录前言一、设置word模板普通字段列表字段复选框二、代码1. 引入POM2. 模板放入项目3.代码