Welcome to Fagus’s documentation!

Contents:

• ISC License
• README
  • Code and tests ready, documentation still WORK IN PROGRESS
  • Table of contents
  • Basic principles
    • Introduction – What it solves
    • The path-parameter
    • Static and instance usage
    • Fagus options
  • Modifying the tree
    • Basic principles for modifying the tree
    • set() – adding and overwriting elements
    • append() – adding a new element to a list
    • extend() – extending a list with multiple elements
    • insert() – insert an element at a given index in a list
    • add() – adding a new element to a set
    • update() – update multiple elements in a set or dict
    • remove(), delete() and pop()
    • serialize() – ensure that a tree is json- or yaml-serializable
    • mod() – modifying elements
  • Iterating over nested objects
    • Skipping nodes in iteration.
  • Filtering nested objects
• fagus package
  • Fagus
    • Fagus.__init__()
    • Fagus.root
    • Fagus.get()
    • Fagus.iter()
    • Fagus.filter()
    • Fagus.split()
    • Fagus.set()
    • Fagus.append()
    • Fagus.extend()
    • Fagus.insert()
    • Fagus.add()
    • Fagus.update()
    • Fagus.setdefault()
    • Fagus.mod()
    • Fagus.mod_all()
    • Fagus.serialize()
    • Fagus.merge()
    • Fagus.pop()
    • Fagus.popitem()
    • Fagus.discard()
    • Fagus.remove()
    • Fagus.keys()
    • Fagus.values()
    • Fagus.items()
    • Fagus.clear()
    • Fagus.contains()
    • Fagus.count()
    • Fagus.index()
    • Fagus.isdisjoint()
    • Fagus.child()
    • Fagus.reversed()
    • Fagus.reverse()
    • Fagus.copy()
    • Fagus.options()
    • Fagus.__copy__()
    • Fagus.__call__()
    • Fagus.__getattr__()
    • Fagus.__getitem__()
    • Fagus.__setattr__()
    • Fagus.__setitem__()
    • Fagus.__delattr__()
    • Fagus.__delitem__()
    • Fagus.__iter__()
    • Fagus.__hash__()
    • Fagus.__eq__()
    • Fagus.__ne__()
    • Fagus.__lt__()
    • Fagus.__le__()
    • Fagus.__gt__()
    • Fagus.__ge__()
    • Fagus.__contains__()
    • Fagus.__len__()
    • Fagus.__bool__()
    • Fagus.__repr__()
    • Fagus.__str__()
    • Fagus.__iadd__()
    • Fagus.__add__()
    • Fagus.__radd__()
    • Fagus.__isub__()
    • Fagus.__sub__()
    • Fagus.__rsub__()
    • Fagus.__imul__()
    • Fagus.__abstractmethods__
    • Fagus.__annotations__
    • Fagus.__dict__
    • Fagus.__module__
    • Fagus.__mul__()
    • Fagus.__weakref__
    • Fagus.__rmul__()
    • Fagus.__reversed__()
    • Fagus.__reduce__()
    • Fagus.__reduce_ex__()
  • Fil
    • Fil.__module__
  • CFil
    • CFil.__init__()
    • CFil.match_node()
    • CFil.__annotations__
    • CFil.__module__
  • VFil
    • VFil.__init__()
    • VFil.match_node()
    • VFil.__annotations__
    • VFil.__module__
  • Submodules
    • fagus.fagus module
    • fagus.filters module
    • fagus.iterators module
    • fagus.utils module
• Changelog
• Contributing to Fagus
  • Table of contents
  • Fagus Principles
  • How Can I Contribute?
    • Reporting Bugs
    • Requesting New Features
  • Developing Fagus
    • Software Dependencies For Development
    • Code Styling Guidelines
    • Setting Up A Local Fagus Developing Environment
    • Submitting Pull Requests for Fagus

Indices and tables

• Index

• Module Index

• Search Page