Add Tree.build_random_tree() (#9)

* Add Tree.build_random_tree()

* Fix tests and format

* wip

* Update docs

* 2024

Author: mar10

CHANGELOG.md

@@ -1,7 +1,9 @@
 # Changelog
 
-## 0.8.1 (unreleased)
+## 0.9.0 (unreleased)
 
+- Add `Tree.build_random_tree()`
+- Add `GenericNodeData`
 - Fixed #7 Tree.from_dict failing to recreate an arbitrary object tree with a mapper.
 
 ## 0.8.0 (2024-03-29)

Pipfile

@@ -5,10 +5,9 @@ name = "pypi"
 
 [dev-packages]
 black = { version = "~=24.3", extras = ["jupyter"] }
+# coverage = "*"
+fabulist="*"
 isort = "*"
-# pylint = "*"
-# TODO: remove this line:
-# pytest-html = "!=3.2.0" # wait for https://github.com/pytest-dev/pytest-html/pull/583
 pytest = "*"
 pytest-cov = "*"
 PyYAML = "*"
@@ -22,14 +21,13 @@ tox = "*"
 twine = "*"
 wheel = "*"
 yabs = "*"
-nutree = {path = ".",editable = true}
 ipykernel = "*"
 notebook = "*"
+nutree = {path = ".",editable = true}
 
 [packages]
 
 [requires]
 python_version = "3.12"
 
 [pipenv]
-# allow_prereleases = true

Pipfile.lock

@@ -23,6 +23,7 @@ Nodes can be plain strings or objects <br>
 (De)Serialize to (compressed) JSON <br>
 Save as Mermaid flow diagram <br>
 Different traversal methods <br>
+Generate random trees <br>
 Fully type annotated <br>
 Convert to RDF graph <br>
 Typed child nodes <br>

README.md

@@ -119,7 +119,7 @@
 
 # General information about the project.
 project = u'nutree'
-copyright = u'2021-2023, <a href="https://wwwendt.de">Martin Wendt</a>'
+copyright = u'2021-2024, <a href="https://wwwendt.de">Martin Wendt</a>'
 author = u'Martin Wendt'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -130,19 +130,25 @@
 #version = '1.0'
 # The full version, including alpha/beta/rc tags.
 #release = '1.0'
-import pkg_resources
+import importlib
 
 try:
-    release = pkg_resources.get_distribution('nutree').version
-    # print( "release", release)
-    del pkg_resources
-except pkg_resources.DistributionNotFound:
-    print('To build the documentation, The distribution information')
-    print('Has to be available.  Either install the package into your')
+    # release = pkg_resources.get_distribution("nutree").version
+    release = importlib.metadata.version("nutree")
+except importlib.metadata.PackageNotFoundError:
+    print("To build the documentation, The distribution information")
+    print("has to be available. Either install the package into your")
     print('development environment or run "setup.py develop" to setup the')
-    print('metadata.  A virtualenv is recommended!')
+    print("metadata. A virtualenv is recommended!")
+
+    print(f"sys.path: {sys.path}")
+    print(f"package_root: {package_root}")
+    for fn in os.listdir(package_root):
+        print("-", fn)
     sys.exit(1)
 
+del importlib.metadata
+
 version = '.'.join(release.split('.')[:2])
 
 # The language for content autogenerated by Sphinx. Refer to documentation

docs/sphinx/conf.py

@@ -96,8 +96,9 @@ Nutree Facts
   * :ref:`(De)Serialize to (compressed) JSON <serialize>`
   * :ref:`Save as Mermaid flow diagram <save-mermaid>`
   * :ref:`Different traversal methods <traversal>`
-  * :ref:`Fully type annotated <api-reference>`
+  * :ref:`Generate random trees <randomize>`
   * :ref:`Convert to RDF graph <save-rdf>`
+  * :ref:`Fully type annotated <api-reference>`
   * :ref:`Typed child nodes <typed-tree>`
   * :ref:`Pretty print <pretty-print>`
   * :ref:`Navigation <navigate>`

docs/sphinx/index.rst

@@ -5,10 +5,18 @@ Reference Guide
 Class Overview
 ==============
 
+nutree classes
+--------------
+
 .. inheritance-diagram:: nutree.tree nutree.node nutree.typed_tree nutree.common
    :parts: 2
    :private-bases:
-   :caption: nutree classes
+
+Random tree generator
+---------------------
+
+.. inheritance-diagram:: nutree.tree_generator
+   :parts: 2
 
 
 .. API

docs/sphinx/reference_guide.rst

@@ -4,6 +4,12 @@ Basics
 
 .. py:currentmodule:: nutree
 
+.. admonition:: TL;DR
+
+    Nutree is a Python library for managing hierarchical data structures.
+    It stores arbitrary data objects in nodes and provides methods for
+    navigation, searching, and iteration.
+
 
 Adding Nodes
 ------------
@@ -35,8 +41,8 @@ Nodes are usually created by adding a new data instance to a parent::
 
 .. seealso::
 
-    See :doc:`ug_objects` for details on how to manage arbitrary objects instead
-    of plain strings.
+    See :doc:`ug_objects` for details on how to manage arbitrary objects, dicts,
+    etc. instead of plain strings.
 
 
 Info and Navigation

docs/sphinx/ug_basics.rst

@@ -6,6 +6,10 @@ Multiple Instances ('Clones')
 
 .. py:currentmodule:: nutree
 
+.. admonition:: TL;DR
+
+    Nutree allows to store multiple references to the same data object in a tree.
+
 Every :class:`~nutree.node.Node` instance is unique within the tree and
 also has a unique `node.node_id` value.
 

docs/sphinx/ug_clones.rst

@@ -6,6 +6,10 @@ Diff and Merge
 
 .. py:currentmodule:: nutree
 
+.. admonition:: TL;DR
+
+    Nutree provides a `diff` method to compare two trees and calculate the differences.
+
 The :meth:`~nutree.tree.Tree.diff` method compares a tree (`T0`) against another 
 one (`T1`) and returns a merged, annotated copy.