Merge pull request #25 from adafruit/pylint-update

Ran black, updated to pylint 2.x

Author: kattni

.github/workflows/build.yml

@@ -40,7 +40,7 @@ jobs:
         source actions-ci/install.sh
     - name: Pip install pylint, black, & Sphinx
       run: |
-        pip install --force-reinstall pylint==1.9.2 black==19.10b0 Sphinx sphinx-rtd-theme
+        pip install --force-reinstall pylint black==19.10b0 Sphinx sphinx-rtd-theme
     - name: Library version
       run: git describe --dirty --always --tags
     - name: PyLint

.pylintrc

@@ -119,7 +119,8 @@ spelling-store-unknown-words=no
 [MISCELLANEOUS]
 
 # List of note tags to take in consideration, separated by a comma.
-notes=FIXME,XXX,TODO
+# notes=FIXME,XXX,TODO
+notes=FIXME,XXX
 
 
 [TYPECHECK]
@@ -300,7 +301,7 @@ function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
 
 # Good variable names which should always be accepted, separated by a comma
 # good-names=i,j,k,ex,Run,_
-good-names=r,g,b,i,j,k,n,ex,Run,_
+good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_
 
 # Include a hint for the correct naming format with invalid-name
 include-naming-hint=no
@@ -422,7 +423,7 @@ max-returns=6
 max-statements=50
 
 # Minimum number of public methods for a class (see R0903).
-min-public-methods=2
+min-public-methods=1
 
 
 [EXCEPTIONS]

adafruit_ds3231.py

@@ -62,14 +62,14 @@
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_DS3231.git"
 
-#pylint: disable-msg=too-few-public-methods
+# pylint: disable-msg=too-few-public-methods
 class DS3231:
     """Interface to the DS3231 RTC."""
 
-    lost_power = i2c_bit.RWBit(0x0f, 7)
+    lost_power = i2c_bit.RWBit(0x0F, 7)
     """True if the device has lost power since the time was set."""
 
-    disable_oscillator = i2c_bit.RWBit(0x0e, 7)
+    disable_oscillator = i2c_bit.RWBit(0x0E, 7)
     """True if the oscillator is disabled."""
 
     datetime_register = i2c_bcd_datetime.BCDDateTimeRegister(0x00)
@@ -78,19 +78,19 @@ class DS3231:
     alarm1 = i2c_bcd_alarm.BCDAlarmTimeRegister(0x07)
     """Alarm time for the first alarm."""
 
-    alarm1_interrupt = i2c_bit.RWBit(0x0e, 0)
+    alarm1_interrupt = i2c_bit.RWBit(0x0E, 0)
     """True if the interrupt pin will output when alarm1 is alarming."""
 
-    alarm1_status = i2c_bit.RWBit(0x0f, 0)
+    alarm1_status = i2c_bit.RWBit(0x0F, 0)
     """True if alarm1 is alarming. Set to False to reset."""
 
-    alarm2 = i2c_bcd_alarm.BCDAlarmTimeRegister(0x0b, has_seconds=False)
+    alarm2 = i2c_bcd_alarm.BCDAlarmTimeRegister(0x0B, has_seconds=False)
     """Alarm time for the second alarm."""
 
-    alarm2_interrupt = i2c_bit.RWBit(0x0e, 1)
+    alarm2_interrupt = i2c_bit.RWBit(0x0E, 1)
     """True if the interrupt pin will output when alarm2 is alarming."""
 
-    alarm2_status = i2c_bit.RWBit(0x0f, 1)
+    alarm2_status = i2c_bit.RWBit(0x0F, 1)
     """True if alarm2 is alarming. Set to False to reset."""
 
     def __init__(self, i2c):

docs/conf.py

@@ -18,7 +18,8 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('..'))
+
+sys.path.insert(0, os.path.abspath(".."))
 
 # -- General configuration ------------------------------------------------
 
@@ -30,48 +31,59 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.todo',
-    'sphinx.ext.viewcode',
-    'sphinx.ext.intersphinx'
+    "sphinx.ext.autodoc",
+    "sphinx.ext.todo",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.intersphinx",
 ]
 
 # Uncomment the below if you use native CircuitPython modules such as
 # digitalio, micropython and busio. List the modules you use. Without it, the
 # autodoc module docs will fail to generate with a warning.
 # autodoc_mock_imports = ["adafruit_bus_device", "adafruit_register"]
 
-intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'BusDevice': ('https://circuitpython.readthedocs.io/projects/busdevice/en/latest/', None),'Register': ('https://circuitpython.readthedocs.io/projects/register/en/latest/', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)}
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3.4", None),
+    "BusDevice": (
+        "https://circuitpython.readthedocs.io/projects/busdevice/en/latest/",
+        None,
+    ),
+    "Register": (
+        "https://circuitpython.readthedocs.io/projects/register/en/latest/",
+        None,
+    ),
+    "CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None),
+}
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
-source_suffix = ['.rst', '.md']
+source_suffix = [".rst", ".md"]
 # source_suffix = '.rst'
 
 # The encoding of source files.
 #
 # source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = u'Adafruit\'s DS3231 RTC Library'
-copyright = u'2016, Philip Moyer'
-author = u'Philip Moyer'
+project = u"Adafruit's DS3231 RTC Library"
+copyright = u"2016, Philip Moyer"
+author = u"Philip Moyer"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = u'1.0'
+version = u"1.0"
 # The full version, including alpha/beta/rc tags.
