genro-treestore

User Guide

  • Quick Start
    • Installation
    • TreeStore API
      • Creating a TreeStore
      • Accessing Values
      • Setting Values
      • Fluent Chaining
      • Attributes
      • Path Syntax
      • Digest
      • Iteration
    • Using Builders (Builder Pattern)
      • Using HtmlBuilder
      • Creating Custom Builders
    • Next Steps
  • Path Syntax
    • Basic Paths
      • Label Access
      • Positional Access
    • Dotted Paths
    • Attribute Access
      • Reading Attributes
      • Setting Attributes
      • Path + Attribute
    • Special Cases
      • Non-existent Paths
      • Attribute on Non-existent Node
    • Path Examples
    • Use Cases
      • Configuration Trees
      • DOM-like Structures
    • With Builders
  • Typed Builders
    • Why Use Builders?
    • Basic Builder
      • Using the Builder
    • Method Chaining
    • Custom Constructors
    • Child Validation
    • Inheritance
    • Type Hints
    • Complete Example
    • Next Steps
  • Resolvers
    • How Resolvers Work
    • Resolver Types
    • CallbackResolver
      • Basic Usage
      • With Caching
      • Callback Signature
    • DirectoryResolver
    • TxtDocResolver
    • Creating Custom Resolvers
    • Resolver Lifecycle
    • Best Practices
    • See Also
  • Subscriptions
    • Event Propagation
    • Event Types
    • Basic Subscription
    • Subscription Flow
    • Selective Subscriptions
    • Callback Signature
    • Unsubscribing
    • Multiple Subscribers
    • Subscription Architecture
    • Use Cases
      • Change Tracking
      • Validation on Change
      • Computed Properties
    • Best Practices
    • See Also
  • Serialization
    • Serialization Formats
    • TYTX Format
      • Supported Types
      • Basic Usage
      • Transport Formats
      • TYTX Structure
    • XML Serialization
      • Parsing XML
      • Generating XML
      • Namespace Handling
    • Dictionary Serialization
    • Serialization Comparison
    • Best Practices
    • See Also
  • Child Validation
    • Basic Usage
      • Valid Children
      • Invalid Children
    • Cardinality Constraints
    • Examples
      • Required Child
      • Optional Single Child
      • Minimum Required
      • Maximum Limit
    • Exceptions
      • InvalidChildError
      • MissingChildError
      • TooManyChildrenError
    • Complete Example
    • Validation Timing
    • Tips

