grpc-frame 0.5.13__tar.gz

grpc_frame-0.5.13/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 [yyyy] [name of copyright owner]
+
+   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.

grpc_frame-0.5.13/PKG-INFO

@@ -0,0 +1,34 @@
+Metadata-Version: 2.4
+Name: grpc_frame
+Version: 0.5.13
+Summary: gRPC server/client frame
+Author-email: Kengo NAKADA <kengo.nakada@email.com>
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: xlogger-py
+Requires-Dist: coloredlogs
+Requires-Dist: colorlog
+Requires-Dist: sphinx
+Requires-Dist: myst-parser
+Requires-Dist: sphinx-autobuild
+Requires-Dist: sphinx-rtd-theme
+Requires-Dist: sphinxcontrib-napoleon
+Requires-Dist: linkify-it-py
+Requires-Dist: protobuf
+Requires-Dist: grpcio
+Requires-Dist: grpcio-tools
+Requires-Dist: google
+Dynamic: license-file
+
+# README
+
+[ohara-lab-su](https://ohara-lab-su.github.io/)/[grpc_frame (doc)](https://ohara-lab-su.github.io/grpc_frame/)
+
+gRPC client/server 用。
+自動ディスパッチサーバークライアントのフレーム
+
+サーバー側の ctrl class を gRPC 経由でクライアント側で使えるように勝手にする。
+
+- proto (I/F API通信規約)を作れば終わり
+- 

grpc_frame-0.5.13/README.md

@@ -0,0 +1,11 @@
+# README
+
+[ohara-lab-su](https://ohara-lab-su.github.io/)/[grpc_frame (doc)](https://ohara-lab-su.github.io/grpc_frame/)
+
+gRPC client/server 用。
+自動ディスパッチサーバークライアントのフレーム
+
+サーバー側の ctrl class を gRPC 経由でクライアント側で使えるように勝手にする。
+
+- proto (I/F API通信規約)を作れば終わり
+- 

grpc_frame-0.5.13/pyproject.toml

@@ -0,0 +1,58 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "grpc_frame"
+
+version = "0.5.13"
+
+description = "gRPC server/client frame"
+authors = [
+  { name="Kengo NAKADA", email="kengo.nakada@email.com" }
+]
+readme = "README.md"
+requires-python = ">=3.7"
+#requires-python = ">=3.8"
+#requires-python = ">=3.11"
+dependencies = [
+    #"x_logger",
+    "xlogger-py",
+    #
+    "coloredlogs",
+    "colorlog",
+    #
+    "sphinx",
+    "myst-parser",
+    "sphinx-autobuild",
+    "sphinx-rtd-theme",
+    "sphinxcontrib-napoleon",
+    "linkify-it-py",
+    #
+    # python >= 3.8
+    # "protobuf>=4.21,<5", # for python3.7
+    # "protobuf==4.21.12; python_version < '3.8'", # for python3.7
+    # "protobuf; python_version >= '3.8'",
+    "protobuf",
+    # "grpcio==1.54.3; python_version < '3.8'",  # for pyhon3.7
+    # "grpcio; python_version >= '3.8'",
+    "grpcio",
+    # "grpcio-tools==1.54.3; python_version < '3.8'",  # for python3.7
+    #
+    # "grpcio-tools; python_version >= '3.8'",
+    "grpcio-tools",
+    #
+    "google",
+]
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+
+# ここでpytestのiniと同じようにオプションが書ける
+# 例えばテストマーク、フィルタ、カバレッジなども追記可能
+
+[tool.black]
+line-length = 89
+
+[tool.isort]
+profile = "black"

grpc_frame-0.5.13/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

grpc_frame-0.5.13/src/grpc_frame/__init__.py

@@ -0,0 +1,45 @@
+from __future__ import annotations
+
+import sys
+
+# --- ctrl gRPC スタブ
+from grpc_frame import ctrl_pb2 as _ctrl_pb2
+from grpc_frame import ctrl_pb2_grpc as _ctrl_pb2_grpc
+
+# ctrl_pb2 を トップレベル名として解決できるように
+sys.modules["ctrl_pb2"] = _ctrl_pb2
+sys.modules["ctrl_pb2_grpc"] = _ctrl_pb2_grpc
+
+# --- events ---
+from grpc_frame import events_pb2 as _events_pb2
+from grpc_frame import events_pb2_grpc as _events_pb2_grpc
+
+sys.modules["events_pb2"] = _events_pb2
+sys.modules["events_pb2_grpc"] = _events_pb2_grpc
+
+# --- public API (client) ---
+from grpc_frame.grpc_client import AsyncGrpcClient
+from grpc_frame.grpc_client import SyncGrpcClient
+from grpc_frame.grpc_client import GrpcClient
+
+
+# --- public API (DeviceProxy) ---
+from grpc_frame.device_proxy import DeviceProxyEntry
+from grpc_frame.device_proxy import register_device_proxy
+from grpc_frame.device_proxy import unregister_device_proxy
+from grpc_frame.device_proxy import get_device_proxy_entry
+from grpc_frame.device_proxy import list_device_proxies
+from grpc_frame.device_proxy import DeviceProxy
+from grpc_frame.device_proxy import create_device_proxy
+
+# --- public API for COM (server) ---
+from grpc_frame.grpc_com import ComExecutionRunner
+from grpc_frame.grpc_com import ThreadSafeCtrlProxy
+
+# --- public API (server) ---
+from grpc_frame.grpc_server import _ControlServicer
+from grpc_frame.dispatch_core import *
+from grpc_frame.adapter import *
+
+# --- pyi generation ---
+from grpc_frame.make_pyi import generate_client_pyi

grpc_frame-0.5.13/src/grpc_frame/adapter.py

@@ -0,0 +1,188 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+"""
+引数表現は adapter の「JSON優先 + pickleフォールバック」
+adapter.pack_args/pack_kwargs/pack_result は
+
+1.	JSON 変換を試す（bytes は base64 で JSON に入れる）
+2.	失敗したら pickle
+
+という二段。payload 先頭 1byte に b"J" / b"P" を付ける方式
+
+「イベントを JSON で送りたい」
+「バイナリを運びたい」
+いずれも収容可能
+
+Kengo NAKADA
+kengo.nakada@mat.shimane-u.ac.jp
+kengo.nakada@gmail.com
+"""
+
+from __future__ import annotations
+from typing import Any, Dict, List, Optional, Union, Tuple, Callable, Sequence
+
+import base64
+import json
+import pickle
+
+# JSON でシリアライズされたことを示す識別子（先頭 1 byte）
+_JSON_MAGIC: bytes = b"J"
+
+# pickle でシリアライズされたことを示す識別子（先頭 1 byte）
+_PICKLE_MAGIC: bytes = b"P"
+
+# tuple を JSON 上で区別するための識別キー
+_TUPLE_MAGIC_KEY: str = "__frame_tuple__"
+
+
+class _BytesJsonEncoder(json.JSONEncoder):
+    # JSONEncoder を拡張し、bytes / bytearray を base64 文字列として扱う
+    def default(
+        self,
+        obj: Any,
+    ) -> Any:
+        # bytes / bytearray は JSON で直接扱えないため base64 化
+        if isinstance(obj, (bytes, bytearray)):
+            b64: str = base64.b64encode(bytes(obj)).decode("ascii")
+            # 復元用の識別キー "__bytes__" を付与
+            return {"__bytes__": b64}
+
+        # それ以外は標準の JSONEncoder に委譲
+        return json.JSONEncoder.default(self, obj)
+
+
+def _bytes_json_object_hook(d: Dict[str, Any]) -> Any:
+    # JSON decode 時に "__bytes__" キーを検出した場合の復元処理
+    if "__bytes__" in d:
+        b64 = d["__bytes__"]
+        if isinstance(b64, str):
+            # base64 文字列を bytes に戻
+            return base64.b64decode(b64.encode("ascii"))
+
+    # tuple 復元用の識別キー
+    if _TUPLE_MAGIC_KEY in d:
+        items = d[_TUPLE_MAGIC_KEY]
+        if isinstance(items, list):
+            return tuple(items)
+        if isinstance(items, tuple):
+            return tuple(items)
+
+    # 特殊形式でなければそのまま返す
+    return d
+
+
+def _prepare_json(obj: Any) -> Any:
+    # tuple を JSON で識別できる形式に変換（list はそのまま）
+    if isinstance(obj, tuple):
+        return {
+            _TUPLE_MAGIC_KEY: [_prepare_json(item) for item in obj],
+        }
+    if isinstance(obj, list):
+        return [_prepare_json(item) for item in obj]
+    if isinstance(obj, dict):
+        return {k: _prepare_json(v) for k, v in obj.items()}
+    return obj
+
+
+def _try_json_dumps(obj: Any) -> bytes:
+    try:
+        # JSON によるシリアライズを最初に試みる
+        s: str = json.dumps(
+            # obj,
+            _prepare_json(obj),
+            cls=_BytesJsonEncoder,  # bytes 対応エンコーダ
+            ensure_ascii=False,  # Unicode をそのまま出力
+            separators=(",", ":"),  # JSON を最小サイズにする
+        )
+
+        # JSON で成功した場合は識別子を先頭に付与
+        return _JSON_MAGIC + s.encode("utf-8")
+    except Exception:
+        # JSON 化できないオブジェクトは pickle にフォールバック
+        pass
+
+    # pickle によるシリアライズ（最高プロトコル）
+    payload: bytes = pickle.dumps(obj, protocol=pickle.HIGHEST_PROTOCOL)
+
+    # pickle 識別子を先頭に付与
+    return _PICKLE_MAGIC + payload
+
+
+def _loads(payload: bytes) -> Any:
+    # None はそのまま None として扱う
+    if payload is None:
+        return None
+
+    # 空 payload も None とみなす
+    if len(payload) == 0:
+        return None
+
+    # 先頭 1 byte を識別子として取得
+    magic: bytes = payload[:1]
+    body: bytes = payload[1:]
+
+    # JSON フォーマットの場合
+    if magic == _JSON_MAGIC:
+        s: str = body.decode("utf-8")
+        # bytes 復元用の object_hook を指定
+        return json.loads(s, object_hook=_bytes_json_object_hook)
+
+    # pickle フォーマットの場合
+    if magic == _PICKLE_MAGIC:
+        return pickle.loads(body)
+
+    # 識別子が無い旧形式などは pickle として扱う
+    return pickle.loads(payload)
+
+
+def pack_args(
+    args: Tuple[Any, ...],
+) -> bytes:
+    # 位置引数を list に変換してシリアライズ
+    return _try_json_dumps(list(args))
+
+
+def pack_kwargs(
+    kwargs: Dict[str, Any],
+) -> bytes:
+    # キーワード引数を dict としてシリアライズ
+    return _try_json_dumps(kwargs)
+
+
+def unpack_args(payload: bytes) -> Tuple[Any, ...]:
+    # シリアライズされた args を復元
+    obj = _loads(payload)
+
+    # None の場合は空タプル
+    if obj is None:
+        return tuple()
+
+    # 正常系では list → tuple に変換
+    if isinstance(obj, list):
+        return tuple(obj)
+
+    # 想定外の型はエラー
+    raise TypeError("args は list として復元される必要があります。")
+
+
+def unpack_kwargs(payload: bytes) -> Dict[str, Any]:
+    # シリアライズされた kwargs を復元
+    obj = _loads(payload)
+
+    # None の場合は空 dict
+    if obj is None:
+        return {}
+
+    # 正常系では dict をそのまま返す
+    if isinstance(obj, dict):
+        return obj
+    raise TypeError("kwargs は dict として復元される必要があります。")
+
+
+def pack_result(result: Any) -> bytes:
+    # 戻り値をシリアライズ
+    return _try_json_dumps(result)
+
+
+def unpack_result(payload: bytes) -> Any:
+    return _loads(payload)