added optional description to attributes

Author: evvaaaa

src/fastcs/attributes.py

@@ -52,6 +52,7 @@ def __init__(
         group: str | None = None,
         handler: Any = None,
         allowed_values: list[T] | None = None,
+        description: str | None = None
     ) -> None:
         assert (
             datatype.dtype in ATTRIBUTE_TYPES
@@ -61,6 +62,7 @@ def __init__(
         self._group = group
         self.enabled = True
         self._allowed_values: list[T] | None = allowed_values
+        self.description = description
 
     @property
     def datatype(self) -> DataType[T]:
@@ -93,13 +95,15 @@ def __init__(
         group: str | None = None,
         handler: Updater | None = None,
         allowed_values: list[T] | None = None,
+        description: str | None = None,
     ) -> None:
         super().__init__(
             datatype,  # type: ignore
             access_mode,
             group,
             handler,
             allowed_values=allowed_values,  # type: ignore
+            description=description
         )
         self._value: T = datatype.dtype()
         self._update_callback: AttrCallback[T] | None = None
@@ -132,13 +136,15 @@ def __init__(
         group: str | None = None,
         handler: Sender | None = None,
         allowed_values: list[T] | None = None,
+        description: str | None = None
     ) -> None:
         super().__init__(
             datatype,  # type: ignore
             access_mode,
             group,
             handler,
             allowed_values=allowed_values,  # type: ignore
+            description=description
         )
         self._process_callback: AttrCallback[T] | None = None
         self._write_display_callback: AttrCallback[T] | None = None
@@ -180,13 +186,15 @@ def __init__(
         group: str | None = None,
         handler: Handler | None = None,
         allowed_values: list[T] | None = None,
+        description: str | None = None
     ) -> None:
         super().__init__(
             datatype,  # type: ignore
             access_mode,
             group,
             handler,
             allowed_values,  # type: ignore
+            description=description
         )
 
     async def process(self, value: T) -> None:

src/fastcs/backends/epics/ioc.py

@@ -172,22 +172,26 @@ async def async_record_set(value: T):
 
 
 def _get_input_record(pv: str, attribute: AttrR) -> RecordWrapper:
+    attribute_fields = {}
+    if attribute.description is not None:
+        attribute_fields.update({"DESC": attribute.description})
+
     if attr_is_enum(attribute):
         assert attribute.allowed_values is not None and all(
             isinstance(v, str) for v in attribute.allowed_values
         )
         state_keys = dict(zip(MBB_STATE_FIELDS, attribute.allowed_values, strict=False))
-        return builder.mbbIn(pv, **state_keys)
+        return builder.mbbIn(pv, **state_keys, **attribute_fields)
 
     match attribute.datatype:
         case Bool(znam, onam):
-            return builder.boolIn(pv, ZNAM=znam, ONAM=onam)
+            return builder.boolIn(pv, ZNAM=znam, ONAM=onam, **attribute_fields)
         case Int():
-            return builder.longIn(pv)
+            return builder.longIn(pv, **attribute_fields)
         case Float(prec):
-            return builder.aIn(pv, PREC=prec)
+            return builder.aIn(pv, PREC=prec, **attribute_fields)
         case String():
-            return builder.longStringIn(pv)
+            return builder.longStringIn(pv, **attribute_fields)
         case _:
             raise FastCSException(
                 f"Unsupported type {type(attribute.datatype)}: {attribute.datatype}"
@@ -224,12 +228,15 @@ async def async_write_display(value: T):
 
 
 def _get_output_record(pv: str, attribute: AttrW, on_update: Callable) -> Any:
+    attribute_fields = {}
+    if attribute.description is not None:
+        attribute_fields.update({"DESC": attribute.description})
     if attr_is_enum(attribute):
         assert attribute.allowed_values is not None and all(
             isinstance(v, str) for v in attribute.allowed_values
         )
         state_keys = dict(zip(MBB_STATE_FIELDS, attribute.allowed_values, strict=False))
-        return builder.mbbOut(pv, always_update=True, on_update=on_update, **state_keys)
+        return builder.mbbOut(pv, always_update=True, on_update=on_update, **state_keys, **attribute_fields)
 
     match attribute.datatype:
         case Bool(znam, onam):
@@ -241,11 +248,11 @@ def _get_output_record(pv: str, attribute: AttrW, on_update: Callable) -> Any:
                 on_update=on_update,
             )
         case Int():
-            return builder.longOut(pv, always_update=True, on_update=on_update)
+            return builder.longOut(pv, always_update=True, on_update=on_update, **attribute_fields)
         case Float(prec):
-            return builder.aOut(pv, always_update=True, on_update=on_update, PREC=prec)
+            return builder.aOut(pv, always_update=True, on_update=on_update, PREC=prec, **attribute_fields)
         case String():
-            return builder.longStringOut(pv, always_update=True, on_update=on_update)
+            return builder.longStringOut(pv, always_update=True, on_update=on_update, **attribute_fields)
         case _:
             raise FastCSException(
                 f"Unsupported type {type(attribute.datatype)}: {attribute.datatype}"