讲师中心 微信公众号
AI工具推荐 视频效率加速

Class 语法的代码风格建议

小辰大大_4339

小辰大大_4339

发布时间:2026-06-08 17:11:47

|

152人浏览过

|

来源于php中文网

原创

Python类定义应遵循PEP 8:类名用CapWords(如UserProfile);类内顺序为文档字符串→类变量→__init__→特殊方法→公共方法→私有方法;方法间空一行,类间空两行;实例方法首参为self且不换行对齐。

class 语法的代码风格建议

Python 中定义类时,代码风格直接影响可读性、协作效率和长期维护成本。核心原则是遵循 PEP 8,并兼顾 Pythonic 表达习惯。

类名用 CapWords(驼峰式)

类名必须采用首字母大写的驼峰命名法,单词间不加下划线,且避免缩写或模糊简称。

  • ✅ 正确:UserProfile、DataProcessor、HTTPClient
  • ❌ 错误:user_profile(应为函数/变量名)、userprofile(缺少大小写分隔)、UProfile(缩写难懂)

类内结构保持清晰顺序

一个类的定义应按逻辑顺序组织:文档字符串 → 类变量 → 实例变量(在 __init__ 中声明)→ 特殊方法 → 公共方法 → 受保护/私有方法。

  • 类变量(如 DEFAULT_TIMEOUT)放在 __init__ 之前,全大写加下划线
  • __init__ 方法紧随类定义后,作为第一个实例方法
  • 双下划线开头的方法(如 __str__)建议集中放在靠前位置,便于快速识别协议实现
  • 私有方法(单下划线开头,如 _validate_input)放在公共方法之后,体现封装意图

方法之间空一行,类之间空两行

这是 PEP 8 明确要求的视觉分隔方式,帮助读者快速定位作用域边界。

  • 类内部各方法之间用 一个空行 分隔(包括 __init__ 与其他方法)
  • 两个独立类定义之间必须用 两个空行
  • 类与上方的模块级注释、导入语句之间也应空两行

方法参数与 self/cls 的规范写法

实例方法第一个参数必须是 self,类方法第一个参数必须是 cls,且它们**不参与命名逻辑,不加类型提示前缀,也不换行**。

  • ✅ 推荐:def save(self, user_id: int, data: dict) -> bool:
  • ❌ 避免:def save( self, user_id: int, data: dict) -> bool:(参数强行对齐反而降低可读性)
  • 若参数过多,优先用数据类或字典解包,而非把 self 拆到下一行

热门AI工具

更多
WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

4586

2023.06.20

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

1149

2023.07.04

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

4504

2023.07.04

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

900

2023.09.01

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

1796

2023.09.04

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

3285

2023.09.04

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

4253

2023.09.12

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2760

2023.09.20

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

100

2026.09.30

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
python编程入门系列图文教程
python编程入门系列图文教程

共65课时 | 27.2万人学习

PHP开发编码规范
PHP开发编码规范

共37课时 | 71.5万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn