gamsapi 52.5.0__cp312-cp312-win_amd64.whl

gams/engine/exceptions.py

@@ -0,0 +1,216 @@
+# coding: utf-8
+
+"""
+    GAMS Engine
+
+    With GAMS Engine you can register and solve GAMS models. It has a namespace management system, so you can restrict your users to certain models.
+
+    The version of the OpenAPI document: latest
+    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

gams/engine/models/__init__.py

@@ -0,0 +1,86 @@
+# coding: utf-8
+
+# flake8: noqa
+"""
+    GAMS Engine
+
+    With GAMS Engine you can register and solve GAMS models. It has a namespace management system, so you can restrict your users to certain models.
+
+    The version of the OpenAPI document: latest
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+# import models into model package
+from gams.engine.models.bad_input import BadInput
+from gams.engine.models.cleanable_job_result import CleanableJobResult
+from gams.engine.models.cleanable_job_result_page import CleanableJobResultPage
+from gams.engine.models.engine_license import EngineLicense
+from gams.engine.models.files_not_found import FilesNotFound
+from gams.engine.models.forwarded_token_response import ForwardedTokenResponse
+from gams.engine.models.generic_key_value_pair import GenericKeyValuePair
+from gams.engine.models.hypercube import Hypercube
+from gams.engine.models.hypercube_page import HypercubePage
+from gams.engine.models.hypercube_summary import HypercubeSummary
+from gams.engine.models.hypercube_token import HypercubeToken
+from gams.engine.models.identity_provider import IdentityProvider
+from gams.engine.models.identity_provider_ldap import IdentityProviderLdap
+from gams.engine.models.identity_provider_oauth2 import IdentityProviderOauth2
+from gams.engine.models.identity_provider_oauth2_scope import IdentityProviderOauth2Scope
+from gams.engine.models.identity_provider_oauth2_with_secret import IdentityProviderOauth2WithSecret
+from gams.engine.models.identity_provider_oidc import IdentityProviderOidc
+from gams.engine.models.identity_provider_oidc_with_secret import IdentityProviderOidcWithSecret
+from gams.engine.models.inex import Inex
+from gams.engine.models.invitation import Invitation
+from gams.engine.models.invitation_quota import InvitationQuota
+from gams.engine.models.invitation_token import InvitationToken
+from gams.engine.models.job import Job
+from gams.engine.models.job_no_text_entry import JobNoTextEntry
+from gams.engine.models.job_no_text_entry_page import JobNoTextEntryPage
+from gams.engine.models.license import License
+from gams.engine.models.log_piece import LogPiece
+from gams.engine.models.message import Message
+from gams.engine.models.message_and_token import MessageAndToken
+from gams.engine.models.message_with_webhook_id import MessageWithWebhookId
+from gams.engine.models.model_auth_token import ModelAuthToken
+from gams.engine.models.model_configuration import ModelConfiguration
+from gams.engine.models.model_default_instance import ModelDefaultInstance
+from gams.engine.models.model_default_user_instance import ModelDefaultUserInstance
+from gams.engine.models.model_hypercube_job import ModelHypercubeJob
+from gams.engine.models.model_hypercube_usage import ModelHypercubeUsage
+from gams.engine.models.model_instance_info import ModelInstanceInfo
+from gams.engine.models.model_instance_info_full import ModelInstanceInfoFull
+from gams.engine.models.model_instance_pool_info import ModelInstancePoolInfo
+from gams.engine.models.model_job_labels import ModelJobLabels
+from gams.engine.models.model_job_usage import ModelJobUsage
+from gams.engine.models.model_pool_usage import ModelPoolUsage
+from gams.engine.models.model_usage import ModelUsage
+from gams.engine.models.model_user import ModelUser
+from gams.engine.models.model_userinstance_info import ModelUserinstanceInfo
+from gams.engine.models.model_userinstancepool_info import ModelUserinstancepoolInfo
+from gams.engine.models.model_version import ModelVersion
+from gams.engine.models.models import Models
+from gams.engine.models.namespace import Namespace
+from gams.engine.models.namespace_quota import NamespaceQuota
+from gams.engine.models.namespace_with_permission import NamespaceWithPermission
+from gams.engine.models.not_found import NotFound
+from gams.engine.models.password_policy import PasswordPolicy
+from gams.engine.models.perm_and_username import PermAndUsername
+from gams.engine.models.quota import Quota
+from gams.engine.models.quota_exceeded import QuotaExceeded
+from gams.engine.models.status_code_meaning import StatusCodeMeaning
+from gams.engine.models.stream_entry import StreamEntry
+from gams.engine.models.system_wide_license import SystemWideLicense
+from gams.engine.models.text_entries import TextEntries
+from gams.engine.models.text_entry import TextEntry
+from gams.engine.models.time_span import TimeSpan
+from gams.engine.models.time_span_pool_worker import TimeSpanPoolWorker
+from gams.engine.models.token_forward_error import TokenForwardError
+from gams.engine.models.user import User
+from gams.engine.models.user_group_member import UserGroupMember
+from gams.engine.models.user_groups import UserGroups
+from gams.engine.models.vapid_info import VapidInfo
+from gams.engine.models.webhook import Webhook
+from gams.engine.models.webhook_parameterized_event import WebhookParameterizedEvent
+

