this post was submitted on 06 Sep 2025
110 points (95.1% liked)

Programming

26280 readers
401 users here now

Welcome to the main community in programming.dev! Feel free to post anything relating to programming here!

Cross posting is strongly encouraged in the instance. If you feel your post or another person's post makes sense in another community cross post into it.

Hope you enjoy the instance!

Rules

Rules

  • Follow the programming.dev instance rules
  • Keep content related to programming in some way
  • If you're posting long videos try to add in some form of tldr for those who don't want to watch videos

Wormhole

Follow the wormhole through a path of communities !webdev@programming.dev



founded 2 years ago
MODERATORS
you are viewing a single comment's thread
view the rest of the comments
[–] azertyfun@sh.itjust.works 24 points 6 months ago (1 children)

Counterpoint: Yes, parse don't validate, but CLIs should not be dealing with dependency management.

I love Python's argparse because:

  • It's "Parse, don't validate" (even supports FileType as a target)
  • It enforces or strongly encourages good CLI design
    • Required arguments should in most situations be positional arguments, not flags. It's curl <URL> not curl --url <URL>.
    • Flags should not depend on each other. That usually indicates spaghetti CLI design. Don't do server --serve --port 8080 and server --reload with rules for mix-and-matching those, do server serve --port 8080 and server reload with two separate subparsers.
    • Mutually exclusive flags sometimes make sense but usually don't. Don't do --xml --json, do -f [xml|json].
    • This or( pattern of yours IMO should always be replaced by a subparser (which can use inheritance!). As a user the options' data model should be immediately intuitive to me as I look at the --help and having mutually exclusive flags forces the user to do the extra work of dependency management. Don't do server --env prod --auth abc --ssl, do server serve prod --auth abc --ssl where prod is its own subparser inheriting from AbstractServeParser or whatever.

Thinking of CLI flags as a direct mapping to runtime variables is the fundamental mistake here I think. A CLI should be a mapping to the set(s) of behavior(s) of your application. A good CLI may have mandatory positional arguments but has 0 mandatory flags, 0 mutually exclusive flags, and if it implements multiple separate behaviors should be a tree of subparsers. Any mandatory or mutually exclusive flags should be an immediate warning that you're not being very UNIX-y in your CLI design.

[–] vk6flab@lemmy.radio 2 points 6 months ago (1 children)

I've used the node.js version of argparse, which as I understand it, is a clone of the python implementation and I've not seen how to do mutually exclusive flags. Mind you, at the time I didn't need them, so it wasn't an issue, but I don't recall seeing any way to do it either.

Did I miss something?

[–] azertyfun@sh.itjust.works 3 points 6 months ago

https://docs.python.org/3/library/argparse.html#argparse.ArgumentParser.add_mutually_exclusive_group

However I've never had to use that feature. Like I said it can make sense in specific contexts but it is a pretty strong indicator that you have built in a CLI antipattern or too much complexity.