文档内容学习于
http://www.cnblogs.com/xiaozhiqi/
参考：
https://www.cnblogs.com/monologuesmw/p/9490093.html
软件目录结构规范
- 可读性高: 不熟悉这个项目的代码的人，一眼就能看懂目录结构，知道程序启动脚本是哪个，测试目录在哪儿，配置文件在哪儿等等。从而非常快速的了解、跟进这个项目。
- 可维护性高: 定义好组织规则后，维护者就能很明确地知道，新增的哪个文件和代码应该放在什么目录之下。这个好处是，随着时间的推移，代码/配置的规模增加，项目结构不会混乱，仍然能够组织良好。
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包列表，这只是一个txt文件。README: 项目说明文件。
关于配置文件：
此处配置文件conf.py并未直接放于源码目录下，而是放置在docs/目录下，模块的配置应该是灵活的，不受外界配置文件的影响，所以不应当在代码中直接import conf 来使用配置文件，可以通过给main.py启动参数指定配置路径的方式来让程序读取配置内容。
关于setup.py
一般来说，用setup.py来管理代码的打包、安装、部署问题。业界标准的写法是用Python流行的打包工具setuptools来管理这些事情。这种方式普遍应用于开源项目中。不过这里的核心思想不是用标准化的工具来解决这些问题，而是说，一个项目一定要有一个安装部署工具，能快速便捷的在一台新机器上将环境装好、代码部署好和将程序运行起来。
整合打包时应核对requirements中所记录的python包列表与实际使用的Python包是否吻合，包括使用包的版本
关于requirements.txt
这个文件存在的目的是:
-
- 方便开发者维护软件的包依赖。将开发过程中新增的包添加进这个列表中，避免在
setup.py安装依赖时漏掉软件包。 - 方便读者明确项目使用了哪些Python包，通过包的学习快速跟进项目程序。
- 方便开发者维护软件的包依赖。将开发过程中新增的包添加进这个列表中，避免在
requirements.txt中存放软件依赖的外部Python包列表最好和开发过程中软件实际使用的Python包保持实时同步，这样在最后打包setup.py文件时才不会有遗漏。
关于ReadMe
这个同setup.py一样，是每个项目都应该有的一个文件，目的是能简要描述该项目的信息，让读者快速了解这个项目。
它需要说明以下几个事项:
-
- 软件定位，软件的基本功能。
- 运行代码的方法: 安装环境、启动命令等。
- 简要的使用说明。
- 代码目录结构说明，更详细点可以说明软件的基本原理。
- 常见问题说明。
ReadMe的作用就好像是干练的用户使用手册说明，这样的文档多在项目完结的时候进行撰写。
跨目录读取程序文件
在python中，如果要调用其他的脚本。 需要进行import。 但是如果程序在其他目录线面，直接 import 会报错的
以下是调取程序的 方法
我们现在有这么一个目录
可以使用os.path
import os print (os.path.abspath(__file__)) # 打印文件路径 print (os.path.dirname( os.path.abspath(__file__) )) # 打印目录的路劲
执行结果
然后调取程序的话 看以下
[root@master Atm]# pwd #全路径
/root/python/day4/Atm
[root@master Atm]# tree #目录结构，里面有3个py程序 . ├── bin │ └── atm.py # 主文件 ├── conf │ ├── __pycache__ │ │ └── setting.cpython-36.pyc │ └── setting.py #被调取程序1 └── foo ├── main.py #被调取程序2 └── __pycache__ └── main.cpython-36.pyc 5 directories, 5 files
[root@master Atm]# cat bin/atm.py #主程序，执行的程序。 里面的程序下面会详细解释 ，先知道有这么一个文件。 #!/usr/bin/env python3 import os import sys print (os.path.abspath(__file__)) print (os.path.dirname( os.path.abspath(__file__) )) BASE_DIR= os.path.dirname(os.path.dirname( os.path.abspath(__file__) )) sys.path.append( BASE_DIR ) from conf import setting from foo import main main main.login() [root@master Atm]# cat conf/setting.py #被调取程序1 #!/usr/bin/env python3 print ("welcome")
[root@master Atm]# cat foo/main.py #被调取程序2，里面是个函数 #!/usr/bin/env python3 def login(): print ("please login")
执行主程序。调取另外2个程序
[root@master Atm]# ls bin conf foo [root@master Atm]# cat ./bin/atm.py #!/usr/bin/env python3 import os import sys print (os.path.abspath(__file__)) #打印文件路劲 print (os.path.dirname( os.path.abspath(__file__) )) #打印文件的目录路劲，这个时候是在bin这一层。
print (os.path.dirname(os.path.dirname( os.path.abspath(__file__) ))) #打印文件的目录路劲, 这个时候是在atm这一层。os.path.dirname这个再用了一次 BASE_DIR= os.path.dirname(os.path.dirname( os.path.abspath(__file__) )) # 要调取其他目录下的文件。 需要在atm这一层才可以 sys.path.append( BASE_DIR ) # 将这个路径添加到环境变量中。 from conf import setting # 根据目录调取程序（文件） from foo import main # 根据目录调取程序（文件） setting #直接执行程序
main.login() #执行程序中的函数 [root@master Atm]# ./bin/atm.py # 看执行结果 /root/python/day4/Atm/bin/atm.py /root/python/day4/Atm/bin
/root/python/day4/Atm welcome
please login
这样就搞定了，跨目录调取文件 。
注意：
在pycharm中如果发现 调取其他程序中的模块，有红线时，如果确定自己的语法没问题，并且模块确实存在且能调到。忽略它。不影响执行。（如果执行报错，就是代码有问题）。
因为pycharm是动态加载的。 可能是因为 pycharm本生就没有这2个模块的 。所以报红线。 但是左侧的目录树里面 ，是正常的。 不影响执行。
