Added script files support #1504

peterdeme · 2019-10-26T13:21:43Z

Pull Request Check List

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

Feature: script-files section in pyproject.toml

Reasoning

This one is a long overdue, see: #241 (June 2018)

Basically, our company wants to migrate over Poetry but it's impossible since Poetry does not provide a way to add non-Python scripts to the dist package and our migration project is pretty much blocked 😞. This is a very basic feature of setup.py See here: docs.

Note: this is not the same as entry_point! This setuptools feature basically just copies over the given files to the virtualenv's bin folder so that it'll be available on the $PATH and you can simply invoke it.

Example

[tools.poetry]
package = "my_package"
script-files = ["bin/run_db_migrations.sh"]

Then:

poetry install
poetry run sh run_db_migrations.sh

Testing

I added a couple of automated tests
I tested this manually with one of our repositories and it worked

Possible discussion

Naming. Well, I was scratching my head to come up with a decent name. script-files sounds sensible to me, but I can change it if you guys want.

edit.: for some reason the GitHub Actions build on Windows failed for me. Looks like it tried to run the commands in powershell instead of cmd - I don't know why, maybe GitHub changed something this weekend? Anyway, I enforced cmd in the build declaration, the build looks good now.

peterdeme · 2019-11-04T09:38:02Z

Can this have some visibility?

peterdeme · 2019-11-06T16:37:53Z

@stephsamson - what do you think?

jleclanche · 2019-11-14T07:59:46Z

I'm not a fan of this approach… There is solid prior art on how to do this in yarn/npm and pipenv.

This is completely intuitive:

[tool.poetry.scripts]
dosomething = "./path/to/dosomething --arg"  # Path relative to pyproject.toml

I also agree with your assessment in this comment that the "scripts" naming for what "scripts" currently is doesn't make sense if it's just to replicate setuptools' entrypoints.

It should either be renamed tool.poetry.entry_points, or tool.poetry.scripts should be able to safely detect whether you're attempting to run a script vs. an entrypoint.

jleclanche · 2019-11-14T08:04:37Z

Just to clarify the comment above, this is more in response to this PR resolving #241, which I don't think it does; IMO that issue has more to do with poetry's usage as a project manager than a project packager. Being able to include scripts files in the resulting package makes sense, but isn't the whole picture.

peterdeme · 2019-11-14T09:47:00Z

@jleclanche yeah, I was also confused about the terminology.
I think it's a bad idea to introduce such a breaking change so I did not rename existing functions.

Being able to include scripts files in the resulting package makes sense, but isn't the whole picture.

Care to elaborate? Just to clarify I don't wanna shake the earth with this PR, I just want for our (and obviously many other) companies to enable this feature.

peterdeme · 2019-12-10T15:19:03Z

@sdispater opinion?

elihunter173 · 2020-01-01T05:19:46Z

To avoid changing scripts to entry_point and breaking a bunch of people's projects (although I agree entrypoints makes more sense), I think calling the new functionality tasks is intuitive.

For example, if I have something like below in my pyproject.toml, then I'd expect to be able to do either poetry dosomething or poetry task dosomething to execute the task.

[tool.poetry.tasks]
dosomething = "./path/to/dosomething --arg"  # Path relative to pyproject.toml

peterdeme · 2020-01-01T11:00:28Z

Nice idea, it makes sense but I’m still a bit confused how is this relevant to this feature. This isn’t about running arbitrary scripts but copying any kind of files (not just executables) to a package.

danbradham · 2020-01-16T12:43:53Z

Glad to see this PR @peterdeme thank you for working on it. I'm not sure why everyone is misunderstanding this PR as well as #241, but hopefully this will push the feature along.

The scripts keyword of setup() allows you to install non-python scripts along with a python package. This should not be confused with running arbitrary development tasks.

I personally feel like tool.poetry.scripts should be renamed for the sake of clarity, but, that seems like a larger discussion / outside of the scope of this PR. The script-files keyword seems fine, I could also see something a bit more explicit like include-scripts working well.

Can @sdispater or any other maintainers weigh in on this? I think there are probably quite a few projects that are unable to use poetry due to this missing feature.

# Conflicts: # .github/workflows/main.yml # README.md # poetry/masonry/builders/builder.py # tests/masonry/builders/test_complete.py

AstraLuma · 2020-02-23T03:45:41Z

Any motion on this? I just reworked a bunch of stuff in my project to work around #241.

peterdeme · 2020-02-23T05:56:47Z

@astronouth7303 the PR’s been open for 4 months. Looks like they don’t have bandwith to review it or it’s a low priority to them

geckon · 2020-02-28T18:59:58Z

I'd also love to see attention to this as it's something I think poetry definitely should support and I'd love to use this feature instead of trying to come up with a work-around.

