add doc/conf.py to pylint checking, reformat files

felixdivo · felixdivo · commit 8f1ba2322eb4 · 2019-09-12T09:02:00.000+02:00
diff --git a/.travis.yml b/.travis.yml
@@ -84,7 +84,10 @@ jobs:
         # warnings to the .pylintrc-wip file to prevent them from being
         # re-introduced
         - pylint --rcfile=.pylintrc-wip can/
-        - pylint --rcfile=.pylintrc setup.py
+        # check setup.py
+        - pylint --rcfile=.pylintrc *.py
+        # check doc/conf.py
+        - pylint --rcfile=.pylintrc doc/**.py
         # mypy checking
         - mypy
           --python-version=3.7
diff --git a/can/__init__.py b/can/__init__.py
@@ -1,4 +1,3 @@
-
 """
 ``can`` is an object-orient Controller Area Network (CAN) interface module.
 """
diff --git a/can/broadcastmanager.py b/can/broadcastmanager.py
@@ -1,4 +1,3 @@
-
 """
 Exposes several methods for transmitting cyclic messages.
 
diff --git a/can/bus.py b/can/bus.py
@@ -1,4 +1,3 @@
-
 """
 Contains the ABC bus implementation and its documentation.
 """
diff --git a/can/ctypesutil.py b/can/ctypesutil.py
@@ -1,4 +1,3 @@
-
 """
 This module contains common `ctypes` utils.
 """
diff --git a/can/interface.py b/can/interface.py
@@ -1,4 +1,3 @@
-
 """
 This module contains the base implementation of :class:`can.BusABC` as well
 as a list of all available backends and some implemented
diff --git a/can/interfaces/__init__.py b/can/interfaces/__init__.py
@@ -1,4 +1,3 @@
-
 """
 Interfaces contain low level implementations that interact with CAN hardware.
 """
diff --git a/can/interfaces/canalystii.py b/can/interfaces/canalystii.py
@@ -1,4 +1,3 @@
-
 from ctypes import *
 import logging
 import platform
diff --git a/can/interfaces/ics_neovi/__init__.py b/can/interfaces/ics_neovi/__init__.py
@@ -1,4 +1,3 @@
-
 """
 """
 
diff --git a/can/interfaces/ics_neovi/neovi_bus.py b/can/interfaces/ics_neovi/neovi_bus.py
@@ -1,4 +1,3 @@
-
 """
 ICS NeoVi interface module.
 
diff --git a/can/interfaces/iscan.py b/can/interfaces/iscan.py
@@ -1,4 +1,3 @@
-
 """
 Interface for isCAN from Thorsis Technologies GmbH, former ifak system GmbH.
 """
diff --git a/can/interfaces/ixxat/__init__.py b/can/interfaces/ixxat/__init__.py
@@ -1,4 +1,3 @@
-
 """
 Ctypes wrapper module for IXXAT Virtual CAN Interface V3 on win32 systems
 
diff --git a/can/interfaces/ixxat/canlib.py b/can/interfaces/ixxat/canlib.py
@@ -1,4 +1,3 @@
-
 """
 Ctypes wrapper module for IXXAT Virtual CAN Interface V3 on win32 systems
 
diff --git a/can/interfaces/ixxat/constants.py b/can/interfaces/ixxat/constants.py
@@ -1,4 +1,3 @@
-
 """
 Ctypes wrapper module for IXXAT Virtual CAN Interface V3 on win32 systems
 
diff --git a/can/interfaces/ixxat/exceptions.py b/can/interfaces/ixxat/exceptions.py
@@ -1,4 +1,3 @@
-
 """
 Ctypes wrapper module for IXXAT Virtual CAN Interface V3 on win32 systems
 
diff --git a/can/interfaces/ixxat/structures.py b/can/interfaces/ixxat/structures.py
@@ -1,4 +1,3 @@
-
 """
 Ctypes wrapper module for IXXAT Virtual CAN Interface V3 on win32 systems
 
diff --git a/can/interfaces/kvaser/__init__.py b/can/interfaces/kvaser/__init__.py
@@ -1,4 +1,3 @@
-
 """
 """
 
diff --git a/can/interfaces/kvaser/canlib.py b/can/interfaces/kvaser/canlib.py
@@ -1,4 +1,3 @@
-
 """
 Contains Python equivalents of the function and constant
 definitions in CANLIB's canlib.h, with some supporting functionality
diff --git a/can/interfaces/kvaser/constants.py b/can/interfaces/kvaser/constants.py
@@ -1,4 +1,3 @@
-
 """
 Contains Python equivalents of the function and constant
 definitions in CANLIB's canstat.h, with some supporting functionality
diff --git a/can/interfaces/kvaser/structures.py b/can/interfaces/kvaser/structures.py
@@ -1,4 +1,3 @@
-
 """
 Contains Python equivalents of the structures in CANLIB's canlib.h,
 with some supporting functionality specific to Python.
diff --git a/can/interfaces/nican.py b/can/interfaces/nican.py
@@ -1,4 +1,3 @@
-
 """
 NI-CAN interface module.
 
diff --git a/can/interfaces/pcan/__init__.py b/can/interfaces/pcan/__init__.py
@@ -1,4 +1,3 @@
-
 """
 """
 
diff --git a/can/interfaces/pcan/basic.py b/can/interfaces/pcan/basic.py
@@ -1,4 +1,3 @@
-
 """
 PCAN-Basic API
 
diff --git a/can/interfaces/pcan/pcan.py b/can/interfaces/pcan/pcan.py
@@ -1,4 +1,3 @@
-
 """
 Enable basic CAN over a PCAN USB device.
 """
diff --git a/can/interfaces/seeedstudio/__init__.py b/can/interfaces/seeedstudio/__init__.py
@@ -1,4 +1,3 @@
-
 """
 """
 
diff --git a/can/interfaces/seeedstudio/seeedstudio.py b/can/interfaces/seeedstudio/seeedstudio.py
@@ -1,4 +1,3 @@
-
 """
 To Support the Seeed USB-Can analyzer interface. The device will appear
 as a serial port, for example "/dev/ttyUSB0" on Linux machines
diff --git a/can/interfaces/serial/__init__.py b/can/interfaces/serial/__init__.py
@@ -1,4 +1,3 @@
-
 """
 """
 
diff --git a/can/interfaces/serial/serial_can.py b/can/interfaces/serial/serial_can.py
@@ -1,4 +1,3 @@
-
 """
 A text based interface. For example use over serial ports like
 "/dev/ttyS1" or "/dev/ttyUSB0" on Linux machines or "COM1" on Windows.
diff --git a/can/interfaces/slcan.py b/can/interfaces/slcan.py
@@ -1,4 +1,3 @@
-
 """
 Interface for slcan compatible interfaces (win32/linux).
 
diff --git a/can/interfaces/socketcan/__init__.py b/can/interfaces/socketcan/__init__.py
@@ -1,4 +1,3 @@
-
 """
 See: https://www.kernel.org/doc/Documentation/networking/can.txt
 """
diff --git a/can/interfaces/socketcan/constants.py b/can/interfaces/socketcan/constants.py
@@ -1,4 +1,3 @@
-
 """
 Defines shared CAN constants.
 """
diff --git a/can/interfaces/socketcan/socketcan.py b/can/interfaces/socketcan/socketcan.py
@@ -1,4 +1,3 @@
-
 """
 The main module of the socketcan interface containing most user-facing classes and methods
 along some internal methods.
diff --git a/can/interfaces/socketcan/utils.py b/can/interfaces/socketcan/utils.py
@@ -1,4 +1,3 @@
-
 """
 Defines common socketcan functions.
 """
diff --git a/can/interfaces/systec/__init__.py b/can/interfaces/systec/__init__.py
@@ -1,4 +1,3 @@
-
 """
 """
 
diff --git a/can/interfaces/systec/constants.py b/can/interfaces/systec/constants.py
@@ -1,4 +1,3 @@
-
 from ctypes import c_ubyte as BYTE, c_ushort as WORD, c_ulong as DWORD
 
 #: Maximum number of modules that are supported.
diff --git a/can/interfaces/systec/exceptions.py b/can/interfaces/systec/exceptions.py
@@ -1,4 +1,3 @@
-
 from .constants import ReturnCode
 from can import CanError
 
diff --git a/can/interfaces/systec/structures.py b/can/interfaces/systec/structures.py
@@ -1,4 +1,3 @@
-
 from ctypes import Structure, POINTER, sizeof
 from ctypes import (
     c_ubyte as BYTE,
diff --git a/can/interfaces/systec/ucan.py b/can/interfaces/systec/ucan.py
@@ -1,4 +1,3 @@
-
 import logging
 import sys
 
diff --git a/can/interfaces/systec/ucanbus.py b/can/interfaces/systec/ucanbus.py
@@ -1,4 +1,3 @@
-
 import logging
 from threading import Event
 
diff --git a/can/interfaces/usb2can/__init__.py b/can/interfaces/usb2can/__init__.py
@@ -1,4 +1,3 @@
-
 """
 """
 
diff --git a/can/interfaces/usb2can/serial_selector.py b/can/interfaces/usb2can/serial_selector.py
@@ -1,4 +1,3 @@
-
 """
 """
 
diff --git a/can/interfaces/usb2can/usb2canInterface.py b/can/interfaces/usb2can/usb2canInterface.py
@@ -1,4 +1,3 @@
-
 """
 This interface is for Windows only, otherwise use socketCAN.
 """
diff --git a/can/interfaces/usb2can/usb2canabstractionlayer.py b/can/interfaces/usb2can/usb2canabstractionlayer.py
@@ -1,4 +1,3 @@
-
 """
 This wrapper is for windows or direct access via CANAL API.
 Socket CAN is recommended under Unix/Linux systems.
diff --git a/can/interfaces/vector/__init__.py b/can/interfaces/vector/__init__.py
@@ -1,4 +1,3 @@
-
 """
 """
 
diff --git a/can/interfaces/vector/canlib.py b/can/interfaces/vector/canlib.py
@@ -1,4 +1,3 @@
-
 """
 Ctypes wrapper module for Vector CAN Interface on win32/win64 systems.
 
diff --git a/can/interfaces/vector/exceptions.py b/can/interfaces/vector/exceptions.py
@@ -1,4 +1,3 @@
-
 """
 """
 
diff --git a/can/interfaces/vector/xlclass.py b/can/interfaces/vector/xlclass.py
@@ -1,4 +1,3 @@
-
 """
 Definition of data types and structures for vxlapi.
 
diff --git a/can/interfaces/vector/xldefine.py b/can/interfaces/vector/xldefine.py
@@ -1,4 +1,3 @@
-
 """
 Definition of constants for vxlapi.
 """
diff --git a/can/interfaces/vector/xldriver.py b/can/interfaces/vector/xldriver.py
@@ -1,4 +1,3 @@
-
 """
 Ctypes wrapper module for Vector CAN Interface on win32/win64 systems.
 
diff --git a/can/interfaces/virtual.py b/can/interfaces/virtual.py
@@ -1,4 +1,3 @@
-
 """
 This module implements an OS and hardware independent
 virtual CAN interface for testing purposes.
diff --git a/can/io/__init__.py b/can/io/__init__.py
@@ -1,4 +1,3 @@
-
 """
 Read and write CAN bus messages using a range of Readers
 and Writers based off the file extension.
diff --git a/can/io/asc.py b/can/io/asc.py
@@ -1,4 +1,3 @@
-
 """
 Contains handling of ASC logging files.
 
diff --git a/can/io/blf.py b/can/io/blf.py
@@ -1,4 +1,3 @@
-
 """
 Implements support for BLF (Binary Logging Format) which is a proprietary
 CAN log format from Vector Informatik GmbH (Germany).
diff --git a/can/io/canutils.py b/can/io/canutils.py
@@ -1,4 +1,3 @@
-
 """
 This module works with CAN data in ASCII log files (*.log).
 It is is compatible with "candump -L" from the canutils program
diff --git a/can/io/csv.py b/can/io/csv.py
@@ -1,4 +1,3 @@
-
 """
 This module contains handling for CSV (comma separated values) files.
 
diff --git a/can/io/generic.py b/can/io/generic.py
@@ -1,4 +1,3 @@
-
 """
 Contains a generic class for file IO.
 """
diff --git a/can/io/logger.py b/can/io/logger.py
@@ -1,4 +1,3 @@
-
 """
 See the :class:`Logger` class.
 """
diff --git a/can/io/player.py b/can/io/player.py
@@ -1,4 +1,3 @@
-
 """
 This module contains the generic :class:`LogReader` as
 well as :class:`MessageSync` which plays back messages
diff --git a/can/io/printer.py b/can/io/printer.py
@@ -1,4 +1,3 @@
-
 """
 This Listener simply prints to stdout / the terminal or a file.
 """
diff --git a/can/io/sqlite.py b/can/io/sqlite.py
@@ -1,4 +1,3 @@
-
 """
 Implements an SQL database writer and reader for storing CAN messages.
 
diff --git a/can/listener.py b/can/listener.py
@@ -1,4 +1,3 @@
-
 """
 This module contains the implementation of `can.Listener` and some readers.
 """
diff --git a/can/logger.py b/can/logger.py
@@ -1,4 +1,3 @@
-
 """
 logger.py logs CAN traffic to the terminal and to a file on disk.
 
diff --git a/can/message.py b/can/message.py
@@ -1,4 +1,3 @@
-
 """
 This module contains the implementation of :class:`can.Message`.
 
diff --git a/can/notifier.py b/can/notifier.py
@@ -1,4 +1,3 @@
-
 """
 This module contains the implementation of :class:`~can.Notifier`.
 """
diff --git a/can/player.py b/can/player.py
@@ -1,4 +1,3 @@
-
 """
 Replays CAN traffic saved with can.logger back
 to a CAN bus.
diff --git a/can/thread_safe_bus.py b/can/thread_safe_bus.py
@@ -1,4 +1,3 @@
-
 from threading import RLock
 
 try:
diff --git a/can/util.py b/can/util.py
@@ -1,4 +1,3 @@
-
 """
 Utilities and configuration file parsing.
 """
diff --git a/can/viewer.py b/can/viewer.py
@@ -1,4 +1,3 @@
-
 # Copyright (C) 2018 Kristian Sloth Lauszus.
 #
 # This program is free software; you can redistribute it and/or
diff --git a/doc/conf.py b/doc/conf.py
@@ -1,23 +1,24 @@
-# -*- coding: utf-8 -*-
-#
-# python-can documentation build configuration file
-#
-# This file is execfile()d with the current directory set to its containing dir.
+"""
+python-can documentation build configuration file
+
+This file is execfile()d with the current directory set to its containing dir.
+"""
 
-from __future__ import unicode_literals, absolute_import
+# -- Imports -------------------------------------------------------------------
 
 import sys
 import os
 
-# General information about the project.
-project = "python-can"
-
 # 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.
 sys.path.insert(0, os.path.abspath(".."))
 
-import can
+import can  # pylint: disable=wrong-import-position
+
+# -- General configuration -----------------------------------------------------
+
+# pylint: disable=invalid-name
 
 # The version info for the project, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -27,7 +28,8 @@
 version = can.__version__.split("-")[0]
 release = can.__version__
 
-# -- General configuration -----------------------------------------------------
+# General information about the project.
+project = "python-can"
 
 primary_domain = "py"
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-`
`2`	`1`	`"""`
`3`	`2`	``can`` is an object-orient Controller Area Network (CAN) interface module.
`4`	`3`	`"""`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-`
`2`	`1`	`"""`
`3`	`2`	`Exposes several methods for transmitting cyclic messages.`
`4`	`3`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-`
`2`	`1`	`"""`
`3`	`2`	`Contains the ABC bus implementation and its documentation.`
`4`	`3`	`"""`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-`
`2`	`1`	`"""`
`3`	`2`	This module contains common `ctypes` utils.
`4`	`3`	`"""`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-`
`2`	`1`	`"""`
`3`	`2`	This module contains the base implementation of :class:`can.BusABC` as well
`4`	`3`	`as a list of all available backends and some implemented`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-`
`2`	`1`	`"""`
`3`	`2`	`Interfaces contain low level implementations that interact with CAN hardware.`
`4`	`3`	`"""`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-`
`2`	`1`	`from ctypes import *`
`3`	`2`	`import logging`
`4`	`3`	`import platform`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-`
`2`	`1`	`"""`
`3`	`2`	`ICS NeoVi interface module.`
`4`	`3`