Python學習之路：軟件目錄開發規范

一、背景

軟件開發是一個系統工程，當然編碼實現是其中尤其重要的一個環節，關乎到功能需求的實現好壞。這個環節中除了編碼這一硬功之外，與之相關的編碼風格這一柔道，雖然沒有直接決定功能的實現與否，但卻在很大程度上決定了的項目代碼整體的可讀性、健壯性、移植性、可維護性等重要特性。編碼風格不僅涉及到代碼如何編寫，也涉及到代碼模塊的分布組織，即項目代碼目錄的設計。

好的代碼目錄設計可以直觀展現開發者的邏輯條理，提高代碼的可讀性、可維護性、移植性甚至是健壯性，不好的代碼目錄設計就不細說了，邏輯層次混亂不清，代碼拷貝到其他環境不能運行等是最常見的問題了。

今天就來談談軟件目錄開發設計規范相關的事宜。

二、設計軟件目錄開發規范的重要性和必要性

在上文中略微提到軟件項目代碼目錄設計規范對項目的一些影響，這里細化展開一下其重要性和必要性，大致為以下幾點：

• 可讀性高：好的代碼目錄設計，可以讓剛接觸項目的人員通過目錄即可大致了解開發者的邏輯條理，明確程序入口文件、測試樣例、說明幫助文檔、配置文件等的分布位置，從而可以最快的速度熟悉項目。
• 可維護性強：當前的目錄設計規范可以明確地提示維護者新增的代碼文件、配置文件等該設計在哪個目錄下，以便更好的維護項目。這樣可確保隨着時間的推移和人員的變更，項目本身的可維護性依然很強。
• 可移植性：當項目上到一定規模或變得復雜時，通過不同的層級目錄來分布不同用途的文件顯得異常重要，這樣可以確保代碼包拷貝到其他環境后，盡可能地避免因模塊依賴、配置文件缺少、目錄調用失敗等問題導致的運行失敗問題。

三、軟件開發目錄組織方式

僅以Python為例，談談建議的軟件開發目錄組織結構：

Foo/
|-- bin/
|   |-- foo
|
|-- foo/
|   |-- tests/
|   |   |-- __init__.py
|   |   |-- test_main.py
|   |
|   |-- __init__.py
|   |-- main.py
| |--conf/ |  |-- __init__.py |　|-- settings.py | |--logs/ |
|-- docs/
|   |-- conf.py
|   |-- abc.rst
|
|-- setup.py
|-- requirements.txt
|-- README

解釋如下：

1. bin/: 存放項目的一些可執行文件，當然起名scripts/之類的也未嘗不可

2. foo/: 存放項目的所有源代碼。(1) 源代碼中的所有模塊、包都應該放在此目錄。不要置於頂層目錄。(2) 其子目錄tests/存放單元測試代碼； (3) 程序的入口最       好命名為main.py。

3. conf/: 存放配置文件

4. logs/: 作為日志目錄存放程序運行中生成的各種日志

5. docs/:存放項目的幫助文檔

6. setup.py：安裝、部署、打包的腳本，一般用於適配環境、解決依賴關系等

7. requirements.txt: 存放軟件依賴的外部python包列表

8. README：存放項目說明文檔，下文詳述

除此之外，有一些方案給出了更加多的內容。比如LICENSE.txt,ChangeLog.txt文件等，其中LICENSE.txt主要是項目開源的時候需要用到。ChangeLog.txt可根據需要確定是否添加。

四、README相關

使用過開源軟件的朋友們都知道README可以給軟件的使用帶來很大的幫助，包括軟件介紹、功能定位、安裝啟動使用方法、有建議或bug怎么聯系作者等，其必要性和重要性不言而喻。

因此每一個項目都應該有README說明，好的README應該至少包括以下幾方面的內容：

• 軟件的簡要介紹、功能定位、適用場景等
• 軟件的安裝、環境依賴、啟動方法、常見使用命令（使用說明）等
• 代碼的目錄結構說明
• 常見問題說明
• 遇到建議或bug如何聯系作者或項目組

