qi-compute-api-client 0.56.0__py3-none-any.whl

compute_api_client/models/backend.py

@@ -0,0 +1,106 @@
+# coding: utf-8
+
+"""
+    Quantum Inspire 2
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.0
+    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 datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from compute_api_client.models.backend_message import BackendMessage
+from compute_api_client.models.backend_status import BackendStatus
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Backend(BaseModel):
+    """
+    Backend
+    """ # noqa: E501
+    id: StrictInt = Field(description="The id of the backend")
+    name: Annotated[str, Field(strict=True, max_length=32)] = Field(description="The name of the backend")
+    location: Annotated[str, Field(strict=True, max_length=32)] = Field(description="The location of the backend")
+    backend_type_id: StrictInt = Field(description="The id of the backend type")
+    status: BackendStatus = Field(description="Status of the backend")
+    message: Optional[BackendMessage] = Field(default=None, description="The message obj for a backend")
+    last_heartbeat: datetime = Field(description="Time of last heartbeat")
+    __properties: ClassVar[List[str]] = ["id", "name", "location", "backend_type_id", "status", "message", "last_heartbeat"]
+
+    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))
+
+    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) -> Optional[Self]:
+        """Create an instance of Backend 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 message
+        if self.message:
+            _dict['message'] = self.message.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Backend 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"),
+            "location": obj.get("location"),
+            "backend_type_id": obj.get("backend_type_id"),
+            "status": obj.get("status"),
+            "message": BackendMessage.from_dict(obj["message"]) if obj.get("message") is not None else None,
+            "last_heartbeat": obj.get("last_heartbeat")
+        })
+        return _obj
+
+

compute_api_client/models/backend_in.py

@@ -0,0 +1,104 @@
+# coding: utf-8
+
+"""
+    Quantum Inspire 2
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.0
+    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 datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from compute_api_client.models.backend_message import BackendMessage
+from compute_api_client.models.backend_status import BackendStatus
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BackendIn(BaseModel):
+    """
+    BackendIn
+    """ # noqa: E501
+    name: Annotated[str, Field(strict=True, max_length=32)] = Field(description="The name of the backend")
+    location: Annotated[str, Field(strict=True, max_length=32)] = Field(description="The location of the backend")
+    backend_type_id: StrictInt = Field(description="The id of the backend type")
+    status: BackendStatus = Field(description="Status of the backend")
+    last_heartbeat: datetime = Field(description="Time of last heartbeat")
+    message: Optional[BackendMessage] = Field(default=None, description="The message obj for a backend")
+    __properties: ClassVar[List[str]] = ["name", "location", "backend_type_id", "status", "last_heartbeat", "message"]
+
+    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))
+
+    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) -> Optional[Self]:
+        """Create an instance of BackendIn 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 message
+        if self.message:
+            _dict['message'] = self.message.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of BackendIn from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "name": obj.get("name"),
+            "location": obj.get("location"),
+            "backend_type_id": obj.get("backend_type_id"),
+            "status": obj.get("status"),
+            "last_heartbeat": obj.get("last_heartbeat"),
+            "message": BackendMessage.from_dict(obj["message"]) if obj.get("message") is not None else None
+        })
+        return _obj
+
+

compute_api_client/models/backend_message.py

@@ -0,0 +1,87 @@
+# coding: utf-8
+
+"""
+    Quantum Inspire 2
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.0
+    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 BackendMessage(BaseModel):
+    """
+    BackendMessage
+    """ # noqa: E501
+    content: Optional[StrictStr] = Field(default='', description="Content of the message")
+    __properties: ClassVar[List[str]] = ["content"]
+
+    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))
+
+    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) -> Optional[Self]:
+        """Create an instance of BackendMessage 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 BackendMessage from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "content": obj.get("content") if obj.get("content") is not None else ''
+        })
+        return _obj
+
+

compute_api_client/models/backend_patch.py

@@ -0,0 +1,112 @@
+# coding: utf-8
+
+"""
+    Quantum Inspire 2
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.0
+    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 datetime import datetime
+from pydantic import BaseModel, ConfigDict
+from typing import Any, ClassVar, Dict, List, Optional
+from compute_api_client.models.backend_message import BackendMessage
+from compute_api_client.models.backend_status import BackendStatus
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BackendPatch(BaseModel):
+    """
+    BackendPatch
+    """ # noqa: E501
+    message: Optional[BackendMessage] = None
+    status: Optional[BackendStatus] = None
+    last_heartbeat: Optional[datetime] = None
+    __properties: ClassVar[List[str]] = ["message", "status", "last_heartbeat"]
+
+    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))
+
+    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) -> Optional[Self]:
+        """Create an instance of BackendPatch 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 message
+        if self.message:
+            _dict['message'] = self.message.to_dict()
+        # set to None if message (nullable) is None
+        # and model_fields_set contains the field
+        if self.message is None and "message" in self.model_fields_set:
+            _dict['message'] = None
+
+        # set to None if status (nullable) is None
+        # and model_fields_set contains the field
+        if self.status is None and "status" in self.model_fields_set:
+            _dict['status'] = None
+
+        # set to None if last_heartbeat (nullable) is None
+        # and model_fields_set contains the field
+        if self.last_heartbeat is None and "last_heartbeat" in self.model_fields_set:
+            _dict['last_heartbeat'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of BackendPatch from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "message": BackendMessage.from_dict(obj["message"]) if obj.get("message") is not None else None,
+            "status": obj.get("status"),
+            "last_heartbeat": obj.get("last_heartbeat")
+        })
+        return _obj
+
+

