tango-frame 0.1.1__tar.gz

tango_frame-0.1.1/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.

tango_frame-0.1.1/PKG-INFO

@@ -0,0 +1,8 @@
+Metadata-Version: 2.4
+Name: tango-frame
+Version: 0.1.1
+Summary: Automatic TANGO dispatch framework for ordinary Python device classes
+Requires-Python: >=3.8
+License-File: LICENSE
+Requires-Dist: pytango>=10
+Dynamic: license-file

tango_frame-0.1.1/README.md

@@ -0,0 +1,229 @@
+# tango-frame
+
+`tango-frame` は、通常の Python 機器制御クラスを TANGO Device Server として自動公開し、それに対応する Python クライアントを構成するためのフレームワークである。
+
+機器制御クラス自身は PyTango を import する必要がなく、`tango.server.Device` を継承する必要もない。公開メソッドを TANGO command、Python の property を TANGO attribute として対応付ける。
+
+[English README](README.md)
+
+## 基本思想
+
+機器実装と通信層を分離する。
+
+```text
+通常の Python 機器制御クラス
+        |
+        +---- tango-frame ----> TANGO Device Server
+        |                        method   -> command
+        |                        property -> attribute
+        |
+        +---- tango-frame ----> Python client wrapper
+                                 |
+                                 +---- TANGO DeviceProxy
+```
+
+`tango-frame` は TANGO の上に別の RPC プロトコルを構築するものではない。TANGO 標準の command / attribute を自動生成し、クライアント側も `DeviceProxy` を用いてそれらを呼び出す。
+
+## 主な機能
+
+- 通常の Python class を機器 API の定義として利用する。
+- public method を同名の TANGO command として公開する。
+- `@property` を TANGO attribute として公開する。
+- setter を持つ property は read/write attribute とする。
+- TANGO で直接表現できる scalar / homogeneous array は native TANGO 型を優先する。
+- 複数の異種引数など、TANGO command の1入力で直接表現できない呼び出しだけを1個の JSON string に変換する。
+- native TANGO 型で表現できない複雑な戻り値は JSON string に変換する。
+- クライアント側は内部で `tango.DeviceProxy` を使いながら、元の機器クラスに近い Python method / property API を提供する。
+- 機器固有の client-side 処理は自動 remote dispatch を override できる。
+
+## 構成
+
+```text
+src/
+└── tango_frame/
+    ├── __init__.py
+    ├── auto_dispatch.py
+    ├── client.py
+    ├── codec.py
+    ├── introspection.py
+    ├── server.py
+    └── type_mapping.py
+
+example/
+└── device_server/
+    ├── src/
+    │   └── device/
+    │       ├── device_class.py
+    │       └── server_tango/
+    │           ├── tango_ds.py
+    │           └── device_client.py
+    └── example/
+        ├── server_start.py
+        └── client.py
+```
+
+`src/tango_frame/` は再利用可能な framework であり、具体的な機器クラスを含まない。
+
+`example/device_server/src/device/` は具体的な機器モジュールの例である。`device_class.py` は TANGO 非依存で、`server_tango/` がその機器に対する TANGO adapter 層になる。
+
+## インストール
+
+```bash
+pip install .
+```
+
+PyTango 10 以降を必要とする。
+
+## 機器制御クラス
+
+機器制御クラスは通常の Python class のままでよい。
+
+```python
+from typing import List
+
+
+class DeviceClass(object):
+    def __init__(self) -> None:
+        self._position = 0.0
+
+    def add(self, value: float) -> float:
+        self._position += value
+        return self._position
+
+    def move(
+        self,
+        position: float,
+        speed: float = 1.0,
+        wait: bool = True,
+    ) -> bool:
+        self._position = position
+        return wait
+
+    def get_samples(self) -> List[float]:
+        return [1.0, 2.0, 3.0]
+
+    @property
+    def position(self) -> float:
+        return self._position
+
+    @position.setter
+    def position(self, value: float) -> None:
+        self._position = value
+```
+
+このクラスは TANGO を使わず、通常の Python object として直接実行することもできる。
+
+## TANGO Device Server
+
+機器固有の TANGO server class では、`AutoDispatchDevice` に機器クラスを指定する。
+
+```python
+from tango_frame import AutoDispatchDevice
+
+from device.device_class import DeviceClass
+
+
+class TangoDevice(AutoDispatchDevice):
+    device_class = DeviceClass
+```
+
+上の例は概ね次の TANGO API に変換される。
+
+```text
+add(value: float) -> float
+    TANGO command: float -> float
+
+move(position: float, speed: float, wait: bool) -> bool
+    TANGO command: JSON string -> bool
+
+get_samples() -> List[float]
+    TANGO command: void -> homogeneous float array
+
+position: float
+    TANGO read/write attribute
+```
+
+サーバー側で実行すべきでないメソッドは、機器固有の server class から除外できる。
+
+```python
+class TangoDevice(AutoDispatchDevice):
+    device_class = DeviceClass
+    excluded_commands = {"save"}
+```
+
+Device Server の起動自体は通常の PyTango server runtime を使用する。example の `-nodb` は TANGO database を使わずローカル試験するためだけの指定であり、framework の前提ではない。
+
+## クライアント
+
+同じ機器クラスを `AutoDispatchClient` に指定する。
+
+```python
+from tango_frame import AutoDispatchClient
+
+from device.device_class import DeviceClass
+
+
+class DeviceClient(AutoDispatchClient):
+    device_class = DeviceClass
+```
+
+内部通信には TANGO `DeviceProxy` を使用するが、利用側では Python の method / property として扱う。
+
+```python
+device = DeviceClient(
+    "tango://127.0.0.1:10000/test/tango/device#dbase=no"
+)
+
+print(device.position)
+print(device.add(2.5))
+device.position = 20.0
+```
+
+機器固有の client-side 処理は通常の継承で override する。たとえば `save(path)` は Device Server 側ではなく client machine に保存すべきなので、次のように実装できる。
+
+```python
+from pathlib import Path
+
+
+class DeviceClient(AutoDispatchClient):
+    device_class = DeviceClass
+
+    def save(self, path: str) -> str:
+        data = self.get_data()
+        Path(path).write_bytes(data)
+        return path
+```
+
+明示的に実装した client method は自動 remote dispatch より優先される。
+
+## 型変換
+
+原則として native TANGO 型を使用する。
+
+| Python API | TANGO 上の表現 |
+| --- | --- |
+| `bool` | native boolean |
+| `int` | native integer |
+| `float` | native double |
+| `str` | native string |
+| homogeneous `List[T]` | native TANGO array / spectrum |
+| 引数なし / 戻り値なし | void |
+| 複数または異種の引数 | 1個の JSON string input |
+| native 型にできない複雑な戻り値 | JSON string |
+
+したがって JSON は通常の通信形式ではなく、TANGO の command model に直接対応できない Python 呼び出しを扱うための fallback である。
+
+## ドキュメント
+
+Sphinx/MyST のドキュメントは `docs/` 以下に置く。
+
+```bash
+cd docs
+./build.sh
+```
+
+## バージョン
+
+現在のバージョン: **0.1.0**
+
+変更内容は [CHANGELOG.md](CHANGELOG.md) を参照。

tango_frame-0.1.1/pyproject.toml

@@ -0,0 +1,13 @@
+[build-system]
+requires = ["setuptools>=61"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "tango-frame"
+version = "0.1.1"
+description = "Automatic TANGO dispatch framework for ordinary Python device classes"
+requires-python = ">=3.8"
+dependencies = ["pytango>=10"]
+
+[tool.setuptools.packages.find]
+where = ["src"]

tango_frame-0.1.1/setup.cfg

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

tango_frame-0.1.1/src/tango_frame/__init__.py

@@ -0,0 +1,8 @@
+from .auto_dispatch import AutoDispatchClient, AutoDispatchDevice
+from .server import run_device_server
+
+__all__ = [
+    "AutoDispatchClient",
+    "AutoDispatchDevice",
+    "run_device_server",
+]