通過使用4個空間進(jìn)行凹痕，將線路限制為79個字符，用下劃線命名變量，帶有駱駝的類命名變量以及用空白行分離功能，同時使用Black或Flake8諸如執(zhí)行諸如Black或Flake8的工具，將變量限制在79個字符中。 2。使用有意義的名稱，例如total_price，而不是tp和動詞，以獲取諸如計算_tax之類的功能，從而確?？缦嗨聘拍畹囊恢滦?。 3。通過將大型助手分解為validate_order和ship_order等較小的助手，使功能較小且專注於20-30行。 4。使用類型提示，例如def engret（name：str） - > str來提高清晰度並使用mypy啟用靜態(tài)分析。 5。以Google或Sphinx格式編寫清晰的Docstring，以進(jìn)行功能，解釋參數(shù)和返回值，並避免冗餘註釋。 6.擁抱pythonic成語，例如列表綜合，上下文管理器進(jìn)行文件處理以及枚舉和郵政編碼等內(nèi)置功能。 7.按順序組織進(jìn)口 - 標(biāo)準(zhǔn)庫，第三方，本地 - 由空白分開，避免通配符進(jìn)口。 8.處理錯誤，具有特定異常（例如valueerror除外），而不是裸露的錯誤，除了子句外，也有意義的消息。 9。使用PYTEST或UNITSEST編寫具有描述性名稱的單元測試，例如Test_calculate_tax_with_with_zero_income並維護(hù)乾淨(jìng)的測試代碼。 10。通過刪除死亡代碼，消除重複，提取可重複使用的邏輯並改善名稱隨著理解的發(fā)展而定期進(jìn)行重構(gòu)。遵循這些實踐確保Python代碼隨著時間的流逝保持乾淨(jìng)，可讀，可維護(hù)且容易出錯。

編寫清潔且可讀的Python代碼對於可維護(hù)性，協(xié)作和減少錯誤至關(guān)重要。以下是一些公認(rèn)的最佳實踐：

1。遵循PEP 8 - Python代碼的樣式指南

Pep 8是Python的官方樣式指南，並涵蓋了格式，命名慣例和佈局。要點包括：

• 每個凹痕級別使用4個空間（不是選項卡）。
• 將行限制為79個字符（72個DOCSTRINGS）。
• 具有兩個空白行的單獨功能和類。
• 將小寫與下劃線使用函數(shù)和可變名稱（ my_variable ， process_data ）。
• 使用CamelCase作為班級名稱（ MyClass ， DataProcessor ）。
• 圍繞著空白行的頂級功能和類。
• 避免外部空格（例如， func( arg ) → func(arg) ）。

您可以使用flake8 ， black或autopep8之類的工具自動檢查或格式化代碼。

2。寫有意義的名字

為變量，函數(shù)和類選擇描述性和明確的名稱。

• 避免單字母的名稱（除循環(huán)或數(shù)學(xué)上下文以外）。
• 使用total_price而不是tp 。
• 使用動詞來函數(shù)名稱： calculate_tax() ， fetch_user_data() 。
• 保持一致：如果您使用user_data ，請不要切換到client_info以獲取相同的概念。

這使您的代碼自我記錄並易於遵循。

3。保持功能較小且專注

每個功能都應(yīng)該做一件事並做得很好（單個責(zé)任原則）。

• 旨在在20-30行以下的功能。
• 將大功能分解為較小的輔助功能。
• 使用清晰的功能名稱來描述他們的工作。

例如：

 def process_orders（訂單）：
    驗證= [validate_order（o）o在訂單中的o]
    發(fā)貨= [ship_order（o）for o o.is_valid的驗證]
    send_notifications（發(fā)貨）

而不是一個長功能進(jìn)行驗證，運(yùn)輸和通知。

4。使用類型提示

類型提示提高了可讀性，並有助於儘早捕獲錯誤。

 def問候（名稱：str） - > str：
    返回f“你好，{name}”

它們在較大的項目中特別有用，以及使用mypy等工具進(jìn)行靜態(tài)分析。

5。寫清晰而簡潔的評論和docstrings

僅當(dāng)代碼不自稱時發(fā)表評論。避免說明明顯。

將DOCSTRINGS用於模塊，類和功能。最常見的格式是Google樣式或獅身人面像：

 def calculate_area（半徑：float） - > float：
    “”“鑑於其半徑，計算圓的面積。

    args：
        半徑：圓的半徑。

    返回：
        圓的區(qū)域。
    ”“”
    返回3.14159 *半徑** 2

6。槓桿pythonic成語

以一種自然的方式編寫代碼：

• 使用列表綜合以進(jìn)行簡單轉(zhuǎn)換：

   squares = [x ** 2 for x在範(fàn)圍內(nèi)（10）]

• 使用上下文經(jīng)理進(jìn)行文件處理：

  打開（“ file.txt”）為f：
      content = f.read（）

• 使用enumerate()和zip()而不是手動索引。
• if not list if len(list) == 0優(yōu)先列出。

7。正確組織進(jìn)口

遵循PEP 8進(jìn)口訂單：

1. 標(biāo)準(zhǔn)庫導(dǎo)入
2. 第三方進(jìn)口
3. 本地應(yīng)用程序?qū)?/li>

用空白行分開每個組。避免通配符導(dǎo)入（ from module import * ）。

導(dǎo)入操作系統(tǒng)
導(dǎo)入系統(tǒng)

導(dǎo)入請求
導(dǎo)入numpy作為NP

從mypackage導(dǎo)入mymodule

8。優(yōu)雅處理錯誤

使用特定的例外，避免裸露except:從句。

嘗試：
    值= int（user_input）
除了Valueerror：
    打?。ā盁o效號碼”）

記錄有意義的錯誤消息，並避免沉默，除非有意。

9。使用版本控制和寫作測試

乾淨(jìng)的代碼不僅與樣式有關(guān)，還與可靠性有關(guān)。

• 使用unittest或pytest編寫單元測試。
• 保持測試代碼也清潔。
• 使用描述性測試名稱： test_calculate_tax_with_zero_income 。

10。定期重構(gòu)

不要編寫一次代碼而忘記它。隨著您了解更多信息，重新訪問和簡化。

• 刪除死亡代碼和重複邏輯。
• 將重複的模式提取到函數(shù)或類中。
• 隨著理解的發(fā)展而重命名。

基本上，乾淨(jìng)的python代碼讀取的散文讀起來很清楚：清晰，簡潔且易於遵循。遵循這些實踐會隨著時間的流逝而產(chǎn)生很大的不同。

以上是編寫清潔和可讀的Python代碼的最佳實踐是什麼？的詳細(xì)內(nèi)容。更多資訊請關(guān)注PHP中文網(wǎng)其他相關(guān)文章！