[#3287] fix pycodestyle warnings

- E111 indentation is not a multiple of 4
- E117 over-indented
- E125 continuation line with same indent as next logical line
- E127 continuation line over-indented for visual indent
- E128 continuation line under-indented for visual indent
- E129 visually indented line with same indent as next logical line
- E131 continuation line unaligned for hanging indent
- E201 whitespace after '['
- E201 whitespace after '{'
- E202 whitespace before ')'
- E202 whitespace before ']'
- E202 whitespace before '}'
- E203 whitespace before '
- E203 whitespace before ','
- E222 multiple spaces after operator
- E225 missing whitespace around operator
- E228 missing whitespace around modulo operator
- E231 missing whitespace after ','
- E251 unexpected spaces around keyword / parameter equals
- E261 at least two spaces before inline comment
- E262 inline comment should start with '# '
- E265 block comment should start with '# '
- E301 expected 1 blank line, found 0
- E302 expected 2 blank lines, found 1
- E303 too many blank lines (2)
- E305 expected 2 blank lines after class or function definition, found 1
- E306 expected 1 blank line before a nested definition, found 0
- E401 multiple imports on one line
- E402 module level import not at top of file
- E501 line too long
- E502 the backslash is redundant between brackets
- E703 statement ends with a semicolon
- E713 test for membership should be 'not in'
- E722 do not use bare 'except'
- E741 ambiguous variable name 'l'
- W605 invalid escape sequence '\/'

Author: andrei-pavel

doc/sphinx/api2doc.py

@@ -38,8 +38,8 @@ def read_input_files(files):
             # use OrderedDict to preserve order of fields in cmd-syntax
             try:
                 descr = json.load(fp, object_pairs_hook=collections.OrderedDict)
-            except:
-                print('\nError while processing %s\n\n' % f)
+            except Exception as e:
+                print(f'\nError while processing {f}: {e}\n\n')
                 raise
             if name != descr['name']:
                 exit("Expected name == descr['name'], but name is {name} and descr['name'] is {descr['name']}")
@@ -78,14 +78,14 @@ def generate_rst(apis):
     for dm, funcs in sorted(daemons.items()):
         rst += '.. _commands-%s:\n\n' % dm
         rst += 'Commands supported by `%s` daemon: ' % dm
-        funcs = sorted([ ':ref:`%s <ref-%s>`' % (f['name'], f['name']) for f in funcs])
+        funcs = sorted([':ref:`%s <ref-%s>`' % (f['name'], f['name']) for f in funcs])
         rst += ', '.join(funcs)
         rst += '.\n\n'
 
     for h, funcs in sorted(hooks.items()):
         rst += '.. _commands-%s:\n\n' % h
         rst += 'Commands supported by `%s` hook library: ' % h
-        funcs = sorted([ ':ref:`%s <ref-%s>`' % (f['name'], f['name']) for f in funcs])
+        funcs = sorted([':ref:`%s <ref-%s>`' % (f['name'], f['name']) for f in funcs])
         rst += ', '.join(funcs)
         rst += '.\n\n'
 
@@ -112,16 +112,16 @@ def generate_rst(apis):
 
         # availability
         rst += 'Availability: %s ' % func['avail']
-        rst += '(:ref:`%s <commands-%s>` hook library)' % (func['hook'], func['hook']) if 'hook' in func else '(built-in)'
+        rst += f'(:ref:`{func["hook"]} <commands-{func["hook"]}>` hook library)' if 'hook' in func else '(built-in)'
         rst += '\n\n'
 
         # access
         try:
             access = func['access']
-        except:
-            print('\naccess missing in %s\n\n' % name)
+        except Exception as e:
+            print(f'\naccess missing in {name}: {e}\n\n')
             raise
-        if not access in ['read', 'write']:
+        if access not in ['read', 'write']:
             print('\nUnknown access %s in %s\n\n' % (access, name))
             raise ValueError('access must be read or write')
         rst += 'Access: %s *(parameter ignored in this Kea version)* \n\n' % access
@@ -151,8 +151,8 @@ def generate_rst(apis):
         rst += '\n\n'
 
         if 'cmd-comment' in func:
-            for l in func['cmd-comment']:
-                rst += "%s\n" % l
+            for line in func['cmd-comment']:
+                rst += "%s\n" % line
             rst += '\n'
 
         # response syntax
@@ -184,7 +184,8 @@ def generate_rst(apis):
             rst += '- 1 - error\n'
             rst += '- 2 - unsupported\n'
             rst += '- 3 - empty (command was completed successfully, but no data was affected or returned)\n'
-            rst += '- 4 - conflict (command could not apply requested configuration changes because they were in conflict with the server state)\n\n'
+            rst += '- 4 - conflict (command could not apply requested configuration changes because they were '
+            rst += 'in conflict with the server state)\n\n'
 
     return rst
 

doc/sphinx/conf.py

@@ -16,7 +16,7 @@
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
 
-# to avoid "sphinx.errors.SphinxParallelError: RecursionError: maximum recursion depth exceeded while pickling an object"
+# to avoid sphinx.errors.SphinxParallelError: RecursionError: maximum recursion depth exceeded while pickling an object
 import sys
 sys.setrecursionlimit(5000)
 
@@ -45,7 +45,7 @@
                     release = candidate_release
             break
 version = release
-dashed_version_series='-'.join(version.split('.')[0:2])
+dashed_version_series = '-'.join(version.split('.')[0:2])
 
 # now let's replace versions with odd minor number with dev
 if int(dashed_version_series[-1]) % 2 != 0:
@@ -146,17 +146,17 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-#html_theme = 'alabaster'
+# html_theme = 'alabaster'
 html_theme = 'sphinx_rtd_theme'
 html_logo = 'static/kea-imageonly-100bw.png'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
-#html_theme_options = {
-#    "logo": "kea-logo-100x70.png",
-#}
+# html_theme_options = {
+#     "logo": "kea-logo-100x70.png",
+# }
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
@@ -177,7 +177,7 @@
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
-#htmlhelp_basename = 'KeaAdministratorReferenceManualdoc'
+# htmlhelp_basename = 'KeaAdministratorReferenceManualdoc'
 
 
 # -- Options for LaTeX output ------------------------------------------------
@@ -241,10 +241,11 @@
 
 # -- Substitutions -----------------------------------------------------------
 
-rst_prolog="""
+rst_prolog = """
 .. |cloudsmith_repo| replace:: kea-{dashed_version_series}
 """.format(dashed_version_series=dashed_version_series)
 
+
 # -- Functions ---------------------------------------------------------------
 
 # Do generation of api.rst and kea-messages.rst here in conf.py instead of Makefile.am
@@ -278,17 +279,17 @@ def run_generate_docs(_):
     # The first entry on this list is the actual file to copy, the second is a unique name
     # that will be used when copied over to arm/ directory.
     FILES_TO_COPY = [
-        [ '../../platforms.rst', 'platforms.rst' ],
-        [ '../examples/template-power-user-home/info.md', 'template-power-user-home.md' ],
-        [ '../examples/template-power-user-home/kea-ca-1.conf', 'template-power-user-home-ca-1.conf' ],
-        [ '../examples/template-power-user-home/kea-ca-2.conf', 'template-power-user-home-ca-2.conf' ],
-        [ '../examples/template-power-user-home/kea-dhcp4-1.conf', 'template-power-user-home-dhcp4-1.conf' ],
-        [ '../examples/template-power-user-home/kea-dhcp4-2.conf', 'template-power-user-home-dhcp4-2.conf' ],
-        [ '../examples/template-ha-mt-tls/info.md', 'template-ha-mt-tls.md' ],
-        [ '../examples/template-ha-mt-tls/kea-ca-1.conf', 'template-ha-mt-tls-ca-1.conf' ],
-        [ '../examples/template-ha-mt-tls/kea-ca-2.conf', 'template-ha-mt-tls-ca-2.conf' ],
-        [ '../examples/template-ha-mt-tls/kea-dhcp4-1.conf', 'template-ha-mt-tls-dhcp4-1.conf' ],
-        [ '../examples/template-ha-mt-tls/kea-dhcp4-2.conf', 'template-ha-mt-tls-dhcp4-2.conf' ]
+        ['../../platforms.rst', 'platforms.rst'],
+        ['../examples/template-power-user-home/info.md', 'template-power-user-home.md'],
+        ['../examples/template-power-user-home/kea-ca-1.conf', 'template-power-user-home-ca-1.conf'],
+        ['../examples/template-power-user-home/kea-ca-2.conf', 'template-power-user-home-ca-2.conf'],
+        ['../examples/template-power-user-home/kea-dhcp4-1.conf', 'template-power-user-home-dhcp4-1.conf'],
+        ['../examples/template-power-user-home/kea-dhcp4-2.conf', 'template-power-user-home-dhcp4-2.conf'],
+        ['../examples/template-ha-mt-tls/info.md', 'template-ha-mt-tls.md'],
+        ['../examples/template-ha-mt-tls/kea-ca-1.conf', 'template-ha-mt-tls-ca-1.conf'],
+        ['../examples/template-ha-mt-tls/kea-ca-2.conf', 'template-ha-mt-tls-ca-2.conf'],
+        ['../examples/template-ha-mt-tls/kea-dhcp4-1.conf', 'template-ha-mt-tls-dhcp4-1.conf'],
+        ['../examples/template-ha-mt-tls/kea-dhcp4-2.conf', 'template-ha-mt-tls-dhcp4-2.conf']
     ]
 
     from shutil import copyfile
@@ -298,6 +299,7 @@ def run_generate_docs(_):
         print("Copying %s to %s" % (src, dst))
         copyfile(src, dst)
 
+
 # custom setup hook
 def setup(app):
     app.add_crossref_type('isccmd', 'isccmd')

doc/sphinx/mes2doc.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 
-# Copyright (C) 2019-2021 Internet Systems Consortium, Inc. ("ISC")
+# Copyright (C) 2019-2024 Internet Systems Consortium, Inc. ("ISC")
 #
 # This Source Code Form is subject to the terms of the Mozilla Public
 # License, v. 2.0. If a copy of the MPL was not distributed with this
@@ -58,7 +58,7 @@ def read_input_files(files):
                         messages[msg_id] = (section, msg_id, msg_text, msg_descr)
 
                     # start next message
-                    m = re.search('^%\s?([A-Z0-9_]+)\s+(.*)', line);
+                    m = re.search(r'^%\s?([A-Z0-9_]+)\s+(.*)', line)
                     msg_id, msg_text = m.groups()
                     msg_descr = []
 
@@ -107,12 +107,12 @@ def generate_rst(messages):
 
         rst += msg_text + '\n\n'
 
-        rst += ''.join(['  ' + l + '\n' for l in msg_descr])
+        rst += ''.join(['  ' + line + '\n' for line in msg_descr])
         rst += '\n'
 
-
     return rst
 
+
 def generate(in_files, out_file):
     messages = read_input_files(in_files)