qi-compute-api-client 0.52.0__py3-none-any.whl → 0.54.0__py3-none-any.whl

compute_api_client/models/backend_type.py

@@ -17,44 +17,42 @@ import pprint
 import re  # noqa: F401
 import json
 
-
-from typing import Any, ClassVar, Dict, List
-from pydantic import BaseModel, StrictBool, StrictInt, StrictStr
-from pydantic import Field
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
 from typing_extensions import Annotated
 from compute_api_client.models.backend_status import BackendStatus
-try:
-    from typing import Self
-except ImportError:
-    from typing_extensions import Self
+from typing import Optional, Set
+from typing_extensions import Self
 
 class BackendType(BaseModel):
     """
     BackendType
     """ # noqa: E501
-    id: StrictInt
-    name: Annotated[str, Field(strict=True, max_length=32)]
-    infrastructure: Annotated[str, Field(strict=True, max_length=32)]
-    description: StrictStr
-    image_id: Annotated[str, Field(strict=True, max_length=16)]
-    is_hardware: StrictBool
-    supports_raw_data: StrictBool
-    features: List[StrictStr]
-    default_compiler_config: Dict[str, Any]
-    gateset: List[StrictStr]
-    topology: List[List[StrictInt]]
-    nqubits: StrictInt
-    status: BackendStatus
-    default_number_of_shots: StrictInt
-    max_number_of_shots: StrictInt
-    enabled: StrictBool
-    identifier: Annotated[str, Field(strict=True, max_length=32)]
-    __properties: ClassVar[List[str]] = ["id", "name", "infrastructure", "description", "image_id", "is_hardware", "supports_raw_data", "features", "default_compiler_config", "gateset", "topology", "nqubits", "status", "default_number_of_shots", "max_number_of_shots", "enabled", "identifier"]
-
-    model_config = {
-        "populate_by_name": True,
-        "validate_assignment": True
-    }
+    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=16)] = 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")
+    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
+    __properties: ClassVar[List[str]] = ["id", "name", "infrastructure", "description", "image_id", "is_hardware", "supports_raw_data", "features", "default_compiler_config", "gateset", "topology", "nqubits", "status", "default_number_of_shots", "max_number_of_shots", "enabled", "identifier", "protocol_version"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
 
 
     def to_str(self) -> str:
@@ -67,7 +65,7 @@ class BackendType(BaseModel):
         return json.dumps(self.to_dict())
 
     @classmethod
-    def from_json(cls, json_str: str) -> Self:
+    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))
 
@@ -81,16 +79,23 @@ class BackendType(BaseModel):
           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={
-            },
+            exclude=excluded_fields,
             exclude_none=True,
         )
+        # 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: Dict) -> Self:
+    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
@@ -115,7 +120,8 @@ class BackendType(BaseModel):
             "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")
+            "identifier": obj.get("identifier"),
+            "protocol_version": obj.get("protocol_version")
         })
         return _obj
 

compute_api_client/models/backend_type_patch.py

@@ -17,15 +17,11 @@ import pprint
 import re  # noqa: F401
 import json
 
-
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
-from pydantic import BaseModel, StrictBool, StrictInt, StrictStr
-from pydantic import Field
 from typing_extensions import Annotated
-try:
-    from typing import Self
-except ImportError:
-    from typing_extensions import Self
+from typing import Optional, Set
+from typing_extensions import Self
 
 class BackendTypePatch(BaseModel):
     """
@@ -46,12 +42,14 @@ class BackendTypePatch(BaseModel):
     max_number_of_shots: Optional[StrictInt] = None
     enabled: Optional[StrictBool] = None
     identifier: Optional[Annotated[str, Field(strict=True, max_length=32)]] = None
-    __properties: ClassVar[List[str]] = ["name", "infrastructure", "description", "image_id", "is_hardware", "supports_raw_data", "features", "default_compiler_config", "gateset", "topology", "nqubits", "default_number_of_shots", "max_number_of_shots", "enabled", "identifier"]
+    protocol_version: Optional[StrictInt] = None
+    __properties: ClassVar[List[str]] = ["name", "infrastructure", "description", "image_id", "is_hardware", "supports_raw_data", "features", "default_compiler_config", "gateset", "topology", "nqubits", "default_number_of_shots", "max_number_of_shots", "enabled", "identifier", "protocol_version"]
 
-    model_config = {
-        "populate_by_name": True,
-        "validate_assignment": True
-    }
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
 
 
     def to_str(self) -> str:
@@ -64,7 +62,7 @@ class BackendTypePatch(BaseModel):
         return json.dumps(self.to_dict())
 
     @classmethod
-    def from_json(cls, json_str: str) -> Self:
+    def from_json(cls, json_str: str) -> Optional[Self]:
         """Create an instance of BackendTypePatch from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
