Day04 - Python 迭代器、装饰器、软件开发规范

1. 列表生成式

实现对列表中每个数值都加一

第一种，使用for循环，取列表中的值，值加一后，添加到一空列表中，并将新列表赋值给原列表

>>> a = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
>>> b = []
>>> for i in a:
...     b.append(i + 1)
... 
>>> a = b
>>> a
[1, 2, 3, 4, 5, 6, 7, 8, 9, 10]

第二种，使用匿名函数和map函数，并循环取值添加的另一空列表中，并将新列表赋值给原列表

>>> a = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
>>> b = []
>>> for i in map(lambda x:x+1,a):
...     b.append(i)
... 
>>> a = b
>>> a
[1, 2, 3, 4, 5, 6, 7, 8, 9, 10]

第三种，使用列表生成式

>>> a = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
>>> a = [i+1 for i in a]
>>> a
[1, 2, 3, 4, 5, 6, 7, 8, 9, 10]

 

2. 生成器

在Python中，一边循环一边计算的机制，称为生成器（generator）。

创建一个generator：

第一种方法，只要把列表生成式的 [] 改成 () ，就创建了一个generator。

>>> l = [x * x for x in range(10)]
>>> l
[0, 1, 4, 9, 16, 25, 36, 49, 64, 81]
>>> g = (x * x for x in range(10))
>>> g
<generator object <genexpr> at 0xb7b1fc5c>

通过next()函数获得generator的下一个返回值

>>> next(g)
0
>>> next(g)
1
>>> next(g)
4
>>> next(g)
9
>>> next(g)
16
>>> next(g)
25
>>> next(g)
36
>>> next(g)
49
>>> next(g)
64
>>> next(g)
81
>>> next(g)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
StopIteration

generator 保存的是算法，每次调用next(g)，就计算出g的下一个元素的值，直到计算到最后一个元素，没有更多的元素时，抛出StopIteration的错误。

generator 是可迭代对象，可以使用for循环打印 generator 的元素：

>>> for i in g:
...   print(i)
... 
0
1
4
9
16
25
36
49
64
81

第二种方法，添加 yield 关键字。如果一个函数定义中包含yield关键字，那么这个函数就不再是一个普通函数，而是一个generator。

generator 和函数的执行流程不一样。函数是顺序执行的，遇到 return 语句或者最后一行函数语句就返回。而 generator 函数，在每次调用next()的时候执行，遇到yield语句返回，再次执行时从上次返回的yield语句处继续执行。

3. 迭代器

 

作用于for循环的数据类型有以下几种：

一类是集合数据类型，如list、tuple、dict、set、str等；另一类是generator，包括生成器和带yield的generator function。

这些可以直接作用于for循环的对象统称为可迭代对象（Iterable）。

可以使用isinstance()判断一个对象是否是Iterable对象：

>>> from collections import Iterable
>>> isinstance([], Iterable)
True
>>> isinstance({}, Iterable)
True
>>> isinstance('abc', Iterable)
True
>>> isinstance((x for x in range(10)), Iterable)
True
>>> isinstance(100, Iterable)
False

可以被next()函数调用并不断返回下一个值的对象称为迭代器（Iterator）。

可以使用isinstance()判断一个对象是否是Iterator对象：

>>> from collections import Iterator
>>> isinstance((x for x in range(10)), Iterator)
True
>>> isinstance([], Iterator)
False
>>> isinstance({}, Iterator)
False
>>> isinstance('abc', Iterator)
False

生成器都是Iterator对象，但list、dict、str虽然是Iterable，却不是Iterator。

把list、dict、str等Iterable变成Iterator可以使用iter()函数：

>>> isinstance(iter([]), Iterator)
True
>>> isinstance(iter('abc'), Iterator)
True

 

Iterator的计算是惰性的，只有在需要返回下一个数据时它才会计算。

凡是可作用于for循环的对象都是Iterable类型；

凡是可作用于next()函数的对象都是Iterator类型，它们表示一个惰性计算的序列；

集合数据类型如list、dict、str等是Iterable但不是Iterator，不过可以通过iter()函数获得一个Iterator对象。

Python的for循环本质上就是通过不断调用next()函数实现的，例如：

for x in [1, 2, 3, 4, 5]:
    pass

等价于：

# 首先获得Iterator对象:
it = iter([1, 2, 3, 4, 5])
# 循环:
while True:
    try:
        # 获得下一个值:
        x = next(it)
    except StopIteration:
        # 遇到StopIteration就退出循环
        break

4. 装饰器

软件开发中的一个原则：“开放-封闭”原则。简单来说，它规定已经实现的功能代码不允许被修改，但可以被扩展，即：

• 封闭：已实现的功能代码块
• 开放：对扩展开发

