gamsapi 52.5.0__cp312-cp312-win_amd64.whl

gams/engine/models/webhook_parameterized_event.py

@@ -0,0 +1,99 @@
+# 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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class WebhookParameterizedEvent(BaseModel):
+    """
+    WebhookParameterizedEvent
+    """ # noqa: E501
+    event: Optional[StrictStr] = None
+    parameters: Optional[List[StrictStr]] = None
+    __properties: ClassVar[List[str]] = ["event", "parameters"]
+
+    @field_validator('event')
+    def event_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['ALL', 'JOB_FINISHED', 'HC_JOB_FINISHED', 'JOB_OUT_OF_RESOURCES', 'HC_JOB_OUT_OF_RESOURCES', 'VOLUME_QUOTA_THRESHOLD', 'JOB_DURATION_THRESHOLD', 'HC_JOB_DURATION_THRESHOLD', 'INVALIDATE_CACHE']):
+            raise ValueError("must be one of enum values ('ALL', 'JOB_FINISHED', 'HC_JOB_FINISHED', 'JOB_OUT_OF_RESOURCES', 'HC_JOB_OUT_OF_RESOURCES', 'VOLUME_QUOTA_THRESHOLD', 'JOB_DURATION_THRESHOLD', 'HC_JOB_DURATION_THRESHOLD', 'INVALIDATE_CACHE')")
+        return value
+
+    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 WebhookParameterizedEvent 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 WebhookParameterizedEvent from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "event": obj.get("event"),
+            "parameters": obj.get("parameters")
+        })
+        return _obj
+
+

gams/engine/rest.py

