【Python基礎】lpthw - Exercise 46 項目骨架

　　本節將會介紹如何構建一個項目骨架目錄。骨架目錄中會包含項目文件佈局、自動測試代碼、模塊及安裝腳本。

　　1、環境配置（win10）

　　1. 檢查並確認本身只安裝了一個python版本。

cd ~
python

　　能夠檢查python版本。

　　2. 運行pip，確認有基本的安裝。

>pip list
pip(version xxx.xxx)
setuptools(version xxx.xxx)

　　3. 使用下述命令設置虛擬環境

> pip install virtualenv

　　4. 建立一個.venvs文件夾，在裏面裝虛擬環境

> mkdir .venvs
> virtualenv --system-site-packages .venvs/lpthw

　　這兩個命令建立了一個.venvs文件夾，用來存儲不一樣的虛擬環境，而後建立了第一個虛擬環境lpthw。虛擬環境是一個用來安裝軟件的「假的」地方，這樣咱們就能夠針對不一樣項目使用不一樣版本的軟件包。

　　5. 安裝完成後須要激活虛擬環境

　　先cd到.venvs所在目錄，而後執行如下命令進行激活：

> .\.venvs\lpthw\Scripts\activate

　　這樣就爲PowerShell運行activate腳本，它把你當前的shell設爲使用lpthw虛擬環境，之後每次使用書中的軟件，都要先激活虛擬環境。

　　須要注意的是，win10下還須要開啓PS不能運行腳本的問題。方法爲管理員身份運行PowerShell，並運行如下命令

> set-executionpolicy remotesigned

　　6. 安裝nose，以供後面運行測試使用

> pip install nose

　　這樣nose就安裝完畢了，只不過pip將其安裝到了.venvs/lpthw的虛擬環境下面，而非主系統軟件包目錄。這樣你就能夠爲不一樣項目安裝不一樣的相互衝突的Python軟件包版本，同時還不會污染主系統級別的配置。

　　2、建立骨架項目目錄

　　1. 建立骨架目錄

> mkdir projects
> cd projects
> mkdir skeleton
> cd skeleton
> mkdir -p bin,NAME,tests,docs

　　注意mkdir同時建立多個文件須要使用-p參數，並用逗號隔開文件名。

　　projects用來存儲各個項目。skeleton是本節新項目的基礎目錄。其中NAME目錄是項目的主模塊，使用骨架時，能夠將其重命名爲本身的項目的主模塊名稱。

　　2. 設置初始文件

 　　建立一些空的python模塊目錄：

> new-item -type file NAME/__init__.py
> new-item -type file tests/__init__.py

　　在skeleton目錄下建立一個setup.py文件，這個文件在安裝項目的時候會用到，其內容以下：

 1 try:
 2     from setuptools import setup
 3 except ImportError:
 4     from distutils.core import setup
 5 
 6 config = {
 7     'description': 'My Project',
 8     'author': 'Crystal',
 9     'url': 'URL to get it at.',
10     'downloard_url': 'Where to download it.',
11     'author_email': 'my_email@xx.xx',
12     'version': '1.0',
13     'install_requires': ['nose'],
14     'packages': ['NAME'],
15     'scripts': [],
16     'name': 'projectname'
17 }
18 
19 setup(**config)

　　3. 創建測試專用的骨架文件

　　在tests文件夾下創建一個NAME_tests.py，內容以下：

 1 from nose.tools import *
 2 import NAME
 3 
 4 def setup():
 5     print("SETUP!")
 6 
 7 def teardown():
 8     print("TEAR DOWN!")
 9 
10 def test_basic():
11     print("I RAN!")

　　4. 最終的目錄結構

　　完成上述步驟後的目錄結構應該以下所示：

　　skeleton/

　　　　　　NAME/

　　　　　　　　　　__init__.py

　　　　　　bin/

　　　　　　docs/

　　　　　　tests/

　　　　　　　　　　NAME_tests.py

　　　　　　　　　　__init__.py

　　　　　　setup.py

　　5. 運行測試程序

　　注意必定要在skeleton目錄下運行，而非tests目錄下。

> nosetests
.
----------------------------------
Ran 1 test in 0.007s

OK

　　3、使用這個骨架

　　之後每次要新建一個項目時，遵循如下步驟便可：

　　1. 複製這份骨架目錄，把名字改爲新項目的名字

