当前位置:   article > 正文

python学习笔记(2)—— 控制流_control flow python

control flow python

参考:python 官方教学英文文档

控制流(More Control Flow Tools)

if 语句

>>>x = int(input("Please enter an integer: "))
Please enter an integer: 42
>>>if x < 0:
...    x = 0
...    print('Negative changed to zero')
...elif x == 0:
...    print('Zero')
...elif x == 1:
...    print('Single')
...else:
...    print('More')
...More
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12

可以有零个或多个elif部分,else部分是可选的。关键字’ elif ‘是’ else if '的缩写,它有助于避免过度缩进。if…elif…序列是其他语言中switch或case语句的替代品。

如果将相同的值与几个常量进行比较,或者检查特定的类型或属性,您可能会发现match语句很有用。

for 语句

Python中的for语句与你在C或Pascal中所习惯的语句略有不同。Python的for语句不是总是迭代数字的等差数列(如Pascal),也不是让用户能够定义迭代步骤和停止条件(如C),而是按照它们在序列中出现的顺序迭代任意序列(列表或字符串)中的项。例如:

>>># Measure some strings:
words = ['cat', 'window', 'defenestrate']
>>>for w in words:
      print(w, len(w))

cat 3
window 6
defenestrate 12
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8

在迭代同一集合的同时修改集合的代码可能很难正确处理。相反,通常更直接的方法是遍历集合的副本或创建一个新的集合:

# Create a sample collection
users = {'Hans': 'active', 'Éléonore': 'inactive', '景太郎': 'active'}

# Strategy:  Iterate over a copy
for user, status in users.copy().items():
    if status == 'inactive':
        del users[user]

# Strategy:  Create a new collection
active_users = {}
for user, status in users.items():
    if status == 'active':
        active_users[user] = status
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13

range() 函数

如果确实需要对数字序列进行迭代,则内置函数range()会派上用场。它生成等差级数:

>>>for i in range(5):
...    print(i)
...
0
1
2
3
4
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8

给定的结束端点从来不是生成序列的一部分; range(10)生成10个值,它们是长度为10的序列项的合法索引。也可以让范围从另一个数字开始,或者指定不同的增量(甚至是负数;有时这被称为“step”):

>>>list(range(5, 10))
[5, 6, 7, 8, 9]

>>>list(range(0, 10, 3))
[0, 3, 6, 9]

>>>list(range(-10, -100, -30))
[-10, -40, -70]
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8

要遍历序列的索引,你可以组合range()和len(),如下所示:

>>>a = ['Mary', 'had', 'a', 'little', 'lamb']
>>>for i in range(len(a)):
       print(i, a[i])

0 Mary
1 had
2 a
3 little
4 lamb
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9

然而,在大多数这种情况下,使用enumerate()函数比较方便,请参阅Looping技术。

如果你只是打印一个range,会发生一件奇怪的事情:

>>>range(10)
range(0, 10)
  • 1
  • 2

在很多情况下,range()返回的对象表现得就像一个列表,但实际上它不是。它是一个对象,当您遍历它时,它返回所需序列的连续项,但它并不真正进入列表,因此节省空间。

我们说这样的对象是可迭代的,也就是说,适合作为函数和构造的目标,这些函数和构造期望从这些对象中获得连续的项,直到耗尽供应。我们已经看到,for语句就是这样一个构造,而接受可迭代对象的函数的一个例子是sum():

>>>sum(range(4))  # 0 + 1 + 2 + 3
6
  • 1
  • 2

breakcontinue 语句

break语句与C中一样,突破了最内部的封闭for或while循环。

循环语句可以有else子句;当循环因耗尽可迭代对象而终止时(使用for)或当条件为false时(使用while)执行,但当循环由break语句终止时不执行。下面的循环就是一个例子,它搜索质数:

