gnpy-api 0.0.0__py3-none-any.whl

gnpy_api-0.0.0.dist-info/METADATA

@@ -0,0 +1,78 @@
+Metadata-Version: 2.4
+Name: gnpy-api
+Version: 0.0.0
+Home-page: https://github.com/Telecominfraproject/oopt-gnpy-api
+Author: Telecom Infra Project
+Author-email: adamico@nec-labs.com
+License: BSD-3-Clause
+Project-URL: Bug Tracker, https://github.com/Telecominfraproject/oopt-gnpy-api/issues
+Project-URL: Documentation, https://gnpyapi.readthedocs.io/
+Keywords: optics,network,fiber,communication,route,planning,optimization,api
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Telecommunications Industry
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Topic :: System :: Networking
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown; variant=GFM
+License-File: LICENSE
+License-File: AUTHORS
+Requires-Dist: setuptools
+Requires-Dist: gnpy==2.12.1
+Requires-Dist: flask>=1.1.2
+Requires-Dist: Flask-Injector
+Requires-Dist: pyopenssl==25.0.0
+Provides-Extra: tests
+Requires-Dist: build<2,>=1.0.3; extra == "tests"
+Requires-Dist: pytest<8,>=7.4.3; extra == "tests"
+Requires-Dist: pyang<3,>=2.6.1; extra == "tests"
+Provides-Extra: docs
+Requires-Dist: alabaster<1,>=0.7.12; extra == "docs"
+Requires-Dist: docutils<1,>=0.17.1; extra == "docs"
+Requires-Dist: myst-parser<1,>=0.16.1; extra == "docs"
+Requires-Dist: Pygments<3,>=2.11.2; extra == "docs"
+Requires-Dist: rstcheck; extra == "docs"
+Requires-Dist: Sphinx<6,>=5.3.0; extra == "docs"
+Requires-Dist: sphinxcontrib-bibtex<3,>=2.4.1; extra == "docs"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-python
+
+# GNPy API
+[![Python versions](https://img.shields.io/pypi/pyversions/gnpy)](https://pypi.org/project/gnpy/)
+
+REST API (experimental)
+-----------------------
+``gnpyapi`` provides an experimental api for requesting several paths at once. It is based on Flask server.
+You can run it through command line or Docker.
+
+
+
+    $ curl --location 'http://localhost:8080/api/v1/path-request' --header 'Content-Type: application/json' --data @gnpyapi/exampledata/planning_demand_example.json 
+
+TODO: api documentation, unit tests, real WSGI server with trusted certificates
+
+## Quick Start
+
+tbd
+

gnpy_api-0.0.0.dist-info/RECORD

@@ -0,0 +1,40 @@
+gnpy_api-0.0.0.dist-info/licenses/AUTHORS,sha256=VP1D1A_-JYIc3kvJtwEUQkkMgjOl09IgrTH1GyzxjPI,36
+gnpy_api-0.0.0.dist-info/licenses/LICENSE,sha256=cEDonVncyb0p8F7f57_25_rcOTxaWOPY8TTri-CkNTc,1508
+gnpyapi/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+gnpyapi/core/__init__.py,sha256=QQOebt2JqesPW7YKguN2bRa_WifHtPHSAMtQXo8tgms,241
+gnpyapi/core/exception/__init__.py,sha256=Hc0g8HMsO3WRghOQdRyaLC9zjc2pRrVAB24uYcIfmH0,16
+gnpyapi/core/exception/config_error.py,sha256=8rBUTNs1oflTZPdbUc4p1fntD6NjRQbdvQlx-qTgES0,286
+gnpyapi/core/exception/equipment_error.py,sha256=16XowWrrwGDIquqxYmM7oUZPrsjxd3TEiPGqs5WHiSE,280
+gnpyapi/core/exception/exception_handler.py,sha256=6SKxhqOjH0lx-sFw3ljPt9blODH7xUtgnFLwdH3pmPM,1069
+gnpyapi/core/exception/path_computation_error.py,sha256=r2NXIzOWktLwilqSKM-S-YCblry05VEkJTgSdbPxNhA,299
+gnpyapi/core/exception/topology_error.py,sha256=WlY97n8uba5fB73Eu2nDpEyN6v5g1EJ-gDL_9s_7lxI,277
+gnpyapi/core/model/__init__.py,sha256=Hc0g8HMsO3WRghOQdRyaLC9zjc2pRrVAB24uYcIfmH0,16
+gnpyapi/core/model/error.py,sha256=zAIahu9qwIsChuhrnHWpQee3noNDcCLPQbKxmE0RFMM,481
+gnpyapi/core/model/result.py,sha256=Te-u9PuZY4pdle39h03IT-6jTWYDwdVi9r5w-opyb0Y,173
+gnpyapi/core/route/__init__.py,sha256=Hc0g8HMsO3WRghOQdRyaLC9zjc2pRrVAB24uYcIfmH0,16
+gnpyapi/core/route/path_request_route.py,sha256=RASAwlNnMmcUFkfgxU1BPtyxpTOIaIQffkOjjqzjPHg,988
+gnpyapi/core/route/status_route.py,sha256=2gVoBXpo-16lmCvcnpq-S0WysNaUKFrrbn-bZbxnoRw,207
+gnpyapi/core/service/__init__.py,sha256=Hc0g8HMsO3WRghOQdRyaLC9zjc2pRrVAB24uYcIfmH0,16
+gnpyapi/core/service/config_service.py,sha256=t3SJ3KRmiJb_PWOZuuzm4pb1tvCZb6a8Pd9HwREC868,74
+gnpyapi/core/service/equipment_service.py,sha256=7auoi_WdPM9YU_Z9f1sil_ECzrU96kP9N67F2F-DeEY,77
+gnpyapi/core/service/path_request_service.py,sha256=h4J9KukBE1mgrfDFxJYtzo1_WS5NVt2zGE6fWGNlQNc,1315
+gnpyapi/core/service/topology_service.py,sha256=RbY3sH4XAAcK_Gok35-uAgQ5DoavKuKR6DNdib8ThQE,76
+gnpyapi/exampledata/planning_demand_example.json,sha256=3RMJyvx9MaEnmDI6mE3LrCLze0PZ02PFGsLtQuonl0k,52086
+gnpyapi/tools/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+gnpyapi/yang/gnpy-api@2021-01-06.yang,sha256=zBRxQnn9mL2mA8W-su_Om2LGJtCiuZZ83qUNR6XR_Do,1817
+gnpyapi/yang/gnpy-eqpt-config@2020-10-22.yang,sha256=l39oJ6R_lxFxYM8t9-Ydvzv4JTDjQDjj5PNR2wGMCu4,9582
+gnpyapi/yang/gnpy-eqpt-config@2025-01-20.yang,sha256=ZoZiegd-2S7HSgWx8HUAg_0r56C37PrBthw8Q1Hg_2g,18954
+gnpyapi/yang/gnpy-network-topology@2020-10-22.yang,sha256=6AMEsA_tAU8v_-ZpFD7DtESoQ5H2Mpx3ImdEkg91lh8,5901
+gnpyapi/yang/gnpy-network-topology@2025-01-20.yang,sha256=Zgk1duD426buLNd2qCFYRhuJgyE9NfbQRTltG-gBMa8,13312
+gnpyapi/yang/gnpy-path-computation-simplified@2020-10-22.yang,sha256=DNrK_EUSW61kVsj-DhpM_XJgpbKtc4_LEtElIEyAR-E,14435
+gnpyapi/yang/gnpy-path-computation@2025-01-21.yang,sha256=ayLYz7DC3exogGWqSEv2aoUoaxdmfigXi9Vug1iKKcA,15148
+gnpyapi/yang/ietf-layer0-types@2024-03-04.yang,sha256=Ls7obP0ltyBqnzdKXbbXOYo6d-2Ye3myQD0WDwTl8a4,66052
+gnpyapi/yang/ietf-optical-impairment-topology@2024-05-21.yang,sha256=v3wE9tGcexQmdxRiAq4VPNL1XJuub5lNWHEj5lFXtHk,62035
+gnpyapi/yang/ietf-routing-types@2017-12-04.yang,sha256=v6PUizT3btVEAGpMXYdzYg4WRXSyT2OVre8Qwuy2z74,24480
+gnpyapi/yang/ietf-te-topology@2020-08-06.yang,sha256=f4nGBPahXT8JM_erFyChf92uejqmRrD0L4qUT_uZWTw,58841
+gnpyapi/yang/ietf-te-types@2022-10-21.yang,sha256=E8vBrKPGvsQruOPRhD6nEbEsDB39Ktz3DWVDAz9WEIs,104223
+gnpy_api-0.0.0.dist-info/METADATA,sha256=Rr9w9IRGn8yyPlNSF3lyMVGBdTkdS8oosLpyR3W4rt0,2935
+gnpy_api-0.0.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+gnpy_api-0.0.0.dist-info/pbr.json,sha256=SbHTygR5eU601azgsndj9fyL6GpBxx3ja7mfWMIT3g8,47
+gnpy_api-0.0.0.dist-info/top_level.txt,sha256=Yq6ziGLLjNZbDSPguICvEMWftNr5FIGJz7GiiD9PhXE,8
+gnpy_api-0.0.0.dist-info/RECORD,,

gnpy_api-0.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (78.1.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

gnpy_api-0.0.0.dist-info/licenses/AUTHORS

@@ -0,0 +1 @@
+AndreaDAmico <adamico@nec-labs.com>

gnpy_api-0.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2025, Telecom Infra Project
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

gnpy_api-0.0.0.dist-info/pbr.json

@@ -0,0 +1 @@
+{"git_version": "f9f7ba5", "is_release": false}

gnpy_api-0.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+gnpyapi

gnpyapi/core/__init__.py

@@ -0,0 +1,12 @@
+#!/usr/bin/env python
+
+"""GNPy official API
+"""
+from flask import Flask
+
+API_VERSION = "/api/v0.1"
+
+app = Flask(__name__)
+
+import gnpyapi.core.route.path_request_route  # noqa: E402
+import gnpyapi.core.route.status_route  # noqa: F401, E402

gnpyapi/core/exception/__init__.py

@@ -0,0 +1 @@
+# coding: utf-8

gnpyapi/core/exception/config_error.py

@@ -0,0 +1,14 @@
+# coding: utf-8
+
+
+class ConfigError(Exception):
+    """ Exception raise for configuration file error
+    Attributes:
+        message -- explanation of the error
+    """
+
+    def __init__(self, message):
+        self.message = message
+
+    def __str__(self):
+        return self.message

gnpyapi/core/exception/equipment_error.py

@@ -0,0 +1,14 @@
+# coding: utf-8
+
+
+class EquipmentError(Exception):
+    """ Exception raise for equipment error
+    Attributes:
+        message -- explanation of the error
+    """
+
+    def __init__(self, message):
+        self.message = message
+
+    def __str__(self):
+        return self.message

gnpyapi/core/exception/exception_handler.py

@@ -0,0 +1,34 @@
+# coding: utf-8
+import json
+import re
+
+import werkzeug
+
+from gnpyapi.core.model.error import Error
+
+_reaesc = re.compile(r'\x1b[^m]*m')
+
+
+def common_error_handler(exception):
+    """
+
+    :type exception: Exception
+
+    """
+    status_code = 500
+    if not isinstance(exception, werkzeug.exceptions.HTTPException):
+        exception = werkzeug.exceptions.InternalServerError()
+        exception.description = "Something went wrong on our side."
+    else:
+        status_code = exception.code
+    response = Error(message=exception.name, description=exception.description,
+                     code=status_code)
+
+    return werkzeug.Response(response=json.dumps(response.__dict__), status=status_code, mimetype='application/json')
+
+
+def bad_request_handler(exception):
+    exception_str = " ".join(str(exception).split())
+    response = Error(message='bad request', description=_reaesc.sub('', exception_str.replace("\n", " ")),
+                     code=400)
+    return werkzeug.Response(response=json.dumps(response.__dict__), status=400, mimetype='application/json')

gnpyapi/core/exception/path_computation_error.py

@@ -0,0 +1,14 @@
+# coding: utf-8
+
+
+class PathComputationError(Exception):
+    """ Exception raise for path computation error error
+    Attributes:
+        message -- explanation of the error
+    """
+
+    def __init__(self, message):
+        self.message = message
+
+    def __str__(self):
+        return self.message

gnpyapi/core/exception/topology_error.py

@@ -0,0 +1,13 @@
+# coding: utf-8
+
+class TopologyError(Exception):
+    """ Exception raise for topology error
+    Attributes:
+        message -- explanation of the error
+    """
+
+    def __init__(self, message):
+        self.message = message
+
+    def __str__(self):
+        return self.message

gnpyapi/core/model/__init__.py

@@ -0,0 +1 @@
+# coding: utf-8

gnpyapi/core/model/error.py

@@ -0,0 +1,17 @@
+# coding: utf-8
+
+
+class Error:
+
+    def __init__(self, code: int = None, message: str = None, description: str = None):
+        """Error
+        :param code: The code of this Error.
+        :type code: int
+        :param message: The message of this Error.
+        :type message: str
+        :param description: The description of this Error.
+        :type description: str
+        """
+        self.code = code
+        self.message = message
+        self.description = description

gnpyapi/core/model/result.py

@@ -0,0 +1,8 @@
+# coding: utf-8
+
+
+class Result:
+
+    def __init__(self, message: str = None, description: str = None):
+        self.message = message
+        self.description = description

gnpyapi/core/route/__init__.py

@@ -0,0 +1 @@
+# coding: utf-8

gnpyapi/core/route/path_request_route.py

@@ -0,0 +1,28 @@
+# coding: utf-8
+
+from flask import request
+
+from gnpyapi.core import app
+from gnpyapi.core.exception.equipment_error import EquipmentError
+from gnpyapi.core.exception.topology_error import TopologyError
+from gnpyapi.core.service.path_request_service import PathRequestService
+from gnpyapi.core import API_VERSION
+
+PATH_REQUEST_BASE_PATH = '/path-request'
+
+
+@app.route(API_VERSION + PATH_REQUEST_BASE_PATH, methods=['POST'])
+@app.route(PATH_REQUEST_BASE_PATH, methods=['POST'])
+def path_request(path_request_service: PathRequestService):
+    data = request.json
+    service = data['gnpy-api:service']
+    if 'gnpy-api:topology' in data:
+        topology = data['gnpy-api:topology']
+    else:
+        raise TopologyError('No topology found in request')
+    if 'gnpy-api:equipment' in data:
+        equipment = data['gnpy-api:equipment']
+    else:
+        raise EquipmentError('No equipment found in request')
+
+    return path_request_service.path_request(topology, equipment, service), 201

gnpyapi/core/route/status_route.py

@@ -0,0 +1,8 @@
+# coding: utf-8
+from gnpyapi.core import app
+from gnpyapi.core import API_VERSION
+
+
+@app.route(API_VERSION + '/status', methods=['GET'])
+def api_status():
+    return {"version": "v0.1", "status": "ok"}, 200

gnpyapi/core/service/__init__.py

@@ -0,0 +1 @@
+# coding: utf-8

gnpyapi/core/service/config_service.py

@@ -0,0 +1,4 @@
+# coding: utf-8
+class ConfigService:
+    def __init__(self):
+        pass

gnpyapi/core/service/equipment_service.py

@@ -0,0 +1,5 @@
+# coding: utf-
+class EquipmentService:
+
+    def __init__(self):
+        pass

gnpyapi/core/service/path_request_service.py

@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+
+import logging
+
+from gnpy.core.exceptions import EquipmentConfigError, NetworkTopologyError
+from gnpy.tools.json_io import results_to_json, load_eqpt_topo_from_json
+from gnpy.tools.worker_utils import designed_network, planning
+from gnpyapi.core.exception.topology_error import TopologyError
+
+from gnpyapi.core.exception.equipment_error import EquipmentError
+
+_logger = logging.getLogger(__name__)
+
+
+class PathRequestService:
+
+    def __init__(self):
+        pass
+
+    @staticmethod
+    def path_request(topology: dict, equipment: dict, service: dict = None) -> dict:
+        try:
+            (equipment, network) = load_eqpt_topo_from_json(equipment, topology)
+            network, _, _ = designed_network(equipment, network)
+            # todo parse request
+            _, _, _, _, _, result = planning(network, equipment, service)
+            return results_to_json(result)
+        except EquipmentConfigError as e:
+            _logger.error(f"An equipment error occurred: {e}")
+            raise EquipmentError(str(e))
+        except NetworkTopologyError as e:
+            _logger.error(f"An equipment error occurred: {e}")
+            raise TopologyError(str(e))
+        except Exception as e:
+            _logger.error(f"An error occurred during path request: {e}")
+            raise

gnpyapi/core/service/topology_service.py

@@ -0,0 +1,5 @@
+# coding: utf-
+
+class TopologyService:
+    def __init__(self):
+        pass