Kernel Provisioning - initial implementation

.github/workflows/main.yml

@@ -112,7 +112,7 @@ jobs:
           pip freeze
 
       - name: Check types
-        run: mypy jupyter_client --exclude '\/tests|kernelspecapp|ioloop|runapp'
+        run: mypy jupyter_client --exclude '\/tests|kernelspecapp|ioloop|runapp' --install-types --non-interactive
 
       - name: Run the tests
         run: pytest --cov jupyter_client -v jupyter_client

docs/api/index.rst

@@ -10,3 +10,4 @@ jupyter_client API
    kernelspec
    manager
    client
+   provisioners

docs/api/manager.rst

@@ -9,12 +9,11 @@ manager - starting, stopping, signalling
 
       The name of the kernel to launch (see :ref:`kernelspecs`).
 
-   .. automethod:: start_kernel
+   .. autoattribute:: provisioner
 
-   .. attribute:: kernel
+      The kernel provisioner with which this :class:`KernelManager` is communicating.  This will generally be a :class:`LocalProvisioner` instance unless the kernelspec indicates otherwise.
 
-      Once the kernel has been started, this is the :class:`subprocess.Popen`
-      class for the kernel process.
+   .. automethod:: start_kernel
 
    .. automethod:: is_alive
 

docs/api/provisioners.rst

@@ -0,0 +1,71 @@
+kernel provisioner apis
+=======================
+
+.. seealso::
+
+   :doc:`/provisioning`
+
+.. module:: jupyter_client.provisioning.provisioner_base
+
+.. autoclass:: KernelProvisionerBase
+
+   .. attribute:: kernel_spec
+
+      The kernel specification associated with the provisioned kernel (see :ref:`kernelspecs`).
+
+   .. attribute:: kernel_id
+
+      The provisioned kernel's ID.
+
+   .. attribute:: connection_info
+
+      The provisioned kernel's connection information.
+
+
+   .. autoproperty:: has_process
+
+   .. automethod:: poll
+
+   .. automethod:: wait
+
+   .. automethod:: send_signal
+
+   .. automethod:: kill
+
+   .. automethod:: terminate
+
+   .. automethod:: launch_kernel
+
+   .. automethod:: cleanup
+
+   .. automethod:: shutdown_requested
+
+   .. automethod:: pre_launch
+
+   .. automethod:: post_launch
+
+   .. automethod:: get_provisioner_info
+
+   .. automethod:: load_provisioner_info
+
+   .. automethod:: get_shutdown_wait_time
+
+   .. automethod:: _finalize_env
+
+   .. automethod:: __apply_env_substitutions
+
+.. module:: jupyter_client.provisioning.local_provisioner
+
+.. autoclass:: LocalProvisioner
+
+.. module:: jupyter_client.provisioning.factory
+
+.. autoclass:: KernelProvisionerFactory
+
+    .. attribute:: default_provisioner_name
+
+       Indicates the name of the provisioner to use when no kernel_provisioner entry is present in the kernel specification.  This value can also be specified via the environment variable ``JUPYTER_DEFAULT_PROVISIONER_NAME``.
+
+    .. automethod:: is_provisioner_available
+
+    .. automethod:: create_provisioner_instance

docs/index.rst

@@ -23,6 +23,7 @@ with Jupyter kernels.
 
    kernels
    wrapperkernels
+   provisioning
 
 .. toctree::
    :maxdepth: 2