oocana-python-executor 0.15.3__tar.gz → 0.16.0__tar.gz

{oocana_python_executor-0.15.3 → oocana_python_executor-0.16.0}/PKG-INFO

@@ -1,9 +1,11 @@
 Metadata-Version: 2.1
 Name: oocana-python-executor
-Version: 0.15.3
+Version: 0.16.0
 Summary: a client subscribe mqtt topic to execute oocana's block
 Author-Email: l1shen <lishen1635@gmail.com>, yleaf <11785335+leavesster@users.noreply.github.com>
 License: MIT
 Requires-Python: >=3.9
 Requires-Dist: oocana
+Provides-Extra: debug
+Requires-Dist: debugpy; extra == "debug"
 

{oocana_python_executor-0.15.3 → oocana_python_executor-0.16.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "oocana-python-executor"
-version = "0.15.3"
+version = "0.16.0"
 authors = [
     { name = "l1shen", email = "lishen1635@gmail.com" },
     { name = "yleaf", email = "11785335+leavesster@users.noreply.github.com" },
@@ -14,6 +14,11 @@ dependencies = [
 [project.license]
 text = "MIT"
 
+[project.optional-dependencies]
+debug = [
+    "debugpy",
+]
+
 [project.scripts]
 python-executor = "python_executor.executor:main"
 

{oocana_python_executor-0.15.3 → oocana_python_executor-0.16.0}/python_executor/block.py

@@ -70,24 +70,24 @@ def load_module(file_path: str, source_dir=None):
 
 def output_return_object(obj, context: Context):
     if obj is None:
-        context.done()
+        context.done() if not context.is_done else None
     elif obj is context.keepAlive:
         pass
     elif isinstance(obj, dict):
         for k, v in obj.items():
             context.output(k, v)
-        context.done()
+        context.done() if not context.is_done else None
     else:
         context.done(f"return object needs to be a dictionary, but get type: {type(obj)}")
 
 logger = logging.getLogger(EXECUTOR_NAME)
 
-async def run_block(message, mainframe: Mainframe, session_dir: str):
+async def run_block(message, mainframe: Mainframe, session_dir: str, tmp_dir: str):
 
     logger.info(f"block {message.get('job_id')} start")
     try:
         payload = ExecutePayload(**message)
-        context = createContext(mainframe, payload.session_id, payload.job_id, store, payload.outputs, session_dir)
+        context = createContext(mainframe, payload.session_id, payload.job_id, store, payload.outputs, session_dir, tmp_dir = tmp_dir)
     except Exception:
         traceback_str = traceback.format_exc()
         # rust 那边会保证传过来的 message 一定是符合格式的，所以这里不应该出现异常。这里主要是防止 rust 修改错误。

{oocana_python_executor-0.15.3 → oocana_python_executor-0.16.0}/python_executor/context.py

@@ -9,7 +9,7 @@ from .data import EXECUTOR_NAME
 logger = logging.getLogger(EXECUTOR_NAME)
 
 def createContext(
-    mainframe: Mainframe, session_id: str, job_id: str, store, output, session_dir: str
+    mainframe: Mainframe, session_id: str, job_id: str, store, output, session_dir: str, tmp_dir: str
 ) -> Context:
 
     node_props = mainframe.notify_block_ready(session_id, job_id)
@@ -59,7 +59,7 @@ def createContext(
     
     blockInfo = BlockInfo(**node_props)
 
-    ctx = Context(inputs, blockInfo, mainframe, store, output, session_dir)
+    ctx = Context(inputs, blockInfo, mainframe, store, output, session_dir, tmp_dir)
     # 跟 executor 日志分开，避免有的库在 logger 里面使用 print，导致 hook 出现递归调用。
     block_logger = logging.getLogger(f"block {job_id}")
     ctx_handler = ContextHandler(ctx)

{oocana_python_executor-0.15.3 → oocana_python_executor-0.16.0}/python_executor/executor.py

@@ -19,9 +19,9 @@ service_store: dict[str, Literal["launching", "running"]] = {}
 job_set = set()
 
 # 日志目录 ~/.oocana/sessions/{session_id}
-# executor 的日志都会记录在 [python-executor-{suffix}.log | python-executor.log]
-# 全局 logger 会记录在 python-{suffix}.log | python.log
-def config_logger(session_id: str, suffix: str | None, output: Literal["console", "file"]):
+# executor 的日志都会记录在 [python-executor-{identifier}.log | python-executor.log]
+# 全局 logger 会记录在 python-{identifier}.log | python.log
+def config_logger(session_id: str, identifier: str | None, output: Literal["console", "file"]):
 
 
     format = '%(asctime)s - %(levelname)s - {%(pathname)s:%(lineno)d} - %(message)s'
@@ -29,7 +29,7 @@ def config_logger(session_id: str, suffix: str | None, output: Literal["console"
     logger.setLevel(logging.DEBUG)
     if output == "file":
         executor_dir = os.path.join(oocana_dir(), "sessions", session_id)
-        logger_file = os.path.join(executor_dir, f"python-executor-{suffix}.log") if suffix is not None else os.path.join(executor_dir, "python-executor.log")
+        logger_file = os.path.join(executor_dir, f"python-executor-{identifier}.log") if identifier is not None else os.path.join(executor_dir, "python-executor.log")
 
         if not os.path.exists(logger_file):
             os.makedirs(os.path.dirname(logger_file), exist_ok=True)
@@ -37,7 +37,7 @@ def config_logger(session_id: str, suffix: str | None, output: Literal["console"
         print(f"setup logging in file {logger_file}")
         h = logging.FileHandler(logger_file)
 
-        global_logger_file = os.path.join(executor_dir, f"python-{suffix}.log") if suffix is not None else os.path.join(executor_dir, "python.log")
+        global_logger_file = os.path.join(executor_dir, f"python-{identifier}.log") if identifier is not None else os.path.join(executor_dir, "python.log")
         logging.basicConfig(filename=global_logger_file, level=logging.DEBUG, format=format)
     else:
         logging.basicConfig(level=logging.DEBUG, format=format)
@@ -49,10 +49,10 @@ def config_logger(session_id: str, suffix: str | None, output: Literal["console"
     logger.propagate = False
 
 
-async def run_executor(address: str, session_id: str, package: str | None, session_dir: str, suffix: str | None = None, identifier: str | None = None):
+async def run_executor(address: str, session_id: str, tmp_dir: str, package: str | None, session_dir: str, identifier: str | None = None):
 
-    if suffix is not None:
-        mainframe = Mainframe(address, f"python-executor-{suffix}", logger)
+    if identifier is not None:
+        mainframe = Mainframe(address, f"python-executor-id-{identifier}", logger)
     else:
         mainframe = Mainframe(address, f"python-executor-{session_id}", logger)
 
@@ -211,12 +211,12 @@ async def run_executor(address: str, session_id: str, package: str | None, sessi
             else:
                 if not_current_session(message):
                     continue
-                run_block_in_new_thread(message, mainframe, session_dir=session_dir)
+                run_block_in_new_thread(message, mainframe, session_dir=session_dir, tmp_dir=tmp_dir)
 
-def run_block_in_new_thread(message, mainframe: Mainframe, session_dir: str):
+def run_block_in_new_thread(message, mainframe: Mainframe, session_dir: str, tmp_dir: str):
 
     async def run():
-        await run_block(message, mainframe, session_dir=session_dir)
+        await run_block(message, mainframe, session_dir=session_dir, tmp_dir=tmp_dir)
     run_in_new_thread(run)
 
 def main():
@@ -224,26 +224,48 @@ def main():
     import argparse
     parser = argparse.ArgumentParser(description="run executor with address, session-id, tmp-dir")
     parser.add_argument("--session-id", help="executor subscribe session id", required=True)
-    parser.add_argument("--address", help="mqtt address", default="mqtt://127.0.0.1:47688")
     parser.add_argument("--session-dir", help="a tmp dir for whole session", required=True)
+    parser.add_argument("--tmp-dir", help="a tmp dir for whole session. It will be cleaned after session success, this behavior is guaranteed by oocana.", required=True)
+    parser.add_argument("--address", help="mqtt address", default="mqtt://127.0.0.1:47688")
     parser.add_argument("--output", help="output log to console or file", default="file", choices=["console", "file"])
     parser.add_argument("--package", help="package path, if set, executor will only run same package block", default=None)
     parser.add_argument("--identifier", help="identifier for executor, oocana will think same identifier as one executor", default=None)
-    parser.add_argument("--suffix", help="suffix for log file", default=None)
+    parser.add_argument("--debug-port", help="debug port for python", default=None)
+    parser.add_argument("--wait-for-client", help="wait for client to connect", default=False, action="store_true")
 
-    args = parser.parse_args()
+    try:
+        args = parser.parse_args()
+    except Exception as e:
+        print(f"parse args error: {e}")
+        # because we hook sys.exit in hook.py and raise a exception, the exit will be reset to 1.
+        # parser origin exit code is 2. so we use 2 here.
+        sys.exit(2)
 
     address: str = args.address
     session_id: str = str(args.session_id)
     output: Literal["console", "file"] = args.output
     package: str | None = args.package
-    suffix: str | None = args.suffix
     session_dir: str = args.session_dir
+    tmp_dir: str = args.tmp_dir
     identifier: str | None = args.identifier
 
-    config_logger(session_id, suffix, output)
-
-    run_async_code(run_executor(address=address, session_id=session_id, package=package, session_dir=session_dir, suffix=suffix, identifier=identifier))
+    config_logger(session_id, identifier, output)
+
+    if args.debug_port is not None and args.debug_port.isdigit():
+        try:
+            import debugpy
+            debugpy.listen(int(args.debug_port))
+            logger.info(f"debugpy listen on port {args.debug_port}")
+            if args.wait_for_client:
+                logger.info("wait for client to connect")
+                debugpy.wait_for_client()
+                logger.info("client connected")
+        except ImportError:
+            logger.warning("Warning: debugpy not installed, debugging functionality will not be available")
+        except Exception as e:
+            logger.warning(f"Warning: debugpy listen failed: {e}")
+
+    run_async_code(run_executor(address=address, tmp_dir=tmp_dir, session_id=session_id, package=package, session_dir=session_dir, identifier=identifier))
 
 if __name__ == '__main__':
     main()

{oocana_python_executor-0.15.3 → oocana_python_executor-0.16.0}/python_executor/service.py

@@ -179,7 +179,7 @@ class ServiceRuntime(ServiceContextAbstractClass):
         self._runningBlocks.add(job_id)
         self._jobs.add(job_id)
 
-        context = createContext(self._mainframe, payload["session_id"], payload["job_id"], self._store, payload["outputs"], self._session_dir)
+        context = createContext(self._mainframe, payload["session_id"], payload["job_id"], self._store, payload["outputs"], self._session_dir, tmp_dir=self._session_dir) # TODO: tmp_dir need consider global service.
 
         if isinstance(self.block_handler, dict):
             handler = self.block_handler.get(block_name)

{oocana_python_executor-0.15.3 → oocana_python_executor-0.16.0}/tests/test_cli.py

@@ -20,7 +20,7 @@ class TestExecutorCLI(unittest.TestCase):
         self.assertIsNone(code, "HTTP server failed to start or exit.")
 
     def test_cli(self):
-        cli_command = [sys.executable, "-u", "-m", "python_executor.executor", "--session-id", "test-session", "--session-dir", "/tmp"]
+        cli_command = [sys.executable, "-u", "-m", "python_executor.executor", "--session-id", "test-session", "--session-dir", "/tmp", "--tmp-dir", "/tmp"]
 
         print("Starting CLI tool... in", executor_parent_dir)