Skip to main content
 首页 » 编程设计

python之如何创建具有顶层函数的 PyPi 包

2024年11月24日8youxin

我正在尝试在 PyPi 上安装一个包,但无法将其配置为具有所需的语法。最后,我希望能够使用以下语法在我的模块中使用一个函数:

import ucal 
ucal.calculate(...) 

此语法遵循所有公共(public)库。 (也可以使用 from ucal import calculate)。

我的目录结构如下:

ucal/ 
    ucal/ 
        __init__.py 
        ucal.py 
        ucal_units.py 
    setup.py 

在 ucal.py 中:

   import ucal_units 
   def calculate(): 
       pass 

我可以上传到 PyPi,然后使用 pip 安装:

> python setup.py bdist_wheel 
> python -m twine upload dist/ucal-0.1.3-py3-none-any.whl 
(wait a minute) 
> pip install --user ucal 

但是,在新脚本中,以下脚本会产生错误:

import ucal 
ucal.calculate() # <-- AttributeError: module 'ucal' has no attribute 'calculate' 

事实证明这是可行的:

from ucal import ucal 
ucal.calculate() 

但我不想要这种愚蠢的语法。 ucal 应该在顶层。我需要进行哪些更改才能使所需的语法正常工作?

我尝试将 ucal/ucal 中的所有文件移动到父目录,但这导致了 ModuleNotFoundError: No module named 'ucal' 即使模块已安装(使用 pip 列表验证)

请您参考如下方法:

在 ucal/ucal.py 中,使用 __all__ 声明要导出的公共(public)名称变量:

# ucal/ucal.py 
 
__all__ = ["calculate"] 
 
def calculate(...): 
    ... 

在 ucal/__init__.py 中,使用 * 导入将这些名称拉入顶级命名空间:

# ucal/__init__.py 
 
from ucal.ucal import * 

现在,用户将在顶级命名空间中看到calculate。