Skip to content

Ran black, updated to pylint 2.x #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 17, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
33 changes: 24 additions & 9 deletions adafruit_slideshow.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@

class PlayBackOrder:
"""Defines possible slideshow playback orders."""

# pylint: disable=too-few-public-methods
ALPHABETICAL = 0
"""Orders by alphabetical sort of filenames"""
Expand All @@ -62,6 +63,7 @@ class PlayBackOrder:

class PlayBackDirection:
"""Defines possible slideshow playback directions."""

# pylint: disable=too-few-public-methods
BACKWARD = -1
"""The next image is before the current image. When alphabetically sorted, this is towards A."""
Expand Down Expand Up @@ -149,9 +151,19 @@ class SlideShow:
slideshow.brightness -= 0.001
"""

def __init__(self, display, backlight_pwm=None, *, folder="/", order=PlayBackOrder.ALPHABETICAL,
loop=True, dwell=3, fade_effect=True, auto_advance=True,
direction=PlayBackDirection.FORWARD):
def __init__(
self,
display,
backlight_pwm=None,
*,
folder="/",
order=PlayBackOrder.ALPHABETICAL,
loop=True,
dwell=3,
fade_effect=True,
auto_advance=True,
direction=PlayBackDirection.FORWARD
):
self.loop = loop
"""Specifies whether to loop through the images continuously or play through the list once.
``True`` will continue to loop, ``False`` will play only once."""
Expand All @@ -173,8 +185,11 @@ def __init__(self, display, backlight_pwm=None, *, folder="/", order=PlayBackOrd

# Load the image names before setting order so they can be reordered.
self._img_start = None
self._file_list = [folder+"/"+f for f in os.listdir(folder) if (f.endswith(".bmp")
and not f.startswith("."))]
self._file_list = [
folder + "/" + f
for f in os.listdir(folder)
if (f.endswith(".bmp") and not f.startswith("."))
]

self._order = None
self.order = order
Expand Down Expand Up @@ -314,11 +329,11 @@ def advance(self):
raise RuntimeError("No valid images")

try:
sprite = self._sprite_class(odb,
pixel_shader=displayio.ColorConverter())
sprite = self._sprite_class(odb, pixel_shader=displayio.ColorConverter())
except TypeError:
sprite = self._sprite_class(odb,
pixel_shader=displayio.ColorConverter(), position=(0, 0))
sprite = self._sprite_class(
odb, pixel_shader=displayio.ColorConverter(), position=(0, 0)
)
self._group.append(sprite)

self._fade_up()
Expand Down
120 changes: 73 additions & 47 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,19 @@

import os
import sys
sys.path.insert(0, os.path.abspath('..'))

sys.path.insert(0, os.path.abspath(".."))

# -- General configuration ------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be
# 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!
Expand All @@ -23,29 +24,40 @@
autodoc_mock_imports = ["displayio"]


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 Slideshow Library'
copyright = u'2018 Kattni Rembor'
author = u'Kattni Rembor'
project = u"Adafruit Slideshow Library"
copyright = u"2018 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.
Expand All @@ -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.
Expand All @@ -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
Expand All @@ -84,68 +96,76 @@
# 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 = 'AdafruitSlideshowLibrarydoc'
htmlhelp_basename = "AdafruitSlideshowLibrarydoc"

# -- 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, 'AdafruitSlideshowLibrary.tex', u'AdafruitSlideshow Library Documentation',
author, 'manual'),
(
master_doc,
"AdafruitSlideshowLibrary.tex",
u"AdafruitSlideshow Library Documentation",
author,
"manual",
),
]

# -- Options for manual page output ---------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'AdafruitSlideshowlibrary', u'Adafruit Slideshow Library Documentation',
[author], 1)
(
master_doc,
"AdafruitSlideshowlibrary",
u"Adafruit Slideshow Library Documentation",
[author],
1,
)
]

# -- Options for Texinfo output -------------------------------------------
Expand All @@ -154,7 +174,13 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'AdafruitSlideshowLibrary', u'Adafruit Slideshow Library Documentation',
author, 'AdafruitSlideshowLibrary', 'One line description of project.',
'Miscellaneous'),
(
master_doc,
"AdafruitSlideshowLibrary",
u"Adafruit Slideshow Library Documentation",
author,
"AdafruitSlideshowLibrary",
"One line description of project.",
"Miscellaneous",
),
]
12 changes: 9 additions & 3 deletions examples/slideshow_simpletest.py
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
import board
import pulseio
from adafruit_slideshow import PlayBackOrder, SlideShow
#pylint: disable=no-member

# pylint: disable=no-member

# Create the slideshow object that plays through once alphabetically.
slideshow = SlideShow(board.DISPLAY, pulseio.PWMOut(board.TFT_BACKLIGHT), folder="/",
loop=False, order=PlayBackOrder.ALPHABETICAL)
slideshow = SlideShow(
board.DISPLAY,
pulseio.PWMOut(board.TFT_BACKLIGHT),
folder="/",
loop=False,
order=PlayBackOrder.ALPHABETICAL,
)

while slideshow.update():
pass
3 changes: 1 addition & 2 deletions examples/slideshow_tft_gizmo.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,7 @@
back_button = digitalio.DigitalInOut(board.BUTTON_B)
back_button.switch_to_input(pull=digitalio.Pull.DOWN)

slideshow = SlideShow(display, None, folder="/",
auto_advance=False, dwell=0)
slideshow = SlideShow(display, None, folder="/", auto_advance=False, dwell=0)

while True:
if forward_button.value:
Expand Down
12 changes: 9 additions & 3 deletions examples/slideshow_touch.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,22 @@
import pulseio
import touchio
from adafruit_slideshow import SlideShow, PlayBackDirection
#pylint: disable=no-member

# pylint: disable=no-member

forward_button = touchio.TouchIn(board.TOUCH4)
back_button = touchio.TouchIn(board.TOUCH1)

brightness_up = touchio.TouchIn(board.TOUCH3)
brightness_down = touchio.TouchIn(board.TOUCH2)

slideshow = SlideShow(board.DISPLAY, pulseio.PWMOut(board.TFT_BACKLIGHT), folder="/",
auto_advance=False, dwell=0)
slideshow = SlideShow(
board.DISPLAY,
pulseio.PWMOut(board.TFT_BACKLIGHT),
folder="/",
auto_advance=False,
dwell=0,
)

while True:
if forward_button.value:
Expand Down
Loading