From 2ca197f3e0934554e07cba4316adbd37c50cefea Mon Sep 17 00:00:00 2001 From: dherrada Date: Sun, 15 Mar 2020 14:46:35 -0400 Subject: [PATCH] Ran black, updated to pylint 2.x --- .github/workflows/build.yml | 2 +- adafruit_veml6075.py | 41 ++++++------ docs/conf.py | 126 ++++++++++++++++++++++-------------- setup.py | 50 ++++++-------- 4 files changed, 121 insertions(+), 98 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_veml6075.py b/adafruit_veml6075.py index 77168e4..da6620e 100644 --- a/adafruit_veml6075.py +++ b/adafruit_veml6075.py @@ -53,22 +53,19 @@ # pylint: disable=bad-whitespace _VEML6075_ADDR = const(0x10) -_REG_CONF = const(0x00) -_REG_UVA = const(0x07) -_REG_DARK = const(0x08) # check is true? -_REG_UVB = const(0x09) +_REG_CONF = const(0x00) +_REG_UVA = const(0x07) +_REG_DARK = const(0x08) # check is true? +_REG_UVB = const(0x09) _REG_UVCOMP1 = const(0x0A) _REG_UVCOMP2 = const(0x0B) -_REV_ID = const(0x0C) +_REV_ID = const(0x0C) # Valid constants for UV Integration Time -_VEML6075_UV_IT = { 50: 0x00, - 100: 0x01, - 200: 0x02, - 400: 0x03, - 800: 0x04 } +_VEML6075_UV_IT = {50: 0x00, 100: 0x01, 200: 0x02, 400: 0x03, 800: 0x04} # pylint: enable=bad-whitespace + class VEML6075: """ Driver base for the VEML6075 UV Light Sensor @@ -89,10 +86,19 @@ class VEML6075: :param float uvb_response: the UVA responsivity """ - def __init__(self, i2c_bus, *, integration_time=50, high_dynamic=True, - uva_a_coef=2.22, uva_b_coef=1.33, - uvb_c_coef=2.95, uvb_d_coef=1.74, - uva_response=0.001461, uvb_response=0.002591): + def __init__( + self, + i2c_bus, + *, + integration_time=50, + high_dynamic=True, + uva_a_coef=2.22, + uva_b_coef=1.33, + uvb_c_coef=2.95, + uvb_d_coef=1.74, + uva_response=0.001461, + uvb_response=0.002591 + ): # Set coefficients self._a = uva_a_coef self._b = uva_b_coef @@ -129,13 +135,13 @@ def _take_reading(self): time.sleep(0.1) uva = self._read_register(_REG_UVA) uvb = self._read_register(_REG_UVB) - #dark = self._read_register(_REG_DARK) + # dark = self._read_register(_REG_DARK) uvcomp1 = self._read_register(_REG_UVCOMP1) uvcomp2 = self._read_register(_REG_UVCOMP2) # Equasion 1 & 2 in App note, without 'golden sample' calibration self._uvacalc = uva - (self._a * uvcomp1) - (self._b * uvcomp2) self._uvbcalc = uvb - (self._c * uvcomp1) - (self._d * uvcomp2) - #print("UVA = %d, UVB = %d, UVcomp1 = %d, UVcomp2 = %d, Dark = %d" % + # print("UVA = %d, UVB = %d, UVcomp1 = %d, UVcomp2 = %d, Dark = %d" % # (uva, uvb, uvcomp1, uvcomp2, dark)) @property @@ -171,11 +177,10 @@ def integration_time(self, val): if not val in _VEML6075_UV_IT.keys(): raise RuntimeError("Invalid integration time") conf = self._read_register(_REG_CONF) - conf &= ~ 0b01110000 # mask off bits 4:6 + conf &= ~0b01110000 # mask off bits 4:6 conf |= _VEML6075_UV_IT[val] << 4 self._write_register(_REG_CONF, conf) - def _read_register(self, register): """Read a 16-bit value from the `register` location""" self._buffer[0] = register diff --git a/docs/conf.py b/docs/conf.py index 8ab6f16..326d094 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,42 +11,53 @@ # 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! # 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 = ["micropython"] - - -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)} +# autodoc_mock_imports = ["micropython"] + + +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 VEML6075 Library' -copyright = u'2018 ladyada' -author = u'ladyada' +project = u"Adafruit VEML6075 Library" +copyright = u"2018 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 @@ # 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 @@ 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 @@ # 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 = 'AdafruitVeml6075Librarydoc' +htmlhelp_basename = "AdafruitVeml6075Librarydoc" # -- 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, 'AdafruitVEML6075Library.tex', u'AdafruitVEML6075 Library Documentation', - author, 'manual'), + ( + master_doc, + "AdafruitVEML6075Library.tex", + u"AdafruitVEML6075 Library Documentation", + author, + "manual", + ), ] # -- Options for manual page output --------------------------------------- @@ -144,8 +159,13 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'AdafruitVEML6075library', u'Adafruit VEML6075 Library Documentation', - [author], 1) + ( + master_doc, + "AdafruitVEML6075library", + u"Adafruit VEML6075 Library Documentation", + [author], + 1, + ) ] # -- Options for Texinfo output ------------------------------------------- @@ -154,7 +174,13 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'AdafruitVEML6075Library', u'Adafruit VEML6075 Library Documentation', - author, 'AdafruitVEML6075Library', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "AdafruitVEML6075Library", + u"Adafruit VEML6075 Library Documentation", + author, + "AdafruitVEML6075Library", + "One line description of project.", + "Miscellaneous", + ), ] diff --git a/setup.py b/setup.py index 00abd1e..7440e22 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-veml6075', - + name="adafruit-circuitpython-veml6075", use_scm_version=True, - setup_requires=['setuptools_scm'], - - description='CircuitPython library for interfacing with VEML6075 UV sensor', + setup_requires=["setuptools_scm"], + description="CircuitPython library for interfacing with VEML6075 UV 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_VEML6075', - + url="https://github.com/adafruit/Adafruit_CircuitPython_VEML6075", # Author details - author='Adafruit Industries', - author_email='circuitpython@adafruit.com', - - install_requires=['Adafruit-Blinka', 'adafruit-circuitpython-busdevice'], - + author="Adafruit Industries", + author_email="circuitpython@adafruit.com", + install_requires=["Adafruit-Blinka", "adafruit-circuitpython-busdevice"], # 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 sensor hardware micropython circuitpython', - + keywords="adafruit sensor 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_veml6075'], + py_modules=["adafruit_veml6075"], )