Add option to specify config path argument name

[joshlk]

Add an option so the user can specify the name of the config path argument.

I have extended the add_config_path_arg parameter of ArgumentParser to accept a string. If specified this determines the name of the argument, otherwise, it defaults to the previous value of config_path.

I have also added the config_path parameter to ArgumentParser's docstrings, as it was missing previously.

[codecov]

Codecov Report

Attention: Patch coverage is 66.66667% with 2 lines in your changes missing coverage. Please review.

Project coverage is 87.03%. Comparing base (4388893) to head (83e0e8f).

Files with missing lines	Patch %	Lines
simple_parsing/parsing.py	66.66%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #334      +/-   ##
==========================================
- Coverage   87.06%   87.03%   -0.03%     
==========================================
  Files          34       34              
  Lines        4538     4543       +5     
==========================================
+ Hits         3951     3954       +3     
- Misses        587      589       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[lebrice]

Thanks a lot @joshlk , this looks good! There's just a minor comment here about the extra restriction that you place on the values that config_path_name can take.

[lebrice]

Actually, you can use attribute names with dashes when you getattr and setattr on a Namespace object:

>>> from argparse import Namespace
>>> ns = Namespace()
>>> setattr(ns, "some-attr", 42)
>>> getattr(ns, "some-attr")
42

[lebrice]

Also, if you have the time, would you mind adding a simple test so we can cover this change?

@pytest.mark.parametrize("invalid_value", ["foo.bar.baz?", "-------", "bob bob bob"])  # add other more relevant examples perhaps?
def test_pass_invalid_value_to_add_config_path_arg(invalid_value):
    with pytest.raises(ValueError):
        _ = ArgumentParser(add_config_path_arg=invalid_value)

[joshlk]

Actually, you can use attribute names with dashes when you getattr and setattr on a Namespace object:

>>> from argparse import Namespace
>>> ns = Namespace()
>>> setattr(ns, "some-attr", 42)
>>> getattr(ns, "some-attr")
42

Thanks good idea. I have it working now. For reference, you have to replace the dashes with underscores like so:

getattr(args_with_config_path, config_path_name.replace('-', '_'))

[joshlk]

Also, if you have the time, would you mind adding a simple test so we can cover this change?

@pytest.mark.parametrize("invalid_value", ["foo.bar.baz?", "-------", "bob bob bob"])  # add other more relevant examples perhaps?
def test_pass_invalid_value_to_add_config_path_arg(invalid_value):
    with pytest.raises(ValueError):
        _ = ArgumentParser(add_config_path_arg=invalid_value)

I've added some tests

[lebrice]

Suggested change

	raise ValueError("`add_config_path_arg` cannot use the same name as `dest`.")
	raise ValueError("`add_config_path_arg` cannot be the same as `dest`.")

[joshlk]

@lebrice I've addressed the comments. Its ready for a re-review