Default file inclusion rules

[soxofaan]

Hi,

While experimenting with how file discovery/inclusion works in hatch/hatchling, I stumbled on the following confusing behavior.

I have this project layout:

├── pyproject.toml
├── somefile.py
└── src
    └── thename
        └── __init__.py

So I have a (loose) python file somefile.py and a src layout with a package named thename. These pythons files are empty, but that is not relevant I guess.

The contents of pyproject.toml is:

[project]
name = "thename"
version = "1.2.3"

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

After I build this with python -m build, I get a sdist and wheel. The contents of the sdist is:

-rw-r--r--  0 0      0           0 Feb  2  2020 thename-1.2.3/somefile.py
-rw-r--r--  0 0      0           0 Feb  2  2020 thename-1.2.3/src/thename/__init__.py
-rw-r--r--  0 0      0         121 Feb  2  2020 thename-1.2.3/pyproject.toml
-rw-r--r--  0 0      0          51 Feb  2  2020 thename-1.2.3/PKG-INFO

and the contents of the wheel is

        0  02-02-2020 00:00   thename/__init__.py
       51  02-02-2020 00:00   thename-1.2.3.dist-info/METADATA
      105  02-02-2020 00:00   thename-1.2.3.dist-info/WHEEL
      278  02-02-2020 00:00   thename-1.2.3.dist-info/RECORD

Note how the loose file somefile.py is in the sdist, but not in the wheel. The wheel also doesn't show the src folder anymore either.

Now, if I change the name in pyproject.toml, e.g. add a dash

name = "the-name"

the results are quite different.

The sdist is roughly the same (except for the_name instead of thename in folders). But the wheel suddenly contains the loose file and puts an additional src folder to the structure:

        0  02-02-2020 00:00   somefile.py
        0  02-02-2020 00:00   src/thename/__init__.py
       52  02-02-2020 00:00   the_name-1.2.3.dist-info/METADATA
      105  02-02-2020 00:00   the_name-1.2.3.dist-info/WHEEL
      350  02-02-2020 00:00   the_name-1.2.3.dist-info/RECORD

Same happens if I use different names in pyproject.toml (the_name, or even foobar).

This is behavior quite confusing and I wonder if this behavior is documented somewhere, or can be understood from rules in the documentation.

And follow up question: what config should I use or add in pyproject.toml to make sure the behavior is consistent, regardless of the name, e.g. for the given source tree layout.

thanks for your time and sorry about the wall of text

[ofek]

• https://hatch.pypa.io/latest/plugins/builder/sdist/#default-file-selection
• https://hatch.pypa.io/latest/plugins/builder/wheel/#default-file-selection

If you define any file selection options then the behavior is always consistent

[soxofaan]

Aha, many thanks for those pointers.
So the default behavior depends on these individual plugins (which behave a bit different),
but once you use explicit tool.hatch.build options, things become consistent.

[ofek]

Yes because the contents of the wheel are almost always different than the source distribution, the latter often including tests and docs, retaining the directory structure like src/, etc.