polyapi 0.0.5__tar.gz → 5.9.20__tar.gz

{polyapi-0.0.5 → polyapi-5.9.20}/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright 2020 Polymatica Rus LLC
+Copyright 2020-2025 Polymatica Rus LLC
 
 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.

polyapi-5.9.20/PKG-INFO

@@ -0,0 +1,73 @@
+Metadata-Version: 2.4
+Name: polyapi
+Version: 5.9.20
+Summary: Wrapper for Polymatica API
+Home-page: https://slsoft.ru/products/polymatica/
+Author: Polymatica Rus LLC
+Author-email: polymatica_support@slsoft.ru
+License: MIT
+Keywords: polymatica
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: OS Independent
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+License-File: LICENSE.txt
+Requires-Dist: setuptools
+Requires-Dist: numpy==1.19.5; python_version < "3.9"
+Requires-Dist: numpy>1.21.1; python_version >= "3.9"
+Requires-Dist: pandas<=1.2.5,>=1.1.5; python_version < "3.9"
+Requires-Dist: pandas>2.0.0; python_version >= "3.9"
+Requires-Dist: requests>=2.27.1
+Requires-Dist: pydantic<=2.5.3,>=1.9.2
+Requires-Dist: packaging
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: summary
+
+
+# Основные сведения
+Библиотека предназначена для работы с Polymatica API.
+
+# Работа с библиотекой
+Основным модулем бизнес-логики является файл business_scenarios.py, 
+импортировать который можно с помощью команды ``from polymatica import business_scenarios as sc``.
+
+Модуль предоставляет два класса для работы с Полиматикой - ``BusinessLogic`` и ``GetDataChunk``. 
+Методы этих классов можно посмотреть при помощи стандартной функции ``dir()``.
+
+Аргументы функций и прочую docstring-документацию модуля и функций можно посмотреть 
+при помощи стандартной функции ``help()``.
+
+### Инициализация нового клиентского подключения: 
+``session = sc.BusinessLogic(login="your_login", password="your_password", url="polymatica_server_url", **args)``
+
+### Пример создания слоя и воспроизведения сценария на этом слое с использованием PolyAPI
+
+Создадим слой:
+``session.execute_manager_command(command_name="user_layer", state="create_layer")``
+
+Запросим список сценариев:
+``session.execute_manager_command(command_name="scripts", state="get_script_descriptions_list")``
+
+Загрузим сценарий на слой, используя полученные на предыдущих шагах идентификаторы слоя и сценария:
+``session.execute_manager_command(command_name="scripts", state="load_on_layer", runtime_id="d46b7075", script_id="40fc65db", on_load_action=0)``
+
+Воспроизведем сценарий:
+``session.execute_manager_command(command_name="scripts", state="play_to_position", runtime_id="d46b7075", script_id="40fc65db", play_to_position=23, clear_workspace=True)``
+
+Получим статус воспроизведения сценария:
+``session.execute_manager_command(command_name="scripts", state="get_script_status", runtime_id="d46b7075")``
+
+Получили ответ, из которого видим, что сценарий воспроизведен успешно:
+``{'state': 1, 'queries': [{'uuid': '872bdbde-20b9f734-2a5a5ad5-9b08e670', 'command': {'plm_type_code': 227, 'state': 6, 'script_status': {'id': '40fc65db', 'action_name': '', 'status': 3, 'current_step': 24, 'steps_count': 24, 'errors': []}}}]}``
+
+Получим информацию о слое:
+``session.execute_manager_command(command_name="user_layer", state="get_layer", layer_id="d46b7075")``

polyapi-5.9.20/README.md

