軟體目錄結構規範
alex_老男孩:
為什麼要設計好目錄結構？
「設計專案目錄結構」，就和「膽碼編碼風格」一樣，屬於個人風格問題。對於這種風格上的規範，一直都存在兩種態度：
1.一類同學認為，這種個人風格問題「無關緊要」理由是能讓程式work就好，風格問題根本不是問題。
2.另一類同學認為，規範化能更好的控制程式結構，讓程式具有更高的可讀性。
我比較偏向理解後者的，因為我是一種同學思想行為下的直接受害者。我曾靜維護過乙個非常不好的專案，其實邏輯並不複雜，但是卻耗費了我非常長的時間去理解它想要表達的意思。從此個人對提高專案可讀性、可維護性的要求就很高了。
「專案目錄結構」其實額是屬於「可讀性和可維護性」的範疇，我們設定乙個層次清晰的目錄結構，就是為了達到一下兩點：
1.可讀性高：不熟悉換個專案的**人，一眼就能看懂目錄結構，知道程式的啟動指令碼是那個，測試目錄在那裡，配置檔案在**等等。從而非常快速的了解這個專案。
2.可維護性高：定義好組織規範後，維護者就能很明確地知道，新增的那個檔案和**應該在什麼目錄之下。這個好處是，隨著時間的退役，**/配置的規模增加，專案結構不會混亂，乃然能夠組織良好。
所以，我認為，保持乙個層次清晰的目錄結構是有必要的，更何況組織乙個良好的工程目錄，其實是一鍵很簡單的事情。
目錄組織方式：
關於如何組織乙個較好的python工程目錄結構，已經有一些得到了共識的目錄結構，在stackoverflow的這個問題上，能看到大家對python目錄結構的討論。
簡要解釋一下：
1.bin/：存放專案的一些可執行檔案，當然你可以起名script/之類的也行
2.foo/：存放專案的所有源**，1.源**中所有模組、包都應該放在此目錄。不要置於頂層目錄。2.其子目錄tests/存放單元測試** 3.程式的入口最好命名為main.py
3.docs/：存放一些文件。
4.setup.py：安裝、不熟、打包的指令碼
5.requirement。txt：存放潤阿金依賴的外部python包列表
6.readme：專案說明檔案。
除此之外，有一些方案給出了更加多的內容。比如license.txt ，changelog。txt檔案等，我沒有列在這裡，因為這些東西主要是專案開元的時候需要用到的。
關於readme的內容
這個我覺得每個專案都應該有的乙個檔案,目的是能簡要描述該項目的資訊,讓讀者快速了解這個專案.
它需要說明一下幾個事項:
1.軟體定位,軟體的基本功能
2.執行**的方法:安裝環境、啟動命令等.
3.簡要的使用說明
4.**目錄機構說明,更詳細點可以說明軟體的基本原理.
5.常見問題說明.
關於requirements.txt 和 setup.py
一般來說,用setup.py來管理diamante的打包、安裝、部署問題.業界標準的寫法是用python流行的打包工具setuptools來管理這些事情.這種方式普遍應用於開源專案中.不過這裡的核心思想不是用標準化的工具來解決這些問題,而是說,乙個專案一定要有乙個安裝部署工具,能夠快速便捷的在一台新的機器上將環境裝好、**部署好將程式執行起來.
我剛開始接觸python寫專案的時候,安祖航環境、部署**、執行程式這個過程全是手動完成,遇到以下問題:
1.安裝環境時經常忘了最近又新增了乙個新的python包,結果一到線上執行,程式就出錯了.
2.python包的版本依賴問題,有時候我們程式中使用的是乙個版本的python包,但是官方的已經是最新的包了,通過手動安裝就可能裝錯.
3.如果依賴的包很多的話,乙個乙個安裝這些依賴是很費時的事情.
4.新同學開始寫專案的時候,將程式跑起來非常麻煩,因為可能經常忘了要怎麼安裝各種依賴.
setup.py可以將這些事情自動化起來,提高效率、減少出錯的概率."複雜的東西自動化,能自動化的東西一定要自動化"是乙個非常好的習慣
setuptools的文件比較龐大,剛接觸的話,可能不太好好找到切入點,學習技術的方式就是看別人怎麼用的,可以參考一些python的乙個web框架flask是如何寫的setup.py
當然,簡單點自己寫個安裝指令碼(deploy.sh)替代setup.py也未嘗不可.
requirements.txt
這個檔案存在目的是:
1.方便開發者維護軟體的包依賴.將開發過程中新增的包新增進這個列表中,避免在setup.py安裝依賴時漏掉軟體包.
2.方便讀者明確專案使用了哪些python包
這個的格式是每一行包含乙個包依賴的說明,通常是flask >= 0.10這個格式,要求是這個格式被pip識別,這樣就可以簡單的通過pip install -r requirements.txt 來包所有python包依賴都裝好了.
Python程式設計規範
1，python程式設計規範 編碼 所有的 python 指令碼檔案都應在檔案頭標上 coding utf 8 用於設定編輯器，預設儲存為 utf 8 格式。注釋 業界普遍認同 python 的注釋分為兩種，堅持適當注釋原則。對不存在技術難點的 堅持不注釋，對存在技術難點的 必須注釋。但與注釋不同，...
Python程式設計規範
簡單總結一下 類名 首字母大寫，如 myclass，內部類可以使用額外的前導下劃線。函式 方法名 小寫 下劃線 函式和方法的引數 如果函式的引數名稱和保留關鍵字衝突，通常加乙個字尾下劃線 全域性變數 避免使用全域性變數 變數 小寫，使用下劃線連線各個單詞。如 this is a variable 1...
Python 程式設計規範
二 縮排 三 空行 四 命名 五 import 好的 vs 不好的 參考資料 一 注釋 兩重意思，兩種方式 兩種方式 個人注釋 docstrings 表明如何使用這個包 模組 類 函式 方法 甚至包括使用示例和單元測試。推薦對每乙個包 模組 類 函式 方法 寫 docstrings。示例 函式或者類...