@@ -0,0 +1,258 @@
+# 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
+
+
+import io
+import json
+import re
+import ssl
+
+import urllib3
+
+from gams.engine.exceptions import ApiException, ApiValueError
+
+SUPPORTED_SOCKS_PROXIES = {"socks5", "socks5h", "socks4", "socks4a"}
+RESTResponseType = urllib3.HTTPResponse
+
+
+def is_socks_proxy_url(url):
+    if url is None:
+        return False
+    split_section = url.split("://")
+    if len(split_section) < 2:
+        return False
+    else:
+        return split_section[0].lower() in SUPPORTED_SOCKS_PROXIES
+
+
+class RESTResponse(io.IOBase):
+
+    def __init__(self, resp) -> None:
+        self.response = resp
+        self.status = resp.status
+        self.reason = resp.reason
+        self.data = None
+
+    def read(self):
+        if self.data is None:
+            self.data = self.response.data
+        return self.data
+
+    def getheaders(self):
+        """Returns a dictionary of the response headers."""
+        return self.response.headers
+
+    def getheader(self, name, default=None):
+        """Returns a given response header."""
+        return self.response.headers.get(name, default)
+
+
+class RESTClientObject:
+
+    def __init__(self, configuration) -> None:
+        # urllib3.PoolManager will pass all kw parameters to connectionpool
+        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/poolmanager.py#L75  # noqa: E501
+        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/connectionpool.py#L680  # noqa: E501
+        # Custom SSL certificates and client certificates: http://urllib3.readthedocs.io/en/latest/advanced-usage.html  # noqa: E501
+
+        # cert_reqs
+        if configuration.verify_ssl:
+            cert_reqs = ssl.CERT_REQUIRED
+        else:
+            cert_reqs = ssl.CERT_NONE
+
+        pool_args = {
+            "cert_reqs": cert_reqs,
+            "ca_certs": configuration.ssl_ca_cert,
+            "cert_file": configuration.cert_file,
+            "key_file": configuration.key_file,
+            "ca_cert_data": configuration.ca_cert_data,
+        }
+        if configuration.assert_hostname is not None:
+            pool_args['assert_hostname'] = (
+                configuration.assert_hostname
+            )
+
+        if configuration.retries is not None:
+            pool_args['retries'] = configuration.retries
+
+        if configuration.tls_server_name:
+            pool_args['server_hostname'] = configuration.tls_server_name
+
+
+        if configuration.socket_options is not None:
+            pool_args['socket_options'] = configuration.socket_options
+
+        if configuration.connection_pool_maxsize is not None:
+            pool_args['maxsize'] = configuration.connection_pool_maxsize
+
+        # https pool manager
+        self.pool_manager: urllib3.PoolManager
+
+        if configuration.proxy:
+            if is_socks_proxy_url(configuration.proxy):
+                from urllib3.contrib.socks import SOCKSProxyManager
+                pool_args["proxy_url"] = configuration.proxy
+                pool_args["headers"] = configuration.proxy_headers
+                self.pool_manager = SOCKSProxyManager(**pool_args)
+            else:
+                pool_args["proxy_url"] = configuration.proxy
+                pool_args["proxy_headers"] = configuration.proxy_headers
+                self.pool_manager = urllib3.ProxyManager(**pool_args)
+        else:
+            self.pool_manager = urllib3.PoolManager(**pool_args)
+
+    def request(
+        self,
+        method,
+        url,
+        headers=None,
+        body=None,
+        post_params=None,
+        _request_timeout=None
+    ):
+        """Perform requests.
+
+        :param method: http request method
+        :param url: http request url
+        :param headers: http request headers
+        :param body: request json body, for `application/json`
+        :param post_params: request post parameters,
+                            `application/x-www-form-urlencoded`
+                            and `multipart/form-data`
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        """
+        method = method.upper()
+        assert method in [
+            'GET',
+            'HEAD',
+            'DELETE',
+            'POST',
+            'PUT',
+            'PATCH',
+            'OPTIONS'
+        ]
+
+        if post_params and body:
+            raise ApiValueError(
+                "body parameter cannot be used with post_params parameter."
+            )
+
+        post_params = post_params or {}
+        headers = headers or {}
+
+        timeout = None
+        if _request_timeout:
+            if isinstance(_request_timeout, (int, float)):
+                timeout = urllib3.Timeout(total=_request_timeout)
+            elif (
+                    isinstance(_request_timeout, tuple)
+                    and len(_request_timeout) == 2
+                ):
+                timeout = urllib3.Timeout(
+                    connect=_request_timeout[0],
+                    read=_request_timeout[1]
+                )
+
+        try:
+            # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE`
+            if method in ['POST', 'PUT', 'PATCH', 'OPTIONS']:
+
+                # no content type provided or payload is json
+                content_type = headers.get('Content-Type')
+                if (
+                    not content_type
+                    or re.search('json', content_type, re.IGNORECASE)
+                ):
+                    request_body = None
+                    if body is not None:
+                        request_body = json.dumps(body)
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=request_body,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif content_type == 'application/x-www-form-urlencoded':
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        fields=post_params,
+                        encode_multipart=False,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif content_type == 'multipart/form-data':
+                    # must del headers['Content-Type'], or the correct
+                    # Content-Type which generated by urllib3 will be
+                    # overwritten.
+                    del headers['Content-Type']
+                    # Ensures that dict objects are serialized
+                    post_params = [(a, json.dumps(b)) if isinstance(b, dict) else (a,b) for a, b in post_params]
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        fields=post_params,
+                        encode_multipart=True,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                # Pass a `string` parameter directly in the body to support
+                # other content types than JSON when `body` argument is
+                # provided in serialized form.
+                elif isinstance(body, str) or isinstance(body, bytes):
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=body,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif headers['Content-Type'].startswith('text/') and isinstance(body, bool):
+                    request_body = "true" if body else "false"
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=request_body,
+                        preload_content=False,
+                        timeout=timeout,
+                        headers=headers)
+                else:
+                    # Cannot generate the request from given parameters
+                    msg = """Cannot prepare a request message for provided
+                             arguments. Please check that your arguments match
+                             declared content type."""
+                    raise ApiException(status=0, reason=msg)
+            # For `GET`, `HEAD`
+            else:
+                r = self.pool_manager.request(
+                    method,
+                    url,
+                    fields={},
+                    timeout=timeout,
+                    headers=headers,
+                    preload_content=False
+                )
+        except urllib3.exceptions.SSLError as e:
+            msg = "\n".join([type(e).__name__, str(e)])
+            raise ApiException(status=0, reason=msg)
+
+        return RESTResponse(r)

gams/magic/__init__.py

@@ -0,0 +1,32 @@
+#
+# GAMS - General Algebraic Modeling System Python API
+#
+# Copyright (c) 2017-2026 GAMS Development Corp. <support@gams.com>
+# Copyright (c) 2017-2026 GAMS Software GmbH <support@gams.com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#
+
+__version__ = '0.99'
+from gams.magic.interactive import GamsInteractive
+
+def load_ipython_extension(ipython):
+    from gams.magic.gams_magic import GamsMagic
+    magics = GamsMagic(ipython)
+    ipython.register_magics(magics)