@@ -0,0 +1,39 @@
+
+# Основные сведения
+Библиотека предназначена для работы с Polymatica API.
+
+# Работа с библиотекой
+Основным модулем бизнес-логики является файл business_scenarios.py, 
+импортировать который можно с помощью команды ``from polymatica import business_scenarios as sc``.
+
+Модуль предоставляет два класса для работы с Полиматикой - ``BusinessLogic`` и ``GetDataChunk``. 
+Методы этих классов можно посмотреть при помощи стандартной функции ``dir()``.
+
+Аргументы функций и прочую docstring-документацию модуля и функций можно посмотреть 
+при помощи стандартной функции ``help()``.
+
+### Инициализация нового клиентского подключения: 
+``session = sc.BusinessLogic(login="your_login", password="your_password", url="polymatica_server_url", **args)``
+
+### Пример создания слоя и воспроизведения сценария на этом слое с использованием PolyAPI
+
+Создадим слой:
+``session.execute_manager_command(command_name="user_layer", state="create_layer")``
+
+Запросим список сценариев:
+``session.execute_manager_command(command_name="scripts", state="get_script_descriptions_list")``
+
+Загрузим сценарий на слой, используя полученные на предыдущих шагах идентификаторы слоя и сценария:
+``session.execute_manager_command(command_name="scripts", state="load_on_layer", runtime_id="d46b7075", script_id="40fc65db", on_load_action=0)``
+
+Воспроизведем сценарий:
+``session.execute_manager_command(command_name="scripts", state="play_to_position", runtime_id="d46b7075", script_id="40fc65db", play_to_position=23, clear_workspace=True)``
+
+Получим статус воспроизведения сценария:
+``session.execute_manager_command(command_name="scripts", state="get_script_status", runtime_id="d46b7075")``
+
+Получили ответ, из которого видим, что сценарий воспроизведен успешно:
+``{'state': 1, 'queries': [{'uuid': '872bdbde-20b9f734-2a5a5ad5-9b08e670', 'command': {'plm_type_code': 227, 'state': 6, 'script_status': {'id': '40fc65db', 'action_name': '', 'status': 3, 'current_step': 24, 'steps_count': 24, 'errors': []}}}]}``
+
+Получим информацию о слое:
+``session.execute_manager_command(command_name="user_layer", state="get_layer", layer_id="d46b7075")``

polyapi-5.9.20/polyapi.egg-info/PKG-INFO

@@ -0,0 +1,73 @@
+Metadata-Version: 2.4
+Name: polyapi
+Version: 5.9.20
+Summary: Wrapper for Polymatica API
+Home-page: https://slsoft.ru/products/polymatica/
+Author: Polymatica Rus LLC
+Author-email: polymatica_support@slsoft.ru
+License: MIT
+Keywords: polymatica
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: OS Independent
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+License-File: LICENSE.txt
+Requires-Dist: setuptools
+Requires-Dist: numpy==1.19.5; python_version < "3.9"
+Requires-Dist: numpy>1.21.1; python_version >= "3.9"
+Requires-Dist: pandas<=1.2.5,>=1.1.5; python_version < "3.9"
+Requires-Dist: pandas>2.0.0; python_version >= "3.9"
+Requires-Dist: requests>=2.27.1
+Requires-Dist: pydantic<=2.5.3,>=1.9.2
+Requires-Dist: packaging
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: summary
+
+
+# Основные сведения
+Библиотека предназначена для работы с Polymatica API.
+
+# Работа с библиотекой
+Основным модулем бизнес-логики является файл business_scenarios.py, 
+импортировать который можно с помощью команды ``from polymatica import business_scenarios as sc``.
+
+Модуль предоставляет два класса для работы с Полиматикой - ``BusinessLogic`` и ``GetDataChunk``. 
+Методы этих классов можно посмотреть при помощи стандартной функции ``dir()``.
+
+Аргументы функций и прочую docstring-документацию модуля и функций можно посмотреть 
+при помощи стандартной функции ``help()``.
+
+### Инициализация нового клиентского подключения: 
+``session = sc.BusinessLogic(login="your_login", password="your_password", url="polymatica_server_url", **args)``
+
+### Пример создания слоя и воспроизведения сценария на этом слое с использованием PolyAPI
+
+Создадим слой:
+``session.execute_manager_command(command_name="user_layer", state="create_layer")``
+
+Запросим список сценариев:
+``session.execute_manager_command(command_name="scripts", state="get_script_descriptions_list")``
+
+Загрузим сценарий на слой, используя полученные на предыдущих шагах идентификаторы слоя и сценария:
+``session.execute_manager_command(command_name="scripts", state="load_on_layer", runtime_id="d46b7075", script_id="40fc65db", on_load_action=0)``
+
+Воспроизведем сценарий:
+``session.execute_manager_command(command_name="scripts", state="play_to_position", runtime_id="d46b7075", script_id="40fc65db", play_to_position=23, clear_workspace=True)``
+
+Получим статус воспроизведения сценария:
+``session.execute_manager_command(command_name="scripts", state="get_script_status", runtime_id="d46b7075")``
+
+Получили ответ, из которого видим, что сценарий воспроизведен успешно:
+``{'state': 1, 'queries': [{'uuid': '872bdbde-20b9f734-2a5a5ad5-9b08e670', 'command': {'plm_type_code': 227, 'state': 6, 'script_status': {'id': '40fc65db', 'action_name': '', 'status': 3, 'current_step': 24, 'steps_count': 24, 'errors': []}}}]}``
+
+Получим информацию о слое:
+``session.execute_manager_command(command_name="user_layer", state="get_layer", layer_id="d46b7075")``

