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__cpython.py b/adafruit__cpython.py index 2e91d51..99b51b7 100644 --- a/adafruit__cpython.py +++ b/adafruit__cpython.py @@ -39,7 +39,7 @@ * Adafruit CircuitPython firmware for the supported boards: https://github.com/adafruit/circuitpython/releases - + .. todo:: Uncomment or remove the Bus Device and/or the Register library dependencies based on the library's use of either. # * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice diff --git a/colorsys.py b/colorsys.py index 1de6839..2d0faa6 100644 --- a/colorsys.py +++ b/colorsys.py @@ -7,37 +7,43 @@ # This implements a chopped down relevant version of the colorsys library # to add HLS and HSV to RGB support. Script altered to return RGB[0-255] -__all__ = ["hls_to_rgb","hsv_to_rgb"] +__all__ = ["hls_to_rgb", "hsv_to_rgb"] # Some floating point constants -ONE_THIRD = 1.0/3.0 -ONE_SIXTH = 1.0/6.0 -TWO_THIRD = 2.0/3.0 +ONE_THIRD = 1.0 / 3.0 +ONE_SIXTH = 1.0 / 6.0 +TWO_THIRD = 2.0 / 3.0 # HLS: Hue, Luminance, Saturation # H: position in the spectrum # L: color lightness # S: color saturation + def hls_to_rgb(h, l, s): if s == 0.0: return l, l, l if l <= 0.5: - m2 = l * (1.0+s) + m2 = l * (1.0 + s) else: - m2 = l+s-(l*s) - m1 = 2.0*l - m2 - return (int(_v(m1, m2, h+ONE_THIRD)*255), int(_v(m1, m2, h)*255), int(_v(m1, m2, h-ONE_THIRD)*255)) + m2 = l + s - (l * s) + m1 = 2.0 * l - m2 + return ( + int(_v(m1, m2, h + ONE_THIRD) * 255), + int(_v(m1, m2, h) * 255), + int(_v(m1, m2, h - ONE_THIRD) * 255), + ) + def _v(m1, m2, hue): hue = hue % 1.0 if hue < ONE_SIXTH: - return m1 + (m2-m1)*hue*6.0 + return m1 + (m2 - m1) * hue * 6.0 if hue < 0.5: return m2 if hue < TWO_THIRD: - return m1 + (m2-m1)*(TWO_THIRD-hue)*6.0 + return m1 + (m2 - m1) * (TWO_THIRD - hue) * 6.0 return m1 @@ -46,25 +52,26 @@ def _v(m1, m2, hue): # S: color saturation ("purity") # V: color brightness + def hsv_to_rgb(h, s, v): if s == 0.0: return v, v, v - i = int(h*6.0) # XXX assume int() truncates! - f = (h*6.0) - i - p = v*(1.0 - s) - q = v*(1.0 - s*f) - t = v*(1.0 - s*(1.0-f)) - i = i%6 + i = int(h * 6.0) # XXX assume int() truncates! + f = (h * 6.0) - i + p = v * (1.0 - s) + q = v * (1.0 - s * f) + t = v * (1.0 - s * (1.0 - f)) + i = i % 6 if i == 0: - return int(v * 255), int(t *255), int(p * 255) + return int(v * 255), int(t * 255), int(p * 255) if i == 1: - return int(q * 255), int(v *255), int(p * 255) + return int(q * 255), int(v * 255), int(p * 255) if i == 2: - return int(p * 255), int(v *255), int(t * 255) + return int(p * 255), int(v * 255), int(t * 255) if i == 3: - return int(p * 255), int(q *255), int(v * 255) + return int(p * 255), int(q * 255), int(v * 255) if i == 4: - return int(t * 255), int(p *255), int(v * 255) + return int(t * 255), int(p * 255), int(v * 255) if i == 5: - return int(v * 255), int(p *255), int(q * 255) + return int(v * 255), int(p * 255), int(q * 255) # Cannot get here diff --git a/docs/conf.py b/docs/conf.py index fd16e22..ead45a6 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 @@ # 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,32 @@ # autodoc_mock_imports = ["digitalio", "busio"] -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_ CPython Library' -copyright = u'2017 Scott Shawcroft' -author = u'Scott Shawcroft' +project = u"Adafruit_ CPython 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. @@ -57,7 +61,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 +73,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 +88,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 = 'Adafruit_CpythonLibrarydoc' +htmlhelp_basename = "Adafruit_CpythonLibrarydoc" # -- 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, 'Adafruit_CPythonLibrary.tex', u'Adafruit_CPython Library Documentation', - author, 'manual'), + ( + master_doc, + "Adafruit_CPythonLibrary.tex", + u"Adafruit_CPython Library Documentation", + author, + "manual", + ), ] # -- Options for manual page output --------------------------------------- @@ -144,8 +151,13 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'Adafruit_CPythonlibrary', u'Adafruit_ CPython Library Documentation', - [author], 1) + ( + master_doc, + "Adafruit_CPythonlibrary", + u"Adafruit_ CPython Library Documentation", + [author], + 1, + ) ] # -- Options for Texinfo output ------------------------------------------- @@ -154,7 +166,13 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'Adafruit_CPythonLibrary', u'Adafruit_ CPython Library Documentation', - author, 'Adafruit_CPythonLibrary', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "Adafruit_CPythonLibrary", + u"Adafruit_ CPython Library Documentation", + author, + "Adafruit_CPythonLibrary", + "One line description of project.", + "Miscellaneous", + ), ]