Garmelon/bowl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Move ElementSupply to own file and document it

Browse source
This commit is contained in:
Joscha 2019-05-11 22:50:12 +00:00
parent 7c89ada5f0
commit b71e3e15d6
4 changed files with 156 additions and 97 deletions
Download patch file Download diff file Expand all files Collapse all files

97
cheuph/element.py
View file

@ -4,7 +4,7 @@ from typing import Hashable, List, Optional
from .exceptions import ElementException, TreeException
from .markup import AttributedText
__all__ = ["Id", "Element", "ElementSupply", "RenderedElement"]
__all__ = ["Id", "Element", "RenderedElement"]
Id = Hashable
@ -47,101 +47,6 @@ class Element(abc.ABC):
) -> RenderedElement:
pass
class ElementSupply(abc.ABC):
@abc.abstractmethod
def get(self, element_id: Id) -> Element:
pass
@abc.abstractmethod
def get_parent_id(self, element_id: Id) -> Optional[Id]:
pass
def get_parent(self, element_id: Id) -> Optional[Element]:
parent_id = self.get_parent_id(element_id)
if parent_id is not None:
return self.get(parent_id)
else:
return None
@abc.abstractmethod
def get_children_ids(self, element_id: Id) -> List[Id]:
pass
def get_children(self, element_id: Id) -> List[Element]:
children_ids = self.get_children_ids(element_id)
children: List[Element] = []
for child_id in children_ids:
children.append(self.get(child_id))
return children
# There is not a clear-cut way to get the previous or next "sibling" of an
# element that is itself a child of the implicit root (None), since
# get_children() doesn't accept None in its element_id argument.
#
# Because of this, the get_previous_id() and get_next_id() functions are
# abstract (until I decide to change the signature of get_children(), that
# is :P).
@abc.abstractmethod
def get_previous_id(self, element_id: Id) -> Optional[Id]:
pass
def get_previous(self, element_id: Id) -> Optional[Element]:
previous_id = self.get_previous_id(element_id)
if previous_id is not None:
return self.get(previous_id)
else:
return None
@abc.abstractmethod
def get_next_id(self, element_id: Id) -> Optional[Id]:
pass
def get_next(self, element_id: Id) -> Optional[Element]:
next_id = self.get_next_id(element_id)
if next_id is not None:
return self.get(next_id)
else:
return None
def get_furthest_ancestor_id(self,
element_id: Id,
root_id: Optional[Id] = None,
) -> Id:
current_id = element_id
while True:
parent_id = self.get_parent_id(current_id)
if parent_id == root_id:
return current_id
elif parent_id is None:
raise TreeException("Reached implicit root before hitting specified root")
current_id = parent_id
def get_furthest_ancestor(self,
element_id: Id,
root_id: Optional[Id] = None,
) -> Element:
return self.get(self.get_furthest_ancestor_id(element_id,
root_id=root_id))
def get_tree(self, tree_id: Id) -> Element:
tree = self.get(tree_id)
children: List[Element] = []
for child_id in self.get_children_ids(tree_id):
children.append(self.get_tree(child_id))
tree.children = children
return tree
class RenderedElement:
def __init__(self,
element: Element,