Add support for config option `compose-node-name` #84

simu · 2024-01-23T16:41:35Z

This PR adds support for the Reclass option compose-node-name.

Additionally, we implement support for compatibility flags (including helpers to set/unset/clear flags from Python), and introduce a first flag ComposeNodeNameLiteralDots. This flag configures reclass-rs to generate node metadata which matches Python reclass when compose-node-name is enabled.

The compatibility flag is required because Python reclass discards literal dots in node filepaths when compose-node-name is enabled, resulting in incorrect node metadata for nodes which have literal dots in their filename (e.g. node a.1 in the test/inventory-compose-node-name inventory).

By default, reclass-rs will preserve literal dots in the node metadata (path, and part) for node names when compose-node-name is enabled.

Checklist

The PR has a meaningful title. The title will be used to auto generate the changelog
PR contains a single logical change (to build a better changelog).
Update the documentation.
Update tests.
Categorize the PR by setting a good title and adding one of the labels:
bug, enhancement, documentation, change, breaking, dependency, internal
as they show up in the changelog
Link this PR to related PRs or issues.

HappyTetrahedron

I really ought to learn rust.

src/inventory.rs

When enabled, this option allows users to define nodes in nested directories in `nodes_path`. Node names are constructed the same way as class names, by replacing directory separators with dots. This commit implements support for compose-node-name in such a way that the resulting node metadata is compatible with Python reclass.

…bled Python reclass discards literal dots in node filepaths when compose-node-name is enabled, resulting in incorrect node metadata for nodes which have literal dots in their filename (e.g. node `a.1` in the `test/inventory-compose-node-name` inventory). This commit implements compatibility flag `ComposeNodeNameLiteralDots`. When set, this flag tells reclass-rs to generate node metadata which matches Python reclass when compose-node-name is enabled. By default (i.e. without the compatibility flag), reclass-rs preserves literal dots in node names when compose-node-name is enabled. To implement the new default behavior, we additionally track the node's path in `nodes_path` in `NodeInfoMeta`, so that we can ensure that literal dots are preserved when generating the node's metadata.

PyO3's getters return a clone of the field, so we can't directly operate on `Reclass.config.compatflags`. Instead we introduce methods `set_compat_flag()`, `unset_compat_flag()` and `clear_compat_flags()` on class `Reclass` to modify compatibility flags from Python.

In particular, test compat flag

…s()`

The compose-node-name feature in Python Reclass treats nodes whose path in `nodes_path` starts with a `_` as top-level nodes. We extend our implementation of compose-node-name and the test inventory for compose-node-name to handle such nodes the same way as Python reclass.

github-actions · 2024-02-13T09:56:14Z