python代码规范

  1. 云栖社区>
  2. 博客>
  3. 正文

python代码规范

科技小能手 2017-11-12 03:34:00 浏览1270
展开阅读全文

软件目录结构层次性规范的优点:

        1、可读性高
        2、可维护性高

目录组织方式:

        FOO/    项目名
                bin/    可执行文件放的目录
                        foo     可执行文件名字,当启动foo的时候调用foo/下的main.py;
                conf    配置文件
                foo/    主程序目录,源代码中的所有模块、包都应该放在此目录。
                        tests/      存放单元测试代码;
                        __init__.py  pycharm自动创建,是个空文件;
                        main.py     程序主入口,
                docs    存放文档
                        conf.py
                        abc.rst
                setup.py    安装、部署、打包的脚本。
                requirements.txt    存放软件依赖的外部Python包列表。
                README      项目说明文件。
        除此之外,有一些方案给出了更加多的内容。比如LICENSE.txt,ChangeLog.txt文件等,我没有列在这里,因为这些东西主要是项目开源的时候需要用到。

关于README的内容

这个我觉得是每个项目都应该有的一个文件,目的是能简要描述该项目的信息,让读者快速了解这个项目。
它需要说明以下几个事项:
        1.软件定位,软件的基本功能。
        2.运行代码的方法: 安装环境、启动命令等。
        3.简要的使用说明。
        4.代码目录结构说明,更详细点可以说明软件的基本原理。
        5.常见问题说明。
在软件开发初期,由于开发过程中以上内容可能不明确或者发生变化,并不是一定要在一开始就将所有信息都补全。但是在项目完结的时候,是需要撰写这样的一个文档的。
可以参考Redis源码中Readme的写法,这里面简洁但是清晰的描述了Redis功能和源码结构。

关于requirements.txt和setup.py`

setup.py

一般来说,用setup.py来管理代码的打包、安装、部署问题。业界标准的写法是用Python流行的打包工具setuptools来管理这些事情。
这种方式普遍应用于开源项目中。不过这里的核心思想不是用标准化的工具来解决这些问题,而是说,
一个项目一定要有一个安装部署工具,能快速便捷的在一台新机器上将环境装好、代码部署好和将程序运行起来。
setuptools的文档比较庞大,刚接触的话,可能不太好找到切入点。学习技术的方式就是看他人是怎么用的,
可以参考一下Python的一个Web框架,flask是如何写的: setup.py  https://github.com/mitsuhiko/flask/blob/master/setup.py
当然,简单点自己写个安装脚本(deploy.sh)替代setup.py也未尝不可。

requirements.txt

这个文件存在的目的是:

方便开发者维护软件的包依赖。将开发过程中新增的包添加进这个列表中,避免在setup.py安装依赖时漏掉软件包。
方便读者明确项目使用了哪些Python包。
这个文件的格式是每一行包含一个包依赖的说明,通常是flask>=0.10这种格式,要求是这个格式能被pip识别,
这样就可以简单的通过 pip install -r requirements.txt来把所有Python包依赖都装好了。具体格式说明: 点这里。
https://pip.readthedocs.org/en/1.1/requirements.html

关于配置文件的使用方法

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

本文转自 506554897 51CTO博客,原文链接:http://blog.51cto.com/506554897/2056664


网友评论

登录后评论
0/500
评论