学习 Python 编程的规则与风格指南

embedded/2024/12/29 0:17:45/

在这里插入图片描述

文章目录

    • 1. Python 编程规则
      • 1.1 Python 的哲学:The Zen of Python
      • 1.2 遵守 PEP 8
      • 1.3 Python 是大小写敏感的
      • 1.4 使用 Pythonic 风格
    • 2. Python 编程风格
      • 2.1 命名风格
      • 2.2 注释风格
      • 2.3 文档字符串(Docstring)
      • 2.4 空格使用
      • 2.5 文件和代码组织
    • 3. Python 编程中的最佳实践
      • 3.1 避免硬编码
      • 3.2 使用异常处理
      • 3.3 使用列表推导式
      • 3.4 使用上下文管理器
      • 3.5 定期优化代码

编程是一门需要秩序和逻辑的艺术,学习 Python 编程时,掌握规范和风格是提高代码质量、提升开发效率的关键。Python 提倡 “优雅”、“明确”、“简单”,因此有一套公认的编码风格指南,称为 PEP 8。本文将介绍学习 Python 编程时需要遵循的规则和风格建议,帮助你写出整洁、易读的代码。


1. Python 编程规则

1.1 Python 的哲学:The Zen of Python

运行以下代码即可查看 Python 的核心设计哲学:

python">import this

输出中包含的几点核心原则:

  • 明确优于隐式(Explicit is better than implicit)。
  • 简单优于复杂(Simple is better than complex)。
  • 可读性很重要(Readability counts)。

1.2 遵守 PEP 8

PEP 8 是 Python 官方的编码规范,涵盖代码布局、命名规则、导入语句等。以下是几个关键点:

  • 缩进:使用 4 个空格缩进,不要用 Tab。

  • 每行长度:每行代码不超过 79 个字符(注释不超过 72 个字符)。

  • 空行:模块级别需要两个空行,类或函数定义之间保留一个空行。

  • 导入顺序:

    • 标准库模块
    • 第三方库
    • 自定义模块
      每组导入之间保留一个空行。

1.3 Python 是大小写敏感的

变量名、函数名等区分大小写。例如:

python">name = "Alice"
Name = "Bob"
# name 和 Name 是不同的变量

1.4 使用 Pythonic 风格

Pythonic 风格是指采用 Python 社区推荐的惯用写法。避免冗长、复杂的代码,尽量使用简洁、直观的方法。例如:

  • 好:
python"> if x in [1, 2, 3]:print("x is in the list")
  • 不好
python"> if x == 1 or x == 2 or x == 3:print("x is in the list")

2. Python 编程风格

2.1 命名风格

Python 中的变量、函数和类需要遵循一致的命名规则:

  • 变量和函数

    :使用小写字母,单词之间用下划线分隔(snake_case)。

python">  user_name = "Alice"def get_user_name():return user_name
  • 类名

    :每个单词首字母大写(PascalCase)。

python"> class UserProfile:pass
  • 常量

    :所有字母大写,单词用下划线分隔。

python">  MAX_RETRY_COUNT = 5
  • 模块和包

    :文件名用小写字母,单词间用下划线。

python">  # 文件名:data_loader.py

2.2 注释风格

注释是代码的重要组成部分,帮助其他开发者理解你的逻辑。

  • 单行注释

    :使用

python">  #

开头,注释与代码之间至少一个空格。

python"> total = 0  # 用于计算总和
  • 多行注释

    :使用三引号

python">  """

