Merge pull request #118 from tiqi-group/feat/sio_server_client

Feat/sio server client

README.md

@@ -11,13 +11,17 @@
   - [Defining a DataService](#defining-a-dataservice)
   - [Running the Server](#running-the-server)
   - [Accessing the Web Interface](#accessing-the-web-interface)
-  - [Connecting to the Service using rpyc](#connecting-to-the-service-using-rpyc)
+  - [Connecting to the Service via Python Client](#connecting-to-the-service-via-python-client)
+    - [Tab Completion Support](#tab-completion-support)
+    - [Integration within Another Service](#integration-within-another-service)
 - [Understanding the Component System](#understanding-the-component-system)
   - [Built-in Type and Enum Components](#built-in-type-and-enum-components)
   - [Method Components](#method-components)
   - [DataService Instances (Nested Classes)](#dataservice-instances-nested-classes)
   - [Custom Components (`pydase.components`)](#custom-components-pydasecomponents)
     - [`DeviceConnection`](#deviceconnection)
+      - [Customizing Connection Logic](#customizing-connection-logic)
+      - [Reconnection Interval](#reconnection-interval)
     - [`Image`](#image)
     - [`NumberSlider`](#numberslider)
     - [`ColouredEnum`](#colouredenum)
@@ -30,6 +34,7 @@
 - [Customizing the Web Interface](#customizing-the-web-interface)
   - [Enhancing the Web Interface Style with Custom CSS](#enhancing-the-web-interface-style-with-custom-css)
   - [Tailoring Frontend Component Layout](#tailoring-frontend-component-layout)
+  - [Specifying a Custom Frontend Source](#specifying-a-custom-frontend-source)
 - [Logging in pydase](#logging-in-pydase)
   - [Changing the Log Level](#changing-the-log-level)
 - [Documentation](#documentation)
@@ -41,7 +46,7 @@
 <!-- no toc -->
 - [Simple data service definition through class-based interface](#defining-a-dataService)
 - [Integrated web interface for interactive access and control of your data service](#accessing-the-web-interface)
-- [Support for `rpyc` connections, allowing for programmatic control and interaction with your service](#connecting-to-the-service-using-rpyc)
+- [Support for programmatic control and interaction with your service](#connecting-to-the-service-via-python-client)
 - [Component system bridging Python backend with frontend visual representation](#understanding-the-component-system)
 - [Customizable styling for the web interface through user-defined CSS](#customizing-web-interface-style)
 - [Saving and restoring the service state for service persistence](#understanding-service-persistence)
@@ -71,11 +76,11 @@ pip install pydase
 
 <!--usage-start-->
 
-Using `pydase` involves three main steps: defining a `DataService` subclass, running the server, and then connecting to the service either programmatically using `rpyc` or through the web interface.
+Using `pydase` involves three main steps: defining a `DataService` subclass, running the server, and then connecting to the service either programmatically using `pydase.Client` or through the web interface.
 
 ### Defining a DataService
 
-To use pydase, you'll first need to create a class that inherits from `DataService`. This class represents your custom data service, which will be exposed via RPC (using rpyc) and a web server. Your class can implement class / instance attributes and synchronous and asynchronous tasks.
+To use pydase, you'll first need to create a class that inherits from `DataService`. This class represents your custom data service, which will be exposed via a web server. Your class can implement class / instance attributes and synchronous and asynchronous tasks.
 
 Here's an example:
 
@@ -156,23 +161,51 @@ Once the server is running, you can access the web interface in a browser:
 
 In this interface, you can interact with the properties of your `Device` service.
 
-### Connecting to the Service using rpyc
+### Connecting to the Service via Python Client
 
-You can also connect to the service using `rpyc`. Here's an example on how to establish a connection and interact with the service:
+You can connect to the service using the `pydase.Client`. Below is an example of how to establish a connection to a service and interact with it:
 
 ```python
-import rpyc
+import pydase
 
-# Connect to the service
-conn = rpyc.connect("<ip_addr>", 18871)
-client = conn.root
+# Replace the hostname and port with the IP address and the port of the machine where 
+# the service is running, respectively
+client_proxy = pydase.Client(hostname="<ip_addr>", port=8001).proxy
 
-# Interact with the service
-client.voltage = 5.0
-print(client.voltage)  # prints 5.0
+# After the connection, interact with the service attributes as if they were local
+client_proxy.voltage = 5.0
+print(client_proxy.voltage)  # Expected output: 5.0
 ```
 
-In this example, replace `<ip_addr>` with the IP address of the machine where the service is running. After establishing a connection, you can interact with the service attributes as if they were local attributes.
+This example demonstrates setting and retrieving the `voltage` attribute through the client proxy.
+The proxy acts as a local representative of the remote service, enabling straightforward interaction.
+
+The proxy class dynamically synchronizes with the server's exposed attributes. This synchronization allows the proxy to be automatically updated with any attributes or methods that the server exposes, essentially mirroring the server's API. This dynamic updating enables users to interact with the remote service as if they were working with a local object.
+
+#### Tab Completion Support
+
+In interactive environments such as Python interpreters and Jupyter notebooks, the proxy class supports tab completion, which allows users to explore available methods and attributes.
+
+#### Integration within Another Service
+
+You can also integrate a client proxy within another service. Here's how you can set it up:
+
+```python
+import pydase
+
+class MyService(pydase.DataService):
+    # Initialize the client without blocking the constructor
+    proxy = pydase.Client(hostname="<ip_addr>", port=8001, block_until_connected=False).proxy
+
+if __name__ == "__main__":
+    service = MyService()
+    # Create a server that exposes this service; adjust the web_port as needed
+    server = pydase.Server(service, web_port=8002). run()
+```
+
+In this setup, the `MyService` class has a `proxy` attribute that connects to a `pydase` service located at `<ip_addr>:8001`.
+The `block_until_connected=False` argument allows the service to start up even if the initial connection attempt fails.
+This configuration is particularly useful in distributed systems where services may start in any order.
 
 <!--usage-end-->
 
@@ -831,10 +864,33 @@ Please ensure that the CSS file path is accessible from the server's running loc
 `pydase` enables users to customize the frontend layout via the `web_settings.json` file. Each key in the file corresponds to the full access path of public attributes, properties, and methods of the exposed service, using dot-notation.
 
 - **Custom Display Names**: Modify the `"displayName"` value in the file to change how each component appears in the frontend.
-<!-- - **Adjustable Component Order**: The `"index"` values determine the order of components. Alter these values to rearrange the components as desired. -->
+- **Control Component Visibility**: Utilize the `"display"` key-value pair to control whether a component is rendered in the frontend. Set the value to `true` to make the component visible or `false` to hide it.
+<!-- - **Adjustable Component Order**: The `"displayOrder"` values determine the order of components. Alter these values to rearrange the components as desired. -->
 
 The `web_settings.json` file will be stored in the directory specified by `SERVICE_CONFIG_DIR`. You can generate a `web_settings.json` file by setting the `GENERATE_WEB_SETTINGS` to `True`. For more information, see the [configuration section](#configuring-pydase-via-environment-variables).
 
+### Specifying a Custom Frontend Source
+
+To further personalize your web interface, you can provide `pydase` with a custom frontend GUI. To do so, you can use the `frontend_src` keyword in the `pydase.Server`:
+
+```python
+from pathlib import Path
+
+import pydase
+
+
+class MyService(pydase.DataService):
+    # Service definition
+
+
+if __name__ == "__main__":
+    service = MyService()
+    pydase.Server(
+        service,
+        frontend_src=Path("path/to/your/frontend/directory"),
+    ).run()
+```
+
 ## Logging in pydase
 
 The `pydase` library organizes its loggers on a per-module basis, mirroring the Python package hierarchy. This structured approach allows for granular control over logging levels and behaviour across different parts of the library.

frontend/src/App.tsx

@@ -32,6 +32,9 @@ const reducer = (state: State, action: Action): State => {
     case 'SET_DATA':
       return action.data;
     case 'UPDATE_ATTRIBUTE': {
+      if (state === null) {
+        return null;
+      }
       return {
         ...state,
         value: setNestedValueByPath(state.value, action.fullAccessPath, action.newValue)
@@ -185,8 +188,6 @@ const App = () => {
       <div className="App navbarOffset">
         <WebSettingsContext.Provider value={webSettings}>
           <GenericComponent
-            name=""
-            parentPath=""
             attribute={state as SerializedValue}
             isInstantUpdate={isInstantUpdate}
             addNotification={addNotification}

frontend/src/WebSettings.tsx

@@ -4,5 +4,6 @@ export const WebSettingsContext = createContext<Record<string, WebSetting>>({});
 
 export type WebSetting = {
   displayName: string;
+  display: boolean;
   index: number;
 };

frontend/src/components/AsyncMethodComponent.tsx

@@ -5,8 +5,7 @@ import { DocStringComponent } from './DocStringComponent';
 import { LevelName } from './NotificationsComponent';
 
 type AsyncMethodProps = {
-  name: string;
-  parentPath: string;
+  fullAccessPath: string;
   value: 'RUNNING' | null;
   docString?: string;
   hideOutput?: boolean;
@@ -18,8 +17,7 @@ type AsyncMethodProps = {
 
 export const AsyncMethodComponent = React.memo((props: AsyncMethodProps) => {
   const {
-    name,
-    parentPath,
+    fullAccessPath,
     docString,
     value: runningTask,
     addNotification,
@@ -34,7 +32,8 @@ export const AsyncMethodComponent = React.memo((props: AsyncMethodProps) => {
 
   const renderCount = useRef(0);
   const formRef = useRef(null);
-  const fullAccessPath = [parentPath, name].filter((element) => element).join('.');
+  const name = fullAccessPath.split('.').at(-1);
+  const parentPath = fullAccessPath.slice(0, -(name.length + 1));
 
   useEffect(() => {
     renderCount.current++;
@@ -58,7 +57,8 @@ export const AsyncMethodComponent = React.memo((props: AsyncMethodProps) => {
       method_name = `start_${name}`;
     }
 
-    runMethod(method_name, parentPath, {});
+    const accessPath = [parentPath, method_name].filter((element) => element).join('.');
+    runMethod(accessPath);
   };
 
   return (

frontend/src/components/ButtonComponent.tsx

@@ -1,22 +1,17 @@
 import React, { useEffect, useRef } from 'react';
 import { ToggleButton } from 'react-bootstrap';
 import { DocStringComponent } from './DocStringComponent';
+import { SerializedValue } from './GenericComponent';
 import { LevelName } from './NotificationsComponent';
 
 type ButtonComponentProps = {
-  name: string;
-  parentPath?: string;
+  fullAccessPath: string;
   value: boolean;
   readOnly: boolean;
   docString: string;
   mapping?: [string, string]; // Enforce a tuple of two strings
   addNotification: (message: string, levelname?: LevelName) => void;
-  changeCallback?: (
-    value: unknown,
-    attributeName?: string,
-    prefix?: string,
-    callback?: (ack: unknown) => void
-  ) => void;
+  changeCallback?: (value: SerializedValue, callback?: (ack: unknown) => void) => void;
   displayName: string;
   id: string;
 };
@@ -24,6 +19,7 @@ type ButtonComponentProps = {
 export const ButtonComponent = React.memo((props: ButtonComponentProps) => {
   const {
     value,
+    fullAccessPath,
     readOnly,
     docString,
     addNotification,
@@ -32,9 +28,6 @@ export const ButtonComponent = React.memo((props: ButtonComponentProps) => {
     id
   } = props;
   // const buttonName = props.mapping ? (value ? props.mapping[0] : props.mapping[1]) : name;
-  const fullAccessPath = [props.parentPath, props.name]
-    .filter((element) => element)
-    .join('.');
 
   const renderCount = useRef(0);
 

frontend/src/components/ColouredEnumComponent.tsx

@@ -1,100 +0,0 @@
-import React, { useEffect, useRef, useState } from 'react';
-import { InputGroup, Form, Row, Col } from 'react-bootstrap';
-import { DocStringComponent } from './DocStringComponent';
-import { LevelName } from './NotificationsComponent';
-
-type ColouredEnumComponentProps = {
-  name: string;
-  parentPath: string;
-  value: string;
-  docString?: string;
-  readOnly: boolean;
-  enumDict: Record<string, string>;
-  addNotification: (message: string, levelname?: LevelName) => void;
-  changeCallback?: (
-    value: unknown,
-    attributeName?: string,
-    prefix?: string,
-    callback?: (ack: unknown) => void
-  ) => void;
-  displayName: string;
-  id: string;
-};
-
-export const ColouredEnumComponent = React.memo((props: ColouredEnumComponentProps) => {
-  const {
-    name,
-    value,
-    docString,
-    enumDict,
-    readOnly,
-    addNotification,
-    displayName,
-    id
-  } = props;
-  let { changeCallback } = props;
-  if (changeCallback === undefined) {
-    changeCallback = (value: string) => {
-      setEnumValue(() => {
-        return value;
-      });
-    };
-  }
-
-  const renderCount = useRef(0);
-  const [enumValue, setEnumValue] = useState(value);
-
-  const fullAccessPath = [props.parentPath, props.name]
-    .filter((element) => element)
-    .join('.');
-
-  useEffect(() => {
-    renderCount.current++;
-  });
-
-  useEffect(() => {
-    setEnumValue(() => {
-      return props.value;
-    });
-    addNotification(`${fullAccessPath} changed to ${value}.`);
-  }, [props.value]);
-
-  return (
-    <div className={'component enumComponent'} id={id}>
-      {process.env.NODE_ENV === 'development' && (
-        <div>Render count: {renderCount.current}</div>
-      )}
-      <Row>
-        <Col className="d-flex align-items-center">
-          <InputGroup.Text>
-            {displayName}
-            <DocStringComponent docString={docString} />
-          </InputGroup.Text>
-          {readOnly ? (
-            // Display the Form.Control when readOnly is true
-            <Form.Control
-              value={enumValue}
-              name={name}
-              disabled={true}
-              style={{ backgroundColor: enumDict[enumValue] }}
-            />
-          ) : (
-            // Display the Form.Select when readOnly is false
-            <Form.Select
-              aria-label="coloured-enum-select"
-              value={enumValue}
-              name={name}
-              style={{ backgroundColor: enumDict[enumValue] }}
-              onChange={(event) => changeCallback(event.target.value)}>
-              {Object.entries(enumDict).map(([key]) => (
-                <option key={key} value={key}>
-                  {key}
-                </option>
-              ))}
-            </Form.Select>
-          )}
-        </Col>
-      </Row>
-    </div>
-  );
-});

frontend/src/components/DataServiceComponent.tsx

@@ -6,9 +6,7 @@ import { SerializedValue, GenericComponent } from './GenericComponent';
 import { LevelName } from './NotificationsComponent';
 
 type DataServiceProps = {
-  name: string;
   props: DataServiceJSON;
-  parentPath?: string;
   isInstantUpdate: boolean;
   addNotification: (message: string, levelname?: LevelName) => void;
   displayName: string;
@@ -18,17 +16,8 @@ type DataServiceProps = {
 export type DataServiceJSON = Record<string, SerializedValue>;
 
 export const DataServiceComponent = React.memo(
-  ({
-    name,
-    props,
-    parentPath = undefined,
-    isInstantUpdate,
-    addNotification,
-    displayName,
-    id
-  }: DataServiceProps) => {
+  ({ props, isInstantUpdate, addNotification, displayName, id }: DataServiceProps) => {
     const [open, setOpen] = useState(true);
-    const fullAccessPath = [parentPath, name].filter((element) => element).join('.');
 
     if (displayName !== '') {
       return (
@@ -43,8 +32,6 @@ export const DataServiceComponent = React.memo(
                   <GenericComponent
                     key={key}
                     attribute={value}
-                    name={key}
-                    parentPath={fullAccessPath}
                     isInstantUpdate={isInstantUpdate}
                     addNotification={addNotification}
                   />
@@ -61,8 +48,6 @@ export const DataServiceComponent = React.memo(
             <GenericComponent
               key={key}
               attribute={value}
-              name={key}
-              parentPath={fullAccessPath}
               isInstantUpdate={isInstantUpdate}
               addNotification={addNotification}
             />

frontend/src/components/DeviceConnection.tsx

@@ -4,9 +4,8 @@ import { DataServiceComponent, DataServiceJSON } from './DataServiceComponent';
 import { MethodComponent } from './MethodComponent';
 
 type DeviceConnectionProps = {
-  name: string;
+  fullAccessPath: string;
   props: DataServiceJSON;
-  parentPath: string;
   isInstantUpdate: boolean;
   addNotification: (message: string, levelname?: LevelName) => void;
   displayName: string;
@@ -15,9 +14,8 @@ type DeviceConnectionProps = {
 
 export const DeviceConnectionComponent = React.memo(
   ({
-    name,
+    fullAccessPath,
     props,
-    parentPath,
     isInstantUpdate,
     addNotification,
     displayName,
@@ -26,8 +24,6 @@ export const DeviceConnectionComponent = React.memo(
     const { connected, connect, ...updatedProps } = props;
     const connectedVal = connected.value;
 
-    const fullAccessPath = [parentPath, name].filter((element) => element).join('.');
-
     return (
       <div className="deviceConnectionComponent" id={id}>
         {!connectedVal && (
@@ -36,8 +32,7 @@ export const DeviceConnectionComponent = React.memo(
               {displayName != '' ? displayName : 'Device'} is currently not available!
             </div>
             <MethodComponent
-              name="connect"
-              parentPath={fullAccessPath}
+              fullAccessPath={`${fullAccessPath}.connect`}
               docString={connect.doc}
               addNotification={addNotification}
               displayName={'reconnect'}
@@ -47,9 +42,7 @@ export const DeviceConnectionComponent = React.memo(
           </div>
         )}
         <DataServiceComponent
-          name={name}
           props={updatedProps}
-          parentPath={parentPath}
           isInstantUpdate={isInstantUpdate}
           addNotification={addNotification}
           displayName={displayName}

frontend/src/components/EnumComponent.tsx

@@ -1,63 +1,58 @@
 import React, { useEffect, useRef, useState } from 'react';
 import { InputGroup, Form, Row, Col } from 'react-bootstrap';
 import { DocStringComponent } from './DocStringComponent';
+import { SerializedValue } from './GenericComponent';
 import { LevelName } from './NotificationsComponent';
 
-type EnumComponentProps = {
+export type EnumSerialization = {
+  type: 'Enum' | 'ColouredEnum';
+  full_access_path: string;
   name: string;
-  parentPath: string;
   value: string;
-  docString?: string;
-  readOnly: boolean;
-  enumDict: Record<string, string>;
+  readonly: boolean;
+  doc?: string | null;
+  enum: Record<string, string>;
+};
+
+type EnumComponentProps = {
+  attribute: EnumSerialization;
   addNotification: (message: string, levelname?: LevelName) => void;
-  changeCallback?: (
-    value: unknown,
-    attributeName?: string,
-    prefix?: string,
-    callback?: (ack: unknown) => void
-  ) => void;
   displayName: string;
   id: string;
+  changeCallback?: (value: SerializedValue, callback?: (ack: unknown) => void) => void;
 };
 
 export const EnumComponent = React.memo((props: EnumComponentProps) => {
+  const { attribute, addNotification, displayName, id } = props;
   const {
-    name,
+    full_access_path: fullAccessPath,
     value,
-    docString,
-    enumDict,
-    addNotification,
-    displayName,
-    id,
-    readOnly
-  } = props;
+    doc: docString,
+    enum: enumDict,
+    readonly: readOnly
+  } = attribute;
 
   let { changeCallback } = props;
   if (changeCallback === undefined) {
-    changeCallback = (value: string) => {
+    changeCallback = (value: SerializedValue) => {
       setEnumValue(() => {
-        return value;
+        return String(value.value);
       });
     };
   }
   const renderCount = useRef(0);
   const [enumValue, setEnumValue] = useState(value);
 
-  const fullAccessPath = [props.parentPath, props.name]
-    .filter((element) => element)
-    .join('.');
-
   useEffect(() => {
     renderCount.current++;
   });
 
   useEffect(() => {
     setEnumValue(() => {
-      return props.value;
+      return value;
     });
     addNotification(`${fullAccessPath} changed to ${value}.`);
-  }, [props.value]);
+  }, [value]);
 
   return (
     <div className={'component enumComponent'} id={id}>
@@ -73,17 +68,36 @@ export const EnumComponent = React.memo((props: EnumComponentProps) => {
 
           {readOnly ? (
             // Display the Form.Control when readOnly is true
-            <Form.Control value={enumDict[enumValue]} name={name} disabled={true} />
+            <Form.Control
+              value={enumDict[enumValue]}
+              name={fullAccessPath}
+              disabled={true}
+            />
           ) : (
             // Display the Form.Select when readOnly is false
             <Form.Select
               aria-label="example-select"
               value={enumValue}
-              name={name}
-              onChange={(event) => changeCallback(event.target.value)}>
+              name={fullAccessPath}
+              style={
+                attribute.type == 'ColouredEnum'
+                  ? { backgroundColor: enumDict[enumValue] }
+                  : {}
+              }
+              onChange={(event) =>
+                changeCallback({
+                  type: attribute.type,
+                  name: attribute.name,
+                  enum: enumDict,
+                  value: event.target.value,
+                  full_access_path: fullAccessPath,
+                  readonly: attribute.readonly,
+                  doc: attribute.doc
+                })
+              }>
               {Object.entries(enumDict).map(([key, val]) => (
                 <option key={key} value={key}>
-                  {val}
+                  {attribute.type == 'ColouredEnum' ? key : val}
                 </option>
               ))}
             </Form.Select>

frontend/src/components/GenericComponent.tsx

@@ -2,7 +2,7 @@ import React, { useContext } from 'react';
 import { ButtonComponent } from './ButtonComponent';
 import { NumberComponent } from './NumberComponent';
 import { SliderComponent } from './SliderComponent';
-import { EnumComponent } from './EnumComponent';
+import { EnumComponent, EnumSerialization } from './EnumComponent';
 import { MethodComponent } from './MethodComponent';
 import { AsyncMethodComponent } from './AsyncMethodComponent';
 import { StringComponent } from './StringComponent';
@@ -10,11 +10,10 @@ import { ListComponent } from './ListComponent';
 import { DataServiceComponent, DataServiceJSON } from './DataServiceComponent';
 import { DeviceConnectionComponent } from './DeviceConnection';
 import { ImageComponent } from './ImageComponent';
-import { ColouredEnumComponent } from './ColouredEnumComponent';
 import { LevelName } from './NotificationsComponent';
 import { getIdFromFullAccessPath } from '../utils/stringUtils';
 import { WebSettingsContext } from '../WebSettings';
-import { setAttribute } from '../socket';
+import { updateValue } from '../socket';
 
 type AttributeType =
   | 'str'
@@ -34,6 +33,8 @@ type AttributeType =
 type ValueType = boolean | string | number | Record<string, unknown>;
 export type SerializedValue = {
   type: AttributeType;
+  full_access_path: string;
+  name?: string;
   value?: ValueType | ValueType[];
   readonly: boolean;
   doc?: string | null;
@@ -43,43 +44,37 @@ export type SerializedValue = {
 };
 type GenericComponentProps = {
   attribute: SerializedValue;
-  name: string;
-  parentPath: string;
   isInstantUpdate: boolean;
   addNotification: (message: string, levelname?: LevelName) => void;
 };
 
 export const GenericComponent = React.memo(
-  ({
-    attribute,
-    name,
-    parentPath,
-    isInstantUpdate,
-    addNotification
-  }: GenericComponentProps) => {
-    const fullAccessPath = [parentPath, name].filter((element) => element).join('.');
+  ({ attribute, isInstantUpdate, addNotification }: GenericComponentProps) => {
+    const { full_access_path: fullAccessPath } = attribute;
     const id = getIdFromFullAccessPath(fullAccessPath);
     const webSettings = useContext(WebSettingsContext);
-    let displayName = name;
+    let displayName = fullAccessPath.split('.').at(-1);
 
-    if (webSettings[fullAccessPath] && webSettings[fullAccessPath].displayName) {
-      displayName = webSettings[fullAccessPath].displayName;
+    if (webSettings[fullAccessPath]) {
+      if (webSettings[fullAccessPath].display === false) {
+        return null;
+      }
+      if (webSettings[fullAccessPath].displayName) {
+        displayName = webSettings[fullAccessPath].displayName;
+      }
     }
 
     function changeCallback(
-      value: unknown,
-      attributeName: string = name,
-      prefix: string = parentPath,
+      value: SerializedValue,
       callback: (ack: unknown) => void = undefined
     ) {
-      setAttribute(attributeName, prefix, value, callback);
+      updateValue(value, callback);
     }
 
     if (attribute.type === 'bool') {
       return (
         <ButtonComponent
-          name={name}
-          parentPath={parentPath}
+          fullAccessPath={fullAccessPath}
           docString={attribute.doc}
           readOnly={attribute.readonly}
           value={Boolean(attribute.value)}
@@ -92,9 +87,8 @@ export const GenericComponent = React.memo(
     } else if (attribute.type === 'float' || attribute.type === 'int') {
       return (
         <NumberComponent
-          name={name}
           type={attribute.type}
-          parentPath={parentPath}
+          fullAccessPath={fullAccessPath}
           docString={attribute.doc}
           readOnly={attribute.readonly}
           value={Number(attribute.value)}
@@ -108,9 +102,8 @@ export const GenericComponent = React.memo(
     } else if (attribute.type === 'Quantity') {
       return (
         <NumberComponent
-          name={name}
-          type="float"
-          parentPath={parentPath}
+          type="Quantity"
+          fullAccessPath={fullAccessPath}
           docString={attribute.doc}
           readOnly={attribute.readonly}
           value={Number(attribute.value['magnitude'])}
@@ -125,8 +118,7 @@ export const GenericComponent = React.memo(
     } else if (attribute.type === 'NumberSlider') {
       return (
         <SliderComponent
-          name={name}
-          parentPath={parentPath}
+          fullAccessPath={fullAccessPath}
           docString={attribute.value['value'].doc}
           readOnly={attribute.readonly}
           value={attribute.value['value']}
@@ -140,15 +132,10 @@ export const GenericComponent = React.memo(
           id={id}
         />
       );
-    } else if (attribute.type === 'Enum') {
+    } else if (attribute.type === 'Enum' || attribute.type === 'ColouredEnum') {
       return (
         <EnumComponent
-          name={name}
-          parentPath={parentPath}
-          docString={attribute.doc}
-          value={String(attribute.value)}
-          readOnly={attribute.readonly}
-          enumDict={attribute.enum}
+          attribute={attribute as EnumSerialization}
           addNotification={addNotification}
           changeCallback={changeCallback}
           displayName={displayName}
@@ -159,8 +146,7 @@ export const GenericComponent = React.memo(
       if (!attribute.async) {
         return (
           <MethodComponent
-            name={name}
-            parentPath={parentPath}
+            fullAccessPath={fullAccessPath}
             docString={attribute.doc}
             addNotification={addNotification}
             displayName={displayName}
@@ -171,10 +157,9 @@ export const GenericComponent = React.memo(
       } else {
         return (
           <AsyncMethodComponent
-            name={name}
-            parentPath={parentPath}
+            fullAccessPath={fullAccessPath}
             docString={attribute.doc}
-            value={attribute.value as Record<string, string>}
+            value={attribute.value as 'RUNNING' | null}
             addNotification={addNotification}
             displayName={displayName}
             id={id}
@@ -185,11 +170,10 @@ export const GenericComponent = React.memo(
     } else if (attribute.type === 'str') {
       return (
         <StringComponent
-          name={name}
+          fullAccessPath={fullAccessPath}
           value={attribute.value as string}
           readOnly={attribute.readonly}
           docString={attribute.doc}
-          parentPath={parentPath}
           isInstantUpdate={isInstantUpdate}
           addNotification={addNotification}
           changeCallback={changeCallback}
@@ -200,9 +184,7 @@ export const GenericComponent = React.memo(
     } else if (attribute.type === 'DataService') {
       return (
         <DataServiceComponent
-          name={name}
           props={attribute.value as DataServiceJSON}
-          parentPath={parentPath}
           isInstantUpdate={isInstantUpdate}
           addNotification={addNotification}
           displayName={displayName}
@@ -212,9 +194,8 @@ export const GenericComponent = React.memo(
     } else if (attribute.type === 'DeviceConnection') {
       return (
         <DeviceConnectionComponent
-          name={name}
+          fullAccessPath={fullAccessPath}
           props={attribute.value as DataServiceJSON}
-          parentPath={parentPath}
           isInstantUpdate={isInstantUpdate}
           addNotification={addNotification}
           displayName={displayName}
@@ -224,10 +205,8 @@ export const GenericComponent = React.memo(
     } else if (attribute.type === 'list') {
       return (
         <ListComponent
-          name={name}
           value={attribute.value as SerializedValue[]}
           docString={attribute.doc}
-          parentPath={parentPath}
           isInstantUpdate={isInstantUpdate}
           addNotification={addNotification}
           id={id}
@@ -236,8 +215,7 @@ export const GenericComponent = React.memo(
     } else if (attribute.type === 'Image') {
       return (
         <ImageComponent
-          name={name}
-          parentPath={parentPath}
+          fullAccessPath={fullAccessPath}
           docString={attribute.value['value'].doc}
           displayName={displayName}
           id={id}
@@ -247,23 +225,8 @@ export const GenericComponent = React.memo(
           format={attribute.value['format']['value'] as string}
         />
       );
-    } else if (attribute.type === 'ColouredEnum') {
-      return (
-        <ColouredEnumComponent
-          name={name}
-          parentPath={parentPath}
-          docString={attribute.doc}
-          value={String(attribute.value)}
-          readOnly={attribute.readonly}
-          enumDict={attribute.enum}
-          addNotification={addNotification}
-          changeCallback={changeCallback}
-          displayName={displayName}
-          id={id}
-        />
-      );
     } else {
-      return <div key={name}>{name}</div>;
+      return <div key={fullAccessPath}>{fullAccessPath}</div>;
     }
   }
 );

frontend/src/components/ImageComponent.tsx

@@ -5,8 +5,7 @@ import { ChevronDown, ChevronRight } from 'react-bootstrap-icons';
 import { LevelName } from './NotificationsComponent';
 
 type ImageComponentProps = {
-  name: string;
-  parentPath: string;
+  fullAccessPath: string;
   value: string;
   docString: string;
   format: string;
@@ -16,13 +15,11 @@ type ImageComponentProps = {
 };
 
 export const ImageComponent = React.memo((props: ImageComponentProps) => {
-  const { value, docString, format, addNotification, displayName, id } = props;
+  const { fullAccessPath, value, docString, format, addNotification, displayName, id } =
+    props;
 
   const renderCount = useRef(0);
   const [open, setOpen] = useState(true);
-  const fullAccessPath = [props.parentPath, props.name]
-    .filter((element) => element)
-    .join('.');
 
   useEffect(() => {
     renderCount.current++;

frontend/src/components/ListComponent.tsx

@@ -4,8 +4,6 @@ import { SerializedValue, GenericComponent } from './GenericComponent';
 import { LevelName } from './NotificationsComponent';
 
 type ListComponentProps = {
-  name: string;
-  parentPath?: string;
   value: SerializedValue[];
   docString: string;
   isInstantUpdate: boolean;
@@ -14,8 +12,7 @@ type ListComponentProps = {
 };
 
 export const ListComponent = React.memo((props: ListComponentProps) => {
-  const { name, parentPath, value, docString, isInstantUpdate, addNotification, id } =
-    props;
+  const { value, docString, isInstantUpdate, addNotification, id } = props;
 
   const renderCount = useRef(0);
 
@@ -34,8 +31,6 @@ export const ListComponent = React.memo((props: ListComponentProps) => {
           <GenericComponent
             key={`${name}[${index}]`}
             attribute={item}
-            name={`${name}[${index}]`}
-            parentPath={parentPath}
             isInstantUpdate={isInstantUpdate}
             addNotification={addNotification}
           />

frontend/src/components/MethodComponent.tsx

@@ -5,8 +5,7 @@ import { DocStringComponent } from './DocStringComponent';
 import { LevelName } from './NotificationsComponent';
 
 type MethodProps = {
-  name: string;
-  parentPath: string;
+  fullAccessPath: string;
   docString?: string;
   addNotification: (message: string, levelname?: LevelName) => void;
   displayName: string;
@@ -15,7 +14,7 @@ type MethodProps = {
 };
 
 export const MethodComponent = React.memo((props: MethodProps) => {
-  const { name, parentPath, docString, addNotification, displayName, id } = props;
+  const { fullAccessPath, docString, addNotification, displayName, id } = props;
 
   // Conditional rendering based on the 'render' prop.
   if (!props.render) {
@@ -24,7 +23,6 @@ export const MethodComponent = React.memo((props: MethodProps) => {
 
   const renderCount = useRef(0);
   const formRef = useRef(null);
-  const fullAccessPath = [parentPath, name].filter((element) => element).join('.');
 
   const triggerNotification = () => {
     const message = `Method ${fullAccessPath} was triggered.`;
@@ -34,7 +32,7 @@ export const MethodComponent = React.memo((props: MethodProps) => {
 
   const execute = async (event: React.FormEvent) => {
     event.preventDefault();
-    runMethod(name, parentPath, {});
+    runMethod(fullAccessPath);
 
     triggerNotification();
   };

frontend/src/components/NumberComponent.tsx

@@ -3,6 +3,7 @@ import { Form, InputGroup } from 'react-bootstrap';
 import { DocStringComponent } from './DocStringComponent';
 import '../App.css';
 import { LevelName } from './NotificationsComponent';
+import { SerializedValue } from './GenericComponent';
 
 // TODO: add button functionality
 
@@ -30,21 +31,15 @@ export type FloatObject = {
 export type NumberObject = IntObject | FloatObject | QuantityObject;
 
 type NumberComponentProps = {
-  name: string;
-  type: 'float' | 'int';
-  parentPath?: string;
+  type: 'float' | 'int' | 'Quantity';
+  fullAccessPath: string;
   value: number;
   readOnly: boolean;
   docString: string;
   isInstantUpdate: boolean;
   unit?: string;
   addNotification: (message: string, levelname?: LevelName) => void;
-  changeCallback?: (
-    value: unknown,
-    attributeName?: string,
-    prefix?: string,
-    callback?: (ack: unknown) => void
-  ) => void;
+  changeCallback?: (value: SerializedValue, callback?: (ack: unknown) => void) => void;
   displayName?: string;
   id: string;
 };
@@ -161,7 +156,7 @@ const handleNumericKey = (
 
 export const NumberComponent = React.memo((props: NumberComponentProps) => {
   const {
-    name,
+    fullAccessPath,
     value,
     readOnly,
     type,
@@ -179,9 +174,7 @@ export const NumberComponent = React.memo((props: NumberComponentProps) => {
   // Create a state for the input string
   const [inputString, setInputString] = useState(value.toString());
   const renderCount = useRef(0);
-  const fullAccessPath = [props.parentPath, props.name]
-    .filter((element) => element)
-    .join('.');
+  const name = fullAccessPath.split('.').at(-1);
 
   const handleKeyDown = (event) => {
     const { key, target } = event;
@@ -225,7 +218,7 @@ export const NumberComponent = React.memo((props: NumberComponentProps) => {
         selectionStart,
         selectionEnd
       ));
-    } else if (key === '.' && type === 'float') {
+    } else if (key === '.' && (type === 'float' || type === 'Quantity')) {
       ({ value: newValue, selectionStart } = handleNumericKey(
         key,
         value,
@@ -252,7 +245,20 @@ export const NumberComponent = React.memo((props: NumberComponentProps) => {
         selectionEnd
       ));
     } else if (key === 'Enter' && !isInstantUpdate) {
-      changeCallback(Number(newValue));
+      let updatedValue: number | Record<string, unknown> = Number(newValue);
+      if (type === 'Quantity') {
+        updatedValue = {
+          magnitude: Number(newValue),
+          unit: unit
+        };
+      }
+      changeCallback({
+        type: type,
+        value: updatedValue,
+        full_access_path: fullAccessPath,
+        readonly: readOnly,
+        doc: docString
+      });
       return;
     } else {
       console.debug(key);
@@ -261,7 +267,20 @@ export const NumberComponent = React.memo((props: NumberComponentProps) => {
 
     // Update the input value and maintain the cursor position
     if (isInstantUpdate) {
-      changeCallback(Number(newValue));
+      let updatedValue: number | Record<string, unknown> = Number(newValue);
+      if (type === 'Quantity') {
+        updatedValue = {
+          magnitude: Number(newValue),
+          unit: unit
+        };
+      }
+      changeCallback({
+        type: type,
+        value: updatedValue,
+        full_access_path: fullAccessPath,
+        readonly: readOnly,
+        doc: docString
+      });
     }
 
     setInputString(newValue);
@@ -273,7 +292,20 @@ export const NumberComponent = React.memo((props: NumberComponentProps) => {
   const handleBlur = () => {
     if (!isInstantUpdate) {
       // If not in "instant update" mode, emit an update when the input field loses focus
-      changeCallback(Number(inputString));
+      let updatedValue: number | Record<string, unknown> = Number(inputString);
+      if (type === 'Quantity') {
+        updatedValue = {
+          magnitude: Number(inputString),
+          unit: unit
+        };
+      }
+      changeCallback({
+        type: type,
+        value: updatedValue,
+        full_access_path: fullAccessPath,
+        readonly: readOnly,
+        doc: docString
+      });
     }
   };
   useEffect(() => {

frontend/src/components/SliderComponent.tsx

@@ -4,24 +4,19 @@ import { DocStringComponent } from './DocStringComponent';
 import { Slider } from '@mui/material';
 import { NumberComponent, NumberObject } from './NumberComponent';
 import { LevelName } from './NotificationsComponent';
+import { SerializedValue } from './GenericComponent';
 
 type SliderComponentProps = {
-  name: string;
+  fullAccessPath: string;
   min: NumberObject;
   max: NumberObject;
-  parentPath?: string;
   value: NumberObject;
   readOnly: boolean;
   docString: string;
   stepSize: NumberObject;
   isInstantUpdate: boolean;
   addNotification: (message: string, levelname?: LevelName) => void;
-  changeCallback?: (
-    value: unknown,
-    attributeName?: string,
-    prefix?: string,
-    callback?: (ack: unknown) => void
-  ) => void;
+  changeCallback?: (value: SerializedValue, callback?: (ack: unknown) => void) => void;
   displayName: string;
   id: string;
 };
@@ -30,8 +25,7 @@ export const SliderComponent = React.memo((props: SliderComponentProps) => {
   const renderCount = useRef(0);
   const [open, setOpen] = useState(false);
   const {
-    name,
-    parentPath,
+    fullAccessPath,
     value,
     min,
     max,
@@ -43,7 +37,6 @@ export const SliderComponent = React.memo((props: SliderComponentProps) => {
     displayName,
     id
   } = props;
-  const fullAccessPath = [parentPath, name].filter((element) => element).join('.');
 
   useEffect(() => {
     renderCount.current++;
@@ -71,11 +64,26 @@ export const SliderComponent = React.memo((props: SliderComponentProps) => {
     if (Array.isArray(newNumber)) {
       newNumber = newNumber[0];
     }
-    changeCallback(newNumber, `${name}.value`);
+    changeCallback({
+      type: value.type,
+      value: newNumber,
+      full_access_path: `${fullAccessPath}.value`,
+      readonly: value.readonly,
+      doc: docString
+    });
   };
 
-  const handleValueChange = (newValue: number, valueType: string) => {
-    changeCallback(newValue, `${name}.${valueType}`);
+  const handleValueChange = (
+    newValue: number,
+    name: string,
+    valueObject: NumberObject
+  ) => {
+    changeCallback({
+      type: valueObject.type,
+      value: newValue,
+      full_access_path: `${fullAccessPath}.${name}`,
+      readonly: valueObject.readonly
+    });
   };
 
   const deconstructNumberDict = (
@@ -133,15 +141,14 @@ export const SliderComponent = React.memo((props: SliderComponentProps) => {
         <Col xs="3" xl>
           <NumberComponent
             isInstantUpdate={isInstantUpdate}
-            parentPath={parentPath}
-            name={`${name}.value`}
-            docString=""
+            fullAccessPath={`${fullAccessPath}.value`}
+            docString={docString}
             readOnly={valueReadOnly}
             type="float"
             value={valueMagnitude}
             unit={valueUnit}
             addNotification={() => {}}
-            changeCallback={(value) => changeCallback(value, name + '.value')}
+            changeCallback={changeCallback}
             id={id + '-value'}
           />
         </Col>
@@ -179,7 +186,7 @@ export const SliderComponent = React.memo((props: SliderComponentProps) => {
                 type="number"
                 value={minMagnitude}
                 disabled={minReadOnly}
-                onChange={(e) => handleValueChange(Number(e.target.value), 'min')}
+                onChange={(e) => handleValueChange(Number(e.target.value), 'min', min)}
               />
             </Col>
 
@@ -189,7 +196,7 @@ export const SliderComponent = React.memo((props: SliderComponentProps) => {
                 type="number"
                 value={maxMagnitude}
                 disabled={maxReadOnly}
-                onChange={(e) => handleValueChange(Number(e.target.value), 'max')}
+                onChange={(e) => handleValueChange(Number(e.target.value), 'max', max)}
               />
             </Col>
 
@@ -199,7 +206,9 @@ export const SliderComponent = React.memo((props: SliderComponentProps) => {
                 type="number"
                 value={stepSizeMagnitude}
                 disabled={stepSizeReadOnly}
-                onChange={(e) => handleValueChange(Number(e.target.value), 'step_size')}
+                onChange={(e) =>
+                  handleValueChange(Number(e.target.value), 'step_size', stepSize)
+                }
               />
             </Col>
           </Row>

frontend/src/components/StringComponent.tsx

@@ -3,30 +3,25 @@ import { Form, InputGroup } from 'react-bootstrap';
 import { DocStringComponent } from './DocStringComponent';
 import '../App.css';
 import { LevelName } from './NotificationsComponent';
+import { SerializedValue } from './GenericComponent';
 
 // TODO: add button functionality
 
 type StringComponentProps = {
-  name: string;
-  parentPath?: string;
+  fullAccessPath: string;
   value: string;
   readOnly: boolean;
   docString: string;
   isInstantUpdate: boolean;
   addNotification: (message: string, levelname?: LevelName) => void;
-  changeCallback?: (
-    value: unknown,
-    attributeName?: string,
-    prefix?: string,
-    callback?: (ack: unknown) => void
-  ) => void;
+  changeCallback?: (value: SerializedValue, callback?: (ack: unknown) => void) => void;
   displayName: string;
   id: string;
 };
 
 export const StringComponent = React.memo((props: StringComponentProps) => {
   const {
-    name,
+    fullAccessPath,
     readOnly,
     docString,
     isInstantUpdate,
@@ -38,9 +33,6 @@ export const StringComponent = React.memo((props: StringComponentProps) => {
 
   const renderCount = useRef(0);
   const [inputString, setInputString] = useState(props.value);
-  const fullAccessPath = [props.parentPath, props.name]
-    .filter((element) => element)
-    .join('.');
 
   useEffect(() => {
     renderCount.current++;
@@ -63,14 +55,26 @@ export const StringComponent = React.memo((props: StringComponentProps) => {
 
   const handleKeyDown = (event) => {
     if (event.key === 'Enter' && !isInstantUpdate) {
-      changeCallback(inputString);
+      changeCallback({
+        type: 'str',
+        value: inputString,
+        full_access_path: fullAccessPath,
+        readonly: readOnly,
+        doc: docString
+      });
       event.preventDefault();
     }
   };
 
   const handleBlur = () => {
     if (!isInstantUpdate) {
-      changeCallback(inputString);
+      changeCallback({
+        type: 'str',
+        value: inputString,
+        full_access_path: fullAccessPath,
+        readonly: readOnly,
+        doc: docString
+      });
     }
   };
 
@@ -86,7 +90,7 @@ export const StringComponent = React.memo((props: StringComponentProps) => {
         </InputGroup.Text>
         <Form.Control
           type="text"
-          name={name}
+          name={fullAccessPath}
           value={inputString}
           disabled={readOnly}
           onChange={handleChange}

frontend/src/socket.ts

@@ -1,4 +1,6 @@
 import { io } from 'socket.io-client';
+import { SerializedValue } from './components/GenericComponent';
+import { serializeDict, serializeList } from './utils/serializationUtils';
 
 export const hostname =
   process.env.NODE_ENV === 'development' ? `localhost` : window.location.hostname;
@@ -9,28 +11,44 @@ console.debug('Websocket: ', URL);
 
 export const socket = io(URL, { path: '/ws/socket.io', transports: ['websocket'] });
 
-export const setAttribute = (
-  name: string,
-  parentPath: string,
-  value: unknown,
+export const updateValue = (
+  serializedObject: SerializedValue,
   callback?: (ack: unknown) => void
 ) => {
   if (callback) {
-    socket.emit('set_attribute', { name, parent_path: parentPath, value }, callback);
+    socket.emit(
+      'update_value',
+      { access_path: serializedObject['full_access_path'], value: serializedObject },
+      callback
+    );
   } else {
-    socket.emit('set_attribute', { name, parent_path: parentPath, value });
+    socket.emit('update_value', {
+      access_path: serializedObject['full_access_path'],
+      value: serializedObject
+    });
   }
 };
 
 export const runMethod = (
-  name: string,
-  parentPath: string,
-  kwargs: Record<string, unknown>,
+  accessPath: string,
+  args: unknown[] = [],
+  kwargs: Record<string, unknown> = {},
   callback?: (ack: unknown) => void
 ) => {
+  const serializedArgs = serializeList(args);
+  const serializedKwargs = serializeDict(kwargs);
+
   if (callback) {
-    socket.emit('run_method', { name, parent_path: parentPath, kwargs }, callback);
+    socket.emit(
+      'trigger_method',
+      { access_path: accessPath, args: serializedArgs, kwargs: serializedKwargs },
+      callback
+    );
   } else {
-    socket.emit('run_method', { name, parent_path: parentPath, kwargs });
+    socket.emit('trigger_method', {
+      access_path: accessPath,
+      args: serializedArgs,
+      kwargs: serializedKwargs
+    });
   }
 };

frontend/src/utils/serializationUtils.ts

@@ -0,0 +1,101 @@
+const serializePrimitive = (
+  obj: number | boolean | string | null,
+  accessPath: string
+) => {
+  let type: string;
+
+  if (typeof obj === 'number') {
+    type = Number.isInteger(obj) ? 'int' : 'float';
+    return {
+      full_access_path: accessPath,
+      doc: null,
+      readonly: false,
+      type,
+      value: obj
+    };
+  } else if (typeof obj === 'boolean') {
+    type = 'bool';
+    return {
+      full_access_path: accessPath,
+      doc: null,
+      readonly: false,
+      type,
+      value: obj
+    };
+  } else if (typeof obj === 'string') {
+    type = 'str';
+    return {
+      full_access_path: accessPath,
+      doc: null,
+      readonly: false,
+      type,
+      value: obj
+    };
+  } else if (obj === null) {
+    type = 'NoneType';
+    return {
+      full_access_path: accessPath,
+      doc: null,
+      readonly: false,
+      type,
+      value: null
+    };
+  } else {
+    throw new Error('Unsupported type for serialization');
+  }
+};
+
+export const serializeList = (obj: unknown[], accessPath: string = '') => {
+  const doc = null;
+  const value = obj.map((item, index) => {
+    if (
+      typeof item === 'number' ||
+      typeof item === 'boolean' ||
+      typeof item === 'string' ||
+      item === null
+    ) {
+      serializePrimitive(
+        item as number | boolean | string | null,
+        `${accessPath}[${index}]`
+      );
+    }
+  });
+
+  return {
+    full_access_path: accessPath,
+    type: 'list',
+    value,
+    readonly: false,
+    doc
+  };
+};
+export const serializeDict = (
+  obj: Record<string, unknown>,
+  accessPath: string = ''
+) => {
+  const doc = null;
+  const value = Object.entries(obj).reduce((acc, [key, val]) => {
+    // Construct the new access path for nested properties
+    const newPath = `${accessPath}["${key}"]`;
+
+    // Serialize each value in the dictionary and assign to the accumulator
+    if (
+      typeof val === 'number' ||
+      typeof val === 'boolean' ||
+      typeof val === 'string' ||
+      val === null
+    ) {
+      acc[key] = serializePrimitive(val as number | boolean | string | null, newPath);
+    }
+
+    return acc;
+  }, {});
+
+  return {
+    full_access_path: accessPath,
+    type: 'dict',
+    value,
+    readonly: false,
+    doc
+  };
+};

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pydase"
-version = "0.7.2"
+version = "0.8.0"
 description = "A flexible and robust Python library for creating, managing, and interacting with data services, with built-in support for web and RPC servers, and customizable features for diverse use cases."
 authors = ["Mose Mueller <mosmuell@ethz.ch>"]
 readme = "README.md"
@@ -9,7 +9,6 @@ packages = [{ include = "pydase", from = "src" }]
 
 [tool.poetry.dependencies]
 python = "^3.10"
-rpyc = "^5.3.1"
 fastapi = "^0.108.0"
 uvicorn = "^0.27.0"
 toml = "^0.10.2"
@@ -17,6 +16,8 @@ python-socketio = "^5.8.0"
 confz = "^2.0.0"
 pint = "^0.22"
 pillow = "^10.0.0"
+websocket-client = "^1.7.0"
+aiohttp = "^3.9.3"
 
 [tool.poetry.group.dev]
 optional = true
@@ -29,7 +30,7 @@ mypy = "^1.4.1"
 matplotlib = "^3.7.2"
 pyright = "^1.1.323"
 pytest-mock = "^3.11.1"
-ruff = "^0.1.5"
+ruff = "^0.2.0"
 pytest-asyncio = "^0.23.2"
 
 [tool.poetry.group.docs]

src/pydase/__init__.py

@@ -1,3 +1,4 @@
+from pydase.client.client import Client
 from pydase.data_service import DataService
 from pydase.server import Server
 from pydase.utils.logging import setup_logging
@@ -7,4 +8,5 @@ setup_logging()
 __all__ = [
     "DataService",
     "Server",
+    "Client",
 ]

src/pydase/client/__init__.py

@@ -0,0 +1,3 @@
+from pydase.client.client import Client
+
+__all__ = ["Client"]

src/pydase/client/client.py

@@ -0,0 +1,151 @@
+import asyncio
+import logging
+import threading
+from typing import TypedDict, cast
+
+import socketio  # type: ignore
+
+import pydase.components
+from pydase.client.proxy_loader import ProxyClassMixin, ProxyLoader
+from pydase.utils.serialization.deserializer import loads
+from pydase.utils.serialization.types import SerializedDataService, SerializedObject
+
+logger = logging.getLogger(__name__)
+
+
+class NotifyDataDict(TypedDict):
+    full_access_path: str
+    value: SerializedObject
+
+
+class NotifyDict(TypedDict):
+    data: NotifyDataDict
+
+
+def asyncio_loop_thread(loop: asyncio.AbstractEventLoop) -> None:
+    asyncio.set_event_loop(loop)
+    loop.run_forever()
+
+
+class ProxyClass(ProxyClassMixin, pydase.components.DeviceConnection):
+    """
+    A proxy class that serves as the interface for interacting with device connections
+    via a socket.io client in an asyncio environment.
+
+    Args:
+        sio_client (socketio.AsyncClient):
+            The socket.io client instance used for asynchronous communication with the
+            pydase service server.
+        loop (asyncio.AbstractEventLoop):
+            The event loop in which the client operations are managed and executed.
+
+    This class is used to create a proxy object that behaves like a local representation
+    of a remote pydase service, facilitating direct interaction as if it were local
+    while actually communicating over network protocols.
+    It can also be used as an attribute of a pydase service itself, e.g.
+
+        ```python
+        import pydase
+
+
+        class MyService(pydase.DataService):
+            proxy = pydase.Client(
+                hostname="...", port=8001, block_until_connected=False
+            ).proxy
+
+
+        if __name__ == "__main__":
+            service = MyService()
+            server = pydase.Server(service, web_port=8002).run()
+        ```
+    """
+
+    def __init__(
+        self, sio_client: socketio.AsyncClient, loop: asyncio.AbstractEventLoop
+    ) -> None:
+        super().__init__()
+        self._initialise(sio_client=sio_client, loop=loop)
+
+
+class Client:
+    """
+    A client for connecting to a remote pydase service using socket.io. This client
+    handles asynchronous communication with a service, manages events such as
+    connection, disconnection, and updates, and ensures that the proxy object is
+    up-to-date with the server state.
+
+    Attributes:
+        proxy (ProxyClass):
+            A proxy object representing the remote service, facilitating interaction as
+            if it were local.
+
+    Args:
+        hostname (str):
+            Hostname of the exposed service this client attempts to connect to.
+            Default is "localhost".
+        port (int):
+            Port of the exposed service this client attempts to connect on.
+            Default is 8001.
+        block_until_connected (bool):
+            If set to True, the constructor will block until the connection to the
+            service has been established. This is useful for ensuring the client is
+            ready to use immediately after instantiation. Default is True.
+    """
+
+    def __init__(
+        self,
+        hostname: str,
+        port: int,
+        block_until_connected: bool = True,
+    ):
+        self._hostname = hostname
+        self._port = port
+        self._sio = socketio.AsyncClient()
+        self._loop = asyncio.new_event_loop()
+        self.proxy = ProxyClass(sio_client=self._sio, loop=self._loop)
+        self._thread = threading.Thread(
+            target=asyncio_loop_thread, args=(self._loop,), daemon=True
+        )
+        self._thread.start()
+        connection_future = asyncio.run_coroutine_threadsafe(
+            self._connect(), self._loop
+        )
+        if block_until_connected:
+            connection_future.result()
+
+    async def _connect(self) -> None:
+        logger.debug("Connecting to server '%s:%s' ...", self._hostname, self._port)
+        await self._setup_events()
+        await self._sio.connect(
+            f"ws://{self._hostname}:{self._port}",
+            socketio_path="/ws/socket.io",
+            transports=["websocket"],
+            retry=True,
+        )
+
+    async def _setup_events(self) -> None:
+        self._sio.on("connect", self._handle_connect)
+        self._sio.on("disconnect", self._handle_disconnect)
+        self._sio.on("notify", self._handle_update)
+
+    async def _handle_connect(self) -> None:
+        logger.debug("Connected to '%s:%s' ...", self._hostname, self._port)
+        serialized_object = cast(
+            SerializedDataService, await self._sio.call("service_serialization")
+        )
+        ProxyLoader.update_data_service_proxy(
+            self.proxy, serialized_object=serialized_object
+        )
+        serialized_object["type"] = "DeviceConnection"
+        self.proxy._notify_changed("", loads(serialized_object))
+        self.proxy._connected = True
+
+    async def _handle_disconnect(self) -> None:
+        logger.debug("Disconnected from '%s:%s' ...", self._hostname, self._port)
+        self.proxy._connected = False
+
+    async def _handle_update(self, data: NotifyDict) -> None:
+        self.proxy._notify_changed(
+            data["data"]["full_access_path"],
+            loads(data["data"]["value"]),
+        )

src/pydase/client/proxy_loader.py

@@ -0,0 +1,368 @@
+import asyncio
+import logging
+from collections.abc import Iterable
+from copy import copy
+from typing import TYPE_CHECKING, Any, cast
+
+import socketio  # type: ignore
+from typing_extensions import SupportsIndex
+
+from pydase.utils.serialization.deserializer import Deserializer, loads
+from pydase.utils.serialization.serializer import dump
+from pydase.utils.serialization.types import SerializedObject
+
+if TYPE_CHECKING:
+    from collections.abc import Callable
+
+logger = logging.getLogger(__name__)
+
+
+class ProxyAttributeError(Exception): ...
+
+
+def trigger_method(
+    sio_client: socketio.AsyncClient,
+    loop: asyncio.AbstractEventLoop,
+    access_path: str,
+    args: list[Any],
+    kwargs: dict[str, Any],
+) -> Any:
+    async def async_trigger_method() -> Any:
+        return await sio_client.call(
+            "trigger_method",
+            {
+                "access_path": access_path,
+                "args": dump(args),
+                "kwargs": dump(kwargs),
+            },
+        )
+
+    result: SerializedObject | None = asyncio.run_coroutine_threadsafe(
+        async_trigger_method(),
+        loop=loop,
+    ).result()
+
+    if result is not None:
+        return ProxyLoader.loads_proxy(
+            serialized_object=result, sio_client=sio_client, loop=loop
+        )
+
+    return None
+
+
+def update_value(
+    sio_client: socketio.AsyncClient,
+    loop: asyncio.AbstractEventLoop,
+    access_path: str,
+    value: Any,
+) -> Any:
+    async def set_result() -> Any:
+        return await sio_client.call(
+            "update_value",
+            {
+                "access_path": access_path,
+                "value": dump(value),
+            },
+        )
+
+    result: SerializedObject | None = asyncio.run_coroutine_threadsafe(
+        set_result(),
+        loop=loop,
+    ).result()
+    if result is not None:
+        ProxyLoader.loads_proxy(
+            serialized_object=result, sio_client=sio_client, loop=loop
+        )
+
+
+class ProxyList(list[Any]):
+    def __init__(
+        self,
+        original_list: list[Any],
+        parent_path: str,
+        sio_client: socketio.AsyncClient,
+        loop: asyncio.AbstractEventLoop,
+    ) -> None:
+        super().__init__(original_list)
+        self._parent_path = parent_path
+        self._loop = loop
+        self._sio = sio_client
+
+    def __setitem__(self, key: int, value: Any) -> None:  # type: ignore[override]
+        full_access_path = f"{self._parent_path}[{key}]"
+
+        update_value(self._sio, self._loop, full_access_path, value)
+
+    def append(self, __object: Any) -> None:
+        full_access_path = f"{self._parent_path}.append"
+
+        trigger_method(self._sio, self._loop, full_access_path, [__object], {})
+
+    def clear(self) -> None:
+        full_access_path = f"{self._parent_path}.clear"
+
+        trigger_method(self._sio, self._loop, full_access_path, [], {})
+
+    def extend(self, __iterable: Iterable[Any]) -> None:
+        full_access_path = f"{self._parent_path}.extend"
+
+        trigger_method(self._sio, self._loop, full_access_path, [__iterable], {})
+
+    def insert(self, __index: SupportsIndex, __object: Any) -> None:
+        full_access_path = f"{self._parent_path}.insert"
+
+        trigger_method(self._sio, self._loop, full_access_path, [__index, __object], {})
+
+    def pop(self, __index: SupportsIndex = -1) -> Any:
+        full_access_path = f"{self._parent_path}.pop"
+
+        return trigger_method(self._sio, self._loop, full_access_path, [__index], {})
+
+    def remove(self, __value: Any) -> None:
+        full_access_path = f"{self._parent_path}.remove"
+
+        trigger_method(self._sio, self._loop, full_access_path, [__value], {})
+
+
+class ProxyClassMixin:
+    def __init__(self) -> None:
+        # declare before DataService init to avoid warning messaged
+        self._observers: dict[str, Any] = {}
+
+        self._proxy_getters: dict[str, Callable[..., Any]] = {}
+        self._proxy_setters: dict[str, Callable[..., Any]] = {}
+        self._proxy_methods: dict[str, Callable[..., Any]] = {}
+
+    def _initialise(
+        self,
+        sio_client: socketio.AsyncClient,
+        loop: asyncio.AbstractEventLoop,
+    ) -> None:
+        self._loop = loop
+        self._sio = sio_client
+
+    def __dir__(self) -> list[str]:
+        """Used to provide tab completion on CLI / notebook"""
+        static_dir = super().__dir__()
+        return sorted({*static_dir, *self._proxy_getters, *self._proxy_methods.keys()})
+
+    def __getattribute__(self, name: str) -> Any:
+        try:
+            if name in super().__getattribute__("_proxy_getters"):
+                return super().__getattribute__("_proxy_getters")[name]()
+            if name in super().__getattribute__("_proxy_methods"):
+                return super().__getattribute__("_proxy_methods")[name]
+        except AttributeError:
+            pass
+        return super().__getattribute__(name)
+
+    def __setattr__(self, name: str, value: Any) -> None:
+        try:
+            if name in super().__getattribute__("_proxy_setters"):
+                return super().__getattribute__("_proxy_setters")[name](value)
+            if name in super().__getattribute__("_proxy_getters"):
+                raise ProxyAttributeError(
+                    f"Proxy attribute {name!r} of {type(self).__name__!r} is readonly!"
+                )
+        except AttributeError:
+            pass
+        return super().__setattr__(name, value)
+
+    def _handle_serialized_method(
+        self, attr_name: str, serialized_object: SerializedObject
+    ) -> None:
+        def add_prefix_to_last_path_element(s: str, prefix: str) -> str:
+            parts = s.split(".")
+            parts[-1] = f"{prefix}_{parts[-1]}"
+            return ".".join(parts)
+
+        if serialized_object["type"] == "method":
+            if serialized_object["async"] is True:
+                start_method = copy(serialized_object)
+                start_method["full_access_path"] = add_prefix_to_last_path_element(
+                    start_method["full_access_path"], "start"
+                )
+                stop_method = copy(serialized_object)
+                stop_method["full_access_path"] = add_prefix_to_last_path_element(
+                    stop_method["full_access_path"], "stop"
+                )
+                self._add_method_proxy(f"start_{attr_name}", start_method)
+                self._add_method_proxy(f"stop_{attr_name}", stop_method)
+            else:
+                self._add_method_proxy(attr_name, serialized_object)
+
+    def _add_method_proxy(
+        self, attr_name: str, serialized_object: SerializedObject
+    ) -> None:
+        def method_proxy(*args: Any, **kwargs: Any) -> Any:
+            return trigger_method(
+                self._sio,
+                self._loop,
+                serialized_object["full_access_path"],
+                list(args),
+                kwargs,
+            )
+
+        dict.__setitem__(self._proxy_methods, attr_name, method_proxy)
+
+    def _add_attr_proxy(
+        self, attr_name: str, serialized_object: SerializedObject
+    ) -> None:
+        self._add_getattr_proxy(attr_name, serialized_object=serialized_object)
+        if not serialized_object["readonly"]:
+            self._add_setattr_proxy(attr_name, serialized_object=serialized_object)
+
+    def _add_setattr_proxy(
+        self, attr_name: str, serialized_object: SerializedObject
+    ) -> None:
+        self._add_getattr_proxy(attr_name, serialized_object=serialized_object)
+        if not serialized_object["readonly"]:
+
+            def setter_proxy(value: Any) -> None:
+                update_value(
+                    self._sio, self._loop, serialized_object["full_access_path"], value
+                )
+
+            dict.__setitem__(self._proxy_setters, attr_name, setter_proxy)  # type: ignore
+
+    def _add_getattr_proxy(
+        self, attr_name: str, serialized_object: SerializedObject
+    ) -> None:
+        def getter_proxy() -> Any:
+            async def get_result() -> Any:
+                return await self._sio.call(
+                    "get_value", serialized_object["full_access_path"]
+                )
+
+            result = asyncio.run_coroutine_threadsafe(
+                get_result(),
+                loop=self._loop,
+            ).result()
+            return ProxyLoader.loads_proxy(result, self._sio, self._loop)
+
+        dict.__setitem__(self._proxy_getters, attr_name, getter_proxy)  # type: ignore
+
+
+class ProxyLoader:
+    @staticmethod
+    def load_list_proxy(
+        serialized_object: SerializedObject,
+        sio_client: socketio.AsyncClient,
+        loop: asyncio.AbstractEventLoop,
+    ) -> Any:
+        return ProxyList(
+            [
+                ProxyLoader.loads_proxy(item, sio_client, loop)
+                for item in cast(list[SerializedObject], serialized_object["value"])
+            ],
+            parent_path=serialized_object["full_access_path"],
+            sio_client=sio_client,
+            loop=loop,
+        )
+
+    @staticmethod
+    def load_dict_proxy(
+        serialized_object: SerializedObject,
+        sio_client: socketio.AsyncClient,
+        loop: asyncio.AbstractEventLoop,
+    ) -> Any:
+        return loads(serialized_object)
+
+    @staticmethod
+    def update_data_service_proxy(
+        proxy_class: ProxyClassMixin,
+        serialized_object: SerializedObject,
+    ) -> Any:
+        proxy_class._proxy_getters.clear()
+        proxy_class._proxy_setters.clear()
+        proxy_class._proxy_methods.clear()
+        for key, value in cast(
+            dict[str, SerializedObject], serialized_object["value"]
+        ).items():
+            type_handler: dict[str | None, None | Callable[..., Any]] = {
+                None: None,
+                "int": proxy_class._add_attr_proxy,
+                "float": proxy_class._add_attr_proxy,
+                "bool": proxy_class._add_attr_proxy,
+                "str": proxy_class._add_attr_proxy,
+                "NoneType": proxy_class._add_attr_proxy,
+                "Quantity": proxy_class._add_attr_proxy,
+                "Enum": proxy_class._add_attr_proxy,
+                "ColouredEnum": proxy_class._add_attr_proxy,
+                "method": proxy_class._handle_serialized_method,
+                "list": proxy_class._add_getattr_proxy,
+                "dict": proxy_class._add_getattr_proxy,
+            }
+
+            # First go through handled types (as ColouredEnum is also within the
+            # components)
+            handler = type_handler.get(value["type"])
+            if handler:
+                handler(key, value)
+            else:
+                proxy_class._add_getattr_proxy(key, value)
+
+    @staticmethod
+    def load_data_service_proxy(
+        serialized_object: SerializedObject,
+        sio_client: socketio.AsyncClient,
+        loop: asyncio.AbstractEventLoop,
+    ) -> Any:
+        # Custom types like Components or DataService classes
+        component_class = cast(
+            type, Deserializer.get_component_class(serialized_object["type"])
+        )
+        class_bases = (
+            ProxyClassMixin,
+            component_class,
+        )
+        proxy_base_class: type[ProxyClassMixin] = type(
+            serialized_object["name"],  # type: ignore
+            class_bases,
+            {},
+        )
+        proxy_class_instance = proxy_base_class()
+        proxy_class_instance._initialise(sio_client=sio_client, loop=loop)
+        ProxyLoader.update_data_service_proxy(
+            proxy_class=proxy_class_instance, serialized_object=serialized_object
+        )
+        return proxy_class_instance
+
+    @staticmethod
+    def load_default(
+        serialized_object: SerializedObject,
+        sio_client: socketio.AsyncClient,
+        loop: asyncio.AbstractEventLoop,
+    ) -> Any:
+        return loads(serialized_object)
+
+    @staticmethod
+    def loads_proxy(
+        serialized_object: SerializedObject,
+        sio_client: socketio.AsyncClient,
+        loop: asyncio.AbstractEventLoop,
+    ) -> Any:
+        type_handler: dict[str | None, None | Callable[..., Any]] = {
+            "int": ProxyLoader.load_default,
+            "float": ProxyLoader.load_default,
+            "bool": ProxyLoader.load_default,
+            "str": ProxyLoader.load_default,
+            "NoneType": ProxyLoader.load_default,
+            "Quantity": ProxyLoader.load_default,
+            "Enum": ProxyLoader.load_default,
+            "ColouredEnum": ProxyLoader.load_default,
+            "Exception": ProxyLoader.load_default,
+            "list": ProxyLoader.load_list_proxy,
+            "dict": ProxyLoader.load_dict_proxy,
+        }
+
+        # First go through handled types (as ColouredEnum is also within the components)
+        handler = type_handler.get(serialized_object["type"])
+        if handler:
+            return handler(
+                serialized_object=serialized_object, sio_client=sio_client, loop=loop
+            )
+
+        return ProxyLoader.load_data_service_proxy(
+            serialized_object=serialized_object, sio_client=sio_client, loop=loop
+        )

src/pydase/components/device_connection.py

@@ -1,9 +1,9 @@
 import asyncio
 
-import pydase
+import pydase.data_service
 
 
-class DeviceConnection(pydase.DataService):
+class DeviceConnection(pydase.data_service.DataService):
     """
     Base class for device connection management within the pydase framework.
 

src/pydase/config.py

@@ -13,7 +13,6 @@ class OperationMode(BaseConfig):  # type: ignore[misc]
 class ServiceConfig(BaseConfig):  # type: ignore[misc]
     config_dir: Path = Path("config")
     web_port: int = 8001
-    rpc_port: int = 18871
 
     CONFIG_SOURCES = EnvSource(allow_all=True, prefix="SERVICE_", file=".env")
 

src/pydase/data_service/data_service.py

@@ -1,9 +1,7 @@
 import inspect
 import logging
 from enum import Enum
-from typing import Any, get_type_hints
-
-import rpyc  # type: ignore[import-untyped]
+from typing import Any
 
 import pydase.units as u
 from pydase.data_service.abstract_data_service import AbstractDataService
@@ -12,30 +10,19 @@ from pydase.observer_pattern.observable.observable import (
     Observable,
 )
 from pydase.utils.helpers import (
-    convert_arguments_to_hinted_types,
     get_class_and_instance_attributes,
     is_property_attribute,
 )
-from pydase.utils.serializer import (
+from pydase.utils.serialization.serializer import (
+    SerializedObject,
     Serializer,
 )
 
 logger = logging.getLogger(__name__)
 
 
-def process_callable_attribute(attr: Any, args: dict[str, Any]) -> Any:
-    converted_args_or_error_msg = convert_arguments_to_hinted_types(
-        args, get_type_hints(attr)
-    )
-    return (
-        attr(**converted_args_or_error_msg)
-        if not isinstance(converted_args_or_error_msg, str)
-        else converted_args_or_error_msg
-    )
-
-
-class DataService(rpyc.Service, AbstractDataService):
-    def __init__(self, **kwargs: Any) -> None:
+class DataService(AbstractDataService):
+    def __init__(self) -> None:
         super().__init__()
         self._task_manager = TaskManager(self)
 
@@ -105,27 +92,7 @@ class DataService(rpyc.Service, AbstractDataService):
             ):
                 self.__warn_if_not_observable(attr_value)
 
-    def _rpyc_getattr(self, name: str) -> Any:
-        if name.startswith("_"):
-            # disallow special and private attributes
-            raise AttributeError("cannot access private/special names")
-        # allow all other attributes
-        return getattr(self, name)
-
-    def _rpyc_setattr(self, name: str, value: Any) -> None:
-        if name.startswith("_"):
-            # disallow special and private attributes
-            raise AttributeError("cannot access private/special names")
-
-        # check if the attribute has a setter method
-        attr = getattr(self, name, None)
-        if isinstance(attr, property) and attr.fset is None:
-            raise AttributeError(f"{name} attribute does not have a setter method")
-
-        # allow all other attributes
-        setattr(self, name, value)
-
-    def serialize(self) -> dict[str, dict[str, Any]]:
+    def serialize(self) -> SerializedObject:
         """
         Serializes the instance into a dictionary, preserving the structure of the
         instance.

src/pydase/data_service/data_service_cache.py

@@ -1,9 +1,10 @@
 import logging
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING, Any, cast
 
-from pydase.utils.serializer import (
+from pydase.utils.serialization.serializer import (
     SerializationPathError,
     SerializationValueError,
+    SerializedObject,
     get_nested_dict_by_path,
     set_nested_value_by_path,
 )
@@ -16,12 +17,12 @@ logger = logging.getLogger(__name__)
 
 class DataServiceCache:
     def __init__(self, service: "DataService") -> None:
-        self._cache: dict[str, Any] = {}
+        self._cache: SerializedObject
         self.service = service
         self._initialize_cache()
 
     @property
-    def cache(self) -> dict[str, Any]:
+    def cache(self) -> SerializedObject:
         return self._cache
 
     def _initialize_cache(self) -> None:
@@ -30,10 +31,23 @@ class DataServiceCache:
         self._cache = self.service.serialize()
 
     def update_cache(self, full_access_path: str, value: Any) -> None:
-        set_nested_value_by_path(self._cache["value"], full_access_path, value)
+        set_nested_value_by_path(
+            cast(dict[str, SerializedObject], self._cache["value"]),
+            full_access_path,
+            value,
+        )
 
-    def get_value_dict_from_cache(self, full_access_path: str) -> dict[str, Any]:
+    def get_value_dict_from_cache(self, full_access_path: str) -> SerializedObject:
         try:
-            return get_nested_dict_by_path(self._cache["value"], full_access_path)
+            return get_nested_dict_by_path(
+                cast(dict[str, SerializedObject], self._cache["value"]),
+                full_access_path,
+            )
         except (SerializationPathError, SerializationValueError, KeyError):
-            return {}
+            return {
+                "full_access_path": full_access_path,
+                "value": None,
+                "type": "None",
+                "doc": None,
+                "readonly": False,
+            }

src/pydase/data_service/data_service_observer.py

@@ -8,8 +8,8 @@ from pydase.observer_pattern.observable.observable_object import ObservableObjec
 from pydase.observer_pattern.observer.property_observer import (
     PropertyObserver,
 )
-from pydase.utils.helpers import get_object_attr_from_path_list
-from pydase.utils.serializer import dump
+from pydase.utils.helpers import get_object_attr_from_path
+from pydase.utils.serialization.serializer import SerializedObject, dump
 
 logger = logging.getLogger(__name__)
 
@@ -18,7 +18,7 @@ class DataServiceObserver(PropertyObserver):
     def __init__(self, state_manager: StateManager) -> None:
         self.state_manager = state_manager
         self._notification_callbacks: list[
-            Callable[[str, Any, dict[str, Any]], None]
+            Callable[[str, Any, SerializedObject], None]
         ] = []
         super().__init__(state_manager.service)
 
@@ -42,10 +42,16 @@ class DataServiceObserver(PropertyObserver):
         ):
             logger.debug("'%s' changed to '%s'", full_access_path, value)
 
-        self._update_cache_value(full_access_path, value, cached_value_dict)
+            self._update_cache_value(full_access_path, value, cached_value_dict)
 
-        for callback in self._notification_callbacks:
-            callback(full_access_path, value, cached_value_dict)
+            cached_value_dict = deepcopy(
+                self.state_manager._data_service_cache.get_value_dict_from_cache(
+                    full_access_path
+                )
+            )
+
+            for callback in self._notification_callbacks:
+                callback(full_access_path, value, cached_value_dict)
 
         if isinstance(value, ObservableObject):
             self._update_property_deps_dict()
@@ -53,26 +59,29 @@ class DataServiceObserver(PropertyObserver):
         self._notify_dependent_property_changes(full_access_path)
 
     def _update_cache_value(
-        self, full_access_path: str, value: Any, cached_value_dict: dict[str, Any]
+        self,
+        full_access_path: str,
+        value: Any,
+        cached_value_dict: SerializedObject | dict[str, Any],
     ) -> None:
         value_dict = dump(value)
-        if cached_value_dict != {}:
-            if (
-                cached_value_dict["type"] != "method"
-                and cached_value_dict["type"] != value_dict["type"]
-            ):
-                logger.warning(
-                    "Type of '%s' changed from '%s' to '%s'. This could have unwanted "
-                    "side effects! Consider setting it to '%s' directly.",
-                    full_access_path,
-                    cached_value_dict["type"],
-                    value_dict["type"],
-                    cached_value_dict["type"],
-                )
-            self.state_manager._data_service_cache.update_cache(
+        if (
+            cached_value_dict != {}
+            and cached_value_dict["type"] != "method"
+            and cached_value_dict["type"] != value_dict["type"]
+        ):
+            logger.warning(
+                "Type of '%s' changed from '%s' to '%s'. This could have unwanted "
+                "side effects! Consider setting it to '%s' directly.",
                 full_access_path,
-                value,
+                cached_value_dict["type"],
+                value_dict["type"],
+                cached_value_dict["type"],
             )
+        self.state_manager._data_service_cache.update_cache(
+            full_access_path,
+            value,
+        )
 
     def _notify_dependent_property_changes(self, changed_attr_path: str) -> None:
         changed_props = self.property_deps_dict.get(changed_attr_path, [])
@@ -83,11 +92,11 @@ class DataServiceObserver(PropertyObserver):
             if prop not in self.changing_attributes:
                 self._notify_changed(
                     prop,
-                    get_object_attr_from_path_list(self.observable, prop.split(".")),
+                    get_object_attr_from_path(self.observable, prop),
                 )
 
     def add_notification_callback(
-        self, callback: Callable[[str, Any, dict[str, Any]], None]
+        self, callback: Callable[[str, Any, SerializedObject], None]
     ) -> None:
         """
         Registers a callback function to be invoked upon attribute changes in the

src/pydase/data_service/state_manager.py

@@ -5,15 +5,16 @@ from collections.abc import Callable
 from pathlib import Path
 from typing import TYPE_CHECKING, Any, cast
 
-import pydase.units as u
 from pydase.data_service.data_service_cache import DataServiceCache
 from pydase.utils.helpers import (
-    get_object_attr_from_path_list,
+    get_object_attr_from_path,
     is_property_attribute,
     parse_list_attr_and_index,
 )
-from pydase.utils.serializer import (
-    dump,
+from pydase.utils.serialization.deserializer import loads
+from pydase.utils.serialization.serializer import (
+    SerializationPathError,
+    SerializedObject,
     generate_serialized_data_paths,
     get_nested_dict_by_path,
     serialized_dict_is_nested_object,
@@ -114,10 +115,17 @@ class StateManager:
         self._data_service_cache = DataServiceCache(self.service)
 
     @property
-    def cache(self) -> dict[str, Any]:
+    def cache(self) -> SerializedObject:
         """Returns the cached DataService state."""
         return self._data_service_cache.cache
 
+    @property
+    def cache_value(self) -> dict[str, SerializedObject]:
+        """Returns the "value" value of the DataService serialization."""
+        return cast(
+            dict[str, SerializedObject], self._data_service_cache.cache["value"]
+        )
+
     def save_state(self) -> None:
         """
         Saves the DataService's current state to a JSON file defined by `self.filename`.
@@ -126,7 +134,7 @@ class StateManager:
 
         if self.filename is not None:
             with open(self.filename, "w") as f:
-                json.dump(self.cache["value"], f, indent=4)
+                json.dump(self.cache_value, f, indent=4)
         else:
             logger.info(
                 "State manager was not initialised with a filename. Skipping "
@@ -146,24 +154,26 @@ class StateManager:
             return
 
         for path in generate_serialized_data_paths(json_dict):
-            nested_json_dict = get_nested_dict_by_path(json_dict, path)
-            nested_class_dict = self._data_service_cache.get_value_dict_from_cache(path)
-
-            value, value_type = nested_json_dict["value"], nested_json_dict["type"]
-            class_attr_value_type = nested_class_dict.get("type", None)
-
-            if class_attr_value_type == value_type:
-                if self.__is_loadable_state_attribute(path):
-                    self.set_service_attribute_value_by_path(path, value)
-            else:
-                logger.info(
-                    "Attribute type of '%s' changed from '%s' to "
-                    "'%s'. Ignoring value from JSON file...",
-                    path,
-                    value_type,
-                    class_attr_value_type,
+            if self.__is_loadable_state_attribute(path):
+                nested_json_dict = get_nested_dict_by_path(json_dict, path)
+                nested_class_dict = self._data_service_cache.get_value_dict_from_cache(
+                    path
                 )
 
+                value_type = nested_json_dict["type"]
+                class_attr_value_type = nested_class_dict.get("type", None)
+
+                if class_attr_value_type == value_type:
+                    self.set_service_attribute_value_by_path(path, nested_json_dict)
+                else:
+                    logger.info(
+                        "Attribute type of '%s' changed from '%s' to "
+                        "'%s'. Ignoring value from JSON file...",
+                        path,
+                        value_type,
+                        class_attr_value_type,
+                    )
+
     def _get_state_dict_from_json_file(self) -> dict[str, Any]:
         if self.filename is not None and os.path.exists(self.filename):
             with open(self.filename) as f:
@@ -175,7 +185,7 @@ class StateManager:
     def set_service_attribute_value_by_path(
         self,
         path: str,
-        value: Any,
+        serialized_value: SerializedObject,
     ) -> None:
         """
         Sets the value of an attribute in the service managed by the `StateManager`
@@ -191,59 +201,76 @@ class StateManager:
             value: The new value to set for the attribute.
         """
 
-        current_value_dict = get_nested_dict_by_path(self.cache["value"], path)
+        current_value_dict = get_nested_dict_by_path(self.cache_value, path)
 
         # This will also filter out methods as they are 'read-only'
         if current_value_dict["readonly"]:
             logger.debug("Attribute '%s' is read-only. Ignoring new value...", path)
             return
 
-        converted_value = self.__convert_value_if_needed(value, current_value_dict)
+        if "full_access_path" not in serialized_value:
+            # Backwards compatibility for JSON files not containing the
+            # full_access_path
+            logger.warning(
+                "The format of your JSON file is out-of-date. This might lead "
+                "to unexpected errors. Please consider updating it."
+            )
+            serialized_value["full_access_path"] = current_value_dict[
+                "full_access_path"
+            ]
 
         # only set value when it has changed
-        if self.__attr_value_has_changed(converted_value, current_value_dict["value"]):
-            self.__update_attribute_by_path(path, converted_value)
+        if self.__attr_value_has_changed(serialized_value, current_value_dict):
+            self.__update_attribute_by_path(path, serialized_value)
         else:
             logger.debug("Value of attribute '%s' has not changed...", path)
 
-    def __attr_value_has_changed(self, value_object: Any, current_value: Any) -> bool:
-        """Check if the serialized value of `value_object` differs from `current_value`.
+    def __attr_value_has_changed(
+        self, serialized_new_value: Any, serialized_current_value: Any
+    ) -> bool:
+        return not (
+            serialized_new_value["type"] == serialized_current_value["type"]
+            and serialized_new_value["value"] == serialized_current_value["value"]
+        )
 
-        The method serializes `value_object` to compare it, which is mainly
-        necessary for handling Quantity objects.
-        """
-
-        return dump(value_object)["value"] != current_value
-
-    def __convert_value_if_needed(
-        self, value: Any, current_value_dict: dict[str, Any]
-    ) -> Any:
-        if current_value_dict["type"] == "Quantity":
-            return u.convert_to_quantity(value, current_value_dict["value"]["unit"])
-        if current_value_dict["type"] == "float" and not isinstance(value, float):
-            return float(value)
-        return value
-
-    def __update_attribute_by_path(self, path: str, value: Any) -> None:
-        parent_path_list, attr_name = path.split(".")[:-1], path.split(".")[-1]
+    def __update_attribute_by_path(
+        self, path: str, serialized_value: SerializedObject
+    ) -> None:
+        parent_path, attr_name = ".".join(path.split(".")[:-1]), path.split(".")[-1]
 
         # If attr_name corresponds to a list entry, extract the attr_name and the
         # index
         attr_name, index = parse_list_attr_and_index(attr_name)
 
         # Update path to reflect the attribute without list indices
-        path = ".".join([*parent_path_list, attr_name])
+        path = f"{parent_path}.{attr_name}" if parent_path != "" else attr_name
 
-        attr_cache_type = get_nested_dict_by_path(self.cache["value"], path)["type"]
+        attr_cache_type = get_nested_dict_by_path(self.cache_value, path)["type"]
 
         # Traverse the object according to the path parts
-        target_obj = get_object_attr_from_path_list(self.service, parent_path_list)
+        target_obj = get_object_attr_from_path(self.service, parent_path)
 
         if attr_cache_type in ("ColouredEnum", "Enum"):
-            enum_attr = get_object_attr_from_path_list(target_obj, [attr_name])
-            setattr(target_obj, attr_name, enum_attr.__class__[value])
-        elif attr_cache_type == "list":
-            list_obj = get_object_attr_from_path_list(target_obj, [attr_name])
+            enum_attr = get_object_attr_from_path(target_obj, attr_name)
+            # take the value of the existing enum class
+            if serialized_value["type"] in ("ColouredEnum", "Enum"):
+                try:
+                    setattr(
+                        target_obj,
+                        attr_name,
+                        enum_attr.__class__[serialized_value["value"]],
+                    )
+                    return
+                except KeyError:
+                    # This error will arise when setting an enum from another enum class
+                    # In this case, we resort to loading the enum and setting it
+                    # directly
+                    pass
+
+        value = loads(serialized_value)
+
+        if attr_cache_type == "list":
+            list_obj = get_object_attr_from_path(target_obj, attr_name)
             list_obj[index] = value
         else:
             setattr(target_obj, attr_name, value)
@@ -256,10 +283,11 @@ class StateManager:
         attributes default to being loadable.
         """
 
-        parent_object = get_object_attr_from_path_list(
-            self.service, full_access_path.split(".")[:-1]
+        parent_path, attr_name = (
+            ".".join(full_access_path.split(".")[:-1]),
+            full_access_path.split(".")[-1],
         )
-        attr_name = full_access_path.split(".")[-1]
+        parent_object = get_object_attr_from_path(self.service, parent_path)
 
         if is_property_attribute(parent_object, attr_name):
             prop = getattr(type(parent_object), attr_name)
@@ -272,12 +300,20 @@ class StateManager:
                 )
             return has_decorator
 
-        cached_serialization_dict = get_nested_dict_by_path(
-            self.cache["value"], full_access_path
-        )
+        try:
+            cached_serialization_dict = get_nested_dict_by_path(
+                self.cache_value, full_access_path
+            )
 
-        if cached_serialization_dict["value"] == "method":
+            if cached_serialization_dict["value"] == "method":
+                return False
+
+            # nested objects cannot be loaded
+            return not serialized_dict_is_nested_object(cached_serialization_dict)
+        except SerializationPathError:
+            logger.debug(
+                "Path %a could not be loaded. It does not correspond to an attribute of"
+                " the class. Ignoring value from JSON file...",
+                attr_name,
+            )
             return False
-
-        # nested objects cannot be loaded
-        return not serialized_dict_is_nested_object(cached_serialization_dict)

src/pydase/frontend/asset-manifest.json

@@ -1,13 +1,13 @@
 {
   "files": {
     "main.css": "/static/css/main.7ef670d5.css",
-    "main.js": "/static/js/main.6d1d080e.js",
+    "main.js": "/static/js/main.9c35da6c.js",
     "index.html": "/index.html",
     "main.7ef670d5.css.map": "/static/css/main.7ef670d5.css.map",
-    "main.6d1d080e.js.map": "/static/js/main.6d1d080e.js.map"
+    "main.9c35da6c.js.map": "/static/js/main.9c35da6c.js.map"
   },
   "entrypoints": [
     "static/css/main.7ef670d5.css",
-    "static/js/main.6d1d080e.js"
+    "static/js/main.9c35da6c.js"
   ]
 }

src/pydase/frontend/index.html

@@ -1 +1 @@
-<!doctype html><html lang="en"><head><meta charset="utf-8"/><link rel="icon" href="/favicon.ico"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="theme-color" content="#000000"/><meta name="description" content="Web site displaying a pydase UI."/><link rel="apple-touch-icon" href="/logo192.png"/><link rel="manifest" href="/manifest.json"/><title>pydase App</title><script defer="defer" src="/static/js/main.6d1d080e.js"></script><link href="/static/css/main.7ef670d5.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>
+<!doctype html><html lang="en"><head><meta charset="utf-8"/><link rel="icon" href="/favicon.ico"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="theme-color" content="#000000"/><meta name="description" content="Web site displaying a pydase UI."/><link rel="apple-touch-icon" href="/logo192.png"/><link rel="manifest" href="/manifest.json"/><title>pydase App</title><script defer="defer" src="/static/js/main.9c35da6c.js"></script><link href="/static/css/main.7ef670d5.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>

src/pydase/observer_pattern/observable/observable.py

@@ -67,5 +67,9 @@ class Observable(ObservableObject):
         self, observer_attr_name: str, instance_attr_name: str
     ) -> str:
         if observer_attr_name != "":
-            return f"{observer_attr_name}.{instance_attr_name}"
+            return (
+                f"{observer_attr_name}.{instance_attr_name}"
+                if instance_attr_name != ""
+                else observer_attr_name
+            )
         return instance_attr_name

src/pydase/observer_pattern/observer/property_observer.py

@@ -49,7 +49,7 @@ class PropertyObserver(Observer):
     def _process_observable_properties(
         self, obj: Observable, deps: dict[str, Any], prefix: str
     ) -> None:
-        for k, value in vars(type(obj)).items():
+        for k, value in inspect.getmembers(type(obj)):
             prefix = (
                 f"{prefix}." if prefix != "" and not prefix.endswith(".") else prefix
             )

src/pydase/server/server.py

@@ -3,12 +3,10 @@ import logging
 import os
 import signal
 import threading
-from concurrent.futures import ThreadPoolExecutor
 from pathlib import Path
 from types import FrameType
 from typing import Any, Protocol, TypedDict
 
-from rpyc import ThreadedServer  # type: ignore[import-untyped]
 from uvicorn.server import HANDLED_SIGNALS
 
 from pydase import DataService
@@ -51,8 +49,7 @@ class AdditionalServerProtocol(Protocol):
         host: str,
         port: int,
         **kwargs: Any,
-    ) -> None:
-        ...
+    ) -> None: ...
 
     async def serve(self) -> Any:
         """Starts the server. This method should be implemented as an asynchronous
@@ -81,71 +78,67 @@ class Server:
 
     Args:
         service: DataService
-          The DataService instance that this server will manage.
+            The DataService instance that this server will manage.
         host: str
-          The host address for the server. Default is '0.0.0.0', which means all
-          available network interfaces.
-        rpc_port: int
-          The port number for the RPC server. Default is
-          `pydase.config.ServiceConfig().rpc_port`.
+            The host address for the server. Default is '0.0.0.0', which means all
+            available network interfaces.
         web_port: int
-          The port number for the web server. Default is
-          `pydase.config.ServiceConfig().web_port`.
-        enable_rpc: bool
-          Whether to enable the RPC server. Default is True.
+            The port number for the web server. Default is
+            `pydase.config.ServiceConfig().web_port`.
         enable_web: bool
-          Whether to enable the web server. Default is True.
+            Whether to enable the web server. Default is True.
         filename: str | Path | None
-          Filename of the file managing the service state persistence. Defaults to None.
-        use_forking_server: bool
-          Whether to use ForkingServer for multiprocessing. Default is False.
+            Filename of the file managing the service state persistence.
+            Defaults to None.
         additional_servers : list[AdditionalServer]
-          A list of additional servers to run alongside the main server. Each entry in
-          the list should be a dictionary with the following structure:
-            - server: A class that adheres to the AdditionalServerProtocol. This class
-                should have an `__init__` method that accepts the DataService instance,
-                port, host, and optional keyword arguments, and a `serve` method that is
-                a coroutine responsible for starting the server.
-            - port: The port on which the additional server will be running.
-            - kwargs: A dictionary containing additional keyword arguments that will be
-                passed to the server's `__init__` method.
+            A list of additional servers to run alongside the main server. Each entry in
+            the list should be a dictionary with the following structure:
+                - server: A class that adheres to the AdditionalServerProtocol. This
+                    class should have an `__init__` method that accepts the DataService
+                    instance, port, host, and optional keyword arguments, and a `serve`
+                    method that is a coroutine responsible for starting the server.
+                - port: The port on which the additional server will be running.
+                - kwargs: A dictionary containing additional keyword arguments that will
+                    be passed to the server's `__init__` method.
 
-          Here's an example of how you might define an additional server:
+            Here's an example of how you might define an additional server:
 
+            ```python
+            class MyCustomServer:
+                def __init__(
+                    self,
+                    data_service_observer: DataServiceObserver,
+                    host: str,
+                    port: int,
+                    **kwargs: Any,
+                ) -> None:
+                    self.observer = data_service_observer
+                    self.state_manager = self.observer.state_manager
+                    self.service = self.state_manager.service
+                    self.port = port
+                    self.host = host
+                    # handle any additional arguments...
 
-          >>>     class MyCustomServer:
-          ...         def __init__(
-          ...             self,
-          ...             data_service_observer: DataServiceObserver,
-          ...             host: str,
-          ...             port: int,
-          ...             **kwargs: Any,
-          ...         ) -> None:
-          ...             self.observer = data_service_observer
-          ...             self.state_manager = self.observer.state_manager
-          ...             self.service = self.state_manager.service
-          ...             self.port = port
-          ...             self.host = host
-          ...             # handle any additional arguments...
-          ...
-          ...         async def serve(self):
-          ...             # code to start the server...
+                async def serve(self):
+                    # code to start the server...
+            ```
 
-          And here's how you might add it to the `additional_servers` list when creating
-          a `Server` instance:
-
-          >>>    server = Server(
-          ...        service=my_data_service,
-          ...        additional_servers=[
-          ...            {
-          ...                "server": MyCustomServer,
-          ...                "port": 12345,
-          ...                "kwargs": {"some_arg": "some_value"}
-          ...            }
-          ...        ],
-          ...    )
-          ...    server.run()
+            And here's how you might add it to the `additional_servers` list when
+            creating a `Server` instance:
 
+            ```python
+            server = Server(
+                service=my_data_service,
+                additional_servers=[
+                    {
+                        "server": MyCustomServer,
+                        "port": 12345,
+                        "kwargs": {"some_arg": "some_value"}
+                    }
+                ],
+            )
+            server.run()
+            ```
         **kwargs: Any
           Additional keyword arguments.
     """
@@ -154,9 +147,7 @@ class Server:
         self,
         service: DataService,
         host: str = "0.0.0.0",
-        rpc_port: int = ServiceConfig().rpc_port,
         web_port: int = ServiceConfig().web_port,
-        enable_rpc: bool = True,
         enable_web: bool = True,
         filename: str | Path | None = None,
         additional_servers: list[AdditionalServer] | None = None,
@@ -166,16 +157,13 @@ class Server:
             additional_servers = []
         self._service = service
         self._host = host
-        self._rpc_port = rpc_port
         self._web_port = web_port
-        self._enable_rpc = enable_rpc
         self._enable_web = enable_web
         self._kwargs = kwargs
         self._loop: asyncio.AbstractEventLoop
         self._additional_servers = additional_servers
         self.should_exit = False
         self.servers: dict[str, asyncio.Future[Any]] = {}
-        self.executor: ThreadPoolExecutor | None = None
         self._state_manager = StateManager(self._service, filename)
         self._observer = DataServiceObserver(self._state_manager)
         self._state_manager.load_state()
@@ -207,20 +195,6 @@ class Server:
         self.install_signal_handlers()
         self._service._task_manager.start_autostart_tasks()
 
-        if self._enable_rpc:
-            self.executor = ThreadPoolExecutor()
-            self._rpc_server = ThreadedServer(
-                self._service,
-                port=self._rpc_port,
-                protocol_config={
-                    "allow_all_attrs": True,
-                    "allow_setattr": True,
-                },
-            )
-            future_or_task = self._loop.run_in_executor(
-                executor=self.executor, func=self._rpc_server.start
-            )
-            self.servers["rpyc"] = future_or_task
         for server in self._additional_servers:
             addin_server = server["server"](
                 data_service_observer=self._observer,
@@ -258,10 +232,6 @@ class Server:
         await self.__cancel_servers()
         await self.__cancel_tasks()
 
-        if hasattr(self, "_rpc_server") and self._enable_rpc:
-            logger.debug("Closing rpyc server.")
-            self._rpc_server.close()
-
     async def __cancel_servers(self) -> None:
         for server_name, task in self.servers.items():
             task.cancel()

src/pydase/server/web_server/sio_setup.py

@@ -2,14 +2,15 @@ import asyncio
 import logging
 from typing import Any, TypedDict
 
+import click
 import socketio  # type: ignore[import-untyped]
 
-from pydase.data_service.data_service import process_callable_attribute
 from pydase.data_service.data_service_observer import DataServiceObserver
 from pydase.data_service.state_manager import StateManager
-from pydase.utils.helpers import get_object_attr_from_path_list
+from pydase.utils.helpers import get_object_attr_from_path
 from pydase.utils.logging import SocketIOHandler
-from pydase.utils.serializer import dump
+from pydase.utils.serialization.deserializer import Deserializer
+from pydase.utils.serialization.serializer import SerializedObject, dump
 
 logger = logging.getLogger(__name__)
 
@@ -21,26 +22,20 @@ class UpdateDict(TypedDict):
 
     Attributes:
     ----------
-    name : str
-        The name of the attribute to be updated in the DataService instance.
-        If the attribute is part of a nested structure, this would be the name of the
-        attribute in the last nested object. For example, for an attribute access path
-        'attr1.list_attr[0].attr2', 'attr2' would be the name.
-
-    parent_path : str
-        The access path for the parent object of the attribute to be updated. This is
-        used to construct the full access path for the attribute. For example, for an
-        attribute access path 'attr1.list_attr[0].attr2', 'attr1.list_attr[0]' would be
-        the parent_path.
-
-    value : Any
-        The new value to be assigned to the attribute. The type of this value should
-        match the type of the attribute to be updated.
+    access_path : string
+        The full access path of the attribute to be updated.
+    value : SerializedObject
+        The serialized new value to be assigned to the attribute.
     """
 
-    name: str
-    parent_path: str
-    value: Any
+    access_path: str
+    value: SerializedObject
+
+
+class TriggerMethodDict(TypedDict):
+    access_path: str
+    args: SerializedObject
+    kwargs: SerializedObject
 
 
 class RunMethodDict(TypedDict):
@@ -62,7 +57,7 @@ class RunMethodDict(TypedDict):
     kwargs: dict[str, Any]
 
 
-def setup_sio_server(  # noqa: C901
+def setup_sio_server(
     observer: DataServiceObserver,
     enable_cors: bool,
     loop: asyncio.AbstractEventLoop,
@@ -94,18 +89,9 @@ def setup_sio_server(  # noqa: C901
 
     # Add notification callback to observer
     def sio_callback(
-        full_access_path: str, value: Any, cached_value_dict: dict[str, Any]
+        full_access_path: str, value: Any, cached_value_dict: SerializedObject
     ) -> None:
         if cached_value_dict != {}:
-            serialized_value = dump(value)
-            if cached_value_dict["type"] != "method":
-                cached_value_dict["type"] = serialized_value["type"]
-
-            cached_value_dict["value"] = serialized_value["value"]
-
-            # Check if the serialized value contains an "enum" key, and if so, copy it
-            if "enum" in serialized_value:
-                cached_value_dict["enum"] = serialized_value["enum"]
 
             async def notify() -> None:
                 try:
@@ -128,24 +114,57 @@ def setup_sio_server(  # noqa: C901
     return sio
 
 
-def setup_sio_events(sio: socketio.AsyncServer, state_manager: StateManager) -> None:
-    @sio.event
-    def set_attribute(sid: str, data: UpdateDict) -> Any:
-        logger.debug("Received frontend update: %s", data)
-        parent_path = data["parent_path"].split(".")
-        path_list = [element for element in parent_path if element] + [data["name"]]
-        path = ".".join(path_list)
-        return state_manager.set_service_attribute_value_by_path(
-            path=path, value=data["value"]
+def setup_sio_events(sio: socketio.AsyncServer, state_manager: StateManager) -> None:  # noqa: C901
+    @sio.event  # type: ignore
+    async def connect(sid: str, environ: Any) -> None:
+        logging.debug("Client [%s] connected", click.style(str(sid), fg="cyan"))
+
+    @sio.event  # type: ignore
+    async def disconnect(sid: str) -> None:
+        logging.debug("Client [%s] disconnected", click.style(str(sid), fg="cyan"))
+
+    @sio.event  # type: ignore
+    async def service_serialization(sid: str) -> SerializedObject:
+        logging.debug(
+            "Client [%s] requested service serialization",
+            click.style(str(sid), fg="cyan"),
         )
+        return state_manager.cache
 
     @sio.event
-    def run_method(sid: str, data: RunMethodDict) -> Any:
-        logger.debug("Running method: %s", data)
-        parent_path = data["parent_path"].split(".")
-        path_list = [element for element in parent_path if element] + [data["name"]]
-        method = get_object_attr_from_path_list(state_manager.service, path_list)
-        return process_callable_attribute(method, data["kwargs"])
+    async def update_value(sid: str, data: UpdateDict) -> SerializedObject | None:  # type: ignore
+        path = data["access_path"]
+
+        try:
+            state_manager.set_service_attribute_value_by_path(
+                path=path, serialized_value=data["value"]
+            )
+        except Exception as e:
+            logger.exception(e)
+            return dump(e)
+
+    @sio.event
+    async def get_value(sid: str, access_path: str) -> SerializedObject:
+        try:
+            return state_manager._data_service_cache.get_value_dict_from_cache(
+                access_path
+            )
+        except Exception as e:
+            logger.exception(e)
+            return dump(e)
+
+    @sio.event
+    async def trigger_method(sid: str, data: TriggerMethodDict) -> Any:
+        try:
+            method = get_object_attr_from_path(
+                state_manager.service, data["access_path"]
+            )
+            args = Deserializer.deserialize(data["args"])
+            kwargs: dict[str, Any] = Deserializer.deserialize(data["kwargs"])
+            return dump(method(*args, **kwargs))
+        except Exception as e:
+            logger.error(e)
+            return dump(e)
 
 
 def setup_logging_handler(sio: socketio.AsyncServer) -> None:

src/pydase/server/web_server/web_server.py

@@ -6,7 +6,7 @@ from typing import Any
 
 import socketio  # type: ignore[import-untyped]
 import uvicorn
-from fastapi import FastAPI
+from fastapi import FastAPI, Response
 from fastapi.middleware.cors import CORSMiddleware
 from fastapi.responses import FileResponse
 from fastapi.staticfiles import StaticFiles
@@ -16,7 +16,7 @@ from pydase.data_service.data_service_observer import DataServiceObserver
 from pydase.server.web_server.sio_setup import (
     setup_sio_server,
 )
-from pydase.utils.serializer import generate_serialized_data_paths
+from pydase.utils.serialization.serializer import generate_serialized_data_paths
 from pydase.version import __version__
 
 logger = logging.getLogger(__name__)
@@ -70,7 +70,7 @@ class WebServer:
         enable_cors: bool = True,
         config_dir: Path = ServiceConfig().config_dir,
         generate_web_settings: bool = WebServerConfig().generate_web_settings,
-        **kwargs: Any,
+        frontend_src: Path = Path(__file__).parent.parent.parent / "frontend",
     ) -> None:
         self.observer = data_service_observer
         self.state_manager = self.observer.state_manager
@@ -79,6 +79,7 @@ class WebServer:
         self.host = host
         self.css = css
         self.enable_cors = enable_cors
+        self.frontend_src = frontend_src
         self._service_config_dir = config_dir
         self._generate_web_settings = generate_web_settings
         self._loop: asyncio.AbstractEventLoop
@@ -126,11 +127,14 @@ class WebServer:
     @property
     def web_settings(self) -> dict[str, dict[str, Any]]:
         current_web_settings = self._get_web_settings_from_file()
-        for path in generate_serialized_data_paths(self.state_manager.cache["value"]):
+        for path in generate_serialized_data_paths(self.state_manager.cache_value):
             if path in current_web_settings:
                 continue
 
-            current_web_settings[path] = {"displayName": path.split(".")[-1]}
+            current_web_settings[path] = {
+                "displayName": path.split(".")[-1],
+                "display": True,
+            }
 
         return current_web_settings
 
@@ -161,23 +165,24 @@ class WebServer:
 
         @app.get("/service-properties")
         def service_properties() -> dict[str, Any]:
-            return self.state_manager.cache
+            return self.state_manager.cache  # type: ignore
 
         @app.get("/web-settings")
         def web_settings() -> dict[str, Any]:
             return self.web_settings
 
         # exposing custom.css file provided by user
-        if self.css is not None:
-
-            @app.get("/custom.css")
-            async def styles() -> FileResponse:
+        @app.get("/custom.css")
+        async def styles() -> Response:
+            if self.css is not None:
                 return FileResponse(str(self.css))
 
+            return Response(content="", media_type="text/css")
+
         app.mount(
             "/",
             StaticFiles(
-                directory=Path(__file__).parent.parent.parent / "frontend",
+                directory=self.frontend_src,
                 html=True,
             ),
         )

src/pydase/utils/helpers.py

@@ -30,13 +30,13 @@ def get_class_and_instance_attributes(obj: object) -> dict[str, Any]:
     return dict(chain(type(obj).__dict__.items(), obj.__dict__.items()))
 
 
-def get_object_attr_from_path_list(target_obj: Any, path: list[str]) -> Any:
+def get_object_attr_from_path(target_obj: Any, path: str) -> Any:
     """
     Traverse the object tree according to the given path.
 
     Args:
         target_obj: The root object to start the traversal from.
-        path: A list of attribute names representing the path to traverse.
+        path: Access path of the object.
 
     Returns:
         The attribute at the end of the path. If the path includes a list index,
@@ -46,7 +46,8 @@ def get_object_attr_from_path_list(target_obj: Any, path: list[str]) -> Any:
     Raises:
         ValueError: If a list index in the path is not a valid integer.
     """
-    for part in path:
+    path_list = path.split(".") if path != "" else []
+    for part in path_list:
         try:
             # Try to split the part into attribute and index
             attr, index_str = part.split("[", maxsplit=1)
@@ -63,49 +64,6 @@ def get_object_attr_from_path_list(target_obj: Any, path: list[str]) -> Any:
     return target_obj
 
 
-def convert_arguments_to_hinted_types(
-    args: dict[str, Any], type_hints: dict[str, Any]
-) -> dict[str, Any] | str:
-    """
-    Convert the given arguments to their types hinted in the type_hints dictionary.
-
-    This function attempts to convert each argument in the args dictionary to the type
-    specified for the argument in the type_hints dictionary. If the conversion is
-    successful, the function replaces the original argument in the args dictionary with
-    the converted argument.
-
-    If a ValueError is raised during the conversion of an argument, the function logs
-    an error message and returns the error message as a string.
-
-    Args:
-        args: A dictionary of arguments to be converted. The keys are argument names
-              and the values are the arguments themselves.
-        type_hints: A dictionary of type hints for the arguments. The keys are
-                    argument names and the values are the hinted types.
-
-    Returns:
-        A dictionary of the converted arguments if all conversions are successful,
-        or an error message string if a ValueError is raised during a conversion.
-    """
-
-    # Convert arguments to their hinted types
-    for arg_name, arg_value in args.items():
-        if arg_name in type_hints:
-            arg_type = type_hints[arg_name]
-            if isinstance(arg_type, type):
-                # Attempt to convert the argument to its hinted type
-                try:
-                    args[arg_name] = arg_type(arg_value)
-                except ValueError:
-                    msg = (
-                        f"Failed to convert argument '{arg_name}' to type "
-                        f"{arg_type.__name__}"
-                    )
-                    logger.error(msg)
-                    return msg
-    return args
-
-
 def update_value_if_changed(
     target: Any, attr_name_or_index: str | int, new_value: Any
 ) -> None:
@@ -195,7 +153,12 @@ def get_data_service_class_reference() -> Any:
     return getattr(pydase.data_service.data_service, "DataService")
 
 
-def is_property_attribute(target_obj: Any, attr_name: str) -> bool:
+def is_property_attribute(target_obj: Any, access_path: str) -> bool:
+    parent_path, attr_name = (
+        ".".join(access_path.split(".")[:-1]),
+        access_path.split(".")[-1],
+    )
+    target_obj = get_object_attr_from_path(target_obj, parent_path)
     return isinstance(getattr(type(target_obj), attr_name, None), property)
 
 

src/pydase/utils/serialization/deserializer.py

@@ -0,0 +1,151 @@
+import enum
+import logging
+from typing import TYPE_CHECKING, Any, NoReturn, cast
+
+import pydase
+import pydase.components
+import pydase.units as u
+from pydase.utils.helpers import get_component_classes
+from pydase.utils.serialization.types import SerializedObject
+
+if TYPE_CHECKING:
+    from collections.abc import Callable
+
+logger = logging.getLogger(__name__)
+
+
+class Deserializer:
+    @classmethod
+    def deserialize(cls, serialized_object: SerializedObject) -> Any:
+        type_handler: dict[str | None, None | Callable[..., Any]] = {
+            None: None,
+            "int": cls.deserialize_primitive,
+            "float": cls.deserialize_primitive,
+            "bool": cls.deserialize_primitive,
+            "str": cls.deserialize_primitive,
+            "NoneType": cls.deserialize_primitive,
+            "Quantity": cls.deserialize_quantity,
+            "Enum": cls.deserialize_enum,
+            "ColouredEnum": lambda serialized_object: cls.deserialize_enum(
+                serialized_object, enum_class=pydase.components.ColouredEnum
+            ),
+            "list": cls.deserialize_list,
+            "dict": cls.deserialize_dict,
+            "method": cls.deserialize_method,
+            "Exception": cls.deserialize_exception,
+        }
+
+        # First go through handled types (as ColouredEnum is also within the components)
+        handler = type_handler.get(serialized_object["type"])
+        if handler:
+            return handler(serialized_object)
+
+        # Custom types like Components or DataService classes
+        component_class = cls.get_component_class(serialized_object["type"])
+        if component_class:
+            return cls.deserialize_component_type(serialized_object, component_class)
+
+        return None
+
+    @classmethod
+    def deserialize_primitive(cls, serialized_object: SerializedObject) -> Any:
+        if serialized_object["type"] == "float":
+            return float(serialized_object["value"])
+        return serialized_object["value"]
+
+    @classmethod
+    def deserialize_quantity(cls, serialized_object: SerializedObject) -> Any:
+        return u.convert_to_quantity(serialized_object["value"])  # type: ignore
+
+    @classmethod
+    def deserialize_enum(
+        cls,
+        serialized_object: SerializedObject,
+        enum_class: type[enum.Enum] = enum.Enum,
+    ) -> Any:
+        return enum_class(serialized_object["name"], serialized_object["enum"])[  # type: ignore
+            serialized_object["value"]
+        ]
+
+    @classmethod
+    def deserialize_list(cls, serialized_object: SerializedObject) -> Any:
+        return [
+            cls.deserialize(item)
+            for item in cast(list[SerializedObject], serialized_object["value"])
+        ]
+
+    @classmethod
+    def deserialize_dict(cls, serialized_object: SerializedObject) -> Any:
+        return {
+            key: cls.deserialize(value)
+            for key, value in cast(
+                dict[str, SerializedObject], serialized_object["value"]
+            ).items()
+        }
+
+    @classmethod
+    def deserialize_method(cls, serialized_object: SerializedObject) -> Any:
+        return
+
+    @classmethod
+    def deserialize_exception(cls, serialized_object: SerializedObject) -> NoReturn:
+        import builtins
+
+        try:
+            exception = getattr(builtins, serialized_object["name"])  # type: ignore
+        except AttributeError:
+            exception = type(serialized_object["name"], (Exception,), {})  # type: ignore
+        raise exception(serialized_object["value"])
+
+    @staticmethod
+    def get_component_class(type_name: str | None) -> type | None:
+        for component_class in get_component_classes():
+            if type_name == component_class.__name__:
+                return component_class
+        if type_name == "DataService":
+            import pydase
+
+            return pydase.DataService
+        return None
+
+    @classmethod
+    def create_attr_property(cls, serialized_attr: SerializedObject) -> property:
+        attr_name = serialized_attr["full_access_path"].split(".")[-1]
+
+        def get(self) -> Any:  # type: ignore
+            return getattr(self, f"_{attr_name}")
+
+        get.__doc__ = serialized_attr["doc"]
+
+        def set(self, value: Any) -> None:  # type: ignore
+            return setattr(self, f"_{attr_name}", value)
+
+        if serialized_attr["readonly"]:
+            return property(get)
+        return property(get, set)
+
+    @classmethod
+    def deserialize_component_type(
+        cls, serialized_object: SerializedObject, base_class: type
+    ) -> Any:
+        def create_proxy_class(serialized_object: SerializedObject) -> type:
+            class_bases = (base_class,)
+            class_attrs = {}
+
+            # Process and add properties based on the serialized object
+            for key, value in cast(
+                dict[str, SerializedObject], serialized_object["value"]
+            ).items():
+                if value["type"] != "method":
+                    class_attrs[key] = cls.create_attr_property(value)
+                    # Initialize a placeholder for the attribute to avoid AttributeError
+                    class_attrs[f"_{key}"] = cls.deserialize(value)
+
+            # Create the dynamic class with the given name and attributes
+            return type(serialized_object["name"], class_bases, class_attrs)  # type: ignore
+
+        return create_proxy_class(serialized_object)()
+
+
+def loads(serialized_object: SerializedObject) -> Any:
+    return Deserializer.deserialize(serialized_object)

src/pydase/utils/serialization/serializer.py

@@ -1,9 +1,10 @@
+from __future__ import annotations
+
 import inspect
 import logging
 import sys
-from collections.abc import Callable
 from enum import Enum
-from typing import Any, TypedDict
+from typing import TYPE_CHECKING, Any, Literal, cast
 
 import pydase.units as u
 from pydase.data_service.abstract_data_service import AbstractDataService
@@ -15,10 +16,34 @@ from pydase.utils.helpers import (
     parse_list_attr_and_index,
     render_in_frontend,
 )
+from pydase.utils.serialization.types import (
+    DataServiceTypes,
+    SerializedBool,
+    SerializedDataService,
+    SerializedDict,
+    SerializedEnum,
+    SerializedException,
+    SerializedFloat,
+    SerializedInteger,
+    SerializedList,
+    SerializedMethod,
+    SerializedNoneType,
+    SerializedObject,
+    SerializedQuantity,
+    SerializedString,
+    SignatureDict,
+)
+
+if TYPE_CHECKING:
+    from collections.abc import Callable
 
 logger = logging.getLogger(__name__)
 
 
+class SerializationError(Exception):
+    pass
+
+
 class SerializationPathError(Exception):
     pass
 
@@ -29,61 +54,94 @@ class SerializationValueError(Exception):
 
 class Serializer:
     @staticmethod
-    def serialize_object(obj: Any) -> dict[str, Any]:
-        result: dict[str, Any] = {}
-        if isinstance(obj, AbstractDataService):
-            result = Serializer._serialize_data_service(obj)
+    def serialize_object(obj: Any, access_path: str = "") -> SerializedObject:  # noqa: C901
+        result: SerializedObject
+
+        if isinstance(obj, Exception):
+            result = Serializer._serialize_exception(obj)
+
+        elif isinstance(obj, AbstractDataService):
+            result = Serializer._serialize_data_service(obj, access_path=access_path)
 
         elif isinstance(obj, list):
-            result = Serializer._serialize_list(obj)
+            result = Serializer._serialize_list(obj, access_path=access_path)
 
         elif isinstance(obj, dict):
-            result = Serializer._serialize_dict(obj)
+            result = Serializer._serialize_dict(obj, access_path=access_path)
 
         # Special handling for u.Quantity
         elif isinstance(obj, u.Quantity):
-            result = Serializer._serialize_quantity(obj)
+            result = Serializer._serialize_quantity(obj, access_path=access_path)
 
         # Handling for Enums
         elif isinstance(obj, Enum):
-            result = Serializer._serialize_enum(obj)
+            result = Serializer._serialize_enum(obj, access_path=access_path)
 
         # Methods and coroutines
         elif inspect.isfunction(obj) or inspect.ismethod(obj):
-            result = Serializer._serialize_method(obj)
+            result = Serializer._serialize_method(obj, access_path=access_path)
 
-        else:
-            obj_type = type(obj).__name__
-            value = obj
-            readonly = False
-            doc = get_attribute_doc(obj)
-            result = {
-                "type": obj_type,
-                "value": value,
-                "readonly": readonly,
-                "doc": doc,
-            }
+        elif isinstance(obj, int | float | bool | str | None):
+            result = Serializer._serialize_primitive(obj, access_path=access_path)
 
-        return result
+        try:
+            return result
+        except UnboundLocalError:
+            raise SerializationError(
+                f"Could not serialized object of type {type(obj)}."
+            )
 
     @staticmethod
-    def _serialize_enum(obj: Enum) -> dict[str, Any]:
+    def _serialize_primitive(
+        obj: float | bool | str | None,
+        access_path: str,
+    ) -> (
+        SerializedInteger
+        | SerializedFloat
+        | SerializedBool
+        | SerializedString
+        | SerializedNoneType
+    ):
+        doc = get_attribute_doc(obj)
+        return {  # type: ignore
+            "full_access_path": access_path,
+            "doc": doc,
+            "readonly": False,
+            "type": type(obj).__name__,
+            "value": obj,
+        }
+
+    @staticmethod
+    def _serialize_exception(obj: Exception) -> SerializedException:
+        return {
+            "full_access_path": "",
+            "doc": None,
+            "readonly": True,
+            "type": "Exception",
+            "value": obj.args[0],
+            "name": obj.__class__.__name__,
+        }
+
+    @staticmethod
+    def _serialize_enum(obj: Enum, access_path: str = "") -> SerializedEnum:
         import pydase.components.coloured_enum
 
         value = obj.name
-        readonly = False
         doc = obj.__doc__
+        class_name = type(obj).__name__
         if sys.version_info < (3, 11) and doc == "An enumeration.":
             doc = None
         if isinstance(obj, pydase.components.coloured_enum.ColouredEnum):
-            obj_type = "ColouredEnum"
+            obj_type: Literal["ColouredEnum", "Enum"] = "ColouredEnum"
         else:
             obj_type = "Enum"
 
         return {
+            "full_access_path": access_path,
+            "name": class_name,
             "type": obj_type,
             "value": value,
-            "readonly": readonly,
+            "readonly": False,
             "doc": doc,
             "enum": {
                 name: member.value for name, member in obj.__class__.__members__.items()
@@ -91,48 +149,55 @@ class Serializer:
         }
 
     @staticmethod
-    def _serialize_quantity(obj: u.Quantity) -> dict[str, Any]:
-        obj_type = "Quantity"
+    def _serialize_quantity(
+        obj: u.Quantity, access_path: str = ""
+    ) -> SerializedQuantity:
+        doc = get_attribute_doc(obj)
+        value: u.QuantityDict = {"magnitude": obj.m, "unit": str(obj.u)}
+        return {
+            "full_access_path": access_path,
+            "type": "Quantity",
+            "value": value,
+            "readonly": False,
+            "doc": doc,
+        }
+
+    @staticmethod
+    def _serialize_dict(obj: dict[str, Any], access_path: str = "") -> SerializedDict:
         readonly = False
         doc = get_attribute_doc(obj)
-        value = {"magnitude": obj.m, "unit": str(obj.u)}
+        value = {
+            key: Serializer.serialize_object(val, access_path=f'{access_path}["{key}"]')
+            for key, val in obj.items()
+        }
         return {
-            "type": obj_type,
+            "full_access_path": access_path,
+            "type": "dict",
             "value": value,
             "readonly": readonly,
             "doc": doc,
         }
 
     @staticmethod
-    def _serialize_dict(obj: dict[str, Any]) -> dict[str, Any]:
-        obj_type = "dict"
+    def _serialize_list(obj: list[Any], access_path: str = "") -> SerializedList:
         readonly = False
         doc = get_attribute_doc(obj)
-        value = {key: Serializer.serialize_object(val) for key, val in obj.items()}
+        value = [
+            Serializer.serialize_object(o, access_path=f"{access_path}[{i}]")
+            for i, o in enumerate(obj)
+        ]
         return {
-            "type": obj_type,
+            "full_access_path": access_path,
+            "type": "list",
             "value": value,
             "readonly": readonly,
             "doc": doc,
         }
 
     @staticmethod
-    def _serialize_list(obj: list[Any]) -> dict[str, Any]:
-        obj_type = "list"
-        readonly = False
-        doc = get_attribute_doc(obj)
-        value = [Serializer.serialize_object(o) for o in obj]
-        return {
-            "type": obj_type,
-            "value": value,
-            "readonly": readonly,
-            "doc": doc,
-        }
-
-    @staticmethod
-    def _serialize_method(obj: Callable[..., Any]) -> dict[str, Any]:
-        obj_type = "method"
-        value = None
+    def _serialize_method(
+        obj: Callable[..., Any], access_path: str = ""
+    ) -> SerializedMethod:
         readonly = True
         doc = get_attribute_doc(obj)
         frontend_render = render_in_frontend(obj)
@@ -141,21 +206,22 @@ class Serializer:
         sig = inspect.signature(obj)
         sig.return_annotation
 
-        class SignatureDict(TypedDict):
-            parameters: dict[str, dict[str, Any]]
-            return_annotation: dict[str, Any]
-
         signature: SignatureDict = {"parameters": {}, "return_annotation": {}}
 
         for k, v in sig.parameters.items():
+            default_value = cast(
+                dict[str, Any], {} if v.default == inspect._empty else dump(v.default)
+            )
+            default_value.pop("full_access_path", None)
             signature["parameters"][k] = {
                 "annotation": str(v.annotation),
-                "default": dump(v.default) if v.default != inspect._empty else {},
+                "default": default_value,
             }
 
         return {
-            "type": obj_type,
-            "value": value,
+            "full_access_path": access_path,
+            "type": "method",
+            "value": None,
             "readonly": readonly,
             "doc": doc,
             "async": inspect.iscoroutinefunction(obj),
@@ -164,10 +230,12 @@ class Serializer:
         }
 
     @staticmethod
-    def _serialize_data_service(obj: AbstractDataService) -> dict[str, Any]:
+    def _serialize_data_service(
+        obj: AbstractDataService, access_path: str = ""
+    ) -> SerializedDataService:
         readonly = False
         doc = get_attribute_doc(obj)
-        obj_type = "DataService"
+        obj_type: DataServiceTypes = "DataService"
         obj_name = obj.__class__.__name__
 
         # Get component base class if any
@@ -175,7 +243,7 @@ class Serializer:
             (cls for cls in get_component_classes() if isinstance(obj, cls)), None
         )
         if component_base_cls:
-            obj_type = component_base_cls.__name__
+            obj_type = component_base_cls.__name__  # type: ignore
 
         # Get the set of DataService class attributes
         data_service_attr_set = set(dir(get_data_service_class_reference()))
@@ -184,7 +252,7 @@ class Serializer:
         # Get the difference between the two sets
         derived_only_attr_set = obj_attr_set - data_service_attr_set
 
-        value = {}
+        value: dict[str, SerializedObject] = {}
 
         # Iterate over attributes, properties, class attributes, and methods
         for key in sorted(derived_only_attr_set):
@@ -203,11 +271,14 @@ class Serializer:
 
             val = getattr(obj, key)
 
-            value[key] = Serializer.serialize_object(val)
+            path = f"{access_path}.{key}" if access_path else key
+            serialized_object = Serializer.serialize_object(val, access_path=path)
 
             # If there's a running task for this method
-            if key in obj._task_manager.tasks:
-                value[key]["value"] = TaskStatus.RUNNING.name
+            if serialized_object["type"] == "method" and key in obj._task_manager.tasks:
+                serialized_object["value"] = TaskStatus.RUNNING.name
+
+            value[key] = serialized_object
 
             # If the DataService attribute is a property
             if isinstance(getattr(obj.__class__, key, None), property):
@@ -216,6 +287,7 @@ class Serializer:
                 value[key]["doc"] = get_attribute_doc(prop)  # overwrite the doc
 
         return {
+            "full_access_path": access_path,
             "name": obj_name,
             "type": obj_type,
             "value": value,
@@ -224,12 +296,12 @@ class Serializer:
         }
 
 
-def dump(obj: Any) -> dict[str, Any]:
+def dump(obj: Any) -> SerializedObject:
     return Serializer.serialize_object(obj)
 
 
 def set_nested_value_by_path(
-    serialization_dict: dict[str, Any], path: str, value: Any
+    serialization_dict: dict[str, SerializedObject], path: str, value: Any
 ) -> None:
     """
     Set a value in a nested dictionary structure, which conforms to the serialization
@@ -251,53 +323,65 @@ def set_nested_value_by_path(
     """
 
     parent_path_parts, attr_name = path.split(".")[:-1], path.split(".")[-1]
-    current_dict: dict[str, Any] = serialization_dict
+    current_dict: dict[str, SerializedObject] = serialization_dict
 
     try:
         for path_part in parent_path_parts:
-            current_dict = get_next_level_dict_by_key(
+            next_level_serialized_object = get_next_level_dict_by_key(
                 current_dict, path_part, allow_append=False
             )
-            current_dict = current_dict["value"]
+            current_dict = cast(
+                dict[str, SerializedObject], next_level_serialized_object["value"]
+            )
 
-        current_dict = get_next_level_dict_by_key(
+        next_level_serialized_object = get_next_level_dict_by_key(
             current_dict, attr_name, allow_append=True
         )
     except (SerializationPathError, SerializationValueError, KeyError) as e:
         logger.error(e)
         return
 
-    # setting the new value
-    serialized_value = dump(value)
-    if "readonly" in current_dict:
-        if current_dict["type"] != "method":
-            current_dict["type"] = serialized_value["type"]
-        current_dict["value"] = serialized_value["value"]
+    if next_level_serialized_object["type"] == "method":  # state change of task
+        next_level_serialized_object["value"] = (
+            "RUNNING" if isinstance(value, TaskStatus) else None
+        )
     else:
-        current_dict.update(serialized_value)
+        serialized_value = Serializer.serialize_object(value, access_path=path)
+        serialized_value["readonly"] = next_level_serialized_object["readonly"]
+
+        keys_to_keep = set(serialized_value.keys())
+
+        next_level_serialized_object.update(serialized_value)  # type: ignore
+
+        # removes keys that are not present in the serialized new value
+        for key in list(next_level_serialized_object.keys()):
+            if key not in keys_to_keep:
+                next_level_serialized_object.pop(key, None)  # type: ignore
 
 
 def get_nested_dict_by_path(
-    serialization_dict: dict[str, Any],
+    serialization_dict: dict[str, SerializedObject],
     path: str,
-) -> dict[str, Any]:
+) -> SerializedObject:
     parent_path_parts, attr_name = path.split(".")[:-1], path.split(".")[-1]
-    current_dict: dict[str, Any] = serialization_dict
+    current_dict: dict[str, SerializedObject] = serialization_dict
 
     for path_part in parent_path_parts:
-        current_dict = get_next_level_dict_by_key(
+        next_level_serialized_object = get_next_level_dict_by_key(
             current_dict, path_part, allow_append=False
         )
-        current_dict = current_dict["value"]
+        current_dict = cast(
+            dict[str, SerializedObject], next_level_serialized_object["value"]
+        )
     return get_next_level_dict_by_key(current_dict, attr_name, allow_append=False)
 
 
 def get_next_level_dict_by_key(
-    serialization_dict: dict[str, Any],
+    serialization_dict: dict[str, SerializedObject],
     attr_name: str,
     *,
     allow_append: bool = False,
-) -> dict[str, Any]:
+) -> SerializedObject:
     """
     Retrieve a nested dictionary entry or list item from a data structure serialized
     with `pydase.utils.serializer.Serializer`.
@@ -322,36 +406,62 @@ def get_next_level_dict_by_key(
 
     try:
         if index is not None:
-            serialization_dict = serialization_dict[attr_name]["value"][index]
+            next_level_serialized_object = cast(
+                list[SerializedObject], serialization_dict[attr_name]["value"]
+            )[index]
         else:
-            serialization_dict = serialization_dict[attr_name]
+            next_level_serialized_object = serialization_dict[attr_name]
     except IndexError as e:
-        if allow_append and index == len(serialization_dict[attr_name]["value"]):
+        if (
+            index is not None
+            and allow_append
+            and index
+            == len(cast(list[SerializedObject], serialization_dict[attr_name]["value"]))
+        ):
             # Appending to list
-            serialization_dict[attr_name]["value"].append({})
-            serialization_dict = serialization_dict[attr_name]["value"][index]
+            cast(list[SerializedObject], serialization_dict[attr_name]["value"]).append(
+                {
+                    "full_access_path": "",
+                    "value": None,
+                    "type": "None",
+                    "doc": None,
+                    "readonly": False,
+                }
+            )
+            next_level_serialized_object = cast(
+                list[SerializedObject], serialization_dict[attr_name]["value"]
+            )[index]
         else:
             raise SerializationPathError(
                 f"Error occured trying to change '{attr_name}[{index}]': {e}"
             )
     except KeyError:
-        raise SerializationPathError(
-            f"Error occured trying to access the key '{attr_name}': it is either "
-            "not present in the current dictionary or its value does not contain "
-            "a 'value' key."
-        )
+        if not allow_append:
+            raise SerializationPathError(
+                f"Error occured trying to access the key '{attr_name}': it is either "
+                "not present in the current dictionary or its value does not contain "
+                "a 'value' key."
+            )
+        serialization_dict[attr_name] = {
+            "full_access_path": "",
+            "value": None,
+            "type": "None",
+            "doc": None,
+            "readonly": False,
+        }
+        next_level_serialized_object = serialization_dict[attr_name]
 
-    if not isinstance(serialization_dict, dict):
+    if not isinstance(next_level_serialized_object, dict):
         raise SerializationValueError(
             f"Expected a dictionary at '{attr_name}', but found type "
-            f"'{type(serialization_dict).__name__}' instead."
+            f"'{type(next_level_serialized_object).__name__}' instead."
         )
 
-    return serialization_dict
+    return next_level_serialized_object
 
 
 def generate_serialized_data_paths(
-    data: dict[str, dict[str, Any]], parent_path: str = ""
+    data: dict[str, Any], parent_path: str = ""
 ) -> list[str]:
     """
     Generate a list of access paths for all attributes in a dictionary representing
@@ -391,7 +501,7 @@ def generate_serialized_data_paths(
     return paths
 
 
-def serialized_dict_is_nested_object(serialized_dict: dict[str, Any]) -> bool:
+def serialized_dict_is_nested_object(serialized_dict: SerializedObject) -> bool:
     return (
         serialized_dict["type"] != "Quantity"
         and isinstance(serialized_dict["value"], dict)

src/pydase/utils/serialization/types.py

@@ -0,0 +1,119 @@
+from __future__ import annotations
+
+import logging
+from typing import TYPE_CHECKING, Any, Literal, TypedDict
+
+if TYPE_CHECKING:
+    import pydase.units as u
+
+logger = logging.getLogger(__name__)
+
+
+class SignatureDict(TypedDict):
+    parameters: dict[str, dict[str, Any]]
+    return_annotation: dict[str, Any]
+
+
+class SerializedObjectBase(TypedDict):
+    full_access_path: str
+    doc: str | None
+    readonly: bool
+
+
+class SerializedInteger(SerializedObjectBase):
+    value: int
+    type: Literal["int"]
+
+
+class SerializedFloat(SerializedObjectBase):
+    value: float
+    type: Literal["float"]
+
+
+class SerializedQuantity(SerializedObjectBase):
+    value: u.QuantityDict
+    type: Literal["Quantity"]
+
+
+class SerializedBool(SerializedObjectBase):
+    value: bool
+    type: Literal["bool"]
+
+
+class SerializedString(SerializedObjectBase):
+    value: str
+    type: Literal["str"]
+
+
+class SerializedEnum(SerializedObjectBase):
+    name: str
+    value: str
+    type: Literal["Enum", "ColouredEnum"]
+    enum: dict[str, Any]
+
+
+class SerializedList(SerializedObjectBase):
+    value: list[SerializedObject]
+    type: Literal["list"]
+
+
+class SerializedDict(SerializedObjectBase):
+    value: dict[str, SerializedObject]
+    type: Literal["dict"]
+
+
+class SerializedNoneType(SerializedObjectBase):
+    value: None
+    type: Literal["NoneType"]
+
+
+class SerializedNoValue(SerializedObjectBase):
+    value: None
+    type: Literal["None"]
+
+
+SerializedMethod = TypedDict(
+    "SerializedMethod",
+    {
+        "full_access_path": str,
+        "value": Literal["RUNNING"] | None,
+        "type": Literal["method"],
+        "doc": str | None,
+        "readonly": bool,
+        "async": bool,
+        "signature": SignatureDict,
+        "frontend_render": bool,
+    },
+)
+
+
+class SerializedException(SerializedObjectBase):
+    name: str
+    value: str
+    type: Literal["Exception"]
+
+
+DataServiceTypes = Literal["DataService", "Image", "NumberSlider", "DeviceConnection"]
+
+
+class SerializedDataService(SerializedObjectBase):
+    name: str
+    value: dict[str, SerializedObject]
+    type: DataServiceTypes
+
+
+SerializedObject = (
+    SerializedBool
+    | SerializedFloat
+    | SerializedInteger
+    | SerializedString
+    | SerializedList
+    | SerializedDict
+    | SerializedNoneType
+    | SerializedMethod
+    | SerializedException
+    | SerializedDataService
+    | SerializedEnum
+    | SerializedQuantity
+    | SerializedNoValue
+)

tests/client/test_client.py

@@ -0,0 +1,118 @@
+import threading
+from collections.abc import Generator
+from typing import Any
+
+import pydase
+import pytest
+from pydase.client.proxy_loader import ProxyAttributeError
+
+
+@pytest.fixture(scope="session")
+def pydase_client() -> Generator[pydase.Client, None, Any]:
+    class SubService(pydase.DataService):
+        name = "SubService"
+
+    class MyService(pydase.DataService):
+        def __init__(self) -> None:
+            super().__init__()
+            self._name = "MyService"
+            self._my_property = 12.1
+            self.sub_service = SubService()
+            self.list_attr = [1, 2]
+
+        @property
+        def my_property(self) -> float:
+            return self._my_property
+
+        @my_property.setter
+        def my_property(self, value: float) -> None:
+            self._my_property = value
+
+        @property
+        def name(self) -> str:
+            return self._name
+
+        def my_method(self, input_str: str) -> str:
+            return input_str
+
+    server = pydase.Server(MyService(), web_port=9999)
+    thread = threading.Thread(target=server.run, daemon=True)
+    thread.start()
+
+    client = pydase.Client(hostname="localhost", port=9999)
+
+    yield client
+
+    server.handle_exit()
+    thread.join()
+
+
+def test_property(pydase_client: pydase.Client) -> None:
+    assert pydase_client.proxy.my_property == 12.1
+    pydase_client.proxy.my_property = 2.1
+    assert pydase_client.proxy.my_property == 2.1
+
+
+def test_readonly_property(pydase_client: pydase.Client) -> None:
+    assert pydase_client.proxy.name == "MyService"
+    with pytest.raises(ProxyAttributeError):
+        pydase_client.proxy.name = "Hello"
+
+
+def test_method_execution(pydase_client: pydase.Client) -> None:
+    assert pydase_client.proxy.my_method("My return string") == "My return string"
+    assert (
+        pydase_client.proxy.my_method(input_str="My return string")
+        == "My return string"
+    )
+
+    with pytest.raises(TypeError):
+        pydase_client.proxy.my_method("Something", 2)
+
+    with pytest.raises(TypeError):
+        pydase_client.proxy.my_method(kwarg="hello")
+
+
+def test_nested_service(pydase_client: pydase.Client) -> None:
+    assert pydase_client.proxy.sub_service.name == "SubService"
+    pydase_client.proxy.sub_service.name = "New name"
+    assert pydase_client.proxy.sub_service.name == "New name"
+
+
+def test_list(pydase_client: pydase.Client) -> None:
+    assert pydase_client.proxy.list_attr == [1, 2]
+
+    pydase_client.proxy.list_attr.append(1)
+    assert pydase_client.proxy.list_attr == [1, 2, 1]
+
+    pydase_client.proxy.list_attr.extend([123, 2.1])
+    assert pydase_client.proxy.list_attr == [1, 2, 1, 123, 2.1]
+
+    pydase_client.proxy.list_attr.insert(1, 1.2)
+    assert pydase_client.proxy.list_attr == [1, 1.2, 2, 1, 123, 2.1]
+
+    assert pydase_client.proxy.list_attr.pop() == 2.1
+    assert pydase_client.proxy.list_attr == [1, 1.2, 2, 1, 123]
+
+    pydase_client.proxy.list_attr.remove(1.2)
+    assert pydase_client.proxy.list_attr == [1, 2, 1, 123]
+
+    pydase_client.proxy.list_attr[1] = 1337
+    assert pydase_client.proxy.list_attr == [1, 1337, 1, 123]
+
+    pydase_client.proxy.list_attr.clear()
+    assert pydase_client.proxy.list_attr == []
+
+
+def test_tab_completion(pydase_client: pydase.Client) -> None:
+    # Tab completion gets its suggestions from the __dir__ class method
+    assert all(
+        x in pydase_client.proxy.__dir__()
+        for x in [
+            "list_attr",
+            "my_method",
+            "my_property",
+            "name",
+            "sub_service",
+        ]
+    )

tests/components/test_device_connection.py

@@ -3,10 +3,9 @@ import logging
 
 import pydase
 import pydase.components.device_connection
+import pytest
 from pytest import LogCaptureFixture
 
-from tests.utils.test_serializer import pytest
-
 logger = logging.getLogger(__name__)
 
 

tests/components/test_image.py

@@ -0,0 +1,149 @@
+import logging
+
+import pydase
+import pydase.components
+from pydase.data_service.data_service_observer import DataServiceObserver
+from pydase.data_service.state_manager import StateManager
+from pydase.utils.serialization.serializer import dump
+from pytest import LogCaptureFixture
+
+logger = logging.getLogger(__name__)
+
+
+def test_image_functions(caplog: LogCaptureFixture) -> None:
+    class MyService(pydase.DataService):
+        def __init__(self) -> None:
+            super().__init__()
+            self.my_image = pydase.components.Image()
+
+    service_instance = MyService()
+    state_manager = StateManager(service_instance)
+    DataServiceObserver(state_manager)
+
+    service_instance.my_image.load_from_url("https://picsum.photos/200")
+
+    caplog.clear()
+
+
+def test_image_serialization() -> None:
+    class MyService(pydase.DataService):
+        def __init__(self) -> None:
+            super().__init__()
+            self.my_image = pydase.components.Image()
+
+    assert dump(MyService()) == {
+        "full_access_path": "",
+        "name": "MyService",
+        "type": "DataService",
+        "value": {
+            "my_image": {
+                "full_access_path": "my_image",
+                "name": "Image",
+                "type": "Image",
+                "value": {
+                    "format": {
+                        "full_access_path": "my_image.format",
+                        "type": "str",
+                        "value": "",
+                        "readonly": True,
+                        "doc": None,
+                    },
+                    "load_from_base64": {
+                        "full_access_path": "my_image.load_from_base64",
+                        "type": "method",
+                        "value": None,
+                        "readonly": True,
+                        "doc": None,
+                        "async": False,
+                        "signature": {
+                            "parameters": {
+                                "value_": {
+                                    "annotation": "<class 'bytes'>",
+                                    "default": {},
+                                },
+                                "format_": {
+                                    "annotation": "str | None",
+                                    "default": {
+                                        "type": "NoneType",
+                                        "value": None,
+                                        "readonly": False,
+                                        "doc": None,
+                                    },
+                                },
+                            },
+                            "return_annotation": {},
+                        },
+                        "frontend_render": False,
+                    },
+                    "load_from_matplotlib_figure": {
+                        "full_access_path": "my_image.load_from_matplotlib_figure",
+                        "type": "method",
+                        "value": None,
+                        "readonly": True,
+                        "doc": None,
+                        "async": False,
+                        "signature": {
+                            "parameters": {
+                                "fig": {"annotation": "Figure", "default": {}},
+                                "format_": {
+                                    "annotation": "<class 'str'>",
+                                    "default": {
+                                        "type": "str",
+                                        "value": "png",
+                                        "readonly": False,
+                                        "doc": None,
+                                    },
+                                },
+                            },
+                            "return_annotation": {},
+                        },
+                        "frontend_render": False,
+                    },
+                    "load_from_path": {
+                        "full_access_path": "my_image.load_from_path",
+                        "type": "method",
+                        "value": None,
+                        "readonly": True,
+                        "doc": None,
+                        "async": False,
+                        "signature": {
+                            "parameters": {
+                                "path": {
+                                    "annotation": "pathlib.Path | str",
+                                    "default": {},
+                                }
+                            },
+                            "return_annotation": {},
+                        },
+                        "frontend_render": False,
+                    },
+                    "load_from_url": {
+                        "full_access_path": "my_image.load_from_url",
+                        "type": "method",
+                        "value": None,
+                        "readonly": True,
+                        "doc": None,
+                        "async": False,
+                        "signature": {
+                            "parameters": {
+                                "url": {"annotation": "<class 'str'>", "default": {}}
+                            },
+                            "return_annotation": {},
+                        },
+                        "frontend_render": False,
+                    },
+                    "value": {
+                        "full_access_path": "my_image.value",
+                        "type": "str",
+                        "value": "",
+                        "readonly": True,
+                        "doc": None,
+                    },
+                },
+                "readonly": False,
+                "doc": None,
+            }
+        },
+        "readonly": False,
+        "doc": None,
+    }

tests/components/test_number_slider.py

@@ -1,14 +1,13 @@
 import logging
 from collections.abc import Callable
 
+import pytest
 from pydase.components.number_slider import NumberSlider
 from pydase.data_service.data_service import DataService
 from pydase.data_service.data_service_observer import DataServiceObserver
 from pydase.data_service.state_manager import StateManager
 from pytest import LogCaptureFixture
 
-from tests.utils.test_serializer import pytest
-
 logger = logging.getLogger(__name__)
 
 

tests/data_service/test_data_service.py

@@ -37,8 +37,7 @@ def test_unexpected_type_change_warning(caplog: LogCaptureFixture) -> None:
 
 
 def test_basic_inheritance_warning(caplog: LogCaptureFixture) -> None:
-    class SubService(DataService):
-        ...
+    class SubService(DataService): ...
 
     class SomeEnum(Enum):
         HI = 0
@@ -58,11 +57,9 @@ def test_basic_inheritance_warning(caplog: LogCaptureFixture) -> None:
         def name(self) -> str:
             return self._name
 
-        def some_method(self) -> None:
-            ...
+        def some_method(self) -> None: ...
 
-        async def some_task(self) -> None:
-            ...
+        async def some_task(self) -> None: ...
 
     ServiceClass()
 
@@ -135,3 +132,15 @@ def test_exposing_methods() -> None:
             @frontend
             def some_method(self, *args: Any) -> str:
                 return "some method"
+
+
+def test_dynamically_added_attribute(caplog: LogCaptureFixture) -> None:
+    class MyService(DataService):
+        pass
+
+    service_instance = MyService()
+    pydase.Server(service_instance)
+
+    service_instance.dynamically_added_attr = 1.0
+
+    assert ("'dynamically_added_attr' changed to '1.0'") in caplog.text

tests/data_service/test_state_manager.py

@@ -240,8 +240,8 @@ def test_load_state(tmp_path: Path, caplog: LogCaptureFixture) -> None:
         "Ignoring value from JSON file..."
     ) in caplog.text
     assert (
-        "Attribute type of 'removed_attr' changed from 'str' to 'None'. "
-        "Ignoring value from JSON file..." in caplog.text
+        "Path 'removed_attr' could not be loaded. It does not correspond to an "
+        "attribute of the class. Ignoring value from JSON file..." in caplog.text
     )
     assert "Value of attribute 'subservice.name' has not changed..." in caplog.text
     assert "'my_slider.value' changed to '1.0'" in caplog.text

tests/observer_pattern/observer/test_property_observer.py

@@ -0,0 +1,21 @@
+from typing import Any
+
+from pydase.observer_pattern.observable.observable import Observable
+from pydase.observer_pattern.observer.property_observer import PropertyObserver
+
+
+def test_inherited_property_dependency_resolution() -> None:
+    class BaseObservable(Observable):
+        _name = "BaseObservable"
+
+        @property
+        def name(self) -> str:
+            return self._name
+
+    class DerivedObservable(BaseObservable):
+        _name = "DerivedObservable"
+
+    class MyObserver(PropertyObserver):
+        def on_change(self, full_access_path: str, value: Any) -> None: ...
+
+    assert MyObserver(DerivedObservable()).property_deps_dict == {"_name": ["name"]}

tests/server/web_server/test_sio_setup.py

@@ -1,68 +0,0 @@
-import asyncio
-import logging
-
-import pydase
-import pytest
-from pydase.data_service.data_service_observer import DataServiceObserver
-from pydase.data_service.state_manager import StateManager
-from pydase.server.web_server.sio_setup import (
-    RunMethodDict,
-    UpdateDict,
-    setup_sio_server,
-)
-
-logger = logging.getLogger(__name__)
-
-
-@pytest.mark.asyncio
-async def test_set_attribute_event() -> None:
-    class SubClass(pydase.DataService):
-        name = "SubClass"
-
-    class ServiceClass(pydase.DataService):
-        def __init__(self) -> None:
-            super().__init__()
-            self.sub_class = SubClass()
-
-        def some_method(self) -> None:
-            logger.info("Triggered 'test_method'.")
-
-    service_instance = ServiceClass()
-    state_manager = StateManager(service_instance)
-    observer = DataServiceObserver(state_manager)
-
-    server = setup_sio_server(observer, False, asyncio.get_running_loop())
-
-    test_sid = 1234
-    test_data: UpdateDict = {
-        "parent_path": "sub_class",
-        "name": "name",
-        "value": "new name",
-    }
-
-    server.handlers["/"]["set_attribute"](test_sid, test_data)
-
-    assert service_instance.sub_class.name == "new name"
-
-
-@pytest.mark.asyncio
-async def test_run_method_event(caplog: pytest.LogCaptureFixture):
-    class ServiceClass(pydase.DataService):
-        def test_method(self) -> None:
-            logger.info("Triggered 'test_method'.")
-
-    state_manager = StateManager(ServiceClass())
-    observer = DataServiceObserver(state_manager)
-
-    server = setup_sio_server(observer, False, asyncio.get_running_loop())
-
-    test_sid = 1234
-    test_data: RunMethodDict = {
-        "parent_path": "",
-        "name": "test_method",
-        "kwargs": {},
-    }
-
-    server.handlers["/"]["run_method"](test_sid, test_data)
-
-    assert "Triggered 'test_method'." in caplog.text

tests/server/web_server/test_web_server.py

@@ -26,8 +26,8 @@ def test_web_settings() -> None:
     observer = DataServiceObserver(state_manager)
     with tempfile.TemporaryDirectory() as tmp:
         web_settings = {
-            "attr_1": {"displayName": "Attribute"},
-            "attr_1.name": {"displayName": "Attribute name"},
+            "attr_1": {"displayName": "Attribute", "display": False},
+            "attr_1.name": {"displayName": "Attribute name", "display": True},
         }
         web_settings_file = Path(tmp) / "web_settings.json"
 
@@ -44,8 +44,11 @@ def test_web_settings() -> None:
         new_web_settings = server.web_settings
 
         # existing entries are not overwritten, new entries are appended
-        assert new_web_settings == {**web_settings, "added": {"displayName": "added"}}
+        assert new_web_settings == {
+            **web_settings,
+            "added": {"displayName": "added", "display": True},
+        }
         assert json.loads(web_settings_file.read_text()) == {
             **web_settings,
-            "added": {"displayName": "added"},
+            "added": {"displayName": "added", "display": True},
         }

tests/test_units.py

@@ -5,6 +5,7 @@ import pydase.units as u
 from pydase.data_service.data_service import DataService
 from pydase.data_service.data_service_observer import DataServiceObserver
 from pydase.data_service.state_manager import StateManager, load_state
+from pydase.utils.serialization.serializer import dump
 from pytest import LogCaptureFixture
 
 
@@ -70,21 +71,11 @@ def test_set_service_attribute_value_by_path(caplog: LogCaptureFixture) -> None:
     DataServiceObserver(state_manager)
 
     state_manager.set_service_attribute_value_by_path(
-        path="voltage", value=1.0 * u.units.mV
+        path="voltage", serialized_value=dump(1.0 * u.units.mV)
     )
     assert "'voltage' changed to '1.0 mV'" in caplog.text
     caplog.clear()
 
-    state_manager.set_service_attribute_value_by_path(path="voltage", value=2)
-
-    assert "'voltage' changed to '2.0 mV'" in caplog.text
-    caplog.clear()
-
-    state_manager.set_service_attribute_value_by_path(
-        path="voltage", value={"magnitude": 123, "unit": "kV"}
-    )
-    assert "'voltage' changed to '123.0 kV'" in caplog.text
-
 
 def test_autoconvert_offset_to_baseunit() -> None:
     import pint

tests/utils/serialization/test_deserializer.py

@@ -0,0 +1,143 @@
+import enum
+from typing import Any
+
+import pydase.components
+import pydase.units as u
+import pytest
+from pydase.utils.serialization.deserializer import loads
+from pydase.utils.serialization.serializer import dump
+from pydase.utils.serialization.types import SerializedObject
+
+
+class MyEnum(enum.Enum):
+    FINISHED = "finished"
+    RUNNING = "running"
+
+
+class MyService(pydase.DataService):
+    name = "MyService"
+
+
+@pytest.mark.parametrize(
+    "obj, obj_serialization",
+    [
+        (
+            1,
+            {
+                "full_access_path": "",
+                "type": "int",
+                "value": 1,
+                "readonly": False,
+                "doc": None,
+            },
+        ),
+        (
+            1.0,
+            {
+                "full_access_path": "",
+                "type": "float",
+                "value": 1.0,
+                "readonly": False,
+                "doc": None,
+            },
+        ),
+        (
+            True,
+            {
+                "full_access_path": "",
+                "type": "bool",
+                "value": True,
+                "readonly": False,
+                "doc": None,
+            },
+        ),
+        (
+            u.Quantity(10, "m"),
+            {
+                "full_access_path": "",
+                "type": "Quantity",
+                "value": {"magnitude": 10, "unit": "meter"},
+                "readonly": False,
+                "doc": None,
+            },
+        ),
+        (
+            [1.0],
+            {
+                "full_access_path": "",
+                "value": [
+                    {
+                        "full_access_path": "[0]",
+                        "doc": None,
+                        "readonly": False,
+                        "type": "float",
+                        "value": 1.0,
+                    }
+                ],
+                "type": "list",
+                "doc": None,
+                "readonly": False,
+            },
+        ),
+        (
+            {"key": 1.0},
+            {
+                "full_access_path": "",
+                "value": {
+                    "key": {
+                        "full_access_path": '["key"]',
+                        "doc": None,
+                        "readonly": False,
+                        "type": "float",
+                        "value": 1.0,
+                    }
+                },
+                "type": "dict",
+                "doc": None,
+                "readonly": False,
+            },
+        ),
+    ],
+)
+def test_loads_primitive_types(obj: Any, obj_serialization: SerializedObject) -> None:
+    assert loads(obj_serialization) == obj
+
+
+@pytest.mark.parametrize(
+    "obj, obj_serialization",
+    [
+        (
+            MyEnum.RUNNING,
+            {
+                "full_access_path": "",
+                "value": "RUNNING",
+                "type": "Enum",
+                "doc": "MyEnum description",
+                "readonly": False,
+                "name": "MyEnum",
+                "enum": {"RUNNING": "running", "FINISHED": "finished"},
+            },
+        ),
+        (
+            MyService(),
+            {
+                "full_access_path": "",
+                "value": {
+                    "name": {
+                        "full_access_path": "name",
+                        "doc": None,
+                        "readonly": False,
+                        "type": "str",
+                        "value": "MyService",
+                    }
+                },
+                "type": "DataService",
+                "doc": None,
+                "readonly": False,
+                "name": "MyService",
+            },
+        ),
+    ],
+)
+def test_loads_advanced_types(obj: Any, obj_serialization: SerializedObject) -> None:
+    assert dump(loads(obj_serialization)) == dump(obj)

tests/utils/serialization/test_serializer.py

@@ -1,4 +1,5 @@
 import asyncio
+import enum
 from enum import Enum
 from typing import Any
 
@@ -8,8 +9,9 @@ import pytest
 from pydase.components.coloured_enum import ColouredEnum
 from pydase.data_service.task_manager import TaskStatus
 from pydase.utils.decorators import frontend
-from pydase.utils.serializer import (
+from pydase.utils.serialization.serializer import (
     SerializationPathError,
+    SerializedObject,
     dump,
     get_nested_dict_by_path,
     get_next_level_dict_by_key,
@@ -18,15 +20,50 @@ from pydase.utils.serializer import (
 )
 
 
+class MyEnum(enum.Enum):
+    """MyEnum description"""
+
+    RUNNING = "running"
+    FINISHED = "finished"
+
+
 @pytest.mark.parametrize(
     "test_input, expected",
     [
-        (1, {"type": "int", "value": 1, "readonly": False, "doc": None}),
-        (1.0, {"type": "float", "value": 1.0, "readonly": False, "doc": None}),
-        (True, {"type": "bool", "value": True, "readonly": False, "doc": None}),
+        (
+            1,
+            {
+                "full_access_path": "",
+                "type": "int",
+                "value": 1,
+                "readonly": False,
+                "doc": None,
+            },
+        ),
+        (
+            1.0,
+            {
+                "full_access_path": "",
+                "type": "float",
+                "value": 1.0,
+                "readonly": False,
+                "doc": None,
+            },
+        ),
+        (
+            True,
+            {
+                "full_access_path": "",
+                "type": "bool",
+                "value": True,
+                "readonly": False,
+                "doc": None,
+            },
+        ),
         (
             u.Quantity(10, "m"),
             {
+                "full_access_path": "",
                 "type": "Quantity",
                 "value": {"magnitude": 10, "unit": "meter"},
                 "readonly": False,
@@ -73,7 +110,9 @@ def test_enum_serialize() -> None:
 
     assert dump(EnumAttribute())["value"] == {
         "some_enum": {
+            "full_access_path": "some_enum",
             "type": "Enum",
+            "name": "EnumClass",
             "value": "FOO",
             "enum": {"FOO": "foo", "BAR": "bar"},
             "readonly": False,
@@ -82,7 +121,9 @@ def test_enum_serialize() -> None:
     }
     assert dump(EnumPropertyWithoutSetter())["value"] == {
         "some_enum": {
+            "full_access_path": "some_enum",
             "type": "Enum",
+            "name": "EnumClass",
             "value": "FOO",
             "enum": {"FOO": "foo", "BAR": "bar"},
             "readonly": True,
@@ -91,7 +132,9 @@ def test_enum_serialize() -> None:
     }
     assert dump(EnumPropertyWithSetter())["value"] == {
         "some_enum": {
+            "full_access_path": "some_enum",
             "type": "Enum",
+            "name": "EnumClass",
             "value": "FOO",
             "enum": {"FOO": "foo", "BAR": "bar"},
             "readonly": False,
@@ -113,7 +156,9 @@ def test_ColouredEnum_serialize() -> None:
         CANCELLED = "SlateGray"
 
     assert dump(Status.FAILED) == {
+        "full_access_path": "",
         "type": "ColouredEnum",
+        "name": "Status",
         "value": "FAILED",
         "enum": {
             "CANCELLED": "SlateGray",
@@ -144,6 +189,7 @@ async def test_method_serialization() -> None:
 
     assert dump(instance)["value"] == {
         "some_method": {
+            "full_access_path": "some_method",
             "type": "method",
             "value": None,
             "readonly": True,
@@ -153,6 +199,7 @@ async def test_method_serialization() -> None:
             "frontend_render": False,
         },
         "some_task": {
+            "full_access_path": "some_task",
             "type": "method",
             "value": TaskStatus.RUNNING.name,
             "readonly": True,
@@ -178,6 +225,7 @@ def test_methods_with_type_hints() -> None:
         pass
 
     assert dump(method_without_type_hint) == {
+        "full_access_path": "",
         "async": False,
         "doc": None,
         "signature": {
@@ -196,6 +244,7 @@ def test_methods_with_type_hints() -> None:
     }
 
     assert dump(method_with_type_hint) == {
+        "full_access_path": "",
         "type": "method",
         "value": None,
         "readonly": True,
@@ -210,6 +259,7 @@ def test_methods_with_type_hints() -> None:
         "frontend_render": False,
     }
     assert dump(method_with_union_type_hint) == {
+        "full_access_path": "",
         "type": "method",
         "value": None,
         "readonly": True,
@@ -236,6 +286,7 @@ def test_exposed_function_serialization() -> None:
         pass
 
     assert dump(MyService().some_method) == {
+        "full_access_path": "",
         "type": "method",
         "value": None,
         "readonly": True,
@@ -246,6 +297,7 @@ def test_exposed_function_serialization() -> None:
     }
 
     assert dump(some_function) == {
+        "full_access_path": "",
         "type": "method",
         "value": None,
         "readonly": True,
@@ -273,30 +325,41 @@ def test_list_serialization() -> None:
 
     assert dump(instance)["value"] == {
         "list_attr": {
+            "full_access_path": "list_attr",
             "doc": None,
             "readonly": False,
             "type": "list",
             "value": [
-                {"doc": None, "readonly": False, "type": "int", "value": 1},
                 {
+                    "full_access_path": "list_attr[0]",
+                    "doc": None,
+                    "readonly": False,
+                    "type": "int",
+                    "value": 1,
+                },
+                {
+                    "full_access_path": "list_attr[1]",
                     "doc": None,
                     "readonly": False,
                     "type": "DataService",
                     "name": "MySubclass",
                     "value": {
                         "bool_attr": {
+                            "full_access_path": "list_attr[1].bool_attr",
                             "doc": None,
                             "readonly": False,
                             "type": "bool",
                             "value": True,
                         },
                         "int_attr": {
+                            "full_access_path": "list_attr[1].int_attr",
                             "doc": None,
                             "readonly": False,
                             "type": "int",
                             "value": 1,
                         },
                         "name": {
+                            "full_access_path": "list_attr[1].name",
                             "doc": None,
                             "readonly": True,
                             "type": "str",
@@ -322,17 +385,20 @@ def test_dict_serialization() -> None:
     }
 
     assert dump(test_dict) == {
+        "full_access_path": "",
         "doc": None,
         "readonly": False,
         "type": "dict",
         "value": {
             "DataService_key": {
+                "full_access_path": '["DataService_key"]',
                 "name": "MyClass",
                 "doc": None,
                 "readonly": False,
                 "type": "DataService",
                 "value": {
                     "name": {
+                        "full_access_path": '["DataService_key"].name',
                         "doc": None,
                         "readonly": False,
                         "type": "str",
@@ -341,19 +407,33 @@ def test_dict_serialization() -> None:
                 },
             },
             "Quantity_key": {
+                "full_access_path": '["Quantity_key"]',
                 "doc": None,
                 "readonly": False,
                 "type": "Quantity",
                 "value": {"magnitude": 1.0, "unit": "s"},
             },
-            "bool_key": {"doc": None, "readonly": False, "type": "bool", "value": True},
+            "bool_key": {
+                "full_access_path": '["bool_key"]',
+                "doc": None,
+                "readonly": False,
+                "type": "bool",
+                "value": True,
+            },
             "float_key": {
+                "full_access_path": '["float_key"]',
                 "doc": None,
                 "readonly": False,
                 "type": "float",
                 "value": 1.0,
             },
-            "int_key": {"doc": None, "readonly": False, "type": "int", "value": 1},
+            "int_key": {
+                "full_access_path": '["int_key"]',
+                "doc": None,
+                "readonly": False,
+                "type": "int",
+                "value": 1,
+            },
         },
     }
 
@@ -374,8 +454,7 @@ def test_derived_data_service_serialization() -> None:
         def name(self, value: str) -> None:
             self._name = value
 
-    class DerivedService(BaseService):
-        ...
+    class DerivedService(BaseService): ...
 
     base_service_serialization = dump(BaseService())
     derived_service_serialization = dump(DerivedService())
@@ -396,33 +475,93 @@ def setup_dict() -> dict[str, Any]:
     class ServiceClass(pydase.DataService):
         attr1 = 1.0
         attr2 = MySubclass()
+        enum_attr = MyEnum.RUNNING
         attr_list = [0, 1, MySubclass()]
 
-    return ServiceClass().serialize()["value"]
+        def my_task(self) -> None:
+            pass
+
+    return ServiceClass().serialize()["value"]  # type: ignore
 
 
-def test_update_attribute(setup_dict) -> None:
+def test_update_attribute(setup_dict: dict[str, Any]) -> None:
     set_nested_value_by_path(setup_dict, "attr1", 15)
     assert setup_dict["attr1"]["value"] == 15
 
 
-def test_update_nested_attribute(setup_dict) -> None:
+def test_update_nested_attribute(setup_dict: dict[str, Any]) -> None:
     set_nested_value_by_path(setup_dict, "attr2.attr3", 25.0)
     assert setup_dict["attr2"]["value"]["attr3"]["value"] == 25.0
 
 
-def test_update_list_entry(setup_dict) -> None:
+def test_update_float_attribute_to_enum(setup_dict: dict[str, Any]) -> None:
+    set_nested_value_by_path(setup_dict, "attr2.attr3", MyEnum.RUNNING)
+    assert setup_dict["attr2"]["value"]["attr3"] == {
+        "full_access_path": "attr2.attr3",
+        "name": "MyEnum",
+        "doc": "MyEnum description",
+        "enum": {"FINISHED": "finished", "RUNNING": "running"},
+        "readonly": False,
+        "type": "Enum",
+        "value": "RUNNING",
+    }
+
+
+def test_update_enum_attribute_to_float(setup_dict: dict[str, Any]) -> None:
+    set_nested_value_by_path(setup_dict, "enum_attr", 1.01)
+    assert setup_dict["enum_attr"] == {
+        "full_access_path": "enum_attr",
+        "doc": None,
+        "readonly": False,
+        "type": "float",
+        "value": 1.01,
+    }
+
+
+def test_update_task_state(setup_dict: dict[str, Any]) -> None:
+    assert setup_dict["my_task"] == {
+        "full_access_path": "my_task",
+        "async": False,
+        "doc": None,
+        "frontend_render": False,
+        "readonly": True,
+        "signature": {"parameters": {}, "return_annotation": {}},
+        "type": "method",
+        "value": None,
+    }
+    set_nested_value_by_path(setup_dict, "my_task", TaskStatus.RUNNING)
+    assert setup_dict["my_task"] == {
+        "full_access_path": "my_task",
+        "async": False,
+        "doc": None,
+        "frontend_render": False,
+        "readonly": True,
+        "signature": {"parameters": {}, "return_annotation": {}},
+        "type": "method",
+        "value": "RUNNING",
+    }
+
+
+def test_update_list_entry(setup_dict: dict[str, SerializedObject]) -> None:
     set_nested_value_by_path(setup_dict, "attr_list[1]", 20)
-    assert setup_dict["attr_list"]["value"][1]["value"] == 20
+    assert setup_dict["attr_list"]["value"][1]["value"] == 20  # type: ignore # noqa
 
 
-def test_update_list_append(setup_dict) -> None:
-    set_nested_value_by_path(setup_dict, "attr_list[3]", 20)
-    assert setup_dict["attr_list"]["value"][3]["value"] == 20
+def test_update_list_append(setup_dict: dict[str, SerializedObject]) -> None:
+    set_nested_value_by_path(setup_dict, "attr_list[3]", MyEnum.RUNNING)
+    assert setup_dict["attr_list"]["value"][3] == {  # type: ignore
+        "full_access_path": "attr_list[3]",
+        "doc": "MyEnum description",
+        "name": "MyEnum",
+        "enum": {"FINISHED": "finished", "RUNNING": "running"},
+        "readonly": False,
+        "type": "Enum",
+        "value": "RUNNING",
+    }
 
 
 def test_update_invalid_list_index(
-    setup_dict, caplog: pytest.LogCaptureFixture
+    setup_dict: dict[str, Any], caplog: pytest.LogCaptureFixture
 ) -> None:
     set_nested_value_by_path(setup_dict, "attr_list[10]", 30)
     assert (
@@ -431,25 +570,14 @@ def test_update_invalid_list_index(
     )
 
 
-def test_update_invalid_path(
-    setup_dict: dict[str, Any], caplog: pytest.LogCaptureFixture
-) -> None:
-    set_nested_value_by_path(setup_dict, "invalid_path", 30)
-    assert (
-        "Error occured trying to access the key 'invalid_path': it is either "
-        "not present in the current dictionary or its value does not contain "
-        "a 'value' key." in caplog.text
-    )
-
-
 def test_update_list_inside_class(setup_dict: dict[str, Any]) -> None:
     set_nested_value_by_path(setup_dict, "attr2.list_attr[1]", 40)
-    assert setup_dict["attr2"]["value"]["list_attr"]["value"][1]["value"] == 40
+    assert setup_dict["attr2"]["value"]["list_attr"]["value"][1]["value"] == 40  # noqa
 
 
 def test_update_class_attribute_inside_list(setup_dict: dict[str, Any]) -> None:
     set_nested_value_by_path(setup_dict, "attr_list[2].attr3", 50)
-    assert setup_dict["attr_list"]["value"][2]["value"]["attr3"]["value"] == 50
+    assert setup_dict["attr_list"]["value"][2]["value"]["attr3"]["value"] == 50  # noqa
 
 
 def test_get_next_level_attribute_nested_dict(setup_dict: dict[str, Any]) -> None:
@@ -604,3 +732,142 @@ def test_serialized_dict_is_nested_object() -> None:
     assert not serialized_dict_is_nested_object(serialized_dict["unit"])
     assert not serialized_dict_is_nested_object(serialized_dict["float"])
     assert not serialized_dict_is_nested_object(serialized_dict["state"])
+
+
+class MyService(pydase.DataService):
+    name = "MyService"
+
+
+@pytest.mark.parametrize(
+    "test_input, expected",
+    [
+        (
+            1,
+            {
+                "new_attr": {
+                    "full_access_path": "new_attr",
+                    "type": "int",
+                    "value": 1,
+                    "readonly": False,
+                    "doc": None,
+                }
+            },
+        ),
+        (
+            1.0,
+            {
+                "new_attr": {
+                    "full_access_path": "new_attr",
+                    "type": "float",
+                    "value": 1.0,
+                    "readonly": False,
+                    "doc": None,
+                },
+            },
+        ),
+        (
+            True,
+            {
+                "new_attr": {
+                    "full_access_path": "new_attr",
+                    "type": "bool",
+                    "value": True,
+                    "readonly": False,
+                    "doc": None,
+                },
+            },
+        ),
+        (
+            u.Quantity(10, "m"),
+            {
+                "new_attr": {
+                    "full_access_path": "new_attr",
+                    "type": "Quantity",
+                    "value": {"magnitude": 10, "unit": "meter"},
+                    "readonly": False,
+                    "doc": None,
+                },
+            },
+        ),
+        (
+            MyEnum.RUNNING,
+            {
+                "new_attr": {
+                    "full_access_path": "new_attr",
+                    "value": "RUNNING",
+                    "type": "Enum",
+                    "doc": "MyEnum description",
+                    "readonly": False,
+                    "name": "MyEnum",
+                    "enum": {"RUNNING": "running", "FINISHED": "finished"},
+                }
+            },
+        ),
+        (
+            [1.0],
+            {
+                "new_attr": {
+                    "full_access_path": "new_attr",
+                    "value": [
+                        {
+                            "full_access_path": "new_attr[0]",
+                            "doc": None,
+                            "readonly": False,
+                            "type": "float",
+                            "value": 1.0,
+                        }
+                    ],
+                    "type": "list",
+                    "doc": None,
+                    "readonly": False,
+                }
+            },
+        ),
+        (
+            {"key": 1.0},
+            {
+                "new_attr": {
+                    "full_access_path": "new_attr",
+                    "value": {
+                        "key": {
+                            "full_access_path": 'new_attr["key"]',
+                            "doc": None,
+                            "readonly": False,
+                            "type": "float",
+                            "value": 1.0,
+                        }
+                    },
+                    "type": "dict",
+                    "doc": None,
+                    "readonly": False,
+                }
+            },
+        ),
+        (
+            MyService(),
+            {
+                "new_attr": {
+                    "full_access_path": "new_attr",
+                    "value": {
+                        "name": {
+                            "full_access_path": "new_attr.name",
+                            "doc": None,
+                            "readonly": False,
+                            "type": "str",
+                            "value": "MyService",
+                        }
+                    },
+                    "type": "DataService",
+                    "doc": None,
+                    "readonly": False,
+                    "name": "MyService",
+                }
+            },
+        ),
+    ],
+)
+def test_dynamically_add_attributes(test_input: Any, expected: dict[str, Any]) -> None:
+    serialized_object: dict[str, SerializedObject] = {}
+
+    set_nested_value_by_path(serialized_object, "new_attr", test_input)
+    assert serialized_object == expected