qi-compute-api-client 0.53.0__py3-none-any.whl → 0.54.1__py3-none-any.whl

compute_api_client/models/final_result_in.py

@@ -17,26 +17,24 @@ 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 FinalResultIn(BaseModel):
     """
     FinalResultIn
     """ # noqa: E501
-    job_id: StrictInt
-    final_result: Dict[str, Any]
+    job_id: StrictInt = Field(description="ID of the job")
+    final_result: Dict[str, Any] = Field(description="The final results of the job")
     __properties: ClassVar[List[str]] = ["job_id", "final_result"]
 
-    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 FinalResultIn(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 FinalResultIn from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
@@ -63,16 +61,18 @@ class FinalResultIn(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 FinalResultIn from a dict"""
         if obj is None:
             return None

compute_api_client/models/http_bad_request_error.py

@@ -17,13 +17,10 @@ import pprint
 import re  # noqa: F401
 import json
 
-
+from pydantic import BaseModel, ConfigDict, StrictStr
 from typing import Any, ClassVar, Dict, List
-from pydantic import BaseModel, StrictStr
-try:
-    from typing import Self
-except ImportError:
-    from typing_extensions import Self
+from typing import Optional, Set
+from typing_extensions import Self
 
 class HTTPBadRequestError(BaseModel):
     """
@@ -32,10 +29,11 @@ class HTTPBadRequestError(BaseModel):
     detail: StrictStr
     __properties: ClassVar[List[str]] = ["detail"]
 
-    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 HTTPBadRequestError(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 HTTPBadRequestError from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
@@ -62,16 +60,18 @@ class HTTPBadRequestError(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 HTTPBadRequestError from a dict"""
         if obj is None:
             return None

compute_api_client/models/http_not_found_error.py

@@ -17,13 +17,10 @@ import pprint
 import re  # noqa: F401
 import json
 
-
+from pydantic import BaseModel, ConfigDict, StrictStr
 from typing import Any, ClassVar, Dict, List
-from pydantic import BaseModel, StrictStr
-try:
-    from typing import Self
-except ImportError:
-    from typing_extensions import Self
+from typing import Optional, Set
+from typing_extensions import Self
 
 class HTTPNotFoundError(BaseModel):
     """
@@ -32,10 +29,11 @@ class HTTPNotFoundError(BaseModel):
     detail: StrictStr
     __properties: ClassVar[List[str]] = ["detail"]
 
-    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 HTTPNotFoundError(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 HTTPNotFoundError from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
@@ -62,16 +60,18 @@ class HTTPNotFoundError(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 HTTPNotFoundError from a dict"""
         if obj is None:
             return None

compute_api_client/models/http_validation_error.py

@@ -17,14 +17,11 @@ import pprint
 import re  # noqa: F401
 import json
 
-
+from pydantic import BaseModel, ConfigDict
 from typing import Any, ClassVar, Dict, List, Optional
-from pydantic import BaseModel
 from compute_api_client.models.validation_error import ValidationError
-try:
-    from typing import Self
-except ImportError:
-    from typing_extensions import Self
+from typing import Optional, Set
+from typing_extensions import Self
 
 class HTTPValidationError(BaseModel):
     """
@@ -33,10 +30,11 @@ class HTTPValidationError(BaseModel):
     detail: Optional[List[ValidationError]] = None
     __properties: ClassVar[List[str]] = ["detail"]
 
-    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 HTTPValidationError(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 HTTPValidationError from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
@@ -63,23 +61,25 @@ class HTTPValidationError(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,
         )
         # override the default output from pydantic by calling `to_dict()` of each item in detail (list)
         _items = []
         if self.detail:
-            for _item in self.detail:
-                if _item:
-                    _items.append(_item.to_dict())
+            for _item_detail in self.detail:
+                if _item_detail:
+                    _items.append(_item_detail.to_dict())
             _dict['detail'] = _items
         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 HTTPValidationError from a dict"""
         if obj is None:
             return None
@@ -88,7 +88,7 @@ class HTTPValidationError(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "detail": [ValidationError.from_dict(_item) for _item in obj.get("detail")] if obj.get("detail") is not None else None
+            "detail": [ValidationError.from_dict(_item) for _item in obj["detail"]] if obj.get("detail") is not None else None
         })
         return _obj
 

compute_api_client/models/job.py

@@ -18,40 +18,38 @@ import re  # noqa: F401
 import json
 
 from datetime import datetime
+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 compute_api_client.models.algorithm_type import AlgorithmType
 from compute_api_client.models.job_status import JobStatus
-try:
-    from typing import Self
-except ImportError:
-    from typing_extensions import Self
+from typing import Optional, Set
+from typing_extensions import Self
 
 class Job(BaseModel):
     """
     Job
     """ # noqa: E501
-    id: StrictInt
-    created_on: datetime
-    file_id: StrictInt
-    algorithm_type: AlgorithmType
-    status: JobStatus
-    batch_job_id: StrictInt
+    id: StrictInt = Field(description="The ID of the job")
+    created_on: datetime = Field(description="Time of creation of the Job")
+    file_id: StrictInt = Field(description="The ID of the file")
+    algorithm_type: AlgorithmType = Field(description="The type of the algorithm")
+    status: JobStatus = Field(description="The status of the Job")
+    batch_job_id: StrictInt = Field(description="The ID of the batch job")
     queued_at: Optional[datetime]
     finished_at: Optional[datetime]
     number_of_shots: Optional[StrictInt]
-    raw_data_enabled: StrictBool
-    session_id: StrictStr
-    trace_id: StrictStr
-    message: StrictStr
+    raw_data_enabled: StrictBool = Field(description="If raw data is to be attached to results")
+    session_id: StrictStr = Field(description="The uuid assigned to the job")
+    trace_id: StrictStr = Field(description="The uuid of the trace in case of job failure")
+    message: StrictStr = Field(description="The message associated with the executed job if it failed")
     source: Optional[StrictStr] = Field(default='', description="The source application of an exception that caused a job to fail (if applicable).")
     __properties: ClassVar[List[str]] = ["id", "created_on", "file_id", "algorithm_type", "status", "batch_job_id", "queued_at", "finished_at", "number_of_shots", "raw_data_enabled", "session_id", "trace_id", "message", "source"]
 
-    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 Job(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 Job from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
@@ -78,10 +76,12 @@ class Job(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 queued_at (nullable) is None
@@ -102,7 +102,7 @@ class Job(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 Job from a dict"""
         if obj is None:
             return None

compute_api_client/models/job_in.py

@@ -17,28 +17,26 @@ import pprint
 import re  # noqa: F401
 import json
 
-
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt
 from typing import Any, ClassVar, Dict, List, Optional
-from pydantic import BaseModel, StrictBool, StrictInt
-try:
-    from typing import Self
-except ImportError:
-    from typing_extensions import Self
+from typing import Optional, Set
+from typing_extensions import Self
 
 class JobIn(BaseModel):
     """
     JobIn
     """ # noqa: E501
-    file_id: StrictInt
-    batch_job_id: StrictInt
+    file_id: StrictInt = Field(description="The ID of the file")
+    batch_job_id: StrictInt = Field(description="The ID of the batch job")
     number_of_shots: Optional[StrictInt] = None
-    raw_data_enabled: Optional[StrictBool] = False
+    raw_data_enabled: Optional[StrictBool] = Field(default=False, description="If raw data is to be attached to results")
     __properties: ClassVar[List[str]] = ["file_id", "batch_job_id", "number_of_shots", "raw_data_enabled"]
 
-    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:
@@ -51,7 +49,7 @@ class JobIn(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 JobIn from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
@@ -65,10 +63,12 @@ class JobIn(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 number_of_shots (nullable) is None
@@ -79,7 +79,7 @@ class JobIn(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 JobIn from a dict"""
         if obj is None:
             return None

compute_api_client/models/job_patch.py

@@ -17,33 +17,30 @@ import pprint
 import re  # noqa: F401
 import json
 
-
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
-from pydantic import BaseModel, StrictStr
-from pydantic import Field
 from typing_extensions import Annotated
 from compute_api_client.models.job_status import JobStatus
-try:
-    from typing import Self
-except ImportError:
-    from typing_extensions import Self
+from typing import Optional, Set
+from typing_extensions import Self
 
 class JobPatch(BaseModel):
     """
     JobPatch
     """ # noqa: E501
-    status: JobStatus
-    session_id: Optional[Annotated[str, Field(strict=True, max_length=255)]] = ''
-    trace_id: Optional[Annotated[str, Field(strict=True, max_length=255)]] = ''
-    message: Optional[StrictStr] = ''
+    status: JobStatus = Field(description="The status of the Job")
+    session_id: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default='', description="The uuid assigned to the job")
+    trace_id: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default='', description="The uuid of the trace in case of job failure")
+    message: Optional[StrictStr] = Field(default='', description="The message associated with the executed job if it failed")
     source: Optional[StrictStr] = Field(default='', description="The source application of an exception that caused a job to fail (if applicable).")
-    traceback: Optional[StrictStr] = ''
+    traceback: Optional[StrictStr] = Field(default='', description="The traceback of the exception")
     __properties: ClassVar[List[str]] = ["status", "session_id", "trace_id", "message", "source", "traceback"]
 
-    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:
@@ -56,7 +53,7 @@ class JobPatch(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 JobPatch from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
@@ -70,16 +67,18 @@ class JobPatch(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 JobPatch from a dict"""
         if obj is None:
             return None

compute_api_client/models/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 JobStatus(str, Enum):

compute_api_client/models/language.py

@@ -17,29 +17,26 @@ 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
-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 Language(BaseModel):
     """
     Language
     """ # noqa: E501
-    id: StrictInt
-    name: Annotated[str, Field(strict=True, max_length=64)]
-    version: Annotated[str, Field(strict=True, max_length=16)]
+    id: StrictInt = Field(description="The ID of the language")
+    name: Annotated[str, Field(strict=True, max_length=64)] = Field(description="Name of the language")
+    version: Annotated[str, Field(strict=True, max_length=16)] = Field(description="Version of the language")
     __properties: ClassVar[List[str]] = ["id", "name", "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:
@@ -52,7 +49,7 @@ class Language(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 Language from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
@@ -66,16 +63,18 @@ class Language(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 Language from a dict"""
         if obj is None:
             return None