python学习笔记（装饰器、迭代器&生成器、内置函数、软件目录开发规范）

装饰器

定义：本质是函数，（功能：装饰其他函数）；就是为其他函数添加附加功能

模拟场景一，在现有的函数中增加某个功能。现有的做法是定义新函数，并且加入函数中。需要修改源代码。

def logger():
    print("logging")

def test1():
    logger()

def test2():
    logger()

场景二，如果是在生产环境中，需要增加功能。不能直接修改源代码。该怎么实现。

原则：1. 不能修改被装饰的函数的源代码

　　   2. 不能修改被装饰的函数的调用方式

装饰器实例：直观感受一下装饰器的作用。

import time

def timmer(func):
    def warpper(*args,**kwargs):
        start_time = time.time()
        func()
        stop_time = time.time()
        print("the func run time is %s" %(stop_time-start_time))
    return warpper
@timmer
def test1():
    time.sleep(3)
    print("in the test1")

test1()

实现装饰器知识储备：

1. 函数即“变量”

　　通过例子来阐述函数即“变量”：

#例一：因为没有定义bar函数，程序报错
def foo():
    print("in the foo")
    bar()
foo()

#例二：程序正常运行，相当于先定义变量x和y，再进行输出。
def bar():
    print("in the bar")
def foo():
    print("in the foo")
    bar()
foo()

#例三：程序正常运行，相当于例二定义变量的顺序相反，但结果不变。
def foo():
    print("in the foo")
    bar()
def bar():
    print("in the bar")
foo()

#例四：程序报错。因为执行foo函数的时候，当顺序执行到bar()语句的时候，这时候bar还没有被定义。
def foo():
    print("in the foo")
    bar()
foo()
def bar():
    print("in the bar")

2. 高阶函数

　　a: 把一个函数名当做实参传给另外一个函数（在不修改被装饰函数源代码的情况下为其添加功能）

　　举例：

import time
def bar():
    time.sleep(1)
    print("in the bar")
def test1(func):
    start_time =time.time()
    func()
    stop_time =time.time()
    print("the func run time is %s" %(stop_time-start_time))
test1(bar)

　　b: 返回值中包含函数名（不修改函数的调用方式）

　　实例：

import time
def bar():
    time.sleep(2)
    print("in the bar")
def test2(func):
    print(func)
    return func

bar =test2(bar)
bar()

3. 嵌套函数：在def定义的函数中用def再定义函数。里层的函数有局部变量的特性。

def foo():
    print("in the foo")
    def bar():
        print("in the bar")
    bar()
foo()

总结：高阶函数+嵌套函数 => 装饰器

 复习作用域内容，以供下面内容所需：局部作用域和全局作用域的访问顺序：由内而外。

#局部作用域和全局作用域的访问顺序
x = 0
def grandpa():
    # x = 1
    def dad():
        x = 2
        def son():
            x = 3
            print(x)
        son()
    dad()
grandpa()

 装饰器实例一：

import time
def timer(func): #timer(test1)  func=test1
    def deco():
        start_time = time.time()
        func() #运行被装饰的函数
        stop_time=time.time()
        print("the func run time is %s" %(stop_time-start_time))
    return deco #返回函数的内存地址

@timer #相当于test1 = timer(test1)
def test1():
    time.sleep(1) #等待1秒
    print("in the test1")
def test2():
    time.sleep(1)
    print("in the test2")

test1()
test2 = timer(test2) #python提供了语法糖@，用法看test1
test2()

由实例一引出的问题：如果test2是有参数需要传递的，那么以上代码在运行到test2()的时候就会报错。

需要把代码改成通用型。

实例二：通用型装饰器代码。

import time
def timer(func): #timer(test1)  func=test1
    def deco(*args,**kwargs): #以实现任意参数的传递
        start_time = time.time()
        func(*args,**kwargs) #运行被装饰的函数，不带参数或带参数都可以运行
        stop_time=time.time()
        print("the func run time is %s" %(stop_time-start_time))
    return deco

@timer
def test1():
    time.sleep(1) #等待1秒
    print("in the test1")

@timer
def test2(name,age,job):
    time.sleep(1)
    print("test2:",name, age, job)

test1()
test2("abc",23,"IT")

实例一没有解决函数有返回值的问题。导致虽然没有改变源代码和调用方式，但是运行的结果变了。需要修改代码如下：

import time
user,passwd = "alex","abc123"
def auth(func):
    def wrapper(*args,**kwargs):
        username = input("username:").strip()
        password = input("password:").strip()
        if user == username and passwd == password:
            print("33[32;1mUser has passed authentication33[0m")
            res = func(*args,**kwargs) #运行index后的返回值传递给参数res #这一步也可以直接return
            print("----after authentication----") # 可加入其他装饰功能
            return res #返回index函数的返回值
        else:
            exit("33[32;1mInvalid username or password33[0m")
    return wrapper