@@ -78,10 +76,12 @@ class BackendTypePatch(BaseModel):
           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={
-            },
+            exclude=excluded_fields,
             exclude_none=True,
         )
         # set to None if name (nullable) is None
@@ -159,10 +159,15 @@ class BackendTypePatch(BaseModel):
         if self.identifier is None and "identifier" in self.model_fields_set:
             _dict['identifier'] = None
 
+        # 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: Dict) -> Self:
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
         """Create an instance of BackendTypePatch from a dict"""
         if obj is None:
             return None
@@ -185,7 +190,8 @@ class BackendTypePatch(BaseModel):
             "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")
+            "identifier": obj.get("identifier"),
+            "protocol_version": obj.get("protocol_version")
         })
         return _obj
 

compute_api_client/models/backend_with_authentication.py

@@ -18,33 +18,31 @@ import re  # noqa: F401
 import json
 
 from datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictInt
 from typing import Any, ClassVar, Dict, List
-from pydantic import BaseModel, StrictInt
-from pydantic import Field
 from typing_extensions import Annotated
 from compute_api_client.models.backend_status import BackendStatus
-try:
-    from typing import Self
-except ImportError:
-    from typing_extensions import Self
+from typing import Optional, Set
+from typing_extensions import Self
 
 class BackendWithAuthentication(BaseModel):
     """
     BackendWithAuthentication
     """ # noqa: E501
-    id: StrictInt
-    name: Annotated[str, Field(strict=True, max_length=32)]
-    location: Annotated[str, Field(strict=True, max_length=32)]
-    backend_type_id: StrictInt
-    status: BackendStatus
-    last_heartbeat: datetime
-    authentication_hash: Annotated[str, Field(strict=True, max_length=32)]
+    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")
+    last_heartbeat: datetime = Field(description="Time of last heartbeat")
+    authentication_hash: Annotated[str, Field(strict=True, max_length=32)] = Field(description="The authentication hash of the backend")
     __properties: ClassVar[List[str]] = ["id", "name", "location", "backend_type_id", "status", "last_heartbeat", "authentication_hash"]
 
-    model_config = {
-        "populate_by_name": True,
-        "validate_assignment": True
-    }
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
 
 
     def to_str(self) -> str:
@@ -57,7 +55,7 @@ class BackendWithAuthentication(BaseModel):
         return json.dumps(self.to_dict())
 
     @classmethod
-    def from_json(cls, json_str: str) -> Self:
+    def from_json(cls, json_str: str) -> Optional[Self]:
         """Create an instance of BackendWithAuthentication from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
@@ -71,16 +69,18 @@ class BackendWithAuthentication(BaseModel):
           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={
-            },
+            exclude=excluded_fields,
             exclude_none=True,
         )
         return _dict
 
     @classmethod
-    def from_dict(cls, obj: Dict) -> Self:
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
         """Create an instance of BackendWithAuthentication from a dict"""
         if obj is None:
             return None

compute_api_client/models/batch_job.py

@@ -18,36 +18,35 @@ 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 pydantic import BaseModel, StrictInt
 from compute_api_client.models.algorithm_type import AlgorithmType
 from compute_api_client.models.batch_job_status import BatchJobStatus
-try:
-    from typing import Self
-except ImportError:
-    from typing_extensions import Self
+from typing import Optional, Set
+from typing_extensions import Self
 
 class BatchJob(BaseModel):
     """
     BatchJob
     """ # noqa: E501
-    id: StrictInt
-    created_on: datetime
-    status: BatchJobStatus
-    user_id: StrictInt
-    backend_type_id: StrictInt
+    id: StrictInt = Field(description="ID of the batch job")
+    created_on: datetime = Field(description="Time of batchjob creation")
+    status: BatchJobStatus = Field(description="Status of the batchjob")
+    user_id: StrictInt = Field(description="ID of the user to whom this job belongs")
+    backend_type_id: StrictInt = Field(description="ID of the backendtype")
     backend_id: Optional[StrictInt]
     queued_at: Optional[datetime]
     reserved_at: Optional[datetime]
     finished_at: Optional[datetime]
-    job_ids: List[StrictInt]
-    aggregated_algorithm_type: AlgorithmType
+    job_ids: List[StrictInt] = Field(description="Job ids in the batch job")
+    aggregated_algorithm_type: AlgorithmType = Field(description="Algorithm type submitted")
     __properties: ClassVar[List[str]] = ["id", "created_on", "status", "user_id", "backend_type_id", "backend_id", "queued_at", "reserved_at", "finished_at", "job_ids", "aggregated_algorithm_type"]
 
-    model_config = {
-        "populate_by_name": True,
-        "validate_assignment": True
-    }
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
 
 
     def to_str(self) -> str:
@@ -60,7 +59,7 @@ class BatchJob(BaseModel):
         return json.dumps(self.to_dict())
 
     @classmethod
-    def from_json(cls, json_str: str) -> Self:
+    def from_json(cls, json_str: str) -> Optional[Self]:
         """Create an instance of BatchJob from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
