Skip to main content

Python parser for ROS message definitions and Foxglove message path syntax

Project description

ROS Parser

A Python parser for ROS message definitions and Foxglove message path syntax.

Installation

uv add ros-parser

Parsers

  • ros1_msg: Parses ROS1 message definition files (.msg)
  • ros2_msg: Parses ROS2 message definition files (.msg)
  • message_path: Parses Foxglove message path syntax for data access and filtering

Usage

Parsing ROS2 Messages

from ros_parser import ros2_msg

definition = ros2_msg.parse_message_string("""
float64 x
float64 y
float64 z
""")

for field in definition.fields:
    print(f"{field.name}: {field.type}")

Parsing ROS1 Messages

from ros_parser import ros1_msg

definition = ros1_msg.parse_message_string("""
Header header
float64 x
float64 y
float64 z
""")

for field in definition.fields:
    print(f"{field.name}: {field.type}")

Parsing Schema with Dependencies

from ros_parser import parse_schema_to_definitions

# Parse a full schema including embedded type definitions
definitions = parse_schema_to_definitions(
    "geometry_msgs/msg/Pose",
    schema_data
)

Regenerating Standalone Parsers

The project uses Lark to generate standalone parsers from grammar files. If you modify any .lark grammar file, regenerate the parsers:

uv run _generate_standalone.py \
  src/ros_parser/ros1_msg/grammar.lark \
  src/ros_parser/ros2_msg/grammar.lark \
  src/ros_parser/message_path/grammar.lark \
  --output-dir src/ros_parser \
  --lexer contextual

For more details on the message path syntax, see src/ros_parser/message_path/README.md.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ros_parser-0.8.0.tar.gz (82.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ros_parser-0.8.0-py3-none-any.whl (91.3 kB view details)

Uploaded Python 3

File details

Details for the file ros_parser-0.8.0.tar.gz.

File metadata

  • Download URL: ros_parser-0.8.0.tar.gz
  • Upload date:
  • Size: 82.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.29 {"installer":{"name":"uv","version":"0.11.29","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for ros_parser-0.8.0.tar.gz
Algorithm Hash digest
SHA256 ea6f8b2e53766244dbf3153e0dc1d9cc04c87b3dfd10cb80b513dc49118085b1
MD5 380272306d0a6f13b8dc4c6da2f3dcd3
BLAKE2b-256 e3ba508f89464798fd86e45b6572555609a1d195b5852eeb66496922345dcf6c

See more details on using hashes here.

File details

Details for the file ros_parser-0.8.0-py3-none-any.whl.

File metadata

  • Download URL: ros_parser-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 91.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.29 {"installer":{"name":"uv","version":"0.11.29","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for ros_parser-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2472eee8b125be6430fd88f68c0587632b0b30a96e4b1feca63f320600ec981d
MD5 c45d6e26f4e7ccf0924209335d44521d
BLAKE2b-256 62f47df1a1ec680a1f800b8d2cd43799f344ad9a345c1c9416b57eae19a8c325

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page