　　2. 將NAME目錄改名爲本身的項目的名字，或根模塊的名字

　　3. 編輯setup.py，將其包含的信息更新爲新項目的信息

　　4. 重命名tests/NAME_tests.py，把NAME換成2中所說的模塊的名字

　　5. 使用nosetests檢查有無錯誤

　　6. 開始寫代碼

　　4、setup.py——python的構建工具

　　【摘錄自博客 http://www.javashuo.com/article/p-fuyrkuvo-c.html】

　　在安裝python的相關庫時，能夠有如下兩種安裝方式

　　pip install 模塊名

　　這種方法爲在線安裝，會安裝該模塊的相關依賴包。

　　python setup.py install 模塊名

　　這種方法爲下載源碼後在本地安裝，不會安裝相關的依賴包。

　　在安裝普通的python包時，利用pip來安裝是很方便的，可是在有的場景下，使用後者會更加知足咱們的須要，例如：

　　在本機開發一個程序，須要用到python的官方模塊，以及本身編寫的自定義模塊。那麼如何實如今服務器上去發佈該系統，實現依賴模塊和自定義模塊一塊兒打包和一鍵安裝呢？也就是如何同時將本身編寫的自定義模塊以exe文件格式安裝到python的全局執行路徑C:\Python37\Scripts下呢？

　　　此時，pip工具彷佛派不上用場，只能使用setup.py。咱們只須要在setup.py文件中寫明依賴的庫和版本，而後到目標機器上使用python setup.py install 安裝。

　　示例：

 1 from setuptools import setup, find_packages  
 2   
 3 setup(  
 4     name = "test",  
 5     version = "1.0",  
 6     keywords = ("test", "xxx"),  
 7     description = "eds sdk",  
 8     long_description = "eds sdk for python",  
 9     license = "MIT Licence",  
10   
11     url = "http://test.com",  
12     author = "test",  
13     author_email = "test@gmail.com",  
14   
15     packages = find_packages(),  
16     include_package_data = True,  
17     platforms = "any",  
18     install_requires = [],  
19   
20     scripts = [],  
21     entry_points = {  
22         'console_scripts': [  
23             'test = test.help:main'  
24         ]  
25     }  
26 )

　　參數介紹：

--name 包名稱
--version (-V) 包版本
--author 程序的做者
--author_email 程序的做者的郵箱地址
--maintainer 維護者
--maintainer_email 維護者的郵箱地址
--url 程序的官網地址
--license 程序的受權信息
--description 程序的簡單描述
--long_description 程序的詳細描述
--platforms 程序適用的軟件平臺列表
--classifiers 程序的所屬分類列表
--keywords 程序的關鍵字列表
--packages 須要處理的包目錄（包含__init__.py的文件夾） 
--py_modules 須要打包的python文件列表
--download_url 程序的下載地址
--cmdclass 
--data_files 打包時須要打包的數據文件，如圖片，配置文件等
--scripts 安裝時須要執行的腳步列表
--package_dir 告訴setuptools哪些目錄下的文件被映射到哪一個源碼包。一個例子：package_dir = {'': 'lib'}，表示「root package」中的模塊都在lib 目錄中。
--requires 定義依賴哪些模塊 
--provides定義能夠爲哪些模塊提供依賴 
--find_packages() 對於簡單工程來講，手動增長packages參數很容易，剛剛咱們用到了這個函數，它默認在和setup.py同一目錄下搜索各個含有 __init__.py的包。其實咱們能夠將包統一放在一個src目錄中，另外，這個包內可能還有aaa.txt文件和data數據文件夾。另外，也能夠排除一些特定的包   find_packages(exclude=["*.tests", "*.tests.*", "tests.*", "tests"])

--install_requires = ["requests"] 須要安裝的依賴包
--entry_points 動態發現服務和插件

　　在前述entry_points中： 

　　console_scripts 指明瞭命令行工具的名稱；在「redis_run=RedisRun.redis_run:main」中，等號前面指明瞭工具包的名稱，等號後面的內容指明瞭程序的入口地址。

　　這裏也能夠有多條記錄，這樣一個項目就能夠製做多個命令行工具了，如

