1 关于字符串
相邻的两个或多个字符串字面值 (引号引起来的字符)将会自动连接到一起:
str_cat = 'py' "thon" '!'
str_cat
输出:
python!
把很长的字符串拆开分别输入的时候尤其有用:
text = ('Put several strings within parentheses '
'to have them joined together.')
text
输出:
Put several strings within parentheses to have them joined together.
2 关于函数
在函数被调用时,实际参数(实参)会被引入被调用函数的本地符号表中;因此,实参是通过 按值调用 传递的(其中 值 始终是对象 引用 而不是对象的值)。
当一个函数调用另外一个函数时,将会为该调用创建一个新的本地符号表。实际上,通过对象引用调用 会是一个更好的表述,因为如果传递的是可变对象,则调用者将看到被调用者对其做出的任何更改(插入到列表中的元素)。
函数定义会将函数名称与函数对象在当前符号表中进行关联。 解释器会将该名称所指向的对象识别为用户自定义函数。 其他名称也可指向同一个函数对象并可被用来访问访函数:
重要警告: 函数默认值只会执行一次。这条规则在默认值为可变对象(列表、字典以及大多数类实例)时很重要。比如,下面的函数会存储在后续调用中传递给它的参数:
def f(a, L=[]):
L.append(a)
return L
print(f(1))
print(f(2))
print(f(3))
如果你不想要在后续调用之间共享默认值,你可以这样写这个函数:
def f(a, L=None):
if a is None:
L = []
L.append(a)
return L
print(f(1))
print(f(2))
print(f(3))
函数定义:
def f(pos1, pos2, /, pos_or_kwd, *, kwd1, kwd2):
----------- ---------- ----------
| | |
| Positional or keyword |
| - Keyword only
-- Positional only
- 如果你希望形参名称对用户来说不可用,则使用仅限位置形参。 这适用于形参名称没有实际意义,以及当你希望强制规定调用时的参数顺序,或是需要同时收受一些位置形参和任意关键字形参等情况。
- 当形参名称有实际意义,以及显式指定形参名称可使函数定义更易理解,或者当你想要防止用户过于依赖传入参数的位置时,则使用仅限关键字形参。
- 对于 API 来说,使用仅限位置形参可以防止形参名称在未来被修改时造成破坏性的 API 变动。
def standard_arg(arg):
print(arg)
def pos_only_arg(arg, /):
print(arg)
def kwd_only_arg(*, arg):
print(arg)
def combined_example(pos_only, /, standard, *, kwd_only):
print(pos_only, standard, kwd_only)
最不常用的选项是可以使用任意数量的参数调用函数。这些参数会被包含在一个元组里(参见 元组和序列 )。在可变数量的参数之前,可能会出现零个或多个普通参数。
def write_multiple_items(file, separator, *args):
file.write(separator.join(args))
一般来说,这些 可变参数 将在形式参数列表的末尾,因为它们收集传递给函数的所有剩余输入参数。出现在 *args
参数之后的任何形式参数都是 ‘仅关键字参数’,也就是说它们只能作为关键字参数而不能是位置参数:
def concat(*args, sep="/"):
return sep.join(args)
concat("earth", "mars", "venus")
concat("earth", "mars", "venus", sep=".")
3 解包参数列表
当参数已经在列表或元组中但要为需要单独位置参数的函数调用解包时,会发生相反的情况。例如,内置的 range()
函数需要单独的 start
和 stop
参数。如果它们不能单独使用,可以使用 *
操作符来编写函数调用以便从列表或元组中解包参数:
list(range(3, 6)) # normal call with separate arguments
args = [3, 6]
list(range(*args)) # call with arguments unpacked from a list
同样的方式,字典可使用 **
操作符 来提供关键字参数:
def parrot(voltage, state='a stiff', action='voom'):
print("-- This parrot wouldn't", action, end=' ')
print("if you put", voltage, "volts through it.", end=' ')
print("E's", state, "!")
d = {"voltage": "four million", "state": "bleedin' demised", "action": "VOOM"}
parrot(**d)
4 Lambda 表达式
可以用 lambda
关键字来创建一个小的匿名函数。这个函数返回两个参数的和:lambda a, b: a+b
。lambda
函数可以在需要函数对象的任何地方使用。它们在语法上限于单个表达式。从语义上来说,它们只是正常函数定义的语法糖。与嵌套函数定义一样,lambda
函数可以引用所包含域的变量:
def make_incrementor(n):
return lambda x: x + n
f = make_incrementor(42)
f(0), f(1)
上面的例子使用一个lambda
表达式来返回一个函数。另一个用法是传递一个小函数作为参数:
pairs = [(1, 'one'), (2, 'two'), (3, 'three'), (4, 'four')]
pairs.sort(key=lambda pair: pair[1])
pairs
5 文档字符串
以下是有关文档字符串的内容和格式的一些约定。
- 第一行应该是对象目的的简要概述。为简洁起见,它不应显式声明对象的名称或类型,因为这些可通过其他方式获得(除非名称恰好是描述函数操作的动词)。这一行应以大写字母开头,以句点结尾。
- 如果文档字符串中有更多行,则第二行应为空白,从而在视觉上将摘要与其余描述分开。后面几行应该是一个或多个段落,描述对象的调用约定,它的副作用等。
Python 解析器不会从 Python 中删除多行字符串文字的缩进,因此处理文档的工具必须在需要时删除缩进。这是使用以下约定完成的。文档字符串第一行之后的第一个非空行确定整个文档字符串的缩进量。(我们不能使用第一行,因为它通常与字符串的开头引号相邻,因此它的缩进在字符串文字中不明显。)然后从字符串的所有行的开头剥离与该缩进 "等效" 的空格。缩进更少的行不应该出现,但是如果它们出现,则应该剥离它们的所有前导空格。应在转化制表符为空格后测试空格的等效性(通常转化为8个空格)。
def my_function():
"""Do nothing, but document it.
No, really, it doesn't do anything.
"""
pass
print(my_function.__doc__)
6 函数标注
函数标注 是关于用户自定义函数中使用的类型的完全可选元数据信息(有关详情请参阅 PEP 3107 和 PEP 484 )。
函数标注 以字典的形式存放在函数的 __annotations__
属性中,并且不会影响函数的任何其他部分。形参标注的定义方式是在形参名称后加上冒号,后面跟一个表达式,该表达式会被求值为标注的值。返回值标注的定义方式是加上一个组合符号 ->
,后面跟一个表达式,该标注位于形参列表和表示 def
语句结束的冒号之间。下面的示例有一个位置参数,一个关键字参数以及返回值带有相应标注:
def f(ham: str, eggs: str = 'eggs') -> str:
print("Annotations:", f.__annotations__)
print("Arguments:", ham, eggs)
return ham + ' and ' + eggs
f('spam')
7 编码风格 PEP 8
- 使用4个空格缩进,不要使用制表符。
4个空格是一个在小缩进(允许更大的嵌套深度)和大缩进(更容易阅读)的一种很好的折中方案。制表符会引入混乱,最好不要使用它。 - 换行,使一行不超过79个字符。
这有助于使用小型显示器的用户,并且可以在较大的显示器上并排放置多个代码文件。 - 使用空行分隔函数和类,以及函数内的较大的代码块。
- 如果可能,把注释放到单独的一行。
- 使用文档字符串。
- 在运算符前后和逗号后使用空格,但不能直接在括号内使用。例如,
a = f(1, 2) + g(3, 4)
是不好的写法。 - 以一致的规则为你的类和函数命名;按照惯例应使用
UpperCamelCase
来命名类,而以lowercase_with_underscores
来命名函数和方法。 始终应使用self
来命名第一个方法参数 (有关类和方法的更多信息请参阅 初探类)。 - 如果你的代码旨在用于国际环境,请不要使用花哨的编码。Python 默认的 UTF-8 或者纯 ASCII 在任何情况下都能有最好的表现。
- 同样,哪怕只有很小的可能,遇到说不同语言的人阅读或维护代码,也不要在标识符中使用非ASCII字符。
-
import
应该独立成行
# Correct:
import os
import sys
# Wrong:
import sys, os
也可以:
# Correct:
from subprocess import Popen, PIPE
8 __main__
--- 顶层脚本环境
'__main__'
是顶层代码执行的作用域的名称。模块的 __name__
在通过标准输入、脚本文件或是交互式命令读入的时候会等于 '__main__'
。
模块可以通过检查自己的 __name__
来得知是否运行在 main
作用域中,这使得模块可以在作为脚本或是通过 python -m
运行时条件性地执行一些代码,而在被 import
时不会执行。
if __name__ == "__main__":
# execute only if run as a script
main()
对软件包来说,通过加入 main.py 模块可以达到同样的效果,当使用 -m 运行模块时,其中的代码会被执行。