清洁Python导入语句

Question

我为REST API创建了一个Python包装器。 API有很多端点，因此我为每个端点创建了一个文件。

总体上的想法是，用户可以这样做，

from my_package import Client
from my_package.endpoints import Users

prod = Client("myhostname.com", "Username", "Password")
all_users = Users(prod).list()

我的软件包的文件当前是这样的，

my_project/
 └-- my_package/
 |    └-- __init__.py
 |    └-- client.py
 |    └-- const.py
 |    └-- endpoints/
 |        └-- __init__.py
 |        └-- contracts.py
 |        └-- credits.py
 |        └-- payments.py
 |        └-- users.py
 └-- setup.cfg
 └-- readme.md
 └-- pyproject.toml

# my_package/__init__.py
from my_package.client import Client

# my_package/endpoints/__init__.py
from my_package.endpoints.contracts import Contracts
from my_package.endpoints.creditsimport Credits
from my_package.endpoints.paymentsimport Payments
from my_package.endpoints.usersimport Users

现在问题是，当您导入时，通过Intellisense为您提供了许多重复。

from my_package.endpoints import contracts
                                 Contracts
                                 credits
                                 Credits
                                 payments
                                 Payments
                                 users
                                 Users

我该如何清理？

Answer 1

我认为这是正确的行为。为了将IntelliSense建议仅减少到类名称，您需要将模块移至另一个软件包。

例如

my_project/
 └-- my_package/
      └-- __init__.py
      └-- client.py
      └-- api
      |   └-- endpoints.py
      └-- endpoints/
          └-- __init__.py
          └-- contracts.py
          └-- credits.py
          └-- payments.py
          └-- users.py

# my_package/endpoints/__init__.py

# my_package/api/endpoints.py
from my_package.endpoints.contracts import Contracts
from my_package.endpoints.creditsimport Credits
from my_package.endpoints.paymentsimport Payments
from my_package.endpoints.usersimport Users

from my_package.api.endpoints import Contracts
                                     Credits
                                     Payments
                                     Users

，您当然可以以不同的方式命名包裹，也可以选择适合您需求的另一个结构。例如，您可以将contracts.py和朋友移动到impl subpackage，并保留endpoints/__ init __. py文件，只需稍有修改在其中。或者，您可以将Contracts.py和朋友移至另一个软件包。选项数量是无限的。

关键是Intellisense始终建议您在给定模块中的所有名称。它们是子模块名称，班级名称还是任何其他名称。这就是用户通常想要的及其所用的东西。我们通常使用文档作为通过库中的用户导航而不是IntelliSense的方式。但是，如果建议对您来说确实很重要，则必须将名称移到模块之外。 （或者使用导入系统和Dunder属性进行一些丑陋的技巧。）