Python基础教程 10
合集下载
相关主题
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
第十章
Python 编码规范
PEP 8
1. 用 4 个空格对齐代码
# Aligned with opening delimiter. foo = long_function_name(var_one, var_two,
2. 参数换行应该与分隔符垂直对齐
3. 每行不应超过 79 个字符 • • 提高阅读体验 可以换行来缩减长度
1. 类型提示
def greeting(name: str) -> str: return 'Hello ' + name
•
• •
函数的参数和返回值类型
有助于 IDE 的代码提示 可以通过 typing 库扩展
from typing import List, Union
def sort_integers(int_list: List[Union[int, float]]): int_list.sort(reverse=True)
var2: int = 2 a:int = “2.0” # 不会报错
小结
1. 代码总是给人看的，可读性非常重要
2. PEP8, PEP484, PEP526 都是 Python 官方对编码规范的建议
3. 编码规范不用死记硬背，应该逐渐熟练成为编码习惯
8. 文档字符串
:return: the sum of the two numbers
自动化工具
1. 手动检查调整费时费力
2. pycodestyle
• • 命令行工具 可以显示源代码、相应的 PEP8 文本和改进意见等
3. PyCharm • • PEP8 检查是内置功能之一 实时检查提醒
PEP484 和 PEP526
def long_function_name(
var_three, var_four)
# More indentation included to distinguish this from the rest.
var_one, var_two, var_three, var_four): print(var_one)
4. 适当空行增强段落感
# easy to match operators with operands income = (gross_wages + taxable_interest + (dividends - qualified_dividends)
- ira_deduction
- student_loan_interest)
Baidu Nhomakorabea
PEP 8
5. import 顺序
def add_number(number1, number2): """
•
先后顺序为：标准库、第三方库、
本地库
calculate the sum of two numbers :param number1: the first number :param number2: the second number :return: the sum of the two numbers """ return number1 + number2
•
避免用 * 引入
6. 字符串分隔符尽量统一 7. 注释的要求 • 完整、同步
print(add_number.__doc__)
calculate the sum of two numbers :param number1: the first number :param number2: the second number
2. 变量标注 • • 和类型提示的语法相似 Python3.6 以后的版本才有
list_to_sort = [1, 2.2, 3.3]
sort_integers(list_to_sort)
print(list_to_sort)
# Python 3.6 Variable Annotations
3. 编辑期生效 • 提示和标注都不影响运行期
Python 编码规范
PEP 8
1. 用 4 个空格对齐代码
# Aligned with opening delimiter. foo = long_function_name(var_one, var_two,
2. 参数换行应该与分隔符垂直对齐
3. 每行不应超过 79 个字符 • • 提高阅读体验 可以换行来缩减长度
1. 类型提示
def greeting(name: str) -> str: return 'Hello ' + name
•
• •
函数的参数和返回值类型
有助于 IDE 的代码提示 可以通过 typing 库扩展
from typing import List, Union
def sort_integers(int_list: List[Union[int, float]]): int_list.sort(reverse=True)
var2: int = 2 a:int = “2.0” # 不会报错
小结
1. 代码总是给人看的，可读性非常重要
2. PEP8, PEP484, PEP526 都是 Python 官方对编码规范的建议
3. 编码规范不用死记硬背，应该逐渐熟练成为编码习惯
8. 文档字符串
:return: the sum of the two numbers
自动化工具
1. 手动检查调整费时费力
2. pycodestyle
• • 命令行工具 可以显示源代码、相应的 PEP8 文本和改进意见等
3. PyCharm • • PEP8 检查是内置功能之一 实时检查提醒
PEP484 和 PEP526
def long_function_name(
var_three, var_four)
# More indentation included to distinguish this from the rest.
var_one, var_two, var_three, var_four): print(var_one)
4. 适当空行增强段落感
# easy to match operators with operands income = (gross_wages + taxable_interest + (dividends - qualified_dividends)
- ira_deduction
- student_loan_interest)
Baidu Nhomakorabea
PEP 8
5. import 顺序
def add_number(number1, number2): """
•
先后顺序为：标准库、第三方库、
本地库
calculate the sum of two numbers :param number1: the first number :param number2: the second number :return: the sum of the two numbers """ return number1 + number2
•
避免用 * 引入
6. 字符串分隔符尽量统一 7. 注释的要求 • 完整、同步
print(add_number.__doc__)
calculate the sum of two numbers :param number1: the first number :param number2: the second number
2. 变量标注 • • 和类型提示的语法相似 Python3.6 以后的版本才有
list_to_sort = [1, 2.2, 3.3]
sort_integers(list_to_sort)
print(list_to_sort)
# Python 3.6 Variable Annotations
3. 编辑期生效 • 提示和标注都不影响运行期