API Reference

  • API Reference
    • Store Module
      • Module Structure
      • TreeStore
        • TreeStore
      • TreeStoreNode
        • TreeStoreNode
      • Class Relationships
      • Path Resolution
      • Subscription System
        • SubscriptionMixin
        • Event Types
      • Serialization
        • to_tytx()
        • from_tytx()
      • See Also
    • Builders Module
      • Module Structure
      • BuilderBase
        • BuilderBase
      • Decorators
        • @element
      • HtmlBuilder
        • HtmlBuilder
        • HTML5 Content Model
      • XsdBuilder
        • XsdBuilder
        • Example
      • Builder Architecture
      • Validation Flow
      • Cardinality Syntax
      • See Also
    • Resolvers Module
      • Module Structure
      • TreeStoreResolver
        • TreeStoreResolver
      • CallbackResolver
        • CallbackResolver
        • Example
      • DirectoryResolver
        • DirectoryResolver
        • Example
      • TxtDocResolver
        • TxtDocResolver
        • Example
      • Resolver Architecture
      • Resolver Lifecycle
      • Caching
      • Creating Custom Resolvers
      • See Also
    • Exceptions Module
      • Exception Hierarchy
      • TreeStoreError
        • TreeStoreError
      • InvalidChildError
        • InvalidChildError
      • InvalidParentError
        • InvalidParentError
      • MissingChildError
        • MissingChildError
      • TooManyChildrenError
        • TooManyChildrenError
      • Exception Handling Patterns
        • Catching All TreeStore Errors
        • Specific Exception Handling
      • Exception Flow
      • See Also
    • Package Overview
    • Module Summary
    • Quick Import
    • Class Hierarchy
    • See Also
  • Store Module
    • Module Structure
    • TreeStore
      • TreeStore
        • TreeStore.parent
        • TreeStore.__init__()
        • TreeStore.parent
        • TreeStore.__repr__()
        • TreeStore.__len__()
        • TreeStore.__iter__()
        • TreeStore.__contains__()
        • TreeStore.__getattr__()
        • TreeStore.builder
        • TreeStore.set_item()
        • TreeStore.get_item()
        • TreeStore.__getitem__()
        • TreeStore.__setitem__()
        • TreeStore.get_node()
        • TreeStore.get_attr()
        • TreeStore.set_attr()
        • TreeStore.set_resolver()
        • TreeStore.get_resolver()
        • TreeStore.del_item()
        • TreeStore.pop()
        • TreeStore.iter_keys()
        • TreeStore.iter_values()
        • TreeStore.iter_items()
        • TreeStore.iter_nodes()
        • TreeStore.keys()
        • TreeStore.values()
        • TreeStore.items()
        • TreeStore.nodes()
        • TreeStore.get_nodes()
        • TreeStore.iter_digest()
        • TreeStore.digest()
        • TreeStore.walk()
        • TreeStore.flattened()
        • TreeStore.root
        • TreeStore.depth
        • TreeStore.parent_node
        • TreeStore.as_dict()
        • TreeStore.clear()
        • TreeStore.update()
        • TreeStore.get()
        • TreeStore.is_valid
        • TreeStore.validation_errors()
        • TreeStore.to_tytx()
        • TreeStore.from_tytx()
        • TreeStore.from_xml()
        • TreeStore.to_xml()
    • TreeStoreNode
      • TreeStoreNode
        • TreeStoreNode.__init__()
        • TreeStoreNode.label
        • TreeStoreNode.attr
        • TreeStoreNode.parent
        • TreeStoreNode.tag
        • TreeStoreNode.value
        • TreeStoreNode.resolver
        • TreeStoreNode.set_value()
        • TreeStoreNode.is_branch
        • TreeStoreNode.is_leaf
        • TreeStoreNode.get_attr()
        • TreeStoreNode.set_attr()
        • TreeStoreNode.subscribe()
        • TreeStoreNode.unsubscribe()
        • TreeStoreNode.is_valid
    • Class Relationships
    • Path Resolution
    • Subscription System
      • SubscriptionMixin
        • SubscriptionMixin.parent
        • SubscriptionMixin.subscribe()
        • SubscriptionMixin.unsubscribe()
      • Event Types
    • Serialization
      • to_tytx()
      • from_tytx()
    • See Also
  • Builders Module
    • Module Structure
    • BuilderBase
      • BuilderBase
        • BuilderBase.__init_subclass__()
        • BuilderBase.__getattr__()
        • BuilderBase.child()
        • BuilderBase.check()
    • Decorators
      • @element
        • element()
    • HtmlBuilder
      • HtmlBuilder
        • HtmlBuilder.VOID_ELEMENTS
        • HtmlBuilder.ALL_TAGS
        • HtmlBuilder.__init__()
        • HtmlBuilder.VOID_ELEMENTS
        • HtmlBuilder.ALL_TAGS
        • HtmlBuilder.__getattr__()
      • HTML5 Content Model
    • XsdBuilder
      • XsdBuilder
        • XsdBuilder.__init__()
        • XsdBuilder.__getattr__()
        • XsdBuilder.elements
        • XsdBuilder.get_children()
      • Example
    • Builder Architecture
    • Validation Flow
    • Cardinality Syntax
    • See Also
  • Resolvers Module
    • Module Structure
    • TreeStoreResolver
      • TreeStoreResolver
        • TreeStoreResolver.parent_node
        • TreeStoreResolver.cache_time
        • TreeStoreResolver.read_only
        • TreeStoreResolver.__init__()
        • TreeStoreResolver.parent_node
        • TreeStoreResolver.read_only
        • TreeStoreResolver.cache_time
        • TreeStoreResolver.expired
        • TreeStoreResolver.reset()
        • TreeStoreResolver.load()
        • TreeStoreResolver.serialize()
        • TreeStoreResolver.deserialize()
    • CallbackResolver
      • CallbackResolver
        • CallbackResolver.callback
        • CallbackResolver.__init__()
        • CallbackResolver.callback
        • CallbackResolver.load()
      • Example
    • DirectoryResolver
      • DirectoryResolver
        • DirectoryResolver.path
        • DirectoryResolver.relocate
        • DirectoryResolver.invisible
        • DirectoryResolver.ext
        • DirectoryResolver.include
        • DirectoryResolver.exclude
        • DirectoryResolver.callback
        • DirectoryResolver.dropext
        • DirectoryResolver.processors
        • DirectoryResolver.__init__()
        • DirectoryResolver.path
        • DirectoryResolver.relocate
        • DirectoryResolver.invisible
        • DirectoryResolver.ext
        • DirectoryResolver.include
        • DirectoryResolver.exclude
        • DirectoryResolver.callback
        • DirectoryResolver.dropext
        • DirectoryResolver.processors
        • DirectoryResolver.instance_kwargs
        • DirectoryResolver.load()
        • DirectoryResolver.processor_directory()
        • DirectoryResolver.processor_default()
      • Example
    • TxtDocResolver
      • TxtDocResolver
        • TxtDocResolver.path
        • TxtDocResolver.__init__()
        • TxtDocResolver.path
        • TxtDocResolver.load()
      • Example
    • Resolver Architecture
    • Resolver Lifecycle
    • Caching
    • Creating Custom Resolvers
    • See Also
  • Exceptions Module
    • Exception Hierarchy
    • TreeStoreError
      • TreeStoreError
        • TreeStoreError.args
    • InvalidChildError
      • InvalidChildError
    • InvalidParentError
      • InvalidParentError
    • MissingChildError
      • MissingChildError
    • TooManyChildrenError
      • TooManyChildrenError
    • Exception Handling Patterns
      • Catching All TreeStore Errors
      • Specific Exception Handling
    • Exception Flow
    • See Also
genro-treestore
  • Search

© Copyright 2025, Softwell S.r.l. - Genropy Team.

Built with Sphinx using a theme provided by Read the Docs.