pylint: create a global configuration file

Move all too-few / too-many arbitrary warnings into this config file. Signed-off-by: Emmanuel Blot <emmanuel.blot@free.fr>
eblot · Apr 5, 2024 · 5ca35f4 · 5ca35f4
1 parent 9834c46
commit 5ca35f4
Show file tree

Hide file tree

Showing 37 changed files with 134 additions and 176 deletions.
diff --git a/.flake8 b/.flake8
@@ -0,0 +1,2 @@
+[flake8]
+max-line-length = 80
diff --git a/.pylintrc b/.pylintrc
@@ -0,0 +1,12 @@
+[MESSAGES CONTROL]
+
+disable=
+    too-few-public-methods,
+    too-many-arguments,
+    too-many-branches,
+    too-many-instance-attributes,
+    too-many-lines,
+    too-many-locals,
+    too-many-nested-blocks,
+    too-many-public-methods,
+    too-many-statements
diff --git a/pyftdi/__init__.py b/pyftdi/__init__.py
@@ -4,7 +4,7 @@
 #
 # SPDX-License-Identifier: BSD-3-Clause
 
-#pylint: disable-msg=missing-docstring
+# pylint: disable=missing-docstring
 
 __version__ = '0.55.1'
 __title__ = 'PyFtdi'

diff --git a/pyftdi/bin/ftconf.py b/pyftdi/bin/ftconf.py
@@ -19,9 +19,9 @@
 from pyftdi.ftdi import Ftdi
 from pyftdi.misc import add_custom_devices, hexdump
 
-#pylint: disable-msg=too-many-locals
-#pylint: disable-msg=too-many-branches
-#pylint: disable-msg=too-many-statements
+# pylint: disable=too-many-locals
+# pylint: disable=too-many-branches
+# pylint: disable=too-many-statements
 
 
 def main():
@@ -107,7 +107,7 @@ def main():
         FtdiLogger.log.addHandler(StreamHandler(stderr))
 
         if args.virtual:
-            #pylint: disable-msg=import-outside-toplevel
+            # pylint: disable=import-outside-toplevel
             from pyftdi.usbtools import UsbTools
             # Force PyUSB to use PyFtdi test framework for USB backends
             UsbTools.BACKENDS = ('pyftdi.tests.backend.usbvirt', )

diff --git a/pyftdi/bin/ftdi_urls.py b/pyftdi/bin/ftdi_urls.py
@@ -45,7 +45,7 @@ def main():
         FtdiLogger.log.addHandler(StreamHandler(stderr))
 
         if args.virtual:
-            #pylint: disable-msg=import-outside-toplevel
+            # pylint: disable=import-outside-toplevel
             from pyftdi.usbtools import UsbTools
             # Force PyUSB to use PyFtdi test framework for USB backends
             UsbTools.BACKENDS = ('pyftdi.tests.backend.usbvirt', )

diff --git a/pyftdi/bin/i2cscan.py b/pyftdi/bin/i2cscan.py
@@ -1,15 +1,14 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
-# Copyright (c) 2018-2022, Emmanuel Blot <emmanuel.blot@free.fr>
+# Copyright (c) 2018-2024, Emmanuel Blot <emmanuel.blot@free.fr>
 # All rights reserved.
 #
 # SPDX-License-Identifier: BSD-3-Clause
 
 """Tiny I2C bus scanner."""
 
-#pylint: disable-msg=broad-except
-#pylint: disable-msg=too-few-public-methods
+# pylint: disable=broad-except
 
 from argparse import ArgumentParser, FileType
 from logging import Formatter, StreamHandler, getLogger, DEBUG, ERROR
@@ -124,7 +123,7 @@ def main():
         FtdiLogger.set_level(loglevel)
 
         if args.virtual:
-            #pylint: disable-msg=import-outside-toplevel
+            # pylint: disable=import-outside-toplevel
             from pyftdi.usbtools import UsbTools
             # Force PyUSB to use PyFtdi test framework for USB backends
             UsbTools.BACKENDS = ('pyftdi.tests.backend.usbvirt', )

diff --git a/pyftdi/bin/pyterm.py b/pyftdi/bin/pyterm.py
@@ -3,20 +3,14 @@
 """Simple Python serial terminal
 """
 
