首页 > 解决方案 > 创建python包的最佳编码实践是什么

问题描述

我正在创建pypipython 包,为此我厌倦了在不同网站上提供的许多解决方案。

  1. 首先,我遵循了这个Approach1,在这个方法中作者已经创建了classfunctions但是当尝试这个时,我的包给了我一个错误,no module并且class name is not define
  2. 我厌倦了许多其他方法,比如这种方法2,作者在这种方法中只创建了functions没有class__init__.py
  3. 然后尝试了这个也很常见的方法3

这是pypi官方提供的重要文件结构

├── LICENSE
├── README.md
├── example_pkg
│   └── __init__.py
├── setup.py
└── tests

我已经准备好我的包裹,但是在花了一整夜找到最佳编码实践之后?现在很困惑

所以我的问题如下

  1. 文件有什么用__init__.py
  2. 给出目录、类和函数名称的最佳实践,以便在导入过程中有所帮助。因为根据这些答案,有些人说导入目录名称,有些人说文件名后跟类等。
  3. 任何人都可以为我提供适当的步骤,以便我也可以在即将推出的包裹中跟进

标签: python-3.xpippackagepypi

解决方案


我建议遵循https://packaging.python.org上的 Python Packaging Authorities 指南和教程。

此外,PyPA 发布了一个示例项目框架,您可以将其用作起点:https ://github.com/pypa/sampleproject/


推荐阅读