Skip to content

Commit 6d473f1

Browse files
authored
Rename to launch_frontend_py (#9)
Noted in ROS 2 PMC meeting that the name might indicate a "reimplementation of the launch system in Python", per that something like launch-rs or launch-js might indicate. This new name launch_frontend_py is much harder to misinterpret.
1 parent 581f81e commit 6d473f1

File tree

13 files changed

+16
-16
lines changed

13 files changed

+16
-16
lines changed

.github/workflows/build.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ jobs:
3232
- uses: ros-tooling/[email protected]
3333
with:
3434
target-ros2-distro: ${{ matrix.ros }}
35-
package-name: launch_py
35+
package-name: launch_frontend_py
3636
- uses: actions/upload-artifact@v4
3737
with:
3838
name: colcon-logs-${{ matrix.ros }}

CMakeLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
cmake_minimum_required(VERSION 3.22)
22

3-
project(launch_py)
3+
project(launch_frontend_py)
44

55
find_package(ament_cmake REQUIRED)
66
find_package(ament_cmake_python REQUIRED)

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ That is, they are the intended user-facing API.
77
However, much of the community got hooked on Python launchfiles due to early adoption when the frontends were incomplete.
88
With that in mind, and the extensive explicit use of exact filenames and `PythonLaunchDescriptionSource`, migration to these frontends is difficult for packages with downstream consumers.
99

10-
Enter `launch_py` - this package provides a Python-language frontend to `launch`, with identical usage to the XML and YAML versions.
10+
Enter `launch_frontend_py` - this package provides a Python-language frontend to `launch`, with identical usage to the XML and YAML versions.
1111
It provides the same benefits of conciseness, declarative style, while allowing launchfiles to stay in Python.
1212

1313

File renamed without changes.

launch_py/actions.py renamed to launch_frontend_py/actions.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ def make_action_factory(action_name: str, **kwargs) -> Callable[..., Any]:
2727
def fn(*args, **kwargs):
2828
return Entity(action_name, *args, **kwargs)
2929

30-
fn.__doc__ = f'launch_py action: {action_name} (dynamically generated)'
30+
fn.__doc__ = f'launch_frontend_py action: {action_name} (dynamically generated)'
3131
fn.__name__ = action_name
3232
fn.__qualname__ = action_name
3333
fn.__module__ = __name__

launch_py/entity.py renamed to launch_frontend_py/entity.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15-
"""Module for launch_py Entity class."""
15+
"""Module for launch_frontend_py Entity class."""
1616
import builtins
1717
from collections.abc import Iterable
1818
import keyword
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
[mypy-launch_py]
1+
[mypy-launch_frontend_py]
22
disable_error_code = attr-defined

package.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<?xml version="1.0"?>
22
<?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
33
<package format="3">
4-
<name>launch_py</name>
4+
<name>launch_frontend_py</name>
55
<version>0.1.0</version>
66
<description>Python frontend for writing ROS 2 launch files</description>
77
<maintainer email="[email protected]">Emerson Knapp</maintainer>

test/basic_launch.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@
1313
# limitations under the License.
1414
from pathlib import Path
1515

16-
from launch_py import launch
17-
from launch_py.actions import arg, executable, group, include, let, log, set_env
16+
from launch_frontend_py import launch
17+
from launch_frontend_py.actions import arg, executable, group, include, let, log, set_env
1818

1919
THIS_DIR = Path(__file__).parent
2020

@@ -24,7 +24,7 @@ def generate_launch_description():
2424
arg(name='arg1', default='arg1_value'),
2525
let(name='arg2', value='let_$(var arg1)'),
2626
executable(
27-
cmd='echo hello launch_py executable',
27+
cmd='echo hello launch_frontend_py executable',
2828
output='screen',
2929
),
3030
log(level='INFO', message='Log warning: arg1=$(var arg1), arg2=$(var arg2)'),

test/include_launch.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15-
from launch_py import launch
16-
from launch_py.actions import arg, log
15+
from launch_frontend_py import launch
16+
from launch_frontend_py.actions import arg, log
1717

1818

1919
def generate_launch_description():

0 commit comments

Comments
 (0)