python 自动化之路 day 05
2016-11-06 14:27
260 查看
内容目录:
列表生成式、迭代器&生成器
装饰器
软件目录结构规范
模块初始
常用模块
你可能会想到2种方式 :
View Code
一类同学认为,这种个人风格问题"无关紧要"。理由是能让程序work就好,风格问题根本不是问题。
另一类同学认为,规范化能更好的控制程序结构,让程序具有更高的可读性。
我是比较偏向于后者的,因为我是前一类同学思想行为下的直接受害者。我曾经维护过一个非常不好读的项目,其实现的逻辑并不复杂,但是却耗费了我非常长的时间去理解它想表达的意思。从此我个人对于提高项目可读性、可维护性的要求就很高了。"项目目录结构"其实也是属于"可读性和可维护性"的范畴,我们设计一个层次清晰的目录结构,就是为了达到以下两点:
可读性高: 不熟悉这个项目的代码的人,一眼就能看懂目录结构,知道程序启动脚本是哪个,测试目录在哪儿,配置文件在哪儿等等。从而非常快速的了解这个项目。
可维护性高: 定义好组织规则后,维护者就能很明确地知道,新增的哪个文件和代码应该放在什么目录之下。这个好处是,随着时间的推移,代码/配置的规模增加,项目结构不会混乱,仍然能够组织良好。
所以,我认为,保持一个层次清晰的目录结构是有必要的。更何况组织一个良好的工程目录,其实是一件很简单的事儿。
这里面说的已经很好了,我也不打算重新造轮子列举各种不同的方式,这里面我说一下我的理解和体会。
假设你的项目名为foo, 我比较建议的最方便快捷目录结构这样就足够了:
简要解释一下:
除此之外,有一些方案给出了更加多的内容。比如
下面,再简单讲一下我对这些目录的理解和个人要求吧。
它需要说明以下几个事项:
软件定位,软件的基本功能。
运行代码的方法: 安装环境、启动命令等。
简要的使用说明。
代码目录结构说明,更详细点可以说明软件的基本原理。
常见问题说明。
我觉得有以上几点是比较好的一个
可以参考Redis源码中Readme的写法,这里面简洁但是清晰的描述了Redis功能和源码结构。
这个我是踩过坑的。
我刚开始接触Python写项目的时候,安装环境、部署代码、运行程序这个过程全是手动完成,遇到过以下问题:
安装环境时经常忘了最近又添加了一个新的Python包,结果一到线上运行,程序就出错了。
Python包的版本依赖问题,有时候我们程序中使用的是一个版本的Python包,但是官方的已经是最新的包了,通过手动安装就可能装错了。
如果依赖的包很多的话,一个一个安装这些依赖是很费时的事情。
新同学开始写项目的时候,将程序跑起来非常麻烦,因为可能经常忘了要怎么安装各种依赖。
setuptools的文档比较庞大,刚接触的话,可能不太好找到切入点。学习技术的方式就是看他人是怎么用的,可以参考一下Python的一个Web框架,flask是如何写的: setup.py
当然,简单点自己写个安装脚本(
方便开发者维护软件的包依赖。将开发过程中新增的包添加进这个列表中,避免在
方便读者明确项目使用了哪些Python包。
这个文件的格式是每一行包含一个包依赖的说明,通常是
注意,在上面的目录结构中,没有将
很多项目对配置文件的使用做法是:
配置文件写在一个或多个python文件中,比如此处的conf.py。
项目中哪个模块用到这个配置文件就直接通过
这种做法我不太赞同:
这让单元测试变得困难(因为模块内部依赖了外部配置)
另一方面配置文件作为用户控制程序的接口,应当可以由用户自由指定该文件的路径。
程序组件可复用性太差,因为这种贯穿所有模块的代码硬编码方式,使得大部分模块都依赖
所以,我认为配置的使用,更好的方式是,
模块的配置都是可以灵活配置的,不受外部配置文件的影响。
程序的配置也是可以灵活控制的。
能够佐证这个思想的是,用过nginx和mysql的同学都知道,nginx、mysql这些程序都可以自由的指定用户配置。
所以,不应当在代码中直接
类似于函数式编程和面向过程编程,函数式编程则完成一个功能,其他代码用来调用即可,提供了代码的重用性和代码间的耦合。而对于一个复杂的功能来,可能需要多个函数才能完成(函数又可以在不同的.py文件中),n个 .py 文件组成的代码集合就称为模块。
如:os 是系统相关的模块;file是文件操作相关的模块
模块分为三种:
自定义模块
内置标准模块(又称标准库)
开源模块 (https://pypi.python.org/pypi)
如何在py文件中引入自定义模块?
import os
from os import time
通过:
我们可以得到模块路径。
在pycharm中自动帮我们把pychram的路径加进去了。
但是在windows 系统执行的时候是不会把pychram的路径加进去的。
这时候我们需要手工添加进去:
python2中
目录里没有__init__,那就只是一个目录,目录是不可以被导入的。
有__init__,那这个目录就变成了包 = "package"
no matter py2 or py3 , only the package can be imported
howere, in py 3 ,the directory will also be treated as package,
__init__.pi in py3 is not mandatory.
Python进度条实现:
把字符串转化成对应的内存对象 就叫反序列化。
序列化的作用就是持久化内存数据对象。
Python中用于序列化的两个模块:
json 跨平台跨语言的数据传输格式,用于【字符串】和 【python基本数据类型】 间进行转换
pickle python内置的数据传输格式,多用于二进制形式,用于【python特有的类型】 和 【python基本数据类型】间进行转换
所有的语言都支持 json 。
Json模块提供了四个功能:dumps、dump、loads、load
pickle模块提供了四个功能:dumps、dump、loads、load
模拟实现一个ATM + 购物商城程序
额度 15000或自定义
实现购物商城,买东西加入购物车,最后结账的时候调用信用卡接口结账
可以提现,手续费5%,最多只能取信用额度的一半
支持多账户登录,每个用户信息独立
支持账户间转账
记录每月日常消费流水,记录 date shop_name transaction_type intrest(手续费)
提供还款接口
ATM记录操作日志
提供管理接口,包括添加账户、用户额度,冻结账户等。。。
用户认证用装饰器
列表生成式、迭代器&生成器
装饰器
软件目录结构规范
模块初始
常用模块
1.列表生成式,迭代器&生成器
列表生成式
需求:列表[0, 1, 2, 3, 4, 5, 6, 7, 8, 9],要求把列表里的每个值加1你可能会想到2种方式 :
1 user_status = False 2 def login(authtype): 3 def outer(func): 4 def inter(): 5 if authtype == 'qq': 6 _username = 'yang' 7 _password = 'abc123' 8 global user_status 9 10 if user_status == False: 11 username = input("username: ") 12 password = input("password: ") 13 14 if username == _username and password == _password: 15 print("欢迎你,尊敬的VIP 。 ") 16 user_status = True 17 else: 18 print("用户名或密码错误。 ") 19 if user_status == True: 20 func() 21 else: 22 print("仅支持QQ。 ") 23 return inter 24 return outer 25 def home(): 26 print("---首页---") 27 @login('qq') 28 def amercia(): 29 print("---欧美专区---") 30 31 def japan(): 32 print("---日韩专区---") 33 @login('weixin') 34 def henan(): 35 print("---河南专区---") 36 37 38 home() 39 amercia() 40 japan() 41 henan()
View Code
3. 软件目录结构规范
为什么要设计好目录结构?
"设计项目目录结构",就和"代码编码风格"一样,属于个人风格问题。对于这种风格上的规范,一直都存在两种态度:一类同学认为,这种个人风格问题"无关紧要"。理由是能让程序work就好,风格问题根本不是问题。
另一类同学认为,规范化能更好的控制程序结构,让程序具有更高的可读性。
我是比较偏向于后者的,因为我是前一类同学思想行为下的直接受害者。我曾经维护过一个非常不好读的项目,其实现的逻辑并不复杂,但是却耗费了我非常长的时间去理解它想表达的意思。从此我个人对于提高项目可读性、可维护性的要求就很高了。"项目目录结构"其实也是属于"可读性和可维护性"的范畴,我们设计一个层次清晰的目录结构,就是为了达到以下两点:
可读性高: 不熟悉这个项目的代码的人,一眼就能看懂目录结构,知道程序启动脚本是哪个,测试目录在哪儿,配置文件在哪儿等等。从而非常快速的了解这个项目。
可维护性高: 定义好组织规则后,维护者就能很明确地知道,新增的哪个文件和代码应该放在什么目录之下。这个好处是,随着时间的推移,代码/配置的规模增加,项目结构不会混乱,仍然能够组织良好。
所以,我认为,保持一个层次清晰的目录结构是有必要的。更何况组织一个良好的工程目录,其实是一件很简单的事儿。
目录组织方式
关于如何组织一个较好的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
简要解释一下:
bin/: 存放项目的一些可执行文件,当然你可以起名
script/之类的也行。
foo/: 存放项目的所有源代码。(1) 源代码中的所有模块、包都应该放在此目录。不要置于顶层目录。(2) 其子目录
tests/存放单元测试代码; (3) 程序的入口最好命名为
main.py。
docs/: 存放一些文档。
setup.py: 安装、部署、打包的脚本。
requirements.txt: 存放软件依赖的外部Python包列表。
README: 项目说明文件。
除此之外,有一些方案给出了更加多的内容。比如
LICENSE.txt,
ChangeLog.txt文件等,我没有列在这里,因为这些东西主要是项目开源的时候需要用到。如果你想写一个开源软件,目录该如何组织,可以参考这篇文章。
下面,再简单讲一下我对这些目录的理解和个人要求吧。
关于README的内容
这个我觉得是每个项目都应该有的一个文件,目的是能简要描述该项目的信息,让读者快速了解这个项目。它需要说明以下几个事项:
软件定位,软件的基本功能。
运行代码的方法: 安装环境、启动命令等。
简要的使用说明。
代码目录结构说明,更详细点可以说明软件的基本原理。
常见问题说明。
我觉得有以上几点是比较好的一个
README。在软件开发初期,由于开发过程中以上内容可能不明确或者发生变化,并不是一定要在一开始就将所有信息都补全。但是在项目完结的时候,是需要撰写这样的一个文档的。
可以参考Redis源码中Readme的写法,这里面简洁但是清晰的描述了Redis功能和源码结构。
关于requirements.txt和setup.py
setup.py
一般来说,用setup.py来管理代码的打包、安装、部署问题。业界标准的写法是用Python流行的打包工具setuptools来管理这些事情。这种方式普遍应用于开源项目中。不过这里的核心思想不是用标准化的工具来解决这些问题,而是说,一个项目一定要有一个安装部署工具,能快速便捷的在一台新机器上将环境装好、代码部署好和将程序运行起来。
这个我是踩过坑的。
我刚开始接触Python写项目的时候,安装环境、部署代码、运行程序这个过程全是手动完成,遇到过以下问题:
安装环境时经常忘了最近又添加了一个新的Python包,结果一到线上运行,程序就出错了。
Python包的版本依赖问题,有时候我们程序中使用的是一个版本的Python包,但是官方的已经是最新的包了,通过手动安装就可能装错了。
如果依赖的包很多的话,一个一个安装这些依赖是很费时的事情。
新同学开始写项目的时候,将程序跑起来非常麻烦,因为可能经常忘了要怎么安装各种依赖。
setup.py可以将这些事情自动化起来,提高效率、减少出错的概率。"复杂的东西自动化,能自动化的东西一定要自动化。"是一个非常好的习惯。
setuptools的文档比较庞大,刚接触的话,可能不太好找到切入点。学习技术的方式就是看他人是怎么用的,可以参考一下Python的一个Web框架,flask是如何写的: setup.py
当然,简单点自己写个安装脚本(
deploy.sh)替代
setup.py也未尝不可。
requirements.txt
这个文件存在的目的是:方便开发者维护软件的包依赖。将开发过程中新增的包添加进这个列表中,避免在
setup.py安装依赖时漏掉软件包。
方便读者明确项目使用了哪些Python包。
这个文件的格式是每一行包含一个包依赖的说明,通常是
flask>=0.10这种格式,要求是这个格式能被
pip识别,这样就可以简单的通过
pip install -r requirements.txt来把所有Python包依赖都装好了。具体格式说明: 点这里。
关于配置文件的使用方法
注意,在上面的目录结构中,没有将conf.py
放在源码目录下,而是放在docs/
目录下。
很多项目对配置文件的使用做法是:配置文件写在一个或多个python文件中,比如此处的conf.py。
项目中哪个模块用到这个配置文件就直接通过
import conf这种形式来在代码中使用配置。
这种做法我不太赞同:
这让单元测试变得困难(因为模块内部依赖了外部配置)
另一方面配置文件作为用户控制程序的接口,应当可以由用户自由指定该文件的路径。
程序组件可复用性太差,因为这种贯穿所有模块的代码硬编码方式,使得大部分模块都依赖
conf.py这个文件。
所以,我认为配置的使用,更好的方式是,
模块的配置都是可以灵活配置的,不受外部配置文件的影响。
程序的配置也是可以灵活控制的。
能够佐证这个思想的是,用过nginx和mysql的同学都知道,nginx、mysql这些程序都可以自由的指定用户配置。
所以,不应当在代码中直接
import conf来使用配置文件。上面目录结构中的
conf.py,是给出的一个配置样例,不是在写死在程序中直接引用的配置文件。可以通过给
main.py启动参数指定配置路径的方式来让程序读取配置内容。当然,这里的
conf.py你可以换个类似的名字,比如
settings.py。或者你也可以使用其他格式的内容来编写配置文件,比如
settings.yaml之类的。
4.模块初始
模块,用一砣代码实现了某个功能的代码集合。类似于函数式编程和面向过程编程,函数式编程则完成一个功能,其他代码用来调用即可,提供了代码的重用性和代码间的耦合。而对于一个复杂的功能来,可能需要多个函数才能完成(函数又可以在不同的.py文件中),n个 .py 文件组成的代码集合就称为模块。
如:os 是系统相关的模块;file是文件操作相关的模块
模块分为三种:
自定义模块
内置标准模块(又称标准库)
开源模块 (https://pypi.python.org/pypi)
如何在py文件中引入自定义模块?
import os
from os import time
通过:
1 for i in sys.path: 2 print(i)
我们可以得到模块路径。
在pycharm中自动帮我们把pychram的路径加进去了。
但是在windows 系统执行的时候是不会把pychram的路径加进去的。
这时候我们需要手工添加进去:
1 import sys 2 import os 3 BaseDir = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) 4 # #__file__是取文件的相对路径 5 # os.path.abspath()是取文件的绝对路径 6 # os.path.dirname()是取文件的上级路径 7 sys.path.append(BaseDir)
python2中
目录里没有__init__,那就只是一个目录,目录是不可以被导入的。
有__init__,那这个目录就变成了包 = "package"
no matter py2 or py3 , only the package can be imported
howere, in py 3 ,the directory will also be treated as package,
__init__.pi in py3 is not mandatory.
5.常用模块
5.1、OS
提供对操作系统进行调用的接口:5.2、sys
1 import time 2 import sys 3 for i in range(20): 4 time.sleep(0.1) 5 sys.stdout.write('>') 6 sys.stdout.flush()
5.3 序列化模块
把内存对象转化成字符串的格式 就叫序列化。把字符串转化成对应的内存对象 就叫反序列化。
序列化的作用就是持久化内存数据对象。
Python中用于序列化的两个模块:
json 跨平台跨语言的数据传输格式,用于【字符串】和 【python基本数据类型】 间进行转换
pickle python内置的数据传输格式,多用于二进制形式,用于【python特有的类型】 和 【python基本数据类型】间进行转换
所有的语言都支持 json 。
Json模块提供了四个功能:dumps、dump、loads、load
pickle模块提供了四个功能:dumps、dump、loads、load
#pickle.dumps将数据通过特殊的形式转换为只有python能识别的字符串 import pickle data={'k1':123,'k2':'hello'} p_str=pickle.dumps(data) print(p_str) ------->b'\x80\x03}q\x00(X\x02\x00\x00\x00k2q\x01X\x05\x00\x00\x00helloq\x02X\x02\x00\x00\x00k1q\x03K{u.' s = pickle.loads(p_str) print(s) -------->{'k2': 'hello', 'k1': 123} #pickle.dump将数据通过特殊的形式转换为只有python认识的字符串,并写入文件 with open('db','w') as fp: pickle.dump(data,fp) json实例 #json.loads()#将字符串转换成python基本数据类型,注:里面一定要是双引号,外面是单引号 import json s='{"name":"tina","age":"18"}' l='[1,2,3,4]' r=json.loads(l) w=json.loads(s) print(r,type(r)) print(w,type(w)) ############执行结果如下:########### [1, 2, 3, 4] <class 'list'> {'age': '18', 'name': 'tina'} <class 'dict'> #json.dumps()将python的基本数据类型转换成字符串 a={"name":"tina","age":"18"} b=json.dumps(a) print(b,type(b)) #############执行结果如下:########## {"age": "18", "name": "tina"} <class 'str'> #不带s的是对文件进行操作 dic = {'k1':123,'k2':345} a=json.dump(dic,open('db','w')) print(a,type(a)) #读内容 #字符串转换成字典 r=json.load(open('db','r')) print(r,type(r)) #############执行结果如下:########## 写入db文件中的内容即为dict {'k2': 345, 'k1': 123} <class 'dict'>
作业
作业需求:模拟实现一个ATM + 购物商城程序
额度 15000或自定义
实现购物商城,买东西加入购物车,最后结账的时候调用信用卡接口结账
可以提现,手续费5%,最多只能取信用额度的一半
支持多账户登录,每个用户信息独立
支持账户间转账
记录每月日常消费流水,记录 date shop_name transaction_type intrest(手续费)
提供还款接口
ATM记录操作日志
提供管理接口,包括添加账户、用户额度,冻结账户等。。。
用户认证用装饰器
程序介绍: 实现ATM常用功能 功能全部用python的基础知识实现,用到了time\os\sys\json\open\logging\函数\模块知识, 主要帮给大家一个简单的模块化编程的示例 程序结构: day5-atm/ ├── README ├── atm #ATM主程目录 │ ├── __init__.py │ ├── bin #ATM 执行文件 目录 │ │ ├── __init__.py │ │ ├── atm.py #ATM 执行程序 │ │ └── manage.py #ATM 管理端,未实现 │ ├── conf #配置文件 │ │ ├── __init__.py │ │ └── settings.py │ ├── core #主要程序逻辑都 在这个目录 里 │ │ ├── __init__.py │ │ ├── accounts.py #用于从文件里加载和存储账户数据 │ │ ├── auth.py #用户认证模块 │ │ ├── db_handler.py #数据库连接引擎 │ │ ├── logger.py #日志记录模块 │ │ ├── main.py #主逻辑交互程序 │ │ └── transaction.py #记账\还钱\取钱等所有的与账户金额相关的操作都 在这 │ ├── db #用户数据存储的地方 │ │ ├── __init__.py │ │ ├── account_sample.py #生成一个初始的账户数据 ,把这个数据 存成一个 以这个账户id为文件名的文件,放在accounts目录 就行了,程序自己去会这里找 │ │ └── accounts #存各个用户的账户数据 ,一个用户一个文件 │ │ └── 1234.json #一个用户账户示例文件 │ └── log #日志目录 │ ├── __init__.py │ ├── access.log #用户访问和操作的相关日志 │ └── transactions.log #所有的交易日志 └── shopping_mall #电子商城程序,需单独实现 └── __init__.py
相关文章推荐
- python 自动化之路 day 面向对象基础
- python 自动化之路 day 19 Django基础[二]
- python 自动化之路 day 07 面向对象基础
- python 自动化之路 day 00 目录
- python 自动化之路 day 09 进程、线程、协程篇
- python 自动化之路 day 13
- python 自动化之路 day 03
- python 自动化之路 day 18 前端内容回顾、补充/Django安装、创建
- python 自动化之路 day 14
- python自动化之路-day14.1
- python 自动化之路 day 20 Django进阶/BBS项目【一】
- python 自动化之路 day 04
- python 自动化之路 day 08 面向对象进阶
- python 自动化之路 day 08_2 网络编程
- python 自动化之路 day 01.1 数据类型
- python 自动化之路 day 04.1 python内置函数
- python 自动化之路 day 01 人生若只如初见
- python 自动化之路 day 02
- python 自动化之路 day 10 协程、异步IO、队列、缓存
- python 自动化之路 分分钟带你写个FTP