volttron-lib-tree 2.0.0rc1__tar.gz

volttron_lib_tree-2.0.0rc1/LICENSE

@@ -0,0 +1,216 @@
+Copyright 2022 Battelle Memorial Institute
+
+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.
+
+
+                                  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 [yyyy] [name of copyright owner]
+
+   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.

volttron_lib_tree-2.0.0rc1/PKG-INFO

@@ -0,0 +1,28 @@
+Metadata-Version: 2.3
+Name: volttron-lib-tree
+Version: 2.0.0rc1
+Summary: Tree data structures for handling topic-based resources in VOLTTRON.
+License: Apache-2.0
+Author: volttron
+Author-email: volttron@pnnl.gov
+Requires-Python: >=3.10,<4.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python
+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 :: Software Development :: Libraries :: Python Modules
+Requires-Dist: pydantic (>=2.0.0,<3.0.0)
+Requires-Dist: treelib (>=1.6.1)
+Requires-Dist: volttron-core (>=2.0.0rc30)
+Project-URL: Documentation, https://volttron.readthedocs.org
+Project-URL: Homepage, https://volttron.org
+Project-URL: Repository, https://github.com/eclipse-volttron/volttron-lib-tree
+Description-Content-Type: text/markdown
+
+# volttron-lib-tree

volttron_lib_tree-2.0.0rc1/README.md

@@ -0,0 +1 @@
+# volttron-lib-tree

volttron_lib_tree-2.0.0rc1/pyproject.toml

@@ -0,0 +1,34 @@
+[tool.poetry]
+name = "volttron-lib-tree"
+version = "2.0.0rc1"
+description = "Tree data structures for handling topic-based resources in VOLTTRON."
+authors = ["volttron <volttron@pnnl.gov>"]
+license = "Apache-2.0"
+readme = "README.md"
+homepage = "https://volttron.org"
+repository = "https://github.com/eclipse-volttron/volttron-lib-tree"
+documentation = "https://volttron.readthedocs.org"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Education",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Topic :: Software Development :: Libraries :: Python Modules"
+]
+
+packages = [ { include = "volttron", from = "src" }]
+
+[tool.poetry.dependencies]
+python = "^3.10"
+treelib = ">=1.6.1"
+volttron-core = ">=2.0.0rc30"
+pydantic = ">=2.0.0,<3.0.0"
+
+[tool.poetry.group.dev.dependencies]
+pytest = ">=7.0.0"
+
+[build-system]
+requires = ["poetry-core>=2.0.0"]
+build-backend = "poetry.core.masonry.api"

volttron_lib_tree-2.0.0rc1/src/volttron/lib/tree/__init__.py

@@ -0,0 +1,4 @@
+from . device import DeviceNode, DeviceTree
+from . topic import DuplicatedNodeIdError, NodeIDAbsentError, TopicNode, TopicTree
+
+__all__ = DeviceNode, DeviceTree, DuplicatedNodeIdError, NodeIDAbsentError, TopicNode, TopicTree

volttron_lib_tree-2.0.0rc1/src/volttron/lib/tree/device.py