装饰器本质上是一个 Python 函数，它可以让其他函数在不需要做任何代码变动的前提下增加额外功能。装饰器的返回值也是一个函数对象，它经常用于有切面需求的场景，比如：插入日志、性能测试、事务处理、缓存、权限校验等场景。装饰器是解决这类问题的绝佳设计，有了装饰器，就可以抽离出大量与函数功能本身无关的雷同代码并继续重用。概括的讲，装饰器的作用就是为已经存在的对象添加额外的功能。
1）入门示例：

第一步，写一个简单的函数：

#!/usr/bin/env python
# -*- coding:UTF-8 -*-


def myfunc():
    print("i am myfunc ...")

myfunc()

输出结果：

i am myfunc

第二步，添加打印日志的功能：

#!/usr/bin/env python
# -*- coding:UTF-8 -*-


def myfunc():
    print("myfunc() called ...")
    print("i am myfunc")

myfunc()

输出结果：

myfunc() called ...
i am myfunc

好处：成功插入了日志功能

缺点：1）其他函数也有插入日志的需求，这样写就形成了大量的重复代码。

　　　2）违背了“开放-封闭”原则，已经实现的功能代码被修改。

为了减少重复写代码，根据“开放-封闭”原则，重新定义一个函数，用来专门处理日志。

第三步，定义一个记录日志的函数：

#!/usr/bin/env python
# -*- coding:UTF-8 -*-


def myfunc():
    print("i am myfunc")


# def myfunc():
#     print("myfunc() called ...")
#     print("i am myfunc")


def use_logging(func):
    print("%s is called ..." % func.__name__)
    func()

use_logging(myfunc)

输出结果：

myfunc is called ...
i am myfunc

好处：

　　1）符合“开放-封闭”原则

      2）减少了重复代码

缺点：改变了调用方式，破坏了原有代码的逻辑结构

第四步，使用装饰器

#!/usr/bin/env python
# -*- coding:UTF-8 -*-


def myfunc():
    print("i am myfunc")


def use_logging(func):
    def wrapper(*args, **kwargs):
        print("%s is called ..." % func.__name__)
        func()
    return wrapper

myfunc = use_logging(myfunc)
myfunc()

输出结果：

myfunc is called ...
i am myfunc

函数 use_logging 就是装饰器，它把执行真正业务方法的 func 包裹在函数里面，看起来像 myfunc 被 use_logging 装饰了。在这个例子中，函数进入和退出时 ，被称为一个横切面(Aspect)，这种编程方式被称为面向切面的编程(Aspect-Oriented Programming)。

@ 符号是装饰器的语法糖，在定义函数的时候使用，避免再一次赋值操作。

第五步，使用语法糖：

#!/usr/bin/env python
# -*- coding:UTF-8 -*-


def use_logging(func):
    def wrapper(*args, **kwargs):
        print("%s is called ..." % func.__name__)
        func()
    return wrapper


@use_logging
def myfunc():
    print("i am myfunc")

myfunc()

输出结果：

myfunc is called ...
i am myfunc

如上所示，这样我们就可以省去 myfunc = use_logging(myfunc) 这一句了，直接调用 myfunc() 即可得到想要的结果。如果我们有其他的类似函数，我们可以继续调用装饰器来修饰函数，而不用重复修改函数或者增加新的封装。这样，我们就提高了程序的可重复利用性，并增加了程序的可读性。

装饰器在 Python 使用如此方便都要归因于 Python 的函数能像普通的对象一样能作为参数传递给其他函数，可以被赋值给其他变量，可以作为返回值，可以被定义在另外一个函数内。

2）带参数的装饰器

装饰器还有更大的灵活性，例如带参数的装饰器：在上面的装饰器调用中，比如 @use_logging，该装饰器唯一的参数就是执行业务的函数。装饰器的语法允许我们在调用时，提供其它参数，比如 @decorator(a) ，这样，就为装饰器的编写和使用提供了更大的灵活性。

#!/usr/bin/env python
# -*- coding:UTF-8 -*-


def use_logging(level):
    def decorator(func):
        def wrapper(*args, **kwargs):
            if level == "warn":
                print("%s is called ..." % func.__name__)
            return func(*args)
        return wrapper
    return decorator


@use_logging(level="warn")
def myfunc(name = 'myfunc'):
    print("i am %s" % name)

myfunc()

输出结果：

myfunc is called ...
i am myfunc

上面的 use_logging 是允许带参数的装饰器，它实际上是对原有装饰器的一个函数封装，并返回一个装饰器。我们可以将它理解为一个含有参数的闭包。当我们使用@use_logging(level="warn") 调用的时候，Python 能够发现这一层的封装，并把参数传递到装饰器的环境中。

3）类装饰器

相比函数装饰器，类装饰器具有灵活度大、高内聚、封装性等优点。使用类装饰器还可以依靠类内部的 __call__方法，当使用 @ 形式将装饰器附加到函数上时，就会调用此方法。