funkyfuture · 2020-02-29T13:46:25Z

imo poetry shouldn't have invented its own semantics for keywords in the first place and i think the 1.0 release was premature. i don't know how the maintainers employ the versioning scheme as the last patch release broke builds, so if breaking changes are also okay for minor releases, i'd say the current [tool.poetry.scripts] section should be renamed to [tool.poetry.console_scripts] asap and the feature in this pr should handle the [tool.poetry.scripts] section.

finswimmer · 2020-02-29T17:17:21Z

i don't know how the maintainers employ the versioning scheme as the last patch release broke builds,

Patch releases shouldn't break anything. So if this really happens it wasn't intended. Could you please open an issue for this or give us a linke to an existing issue?

funkyfuture · 2020-02-29T18:15:54Z

Could you please open an issue for this or give us a linke to an existing issue?

that was #2107

sdispater · 2020-02-29T18:27:43Z

@funkyfuture

i don't know how the maintainers employ the versioning scheme as the last patch release broke builds

Poetry follows semver. And the latest release did not break builds on purpose, it's just that bugs happen, unintended side effects happen. Semver is not a silver bullet against unplanned regressions. While we try our best to not break anything, we are only human and sometimes mistakes happen.

That being said, the Git issue you mentioned should now be fixed in the latest release.

peterdeme · 2020-03-11T09:10:00Z

@sdispater @finswimmer @stephsamson this has been open for around half year and I barely saw any relevant comments here. Can you guys at least tell me if this is bad or good or something? This would unblock a lot of people/companies plan to migrate to Poetry. We're also a Python-shop at TrueMotion and we can't wait to adopt Poetry more but the lack of this feature blocks us.
Thank you.

kasteph · 2020-03-29T23:50:23Z

Hi @peterdeme,

Thank you for your contribution! This PR is a great one. Although it is not part of the roadmap afaik, I think this should be seriously considered @sdispater.

I also think naming it tasks instead of script-files makes more sense since it’s equivalent to rake/bundle/make tasks.

AstraLuma · 2020-03-30T00:59:49Z

THEY"RE NOT PROJECT TASKS.

This defines a new type of installable: Files that should be placed on the $PATH without modification.

peterdeme · 2020-03-30T08:01:21Z

@stephsamson , thanks for the feedback. it is not really equivalent with those. As astrobouth said this one just copies a bunch of files to your PATH.

https://python-packaging.readthedocs.io/en/latest/command-line-scripts.html#the-scripts-keyword-argument

kasteph · 2020-03-30T11:01:27Z

@astronouth7303 thanks for the clarification, I was hastily scanning the comments of the PR when I was reviewing a bunch of others and was careless. I won't do this next time and be more careful but typing in caps lock is also unnecessary :)

Regarding the keyword, I think an RFC needs to be opened on whether poetry should be using keywords equivalent to setup.py and would mean breaking changes.

AstraLuma · 2020-03-30T13:35:22Z

Sorry, the issue is like 3 miles long because of this confusion.

kasteph · 2020-03-30T13:40:20Z

No worries, I can understand that it's incredibly frustrating. I'll make sure to raise this particular issue once again to the core team.

kasteph

Hi there,

Sorry for getting back late but I've come back with feedback.

The core team has come to an agreement that instead of introducing a new namespace in the pyproject.toml file, that we'd rather have extended inline tables under the tool.poetry.scripts namespace instead. See here.

I'd kindly ask you to make changes in the core repo and I'll make sure to review them ASAP (you can ping me on Discord, my username there is same as here on GitHub).

Thank you for your contribution! 🙌

kasteph · 2020-04-16T19:05:58Z

docs/docs/pyproject.md

