Add get_controller_schema function

src/fastcs/launch.py

@@ -1,7 +1,7 @@
 import inspect
 import json
 from pathlib import Path
-from typing import Annotated, TypeAlias, get_type_hints
+from typing import Annotated, Any, TypeAlias, get_type_hints
 
 import typer
 from pydantic import BaseModel, create_model
@@ -205,3 +205,9 @@ def _extract_options_model(controller_class: type[Controller]) -> type[BaseModel
             f".__init__' but received {len(args)} as `{sig}`"
         )
     return fastcs_options
+
+
+def get_controller_schema(target: type[Controller]) -> dict[str, Any]:
+    options_model = _extract_options_model(target)
+    target_schema = options_model.model_json_schema()
+    return target_schema

tests/test_launch.py

@@ -4,12 +4,13 @@
 import pytest
 from pydantic import create_model
 from pytest_mock import MockerFixture
+from ruamel.yaml import YAML
 from typer.testing import CliRunner
 
 from fastcs.__main__ import __version__
 from fastcs.controller import Controller
 from fastcs.exceptions import LaunchError
-from fastcs.launch import TransportOptions, _launch, launch
+from fastcs.launch import TransportOptions, _launch, get_controller_schema, launch
 
 
 @dataclass
@@ -143,3 +144,9 @@ def test_launch_full(mocker: MockerFixture, data):
     run.assert_called_once()
     gui.assert_called_once()
     docs.assert_called_once()
+
+
+def test_get_schema(data):
+    ref_schema = YAML(typ="safe").load(data / "schema.json")
+    target_schema = get_controller_schema(IsHinted)
+    assert target_schema == ref_schema