编写优雅Python代码的20个最佳实践

想要让你的代码像艺术品一样既实用又赏心悦目吗?今天我们就来聊聊如何通过20个小技巧,让你的Python代码从平凡走向优雅,让同行看了都忍不住点赞!
**温馨提示:更多的编程资料,领取方式在:
在这里插入图片描述


1. 拥抱PEP 8

  • 实践 : 遵循PEP 8编码规范,比如行宽不超过79字符,使用空格而不是制表符缩进。

  • 为什么 : 它是Python世界的风格指南,统一代码风格,让阅读成为享受。

# 对  
def my_function(arg1, arg2):  
    return arg1 + arg2  
  
# 错误示范  
def my_function(arg1,arg2):  
    return arg1+arg2  # 看起来不整齐,对吧?  

2. 列表推导式

  • 实践 : 用列表推导式替代循环创建列表,简洁又高效。

  • 例子 :

# 对  
squares = [x**2 for x in range(10)]  
# 而不是  
squares = []  
for x in range(10):  
    squares.append(x**2)  



3\. **理解上下文管理器**
----------------

*   **实践** : 使用`with`语句管理资源,如文件操作,自动处理打开和关闭。
    
*   **原因** : 自动资源管理,减少错误,代码更干净。
    

with open(‘example.txt’, ‘r’) as file:
content = file.read()

文件会自动关闭,无需file.close()


4\. **函数默认参数与可变参数**
-------------------

*   **实践** : 利用默认参数简化调用,使用`*args`和`**kwargs`接收任意数量的参数。
    
*   **示例** :
    

