首页 > 代码库 > Python_Day5_迭代器、装饰器、软件开发规范

Python_Day5_迭代器、装饰器、软件开发规范

2024-08-20 08:53:49   218人阅读

本节内容

  1. 迭代器&生成器
  2. 装饰器
  3. Json & pickle 数据序列化
  4. 软件目录结构规范

1.列表生成式，迭代器&生成器

列表生成

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

生成器



通过列表生成式，我们可以直接创建一个列表。但是，受到内存限制，列表容量肯定是有限的。而且，创建一个包含100万个元素的列表，不仅占用很大的存储空间，如果我们仅仅需要访问前面几个元素，那后面绝大多数元素占用的空间都白白浪费了。




所以，如果列表元素可以按照某种算法推算出来，那我们是否可以在循环的过程中不断推算出后续的元素呢？这样就不必创建完整的list，从而节省大量的空间。在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 0x1022ef630>




创建L和g的区别仅在于最外层的[]和()，L是一个list，而g是一个generator。


我们可以直接打印出list的每一个元素，但我们怎么打印出generator的每一个元素呢？


如果要一个一个打印出来，可以通过next()函数获得generator的下一个返回值：


>>> next(g)


0


>>> next(g)


1


>>> next(g)


4


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


我们创建了一个generator后，基本上永远不会调用next()，而是通过for循环来迭代它，并且不需要关心StopIteration的错误。

generator非常强大。如果推算的算法比较复杂，用类似列表生成式的for循环无法实现的时候，还可以用函数来实现。


比如，著名的斐波拉契数列（Fibonacci），除第一个和第二个数外，任意一个数都可由前两个数相加得到：


1, 1, 2, 3, 5, 8, 13, 21, 34, ...


斐波拉契数列用列表生成式写不出来，但是，用函数把它打印出来却很容易：


斐波拉契数列函数：




def fib(max):


    n, a, b = 0, 0, 1


    while n < max:


        print(b)


        a, b = b, a + b


        n = n + 1


    return ‘done‘




 


上面的函数和generator仅一步之遥。要把fib函数变成generator，只需要把print(b)改为yield b就可以了：


def fib(max): 



    n,a,b = 0,0,1

    while n < max:
        #print(b)
        yield  b
        a,b = b,a+b

        n += 1

    return ‘done‘ 






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


data = http://www.mamicode.com/fib(10)
print(data)

print(data.__next__())
print(data.__next__())
print("干点别的事")
print(data.__next__())
print(data.__next__())
print(data.__next__())
print(data.__next__())
print(data.__next__())

#输出
<generator object fib at 0x101be02b0>
1
1
干点别的事
2
3
5


 


在上面fib的例子，我们在循环过程中不断调用yield，就会不断中断。当然要给循环设置一个条件来退出循环，不然就会产生一个无限数列出来。


同样的，把函数改成generator后，我们基本上从来不会用next()来获取下一个返回值，而是直接使用for循环来迭代：


>>> g = fib(6)


>>> while True:


...     try:


...         x = next(g)


...         print(‘g:‘, x)


...     except StopIteration as e:


...         print(‘Generator return value:‘, e.value)


...         break


 


还可通过yield实现在单线程的情况下实现并发运算的效果（生产者&消费者）：


 


import time


def consumer(name):
    print(‘%s准备开始消费产品‘%name)
    while True:
        pici = yield
        print(‘第%s批产品被%s消费了‘%(pici,name))


def producer():
    c1 = consumer(‘A‘)
    c2 = consumer(‘B‘)
    print(‘生产者开始准备产品‘)
    c1.__next__()
    c2.__next__()
    for i in range(1,100):
        time.sleep(2)
        print(‘START%s‘.center(30,‘*‘)%i)
        print(‘第%s批产品生产完毕！‘%i)
        time.sleep(3)
        c1.send(i)
        c2.send(i)
        print(‘END%s‘.center(30, ‘*‘)%i)

producer()




迭代器


我们已经知道，可以直接作用于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)




而生成器不但可以作用于for循环，还可以被next()函数不断调用并返回下一个值，直到最后抛出StopIteration错误表示无法继续返回下一个值了。


*可以被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




你可能会问，为什么list、dict、str等数据类型不是Iterator？


这是因为Python的Iterator对象表示的是一个数据流，Iterator对象可以被next()函数调用并不断返回下一个数据，直到没有数据时抛出StopIteration错误。可以把这个数据流看做是一个有序序列，但我们却不能提前知道序列的长度，只能不断通过next()函数实现按需计算下一个数据，所以Iterator的计算是惰性的，只有在需要返回下一个数据时它才会计算。


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


 


小结


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


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


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


2.装饰器


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


    

  • 封闭：已实现的功能代码块
    • 

  • 开放：对扩展开发
    • 





代码示例：




user_status = False

