wandelbots_api_client 26.3.0.dev29__py3-none-any.whl

wandelbots_api_client/models/motion_command_path.py

@@ -0,0 +1,221 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 1.4.0 dev
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+import json
+import pprint
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator
+from typing import Any, List, Optional
+from wandelbots_api_client.models.path_cartesian_ptp import PathCartesianPTP
+from wandelbots_api_client.models.path_circle import PathCircle
+from wandelbots_api_client.models.path_cubic_spline import PathCubicSpline
+from wandelbots_api_client.models.path_joint_ptp import PathJointPTP
+from wandelbots_api_client.models.path_line import PathLine
+from pydantic import StrictStr, Field
+from typing import Union, List, Set, Optional, Dict
+from typing_extensions import Literal, Self
+
+MOTIONCOMMANDPATH_ONE_OF_SCHEMAS = ["PathCartesianPTP", "PathCircle", "PathCubicSpline", "PathJointPTP", "PathLine"]
+
+
+class MotionCommandPath(BaseModel):
+    """
+    MotionCommandPath
+    """
+
+    # data type: PathCartesianPTP
+    oneof_schema_1_validator: Optional[PathCartesianPTP] = None
+    # data type: PathCubicSpline
+    oneof_schema_2_validator: Optional[PathCubicSpline] = None
+    # data type: PathLine
+    oneof_schema_3_validator: Optional[PathLine] = None
+    # data type: PathCircle
+    oneof_schema_4_validator: Optional[PathCircle] = None
+    # data type: PathJointPTP
+    oneof_schema_5_validator: Optional[PathJointPTP] = None
+    actual_instance: Optional[Union[PathCartesianPTP, PathCircle, PathCubicSpline, PathJointPTP, PathLine]] = None
+    one_of_schemas: Set[str] = {"PathCartesianPTP", "PathCircle", "PathCubicSpline", "PathJointPTP", "PathLine"}
+
+    model_config = ConfigDict(
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    discriminator_value_class_map: Dict[str, str] = {}
+
+    def __init__(self, *args, **kwargs) -> None:
+        if args:
+            if len(args) > 1:
+                raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
+            if kwargs:
+                raise ValueError("If a position argument is used, keyword arguments cannot be used.")
+            super().__init__(actual_instance=args[0])
+        else:
+            super().__init__(**kwargs)
+
+    @field_validator("actual_instance")
+    def actual_instance_must_validate_oneof(cls, v):
+        instance = MotionCommandPath.model_construct()
+        error_messages = []
+        match = 0
+        # validate data type: PathCartesianPTP
+        if not isinstance(v, PathCartesianPTP):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `PathCartesianPTP`")
+        else:
+            match += 1
+        # validate data type: PathCubicSpline
+        if not isinstance(v, PathCubicSpline):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `PathCubicSpline`")
+        else:
+            match += 1
+        # validate data type: PathLine
+        if not isinstance(v, PathLine):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `PathLine`")
+        else:
+            match += 1
+        # validate data type: PathCircle
+        if not isinstance(v, PathCircle):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `PathCircle`")
+        else:
+            match += 1
+        # validate data type: PathJointPTP
+        if not isinstance(v, PathJointPTP):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `PathJointPTP`")
+        else:
+            match += 1
+        if match > 1:
+            # more than 1 match
+            raise ValueError(
+                "Multiple matches found when setting `actual_instance` in MotionCommandPath with oneOf schemas: PathCartesianPTP, PathCircle, PathCubicSpline, PathJointPTP, PathLine. Details: "
+                + ", ".join(error_messages)
+            )
+        elif match == 0:
+            # no match
+            raise ValueError(
+                "No match found when setting `actual_instance` in MotionCommandPath with oneOf schemas: PathCartesianPTP, PathCircle, PathCubicSpline, PathJointPTP, PathLine. Details: "
+                + ", ".join(error_messages)
+            )
+        else:
+            return v
+
+    @classmethod
+    def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self:
+        return cls.from_json(json.dumps(obj))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Returns the object represented by the json string"""
+        instance = cls.model_construct()
+        error_messages = []
+        match = 0
+
+        # use oneOf discriminator to lookup the data type
+        _data_type = json.loads(json_str).get("path_definition_name")
+        if not _data_type:
+            raise ValueError("Failed to lookup data type from the field `path_definition_name` in the input.")
+
+        # check if data type is `PathCartesianPTP`
+        if _data_type == "PathCartesianPTP":
+            instance.actual_instance = PathCartesianPTP.from_json(json_str)
+            return instance
+
+        # check if data type is `PathCircle`
+        if _data_type == "PathCircle":
+            instance.actual_instance = PathCircle.from_json(json_str)
+            return instance
+
+        # check if data type is `PathCubicSpline`
+        if _data_type == "PathCubicSpline":
+            instance.actual_instance = PathCubicSpline.from_json(json_str)
+            return instance
+
+        # check if data type is `PathJointPTP`
+        if _data_type == "PathJointPTP":
+            instance.actual_instance = PathJointPTP.from_json(json_str)
+            return instance
+
+        # check if data type is `PathLine`
+        if _data_type == "PathLine":
+            instance.actual_instance = PathLine.from_json(json_str)
+            return instance
+
+        # deserialize data into PathCartesianPTP
+        try:
+            instance.actual_instance = PathCartesianPTP.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into PathCubicSpline
+        try:
+            instance.actual_instance = PathCubicSpline.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into PathLine
+        try:
+            instance.actual_instance = PathLine.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into PathCircle
+        try:
+            instance.actual_instance = PathCircle.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into PathJointPTP
+        try:
+            instance.actual_instance = PathJointPTP.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+
+        if match > 1:
+            # more than 1 match
+            raise ValueError(
+                "Multiple matches found when deserializing the JSON string into MotionCommandPath with oneOf schemas: PathCartesianPTP, PathCircle, PathCubicSpline, PathJointPTP, PathLine. Details: "
+                + ", ".join(error_messages)
+            )
+        elif match == 0:
+            # no match
+            raise ValueError(
+                "No match found when deserializing the JSON string into MotionCommandPath with oneOf schemas: PathCartesianPTP, PathCircle, PathCubicSpline, PathJointPTP, PathLine. Details: "
+                + ", ".join(error_messages)
+            )
+        else:
+            return instance
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json):
+            return self.actual_instance.to_json()
+        else:
+            return json.dumps(self.actual_instance)
+
+    def to_dict(self) -> Optional[Union[Dict[str, Any], PathCartesianPTP, PathCircle, PathCubicSpline, PathJointPTP, PathLine]]:
+        """Returns the dict representation of the actual instance"""
+        if self.actual_instance is None:
+            return None
+
+        if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict):
+            return self.actual_instance.to_dict()
+        else:
+            # primitive type
+            return self.actual_instance
+
+    def to_str(self) -> str:
+        """Returns the string representation of the actual instance"""
+        return pprint.pformat(self.model_dump())

wandelbots_api_client/models/motion_group_behavior_getter.py

@@ -0,0 +1,87 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 1.4.0 dev
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict
+from typing import Any, ClassVar, Dict, List
+from wandelbots_api_client.models.behavior import Behavior
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class MotionGroupBehaviorGetter(BaseModel):
+    """
+    MotionGroupBehaviorGetter
+    """  # noqa: E501
+
+    behavior: Behavior
+    __properties: ClassVar[List[str]] = ["behavior"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True, exclude_none=True))
+
+    def to_json(self) -> str:
+        """
+        Returns the JSON representation of the model using alias
+
+        Do not use pydantic v2 .model_dump_json(by_alias=True, exclude_unset=True) here!
+        It is unable to resolve nested types generated by openapi-generator.
+        """
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of MotionGroupBehaviorGetter from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of MotionGroupBehaviorGetter from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"behavior": obj.get("behavior")})
+        return _obj

wandelbots_api_client/models/motion_group_info.py

@@ -0,0 +1,88 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 1.4.0 dev
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class MotionGroupInfo(BaseModel):
+    """
+    MotionGroupInfo
+    """  # noqa: E501
+
+    id: StrictInt = Field(description="The unique identifier of the motion group. Use it to refer to the motion group in other calls. ")
+    name: StrictStr = Field(description="The name of the motion group for display purposes. ")
+    dof: StrictInt = Field(description="The number of joints aka degrees of freedom in the motion group. ")
+    __properties: ClassVar[List[str]] = ["id", "name", "dof"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True, exclude_none=True))
+
+    def to_json(self) -> str:
+        """
+        Returns the JSON representation of the model using alias
+
+        Do not use pydantic v2 .model_dump_json(by_alias=True, exclude_unset=True) here!
+        It is unable to resolve nested types generated by openapi-generator.
+        """
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of MotionGroupInfo from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of MotionGroupInfo from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"id": obj.get("id"), "name": obj.get("name"), "dof": obj.get("dof")})
+        return _obj

wandelbots_api_client/models/motion_group_infos.py

@@ -0,0 +1,109 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 1.4.0 dev
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict
+from typing import Any, ClassVar, Dict, List
+from wandelbots_api_client.models.motion_group_info import MotionGroupInfo
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class MotionGroupInfos(BaseModel):
+    """
+    MotionGroupInfos
+    """  # noqa: E501
+
+    motiongroups: List[MotionGroupInfo]
+    __properties: ClassVar[List[str]] = ["motiongroups"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True, exclude_none=True))
+
+    def to_json(self) -> str:
+        """
+        Returns the JSON representation of the model using alias
+
+        Do not use pydantic v2 .model_dump_json(by_alias=True, exclude_unset=True) here!
+        It is unable to resolve nested types generated by openapi-generator.
+        """
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of MotionGroupInfos from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in motiongroups (list)
+        _items = []
+        if self.motiongroups:
+            for _item in self.motiongroups:
+                # >>> Modified from https://github.com/OpenAPITools/openapi-generator/blob/v7.6.0/modules/openapi-generator/src/main/resources/python/model_generic.mustache
+                #     to not drop empty elements in lists
+                if _item is not None:
+                    _items.append(_item.to_dict())
+                # <<< End modification
+            _dict["motiongroups"] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of MotionGroupInfos from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "motiongroups": [
+                    # >>> Modified from https://github.com/OpenAPITools/openapi-generator/blob/v7.6.0/modules/openapi-generator/src/main/resources/python/model_generic.mustache
+                    #     to allow dicts in lists
+                    MotionGroupInfo.from_dict(_item) if hasattr(MotionGroupInfo, "from_dict") else _item
+                    # <<< End modification
+                    for _item in obj["motiongroups"]
+                ]
+                if obj.get("motiongroups") is not None
+                else None
+            }
+        )
+        return _obj

wandelbots_api_client/models/motion_group_instance.py

@@ -0,0 +1,101 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 1.4.0 dev
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class MotionGroupInstance(BaseModel):
+    """
+    The data type describes the physically connected motion groups on a robot controller, e.g. a robot arm.
+    """  # noqa: E501
+
+    motion_group: StrictStr = Field(description="Identifier of the motion group.")
+    controller: StrictStr = Field(description="Identifier of the robot controller the motion group is attached to.")
+    name_from_controller: StrictStr = Field(description="The name of the motion group has on the robot controller.")
+    model_from_controller: StrictStr = Field(description="The robot controller model if available. Usable for frontend 3D visualization. ")
+    serial_number: Optional[StrictStr] = Field(
+        default=None,
+        description="The serial number of the motion group if available. If not available, the serial number of the robot controller. if available. If not available, then empty. ",
+    )
+    __properties: ClassVar[List[str]] = ["motion_group", "controller", "name_from_controller", "model_from_controller", "serial_number"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True, exclude_none=True))
+
+    def to_json(self) -> str:
+        """
+        Returns the JSON representation of the model using alias
+
+        Do not use pydantic v2 .model_dump_json(by_alias=True, exclude_unset=True) here!
+        It is unable to resolve nested types generated by openapi-generator.
+        """
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of MotionGroupInstance from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of MotionGroupInstance from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "motion_group": obj.get("motion_group"),
+                "controller": obj.get("controller"),
+                "name_from_controller": obj.get("name_from_controller"),
+                "model_from_controller": obj.get("model_from_controller"),
+                "serial_number": obj.get("serial_number"),
+            }
+        )
+        return _obj