Add multiple option for args #70

nat-n · 2022-05-30T20:34:37Z

WIP solution for #54 @wsascha

The new multiple option can be added to args to make them accept multiple values.

only the last positional arg may have multiple set
multiple option defaults to false
if multiple = true and required = false then the result is nargs = "*", or if required = true then nargs = "+"
an integer value >= 2 may also be given to specify an exact number of values are required for an arg
for script tasks the values are passed as a list, for command tasks they can be templated into the command (thus potentially passed as multiple arguments), shell tasks don't have any special support.
All tasks also get the list of values as an env var in the form of a space delimited string

Still to test:

created a task for testing in the scripts project, but still need to write thorough test cases yet in test_script_tasks
also need basic test cases for cmd, shell, and sequence tasks
what if multiple=true with type=boolean ?

Also todo:

Fix other broken tests
Document new functionality in the readme
Think of a nice way to indicate that an arg accepts multiple arguments when generating documentation for a task

wsascha

Hey, sorry for the late reply, I'm currently on vacation 😅 looks good to me over all. Thanks for your efforts, really appreciated! I left two minor comments below, let me know what you think.

wsascha · 2022-06-06T21:14:11Z

poethepoet/task/args.py

@@ -26,6 +26,7 @@
    "positional": (bool, str),
    "required": bool,
    "type": str,
+    "multiple": (bool, int),


Not sure if it's really necessary to have an int here. At least I don't know any use cases from tools I used.

I'm not sure either. Though it seemed like a low cost feature to support (because it just works with argparse), and imagined that there could be use-cases for it.

wsascha · 2022-06-06T21:31:35Z

tests/fixtures/scripts_project/pyproject.toml

@@ -99,6 +99,29 @@ greet = "pkg:greet"
    type = "boolean"


+  [tool.poe.tasks.multiple-value-args]


Maybe we could also add a sequence task here.

Also progress a little further on reducing test dependency on echo and env

…windows

…lues (#70) Also improve tests for executing on windows The new `multiple` option can be added to args to make them accept multiple values. - only the last positional arg may have multiple set - multiple option defaults to false - args of type boolean may not have the multiple option set - if `multiple = true` and `required = false` then the result is `nargs="*"`, or if `required = true` then `nargs="+"` - an integer value >= 2 may also be given to specify an exact number of values are required for an arg - for script tasks the values are passed as a list, for command tasks they can be templated into the command (thus potentially passed as multiple arguments), shell tasks don't have any special support. - All tasks also get the list of values as an env var in the form of a space delimited string

nat-n added the enhancement New feature or request label May 30, 2022

nat-n force-pushed the development branch from ef461f0 to 22df319 Compare June 5, 2022 22:12

nat-n force-pushed the feature/54/multiple_value_args branch from 4b4aa9f to e422ff2 Compare June 5, 2022 22:21

wsascha reviewed Jun 6, 2022

View reviewed changes

nat-n added 4 commits June 7, 2022 23:06

Add multiple option for args

6f9ff3c

Fix bug when multiple=False

72611ff

Write tests for multiple args for script task

e1ea459

Add basic tests for multiple args option for other task types

515467e

Also progress a little further on reducing test dependency on echo and env

nat-n force-pushed the feature/54/multiple_value_args branch from 5add810 to 515467e Compare June 7, 2022 21:45

nat-n mentioned this pull request Jun 9, 2022

[Linux] Setting LD_LIBRARY_PATH does not work for detecting DLLs #72

Closed

nat-n force-pushed the feature/54/multiple_value_args branch 2 times, most recently from 7586f86 to 61f3a9f Compare June 10, 2022 20:36

Update ci config

b8f82cb

nat-n force-pushed the feature/54/multiple_value_args branch from 61f3a9f to b8f82cb Compare June 10, 2022 20:38

Disallow configuration of boolean args with multiple values

20814f7

nat-n force-pushed the feature/54/multiple_value_args branch 2 times, most recently from f098f55 to 6e4d654 Compare June 10, 2022 22:00

Write readme section for multiple option & make tests work better on …

798688e

…windows

nat-n force-pushed the feature/54/multiple_value_args branch from 6e4d654 to 798688e Compare June 11, 2022 19:23

debug windows test

dba4457

nat-n force-pushed the feature/54/multiple_value_args branch from fff476c to dba4457 Compare June 11, 2022 21:00

nat-n merged commit b891016 into development Jun 11, 2022

nat-n deleted the feature/54/multiple_value_args branch June 11, 2022 21:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add multiple option for args #70

Add multiple option for args #70

nat-n commented May 30, 2022 •

edited

wsascha left a comment

wsascha Jun 6, 2022

nat-n Jun 7, 2022 •

edited

wsascha Jun 6, 2022

		@@ -99,6 +99,29 @@ greet = "pkg:greet"
		type = "boolean"


		[tool.poe.tasks.multiple-value-args]

Add multiple option for args #70

Add multiple option for args #70

Conversation

nat-n commented May 30, 2022 • edited

Still to test:

Also todo:

wsascha left a comment

Choose a reason for hiding this comment

wsascha Jun 6, 2022

Choose a reason for hiding this comment

nat-n Jun 7, 2022 • edited

Choose a reason for hiding this comment

wsascha Jun 6, 2022

Choose a reason for hiding this comment

nat-n commented May 30, 2022 •

edited

nat-n Jun 7, 2022 •

edited