lightree initial version

Author: leonardbinet

.github/CODEOWNERS

@@ -0,0 +1 @@
+*  @leonardbinet

.gitignore

@@ -0,0 +1,41 @@
+*.py[cod]
+.idea
+env/*
+.python-version
+
+# C extensions
+*.so
+
+# Packages
+*.egg
+*.egg-info
+dist
+build
+eggs
+parts
+bin
+var
+sdist
+develop-eggs
+.installed.cfg
+lib
+lib64
+__pycache__
+\.vscode/*
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+.coverage
+.tox
+nosetests.xml
+
+# Translations
+*.mo
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+*.swp

LICENSE

@@ -0,0 +1,24 @@
+Even though all code has been rewritten and inner structure revamped, lots of interfaces are inspired by treelib:
+https://github.com/caesar0301/treelib
+
+MIT License
+
+Copyright (c) 2020 Léonard Binet [email protected]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

MANIFEST.in

@@ -0,0 +1 @@
+include README*

Makefile

@@ -0,0 +1,24 @@
+.PHONY : develop clean clean_pyc lint-diff black test coverage
+
+clean:
+	-python setup.py clean
+
+clean_pyc:
+	-find ./tests -name "*.py[co]" -exec rm {} \;
+	-find ./lighttree -name "*.py[co]" -exec rm {} \;
+
+lint-diff:
+	git diff upstream/master --name-only -- "*.py" | xargs flake8
+
+black:
+	black lighttree tests setup.py
+
+develop:
+	-python -m pip install -e .
+
+test:
+	-python -m unittest
+
+coverage:
+	-coverage run --source=./lighttree -m unittest
+	coverage report

README.md

@@ -0,0 +1,4 @@
+from .tree import Tree
+from .node import Node
+
+__all__ = ["Tree", "Node"]

lighttree/__init__.py

@@ -0,0 +1,16 @@
+class NotFoundNodeError(Exception):
+    """Requested node identifier is not present in tree"""
+
+    pass
+
+
+class MultipleRootError(Exception):
+    """Tree root is already declared."""
+
+    pass
+
+
+class DuplicatedNodeError(Exception):
+    """Node identifier already exists in tree."""
+
+    pass

lighttree/exceptions.py

@@ -0,0 +1,48 @@
+#!/usr/bin/env python
+
+from __future__ import unicode_literals
+from future.utils import python_2_unicode_compatible, string_types
+
+import uuid
+
+
+@python_2_unicode_compatible
+class Node(object):
+    def __init__(self, identifier=None, auto_uuid=False):
+        """
+        :param identifier: node identifier, must be unique per tree
+        """
+        if not isinstance(identifier, string_types):
+            raise ValueError(
+                "Identifier must be a string type, provided type is <%s>"
+                % type(identifier)
+            )
+        if identifier is None:
+            if not auto_uuid:
+                raise ValueError("Required identifier")
+            identifier = uuid.uuid4()
+        self.identifier = identifier
+
+    def line_repr(self, **kwargs):
+        """Control how node is displayed in tree representation.
+        """
+        return self.identifier
+
+    def serialize(self, *args, **kwargs):
+        return {"identifier": self.identifier}
+
+    @classmethod
+    def deserialize(cls, d, *args, **kwargs):
+        if not isinstance(d, dict):
+            raise ValueError("Deserialization requires a dict.")
+        return cls._deserialize(d, *args, **kwargs)
+
+    @classmethod
+    def _deserialize(cls, d, *args, **kwargs):
+        return cls(d.get("identifier"))
+
+    def __str__(self):
+        return "%s, id=%s" % (self.__class__.__name__, self.identifier)
+
+    def __repr__(self):
+        return self.__str__()