如何在Python 3.12中正确定义一个符合PEP8规范的类?

陌强吖_4614

陌强吖_4614

2026-08-13

810人浏览

原创

类名必须用大驼峰且不能带下划线,如userprofile;方法必须显式声明self并正确空格;参数间及逗号后需单空格;方法间空一行,特殊方法前后不额外空行;类型提示紧随参数名后,返回类型用->标注。

如何在python 3.12中正确定义一个符合pep8规范的类?

类名必须用大驼峰,且不能带下划线

PEP 8 明确要求类名使用 CapWords(即 PascalCase),比如 UserProfile、HTTPClient。写成 user_profile 或 User_Profile 都是错的——前者是变量命名风格,后者混用了下划线,Python 解析器虽不报错,但违反规范且影响可读性。

常见错误现象:class api_handler:(全小写)、class DataProcessor_v2:(带下划线和数字后缀)。

  • 类名中避免缩写,除非是广泛接受的(如 XMLParser、URL)
  • 首字母必须大写,哪怕只有一个词,比如 Config,不是 config
  • Python 3.12 对此无新限制,但 ast 和 linter(如 pylint、flake8)会直接标红

方法定义必须显式声明 self,且其后紧跟冒号和空格

self 是实例方法的第一个参数,PEP 8 要求它必须命名为 self(不能是 this 或 me),且与括号间不留空格:def __init__(self) ✔️,def __init__( self ) ❌。

容易踩的坑:在 __init__ 中漏掉 self,或误写成 def __init__(cls)(那是类方法该用的 cls)。

python-script-generator
python-script-generator

快速生成专业的 Python 脚本和应用代码。一键创建完整项目结构,支持CLI、API、爬虫、Bot、Django等多种项目类型,包含完整的项目结构、配置文件、依赖管理、测试、README和文档。

下载
  • 所有实例方法都必须以 self 开头,包括 __str__、__eq__ 等特殊方法
  • 参数之间用单个空格分隔,逗号后也加空格:def connect(self, host, port=8080)
  • Python 3.12 引入了更严格的 AST 检查,某些拼写错误(如 slf)可能被 pyright 直接标记为未定义变量

类内方法间至少空一行,特殊方法前后不额外空行

PEP 8 规定:类中方法之间用单个空行分隔;但 __init__ 前后不强制空行,尤其当它是第一个方法时,前面不空,后面只空一行(和下一个普通方法之间)。

典型反例:__init__ 前空两行、方法间空两行、所有方法挤在一起没空行——这些都会被 black 或 autopep8 自动修正,但手动写时容易忽略。

  • 类开头注释(如果有)和 class 语句之间不空行
  • 类结尾不强制空行,但如果后面紧跟另一个类或函数,建议空一行
  • Python 3.12 的 ast.unparse() 输出会严格遵循此格式,手写不一致可能导致 diff 冗余

类型提示应放在参数后、冒号后,而非等号后

Python 3.12 全面支持 PEP 563(延迟求值注解),但语法位置没变:类型提示必须紧贴参数名之后,用冒号分隔,例如 name: str,不是 name: str = None(这是带默认值的写法,但冒号位置不变)。

常见错误:把类型提示写成赋值形式 name = str,或混淆位置:def __init__(self: MyClass)(self 不需要类型提示)。

  • 仅对非 self 参数加类型提示,如 def add(self, x: int, y: float) -> float:
  • 返回类型用 ->,紧跟在参数括号后,箭头前后各一个空格
  • 复杂类型用 typing 模块(如 list[str]),Python 3.12 已支持内置泛型,无需再从 typing 导入 List
类定义看着简单,真正卡住人的往往是空行数量、冒号前后空格、以及 self 这种“看不见的接口”——它不报错,但一错就让整个类无法实例化,而且 IDE 很难实时提示。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1691

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

4264

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1689

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

24757

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3027

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3047

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1163

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2363

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程