#!/usr/bin/env python
# -*- coding:UTF-8 -*-


class Logging(object):
    def __init__(self, func):
        self._func = func
        
    def __call__(self):
        print('class decorator running')
        self._func()
        print('class decorator ending')


@Logging
def myfunc():
    print('i am myfunc')

myfunc()

输出结果：

class decorator running
i am myfunc
class decorator ending

4）functools.wraps

使用装饰器极大地复用了代码，但是他有一个缺点就是原函数的元信息不见了，比如函数的 docstring、__name__、参数列表，先看例子：

#!/usr/bin/env python
# -*- coding:UTF-8 -*-


# 装饰器
def logged(func):
    def with_logging(*args, **kwargs):
        print(func.__name__ + " was called")
        return func(*args, **kwargs)
    return with_logging


# 函数
@logged
def f(x):
    """do some math"""
    return x + x * x


# # 上述函数完全等价于以下函数
# def f(x):
#     return x + x * x
# f = logged(f)

print(f.__name__)
print(f.__doc__)

输出结果：

with_logging
None

这个问题是就比较严重的，好在我们有functools.wraps，wraps本身也是一个装饰器，它能把原函数的元信息拷贝到装饰器函数中，这使得装饰器函数也有和原函数一样的元信息了。

#!/usr/bin/env python
# -*- coding:UTF-8 -*-


from functools import wraps
def logged(func):
    @wraps(func)
    def with_logging(*args, **kwargs):
        print(func.__name__ + " was called")
        return func(*args, **kwargs)
    return with_logging


@logged
def f(x):
    """do some math"""
    return x + x * x

print(f.__name__)
print(f.__doc__)

输出结果：

f
do some math

5）内置装饰器

@staticmathod、@classmethod、@property

装饰器的顺序

@a
@b
@c
def f ():

等效于

f = a(b(c(f)))

5. 软件目录构规范

1）为什么要设计好目录结构

"设计项目目录结构"，就和"代码编码风格"一样，属于个人风格问题。对于这种风格上的规范，一直都存在两种态度:

1. 一类同学认为，这种个人风格问题"无关紧要"。理由是能让程序 work 就好，风格问题根本不是问题。
2. 另一类同学认为，规范化能更好的控制程序结构，让程序具有更高的可读性。

　　软件开发比较偏向于后者，维护一个非常不好读的项目，虽然其实现的逻辑可能并不复杂，但是却会耗费非常长的时间去理解它想表达的意思。所以，对于提高项目可读性、可维护性的要求就很必要了。"项目目录结构"其实也是属于"可读性和可维护性"的范畴，我们设计一个层次清晰的目录结构，就是为了达到以下两点:

1. 可读性高: 不熟悉这个项目的代码的人，一眼就能看懂目录结构，知道程序启动脚本是哪个，测试目录在哪儿，配置文件在哪儿等等。从而非常快速的了解这个项目。
2. 可维护性高: 定义好组织规则后，维护者就能很明确地知道，新增的哪个文件和代码应该放在什么目录之下。这个好处是，随着时间的推移，代码/配置的规模增加，项目结构不会混乱，仍然能够组织良好。

所以，保持一个层次清晰的目录结构是有必要的。更何况组织一个良好的工程目录，其实是一件很简单的事儿。

2）目录组织方式

关于如何组织一个较好的Python工程目录结构，已经有一些得到了共识的目录结构。在Stackoverflow的这个问题上，能看到大家对Python目录结构的讨论。

假设你的项目名为foo, 建议最方便快捷目录结构这样就足够了:

Foo/
|-- bin/
|   |-- foo
|
|-- foo/
|   |-- tests/
|   |   |-- __init__.py
|   |   |-- test_main.py
|   |
|   |-- __init__.py
|   |-- main.py
|
|-- docs/
|   |-- conf.py
|   |-- abc.rst
|
|-- setup.py
|-- requirements.txt
|-- README

简要解释一下:

1. bin/: 存放项目的一些可执行文件，当然你可以起名script/之类的也可以。
2. foo/: 存放项目的所有源代码。(1) 源代码中的所有模块、包都应该放在此目录。不要置于顶层目录。(2) 其子目录tests/存放单元测试代码； (3) 程序的入口最好命名为main.py。
3. docs/: 存放一些文档。
4. setup.py: 安装、部署、打包的脚本。
5. requirements.txt: 存放软件依赖的外部Python包列表。
6. README: 项目说明文件。

除此之外，有一些方案给出了更加多的内容。比如 LICENSE.txt，ChangeLog.txt 文件等，这些东西主要是项目开源的时候需要用到。如果你想写一个开源软件，目录该如何组织，可以参考这篇文章。

3）关于README的内容

