roschema 0.1.0__tar.gz

roschema-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,47 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    name: lint & type-check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+        with:
+          python-version: "3.12"
+          enable-cache: true
+      - name: Install
+        run: uv sync --extra dev --extra bag
+      - name: Ruff
+        run: uv run ruff check .
+      - name: Mypy
+        run: uv run mypy --strict src
+      - name: Rule docs in sync
+        run: uv run python -m roschema.rules.gendocs --check
+
+  test:
+    name: test (py${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          enable-cache: true
+      - name: Install
+        run: uv sync --extra dev --extra bag
+      - name: Pytest
+        run: uv run pytest -q

roschema-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,52 @@
+name: Release
+
+on:
+  push:
+    tags: ["v*"]
+
+jobs:
+  build:
+    name: build & verify
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+        with:
+          python-version: "3.12"
+          enable-cache: true
+      - name: Install
+        run: uv sync --extra dev --extra bag
+      - name: Test, lint, type-check
+        run: |
+          uv run pytest -q
+          uv run ruff check .
+          uv run mypy --strict src
+          uv run python -m roschema.rules.gendocs --check
+      - name: Tag matches package version
+        run: |
+          version=$(uv run python -c "import roschema; print(roschema.__version__)")
+          tag="${GITHUB_REF_NAME#v}"
+          if [ "$version" != "$tag" ]; then
+            echo "tag $tag does not match roschema.__version__ $version" >&2
+            exit 1
+          fi
+      - name: Build sdist and wheel
+        run: uv build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    name: publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write  # required for Trusted Publishing
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

roschema-0.1.0/.gitignore

@@ -0,0 +1,30 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+uv.lock
+
+# Virtual envs
+.venv/
+venv/
+env/
+
+# Tooling caches
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+.tox/
+
+# Editor / OS
+.idea/
+.vscode/
+*.swp
+.DS_Store
+
+# internal bookkeeping docs
+.docs

roschema-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Saif Sidhik
+
+   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.

roschema-0.1.0/PKG-INFO

@@ -0,0 +1,270 @@
+Metadata-Version: 2.4
+Name: roschema
+Version: 0.1.0
+Summary: Breaking-change detection, linting and formatting for ROS 2 interface definitions
+Project-URL: Homepage, https://github.com/justagist/roschema
+Project-URL: Documentation, https://github.com/justagist/roschema#readme
+Author-email: Saif Sidhik <saif.sidhik@helloleap.ai>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: action,breaking-change,interface,lint,msg,ros,ros2,srv
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Python: >=3.10
+Requires-Dist: rich>=13.0
+Requires-Dist: tomli>=2.0; python_version < '3.11'
+Requires-Dist: typer>=0.12
+Provides-Extra: bag
+Requires-Dist: mcap>=1.1; extra == 'bag'
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pytest>=7.4; extra == 'dev'
+Requires-Dist: ruff>=0.5; extra == 'dev'
+Requires-Dist: tomli>=2.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# roschema
+
+[![CI](https://github.com/justagist/roschema/actions/workflows/ci.yml/badge.svg)](https://github.com/justagist/roschema/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/roschema.svg)](https://pypi.org/project/roschema/)
+[![Python versions](https://img.shields.io/pypi/pyversions/roschema.svg)](https://pypi.org/project/roschema/)
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![Checked with mypy](https://img.shields.io/badge/mypy-strict-blue.svg)](https://mypy-lang.org/)
+
+Catch breaking ROS 2 interface changes in the PR, not on the robot.
+
+`roschema` detects breaking changes, lints and formats ROS 2 interface
+definitions (`.msg`, `.srv`, `.action`) with zero ROS dependencies, so it runs
+in a bare CI container.
+
+![demo](docs/demo.gif)
+<!-- TODO: replace with an animated capture of `roschema check` on a PR. -->
+
+## Quickstart
+
+```bash
+# in a pull request, compare the working tree against the base branch
+uvx roschema check --against origin/main
+```
+
+See the full [rule reference](docs/rules.md) for every check (`RS***`) and lint
+(`RSL***`) rule.
+
+## Checking
+
+```
+roschema check [TARGET] --against REF [--level LEVEL] [--format text|json|github]
+               [--deep] [--exit-zero] [--config PATH] [--exclude GLOB]
+```
+
+`TARGET` is a path, a package name, or a glob (`'src/**'`) that expands to every
+package underneath; omit it for the current workspace.
+
+`--against` accepts a git ref (validated with `git rev-parse`), a directory, an
+MCAP bag (`.mcap`) or a lockfile (`roschema.lock`); the type is auto-detected. A
+git ref is preferred when a directory of the same name also exists -- prefix the
+argument with `./` (e.g. `--against ./main`) to force the directory. Exit codes:
+`0` clean, `1` breaking changes found, `2` tool/usage error. `--exit-zero` forces
+`0`. Warnings alone do not fail (exit `0`).
+
+CDR is positional -- fields are serialised in declaration order with no field
+tags -- so adding, removing, reordering or retyping a field is wire-breaking
+even when your code still compiles. That is why the taxonomy is structural, and
+why the default `source` level already reports wire-level changes.
+
+## Freeze (non-git baselines)
+
+```
+roschema freeze [TARGET] -o roschema.lock
+roschema check  [TARGET] --against roschema.lock
+```
+
+`freeze` writes a lockfile holding each interface's canonical (post-`fmt`) text
+plus a sha256, so a release tarball can carry its own baseline without git.
+`check --against roschema.lock` reads it back (sha256-verified) and compares.
+
+The lockfile records the roschema `tool_version` for provenance; upgrading
+roschema therefore changes that one line on the next `freeze` even when the
+interfaces are identical. It is not read during comparison -- `check` diffs only
+the interface text -- so the churn is cosmetic.
+
+## Deep checking
+
+`check --deep` resolves nested complex types through the workspace and ament
+index and reports transitive breakage (`RS110`): an interface that embeds -
+directly or through nested types - another whose wire layout changed is flagged
+even when its own definition is unchanged, with the causal chain shown. Without
+`--deep`, nested types are compared by name only.
+
+## Linting and formatting
+
+```
+roschema lint [TARGET] [--format text|json|github] [--rules RULE=SEV] [--exit-zero]
+roschema fmt  [TARGET] [--check]
+```
+
+`lint` checks a single tree (no baseline). Naming rules follow rosidl: field
+names snake_case (RSL001), constants UPPER_SNAKE (RSL002), interface names
+PascalCase (RSL003); it also flags deprecated `char`/scalar-`byte` (RSL005) and
+request/response field shadowing in services (RSL010). RSL004 (missing doc) and
+RSL006 (unbounded) are off by default; enable via `[lint.rules]` or per run with
+`--rules` (e.g. `--rules RSL004=warn --rules RSL001=off`; a bare `--rules RSL004`
+means `=warn`). `--rules` is repeatable and beats config.
+
+`fmt` canonically formats interface files (single space between type and name,
+`=` without spaces for constants, one trailing newline) while preserving
+comments, blank lines and section separators. It is idempotent and never
+changes what `check` reports; `--check` exits `1` if any file would change.
+Inline `# roschema: ignore=` suppressions survive formatting.
+
+## Checking against a recorded bag
+
+```
+pip install 'roschema[bag]'
+roschema bag-check recording.mcap [TARGETS...] [--format ...]
+```
+
+`bag-check` reads the interface definitions embedded in an MCAP bag and checks
+whether they are still compatible with your **current environment** - the bag is
+the baseline, so it flags changes that would stop current code from reading the
+recorded data. By default the bag's types are resolved from the ament index
+(`AMENT_PREFIX_PATH`), i.e. the packages installed in the sourced environment,
+so system packages like `sensor_msgs` are compared against their installed
+definitions rather than reported as missing.
+
+Optional `TARGETS` (paths or package names) are overlaid on top of the
+environment, so a package you are editing can be checked from source instead of
+its installed copy. A bag type found in neither the environment nor any target
+is reported as removed (RS040). `ros2msg` schemas (including concatenated
+dependent definitions) are fully supported; `ros2idl` is a best-effort
+conversion of the msg-equivalent subset.
+
+## Compatibility levels
+
+`--level` selects a cumulative bundle of what is reported; the default is
+`source`.
+
+| Level | Reports |
+|---|---|
+| `wire` | CDR byte-stream compatibility only |
+| `source` | wire + generated C++/Python API |
+| `introspection` | source + name-based tooling (bags, echo, YAML) |
+| `behavior` | introspection + semantics (defaults, constant values) |
+
+## Configuration
+
+`roschema.toml` at the workspace root, a per-package `roschema.toml`, or
+`[tool.roschema]` in `pyproject.toml`. Precedence: CLI > package > workspace >
+defaults.
+
+```toml
+[check]
+level = "source"
+
+[check.rules]
+RS008 = "off"          # off | warn | error
+
+[check.allow]
+# intentional breaks need a fully-qualified target and a mandatory reason
+"my_msgs/msg/State.old_field" = { rules = ["RS001"], reason = "removed in 2.0, see #142" }
+```
+
+Inline suppression: a trailing comment on the new-side member line, e.g.
+`float64 theta  # roschema: ignore=RS003` (comma-separate multiple IDs).
+Suppressed findings are counted, not failed.
+
+## JSON output
+
+`--format json` emits a stable document (`version: 1`):
+
+```json
+{
+  "version": 1,
+  "findings": [
+    {
+      "rule": "RS003",
+      "severity": "error",
+      "level": "wire",
+      "package": "my_msgs",
+      "interface": "my_msgs/msg/Pose",
+      "section": "message",
+      "target": "theta",
+      "message": "type changed float32 -> float64",
+      "old": { "file": "my_msgs/msg/Pose.msg", "line": 1 },
+      "new": { "file": "my_msgs/msg/Pose.msg", "line": 1 },
+      "suppressed": false
+    }
+  ],
+  "summary": {
+    "total": 1,
+    "errors": 1,
+    "warnings": 0,
+    "suppressed": 0,
+    "advisories": { "my_msgs": "MAJOR" }
+  }
+}
+```
+
+`old`/`new` are `null` when there is no corresponding side (e.g. a removed
+interface has no `new`). `--format github` emits `::error`/`::warning`
+workflow-command annotations instead.
+
+## GitHub Action
+
+A composite action wraps `uvx roschema check` and posts inline annotations on
+the PR diff:
+
+```yaml
+# .github/workflows/interfaces.yml
+on: pull_request
+jobs:
+  interfaces:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0            # needed for the git-ref baseline
+      - uses: justagist/roschema/action@v1
+        with:
+          against: origin/${{ github.base_ref }}
+          # level: source
+          # deep: "true"
+          # exclude: "vendor_msgs* legacy_msgs/msg/Old"
+```
+
+`against` takes the same values as the CLI (git ref, directory, `.mcap`,
+`roschema.lock`). A lockfile or directory baseline needs no `fetch-depth: 0`
+because it is a plain file in the checkout.
+
+## Rule reference
+
+Every rule, its levels, default severity and rationale is documented in
+[docs/rules.md](docs/rules.md), generated from the rule metadata with
+`python -m roschema.rules.gendocs`.
+
+## Non-goals
+
+roschema deliberately does **not**:
+
+- generate migration or translation rules;
+- parse ROS 1 `.msg` (md5 semantics differ);
+- parse hand-written `.idl` beyond the MCAP-embedded subset;
+- provide any registry or server component;
+- parse `CMakeLists.txt` for discovery (directory convention + ament index only).
+
+## Relationship to REP-2011 and type hashes
+
+These are complementary layers, not alternatives:
+
+- **roschema** prevents *accidental* breaks at PR time, before anything ships.
+- **RIHS type hashes** (REP-2011) detect a pub/sub *mismatch at runtime* -- after
+  the fact, on the robot.
+- **REP-2011 type-description distribution / translation** mitigates *intentional*
+  evolution by carrying enough information to translate between versions.
+
+roschema is the earliest gate: catch the break in review so the later layers
+never have to.