ansible: cleanup various docstrings

ansible_mitogen/process.py

@@ -359,6 +359,11 @@ class Binding(object):
 
 
 class WorkerModel(object):
+    """
+    Interface used by StrategyMixin to manage various Mitogen services, by
+    default running in one or more connection multiplexer subprocesses spawned
+    off the top-level Ansible process.
+    """
     def on_strategy_start(self):
         """
         Called prior to strategy start in the top-level process. Responsible
@@ -375,6 +380,11 @@ class WorkerModel(object):
         raise NotImplementedError()
 
     def get_binding(self, inventory_name):
+        """
+        Return a :class:`Binding` to access Mitogen services for
+        `inventory_name`. Usually called from worker processes, but may also be
+        called from top-level process to handle "meta: reset_connection".
+        """
         raise NotImplementedError()
 
 
@@ -434,13 +444,10 @@ class ClassicWorkerModel(WorkerModel):
 
     def __init__(self, _init_logging=True):
         """
-        Arrange for classic model multiplexers to be started, if they are not
+        Arrange for classic model multiplexers to be started. The parent choses
-        already running.
+        UNIX socket paths each child will use prior to fork, creates a
-
+        socketpair used essentially as a semaphore, then blocks waiting for the
-        The parent process picks a UNIX socket path each child will use prior
+        child to indicate the UNIX socket is ready for use.
-        to fork, creates a socketpair used essentially as a semaphore, then
-        blocks waiting for the child to indicate the UNIX socket is ready for
-        use.
 
         :param bool _init_logging:
             For testing, if :data:`False`, don't initialize logging.

ansible_mitogen/strategy.py

@@ -124,7 +124,7 @@ def wrap_action_loader__get(name, *args, **kwargs):
     the use of shell fragments wherever possible.
 
     This is used instead of static subclassing as it generalizes to third party
-    action modules outside the Ansible tree.
+    action plugins outside the Ansible tree.
     """
     get_kwargs = {'class_only': True}
     if ansible.__version__ >= '2.8':
@@ -141,8 +141,8 @@ def wrap_action_loader__get(name, *args, **kwargs):
 
 def wrap_connection_loader__get(name, *args, **kwargs):
     """
-    While the strategy is active, rewrite connection_loader.get() calls for
+    While a Mitogen strategy is active, rewrite connection_loader.get() calls
-    some transports into requests for a compatible Mitogen transport.
+    for some transports into requests for a compatible Mitogen transport.
     """
     if name in ('buildah', 'docker', 'kubectl', 'jail', 'local',
                 'lxc', 'lxd', 'machinectl', 'setns', 'ssh'):
@@ -152,8 +152,10 @@ def wrap_connection_loader__get(name, *args, **kwargs):
 
 def wrap_worker__run(self):
     """
-    While the strategy is active, rewrite connection_loader.get() calls for
+    While a Mitogen strategy is active, trap WorkerProcess.run() calls and use
-    some transports into requests for a compatible Mitogen transport.
+    the opportunity to set the worker's name in the process list and log
+    output, activate profiling if requested, and bind the worker to a specific
+    CPU.
     """
     if setproctitle:
         setproctitle.setproctitle('worker:%s task:%s' % (
@@ -225,10 +227,14 @@ class AnsibleWrappers(object):
 
 class StrategyMixin(object):
     """
-    This mix-in enhances any built-in strategy by arranging for various Mitogen
+    This mix-in enhances any built-in strategy by arranging for an appropriate
-    services to be initialized in the Ansible top-level process, and for worker
+    WorkerModel instance to be constructed as necessary, or for the existing
-    processes to grow support for using those top-level services to communicate
+    one to be reused.
-    with and execute modules on remote hosts.
+
+    The WorkerModel in turn arranges for a connection multiplexer to be started
+    somewhere (by default in an external process), and for WorkerProcesses to
+    grow support for using those top-level services to communicate with remote
+    hosts.
 
     Mitogen:
 
@@ -246,18 +252,19 @@ class StrategyMixin(object):
         services, review the Standard Handles section of the How It Works guide
         in the documentation.
 
-        A ContextService is installed as a message handler in the master
+        A ContextService is installed as a message handler in the connection
-        process and run on a private thread. It is responsible for accepting
+        mutliplexer subprocess and run on a private thread. It is responsible
-        requests to establish new SSH connections from worker processes, and
+        for accepting requests to establish new SSH connections from worker
-        ensuring precisely one connection exists and is reused for subsequent
+        processes, and ensuring precisely one connection exists and is reused
-        playbook steps. The service presently runs in a single thread, so to
+        for subsequent playbook steps. The service presently runs in a single
-        begin with, new SSH connections are serialized.
+        thread, so to begin with, new SSH connections are serialized.
 
         Finally a mitogen.unix listener is created through which WorkerProcess
-        can establish a connection back into the master process, in order to
+        can establish a connection back into the connection multiplexer, in
-        avail of ContextService. A UNIX listener socket is necessary as there
+        order to avail of ContextService. A UNIX listener socket is necessary
-        is no more sane mechanism to arrange for IPC between the Router in the
+        as there is no more sane mechanism to arrange for IPC between the
-        master process, and the corresponding Router in the worker process.
+        Router in the connection multiplexer, and the corresponding Router in
+        the worker process.
 
     Ansible:
 
@@ -265,10 +272,10 @@ class StrategyMixin(object):
         connection and action plug-ins.
 
         For connection plug-ins, if the desired method is "local" or "ssh", it
-        is redirected to the "mitogen" connection plug-in. That plug-in
+        is redirected to one of the "mitogen_*" connection plug-ins. That
-        implements communication via a UNIX socket connection to the top-level
+        plug-in implements communication via a UNIX socket connection to the
-        Ansible process, and uses ContextService running in the top-level
+        connection multiplexer process, and uses ContextService running there
-        process to actually establish and manage the connection.
+        to establish a persistent connection to the target.
 
         For action plug-ins, the original class is looked up as usual, but a
         new subclass is created dynamically in order to mix-in