def login(auth_type):
    _username = ‘alex‘
    _password = ‘abc123‘
    def outer(func):
        def inner(*args,**kwargs):
            print(‘----->‘,auth_type,func,args,kwargs)
            if auth_type == ‘qq‘:
                global user_status

                if user_status == False:
                    username = input(‘user:‘)
                    password = input(‘password:‘)

                    if username == _username and password == _password:
                        print(‘welcome login!‘)
                        user_status = True
                    else:
                        print(‘Wrong username or password!‘)

                if user_status == True:
                    func(*args,**kwargs)
            else:
                print(‘Sorry Not Suport for Webchat‘)
        return inner
    return outer
def home():
    print(‘首页‘.center(30,‘-‘))

@login(‘qq‘)
def america():
    print(‘欧美专区‘.center(30, ‘-‘))

@login(‘Webchat‘)
def janpan():
    print(‘日韩专区‘.center(30, ‘-‘))
def henan():
    print(‘河南专区‘.center(30, ‘-‘))

home()

# america = login(america)
# henan = login(henan)
# #login(henan)
# print(‘America user login:‘)
america()
janpan()
#
# print(‘Henan user login:‘)
# henan()




3.Json & pickle 数据序列化




import json
data =http://www.mamicode.com/{
    ‘name‘:‘alex‘,
    ‘age‘:25,
    ‘sex‘:‘M‘
}
#
# f =open(‘data.txt‘,‘w‘,encoding=‘utf-8‘)
#
# json.dump(data,f)
# f.close()

f_r =open(‘data.txt‘,‘r‘,encoding=‘utf-8‘)
data = http://www.mamicode.com/json.load(f_r)
f_r.close()
print(data[‘age‘])




4.软件目录结构规范




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




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




    

  1. 一类同学认为，这种个人风格问题"无关紧要"。理由是能让程序work就好，风格问题根本不是问题。
    2. 

  2. 另一类同学认为，规范化能更好的控制程序结构，让程序具有更高的可读性。
    3. 





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




    

  1. 可读性高: 不熟悉这个项目的代码的人，一眼就能看懂目录结构，知道程序启动脚本是哪个，测试目录在哪儿，配置文件在哪儿等等。从而非常快速的了解这个项目。
    2. 

  2. 可维护性高: 定义好组织规则后，维护者就能很明确地知道，新增的哪个文件和代码应该放在什么目录之下。这个好处是，随着时间的推移，代码/配置的规模增加，项目结构不会混乱，仍然能够组织良好。
    3. 





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




目录组织方式




关于如何组织一个较好的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. 

  2. foo/: 存放项目的所有源代码。(1) 源代码中的所有模块、包都应该放在此目录。不要置于顶层目录。(2) 其子目录tests/存放单元测试代码； (3) 程序的入口最好命名为main.py。
    3. 

  3. docs/: 存放一些文档。
    4. 

  4. setup.py: 安装、部署、打包的脚本。
    5. 

  5. requirements.txt: 存放软件依赖的外部Python包列表。
    6. 

  6. README: 项目说明文件。
    7. 



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


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


关于README的内容


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


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


    

  1. 软件定位，软件的基本功能。
    2. 

  2. 运行代码的方法: 安装环境、启动命令等。
    3. 

  3. 简要的使用说明。
    4. 

  4. 代码目录结构说明，更详细点可以说明软件的基本原理。
    5. 

  5. 常见问题说明。
    6. 



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


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


关于requirements.txt和setup.py


setup.py


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


这个我是踩过坑的。


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


    

  1. 安装环境时经常忘了最近又添加了一个新的Python包，结果一到线上运行，程序就出错了。
    2. 

  2. Python包的版本依赖问题，有时候我们程序中使用的是一个版本的Python包，但是官方的已经是最新的包了，通过手动安装就可能装错了。
    3. 

  3. 如果依赖的包很多的话，一个一个安装这些依赖是很费时的事情。
    4. 

  4. 新同学开始写项目的时候，将程序跑起来非常麻烦，因为可能经常忘了要怎么安装各种依赖。
    5. 



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


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


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


requirements.txt


这个文件存在的目的是:


    

  1. 方便开发者维护软件的包依赖。将开发过程中新增的包添加进这个列表中，避免在setup.py安装依赖时漏掉软件包。
    2. 

  2. 方便读者明确项目使用了哪些Python包。
    3. 



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


 


关于配置文件的使用方法


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


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


    

  1. 配置文件写在一个或多个python文件中，比如此处的conf.py。
    2. 

  2. 项目中哪个模块用到这个配置文件就直接通过import conf这种形式来在代码中使用配置。
    3. 



这种做法我不太赞同:


    

  1. 这让单元测试变得困难（因为模块内部依赖了外部配置）
    2. 

  2. 另一方面配置文件作为用户控制程序的接口，应当可以由用户自由指定该文件的路径。
    3. 

  3. 程序组件可复用性太差，因为这种贯穿所有模块的代码硬编码方式，使得大部分模块都依赖conf.py这个文件。
    4. 



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


    

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

  2. 程序的配置也是可以灵活控制的。
    3. 



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


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












Python_Day5_迭代器、装饰器、软件开发规范






























        

            
                
                  
                
                

                    联系

                    我们