From b0375e401634096552f68e1655fd00e97dbcd71a Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 9 Mar 2020 20:11:51 -0400 Subject: [PATCH 1/2] Ran black, updated to pylint 2.x --- .github/workflows/build.yml | 2 +- adafruit_itertools/adafruit_itertools.py | 17 +-- .../adafruit_itertools_extras.py | 9 +- docs/conf.py | 112 ++++++++++-------- 4 files changed, 80 insertions(+), 60 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_itertools/adafruit_itertools.py b/adafruit_itertools/adafruit_itertools.py index 601fd62..976833d 100644 --- a/adafruit_itertools/adafruit_itertools.py +++ b/adafruit_itertools/adafruit_itertools.py @@ -59,8 +59,8 @@ * Adafruit CircuitPython firmware for the supported boards: https://github.com/adafruit/circuitpython/releases """ -#pylint:disable=invalid-name,redefined-builtin,attribute-defined-outside-init -#pylint:disable=stop-iteration-return,anomalous-backslash-in-string +# pylint:disable=invalid-name,redefined-builtin,attribute-defined-outside-init +# pylint:disable=stop-iteration-return,anomalous-backslash-in-string __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Itertools.git" @@ -146,8 +146,8 @@ def combinations(iterable, r): else: return indices[index] += 1 - for j in range(index+1, r): - indices[j] = indices[j-1] + 1 + for j in range(index + 1, r): + indices[j] = indices[j - 1] + 1 yield tuple(pool[i] for i in indices) @@ -296,6 +296,7 @@ class groupby: :param key: the key computation function (default is None) """ + # [k for k, g in groupby('AAAABBBCCDAABBB')] --> A B C D A B # [list(g) for k, g in groupby('AAAABBBCCD')] --> AAAA BBB CC D @@ -312,7 +313,7 @@ def __iter__(self): def __next__(self): self.id = object() while self.currkey == self.tgtkey: - self.currvalue = next(self.it) # Exit on StopIteration + self.currvalue = next(self.it) # Exit on StopIteration self.currkey = self.keyfunc(self.currvalue) self.tgtkey = self.currkey return (self.currkey, self._grouper(self.tgtkey, self.id)) @@ -397,13 +398,13 @@ def permutations(iterable, r=None): if r > n: return indices = list(range(n)) - cycles = list(range(n, n-r, -1)) + cycles = list(range(n, n - r, -1)) yield tuple(pool[i] for i in indices[:r]) while n: for i in reversed(range(r)): cycles[i] -= 1 if cycles[i] == 0: - indices[i:] = indices[i+1:] + indices[i:i+1] + indices[i:] = indices[i + 1 :] + indices[i : i + 1] cycles[i] = n - i else: j = cycles[i] @@ -440,7 +441,7 @@ def product(*args, r=1): pools = [tuple(pool) for pool in args] * r result = [[]] for pool in pools: - result = [x+[y] for x in result for y in pool] + result = [x + [y] for x in result for y in pool] for prod in result: yield tuple(prod) diff --git a/adafruit_itertools/adafruit_itertools_extras.py b/adafruit_itertools/adafruit_itertools_extras.py index 460475a..e4b2529 100644 --- a/adafruit_itertools/adafruit_itertools_extras.py +++ b/adafruit_itertools/adafruit_itertools_extras.py @@ -74,7 +74,7 @@ https://github.com/adafruit/circuitpython/releases """ -#pylint:disable=invalid-name,deprecated-lambda,keyword-arg-before-vararg,relative-beyond-top-level +# pylint:disable=invalid-name,keyword-arg-before-vararg,relative-beyond-top-level from . import adafruit_itertools as it @@ -89,9 +89,9 @@ def all_equal(iterable): """ g = it.groupby(iterable) - next(g) # should succeed, value isn't relevant + next(g) # should succeed, value isn't relevant try: - next(g) # should fail: only 1 group + next(g) # should fail: only 1 group return False except StopIteration: return True @@ -198,10 +198,11 @@ def nth(iterable, n, default=None): """ try: - return next(it.islice(iterable, n, n+1)) + return next(it.islice(iterable, n, n + 1)) except StopIteration: return default + def padnone(iterable): """Returns the sequence elements and then returns None indefinitely. diff --git a/docs/conf.py b/docs/conf.py index 582c6c9..71a8606 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,35 +11,38 @@ # 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", ] -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 itertools Library' -copyright = u'2019 Dave Astels' -author = u'Dave Astels' +project = "Adafruit itertools Library" +copyright = "2019 Dave Astels" +author = "Dave Astels" # 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. @@ -50,7 +54,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. @@ -62,7 +66,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 @@ -77,59 +81,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 = 'AdafruitItertoolsLibrarydoc' +htmlhelp_basename = "AdafruitItertoolsLibrarydoc" # -- 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, 'AdafruititertoolsLibrary.tex', u'Adafruititertools Library Documentation', - author, 'manual'), + ( + master_doc, + "AdafruititertoolsLibrary.tex", + "Adafruititertools Library Documentation", + author, + "manual", + ), ] # -- Options for manual page output --------------------------------------- @@ -137,8 +144,13 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'Adafruititertoolslibrary', u'Adafruit itertools Library Documentation', - [author], 1) + ( + master_doc, + "Adafruititertoolslibrary", + "Adafruit itertools Library Documentation", + [author], + 1, + ) ] # -- Options for Texinfo output ------------------------------------------- @@ -147,7 +159,13 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'AdafruititertoolsLibrary', u'Adafruit itertools Library Documentation', - author, 'AdafruititertoolsLibrary', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "AdafruititertoolsLibrary", + "Adafruit itertools Library Documentation", + author, + "AdafruititertoolsLibrary", + "One line description of project.", + "Miscellaneous", + ), ] From 113bfd473f0e213ce7e16c843ed7273ff604d5b9 Mon Sep 17 00:00:00 2001 From: dherrada Date: Tue, 10 Mar 2020 13:47:46 -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