+
+```toml
+[tool.poetry]
+script-files = ["contrib/run_db_migration.sh", "bin/healthcheck.py"]


The @python-poetry/core team has decided on going forward with keeping the [tool.poetry.scripts] namespace and using inline tables to have more flexibility and backwards compatibility.

kasteph · 2020-04-16T19:06:14Z

poetry/json/schemas/poetry-schema.json

@@ -82,8 +82,15 @@
                    },
                    "format": {
                        "oneOf": [
-                            {"type": "string"},
-                            {"type":  "array", "items": {"type":  "string"}}
+                            {


This schema will have to change w.r.t. my comment above.

peterdeme · 2020-06-28T22:16:54Z

I’ll try to find time in the next few weeks.

peterdeme · 2020-06-29T21:42:06Z

Today, I had time to develop this. I opened a new PR and closing this one now.

@stephsamson Can you please take a look at python-poetry/poetry-core#40?

github-actions · 2024-03-01T07:09:03Z

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.

Added script files support

8c66d38

finswimmer mentioned this pull request Nov 30, 2019

How do we specify paste entrypoints #1300

Closed

2 tasks

finswimmer added kind/feature Feature requests/implementations area/build-system Related to PEP 517 packaging (see poetry-core) labels Dec 23, 2019

peterdeme requested a review from sdispater January 22, 2020 11:43

Merge remote-tracking branch 'upstream/develop' into develop

9cc6227

# Conflicts: # .github/workflows/main.yml # README.md # poetry/masonry/builders/builder.py # tests/masonry/builders/test_complete.py

sdispater mentioned this pull request Jan 31, 2020

Path based scripts #304

Closed

2 tasks

Fix grammar

80bc817

peterdeme requested review from finswimmer and kasteph February 9, 2020 13:20

geckon mentioned this pull request Feb 28, 2020

Installing CLI with setuptools style "scripts" vs "console_scripts". #1023

Closed

2 tasks

abn mentioned this pull request Apr 14, 2020

Improve script section: support use of script files #2310

Open

kasteph requested changes Apr 16, 2020

View reviewed changes

peterdeme closed this Jun 29, 2020

peterdeme mentioned this pull request Dec 3, 2020

Added script file feature python-poetry/poetry-core#40

Merged

2 tasks

github-actions bot locked as resolved and limited conversation to collaborators Mar 1, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added script files support #1504

Added script files support #1504

peterdeme commented Oct 26, 2019 •

edited

Loading

peterdeme commented Nov 4, 2019

peterdeme commented Nov 6, 2019

jleclanche commented Nov 14, 2019

jleclanche commented Nov 14, 2019

peterdeme commented Nov 14, 2019 •

edited

Loading

peterdeme commented Dec 10, 2019

elihunter173 commented Jan 1, 2020

peterdeme commented Jan 1, 2020 •

edited

Loading

danbradham commented Jan 16, 2020 •

edited

Loading

AstraLuma commented Feb 23, 2020

peterdeme commented Feb 23, 2020

geckon commented Feb 28, 2020

funkyfuture commented Feb 29, 2020

finswimmer commented Feb 29, 2020

funkyfuture commented Feb 29, 2020

sdispater commented Feb 29, 2020

peterdeme commented Mar 11, 2020 •

edited

Loading

kasteph commented Mar 29, 2020

AstraLuma commented Mar 30, 2020

peterdeme commented Mar 30, 2020

kasteph commented Mar 30, 2020

AstraLuma commented Mar 30, 2020

kasteph commented Mar 30, 2020

kasteph left a comment

kasteph Apr 16, 2020

kasteph Apr 16, 2020

peterdeme commented Jun 28, 2020

peterdeme commented Jun 29, 2020

github-actions bot commented Mar 1, 2024

Added script files support #1504

Added script files support #1504

Conversation

peterdeme commented Oct 26, 2019 • edited Loading

Pull Request Check List

Feature: script-files section in pyproject.toml

Reasoning

Example

Testing

Possible discussion

peterdeme commented Nov 4, 2019

peterdeme commented Nov 6, 2019

jleclanche commented Nov 14, 2019

jleclanche commented Nov 14, 2019

peterdeme commented Nov 14, 2019 • edited Loading

peterdeme commented Dec 10, 2019

elihunter173 commented Jan 1, 2020

peterdeme commented Jan 1, 2020 • edited Loading

danbradham commented Jan 16, 2020 • edited Loading

AstraLuma commented Feb 23, 2020

peterdeme commented Feb 23, 2020

geckon commented Feb 28, 2020

funkyfuture commented Feb 29, 2020

finswimmer commented Feb 29, 2020

funkyfuture commented Feb 29, 2020

sdispater commented Feb 29, 2020

peterdeme commented Mar 11, 2020 • edited Loading

kasteph commented Mar 29, 2020

AstraLuma commented Mar 30, 2020

peterdeme commented Mar 30, 2020

kasteph commented Mar 30, 2020

AstraLuma commented Mar 30, 2020

kasteph commented Mar 30, 2020

kasteph left a comment

Choose a reason for hiding this comment

kasteph Apr 16, 2020

Choose a reason for hiding this comment

kasteph Apr 16, 2020

Choose a reason for hiding this comment

peterdeme commented Jun 28, 2020

peterdeme commented Jun 29, 2020

github-actions bot commented Mar 1, 2024

peterdeme commented Oct 26, 2019 •

edited

Loading

peterdeme commented Nov 14, 2019 •

edited

Loading

peterdeme commented Jan 1, 2020 •

edited

Loading

danbradham commented Jan 16, 2020 •

edited

Loading

peterdeme commented Mar 11, 2020 •

edited

Loading