zoukankan      html  css  js  c++  java
  • python(37)- 软件开发规范

    软件开发规范

    一、为什么要设计好目录结构?

    1.可读性高: 不熟悉这个项目的代码的人,一眼就能看懂目录结构,知道程序启动脚本是哪个,测试目录在哪儿,配置文件在哪儿等等。从而非常快速的了解这个项目。

    2.可维护性高: 定义好组织规则后,维护者就能很明确地知道,新增的哪个文件和代码应该放在什么目录之下。这个好处是,随着时间的推移,代码/配置的规模增加,项目结构不会混乱,仍然能够组织良好。

     

    二、目录组织方式

    关于如何组织一个较好的Python工程目录结构,已经有一些得到了共识的目录结构。

    假设你的项目名为ATM

    ATM/
    |-- bin/
    |   |-- __init__
    |  |-- start.py | |-- core/
    | |-- tests/
    | | |-- __init__.py
    | | |-- test.main.py
    | | | |-- __init__.py | |-- test_main.py| | |-- conf/ | |-- __init__.py | |-- setting.py
    |
    |---db/ | |--db.json
    | |-- docs/
    | |-- lib/
    | |-- __init__.py
    | |-- common.py
    |
    |-- log/
    | |-- access.log
    |
    |-- __init__.py |-- README


    1. bin/: 存放项目的一些可执行文件,当然你可以起名script/之类的也行,但bin/更直观。易懂
    2. core/: 存放项目的所有源代码。(1) 源代码中的所有模块、包都应该放在此目录。不要置于顶层目录。 (2) 其子目录tests/存放单元测试代码; (3) 程序的入口最好命名为main.py
    3. conf/:配置文件。
    4. db/:数据库文件。
    5. lib/:库文件,放自定义模块和包。
    6. docs/: 存放一些文档。
    7. log/: 日志文件。
    8. README: 项目说明文件。

    注:运行程序时,在bin目录下执行start.py代码,不可以直接执行core下的模块。




  • 相关阅读:
    北极星杯 awd复现
    5,linux入门到上手-文件与文件系统的压缩,打包与备份
    4,linux入门到上手-文件与目录相关操作
    ctf中 preg_match 绕过技术 | 无字母数字的webshell
    巅峰极客 2019部分题解 writeup
    使用python爬去中国最好大学排名2016年
    python进制转换
    python应用-爬取猫眼电影top100
    3,linux入门到上手-文件权限管理与配置
    DNS、域、域名及FQDN 概念
  • 原文地址:https://www.cnblogs.com/xuyaping/p/6802440.html
Copyright © 2011-2022 走看看