Function generate_structure

toon/structure_generator.py:11–62

Generate a TOON structure template from a schema definition. This function creates a response structure template that can be included in LLM prompts to specify the expected output format without examples. Args: schema: Schema definition as a dict or list of dicts

(
    schema: Union[Dict[str, Any], List[Dict[str, Any]]], 
    options: Optional[Dict[str, Any]] = None
)

def generate_structure(
    schema: Union[Dict[str, Any], List[Dict[str, Any]]], 
    options: Optional[Dict[str, Any]] = None
) -> str:
    """
    Generate a TOON structure template from a schema definition.
    
    This function creates a response structure template that can be included
    in LLM prompts to specify the expected output format without examples.
    
    Args:
        schema: Schema definition as a dict or list of dicts
            - For simple fields: {"field_name": "description"}
            - For nested objects: {"field_name": {"nested_field": "description"}}
            - For arrays: {"field_name": [{"array_field": "description"}]}
            - List at root level creates a tabular array template
        options: Optional encoding options
            - delimiter: ',' (default), '\t', or '|'
            - indent: int (default 2)
            
    Returns:
        TOON formatted structure template string
        
    Examples:
        >>> schema = {
        ...     "name": "name of the person",
        ...     "age": "age of the person",
        ...     "occupation": "job description of the person"
        ... }
        >>> print(generate_structure(schema))
        name: <name of the person>
        age: <age of the person>
        occupation: <job description of the person>
        
        >>> schema = [{"id": "user id", "name": "user name"}]
        >>> print(generate_structure(schema))
        [N]{id,name}:
          <user id>,<user name>
          ...
    """
    if options is None:
        options = {}
    
    delimiter = options.get('delimiter', DEFAULT_DELIMITER)
    indent = options.get('indent', DEFAULT_INDENT)
    
    if isinstance(schema, list):
        return _generate_array_structure(schema, 0, delimiter, indent)
    elif isinstance(schema, dict):
        return _generate_object_structure(schema, 0, delimiter, indent)
    else:
        return "<value>"


def _generate_object_structure(