首頁 > 軟體

python生產環境禁用assert斷言的方法

2022-06-09 14:01:55

1. 背景

在潛意識中, assert 是應用在unittest或pytest環境中, 不能應用到業務程式碼中, 因為斷言會導致執行中斷,對業務有損,並且消耗記憶體, 影響效能.

但不可否認, 使用斷言非常方便偵錯程式碼

通過研讀assert的檔案, 發現斷言是可以被關閉的,特此記錄下

詳細的介紹參考這個檔案: 參考這篇檔案

2.解決方案

2.1 禁用assert的策略

有兩種方案

  1. 啟動命令列的引數中,新增-O, 也就是大寫的o
  2. 設定PYTHONOPTIMIZE環境變數為合適的值

2.2 禁用的原理

在python 內部機制中, 有一常數__debug__,值為BOOL型別的, 與斷言是強關聯的, 因為__debug__是常數, 所以當python 直譯器執行時, 不能修改它的值.

Python 3.8.13 (default, Mar 28 2022, 06:16:26) 
[Clang 12.0.0 ] :: Anaconda, Inc. on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> __debug__
True
>>> __debug__ = False
  File "<stdin>", line 1
SyntaxError: cannot assign to __debug__
>>> 

既然執行時不能修改, 那沒有執行時可以修改嗎?當然可以的, 這取決於python 執行模式,python執行模式有兩種,和__debug__的關係如下表所示:

ModeValue of debug
Normal (or debug)(偵錯模式)True
Optimized(優化模式)False

那__debug__的值和斷言有什麼關係呢?

看原始碼:

if __debug__:
    if not expression:
        raise AssertionError(assertion_message)

所以__debug__==True時會丟擲斷言異常, __debug__==False時就啥也不幹,跳過了

這下清晰了

3. 實施禁用策略

3.1 啟動命令列的引數中,新增-O

驗證方案:

1、先寫這樣一個測試指令碼,命名為demo.py