polyapi-5.9.20/polyapi.egg-info/SOURCES.txt

@@ -0,0 +1,53 @@
+LICENSE.txt
+README.md
+pyproject.toml
+setup.cfg
+setup.py
+polyapi.egg-info/PKG-INFO
+polyapi.egg-info/SOURCES.txt
+polyapi.egg-info/dependency_links.txt
+polyapi.egg-info/requires.txt
+polyapi.egg-info/top_level.txt
+polymatica/__init__.py
+polymatica/authorization.py
+polymatica/business_logic_doc.py
+polymatica/business_scenarios.py
+polymatica/error_handler.py
+polymatica/exceptions.py
+polymatica/executor.py
+polymatica/helper.py
+polymatica/commands/__init__.py
+polymatica/commands/base_command.py
+polymatica/commands/olap_module.py
+polymatica/commands/other_modules.py
+polymatica/common/__init__.py
+polymatica/common/consts.py
+polymatica/common/helper_funcs.py
+polymatica/common/params_models.py
+polymatica/graph/__init__.py
+polymatica/graph/base_graph.py
+polymatica/graph/graph_interface.py
+polymatica/graph/types/__init__.py
+polymatica/graph/types/areas.py
+polymatica/graph/types/balls.py
+polymatica/graph/types/chord.py
+polymatica/graph/types/circles.py
+polymatica/graph/types/circles_series.py
+polymatica/graph/types/corridors.py
+polymatica/graph/types/cumulative_areas.py
+polymatica/graph/types/cumulative_cylinders.py
+polymatica/graph/types/cylinders.py
+polymatica/graph/types/graph.py
+polymatica/graph/types/lines.py
+polymatica/graph/types/pies.py
+polymatica/graph/types/point.py
+polymatica/graph/types/point_series.py
+polymatica/graph/types/pools.py
+polymatica/graph/types/pools_3d.py
+polymatica/graph/types/radar.py
+polymatica/graph/types/sankey.py
+polymatica/graph/types/surface.py
+tests/test_create_sphere.py
+tests/test_create_sphere_dims_measures.py
+tests/test_create_sphere_links_multisource.py
+tests/test_update_cube.py

polyapi-5.9.20/polyapi.egg-info/requires.txt

@@ -0,0 +1,12 @@
+setuptools
+requests>=2.27.1
+pydantic<=2.5.3,>=1.9.2
+packaging
+
+[:python_version < "3.9"]
+numpy==1.19.5
+pandas<=1.2.5,>=1.1.5
+
+[:python_version >= "3.9"]
+numpy>1.21.1
+pandas>2.0.0

