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

compute_api_client/docs/ValidationErrorLocInner.md

@@ -0,0 +1,28 @@
+# ValidationErrorLocInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Example
+
+```python
+from compute_api_client.models.validation_error_loc_inner import ValidationErrorLocInner
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ValidationErrorLocInner from a JSON string
+validation_error_loc_inner_instance = ValidationErrorLocInner.from_json(json)
+# print the JSON string representation of the object
+print(ValidationErrorLocInner.to_json())
+
+# convert the object into a dict
+validation_error_loc_inner_dict = validation_error_loc_inner_instance.to_dict()
+# create an instance of ValidationErrorLocInner from a dict
+validation_error_loc_inner_from_dict = ValidationErrorLocInner.from_dict(validation_error_loc_inner_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

compute_api_client/exceptions.py

@@ -0,0 +1,216 @@
+# 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 typing import Any, Optional
+from typing_extensions import Self
+
+class OpenApiException(Exception):
+    """The base exception class for all OpenAPIExceptions"""
+
+
+class ApiTypeError(OpenApiException, TypeError):
+    def __init__(self, msg, path_to_item=None, valid_classes=None,
+                 key_type=None) -> None:
+        """ Raises an exception for TypeErrors
+
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (list): a list of keys an indices to get to the
+                                 current_item
+                                 None if unset
+            valid_classes (tuple): the primitive classes that current item
+                                   should be an instance of
+                                   None if unset
+            key_type (bool): False if our value is a value in a dict
+                             True if it is a key in a dict
+                             False if our item is an item in a list
+                             None if unset
+        """
+        self.path_to_item = path_to_item
+        self.valid_classes = valid_classes
+        self.key_type = key_type
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiTypeError, self).__init__(full_msg)
+
+
+class ApiValueError(OpenApiException, ValueError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (list) the path to the exception in the
+                received_data dict. None if unset
+        """
+
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiValueError, self).__init__(full_msg)
+
+
+class ApiAttributeError(OpenApiException, AttributeError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Raised when an attribute reference or assignment fails.
+
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (None/list) the path to the exception in the
+                received_data dict
+        """
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiAttributeError, self).__init__(full_msg)
+
+
+class ApiKeyError(OpenApiException, KeyError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (None/list) the path to the exception in the
+                received_data dict
+        """
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiKeyError, self).__init__(full_msg)
+
+
+class ApiException(OpenApiException):
+
+    def __init__(
+        self, 
+        status=None, 
+        reason=None, 
+        http_resp=None,
+        *,
+        body: Optional[str] = None,
+        data: Optional[Any] = None,
+    ) -> None:
+        self.status = status
+        self.reason = reason
+        self.body = body
+        self.data = data
+        self.headers = None
+
+        if http_resp:
+            if self.status is None:
+                self.status = http_resp.status
+            if self.reason is None:
+                self.reason = http_resp.reason
+            if self.body is None:
+                try:
+                    self.body = http_resp.data.decode('utf-8')
+                except Exception:
+                    pass
+            self.headers = http_resp.getheaders()
+
+    @classmethod
+    def from_response(
+        cls, 
+        *, 
+        http_resp, 
+        body: Optional[str], 
+        data: Optional[Any],
+    ) -> Self:
+        if http_resp.status == 400:
+            raise BadRequestException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 401:
+            raise UnauthorizedException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 403:
+            raise ForbiddenException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 404:
+            raise NotFoundException(http_resp=http_resp, body=body, data=data)
+
+        # Added new conditions for 409 and 422
+        if http_resp.status == 409:
+            raise ConflictException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 422:
+            raise UnprocessableEntityException(http_resp=http_resp, body=body, data=data)
+
+        if 500 <= http_resp.status <= 599:
+            raise ServiceException(http_resp=http_resp, body=body, data=data)
+        raise ApiException(http_resp=http_resp, body=body, data=data)
+
+    def __str__(self):
+        """Custom error messages for exception"""
+        error_message = "({0})\n"\
+                        "Reason: {1}\n".format(self.status, self.reason)
+        if self.headers:
+            error_message += "HTTP response headers: {0}\n".format(
+                self.headers)
+
+        if self.data or self.body:
+            error_message += "HTTP response body: {0}\n".format(self.data or self.body)
+
+        return error_message
+
+
+class BadRequestException(ApiException):
+    pass
+
+
+class NotFoundException(ApiException):
+    pass
+
+
+class UnauthorizedException(ApiException):
+    pass
+
+
+class ForbiddenException(ApiException):
+    pass
+
+
+class ServiceException(ApiException):
+    pass
+
+
+class ConflictException(ApiException):
+    """Exception for HTTP 409 Conflict."""
+    pass
+
+
+class UnprocessableEntityException(ApiException):
+    """Exception for HTTP 422 Unprocessable Entity."""
+    pass
+
+
+def render_path(path_to_item):
+    """Returns a string representation of a path"""
+    result = ""
+    for pth in path_to_item:
+        if isinstance(pth, int):
+            result += "[{0}]".format(pth)
+        else:
+            result += "['{0}']".format(pth)
+    return result

compute_api_client/models/__init__.py

@@ -0,0 +1,84 @@
+# coding: utf-8
+
+# flake8: noqa
+"""
+    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
+
+
+# import models into model package
+from compute_api_client.models.algorithm import Algorithm
+from compute_api_client.models.algorithm_in import AlgorithmIn
+from compute_api_client.models.algorithm_type import AlgorithmType
+from compute_api_client.models.auth_config import AuthConfig
+from compute_api_client.models.backend import Backend
+from compute_api_client.models.backend_in import BackendIn
+from compute_api_client.models.backend_message import BackendMessage
+from compute_api_client.models.backend_patch import BackendPatch
+from compute_api_client.models.backend_status import BackendStatus
+from compute_api_client.models.backend_type import BackendType
+from compute_api_client.models.backend_type_patch import BackendTypePatch
+from compute_api_client.models.backend_with_authentication import BackendWithAuthentication
+from compute_api_client.models.batch_job import BatchJob
+from compute_api_client.models.batch_job_in import BatchJobIn
+from compute_api_client.models.batch_job_status import BatchJobStatus
+from compute_api_client.models.commit import Commit
+from compute_api_client.models.commit_in import CommitIn
+from compute_api_client.models.compile_payload import CompilePayload
+from compute_api_client.models.compile_stage import CompileStage
+from compute_api_client.models.domain import Domain
+from compute_api_client.models.file import File
+from compute_api_client.models.file_in import FileIn
+from compute_api_client.models.final_result import FinalResult
+from compute_api_client.models.final_result_in import FinalResultIn
+from compute_api_client.models.http_bad_request_error import HTTPBadRequestError
+from compute_api_client.models.http_not_found_error import HTTPNotFoundError
+from compute_api_client.models.http_validation_error import HTTPValidationError
+from compute_api_client.models.job import Job
+from compute_api_client.models.job_in import JobIn
+from compute_api_client.models.job_patch import JobPatch
+from compute_api_client.models.job_status import JobStatus
+from compute_api_client.models.language import Language
+from compute_api_client.models.member import Member
+from compute_api_client.models.member_in import MemberIn
+from compute_api_client.models.page_algorithm import PageAlgorithm
+from compute_api_client.models.page_backend import PageBackend
+from compute_api_client.models.page_backend_type import PageBackendType
+from compute_api_client.models.page_batch_job import PageBatchJob
+from compute_api_client.models.page_commit import PageCommit
+from compute_api_client.models.page_file import PageFile
+from compute_api_client.models.page_job import PageJob
+from compute_api_client.models.page_language import PageLanguage
+from compute_api_client.models.page_member import PageMember
+from compute_api_client.models.page_permission import PagePermission
+from compute_api_client.models.page_permission_group import PagePermissionGroup
+from compute_api_client.models.page_project import PageProject
+from compute_api_client.models.page_reservation import PageReservation
+from compute_api_client.models.page_result import PageResult
+from compute_api_client.models.page_team import PageTeam
+from compute_api_client.models.page_transaction import PageTransaction
+from compute_api_client.models.page_user import PageUser
+from compute_api_client.models.permission import Permission
+from compute_api_client.models.permission_group import PermissionGroup
+from compute_api_client.models.project import Project
+from compute_api_client.models.project_in import ProjectIn
+from compute_api_client.models.project_patch import ProjectPatch
+from compute_api_client.models.reservation import Reservation
+from compute_api_client.models.reservation_in import ReservationIn
+from compute_api_client.models.result import Result
+from compute_api_client.models.result_in import ResultIn
+from compute_api_client.models.role import Role
+from compute_api_client.models.share_type import ShareType
+from compute_api_client.models.team import Team
+from compute_api_client.models.transaction import Transaction
+from compute_api_client.models.user import User
+from compute_api_client.models.user_in import UserIn
+from compute_api_client.models.validation_error import ValidationError
+from compute_api_client.models.validation_error_loc_inner import ValidationErrorLocInner

compute_api_client/models/algorithm.py

@@ -0,0 +1,105 @@
+# 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, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from compute_api_client.models.algorithm_type import AlgorithmType
+from compute_api_client.models.share_type import ShareType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Algorithm(BaseModel):
+    """
+    Algorithm
+    """ # noqa: E501
+    id: StrictInt = Field(description="ID of the algorithm")
+    project_id: StrictInt = Field(description="ID of the project")
+    type: AlgorithmType = Field(description="The type of algorithm i.e. hybrid or quantum")
+    shared: ShareType = Field(description="The sharing scope of the algorithm")
+    link: Optional[Annotated[str, Field(strict=True, max_length=255)]]
+    name: Annotated[str, Field(strict=True, max_length=255)] = Field(description="Name of the algorithm")
+    __properties: ClassVar[List[str]] = ["id", "project_id", "type", "shared", "link", "name"]
+
+    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 Algorithm 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,
+        )
+        # set to None if link (nullable) is None
+        # and model_fields_set contains the field
+        if self.link is None and "link" in self.model_fields_set:
+            _dict['link'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Algorithm 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"),
+            "project_id": obj.get("project_id"),
+            "type": obj.get("type"),
+            "shared": obj.get("shared"),
+            "link": obj.get("link"),
+            "name": obj.get("name")
+        })
+        return _obj
+
+

compute_api_client/models/algorithm_in.py

@@ -0,0 +1,103 @@
+# 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, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from compute_api_client.models.algorithm_type import AlgorithmType
+from compute_api_client.models.share_type import ShareType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AlgorithmIn(BaseModel):
+    """
+    AlgorithmIn
+    """ # noqa: E501
+    project_id: StrictInt = Field(description="ID of the project")
+    type: AlgorithmType = Field(description="The type of algorithm i.e. hybrid or quantum")
+    shared: ShareType = Field(description="The sharing scope of the algorithm")
+    link: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None
+    name: Annotated[str, Field(strict=True, max_length=255)] = Field(description="The name of the algorithm")
+    __properties: ClassVar[List[str]] = ["project_id", "type", "shared", "link", "name"]
+
+    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 AlgorithmIn 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,
+        )
+        # set to None if link (nullable) is None
+        # and model_fields_set contains the field
+        if self.link is None and "link" in self.model_fields_set:
+            _dict['link'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AlgorithmIn from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "project_id": obj.get("project_id"),
+            "type": obj.get("type"),
+            "shared": obj.get("shared"),
+            "link": obj.get("link"),
+            "name": obj.get("name")
+        })
+        return _obj
+
+

compute_api_client/models/algorithm_type.py

@@ -0,0 +1,37 @@
+# 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 AlgorithmType(str, Enum):
+    """
+    AlgorithmType
+    """
+
+    """
+    allowed enum values
+    """
+    HYBRID = 'hybrid'
+    QUANTUM = 'quantum'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of AlgorithmType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

compute_api_client/models/auth_config.py

@@ -0,0 +1,91 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AuthConfig(BaseModel):
+    """
+    AuthConfig
+    """ # noqa: E501
+    client_id: StrictStr
+    audience: StrictStr
+    well_known_endpoint: StrictStr
+    __properties: ClassVar[List[str]] = ["client_id", "audience", "well_known_endpoint"]
+
+    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 AuthConfig 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 AuthConfig from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "client_id": obj.get("client_id"),
+            "audience": obj.get("audience"),
+            "well_known_endpoint": obj.get("well_known_endpoint")
+        })
+        return _obj
+
+