Function autoextract

backend/python/pydevlake/pydevlake/extractor.py:24–59

Automatically extract a tool model from a json object. The tool model class can define fields with a source argument to specify the JSON pointer (RFC 6901) to the value. Example: class DummyModel(ToolModel): name: str version: str = Field(source='/versio

(json: dict, model_cls: Type[ToolModel])

def autoextract(json: dict, model_cls: Type[ToolModel]) -> ToolModel:
    """
    Automatically extract a tool model from a json object.
    The tool model class can define fields with a source argument to specify the JSON pointer (RFC 6901) to the value.

    Example:
        class DummyModel(ToolModel):
            name: str
            version: str = Field(source='/version/number')

        json = {
            'name': 'test',
            'version': {
                'number': '1.0.0',
                'build_date': '2023-04-19'
            }
        }

        model = autoextract(json, DummyModel)
    """
    attributes = {}
    for field in model_cls.__fields__.values():
        pointer = field.field_info.extra.get('source')

        if pointer:
            if field.required:
                try:
                    value = resolve_pointer(json, pointer)
                except JsonPointerException:
                    raise ValueError(f"Missing required value for field {field.name} at {pointer}")
            else:
                value = resolve_pointer(json, pointer, field.default)
        else:
            value = json.get(field.name) or json.get(field.alias)
        attributes[field.name] = value
    return model_cls(**attributes)