Skip to content

Latest commit

 

History

History
203 lines (149 loc) · 9.41 KB

README.zh-TW.md

File metadata and controls

203 lines (149 loc) · 9.41 KB

學習 Python 的練習場(Playground)和速查表(Cheatsheet)

Build Status

此專案依據 目錄 分類收集了 Python 腳本,包含了程式碼範例及解釋、不同的使用情境以及衍伸閱讀連結。

閱讀英文原始版本: English, Português, Español.

此專案名稱之所以叫做 練習場(Playground),是因為您可以修改或是新增程式碼至範例中去觀察程式執行流程並使用斷言關鍵字(assert)來 測試程式。同時,此專案也使用了業界常用的工具來 檢查程式碼,確保您所撰寫的程式碼符合官方建議的 Python 程式碼風格規範。

總而言之,此專案會使您的學習過程更具互動性,並幫助您從一開始學習的時候就使用高品質的程式碼。

此專案名稱之所以也包含了 速查表(Cheatsheet) 是因為您可以隨時透過此專案中的 標準 Python 陳述式以及結構 回顧程式碼語法,也因為在此專案中的每個程式碼範例都使用了斷言來說明及教學,故您可以不用執行程式就看到函式/陳述式的預期輸出結果。

若對機器學習(Machine Learning)有興趣,可以參考專案原作者的另一個學習專案:🤖 Interactive Machine Learning Experiments

如何使用此專案儲存庫

在此專案儲存庫中的每一個 Python 腳本皆為以下結構:

"""串列(Lists) <--- 此為主題名稱

# @詳見: https://www.learnpython.org/en/Lists <-- 此為延伸閱讀連結

此處可能會有針對此主題更多的詳細說明(例如:關於串列的基本使用方法)
"""

def test_list_type():
    """此處為子主題解釋

    每個檔案皆包含說明該子主題的測試函式(例如:串列型態、串列方法)
    """

    # 建立串列之範例 <-- 此行是解釋下一行程式碼動作之註解
    squares = [1, 4, 9, 16, 25]

    # 串列可以被索引(indexed)及切片(sliced)
    # 索引會回傳該索引位置之內容值
    assert squares[0] == 1 # <-- 利用斷言來呈現結果
    # 切片會回傳一個新的串列
    assert squares[-3:] == [9, 16, 25] # <-- 利用斷言來呈現結果

故您可以做以下動作:

  • 找一個您想要學習或是回顧的 主題
  • 閱讀註解及/或包含於腳本文件字串(docstring)中的延伸閱讀資料(如上述之程式碼範例)。
  • 查看程式碼範例並利用斷言來展示使用範例及預期輸出。
  • 修改程式碼或新增新的斷言來了解程式運作流程。
  • 執行測試檢查程式碼 來確認程式是否被正確撰寫及是否可以被正確執行。

目錄

  1. 入門
  2. 運算子
  3. 資料類型
  4. 流程控制
  5. 函式
  6. 類別
  7. 模組
  8. 錯誤和例外
  9. 檔案
  10. 附加內容
  11. 標準函式庫簡介

使用此專案必備條件

安裝 Python

確認您已安裝 Python3 在您的電腦上。

您可能會想要使用標準 Python 函式庫所提供的 虛擬環境 功能在專案目錄中建立虛擬環境來佈署 Python 程式、pip 程式以及安裝所有需要的套件,藉此來避免作業系統中 Python 版本及相依性的混亂。

根據您的安裝方法,您可能可以通過以下方式執行 Python 3 直譯器:執行 pythonpython3 命令。pip 套件管理器執行方式也是如此:執行 pippip3

您可以使用以下命令來確認 Python 版本:

python --version

此專案儲存庫中的所有程式碼皆是基於 Python 3

安裝相依性套件

透過以下命令安裝此專案需要的相依性套件:

pip install -r requirements.txt

測試程式

此專案使用 pytest 測試框架來執行程式碼測試。

您可以新增以 test_ 為開頭的檔案/函式來新增測試。(例如:test_topic.py 檔案內有 def test_sub_topic() 測試函式)

請從專案根目錄下使用以下命令來執行所有測試:

pytest

您也可以使用以下命令執行特定測試:

pytest ./path/to/the/test_file.py

檢查程式碼

此專案使用 pylint 以及 flake8 函式庫來執行程式碼檢查。

PyLint

檢查撰寫之程式碼是否符合 PEP 8 風格規範,請執行以下命令:

pylint ./src/

若此檢查工具偵測到錯誤(例如:missing-docstring),您可以使用以下命令查看特定錯誤之詳細說明:

pylint --help-msg=missing-docstring

更多關於 PyLint

Flake8

檢查撰寫之程式碼是否符合 PEP 8 風格規範,請執行以下命令:

flake8 . /src

若您希望得到更多詳細的輸出,您可以加上以下參數再執行此工具:

flake8 . /src --statistics --show-source --count

更多關於 Flake8

支持此專案

您可以透過 ❤️️ GitHub 或 ❤️️ Patreon 支持原作者專案