如何检查Python函数内所有变量为局部变量？是否有相关工具？

手动检查方法 #

• 逐行审阅代码：直接核对每个用到的变量——要么是函数的入参，要么是在函数内部通过赋值语句定义的。如果出现global或nonlocal声明的变量，这类不属于局部变量，需排除在外。
• 利用函数内置属性：每个函数都自带__code__属性，其中的几个字段能帮你快速甄别变量作用域：
  • co_varnames：包含函数的所有局部变量（包括参数）
  • co_names：包含函数中引用的全局名称（比如自定义全局变量、内置函数）
  • co_freevars：包含闭包引用的外层作用域变量
    示例代码：

  def calc(x):
      y = 2
      return x * y
  
  print(calc.__code__.co_varnames)  # 输出 ('x', 'y')，均为局部变量
  print(calc.__code__.co_names)     # 输出空元组，说明未引用自定义全局变量
  

• 反汇编字节码：用dis模块查看函数的字节码，如果出现LOAD_GLOBAL指令，且对应的名称不是Python内置工具（比如print、len），就说明函数引用了全局变量：

  import dis
  dis.dis(calc)
  

可用工具 #

• pylint：自动检测函数中未声明的全局变量、未定义的变量，以及不合理的作用域使用。比如规则W0602会提示"Using global variable 'xxx' without declaring"，W0621会提示变量重定义了外层作用域的名称。
• flake8：配合flake8-bugbear插件，可检测作用域相关问题，比如函数引用了外层变量却未加nonlocal声明。
• mypy：开启严格模式（--strict）后，会强制要求变量有明确的作用域，未在局部定义或作为参数的变量会被标记为错误。
• 自定义AST分析脚本：用Python的ast模块编写小工具，遍历函数的抽象语法树，收集所有局部赋值的变量和参数，再对比函数中所有引用的变量，即可找出非局部变量。

内容的提问来源于stack exchange，提问作者Yandle