>>> for n in range(2, 10):
		    for x in range(2, n):
		        if n % x == 0:
		            print(n, 'equals', x, '*', n//x)
		            break
		    else:
		        # loop fell through without finding a factor
		        print(n, 'is a prime number')

2 is a prime number
3 is a prime number
4 equals 2 * 2
5 is a prime number
6 equals 2 * 3
7 is a prime number
8 equals 2 * 4
9 equals 3 * 3
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17

(是的,这是正确的代码。仔细看:else子句属于for循环,而不是if语句)

当与循环一起使用时,else子句与try语句的else子句有更多的共同之处,而不是与if语句的else子句: try语句的else子句在没有异常发生时运行,而循环的else子句在没有中断发生时运行。

continue语句也是借鉴自C语言,用于循环的下一次迭代:

>>> for num in range(2, 10):
		    if num % 2 == 0:
		        print("Found an even number", num)
		        continue
		    print("Found an odd number", num)
		
Found an even number 2
Found an odd number 3
Found an even number 4
Found an odd number 5
Found an even number 6
Found an odd number 7
Found an even number 8
Found an odd number 9
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14

pass 语句

pass语句什么也不做。当语法上需要一条语句但程序不需要任何操作时,可以使用它。例如:

>>>while True:
      pass  # Busy-wait for keyboard interrupt (Ctrl+C)
  • 1
  • 2

这通常用于创建最小类:

>>> class MyEmptyClass:
		   pass
  • 1
  • 2

另一个可以使用pass的地方是在处理新代码时作为函数或条件体的占位符,允许您在更抽象的级别上继续思考。pass会被忽略:

>>> def initlog(*args):
       pass   # Remember to implement this!
  • 1
  • 2

match 语句

match语句接受一个表达式,并将其值与作为一个或多个case块给出的连续模式进行比较。这表面上类似于C、Java或JavaScript(以及许多其他语言)中的switch语句,但它更类似于Rust或Haskell等语言中的模式匹配。只有第一个匹配的模式被执行,它还可以从值中提取组件(序列元素或对象属性)到变量中。

最简单的形式是将主题值与一个或多个字面量进行比较:

def http_error(status):
    match status:
        case 400:
            return "Bad request"
        case 404:
            return "Not found"
        case 418:
            return "I'm a teapot"
        case _:
            return "Something's wrong with the internet"
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10

注意最后一个块:“变量名”_作为通配符,永远不会匹配失败。如果没有匹配的案例,则不执行任何分支。

你可以使用|(“或者”)在单个模式中组合多个字面量:

case 401 | 403 | 404:
    return "Not allowed"
  • 1
  • 2

模式看起来像解包赋值,可以用来绑定变量:

# point is an (x, y) tuple
match point:
    case (0, 0):
        print("Origin")
    case (0, y):
        print(f"Y={y}")
    case (x, 0):
        print(f"X={x}")
    case (x, y):
        print(f"X={x}, Y={y}")
    case _:
        raise ValueError("Not a point")
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12

仔细研究这个: 第一个模式有两个字面量,可以认为是上面显示的字面量模式的扩展。但是接下来的两种模式组合了文字和变量,变量绑定了来自subject(点)的值。第四个模式捕获两个值,这使得它在概念上类似于解包赋值(x, y) =点。

如果你正在使用类来构造你的数据,你可以使用类名后面跟一个类似构造函数的参数列表,但具有将属性捕获到变量的能力:

class Point:
    x: int
    y: int

def where_is(point):
    match point:
        case Point(x=0, y=0):
            print("Origin")
        case Point(x=0, y=y):
            print(f"Y={y}")
        case Point(x=x, y=0):
            print(f"X={x}")
        case Point():
            print("Somewhere else")
        case _:
            print("Not a point")
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16

你可以在一些内置类中使用位置参数,这些类为它们的属性提供了排序(例如数据类)。通过在类中设置__match_args__特殊属性,还可以为模式中的属性定义一个特定的位置。如果它被设置为(" x ", " y "),下面的模式都是等价的(并且都将y属性绑定到var变量):

Point(1, var)
Point(1, y=var)
Point(x=1, y=var)
Point(y=var, x=1)
  • 1
  • 2
  • 3
  • 4

阅读模式的一种推荐方法是将它们视为赋值左边内容的扩展形式,以理解哪些变量将被设置为什么。只有独立名称(如上面的var)由match语句赋值。虚线名称(如foo.bar)、属性名称(如上面的x=y=)或类名称(由它们旁边的“(…)”识别,如上面的Point)永远不会被赋值。

模式可以任意嵌套。例如,如果我们有一个简短的点列表,我们可以像这样匹配它:

match points:
    case []:
        print("No points")
    case [Point(0, 0)]:
        print("The origin")
    case [Point(x, y)]:
        print(f"Single point {x}, {y}")
    case [Point(0, y1), Point(0, y2)]:
        print(f"Two on the Y axis at {y1}, {y2}")
    case _:
        print("Something else")
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11

我们可以在模式中添加if子句,称为“守卫”。如果守卫为假,匹配将继续尝试下一个case块。注意,值捕获发生在评估守卫之前:

match point:
    case Point(x, y) if x == y:
        print(f"Y=X at {x}")
    case Point(x, y):
        print(f"Not on the diagonal")
  • 1
  • 2
  • 3
  • 4
  • 5

这条语句的其他几个关键特性:

  • 像解包赋值一样,元组和列表模式具有完全相同的含义,实际上可以匹配任意序列。一个重要的例外是它们不匹配迭代器或字符串。

  • 序列模式支持扩展解包:[x, y, *rest](x, y, *rest)的工作与解包赋值类似。*后面的名字也可以是_,所以(x, y, *_)匹配至少两个元素的序列,而不绑定其余元素。

  • 映射模式:{"bandwidth": b, "latency": l}从字典中捕获"bandwidth"和"latency"的值。与序列模式不同,额外的键会被忽略。它也支持类似**rest 的解包。(但_是多余的,所以是不允许的。)

  • 可以使用as关键字来捕获子模式

    case (Point(x1, y1), Point(x2, y2) as p2): ...
    # 将输入的第二个元素捕获为p2(只要输入是两个点的序列)
    
    • 1
    • 2
  • 大多数字面量是通过相等来比较的,但是单例True、False和None是通过indentity来比较的。

from enum import Enum
class Color(Enum):
    RED = 'red'
    GREEN = 'green'
    BLUE = 'blue'

color = Color(input("Enter your choice of 'red', 'blue' or 'green': "))

match color:
    case Color.RED:
        print("I see red!")
    case Color.GREEN:
        print("Grass is green")
    case Color.BLUE:
        print("I'm feeling the blues :(")
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15

模式可以使用命名常量。这些名称必须为dotted name,以防止它们被解释为捕获变量:

函数定义

我们可以创建一个函数,将斐波那契数列写入任意边界:

>>>def fib(n):    # write Fibonacci series up to n
	    """Print a Fibonacci series up to n."""
	    a, b = 0, 1
	    while a < n:
	        print(a, end=' ')
	        a, b = b, a+b
	    print()

# Now call the function we just defined:
>>>fib(2000)
0 1 1 2 3 5 8 13 21 34 55 89 144 233 377 610 987 1597
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11

关键字def引入一个函数定义。它后面必须跟着函数名和圆括号括起来的形式形参列表。构成函数主体的语句从下一行开始,并且必须缩进。

函数的执行会引入一个新的符号表,用于存储函数的局部变量。更准确地说,函数中所有的变量赋值都将值存储在局部符号表中。而变量引用首先会在局部符号表中查找,然后是外部函数的局部符号表,然后是全局符号表,最后是内置名称表。因此,全局变量和封闭函数中的变量不能在函数中直接赋值(除非全局变量是在global语句中命名的,或者封闭函数中的变量是在nonlocal语句中命名的),尽管它们可以被引用。

函数调用的实际形参(实参)在被调用函数的局部符号表中引入。因此,参数是通过值调用传递的(值始终是对象引用,而不是对象本身的值)。当一个函数调用另一个函数或递归调用自己时,会为该调用创建一个新的局部符号表。函数定义将函数名与当前符号表中的函数对象关联起来。解释器将该名称指向的对象识别为用户定义的函数。其他名字也可以指向同一个函数对象,也可以用来访问这个函数:

>>>fib
<function fib at 10042ed0>
>>>f = fib
>>>f(100)
0 1 1 2 3 5 8 13 21 34 55 89
  • 1
  • 2
  • 3
  • 4
  • 5

来自其他语言的经验,你可能会反对fib不是一个函数而是一个过程,因为它不返回值。事实上,即使没有return语句的函数也会返回一个值,尽管是一个相当无聊的值。这个值称为None(这是一个内置名称)。如果None是唯一写入的值,解释器通常会抑制它。如果你真的想使用print(),你可以看到它:

>>>fib(0)
>>>print(fib(0))
None
  • 1
  • 2
  • 3

编写一个返回斐波那契数列的数字列表的函数很简单:

>>>def fib2(n):  # return Fibonacci series up to n
	    """Return a list containing the Fibonacci series up to n."""
	    result = []
	    a, b = 0, 1
	    while a < n:
	        result.append(a)    # see below
	        a, b = b, a+b
	    return result

>>>f100 = fib2(100)    # call it
>>>f100                # write the result
[0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89]
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12

与往常一样,这个示例演示了一些新的Python特性:return语句返回函数的值。return不带表达式参数返回None。从函数末尾脱落也会返回None

语句result.append(a)调用列表对象result的一个方法。方法是一个“属于”对象的函数,命名为obj。其中,obj是某个对象(这可能是一个表达式),Methodname是由对象的类型定义的方法名。不同的类型定义不同的方法。不同类型的方法可以具有相同的名称而不会引起歧义。(可以使用类定义自己的对象类型和方法,请参阅类)示例中显示的方法append()是为列表对象定义的;它在列表的末尾添加一个新元素。在本例中,它等价于result = result + [a],但效率更高。

定义函数的更多用法

默认参数值

最有用的形式是为一个或多个参数指定默认值。这将创建一个函数,调用该函数时可以使用比定义允许的更少的参数。例如:

def ask_ok(prompt, retries=4, reminder='Please try again!'):
    while True:
        ok = input(prompt)
        if ok in ('y', 'ye', 'yes'):
            return True
        if ok in ('n', 'no', 'nop', 'nope'):
            return False
        retries = retries - 1
        if retries < 0:
            raise ValueError('invalid user response')
        print(reminder)
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11

这个函数可以通过几种方式调用:

  • ask_ok('Do you really want to quit?')
  • ask_ok('OK to overwrite the file?', 2)
  • ask_ok('OK to overwrite the file?', 2, 'Come on, only yes or no!')

默认值会取在函数定义时的作用域的值,比如下例会输出5:

i = 5

def f(arg=i):
    print(arg)

i = 6
f()
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7

重要警告:默认值只计算一次。当默认值是一个可变对象(如列表、字典或大多数类的实例)时,这就有所不同了。例如,下面的函数会在后续调用中累积传递给它的参数:

def f(a, L=[]):
    L.append(a)
    return L

print(f(1))
print(f(2))
print(f(3))
# 会输出
[1]
[1, 2]
[1, 2, 3]
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11

如果你不想在后续调用之间共享默认值,你可以这样写函数:

def f(a, L=None):
    if L is None:
        L = []
    L.append(a)
    return L
  • 1
  • 2
  • 3
  • 4
  • 5

关键字参数

也可以使用kwarg=value形式的关键字参数来调用函数。例如,以下函数:

def parrot(voltage, state='a stiff', action='voom', type='Norwegian Blue'):
    print("-- This parrot wouldn't", action, end=' ')
    print("if you put", voltage, "volts through it.")
    print("-- Lovely plumage, the", type)
    print("-- It's", state, "!")
  • 1
  • 2
  • 3
  • 4
  • 5

接受一个必需参数(voltage)和三个可选参数(state、action和type)。这个函数可以通过以下任何一种方式调用:

parrot(1000)                                          # 1 positional argument
parrot(voltage=1000)                                  # 1 keyword argument
parrot(voltage=1000000, action='VOOOOOM')             # 2 keyword arguments
parrot(action='VOOOOOM', voltage=1000000)             # 2 keyword arguments
parrot('a million', 'bereft of life', 'jump')         # 3 positional arguments
parrot('a thousand', state='pushing up the daisies')  # 1 positional, 1 keyword
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6

但是下面所有的调用都是无效的:

parrot()                     # required argument missing
parrot(voltage=5.0, 'dead')  # non-keyword argument after a keyword argument
parrot(110, voltage=220)     # duplicate value for the same argument
parrot(actor='John Cleese')  # unknown keyword argument
  • 1
  • 2
  • 3
  • 4

在函数调用中,关键字参数必须跟在位置参数后面。传递的所有关键字参数必须匹配函数接受的参数之一(例如actor不是parrot函数的有效参数),它们的顺序并不重要。这也包括非可选参数(例如parrot(voltage=1000)也是有效的)。任何参数都不能接收一个值超过一次。下面是一个由于这个限制而失败的例子:

def cheeseshop(kind, *arguments, **keywords):
    print("-- Do you have any", kind, "?")
    print("-- I'm sorry, we're all out of", kind)
    for arg in arguments:
        print(arg)
    print("-" * 40)
    for kw in keywords:
        print(kw, ":", keywords[kw])
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8

它可以这样调用:

cheeseshop("Limburger", "It's very runny, sir.",
           "It's really very, VERY runny, sir.",
           shopkeeper="Michael Palin",
           client="John Cleese",
           sketch="Cheese Shop Sketch")
  • 1
  • 2
  • 3
  • 4
  • 5

输出:

-- Do you have any Limburger ?
-- I'm sorry, we're all out of Limburger
It's very runny, sir.
It's really very, VERY runny, sir.
----------------------------------------
shopkeeper : Michael Palin
client : John Cleese
sketch : Cheese Shop Sketch
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8

请注意,打印关键字参数的顺序保证与函数调用中提供它们的顺序匹配。

特殊参数

默认情况下,参数可以通过位置或显式地通过关键字传递给Python函数。为了可读性和性能,有必要限制参数的传递方式,以便开发人员只需要查看函数定义来确定项是按位置、按位置或关键字还是按关键字传递的。

函数定义可能如下所示:

def f(pos1, pos2, /, pos_or_kwd, *, kwd1, kwd2):
      -----------    ----------     ----------
        |             |                  |
        |        Positional or keyword   |
        |                                - Keyword only
         -- Positional only
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6

其中/*是可选的。如果使用这些符号,这些符号通过将实参传递给函数的方式指示形参的类型: 仅位置形参、仅位置形参或关键字形参和仅关键字形参。关键字参数也称为命名参数。

  • Positional-or-Keyword参数
    如果函数定义中没有/和*,则可以通过位置或关键字将参数传递给函数。
  • Positional-Only参数
    更详细地看一下这个问题,可以将某些参数标记为仅限位置的。如果仅限位置,则参数的顺序很重要,且参数不能通过关键字传递。仅限位置参数放在/(正斜杠)之前。/用于从逻辑上将仅限位置的参数与其他参数分开。如果函数定义中没有/,则没有仅限位置的形参。/后面的参数可以是位置-或关键字或仅关键字。
  • Keyword-Only参数
    要将参数标记为纯关键字,表示参数必须通过关键字参数传递,请在参数列表中仅在第一个纯关键字参数之前放置一个*

可变参数列表

最后,最不常用的选项是指定可以用任意数量的参数调用函数。这些参数将被封装在一个元组中(参见元组和序列)。在可变数量的参数之前,可能出现0个或多个正常参数。

def write_multiple_items(file, separator, *args):
    file.write(separator.join(args))
  • 1
  • 2

通常,这些可变参数将在形式形参列表的最后,因为它们会吸收传递给函数的所有剩余输入参数。出现在*args形参之后的任何形式形参都是“仅关键字”形参,这意味着它们只能作为关键字而不是位置形参使用。

>>>def concat(*args, sep="/"):
       return sep.join(args)

>>>concat("earth", "mars", "venus")
'earth/mars/venus'
>>>concat("earth", "mars", "venus", sep=".")
'earth.mars.venus'
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7

拆封参数列表

当参数已经在列表或元组中,但需要为需要单独位置参数的函数调用解包时,则会发生相反的情况。例如,内置的range()函数需要独立的start和stop参数。如果它们不能单独使用,用*操作符编写函数调用,将参数从列表或元组中解包:

>>>list(range(3, 6))            # normal call with separate arguments
[3, 4, 5]
>>>args = [3, 6]
>>>list(range(*args))            # call with arguments unpacked from a list
[3, 4, 5]
  • 1
  • 2
  • 3
  • 4
  • 5

以同样的方式,字典可以通过**操作符传递关键字参数:

>>>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)
-- This parrot wouldn't VOOM if you put four million volts through it. E's bleedin' demised !
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8

Lambda表达式

可以使用lambda关键字创建小型匿名函数。这个函数返回其两个参数和: lambda a, b: a+b。Lambda函数可以在任何需要函数对象的地方使用。它们在语法上受限于单个表达式。从语义上讲,它们只是普通函数定义的语法糖。像嵌套函数定义一样,lambda函数可以引用包含作用域的变量:

>>>def make_incrementor(n):
       return lambda x: x + n

>>>f = make_incrementor(42)
>>>f(0)
42
>>>f(1)
43
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8

上面的示例使用lambda表达式返回函数。另一种用法是传递一个小函数作为参数:

>>>pairs = [(1, 'one'), (2, 'two'), (3, 'three'), (4, 'four')]
>>>pairs.sort(key=lambda pair: pair[1])
>>>pairs
[(4, 'four'), (1, 'one'), (3, 'three'), (2, 'two')]
  • 1
  • 2
  • 3
  • 4

文档字符串

下面是关于文档字符串的内容和格式的一些约定。

第一行应该是对象目的的简短总结。为简洁起见,它不应该显式地声明对象的名称或类型,因为这些可以通过其他方式获得(除非名称恰好是描述函数操作的动词)。这一行应该以大写字母开头,以句号结尾。

如果文档字符串中有更多行,第二行应该是空的,从视觉上将摘要与描述的其余部分分开。下面的行应该是一个或多个段落,描述对象的调用约定,它的副作用等。

Python解析器不会在Python中去除多行字符串字面量的缩进,因此处理文档的工具必须根据需要去除缩进。这是使用以下约定完成的。字符串第一行之后的第一个非空行决定了整个文档字符串的缩进大小。(我们不能使用第一行,因为它通常与字符串的开始引号相邻,因此它的缩进在字符串字面量中不明显。)然后从字符串的所有行开始处删除与缩进“等价”的空白。不应该出现缩进少的行,但如果出现了缩进少的行,则应该去掉前导的所有空格。在扩展制表符(通常为8个空格)后,应测试空白的等价性。

下面是一个多行文档字符串的例子:

def my_function():
    """Do nothing, but document it.

    No, really, it doesn't do anything.
    """
    pass

print(my_function.__doc__)
Do nothing, but document it.

    No, really, it doesn't do anything.
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11

函数注释

函数注释是关于用户定义函数使用的类型的完全可选的元数据信息。

注释以字典的形式存储在函数的__annotations__属性中,对函数的任何其他部分都没有影响。参数注释由参数名后面的冒号定义,后面跟着一个求值为注释值的表达式。返回注释由一个文字->和一个表达式定义,位于参数列表和表示def语句结束的冒号之间。下面的示例包含一个required参数、一个optional参数和一个带注释的返回值:

def f(ham: str, eggs: str = 'eggs') -> str:
...    print("Annotations:", f.__annotations__)
...    print("Arguments:", ham, eggs)
...return ham + ' and ' + eggs
...>>>f('spam')
Annotations: {'ham': <class 'str'>, 'return': <class 'str'>, 'eggs': <class 'str'>}
Arguments: spam eggs
'spam and eggs'
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/weixin_40725706/article/detail/166937
推荐阅读
相关标签
  

闽ICP备14008679号