From f550c1d338775fa6d4776fc0557bfacf68fd9703 Mon Sep 17 00:00:00 2001 From: dherrada Date: Sun, 15 Mar 2020 15:58:58 -0400 Subject: [PATCH] Ran black, updated to pylint 2.x --- .github/workflows/build.yml | 2 +- adafruit_thermistor.py | 22 ++++-- docs/conf.py | 110 +++++++++++++++++------------- examples/thermistor_simpletest.py | 6 +- setup.py | 52 ++++++-------- 5 files changed, 106 insertions(+), 86 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_thermistor.py b/adafruit_thermistor.py index 9378eaa..eaeebd0 100644 --- a/adafruit_thermistor.py +++ b/adafruit_thermistor.py @@ -64,8 +64,16 @@ class Thermistor: """Thermistor driver""" - def __init__(self, pin, series_resistor, nominal_resistance, nominal_temperature, - b_coefficient, *, high_side=True): + def __init__( + self, + pin, + series_resistor, + nominal_resistance, + nominal_temperature, + b_coefficient, + *, + high_side=True + ): # pylint: disable=too-many-arguments self.pin = analogio.AnalogIn(pin) self.series_resistor = series_resistor @@ -84,13 +92,13 @@ def temperature(self): reading -= self.series_resistor else: # Thermistor connected from analog input to ground. - reading = self.series_resistor / (65535.0/self.pin.value - 1.0) + reading = self.series_resistor / (65535.0 / self.pin.value - 1.0) steinhart = reading / self.nominal_resistance # (R/Ro) - steinhart = math.log(steinhart) # ln(R/Ro) - steinhart /= self.b_coefficient # 1/B * ln(R/Ro) + steinhart = math.log(steinhart) # ln(R/Ro) + steinhart /= self.b_coefficient # 1/B * ln(R/Ro) steinhart += 1.0 / (self.nominal_temperature + 273.15) # + (1/To) - steinhart = 1.0 / steinhart # Invert - steinhart -= 273.15 # convert to C + steinhart = 1.0 / steinhart # Invert + steinhart -= 273.15 # convert to C return steinhart diff --git a/docs/conf.py b/docs/conf.py index 5c5852e..966aa1b 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,9 +11,9 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.intersphinx', - 'sphinx.ext.viewcode', + "sphinx.ext.autodoc", + "sphinx.ext.intersphinx", + "sphinx.ext.viewcode", ] # Uncomment the below if you use native CircuitPython modules such as @@ -20,29 +21,32 @@ # autodoc module docs will fail to generate with a warning. autodoc_mock_imports = ["analogio"] -intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)} +intersphinx_mapping = { + "python": ("https://docs.python.org/3.4", 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 THERMISTOR Library' -copyright = u'2017 Scott Shawcroft' -author = u'Scott Shawcroft' +project = u"Adafruit THERMISTOR Library" +copyright = u"2017 Scott Shawcroft" +author = u"Scott Shawcroft" # 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. @@ -54,7 +58,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. @@ -66,7 +70,7 @@ 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 @@ -80,59 +84,62 @@ # 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 = 'AdafruitTHERMISTORLibrarydoc' +htmlhelp_basename = "AdafruitTHERMISTORLibrarydoc" # -- 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, 'AdafruitTHERMISTORLibrary.tex', u'Adafruit THERMISTOR Library Documentation', - u'Phiilip Moyer', 'manual'), + ( + master_doc, + "AdafruitTHERMISTORLibrary.tex", + u"Adafruit THERMISTOR Library Documentation", + u"Phiilip Moyer", + "manual", + ), ] # -- Options for manual page output --------------------------------------- @@ -140,8 +147,13 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'AdafruitTHERMISTORlibrary', u'Adafruit THERMISTOR Library Documentation', - [author], 1) + ( + master_doc, + "AdafruitTHERMISTORlibrary", + u"Adafruit THERMISTOR Library Documentation", + [author], + 1, + ) ] # -- Options for Texinfo output ------------------------------------------- @@ -150,7 +162,13 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'AdafruitTHERMISTORLibrary', u'Adafruit THERMISTOR Library Documentation', - author, 'AdafruitTHERMISTORLibrary', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "AdafruitTHERMISTORLibrary", + u"Adafruit THERMISTOR Library Documentation", + author, + "AdafruitTHERMISTORLibrary", + "One line description of project.", + "Miscellaneous", + ), ] diff --git a/examples/thermistor_simpletest.py b/examples/thermistor_simpletest.py index 1af540e..321c333 100644 --- a/examples/thermistor_simpletest.py +++ b/examples/thermistor_simpletest.py @@ -12,11 +12,13 @@ nominal_temp = 25 b_coefficient = 3950 -thermistor = adafruit_thermistor.Thermistor(pin, resistor, resistance, nominal_temp, b_coefficient) +thermistor = adafruit_thermistor.Thermistor( + pin, resistor, resistance, nominal_temp, b_coefficient +) # print the temperature in C and F to the serial console every second while True: celsius = thermistor.temperature fahrenheit = (celsius * 9 / 5) + 32 - print('== Temperature ==\n{} *C\n{} *F\n'.format(celsius, fahrenheit)) + print("== Temperature ==\n{} *C\n{} *F\n".format(celsius, fahrenheit)) time.sleep(1) diff --git a/setup.py b/setup.py index 4e352ab..f25fc13 100644 --- a/setup.py +++ b/setup.py @@ -7,6 +7,7 @@ # 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,47 +15,38 @@ 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-thermistor', - + name="adafruit-circuitpython-thermistor", use_scm_version=True, - setup_requires=['setuptools_scm'], - - description='CircuitPython library for Thermistor thermal resistor temperature sensor.', + setup_requires=["setuptools_scm"], + description="CircuitPython library for Thermistor thermal resistor 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_Thermistor', - + url="https://github.com/adafruit/Adafruit_CircuitPython_Thermistor", # Author details - author='Adafruit Industries', - author_email='circuitpython@adafruit.com', - - install_requires=['Adafruit-Blinka'], - + author="Adafruit Industries", + author_email="circuitpython@adafruit.com", + install_requires=["Adafruit-Blinka"], # 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 thermal resistor temperature hardware micropython circuitpython', - + keywords="adafruit thermal resistor temperature hardware micropython circuitpython", # You can just specify the packages manually here if your project is # simple. Or you can use find_packages(). - py_modules=['adafruit_thermistor'], -) \ No newline at end of file + py_modules=["adafruit_thermistor"], +)