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

编程刘明

于 2024-07-06 17:26:53 发布

阅读量1k

点赞数 19

分类专栏：编程文章标签： python 开发语言 android

本文链接：https://blog.csdn.net/qq_56262770/article/details/140232575

版权

编程专栏收录该内容

20 篇文章 1 订阅

订阅专栏

想要让你的代码像艺术品一样既实用又赏心悦目吗？今天我们就来聊聊如何通过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编程技能将进一步提升，不仅限于编写代码，还包括了代码维护、团队合作和安全性等方面。