Skip to content

Update documentation for path argument parsing #804

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 14, 2025
Merged

Update documentation for path argument parsing #804

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5a5b996
Update documentation for path argument parsing
michael-hoss Nov 12, 2025
85a739b
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Nov 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions DOCUMENTATION.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -669,6 +669,8 @@ using the :py:meth:`.Path.get_content` method. For the previous example would be
``info_db = cfg.databases.info.get_content()``.

An argument with a path type can be given ``nargs='+'`` to parse multiple paths.
The CLI syntax for a list of paths is ``[/path/a,/path/b]`` for the default yaml
loader and ``["/path/a","/path/b"]`` for the json loader.
But it might also be wanted to parse a list of paths found in a plain text file
or from stdin. For this add the argument with type ``List[<path_type>]`` and
``enable_path=True``. To read from stdin give the special string ``'-'``.
Expand Down Expand Up @@ -703,6 +705,10 @@ Example:
If ``nargs='+'`` is given to ``add_argument`` with ``List[<path_type>]`` and
``enable_path=True`` then for each argument a list of paths is generated.

Path list arguments can also be specified using the
:py:meth:`.ArgumentParser.add_class_arguments` method. To do so, specify
``List[<path_type>]`` as your class member's type.

.. note::

Not all features of the :class:`.Path` class are supported on Windows.
Expand Down