appmesh 1.5.5__py3-none-any.whl → 1.5.7__py3-none-any.whl

appmesh/__init__.py

@@ -14,5 +14,7 @@ Example:
 from .app import App
 from .http_client import AppMeshClient
 from .tcp_client import AppMeshClientTCP
+from .http_server import AppMeshServer
+from .tcp_server import AppMeshServerTCP
 
-__all__ = ["App", "AppMeshClient", "AppMeshClientTCP"]
+__all__ = ["App", "AppMeshClient", "AppMeshClientTCP", "AppMeshServer", "AppMeshServerTCP"]

appmesh/http_client.py

@@ -34,10 +34,10 @@ class AppMeshClient(metaclass=abc.ABCMeta):
         - Install the App Mesh Python package:
             python3 -m pip install --upgrade appmesh
         - Import the client module:
-            from appmesh import appmesh_client
+            from appmesh import AppMeshClient
 
     Example:
-        client = appmesh_client.AppMeshClient()
+        client = AppMeshClient()
         client.login("your-name", "your-password")
         response = client.app_view(app_name='ping')
 
@@ -152,7 +152,7 @@ class AppMeshClient(metaclass=abc.ABCMeta):
                 which may be necessary in environments requiring specific CA chains that differ from the default system CAs.
                 To use both a custom CA and the system's default CAs, create a combined CA bundle by concatenating them into a single file. (e.g., `cat custom_ca.pem /etc/ssl/certs/ca-certificates.crt > combined_ca.pem`).
 
-            ssl_client_cert (Union[str, Tuple[str, str]], optional): Path to the SSL client certificate and key. Can be:
+            rest_ssl_client_cert (Union[str, Tuple[str, str]], optional): Path to the SSL client certificate and key. Can be:
                 - `str`: A path to a single PEM file containing both the client certificate and private key.
                 - `tuple`: A pair of paths (`cert_file`, `key_file`), where `cert_file` is the client certificate file path and `key_file` is the private key file path.
 
@@ -1228,54 +1228,6 @@ class AppMeshClient(metaclass=abc.ABCMeta):
 
         return resp.text
 
