[SOLVED] How to decide what to do with command line parameters?
This is solved, I was being dumb. Please see second EDIT below
This isn't really language specific, but if it helps I'm using Python. I can get the parameters just fine with the Traitlets module, but I'm still a novice really and figuring out which patterns to use is challenging.
Say you have a bunch of command line parameters. Some are booleans, where their presence means True, absence means False. Other parameters must accept one text string, and others can be used multiple times to build a list of strings.
It feels inefficient/wrong to use a bunch of IF/THEN/ELSE statements to decide what to do with the parameters, and prone to edge case errors. Is there a pattern that would invoke the correct method based on the combination of input parameters?
EDIT: Via the Traitlets module, I get those arguments parsed and accessible as self.argname, so getting them into my app is working great. It's just deciding what to do with them that is confusing me.
Thank you, sorry for my noobness.
EDIT2: I think I understand where I'm going wrong:
I'm creating subcommands based on objects, not actions. i.e. appname thing --action should really be appname action --thing. Once things are divided up into actions, assigning things to those actions will be much, much easier and straightforward.
Sorry for a confusing and fairly pointless post :(
As a few others mentioned, the argparse module from the stdlib is the way to go for Python. It takes care of most of this for you in an optimized way. Here's a minimal example of the above:
#!/bin/env python3
import argparse
# Setup main parser
parser = argparse.ArgumentParser(
prog="app",
description="App that manages things and jobs",
)
parser.add_argument(
"-v",
"--verbose",
action="store_true",
)
subparsers = parser.add_subparser(
help="Sub commands",
dest="command",
)
# Setup sub-parsers
thing_parser = subparsers.add_parser(
"thing",
help="Manage things",
)
# thing_parser args
thing_parser.add_argument(
"--dry_run",
action="store_true",
help="dry run",
)
thing_parser.add_argument(
"--create",
action="store_true",
help="Create thing",
)
thing_parser.add_argument(
"--name",
action="store",
type=str,
required=True,
nargs="+",
help="Thing name",
)
job_parser = subparsers.add_parser(
"job",
help="Manage jobs",
)
job_parser.add_argument(
"--cancel",
"-c",
action="store_true",
help="Cancel job",
)
job_parser.add_argument(
"--index",
"-i",
action="store",
type=int,
required=True,
nargs="+",
help="Job index",
)
def main():
args=parser.parse_args()
if args.verbose:
print("Verbose mode")
# Match-Case statement for cleaner logic
match args.command:
case "thing":
# thing logic and function calls here
case "job":
# job logic and function calls here
case _:
parser.print_usage()
if __name__ == "__main__":
main()
You're very welcome! I've spent a lot of time with Python and really think that argparse as of 3.x makes most non-stdlib libraries for parsing are unnecessary. You get a ton of functionally and ability to add end-user documentation as you go, while abstracting away some of the basics like type casting/checking
The addition of Match-Case, while not adding much, functionally, does a LOT for readability and keeping logic clear.
I just wish I had thought things through correctly but I guess that's part of becoming a more experienced coder. Arrrrggh! I'm so annoyed I wasted time on the otherwise excellent Traitlets' argument parsing!
I was doing it wrong. I was trying to do appname thing --action when I should have been doing appname action --thing. Thank you for commenting, I'm sorry to waste your time.
What module are you currently using? I think the built-in module argparse should solve your problem but maybe I'm misunderstanding what you're asking for.
I was doing it wrong. I was trying to do appname thing --action when I should have been doing appname action --thing. Thank you for commenting, I'm sorry to waste your time.
Traitlets. It parses the arguments for me just fine, I'm just confused on how to turn those into calls to methods without a mess of if/else or switch statements, which seem fragile.
Others have already mentioned argparse, which is a pretty great module for argument parsing if you want to use something built-in. If you're willing to look into other libraries though, I'd recommend taking a look at Click. You should be able to pip install click to use it. It takes advantage of defining the CLI through decorators, and from my experience, works better when you want to have subcommands.
I've replaced the Traitlets based arg parsing with argparse, and the subcommands are working ok so far. I'll see if Click can add anything, thank you for the recommendation!
I was doing it wrong. I was trying to do appname thing --action when I should have been doing appname action --thing. Thank you for commenting, I'm sorry to waste your time.