如何创建 Python 库(二)

第 3 步:创建文件夹结构

这一步,也就是创建我们开发库所需要的文件。

在 Pycharm 中,打开您的文件夹 mypythonlibrary(或你自己创建的文件夹名称)。它应该是这样的:

如何创建 Python 库(二)

你现在可以开始向项目添加文件夹和文件。您可以通过命令提示符或在 Visual Studio Code 本身中执行此操作。


1.创建一个名为 setup.py 这是创建 Python 库时最重要的文件之一!

2.创建一个名为 README.md 你可以在此处编写 Markdown 以向其他用户描述我们的库内容。

3.创建一个名为 mypythonlib ,或者任何您希望在 pip 安装时调用 Python 库的文件夹。(如果你想稍后发布它,该名称在 pip 上应该是唯一的。)

4.在 mypythonlib 文件夹里面,创建名为 __init__.py 基本上,任何包含文件的 __init__.py 文件夹,在我们构建库的时候,包含在库中。大多数情况下,您可以将 __init__.py 文件留空,也就是不用写代码。导入时,其中的 __init__.py 将被执行,因此它应该只包含能够运行您的项目所需的最少量代码。现在,我们将保持原样。

5.此外,在 mypythonlib 文件夹中,创建一个名为 myfunctions.py

6.最后,在您的根文件夹中创建一个文件夹测试。在里面,创建一个空 __init__.py 文件和一个空的 test_myfunctions.py

你所创建的文件夹和代码文件,现在应如下所示:

如何创建 Python 库(二)


第 4 步:为您的库创建内容

要将函数放入库中,您可以将它们放入 myfunctions.py 文件中。例如,复制文件中的 hasrsine 函数:

如何创建 Python 库(二)

这个函数将给出两个纬度和经度点之间的距离,单位为米。

每当您编写任何代码时,都强烈建议同时为该代码编写测试。对于 Python 测试,可以使用 pytest 和 pytest-runner 库。在虚拟环境中安装库:

如何创建 Python 库(二)

让我们为 haversine 函数创建一个小测试。复制以下内容并将其放入 test_myfunctions.py 文件中:

如何创建 Python 库(二)

最后,让我们创建一个 setup.py 文件,它将帮助我们构建库。setup.py 的内容如下所示:

如何创建 Python 库(二)


上一篇:《Linux From Scratch》第三部分:构建LFS系统 第七章:基本系统配置- 7.2. 通用网络配置


下一篇:Dubbo 源码分析 - SPI 机制