Skip to content

Add type annotations #23

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 2 commits into from
Feb 23, 2022
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 .pylintrc
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ confidence=
# no Warning level messages displayed, use"--disable=all --enable=classes
# --disable=W"
# disable=import-error,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call
disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,bad-continuation,unspecified-encoding
disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,bad-continuation,unspecified-encoding,duplicate-code

# Enable the message, report, category or checker with the given id(s). You can
# either give multiple identifier separated by comma (,) or put this option
Expand Down
31 changes: 28 additions & 3 deletions adafruit_gizmo/eink_gizmo.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,28 @@
from adafruit_il0373 import IL0373
from adafruit_ssd1681 import SSD1681

try:
from typing import Optional
from busio import SPI
from microcontroller import Pin
except ImportError:
pass

# pylint: disable=invalid-name, too-few-public-methods
class EInk_Gizmo(IL0373):
"""Class representing a 152x152 Tri-Color EInk Gizmo."""
"""Class representing a 152x152 Tri-Color EInk Gizmo.

:param"""

def __init__(self, *, spi=None, cs=None, dc=None, reset=None, busy=None):
def __init__(
self,
*,
spi: Optional[SPI] = None,
cs: Optional[Pin] = None,
dc: Optional[Pin] = None,
reset: Optional[Pin] = None,
busy: Optional[Pin] = None
) -> None:
displayio.release_displays()
if spi is None:
import busio # pylint: disable=import-outside-toplevel
Expand Down Expand Up @@ -55,7 +72,15 @@ def __init__(self, *, spi=None, cs=None, dc=None, reset=None, busy=None):
class EInk_HD_Gizmo(SSD1681):
"""Class representing a 200x200 Tri-Color EInk HD Gizmo."""

def __init__(self, *, spi=None, cs=None, dc=None, reset=None, busy=None):
def __init__(
self,
*,
spi: Optional[SPI] = None,
cs: Optional[Pin] = None,
dc: Optional[Pin] = None,
reset: Optional[Pin] = None,
busy: Optional[Pin] = None
) -> None:
displayio.release_displays()
if spi is None:
import busio # pylint: disable=import-outside-toplevel
Expand Down
17 changes: 15 additions & 2 deletions adafruit_gizmo/tft_gizmo.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,26 @@
import displayio
from adafruit_st7789 import ST7789

try:
from typing import Optional
from busio import SPI
from microcontroller import Pin
except ImportError:
pass

# pylint: disable=invalid-name, too-few-public-methods
class TFT_Gizmo(ST7789):
"""Class representing a TFT Gizmo."""

def __init__(
self, *, spi=None, cs=board.RX, dc=board.TX, backlight=board.A3, rotation=180
):
self,
*,
spi: Optional[SPI] = None,
cs: Pin = board.RX,
dc: Pin = board.TX,
backlight: Pin = board.A3,
rotation: int = 180
) -> None:
displayio.release_displays()
if spi is None:
import busio # pylint: disable=import-outside-toplevel
Expand Down