mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-02 13:48:09 +00:00
e229ef4e19
fix: refine nested flow conditionals and ensure router methods and routes are fully parsed fix: improve docstrings, typing, and logging coverage across all events feat: update flow.plot feature with new UI enhancements chore: apply Ruff linting, reorganize imports, and remove deprecated utilities/files chore: split constants and utils, clean JS comments, and add typing for linters tests: strengthen test coverage for flow execution paths and router logic
105 lines
3.0 KiB
Python
105 lines
3.0 KiB
Python
"""OpenAPI schema conversion utilities for Flow methods."""
|
|
|
|
import inspect
|
|
from typing import Any, get_args, get_origin
|
|
|
|
|
|
def type_to_openapi_schema(type_hint: Any) -> dict[str, Any]:
|
|
"""Convert Python type hint to OpenAPI schema.
|
|
|
|
Args:
|
|
type_hint: Python type hint to convert.
|
|
|
|
Returns:
|
|
OpenAPI schema dictionary.
|
|
"""
|
|
if type_hint is inspect.Parameter.empty:
|
|
return {}
|
|
|
|
if type_hint is None or type_hint is type(None):
|
|
return {"type": "null"}
|
|
|
|
if hasattr(type_hint, "__module__") and hasattr(type_hint, "__name__"):
|
|
if type_hint.__module__ == "typing" and type_hint.__name__ == "Any":
|
|
return {}
|
|
|
|
type_str = str(type_hint)
|
|
if type_str == "typing.Any" or type_str == "<class 'typing.Any'>":
|
|
return {}
|
|
|
|
if isinstance(type_hint, str):
|
|
return {"type": type_hint}
|
|
|
|
origin = get_origin(type_hint)
|
|
args = get_args(type_hint)
|
|
|
|
if type_hint is str:
|
|
return {"type": "string"}
|
|
if type_hint is int:
|
|
return {"type": "integer"}
|
|
if type_hint is float:
|
|
return {"type": "number"}
|
|
if type_hint is bool:
|
|
return {"type": "boolean"}
|
|
if type_hint is dict or origin is dict:
|
|
if args and len(args) > 1:
|
|
return {
|
|
"type": "object",
|
|
"additionalProperties": type_to_openapi_schema(args[1]),
|
|
}
|
|
return {"type": "object"}
|
|
if type_hint is list or origin is list:
|
|
if args:
|
|
return {"type": "array", "items": type_to_openapi_schema(args[0])}
|
|
return {"type": "array"}
|
|
if hasattr(type_hint, "__name__"):
|
|
return {"type": "object", "className": type_hint.__name__}
|
|
|
|
return {}
|
|
|
|
|
|
def extract_method_signature(method: Any, method_name: str) -> dict[str, Any]:
|
|
"""Extract method signature as OpenAPI schema with documentation.
|
|
|
|
Args:
|
|
method: Method to analyze.
|
|
method_name: Method name.
|
|
|
|
Returns:
|
|
Dictionary with operationId, parameters, returns, summary, and description.
|
|
"""
|
|
try:
|
|
sig = inspect.signature(method)
|
|
|
|
parameters = {}
|
|
for param_name, param in sig.parameters.items():
|
|
if param_name == "self":
|
|
continue
|
|
parameters[param_name] = type_to_openapi_schema(param.annotation)
|
|
|
|
return_type = type_to_openapi_schema(sig.return_annotation)
|
|
|
|
docstring = inspect.getdoc(method)
|
|
|
|
result: dict[str, Any] = {
|
|
"operationId": method_name,
|
|
"parameters": parameters,
|
|
"returns": return_type,
|
|
}
|
|
|
|
if docstring:
|
|
lines = docstring.strip().split("\n")
|
|
summary = lines[0].strip()
|
|
|
|
if summary:
|
|
result["summary"] = summary
|
|
|
|
if len(lines) > 1:
|
|
description = "\n".join(line.strip() for line in lines[1:]).strip()
|
|
if description:
|
|
result["description"] = description
|
|
|
|
return result
|
|
except Exception:
|
|
return {"operationId": method_name, "parameters": {}, "returns": {}}
|