bisque-metadoc 0.6.7

Bisque Metadoc

ViQi Metadoc

Representation of hierarchical documents with various "rendering" and query options. For doc communication between server/clients.

Install

pip install bisque-metadoc

Usage

Metadoc provides a unified interface for working with hierarchical metadata in various formats (XML, JSON, Python dicts).

Creating a Metadoc

from bq.metadoc.formats import Metadoc

# Create a new document
doc = Metadoc(tag="resource", name="my_image", type="image")

# Add child tags
doc.add_tag("author", value="John Doe")
doc.add_tag("description", value="A sample image")

# Create from Natural XML
xml_str = '<resource name="test"><child>123</child></resource>'
doc = Metadoc.from_naturalxml(xml_str)

# Create from Python dictionary
data = {"resource": {"@name": "test", "child": "123"}}
doc = Metadoc.from_dict(data)

Accessing Data

Metadoc supports attribute-style access and automatic type conversion.

print(doc.tag)         # "resource"
print(doc.name)        # "test"
print(doc.child.value) # 123 (automatically converted to int if type is set)

# Iterating over children
for child in doc:
    print(child.tag, child.value)

Dynamic Attribute and Private Metadata Access

You can also dynamically attach and query custom private metadata/attributes (properties starting with either single or double underscores, e.g., _etag or _origin_url) on any Metadoc instance. Standard pythonic attribute assignments work natively:

# Set custom metadata
doc._etag = '"2026-07-29T14:15:10.000000Z"'
doc._origin_url = "http://localhost:8180/data_service/00-XXXX"

# Retrieve custom metadata
print(doc._etag)        # '"2026-07-29T14:15:10.000000Z"'
print(doc._origin_url)  # "http://localhost:8180/data_service/00-XXXX"

Path Queries

Simplified path queries automatically handle the internal mapping of custom tags. Specifically, short-hand element names are expanded to match Bisque "System" XML representations where generic <tag> elements use the name attribute.

Therefore, the shorthand query "//xx" is translated behind the scenes to "//tag[@name='xx']", making both styles functionally identical.

# Finds all tags named "author" anywhere in the document (shorthand notation)
authors = doc.path_query("//author")

# This is equivalent to explicitly querying by the "tag" element and "name" attribute:
authors_explicit = doc.path_query('//tag[@name="author"]')

# Finds all "author" tags that have a specific attribute "type"
authors_with_type = doc.path_query('//author[@type="primary"]')

# Finds a tag named "author" directly under the root resource
direct_authors = doc.path_query("/resource/author")

# Spaces in tag names are also supported without extra quoting
authors_with_spaces = doc.path_query("//author name with spaces")

Formats and Serialization

Metadoc supports multiple serialization formats:

• Natural XML: Standard XML where data names are used as tags.
• Tag XML: Bisque "System" XML where values are stored in attributes and generic <tag name="..."> elements are used for custom metadata.
• Natural JSON: Idiomatic JSON dictionaries (attributes prefixed with @).
• Ordered JSON: A round-trippable JSON structure that preserves element order using an @children list.

# To XML string
print(doc.to_naturalxml())
print(doc.to_tagxml())

# To JSON string or dict
print(doc.to_json())
print(doc.to_dict())

# To/From Ordered JSON (preserves order and mixed content)
ordered_json = doc.to_ordered_json()
doc2 = Metadoc.from_ordered_json(ordered_json)

Documentation

• Metadoc