Changelog

Version 0.9.1

Clarify documentation and docstrings.

Instances of Node and BaseNode are hashable now. They can be stored in a set.
The __eq__ methods of Node and BaseNode now compare by identity. To compare nodes the old way, use node.similar_to(other_node).
Add equals method on Node to compare nodes by value. This method is stricter than similar_to, because it requires self and other to have the same identifier.
Remove similar_to method from BaseNode to simplify subclassing.

Upgrade to abstracttree 0.2.0.
When using for node, item in tree.preorder(), then item.index is now equal to None for root.
Native implementations of node.root and node.is_leaf should speed up these operations.
Add support for python 3.10

Fix bug in node.compare:

Old erroneous behaviour: Return None if both roots have the same data.
New correct behaviour: Only return None if roots have the same data and there are no differences further down. Otherwise, a difference tree should be returned.

Fix bug caused by moving everything to src-directory.

Add method n1.similar_to(n2) to compare nodes by value and structure. In a future version, the behaviour of n1 == n2 might change to compare by identity.

node.identifier = node.identifier no longer raises a DuplicateChildError. It has now become a no-op.

Add NodeMixin class, which provides something even more basic than BaseNode.
Add parameters keep and deep to tree.copy(). So a pruned copy can be made by doing tree.copy(keep=MaxDepth(3)).
Calling iter_leaves on a node that is a leaf now correctly yields an iterable containing just that Node.
Fix iter_siblings to use identity instead of equality.
Methods sort_children, update and clear no longer return self, but None.

Add NetworkXSerializer for conversion to and from networkx.
Faster implementation of __eq__ for deep trees.
Two trees can now be equal (==) if their roots have a different identifier.
Replace argument str_factory by formatter in tree.show() and tree.to_string. If passed a string, it will be applied as formatter.format(node=node).

Fix bug in tree.compare method

Remove tree.show(img=True). Use tree.to_image().show() instead.
New method tree.transform() that creates a modified or pruned copy of a tree.
New method tree.compare() that compares different trees to each other.
Rewrite copy() in terms of transform. Use tree.copy() for shallow copy. Use tree.copy({}) for deep copy.
Remove style minimal, but add style list for tree.show().
Add option escape_comments to newick serializer to escape newick modifiers in node data.
For now use distance and comment instead of distance_field and comment_field in NewickSerializer.
Changed default format of to_dict to contain identifier.
Rewrite RowSerializer
Refactor RelationSerializer

Streamline DotExporter. Create temporary files in memory. Add option as_bytes to to_image(). Remove unused parameter separator.
Add more default styles to StringExporter. Some have been renamed. const has been renamed to square.
Simplify signature of from_newick. It accepts a string. For files a Path or file object should be passed.
Add tree.show() for quickly rendering a tree to console. Same as print(tree.to_string()).

Improve newick serialization. It’s much faster now and works on big trees.
Because of how it is implemented, it now also works on preorder format A(b, c), even though the standard form is (b, c)A.