# demo.py
print(f"__debug__=={__debug__}"

2、在命令列使用 禁用斷言的啟動方式

python -O demo.py

輸出結果

__debug__==False

輔助理解: 在命令列中執行python -h,其結果也體現了這樣的使用方式

mac$ python -h
usage: python [option] ... [-c cmd | -m mod | file | -] [arg] ...
Options and arguments (and corresponding environment variables):
-b     : issue warnings about str(bytes_instance), str(bytearray_instance)
         and comparing bytes/bytearray with str. (-bb: issue errors)
-B     : don't write .pyc files on import; also PYTHONDONTWRITEBYTECODE=x
-c cmd : program passed in as string (terminates option list)
-d     : debug output from parser; also PYTHONDEBUG=x
-E     : ignore PYTHON* environment variables (such as PYTHONPATH)
-h     : print this help message and exit (also --help)
-i     : inspect interactively after running script; forces a prompt even
         if stdin does not appear to be a terminal; also PYTHONINSPECT=x
-I     : isolate Python from the user's environment (implies -E and -s)
-m mod : run library module as a script (terminates option list)
-O     : remove assert and __debug__-dependent statements; add .opt-1 before
         .pyc extension; also PYTHONOPTIMIZE=x
-OO    : do -O changes and also discard docstrings; add .opt-2 before
         .pyc extension
-q     : don't print version and copyright messages on interactive startup
-s     : don't add user site directory to sys.path; also PYTHONNOUSERSITE
-S     : don't imply 'import site' on initialization
-u     : force the stdout and stderr streams to be unbuffered;
         this option has no effect on stdin; also PYTHONUNBUFFERED=x
-v     : verbose (trace import statements); also PYTHONVERBOSE=x
         can be supplied multiple times to increase verbosity
-V     : print the Python version number and exit (also --version)
         when given twice, print more information about the build
-W arg : warning control; arg is action:message:category:module:lineno
         also PYTHONWARNINGS=arg
-x     : skip first line of source, allowing use of non-Unix forms of #!cmd
-X opt : set implementation-specific option. The following options are available:

         -X faulthandler: enable faulthandler
         -X showrefcount: output the total reference count and number of used
             memory blocks when the program finishes or after each statement in the
             interactive interpreter. This only works on debug builds
         -X tracemalloc: start tracing Python memory allocations using the
             tracemalloc module. By default, only the most recent frame is stored in a
             traceback of a trace. Use -X tracemalloc=NFRAME to start tracing with a
             traceback limit of NFRAME frames
         -X showalloccount: output the total count of allocated objects for each
             type when the program finishes. This only works when Python was built with
             COUNT_ALLOCS defined
         -X importtime: show how long each import takes. It shows module name,
             cumulative time (including nested imports) and self time (excluding
             nested imports). Note that its output may be broken in multi-threaded
             application. Typical usage is python3 -X importtime -c 'import asyncio'
         -X dev: enable CPython's "development mode", introducing additional runtime
             checks which are too expensive to be enabled by default. Effect of the
             developer mode:
                * Add default warning filter, as -W default
                * Install debug hooks on memory allocators: see the PyMem_SetupDebugHooks() C function
                * Enable the faulthandler module to dump the Python traceback on a crash
                * Enable asyncio debug mode
                * Set the dev_mode attribute of sys.flags to True
                * io.IOBase destructor logs close() exceptions
         -X utf8: enable UTF-8 mode for operating system interfaces, overriding the default
             locale-aware mode. -X utf8=0 explicitly disables UTF-8 mode (even when it would
             otherwise activate automatically)
         -X pycache_prefix=PATH: enable writing .pyc files to a parallel tree rooted at the
             given directory instead of to the code tree

--check-hash-based-pycs always|default|never:
    control how Python invalidates hash-based .pyc files
file   : program read from script file
-      : program read from stdin (default; interactive mode if a tty)
arg ...: arguments passed to program in sys.argv[1:]

Other environment variables:
PYTHONSTARTUP: file executed on interactive startup (no default)
PYTHONPATH   : ':'-separated list of directories prefixed to the
               default module search path.  The result is sys.path.
PYTHONHOME   : alternate <prefix> directory (or <prefix>:<exec_prefix>).
               The default module search path uses <prefix>/lib/pythonX.X.
PYTHONCASEOK : ignore case in 'import' statements (Windows).
PYTHONUTF8: if set to 1, enable the UTF-8 mode.
PYTHONIOENCODING: Encoding[:errors] used for stdin/stdout/stderr.
PYTHONFAULTHANDLER: dump the Python traceback on fatal errors.
PYTHONHASHSEED: if this variable is set to 'random', a random value is used
   to seed the hashes of str and bytes objects.  It can also be set to an
   integer in the range [0,4294967295] to get hash values with a
   predictable seed.
PYTHONMALLOC: set the Python memory allocators and/or install debug hooks
   on Python memory allocators. Use PYTHONMALLOC=debug to install debug
   hooks.
PYTHONCOERCECLOCALE: if this variable is set to 0, it disables the locale
   coercion behavior. Use PYTHONCOERCECLOCALE=warn to request display of
   locale coercion and locale compatibility warnings on stderr.
PYTHONBREAKPOINT: if this variable is set to 0, it disables the default
   debugger. It can be set to the callable of your debugger of choice.
PYTHONDEVMODE: enable the development mode.
PYTHONPYCACHEPREFIX: root directory for bytecode cache (pyc) files.

5: 新的需求: 怎麼在命令列中禁用斷言,看下面的對比程式碼:

最關鍵是修改__debug__的值

(sse38) lzh mac$ python
Python 3.8.13 (default, Mar 28 2022, 06:16:26) 
[Clang 12.0.0 ] :: Anaconda, Inc. on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> __debug__
True
>>> exit()
(sse38) lzh mac$ python -O
Python 3.8.13 (default, Mar 28 2022, 06:16:26) 
[Clang 12.0.0 ] :: Anaconda, Inc. on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> __debug__
False
>>> 

3.2 設定PYTHONOPTIMIZE環境變數

這部分是在命令列中操作的

mac or linux 系統中,

(sse38)  mac$ export PYTHONOPTIMIZE=0
(sse38)  mac$ python demo.py
True
(sse38)  mac$ export PYTHONOPTIMIZE=1
(sse38)  mac$ python demo.py
False
(sse38)  mac$ export PYTHONOPTIMIZE=2
(sse38)  mac$ python demo.py
False

window 系統中,

(sse38)  mac$ set PYTHONOPTIMIZE=0
(sse38)  mac$ python demo.py
True
(sse38)  mac$ set PYTHONOPTIMIZE=1
(sse38)  mac$ python demo.py
False
(sse38)  mac$ set PYTHONOPTIMIZE=2
(sse38)  mac$ python demo.py
False

4 使用斷言的坑

處理或驗證資料

處理異常和異常

執行常有副作用的操作

到此這篇關於python生產環境禁用assert斷言的文章就介紹到這了,更多相關python禁用assert斷言內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com!


IT145.com E-mail:sddin#qq.com