程序師世界是廣大編程愛好者互助、分享、學習的平台,程序師世界有你更精彩!
首頁
編程語言
C語言|JAVA編程
Python編程
網頁編程
ASP編程|PHP編程
JSP編程
數據庫知識
MYSQL數據庫|SqlServer數據庫
Oracle數據庫|DB2數據庫
您现在的位置: 程式師世界 >> 編程語言 >  >> 更多編程語言 >> Python

python 在生產環境禁用assert斷言

編輯:Python

文章目錄

  • 1. 背景
  • 2.解決方案
    • 2.1 禁用assert的策略
    • 2.2 禁用的原理
  • 3. 實施禁用策略
    • 3.1 啟動命令行的參數中,添加`-O`
    • 3.2 設置`PYTHONOPTIMIZE`環境變量
  • 4 使用斷言的坑

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 debugNormal (or debug)(調試模式)TrueOptimized(優化模式)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__}"
  1. 在命令行使用 禁用斷言的啟動方式
    python -O demo.py
  2. 輸出結果
__debug__==False
  1. 輔助理解: 在命令行中運行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 使用斷言的坑

處理或驗證數據
處理異常和異常
運行時伴有副作用的操作


  1. 上一篇文章:
  2. 下一篇文章:
Copyright © 程式師世界 All Rights Reserved