• python 软件目录结构规范 与 模块导入


    为什么要规范软件目录结构?

    1. 可读性高: 不熟悉这个项目的代码的人,一眼就能看懂目录结构,知道程序启动脚本是哪个,测试目录在哪儿,配置文件在哪儿等等。从而非常快速的了解、跟进这个项目。
    2. 可维护性高: 定义好组织规则后,维护者就能很明确地知道,新增的哪个文件和代码应该放在什么目录之下。这个好处是,随着时间的推移,代码/配置的规模增加,项目结构不会混乱,仍然能够组织良好。

    所以,在实际项目开发过程中,良好的目录结构是十分必要的。即使追求个人风格,也要在遵循基本的规范的基础上,否则编写的代码只有自己愿意看,这与在代码编写过程中必要的注释是相同的。

    目录组织方式

    假设项目名为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. foo/: 存放项目的所有源代码。(1) 源代码中的所有模块、包都应该放在此目录。不要置于顶层目录。(2) 其子目录tests/存放单元测试代码; (3) 程序的入口最好命名为main.py
    3. docs/: 存放一些文档,配置文件等。
    4. setup.py: 安装、部署、打包的脚本。
    5. requirements.txt: 存放软件依赖的外部Python包列表,这只是一个txt文件。
    6. README: 项目说明文件。

    关于配置文件:

    此处配置文件conf.py并未直接放于源码目录下,而是放置在docs/目录下,模块的配置应该是灵活的,不受外界配置文件的影响,所以不应当在代码中直接import conf 来使用配置文件,可以通过给main.py启动参数指定配置路径的方式来让程序读取配置内容。

     关于setup.py

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

    整合打包时应核对requirements中所记录的python包列表与实际使用的Python包是否吻合,包括使用包的版本

    关于requirements.txt

    这个文件存在的目的是:

      1. 方便开发者维护软件的包依赖。将开发过程中新增的包添加进这个列表中,避免在setup.py安装依赖时漏掉软件包。
      2. 方便读者明确项目使用了哪些Python包,通过包的学习快速跟进项目程序。

      requirements.txt中存放软件依赖的外部Python包列表最好和开发过程中软件实际使用的Python包保持实时同步,这样在最后打包setup.py文件时才不会有遗漏。

    关于ReadMe

    这个同setup.py一样,是每个项目都应该有的一个文件,目的是能简要描述该项目的信息,让读者快速了解这个项目。

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

      1. 软件定位,软件的基本功能。
      2. 运行代码的方法: 安装环境、启动命令等。
      3. 简要的使用说明。
      4. 代码目录结构说明,更详细点可以说明软件的基本原理。
      5. 常见问题说明。

    ReadMe的作用就好像是干练的用户使用手册说明,这样的文档多在项目完结的时候进行撰写。

     

    由于软件目录结构的存在,不可避免的会存在跨目录导入模块的情况

    模块导入详解

    先了解几个概念:

    1. 模块(python file):本质是.py结尾的python文件。
    2. 包(python package):本质是目录(也就是上文介绍的目录结构规范),在包中编写模块,组织模块,每创建一个python package都会在自动生成一个__init__.py文件。

    导入方法:

    1. 导入模块方法:
    1 # 基本导入模块
    2 import sys
    3 # 同时导入多个模块
    4 import sys, copy, numpy, pandas
    5 # 同时导入多个模块并部分重命名
    6 import sys, numpy as np, pandas as pd, tensorflow as tf
    7 
    8 #从某个包中导入某个模块
    9 from tensorflow.contrib import rnn

      import只能导入当前目录,标准库以及第三方库中的模块。在import时,还可以直接导入该模块中的某个变量或者是方法,即import XXX.xxx  (xxx可以是变量或是方法)

      2.  多级目录导入方法:

    需要了解两个模块:

    • sys模块
    • os模块
    1 # 多级目录导入方法:
    2 import sys, os
    3 sys.path()   # 返回执行当前文件执行搜索的所有路径
    4 BaseDir = os.path.abspath(__file__)  # 获取当前文件的路径
    5 addDir = os.path.dirname(os.path.dirname(BaseDir))  # 获取父目录地址
    6 sys.path.append(addDir) #将改地址添加至默认搜索路径中
    7 from logs import logger  # 从包中导入模块

      sys.path():其返回值是一个列表,内包含搜索的所有路径。

      sys.path.append() : 是将目标路径追加至列表的末尾,也就是说,在搜索模块时,会先在当前目录进行搜索,进而到标准库,第三方库中进行搜索,如果都没有改模块,才会到追加的这个路径中进行搜索。如果标准库或第三方库中存在同名的模块,将不能访问到添加路径下的模块。

      sys.path.insert(): 会把路径加入到python系统路径列表的最前边

  • 相关阅读:
    js加入购物车抛物线动画
    mysql模糊查询like/REGEXP
    Servlt入门
    JSON详解
    AJAX技术初级探索
    css与js基础
    JDBC
    数据库
    反射
    网络编程
  • 原文地址:https://www.cnblogs.com/monologuesmw/p/9490093.html
Copyright © 2020-2023  润新知