blackfennec.structure.reference_navigation package

Submodules

blackfennec.structure.reference_navigation.child_navigator module

class blackfennec.structure.reference_navigation.child_navigator.ChildNavigator(token: str)[source]

Bases: Navigator

navigate(current: Union[Map, List]) → Structure[source]

navigates current structure and returns destination

Returns

Structure navigated to

Return type

Structure

blackfennec.structure.reference_navigation.index_of_navigator module

class blackfennec.structure.reference_navigation.index_of_navigator.IndexOfNavigator[source]

Bases: Navigator

navigate(current: Structure) → Structure[source]

navigates to index/key of structure

Returns

Structure navigated to

Return type

Structure

blackfennec.structure.reference_navigation.navigator module

class blackfennec.structure.reference_navigation.navigator.Navigator[source]

Bases: object

abstract navigate(current: Structure) → Structure[source]

navigates current structure and returns destination

Returns

Structure navigated to

Return type

Structure

Raises

NotImplementedError – if subclass did not implement this method

blackfennec.structure.reference_navigation.parent_navigator module

class blackfennec.structure.reference_navigation.parent_navigator.ParentNavigator[source]

Bases: Navigator

navigate(current: Structure) → Structure[source]

navigates current structure and returns destination

Returns

Parent

Return type

Structure

blackfennec.structure.reference_navigation.root_navigator module

class blackfennec.structure.reference_navigation.root_navigator.RootNavigator[source]

Bases: Navigator

navigate(current: Structure) → Structure[source]

navigates current structure and returns destination

Returns

Parent

Return type

Structure

blackfennec.structure.reference_navigation.sibling_offset_navigator module

class blackfennec.structure.reference_navigation.sibling_offset_navigator.SiblingOffsetNavigator(sibling_offset: int)[source]

Bases: Navigator

navigate(current: Structure) → Structure[source]

navigates current structure and returns destination

Returns

Structure navigated to

Return type

Structure

blackfennec.structure.reference_navigation.uri_navigator module

class blackfennec.structure.reference_navigation.uri_navigator.UriNavigator(document_factory: DocumentFactory, uri: str)[source]

Bases: Navigator

navigate(current: Structure) → Structure[source]

navigates current structure and returns destination

Returns

Uri content

Return type

Structure

Module contents