compute_api_client/models/backend_status.py

@@ -0,0 +1,39 @@
+# coding: utf-8
+
+"""
+    Quantum Inspire 2
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class BackendStatus(str, Enum):
+    """
+    BackendStatus
+    """
+
+    """
+    allowed enum values
+    """
+    OFFLINE = 'offline'
+    IDLE = 'idle'
+    EXECUTING = 'executing'
+    CALIBRATING = 'calibrating'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of BackendStatus from a JSON string"""
+        return cls(json.loads(json_str))
+
+

compute_api_client/models/backend_type.py

@@ -0,0 +1,145 @@
+# coding: utf-8
+
+"""
+    Quantum Inspire 2
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.0
+    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, StrictBool, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing_extensions import Annotated
+from compute_api_client.models.backend_message import BackendMessage
+from compute_api_client.models.backend_status import BackendStatus
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BackendType(BaseModel):
+    """
+    BackendType
+    """ # noqa: E501
+    id: StrictInt = Field(description="The id of the backend type")
+    name: Annotated[str, Field(strict=True, max_length=32)] = Field(description="Name of the backend type")
+    infrastructure: Annotated[str, Field(strict=True, max_length=32)] = Field(description="Name of the infrastructure")
+    description: StrictStr = Field(description="Description of the backendtype")
+    image_id: Annotated[str, Field(strict=True, max_length=64)] = Field(description="The id of the image")
+    is_hardware: StrictBool = Field(description="If it is hardware")
+    supports_raw_data: StrictBool = Field(description="If it supports raw data extraction")
+    features: List[Optional[StrictStr]] = Field(description="The features supported by backend type")
+    default_compiler_config: Dict[str, Any] = Field(description="The various passes for each stage")
+    gateset: List[Optional[StrictStr]] = Field(description="The primary gatesets supported by the backend")
+    topology: List[List[StrictInt]] = Field(description="The topology of the backend")
+    nqubits: StrictInt = Field(description="The number of qubits on the backend")
+    status: BackendStatus = Field(description="The status of the backend type")
+    messages: Dict[str, BackendMessage] = Field(description="List of status messages for the various instances")
+    default_number_of_shots: StrictInt = Field(description="The default shots")
+    max_number_of_shots: StrictInt = Field(description="The maximum number of shots")
+    enabled: StrictBool = Field(description="If it is enabled")
+    identifier: Annotated[str, Field(strict=True, max_length=32)] = Field(description="The identifier of the backend")
+    protocol_version: Optional[StrictInt] = None
+    job_execution_time_limit: Union[StrictFloat, StrictInt] = Field(description="Maximum allowed execution time(seconds) for a job.")
+    __properties: ClassVar[List[str]] = ["id", "name", "infrastructure", "description", "image_id", "is_hardware", "supports_raw_data", "features", "default_compiler_config", "gateset", "topology", "nqubits", "status", "messages", "default_number_of_shots", "max_number_of_shots", "enabled", "identifier", "protocol_version", "job_execution_time_limit"]
+
+    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))
+
+    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) -> Optional[Self]:
+        """Create an instance of BackendType 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 value in messages (dict)
+        _field_dict = {}
+        if self.messages:
+            for _key_messages in self.messages:
+                if self.messages[_key_messages]:
+                    _field_dict[_key_messages] = self.messages[_key_messages].to_dict()
+            _dict['messages'] = _field_dict
+        # set to None if protocol_version (nullable) is None
+        # and model_fields_set contains the field
+        if self.protocol_version is None and "protocol_version" in self.model_fields_set:
+            _dict['protocol_version'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of BackendType 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"),
+            "infrastructure": obj.get("infrastructure"),
+            "description": obj.get("description"),
+            "image_id": obj.get("image_id"),
+            "is_hardware": obj.get("is_hardware"),
+            "supports_raw_data": obj.get("supports_raw_data"),
+            "features": obj.get("features"),
+            "default_compiler_config": obj.get("default_compiler_config"),
+            "gateset": obj.get("gateset"),
+            "topology": obj.get("topology"),
+            "nqubits": obj.get("nqubits"),
+            "status": obj.get("status"),
+            "messages": dict(
+                (_k, BackendMessage.from_dict(_v))
+                for _k, _v in obj["messages"].items()
+            )
+            if obj.get("messages") is not None
+            else None,
+            "default_number_of_shots": obj.get("default_number_of_shots"),
+            "max_number_of_shots": obj.get("max_number_of_shots"),
+            "enabled": obj.get("enabled"),
+            "identifier": obj.get("identifier"),
+            "protocol_version": obj.get("protocol_version"),
+            "job_execution_time_limit": obj.get("job_execution_time_limit")
+        })
+        return _obj
+
+