From 8af21f47d2f851539c0d2de136beeab46bcdfe9e Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 16 Mar 2020 16:40:37 -0400 Subject: [PATCH] Ran black, updated to pylint 2.x --- .github/workflows/build.yml | 2 +- adafruit_adt7410.py | 15 +++-- docs/conf.py | 120 ++++++++++++++++++++++-------------- setup.py | 61 +++++++++--------- 4 files changed, 111 insertions(+), 87 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index fff3aa9..1dad804 100644 --- a/.github/workflows/build.yml +++ b/.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 diff --git a/adafruit_adt7410.py b/adafruit_adt7410.py index ec31e0d..1acd1d0 100644 --- a/adafruit_adt7410.py +++ b/adafruit_adt7410.py @@ -61,6 +61,7 @@ _ADT7410_CONFIG = const(0x3) _ADT7410_ID = const(0xB) _ADT7410_SWRST = const(0x2F) + class ADT7410: """Interface to the Analog Devices ADT7410 temperature sensor.""" @@ -71,7 +72,6 @@ class ADT7410: comparator_mode = RWBit(_ADT7410_CONFIG, 4) high_resolution = RWBit(_ADT7410_CONFIG, 7) - def __init__(self, i2c_bus, address=0x48): self.i2c_device = I2CDevice(i2c_bus, address) self._buf = bytearray(3) @@ -79,14 +79,16 @@ class ADT7410: # what we expect. _id = (self._read_register(_ADT7410_ID)[0]) & 0xF8 if _id != 0xC8: - raise ValueError("Unable to find ADT7410 at i2c address " + str(hex(address))) + raise ValueError( + "Unable to find ADT7410 at i2c address " + str(hex(address)) + ) self.reset() @property def temperature(self): """The temperature in celsius""" temp = self._read_register(_ADT7410_TEMPMSB, 2) - return struct.unpack('>h', temp)[0] / 128 + return struct.unpack(">h", temp)[0] / 128 @property def status(self): @@ -110,9 +112,10 @@ class ADT7410: def _read_register(self, addr, num=1): self._buf[0] = addr with self.i2c_device as i2c: - i2c.write_then_readinto(self._buf, self._buf, out_end=1, - in_start=1, in_end=num+1) - return self._buf[1:num+1] + i2c.write_then_readinto( + self._buf, self._buf, out_end=1, in_start=1, in_end=num + 1 + ) + return self._buf[1 : num + 1] def _write_register(self, addr, data=None): self._buf[0] = addr diff --git a/docs/conf.py b/docs/conf.py index e771b16..af701da 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -2,7 +2,8 @@ import os import sys -sys.path.insert(0, os.path.abspath('..')) + +sys.path.insert(0, os.path.abspath("..")) # -- General configuration ------------------------------------------------ @@ -10,10 +11,10 @@ sys.path.insert(0, os.path.abspath('..')) # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.intersphinx', - 'sphinx.ext.napoleon', - 'sphinx.ext.todo', + "sphinx.ext.autodoc", + "sphinx.ext.intersphinx", + "sphinx.ext.napoleon", + "sphinx.ext.todo", ] # TODO: Please Read! @@ -23,29 +24,40 @@ extensions = [ # autodoc_mock_imports = ["digitalio", "busio"] -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"] -source_suffix = '.rst' +source_suffix = ".rst" # The master toctree document. -master_doc = 'index' +master_doc = "index" # General information about the project. -project = u'Adafruit ADT7410 Library' -copyright = u'2019 ladyada' -author = u'ladyada' +project = u"Adafruit ADT7410 Library" +copyright = u"2019 ladyada" +author = u"ladyada" # 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. @@ -57,7 +69,7 @@ language = None # 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. @@ -69,7 +81,7 @@ default_role = "any" add_function_parentheses = True # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = "sphinx" # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = False @@ -84,59 +96,62 @@ napoleon_numpy_docstring = False # 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 = ["."] # 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" # Output file base name for HTML help builder. -htmlhelp_basename = 'AdafruitAdt7410Librarydoc' +htmlhelp_basename = "AdafruitAdt7410Librarydoc" # -- 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, 'AdafruitADT7410Library.tex', u'AdafruitADT7410 Library Documentation', - author, 'manual'), + ( + master_doc, + "AdafruitADT7410Library.tex", + u"AdafruitADT7410 Library Documentation", + author, + "manual", + ), ] # -- Options for manual page output --------------------------------------- @@ -144,8 +159,13 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'AdafruitADT7410library', u'Adafruit ADT7410 Library Documentation', - [author], 1) + ( + master_doc, + "AdafruitADT7410library", + u"Adafruit ADT7410 Library Documentation", + [author], + 1, + ) ] # -- Options for Texinfo output ------------------------------------------- @@ -154,7 +174,13 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'AdafruitADT7410Library', u'Adafruit ADT7410 Library Documentation', - author, 'AdafruitADT7410Library', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "AdafruitADT7410Library", + u"Adafruit ADT7410 Library Documentation", + author, + "AdafruitADT7410Library", + "One line description of project.", + "Miscellaneous", + ), ] diff --git a/setup.py b/setup.py index bb718b2..c746069 100644 --- a/setup.py +++ b/setup.py @@ -7,6 +7,7 @@ https://github.com/pypa/sampleproject # Always prefer setuptools over distutils from setuptools import setup, find_packages + # To use a consistent encoding from codecs import open from os import path @@ -14,50 +15,44 @@ from os import path here = path.abspath(path.dirname(__file__)) # Get the long description from the README file -with open(path.join(here, 'README.rst'), encoding='utf-8') as f: +with open(path.join(here, "README.rst"), encoding="utf-8") as f: long_description = f.read() setup( - name='adafruit-circuitpython-adt7410', - + name="adafruit-circuitpython-adt7410", use_scm_version=True, - setup_requires=['setuptools_scm'], - - description='CircuitPython driver for reading temperature from the Analog Devices ADT7410 ' - 'precision temperature sensor.', + setup_requires=["setuptools_scm"], + description="CircuitPython driver for reading temperature from the Analog Devices ADT7410 " + "precision temperature sensor.", long_description=long_description, - long_description_content_type='text/x-rst', - + long_description_content_type="text/x-rst", # The project's main homepage. - url='https://github.com/adafruit/Adafruit_CircuitPython_ADT7410', - + url="https://github.com/adafruit/Adafruit_CircuitPython_ADT7410", # Author details - author='Adafruit Industries', - author_email='circuitpython@adafruit.com', - - install_requires=['Adafruit-Blinka', 'adafruit-circuitpython-busdevice', - 'adafruit-circuitpython-register'], - + author="Adafruit Industries", + author_email="circuitpython@adafruit.com", + install_requires=[ + "Adafruit-Blinka", + "adafruit-circuitpython-busdevice", + "adafruit-circuitpython-register", + ], # Choose your license - license='MIT', - + license="MIT", # See https://pypi.python.org/pypi?%3Aaction=list_classifiers classifiers=[ - 'Development Status :: 3 - Alpha', - 'Intended Audience :: Developers', - 'Topic :: Software Development :: Libraries', - 'Topic :: System :: Hardware', - 'License :: OSI Approved :: MIT License', - 'Programming Language :: Python :: 3', - 'Programming Language :: Python :: 3.4', - 'Programming Language :: Python :: 3.5', + "Development Status :: 3 - Alpha", + "Intended Audience :: Developers", + "Topic :: Software Development :: Libraries", + "Topic :: System :: Hardware", + "License :: OSI Approved :: MIT License", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.4", + "Programming Language :: Python :: 3.5", ], - # What does your project relate to? - keywords='adafruit analog precision temperature sensor hardware adt7410 ' - 'micropython circuitpython', - + keywords="adafruit analog precision temperature sensor hardware adt7410 " + "micropython circuitpython", # You can just specify the packages manually here if your project is # simple. Or you can use find_packages(). - py_modules=['adafruit_adt7410'], -) \ No newline at end of file + py_modules=["adafruit_adt7410"], +)