python函数注解和编码风格

函数注解

注解（Annotations）是以字典的形式存放在函数的 annotations 属性中，并且不对函数有任何影响。参数注解 (Parameter annotations) 是由参数名称后面加上冒号来定义的，后面紧跟一个描述，来表示注解的值。 返回注解 (Return annotations) 的定义方式是：由 -> 符号开始，在参数列表和表示函数 def结束的冒号之间，加上你的描述。 接下来的例子，表示了位置参数、关键字参数和返回值的注解方法：

>>> 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'

编码风格

PEP 8 是大多数 Python 项目使用的代码风格指南。它提供了高可读性和养眼的代码风格。每一个 Python 开发者都应该阅读它，这里列出了其中的一些重点：

1、缩减使用四个空格而不是制表符

2、四个空格缩进比更少空格（运行跟多的嵌套深度）或者更多空格（更容易阅读）的缩进要好。 制表符会带来歧义，所以最好不要用它

3、每行不要超过 79 个字符

4、这可以帮助显示器较小的用户与帮助显示器较大的用户同屏显示多个文件。

5、使用空行分隔函数、类或者函数内较大的代码段。

6、尽量将注释和代码放在一起。

7、用 docstrings。

8、用在操作符前后和逗号之后加空格，但是括号之内不需要： a= f(1, 2) + g(3, 4).

9、一致性的命名你的类与函数；惯例是用 CamelCase 命名类 ，用 lower_case_with_underscores 命名函数和方法。必须使用 self 作为方法的第一个参数（想了解更多请阅读 A First Look at Classes）。

10、如果你的代码将用于国际化的环境中，请不要使用任何花哨的编码。 Python 默认使用 UTF-8，甚至纯 ASCII 在任何情况下都能最好地工作。

11、即使说其他语言的人阅读或者维护你的代码的几率很小，也不要使用非 ASCII 字符

参考https://learnku.com/docs/tutorial/3.7.0/