qi-compute-api-client 0.7.0__py3-none-any.whl → 0.17.0__py3-none-any.whl

compute_api_client/models/result.py

@@ -3,376 +3,118 @@
 """
     Quantum Inspire 2
 
-    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)  # noqa: E501
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
     The version of the OpenAPI document: 0.1.0
-    Generated by: https://openapi-generator.tech
-"""
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
 
+    Do not edit the class manually.
+"""  # noqa: E501
 
-try:
-    from inspect import getfullargspec
-except ImportError:
-    from inspect import getargspec as getfullargspec
+
+from __future__ import annotations
 import pprint
 import re  # noqa: F401
-import six
-
-from compute_api_client.configuration import Configuration
-
+import json
 
-class Result(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
-    """
+from datetime import datetime
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from pydantic import BaseModel, StrictFloat, StrictInt
+from pydantic import Field
+from typing_extensions import Annotated
+try:
+    from typing import Self
+except ImportError:
+    from typing_extensions import Self
 
+class Result(BaseModel):
     """
-    Attributes:
-      openapi_types (dict): The key is attribute name
-                            and the value is attribute type.
-      attribute_map (dict): The key is attribute name
-                            and the value is json key in definition.
-    """
-    openapi_types = {
-        'created_on': 'datetime',
-        'id': 'int',
-        'number_of_qubits': 'int',
-        'execution_time_in_seconds': 'float',
-        'shots_requested': 'int',
-        'shots_done': 'int',
-        'results': 'object',
-        'metadata_id': 'int',
-        'run_id': 'int'
+    Result
+    """ # noqa: E501
+    id: StrictInt
+    created_on: datetime
+    job_id: StrictInt
+    metadata_id: StrictInt
+    number_of_qubits: Annotated[int, Field(strict=True, ge=-32768)]
+    execution_time_in_seconds: Union[StrictFloat, StrictInt]
+    shots_requested: Optional[StrictInt]
+    shots_done: Optional[StrictInt]
+    results: Optional[Union[str, Any]]
+    __properties: ClassVar[List[str]] = ["id", "created_on", "job_id", "metadata_id", "number_of_qubits", "execution_time_in_seconds", "shots_requested", "shots_done", "results"]
+
+    model_config = {
+        "populate_by_name": True,
+        "validate_assignment": True
     }
 
-    attribute_map = {
-        'created_on': 'created_on',
-        'id': 'id',
-        'number_of_qubits': 'number_of_qubits',
-        'execution_time_in_seconds': 'execution_time_in_seconds',
-        'shots_requested': 'shots_requested',
-        'shots_done': 'shots_done',
-        'results': 'results',
-        'metadata_id': 'metadata_id',
-        'run_id': 'run_id'
-    }
-
-    def __init__(self, created_on=None, id=None, number_of_qubits=None, execution_time_in_seconds=None, shots_requested=None, shots_done=None, results=None, metadata_id=None, run_id=None, local_vars_configuration=None):  # noqa: E501
-        """Result - a model defined in OpenAPI"""  # noqa: E501
-        if local_vars_configuration is None:
-            local_vars_configuration = Configuration.get_default_copy()
-        self.local_vars_configuration = local_vars_configuration
-
-        self._created_on = None
-        self._id = None
-        self._number_of_qubits = None
-        self._execution_time_in_seconds = None
-        self._shots_requested = None
-        self._shots_done = None
-        self._results = None
-        self._metadata_id = None
-        self._run_id = None
-        self.discriminator = None
-
-        self.created_on = created_on
-        self.id = id
-        self.number_of_qubits = number_of_qubits
-        self.execution_time_in_seconds = execution_time_in_seconds
-        self.shots_requested = shots_requested
-        self.shots_done = shots_done
-        self.results = results
-        self.metadata_id = metadata_id
-        self.run_id = run_id
-
-    @property
-    def created_on(self):
-        """Gets the created_on of this Result.  # noqa: E501
-
-
-        :return: The created_on of this Result.  # noqa: E501
-        :rtype: datetime
-        """
-        return self._created_on
-
-    @created_on.setter
-    def created_on(self, created_on):
-        """Sets the created_on of this Result.
-
-
-        :param created_on: The created_on of this Result.  # noqa: E501
-        :type created_on: datetime
-        """
-        if self.local_vars_configuration.client_side_validation and created_on is None:  # noqa: E501
-            raise ValueError("Invalid value for `created_on`, must not be `None`")  # noqa: E501
-
-        self._created_on = created_on
-
-    @property
-    def id(self):
-        """Gets the id of this Result.  # noqa: E501
-
-
-        :return: The id of this Result.  # noqa: E501
-        :rtype: int
-        """
-        return self._id
-
-    @id.setter
-    def id(self, id):
-        """Sets the id of this Result.
-
-
-        :param id: The id of this Result.  # noqa: E501
-        :type id: int
-        """
-        if self.local_vars_configuration.client_side_validation and id is None:  # noqa: E501
-            raise ValueError("Invalid value for `id`, must not be `None`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                id is not None and id > 2147483647):  # noqa: E501
-            raise ValueError("Invalid value for `id`, must be a value less than or equal to `2147483647`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                id is not None and id < 1):  # noqa: E501
-            raise ValueError("Invalid value for `id`, must be a value greater than or equal to `1`")  # noqa: E501
-
-        self._id = id
-
-    @property
-    def number_of_qubits(self):
-        """Gets the number_of_qubits of this Result.  # noqa: E501
-
-
-        :return: The number_of_qubits of this Result.  # noqa: E501
-        :rtype: int
-        """
-        return self._number_of_qubits
-
-    @number_of_qubits.setter
-    def number_of_qubits(self, number_of_qubits):
-        """Sets the number_of_qubits of this Result.
-
-
-        :param number_of_qubits: The number_of_qubits of this Result.  # noqa: E501
-        :type number_of_qubits: int
-        """
-        if self.local_vars_configuration.client_side_validation and number_of_qubits is None:  # noqa: E501
-            raise ValueError("Invalid value for `number_of_qubits`, must not be `None`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                number_of_qubits is not None and number_of_qubits > 32767):  # noqa: E501
-            raise ValueError("Invalid value for `number_of_qubits`, must be a value less than or equal to `32767`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                number_of_qubits is not None and number_of_qubits < -32768):  # noqa: E501
-            raise ValueError("Invalid value for `number_of_qubits`, must be a value greater than or equal to `-32768`")  # noqa: E501
-
-        self._number_of_qubits = number_of_qubits
-
-    @property
-    def execution_time_in_seconds(self):
-        """Gets the execution_time_in_seconds of this Result.  # noqa: E501
-
-
-        :return: The execution_time_in_seconds of this Result.  # noqa: E501
-        :rtype: float
-        """
-        return self._execution_time_in_seconds
-
-    @execution_time_in_seconds.setter
-    def execution_time_in_seconds(self, execution_time_in_seconds):
-        """Sets the execution_time_in_seconds of this Result.
-
-
-        :param execution_time_in_seconds: The execution_time_in_seconds of this Result.  # noqa: E501
-        :type execution_time_in_seconds: float
-        """
-        if self.local_vars_configuration.client_side_validation and execution_time_in_seconds is None:  # noqa: E501
-            raise ValueError("Invalid value for `execution_time_in_seconds`, must not be `None`")  # noqa: E501
-
-        self._execution_time_in_seconds = execution_time_in_seconds
-
-    @property
-    def shots_requested(self):
-        """Gets the shots_requested of this Result.  # noqa: E501
-
-
-        :return: The shots_requested of this Result.  # noqa: E501
-        :rtype: int
-        """
-        return self._shots_requested
-
-    @shots_requested.setter
-    def shots_requested(self, shots_requested):
-        """Sets the shots_requested of this Result.
-
-
-        :param shots_requested: The shots_requested of this Result.  # noqa: E501
-        :type shots_requested: int
-        """
-        if (self.local_vars_configuration.client_side_validation and
-                shots_requested is not None and shots_requested > 2147483647):  # noqa: E501
-            raise ValueError("Invalid value for `shots_requested`, must be a value less than or equal to `2147483647`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                shots_requested is not None and shots_requested < -2147483648):  # noqa: E501
-            raise ValueError("Invalid value for `shots_requested`, must be a value greater than or equal to `-2147483648`")  # noqa: E501
-
-        self._shots_requested = shots_requested
-
-    @property
-    def shots_done(self):
-        """Gets the shots_done of this Result.  # noqa: E501
-
-
-        :return: The shots_done of this Result.  # noqa: E501
-        :rtype: int
-        """
-        return self._shots_done
-
-    @shots_done.setter
-    def shots_done(self, shots_done):
-        """Sets the shots_done of this Result.
-
-
-        :param shots_done: The shots_done of this Result.  # noqa: E501
-        :type shots_done: int
-        """
-        if (self.local_vars_configuration.client_side_validation and
-                shots_done is not None and shots_done > 2147483647):  # noqa: E501
-            raise ValueError("Invalid value for `shots_done`, must be a value less than or equal to `2147483647`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                shots_done is not None and shots_done < -2147483648):  # noqa: E501
-            raise ValueError("Invalid value for `shots_done`, must be a value greater than or equal to `-2147483648`")  # noqa: E501
-
-        self._shots_done = shots_done
-
-    @property
-    def results(self):
-        """Gets the results of this Result.  # noqa: E501
-
-
-        :return: The results of this Result.  # noqa: E501
-        :rtype: object
-        """
-        return self._results
-
-    @results.setter
-    def results(self, results):
-        """Sets the results of this Result.
-
-
-        :param results: The results of this Result.  # noqa: E501
-        :type results: object
-        """
-
-        self._results = results
-
-    @property
-    def metadata_id(self):
-        """Gets the metadata_id of this Result.  # noqa: E501
-
-
-        :return: The metadata_id of this Result.  # noqa: E501
-        :rtype: int
-        """
-        return self._metadata_id
-
-    @metadata_id.setter
-    def metadata_id(self, metadata_id):
-        """Sets the metadata_id of this Result.
-
-
-        :param metadata_id: The metadata_id of this Result.  # noqa: E501
-        :type metadata_id: int
-        """
-        if self.local_vars_configuration.client_side_validation and metadata_id is None:  # noqa: E501
-            raise ValueError("Invalid value for `metadata_id`, must not be `None`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                metadata_id is not None and metadata_id > 2147483647):  # noqa: E501
-            raise ValueError("Invalid value for `metadata_id`, must be a value less than or equal to `2147483647`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                metadata_id is not None and metadata_id < 1):  # noqa: E501
-            raise ValueError("Invalid value for `metadata_id`, must be a value greater than or equal to `1`")  # noqa: E501
-
-        self._metadata_id = metadata_id
-
-    @property
-    def run_id(self):
-        """Gets the run_id of this Result.  # noqa: E501
-
-
-        :return: The run_id of this Result.  # noqa: E501
-        :rtype: int
-        """
-        return self._run_id
-
-    @run_id.setter
-    def run_id(self, run_id):
-        """Sets the run_id of this Result.
-
-
-        :param run_id: The run_id of this Result.  # noqa: E501
-        :type run_id: int
-        """
-        if self.local_vars_configuration.client_side_validation and run_id is None:  # noqa: E501
-            raise ValueError("Invalid value for `run_id`, must not be `None`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                run_id is not None and run_id > 2147483647):  # noqa: E501
-            raise ValueError("Invalid value for `run_id`, must be a value less than or equal to `2147483647`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                run_id is not None and run_id < 1):  # noqa: E501
-            raise ValueError("Invalid value for `run_id`, must be a value greater than or equal to `1`")  # noqa: E501
-
-        self._run_id = run_id
-
-    def to_dict(self, serialize=False):
-        """Returns the model properties as a dict"""
-        result = {}
-
-        def convert(x):
-            if hasattr(x, "to_dict"):
-                args = getfullargspec(x.to_dict).args
-                if len(args) == 1:
-                    return x.to_dict()
-                else:
-                    return x.to_dict(serialize)
-            else:
-                return x
-
-        for attr, _ in six.iteritems(self.openapi_types):
-            value = getattr(self, attr)
-            attr = self.attribute_map.get(attr, attr) if serialize else attr
-            if isinstance(value, list):
-                result[attr] = list(map(
-                    lambda x: convert(x),
-                    value
-                ))
-            elif isinstance(value, dict):
-                result[attr] = dict(map(
-                    lambda item: (item[0], convert(item[1])),
-                    value.items()
-                ))
-            else:
-                result[attr] = convert(value)
-
-        return result
-
-    def to_str(self):
-        """Returns the string representation of the model"""
-        return pprint.pformat(self.to_dict())
-
-    def __repr__(self):
-        """For `print` and `pprint`"""
-        return self.to_str()
-
-    def __eq__(self, other):
-        """Returns true if both objects are equal"""
-        if not isinstance(other, Result):
-            return False
 
-        return self.to_dict() == other.to_dict()
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of Result 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.
+        """
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude={
+            },
+            exclude_none=True,
+        )
+        # set to None if shots_requested (nullable) is None
+        # and model_fields_set contains the field
+        if self.shots_requested is None and "shots_requested" in self.model_fields_set:
+            _dict['shots_requested'] = None
+
+        # set to None if shots_done (nullable) is None
+        # and model_fields_set contains the field
+        if self.shots_done is None and "shots_done" in self.model_fields_set:
+            _dict['shots_done'] = None
+
+        # set to None if results (nullable) is None
+        # and model_fields_set contains the field
+        if self.results is None and "results" in self.model_fields_set:
+            _dict['results'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Dict) -> Self:
+        """Create an instance of Result 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"),
+            "created_on": obj.get("created_on"),
+            "job_id": obj.get("job_id"),
+            "metadata_id": obj.get("metadata_id"),
+            "number_of_qubits": obj.get("number_of_qubits"),
+            "execution_time_in_seconds": obj.get("execution_time_in_seconds"),
+            "shots_requested": obj.get("shots_requested"),
+            "shots_done": obj.get("shots_done"),
+            "results": obj.get("results")
+        })
+        return _obj
 
-    def __ne__(self, other):
-        """Returns true if both objects are not equal"""
-        if not isinstance(other, Result):
-            return True
 
-        return self.to_dict() != other.to_dict()