Move unreleased [include] changes to a feature branch

Author: mnaberez

CHANGES.rst

@@ -19,11 +19,6 @@
   in ``shlex``.  If ``supervisord`` is run on a Python version with the bug,
   it will fall back to legacy mode.  Patch by Stefan Friesel.
 
-- ``supervisorctl`` now reads extra files included via the ``[include]``
-  section in ``supervisord.conf`` like ``supervisord`` does.  This allows
-  the ``[supervisorctl]`` section or ``[ctlplugin:x]`` sections to be in
-  included files.  Patch by François Granade.
-
 4.3.0 (2025-08-23)
 ------------------
 

docs/configuration.rst

@@ -1184,6 +1184,12 @@ section, it must contain a single key named "files".  The values in
 this key specify other configuration files to be included within the
 configuration.
 
+.. note::
+
+    The ``[include]`` section is processed only by ``supervisord``.  It is
+    ignored by ``supervisorctl``.
+
+
 ``[include]`` Section Values
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -1208,10 +1214,6 @@ configuration.
 
   *Changed*: 3.3.0.  Added support for the ``host_node_name`` expansion.
 
-  *Changed*: 4.3.0.  Added support to :program:`supervisorctl` for reading
-  files specified in the ``[include]`` section.  In previous versions,
-  the ``[include]`` section was only supported by :program:`supervisord`.
-
 ``[include]`` Section Example
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

supervisor/options.py

@@ -104,9 +104,6 @@ def __init__(self, require_configfile=True):
         self.add(None, None, "h", "help", self.help)
         self.add(None, None, "?", None, self.help)
         self.add("configfile", None, "c:", "configuration=")
-        self.parse_criticals = []
-        self.parse_warnings = []
-        self.parse_infos = []
 
         here = os.path.dirname(os.path.dirname(sys.argv[0]))
         searchpaths = [os.path.join(here, 'etc', 'supervisord.conf'),
@@ -393,45 +390,6 @@ def import_spec(self, spec):
         """On failure, raises either AttributeError or ImportError"""
         return import_spec(spec)
 
-    def read_include_config(self, fp, parser, expansions):
-        if parser.has_section('include'):
-            parser.expand_here(self.here)
-            if not parser.has_option('include', 'files'):
-                raise ValueError(".ini file has [include] section, but no "
-                "files setting")
-            files = parser.get('include', 'files')
-            files = expand(files, expansions, 'include.files')
-            files = files.split()
-            if hasattr(fp, 'name'):
-                base = os.path.dirname(os.path.abspath(fp.name))
-            else:
-                base = '.'
-            for pattern in files:
-                pattern = os.path.join(base, pattern)
-                filenames = glob.glob(pattern)
-                if not filenames:
-                    self.parse_warnings.append(
-                        'No file matches via include "%s"' % pattern)
-                    continue
-                for filename in sorted(filenames):
-                    self.parse_infos.append(
-                        'Included extra file "%s" during parsing' % filename)
-                    try:
-                        parser.read(filename)
-                    except ConfigParser.ParsingError as why:
-                        raise ValueError(str(why))
-                    else:
-                        parser.expand_here(
-                            os.path.abspath(os.path.dirname(filename))
-                        )
-
-    def _log_parsing_messages(self, logger):
-        for msg in self.parse_criticals:
-            logger.critical(msg)
-        for msg in self.parse_warnings:
-            logger.warn(msg)
-        for msg in self.parse_infos:
-            logger.info(msg)
 
 class ServerOptions(Options):
     user = None
@@ -490,6 +448,9 @@ def __init__(self):
                  "s", "silent", flag=1, default=0)
         self.pidhistory = {}
         self.process_group_configs = []
+        self.parse_criticals = []
+        self.parse_warnings = []
+        self.parse_infos = []
         self.signal_receiver = SignalReceiver()
         self.poller = poller.Poller(self)
 
@@ -618,8 +579,36 @@ def read_config(self, fp):
         expansions = {'here':self.here,
                       'host_node_name':host_node_name}
         expansions.update(self.environ_expansions)
-
-        self.read_include_config(fp, parser, expansions)
+        if parser.has_section('include'):
+            parser.expand_here(self.here)
+            if not parser.has_option('include', 'files'):
+                raise ValueError(".ini file has [include] section, but no "
+                "files setting")
+            files = parser.get('include', 'files')
+            files = expand(files, expansions, 'include.files')
+            files = files.split()
+            if hasattr(fp, 'name'):
+                base = os.path.dirname(os.path.abspath(fp.name))
+            else:
+                base = '.'
+            for pattern in files:
+                pattern = os.path.join(base, pattern)
+                filenames = glob.glob(pattern)
+                if not filenames:
+                    self.parse_warnings.append(
+                        'No file matches via include "%s"' % pattern)
+                    continue
+                for filename in sorted(filenames):
+                    self.parse_infos.append(
+                        'Included extra file "%s" during parsing' % filename)
+                    try:
+                        parser.read(filename)
+                    except ConfigParser.ParsingError as why:
+                        raise ValueError(str(why))
+                    else:
+                        parser.expand_here(
+                            os.path.abspath(os.path.dirname(filename))
+                        )
 
         sections = parser.sections()
         if not 'supervisord' in sections:
@@ -1499,7 +1488,12 @@ def make_logger(self):
             maxbytes=self.logfile_maxbytes,
             backups=self.logfile_backups,
         )
-        self._log_parsing_messages(self.logger)
+        for msg in self.parse_criticals:
+            self.logger.critical(msg)
+        for msg in self.parse_warnings:
+            self.logger.warn(msg)
+        for msg in self.parse_infos:
+            self.logger.info(msg)
 
     def make_http_servers(self, supervisord):
         from supervisor.http import make_http_servers
@@ -1674,11 +1668,6 @@ def realize(self, *arg, **kw):
         if not self.args:
             self.interactive = 1
 
-        format = '%(levelname)s: %(message)s\n'
-        logger = loggers.getLogger()
-        loggers.handle_stdout(logger, format)
-        self._log_parsing_messages(logger)
-
     def read_config(self, fp):
         section = self.configroot.supervisorctl
         need_close = False
@@ -1699,11 +1688,8 @@ def read_config(self, fp):
             parser.read_file(fp)
         except AttributeError:
             parser.readfp(fp)
-
         if need_close:
             fp.close()
-        self.read_include_config(fp, parser, parser.expansions)
-
         sections = parser.sections()
         if not 'supervisorctl' in sections:
             raise ValueError('.ini file does not include supervisorctl section')

supervisor/tests/fixtures/example/included.conf

@@ -1,5 +1,2 @@
 [supervisord]
 childlogdir = %(here)s
-
-[supervisorctl]
-history_file = %(here)s