python"> """这个函数计算两个数的和。输入:x: 第一个数y: 第二个数输出:两个数的和"""def add(x, y):return x + y

2.3 文档字符串(Docstring)

为模块、类或函数添加文档字符串,说明其功能和用途。

python">def greet(name):"""打招呼函数参数:name (str): 用户名返回:str: 打招呼语"""return f"Hello, {name}!"

2.4 空格使用

  • 操作符两侧留空格:
python">  x = 5 + 3
  • 函数参数之间不加额外空格:
python">def add(x, y):return x + y

2.5 文件和代码组织

  • 按功能模块化代码,避免所有代码写在一个文件中。
  • 文件开头按以下顺序书写:
    1. 模块注释或文档字符串
    2. 导入语句
    3. 全局变量或常量定义
    4. 类和函数定义

3. Python 编程中的最佳实践

3.1 避免硬编码

将可变参数提取为常量或配置文件:

python"># 不推荐
retry_count = 3# 推荐
MAX_RETRY_COUNT = 3

3.2 使用异常处理

通过异常处理捕获错误,而不是直接忽略:

python">try:result = 10 / 0
except ZeroDivisionError as e:print(f"Error: {e}")

3.3 使用列表推导式

列表推导式让代码更简洁:

  • 普通写法
python">  numbers = []for i in range(10):numbers.append(i ** 2)
  • 列表推导式
python">  numbers = [i ** 2 for i in range(10)]

3.4 使用上下文管理器

上下文管理器能自动管理资源,例如文件操作:

python"># 不推荐
file = open('example.txt', 'r')
data = file.read()
file.close()# 推荐
with open('example.txt', 'r') as file:data = file.read()

3.5 定期优化代码

  • 使用代码格式化工具如 Black 来保持代码风格一致。
  • 使用静态代码检查工具如 Flake8Pylint 发现潜在问题。

http://www.ppmy.cn/embedded/149592.html

相关文章

Dynamo:Amazon 的高可用键值仓储

大家觉得有意义和帮助记得及时关注和点赞!!! Dynamo 是 Amazon 的高可用分布式键值存储(key/value storage)系统。这篇论文发表 的时候(2007)它还只是一个内部服务,现在(改名为 DynamoDB)已经发…

OCR(三)windows 环境基于c++的 paddle ocr 编译【CPU版本】

目录 1. 下载 2. 编译 2.1 cmake 编译生成vs工程 2.2 修改源代码 2.3 生成 2.4 测试 PaddleOCR windows工具的编译 1. 下载 PaddleOCR2.8下载 Opencv4.10下载 Git下载 PaddlePaddle C++推理库

dolphinscheduler服务RPC心跳机制之实现原理与源码解析

RPC心跳机制设计 1.概述2.设计2.1.心跳机制流程设计2.1.1.常规RPC心跳机制设计2.1.2.Dolphinscheduler的RPC心跳机制设计2.2.心跳机制数据模型设计2.3.心跳机制动态配置3.实现3.1.心跳机制数据模型3.1.1.HeartBeat接口3.1.2.基础实现类BaseHeartBeat3.1.3.Master服务中的心跳消…

webRTC TURN服务器搭建

背景: 前言:如果还不清楚webrtc可以先看读这个文章webrtc的RTCPeerConnection使用_new rtcpeerconnection-CSDN博客 webRTC的RTCPeerConnection通讯,是p2p的通讯,配置的时候需要填写个stun和turn服务器 举例: cons…

家政预约小程序01搭建页面布局

目录 1 创建应用2 搭建页面布局3 设置页面背景色4 设置页面内容区域总结 我们前边已经完成了需求分析及设计工作,本篇开始就进入到具体的搭建。开发小程序先需要创建应用,应用和我们的需求相关,通常我们是有一个应用用来承载小程序&#xff0…

【Linux】小白如何看top命令及其他参数常识

top top 是 Linux 系统中用于实时监控系统性能的命令。它会显示系统的进程、内存、CPU 使用情况等信息。 top命令展示: top 反馈的各个字段的解释 1、第一行代表当前的时间、系统已运行时间(Uptime)、负载均衡(Load average)。 …

linux 中 Vi 和 Vim 的使用

Vi (Visual Interface)是 Linux下基于Shell 的文本编辑器,Vim (Visual Interface iMproved)是 Vi的增强版本,扩展了很多功能,比如对程序源文件的语法高亮。不管是 Vi 还是 Vim,我们习…

Element-plus自动导入

安装 npm i element-plus 自动引入 1. 安装两个插件 npm install -D unplugin-vue-components unplugin-auto-import2. 配置插件 vue3项目修改vite.config.js,把两个插件添加入即可,注意:不是覆盖原有配置 Vite // vite.config.js import { define…