Reorganize to match current Java codebase

Author: ctrueden

src/appose/__init__.py

@@ -218,7 +218,7 @@ def task_listener(event):
 
 from .builder import Builder
 from .environment import Environment
-from .types import NDArray, SharedMemory  # noqa: F401
+from .shm import NDArray, SharedMemory  # noqa: F401
 
 
 def base(directory: Path) -> Builder:

src/appose/builder.py src/appose/builder/__init__.pysrc/appose/builder.py renamed to src/appose/builder/__init__.py

@@ -35,7 +35,7 @@
 
 from pathlib import Path
 
-from .environment import Environment
+from ..environment import Environment
 
 
 class Builder:

src/appose/environment.py

@@ -36,7 +36,7 @@
 import os
 from pathlib import Path
 
-from .filepath import find_exe
+from .util.filepath import find_exe
 from .service import Service
 
 

src/appose/python_worker.py

@@ -50,7 +50,8 @@
 
 # NB: Avoid relative imports so that this script can be run standalone.
 from appose.service import RequestType, ResponseType
-from appose.types import Args, _set_worker, decode, encode
+from appose.util import types
+from appose.util.types import Args, decode, encode
 
 
 class Task:
@@ -200,7 +201,7 @@ def __init__(self):
         self.exports: dict[str, Any] = {}
 
         # Flag this process as a worker, not a service.
-        _set_worker(True)
+        types._worker_mode = True
 
     def run(self) -> None:
         """

src/appose/service.py

@@ -41,7 +41,7 @@
 from typing import Any, Callable
 from uuid import uuid4
 
-from .types import Args, decode, encode
+from .util.types import Args, decode, encode
 
 
 class Service:
@@ -55,7 +55,7 @@ class Service:
     _service_count: int = 0
 
     def __init__(self, cwd: str | Path, args: list[str]) -> None:
-        self._cwd: str | Path = cwd
+        self._cwd: Path = Path(cwd)
         self._args: list[str] = args[:]
         self._tasks: dict[str, "Task"] = {}
         self._service_id: int = Service._service_count

src/appose/types.py src/appose/shm.pysrc/appose/types.py renamed to src/appose/shm.py

@@ -33,13 +33,11 @@
 
 from __future__ import annotations
 
-import json
 import re
 from math import ceil, prod
 from multiprocessing import resource_tracker, shared_memory
-from typing import Any
 
-Args = dict[str, Any]
+from .util import types
 
 
 class SharedMemory(shared_memory.SharedMemory):
@@ -70,7 +68,7 @@ def __init__(self, name: str = None, create: bool = False, rsize: int = 0):
         super().__init__(name=name, create=create, size=rsize)
         self.rsize: int = rsize
         self._unlink_on_dispose: bool = create
-        if _is_worker:
+        if types._worker_mode:
             # HACK: Remove this shared memory block from the resource_tracker,
             # which would otherwise want to clean up shared memory blocks
             # after all known references are done using them.
@@ -141,14 +139,6 @@ def __exit__(self, exc_type, exc_value, exc_tb) -> None:
         self.dispose()
 
 
-def encode(data: Args) -> str:
-    return json.dumps(data, cls=_ApposeJSONEncoder, separators=(",", ":"))
-
-
-def decode(the_json: str) -> Args:
-    return json.loads(the_json, object_hook=_appose_object_hook)
-
-
 class NDArray:
     """
     Data structure for a multi-dimensional array.
@@ -204,46 +194,9 @@ def __exit__(self, exc_type, exc_value, exc_tb) -> None:
         self.shm.dispose()
 
 
-class _ApposeJSONEncoder(json.JSONEncoder):
-    def default(self, obj):
-        if isinstance(obj, SharedMemory):
-            return {
-                "appose_type": "shm",
-                "name": obj.name,
-                "rsize": obj.rsize,
-            }
-        if isinstance(obj, NDArray):
-            return {
-                "appose_type": "ndarray",
-                "dtype": obj.dtype,
-                "shape": obj.shape,
-                "shm": obj.shm,
-            }
-        return super().default(obj)
-
-
-def _appose_object_hook(obj: dict):
-    atype = obj.get("appose_type")
-    if atype == "shm":
-        # Attach to existing shared memory block.
-        return SharedMemory(name=(obj["name"]), rsize=(obj["rsize"]))
-    elif atype == "ndarray":
-        return NDArray(obj["dtype"], obj["shape"], obj["shm"])
-    else:
-        return obj
-
-
 def _bytes_per_element(dtype: str) -> int | float:
     try:
         bits = int(re.sub("[^0-9]", "", dtype))
     except ValueError:
         raise ValueError(f"Invalid dtype: {dtype}")
     return bits / 8
-
-
-_is_worker = False
-
-
-def _set_worker(value: bool) -> None:
-    global _is_worker
-    _is_worker = value

src/appose/util/__init__.py

@@ -0,0 +1 @@
+pass

src/appose/filepath.py src/appose/util/filepath.pysrc/appose/filepath.py renamed to src/appose/util/filepath.py

@@ -0,0 +1,82 @@
+###
+# #%L
+# Appose: multi-language interprocess cooperation with shared memory.
+# %%
+# Copyright (C) 2023 - 2025 Appose developers.
+# %%
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+# #L%
+###
+
+"""
+TODO
+"""
+
+from __future__ import annotations
+
+import json
+from typing import Any
+
+from ..shm import NDArray, SharedMemory
+
+Args = dict[str, Any]
+
+# Flag indicating whether this process is running as an Appose worker.
+# Set to True by python_worker.Worker.__init__().
+_worker_mode = False
+
+
+def encode(data: Args) -> str:
+    return json.dumps(data, cls=_ApposeJSONEncoder, separators=(",", ":"))
+
+
+def decode(the_json: str) -> Args:
+    return json.loads(the_json, object_hook=_appose_object_hook)
+
+
+class _ApposeJSONEncoder(json.JSONEncoder):
+    def default(self, obj):
+        if isinstance(obj, SharedMemory):
+            return {
+                "appose_type": "shm",
+                "name": obj.name,
+                "rsize": obj.rsize,
+            }
+        if isinstance(obj, NDArray):
+            return {
+                "appose_type": "ndarray",
+                "dtype": obj.dtype,
+                "shape": obj.shape,
+                "shm": obj.shm,
+            }
+        return super().default(obj)
+
+
+def _appose_object_hook(obj: dict):
+    atype = obj.get("appose_type")
+    if atype == "shm":
+        # Attach to existing shared memory block.
+        return SharedMemory(name=(obj["name"]), rsize=(obj["rsize"]))
+    elif atype == "ndarray":
+        return NDArray(obj["dtype"], obj["shape"], obj["shm"])
+    else:
+        return obj