[#3287] fix pylint warnings

- C0115: Missing class docstring (missing-class-docstring)
- C0123: Use isinstance() rather than type() for a typecheck. (unidiomatic-typecheck)
- C0201: Consider iterating the dictionary directly instead of calling .keys() (consider-iterating-dictionary)
- C0206: Consider iterating with .items() (consider-using-dict-items)
- C0411: standard import "..." should be placed before "..." (wrong-import-order)
- C0415: Import outside toplevel (...) (import-outside-toplevel)
- C1802: Do not use `len(SEQUENCE)` without comparison to determine if a sequence is empty (use-implicit-booleaness-not-len)
- E0001: Parsing failed: 'invalid syntax (<unknown>, line 2313)' (syntax-error)
- E0401: Unable to import '...' (import-error)
- E0602: Undefined variable 'l' (undefined-variable)
- R0205: Class 'VagrantEnv' inherits from object, can be safely removed from bases in python3 (useless-object-inheritance)
- E1101: Instance of 'NSECBASE' has no 'dump_fixedpart' member (no-member)
- E1123: Unexpected keyword argument 'capture' in method call (unexpected-keyword-arg)
- R0902: Too many instance attributes (too-many-instance-attributes)
- R0913: Too many arguments (too-many-arguments)
- R0916: Too many boolean expressions in if statement (6/5) (too-many-boolean-expressions)
- R1717: Consider using a dictionary comprehension (consider-using-dict-comprehension)
- R1722: Consider using 'sys.exit' instead (consider-using-sys-exit)
- R1732: Consider using 'with' for resource-allocating operations (consider-using-with)
- R1735: Consider using '{}' instead of a call to 'dict'. (use-dict-literal)
- W0102: Dangerous default value sys.argv[1:] (builtins.list) as argument (dangerous-default-value)
- W0102: Dangerous default value {} as argument (dangerous-default-value)
- W0106: Expression "[f.write('%02x' % x) for x in bin_address]" is assigned to nothing (expression-not-assigned)
- W0107: Unnecessary pass statement (unnecessary-pass)
- W0201: Attribute 'config' defined outside __init__ (attribute-defined-outside-init)
- W0404: Reimport '...' (imported line ...) (reimported)
- W0611: Unused import ... (unused-import)
- W0612: Unused variable '...' (unused-variable)
- W0613: Unused argument '...' (unused-argument)
- W0621: Redefining name '...' from outer scope (line 1471) (redefined-outer-name)
- W0622: Redefining built-in '...' (redefined-builtin)
- W0707: Consider explicitly re-raising using 'raise ... from ...' (raise-missing-from)
- W0718: Catching too general exception Exception (broad-exception-caught)
- W1202: Use lazy % formatting in logging functions (logging-format-interpolation)
- W1203: Use lazy % formatting in logging functions (logging-fstring-interpolation)
- W1308: Duplicate string formatting argument 'connection_type', consider passing as named argument (duplicate-string-formatting-argument)
- W1401: Anomalous backslash in string: '\/'. String constant might be missing an r prefix. (anomalous-backslash-in-string)
- W1406: The u prefix for strings is no longer necessary in Python >=3.0 (redundant-u-string-prefix)
- W1514: Using open without explicitly specifying an encoding (unspecified-encoding)
- W4901: Deprecated module 'optparse' (deprecated-module)
- W4904: Using deprecated class SafeConfigParser of module configparser (deprecated-class)

Author: andrei-pavel

doc/sphinx/api2doc.py

@@ -33,7 +33,7 @@ def read_input_files(files):
         if name.startswith('_'):
             print("Skipping %s (starts with underscore)" % f)
             continue
-        with open(f) as fp:
+        with open(f, encoding='utf-8') as fp:
             print("Processing %s" % f)
             # use OrderedDict to preserve order of fields in cmd-syntax
             try:
@@ -42,7 +42,7 @@ def read_input_files(files):
                 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']}")
+                raise ValueError("Expected name == descr['name']. Name is {name} and descr['name'] is {descr['name']}.")
 
         apis[name] = descr
 
@@ -196,7 +196,7 @@ def generate(in_files, out_file):
     rst = generate_rst(apis)
 
     if out_file:
-        with open(out_file, 'w') as f:
+        with open(out_file, 'w', encoding='utf-8') as f:
             f.write(rst)
         print('Wrote generated RST content to: %s' % out_file)
     else:

doc/sphinx/conf.py

@@ -6,31 +6,35 @@
 # full list see the documentation:
 # http://www.sphinx-doc.org/en/master/config
 
+import os
+import sys
+from shutil import copyfile
+
 # -- Path setup --------------------------------------------------------------
 
+# to avoid sphinx.errors.SphinxParallelError: RecursionError: maximum recursion depth exceeded while pickling an object
+sys.setrecursionlimit(5000)
+
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#
-import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+SRC_DIR = os.path.abspath(os.path.dirname(__file__))
+sys.path.append(SRC_DIR)
 
-# to avoid sphinx.errors.SphinxParallelError: RecursionError: maximum recursion depth exceeded while pickling an object
-import sys
-sys.setrecursionlimit(5000)
+import api2doc  # noqa  # pylint: disable=wrong-import-position
+import mes2doc  # noqa  # pylint: disable=wrong-import-position
 
 # -- Project information -----------------------------------------------------
 
 project = 'Kea'
-copyright = '2019-2024, Internet Systems Consortium'
+copyright = '2019-2024, Internet Systems Consortium'  # pylint: disable=redefined-builtin
 author = 'Internet Systems Consortium'
 
 # get current kea version
 config_ac_path = '../../configure.ac'
 changelog_path = '../../ChangeLog'
 release = 'UNRELEASED'
-with open(config_ac_path) as f:
+with open(config_ac_path, encoding='utf-8') as f:
     for line in f.readlines():
         if line.startswith('AC_INIT(kea'):
             parts = line.split(',')
@@ -39,7 +43,7 @@
             # that this is the final release.
             dash_parts = release.split('-')
             candidate_release = dash_parts[0]
-            with open(changelog_path) as changelog_file:
+            with open(changelog_path, encoding='utf-8') as changelog_file:
                 first_line = changelog_file.readline()
                 if candidate_release in first_line and "released" in first_line:
                     release = candidate_release
@@ -251,23 +255,15 @@
 # Do generation of api.rst and kea-messages.rst here in conf.py instead of Makefile.am
 # so they are available on ReadTheDocs as there makefiles are not used for building docs.
 def run_generate_docs(_):
-    import os
-    import sys
-    src_dir = os.path.abspath(os.path.dirname(__file__))
-    print(src_dir)
-    sys.path.append(src_dir)
-
-    import api2doc
-    with open(os.path.join(src_dir, 'api-files.txt')) as af:
+    with open(os.path.join(SRC_DIR, 'api-files.txt'), encoding='utf-8') as af:
         api_files = af.read().split()
-    api_files = [os.path.abspath(os.path.join(src_dir, '../..', af)) for af in api_files]
-    api2doc.generate(api_files, os.path.join(src_dir, 'api.rst'))
+    api_files = [os.path.abspath(os.path.join(SRC_DIR, '../..', af)) for af in api_files]
+    api2doc.generate(api_files, os.path.join(SRC_DIR, 'api.rst'))
 
-    import mes2doc
-    with open(os.path.join(src_dir, 'mes-files.txt')) as mf:
+    with open(os.path.join(SRC_DIR, 'mes-files.txt'), encoding='utf-8') as mf:
         mes_files = mf.read().split()
-    mes_files = [os.path.abspath(os.path.join(src_dir, '../..', mf)) for mf in mes_files]
-    mes2doc.generate(mes_files, os.path.join(src_dir, 'kea-messages.rst'))
+    mes_files = [os.path.abspath(os.path.join(SRC_DIR, '../..', mf)) for mf in mes_files]
+    mes2doc.generate(mes_files, os.path.join(SRC_DIR, 'kea-messages.rst'))
 
     # Sphinx has some limitations. It can't import files from outside its directory, which
     # in our case is src/sphinx. On the other hand, we need to have platforms.rst file
@@ -292,10 +288,9 @@ def run_generate_docs(_):
         ['../examples/template-ha-mt-tls/kea-dhcp4-2.conf', 'template-ha-mt-tls-dhcp4-2.conf']
     ]
 
-    from shutil import copyfile
     for [a, b] in FILES_TO_COPY:
-        src = os.path.join(src_dir, a)
-        dst = os.path.join(src_dir, 'arm', b)
+        src = os.path.join(SRC_DIR, a)
+        dst = os.path.join(SRC_DIR, 'arm', b)
         print("Copying %s to %s" % (src, dst))
         copyfile(src, dst)
 

doc/sphinx/mes2doc.py

@@ -36,9 +36,8 @@ def parse_args():
 def read_input_files(files):
     messages = {}
     for f in files:
-        with open(f) as fp:
+        with open(f, encoding='utf-8') as fp:
             print("Processing %s" % f)
-            namespace = None
             msg_descr = None
             msg_id = None
             msg_text = None
@@ -119,7 +118,7 @@ def generate(in_files, out_file):
     rst = generate_rst(messages)
 
     if out_file:
-        with open(out_file, 'w') as f:
+        with open(out_file, 'w', encoding='utf-8') as f:
             f.write(rst)
         print('Wrote generated RST content to: %s' % out_file)
     else: