Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhancements to JSON Schema Generation in speckle_automate #347

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 69 additions & 8 deletions src/speckle_automate/runner.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
import traceback
from pathlib import Path
from typing import Callable, Optional, Tuple, TypeVar, Union, overload
from enum import Enum

from pydantic import create_model
from pydantic.json_schema import GenerateJsonSchema
Expand Down Expand Up @@ -70,14 +71,7 @@ def execute_automate_function(
automate_function: AutomateFunctionWithoutInputs,
) -> None:
...


class AutomateGenerateJsonSchema(GenerateJsonSchema):
def generate(self, schema, mode="validation"):
json_schema = super().generate(schema, mode=mode)
json_schema["$schema"] = self.schema_dialect
return json_schema



def execute_automate_function(
automate_function: Union[AutomateFunction[T], AutomateFunctionWithoutInputs],
Expand Down Expand Up @@ -195,3 +189,70 @@ def run_function(
automation_context.set_context_view()
automation_context.report_run_status()
return automation_context


class AutomateGenerateJsonSchema(GenerateJsonSchema):
def __init__(self, by_alias: bool = True, ref_template: str = "#/$defs/{model}"):
super().__init__(by_alias=by_alias, ref_template=ref_template)
self.schema_dialect = "https://json-schema.org/draft/2020-12/schema"

def generate(self, schema, mode="validation"):
json_schema = super().generate(schema, mode=mode)
json_schema["$schema"] = self.schema_dialect

if "properties" in json_schema:
for prop, details in json_schema["properties"].items():
self._process_property(
details, json_schema.get("$defs", {}), getattr(schema, prop, None)
)

if "$defs" in json_schema:
for def_name, def_schema in json_schema["$defs"].items():
self._process_property(def_schema, json_schema["$defs"], None)

return json_schema

def _process_property(self, property_schema, defs, field):
if "allOf" in property_schema and len(property_schema["allOf"]) == 1:
ref = property_schema["allOf"][0].get("$ref")
if ref and ref.startswith("#/$defs/"):
enum_name = ref.split("/")[-1]
if enum_name in defs:
enum_schema = defs[enum_name]
property_schema.update(enum_schema)
del property_schema["allOf"]

if "enum" in property_schema:
enum_values = property_schema["enum"]
property_schema["oneOf"] = [
{"const": value, "title": str(value).upper()} for value in enum_values
]
del property_schema["enum"]

if isinstance(field, Enum):
property_schema["oneOf"] = [
{"const": item.value, "title": item.name} for item in field.__class__
]
if "default" in property_schema:
property_schema["default"] = property_schema["default"].value

if "type" not in property_schema:
if "oneOf" in property_schema:
property_schema["type"] = "string"
elif "default" in property_schema:
property_schema["type"] = self._infer_type(property_schema["default"])
else:
property_schema["type"] = "object"

@staticmethod
def _infer_type(value):
if isinstance(value, bool):
return "boolean"
elif isinstance(value, int):
return "integer"
elif isinstance(value, float):
return "number"
elif isinstance(value, str):
return "string"
else:
return "object"