Python工程目录组织
Python工程目录组织
Python工程目录组织
关于如何组织一个较好的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
。在软件开发初期,由于开发过程中以上内容可能不明确或者发生变化,并不是一定要在一开始就将所有信息都补全。但是在项目完结的时候,是需要撰写这样的一个文档的。
关于 requirements
python项目中必须包含一个 requirements.txt 文件,用于记录所有依赖包及其精确的版本号。以便新环境部署。
官方文档:
Pip’s documentation states
pip description
freeze Output installed packages in requirements format.
list List installed packages.
在虚拟环境中使用pip生成(否则会生成大量本地数据包,安装或升级包后,最好更新这个文件):
pip freeze >requirements.txt # 输出本地包环境至文件
当需要创建这个虚拟环境的完全副本,可以创建一个新的虚拟环境,并在其上运行以下命令:
pip install -r requirements.txt # 根据文件进行包安装
需求文件requirements.txt的内容示例如下:
alembic==0.8.6
bleach==1.4.3
click==6.6
dominate==2.2.1
关于setup.py
一般来说,用setup.py
来管理代码的打包、安装、部署问题。业界标准的写法是用Python流行的打包工具setuptools来管理这些事情。这种方式普遍应用于开源项目中。不过这里的核心思想不是用标准化的工具来解决这些问题,而是说,一个项目一定要有一个安装部署工具,能快速便捷的在一台新机器上将环境装好、代码部署好和将程序运行起来。
这个我是踩过坑的。
我刚开始接触Python写项目的时候,安装环境、部署代码、运行程序这个过程全是手动完成,遇到过以下问题:
- 安装环境时经常忘了最近又添加了一个新的Python包,结果一到线上运行,程序就出错了。
- Python包的版本依赖问题,有时候我们程序中使用的是一个版本的Python包,但是官方的已经是最新的包了,通过手动安装就可能装错了。
- 如果依赖的包很多的话,一个一个安装这些依赖是很费时的事情。
- 新同学开始写项目的时候,将程序跑起来非常麻烦,因为可能经常忘了要怎么安装各种依赖。
setup.py
可以将这些事情自动化起来,提高效率、减少出错的概率。"复杂的东西自动化,能自动化的东西一定要自动化。"是一个非常好的习惯。
setuptools的文档比较庞大,刚接触的话,可能不太好找到切入点。学习技术的方式就是看他人是怎么用的,可以参考一下Python的一个Web框架,flask是如何写的: setup.py
当然,简单点自己写个安装脚本(deploy.sh
)替代setup.py
也未尝不可。
关于conf.py
注意,在上面的目录结构中,没有将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
之类的。
关于main.py
__name__ == '__main__'
是Python的main函数
入口。并非说,加入这句才能使用python xxx.py
来执行,而是说,这里可以判断,当前是否是直接被python直接调用执行。
getopt
是一个包装方法,用以读取main函数
后面跟着的参数。getopt.getopt(args, options[, long_options])
有三个变量,args就是python xxx.py
后面跟着的参数,通常就是sys.argv
数组,不过我们一般会去除第一个元素,因为sys.argv
的第一个元素,就是文件名
本身。所以,我们的写法是sys.argv[1:]
。
options
是一个字符串,描述了需要解析哪些参数。如果一个参数,不需要跟变量,比如-h
,那么直接使用参数名即可。如果一个参数需要传入变量,则在后面加:
,比如n:
。所以本案例中hn:w:
的意思是,我们有三个参数,分别是-h
, -n
, -w
,其中-h
无需传入变量,而-n
, -w
需要传入变量。
long_options
是一个字符串数组,也表示需要解析哪些参数。long_options
是相对options
而言的,我们在linux中,经常会看到一个命令的参数有多种写法,最常见的就是帮助参数,它有两种写法:-h
, --help
。前一种是就是我们的options
,而后一种就是long_options
。
假如我们有一个--help
,那么在long_options
中就是['help']
。如果一个参数需要传入参数,比如--name 'Good'
,那么在long_options
中就是['name=']
,是的,就是多一个=
。
getopt.getopt
返回一个元组(opts, args),其中opts
就是我们解析出来的参数,而args
则是剩余没有解析的参数。opts
是元组数组,每个元组,相当于key-value。key
就是我们的参数名,而value
就是参数的内容。
经典例子:
# coding=utf-8
import getopt
import sys
if __name__ == '__main__':
opts, args = getopt.getopt(sys.argv[1:], 'hn:w:', ['name=', 'word=', 'help'])
name = 'No Name'
word = 'Hello'
for key, value in opts:
if key in ['-h', '--help']:
print'一个向人打招呼的程序'
print'参数:'
print'-h\t显示帮助'
print'-n\t你的姓名'
print'-w\t想要说的话'
sys.exit(0)
if key in ['-n', '--name']:
name = value
if key in ['-w', '--word']:
word = value
print'你好,我叫', name, ',', word
类class中调用的优先级:
1、def__new__(cls):
2、def__init__(self):
3、def__call__(self, x):
转载于:https://www.cnblogs.com/bonelee/p/11086806.html
Python工程目录组织相关推荐
- python安装目录结构_python软件目录结构规范
软件目录结构规范 软件开发规范 一.为什么要设计好目录结构? 1.可读性高: 不熟悉这个项目的代码的人,一眼就能看懂目录结构,知道程序启动脚本是哪个,测试目录在哪儿,配置文件在哪儿等等.从而非常快速的 ...
- Python软件目录结构规范
转载自:点击打开链接 软件开发规范 一.为什么要设计好目录结构? 1.可读性高: 不熟悉这个项目的代码的人,一眼就能看懂目录结构,知道程序启动脚本是哪个,测试目录在哪儿,配置文件在哪儿等等.从而非常快 ...
- 【Python】Python 项目目录结构
对于一个代码项目,好的目录结构是必不可少的. 我们为什么需要设计好的目录结构? 好的目录结构,意味着好的 可读性 和 可维护性, 可读性好:刚接触项目的人,一眼就能看懂目录结构,知道哪里是 源码,哪里 ...
- 【开发环境】PyCharm 打开现有 Python 工程 ( 配置 Python 编译器版本 )
文章目录 一.PyCharm 打开现有 Python 工程 二.配置 Python 编译器版本 一.PyCharm 打开现有 Python 工程 在 PyCharm 欢迎界面 , 点击 " ...
- python怎么新建工程_pycharm新建一个python工程步骤
小编最近由于工作原因要用到python,一门新的知识需要接触,对于我来说难度还是很大的. python工程目录结构 每次创建一个python工程 PyCharm会创建如下目录 创建时会把python运 ...
- Python 工程管理及 virtualenv 的迁移
virtualenv 是管理 python 工程的利器,它可以很好的帮你维护项目中的依赖,使用 virtualenv,还能保持 global 库的干净.不会被不同项目中的第三方库所污染. virtua ...
- 【开发环境】Windows 安装 PyCharm 开发环境 ( 下载 PyCharm | 安装 PyCharm | 在 PyCharm 中创建 Python 工程 )
文章目录 一.下载 PyCharm 二.安装 PyCharm 三.在 PyCharm 中创建 Python 工程 一.下载 PyCharm 到 PyCharm 主页 https://www.jetbr ...
- jenkins配置工程目录-启动case
1.我们在python里面编辑的脚本可以正常跑,但是在cmd里面跑就不行了,找不到自己定义的方法模块,这个时候我们要搞个环境变量 name : PYTHONPATH val : 工程目录路劲 ...
- vscode比较整个文件夹_vscode开发ROS1(5)-ROS工程目录结构
ROS工程整体结构图 1, ROS工程整体结构图如下. 2, 对应到之前创建的test工程, 如下. 3, ROS工程总目就是整个工程的根文件夹. 对应这里的test文件夹. 4, 总工程目录下包含3 ...
最新文章
- 性价比高出英特尔45%,亚马逊的云服务器芯片如何做到?| 解读
- Liferay 集群 (fail-over)
- 双重ScrollView,RecyclerView联动实例
- IOS之Label画一条删除线
- unity3d曲线text文本
- Spark之hive的UDF自定义函数
- js img转换base64
- L2-004 搜索树判断 (25 point(s))
- 查看C语言库函数源码
- android直播弹幕开发,Android上专为视屏直播打造的轻量级弹幕库(100多kb)
- 阿里云服务器哪个便宜?
- 使用微信开发工具开发微信小程序(二)——协同工作、发布与事件绑定
- mysql 如何 导入txt文件_mysql中导入txt文件
- 2022软件测试校招笔试题-软件测试基本理论
- 不可错过的爬虫实例(一):教你爬取优美图库
- 查看微信公众号的二维码
- PSP Skype 使用国内卡
- Android RecyclerView万能分割线
- 离开后再回原来的公司合适吗?
- Istio和Linkerd基准性能测试对比
热门文章
- 查看动态链接库依赖关系的命令
- 8g ubuntu 树莓派4b_树莓派4B(4G版本)安装Ubuntu 19.10
- finereport连接oracle_FINEREPORT连接远程ORACLE数据库
- python安装没有pip选项_python-3.x – 在ubuntu上没有pip的python安装
- 初识python教学反思_[python第一课]初识python
- oracle事务处理编号,oracle事务处理
- 计算机专业英语06章在线测试,《计算机专业英语》第06章在线测试.doc
- js调试之console.log()
- 习题2.4 递增的整数序列链表的插入 (15 分)
- oraclf 复杂查询练习_刷完这些烧脑的SQL练习题,复杂查询才能熟能生巧