Skip to content

Ban mutually exclusive positional arguments #187

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
kkarbowiak merged 5 commits into from
Dec 3, 2025
Merged

Ban mutually exclusive positional arguments #187

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5af7bb8
Disallow positional arguments in mutually exclusive groups
kkarbowiak Dec 3, 2025
418013b
Improve error message
kkarbowiak Dec 3, 2025
c68ec3e
Allow non-required positional arguments in mutually exclusive groups
kkarbowiak Dec 3, 2025
2a29f2d
Allow non-required positional arguments in mutually exclusive groups
kkarbowiak Dec 3, 2025
5da0db8
Fix condition
kkarbowiak Dec 3, 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
11 changes: 10 additions & 1 deletion include/argparse.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1897,7 +1897,7 @@ namespace argparse
m_options.mutually_exclusive_group = group;
}

~ArgumentBuilder()
~ArgumentBuilder() noexcept(false)
{
if ((m_options.action == argparse::version) && m_options.help.empty())
{
Expand All @@ -1906,6 +1906,15 @@ namespace argparse

if (is_positional())
{
if (m_options.mutually_exclusive_group != nullptr
&& (!m_options.nargs.has_value()
|| (!std::holds_alternative<Nargs>(*m_options.nargs)
|| (std::get<Nargs>(*m_options.nargs) != zero_or_one
&& std::get<Nargs>(*m_options.nargs) != zero_or_more))))
{
throw option_error("mutually exclusive arguments must be optional");
}

m_arguments.emplace_back(PositionalArgument(std::move(m_options)));
}
else
Expand Down
17 changes: 17 additions & 0 deletions test/unittest/test_argument_parser.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -350,6 +350,23 @@ TEST_CASE("ArgumentParser supports mutually exclusive groups")
CHECK_NOTHROW(parser.add_mutually_exclusive_group());
}

TEST_CASE("Adding a positional argument to a mutually exclusive group results in error")
{
auto parser = argparse::ArgumentParser();
auto group = parser.add_mutually_exclusive_group();

CHECK_THROWS_WITH_AS(group.add_argument("pos"), "mutually exclusive arguments must be optional", argparse::option_error);
}

TEST_CASE("Adding a non-required positional argument to a mutually exclusive group does not result in error")
{
auto parser = argparse::ArgumentParser();
auto group = parser.add_mutually_exclusive_group();

CHECK_NOTHROW(group.add_argument("pos").nargs(argparse::zero_or_one));
CHECK_NOTHROW(group.add_argument("pos").nargs(argparse::zero_or_more));
}

TEST_CASE("Adding an optional argument to a mutually exclusive group does not result in error")
{
auto parser = argparse::ArgumentParser();
Expand Down