ominfra 0.0.0.dev124__py3-none-any.whl → 0.0.0.dev125__py3-none-any.whl

ominfra/supervisor/LICENSE.txt

@@ -1,28 +1,28 @@
 Supervisor is licensed under the following license:
 
-  A copyright notice accompanies this license document that identifies the copyright holders.
+ A copyright notice accompanies this license document that identifies the copyright holders.
 
-  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
-  following conditions are met:
+ Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
+ following conditions are met:
 
-  1.  Redistributions in source code must retain the accompanying copyright notice, this list of conditions, and the
-      following disclaimer.
+ 1. Redistributions in source code must retain the accompanying copyright notice, this list of conditions, and the
+    following disclaimer.
 
-  2.  Redistributions in binary form must reproduce the accompanying copyright notice, this list of conditions, and the
-      following disclaimer in the documentation and/or other materials provided with the distribution.
+ 2. Redistributions in binary form must reproduce the accompanying copyright notice, this list of conditions, and the
+    following disclaimer in the documentation and/or other materials provided with the distribution.
 
-  3.  Names of the copyright holders must not be used to endorse or promote products derived from this software without
-      prior written permission from the copyright holders.
+ 3. Names of the copyright holders must not be used to endorse or promote products derived from this software without
+    prior written permission from the copyright holders.
 
-  4.  If any files are modified, you must cause the modified files to carry prominent notices stating that you changed
-      the files and the date of any change.
+ 4. If any files are modified, you must cause the modified files to carry prominent notices stating that you changed the
+    files and the date of any change.
 
-  Disclaimer
+ Disclaimer
 
-    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY EXPRESSED 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 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.
+  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY EXPRESSED 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 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.

ominfra/supervisor/context.py

@@ -20,8 +20,8 @@ from .exceptions import NotExecutableError
 from .exceptions import NotFoundError
 from .poller import Poller
 from .states import SupervisorState
-from .types import AbstractServerContext
-from .types import AbstractSubprocess
+from .types import Process
+from .types import ServerContext
 from .utils import close_fd
 from .utils import mktempfile
 from .utils import real_exit
@@ -31,7 +31,7 @@ from .utils import try_unlink
 ServerEpoch = ta.NewType('ServerEpoch', int)
 
 
