diff --git a/.commitlintrc.yml b/.commitlintrc.yml
new file mode 100644
index 0000000..ae711cf
--- /dev/null
+++ b/.commitlintrc.yml
@@ -0,0 +1,24 @@
+# SPDX-FileCopyrightText: Copyright DB InfraGO AG and the capellambse contributors
+# SPDX-License-Identifier: CC0-1.0
+rules:
+ body-leading-blank: [2, always]
+ footer-leading-blank: [2, always]
+ scope-case: [2, always, lower-case]
+ subject-case: [2, always, sentence-case]
+ subject-empty: [2, never]
+ subject-full-stop: [2, never, .]
+ subject-max-length: [2, always, 72]
+ type-empty: [2, never]
+ type-enum: [2, always, [
+ build,
+ chore,
+ ci,
+ docs,
+ feat,
+ fix,
+ merge,
+ perf,
+ refactor,
+ revert,
+ test,
+ ]]
diff --git a/.git_archival.txt b/.git_archival.txt
index 1c1d2e8..5a4899c 100644
--- a/.git_archival.txt
+++ b/.git_archival.txt
@@ -1,4 +1,4 @@
-Copyright DB Netz AG and contributors
+Copyright DB InfraGO AG and contributors
SPDX-License-Identifier: CC0-1.0
node: $Format:%H$
diff --git a/.gitattributes b/.gitattributes
index de62da1..e9dd5d5 100644
--- a/.gitattributes
+++ b/.gitattributes
@@ -1,4 +1,4 @@
-# Copyright DB Netz AG and contributors
+# Copyright DB InfraGO AG and contributors
# SPDX-License-Identifier: CC0-1.0
* text=auto
diff --git a/.github/workflows/build-test-publish.yml b/.github/workflows/build-test-publish.yml
index 5b03088..5db9f4d 100644
--- a/.github/workflows/build-test-publish.yml
+++ b/.github/workflows/build-test-publish.yml
@@ -1,4 +1,4 @@
-# Copyright DB Netz AG and contributors
+# Copyright DB InfraGO AG and contributors
# SPDX-License-Identifier: CC0-1.0
name: Build
@@ -18,11 +18,12 @@ jobs:
matrix:
os: [ubuntu-latest]
python_version:
- - "3.9"
- "3.10"
+ - "3.11"
+ - "3.12"
include:
- os: windows-latest
- python_version: "3.9"
+ python_version: "3.10"
steps:
- uses: actions/checkout@v2
- name: Set up Python ${{matrix.python_version}}
@@ -55,7 +56,7 @@ jobs:
- name: Setup Python
uses: actions/setup-python@v2
with:
- python-version: "3.9"
+ python-version: "3.10"
- name: Install dependencies
run: |-
python -m pip install -U pip
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 45fe026..8307775 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -1,4 +1,4 @@
-# Copyright DB Netz AG and contributors
+# Copyright DB InfraGO AG and contributors
# SPDX-License-Identifier: CC0-1.0
name: Docs
@@ -18,7 +18,7 @@ jobs:
fetch-depth: 0
- uses: actions/setup-python@v2
with:
- python-version: "3.9"
+ python-version: "3.10"
- name: Upgrade pip
run: |
python -m pip install -U pip
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
index 1decfee..26dc57f 100644
--- a/.github/workflows/lint.yml
+++ b/.github/workflows/lint.yml
@@ -1,4 +1,4 @@
-# Copyright DB Netz AG and contributors
+# Copyright DB InfraGO AG and contributors
# SPDX-License-Identifier: CC0-1.0
name: Lint
@@ -14,7 +14,7 @@ jobs:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
with:
- python-version: "3.9"
+ python-version: "3.10"
- name: Upgrade pip
run: |-
python -m pip install -U pip
@@ -30,7 +30,7 @@ jobs:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
with:
- python-version: "3.9"
+ python-version: "3.10"
- name: Upgrade pip
run: |-
python -m pip install -U pip
diff --git a/.github/workflows/pr-target.yml b/.github/workflows/pr-target.yml
new file mode 100644
index 0000000..ab7c0ae
--- /dev/null
+++ b/.github/workflows/pr-target.yml
@@ -0,0 +1,81 @@
+# SPDX-FileCopyrightText: Copyright DB InfraGO AG and the capellambse contributors
+# SPDX-License-Identifier: CC0-1.0
+
+name: Conventional Commits
+
+on:
+ pull_request_target:
+ types: [opened, synchronize]
+
+permissions:
+ contents: read
+ pull-requests: write
+
+jobs:
+ conventional-commits:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout the base branch
+ # Commitlint will use the configuration that is checked out; i.e. in
+ # this case it will use the config from the PR's base branch, which
+ # must have already been approved by someone with repo write access.
+ #
+ # Because commitlint accepts arbitrary JavaScript as configuration,
+ # this is necessary to prevent code injection attacks. Combined with
+ # the `pull-requests: write` permission needed for posting comments,
+ # this could potentially allow an attacker to merge any code into any
+ # branch.
+ #
+ # However, it also means that (good) pull requests intended to change
+ # or extend the config will be validated against the old config, which
+ # may cause false errors.
+ uses: actions/checkout@v3
+ with:
+ ref: ${{ github.event.pull_request.base.ref }}
+
+ - name: Pull the PR
+ run: git fetch origin +${{ github.event.pull_request.head.sha }}
+
+ - name: Install commitlint
+ run: npm install -g @commitlint/cli
+
+ - name: Validate commit messages
+ id: conventional-commits
+ continue-on-error: true
+ env:
+ SHA_FROM: ${{ github.event.pull_request.base.sha }}
+ SHA_TO: ${{ github.event.pull_request.head.sha }}
+ run: |
+ delim="_EOF_$(uuidgen)"
+ echo "validation-result<<$delim" >> "$GITHUB_OUTPUT"
+ r=0
+ commitlint --from "$SHA_FROM" --to "$SHA_TO" >> "$GITHUB_OUTPUT" 2>&1 || r=$?
+ echo "$delim" >> "$GITHUB_OUTPUT"
+ exit $r
+
+ - name: Post comment if validation failed
+ if: steps.conventional-commits.outcome == "failure"
+ env:
+ GH_TOKEN: ${{ github.token }}
+ PR_NUMBER: ${{ github.event.pull_request.number }}
+ TEXT: |-
+ The pull request does not conform to the conventional commit specification. Please ensure that your commit messages follow the spec:
+
+
+
+ We also strongly recommend that you set up your development environment with pre-commit, as described in our [CONTRIBUTING guidelines](https://github.com/DSD-DBS/py-capellambse/blob/master/CONTRIBUTING.rst). This will run all the important checks right before you commit your changes, and avoids lengthy CI wait time and round trips.
+
+ The following commits failed to validate:
+
+ ```
+ ${{ steps.conventional-commits.outputs.validation-result }}
+ ```
+
+ Here are some examples of valid commit messages:
+
+ ```
+ feat(model): Add realized_states to State and Mode
+ fix(aird): Fix ZeroDivisionError with zero-sized circles
+ docs(readme): Update project description
+ ```
+ run: 'gh pr comment "$PR_NUMBER" -F - <<< "$TEXT"'
diff --git a/.gitignore b/.gitignore
index 975287e..6dddc2e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,4 +1,4 @@
-# Copyright DB Netz AG and contributors
+# Copyright DB InfraGO AG and contributors
# SPDX-License-Identifier: CC0-1.0
# Byte-compiled / optimized / DLL files
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 7315f4a..1919daf 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -1,11 +1,11 @@
-# Copyright DB Netz AG and contributors
+# Copyright DB InfraGO AG and contributors
# SPDX-License-Identifier: CC0-1.0
default_install_hook_types: [commit-msg, pre-commit]
default_stages: [commit, merge-commit]
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
- rev: v4.4.0
+ rev: v4.5.0
hooks:
- id: check-added-large-files
- id: check-ast
@@ -26,11 +26,11 @@ repos:
- id: fix-byte-order-marker
- id: trailing-whitespace
- repo: https://github.com/psf/black-pre-commit-mirror
- rev: 23.9.1
+ rev: 23.12.1
hooks:
- id: black
- repo: https://github.com/PyCQA/isort
- rev: 5.12.0
+ rev: 5.13.2
hooks:
- id: isort
- repo: https://github.com/PyCQA/docformatter
@@ -47,11 +47,11 @@ repos:
additional_dependencies:
- pydocstyle[toml]
- repo: https://github.com/pre-commit/mirrors-mypy
- rev: v1.5.1
+ rev: v1.8.0
hooks:
- id: mypy
- repo: https://github.com/Lucas-C/pre-commit-hooks
- rev: v1.4.2
+ rev: v1.5.4
hooks:
- id: insert-license
name: Insert license headers (shell-style comments)
@@ -98,6 +98,6 @@ repos:
hooks:
- id: reuse
- repo: https://github.com/qoomon/git-conventional-commits
- rev: v2.6.5
+ rev: v2.6.7
hooks:
- id: conventional-commits
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 3bd1561..fa1edc1 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,5 +1,5 @@
@@ -32,10 +32,14 @@ pytest
We additionally recommend that you set up your editor / IDE as follows.
+- Indent with 4 spaces per level of indentation
- Indent with 4 spaces per level of indentation
+- Maximum line length of 79 (add a ruler / thin line / highlighting / ...)
- Maximum line length of 79 (add a ruler / thin line / highlighting / ...)
+- _If you use Visual Studio Code_: Consider using a platform which supports
+ third-party language servers more easily, and continue with the next point.
- _If you use Visual Studio Code_: Consider using a platform which supports
third-party language servers more easily, and continue with the next point.
@@ -51,19 +55,40 @@ We additionally recommend that you set up your editor / IDE as follows.
}
```
+ ```json
+ "[python]": {
+ "editor.codeActionsOnSave": {
+ "source.organizeImports": true
+ }
+ }
+ ```
+
+ Note that the Pylance language server is not recommended, as it occasionally
+ causes false-positive errors for perfectly valid code.
Note that the Pylance language server is not recommended, as it occasionally
causes false-positive errors for perfectly valid code.
+- _If you do not use VSC_: Set up your editor to use the [python-lsp-server],
+ and make sure that the relevant plugins are installed. You can install
+ everything that's needed into the virtualenv with pip:
- _If you do not use VSC_: Set up your editor to use the [python-lsp-server],
and make sure that the relevant plugins are installed. You can install
everything that's needed into the virtualenv with pip:
+ [python-lsp-server]: https://github.com/python-lsp/python-lsp-server
[python-lsp-server]: https://github.com/python-lsp/python-lsp-server
```sh
pip install "python-lsp-server[pylint]" python-lsp-black pyls-isort pylsp-mypy
```
+ ```sh
+ pip install "python-lsp-server[pylint]" python-lsp-black pyls-isort pylsp-mypy
+ ```
+
+ This will provide as-you-type linting as well as automatic formatting on
+ save. Language server clients are available for a wide range of editors, from
+ Vim/Emacs to PyCharm/IDEA.
This will provide as-you-type linting as well as automatic formatting on
save. Language server clients are available for a wide range of editors, from
Vim/Emacs to PyCharm/IDEA.
@@ -74,27 +99,47 @@ We base our code style on a modified version of the
[Google style guide for Python code](https://google.github.io/styleguide/pyguide.html).
The key differences are:
+- **Docstrings**: The [Numpy style guide] applies here.
- **Docstrings**: The [Numpy style guide] applies here.
[numpy style guide]: https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard
+ [numpy style guide]: https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard
+ When writing docstrings for functions, use the imperative style, as per
+ [PEP-257]). For example, write "Do X and Y" instead of "Does X and Y".
When writing docstrings for functions, use the imperative style, as per
[PEP-257]). For example, write "Do X and Y" instead of "Does X and Y".
[pep-257]: https://peps.python.org/pep-0257/
+ [pep-257]: https://peps.python.org/pep-0257/
+- **Overridden methods**: If the documentation did not change from the base
+ class (i.e. the base class' method's docstring still applies without
+ modification), do not add a short docstring á la "See base class". This lets
+ automated tools pick up the full base class docstring instead, and is
+ therefore more useful in IDEs etc.
- **Overridden methods**: If the documentation did not change from the base
class (i.e. the base class' method's docstring still applies without
modification), do not add a short docstring á la "See base class". This lets
automated tools pick up the full base class docstring instead, and is
therefore more useful in IDEs etc.
+- **Linting**: Use [pylint] for static code analysis, and [mypy] for static
+ type checking.
- **Linting**: Use [pylint] for static code analysis, and [mypy] for static
type checking.
[pylint]: https://github.com/PyCQA/pylint
[mypy]: https://github.com/python/mypy
+ [pylint]: https://github.com/PyCQA/pylint
+ [mypy]: https://github.com/python/mypy
+- **Formatting**: Use [black] as code auto-formatter. The maximum line length
+ is 79, as per [PEP-8]. This setting should be automatically picked up from
+ the `pyproject.toml` file. The reason for the shorter line length is that it
+ avoids wrapping and overflows in side-by-side split views (e.g. diffs) if
+ there's also information displayed to the side of it (e.g. a tree view of the
+ modified files).
- **Formatting**: Use [black] as code auto-formatter. The maximum line length
is 79, as per [PEP-8]. This setting should be automatically picked up from
the `pyproject.toml` file. The reason for the shorter line length is that it
@@ -102,33 +147,42 @@ The key differences are:
there's also information displayed to the side of it (e.g. a tree view of the
modified files).
+ [black]: https://github.com/psf/black
+ [pep-8]: https://www.python.org/dev/peps/pep-0008/
[black]: https://github.com/psf/black
[pep-8]: https://www.python.org/dev/peps/pep-0008/
+ Be aware of the different line length of 72 for docstrings. We currently do
+ not have a satisfactory solution to automatically apply or enforce this.
Be aware of the different line length of 72 for docstrings. We currently do
not have a satisfactory solution to automatically apply or enforce this.
+ Note that, while you're encouraged to do so in general, it is not a hard
+ requirement to break up long strings into smaller parts. Additionally, never
+ break up strings that are presented to the user in e.g. log messages, as that
+ makes it significantly harder to grep for them.
Note that, while you're encouraged to do so in general, it is not a hard
requirement to break up long strings into smaller parts. Additionally, never
break up strings that are presented to the user in e.g. log messages, as that
makes it significantly harder to grep for them.
+ Use [isort] for automatic sorting of imports. Its settings should
+ automatically be picked up from the `pyproject.toml` file as well.
Use [isort] for automatic sorting of imports. Its settings should
automatically be picked up from the `pyproject.toml` file as well.
[isort]: https://github.com/PyCQA/isort
+ [isort]: https://github.com/PyCQA/isort
+- **Typing**: We do not make an exception for `typing` imports. Instead of
+ writing `from typing import SomeName`, use `import typing as t` and access
+ typing related classes like `t.TypedDict`.
- **Typing**: We do not make an exception for `typing` imports. Instead of
writing `from typing import SomeName`, use `import typing as t` and access
typing related classes like `t.TypedDict`.
- Use the new syntax and classes for typing introduced with Python 3.10 and available using
- `from __future__ import annotations` since Python 3.8.
-
- Be aware however that this only works in the context of annotations; the code
- still needs to run on Python 3.9! This means that in some (rare) cases, you _must_ use the
- old-style type hints.
+ Use the new syntax and classes for typing introduced with Python 3.10.
- Instead of `t.Tuple`, `t.List` etc. use the builtin classes `tuple`, `list`
etc.
@@ -140,13 +194,22 @@ The key differences are:
`t.Optional[...]` and always explicitly annotate where `None` is possible.
[pep-604-style unions]: https://www.python.org/dev/peps/pep-0604/
+ [pep-604-style unions]: https://www.python.org/dev/peps/pep-0604/
+- **Python style rules**: For conflicting parts, the [Black code style] wins.
+ If you have set up black correctly, you don't need to worry about this though
+ :)
- **Python style rules**: For conflicting parts, the [Black code style] wins.
If you have set up black correctly, you don't need to worry about this though
:)
[black code style]: https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html
+ [black code style]: https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html
+- When working with `dict`s, consider using `t.TypedDict` instead of a more
+ generic `dict[str, float|int|str]`-like annotation where possible, as the
+ latter is much less precise (often requiring additional `assert`s or
+ `isinstance` checks to pass) and can grow unwieldy very quickly.
- When working with `dict`s, consider using `t.TypedDict` instead of a more
generic `dict[str, float|int|str]`-like annotation where possible, as the
latter is much less precise (often requiring additional `assert`s or
@@ -154,3 +217,5 @@ The key differences are:
- Prefer `t.NamedTuple` over `collections.namedtuple`, because the former uses
a more convenient `class ...:` syntax and also supports type annotations.
+- Prefer `t.NamedTuple` over `collections.namedtuple`, because the former uses
+ a more convenient `class ...:` syntax and also supports type annotations.
diff --git a/LICENSES/.license_header.txt b/LICENSES/.license_header.txt
index c3fb022..dfb50dd 100644
--- a/LICENSES/.license_header.txt
+++ b/LICENSES/.license_header.txt
@@ -1,2 +1,6 @@
+<<<<<<< HEAD
Copyright DB Netz AG and contributors
+=======
+Copyright DB InfraGO AG and contributors
+>>>>>>> 40ef464 (feat: Make tree view draggable)
SPDX-License-Identifier: Apache-2.0
diff --git a/README.md b/README.md
index 6f3eed9..70e3862 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
@@ -8,7 +8,7 @@
-API and scripts to parse .msg files and convert them to Capella
+Tool for converting ROS messages from and to Capella models.
# Documentation
@@ -48,7 +48,7 @@ look at our [guidelines for contributors](CONTRIBUTING.md) for details.
This project is compliant with the
[REUSE Specification Version 3.0](https://git.fsfe.org/reuse/docs/src/commit/d173a27231a36e1a2a3af07421f5e557ae0fec46/spec.md).
-Copyright DB Netz AG, licensed under Apache 2.0 (see full text in
+Copyright DB InfraGO AG, licensed under Apache 2.0 (see full text in
[LICENSES/Apache-2.0.txt](LICENSES/Apache-2.0.txt))
Dot-files are licensed under CC0-1.0 (see full text in
diff --git a/capella_ros_tools/__init__.py b/capella_ros_tools/__init__.py
index c41de8b..b1ace6b 100644
--- a/capella_ros_tools/__init__.py
+++ b/capella_ros_tools/__init__.py
@@ -1,7 +1,6 @@
-# Copyright DB Netz AG and contributors
+# Copyright DB InfraGO AG and contributors
# SPDX-License-Identifier: Apache-2.0
"""The capella_ros_tools package."""
-
from importlib import metadata
try:
diff --git a/capella_ros_tools/__main__.py b/capella_ros_tools/__main__.py
index c40c1db..755444a 100644
--- a/capella_ros_tools/__main__.py
+++ b/capella_ros_tools/__main__.py
@@ -1,4 +1,4 @@
-# Copyright DB Netz AG and contributors
+# Copyright DB InfraGO AG and contributors
# SPDX-License-Identifier: Apache-2.0
"""Main entry point into capella_ros_tools."""
@@ -10,8 +10,8 @@
import click
import capella_ros_tools
-from capella_ros_tools.display import app
from capella_ros_tools.scripts import capella2msg, msg2capella
+from capella_ros_tools.snapshot import app
@click.command()
@@ -27,9 +27,8 @@
default="c" if sys.stdin.isatty() else "a",
help="Default action when an element already exists: (c)heck, (k)eep, (o)verwrite, (a)bort.",
)
-@click.option("--port", "-p", type=int, help="Port for HTML display.")
+@click.option("--port", type=int, help="Port for HTML display.")
@click.option(
- "--in",
"-i",
"in_",
nargs=2,
@@ -38,8 +37,8 @@
help="Input file type and path.",
)
@click.option(
- "--out",
"-o",
+ "out",
nargs=2,
type=(
click.Choice(["capella", "messages"]),
@@ -49,8 +48,8 @@
help="Output file type and path.",
)
@click.option(
- "--layer",
"-l",
+ "layer",
type=click.Choice(["oa", "sa", "la", "pa"], case_sensitive=True),
required=True,
help="Layer to use.",
@@ -91,16 +90,18 @@ def cli(
input = (
input
if input.exists()
- else capellambse.filehandler.get_filehandler(input_path).rootdir
+ else capellambse.filehandler.get_filehandler(input_path)
)
msg_path, capella_path, convert_class = (
- (input, output, msg2capella.Converter)
+ (input.rootdir, output, msg2capella.Converter)
if input_type == "messages"
else (output, input, capella2msg.Converter)
)
- converter = convert_class(msg_path, capella_path, layer, action, no_deps)
+ converter: t.Any = convert_class(
+ msg_path, capella_path, layer, action, no_deps
+ )
converter.convert()
if port:
diff --git a/capella_ros_tools/modules/__init__.py b/capella_ros_tools/modules/__init__.py
index b4f5599..c253554 100644
--- a/capella_ros_tools/modules/__init__.py
+++ b/capella_ros_tools/modules/__init__.py
@@ -1,3 +1,3 @@
-# Copyright DB Netz AG and contributors
+# Copyright DB InfraGO AG and contributors
# SPDX-License-Identifier: Apache-2.0
-"""Capella_ros_tools modules."""
+"""The modules package."""
diff --git a/capella_ros_tools/modules/capella/__init__.py b/capella_ros_tools/modules/capella/__init__.py
index 1859e4d..2449cb0 100644
--- a/capella_ros_tools/modules/capella/__init__.py
+++ b/capella_ros_tools/modules/capella/__init__.py
@@ -1,6 +1,7 @@
-# Copyright DB Netz AG and contributors
+# Copyright DB InfraGO AG and contributors
# SPDX-License-Identifier: Apache-2.0
-"""Capella model definition."""
+"""The capella module."""
+
import typing as t
import capellambse
@@ -11,7 +12,7 @@ class EnumValue(t.NamedTuple):
type: str
name: str
- value: int
+ value: str
description: str
@@ -29,8 +30,8 @@ class ClassProperty(t.NamedTuple):
type_name: str
type_pkg_name: str
name: str
- min_card: float
- max_card: float
+ min_card: str
+ max_card: str
description: str
@@ -43,7 +44,7 @@ class ClassDef(t.NamedTuple):
class BaseCapellaModel:
- """Base class for capella model."""
+ """Base class for Capella model."""
def __init__(
self,
diff --git a/capella_ros_tools/modules/capella/parser.py b/capella_ros_tools/modules/capella/parser.py
index 3d779c2..da98504 100644
--- a/capella_ros_tools/modules/capella/parser.py
+++ b/capella_ros_tools/modules/capella/parser.py
@@ -1,4 +1,4 @@
-# Copyright DB Netz AG and contributors
+# Copyright DB InfraGO AG and contributors
# SPDX-License-Identifier: Apache-2.0
"""Parser for Capella model."""
import typing as t
diff --git a/capella_ros_tools/modules/capella/serializer.py b/capella_ros_tools/modules/capella/serializer.py
index 9d39185..ff94cc2 100644
--- a/capella_ros_tools/modules/capella/serializer.py
+++ b/capella_ros_tools/modules/capella/serializer.py
@@ -1,4 +1,4 @@
-# Copyright DB Netz AG and contributors
+# Copyright DB InfraGO AG and contributors
# SPDX-License-Identifier: Apache-2.0
"""Serializer for Capella model."""
import logging
@@ -13,7 +13,7 @@
class CapellaModel(BaseCapellaModel):
- """Capella model definition for serializing model."""
+ """Capella model definition for serialized model."""
def create_packages(
self, packages: list[str], package: t.Any = None
@@ -108,15 +108,15 @@ def create_enums(
return overlap
- def delete_enums(self, types: list, package: t.Any = None) -> None:
- """Delete types in Capella model."""
+ def delete_enums(self, enums: list, package: t.Any = None) -> None:
+ """Delete enums in Capella model."""
if package is None:
package = self.data
- for type in types:
+ for enum in enums:
try:
- package.datatypes.remove(type)
- logger.info("Deleted %s.", type.name)
+ package.datatypes.remove(enum)
+ logger.info("Deleted %s.", enum.name)
except ValueError:
pass
@@ -171,10 +171,10 @@ def create_properties(self, cls: ClassDef, package: t.Any):
type=superclass,
kind="ASSOCIATION",
min_card=capellambse.new_object(
- "LiteralNumericValue", value=1
+ "LiteralNumericValue", value="1"
),
max_card=capellambse.new_object(
- "LiteralNumericValue", value=1
+ "LiteralNumericValue", value="1"
),
)
self._set_cardinality(composition, prop)
diff --git a/capella_ros_tools/modules/messages/__init__.py b/capella_ros_tools/modules/messages/__init__.py
index ae0ea70..74e18ef 100644
--- a/capella_ros_tools/modules/messages/__init__.py
+++ b/capella_ros_tools/modules/messages/__init__.py
@@ -1,22 +1,26 @@
-# Copyright DB Netz AG and contributors
+# Copyright DB InfraGO AG and contributors
# SPDX-License-Identifier: Apache-2.0
-"""IDL Message definition.""" ""
+"""The messages module."""
+
import typing as t
class BaseTypeDef:
- """Type definition for a field or constant in a message."""
+ """Base type definition for a field or constant in a message."""
def __init__(
self,
name: str,
- array_size: float | None = None,
+ array_size: str | None = None,
pkg_name: str | None = None,
) -> None:
self.name = name
"""Name of the type."""
self.array_size = array_size
- """Max size of the array."""
+ """Max size of the array.
+
+ None: type is not an array
+ """
self.pkg_name = pkg_name
"""Name of the package the type is defined in.
@@ -62,7 +66,7 @@ def __init__(
class BaseMessageDef:
- """Definition of a message."""
+ """Base definition of a message."""
def __init__(
self,
@@ -85,7 +89,8 @@ def _repr_html_(self):
)
for field in self.fields:
fragments.append(
- f'
{field.type.pkg_name+"/" if field.type.pkg_name else ""}{field.type.name}{"[]" if field.type.array_size == float("inf") else f"[{field.type.array_size}]" if field.type.array_size else ""} {field.name} '
+ f"
{field.type.pkg_name+'/' if field.type.pkg_name else ''}"
+ f"{field.type.name}{'[]' if field.type.array_size == '*' else f'[{field.type.array_size}]' if field.type.array_size else ''} {field.name} "
+ " ".join(field.annotations)
+ "
"
)
@@ -109,7 +114,7 @@ def _repr_html_(self):
class BaseMessagePkgDef:
- """Definition of a message package."""
+ """Base definition of a message package."""
def __init__(self, name: str, messages: list, packages: list):
self.name = name
@@ -117,4 +122,10 @@ def __init__(self, name: str, messages: list, packages: list):
self.packages = packages
def _repr_html_(self):
- return f'
{self.name}
Messages
{"".join([f"
{msg.name}
" for msg in self.messages])}
Packages
{"".join([f"
{pkg.name}
" for pkg in self.packages])}'
+ return (
+ f"
{self.name}
Messages
"
+ f"{''.join([f'
{msg.name}
' for msg in self.messages])}"
+ "
Packages
"
+ f"{''.join([f'
{pkg.name}
' for pkg in self.packages])}"
+ ""
+ )
diff --git a/capella_ros_tools/modules/messages/parser.py b/capella_ros_tools/modules/messages/parser.py
index 4e615aa..fb647d0 100644
--- a/capella_ros_tools/modules/messages/parser.py
+++ b/capella_ros_tools/modules/messages/parser.py
@@ -1,4 +1,4 @@
-# Copyright DB Netz AG and contributors
+# Copyright DB InfraGO AG and contributors
# SPDX-License-Identifier: Apache-2.0
"""Parser for IDL messages."""
import os
@@ -51,7 +51,7 @@
class TypeDef(BaseTypeDef):
- """Type definition for a field or constant in a message."""
+ """Type definition for a field or constant in a parsed message."""
def __init__(self, type_string: str) -> None:
super().__init__(type_string)
@@ -61,13 +61,12 @@ def __init__(self, type_string: str) -> None:
index = type_string.rindex("[")
array_size_string = type_string[index + 1 : -1]
if array_size_string:
- array_size_string = array_size_string.lstrip(
+ self.array_size = array_size_string.lstrip(
ARRAY_UPPER_BOUND_TOKEN
)
- self.array_size = float(array_size_string)
else:
# dynamic array
- self.array_size = float("inf")
+ self.array_size = "*"
type_string = type_string[:index]
@@ -83,7 +82,7 @@ def __init__(self, type_string: str) -> None:
def _extract_file_level_comments(message_string: str):
- """Extract comments at the beginning of the message file."""
+ """Extract comments at the beginning of the message."""
lines = message_string.splitlines()
if lines and not lines[0].strip():
lines = lines[1:]
@@ -100,18 +99,18 @@ def _extract_file_level_comments(message_string: str):
class MessageDef(BaseMessageDef):
- """Message definition for a ROS message."""
+ """Definition of a message for parsed messages."""
@classmethod
def from_msg_file(cls, msg_file: t.Any):
- """Create a message definition from a message file."""
+ """Create message definition from a .msg file."""
msg_name = msg_file.stem
message_string = msg_file.read_text()
return cls.from_msg_string(msg_name, message_string)
@classmethod
def from_msg_string(cls, msg_name: str, message_string: str):
- """Create a message definition from a message string."""
+ """Create message definition from a message string."""
message_comments, lines = _extract_file_level_comments(message_string)
msg = cls(msg_name, [], [], message_comments)
last_element: t.Any = msg
@@ -207,7 +206,7 @@ def _rename_enum(enum: EnumDef):
def _process_enums(msg):
- """Condense enums and renames them if necessary."""
+ """Condense enums and rename them if necessary."""
if len(msg.enums) == 0:
return
@@ -270,7 +269,7 @@ def _process_enums(msg):
def _process_comments(instance):
- """Condense comment lines and extracts special annotations."""
+ """Condense comment lines and extract special annotations."""
lines = instance.annotations
if not lines:
return
@@ -302,11 +301,11 @@ def _process_comments(instance):
class MessagePkgDef(BaseMessagePkgDef):
- """Message package definition for ROS message package."""
+ """Definition of a message package for parsed messages."""
@classmethod
def from_msg_folder(cls, package_name: str, msg_pkg_dir: t.Any):
- """Create a message package definition from folder."""
+ """Create MessagePkgDef from a folder of .msg files."""
msg_pkg = cls(package_name, [], [])
for msg_file in msg_pkg_dir.iterdir():
if msg_file.suffix == ".msg":
@@ -319,7 +318,7 @@ def from_msg_folder(cls, package_name: str, msg_pkg_dir: t.Any):
@classmethod
def from_pkg_folder(cls, root_dir: t.Any, root_dir_name: str = "root"):
- """Create a package package definition from a package folder."""
+ """Create MessagePkgDef from a folder of messagefolders."""
out = cls("", [], [])
for dir in root_dir.rglob("msg"):
out.packages.append(
diff --git a/capella_ros_tools/modules/messages/serializer.py b/capella_ros_tools/modules/messages/serializer.py
index 37206b6..6f5a18e 100644
--- a/capella_ros_tools/modules/messages/serializer.py
+++ b/capella_ros_tools/modules/messages/serializer.py
@@ -1,4 +1,4 @@
-# Copyright DB Netz AG and contributors
+# Copyright DB InfraGO AG and contributors
# SPDX-License-Identifier: Apache-2.0
"""Serializer for IDL messages."""
from pathlib import Path
@@ -10,7 +10,7 @@
class MessageDef(BaseMessageDef):
- """Message definition for a ROS message."""
+ """Definition of a message for serialized messages."""
def to_msg_file(self, msg_file: Path):
"""Write message to file."""
@@ -39,7 +39,7 @@ def to_msg_string(self) -> str:
f"{(field.type.pkg_name + '/') if field.type.pkg_name else ''}"
)
msg_string += f"{field.type.name}"
- if field.type.array_size == float("inf"):
+ if field.type.array_size == "*":
msg_string += "[]"
elif field.type.array_size:
msg_string += f"[{field.type.array_size}]"
@@ -51,10 +51,10 @@ def to_msg_string(self) -> str:
class MessagePkgDef(BaseMessagePkgDef):
- """Message package definition for ROS message package."""
+ """Definition of message package for serialized messages."""
def to_msg_folder(self, msg_pkg_dir: Path):
- """Write message package to folder."""
+ """Write messages and packages to a folder of .msg files."""
msg_pkg_dir.mkdir(parents=True, exist_ok=True)
for msg in self.messages:
msg.to_msg_file(msg_pkg_dir / f"{msg.name}.msg")
@@ -62,7 +62,7 @@ def to_msg_folder(self, msg_pkg_dir: Path):
pkg.to_msg_folder(msg_pkg_dir / pkg.name)
def to_pkg_folder(self, pkg_dir: Path):
- """Write packages to folder."""
+ """Write packages to a folder of message folders."""
pkg_dir.mkdir(parents=True, exist_ok=True)
for pkg in self.packages:
pkg.to_msg_folder(pkg_dir / pkg.name / "msg")
diff --git a/capella_ros_tools/scripts/__init__.py b/capella_ros_tools/scripts/__init__.py
index 46ca00d..a999ec1 100644
--- a/capella_ros_tools/scripts/__init__.py
+++ b/capella_ros_tools/scripts/__init__.py
@@ -1,4 +1,3 @@
-# Copyright DB Netz AG and contributors
+# Copyright DB InfraGO AG and contributors
# SPDX-License-Identifier: Apache-2.0
-"""The scripts package.""" ""
-modules = ["capella2msg", "msg2capella"]
+"""The scripts package."""
diff --git a/capella_ros_tools/scripts/capella2msg.py b/capella_ros_tools/scripts/capella2msg.py
index a085ad8..1655b87 100644
--- a/capella_ros_tools/scripts/capella2msg.py
+++ b/capella_ros_tools/scripts/capella2msg.py
@@ -1,4 +1,4 @@
-# Copyright DB Netz AG and contributors
+# Copyright DB InfraGO AG and contributors
# SPDX-License-Identifier: Apache-2.0
"""Convert Capella data to ROS messages."""
import typing as t
@@ -34,7 +34,7 @@
class Converter:
- """Convert Capella data to ROS messages."""
+ """Converter class for converting Capella data to ROS messages."""
def __init__(
self,
@@ -51,7 +51,6 @@ def __init__(
self.no_deps = no_deps
def _add_package(self, current_root: t.Any) -> MessagePkgDef:
- """Add package to message package definition."""
current_pkg_def = MessagePkgDef(current_root.name, [], [])
for cls in self.model.get_classes(current_root):
@@ -64,7 +63,9 @@ def _add_package(self, current_root: t.Any) -> MessagePkgDef:
CAPELLA_TYPE_TO_MSG[prop.type_name]
if prop.type_name in CAPELLA_TYPE_TO_MSG
else prop.type_name,
- None if prop.max_card == 1 else prop.max_card,
+ None
+ if prop.max_card == "1"
+ else prop.max_card,
None
if prop.type_pkg_name == current_pkg_def.name
else prop.type_pkg_name,
@@ -112,6 +113,6 @@ def _add_package(self, current_root: t.Any) -> MessagePkgDef:
return current_pkg_def
def convert(self) -> None:
- """Convert Capella data to ROS messages."""
+ """Start conversion."""
self.msgs.packages.append(self._add_package(self.model.data))
- self.msgs.to_pkg_folder(self.msg_path)
+ self.msgs.to_msg_folder(self.msg_path)
diff --git a/capella_ros_tools/scripts/msg2capella.py b/capella_ros_tools/scripts/msg2capella.py
index 010c5c9..5676ed1 100644
--- a/capella_ros_tools/scripts/msg2capella.py
+++ b/capella_ros_tools/scripts/msg2capella.py
@@ -1,6 +1,6 @@
-# Copyright DB Netz AG and contributors
+# Copyright DB InfraGO AG and contributors
# SPDX-License-Identifier: Apache-2.0
-"""Convert ROS messages to Capella data.""" ""
+"""Import ROS messages into Capella."""
import typing as t
import capellambse
@@ -42,7 +42,7 @@
class Converter:
- """Converts ROS messages to Capella data."""
+ """Converter class for importing ROS messages into Capella."""
def __init__(
self,
@@ -102,7 +102,7 @@ def _add_objects(
EnumValue(
MSG_TYPE_TO_CAPELLA.get(v.type.name) or v.type.name,
v.name,
- int(v.value),
+ v.value,
"\n".join(v.annotations),
)
for v in e.values
@@ -143,8 +143,8 @@ def _add_relations(self, current_pkg_def, current_root):
or f.type.name,
f.type.pkg_name,
f.name,
- min_card=0 if f.type.array_size else 1,
- max_card=f.type.array_size or 1,
+ min_card="0" if f.type.array_size else "1",
+ max_card=f.type.array_size or "1",
description="\n".join(f.annotations),
)
for f in msg.fields
@@ -159,7 +159,7 @@ def _add_relations(self, current_pkg_def, current_root):
self._add_relations(new_pkg_def, new_root)
def convert(self) -> None:
- """Convert ROS messages to Capella data."""
+ """Start conversion."""
current_root = self.model.data
if not self.no_deps:
diff --git a/capella_ros_tools/snapshot/__init__.py b/capella_ros_tools/snapshot/__init__.py
new file mode 100644
index 0000000..12e5d94
--- /dev/null
+++ b/capella_ros_tools/snapshot/__init__.py
@@ -0,0 +1,3 @@
+# Copyright DB InfraGO AG and contributors
+# SPDX-License-Identifier: Apache-2.0
+"""The snapshot package."""
diff --git a/capella_ros_tools/snapshot/app.py b/capella_ros_tools/snapshot/app.py
new file mode 100644
index 0000000..3cc5db0
--- /dev/null
+++ b/capella_ros_tools/snapshot/app.py
@@ -0,0 +1,68 @@
+# Copyright DB InfraGO AG and contributors
+# SPDX-License-Identifier: Apache-2.0
+"""FastAPI app for viewing current snapshot of a Capella model."""
+
+import typing as t
+from pathlib import Path
+
+import uvicorn
+from fastapi import FastAPI, Request
+from fastapi.responses import HTMLResponse
+from fastapi.staticfiles import StaticFiles
+from fastapi.templating import Jinja2Templates
+
+PATH = Path(__file__).parent
+
+
+app = FastAPI(title="Capella ROS Tools")
+app.mount(
+ "/static", StaticFiles(directory=PATH.joinpath("static")), name="static"
+)
+templates = Jinja2Templates(directory=PATH.joinpath("templates"))
+
+
+def get_type(xtype: str) -> str:
+ """Return type name from xtype."""
+ return xtype.rpartition(":")[2]
+
+
+templates.env.globals.update(get_type=get_type)
+
+
+@app.get("/", response_class=HTMLResponse)
+def root(request: Request):
+ """Display root data package."""
+ element = app.state.data_package
+ context = {
+ "request": request,
+ "element": element,
+ "get_type": get_type,
+ }
+ response = templates.TemplateResponse("package.html", context)
+ return response
+
+
+@app.get("/{type}/{uuid}", response_class=HTMLResponse)
+def view(request: Request, type: str, uuid: str):
+ """Display element by uuid."""
+ element = app.state.model.by_uuid(uuid)
+ template = type + ".html"
+
+ context = {
+ "request": request,
+ "element": element,
+ "get_type": get_type,
+ }
+ response = templates.TemplateResponse(template, context)
+ return response
+
+
+def start(model: t.Any, layer: str, port: int = 5000):
+ """Start the app.""" ""
+ app.state.model = model
+ app.state.data_package = getattr(model, layer).data_package
+ uvicorn.run(
+ app,
+ host="0.0.0.0",
+ port=port,
+ )
diff --git a/capella_ros_tools/snapshot/static/icons/favicon.ico b/capella_ros_tools/snapshot/static/icons/favicon.ico
new file mode 100644
index 0000000..a0c9c57
Binary files /dev/null and b/capella_ros_tools/snapshot/static/icons/favicon.ico differ
diff --git a/capella_ros_tools/snapshot/static/icons/favicon.ico.license b/capella_ros_tools/snapshot/static/icons/favicon.ico.license
new file mode 100644
index 0000000..f6f3181
--- /dev/null
+++ b/capella_ros_tools/snapshot/static/icons/favicon.ico.license
@@ -0,0 +1,2 @@
+# Copyright DB InfraGO AG and contributors
+# SPDX-License-Identifier: CC0-1.0
diff --git a/capella_ros_tools/snapshot/static/styles.css b/capella_ros_tools/snapshot/static/styles.css
new file mode 100644
index 0000000..a776e49
--- /dev/null
+++ b/capella_ros_tools/snapshot/static/styles.css
@@ -0,0 +1,152 @@
+/*
+ * Copyright DB InfraGO AG and contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+:root {
+ --vt-c-white: #ffffff;
+ --vt-c-white-soft: #f8f8f8;
+ --vt-c-white-mute: #f2f2f2;
+
+ --vt-c-indigo: #2c3e50;
+
+ --vt-c-divider-light-1: rgba(60, 60, 60, 0.29);
+ --vt-c-divider-light-2: rgba(60, 60, 60, 0.12);
+
+ --vt-c-text-light-1: var(--vt-c-indigo);
+ --vt-c-text-light-2: rgba(60, 60, 60, 0.66);
+ --pink: #ffaccd;
+ --pink-dark: rgb(255, 0, 153);
+}
+
+/* semantic color variables for this project */
+:root {
+ --color-background: var(--vt-c-white);
+ --color-background-soft: var(--vt-c-white-soft);
+ --color-background-mute: var(--vt-c-white-mute);
+
+ --color-border: var(--vt-c-divider-light-2);
+ --color-border-hover: var(--vt-c-divider-light-1);
+
+ --color-heading: var(--vt-c-text-light-1);
+ --color-text: var(--vt-c-text-light-1);
+
+ --color-accent: var(--pink);
+ --color-accent-hover: var(--pink-dark);
+
+ --section-gap: 160px;
+}
+
+*,
+*::before,
+*::after {
+ box-sizing: border-box;
+ margin: 0;
+ font-weight: normal;
+}
+
+html,
+body {
+ width: 100vw;
+ height: 100vh;
+ margin: 0;
+ padding: 0;
+}
+
+body {
+ display: flex;
+ flex-direction: row;
+ color: var(--color-text);
+ background: var(--color-background-soft);
+ line-height: 1.6;
+ font-family: Inter, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto,
+ Oxygen, Ubuntu, Cantarell, "Fira Sans", "Droid Sans", "Helvetica Neue",
+ sans-serif;
+ font-size: 15px;
+ text-rendering: optimizeLegibility;
+ -webkit-font-smoothing: antialiased;
+ -moz-osx-font-smoothing: grayscale;
+}
+
+a {
+ color: inherit;
+ text-decoration: none;
+ border-bottom: 3px solid var(--color-accent);
+}
+
+a:hover {
+ border-bottom-color: var(--color-accent-hover);
+}
+
+span {
+ white-space: pre-wrap;
+ display: inline-flex;
+ opacity: 0.75;
+}
+
+strong {
+ font-weight: 500;
+}
+
+main {
+ padding: 0.5rem 1rem;
+}
+
+main,
+aside {
+ max-height: 100%;
+ overflow-y: auto;
+ flex: 1;
+ display: flex;
+ flex-direction: column;
+}
+
+aside {
+ background-color: white;
+}
+
+aside > div {
+ height: 100%;
+ width: 100%;
+}
+
+table {
+ border-spacing: 0 1.5rem;
+}
+tr > td:first-child {
+ font-weight: bold;
+ text-align: right;
+ padding-right: 2rem;
+ white-space: nowrap;
+ width: 1%;
+}
+
+tr > td:last-child {
+ text-align: left;
+}
+
+ol {
+ padding: 0;
+ counter-reset: list;
+}
+ol > li {
+ list-style: none;
+ display: flex;
+}
+ol > li:before {
+ content: "[" counter(list) "] ";
+ counter-increment: list;
+ margin-right: 0.5em;
+}
+
+::-webkit-scrollbar {
+ display: none;
+}
+
+/* Media query for landscape mode */
+@media screen and (orientation: portrait) {
+ body {
+ display: flex;
+ flex-direction: column;
+ }
+}
diff --git a/capella_ros_tools/snapshot/templates/class.html b/capella_ros_tools/snapshot/templates/class.html
new file mode 100644
index 0000000..247fefe
--- /dev/null
+++ b/capella_ros_tools/snapshot/templates/class.html
@@ -0,0 +1,191 @@
+
+
+
+
+
+
+
+ {{ element.name }} - Overview
+
+
+
+
+
+