本文轉自 ，歡迎大家關注
“寫代碼時，每次都要告訴自己：最後負責維護代碼的，會是一個知道你住在哪的變態暴力狂。”——約翰·伍德（John Woods）
生產代碼（production code）是用戶使用的產品中的代碼。將軟件部署到生產環境（production）後，就意味著用戶可以公開訪問了。本文將介紹13個最佳的編程原則，有助於大家編寫可部署於生產環境的代碼。這些原則來源於《Python編程無師自通》，讀完這本書後我的代碼質量大幅提升。
作者：[美] 科裡•奧爾索夫（Cory Althoff）
01 13個最佳編程技巧
寫代碼是最後的手段
作為一名軟件工程師，你在工作時應儘量少寫代碼。碰到問題時，你首先想到的不應該是“我怎麼解決這個問題”，而是“其他人是不是已經解決了這個問題，我能使用他們的方案嗎？”如果你自己去解決一個常見的問題，很有可能別人已經有了解決方案。先在網上檢索解決辦法，只有在確定沒人解決過該問題之後，才開始自己動手解決。
DRY
DRY是不要重複自己（Dont’t Repeat Yourself）的簡稱，指的是不要在程序中編寫重複的或是基本相同的代碼。正確的做法是將代碼封裝至函數中，後續可重複使用。
正交性
正交性（Orthogonality）是《The Pragmatic Programmer》中提倡並普及的另一個重要編程原則。亨特和托馬斯認為，“該術語已經被用來表示某種獨立性或解耦化。如果兩個或多個事物之間的變化不會相互影響，那麼它們之間就存在正交性。在設計優良的系統中，數據庫代碼與用戶界面之間是正交的；調整用戶界面不會影響數據庫，替換數據庫也不會改變用戶界面。”實踐中請牢記，“A不應該影響B”。假設我們有兩個模塊module_a和module_b，module_a不應對module_b中的內容進行修改，反之亦然。如果設計的系統中A會影響到B，而B又影響C，很快就會失去控制，系統將變得無法管理。
每個數據都只應保存在一處
假設手上有一個數據，我們只需要將其存儲在一個地方。例如，我們正在開發用來處理手機號碼的軟件，其中有兩個函數要使用地區編號的列表，這裡要確保程序中只有一個地區編號列表，而不是為每個函數重複創建。正確的做法是創建一個保存地區編號的全局變量。更好的解決方案則是將信息保存在文件或數據庫中。
函數只做一件事
我們寫的每個函數應該只做一件事。如果發現函數太長，請檢查其是否在完成多個任務。將函數限制為只完成一個任務有很多好處。首先，代碼可讀性增強，因為函數名稱可以直接說明其功能。如果代碼出錯，調試也將更加方便，因為每個函數只負責一個特定的任務，我們可以快速隔離並調試問題函數。用許多知名程序員的話來說：“軟件的複雜性大多源自試圖兩件事當一件事做。”
若耗費時間過長，你的做法很可能就是錯的
如果你不是在處理非常複雜的問題，比如處理大數據，但是程序卻要花很長時間才能加載，這時可以認為你的做法很有可能錯了。
第一次就要用最佳的方法完成
在編程時你可能會這樣想：“我知道有一個更好的做法，但是我已經開始編碼了，不想回頭重寫。”那我建議你停止編碼，改用更好的方法來完成。
遵循慣例
學習新編程語言的慣例，能夠提升閱讀用該語言編寫的代碼的速度。PEP8 是一系列編寫Python代碼的指南，強烈建議閱讀，可前往https://www.python.org/dev/peps/ pep-0008/查看。
使用強大的IDE
到目前為止，我們一直使用的是Python自帶的IDE——IDLE來編碼。但是IDLE只是眾多可選IDE中的一個，而且我也不推薦長期使用它，因為其功能有限。例如，如果使用更強大的IDE打開Python項目，每個Python文件都會有不同的選項卡。在IDLE中則是每個文件新開一個窗口，操作煩瑣且文件之間來回切換困難。
筆者使用JetBrains公司開發的一款名為PyCharm的IDE。他們提供了免費版和專業版兩個版本，這款IDE有如下特性能夠幫助我們節省時間。
1．如果想查看某個變量、函數或對象的定義，PyCharm提供了一個快捷方式，可以跳轉到定義變量、函數或對象的地方（即使是另外一個文件）。PyCharm還提供了跳回開始頁面的快捷方式。
2．PyCharm有保存本地歷史的特性，可以極大提升工作效率。PyCharm會在每次項目出現變動時保存一份，因此可以不推送到代碼庫，就能將PyCharm當做一個本地版的版本管理系統。用戶不需要做任何操作，IDE將自動保存。在我瞭解該特性之前，我經常會在解決問題後，想要換一種方案，但是不久後又希望回滾到原方案。如果我不把原方案推送到Github，很可能早就遺失了，不得不重新編寫。但是有了這個特性，我們就能回滾到10分鐘前，然後重新載入當時的項目狀態。如果又改變主意，也可以隨意地在不同方案之前來回切換。
3．在日常工作過程中，很可能要經常複製粘貼代碼。在PyCharm中，不需要複製粘貼，在當前界面上直接移動代碼即可。
4．PyCharm支持Git和SVN等版本控制系統。無須使用命令行，即可直接在PyCharm中使用Git。在IDE和命令行之間切換次數越少，工作效率越高。
5．PyCharm提供了內置的命令行和Python Shell。
6．PyCharm內置了調試器（debugger）。調試器是支持中斷代碼執行，逐行查看代碼效果的程序。通過調試器，我們可以查看不同代碼中變量的值。
記錄日誌
記錄日誌（logging）指的是在軟件運行時記錄數據的做法。我們可通過日誌來協助程序調試，更好地瞭解程序運行時的狀態。Python自帶了一個logging日誌模塊，支持在控制檯或文件中記錄日誌。
程序出錯時，我們不希望沒有感知——我們應該記錄下相關信息，方便以後核查。記錄日誌也有助於收集和分析信息。例如，可以搭建一個Web服務器來記錄數據，包括每次收到請求的日期和時間。我們可以將所有的日誌記錄在數據庫中，編寫程序分析其中的數據，並生成圖表展示訪問網站的人次。
博客作者亨瑞克·沃納（Henrik Warne）在博客中寫過這樣一段話：“偉大程序員與平庸程序員的區別之一，就是偉大的程序員會做日誌記錄，使得出錯時的調試變得更簡單。”
測試
程序測試指的是檢查程序是否“達到了設計和開發要求，對各類輸入返回正確的結果，功能執行耗時在可接受範圍，可用性足夠高，可在目標環境下安裝和運行，並且實現了相關利益方所期待的效果。”為了進行程序測試，程序員要額外編寫程序。
在生產環境中，測試是必須完成的。對於計劃部署在生產環境的程序，我們應當認為在沒有編寫測試之前都是不完整的。但是，如果是一個不會再使用的臨時程序，測試可能有些浪費時間。如果編寫的是其他人也將使用的程序，則應該編寫測試。很多知名程序員都曾說過：“未經測試的代碼就是漏洞百出的代碼。”
代碼審查
在
代碼審查（code review）時，同事會閱讀你的代碼並提供反饋。建議儘可能多地進行代碼審查，尤其對於自學成才的程序員來說。即使你遵守了本章中所列的所有最佳實踐，也有可能存在錯誤的做法。你需要有經驗的程序員對你的代碼進行檢查，指出所犯的錯誤，這樣才有可能解決。Code Review是一個專注於代碼審查的程序員社區。任何人都可以登入該網站，提交代碼。社區的其他成員會審查代碼，並反饋做得好的地方以及可以改進的地方。
安全
對於自學的程序員來說，安全是一個很容易忽視的問題。在面試時也很少會被問到安全問題，在學習編程時我們也不會去考慮安全問題。但是，在實際工作中，我們需要對自己代碼的安全性負直接責任。本節將給出幾個提高代碼安全性的建議。
我們在本書中已經學習了使用sudo命令以根用戶的身份執行命令。非必要情況下，務必不要在命令行使用sudo執行命令，因為如果有黑客侵入程序的話，將會獲得根訪問權限。如果你是服務器管理員，還應該禁止根用戶登錄。每個黑客都會盯著根賬號，在攻擊系統時是首要選擇的目標。
另外，總是假設用戶的輸入是惡意的。部分惡意攻擊的發生，就是利用了可接受用戶輸入的程序漏洞，因此我們要假設所有的用戶輸入都是惡意的，並以此為依據進行編碼。
另一個提高代碼安全性的策略，是最小化你的攻擊面積（attack surface），即黑客可從程序中提取數據或攻擊系統的相關區域。通過最小化攻擊面積，可以減少程序出現漏洞的可能性。最小化攻擊面積的幾種常見做法包括：避免保存敏感信息，賦予用戶最低的訪問權限，儘可能少用第三方庫（代碼量越小、漏洞越少），剔除不再使用的功能代碼（代碼量越小、漏洞越少）等。
避免以根用戶身份登錄系統，不要信任用戶輸入，以及最小化攻擊面積，是確保程序安全性的幾個重要手段。但這還只是提升安全性的一小部分。我們應該試著從黑客的角度進行思考。他們會如何利用你的代碼？這樣可以幫助我們找到之前可能忽略的漏洞。有關安全的話題非常大，不是本書所能涵蓋的，因此建議大家時刻思考並學習如何提升安全性。布魯斯·舒奈爾（Bruce Schneier）對此的總結十分精闢：“安全是一種思維狀態。”
術語表
生產代碼：某個產品中被用戶使用的代碼。
生產：將軟件投入生產，指的是對外正式發佈。
DRY：一個編程原則，“不要重複自己”的英文簡稱。
正交性：該術語已經被用來表示某種獨立性或解耦化。如果兩個或多個事物之間的變化不會相互影響，那麼它們之間就存在正交性。在設計優良的系統中，數據庫代碼與用戶界面之間是正交的；調整用戶界面不會影響數據庫，替換數據庫也不會改變用戶界面。
調試器：調試器是支持中斷代碼執行，可逐行查看代碼效果的程序。通過調試器，我們可以查看不同代碼中變量的值。
日誌記錄 ：指的是在軟件運行時記錄數據的做法。
測試：檢查程序是否“達到了設計和開發要求，對各類輸入返回正確的結果，功能執行耗時在可接受範圍，可用性足夠高，可在目標環境下安裝和運行，且實現了相關利益方所期待的效果。”
代碼審查：他人閱讀你的代碼並給予反饋的過程。
攻擊面積：黑客可從程序中提取數據或攻擊系統的相關區域。
02《Python編程無師自通》
在美國亞馬遜，有一本書的影響力超高的Python入門書，Kindle版本在美國亞馬遜網站的計算機軟件、軟件開發分類中排行均為第一，超越了眾多實力派Python書，眾多五星好評。也許你有所耳聞，這本書就是《Python編程無師自通——專業程序員的養成》
《Python編程無師自通——專業程序員的養成》作者是一名自學成才的程序員，作為一名文科生他通過自學編程，掌握了編程技能並在eBay找到了一份軟件工程師的工作。這本書是作者結合個人經驗寫作而成，旨在幫助讀者從外行成長為一名專業的Python程序員。
這本書可以滿足幾乎所有想要學習編程的初學者 。本書適合高中、大學階段想要自學編程的學生，以及其他行業想入門編程的人，同時也適合作為編程入門的培訓教材。
《Python編程無師自通——專業程序員的養成》 每章結尾處都有術語表和挑戰練習，讓你更好地學習Python 3。
目錄一覽
第1章 概述
第2章 起步
第3章 編程概論
第4章 函數
第5章 容器
第6章 字符串操作
第7章 循環
第8章 模塊
第9章 文件
第10章 綜合練習
第11章 練習
第二部分 面對對象編程簡介
第12章 編程範式
第13章 面向對象編程的四大支柱
第14章 深入面向對象編程
第15章 綜合練習
第三部分 編程工具簡介
第16章 Bash
第17章 正則表達式
第18章 包管理器
第19章 版本控制
第20章 融會貫通
第四部分 計算機科學簡介
第21章 數據結構
第22章 算法
第五部分 找到工作
第23章 最佳編程實踐
第24章 第一份編程工作
第25章 團隊協作
第26章 更多學習資料
第27章 下一步
書單推薦
作者：【美】Al Sweigart（斯維加特）
Python編程快速上手——讓繁瑣工作自動化
作者：[美] 澤德 A. 肖（Zed A. Shaw）
“笨辦法”學Python
作者：【美】Kenneth A. Lambert（蘭伯特）
數據結構（Python語言描述）
作者：【美】Wesley Chun（衛斯理 春）
Python核心編程（第3版）
Python編程從入門到精通
閱讀更多 幻風的AI之路 的文章