-    def task_fetch(self) -> str:
-        """Fetch invocation data in the currently running App Mesh application process.
-
-        This helper is intended to be called by an application process running from App Mesh
-        to obtain the payload that a client pushed to it. It reads two required
-        environment variables set by the runtime:
-
-        - APP_MESH_PROCESS_ID: the process UUID for this invocation
-        - APP_MESH_APPLICATION_NAME: the application name
-
-        Returns:
-            str: The payload provided by the client as returned by the service.
-        """
-        process_uuid = os.environ["APP_MESH_PROCESS_ID"]
-        app_name = os.environ["APP_MESH_APPLICATION_NAME"]
-        while True:
-            resp = self._request_http(
-                AppMeshClient.Method.GET,
-                path=f"/appmesh/app/{app_name}/task",
-                query={"process_uuid": process_uuid},
-            )
-            if resp.status_code != HTTPStatus.OK:
-                time.sleep(0.1)
-                continue
-
-            return resp.text
-
-    def task_return(self, result: str) -> None:
-        """Return the result of a server-side invocation back to the original client.
-
-        The method posts the `result` associated with the current process UUID so
-        the invoking client can retrieve it. The same environment variables used by
-        `task_fetch` are required to identify the target process.
-
-        Args:
-            result (str): Result payload to be delivered back to the client.
-        """
-        process_uuid = os.environ["APP_MESH_PROCESS_ID"]
-        app_name = os.environ["APP_MESH_APPLICATION_NAME"]
-        resp = self._request_http(
-            AppMeshClient.Method.PUT,
-            path=f"/appmesh/app/{app_name}/task",
-            query={"process_uuid": process_uuid},
-            body=result,
-        )
-        if resp.status_code != HTTPStatus.OK:
-            raise Exception(resp.text)
-
     def run_app_async(
         self,
         app: Union[App, str],
@@ -1369,7 +1321,7 @@ class AppMeshClient(metaclass=abc.ABCMeta):
         Args:
             app (Union[App, str]): An App instance or a shell command string.
                 If a string, an App instance is created as:
-                `appmesh_client.App({"command": "<command_string>", "shell": True})`
+                `appmesh.App({"command": "<command_string>", "shell": True})`
             stdout_print (bool, optional): If True, prints the remote stdout locally. Defaults to True.
             max_time_seconds (Union[int, str], optional): Maximum runtime for the remote process.
                 Supports ISO 8601 duration format (e.g., 'P1Y2M3DT4H5M6S', 'P5W'). Defaults to DEFAULT_RUN_APP_TIMEOUT_SECONDS.
@@ -1418,6 +1370,7 @@ class AppMeshClient(metaclass=abc.ABCMeta):
         """
         rest_url = parse.urljoin(self.auth_server_url, path)
 
+        # Prepare headers
         header = {} if header is None else header
         if self.jwt_token:
             token = self.jwt_token["access_token"] if isinstance(self.jwt_token, dict) and "access_token" in self.jwt_token else self.jwt_token
@@ -1429,6 +1382,11 @@ class AppMeshClient(metaclass=abc.ABCMeta):
                 header[self.HTTP_HEADER_KEY_X_TARGET_HOST] = self.forward_to + ":" + str(parse.urlsplit(self.auth_server_url).port)
         header[self.HTTP_HEADER_KEY_USER_AGENT] = self.HTTP_USER_AGENT
 
+        # Convert body to JSON string if it's a dict or list
+        if isinstance(body, (dict, list)):
+            body = json.dumps(body)
+            header.setdefault("Content-Type", "application/json")
+
         try:
             if method is AppMeshClient.Method.GET:
                 return self.session.get(url=rest_url, params=query, headers=header, cert=self.ssl_client_cert, verify=self.ssl_verify, timeout=self.rest_timeout)
@@ -1437,7 +1395,7 @@ class AppMeshClient(metaclass=abc.ABCMeta):
                     url=rest_url,
                     params=query,
                     headers=header,
-                    data=json.dumps(body) if type(body) in (dict, list) else body,
+                    data=body,
                     cert=self.ssl_client_cert,
                     verify=self.ssl_verify,
                     timeout=self.rest_timeout,

appmesh/http_server.py

@@ -0,0 +1,89 @@
+# TCP-based App Mesh Server
+# pylint: disable=line-too-long,broad-exception-raised,broad-exception-caught,import-outside-toplevel,protected-access
+
+import abc
+import os
+import time
+from http import HTTPStatus
+from .http_client import AppMeshClient
+
+
+class AppMeshServer(metaclass=abc.ABCMeta):
+    """
+    Server SDK for App Mesh application interacting with the local App Mesh REST service over HTTPS.
+
+    Build-in runtime environment variables required:
+      - APP_MESH_PROCESS_ID
+      - APP_MESH_APPLICATION_NAME
+
+    Methods:
+        - task_fetch(): fetch invocation payloads
+        - task_return(): return results to the invoking client
+
+    Example:
+        server = AppMeshServer()
+        payload = server.task_fetch()
+        server.task_return(result)
+    """
+
+    def __init__(
+        self,
+        rest_url: str = "https://127.0.0.1:6060",
+        rest_ssl_verify=AppMeshClient.DEFAULT_SSL_CA_CERT_PATH if os.path.exists(AppMeshClient.DEFAULT_SSL_CA_CERT_PATH) else False,
+        rest_ssl_client_cert=(AppMeshClient.DEFAULT_SSL_CLIENT_CERT_PATH, AppMeshClient.DEFAULT_SSL_CLIENT_KEY_PATH) if os.path.exists(AppMeshClient.DEFAULT_SSL_CLIENT_CERT_PATH) else None,
+        rest_timeout=(60, 300),
+    ):
+        """Initialize an App Mesh HTTP client for interacting with the App Mesh server via secure HTTPS.
+
+        Args:
+            follows the same parameters as `AppMeshClient`.
+        """
+        self._client = AppMeshClient(rest_url, rest_ssl_verify, rest_ssl_client_cert, rest_timeout)
+
+    def task_fetch(self) -> str:
+        """Fetch invocation data in the currently running App Mesh application process.
+
+        This helper is intended to be called by an application process running from App Mesh
+        to obtain the payload that a client pushed to it. It reads two required
+        environment variables set by the runtime:
+
+        - APP_MESH_PROCESS_ID: the process UUID for this invocation
+        - APP_MESH_APPLICATION_NAME: the application name
+
+        Returns:
+            str: The payload provided by the client as returned by the service.
+        """
+        process_uuid = os.environ["APP_MESH_PROCESS_ID"]
+        app_name = os.environ["APP_MESH_APPLICATION_NAME"]
+        while True:
+            resp = self._client._request_http(
+                AppMeshClient.Method.GET,
+                path=f"/appmesh/app/{app_name}/task",
+                query={"process_uuid": process_uuid},
+            )
+            if resp.status_code != HTTPStatus.OK:
+                time.sleep(0.1)
+                continue
+
+            return resp.text
+
+    def task_return(self, result: str) -> None:
+        """Return the result of a server-side invocation back to the original client.
+
+        The method posts the `result` associated with the current process UUID so
+        the invoking client can retrieve it. The same environment variables used by
+        `task_fetch` are required to identify the target process.
+
+        Args:
+            result (str): Result payload to be delivered back to the client.
+        """
+        process_uuid = os.environ["APP_MESH_PROCESS_ID"]
+        app_name = os.environ["APP_MESH_APPLICATION_NAME"]
+        resp = self._client._request_http(
+            AppMeshClient.Method.PUT,
+            path=f"/appmesh/app/{app_name}/task",
+            query={"process_uuid": process_uuid},
+            body=result,
+        )
+        if resp.status_code != HTTPStatus.OK:
+            raise Exception(resp.text)

appmesh/tcp_client.py

@@ -1,5 +1,5 @@
 # TCP-based App Mesh Client
-# pylint: disable=line-too-long,broad-exception-raised,	,broad-exception-caught,import-outside-toplevel,protected-access
+# pylint: disable=line-too-long,broad-exception-raised,broad-exception-caught,import-outside-toplevel,protected-access
 
 import json
 import os

appmesh/tcp_server.py

@@ -0,0 +1,33 @@
+# TCP-based App Mesh Server
+# pylint: disable=line-too-long,broad-exception-raised,broad-exception-caught,import-outside-toplevel,protected-access
+
+import os
+from .http_client import AppMeshClient
+from .tcp_client import AppMeshClientTCP
+from .http_server import AppMeshServer
+
+
+class AppMeshServerTCP(AppMeshServer):
+    """
+    Server SDK for interacting with the local App Mesh service over TCP.
+
+    Attributes:
+        - Inherits all attributes from `AppMeshServer`.
+
+    Methods:
+        - Inherits all methods from `AppMeshServer`.
+    """
+
+    def __init__(
+        self,
+        rest_ssl_verify=AppMeshClient.DEFAULT_SSL_CA_CERT_PATH if os.path.exists(AppMeshClient.DEFAULT_SSL_CA_CERT_PATH) else False,
+        rest_ssl_client_cert=None,
+        tcp_address=("localhost", 6059),
+    ):
+        """Construct an App Mesh server TCP object to communicate securely with an App Mesh server over TLS.
+
+        Args:
+            follows the same parameters as `AppMeshClientTCP`.
+        """
+        object.__init__(self)
+        self._client = AppMeshClientTCP(rest_ssl_verify=rest_ssl_verify, rest_ssl_client_cert=rest_ssl_client_cert, tcp_address=tcp_address)

{appmesh-1.5.5.dist-info → appmesh-1.5.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: appmesh
-Version: 1.5.5
+Version: 1.5.7
 Summary: Client SDK for App Mesh
 Home-page: https://github.com/laoshanxi/app-mesh
 Author: laoshanxi
@@ -102,7 +102,7 @@ Refer to the [Installation doc](https://app-mesh.readthedocs.io/en/latest/Instal
 | GUI               | √        | √          |
 | Virtual Network   |          | √          |
 | Monitor tools     | √        | √          |
-| Task invoke       | √        |            |
+| [Remote API call](https://app-mesh.readthedocs.io/en/latest/RemoteTask.html)   | √        |            |
 
 ---
 

appmesh-1.5.7.dist-info/RECORD

@@ -0,0 +1,15 @@
+appmesh/__init__.py,sha256=fQHuLWBaMZmbs5i5AV4KIXhv9YlIWkhYIv9WSLGNLm4,548
+appmesh/app.py,sha256=9Q-SOOej-MH13BU5Dv2iTa-p-sECCJQp6ZX9DjWWmwE,10526
+appmesh/app_output.py,sha256=JK_TMKgjvaw4n_ys_vmN5S4MyWVZpmD7NlKz_UyMIM8,1015
+appmesh/app_run.py,sha256=9ISKGZ3k3kkbQvSsPfRfkOLqD9xhbqNOM7ork9F4w9c,1712
+appmesh/appmesh_client.py,sha256=0ltkqHZUq094gKneYmC0bEZCP0X9kHTp9fccKdWFWP0,339
+appmesh/http_client.py,sha256=G_T0VDnGf1_CNMYaHHmjfZ_XgMDyC21GBE0zgn4Bh3s,57185
+appmesh/http_server.py,sha256=u4oGtZr8e1AnDvmiyN-6pX-nUpzDK24di0mSl6gJgL0,3467
+appmesh/tcp_client.py,sha256=yi0n2NpBBCA-JHYWQPPE_1euE7Oz6JHBe1op7lypTXY,10999
+appmesh/tcp_messages.py,sha256=w1Kehz_aX4X2CYAUsy9mFVJRhxnLQwwc6L58W4YkQqs,969
+appmesh/tcp_server.py,sha256=c6lNM8OgYUVREs7gn2okt57PYOEfqcUuExCtL4D-xbE,1166
+appmesh/tcp_transport.py,sha256=-XDTQbsKL3yCbguHeW2jNqXpYgnCyHsH4rwcaJ46AS8,8645
+appmesh-1.5.7.dist-info/METADATA,sha256=dFSkl2YjZYHYZop6QQ6X-T94zLmut_nJqJwt0vrK4CQ,11768
+appmesh-1.5.7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+appmesh-1.5.7.dist-info/top_level.txt,sha256=-y0MNQOGJxUzLdHZ6E_Rfv5_LNCkV-GTmOBME_b6pg8,8
+appmesh-1.5.7.dist-info/RECORD,,

appmesh-1.5.5.dist-info/RECORD

@@ -1,13 +0,0 @@
-appmesh/__init__.py,sha256=vgiSdMzlzDwgHxBMDoFaKWb77g2nJVciRf4z_ssAlwE,431
-appmesh/app.py,sha256=9Q-SOOej-MH13BU5Dv2iTa-p-sECCJQp6ZX9DjWWmwE,10526
-appmesh/app_output.py,sha256=JK_TMKgjvaw4n_ys_vmN5S4MyWVZpmD7NlKz_UyMIM8,1015
-appmesh/app_run.py,sha256=9ISKGZ3k3kkbQvSsPfRfkOLqD9xhbqNOM7ork9F4w9c,1712
-appmesh/appmesh_client.py,sha256=0ltkqHZUq094gKneYmC0bEZCP0X9kHTp9fccKdWFWP0,339
-appmesh/http_client.py,sha256=T2HjNtFo20gEh949NorOXRR5FWm2oBbXfIDw0fFJ9t8,58962
-appmesh/tcp_client.py,sha256=Id1aIKVWncTSZiKRVa4sgwo1tFX2wRqOLiTnI9-dNkE,11001
-appmesh/tcp_messages.py,sha256=w1Kehz_aX4X2CYAUsy9mFVJRhxnLQwwc6L58W4YkQqs,969
-appmesh/tcp_transport.py,sha256=-XDTQbsKL3yCbguHeW2jNqXpYgnCyHsH4rwcaJ46AS8,8645
-appmesh-1.5.5.dist-info/METADATA,sha256=1DSsHqL41rkoTMOBTJOVBxd7kyjSJvJEPGiKY2Tsc20,11707
-appmesh-1.5.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-appmesh-1.5.5.dist-info/top_level.txt,sha256=-y0MNQOGJxUzLdHZ6E_Rfv5_LNCkV-GTmOBME_b6pg8,8
-appmesh-1.5.5.dist-info/RECORD,,