@@ -74,10 +73,12 @@ class BatchJob(BaseModel):
           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={
-            },
+            exclude=excluded_fields,
             exclude_none=True,
         )
         # set to None if backend_id (nullable) is None
@@ -103,7 +104,7 @@ class BatchJob(BaseModel):
         return _dict
 
     @classmethod
-    def from_dict(cls, obj: Dict) -> Self:
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
         """Create an instance of BatchJob from a dict"""
         if obj is None:
             return None

compute_api_client/models/batch_job_in.py

@@ -17,25 +17,23 @@ import pprint
 import re  # noqa: F401
 import json
 
-
+from pydantic import BaseModel, ConfigDict, Field, StrictInt
 from typing import Any, ClassVar, Dict, List
-from pydantic import BaseModel, StrictInt
-try:
-    from typing import Self
-except ImportError:
-    from typing_extensions import Self
+from typing import Optional, Set
+from typing_extensions import Self
 
 class BatchJobIn(BaseModel):
     """
     BatchJobIn
     """ # noqa: E501
-    backend_type_id: StrictInt
+    backend_type_id: StrictInt = Field(description="ID of the batch job")
     __properties: ClassVar[List[str]] = ["backend_type_id"]
 
-    model_config = {
-        "populate_by_name": True,
-        "validate_assignment": True
-    }
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
 
 
     def to_str(self) -> str:
@@ -48,7 +46,7 @@ class BatchJobIn(BaseModel):
         return json.dumps(self.to_dict())
 
     @classmethod
-    def from_json(cls, json_str: str) -> Self:
+    def from_json(cls, json_str: str) -> Optional[Self]:
         """Create an instance of BatchJobIn from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
@@ -62,16 +60,18 @@ class BatchJobIn(BaseModel):
           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={
-            },
+            exclude=excluded_fields,
             exclude_none=True,
         )
         return _dict
 
     @classmethod
-    def from_dict(cls, obj: Dict) -> Self:
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
         """Create an instance of BatchJobIn from a dict"""
         if obj is None:
             return None

compute_api_client/models/batch_job_status.py

@@ -14,16 +14,8 @@
 
 from __future__ import annotations
 import json
-import pprint
-import re  # noqa: F401
 from enum import Enum
-
-
-
-try:
-    from typing import Self
-except ImportError:
-    from typing_extensions import Self
+from typing_extensions import Self
 
 
 class BatchJobStatus(str, Enum):

compute_api_client/models/commit.py

@@ -18,30 +18,28 @@ import re  # noqa: F401
 import json
 
 from datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List
-from pydantic import BaseModel, StrictInt, StrictStr
-from pydantic import Field
 from typing_extensions import Annotated
-try:
-    from typing import Self
-except ImportError:
-    from typing_extensions import Self
+from typing import Optional, Set
+from typing_extensions import Self
 
 class Commit(BaseModel):
     """
     Commit
     """ # noqa: E501
-    id: StrictInt
-    created_on: datetime
-    hash: Annotated[str, Field(strict=True, max_length=32)]
-    description: StrictStr
-    algorithm_id: StrictInt
+    id: StrictInt = Field(description="ID of the commit")
+    created_on: datetime = Field(description="Time of creation of the commit")
+    hash: Annotated[str, Field(strict=True, max_length=32)] = Field(description="Unique hash assigned to the commit")
+    description: StrictStr = Field(description="Desriptive message of the commit")
+    algorithm_id: StrictInt = Field(description="ID of the algorithm")
     __properties: ClassVar[List[str]] = ["id", "created_on", "hash", "description", "algorithm_id"]
 
-    model_config = {
-        "populate_by_name": True,
-        "validate_assignment": True
-    }
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
 
 
     def to_str(self) -> str:
@@ -54,7 +52,7 @@ class Commit(BaseModel):
         return json.dumps(self.to_dict())
 
     @classmethod
-    def from_json(cls, json_str: str) -> Self:
+    def from_json(cls, json_str: str) -> Optional[Self]:
         """Create an instance of Commit from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
