Support for shorthand

[Henri-ColibrITD]

It would be supper nice to be able to have short-hands, here is an example of what it looks like with argparse, followed by an idea of what it could look like with argtyped.

parser = argparse.ArgumentParser(
    prog="DB initialization helper",
    description="This script initializes the database.",
)

parser.add_argument(
    "-n",
    "--table-name",
    help="The name of the table to initialize",
    default="test",
)

Could be equivalent to

class Parser(Arguments):
    """This script initializes the database."""

    table_name: Shorthanded[str] = "test"
    """The name of the table to initialize"""

I'm just throwing ideas around, without considering the feasibility. An other solution would be to put the keyword on the right hand side of the equality instead of the type hint. Similarly to the Field class of pydantic I believe. Like so:

class Parser(Arguments):
    """This script initializes the database."""

    table_name: str = Shorthanded("test")
    """The name of the table to initialize"""

[Henri-ColibrITD]

Btw, I'm happy to help implementing this feature

[huzecong]

I think this would be a great addition, but we need to decide on what the syntax should look like. If one writes Shorthand[str], what would that short hand be? Should it be configurable, or should it just take the first letter of the attribute? It's also worth noting that argparse already support prefix matching, so a non-configurable version might not be of too much use.

If we decide this should be configurable, then one option would be to make use of typing.Annotated. It allows attaching metadata to the type annotation, so you could write something like:

Shorthanded = typing.Annotated

class MyArguments(Arguments):
    table_name: Shorthanded[str, "n"] = "test"
    #                             ^ or maybe this should say "-n", so you can also write things like "--name"?

then you'd be able to extract that shorthand on class construction. What do you think?

I probably won't have time to implement something like this, but again, if you'd like to submit a pull request, I'd be happy to review.