From 8bc9333abf9aa30eb9cd666911017ebb823ad877 Mon Sep 17 00:00:00 2001 From: dherrada Date: Sun, 15 Mar 2020 15:04:42 -0400 Subject: [PATCH] Ran black, updated to pylint 2.x --- .github/workflows/build.yml | 2 +- adafruit_vcnl4040.py | 31 ++++---- docs/conf.py | 130 ++++++++++++++++++++------------ examples/vcnl4040_simpletest.py | 2 +- setup.py | 56 ++++++-------- 5 files changed, 121 insertions(+), 100 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_vcnl4040.py b/adafruit_vcnl4040.py index bd7047c..f6d6b64 100644 --- a/adafruit_vcnl4040.py +++ b/adafruit_vcnl4040.py @@ -61,6 +61,7 @@ class VCNL4040: # pylint: disable=too-few-public-methods :param busio.I2C i2c_bus: The I2C bus the VCNL4040 is connected to. """ + # Ambient light sensor integration times ALS_80MS = const(0x0) ALS_160MS = const(0x1) @@ -169,7 +170,6 @@ def proximity_low_interrupt(self): proximity drops below low threshold.""" return self._get_and_clear_cached_interrupt_state(self.PS_IF_AWAY) - led_current = RWBits(3, 0x04, 8, register_width=2) """LED current selection setting, in mA. Options are LED_50MA, LED_75MA, LED_100MA, LED_120MA, LED_140MA, LED_160MA, LED_180MA, LED_200MA.""" @@ -205,14 +205,14 @@ def lux(self): print("Ambient light: %.2f lux"%sensor.lux) time.sleep(0.1) """ - return self.light * (0.1 /(1 << self.light_integration_time)) - + return self.light * (0.1 / (1 << self.light_integration_time)) # ALS_CONF - ALS integration time, persistence, interrupt, function enable/disable light_shutdown = RWBit(0x00, 0, register_width=2) """Ambient light sensor shutdown. When ``True``, ambient light data is disabled.""" _light_integration_time = RWBits(2, 0x00, 6, register_width=2) + @property def light_integration_time(self): """Ambient light sensor integration time setting. Longer time has higher sensitivity. @@ -240,16 +240,16 @@ def light_integration_time(self): @light_integration_time.setter def light_integration_time(self, new_it): - from time import sleep + from time import sleep # pylint: disable=import-outside-toplevel + # IT values are in 0-3 -> 80-640ms - old_it_ms = ((8<< self._light_integration_time)*10) - new_it_ms = ((8<< new_it)*10) + old_it_ms = (8 << self._light_integration_time) * 10 + new_it_ms = (8 << new_it) * 10 it_delay_seconds = (old_it_ms + new_it_ms + 1) * 0.001 self._light_integration_time = new_it sleep(it_delay_seconds) - light_interrupt = RWBit(0x00, 1, register_width=2) """Ambient light sensor interrupt enable. ``True`` to enable, and ``False`` to disable.""" @@ -271,10 +271,9 @@ def light_low_interrupt(self): """Low interrupt event. Triggered when ambient light value drops below low threshold.""" return self._get_and_clear_cached_interrupt_state(self.ALS_IF_L) - _raw_white = ROUnaryStruct(0x0A, " 0) + new_state = new_interrupt_state & (1 << interrupt) > 0 if new_state: self.cached_interrupt_state[interrupt] = new_state diff --git a/docs/conf.py b/docs/conf.py index 7e74018..7227bd9 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,43 +11,60 @@ # 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 = ["adafruit_register.i2c_struct", "adafruit_register.i2c_bits", - "adafruit_register.i2c_bit", "micropython", "adafruit_bus_device", "adafruit_register"] +autodoc_mock_imports = [ + "adafruit_register.i2c_struct", + "adafruit_register.i2c_bits", + "adafruit_register.i2c_bit", + "micropython", + "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"] -source_suffix = '.rst' +source_suffix = ".rst" # The master toctree document. -master_doc = 'index' +master_doc = "index" # General information about the project. -project = u'Adafruit VCNL4040 Library' -copyright = u'2019 Kattni Rembor' -author = u'Kattni Rembor' +project = u"Adafruit VCNL4040 Library" +copyright = u"2019 Kattni Rembor" +author = u"Kattni Rembor" # 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. @@ -58,7 +76,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. @@ -70,7 +88,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 @@ -85,59 +103,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 = 'AdafruitVcnl4040Librarydoc' +htmlhelp_basename = "AdafruitVcnl4040Librarydoc" # -- 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, 'AdafruitVCNL4040Library.tex', u'AdafruitVCNL4040 Library Documentation', - author, 'manual'), + ( + master_doc, + "AdafruitVCNL4040Library.tex", + u"AdafruitVCNL4040 Library Documentation", + author, + "manual", + ), ] # -- Options for manual page output --------------------------------------- @@ -145,8 +166,13 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'AdafruitVCNL4040library', u'Adafruit VCNL4040 Library Documentation', - [author], 1) + ( + master_doc, + "AdafruitVCNL4040library", + u"Adafruit VCNL4040 Library Documentation", + [author], + 1, + ) ] # -- Options for Texinfo output ------------------------------------------- @@ -155,7 +181,13 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'AdafruitVCNL4040Library', u'Adafruit VCNL4040 Library Documentation', - author, 'AdafruitVCNL4040Library', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "AdafruitVCNL4040Library", + u"Adafruit VCNL4040 Library Documentation", + author, + "AdafruitVCNL4040Library", + "One line description of project.", + "Miscellaneous", + ), ] diff --git a/examples/vcnl4040_simpletest.py b/examples/vcnl4040_simpletest.py index 435b004..f554637 100644 --- a/examples/vcnl4040_simpletest.py +++ b/examples/vcnl4040_simpletest.py @@ -8,5 +8,5 @@ while True: print("Proximity:", sensor.proximity) - print("Light: %d lux"% sensor.lux) + print("Light: %d lux" % sensor.lux) time.sleep(1.0) diff --git a/setup.py b/setup.py index 28e5d16..6f82208 100644 --- a/setup.py +++ b/setup.py @@ -6,6 +6,7 @@ """ from setuptools import setup, find_packages + # To use a consistent encoding from codecs import open from os import path @@ -13,54 +14,45 @@ 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-vcnl4040', - + name="adafruit-circuitpython-vcnl4040", use_scm_version=True, - setup_requires=['setuptools_scm'], - - description='A CircuitPython library for the VCNL4040 proximity and ambient light sensor.', + setup_requires=["setuptools_scm"], + description="A CircuitPython library for the VCNL4040 proximity and ambient light 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_VCNL4040', - + url="https://github.com/adafruit/Adafruit_CircuitPython_VCNL4040", # Author details - author='Adafruit Industries', - author_email='circuitpython@adafruit.com', - + author="Adafruit Industries", + author_email="circuitpython@adafruit.com", install_requires=[ - 'Adafruit-Blinka', - 'adafruit-circuitpython-busdevice', - 'adafruit-circuitpython-register' + "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 blinka circuitpython micropython vcnl4040 ambient light proximity ir ' - 'sensor hardware', - + keywords="adafruit blinka circuitpython micropython vcnl4040 ambient light proximity ir " + "sensor hardware", # You can just specify the packages manually here if your project is # simple. Or you can use find_packages(). # TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER, # CHANGE `py_modules=['...']` TO `packages=['...']` - py_modules=['adafruit_vcnl4040'], + py_modules=["adafruit_vcnl4040"], )