Fix script entrypoints with extras

[akeeman]

• Added tests for changed code.
• Updated documentation for changed code.

---

• Resolve invalid script entry point file when script has extras
• Don't add script file when not all extras are selected

---

Consider this pyproject.toml file, which contains a script that has an extra (as implemented, but not yet documented -> #1181)

# pyproject.toml
# ...

[tool.poetry.extras]
my_extra = []

[tool.poetry.scripts]
foo = {callable = "my_package:foo", extras = ["my_extra"]}

Installing the above with poetry install givens you a script file including the

#!/path/to/python
from my_package import foo

if __name__ == '__main__':
    foo[my_extra]()

The last line is obviously incorrect. It should have been

    foo()

In my opinion the file shouldn't have been installed at all in the first place, as those extras often go along with installing some optional packages to let them work. So I chose to skip the installation of the entrypoint as a whole if not all given extras are demanded. Note that I say "in my opinion", as this is different from setuptools. Setuptools will always install all script entrypoints.

[abn]

This will need to move to https://github.com/python-poetry/poetry-core as the relevant logic is now there.

[akeeman]

So, no fixes for v1.1? Or does this no longer fix the problem, because it worked well on an earlier 1.1.x version?

[abn]

@akeeman apologies. I groked the issue incorrectly. Reopening.

[akeeman]

That explains a lot! Thanks.

[akeeman]

Hi, can this pr be handled some time? It should be an easy fix for a simple but annoying problem. Yet it's open for several months now...

[akeeman]

@neersighted any thoughts? The problem still exists in 1.1.13

[finswimmer]

Looks like this is fixed in the current preview release (1.2.0b2). Can you confirm it?

[akeeman]

1.2.0b2 indeed does not have the issue. Is there any news on when it'll come out of beta?
1.2.0b2 does install the executable even when the extra was not asked for.

What's new for me is that poetry run my-command works fine in 1.1.13, because it doesn't seem to call the generated executable. It can act as a workaround.

[neersighted]

1.2.0b2 indeed does not have the issue. Is there any news on when it'll come out of beta? 1.2.0b2 does install the executable even when the extra was not asked for.

#5586

Is it worth rebasing this PR to not install entrypoints when the required extra is not installed? I understand we're not doing anything /wrong/ currently because that's the pip behavior, but I'm open to being convinced that not installing entrypoints is beneficial to the user.

[akeeman]

I guess it would be better to do that in a separate pr pr, so let's not do the convincing here.

[github-actions]

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.