def print_info(name, age=25, *args, **kwargs):
print(f"Name: {name}, Age: {age}“)
for arg in args:
print(arg)
for key, value in kwargs.items():
print(f”{key}: {value}")

print_info(“Alice”, 30, “Python”, “Developer”, city=“New York”)


5\. **列表、元组、字典的解构赋值**
---------------------

*   **实践** : 通过解构赋值简化变量提取。
    
*   **展示** :
    

a, b = (1, 2) # 元组解构
first, *rest, last = [1, 2, 3, 4] # 列表解构,*rest捕获中间项
{key: value for key, value in {‘a’: 1, ‘b’: 2}.items()} # 字典解构


6\. **生成器表达式**
--------------

*   **实践** : 当数据量大时,用生成器替代列表,节省内存。
    
*   **对比** :
    

生成器

gen = (x**2 for x in range(10000))

相比于列表,这不会一次性加载所有数据到内存中


7\. **使用内置函数**
--------------

*   **实践** : 别重复发明轮子,利用Python强大的内置函数,如`map()`, `filter()`, `zip()`。
    
*   **实例** :
    

numbers = [1, 2, 3]
squared = map(lambda x: x**2, numbers)
print(list(squared)) # [1, 4, 9]


8\. **避免全局变量**
--------------

*   **实践** : 尽可能使用函数参数和返回值,减少全局变量的使用,提高模块性。
    
*   **提醒** : 全局变量会让代码难以追踪和测试。
    

9\. **类与继承**
------------

*   **实践** : 使用类来组织相关功能,合理继承实现代码复用。
    
*   **注意** : 避免过度继承,滥用会增加复杂度。
    

10\. **异常处理**
-------------

*   **实践** : 使用`try-except`块来优雅地处理错误,而不是让程序崩溃。
    
*   **案例** :
    

try:
result = 10 / 0
except ZeroDivisionError:
print(“Oops! Can’t divide by zero.”)


11\. **单元测试**
-------------

*   **实践** : 为关键功能编写单元测试,确保代码质量。
    
*   **工具** : 使用`unittest`或`pytest`框架,自动化测试你的函数。
    

12\. **文档字符串**
--------------

*   **实践** : 为每个模块、函数、类添加清晰的文档字符串。
    
*   **好处** : 提高代码可读性和维护性。
    

13\. **类型注解**
-------------

*   **实践** : 使用类型注解(Python 3.5+),帮助IDE和同事理解你的意图。
    
*   **示例** :
    

def greet(name: str) -> str:
return f"Hello, {name}!"


14\. **单行if-else**
------------------

*   **实践** : 简单情况下的单行if-else,使代码紧凑。
    
*   **示例** :
    

age = 20
print(“Adult”) if age >= 18 else print(“Child”)


15\. **模块化**
------------

*   **实践** : 将相关代码组织到模块中,遵循“一个模块一个功能”原则。
    
*   **好处** : 代码结构清晰,易于管理和重用。
    

16\. **使用类型提示工具**
-----------------

*   **实践** : 结合mypy等工具检查类型注解,预防类型错误。
    
*   **理由** : 在运行前发现潜在问题。
    

17\. **避免硬编码**
--------------

*   **实践** : 使用配置文件或环境变量代替硬编码的值。
    
*   **理由** : 提高灵活性,便于配置更改。
    

18\. **性能优化**
-------------

*   **实践** : 使用`timeit`模块测试代码片段,了解并优化瓶颈。
    
*   **小贴士** : 不要过早优化,先确保代码正确和可读。
    

19\. **代码审查**
-------------

*   **实践** : 通过代码审查分享知识,发现潜在问题。
    
*   **建议** : 使用GitHub等平台的Pull Request机制。
    

20\. **持续学习**
-------------

*   **实践** : Python社区活跃,新库新技术层出不穷,保持好奇心,不断学习。
    
*   **资源** : PyPI、官方文档、社区论坛,都是宝贵的资源。
    

* * *

进阶技巧
----

21\. **代码重用的艺术**
----------------

*   **实践** : 利用装饰器、抽象基类(ABCs)和模块导入来避免重复代码。
    
*   **装饰器示例** :
    

def timing_decorator(func):
def wrapper(*args, **kwargs):
start_time = time.time()
result = func(*args, **kwargs)
end_time = time.time()
print(f"{func.name} took {end_time - start_time} seconds to run.")
return result
return wrapper

@timing_decorator
def my_long_running_function():
time.sleep(2)

my_long_running_function()


*   **为什么重要** : 重用代码能减少错误,提高开发效率。
    

22\. **代码性能优化**
---------------

*   **实践** : 使用`cProfile`分析性能瓶颈,考虑使用NumPy、Pandas等库优化数值计算。
    
*   **示例** :
    

import cProfile
def profile_me():
# 你的代码放这里
pass

cProfile.run(‘profile_me()’)


*   **小技巧** : 优化循环和数据处理逻辑,但需平衡可读性。
    

23\. 版本控制
---------

*   **实践** : 使用Git进行版本控制,记录每一次修改,方便回溯。
    
*   **为何重要** : 团队合作的基石,保护代码免受意外损失。
    

24\. 代码风格一致性
------------

*   **实践** : 使用工具如`black`自动格式化代码,确保团队间风格一致。
    
*   **好处** : 统一代码风格,减少审阅时间,增强团队协作。
    

25\. 代码注释与文档
------------

*   **实践** : 适时添加注释,特别是复杂的逻辑和算法解释,同时维护好项目的README文档。
    
*   **提示** : 注释应简洁明了,避免冗余。
    

26\. 安全编码
---------

*   **实践** : 防止SQL注入、XSS攻击等,确保用户输入验证和清理。
    
*   **示例** : 在处理数据库查询时使用参数化查询:
    

import sqlite3
conn = sqlite3.connect(‘example.db’)
c = conn.cursor()
c.execute(“SELECT * FROM stocks WHERE symbol = ?”, (‘ACME’,))


*   **理由** : 安全性是任何软件开发的首要考虑。
    

27\. 持续集成/持续部署 (CI/CD)
----------------------

*   **实践** : 设置自动化测试和部署流程,如使用Jenkins、GitLab CI/CD或GitHub Actions。
    
*   **收益** : 提升软件质量和发布效率。
    


通过这额外的7点实践,你的Python编程技能将进一步提升,不仅限于编写代码,还包括了代码维护、团队合作和安全性等方面。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:/a/779015.html

如若内容造成侵权/违法违规/事实不符,请联系我们进行投诉反馈qq邮箱809451989@qq.com,一经查实,立即删除!

相关文章

【Python文件】操作终极指南:高效管理和处理文件系统的必备技能

目录 ​编辑 1. 文件的基础操作 1.1 打开/关闭文件 ​编辑 示例代码 文件对象 使用with语句打开文件 2. 读文件 2.1 使用read方法读取文件 2.2 使用readline方法读取文件 2.3 使用readlines方法读取文件 2.4 使用for循环读取文件 3. 写文件 3.1 使用write方法写文…

Podman 深度解析

目录 引言Podman 的定义Podman 的架构Podman 的工作原理Podman 的应用场景Podman 在 CentOS 上的常见命令实验场景模拟总结 1. 引言 随着容器化技术的发展,Docker 已成为容器管理的代名词。然而,由于 Docker 的一些局限性,如需要守护进程和 …

基于java+springboot+vue实现的大学生就业需求分析系统(文末源码+Lw)233

摘 要 信息数据从传统到当代,是一直在变革当中,突如其来的互联网让传统的信息管理看到了革命性的曙光,因为传统信息管理从时效性,还是安全性,还是可操作性等各个方面来讲,遇到了互联网时代才发现能补上自…

jmeter-beanshell学习3-beanshell获取请求报文和响应报文

前后两个报文,后面报文要用前面报文的响应结果,这个简单,正则表达式或者json提取器,都能实现。但是如果后面报文要用前面请求报文的内容,感觉有点难。最早时候把随机数写在自定义变量,前后两个接口都用这个…

HTML5使用<progress>进度条、<meter>刻度条

1、<progress>进度条 定义进度信息使用的是 progress 标签。它表示一个任务的完成进度&#xff0c;这个进度可以是不确定的&#xff0c;只是表示进度正在进行&#xff0c;但是不清楚还有多少工作量没有完成&#xff0c;也可以用0到某个最大数字&#xff08;如&#xff1…

如何搜索查找ICLR论文

记录有几个查找顶级会议文章的网址&#xff0c;不止ICLR ICLR 2024 还会有visualization模式&#xff1a; ICLR 2024 virtual 这个网站也很棒 Paper Copilot ICLR 2024 当然还有一个用图表示各论文相关关系的网站&#xff1a; connected papers

ROS——坐标系管理、监听与广播、常用可视化工具

坐标系管理 TF功能包 小海龟追踪实验 ros版本(20.04)的tf安装命令: sudo apt-get install ros-noetic-turtle-tf 解决因python版本出现的无法生成跟随海龟&#xff1a; sudo ln -s /usr/bin/python3 /usr/bin/python ( -s 软链接,符号链接) ln命令&#xff08;英文全拼&#…

Matplotlib Artist 1 概览

Matplotlib API中有三层 matplotlib.backend_bases.FigureCanvas&#xff1a;绘制区域matplotlib.backend_bases.Renderer&#xff1a;控制如何在FigureCanvas上绘制matplotlib.artist.Artist&#xff1a;控制render如何进行绘制 开发者95%的时间都是在使用Artist。Artist有两…

【MYSQL】InnoDB引擎为什么选可重复读作为默认隔离级别

InnoDB引擎为什么选可重复读作为默认隔离级别 一般的DBMS系统&#xff0c;默认都会使用读提交&#xff08;Read-Comitted&#xff0c;RC&#xff09;作为默认隔离级别&#xff0c;如Oracle、SQL Server等&#xff0c;而MySQL却使用可重复读&#xff08;Read-Repeatable&#x…

MySQL 9.0 创新版发布,大失所望。。

大家好&#xff0c;我是程序员鱼皮。2024 年 7 月 1 日&#xff0c;MySQL 发布了 9.0 创新版本。区别于我们大多数开发者常用的 LTS&#xff08;Long-Term Support&#xff09;长期支持版本&#xff0c;创新版本的发布会更频繁、会更快地推出新的特性和变更&#xff0c;可以理解…

白嫖A100活动-入门篇-1.Linux+InterStudio

进入InterStudio 这节课是为了让大家熟悉使用InterStudio平台&#xff0c;以便后续开发 InterStudio平台是算力平台&#xff0c;可以通过平台使用A100,还可以使用“书生”团队集成好的环境、工具&#xff0c;快速部署LLMs. 进入平台&#xff1a; 记得报名&#xff0c;获得免…

快排的非递归实现

前提 快排的递归实现&#xff0c;在深度过深时会存在栈溢出的风险&#xff0c;所以我们需要掌握快排的非递归写法 快排的实现 单趟实现 上次我们使用了hoare的快排单趟写法&#xff0c;所以这次我们使用前后指针法. 前后指针法 初始状态下&#xff0c;初始化prev为left,cu…

Android Studio Run窗口中文乱码解决办法

Android Studio Run窗口中文乱码解决办法 问题描述&#xff1a; AndroidStudio 编译项目时Run窗口中文乱码&#xff0c;如图&#xff1a; 解决方法&#xff1a; 依次打开菜单&#xff1a;Help--Edit Custom VM Options&#xff0c;打开studio64.exe.vmoptions编辑框&#xf…

CV03_mAP计算以及COCO评价标准

COCO数据集回顾&#xff1a;CV02_超强数据集&#xff1a;MSCOCO数据集的简单介绍-CSDN博客 1.1 简介 在目标检测领域中&#xff0c;mAP&#xff08;mean Average Precision&#xff0c;平均精度均值&#xff09;是一个广泛使用的性能评估指标&#xff0c;用于衡量目标检测模型…

【Unity2D 2022:Particle System】添加命中粒子特效

一、创建粒子特效游戏物体 二、修改粒子系统属性 1. 基础属性 &#xff08;1&#xff09;修改发射粒子持续时间&#xff08;Duration&#xff09;为1s &#xff08;2&#xff09;取消勾选循环&#xff08;Looping&#xff09; &#xff08;2&#xff09;修改粒子存在时间&…

数据库管理工具 -- Navicat Premium v17.0.8 特别版

软件简介 Navicat Premium 是一款功能强大的数据库管理工具&#xff0c;适用于Windows、Mac和Linux平台。它支持多种数据库&#xff0c;包括MySQL、MariaDB、SQL Server、PostgreSQL、Oracle、SQLite等。用户可以通过Navicat Premium轻松地连接到各种数据库服务器&#xff0c;…

mac怎么压缩pdf文件,mac压缩pdf文件大小不改变清晰度

在数字化时代&#xff0c;pdf文件因其良好的兼容性和稳定性&#xff0c;已经成为我们日常办公和学习中不可或缺的文件格式。然而&#xff0c;随着文件内容的增多&#xff0c;pdf文件的体积也往往会变得越来越大&#xff0c;给文件的传输和存储带来不便。本文将为你介绍几种简单…

视觉语言模型:融合视觉与语言的未来

1. 概述 视觉语言模型&#xff08;Vision-Language Models, VLMs&#xff09;是能够同时处理和理解视觉&#xff08;图像&#xff09;和语言&#xff08;文本&#xff09;两种模态信息的人工智能模型。这种模型结合了计算机视觉和自然语言处理的技术&#xff0c;使得它们能够在…

第一天(点亮led灯+led灯闪烁)——Arduino uno R3 学习之旅

​ 常识: 一般智能手机的额定工作电流大约为200mA Arduino Uno板上I/0(输入/输出)引脚最大输出电流为40 mA Uno板控制器总的输出电流为200 mA 点亮LED灯 发光二极管介绍 发光二极管(Light Emitting Diode&#xff0c;简称LED)是一种能够将电能转化为光能的固态的半导体器件…

016-GeoGebra基础篇-加载项错误_使用此功能所需的服务已关闭,请检查你的隐私设置,

最近有伙伴说遇到一个问题&#xff1a;“加载项错误_使用此功能所需的服务已关闭&#xff0c;请检查你的隐私设置”&#xff0c;该怎么解决&#xff1f; 若大家也遇到同样的问题&#xff0c;建议按照我下边的步骤逐个排查下&#xff0c;基本可以解决“GeoGebra无法完美插入PPT…