@@ -0,0 +1,104 @@
+# -*- coding: utf-8 -*- {{{
+# ===----------------------------------------------------------------------===
+#
+#                 Installable Component of Eclipse VOLTTRON
+#
+# ===----------------------------------------------------------------------===
+#
+# Copyright 2022 Battelle Memorial Institute
+#
+# 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.
+#
+# ===----------------------------------------------------------------------===
+# }}}
+
+import logging
+import re
+
+from importlib.metadata import distribution, PackageNotFoundError
+
+try:
+    distribution('volttron-core')
+    from volttron.client.known_identities import CONFIGURATION_STORE
+except PackageNotFoundError:
+    from volttron.platform.agent.known_identities import CONFIGURATION_STORE
+
+from .topic import TopicTree, TopicNode
+
+_log = logging.getLogger(__name__)
+
+
+class DeviceNode(TopicNode):
+    def __init__(self, tag=None, identifier=None, expanded=True, data=None, segment_type='TOPIC_SEGMENT', topic=''):
+        super(DeviceNode, self).__init__(tag, identifier, expanded, data, segment_type, topic)
+
+    def is_point(self):
+        return True if self.segment_type == 'POINT' else False
+
+    def is_device(self):
+        return True if self.segment_type == 'DEVICE' else False
+
+
+class DeviceTree(TopicTree):
+    def __init__(self, topic_list=None, root_name='devices', assume_full_topics=False,  *args, **kwargs):
+        super(DeviceTree, self).__init__(topic_list=topic_list, root_name=root_name, node_class=DeviceNode,
+                                         *args, **kwargs)
+        if assume_full_topics:
+            for n in self.leaves():
+                n.data['segment_type'] = 'POINT'
+            for n in [self.parent(l.identifier) for l in self.leaves()]:
+                n.data['segment_type'] = 'DEVICE'
+
+    def points(self, nid=None):
+        if nid is None:
+            points = [n for n in self._nodes.values() if n.is_point()]
+        else:
+            points = [self[n] for n in self.expand_tree(nid) if self[n].is_point()]
+        return points
+
+    def devices(self, nid=None):
+        if nid is None:
+            points = [n for n in self._nodes.values() if n.is_device()]
+        else:
+            points = [self[n] for n in self.expand_tree(nid) if self[n].is_device()]
+        return points
+
+    # TODO: Getting points requires getting device config, using it to find the registry config,
+    #  and then parsing that. There is not a method in config.store, nor in the platform.driver for
+    #  getting a completed configuration. The configuration is only fully assembled in the subsystem's
+    #  _initial_update method called when the agent itself calls get_configs at startup. There does not
+    #  seem to be an equivalent management method, and the code for this is in the agent subsystem
+    #  rather than the service (though it is reached through the service, oddly...
+    @classmethod
+    def from_store(cls, platform, rpc_caller):
+        # TODO: Duplicate logic for external_platform check from VUIEndpoints to remove reference to it from here.
+        kwargs = {'external_platform': platform} if 'VUIEndpoints' in rpc_caller.__repr__() else {}
+        devices = rpc_caller(CONFIGURATION_STORE, 'manage_list_configs', 'platform.driver', **kwargs)
+        devices = devices if kwargs else devices.get(timeout=5)
+        devices = [d for d in devices if re.match('^devices/.*', d)]
+        device_tree = cls(devices)
+        for d in devices:
+            dev_config = rpc_caller(CONFIGURATION_STORE, 'manage_get', 'platform.driver', d, raw=False, **kwargs)
+            # TODO: If not AsyncResponse instead of if kwargs
+            dev_config = dev_config if kwargs else dev_config.get(timeout=5)
+            reg_cfg_name = dev_config.pop('registry_config')[len('config://'):]
+            data = {'config': dev_config, 'segment_type': 'DEVICE'}
+            device_tree.update_node(d, data=data)
+            registry_config = rpc_caller('config.store', 'manage_get', 'platform.driver',
+                                         f'{reg_cfg_name}', raw=False, **kwargs)
+            registry_config = registry_config if kwargs else registry_config.get(timeout=5)
+            for pnt in registry_config:
+                point_name = pnt.pop('Volttron Point Name')
+                n = device_tree.create_node(point_name, f"{d}/{point_name}", parent=d, data=pnt)
+                n.data['segment_type'] = 'POINT'
+        return device_tree

volttron_lib_tree-2.0.0rc1/src/volttron/lib/tree/topic.py

