ros-parser 0.1.0__tar.gz

ros_parser-0.1.0/PKG-INFO

@@ -0,0 +1,101 @@
+Metadata-Version: 2.3
+Name: ros-parser
+Version: 0.1.0
+Summary: Python parser for ROS message definitions and Foxglove message path syntax
+Keywords: ros,ros1,ros2,parser,message,robotics
+Author: Marko Bausch
+License: GPL-3.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Compilers
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Project-URL: Homepage, https://github.com/mrkbac/robotic-tools
+Project-URL: Issues, https://github.com/mrkbac/robotic-tools/issues
+Project-URL: Repository, https://github.com/mrkbac/robotic-tools
+Description-Content-Type: text/markdown
+
+# ROS Parser
+
+A Python parser for ROS message definitions and Foxglove message path syntax.
+
+## Installation
+
+```bash
+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
+
+```python
+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
+
+```python
+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
+
+```python
+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:
+
+```bash
+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](src/ros_parser/message_path/README.md).

ros_parser-0.1.0/README.md

@@ -0,0 +1,75 @@
+# ROS Parser
+
+A Python parser for ROS message definitions and Foxglove message path syntax.
+
+## Installation
+
+```bash
+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
+
+```python
+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
+
+```python
+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
+
+```python
+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:
+
+```bash
+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](src/ros_parser/message_path/README.md).

ros_parser-0.1.0/pyproject.toml

@@ -0,0 +1,58 @@
+[project]
+name = "ros-parser"
+version = "0.1.0"
+description = "Python parser for ROS message definitions and Foxglove message path syntax"
+readme = "README.md"
+requires-python = ">=3.10"
+license = {text = "GPL-3.0"}
+authors = [
+    {name = "Marko Bausch"}
+]
+keywords = ["ros", "ros1", "ros2", "parser", "message", "robotics"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Scientific/Engineering",
+    "Topic :: Software Development :: Compilers",
+    "Typing :: Typed",
+]
+dependencies = []
+
+[project.urls]
+Homepage = "https://github.com/mrkbac/robotic-tools"
+Repository = "https://github.com/mrkbac/robotic-tools"
+Issues = "https://github.com/mrkbac/robotic-tools/issues"
+
+[build-system]
+requires = ["uv_build>=0.8.9,<0.9.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "lark>=1.3.0",
+]
+
+[tool.mypy]
+strict = true
+python_version = "3.10"
+exclude = [
+    "^.*/_standalone.*\\.py$",
+    "^.*/_lark_standalone.*\\.py$",
+]
+
+[tool.ruff]
+extend = "../pyproject.toml"
+extend-exclude = [
+    '**/_standalone*.py',
+    '**/_lark_standalone*.py',
+    'tests/reference_parser.py',
+    '_generate_standalone.py',
+]

ros_parser-0.1.0/src/ros_parser/__init__.py

@@ -0,0 +1,44 @@
+"""ROS message, service, and action definition parser.
+
+Supports both ROS1 and ROS2 message formats.
+
+For ROS2, use:
+    from ros_parser.ros2_msg import parse_message_string
+    from ros_parser import ros2_msg
+
+For ROS1, use:
+    from ros_parser.ros1_msg import parse_message_string
+    from ros_parser import ros1_msg
+
+For shared models:
+    from ros_parser.models import MessageDefinition, Field, Type, Constant
+"""
+
+from . import ros1_msg, ros2_msg
+from .message_path import ValidationError
+from .models import (
+    PRIMITIVE_TYPE_NAMES,
+    ActionDefinition,
+    Constant,
+    Field,
+    MessageDefinition,
+    PrimitiveType,
+    ServiceDefinition,
+    Type,
+)
+from .ros2_msg.schema_parser import parse_schema_to_definitions
+
+__all__ = [
+    "PRIMITIVE_TYPE_NAMES",
+    "ActionDefinition",
+    "Constant",
+    "Field",
+    "MessageDefinition",
+    "PrimitiveType",
+    "ServiceDefinition",
+    "Type",
+    "ValidationError",
+    "parse_schema_to_definitions",
+    "ros1_msg",
+    "ros2_msg",
+]