我知道你在想什么--“我當然知道怎么編碼，你瘋了嗎？”

你每天在Jupyter筆記本上寫成百上千行的代碼。很明顯，你可以編碼。這并不像是在手工或在Excel中訓練機器學習模型（盡管這是可能的）。

那我能說什么呢？

我不想告訴你，但大多數編碼數據科學家都不認為是真正的編程。您正在使用編程語言作為工具來探索數據和構建模型。但是你創建的程序并不是你真正考慮的東西，只要它完成了工作。

您的代碼通常很雜亂，甚至可能無法按順序運行（多虧了筆記本）。您可能從未編寫過任何單元測試，并且對如何編寫好的、可重用的函數知之甚少。

但是，隨著數據科學越來越多地嵌入到實際產品中，這種類型的代碼將無法削減它。你不能信任糟糕的代碼，把你不能信任的代碼放到產品中會導致大量的技術債務和糟糕的用戶體驗。

“好吧，好吧，但是，我是數據科學家，不是軟件工程師”，你說。我構建模型，清理代碼是其他人的問題。雖然這在一些公司可能奏效，但就目前而言，我堅信更好的模式是讓數據科學家學習如何編寫更好的代碼。你可能永遠不會成為一名精英級別的軟件工程師，但數據科學家可以寫出可以信任的代碼，并通過一些工作投入生產。

從你的功能開始

當學習如何升級代碼時，從如何編寫函數開始。大多數代碼只是一系列函數（或潛在的類），如果您能夠學會編寫相當好的函數，這將大大提高您的代碼質量。

您的職能至少應：

1. 只做一件事
2. 有文件
3. 使用好的變量名

雖然有很多關于如何編寫干凈函數的書，但這三個項目是一個很好的開始。

你永遠不應該有一個感覺它試圖做的不僅僅是一件事的函數。一些跡象表明您的功能可能做得太多：

• 它比一個屏幕長度或大約30行代碼長（根據我的經驗）。
• 很難清楚地命名你的函數，因為它做了多少事情
• 它在if/else塊中包含大量代碼，這些代碼實際上應該分解成不同的函數

只做一件事的函數很重要，因為它使您的代碼更容易理解、管理和測試（稍后將詳細介紹測試）。

任何發布到生產中的函數都應該有一個文檔字符串，該字符串應該描述函數的功能，給出關于輸入參數的信息，并可能提供一些如何使用函數的簡單示例。將來，當您有了文檔化的函數時，您會感謝自己，而其他人也會更容易理解您的代碼。

最后，請使用易懂和有用的變量名。太多的數據科學家對使用“a”、“a1”和“a2”這樣的變量名感到很不高興。在實驗時，簡短的、無用的變量名更快地鍵入，但在將代碼投入生產時，請確保您的變量名有助于其他人理解您的代碼。

刪除打印語句

數據科學家經常使用打印語句來顯示正在發生的事情的信息。但是，在生產中，如果不再需要這些打印語句，則應該刪除它們，或者將它們轉換為日志語句。

日志記錄應該是從代碼中傳遞信息和錯誤的方式。Loguru是一個很好的Python庫，可以讓日志記錄變得更加簡單。它會自動處理日志記錄的大部分煩人部分，感覺更像是使用打印語句。

使用樣式指南

編程中的樣式指南用于使許多人更容易地處理相同的代碼，但使代碼看起來更像是由一個人編寫的。

這有什么關系？

當您有一個一致的風格時，它使導航和理解代碼變得更加容易。令人驚訝的是，當使用樣式指南時，發現bug會容易得多。遵循編寫代碼的標準方式將使您更容易在代碼和其他代碼中導航。這意味著您不必花太多時間來理解代碼是如何格式化的，而是可以專注于代碼的功能以及它是否正確和良好地完成了它。

PEP8可能是Python使用最廣泛的樣式指南。不過，外面有很多。另一個流行的風格指南來源是谷歌，因為他們已經公開了他們的內部風格指南。

重要的是你選擇了一個并努力堅持下去。一種簡單的方法是使IDE能夠檢查樣式錯誤，并設置樣式檢查，以便在沒有遵循樣式指南的情況下阻止推送代碼。您還可以通過使用自動格式化程序來進一步提交，該程序將自動為您格式化代碼。這些代碼允許您編寫任何您想要的代碼，然后在運行時自動格式化您的代碼以符合標準。對于Python來說，一個流行的是黑色。

編寫測試

我發現大多數數據科學家害怕測試，因為他們不知道如何開始測試。

事實上，許多數據科學家已經運行我稱之為臨時測試。我發現對于一個數據科學家來說，在他們的筆記本中快速地運行一些新功能的“理智檢查”是很常見的。您通過一些簡單的測試用例，并確保函數按預期運行。

軟件工程師稱之為過程單元測試。

然而，唯一的區別是，數據科學家通常會刪除這些臨時測試，然后繼續前進。相反，您需要保存它們，并確保每次在推送代碼之前都運行它們，以確保沒有任何損壞。

要開始使用Python，我將使用Pytest。使用pytest，您可以輕松地創建測試并一次運行它們以確保它們通過。一個簡單的入門方法是使用一個名為“tests”的目錄，在該目錄中有以“test”開頭的Python文件。例如，可以使用“test_addition.py”

# content of test_addition.py def add(x, y): return x + y def test_add(): assert add(3, 2) == 5

通常，您將在另一個Python文件中擁有您的實際函數，并將其導入到您的測試模塊中。您也不需要測試Python加法，但這只是一個非常簡單的示例。

在這些測試模塊中，您可以保存所有功能的“健全檢查”。通常良好的做法是不僅測試常見情況，而且測試邊緣情況和潛在錯誤情況。

注意：有許多不同類型的測試。我認為單元測試是數據科學家開始測試的最佳測試。

進行代碼審查

最后，但并非最不重要的，在我們的列表中，要寫出更好的代碼，最重要的事情是代碼審查。

代碼審查是指在您將代碼提交給主分支之前，另一個擅長在您的域中編寫代碼的人對您的代碼進行審查。此步驟確保遵循最佳實踐，并希望捕獲任何錯誤代碼或bug。

審查您的代碼的人最好至少和您一樣擅長編寫代碼，但是即使讓更初級的人審查您的代碼仍然是非常有益的。

懶惰是人類特有的行為，很容易讓這種懶惰潛入我們的代碼中。知道有人將審查您的代碼是花時間編寫好代碼的巨大激勵。這也是我發現的最好的改進方法。讓一個更有經驗的同事檢查您的代碼并給出改進方法的建議是無價的。

為了使那些審查您的代碼的人更容易，盡量減少新代碼的數量。小型的、頻繁的代碼審查工作得很好。不經常的、巨大的代碼審查是可怕的。沒有人希望被發送1000行代碼來審查。這些評論往往會提供更糟糕的反饋，因為這個人不能花必要的時間一次真正理解這么多代碼。

提高編碼水平

我希望這篇文章啟發了您花時間學習如何編寫更好的代碼。這不一定很難，但它需要時間和努力來提高。

如果你遵循這5條建議，我相信你會注意到你的代碼質量有了很大的提高。

你未來的自己和你的同事會感謝你的。