@@ -0,0 +1,198 @@
+# -*- coding: utf-8 -*- {{{
+# ===----------------------------------------------------------------------===
+#
+#                 Installable Component of Eclipse VOLTTRON
+#
+# ===----------------------------------------------------------------------===
+#
+# Copyright 2022 Battelle Memorial Institute
+#
+# 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.
+#
+# ===----------------------------------------------------------------------===
+# }}}
+
+import json
+import logging
+import re
+
+from collections import defaultdict
+from datetime import datetime, timedelta
+from enum import Enum
+from importlib.metadata import distribution, PackageNotFoundError
+from os.path import normpath
+from pydantic import BaseModel
+from typing import Any, Union, Iterable
+from treelib import Tree, Node
+from treelib.exceptions import DuplicatedNodeIdError, NodeIDAbsentError
+
+try:
+    distribution('volttron-core')
+    from volttron.client.known_identities import CONFIGURATION_STORE
+except PackageNotFoundError:
+    from volttron.platform.agent.known_identities import CONFIGURATION_STORE
+
+_log = logging.getLogger(__name__)
+
+
+class TopicNode(Node):
+    def __init__(self, tag=None, identifier=None, expanded=True, data=None, segment_type='TOPIC_SEGMENT', topic=''):
+        super(TopicNode, self).__init__(tag, identifier, expanded, data)
+        self.data: dict[str, Any] = data if data else {}
+        self.data['segment_type'] = segment_type
+        self.data['topic'] = topic
+
+    @property
+    def segment_type(self):
+        return self.data['segment_type']
+
+    @property
+    def topic(self):
+        return self.data['topic']
+
+    def is_segment(self):
+        return True if self.segment_type == 'TOPIC_SEGMENT' else False
+
+
+class TopicTree(Tree):
+    def __init__(self, topic_list=None, root_name='root', node_class=None, *args, **kwargs):
+        node_class = node_class if node_class else TopicNode
+        super(TopicTree, self).__init__(node_class=node_class, *args, **kwargs)
+        if topic_list:
+            self._from_topic_list(topic_list, root_name)
+        else:
+            self.create_node(root_name, root_name).data['segment_type'] = 'TOPIC_ROOT'
+
+    def _from_topic_list(self, topic_list, root_name):
+        tops = [t.split('/') for t in topic_list]
+        if all([top[0] == root_name for top in tops]):
+            [top.pop(0) for top in tops]
+        self.create_node(root_name, root_name).data['segment_type'] = 'TOPIC_ROOT'
+        for top in tops:
+            parent = root_name
+            for segment in top:
+                nid = '/'.join([parent, segment])
+                try:
+                    self.create_node(segment, nid, parent=parent)
+                except DuplicatedNodeIdError:
+                    pass
+                parent = nid
+
+    def add_node(self, node, parent=None):
+        super(TopicTree, self).add_node(node, parent)
+        node.data['topic'] = node.identifier[(len(self.root) + 1):]
+        return node
+
+    # TODO: Should this actually be get_child_topics() where topics or routes are returned with wildcards?
+    def get_children_dict(self, sub_root_node_id: Union[list, str], include_root: bool = True,
+                          prefix: str = '', replace_topic: str = None) -> dict:
+        sub_root_node_id = sub_root_node_id if type(sub_root_node_id) is list else [sub_root_node_id]
+        level_dict = defaultdict(set)
+        for r_id in sub_root_node_id:
+            for d in self.children(r_id):
+                try:
+                    if replace_topic:
+                        if include_root:
+                            level_dict[d.tag].add('/'.join([self.root, replace_topic, d.tag]))
+                        else:
+                            level_dict[d.tag].add('/'.join([replace_topic, d.tag]))
+                    else:
+                        if include_root:
+                            level_dict[d.tag].add(d.identifier)
+                        else:
+                            level_dict[d.tag].add(d.identifier.split('/', 1)[1])
+                except NodeIDAbsentError:
+                    return {}
+        ret_dict = {}
+        for k, s in level_dict.items():
+            if len(s) > 1:
+                ret_dict[k] = sorted([normpath('/'.join([prefix, v])) for v in s])
+            else:
+                ret_dict[k] = normpath('/'.join([prefix, s.pop()]))
+        return ret_dict
+
+    def resolve_query(self, topic_pattern: str = '', regex: str = None, exact_matches: Iterable = None,
+                      return_leaves=False) -> Iterable:
+        def clipping(topic_parts, nids=None):
+            nids = nids if nids else []
+            if topic_parts:
+                part = topic_parts.pop(0)
+                if part:
+                    if not nids:
+                        return clipping(topic_parts, [part]) if self.get_node(part) else nids
+                    else:
+                        joined_nids = [self.get_node('/'.join([c.identifier, part])).identifier
+                                       for n in nids for c in self.children(n)]
+                        return clipping(topic_parts, joined_nids)
+                else:
+                    return nids
+            else:
+                return [l.identifier for n in nids for l in self.leaves(n)] if return_leaves else nids
+
+        if not topic_pattern:
+            # If None or empty string, default to "self.root"
+            topic_pattern = self.root
+        elif not topic_pattern.startswith(self.root):
+            topic_pattern = '/'.join([self.root, topic_pattern])
+
+        regex = re.compile(regex) if regex else None
+        topic_nids = clipping([part.strip('/') for part in topic_pattern.split('/-') if part != '']) if topic_pattern else []
+        if topic_nids and exact_matches:
+            nodes = (self.get_node(n) for n in topic_nids if n in exact_matches and (not regex or regex.search(n)))
+        elif topic_nids and not exact_matches:
+            nodes = (self.get_node(n)  for n in topic_nids if not regex or regex.search(n))
+        elif not topic_nids and exact_matches:
+            nodes = (self.get_node(n) for n in exact_matches if (not regex or regex.search(n)) and self.contains(n))
+        else:
+            nodes = self.filter_nodes(lambda n: regex.search(n.identifier)) if regex else []
+        return nodes
+
+    def prune(self, topic_pattern: str = None, regex: str = None, exact_matches: Iterable = None, *args, **kwargs):
+        if topic_pattern:
+            pattern = re.compile(topic_pattern.replace('-', '[^/]+') + '(/|$)')
+            nids = [n.identifier for n in self.filter_nodes(lambda x: pattern.search(x.identifier))]
+        else:
+            nids = list(self.expand_tree())
+        if regex:
+            regex = re.compile(regex)
+            nids = [n for n in nids if regex.search(n)]
+        if exact_matches:
+            nids = [n for n in nids if n in exact_matches]
+        pruned = self.__class__(topic_list=nids, root_name=self.root, *args, **kwargs)
+        for nid in [n.identifier for n in pruned.all_nodes()]:
+            old = self.get_node(nid)
+            pruned.update_node(nid, data=old.data)
+        return pruned
+
+    def get_matches(self, topic, return_nodes=True):
+        pattern = topic.replace('-', '[^/]+') + '$'
+        nodes = self.filter_nodes(lambda x: re.match(pattern, x.identifier))
+        if return_nodes:
+            return list(nodes)
+        else:
+            return [n.identifier for n in nodes]
+
+    def to_json(self, with_data=False, sort=True, reverse=False):
+        """To format the tree in JSON format."""
+        def custom_encoder(obj):
+            if isinstance(obj, BaseModel):
+                return obj.model_dump()
+            if isinstance(obj, Enum):
+                return obj.value
+            if isinstance(obj, timedelta):
+                return obj.total_seconds()
+            if isinstance(obj, datetime):
+                return obj.isoformat()
+            return json.JSONEncoder().default(obj)
+
+        return json.dumps(self.to_dict(with_data=with_data, sort=sort, reverse=reverse), default=custom_encoder)