每个项目都应该有一个README文件，目的是能简要描述该项目的信息，让读者快速了解这个项目。

它需要说明以下几个事项:

1. 软件定位，软件的基本功能。
2. 运行代码的方法: 安装环境、启动命令等。
3. 简要的使用说明。
4. 代码目录结构说明，更详细点可以说明软件的基本原理。
5. 常见问题说明。

有以上几点是比较好的一个README。在软件开发初期，由于开发过程中以上内容可能不明确或者发生变化，并不是一定要在一开始就将所有信息都补全。但是在项目完结的时候，是需要撰写这样的一个文档的。

可以参考Redis源码中Readme的写法，这里面简洁但是清晰的描述了Redis功能和源码结构。

4）关于requirements.txt和setup.py

setup.py

一般来说，用setup.py来管理代码的打包、安装、部署问题。业界标准的写法是用Python流行的打包工具setuptools来管理这些事情。这种方式普遍应用于开源项目中。不过这里的核心思想不是用标准化的工具来解决这些问题，而是说，一个项目一定要有一个安装部署工具，能快速便捷的在一台新机器上将环境装好、代码部署好和将程序运行起来。

刚开始接触Python写项目的时候，安装环境、部署代码、运行程序这个过程全是手动完成，遇到过以下问题:

1. 安装环境时经常忘了最近又添加了一个新的Python包，结果一到线上运行，程序就出错了。
2. Python包的版本依赖问题，有时候我们程序中使用的是一个版本的Python包，但是官方的已经是最新的包了，通过手动安装就可能装错了。
3. 如果依赖的包很多的话，一个一个安装这些依赖是很费时的事情。
4. 新同学开始写项目的时候，将程序跑起来非常麻烦，因为可能经常忘了要怎么安装各种依赖。

setup.py可以将这些事情自动化起来，提高效率、减少出错的概率。"复杂的东西自动化，能自动化的东西一定要自动化。"是一个非常好的习惯。

setuptools的文档比较庞大，刚接触的话，可能不太好找到切入点。学习技术的方式就是看他人是怎么用的，可以参考一下Python的一个Web框架，flask是如何写的: setup.py

当然，简单点自己写个安装脚本（deploy.sh）替代setup.py也未尝不可。

requirements.txt

这个文件存在的目的是:

1. 方便开发者维护软件的包依赖。将开发过程中新增的包添加进这个列表中，避免在setup.py安装依赖时漏掉软件包。
2. 方便读者明确项目使用了哪些Python包。

这个文件的格式是每一行包含一个包依赖的说明，通常是flask>=0.10这种格式，要求是这个格式能被pip识别，这样就可以简单的通过 pip install -r requirements.txt来把所有Python包依赖都装好了。具体格式说明： 点这里。

 

5）关于配置文件的使用方法

注意，在上面的目录结构中，没有将conf.py放在源码目录下，而是放在docs/目录下。

很多项目对配置文件的使用做法是:

1. 配置文件写在一个或多个python文件中，比如此处的conf.py。
2. 项目中哪个模块用到这个配置文件就直接通过import conf这种形式来在代码中使用配置。

对这种做法不太赞同:

1. 这让单元测试变得困难（因为模块内部依赖了外部配置）
2. 另一方面配置文件作为用户控制程序的接口，应当可以由用户自由指定该文件的路径。
3. 程序组件可复用性太差，因为这种贯穿所有模块的代码硬编码方式，使得大部分模块都依赖conf.py这个文件。

所以，更好的配置的使用方式是，

1. 模块的配置都是可以灵活配置的，不受外部配置文件的影响。
2. 程序的配置也是可以灵活控制的。

能够佐证这个思想的是，用过nginx和mysql的同学都知道，nginx、mysql这些程序都可以自由的指定用户配置。

所以，不应当在代码中直接import conf来使用配置文件。上面目录结构中的conf.py，是给出的一个配置样例，不是在写死在程序中直接引用的配置文件。可以通过给main.py启动参数指定配置路径的方式来让程序读取配置内容。当然，这里的conf.py你可以换个类似的名字，比如settings.py。或者你也可以使用其他格式的内容来编写配置文件，比如settings.yaml之类的。

 

5.本节作业

作业需求：

模拟实现一个ATM + 购物商城程序

1. 额度 15000或自定义
2. 实现购物商城，买东西加入 购物车，调用信用卡接口结账
3. 可以提现，手续费5%
4. 每月22号出账单，每月10号为还款日，过期未还，按欠款总额 万分之5 每日计息
5. 支持多账户登录
6. 支持账户间转账
7. 记录每月日常消费流水
8. 提供还款接口
9. ATM记录操作日志 
10. 提供管理接口，包括添加账户、用户额度，冻结账户等。。。
11. 用户认证用装饰器

示例代码 https://github.com/triaquae/py_training/tree/master/sample_code/day5-atm