首页 > 后端开发 > Python教程 > 如何在不使用'sys.path”黑客的情况下有效地在 Python 中导入同级包?

如何在不使用'sys.path”黑客的情况下有效地在 Python 中导入同级包?

Barbara Streisand
发布: 2024-12-14 15:54:11
原创
469 人浏览过

How Can I Effectively Import Sibling Packages in Python Without Using `sys.path` Hacks?

同级包导入

简介

集成同级包并从不同目录执行脚本可能具有挑战性。本指南提供了一个详细的解决方案,可以避免臭名昭著的 sys.path 黑客攻击。

设置

考虑以下目录结构:

├── LICENSE.md
├── README.md
├── api
│   ├── __init__.py
│   ├── api.py
│   └── api_key.py
├── examples
│   ├── __init__.py
│   ├── example_one.py
│   └── example_two.py
└── tests
│   ├── __init__.py
│   └── test_one.py
登录后复制

解决方案

第 1 步:创建 pyproject.toml文件

在根目录中,创建一个 pyproject.toml 文件,其中包含以下最少内容:

[project]
name = "myproject"
version = "0.1.0"
description = "My small project"

[build-system]
build-backend = "flit_core.buildapi"
requires = ["flit_core >=3.2,<4"]
登录后复制

步骤 2:使用虚拟环境(推荐)

创建并激活虚拟环境以实现隔离和依赖

第 3 步:安装您的项目

使用 pip 以可编辑状态安装项目:

pip install -e .
登录后复制

第 4 步:添加我的项目。前缀

在相对或绝对导入失败的导入中,将 myproject 前缀添加到导入语句中:

from myproject.api.api import function_from_api
登录后复制

代码示例

api.py:

def function_from_api():
    return 'I am the return value from api.api!'
登录后复制

test_one.py:

from myproject.api.api import function_from_api

def test_function():
    print(function_from_api())

if __name__ == '__main__':
    test_function()
登录后复制

运行测试

导航到测试目录并执行test_one.py:

python .\myproject\tests\test_one.py
登录后复制

结论

此解决方案提供了一种干净且可移植的方式来导入兄弟包,而无需 sys.path 操作。通过利用 pyproject.toml 并可编辑地安装项目,您可以确保对脚本的更改自动反映在已安装的包中。这种方法简化了开发并简化了项目管理。

以上是如何在不使用'sys.path”黑客的情况下有效地在 Python 中导入同级包?的详细内容。更多信息请关注PHP中文网其他相关文章!

来源:php.cn
本站声明
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
作者最新文章
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板