Python 3.6以下版本变量注解语法报错的解决办法咨询

问题场景 #

为了获得IDE自动补全，我使用了PEP-0526定义的变量注解语法：

status_dict : dict = result.get('status', {})

这段代码在Python 3.6及以上版本运行正常，但在更低版本（如Python 2.6、3.5及以下）中会直接抛出语法错误：

File "/home/marcel/work/py/svn_utils.py", line 261
    status_dict : dict =  svn_result.get('status', {})
                ^
SyntaxError: invalid syntax

我曾尝试在脚本开头添加版本检查：

import sys
MIN_PYTHON = (2, 6)
if sys.version_info < MIN_PYTHON:
    sys.exit("Python %s.%s or newer is required.\n" % MIN_PYTHON)

但由于Python会先完成整个脚本的语法解析再执行代码，版本检查代码根本没机会运行就会报错。目前能想到的办法是用包装脚本做前置版本检查，但希望找到无需额外脚本的解决方案。

可行解决方案 #

1. 改用注释形式的类型标注（推荐） #

放弃PEP-0526的变量注解语法，改用PEP 484定义的注释式类型标注。这种写法在旧Python版本中只会被当作普通注释，不会触发语法错误，同时IDE依然能识别类型并提供自动补全：

# 写法1：注释单独一行
# type: dict
status_dict = result.get('status', {})

# 写法2：注释跟在赋值语句后
status_dict = result.get('status', {})  # type: dict

2. 使用类型存根文件 #

如果不想修改主代码的赋值逻辑，可以创建类型存根文件（.pyi）来单独定义变量类型。

• 主代码中只保留赋值语句：

  status_dict = result.get('status', {})
  

• 在同目录下创建与脚本同名的.pyi文件（比如脚本是svn_utils.py，存根文件就是svn_utils.pyi），在其中定义变量类型：

  status_dict: dict
  

IDE会读取存根文件识别类型，而旧版本Python运行主代码时完全不会接触到存根文件，自然不会有语法问题。

3. 动态执行兼容代码块 #

通过版本判断，在Python 3.6+环境下执行带变量注解的代码，旧环境下执行普通赋值语句，同时用注释保证IDE补全：

import sys

if sys.version_info >= (3, 6):
    exec("status_dict : dict = result.get('status', {})")
else:
    status_dict = result.get('status', {})
    # type: dict  # 让IDE识别类型

这种方式能保留高版本的原生变量注解，但代码可读性稍差，适合必须保留注解语法的场景。

注意事项 #

PEP-0526的变量注解没有对应的__future__导入支持，无法通过from __future__ import xxx的方式让旧版本提前兼容该语法，所以这种方法不可行。

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