diff --git a/clients/python/.gitignore b/clients/python/.gitignore new file mode 100644 index 00000000..d2c614d5 --- /dev/null +++ b/clients/python/.gitignore @@ -0,0 +1,51 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] + +# C extensions +*.so + +# Distribution / packaging +bin/ +build/ +develop-eggs/ +dist/ +eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +*.egg-info/ +.installed.cfg +*.egg + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +.tox/ +.coverage +.cache +nosetests.xml +coverage.xml + +# Translations +*.mo + +# Mr Developer +.mr.developer.cfg +.project +.pydevproject + +# Rope +.ropeproject + +# Django stuff: +*.log +*.pot + +# Sphinx documentation +docs/_build/ +*.desc diff --git a/clients/python/LICENSE b/clients/python/LICENSE new file mode 100644 index 00000000..8cae25e6 --- /dev/null +++ b/clients/python/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [2024] [raystack] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/clients/python/README.md b/clients/python/README.md new file mode 100644 index 00000000..c16b8edb --- /dev/null +++ b/clients/python/README.md @@ -0,0 +1,69 @@ +# Stencil Python client + +[![PyPI version](https://badge.fury.io/py/stencil-python-client.svg)](https://pypi.org/project/stencil-python-client) + +Stencil Python client package provides a store to lookup protobuf descriptors and options to keep the protobuf descriptors upto date. + +It has following features + - Deserialize protobuf messages directly by specifying protobuf message name + - Ability to refresh protobuf descriptors in specified intervals + - Support to download descriptors from multiple urls + + +## Requirements + + - Python 3.7+ + +## Installation + +Install it via git reference +``` +stencil-python-client = { git = "git+https://github.com/raystack/stencil.git", subdirectory = "clients/python"} +``` + +Then import the stencil package into your own code as mentioned below +```python +from raystack import stencil +``` + +## Usage + +### Creating a client + +```python +from raystack import stencil + +url = "http://url/to/proto/descriptorset/file" +client = stencil.Client(url) +``` + +### Creating a multiURLClient + +```python +from raystack import stencil + +urls = ["http://urlA", "http://urlB"] +client = stencil.MultiUrlClient(urls) +``` + +### Get Descriptor +```python +from raystack import stencil + +url = "http://url/to/proto/descriptorset/file" +client = stencil.Client(url) +client.get_descriptor("google.protobuf.DescriptorProto") +``` + +### Parse protobuf message. +```python +from raystack import stencil + +url = "http://url/to/proto/descriptorset/file" +client = stencil.Client(url) + +data = "" +desc = client.parse("google.protobuf.DescriptorProto", data) +``` + +Refer to [stencil documentation](https://raystack.gitbook.io/stencil/) for more information what you can do in stencil. diff --git a/clients/python/conftest.py b/clients/python/conftest.py new file mode 100644 index 00000000..e946b0b7 --- /dev/null +++ b/clients/python/conftest.py @@ -0,0 +1,14 @@ +from subprocess import run + +import pytest +import os + + +@pytest.fixture(scope="session") +def protoc_setup(): + current_dir = os.path.dirname(os.path.realpath(__file__)) + output_file = os.path.join(current_dir, 'test/data/one.desc') + + input_dir = os.path.join(current_dir, 'test/data') + run(['protoc', f'--descriptor_set_out={output_file}', '--include_imports', f'--proto_path={input_dir}', + 'one.proto'], cwd=current_dir) diff --git a/clients/python/requirements.txt b/clients/python/requirements.txt new file mode 100644 index 00000000..a26171a8 --- /dev/null +++ b/clients/python/requirements.txt @@ -0,0 +1,5 @@ +protobuf==3.17.3 +pytest==6.2.5 +pytest-cov==2.12.1 +schedule==1.1.0 +requests==2.26.0 diff --git a/clients/python/setup.py b/clients/python/setup.py new file mode 100644 index 00000000..0d6725aa --- /dev/null +++ b/clients/python/setup.py @@ -0,0 +1,31 @@ +import setuptools + +with open("README.md", "r", encoding="utf-8") as fh: + long_description = fh.read() + +setuptools.setup( + name="stencil-python-client", + version="0.0.1", + author="Raystack", + author_email="raystack@gmail.com", + description="Stencil Python client package provides a store to lookup protobuf descriptors and options to keep the protobuf descriptors upto date.", + long_description=long_description, + long_description_content_type="text/markdown", + url="https://github.com/raystack/stencil", + project_urls={ + "Bug Tracker": "https://github.com/raystack/stencil/issues", + }, + classifiers=[ + "Programming Language :: Python :: 3", + "License :: OSI Approved :: Apache Software License", + "Operating System :: OS Independent", + ], + package_dir={"": "src"}, + packages=setuptools.find_packages(where="src"), + python_requires=">=3.6", + install_requires=[ + 'protobuf', + 'schedule', + 'requests' + ] +) diff --git a/clients/python/src/raystack/__init__.py b/clients/python/src/raystack/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/clients/python/src/raystack/stencil.py b/clients/python/src/raystack/stencil.py new file mode 100644 index 00000000..3712c127 --- /dev/null +++ b/clients/python/src/raystack/stencil.py @@ -0,0 +1,32 @@ +from schedule import Scheduler +from google.protobuf.message import Message + +from raystack.store import Store + + +class MultiUrlClient: + def __init__(self, urls:list, interval=3600, auto_refresh=False) -> None: + self._store = Store() + self._urls = urls + self._interval = interval + self._auto_refresh = auto_refresh + self._scheduler = Scheduler() + if self._auto_refresh: + self._scheduler.every(self._interval).seconds.do(self.refresh) + self.refresh() + + def refresh(self): + for url in self._urls: + self._store.load(url=url) + + def get_descriptor(self, name: str) -> Message: + return self._store.get(name) + + def parse(self, name: str, data: bytes): + msg = self.get_descriptor(name) + return msg.ParseFromString(data) + + +class Client(MultiUrlClient): + def __init__(self, url: str) -> None: + super().__init__([url]) diff --git a/clients/python/src/raystack/store.py b/clients/python/src/raystack/store.py new file mode 100644 index 00000000..a254fb21 --- /dev/null +++ b/clients/python/src/raystack/store.py @@ -0,0 +1,23 @@ +import requests +from google.protobuf.descriptor_pb2 import FileDescriptorSet +from google.protobuf.message import Message +from google.protobuf.message_factory import GetMessages + + +class Store: + def __init__(self): + self.data = {} + + def get(self, name) -> Message: + return self.data.get(name) + + def _load_from_url(self, url): + result = requests.get(url, stream=True) + return result.raw.read() + + def load(self, url: str = None, data: bytes = None): + if url: + data = self._load_from_url(url) + fds = FileDescriptorSet.FromString(data) + messages = GetMessages([file for file in fds.file]) + self.data.update(messages) diff --git a/clients/python/test/data/one.proto b/clients/python/test/data/one.proto new file mode 100644 index 00000000..90d58b0b --- /dev/null +++ b/clients/python/test/data/one.proto @@ -0,0 +1,24 @@ +syntax = "proto3"; + +package test; +import "google/protobuf/timestamp.proto"; +option java_package = "test.stencil"; + +message One { + int64 field_one = 1; +} + +message Two { + message Three { + string data = 1; + google.protobuf.Timestamp timestamp = 3; + } + Three id = 1; + message Four { + Four recursive = 2; + string field_two = 3; + message Five { + double id = 1; + } + } +} diff --git a/clients/python/test/test_client.py b/clients/python/test/test_client.py new file mode 100644 index 00000000..22eccbf3 --- /dev/null +++ b/clients/python/test/test_client.py @@ -0,0 +1,32 @@ +from unittest.mock import patch + +from google.protobuf.reflection import GeneratedProtocolMessageType + +from src.raystack.stencil import Client +from src.raystack.store import Store + +URL = 'http://stencil.test/proto-descriptors/test/latest' + + +def get_file_desc(): + with open('data/one.desc', 'rb') as myfile: + desc = myfile.read() + return desc + + +def test_store(protoc_setup): + file_desc = get_file_desc() + store = Store() + store.load(data=file_desc) + assert 'test.One' in store.data + assert isinstance(store.get('test.One'), store.get('test.One').__class__) + + +@patch('raystack.store.Store._load_from_url') +def test_client(test_desc_from_url, protoc_setup): + file_desc = get_file_desc() + test_desc_from_url.return_value = file_desc + + client = Client(URL) + + assert isinstance(client.get_descriptor('test.One'), GeneratedProtocolMessageType)