pyobs-core 2.7.0__tar.gz → 2.7.2__tar.gz

{pyobs_core-2.7.0 → pyobs_core-2.7.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: pyobs-core
-Version: 2.7.0
+Version: 2.7.2
 Summary: robotic telescope software
 Author-email: Tim-Oliver Husser <thusser@uni-goettingen.de>
 License-Expression: MIT

{pyobs_core-2.7.0 → pyobs_core-2.7.2}/pyobs/utils/config_schema.py

@@ -10,7 +10,19 @@ from typing import Annotated, Any, get_args, get_origin, get_type_hints
 from pydantic import BaseModel
 from pydantic_core import PydanticUndefined
 
-from pyobs.utils.enums import Unit
+from pyobs.utils.enums import AccessLevel, Unit
+
+
+def _coerce_level(value: Any) -> AccessLevel:
+    """Coerce a raw level value (an int, or any IntEnum with matching member values -- e.g. a
+    consumer's own local AccessLevel copy per specs/steering/gui-field-access-levels.md) into
+    this module's AccessLevel. Falls back to BASIC for anything missing or unrecognized, so a
+    field that never opted into this feature keeps rendering exactly as before.
+    """
+    try:
+        return AccessLevel(int(value))
+    except (TypeError, ValueError):
+        return AccessLevel.BASIC
 
 
 @dataclasses.dataclass
@@ -20,6 +32,8 @@ class ConfigFieldSchema:
     options: list[str] | None = None
     default: Any | None = None
     nested: dict[str, ConfigFieldSchema] | None = None
+    level: AccessLevel = AccessLevel.BASIC
+    description: str | None = None
 
 
 @dataclasses.dataclass
@@ -44,7 +58,10 @@ def dataclass_to_schema(cls: type) -> ConfigSchema:
     hints = get_type_hints(cls, include_extras=True)
     fields: dict[str, ConfigFieldSchema] = {}
     for f in dataclasses.fields(cls):
-        fields[f.name] = _field_schema(hints[f.name], f.default)
+        schema = _field_schema(hints[f.name], f.default)
+        schema.level = _coerce_level(f.metadata.get("level", AccessLevel.BASIC))
+        schema.description = f.metadata.get("description")
+        fields[f.name] = schema
     return ConfigSchema(fields=fields)
 
 
@@ -97,10 +114,30 @@ def pydantic_to_schema(cls: type[BaseModel]) -> ConfigSchema:
     fields: dict[str, ConfigFieldSchema] = {}
     for name, info in cls.model_fields.items():
         default = None if info.default is PydanticUndefined else info.default
-        fields[name] = _pydantic_field_schema(info.annotation, default)
+        schema = _pydantic_field_schema(info.annotation, default)
+        schema.level = _pydantic_field_level(info.json_schema_extra)
+        schema.description = _pydantic_field_description(info)
+        fields[name] = schema
     return ConfigSchema(fields=fields)
 
 
+def _pydantic_field_level(json_schema_extra: Any) -> AccessLevel:
+    if isinstance(json_schema_extra, dict) and "level" in json_schema_extra:
+        return _coerce_level(json_schema_extra["level"])
+    return AccessLevel.BASIC
+
+
+def _pydantic_field_description(info: Any) -> str | None:
+    """FTSConfigMain (pyftscontrol) puts the description inside json_schema_extra alongside
+    level, rather than using Pydantic's own Field(description=...) -- prefer that convention
+    when present, but fall back to the native `description` for a model that uses it directly.
+    """
+    extra = info.json_schema_extra
+    if isinstance(extra, dict) and isinstance(extra.get("description"), str):
+        return extra["description"]
+    return info.description
+
+
 def _pydantic_field_schema(annotation: Any, default: Any) -> ConfigFieldSchema:
     origin = get_origin(annotation)
 

{pyobs_core-2.7.0 → pyobs_core-2.7.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pyobs-core"
-version = "2.7.0"
+version = "2.7.2"
 description = "robotic telescope software"
 authors = [{ name = "Tim-Oliver Husser", email = "thusser@uni-goettingen.de" }]
 requires-python = ">=3.11"