subparsers -> add_parser doesn't support hyphen char '-'

[dn2k-dev]

BPO	34046
Nosy	@dn2k-dev

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2018-09-23.02:34:39.342>
created_at = <Date 2018-07-04.16:19:59.210>
labels = ['3.7', 'invalid', 'type-bug', 'library']
title = "subparsers -> add_parser doesn't support hyphen char '-'"
updated_at = <Date 2021-10-27.16:12:52.372>
user = 'https://github.com/dn2k-dev'

bugs.python.org fields:

activity = <Date 2021-10-27.16:12:52.372>
actor = 'paul.j3'
assignee = 'none'
closed = True
closed_date = <Date 2018-09-23.02:34:39.342>
closer = 'paul.j3'
components = ['Library (Lib)']
creation = <Date 2018-07-04.16:19:59.210>
creator = 'nir_barel@bmc.com'
dependencies = []
files = []
hgrepos = []
issue_num = 34046
keywords = []
message_count = 4.0
messages = ['321057', '322227', '405090', '405107']
nosy_count = 3.0
nosy_names = ['paul.j3', 'nir_barel@bmc.com', 'tryauuum']
pr_nums = []
priority = 'normal'
resolution = 'not a bug'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue34046'
versions = ['Python 3.7']

[dn2k-dev]

parent_parser = argparse.ArgumentParser(add_help=False)
main_parser = argparse.ArgumentParser(prog='app_cli')

service_subparsers = main_parser.add_subparsers(title="service",                                        dest="service_command", )

service_parser = service_subparsers.add_parser("-dr", help="sample help", parents=[parent_parser])

service_parser.add_argument("-old_host",help="my old host", dest="oldHost", required=False)

args = main_parser.parse_args()

when I try to run the app_cli -dr I am getting an error "error:unrecognized arguments: -dr"

when I try to run the app_cli with -dr -h I am getting the help of the main application and not the help of the service subparser

only if I change '-dr' to 'dr' it works as expected, but I need to support the hyphen for all arguments

[paulj3]

Do you understand why this is happening?

Subparsers is, in effect, a positional argument with 'choices' - the choices being the parsers (and their aliases).

But '-dr' looks like an flagged (optionals) argument. Since you didn't define such an argument, it gets put in the 'unrecognized' category.

So, no, you can't used a flag-like name for a parser. Why are you trying to do this?

[tryauuum]

I've also struggled with this. The subparser documentation describes them as a tool to "split up functionality into a number of sub-commands".
From the reader's point of view it's not obvious that such "sub-commands" cannot start with --

[paulj3]

Артём Иконников, developers and experienced users are familiar with other programs, such as 'svn' which is used as an example

svn checkout, svn update, and svn commit

Also the use of '--foo' as flagged/optional(s) argument is so familiar to developers, that it does nor occur us that new users might want to use that form here. While there's no explicit prohibition of using the dash, non of the examples use it. Examples are a good starting place when using new features.

If this problem came up more often, I'd recommend modifying the add_parser method to raise an error if the user provides a dashed command name (or alias).