@auth
def index():
    print("welcome to index page")
    return "from index"

print(index()) #只是index()运行函数结果看不出区别。但是如果要输出函数返回值，会发现实例一中的代码会返回None，因为在装饰器中，实际运行原index函数的是func，但是没有返回值。
　　　　　　　　　需要定义参数或者return。

生成器

列表生成式：

a = [i*2 for i in range(10)]
print(a)
#输出结果：[0, 2, 4, 6, 8, 10, 12, 14, 16, 18]

列表生成式的作用：简化代码。

生成器：通过列表生成式，我们可以直接创建一个列表。但是，受到内存限制，列表容量肯定是有限的。而且，创建一个包含100万个元素的列表，

           不仅占用很大的存储空间，如果我们仅仅需要访问前面几个元素，那后面绝大多数元素占用的空间都白白浪费了。

           所以，如果列表元素可以按照某种算法推算出来，那我们是否可以在循环的过程中不断推算出后续的元素呢？这样就不必创建完整的list，

           从而节省大量的空间。在python中，这种一边循环一边计算的机制，成为生成器：generator。

生成器特性：

1. 只有在调用时才会生成相应的数据

2. 只记录当前位置

3. 只有一个__next__()方法

 斐波那契数列，可以用函数创建生成器：

def fib(max):
    n, a, b = 0, 0, 1
    while n < max:
        # print(b)
        yield b #只要函数中出现yield，那么函数已经变成生成器
        a, b = b, a + b
        n = n+1
    return "done"
f =fib(20) #生成10个斐波那契数列，从1开始
print(f.__next__())
print("----- loop 1 -----")
print(f.__next__())
print(f.__next__())
print("==== start loop ====")
for i in f:
    print(i)

解析：

1. 以上例子中，a, b = b, a + b

    相当于：t = (b, a + b) #t是一个tuple

               a = t[0]

               b = t[1]

2. 由于上面有几条__next__语句，所以for开始的循环不是从1开始，而是从当前位置开始循环。

3. 函数中出现yield语句，函数已变成生成器，没有返回值。

另一种情况，如果__next__超过生成器范围，那么程序会报错。例如生成10个斐波那契数列，有11个__next__语句，将出现“StopIteration”错误。

可以用try语句来抓取。代码如下：

def fib(max):
    n, a, b = 0, 0, 1
    while n < max:
        # print(b)
        yield b #只要函数中出现yield，那么函数已经变成生成器
        a, b = b, a + b
        n = n+1
    return "done"
f =fib(10) 
g =fib(6)
while True:
    try:
        x = next(g)
        print("g",x)
    except StopIteration as e: 
        print("Generator return value:",e.value)
        break

生成器并行运算：

吃包子例子：

import time
def consumer(name): #消费者
    print("%s 准备吃包子啦！" %name)
    while True:
        baozi = yield
        print("包子[%s]来了，被[%s]吃了！" %(baozi,name))
c = consumer("姚明")
c.__next__()

def producer(name): #生产者
    c = consumer("A")
    c2 = consumer("B")
    c.__next__()
    c2.__next__()
    print("%s开始准备做包子啦！" %name)
    for i in range(10):
        time.sleep(1)
        print("%s做了一个包子，分两半！"%name)
        c.send(i)
        c2.send(i)

producer("科比")

迭代器

我们已经知道，可以直接作用于for循环的数据类型有以下几种：

一类是集合数据类型，如list、tuple、dict、set、str等；

一类是generator，包括生成器和带yield的generator function。

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

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

from collections import Iterable #返回值：True
print(isinstance([],Iterable)) #返回值：True
print(isinstance({},Iterable)) #返回值：True
print(isinstance("abc",Iterable)) #返回值：True
print(isinstance((x for x in range(10)),Iterable)) #返回值：True
print(isinstance(100,Iterable)) #返回值：False

而生成器不但可以作用于for循环，还可以被next()函数不断调用并返回下一个值，

直到最后跑出StopIteration错误表示无法继续返回下一个值了。

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

from collections import Iterator
print(isinstance([],Iterator)) #返回值：False
print(isinstance({},Iterator)) #返回值：False
print(isinstance("abc",Iterator)) #返回值：False
print(isinstance((x for x in range(10)),Iterator)) #返回值：True
print(isinstance(100,Iterator)) #返回值：False

也可以用dir()函数来查看参数的可调用方法：

a = [1,2,3]
print(dir(a))

以上代码中，list a通过dir(a)函数，输出的内容没有next()方法。

为什么list、dict、str等数据类不是Iteraotr？

这是因为python的Iterator对象表示的是一个数据流，Iterator对象可以被next()函数调用并不断返回下一个数据，直到没有数据时抛出StopIteration错误。

可以把这个数据流看作是一个有序序列，但我们却不能提前知道序列的长度，只能不断通过next()函数实现按需计算下一个数据，所以Iterator的计算是惰性的，