如果再編寫的更詳細，可以考慮簡述軟件的基本原理。這方面最好的參考就是開源軟件的README，如nginx，redis等。

五、requirements.txt和setup.py相關

1. requirements

requirements主要解決以下兩個問題：

1. 方便開發者維護軟件包依賴 有新的依賴包產生時直接添加進該列表即可，然后通過setup.py自動解決該依賴，避免遺漏
2. 方便用戶明確依賴關系

requirements.txt的格式是每一行包含一個包依賴的說明，通常是flask>=0.10這種格式，要求是這個格式能被pip識別，這樣就可以簡單的通過 pip install -r requirements.txt來把所有Python包依賴都裝好了。具體格式說明： 猛擊這里。

2.setup.py

一般來說，用setup.py來管理代碼的打包、安裝、部署問題。業界標准的寫法是用Python流行的打包工具setuptools來管理這些事情。這種方式普遍應用於開源項目中。不過這里的核心思想不是用標准化的工具來解決這些問題，而是說，一個項目一定要有一個安裝部署工具，能快速便捷的在一台新機器上將環境裝好、代碼部署好和將程序運行起來。

這個問題好比在linux通過yum來安裝一個軟件一樣，我們不得不承認，在解決環境依賴關系方面，yum安裝相對於源碼編譯安裝更方便。

在python項目方面，對於初學者來講，很多都經歷過以下問題:

1. 安裝環境時忘了最近又添加了一個新的Python包，結果一到線上運行，程序就出錯了。
2. Python包的版本依賴問題，有時候我們程序中使用的是一個版本的Python包，但是官方的已經是最新的包了，通過手動安裝就可能裝錯了。
3. 如果依賴的包很多的話，一個一個安裝這些依賴是很費時的事情。
4. 新同學開始寫項目的時候，將程序跑起來非常麻煩，因為可能經常忘了要怎么安裝各種依賴。

setup.py的目的是將這些事情自動化起來，統一自動化管理，提高效率並減少出錯的概率。"復雜的東西自動化，能自動化的東西一定要自動化。"是一個非常好的習慣。

setuptools的文檔比較龐大，剛接觸的話，可能不太好找到切入點。先從模仿開始吧，可以參考一下Python的一個Web框架，flask是如何寫的: setup.py

如果開發的項目只是在Linux環境上運行，簡單點自己寫個安裝腳本（deploy.sh）替代setup.py也未嘗不可。

六、配置文件相關

注意，在上面的目錄結構中，沒有將conf.py放在源碼目錄下，而是放在docs/目錄下。

很多項目對配置文件的使用做法是:

1. 配置文件寫在一個或多個python文件中，比如此處的conf.py。
2. 項目中哪個模塊用到這個配置文件就直接通過import conf這種形式來在代碼中使用配置。

這種做法我不太贊同:

1. 這讓單元測試變得困難（因為模塊內部依賴了外部配置）
2. 另一方面配置文件作為用戶控制程序的接口，應當可以由用戶自由指定該文件的路徑。
3. 程序組件可復用性太差，因為這種貫穿所有模塊的代碼硬編碼方式，使得大部分模塊都依賴conf.py這個文件。

所以，我認為配置的使用，更好的方式是，

1. 模塊的配置都是可以靈活配置的，不受外部配置文件的影響。
2. 程序的配置也是可以靈活控制的。

能夠佐證這個思想的是，用過nginx和mysql的同學都知道，nginx、mysql這些程序都可以自由的指定用戶配置。

所以，不應當在代碼中直接import conf來使用配置文件。上面目錄結構中的conf.py，是給出的一個配置樣例，不是在寫死在程序中直接引用的配置文件。可以通過給main.py啟動參數指定配置路徑的方式來讓程序讀取配置內容。當然，這里的conf.py你可以換個類似的名字，比如settings.py。或者你也可以使用其他格式的內容來編寫配置文件，比如settings.yaml之類的。

-------------------------atm.py-------------------------------
print(__file__)#返回當前程序的相對路徑

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 settings
from core import main

main.login()



---------------------------main.py------------------------------------

def login():
    print("Welcome to my atm")