-release = u'1.0'
+release = u"1.0"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -92,7 +104,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.env', 'CODE_OF_CONDUCT.md']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".env", "CODE_OF_CONDUCT.md"]
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
@@ -114,7 +126,7 @@
 # show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # A list of ignored prefixes for module index sorting.
 # modindex_common_prefix = []
@@ -134,18 +146,19 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+on_rtd = os.environ.get("READTHEDOCS", None) == "True"
 
 if not on_rtd:  # only import and set the theme if we're building docs locally
     try:
         import sphinx_rtd_theme
-        html_theme = 'sphinx_rtd_theme'
-        html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), '.']
+
+        html_theme = "sphinx_rtd_theme"
+        html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."]
     except:
-        html_theme = 'default'
-        html_theme_path = ['.']
+        html_theme = "default"
+        html_theme_path = ["."]
 else:
-    html_theme_path = ['.']
+    html_theme_path = ["."]
 
 # 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
@@ -179,13 +192,13 @@
 # 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,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 # The name of an image file (relative to this directory) to use as a favicon of
 # the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
 #
-html_favicon = '_static/favicon.ico'
+html_favicon = "_static/favicon.ico"
 
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied
@@ -265,34 +278,36 @@
 # html_search_scorer = 'scorer.js'
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'AdafruitsDS3231RTCLibrarydoc'
+htmlhelp_basename = "AdafruitsDS3231RTCLibrarydoc"
 
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
-     # The paper size ('letterpaper' or 'a4paper').
-     #
-     # 'papersize': 'letterpaper',
-
-     # The font size ('10pt', '11pt' or '12pt').
-     #
-     # 'pointsize': '10pt',
-
-     # Additional stuff for the LaTeX preamble.
-     #
-     # 'preamble': '',
-
-     # Latex figure (float) alignment
-     #
-     # 'figure_align': 'htbp',
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'AdafruitsDS3231RTCLibrary.tex', u'Adafruit\'s DS3231 RTC Library Documentation',
-     u'Philip Moyer', 'manual'),
+    (
+        master_doc,
+        "AdafruitsDS3231RTCLibrary.tex",
+        u"Adafruit's DS3231 RTC Library Documentation",
+        u"Philip Moyer",
+        "manual",
+    ),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -333,8 +348,13 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'adafruitsds3231rtclibrary', u'Adafruit\'s DS3231 RTC Library Documentation',
-     [author], 1)
+    (
+        master_doc,
+        "adafruitsds3231rtclibrary",
+        u"Adafruit's DS3231 RTC Library Documentation",
+        [author],
+        1,
+    )
 ]
 
 # If true, show URL addresses after external links.
@@ -348,9 +368,15 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'AdafruitsDS3231RTCLibrary', u'Adafruit\'s DS3231 RTC Library Documentation',
-     author, 'AdafruitsDS3231RTCLibrary', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "AdafruitsDS3231RTCLibrary",
+        u"Adafruit's DS3231 RTC Library Documentation",
+        author,
+        "AdafruitsDS3231RTCLibrary",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]
 
 # Documents to append as an appendix to all manuals.

examples/ds3231_simpletest.py

@@ -5,16 +5,18 @@
 
 import time
 import board
+
 # For hardware I2C (M0 boards) use this line:
 import busio as io
+
 # Or for software I2C (ESP8266) use this line instead:
-#import bitbangio as io
+# import bitbangio as io
 
 import adafruit_ds3231
 
 
 i2c = io.I2C(board.SCL, board.SDA)  # Change to the appropriate I2C clock & data
-                                    # pins here!
+# pins here!
 
 # Create the RTC instance:
 rtc = adafruit_ds3231.DS3231(i2c)
@@ -23,23 +25,27 @@
 days = ("Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday")
 
 
-#pylint: disable-msg=bad-whitespace
-#pylint: disable-msg=using-constant-test
-if False:   # change to True if you want to set the time!
+# pylint: disable-msg=bad-whitespace
+# pylint: disable-msg=using-constant-test
+if False:  # change to True if you want to set the time!
     #                     year, mon, date, hour, min, sec, wday, yday, isdst
-    t = time.struct_time((2017,  10,   29,   15,  14,  15,    0,   -1,    -1))
+    t = time.struct_time((2017, 10, 29, 15, 14, 15, 0, -1, -1))
     # you must set year, mon, date, hour, min, sec and weekday
     # yearday is not supported, isdst can be set but we don't do anything with it at this time
-    print("Setting time to:", t)     # uncomment for debugging
+    print("Setting time to:", t)  # uncomment for debugging
     rtc.datetime = t
     print()
-#pylint: enable-msg=using-constant-test
-#pylint: enable-msg=bad-whitespace
+# pylint: enable-msg=using-constant-test
+# pylint: enable-msg=bad-whitespace
 
 # Main loop:
 while True:
     t = rtc.datetime
-    #print(t)     # uncomment for debugging
-    print("The date is {} {}/{}/{}".format(days[int(t.tm_wday)], t.tm_mday, t.tm_mon, t.tm_year))
+    # print(t)     # uncomment for debugging
+    print(
+        "The date is {} {}/{}/{}".format(
+            days[int(t.tm_wday)], t.tm_mday, t.tm_mon, t.tm_year
+        )
+    )
     print("The time is {}:{:02}:{:02}".format(t.tm_hour, t.tm_min, t.tm_sec))
-    time.sleep(1) # wait a second
+    time.sleep(1)  # wait a second