4.15 軟件開發目錄規範

1.為什麽要設計好目錄結構?

。"項目目錄結構"其實也是屬於"可讀性和可維護性"的範疇，我們設計一個層次清晰的目錄結構，就是為了達到以下兩點:

1. 可讀性高: 不熟悉這個項目的代碼的人，一眼就能看懂目錄結構，知道程序啟動腳本是哪個，測試目錄在哪兒，配置文件在哪兒等等。從而非常快速的了解這個項目。
2. 可維護性高: 定義好組織規則後，維護者就能很明確地知道，新增的哪個文件和代碼應該放在什麽目錄之下。這個好處是，隨著時間的推移，代碼/配置的規模增加，項目結構不會混亂，仍然能夠組織良好。

所以，我認為，保持一個層次清晰的目錄結構是有必要的。更何況組織一個良好的工程目錄，其實是一件很簡單的事兒。

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

簡要解釋一下:

• bin/: 存放項目的一些可執行文件，當然你可以起名script/之類的也行。
• foo/: 存放項目的所有源代碼。(1) 源代碼中的所有模塊、包都應該放在此目錄。不要置於頂層目錄。(2) 其子目錄tests/存放單元測試代碼； (3) 程序的入口最好命名為main.py。
• docs/: 存放一些文檔。
• setup.py: 安裝、部署、打包的腳本。
• requirements.txt: 存放軟件依賴的外部Python包列表。
• README: 項目說明文件。

3.關於README的內容

這個我覺得是每個項目都應該有的一個文件，目的是能簡要描述該項目的信息，讓讀者快速了解這個項目。

它需要說明以下幾個事項:

1. 軟件定位，軟件的基本功能。
2. 運行代碼的方法: 安裝環境、啟動命令等。
3. 簡要的使用說明。
4. 代碼目錄結構說明，更詳細點可以說明軟件的基本原理。
5. 常見問題說明。

4.關於requirements.txt和setup.py

setup.py

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

剛開始接觸Python寫項目的時候，安裝環境、部署代碼、運行程序這個過程全是手動完成，遇到過以下問題:

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

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

setuptools的文檔比較龐大，剛接觸的話，可能不太好找到切入點。學習技術的方式就是看他人是怎麽用的，可以參考一下Python的一個Web框架，flask是如何寫的: setup.py

當然，簡單點自己寫個安裝腳本（deploy.sh）替代setup.py也未嘗不可。

6.requirements.txt

這個文件存在的目的是:

1. 方便開發者維護軟件的包依賴。將開發過程中新增的包添加進這個列表中，避免在 setup.py 安裝依賴時漏掉軟件包。
2. 方便讀者明確項目使用了哪些Python包。

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

7.關於配置文件的使用方法

註意，在上面的目錄結構中，沒有將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之類的。

4.16本章小結：

logging模塊有幾個日誌級別？

答案
 logging模塊共5個級別，它們分別是：
 DEBUG INFO WARNING ERROR CRITICAL

請配置logging模塊，使其在屏幕和文件裏同時打印以下格式的日誌

2017-10-18 15:56:26,613 - access - ERROR - account [1234] too many login attempts

json、pickle、shelve三個區別是什麽？

答案
 首先，這三個模塊都是序列化工具。
 1. json是所有語言的序列化工具,優點跨語言、體積小.只能序列化一些基本的數據類型。int\str\list\tuple\dict
 pickle是python語言特有序列化工具，所有數據都能序列化。只能在python中使用，存儲數據占空間大.
 shelve模塊是一個簡單的k,v將內存數據通過文件持久化的模塊，可以持久化任何pickle可支持的python數據格式。
 2. 使用方式，json和pickle用法一樣，shelve是f = shelve.open(‘shelve_test‘)

json的作用是什麽？

答案：
 序列化是指把內存裏的數據類型轉變成字符串，以使其能存儲到硬盤或通過網絡傳輸到遠程，因為硬盤或網絡傳輸時只能接受bytes

subprocess執行命令方法有幾種？

答案吧：有三種方法，他們分別是
 run()方法
 call()方法
 Popen()方法

為什麽要設計好目錄結構？

答案：
1.可讀性高: 不熟悉這個項目的代碼的人，一眼就能看懂目錄結構，知道程序啟動腳本是哪個，測試目錄在哪兒，配置文件在哪兒等等。從而非常快速的了解這個項目。
2.可維護性高: 定義好組織規則後，維護者就能很明確地知道，新增的哪個文件和代碼應該放在什麽目錄之下。這個好處是，隨著時間的推移，代碼/配置的規模增加，項目結構不會混亂，仍然能夠組織良好。

打印出命令行的第一個參數。例如：

python argument.py luffy
打印出 luffy

答案：
import sys
print(sys.argv[1])

代碼如下：

‘‘‘
Linux當前目錄/usr/local/nginx/html/
文件名：index.html
‘‘‘
import os
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(‘index.html‘)))
print(BASE_DIR)

打印的內容是什麽？

答案
/usr/local/nginx

os.path.dirname和os.path.abspath含義是什麽？

答案
os.path.dirname：指定文件的目錄
os.path.abspath：指定文件的絕對路徑

通過configparser模塊完成以下功能

文件名my.cnf

[DEFAULT]

 [client]
 port = 3306
 socket = /data/mysql_3306/mysql.sock

 [mysqld]
 explicit_defaults_for_timestamp = true
 port = 3306
 socket = /data/mysql_3306/mysql.sock
 back_log = 80
 basedir = /usr/local/mysql
 tmpdir = /tmp
 datadir = /data/mysql_3306
 default-time-zone = ‘+8:00‘

修改時區 default-time-zone = ‘+8:00‘ 為 校準的全球時間 +00:00、

答案
import configparser
config = configparser.ConfigParser()
config.read(‘my.cnf‘)
config.set(‘mysqld‘,‘default-time-zone‘,‘+00:00‘)
config.write(open(‘my.cnf‘, "w"))
print(config[‘mysqld‘][‘default-time-zone‘] )

刪除 explicit_defaults_for_timestamp = true

import configparser
config = configparser.ConfigParser()
config.read(‘my.cnf‘)
config.remove_option(‘mysqld‘,‘explicit_defaults_for_timestamp‘)
config.write(open(‘my.cnf‘, "w"))

為DEFAULT增加一條 character-set-server = utf8

答案：
import configparser
config = configparser.ConfigParser()
config.read(‘my.cnf‘)
config.set(‘DEFAULT‘,‘character-set-server‘,‘utf8‘)
config.write(open(‘my.cnf‘, "w"))

第四章——續3.1