停止使用非版本控制的可執行代碼

来源:https://www.cnblogs.com/thomaszdxsn/archive/2019/03/28/stop-using-executable-code-outside-version-control.html
-Advertisement-
Play Games

開發世界現在有很多反設計模式的開發方式,比如使用可執行代碼文件作為配置文件。 ...


https://www.pydanny.com/using-executable-code-outside-version-control.html

開發世界現在有很多反設計模式的開發方式,比如使用可執行代碼作為配置文件。

在Python世界裡面,你很可能碰到過類似下麵的代碼:

# 警告:這是反模式代碼!
try:
    from .local_settings import *
except ImportError:
    pass

一般來說,人們會在local_settings.py文件中加入一些配置變數,然後加入到.gitignore裡面。因此,本地開發環境,你的項目需要一個脫離版本控制的可執行代碼文件。

如果你覺得不對勁,那麼你走在正確的道路上。可執行代碼就應該總是處於版本控制中。

另一個更好的方式是,把secrets和key等配置放在環境變數裡面。如果你不喜歡這種方式,或者因為環境的原因不可以這麼做,仍然可以把配置放在JSON, YAML, TOML文件裡面。

local_settings這種反模式

local_settings是反模式,是因為你生產環境的可執行代碼,不能被開發者看到,也讓他們不好debug解決問題。可能你還沒有這種體驗,但這確實是最糟糕的調試噩夢之一。

它在我的筆記本上運行良好!

有時候,在開發和測試中沒有發現一些細微的bug,發現的時候已經太晚了。

下麵是一個真實的例子,來自於去年我幫客戶解決的問題:

  1. 項目使用第三方庫做slug。配置放在settings中。
  2. 開發者決定自己編寫slug項目。在本地運行良好。
  3. 測試沒有加入新的testcase,測試那些邊角案例。
  4. 在本地開發環境,staging環境,甚至生產環境都看起來運行正常。
  5. 幾天之後,一些特定地區的用戶報告說,一些記錄不可以訪問。
  6. 沒人知道為什麼生產環境會出現這個問題。

然後我介入了。首先我就註意到,settings文件裡面有下麵這種代碼:

# 警告:這是反模式代碼!
try:
    from .local_settings import *
except ImportError:
    pass

他們在版本控制之外還有可執行代碼。這也是為什麼在開發環境有效,但是在其它環境有問題。即使這個微妙的bug,已經通過了常規的測試。但是,進入生產環境之後,這個bug就會被用戶發現。

然後,最糟糕的是,這個bug在第一時間幾乎不可能被髮現,因為開發者的local_settings.py的值是正確的。

但是我不會犯這種錯誤!

人們一般會氣憤地說,“我不像你那麼蠢,我不會犯這種錯誤。“

是的,最近20年我也只碰到去年這一次因為這個原因造成的bug。

但是我相信,不管程式員都沒天才,多麼有經驗,都無可避免會犯一些愚蠢的錯誤。這是為什麼一些好的程式員/工程師都會遵循一個很好的習慣 -- 在犯了愚蠢錯誤的時候,能夠快速捕獲。如果你認為自己能夠完全避免這種錯誤,我只能說你太年輕了。

回到正題,為什麼一定要把配置放在可執行文件里?你可以將它們放在環境變數,或者配置文件。所以,爭論結束!

如何處理環境特有變數

使用環境變數,或者配置文件!

你可以使用第三方庫。我個人喜歡使用django中自帶的功能.

import os

from django.core.exceptions import ImproperlyConfigured


def get_env_var(var_name):
    try:
        return os.environ[var_name]
    except KeyError:
        error_msg = f"Set the {var_name} environment variable"
        return ImproperlyConfigured(error_msg)
        
SECRET_KEY = get_env_var('SECRET_KEY')

您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 一般公司的項目一般都是用Oracle、Mysql、SQL Server等一些國外的資料庫。前段時間公司做了一個國家政府保密單位的項目,別人要求用國產資料庫,所以研究了下,最後決定用神舟通用的,其實國產也很好幾家做資料庫的還不錯,下邊簡單總結了下,以供參考 1:南大通用 公司簡介 天津南大通用數據技術 ...
  • 題目如下。解題步驟參考的是https://cloud.tencent.com/developer/news/373865中作者的思路。 1.首先,兩個四位數相加等於一個五位數,那麼這個五位數的第一位必定是1,也就是“三”=1,。 2.繼續分析“祥”+“三”,若是“祥”(8),“三”為1,那麼低位必定 ...
  • JDBC的使用流程,通過JDBC進行對資料庫增刪改查的操作及代碼封裝。 ...
  • 題意 "題目鏈接" Sol 我們可以把圖行列拆開,同時對於行/列拆成很多個聯通塊,然後考慮每個點所在的行聯通塊/列聯通塊的貢獻。 可以這樣建邊 從S向每個行聯通塊連聯通塊大小條邊,每條邊的容量為1,費用為$i$(i表示這是第幾條邊)。 從每個點所在的行聯通塊向列聯通塊連邊,容量為1,費用為0 從每個 ...
  • 想要熟練使用PyQt,還是需要深入研究下這個庫的使用,筆者這裡只是拋磚引玉。 關註公眾號「**Python專欄**」,後臺回覆:**zsxq06**,獲取本文全套代碼。 ...
  • python讀取大文件 1. 較pythonic的方法,使用with結構 文件可以自動關閉 異常可以在with塊內處理 <! more 最大的優點 :對可迭代對象 f,進行迭代遍歷:for line in f,會自動地使用緩衝IO(buffered IO)以及記憶體管理,而不必擔心任何大文件的問題。 ...
  • 一、簡要說明 開篇說明 其實吧這是我人生中寫的第一篇博客,我也不知道怎麼排版和編輯讓博文顯示的更加美觀,現在正在學Markdown編輯語法,也是剛剛學編程的一個小菜鳥,目前是大二的在校生,我的初衷是把我平時所學的知識都像做筆記一樣寫下來,讓以後在學習更多知識的時候回來一看,舊的知識就可以鞏固回來了, ...
  • ArrayList ArrayList 是通過一個數組來實現的,因此它是在連續的存儲位置存放對象的引用,只不過它比 Array 更智能,能夠根據集合長度進行自動擴容。 假設讓我們來實現一個簡單的能夠自動擴容的數組,我們最容易想到的點就是: 實際上,ArrayList的內部實現原理也是這樣子,我們可以 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...