一文掌握在PyCharm中正確設置Python項目
簡介
在Mac和Linux都支持Python,但許多開發(fā)者發(fā)現(xiàn)正確設置Python項目很困難。本文匯總了多平臺中運行Python的方法,提高編程的效率,如下所示:
- 使用命令行運行Python。
- 在PyCharm(免費社區(qū)版)中運行Python。
- 添加和刪除軟件包。
- 使用虛擬環(huán)境,隔離Python代碼。
目錄結構
使用如下圖所示的目錄結構(文末下載源碼)。
圖片
安裝并啟動PyCharm
安裝了社區(qū)版PyCharm,安裝完成后啟動PyCharm。
【PyCharm社區(qū)版】:https://www.jetbrains.com/zh-cn/pycharm/
在PyCharm中查看文件夾內容
點擊打開->選擇文件夾my_python_project。
PyCharm視圖
scripts
此文件夾包含bash腳本。對于每個"main" Python文件,必須有一個對應的"main" bash腳本。
scripts/application.sh
為什么在Python項目中需要"main" bash腳本?
這些腳本是作為終端或其他程序(例如Ansible,Jenkins)的入口。它們還能確保Python應用程序在固定的虛擬環(huán)境中運行。
也可以使用不調用python程序的其他腳本。
scripts/genssl.sh — generates self signed certificates
src
main files
將包含主要入口的文件直接放在src文件夾下。
application.py
from my_package import names
if __name__ == "__main__":
sys.path.append('.')
names.echo_name("John")
packages
在src文件夾下創(chuàng)建Python包。為了將目錄標識為Python包,Python要求添加一個空的__init.py__文件。
現(xiàn)在,可以將一個包中的Python類和函數(shù)導入到另一個Python文件中。
為了使導入正確,添加sys.path.append('.')很重要。
setupvenv.sh
這個bash腳本將在存儲庫之外的文件夾中設置Python虛擬環(huán)境。它還會根據(jù)requirements.txt安裝庫。
requirements.txt
該文件包含了Python標準庫之外的大多數(shù)常用庫。
requests庫用于進行get/post請求,flask庫用于接收get/post請求。
運行應用程序
終端
打開命令行應用程序(在MacOS/Linux中為Terminal,在Windows中為CMD)
- cd to <your project folder>/scripts
- ./application.sh
這將安裝虛擬環(huán)境,安裝pip軟件包,并執(zhí)行Python應用程序!
第一次運行時,它將設置虛擬環(huán)境和依賴項。如果重新運行,將會看到一個較小的輸出,因為它只是更新了依賴項。
首次從終端運行application.sh。注意:虛擬環(huán)境已創(chuàng)建,程序庫已安裝。
從終端重新運行application.sh的第一次運行。注意,虛擬環(huán)境已創(chuàng)建并安裝了庫。
從終端重新運行application.sh
PyCharm
現(xiàn)有解釋器
在使用PyCharm運行任何程序之前,需要做的第一件事是為項目設置解釋器。PyCharm可以添加一個新解釋器,但在這里,當運行./application.sh時,本文已經(jīng)創(chuàng)建了一個解釋器。因此,請選擇 “add existing interpreter(添加現(xiàn)有解釋器)”。
如果查看終端輸出,你會找到現(xiàn)有解釋器的位置:
Path> /Users/ms/narambunet/wdir/bin/python
等待PyCharm索引文件。完成后,就可以通過PyCharm運行Python應用程序了。
圖片
選擇現(xiàn)有解釋器。你可以通過點擊編輯器最右下角找到此對話框。
圖片
一旦選擇了解釋器,將會顯示在requirements.txt中定義的庫。
將"src"目錄標記為"Sources Root"
在通過IDE(集成開發(fā)環(huán)境)運行應用程序之前,還有一個步驟。將src文件夾標記為Sources Root。當從終端運行application.sh時,這不是必需的,但是當你想直接從PyCharm執(zhí)行application.py時,這是必需的。
圖片
將src目錄標記為"sources root",這樣就可以直接從PyCharm編輯器運行application.py。
從PyCharm運行application.py
圖片
PyCharm成功運行
源代碼
可以從GitHub下載本文的Python項目相關文件。
【Python項目】:https://github.com/naraone/my_python_project