polyapi-5.9.20/polyapi.egg-info/top_level.txt

@@ -0,0 +1 @@
+polymatica

polyapi-5.9.20/polymatica/__init__.py

@@ -0,0 +1,5 @@
+#!/usr/bin/python3
+""" Пакет работы с Polymatica API """
+from polymatica.business_scenarios import BusinessLogic, GetDataChunk
+
+__all__ = ["BusinessLogic", "GetDataChunk"]

polyapi-5.9.20/polymatica/authorization.py

@@ -0,0 +1,197 @@
+#!/usr/bin/python3
+""" Модуль авторизации в Полиматике """
+
+import json
+from typing import Dict, List, Optional, Tuple
+
+import requests
+
+from .common import request_with_undefined_suffix_url
+from .exceptions import AuthError
+
+
+class Authorization:
+    """Предоставляет возможность авторизации в Полиматике"""
+
+    def login(
+        self,
+        user_name: Optional[str],
+        base_url: str,
+        server_codes: Dict,
+        timeout: float,
+        language: str,
+        suffixes_url: List,
+        is_guest: bool,
+        password: Optional[str],
+        session_id: str = "",
+    ) -> Tuple:
+        """
+        Авторизация (парольная/беспарольная/через идентификатор сессии).
+        В метод может быть передан логин-пароль, тогда на сервер будет отправлена команда 205-2; может быть
+        передан только логин, без пароля, тогда метод получит session_id от сервера и отправит ему 205-1;
+        может быть передан session_id, тогда тоже будет отправлена команда 205-1.
+        :param user_name: имя пользователя.
+        :param base_url: базовый URL стенда Полиматики.
+        :param server_codes: значение файла "server_codes.json", хранящего коды команд и их состояний.
+        :param timeout: тайм-аут выполнения запроса авторизации.
+        :param language: язык локализации; возможны значения: "en" / "ru" / "de" / "fr".
+        :param is_guest: флаг гостевого пользователя при беспарольной авторизации.
+        :param password: пароль пользователя; может быть не задан (None).
+        :param suffixes_url: список возможных суффиксов URL-адреса стенда Полиматики.
+        :param session_id: идентификатор сессии, необязательный параметр.
+        :return: (Tuple) идентификатор сессии, uuid, полная версия Полиматики.
+        """
+        self._check_language(language)
+
+        if not isinstance(suffixes_url, list):
+            raise AuthError('Incorrect "suffixes_url" param: expected list type!')
+        suffixes_url.insert(0, "")
+
+        auth_manager_command = server_codes.get("manager", {}).get("command", {}).get("authenticate", {})
+        auth_command = auth_manager_command.get("id")
+        auth_check = auth_manager_command.get("state", {}).get("check")
+        auth_login = auth_manager_command.get("state", {}).get("login")
+        locale_value = server_codes.get("locale", {}).get(language)
+
+        # для авторизации без пароля формируем id сессии для беспарольного пользователя
+        if session_id == "" and password is None:
+            is_guest_str = self._check_guest(is_guest)
+            login_url = f"{base_url}login?login={user_name}&is_guest={is_guest_str}"
+            r = requests.get(url=login_url)
+            if not r.ok:
+                msg = (
+                    'Stand "{}" not supporting non-password authorization. Please, specify the password! '
+                    'Details: Code: {}, Reason: "{}", Text: {}'.format(
+                        base_url,
+                        r.status_code,
+                        r.reason,
+                        "<empty>" if not r.text else r.text,
+                    )
+                )
+                raise AuthError(msg)
+            else:
+                try:
+                    response = r.json()
+                except json.decoder.JSONDecodeError:
+                    msg = 'Invalid server response! Details: URL: {}, Code: {}, Reason: "{}", Text: {}'.format(
+                        login_url,
+                        r.status_code,
+                        r.reason,
+                        "<empty>" if not r.text else r.text,
+                    )
+                    raise AuthError(msg)
+            session_id = response.get("session")
+
+        # формирование поля command
+        command = {"plm_type_code": auth_command}
+        if password is None:
+            command.update({"state": auth_check})
+        else:
+            command.update(
+                {
+                    "state": auth_login,
+                    "login": user_name,
+                    "passwd": password,
+                    "locale": locale_value,
+                }
+            )
+
+        # формирование тела и заголовка запроса
+        params = {
+            "state": 0,
+            "session": session_id,
+            "queries": [{"uuid": "00000000-00000000-00000000-00000000", "command": command}],
+        }
+        headers = {"Content-Type": "text/plain; charset=utf-8", "Accept": "text/plain"}
+
+        # отправляем запрос аутентификации на заданный URL
+        r, suffix_url = request_with_undefined_suffix_url(
+            suffixes_url, base_url, self._get_prepare_query(params), timeout, headers
+        )
+
+        # проверки и вывод результата
+        status_code = r.status_code
+        if not r.ok:
+            error_msg = 'Invalid server response (URL: {}, Code: {}, Reason: "{}", Text: {})'.format(
+                r.url, status_code, r.reason, "<empty>" if not r.text else r.text
+            )
+            raise AuthError(error_msg)
+
+        try:
+            json_response = r.json()
+        except json.decoder.JSONDecodeError:
+            raise AuthError("Server response cannot be converted to the JSON format")
+        return self._authorization_checks(params, json_response, status_code, suffix_url)
+
+    def _get_command(self, data: Dict) -> Dict:
+        """
+        Возвращает команду запроса/ответа.
+        """
+        queries = next(iter(data.get("queries")))
+        return queries.get("command")
+
+    def _authorization_checks(self, request: Dict, response: Dict, response_code: int, url_suffix: str) -> Tuple:
+        """
+        Проверка успешности авторизации. Возвращает идентификатор сессии и manager uuid.
+        :param request: (Dict) запрос.
+        :param response: (Dict) ответ.
+        :param response_code: (int) код ответа.
+        :param url_suffix: (str) верное окончание URL-адреса стенда Полиматики.
+        :return: (Tuple) идентификатор сессии, uuid, полная версия Полиматики, url_suffix
+        """
+        # получаем команды и коды запроса/ответа
+        request_command = self._get_command(request)
+        request_code = request_command.get("plm_type_code")
+        resp_command = self._get_command(response)
+        resp_code = resp_command.get("plm_type_code")
+
+        # проверки полученных кодов
+        assert "error" not in resp_command, resp_command.get("error", "No error description!")
+        assert response_code == 200, "Response code != 200"
+        assert (
+            request_code == resp_code
+        ), f"Request plm_type_code ({request_code}) is not equal response plm_type_code ({resp_code})!"
+
+        # проверки идентификаторов session_id и uuid
+        session_id, uuid = resp_command.get("session_id"), resp_command.get("manager_uuid")
+        assert session_id != "", "incorrect session_id specified, such session does not exist!"
+        assert session_id is not None, "session_id is None!"
+        assert uuid != "", "manager_id is empty!"
+        assert uuid is not None, "manager_id is None!"
+
+        return session_id, uuid, resp_command.get("version"), url_suffix
+
+    def _check_language(self, language: str):
+        """
+        Проверка пользовательского значения языка локализации.
+        Если проверка пройдена - ничего не вернёт, в противном случае будет сгенерирована ошибка AuthError.
+        :param locale: (str) пользовательское значение языка.
+        """
+        if language not in ("ru", "en"):
+            error_msg = f'Invalid language! Expected: "ru"/"en", found: "{language}"'
+            raise AuthError(error_msg)
+
+    def _check_guest(self, guest_param: bool) -> str:
+        """
+        Проверка параметра "is_guest": должны быть только булевы значения. В противном случае сгенерируется ошибка.
+        Возвращает строковое значение параметра.
+        """
+        if not isinstance(guest_param, bool):
+            error_msg = f'Invalid "is_guest" param! Expected: True/False, found: "{guest_param}"'
+            raise AuthError(error_msg)
+        return "true" if guest_param else "false"
+
+    def _get_prepare_query(self, query: Dict) -> str:
+        """
+        Подготовка тела запроса для дальнейшей отправки POST-запросом: обработка кириллицы в логине/пароле.
+        :param query: (Dict) параметры запроса в формате JSON.
+        :return: (str) параметры запроса в формате строки.
+        """
+        params = str(query)
+        return (
+            params.replace("'", '"')
+            .replace("False", "false")
+            .replace("True", "true")
+            .replace("None", "null")
+            .encode("utf-8")
+        )