@@ -68,16 +66,18 @@ class Commit(BaseModel):
           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={
-            },
+            exclude=excluded_fields,
             exclude_none=True,
         )
         return _dict
 
     @classmethod
-    def from_dict(cls, obj: Dict) -> Self:
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
         """Create an instance of Commit from a dict"""
         if obj is None:
             return None

compute_api_client/models/commit_in.py

@@ -17,26 +17,24 @@ import pprint
 import re  # noqa: F401
 import json
 
-
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List
-from pydantic import BaseModel, StrictInt, StrictStr
-try:
-    from typing import Self
-except ImportError:
-    from typing_extensions import Self
+from typing import Optional, Set
+from typing_extensions import Self
 
 class CommitIn(BaseModel):
     """
     CommitIn
     """ # noqa: E501
-    description: StrictStr
-    algorithm_id: StrictInt
+    description: StrictStr = Field(description="Desriptive message of the commit")
+    algorithm_id: StrictInt = Field(description="ID of the algorithm")
     __properties: ClassVar[List[str]] = ["description", "algorithm_id"]
 
-    model_config = {
-        "populate_by_name": True,
-        "validate_assignment": True
-    }
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
 
 
     def to_str(self) -> str:
@@ -49,7 +47,7 @@ class CommitIn(BaseModel):
         return json.dumps(self.to_dict())
 
     @classmethod
-    def from_json(cls, json_str: str) -> Self:
+    def from_json(cls, json_str: str) -> Optional[Self]:
         """Create an instance of CommitIn from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
@@ -63,16 +61,18 @@ class CommitIn(BaseModel):
           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={
-            },
+            exclude=excluded_fields,
             exclude_none=True,
         )
         return _dict
 
     @classmethod
-    def from_dict(cls, obj: Dict) -> Self:
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
         """Create an instance of CommitIn from a dict"""
         if obj is None:
             return None

compute_api_client/models/compile_payload.py

@@ -17,27 +17,25 @@ import pprint
 import re  # noqa: F401
 import json
 
-
+from pydantic import BaseModel, ConfigDict, Field, StrictInt
 from typing import Any, ClassVar, Dict, List, Optional
-from pydantic import BaseModel, StrictInt
 from compute_api_client.models.compile_stage import CompileStage
-try:
-    from typing import Self
-except ImportError:
-    from typing_extensions import Self
+from typing import Optional, Set
+from typing_extensions import Self
 
 class CompilePayload(BaseModel):
     """
     CompilePayload
     """ # noqa: E501
     compile_stage: Optional[CompileStage] = None
-    backend_type_id: StrictInt
+    backend_type_id: StrictInt = Field(description="ID of the backendtype")
     __properties: ClassVar[List[str]] = ["compile_stage", "backend_type_id"]
 
-    model_config = {
-        "populate_by_name": True,
-        "validate_assignment": True
-    }
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
 
 
     def to_str(self) -> str:
@@ -50,7 +48,7 @@ class CompilePayload(BaseModel):
         return json.dumps(self.to_dict())
 
     @classmethod
-    def from_json(cls, json_str: str) -> Self:
+    def from_json(cls, json_str: str) -> Optional[Self]:
         """Create an instance of CompilePayload from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
@@ -64,10 +62,12 @@ class CompilePayload(BaseModel):
           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={
-            },
+            exclude=excluded_fields,
             exclude_none=True,
         )
         # set to None if compile_stage (nullable) is None
@@ -78,7 +78,7 @@ class CompilePayload(BaseModel):
         return _dict
 
     @classmethod
-    def from_dict(cls, obj: Dict) -> Self:
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
         """Create an instance of CompilePayload from a dict"""
         if obj is None:
             return None