-class ServerContext(AbstractServerContext):
+class ServerContextImpl(ServerContext):
     def __init__(
             self,
             config: ServerConfig,
@@ -45,7 +45,7 @@ class ServerContext(AbstractServerContext):
         self._poller = poller
         self._epoch = epoch
 
-        self._pid_history: ta.Dict[int, AbstractSubprocess] = {}
+        self._pid_history: ta.Dict[int, Process] = {}
         self._state: SupervisorState = SupervisorState.RUNNING
 
         if config.user is not None:
@@ -78,7 +78,7 @@ class ServerContext(AbstractServerContext):
         self._state = state
 
     @property
-    def pid_history(self) -> ta.Dict[int, AbstractSubprocess]:
+    def pid_history(self) -> ta.Dict[int, Process]:
         return self._pid_history
 
     @property

ominfra/supervisor/dispatchers.py

@@ -12,7 +12,7 @@ from .events import EventCallbacks
 from .events import ProcessCommunicationEvent
 from .events import ProcessLogStderrEvent
 from .events import ProcessLogStdoutEvent
-from .types import AbstractSubprocess
+from .types import Process
 from .utils import as_bytes
 from .utils import compact_traceback
 from .utils import find_prefix_at_end
@@ -23,7 +23,7 @@ from .utils import strip_escapes
 class Dispatcher(abc.ABC):
     def __init__(
             self,
-            process: AbstractSubprocess,
+            process: Process,
             channel: str,
             fd: int,
             *,
@@ -42,7 +42,7 @@ class Dispatcher(abc.ABC):
         return f'<{self.__class__.__name__} at {id(self)} for {self._process} ({self._channel})>'
 
     @property
-    def process(self) -> AbstractSubprocess:
+    def process(self) -> Process:
         return self._process
 
     @property
@@ -97,7 +97,7 @@ class OutputDispatcher(Dispatcher):
 
     def __init__(
             self,
-            process: AbstractSubprocess,
+            process: Process,
             event_type: ta.Type[ProcessCommunicationEvent],
             fd: int,
             **kwargs: ta.Any,
@@ -306,7 +306,7 @@ class OutputDispatcher(Dispatcher):
 class InputDispatcher(Dispatcher):
     def __init__(
             self,
-            process: AbstractSubprocess,
+            process: Process,
             channel: str,
             fd: int,
             **kwargs: ta.Any,

ominfra/supervisor/events.py

@@ -5,6 +5,9 @@ import typing as ta
 from .states import ProcessState
 
 
+EventCallback = ta.Callable[['Event'], None]
+
+
 ##
 
 
@@ -15,9 +18,6 @@ class Event(abc.ABC):  # noqa
 ##
 
 
-EventCallback = ta.Callable[['Event'], None]
-
-
 class EventCallbacks:
     def __init__(self) -> None:
         super().__init__()

ominfra/supervisor/groups.py

@@ -1,48 +1,42 @@
 # ruff: noqa: UP006 UP007
-import dataclasses as dc
 import typing as ta
 
-from .configs import ProcessConfig
+from omlish.lite.typing import Func
+
 from .configs import ProcessGroupConfig
-from .context import ServerContext
 from .dispatchers import Dispatcher
 from .events import EventCallbacks
 from .events import ProcessGroupAddedEvent
 from .events import ProcessGroupRemovedEvent
 from .states import ProcessState
-from .types import AbstractProcessGroup
-from .types import AbstractServerContext
-from .types import AbstractSubprocess
+from .types import Process
+from .types import ProcessGroup
+from .types import ServerContext
 
 
 ##
 
 
-@dc.dataclass(frozen=True)
-class SubprocessFactory:
-    fn: ta.Callable[[ProcessConfig, AbstractProcessGroup], AbstractSubprocess]
-
-    def __call__(self, config: ProcessConfig, group: AbstractProcessGroup) -> AbstractSubprocess:
-        return self.fn(config, group)
+ProcessFactory = ta.NewType('ProcessFactory', Func[Process])  # (config: ProcessConfig, group: ProcessGroup)
 
 
-class ProcessGroup(AbstractProcessGroup):
+class ProcessGroupImpl(ProcessGroup):
     def __init__(
             self,
             config: ProcessGroupConfig,
             context: ServerContext,
             *,
-            subprocess_factory: SubprocessFactory,
+            process_factory: ProcessFactory,
     ):
         super().__init__()
 
         self._config = config
         self._context = context
-        self._subprocess_factory = subprocess_factory
+        self._process_factory = process_factory
 
         self._processes = {}
         for pconfig in self._config.processes or []:
-            process = self._subprocess_factory(pconfig, self)
+            process = self._process_factory(pconfig, self)
             self._processes[pconfig.name] = process
 
     @property
@@ -54,7 +48,7 @@ class ProcessGroup(AbstractProcessGroup):
         return self._config.name
 
     @property
-    def context(self) -> AbstractServerContext:
+    def context(self) -> ServerContext:
         return self._context
 
     def __repr__(self):
@@ -89,7 +83,7 @@ class ProcessGroup(AbstractProcessGroup):
                 # BACKOFF -> FATAL
                 proc.give_up()
 
-    def get_unstopped_processes(self) -> ta.List[AbstractSubprocess]:
+    def get_unstopped_processes(self) -> ta.List[Process]:
         return [x for x in self._processes.values() if not x.get_state().stopped]
 
     def get_dispatchers(self) -> ta.Dict[int, Dispatcher]:

ominfra/supervisor/inject.py

@@ -1,32 +1,26 @@
 # ruff: noqa: UP006 UP007
-import functools
 import typing as ta
 
-from omlish.lite.inject import Injector
 from omlish.lite.inject import InjectorBindingOrBindings
 from omlish.lite.inject import InjectorBindings
 from omlish.lite.inject import inj
 
-from .configs import ProcessConfig
-from .configs import ProcessGroupConfig
 from .configs import ServerConfig
-from .context import ServerContext
+from .context import ServerContextImpl
 from .context import ServerEpoch
 from .events import EventCallbacks
-from .groups import ProcessGroup
-from .groups import SubprocessFactory
+from .groups import ProcessFactory
+from .groups import ProcessGroupImpl
 from .poller import Poller
 from .poller import get_poller_impl
 from .process import InheritedFds
-from .process import Subprocess
+from .process import ProcessImpl
 from .signals import SignalReceiver
 from .supervisor import ProcessGroupFactory
 from .supervisor import ProcessGroups
 from .supervisor import SignalHandler
 from .supervisor import Supervisor
-from .types import AbstractProcessGroup
-from .types import AbstractServerContext
-from .types import AbstractSubprocess
+from .types import ServerContext
 
 
 ##
@@ -43,8 +37,8 @@ def bind_server(
 
         inj.bind(get_poller_impl(), key=Poller, singleton=True),
 
-        inj.bind(ServerContext, singleton=True),
-        inj.bind(AbstractServerContext, to_key=ServerContext),
+        inj.bind(ServerContextImpl, singleton=True),
+        inj.bind(ServerContext, to_key=ServerContextImpl),
 
         inj.bind(EventCallbacks, singleton=True),
 
@@ -53,21 +47,10 @@ def bind_server(
         inj.bind(SignalHandler, singleton=True),
         inj.bind(ProcessGroups, singleton=True),
         inj.bind(Supervisor, singleton=True),
-    ]
-
-    #
 
-    def make_process_group_factory(injector: Injector) -> ProcessGroupFactory:
-        def inner(group_config: ProcessGroupConfig) -> ProcessGroup:
-            return injector.inject(functools.partial(ProcessGroup, group_config))
-        return ProcessGroupFactory(inner)
-    lst.append(inj.bind(make_process_group_factory))
-
-    def make_subprocess_factory(injector: Injector) -> SubprocessFactory:
-        def inner(process_config: ProcessConfig, group: AbstractProcessGroup) -> AbstractSubprocess:
-            return injector.inject(functools.partial(Subprocess, process_config, group))
-        return SubprocessFactory(inner)
-    lst.append(inj.bind(make_subprocess_factory))
+        inj.bind_factory(ProcessGroupFactory, ProcessGroupImpl),
+        inj.bind_factory(ProcessFactory, ProcessImpl),
+    ]
 
     #
 

ominfra/supervisor/main.py

@@ -1,6 +1,34 @@
 #!/usr/bin/env python3
 # ruff: noqa: UP006 UP007
 # @omlish-amalg ../scripts/supervisor.py
+# Supervisor is licensed under the following license:
+#
+#  A copyright notice accompanies this license document that identifies the copyright holders.
+#
+#  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
+#  following conditions are met:
+#
+#  1. Redistributions in source code must retain the accompanying copyright notice, this list of conditions, and the
+#     following disclaimer.
+#
+#  2. Redistributions in binary form must reproduce the accompanying copyright notice, this list of conditions, and the
+#     following disclaimer in the documentation and/or other materials provided with the distribution.
+#
+#  3. Names of the copyright holders must not be used to endorse or promote products derived from this software without
+#     prior written permission from the copyright holders.
+#
+#  4. If any files are modified, you must cause the modified files to carry prominent notices stating that you changed
+#     the files and the date of any change.
+#
+#  Disclaimer
+#
+#   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY EXPRESSED 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 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.
 import itertools
 import os.path
 import typing as ta
@@ -13,7 +41,7 @@ from omlish.lite.logs import configure_standard_logging
 from ..configs import read_config_file
 from .configs import ServerConfig
 from .configs import prepare_server_config
-from .context import ServerContext
+from .context import ServerContextImpl
 from .context import ServerEpoch
 from .inject import bind_server
 from .process import InheritedFds
@@ -74,7 +102,7 @@ def main(
             inherited_fds=inherited_fds,
         ))
 
-        context = injector[ServerContext]
+        context = injector[ServerContextImpl]
         supervisor = injector[Supervisor]
 
         try:

ominfra/supervisor/process.py

@@ -30,9 +30,9 @@ from .exceptions import ProcessError
 from .signals import sig_name
 from .states import ProcessState
 from .states import SupervisorState
-from .types import AbstractProcessGroup
-from .types import AbstractServerContext
-from .types import AbstractSubprocess
+from .types import Process
+from .types import ProcessGroup
+from .types import ServerContext
 from .utils import as_bytes
 from .utils import as_string
 from .utils import close_fd
@@ -48,15 +48,15 @@ InheritedFds = ta.NewType('InheritedFds', ta.FrozenSet[int])
 ##
 
 
-class Subprocess(AbstractSubprocess):
+class ProcessImpl(Process):
     """A class to manage a subprocess."""
 
     def __init__(
             self,
             config: ProcessConfig,
-            group: AbstractProcessGroup,
+            group: ProcessGroup,
             *,
-            context: AbstractServerContext,
+            context: ServerContext,
             event_callbacks: EventCallbacks,
 
             inherited_fds: ta.Optional[InheritedFds] = None,
@@ -95,7 +95,7 @@ class Subprocess(AbstractSubprocess):
         return self._pid
 
     @property
-    def group(self) -> AbstractProcessGroup:
+    def group(self) -> ProcessGroup:
         return self._group
 
     @property
@@ -103,7 +103,7 @@ class Subprocess(AbstractSubprocess):
         return self._config
 
     @property
-    def context(self) -> AbstractServerContext:
+    def context(self) -> ServerContext:
         return self._context
 
     @property

ominfra/supervisor/supervisor.py

@@ -1,5 +1,4 @@
 # ruff: noqa: UP006 UP007
-import dataclasses as dc
 import signal
 import time
 import typing as ta
@@ -7,9 +6,10 @@ import typing as ta
 from omlish.lite.cached import cached_nullary
 from omlish.lite.check import check_not_none
 from omlish.lite.logs import log
+from omlish.lite.typing import Func
 
 from .configs import ProcessGroupConfig
-from .context import ServerContext
+from .context import ServerContextImpl
 from .dispatchers import Dispatcher
 from .events import TICK_EVENTS
 from .events import EventCallbacks
@@ -18,10 +18,10 @@ from .events import SupervisorStoppingEvent
 from .groups import ProcessGroup
 from .groups import ProcessGroups
 from .poller import Poller
-from .process import Subprocess
 from .signals import SignalReceiver
 from .signals import sig_name
 from .states import SupervisorState
+from .types import Process
 from .utils import ExitNow
 from .utils import as_string
 from .utils import decode_wait_status
@@ -35,7 +35,7 @@ class SignalHandler:
     def __init__(
             self,
             *,
-            context: ServerContext,
+            context: ServerContextImpl,
             signal_receiver: SignalReceiver,
             process_groups: ProcessGroups,
     ) -> None:
@@ -87,19 +87,14 @@ class SignalHandler:
 ##
 
 
-@dc.dataclass(frozen=True)
-class ProcessGroupFactory:
-    fn: ta.Callable[[ProcessGroupConfig], ProcessGroup]
-
-    def __call__(self, config: ProcessGroupConfig) -> ProcessGroup:
-        return self.fn(config)
+ProcessGroupFactory = ta.NewType('ProcessGroupFactory', Func[ProcessGroup])  # (config: ProcessGroupConfig)
 
 
 class Supervisor:
     def __init__(
             self,
             *,
-            context: ServerContext,
+            context: ServerContextImpl,
             poller: Poller,
             process_groups: ProcessGroups,
             signal_handler: SignalHandler,
@@ -123,7 +118,7 @@ class Supervisor:
     #
 
     @property
-    def context(self) -> ServerContext:
+    def context(self) -> ServerContextImpl:
         return self._context
 
     def get_state(self) -> SupervisorState:
@@ -170,16 +165,16 @@ class Supervisor:
         return True
 
     def get_process_map(self) -> ta.Dict[int, Dispatcher]:
-        process_map = {}
+        process_map: ta.Dict[int, Dispatcher] = {}
         for group in self._process_groups:
             process_map.update(group.get_dispatchers())
         return process_map
 
-    def shutdown_report(self) -> ta.List[Subprocess]:
-        unstopped: ta.List[Subprocess] = []
+    def shutdown_report(self) -> ta.List[Process]:
+        unstopped: ta.List[Process] = []
 
         for group in self._process_groups:
-            unstopped.extend(group.get_unstopped_processes())  # type: ignore
+            unstopped.extend(group.get_unstopped_processes())
 
         if unstopped:
             # throttle 'waiting for x to die' reports

ominfra/supervisor/types.py

@@ -10,7 +10,7 @@ from .states import ProcessState
 from .states import SupervisorState
 
 
-class AbstractServerContext(abc.ABC):
+class ServerContext(abc.ABC):
     @property
     @abc.abstractmethod
     def config(self) -> ServerConfig:
@@ -27,12 +27,24 @@ class AbstractServerContext(abc.ABC):
 
     @property
     @abc.abstractmethod
-    def pid_history(self) -> ta.Dict[int, 'AbstractSubprocess']:
+    def pid_history(self) -> ta.Dict[int, 'Process']:
         raise NotImplementedError
 
 
+# class Dispatcher(abc.ABC):
+#     pass
+#
+#
+# class OutputDispatcher(Dispatcher, abc.ABC):
+#     pass
+#
+#
+# class InputDispatcher(Dispatcher, abc.ABC):
+#     pass
+
+
 @functools.total_ordering
-class AbstractSubprocess(abc.ABC):
+class Process(abc.ABC):
     @property
     @abc.abstractmethod
     def pid(self) -> int:
@@ -51,7 +63,7 @@ class AbstractSubprocess(abc.ABC):
 
     @property
     @abc.abstractmethod
-    def context(self) -> AbstractServerContext:
+    def context(self) -> ServerContext:
         raise NotImplementedError
 
     @abc.abstractmethod
@@ -87,12 +99,12 @@ class AbstractSubprocess(abc.ABC):
         raise NotImplementedError
 
     @abc.abstractmethod
-    def get_dispatchers(self) -> ta.Mapping[int, ta.Any]:  # dict[int, Dispatcher]
+    def get_dispatchers(self) -> ta.Mapping[int, ta.Any]:  # Dispatcher]:
         raise NotImplementedError
 
 
 @functools.total_ordering
-class AbstractProcessGroup(abc.ABC):
+class ProcessGroup(abc.ABC):
     @property
     @abc.abstractmethod
     def config(self) -> ProcessGroupConfig:
@@ -103,3 +115,36 @@ class AbstractProcessGroup(abc.ABC):
 
     def __eq__(self, other):
         return self.config.priority == other.config.priority
+
+    @abc.abstractmethod
+    def transition(self) -> None:
+        raise NotImplementedError
+
+    @abc.abstractmethod
+    def stop_all(self) -> None:
+        raise NotImplementedError
+
+    @property
+    @abc.abstractmethod
+    def name(self) -> str:
+        raise NotImplementedError
+
+    @abc.abstractmethod
+    def before_remove(self) -> None:
+        raise NotImplementedError
+
+    @abc.abstractmethod
+    def get_dispatchers(self) -> ta.Mapping[int, ta.Any]:  # Dispatcher]:
+        raise NotImplementedError
+
+    @abc.abstractmethod
+    def reopen_logs(self) -> None:
+        raise NotImplementedError
+
+    @abc.abstractmethod
+    def get_unstopped_processes(self) -> ta.List[Process]:
+        raise NotImplementedError
+
+    @abc.abstractmethod
+    def after_setuid(self) -> None:
+        raise NotImplementedError

{ominfra-0.0.0.dev124.dist-info → ominfra-0.0.0.dev125.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ominfra
-Version: 0.0.0.dev124
+Version: 0.0.0.dev125
 Summary: ominfra
 Author: wrmsr
 License: BSD-3-Clause
@@ -12,8 +12,8 @@ Classifier: Operating System :: OS Independent
 Classifier: Operating System :: POSIX
 Requires-Python: >=3.12
 License-File: LICENSE
-Requires-Dist: omdev==0.0.0.dev124
-Requires-Dist: omlish==0.0.0.dev124
+Requires-Dist: omdev==0.0.0.dev125
+Requires-Dist: omlish==0.0.0.dev125
 Provides-Extra: all
 Requires-Dist: paramiko~=3.5; extra == "all"
 Requires-Dist: asyncssh~=2.18; extra == "all"