polyapi-5.9.20/polymatica/business_logic_doc.py

@@ -0,0 +1,104 @@
+#!/usr/bin/python3
+"""
+Базовый класс, описывающий бизнес-сценарии использования Полиматики.
+Используемые переменные класса:
+
+# Флаг работы в Jupiter Notebook
+self.jupiter
+
+# Флаг гостевого пользователя при беспарольной авторизации
+self.is_guest
+
+# Текст ошибки присваивается в случае аварийного завершения работы; может быть удобно при работе в Jupiter Notebook
+self.current_exception
+
+# Версия сервера Полиматики; например, '5.6'
+self.polymatica_version
+
+# Полная версия сервера Полиматики; например, '5.6.14-ab9def0-7799123f-x86_64-centos'
+self.full_polymatica_version
+
+# Язык интерфейса. Задается во время авторизации. Возможно задать следующие значения: "ru", "en".
+# По-умолчанию "ru"
+self.language
+
+# Базовый URL стенда Полиматики (тот, что передаётся в конструктор при инициализации класса)
+self.base_url
+
+# Таймаут выполнения запросов
+self.timeout
+
+# Логин пользователя Полиматики
+self.login
+
+# Для измерения времени работы функций бизнес-логики
+self.func_timing
+
+# Таблица команд и состояний
+self.server_codes
+
+# Идентификатор активного OLAP-модуля (мультисферы)
+self.multisphere_module_id
+
+# Идентификатор куба, соответствующего активному OLAP-модулю
+self.cube_id
+
+# Название куба, соответствующего активному OLAP-модулю
+self.cube_name
+
+# Список идентификаторов всех слоёв
+self.layers_list
+
+# Идентификатор активного слоя
+self.active_layer_id
+
+# Данные мультисферы в формате {"dimensions": "", "facts": "", "data": ""}
+self.multisphere_data
+
+# Общее число строк текущего (активного) OLAP-модуля
+self.total_row
+
+# Идентификатор активного модуля графиков
+self.graph_module_id
+
+# URL стенда Полиматики, использующийся для вызова серверных команд
+self.command_url
+
+# URL стенда Полиматики для обращения к ресурсам
+self.resources_url
+
+# Идентификатор сессии
+self.session_id
+
+# Идентификатор (uuid) авторизации
+self.authorization_uuid
+
+# Класс, выполняющий HTTP-запросы
+self.exec_request
+
+# Объект выполнения команд модуля Manager
+self.manager_command
+
+# Объект выполнения команд модуля OLAP
+self.olap_command
+
+# Объект выполнения команд модуля Graph
+self.graph_command
+
+# Helper class
+self.h
+
+# Сохранённое имя функции для избежания конфликтов с декоратором
+self.func_name
+
+# Содержимое DataFrame
+self.df
+
+# Колонки DataFrame
+self.df_cols
+
+# Вспомогательный класс, перенаправляющий вызовы методов на нужные реализации (в зависимости от версии)
+self.version_redirect
+"""
+
+__name__ = "BusinessLogic"