自己创建Python库

自己创建Python库

写法模板

​ 我们直接介绍正规写一个Python库的模板是什么，假设我们要创建一个名为 mylib 的简单库，它的目录结构可能如下所示：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
mylib/
    mylib/
        __init__.py
        module1.py
        module2.py
    tests/
        __init__.py
        test_module1.py
        test_module2.py
    setup.py
    README.md
    requirements.txt
    LISCENCE
    pyprojects.toml 
    .gitignore

  • mylib/：主模块目录，包含了库的所有核心代码

  • __init__.py：这个文件告诉Python解释器该目录是一个Python包。你还可以在这个文件中定义包级别的变量或函数，或者通过导入子模块来公开特定的功能

  • module1.py：包含库的一个模块。例如，它可能包含一组相关的函数或类

  • module2.py：另一个模块，类似地包含一组相关的功能

  • tests/：这个目录用来存放所有测试文件

  • __init__.py：同样是一个包标识文件，但在这个例子中，它标记 tests 为一个包

  • test_module1.py：包含针对 module1.py 中功能的单元测试

  • test_module2.py：包含针对 module2.py 中功能的单元测试

  • setup.py：库的配置文件，用于打包和发布。它包含了库的基本信息以及如何构建、测试和安装的指令

  • pyproject.toml ：一个配置文件，最初由 PEP 518 引入，用于描述构建系统的要求，并且可以包含其他工具的配置信息

  • LICENSE ：文件包含了项目的许可信息，告诉其他人他们可以如何使用、复制和修改你的代码。常用的许可证类型包括 MIT 许可证、Apache 许可证、GPLv3 许可证等（这个文件可选可不选）