Merge remote-tracking branch 'upstream/main' into windows

# Conflicts:
#	CHANGES.rst
#	setup.py
#	supervisor/compat.py
#	supervisor/dispatchers.py
#	supervisor/options.py
#	supervisor/supervisord.py
#	supervisor/tests/test_childutils.py
#	supervisor/tests/test_confecho.py
#	supervisor/tests/test_dispatchers.py
#	supervisor/tests/test_events.py
#	supervisor/tests/test_http.py
#	supervisor/tests/test_loggers.py
#	supervisor/tests/test_options.py
#	supervisor/tests/test_poller.py
#	supervisor/tests/test_process.py
#	supervisor/tests/test_rpcinterfaces.py
#	supervisor/tests/test_socket_manager.py
#	supervisor/tests/test_states.py
#	supervisor/tests/test_supervisorctl.py
#	supervisor/tests/test_supervisord.py
#	supervisor/tests/test_web.py
#	supervisor/xmlrpc.py

Author: alexsilva

.github/workflows/main.yml

@@ -4,72 +4,71 @@ on: [push, pull_request]
 
 jobs:
   tests:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
     strategy:
       fail-fast: false
       matrix:
-        python-version: [2.7, 3.4, 3.5, 3.6, 3.7, 3.8, 3.9, "3.10"]
+        python-version: [2.7, 3.5, 3.6, 3.7, 3.8, 3.9, "3.10", 3.11]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
 
-    - name: Show Python version
-      run: python -V
-
-    - name: Set TOXENV based on Python version
-      run: python -c 'import sys; print("TOXENV=py%d%d" % (sys.version_info.major, sys.version_info.minor))' | tee -a $GITHUB_ENV
-
     - name: Install dependencies
       run: pip install virtualenv tox
 
+    - name: Set variable for TOXENV based on Python version
+      id: toxenv
+      run: python -c 'import sys; print("TOXENV=py%d%d" % (sys.version_info.major, sys.version_info.minor))' | tee -a $GITHUB_OUTPUT
+
     - name: Run the unit tests
-      run: tox
+      run: TOXENV=${{steps.toxenv.outputs.TOXENV}} tox
 
     - name: Run the end-to-end tests
-      run: END_TO_END=1 tox
+      run: TOXENV=${{steps.toxenv.outputs.TOXENV}} END_TO_END=1 tox
 
   coverage:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
     strategy:
       fail-fast: false
       matrix:
-        python-version: [2.7, 3.7]
+        python-version: [2.7, 3.8]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
 
     - name: Install dependencies
       run: pip install virtualenv tox
 
-    - name: Set TOXENV based on Python version
-      run: python -c 'import sys; e="cover" if sys.version_info.major == 2 else "cover3"; print("TOXENV=%s" % e)' | tee -a $GITHUB_ENV
+    - name: Set variable for TOXENV based on Python version
+      id: toxenv
+      run: python -c 'import sys; e="cover" if sys.version_info.major == 2 else "cover3"; print("TOXENV=%s" % e)' | tee -a $GITHUB_OUTPUT
 
     - name: Run unit test coverage
-      run: tox
+      run: TOXENV=${{steps.toxenv.outputs.TOXENV}} tox
 
   docs:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: "3.8"
 
     - name: Install dependencies
-      run: pip install virtualenv tox
+      run: pip install virtualenv tox>=4.0.0
 
     - name: Build the docs
       run: TOXENV=docs tox

.readthedocs.yaml

@@ -0,0 +1,23 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# We recommend specifying your dependencies to enable reproducible builds:
+# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+# python:
+#   install:
+#   - requirements: docs/requirements.txt
+

COPYRIGHT.txt

