Repository navigation
CLI arg typecasting #9
Description
Find a decent way to indicate, on a task or automatically, that e.g. invoke taskname --val=5 should result in a Python value 5 instead of "5", and of course similar for bools, lists etc.
Possibilities:
-
Explicit on the CLI level:
invoke mytask --wants-an-int int:5 --wants-a-list=list:"a;b;c" -
Explicit on the task declaration level (off the cuff API, but you get the gist):
@task(argspec={'wants_an_int': int, 'wants_a_list': lambda x: x.split(';')}) def mytask(wants_an_int, wants_a_list): # ...
-
Implicit via conventions, e.g. try/except casting to
intand/orfloat, anything containing semicolons getssplit()'d, etc- Original ticket said to cast
y/yes/etc to booleans, but now that we're using--real --flagsbooleans happen for free. - Would obviously need to be easily toggled, and think about what the default should be
- Original ticket said to cast
-
Explicit via helper functions -- obviously
int/floatalready exist, so maybe a helperdef listarg(x): return x.split(';')- Feels kinda dumb unless we can come up with a larger body of useful subroutines worth supporting.
Right now, I'm leaning towards the explicit-at-task-declaration level, with possible implicit-via-conventions. Very torn on whether the implicit should be on by default -- fits the "get stuff done fast" use case but clashes with "don't be surprising".
Was Fabric #69
Activity
bitprophet commentedon Jul 27, 2012
I have a partial implementation of this in master, which infers typing from the default value of arguments (both in terms of a task's argspec, and at the parser level, e.g. if anybody were to construct the parser arguments manually).
Still needs to be expanded to allow something explicit for any args that lack default values.
bitprophet commentedon May 8, 2018
Years-later clarification: the "partial implementation" mentioned above has been a core part of the CLI framework for a long time and seems to work OK for many/most use cases; it's the functionality that knows when you have:
then this invocation results in
count=7and notcount="7":Combined with boolean true-flags (
--bool/--no-bool) and the recently solved #9 for lists (--mylist a --mylist b --mylist cyielding["a", "b", "c"]) this doesn't leave much but edge cases, which deserve their own ticket(s) anyways.Things like "no I really want SHORTER ways to supply lists" (can be solved on the user's end with
split), dicts (kinda ditto, though we could possibly supply well-tested helpers for parsing eg--mydict=key=val,otherkey=otherval) and etc.Merge pull request pyinvoke#9 from python-tinker/dev/type-updates