Python命名规范

简介: Python命名规范为编写代码提供了一系列规则和约定,以增强代码的可读性、可维护性和一致性。其涵盖了项目、模块、包、类、异常、变量、函数及方法的命名方式,并强调了避免使用单字母命名、关键字和内置名称的重要性。遵循这些规范能够帮助开发者编写更清晰、统一且易懂的代码。

Python命名规范是编写Python代码时需要遵循的一系列命名规则和约定,它们有助于提高代码的可读性、可维护性和一致性。以下是一些关键的Python命名规范:

  1. 项目、模块和包命名
    项目名称:首字母大写,使用大写式驼峰命名法。例如:ProjectName。
    模块名和包名:全部小写,使用下划线分隔多个单词。例如:module_name、package_name。对于包名,不推荐使用下划线,而是使用点(.)来分隔不同的层级。例如:com.mingrisoft、com.mr.book。
  2. 类和异常命名
    类名称:首字母大写,使用大写式驼峰命名法。例如:ClassName、BorrowBook(表示借书类)。内部类可以使用下划线“_”加Pascal风格的类名组成,例如:_BorrowBook。
    异常名称:也遵循类命名的规则,即首字母大写,使用大写式驼峰命名法。
  3. 变量命名
    全局变量和常量:全部使用大写字母,并使用下划线分隔多个单词。例如:GLOBAL_VAR_NAME、CONSTANT_NAME。
    局部变量、函数参数和实例变量:全部小写,使用下划线分隔多个单词。例如:local_var_name、function_parameter_name、instance_var_name。
    避免使用单字母命名:除了常见的简写(如res、req、num等)外,变量名应尽量使用全拼,以便通过命名大致猜到变量的用处。
  4. 函数和方法命名
    函数名:全部小写,使用下划线分隔多个单词。例如:function_name、calculatesum。如果函数是私有的,可以使用单下划线开头。
    方法名:遵循与函数名相同的命名规则,但通常方法会依赖于类对象。方法名应该清晰地说明该方法的作用,例如使用is
    前缀表示判断,使用get前缀表示获取,使用set前缀表示设置等。
  5. 其他命名约定
    受保护的模块变量或函数:使用单下划线“_”开头,这样在使用from xxx import *语句从模块中导入时,这些变量或函数不会被导入。
    私有实例变量或方法:使用双下划线“__”开头,表示这些变量或方法是类私有的。
  6. 禁止使用的命名
    关键字:不能使用Python的关键字作为变量名、函数名、类名等。可以使用import keyword; print(keyword.kwlist)来查看Python的所有关键字。
    内置名称:避免使用Python的内置函数名、模块名、类型名等作为自定义的变量名或函数名。
    遵循这些命名规范有助于编写出清晰、一致、易于理解的Python代码。同时,也有助于其他开发者更好地理解和维护你的代码。
目录
相关文章
|
4月前
|
SQL 人工智能 文字识别
阿里开源的 AI 代码审查工具 open-code-review 来了
阿里巴巴开源Open Code Review(OCR),融合确定性工程与LLM Agent,已服务数万开发者、发现百万级缺陷。内置NPE、SQL注入等安全规则,支持CLI、Agent集成及多平台部署,让AI代码审查更精准、稳定、可落地。(239字)
9127 1
|
XML Java Nacos
Spring Boot 整合Nacos 版本兼容适配 史上最详细文档
本文介绍SpringBoot整合Nacos的完整流程,涵盖Nacos下载安装、配置中心与服务发现集成、版本兼容性问题及实战配置。重点解决SpringBoot 3.3.0与Nacos版本适配难题,推荐使用Spring Cloud Alibaba方案,并提供项目开源地址供参考学习。
|
6月前
|
人工智能 自然语言处理
上下文长度是什么意思?AI大模型128k、256k和1M上下文长度是什么概念?
上下文长度指大模型单次处理的最大Token数,涵盖输入与输出。如Qwen、DeepSeek等支持128K(约16万汉字)、256K乃至1M上下文,直接影响长文档理解、多轮对话与代码分析能力。阿里云百炼/通义平台提供详细参数与阶梯计费
15534 3
|
数据处理 开发工具 开发者
requirement.txt 管理python包依赖
在 Python 项目中,`requirements.txt` 用于记录依赖库及其版本,便于环境复现。本文介绍了多种生成该文件的方法:基础方法使用 `pip freeze`,进阶方法使用 `pipreqs`,专业方法使用 `poetry` 或 `pipenv`,以及手动维护方式。每种方法适用不同场景,涵盖从简单导出到复杂依赖管理,并提供常见问题的解决方案,帮助开发者高效生成精准的依赖列表,确保项目环境一致性。
3511 4
|
人工智能 安全 机器人
2025 年 AI 成为热点的原因及其驱动因素分析
2025年,人工智能技术飞速发展,从实验室走向产业应用,涵盖多模态大模型、智能体崛起、具身智能等热点。政策支持、市场需求推动AI在医疗、服务器、硬件产品等领域的全面落地,同时伦理监管逐步完善,全球治理协作加强,AI正从“工具”向“伙伴”转变。
2095 0
|
人工智能 边缘计算 自然语言处理
普通电脑也能跑AI:10个8GB内存的小型本地LLM模型推荐
随着模型量化技术的发展,大语言模型(LLM)如今可在低配置设备上高效运行。本文介绍本地部署LLM的核心技术、主流工具及十大轻量级模型,探讨如何在8GB内存环境下实现高性能AI推理,涵盖数据隐私、成本控制与部署灵活性等优势。
10591 0
普通电脑也能跑AI:10个8GB内存的小型本地LLM模型推荐
|
监控 Linux 数据安全/隐私保护
Python实现Word转PDF全攻略:从入门到实战
在数字化办公中,Python实现Word转PDF自动化,可大幅提升处理效率,解决格式兼容问题。本文详解五种主流方案,包括跨平台的docx2pdf、Windows原生的pywin32、服务器部署首选的LibreOffice命令行、企业级的Aspose.Words,以及轻量级的python-docx+pdfkit组合。每种方案均提供核心代码与适用场景,并涵盖中文字体处理、表格优化、批量进度监控等实用技巧,助力高效办公自动化。
2395 0
|
IDE 开发工具 Python
python3代码编程规范(命名、空格、注释、代码布局、编程建议等)
该文章详细介绍了Python3的编程规范,包括命名、空格使用、注释、代码布局等方面的最佳实践,帮助提升代码的可读性和一致性。
3486 0
|
关系型数据库 Linux 数据库
PostgreSQL 入门指南:安装、配置与基本命令
本文从零开始,详细介绍如何在 Windows、Linux 和 macOS 上安装和配置 PostgreSQL,涵盖30+个实操代码示例。内容包括安装步骤、配置远程访问和用户权限、基础数据库操作命令(如创建表、插入和查询数据),以及常见问题的解决方案。通过学习,你将掌握 PostgreSQL 的基本使用方法,并为后续深入学习打下坚实基础。
17026 1