gams/engine/models/bad_input.py

@@ -0,0 +1,89 @@
+# coding: utf-8
+
+"""
+    GAMS Engine
+
+    With GAMS Engine you can register and solve GAMS models. It has a namespace management system, so you can restrict your users to certain models.
+
+    The version of the OpenAPI document: latest
+    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, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BadInput(BaseModel):
+    """
+    BadInput
+    """ # noqa: E501
+    errors: Optional[Dict[str, StrictStr]] = None
+    message: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["errors", "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 BadInput 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 BadInput from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "errors": obj.get("errors"),
+            "message": obj.get("message")
+        })
+        return _obj
+
+

gams/engine/models/cleanable_job_result.py

@@ -0,0 +1,104 @@
+# coding: utf-8
+
+"""
+    GAMS Engine
+
+    With GAMS Engine you can register and solve GAMS models. It has a namespace management system, so you can restrict your users to certain models.
+
+    The version of the OpenAPI document: latest
+    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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from gams.engine.models.model_user import ModelUser
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CleanableJobResult(BaseModel):
+    """
+    CleanableJobResult
+    """ # noqa: E501
+    filename: Optional[StrictStr] = None
+    length: Optional[StrictInt] = None
+    namespace: Optional[StrictStr] = None
+    token: Optional[StrictStr] = None
+    type: Optional[StrictStr] = None
+    upload_date: Optional[datetime] = None
+    user: Optional[ModelUser] = None
+    __properties: ClassVar[List[str]] = ["filename", "length", "namespace", "token", "type", "upload_date", "user"]
+
+    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 CleanableJobResult 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 user
+        if self.user:
+            _dict['user'] = self.user.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CleanableJobResult from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "filename": obj.get("filename"),
+            "length": obj.get("length"),
+            "namespace": obj.get("namespace"),
+            "token": obj.get("token"),
+            "type": obj.get("type"),
+            "upload_date": obj.get("upload_date"),
+            "user": ModelUser.from_dict(obj["user"]) if obj.get("user") is not None else None
+        })
+        return _obj
+
+

gams/engine/models/cleanable_job_result_page.py

@@ -0,0 +1,113 @@
+# coding: utf-8
+
+"""
+    GAMS Engine
+
+    With GAMS Engine you can register and solve GAMS models. It has a namespace management system, so you can restrict your users to certain models.
+
+    The version of the OpenAPI document: latest
+    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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from gams.engine.models.cleanable_job_result import CleanableJobResult
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CleanableJobResultPage(BaseModel):
+    """
+    CleanableJobResultPage
+    """ # noqa: E501
+    count: Optional[StrictInt] = None
+    next: Optional[StrictStr] = None
+    previous: Optional[StrictStr] = None
+    results: Optional[List[CleanableJobResult]] = None
+    total_length: Optional[StrictInt] = None
+    __properties: ClassVar[List[str]] = ["count", "next", "previous", "results", "total_length"]
+
+    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 CleanableJobResultPage 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 item in results (list)
+        _items = []
+        if self.results:
+            for _item_results in self.results:
+                if _item_results:
+                    _items.append(_item_results.to_dict())
+            _dict['results'] = _items
+        # set to None if next (nullable) is None
+        # and model_fields_set contains the field
+        if self.next is None and "next" in self.model_fields_set:
+            _dict['next'] = None
+
+        # set to None if previous (nullable) is None
+        # and model_fields_set contains the field
+        if self.previous is None and "previous" in self.model_fields_set:
+            _dict['previous'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CleanableJobResultPage from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "count": obj.get("count"),
+            "next": obj.get("next"),
+            "previous": obj.get("previous"),
+            "results": [CleanableJobResult.from_dict(_item) for _item in obj["results"]] if obj.get("results") is not None else None,
+            "total_length": obj.get("total_length")
+        })
+        return _obj
+
+