-
Notifications
You must be signed in to change notification settings - Fork 163
Declare Boolean Launch Argument #944
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.
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
Open
DLu
wants to merge
1
commit into
ros2:rolling
Choose a base branch
from
DLu:declare_boolean_launch
base: rolling
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+132
−0
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| # Copyright 2026 Metro Robots | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| """Module for the DeclareBooleanLaunchArgument action.""" | ||
|
|
||
| from typing import Any | ||
| from typing import Dict | ||
| from typing import Optional | ||
| from typing import Text | ||
| from typing import Tuple | ||
| from typing import Type | ||
|
|
||
| from .declare_launch_argument import DeclareLaunchArgument | ||
| from ..frontend import Entity | ||
| from ..frontend import expose_action | ||
| from ..frontend import Parser # noqa: F401 | ||
| from ..some_substitutions_type import SomeSubstitutionsType | ||
|
|
||
|
|
||
| @expose_action('bool_arg') | ||
| class DeclareBooleanLaunchArgument(DeclareLaunchArgument): | ||
| """ | ||
| Action that declares a new boolean launch argument. | ||
|
|
||
| This is a bit of syntactic sugar for | ||
| :py:class:`launch.actions.DeclareLaunchArgument` | ||
| that sets the choices to be either true or false (caps-insensitive) | ||
|
|
||
| .. doctest:: | ||
|
|
||
| >>> ld = LaunchDescription([ | ||
| ... DeclareBooleanLaunchArgument('simple_argument'), # default value is False | ||
| ... DeclareBooleanLaunchArgument('with_default_value', default_value=True), | ||
| ... # other actions here, ... | ||
| ... ]) | ||
|
|
||
| .. code-block:: xml | ||
|
|
||
| <launch> | ||
| <bool_arg name="simple_argument"/> | ||
| <bool_arg name="with_default_value" default_value="true"/> | ||
| </launch> | ||
| """ | ||
|
|
||
| def __init__( | ||
| self, | ||
| name: Text, | ||
| *, | ||
| default_value: Optional[SomeSubstitutionsType | bool] = None, | ||
| **kwargs: Any | ||
| ) -> None: | ||
| """Create a DeclareBooleanLaunchArgument action.""" | ||
| super().__init__( | ||
| name=name, | ||
| default_value=(default_value if not isinstance(default_value, bool) | ||
| else str(default_value)), | ||
| choices=['true', 'false', 'True', 'False'], | ||
| **kwargs | ||
| ) | ||
|
|
||
| @classmethod | ||
| def parse( | ||
| cls, | ||
| entity: Entity, | ||
| parser: 'Parser' | ||
| ) -> Tuple[Type['DeclareBooleanLaunchArgument'], Dict[str, Any]]: | ||
| """Parse `bool_arg` tag.""" | ||
| _, kwargs = super().parse(entity, parser) | ||
|
|
||
| if 'choices' in kwargs: | ||
| raise ValueError('Cannot specify choices for bool_arg') | ||
|
|
||
| return cls, kwargs | ||
46 changes: 46 additions & 0 deletions
46
launch/test/launch/actions/test_declare_boolean_launch_argument.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| # Copyright 2026 Metro Robots | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| """Tests for the DeclareBooleanLaunchArgument action class.""" | ||
|
|
||
| # from launch import LaunchContext | ||
| from launch.actions import DeclareBooleanLaunchArgument | ||
|
|
||
| import pytest | ||
|
|
||
|
|
||
| def test_declare_launch_argument_constructors(): | ||
| """Test the constructors for DeclareLaunchArgument class.""" | ||
| DeclareBooleanLaunchArgument('name') | ||
|
|
||
| # All possible default values | ||
| DeclareBooleanLaunchArgument('name', default_value='True') | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Did you consider a for loop here for simplicity? for default_value in ['True', 'true', 'False', 'false', True, False]:
DeclareBooleanLaunchArgument('name', default_value=default_value) |
||
| DeclareBooleanLaunchArgument('name', default_value='true') | ||
| DeclareBooleanLaunchArgument('name', default_value='False') | ||
| DeclareBooleanLaunchArgument('name', default_value='false') | ||
| DeclareBooleanLaunchArgument('name', default_value=True) | ||
| DeclareBooleanLaunchArgument('name', default_value=False) | ||
|
|
||
| # With description | ||
| DeclareBooleanLaunchArgument('name', description='description') | ||
|
|
||
| # With invalid default value | ||
| with pytest.raises(RuntimeError) as excinfo: | ||
| DeclareBooleanLaunchArgument('name', default_value='invalid') | ||
| assert 'not in provided choices' in str(excinfo.value) | ||
|
|
||
| # With invalid choices override | ||
| with pytest.raises(TypeError) as excinfo: | ||
| DeclareBooleanLaunchArgument('name', choices=['verdad', 'no verdad']) | ||
| assert "multiple values for keyword argument 'choices'" in str(excinfo.value) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You might also add one additional case: a capitalized
TRUEandFALSEhere and to your test case.