-# Copyright (c) 2010-2022, Emmanuel Blot <emmanuel.blot@free.fr>
+# Copyright (c) 2010-2024, Emmanuel Blot <emmanuel.blot@free.fr>
 # Copyright (c) 2016, Emmanuel Bouaziz <ebouaziz@free.fr>
 # All rights reserved.
 #
 # SPDX-License-Identifier: BSD-3-Clause
 
-#pylint: disable-msg=too-many-instance-attributes
-#pylint: disable-msg=too-many-arguments
-#pylint: disable-msg=too-many-nested-blocks
-#pylint: disable-msg=too-many-branches
-#pylint: disable-msg=too-many-statements
-#pylint: disable-msg=too-few-public-methods
-#pylint: disable-msg=broad-except
-#pylint: disable-msg=wrong-import-position
+# pylint: disable=broad-except
+# pylint: disable=wrong-import-position
 
 from argparse import ArgumentParser, FileType
 from atexit import register
@@ -30,8 +24,8 @@
 from traceback import format_exc
 from _thread import interrupt_main
 
-#pylint: disable-msg=import-error
-#pylint: disable-msg=import-outside-toplevel
+# pylint: disable=import-error
+# pylint: disable=import-outside-toplevel
 
 from pyftdi import FtdiLogger
 from pyftdi.ftdi import Ftdi

diff --git a/pyftdi/bits.py b/pyftdi/bits.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2019 Emmanuel Blot <emmanuel.blot@free.fr>
+# Copyright (c) 2010-2024 Emmanuel Blot <emmanuel.blot@free.fr>
 # Copyright (c) 2008-2016, Neotion
 # All rights reserved.
 #
@@ -9,11 +9,10 @@
 from typing import Iterable, List, Optional, Tuple, Union
 from .misc import is_iterable, xor
 
-#pylint: disable-msg=invalid-name
-#pylint: disable-msg=unneeded-not
-#pylint: disable-msg=too-many-branches
-#pylint: disable-msg=too-many-arguments
-#pylint: disable-msg=duplicate-key
+# pylint: disable=invalid-name
+# pylint: disable=unneeded-not
+# pylint: disable=duplicate-key
+
 
 class BitSequenceError(Exception):
     """Bit sequence error"""

diff --git a/pyftdi/eeprom.py b/pyftdi/eeprom.py
@@ -5,13 +5,8 @@
 
 """EEPROM management for PyFdti"""
 
-#pylint: disable-msg=too-many-arguments
-#pylint: disable-msg=too-many-branches
-#pylint: disable-msg=too-many-instance-attributes
-#pylint: disable-msg=too-many-locals
-#pylint: disable-msg=too-many-public-methods
-#pylint: disable-msg=wrong-import-position
-#pylint: disable-msg=import-error
+# pylint: disable=wrong-import-position
+# pylint: disable=import-error
 
 import sys
 from binascii import hexlify, unhexlify

diff --git a/pyftdi/ftdi.py b/pyftdi/ftdi.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2023 Emmanuel Blot <emmanuel.blot@free.fr>
+# Copyright (c) 2010-2024 Emmanuel Blot <emmanuel.blot@free.fr>
 # Copyright (c) 2016 Emmanuel Bouaziz <ebouaziz@free.fr>
 # All rights reserved.
 #
@@ -21,17 +21,7 @@
 from .misc import to_bool
 from .usbtools import UsbDeviceDescriptor, UsbTools
 
-#pylint: disable-msg=invalid-name
-#pylint: disable-msg=too-many-arguments
-#pylint: disable=too-many-arguments
-#pylint: disable=too-many-branches
-#pylint: disable=too-many-statements
-#pylint: disable=too-many-nested-blocks
-#pylint: disable=too-many-instance-attributes
-#pylint: disable=too-many-nested-blocks
-#pylint: disable=too-many-public-methods
-#pylint: disable=too-many-locals
-#pylint: disable=too-many-lines
+# pylint: disable=invalid-name
 
 
 class FtdiError(IOError):
