[feature] Allow users to search by name or ip

[gilbert-sci]

Summary

Users have requested that it would be nice to just search by the device name, not only the IP. This removes the uri positional arguments for the CLI and adds the option of --uri with either or

Usage

python3 synapse/cli/__main__.py --uri <device_name/device_ip> info

[maxhodak]

it's super easy to automatically detect whether the string is an ip or a name (i.e., just check for the presence of a .). this shouldn't need to be specified explicitly

[gilbert-sci]

@maxhodak good point I'll update it to be uri

[gilbert-sci]

Funny enough I had that in the previous version lol

[maxhodak]

are there reasons to make it a flag rather than positional? first argument could just always be uri; you always need one, and it changes less often than the method you're calling (which should be the second positional argument)

[gilbert-sci]

@maxhodak I thought that as well, but there are actually commands that don't need a uri, like discover and plot. I mentioned this to @namthor9 but it isn't super clean to support the conditional synapsectl because we also support commands that don't need a uri (but since they are all the same entry point, anything where we have a positional arguments will be interpreted as a subcommand).

I figure that the extra --uri is a decent compromise.

[gilbert-sci]

And to be explicit, the reason why people want that ordering is because then you can easily do from the terminal:

synapsectl --uri <name> info

# up arrow, backspace
synapsectl --uri <name> start

rather than moving back and switching the command.

[maxhodak]

oh i see, basically if the first argument is not command then none of the arguments can be positional anymore. so we are weighing having to type --uri all the time vs needing to seek the cursor further back each invocation. hmm

[gilbert-sci]

Yes. This was a suggestion from a few of our internal users, but if there is more elegant way to solve this then I'm all ears

[gilbert-sci]

We could take the time to make a more proper and persistent TUI.

[maxhodak]

ok don't let me hold this up

[polymerizedsage]

And to be explicit, the reason why people want that ordering is because then you can easily do from the terminal:

synapsectl --uri <name> info

# up arrow, backspace
synapsectl --uri <name> start

rather than moving back and switching the command.

AFAIK you can still do

synapsectl <name> read

without --uri with your changes. The old code still included the option to have a flag its just not strictly necessary. I tested locally and it worked just fine. Maybe im missing something.

[polymerizedsage]

Tested locally and this works for me. Some small comments but otherwise lgtm

[gilbert-sci]

And to be explicit, the reason why people want that ordering is because then you can easily do from the terminal:

synapsectl --uri <name> info

# up arrow, backspace
synapsectl --uri <name> start

rather than moving back and switching the command.

AFAIK you can still do

synapsectl <name> start

without --uri with your changes. The old code still included the option to have a flag its just not strictly necessary. I tested locally and it worked just fine. Maybe im missing something.

I can't reproduce this with the start command.

read did have an errant uri command. I'll look for others.

[gilbert-sci]

@polymerizedsage but also I can't reproduce that with read, it just fails. So I'm not sure how you got that working

[antoniaelsen]

tested, lgtm