@@ -1,27 +1,6 @@
 Supervisor is Copyright (c) 2006-2015 Agendaless Consulting and Contributors.
 (http://www.agendaless.com), All Rights Reserved
 
-  This software is subject to the provisions of the license at
-  http://www.repoze.org/LICENSE.txt . A copy of this license should
-  accompany this distribution.  THIS SOFTWARE IS PROVIDED "AS IS" AND
-  ANY AND ALL EXPRESS OR IMPLIED WARRANTIES ARE DISCLAIMED, INCLUDING,
-  BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF TITLE,
-  MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS FOR A PARTICULAR
-  PURPOSE.
-
 medusa was (is?) Copyright (c) Sam Rushing.
 
 http_client.py code Copyright (c) by Daniel Krech, http://eikeon.com/.
-
-  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
-  OWNER 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.
-

docs/api.rst

@@ -321,6 +321,8 @@ Process Control
         same elements as the struct returned by ``getProcessInfo``. If the process
         table is empty, an empty array is returned.
 
+    .. automethod:: getAllConfigInfo
+
     .. automethod:: startProcess
 
     .. automethod:: startAllProcesses

docs/configuration.rst

@@ -321,7 +321,7 @@ follows.
   activity log.  One of ``critical``, ``error``, ``warn``, ``info``,
   ``debug``, ``trace``, or ``blather``.  Note that at log level
   ``debug``, the supervisord log file will record the stderr/stdout
-  output of its child processes and extended info info about process
+  output of its child processes and extended info about process
   state changes, which is useful for debugging a process which isn't
   starting properly.  See also: :ref:`activity_log_levels`.
 
@@ -1508,9 +1508,9 @@ sections do not have.
 
 ``result_handler``
 
-  A `pkg_resources entry point string
-  <http://peak.telecommunity.com/DevCenter/PkgResources>`_ that
-  resolves to a Python callable.  The default value is
+  An `entry point object reference
+  <https://packaging.python.org/en/latest/specifications/entry-points/#data-model>`_
+  string that resolves to a Python callable.  The default value is
   ``supervisor.dispatchers:default_handler``.  Specifying an alternate
   result handler is a very uncommon thing to need to do, and as a
   result, how to create one is not documented.
@@ -1611,7 +1611,7 @@ And a section in the config file meant to configure it.
 
 ``supervisor.rpcinterface_factory``
 
-  ``pkg_resources`` "entry point" dotted name to your RPC interface's
+  ``entry point object reference`` dotted name to your RPC interface's
   factory function.
 
   *Default*: N/A

docs/events.rst

@@ -93,9 +93,9 @@ follows.
 
    An advanced feature, specifying an alternate "result handler" for a
    pool, can be specified via the ``result_handler`` parameter of an
-   ``[eventlistener:x]`` section in the form of a `pkg_resources
-   <http://peak.telecommunity.com/DevCenter/PkgResources>`_ "entry
-   point" string.  The default result handler is
+   ``[eventlistener:x]`` section in the form of an `entry point object reference
+   <https://packaging.python.org/en/latest/specifications/entry-points/#data-model>`_
+   string.  The default result handler is
    ``supervisord.dispatchers:default_handler``.  Creating an alternate
    result handler is not currently documented.
 
@@ -177,7 +177,7 @@ pool        The name of the event listener pool which       myeventpool
 poolserial  An integer assigned to each event by the        30
             eventlistener pool which it is being sent
             from.  No two events generated by the same
-            eventlister pool during the lifetime of a
+            eventlistener pool during the lifetime of a
             :program:`supervisord` process will have the
             same ``poolserial`` number.  This value can
             be used to detect event ordering anomalies.
@@ -375,7 +375,7 @@ including "process state change", "process communication", and
 these event types.
 
 In the below list, we indicate that some event types have a "body"
-which is a a *token set*.  A token set consists of a set of charaters
+which is a a *token set*.  A token set consists of a set of characters
 with space-separated tokens.  Each token represents a key-value pair.
 The key and value are separated by a colon.  For example:
 
@@ -897,4 +897,3 @@ Indicates that a process group has been removed from Supervisor's configuration.
 .. code-block:: text
 
    groupname:cat
-

docs/installing.rst

@@ -48,11 +48,8 @@ differently.  Since both ``pip`` and ``python setup.py
 install`` depend on internet access to perform downloads of dependent
 software, neither will work on machines without internet access until
 dependencies are installed.  To install to a machine which is not
-internet-connected, obtain the following dependencies on a machine
-which is internet-connected:
-
-- setuptools (latest) from `https://pypi.org/pypi/setuptools/
-  <https://pypi.org/pypi/setuptools/>`_.
+internet-connected, obtain the dependencies listed in ``setup.py``
+using a machine which is internet-connected.
 
 Copy these files to removable media and put them on the target
 machine.  Install each onto the target machine as per its

docs/introduction.rst

@@ -134,7 +134,7 @@ Supervisor Components
   The command-line client talks to the server across a UNIX domain
   socket or an internet (TCP) socket.  The server can assert that the
   user of a client should present authentication credentials before it
-  allows him to perform commands.  The client process typically uses
+  allows them to perform commands.  The client process typically uses
   the same configuration file as the server but any configuration file
   with a ``[supervisorctl]`` section in it will work.
 

docs/plugins.rst

@@ -49,6 +49,11 @@ instances running on different servers.
     Web-based dashboard and command line tool written in Python using PostgreSQL
     with a REST API, event monitoring, and configuration management.
 
+`Polyvisor <https://github.com/poly-laboratory/poly-visor>`_
+    Web-based dashboard written in Python using `flask <http://flask.pocoo.org>`_ web server.
+    Frontend based on `Svelte <https://svelte.dev/>`_ result in lightweighted packages. Communicate via supervisor's event-listener.
+    Providing system resource management via visualized charts & easy to config processes configs via web interface.
+
 Third Party Plugins and Libraries for Supervisor
 ------------------------------------------------
 

docs/subprocess.rst

@@ -248,7 +248,7 @@ per the following directed graph.
    Subprocess State Transition Graph
 
 A process is in the ``STOPPED`` state if it has been stopped
-adminstratively or if it has never been started.
+administratively or if it has never been started.
 
 When an autorestarting process is in the ``BACKOFF`` state, it will be
 automatically restarted by :program:`supervisord`.  It will switch

setup.cfg

@@ -1,8 +1,5 @@
 [easy_install]
 zip_ok = false
 
-[aliases]
-dev = develop easy_install supervisor[testing]
-
 [bdist_wheel]
 universal = 1

setup.py

@@ -22,18 +22,18 @@
 elif (3, 0) < py_version < (3, 4):
     raise RuntimeError('On Python 3, Supervisor requires Python 3.4 or later')
 
-# pkg_resource is used in several places
-requires = ["setuptools"]
+# setuptools is required as a runtime dependency only on
+# Python < 3.8.  See the comments in supervisor/compat.py.
+requires = [
+    "setuptools; python_version < '3.8'",
+]
 
 if (2, 7) <= py_version < (3, 0):
     requires.append("pywin32==228")
 else:
     requires.append("pywin32<=306,>228")
 
 tests_require = []
-if py_version < (3, 3):
-    tests_require.append('mock<4.0.0.dev0')
-
 testing_extras = tests_require + [
     'pytest',
     'pytest-cov',
@@ -70,6 +70,9 @@
     "Programming Language :: Python :: 3.6",
     "Programming Language :: Python :: 3.7",
     "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
 ]
 
 version_txt = os.path.join(here, 'supervisor/version.txt')
@@ -81,6 +84,11 @@
     version=supervisor_version,
     license='BSD-derived (http://www.repoze.org/LICENSE.txt)',
     url='http://supervisord.org/',
+    project_urls={
+        'Changelog': 'http://supervisord.org/changelog',
+        'Documentation': 'http://supervisord.org',
+        'Issue Tracker': 'https://github.com/Supervisor/supervisor',
+    },
     description="A system for controlling process state under WINDOWS",
     long_description=README + '\n\n' + CHANGES,
     classifiers=CLASSIFIERS,
@@ -98,7 +106,7 @@
     install_requires=requires,
     extras_require={
         'testing': testing_extras,
-        },
+    },
     tests_require=tests_require,
     include_package_data=True,
     zip_safe=False,

