fix(cli): allow exclusive arguments as optional

[Sjord]

The CLI takes its arguments from the RequiredOptional, which has three fields: required, optional, and exclusive. In practice, the exclusive options are not defined as either required or optional, and would not be allowed in the CLI. This changes that, so that exclusive options are also added to the argument parser.

Closes #2769

Changes

Documentation and testing

Please consider whether this PR needs documentation and tests. This is not required, but highly appreciated:

• Documentation in the matching docs section
• Unit tests and/or functional tests

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (48726fd) 96.48% compared to head (e435fc9) 96.49%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2770   +/-   ##
=======================================
  Coverage   96.48%   96.49%           
=======================================
  Files          90       90           
  Lines        5866     5874    +8     
=======================================
+ Hits         5660     5668    +8     
  Misses        206      206           

Flag	Coverage Δ
api_func_v4	82.20% <0.00%> (-0.12%)	⬇️
cli_func_v4	83.55% <62.50%> (-0.03%)	⬇️
unit	88.27% <100.00%> (+0.01%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files	Coverage Δ
gitlab/v4/cli.py	91.69% <100.00%> (+0.22%)	⬆️

[JohnVillalovos]

Would it make more sense to create a mutually exclusive group and add the exclusive args to that?

https://docs.python.org/3/library/argparse.html#mutual-exclusion

[Sjord]

I've changed the code to create a mutually exclusive group.

I think the data model of RequiredOptional is not ideal. Whether options are exclusive should be perpendicular to whether they are required or optional. Also, it would be possible to have multiple exclusive groups. Currently this is not reflected in the RequiredOptional.exclusive property. It only allows one group, and it is not clear whether this group is required or not.

Ideally, you would have something lilke this:

RequiredOptional(
    required=("foo", exclusive("user_id", "user_email"), exclusive("project_slug", "project_id")),
    optional=("bar", exclusive("cn", "filter"))
)

But adding these exclusive options to the CLI argument parser at least makes it functioning again, if not perfect.

[JohnVillalovos]

Thank you very much for this.