gams/magic/gams_magic.py

@@ -0,0 +1,142 @@
+#
+# GAMS - General Algebraic Modeling System Python API
+#
+# Copyright (c) 2017-2026 GAMS Development Corp. <support@gams.com>
+# Copyright (c) 2017-2026 GAMS Software GmbH <support@gams.com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#
+
+from IPython.core.magic import (Magics, magics_class, line_magic, cell_magic, line_cell_magic)
+from IPython.core.magic_arguments import (argument, magic_arguments, parse_argstring)
+import pandas as pd
+
+from gams.magic.interactive import GamsInteractive
+
+
+@magics_class
+class GamsMagic(Magics):
+
+    def __init__(self, shell):
+        # You must call the parent constructor
+        super(GamsMagic, self).__init__(shell)
+        self.shell.user_ns['gams'] = self
+        self._gams_interactive = GamsInteractive()
+
+    def from2dim(self, df, column_names=None):
+        return self._gams_interactive.from2dim(df, column_names)
+
+    def pivot(self, df, index=None, columns=None, values=None):
+        return self._gams_interactive.pivot(df, index, columns, values)
+
+    def pivot2d(self, df):
+        return self._gams_interactive.pivot2d(df)
+
+    def _get_write_all(self):
+        return self._gams_interactive.write_all
+    def _set_write_all(self, value):
+        self._gams_interactive.write_all = value
+    write_all = property(_get_write_all, _set_write_all)
+
+    def _get_read_all(self):
+        return self._gams_interactive.read_all
+    def _set_read_all(self, value):
+        self._gams_interactive.read_all = value
+    read_all = property(_get_read_all, _set_read_all)    
+    
+    def _get_exchange_container(self):
+        return self._gams_interactive.exchange_container
+    exchange_container = property(_get_exchange_container)
+
+    def _get_active_name(self):
+        return self._gams_interactive.active
+    active = property(_get_active_name)
+
+    def create(self, name, activate=True):
+        self._gams_interactive.create(name, activate)
+
+    def activate(self, name):
+        self._gams_interactive.activate(name)
+
+    def _get_job_prefix(self):
+        self._gams_interactive._get_job_prefix()
+
+    def _new_job_name(self):
+        self._gams_interactive._new_job_name()
+
+    @magic_arguments()
+    @argument( "--system_directory", "-s", help=("GAMS system directory"))
+    @line_magic
+    def gams_reset(self, line=""):
+        args = parse_argstring(self.gams_reset, line)
+        self.reset(args.system_directory)
+
+    def reset(self, system_directory=None):
+        self._gams_interactive.reset(system_directory)
+
+    @line_magic
+    def gams_log(self, line):
+        self._gams_interactive.gams_log()
+
+    @magic_arguments()
+    @argument(
+        '-e', '--execution', action='store_true'
+    )
+    @line_magic
+    def gams_lst(self, line):
+        args = parse_argstring(self.gams_lst, line)
+        self._gams_interactive.gams_lst(bool(args.execution))
+
+    @magic_arguments()
+    @argument(
+        '-a', '--all', action='store_true'
+    )
+    @argument(
+        '-k', '--keep', action='store_true'
+    )
+    @argument(
+        '-c', '--closedown', action='store_true'
+    )
+    @line_magic
+    def gams_cleanup(self, line=""):
+        args = parse_argstring(self.gams_cleanup, line)
+        self._gams_interactive.gams_cleanup(args.closedown, args.all, args.keep)
+
+    def _parse_trace_file(self, trc_file):
+        return self._gams_interactivate._parse_trace_file(trc_file)
+
+    def _get_description(self, sym):
+        return self._gams_interactivate._get_description(sym)
+
+    def _get_dom_str(self, sym):
+        return self._gams_interactivate._get_dom_str(sym)
+
+    def _get_dom(self, m, sym):
+        return self._gams_interactivate._get_dom(m, sym)
+
+    @line_cell_magic
+    def gams(self, line, cell=None):
+        line = line.strip()
+        code = []
+        if line:
+            code.append(line)
+        if cell:
+            code.append(cell)
+        code = "\n".join(code)
+        return self._gams_interactive.gams(code)