只有在需要返回下一个数据时它才会计算。

Iterator甚至可以表示一个无限大的数据流，例如全体自然数。而使用list时永远不可能存储全体自然数的。

小结

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

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

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

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

for x in [1,2,3,4,5]:
    print(x)

以上for循环语句实际上完全等价于：

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

内置函数

print(all([0])) #全部为非0，返回True
print(any([])) #只要有一个非0，返回True
a = ascii([1,2,"外挂"])
print(type(a),[a])
print(bin(255)) #十进制转二进制
print(bool([])) #判断是否为空
a = bytes("abcde",encoding="utf-8")
print(type(a),[a])
b = bytearray("abcde",encoding="utf-8")
print(b.capitalize(),b) #返回：bytearray(b'Abcde') bytearray(b'abcde')，返回值是新的字节数组
print( b[0] ) #打印出a的ascii码
b[1]= 100 #用ascii编码进行赋值
print(b) #输出：bytearray(b'adcde')
print(callable([])) #是否可调用：指可不可以加括号，此处返回False
def sayhi():pass
print(callable(sayhi)) #函数为可调用，返回True
print(chr(98)) #输出ascii编码表中编号对应的字符
print(ord("b")) #和chr功能相反

code = "for i in range(10):print(i)"
c = compile(code,"","exec") #compile()函数，编译字符串为代码
exec(c)
exec(code) #其实直接用exec也能直接执行代码。请忘记compile .......
code1 = "1+1+1+1"
print(eval(code1))
complex() #复数，略过...
delattr() #后面会讲到
dict() #不加参数生成一个默认字典
divmod(5,3) #返回：(1,2)，即商和余数
enumerate()
eval() #简单运算,字符串转字典
exec()
(lambda n:print(n))(5) #匿名函数lambda，需要结合其他函数来用
calc = lambda n:print(n)
calc(5)
res = filter(lambda n:n>5,range(10)) #filter结合lambda使用
for i in res:
    print(i)

res = map(lambda n:n*n,range(10))  # 相当于[ i*2 for i in range(10) ]
res = [ lambda i:i*2 for i in range(10) ]
print(res)
for i in res:
    print(i)
import functools
res = functools.reduce( lambda x,y:x+y,range(10)) #0加到9
res = functools.reduce( lambda x,y:x*y,range(1,10)) #9的阶乘
a = frozenset([1,4,33,212,33,33,12,4]) #不可修改集合
print(globals()) #返回当前程序中所有的全局变量
hash() #哈希算法，每次python会把变量（中文、英文、其他字符等）进行索引编号，以便在以后调用的时候能快速找到
def test():
    local_var = 333
    print(locals()) #返回当前函数中的局部变量
test()
print(globals())
print(globals().get('local_var'))
print(max([1,3,9,3,4])) #打印列表中的最大值
print(min([1,3,9,3,4])) #打印列表中的最小值
memoryview()
next()
object() #对象，python中一切皆对象。
print(oct(9)) #十进制转为八进制
ord()
print(pow(2,3)) #次方，2的3次方
repr()
reversed()
print(round(1.3352,2)) #小数保留2位，四舍五入
slice() #切片，忘了吧...
a = {6:2,8:0,1:4,-5:6,99:11,4:22}
print(a)
print(sorted(a)) #只输出key，并排序
print(sorted(a.items())) #字典按照key排序
print(sorted(a.items(), key=lambda x:x[1])) #字典按照value排序
type()
vars(object)
a = [1,2,3,4,5,6]
b = ["a","b","c","d"]
for i in zip(a,b):
    print(i)


__import__ ('decorator')

软件目录开发规范（完全引用alex博客，此部分内容多阅读几遍和以后通过实际写代码去体会即可）

为什么要设计好目录结构?

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

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

我是比较偏向于后者的，因为我是前一类同学思想行为下的直接受害者。我曾经维护过一个非常不好读的项目，其实现的逻辑并不复杂，但是却耗费了我非常长的时间去理解它想表达的意思。从此我个人对于提高项目可读性、可维护性的要求就很高了。"项目目录结构"其实也是属于"可读性和可维护性"的范畴，我们设计一个层次清晰的目录结构，就是为了达到以下两点:

1. 可读性高: 不熟悉这个项目的代码的人，一眼就能看懂目录结构，知道程序启动脚本是哪个，测试目录在哪儿，配置文件在哪儿等等。从而非常快速的了解这个项目。
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文件等，我没有列在这里，因为这些东西主要是项目开源的时候需要用到。如果你想写一个开源软件，目录该如何组织，可以参考这篇文章。

下面，再简单讲一下我对这些目录的理解和个人要求吧。

关于README的内容

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

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

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

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

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

关于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包依赖都装好了。具体格式说明： 点这里。

关于配置文件的使用方法

注意，在上面的目录结构中，没有将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之类的。