@@ -730,13 +720,13 @@ def open_mpsse_from_device(self, device: UsbDevice,
            :param bool debug: add more debug traces
            :return: actual bus frequency in Hz
         """
-        # pylint: disable-msg=unused-argument
+        # pylint: disable=unused-argument
         self.open_from_device(device, interface)
         if not self.is_mpsse_interface(interface):
             self.close()
             raise FtdiMpsseError('This interface does not support MPSSE')
         if to_bool(tracer):  # accept strings as boolean
-            #pylint: disable-msg=import-outside-toplevel
+            # pylint: disable=import-outside-toplevel
             from .tracer import FtdiMpsseTracer
             self._tracer = FtdiMpsseTracer(self.device_version)
             self.log.debug('Using MPSSE tracer')
@@ -2044,7 +2034,7 @@ def _set_interface(self, config: UsbConfiguration, ifnum: int):
         except (NotImplementedError, USBError):
             pass
 
-#pylint: disable-msg=protected-access
+# pylint: disable=protected-access
 # need to access private member _ctx of PyUSB device (resource manager)
 # until PyUSB #302 is addressed
 
@@ -2057,7 +2047,7 @@ def _is_pyusb_handle_active(self) -> bool:
         # and there is no public API for this.
         return bool(self._usb_dev._ctx.handle)
 
-#pylint: enable-msg=protected-access
+# pylint: enable-msg=protected-access
 
     def _reset_device(self):
         """Reset the FTDI device (FTDI vendor command)"""

diff --git a/pyftdi/gpio.py b/pyftdi/gpio.py
@@ -1,12 +1,11 @@
-# Copyright (c) 2014-2020, Emmanuel Blot <emmanuel.blot@free.fr>
+# Copyright (c) 2014-2024, Emmanuel Blot <emmanuel.blot@free.fr>
 # Copyright (c) 2016, Emmanuel Bouaziz <ebouaziz@free.fr>
 # All rights reserved.
 #
 # SPDX-License-Identifier: BSD-3-Clause
 
 """GPIO/BitBang support for PyFdti"""
 
-#pylint: disable-msg=too-few-public-methods
 
 from struct import calcsize as scalc, unpack as sunpack
 from typing import Iterable, Optional, Tuple, Union

diff --git a/pyftdi/i2c.py b/pyftdi/i2c.py
@@ -1,19 +1,10 @@
-# Copyright (c) 2017-2021, Emmanuel Blot <emmanuel.blot@free.fr>
+# Copyright (c) 2017-2024, Emmanuel Blot <emmanuel.blot@free.fr>
 # All rights reserved.
 #
 # SPDX-License-Identifier: BSD-3-Clause
 
 """I2C support for PyFdti"""
 
-#pylint: disable-msg=too-many-lines
-#pylint: disable-msg=too-many-locals
-#pylint: disable-msg=too-many-instance-attributes
-#pylint: disable-msg=too-many-public-methods
-#pylint: disable-msg=too-many-arguments
-#pylint: disable-msg=too-many-branches
-#pylint: disable-msg=too-many-statements
-
-
 from binascii import hexlify
 from collections import namedtuple
 from logging import getLogger

diff --git a/pyftdi/jtag.py b/pyftdi/jtag.py
@@ -6,8 +6,8 @@
 
 """JTAG support for PyFdti"""
 
-#pylint: disable-msg=invalid-name
-#pylint: disable-msg=missing-function-docstring
+# pylint: disable=invalid-name
+# pylint: disable=missing-function-docstring
 
 from time import sleep
 from typing import List, Tuple, Union

diff --git a/pyftdi/misc.py b/pyftdi/misc.py
@@ -1,15 +1,13 @@
-# Copyright (c) 2010-2021 Emmanuel Blot <emmanuel.blot@free.fr>
+# Copyright (c) 2010-2024 Emmanuel Blot <emmanuel.blot@free.fr>
 # Copyright (c) 2008-2016, Neotion
 # All rights reserved.
 #
 # SPDX-License-Identifier: BSD-3-Clause
 
 """Miscellaneous helpers"""
 
-#pylint: disable-msg=invalid-name
-#pylint: disable-msg=import-outside-toplevel
-#pylint: disable-msg=too-many-locals
-#pylint: disable-msg=too-many-arguments
+# pylint: disable=invalid-name
+# pylint: disable=import-outside-toplevel
 
 from array import array
 from copy import deepcopy
@@ -198,7 +196,7 @@ def xor(_a_: bool, _b_: bool) -> bool:
        :param _b_: second argument
        :return: xor-ed value
     """
-    #pylint: disable-msg=superfluous-parens
+    # pylint: disable=superfluous-parens
     return bool((not(_a_) and _b_) or (_a_ and not(_b_)))
 
 
@@ -311,7 +309,7 @@ def show_call_stack():
 
 class classproperty(property):
     """Getter property decorator for a class"""
-    #pylint: disable=invalid-name
+    # pylint: disable=invalid-name
     def __get__(self, obj: Any, objtype=None) -> Any:
         return super().__get__(objtype)
 

diff --git a/pyftdi/serialext/logger.py b/pyftdi/serialext/logger.py
@@ -4,12 +4,12 @@
 #
 # SPDX-License-Identifier: BSD-3-Clause
 
-#pylint: disable-msg=no-member
-#pylint: disable-msg=broad-except
-#pylint: disable-msg=invalid-name
-#pylint: disable-msg=super-with-arguments
-#pylint: disable-msg=missing-function-docstring
-#pylint: disable-msg=missing-module-docstring
+# pylint: disable=no-member
+# pylint: disable=broad-except
+# pylint: disable=invalid-name
+# pylint: disable=super-with-arguments
+# pylint: disable=missing-function-docstring
+# pylint: disable=missing-module-docstring
 
 from sys import stderr
 from time import time

diff --git a/pyftdi/serialext/protocol_ftdi.py b/pyftdi/serialext/protocol_ftdi.py
@@ -5,10 +5,10 @@
 # SPDX-License-Identifier: BSD-3-Clause
 
 # this file has not been updated for a while, so coding style needs some love
-#pylint: disable-msg=attribute-defined-outside-init
-#pylint: disable-msg=invalid-name
-#pylint: disable-msg=missing-class-docstring
-#pylint: disable-msg=missing-module-docstring
+# pylint: disable=attribute-defined-outside-init
+# pylint: disable=invalid-name
+# pylint: disable=missing-class-docstring
+# pylint: disable=missing-module-docstring
 
 from io import RawIOBase
 from time import sleep, time as now

diff --git a/pyftdi/serialext/protocol_unix.py b/pyftdi/serialext/protocol_unix.py
@@ -1,18 +1,17 @@
-# Copyright (c) 2008-2016, Emmanuel Blot <emmanuel.blot@free.fr>
+# Copyright (c) 2008-2024, Emmanuel Blot <emmanuel.blot@free.fr>
 # Copyright (c) 2016, Emmanuel Bouaziz <ebouaziz@free.fr>
 # All rights reserved.
 #
 # SPDX-License-Identifier: BSD-3-Clause
 
 # this file has not been updated for a while, so coding style needs some love
-#pylint: disable-msg=broad-except
-#pylint: disable-msg=attribute-defined-outside-init
-#pylint: disable-msg=redefined-outer-name
-#pylint: disable-msg=invalid-name
-#pylint: disable-msg=too-few-public-methods
-#pylint: disable-msg=missing-function-docstring
-#pylint: disable-msg=missing-class-docstring
-#pylint: disable-msg=missing-module-docstring
+# pylint: disable=broad-except
+# pylint: disable=attribute-defined-outside-init
+# pylint: disable=redefined-outer-name
+# pylint: disable=invalid-name
+# pylint: disable=missing-function-docstring
+# pylint: disable=missing-class-docstring
+# pylint: disable=missing-module-docstring
 
 import errno
 import os
@@ -70,7 +69,7 @@ def open(self):
             self.close()
             msg = "Could not open port: %s" % (str(e),)
             if isinstance(e, socket.error):
-                # pylint: disable-msg=no-member
+                # pylint: disable=no-member
                 raise SerialExceptionWithErrno(msg, e.errno) from e
             raise SerialException(msg) from e
         self._set_open_state(True)
@@ -91,7 +90,7 @@ def close(self):
 
     def in_waiting(self):
         """Return the number of characters currently in the input buffer."""
-        #pylint: disable-msg=no-self-use
+        # pylint: disable=no-self-use
         return 0
 
     def read(self, size=1):

diff --git a/pyftdi/serialext/tests/rl.py b/pyftdi/serialext/tests/rl.py
@@ -8,7 +8,7 @@
 
 path.append(dirname(dirname(dirname(dirname(__file__)))))
 
-#pylint: disable-msg=wrong-import-position
+# pylint: disable=wrong-import-position
 from pyftdi import serialext