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.5.0.tar.gz (74.3 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.5.0-py3-none-any.whl (82.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ros_parser-0.5.0.tar.gz
  • Upload date:
  • Size: 74.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","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.5.0.tar.gz
Algorithm Hash digest
SHA256 39a72214f84e3d34e85b8db3e020af6468902f66be5a7fdbddcd1a1cf9a92f2f
MD5 08d76c73f4b02a719e044c675b309084
BLAKE2b-256 22d87cee14c0cf4925692ff270f41c7cf847ca9acb6cf5300fc405c2e9e167d0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ros_parser-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 82.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","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.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5e4f83321cc9d63026ba71276dcbb52706634aa97bb06b2bce5236daa65f7c41
MD5 70378b4f3a1798afd4428e2249d50304
BLAKE2b-256 ba7a37f6801ac2cd0e81798f63e03f2541d4c789d62be897114174aac4927688

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