重命名 python 子包，将旧名称标记为已弃用

我有一个 python 包，它具有以下目录结构

package/
├── __init__.py
└── subpackage_A/
    ├── __init__.py
    ├── moduleA.py
    └── moduleB.py

现在我想更改名称subpackage_A to subpackage_B同时保持旧名称可用，否则很多脚本都会崩溃。所以这应该是可能的：

from package.subpackage_B import moduleA
from package.subpackage_B.moduleB import ClassB

# This should, if possible, display a deprecation warning
from package.subpackage_A import moduleA

我尝试简单地将新包导入名为的模块中subpackage_A，但这不起作用：

# File: package/subpackage_A.py
# This does not work:
from package.subpackage_B import *  # Import everything from the new module

# This is also not working:
sys.modules[__name__] = __import__('package.subpackage_A')

第一个版本导致ModuleNotFoundError如果脚本尝试导入moduleA从旧位置：

from package.subpackage_A import moduleA

Traceback (most recent call last):
...
ModuleNotFoundError: No module named 'package.subpackage_A.moduleA'

如何在不破坏向后兼容性的情况下重命名模块？该解决方案应适用于 python 3.5 及更高版本。

如果您使用的是 Python 3.7+，则可以使用模块级别__getattr__s 定义于PEP562 https://www.python.org/dev/peps/pep-0562/.

您可以将 subpackageA 重命名为 subpackageB，然后在您的package/__init__.py有类似下面的内容

from . import subpackageB
from warnings import warn

def __getattr__(name):
    if name == 'subpackageA':
        warn('subpackageA has been renamed to subpackageB')
        return subpackageB
    raise AttributeError('No module named ' + name)

然后当使用你的包时

>>> from package import subpackageB
>>> from package import subpackageA
/path/to/package/__init__.py:5: UserWarning: subpackageA has been renamed subpackageB
  warn('subB has been renamed subA')
>>> subpackageA == subpackageB
true
>>>