1 setup(
2     entry_points = {
3         'console_scripts': [
4             'foo = demo:test',
5             'bar = demo:test',
6         ]}
7 ）

　　setup.py項目示例代碼：

 1 #!/usr/bin/env python
 2 # coding=utf-8
 3 
 4 from setuptools import setup
 5 
 6 '''
 7 把redis服務打包成C:\Python27\Scripts下的exe文件
 8 '''
 9 
10 setup(
11     name="RedisRun",  #pypi中的名稱，pip或者easy_install安裝時使用的名稱，或生成egg文件的名稱
12     version="1.0",
13     author="Andreas Schroeder",
14     author_email="andreas@drqueue.org",
15     description=("This is a service of redis subscripe"),
16     license="GPLv3",
17     keywords="redis subscripe",
18     url="https://ssl.xxx.org/redmine/projects/RedisRun",
19     packages=['RedisRun'],  # 須要打包的目錄列表
20 
21     # 須要安裝的依賴
22     install_requires=[
23         'redis>=2.10.5',
24         'setuptools>=16.0',
25     ],
26 
27     # 添加這個選項，在windows下Python目錄的scripts下生成exe文件
28     # 注意：模塊與函數之間是冒號:
29     entry_points={'console_scripts': [
30         'redis_run = RedisRun.redis_run:main',
31     ]},
32 
33     # long_description=read('README.md'),
34     classifiers=[  # 程序的所屬分類列表
35         "Development Status :: 3 - Alpha",
36         "Topic :: Utilities",
37         "License :: OSI Approved :: GNU General Public License (GPL)",
38     ],
39     # 此項須要，不然卸載時報windows error
40     zip_safe=False
41 )　　

　　修改後的項目代碼（此時RedisRun模塊是DrQueue模塊的子模塊，這是由於要導入某些公用的模塊）

 1 #!/usr/bin/env python
 2 # coding=utf-8
 3 
 4 from setuptools import setup
 5 
 6 '''
 7 把redis服務打包成C:\Python27\Scripts下的exe文件
 8 '''
 9 
10 setup(
11     name="RedisRun",  #pypi中的名稱，pip或者easy_install安裝時使用的名稱
12     version="1.0",
13     author="Andreas Schroeder",
14     author_email="andreas@drqueue.org",
15     description=("This is a service of redis subscripe"),
16     license="GPLv3",
17     keywords="redis subscripe",
18     url="https://ssl.xxx.org/redmine/projects/RedisRun",
19     packages=['DrQueue'],  # 須要打包的目錄列表
20 
21     # 須要安裝的依賴
22     install_requires=[
23         'redis>=2.10.5',
24     ],
25 
26     # 添加這個選項，在windows下Python目錄的scripts下生成exe文件
27     # 注意：模塊與函數之間是冒號:
28     entry_points={'console_scripts': [
29         'redis_run = DrQueue.RedisRun.redis_run:main',
30     ]},
31 
32     # long_description=read('README.md'),
33     classifiers=[  # 程序的所屬分類列表
34         "Development Status :: 3 - Alpha",
35         "Topic :: Utilities",
36         "License :: OSI Approved :: GNU General Public License (GPL)",
37     ],
38     # 此項須要，不然卸載時報windows error
39     zip_safe=False
40 )

　　此時項目的目錄結構爲：

　　5、進一步的工做

　　1. 在模塊目錄NAME下面寫一些代碼，並讓其能夠運行。

　　2. 在bin目錄下方寫一個能夠運行的腳本，並在setup.py裏配置好bin中的腳本的信息。

　　注意，bin中存放的通常是一些在命令行上運行的腳本，而不是模塊；模塊能夠放在setup.py的同級目錄下，且其必須包含__init__.py。

　　前面提到，包含__init__.py的會被認爲是一個模塊（包），find_packages()就是搜索全部包含__init__.py的文件夾，並認爲其是一個模塊，而後在setup的時候一併安裝。

　　3. 使用setup.py安裝自定義的模塊，並確保安裝的模塊能夠正常使用，最後使用pip將其卸載。

　　cd 到setup.py目錄下，執行如下命令（爲保證不污染主環境，先激活lpthw虛擬環境！）

> python setup.py install

　　此時安裝好了名字爲NAME的模塊（能夠有和NAME相似的其餘文件夾，其中也需包含__init__.py，setup後能夠根據其名字import）。

1 import NAME
2 ...

　　使用pip卸載該包的命令以下

> pip uninstall projectname

　　這個projectname參見前面setup.py中的配置。