團隊協作下的Python程式設計：遵循Code Rules和Clean Code的Python入門指南

2024 年 6 月 28 日 by Dex

Table of Contents

契機

因為專案正在與中央大學合作，本次受到到中央大學電通研究所邀約，進行的「團隊協作下的Python程式設計」短講中，我們討論了多個關鍵點，幫助大家提升Python程式設計技巧並促進有效的團隊協作。

為何要遵循規範來撰寫程式？

在團隊開發中，嚴謹開發規範來撰寫程式是很重要的，以下為我認為重要的幾個關鍵點

提高程式碼質量：可以大概率地減少程式中的錯誤，確保程式碼的穩定性和可靠性。
促進團隊合作：遵循規範和有條理地進行程式碼審查，確保所有開發者的程式碼風格一致，提升團隊協作的效率和溝通效果。
易於維護和擴展：良好的設計模式和程式碼規範使得程式碼更具可讀性和可維護性，減少未來修改和擴展的困難。
快速發現和修復問題：使用程式碼靜態分析工具進行處理和解析，能夠及時發現潛在問題和不規範的程式碼，避免程式在運行中出現錯誤。
提升開發效率：一個清晰的PR流程和具體的回饋機制能夠幫助開發者快速修復問題並合併代碼，保持項目的持續進展。

🚀 減少Debug時間的最佳實踐：

使用 assert 檢查假設：確保程式在運行時符合預期。
善用 pdb 調試工具：讓程式在執行過程中暫停，進入調整與測試模式。
撰寫單元測試：使用 unittest 或 pytest 來確保程式的正確性。

以下為簡單的範例：

#使用 assert 檢查假設
def divide(a,b):
    assert b!=0, """除數不能為零"""
    #如果b為零 程式會立即報錯 方便找出問題

#善用 pdb 調整工具
import pdb
def complex_function(data):
    pdb.set_trace()

🎨 設計模式和最佳實踐：

💡 掌握常用設計模式

如單例模式、工廠模式和觀察者模式，確保程式碼可重用、可擴展。

💡 處理異常和日誌記錄：

使用 try-except 塊來處理異常，保證程式穩定運行。
使用 logging 模組進行日誌記錄，方便追蹤和除錯。

以下為工廠模式、異常例外處理和日誌記錄的範例：

程式碼規範 (Coding Rules)：

🤝 在程式的團隊合作中，清晰、可讀性高且易於維護的程式碼至關重要：

遵循 PEP 8 規範，確保程式碼風格一致。

PEP 8 規範示例如圖

以下範例展示了提到的四個主要PEP 8規範：

縮進：整個代碼使用4個空格進行縮進，沒有使用tab。
行長：所有行的長度都保持在79個字符以內。對於較長的字符串，使用了括號來分隔多行。
空行：頂層函數和類別定義之間使用了兩個空行進行分隔。
導入：導入語句位於文件頂部，並按照標準套件、第三方套件和本地端function的順序排列，每類之間用一個空行分隔。

這個範例還包括了額外的 PEP 8 最佳實踐，比如使用文檔字符串（docstrings）來解釋函數和類的用途。

🛠 使用Pylint和flake8進行程式碼靜態分析

Pylint 用於檢查代碼質量和發現潛在問題

flake8 用於檢查代碼風格

Pylint ,flake8和PEP 8 使用範例如下圖所示

程式碼審查 ( codereview )：

🔍 每次程式碼提交都要進行程式碼審查，提升程式碼質量和一致性。
提供具體的回饋，幫助開發團隊進行程式調整。

Git Pull Request (PR) 流程範例涵蓋了以下關鍵步驟：

創建分支和初始提交：開發者在新分支上工作，保持主分支的穩定性。
創建PR：提供簡潔的描述，說明更改的內容和目的。
程式碼審查：審查者提供具體的反饋，指出可以改進的地方。
審查回饋：開發者根據反饋進行修改，並更新PR。
最終審查和合併：確認問題解決後，PR被批准並合併。
分支清理：合併後刪除功能分支，保持倉庫整潔。

這個流程展示了PR的核心步驟，包括代碼審查、反饋和迭代。
它強調了團隊協作和持續改進的重要性，同時保持了過程的簡潔性。

總結與反思

這次講座強調了在團隊協作中保持程式碼清晰、可維護的重要性。透過使用最佳實踐、遵循PEP 8規範和進行有效的程式碼審查，我們能夠大幅提高代碼質量，促進團隊高效合作。這不僅有助於當前項目的成功，還能為未來的開發奠定堅實的基礎。

在實踐中，我們應該不斷反思和改進這些過程，確保每個團隊成員都能夠熟練掌握並應用這些技巧，真正做到提升整體的開發效率和產品質量。彼此通過不斷學習和分享來成長。

Dex的塵世哲學