supervisor/compat.py

@@ -163,6 +163,55 @@ class SubprocessError(Exception):
 except ImportError: # pragma: no cover
     from HTMLParser import HTMLParser
 
+# Begin importlib/setuptools compatibility code
+
+# Supervisor used pkg_resources (a part of setuptools) to load package
+# resources for 15 years, until setuptools 67.5.0 (2023-03-05) deprecated
+# the use of pkg_resources.  On Python 3.8 or later, Supervisor now uses
+# importlib (part of Python 3 stdlib).  Unfortunately, on Python < 3.8,
+# Supervisor needs to use pkg_resources despite its deprecation.  The PyPI
+# backport packages "importlib-resources" and "importlib-metadata" couldn't
+# be added as dependencies to Supervisor because they require even more
+# dependencies that would likely cause some Supervisor installs to fail.
+from warnings import filterwarnings as _fw
+_fw("ignore", message="pkg_resources is deprecated as an API")
+
+try: # pragma: no cover
+    from importlib.metadata import EntryPoint as _EntryPoint
+
+    def import_spec(spec):
+        return _EntryPoint(None, spec, None).load()
+
+except ImportError: # pragma: no cover
+    from pkg_resources import EntryPoint as _EntryPoint
+
+    def import_spec(spec):
+        ep = _EntryPoint.parse("x=" + spec)
+        if hasattr(ep, 'resolve'):
+            # this is available on setuptools >= 10.2
+            return ep.resolve()
+        else:
+            # this causes a DeprecationWarning on setuptools >= 11.3
+            return ep.load(False)
+
+try: # pragma: no cover
+    import importlib.resources as _importlib_resources
+
+    if hasattr(_importlib_resources, "files"):
+        def resource_filename(package, path):
+            return str(_importlib_resources.files(package).joinpath(path))
+
+    else:
+        # fall back to deprecated .path if .files is not available
+        def resource_filename(package, path):
+            with _importlib_resources.path(package, '__init__.py') as p:
+                return str(p.parent.joinpath(path))
+
+except ImportError: # pragma: no cover
+    from pkg_resources import resource_filename
+
+# End importlib/setuptools compatibility code
+
 try: # pragma: no cover
     import queue
 except ImportError: # pragma: no cover

supervisor/confecho.py

@@ -3,8 +3,10 @@
 import pkg_resources
 
 from supervisor.compat import as_string
+from supervisor.compat import resource_filename
+
 
 
 def main(out=sys.stdout):
-    config = pkg_resources.resource_string(__name__, 'skel/sample.conf')
-    out.write(as_string(config))
+    with open(resource_filename(__package__, 'skel/sample.conf'), 'r') as f:
+        out.write(as_string(f.read()))