From 23a47ddf297bca870bec63c0e47f73ded076096d Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 9 Mar 2020 20:18:30 -0400 Subject: [PATCH 1/2] Ran black, updated to pylint 2.x --- .github/workflows/build.yml | 2 +- adafruit_debug_i2c.py | 29 ++++++++-- docs/conf.py | 112 +++++++++++++++++++++--------------- 3 files changed, 90 insertions(+), 53 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index fff3aa9..97fe64d 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 pylint black==19.10b0 Sphinx sphinx-rtd-theme - name: Library version run: git describe --dirty --always --tags - name: PyLint diff --git a/adafruit_debug_i2c.py b/adafruit_debug_i2c.py index e07f4a9..4b1e22f 100644 --- a/adafruit_debug_i2c.py +++ b/adafruit_debug_i2c.py @@ -41,6 +41,7 @@ __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Debug_I2C.git" + class DebugI2C: """ Wrapper library for debugging I2C. @@ -72,9 +73,10 @@ class DebugI2C: print(accelerometer.acceleration) """ + def __init__(self, i2c): self._i2c = i2c - if hasattr(self._i2c, 'writeto_then_readfrom'): + if hasattr(self._i2c, "writeto_then_readfrom"): self.writeto_then_readfrom = self._writeto_then_readfrom def __enter__(self): @@ -151,8 +153,17 @@ def writeto(self, address, buffer, *args, **kwargs): out_buffer_str = ", ".join([hex(i) for i in buffer]) print("\tI2CWRITE @ {} ::".format(hex(address)), out_buffer_str) - def _writeto_then_readfrom(self, address, buffer_out, buffer_in, *args, out_start=0, - out_end=None, in_start=0, in_end=None): + def _writeto_then_readfrom( + self, + address, + buffer_out, + buffer_in, + *args, + out_start=0, + out_end=None, + in_start=0, + in_end=None + ): """ Debug version of ``write_readinto`` that prints the ``buffer_out`` before writing and the ``buffer_in`` after reading. @@ -173,8 +184,16 @@ def _writeto_then_readfrom(self, address, buffer_out, buffer_in, *args, out_star out_buffer_str = ", ".join([hex(i) for i in buffer_out[out_start:out_end]]) print("\tI2CWRITE @ {} ::".format(hex(address)), out_buffer_str) - self._i2c.writeto_then_readfrom(address, buffer_out, buffer_in, *args, out_start=out_start, - out_end=out_end, in_start=in_start, in_end=in_end) + self._i2c.writeto_then_readfrom( + address, + buffer_out, + buffer_in, + *args, + out_start=out_start, + out_end=out_end, + in_start=in_start, + in_end=in_end, + ) in_buffer_str = ", ".join([hex(i) for i in buffer_in[in_start:in_end]]) print("\tI2CREAD @ {} ::".format(hex(address)), in_buffer_str) diff --git a/docs/conf.py b/docs/conf.py index 02eaf87..4e64836 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 Debug_I2C Library' -copyright = u'2019 Kattni Rembor' -author = u'Kattni Rembor' +project = "Adafruit Debug_I2C Library" +copyright = "2019 Kattni Rembor" +author = "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 = "1.0" # The full version, including alpha/beta/rc tags. -release = u'1.0' +release = "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 = 'AdafruitDebug_i2cLibrarydoc' +htmlhelp_basename = "AdafruitDebug_i2cLibrarydoc" # -- 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, 'AdafruitDebug_I2CLibrary.tex', u'AdafruitDebug_I2C Library Documentation', - author, 'manual'), + ( + master_doc, + "AdafruitDebug_I2CLibrary.tex", + "AdafruitDebug_I2C 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, 'AdafruitDebug_I2Clibrary', u'Adafruit Debug_I2C Library Documentation', - [author], 1) + ( + master_doc, + "AdafruitDebug_I2Clibrary", + "Adafruit Debug_I2C 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, 'AdafruitDebug_I2CLibrary', u'Adafruit Debug_I2C Library Documentation', - author, 'AdafruitDebug_I2CLibrary', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "AdafruitDebug_I2CLibrary", + "Adafruit Debug_I2C Library Documentation", + author, + "AdafruitDebug_I2CLibrary", + "One line description of project.", + "Miscellaneous", + ), ] From 3f6fc0831f7df93f951602b4ad8f3bf3546b0df4 Mon Sep 17 00:00:00 2001 From: dherrada Date: Tue, 10 Mar 2020 13:46:13 -0400 Subject: [PATCH 2/2] Re-added --force-reinstall --- .github/workflows/build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 97fe64d..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 pylint 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