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

1、背景

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

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

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

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

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

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

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

僅以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__init__.py |　|-- settings.py | |--logs/

解釋以下：

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

2. foo/: 存放項目的全部源代碼。(1) 源代碼中的全部模塊、包都應該放在此目錄。不要置於頂層目錄。(2) 其子目錄存放單元測試代碼； (3) 程序的入口最       好命名爲。tests/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可根據須要肯定是否添加。LICENSE.txtChangeLog.txtChangeLog.txt可根據須要肯定是否添加。

4、README相關

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

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

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

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

5、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也何嘗不可。

6、配置文件相關

注意，在上面的目錄結構中，沒有將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")