Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Inconsistent default behavior of include #9691

Open
radoering opened this issue Sep 16, 2024 · 0 comments
Open

Inconsistent default behavior of include #9691

radoering opened this issue Sep 16, 2024 · 0 comments
Labels
area/build-system Related to PEP 517 packaging (see poetry-core) area/core Related to the poetry-core library kind/bug Something isn't working as expected

Comments

@radoering
Copy link
Member

Before diving into the issue, a short clarification:

  1. There are packages includes, which default to sdist and wheel.
  2. There are includes, which (according to the docs) default to only sdist.

These different defaults can be confusing, but might make sense because you normally want to include packages in sdists and wheels but additional data like tests and a changelog only in the sdist.

Issue

The behavior for includes (the second one) is different for files and directories:

  • files are included in both sdist and wheel
  • directories are only included in sdists

Considering that the docs were "fixed" recently in #8852 to describe the behavior for directories - previously, it described the behavior for files - I wondered which behavior is correct and which is the bug?

Events of confusion in chronologically order:

We can be sure that the initial intention was to default to "only sdist". However, I am not sure if the behavior should be changed to "sdist and wheel" later or if it was just a confusion between the two types of includes.

Thus, the big question: What should the default be?

  • sdist and wheel for package includes (first type) and sdist only for includes (second type)
    • pro: You normally want to include packages in sdists and wheels but additional data like tests and a changelog only in the sdist
    • contra: different defaults
  • sdist and wheel for both types of includes
    • pro: same defaults
    • contra: maybe improper default for one type
@radoering radoering added kind/bug Something isn't working as expected area/build-system Related to PEP 517 packaging (see poetry-core) area/core Related to the poetry-core library labels Sep 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/build-system Related to PEP 517 packaging (see poetry-core) area/core Related to the poetry-core library kind/bug Something isn't working as expected
Projects
None yet
Development

No branches or pull requests

1 participant