搜索Python包中的非Python文件

起点

使用给定的项目 struct

? <project root>/
├─? pyproject.toml
├─? src/
│ └─? code/
│   ├─? __init__.py
│   └─? myscript.py
├─? resources/
  └─? artifacts/
    └─? code1.jar

并通过指定

[tool.setuptools.packages.find]
where = ["src","resources"]
include = ["code*"]
exclude = []

[tool.setuptools.package-data]
"resources.artifacts" = ["*"]
recipe = ["*.yaml"]

你会得到一个轮子，里面有以下内容

? myscript-0.0.1-py3-none-any/
└─? code/
  ├─? __init__.py
  └─? myscript.py

这样做的原因是，唯一找到的package个是code个.包是一个文件夹，里面有python(.py)文件，通常有__init__.py个文件(如果不说namespace packages个，那就有点特殊了).

我会怎么做？

• 首先，重命名您的主包文件夹.您已经在pyproject中将项目命名为myscript(因此您会将其与pip install myscript一起安装)，但是文件 struct 将暗示import name是code；因此您需要将其命名为import code.myscript(代码是主包).我将项目名称更改为本例中的myproj，方法是将pyproject t.toml中的名称和./code文件夹中的名称更改为./myproj

• 其次，对我来说"Package-Data"的名称告诉我它是package内部的数据../resources不是一个包，因为它不包含任何python文件.如果你在那里加一个空的__init__.py，它就会变成一个Package.但是在pyproject t.toml中还有另一个问题:您的包应该在一个名为./resources的文件夹下找到，但实际上它在根文件夹(.)中.因此，你要么改where = ['src', '.'](这会产生新的问题)，要么把./resources改成./resources/resources，但你也可以做得更容易(第三点)

• 第三，您可以通过将打包的数据文件inside放入(./myproj)来简化操作.这是比较常见的做法，也让pip使用您的代码在site-packages/myproj内部安装资源，这很好(尽管也有其他可能性).因此，我建议对pyproject t.toml进行以下更改:

[project]
name = "myproj" # <-- this changed
version = "0.0.1"

[tool.setuptools.packages.find]
where = ["src"] # <-- this changed

[tool.setuptools.package-data]
"*" = ["*.*"] # <-- this changed

然后将文件夹 struct 设置为

? <project root>/
├─? pyproject.toml
└─? src/
  └─? myproj/
    ├─? __init__.py
    ├─? __assets__/ # non-code files here
    │ └─? code1.jar     
    └─? myscript.py

这将创建一个具有以下文件夹 struct 的轮子:

└─? myproj-0.0.1-py3-none-any/
  └─? myproj/
    ├─? __init__.py
    ├─? __assets__/
    │ └─? code1.jar
    └─? myscript.py