From 2aee4364adce035843b1d619de14579a7cb04fcc Mon Sep 17 00:00:00 2001 From: foamyguy Date: Wed, 14 May 2025 15:52:25 +0000 Subject: [PATCH] change to ruff --- .gitattributes | 11 + .pre-commit-config.yaml | 43 +-- .pylintrc | 399 ------------------------- README.rst | 6 +- adafruit_fona/adafruit_fona.py | 143 +++------ adafruit_fona/adafruit_fona_network.py | 22 +- adafruit_fona/adafruit_fona_socket.py | 23 +- adafruit_fona/fona_3g.py | 52 +--- docs/api.rst | 3 + docs/conf.py | 8 +- examples/fona_aio_post.py | 13 +- examples/fona_cheerlights.py | 15 +- examples/fona_simpletest.py | 13 +- examples/fona_sms.py | 5 +- examples/fona_sms_response.py | 5 +- ruff.toml | 108 +++++++ 16 files changed, 242 insertions(+), 627 deletions(-) create mode 100644 .gitattributes delete mode 100644 .pylintrc create mode 100644 ruff.toml diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..21c125c --- /dev/null +++ b/.gitattributes @@ -0,0 +1,11 @@ +# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + +.py text eol=lf +.rst text eol=lf +.txt text eol=lf +.yaml text eol=lf +.toml text eol=lf +.license text eol=lf +.md text eol=lf diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 70ade69..ff19dde 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,42 +1,21 @@ -# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò +# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries # # SPDX-License-Identifier: Unlicense repos: - - repo: https://github.com/python/black - rev: 23.3.0 - hooks: - - id: black - - repo: https://github.com/fsfe/reuse-tool - rev: v1.1.2 - hooks: - - id: reuse - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.4.0 + rev: v4.5.0 hooks: - id: check-yaml - id: end-of-file-fixer - id: trailing-whitespace - - repo: https://github.com/pycqa/pylint - rev: v2.17.4 + - repo: https://github.com/astral-sh/ruff-pre-commit + rev: v0.3.4 hooks: - - id: pylint - name: pylint (library code) - types: [python] - args: - - --disable=consider-using-f-string - exclude: "^(docs/|examples/|tests/|setup.py$)" - - id: pylint - name: pylint (example code) - description: Run pylint rules on "examples/*.py" files - types: [python] - files: "^examples/" - args: - - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code - - id: pylint - name: pylint (test code) - description: Run pylint rules on "tests/*.py" files - types: [python] - files: "^tests/" - args: - - --disable=missing-docstring,consider-using-f-string,duplicate-code + - id: ruff-format + - id: ruff + args: ["--fix"] + - repo: https://github.com/fsfe/reuse-tool + rev: v3.0.1 + hooks: + - id: reuse diff --git a/.pylintrc b/.pylintrc deleted file mode 100644 index f945e92..0000000 --- a/.pylintrc +++ /dev/null @@ -1,399 +0,0 @@ -# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries -# -# SPDX-License-Identifier: Unlicense - -[MASTER] - -# A comma-separated list of package or module names from where C extensions may -# be loaded. Extensions are loading into the active Python interpreter and may -# run arbitrary code -extension-pkg-whitelist= - -# Add files or directories to the ignore-list. They should be base names, not -# paths. -ignore=CVS - -# Add files or directories matching the regex patterns to the ignore-list. The -# regex matches against base names, not paths. -ignore-patterns= - -# Python code to execute, usually for sys.path manipulation such as -# pygtk.require(). -#init-hook= - -# Use multiple processes to speed up Pylint. -jobs=1 - -# List of plugins (as comma separated values of python modules names) to load, -# usually to register additional checkers. -load-plugins=pylint.extensions.no_self_use - -# Pickle collected data for later comparisons. -persistent=yes - -# Specify a configuration file. -#rcfile= - -# Allow loading of arbitrary C extensions. Extensions are imported into the -# active Python interpreter and may run arbitrary code. -unsafe-load-any-extension=no - - -[MESSAGES CONTROL] - -# Only show warnings with the listed confidence levels. Leave empty to show -# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED -confidence= - -# Disable the message, report, category or checker with the given id(s). You -# can either give multiple identifiers separated by comma (,) or put this -# option multiple times (only on the command line, not in the configuration -# file where it should appear only once).You can also use "--disable=all" to -# disable everything first and then reenable specific checks. For example, if -# you want to run only the similarities checker, you can use "--disable=all -# --enable=similarities". If you want to run only the classes checker, but have -# no Warning level messages displayed, use"--disable=all --enable=classes -# --disable=W" -# disable=import-error,raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,deprecated-str-translate-call -disable=raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,import-error,pointless-string-statement,unspecified-encoding - -# 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 -# multiple time (only on the command line, not in the configuration file where -# it should appear only once). See also the "--disable" option for examples. -enable= - - -[REPORTS] - -# Python expression which should return a note less than 10 (10 is the highest -# note). You have access to the variables errors warning, statement which -# respectively contain the number of errors / warnings messages and the total -# number of statements analyzed. This is used by the global evaluation report -# (RP0004). -evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) - -# Template used to display messages. This is a python new-style format string -# used to format the message information. See doc for all details -#msg-template= - -# Set the output format. Available formats are text, parseable, colorized, json -# and msvs (visual studio).You can also give a reporter class, eg -# mypackage.mymodule.MyReporterClass. -output-format=text - -# Tells whether to display a full report or only the messages -reports=no - -# Activate the evaluation score. -score=yes - - -[REFACTORING] - -# Maximum number of nested blocks for function / method body -max-nested-blocks=5 - - -[LOGGING] - -# Logging modules to check that the string format arguments are in logging -# function parameter format -logging-modules=logging - - -[SPELLING] - -# Spelling dictionary name. Available dictionaries: none. To make it working -# install python-enchant package. -spelling-dict= - -# List of comma separated words that should not be checked. -spelling-ignore-words= - -# A path to a file that contains private dictionary; one word per line. -spelling-private-dict-file= - -# Tells whether to store unknown words to indicated private dictionary in -# --spelling-private-dict-file option instead of raising a message. -spelling-store-unknown-words=no - - -[MISCELLANEOUS] - -# List of note tags to take in consideration, separated by a comma. -# notes=FIXME,XXX,TODO -notes=FIXME,XXX - - -[TYPECHECK] - -# List of decorators that produce context managers, such as -# contextlib.contextmanager. Add to this list to register other decorators that -# produce valid context managers. -contextmanager-decorators=contextlib.contextmanager - -# List of members which are set dynamically and missed by pylint inference -# system, and so shouldn't trigger E1101 when accessed. Python regular -# expressions are accepted. -generated-members= - -# Tells whether missing members accessed in mixin class should be ignored. A -# mixin class is detected if its name ends with "mixin" (case insensitive). -ignore-mixin-members=yes - -# This flag controls whether pylint should warn about no-member and similar -# checks whenever an opaque object is returned when inferring. The inference -# can return multiple potential results while evaluating a Python object, but -# some branches might not be evaluated, which results in partial inference. In -# that case, it might be useful to still emit no-member and other checks for -# the rest of the inferred objects. -ignore-on-opaque-inference=yes - -# List of class names for which member attributes should not be checked (useful -# for classes with dynamically set attributes). This supports the use of -# qualified names. -ignored-classes=optparse.Values,thread._local,_thread._local - -# List of module names for which member attributes should not be checked -# (useful for modules/projects where namespaces are manipulated during runtime -# and thus existing member attributes cannot be deduced by static analysis. It -# supports qualified module names, as well as Unix pattern matching. -ignored-modules=board - -# Show a hint with possible names when a member name was not found. The aspect -# of finding the hint is based on edit distance. -missing-member-hint=yes - -# The minimum edit distance a name should have in order to be considered a -# similar match for a missing member name. -missing-member-hint-distance=1 - -# The total number of similar names that should be taken in consideration when -# showing a hint for a missing member. -missing-member-max-choices=1 - - -[VARIABLES] - -# List of additional names supposed to be defined in builtins. Remember that -# you should avoid to define new builtins when possible. -additional-builtins= - -# Tells whether unused global variables should be treated as a violation. -allow-global-unused-variables=yes - -# List of strings which can identify a callback function by name. A callback -# name must start or end with one of those strings. -callbacks=cb_,_cb - -# A regular expression matching the name of dummy variables (i.e. expectedly -# not used). -dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ - -# Argument names that match this expression will be ignored. Default to name -# with leading underscore -ignored-argument-names=_.*|^ignored_|^unused_ - -# Tells whether we should check for unused import in __init__ files. -init-import=no - -# List of qualified module names which can have objects that can redefine -# builtins. -redefining-builtins-modules=six.moves,future.builtins - - -[FORMAT] - -# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. -# expected-line-ending-format= -expected-line-ending-format=LF - -# Regexp for a line that is allowed to be longer than the limit. -ignore-long-lines=^\s*(# )??$ - -# Number of spaces of indent required inside a hanging or continued line. -indent-after-paren=4 - -# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 -# tab). -indent-string=' ' - -# Maximum number of characters on a single line. -max-line-length=100 - -# Maximum number of lines in a module -max-module-lines=1000 - -# Allow the body of a class to be on the same line as the declaration if body -# contains single statement. -single-line-class-stmt=no - -# Allow the body of an if to be on the same line as the test if there is no -# else. -single-line-if-stmt=no - - -[SIMILARITIES] - -# Ignore comments when computing similarities. -ignore-comments=yes - -# Ignore docstrings when computing similarities. -ignore-docstrings=yes - -# Ignore imports when computing similarities. -ignore-imports=yes - -# Minimum lines number of a similarity. -min-similarity-lines=12 - - -[BASIC] - -# Regular expression matching correct argument names -argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct attribute names -attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Bad variable names which should always be refused, separated by a comma -bad-names=foo,bar,baz,toto,tutu,tata - -# Regular expression matching correct class attribute names -class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ - -# Regular expression matching correct class names -# class-rgx=[A-Z_][a-zA-Z0-9]+$ -class-rgx=[A-Z_][a-zA-Z0-9_]+$ - -# Regular expression matching correct constant names -const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ - -# Minimum line length for functions/classes that require docstrings, shorter -# ones are exempt. -docstring-min-length=-1 - -# Regular expression matching correct function names -function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Good variable names which should always be accepted, separated by a comma -# good-names=i,j,k,ex,Run,_ -good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_ - -# Include a hint for the correct naming format with invalid-name -include-naming-hint=no - -# Regular expression matching correct inline iteration names -inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ - -# Regular expression matching correct method names -method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct module names -module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ - -# Colon-delimited sets of names that determine each other's naming style when -# the name regexes allow several styles. -name-group= - -# Regular expression which should only match function or class names that do -# not require a docstring. -no-docstring-rgx=^_ - -# List of decorators that produce properties, such as abc.abstractproperty. Add -# to this list to register other decorators that produce valid properties. -property-classes=abc.abstractproperty - -# Regular expression matching correct variable names -variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - - -[IMPORTS] - -# Allow wildcard imports from modules that define __all__. -allow-wildcard-with-all=no - -# Analyse import fallback blocks. This can be used to support both Python 2 and -# 3 compatible code, which means that the block might have code that exists -# only in one or another interpreter, leading to false positives when analysed. -analyse-fallback-blocks=no - -# Deprecated modules which should not be used, separated by a comma -deprecated-modules=optparse,tkinter.tix - -# Create a graph of external dependencies in the given file (report RP0402 must -# not be disabled) -ext-import-graph= - -# Create a graph of every (i.e. internal and external) dependencies in the -# given file (report RP0402 must not be disabled) -import-graph= - -# Create a graph of internal dependencies in the given file (report RP0402 must -# not be disabled) -int-import-graph= - -# Force import order to recognize a module as part of the standard -# compatibility libraries. -known-standard-library= - -# Force import order to recognize a module as part of a third party library. -known-third-party=enchant - - -[CLASSES] - -# List of method names used to declare (i.e. assign) instance attributes. -defining-attr-methods=__init__,__new__,setUp - -# List of member names, which should be excluded from the protected access -# warning. -exclude-protected=_asdict,_fields,_replace,_source,_make - -# List of valid names for the first argument in a class method. -valid-classmethod-first-arg=cls - -# List of valid names for the first argument in a metaclass class method. -valid-metaclass-classmethod-first-arg=mcs - - -[DESIGN] - -# Maximum number of arguments for function / method -max-args=5 - -# Maximum number of attributes for a class (see R0902). -# max-attributes=7 -max-attributes=11 - -# Maximum number of boolean expressions in a if statement -max-bool-expr=5 - -# Maximum number of branch for function / method body -max-branches=12 - -# Maximum number of locals for function / method body -max-locals=15 - -# Maximum number of parents for a class (see R0901). -max-parents=7 - -# Maximum number of public methods for a class (see R0904). -max-public-methods=20 - -# Maximum number of return / yield for function / method body -max-returns=6 - -# Maximum number of statements in function / method body -max-statements=50 - -# Minimum number of public methods for a class (see R0903). -min-public-methods=1 - - -[EXCEPTIONS] - -# Exceptions that will emit a warning when being caught. Defaults to -# "Exception" -overgeneral-exceptions=builtins.Exception diff --git a/README.rst b/README.rst index 79d502f..8b7f415 100644 --- a/README.rst +++ b/README.rst @@ -13,9 +13,9 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_FONA/actions :alt: Build Status -.. image:: https://img.shields.io/badge/code%20style-black-000000.svg - :target: https://github.com/psf/black - :alt: Code Style: Black +.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json + :target: https://github.com/astral-sh/ruff + :alt: Code Style: Ruff CircuitPython library for the `Adafruit FONA `_ cellular module. diff --git a/adafruit_fona/adafruit_fona.py b/adafruit_fona/adafruit_fona.py index 1f244c7..c69c691 100644 --- a/adafruit_fona/adafruit_fona.py +++ b/adafruit_fona/adafruit_fona.py @@ -3,8 +3,6 @@ # # SPDX-License-Identifier: MIT -# pylint: disable=too-many-lines - """ `adafruit_fona` ================================================================================ @@ -22,14 +20,17 @@ https://github.com/adafruit/circuitpython/releases """ + import time + from micropython import const from simpleio import map_range try: from typing import Optional, Tuple, Union - from circuitpython_typing import ReadableBuffer + from busio import UART + from circuitpython_typing import ReadableBuffer from digitalio import DigitalInOut try: @@ -67,7 +68,6 @@ FONA_SMS_STORAGE_INTERNAL = b'"ME"' # Internal storage on the FONA -# pylint: disable=too-many-instance-attributes, too-many-public-methods class FONA: """CircuitPython FONA module interface. @@ -80,12 +80,11 @@ class FONA: TCP_MODE = const(0) # TCP socket UDP_MODE = const(1) # UDP socket - # pylint: disable=too-many-arguments def __init__( self, uart: UART, rst: DigitalInOut, - ri: Optional[DigitalInOut] = None, # pylint: disable=invalid-name + ri: Optional[DigitalInOut] = None, debug: bool = False, ) -> None: self._buf = b"" # shared buffer @@ -100,7 +99,6 @@ def __init__( if not self._init_fona(): raise RuntimeError("Unable to find FONA. Please check connections.") - # pylint: disable=too-many-branches, too-many-statements def _init_fona(self) -> bool: """Initializes FONA module.""" self.reset() @@ -184,7 +182,6 @@ def reset(self) -> None: self._rst.value = True @property - # pylint: disable=too-many-return-statements def version(self) -> int: """The version of the FONA module. Can be FONA_800_L, FONA_800_H, FONA_808_V1, FONA_808_V2, FONA_3G_A, FONA3G_E. @@ -233,7 +230,6 @@ def gprs(self) -> bool: return False return True - # pylint: disable=too-many-return-statements def set_gprs( self, apn: Optional[Tuple[str, Optional[str], Optional[str]]] = None, @@ -257,9 +253,7 @@ def set_gprs( return False # disconnect all sockets - if not self._send_check_reply( - b"AT+CIPSHUT", reply=b"SHUT OK", timeout=20000 - ): + if not self._send_check_reply(b"AT+CIPSHUT", reply=b"SHUT OK", timeout=20000): return False if not self._send_check_reply(b"AT+CGATT=1", reply=REPLY_OK, timeout=10000): @@ -305,9 +299,7 @@ def set_gprs( return False # Open GPRS context - if not self._send_check_reply( - b"AT+SAPBR=1,1", reply=REPLY_OK, timeout=1850 - ): + if not self._send_check_reply(b"AT+SAPBR=1,1", reply=REPLY_OK, timeout=1850): return False # Bring up wireless connection @@ -316,12 +308,8 @@ def set_gprs( if not self.local_ip: return False - else: - # reset PDP state - if not self._send_check_reply( - b"AT+CIPSHUT", reply=b"SHUT OK", timeout=20000 - ): - return False + elif not self._send_check_reply(b"AT+CIPSHUT", reply=b"SHUT OK", timeout=20000): + return False return True @@ -381,14 +369,12 @@ def gps(self) -> int: status = 3 # assume 3D fix self._read_line() else: - raise NotImplementedError( - "FONA 808 v1 not currently supported by this library." - ) + raise NotImplementedError("FONA 808 v1 not currently supported by this library.") return status @gps.setter def gps(self, gps_on: bool = False) -> bool: - if self._fona_type not in (FONA_3G_A, FONA_3G_E, FONA_808_V1, FONA_808_V2): + if self._fona_type not in {FONA_3G_A, FONA_3G_E, FONA_808_V1, FONA_808_V2}: raise TypeError("GPS unsupported for this FONA module.") # check if already enabled or disabled @@ -406,27 +392,21 @@ def gps(self, gps_on: bool = False) -> bool: if self._fona_type == FONA_808_V2: # try GNS if not self._send_check_reply(b"AT+CGNSPWR=1", reply=REPLY_OK): return False - else: - if not self._send_parse_reply(b"AT+CGPSPWR=1", reply_data=REPLY_OK): - return False - else: - if self._fona_type == FONA_808_V2: # try GNS - if not self._send_check_reply(b"AT+CGNSPWR=0", reply=REPLY_OK): - return False - if not self._send_check_reply(b"AT+CGPSPWR=0", reply=REPLY_OK): - return False + elif not self._send_parse_reply(b"AT+CGPSPWR=1", reply_data=REPLY_OK): + return False + elif self._fona_type == FONA_808_V2: # try GNS + if not self._send_check_reply(b"AT+CGNSPWR=0", reply=REPLY_OK): + return False + if not self._send_check_reply(b"AT+CGPSPWR=0", reply=REPLY_OK): + return False return True - def pretty_ip( # pylint: disable=no-self-use, invalid-name - self, ip: ReadableBuffer - ) -> str: + def pretty_ip(self, ip: ReadableBuffer) -> str: """Converts a bytearray IP address to a dotted-quad string for printing""" return "%d.%d.%d.%d" % (ip[0], ip[1], ip[2], ip[3]) - def unpretty_ip( # pylint: disable=no-self-use, invalid-name - self, ip: str - ) -> bytes: + def unpretty_ip(self, ip: str) -> bytes: """Converts a dotted-quad string to a bytearray IP address""" octets = [int(x) for x in ip.split(".")] return bytes(octets) @@ -445,9 +425,8 @@ def enable_sms_notification(self, enable: bool = True) -> bool: if enable: if not self._send_check_reply(b"AT+CNMI=2,1\r\n", reply=REPLY_OK): return False - else: - if not self._send_check_reply(b"AT+CNMI=2,0\r\n", reply=REPLY_OK): - return False + elif not self._send_check_reply(b"AT+CNMI=2,0\r\n", reply=REPLY_OK): + return False return True def receive_sms(self) -> Tuple[str, str]: @@ -498,7 +477,7 @@ def send_sms(self, phone_number: int, message: str) -> bool: # write out message and ^z self._uart_write((message + chr(26)).encode()) - if self._fona_type in (FONA_3G_A, FONA_3G_E): + if self._fona_type in {FONA_3G_A, FONA_3G_E}: self._read_line(200) # eat first 'CRLF' self._read_line(200) # eat second 'CRLF' @@ -522,11 +501,8 @@ def num_sms(self, sim_storage: bool = True) -> int: if sim_storage: # ask how many SMS are stored if self._send_parse_reply(b"AT+CPMS?", FONA_SMS_STORAGE_SIM + b",", idx=1): return self._buf - else: - if self._send_parse_reply( - b"AT+CPMS?", FONA_SMS_STORAGE_INTERNAL + b",", idx=1 - ): - return self._buf + elif self._send_parse_reply(b"AT+CPMS?", FONA_SMS_STORAGE_INTERNAL + b",", idx=1): + return self._buf self._read_line() # eat OK if self._send_parse_reply(b"AT+CPMS?", b'"SM",', idx=1): @@ -545,9 +521,7 @@ def delete_sms(self, sms_slot: int) -> bool: if not self._send_check_reply(b"AT+CMGF=1", reply=REPLY_OK): return False - if not self._send_check_reply( - b"AT+CMGD=" + str(sms_slot).encode(), reply=REPLY_OK - ): + if not self._send_check_reply(b"AT+CMGD=" + str(sms_slot).encode(), reply=REPLY_OK): return False return True @@ -558,16 +532,13 @@ def delete_all_sms(self) -> bool: if not self._send_check_reply(b"AT+CMGF=1", reply=REPLY_OK): return False - if self._fona_type in (FONA_3G_A, FONA_3G_E): + if self._fona_type in {FONA_3G_A, FONA_3G_E}: num_sms = self.num_sms() for slot in range(0, num_sms): if not self.delete_sms(slot): return False - else: # DEL ALL on 808 - if not self._send_check_reply( - b'AT+CMGDA="DEL ALL"', reply=REPLY_OK, timeout=25000 - ): - return False + elif not self._send_check_reply(b'AT+CMGDA="DEL ALL"', reply=REPLY_OK, timeout=25000): + return False return True def read_sms(self, sms_slot: int) -> Tuple[str, str]: @@ -617,9 +588,7 @@ def get_host_by_name(self, hostname: str) -> Union[str, Literal[False]]: if isinstance(hostname, str): hostname = bytes(hostname, "utf-8") - if not self._send_check_reply( - b'AT+CDNSGIP="' + hostname + b'"\r\n', reply=REPLY_OK - ): + if not self._send_check_reply(b'AT+CDNSGIP="' + hostname + b'"\r\n', reply=REPLY_OK): return False self._read_line() @@ -655,9 +624,7 @@ def remote_ip(self, sock_num: int) -> str: :param int sock_num: Desired socket. """ - assert ( - sock_num < FONA_MAX_SOCKETS - ), "Provided socket exceeds the maximum number of \ + assert sock_num < FONA_MAX_SOCKETS, "Provided socket exceeds the maximum number of \ sockets for the FONA module." self._uart_write(b"AT+CIPSTATUS=" + str(sock_num).encode() + b"\r\n") self._read_line(100) @@ -670,9 +637,7 @@ def socket_status(self, sock_num: int) -> bool: :param int sock_num: Desired socket number. """ - assert ( - sock_num < FONA_MAX_SOCKETS - ), "Provided socket exceeds the maximum number of \ + assert sock_num < FONA_MAX_SOCKETS, "Provided socket exceeds the maximum number of \ sockets for the FONA module." if not self._send_check_reply(b"AT+CIPSTATUS", reply=REPLY_OK, timeout=100): return False @@ -700,9 +665,7 @@ def socket_available(self, sock_num: int) -> int: :param int sock_num: Desired socket to return bytes available from. """ - assert ( - sock_num < FONA_MAX_SOCKETS - ), "Provided socket exceeds the maximum number of \ + assert sock_num < FONA_MAX_SOCKETS, "Provided socket exceeds the maximum number of \ sockets for the FONA module." if not self._send_parse_reply( b"AT+CIPRXGET=4," + str(sock_num).encode(), @@ -711,7 +674,7 @@ def socket_available(self, sock_num: int) -> int: return False data = self._buf if self._debug: - print("\t {} bytes available.".format(self._buf)) + print(f"\t {self._buf} bytes available.") self._read_line() self._read_line() @@ -730,16 +693,10 @@ def socket_connect( :param int conn_mode: Connection mode (TCP/UDP) """ if self._debug: - print( - "*** Socket connect, protocol={}, port={}, ip={}".format( - conn_mode, port, dest - ) - ) + print(f"*** Socket connect, protocol={conn_mode}, port={port}, ip={dest}") self._uart.reset_input_buffer() - assert ( - sock_num < FONA_MAX_SOCKETS - ), "Provided socket exceeds the maximum number of \ + assert sock_num < FONA_MAX_SOCKETS, "Provided socket exceeds the maximum number of \ sockets for the FONA module." # Query local IP Address @@ -768,20 +725,17 @@ def socket_close(self, sock_num: int) -> bool: """ if self._debug: print("*** Closing socket #%d" % sock_num) - assert ( - sock_num < FONA_MAX_SOCKETS - ), "Provided socket exceeds the maximum number of \ + assert sock_num < FONA_MAX_SOCKETS, "Provided socket exceeds the maximum number of \ sockets for the FONA module." self._uart_write(b"AT+CIPCLOSE=" + str(sock_num).encode() + b"\r\n") self._read_line(3000) - if self._fona_type in (FONA_3G_A, FONA_3G_E): + if self._fona_type in {FONA_3G_A, FONA_3G_E}: if not self._expect_reply(REPLY_OK): return False - else: - if not self._expect_reply(b"CLOSE OK"): - return False + elif not self._expect_reply(b"CLOSE OK"): + return False return True def socket_read(self, sock_num: int, length: int) -> bytearray: @@ -792,9 +746,7 @@ def socket_read(self, sock_num: int, length: int) -> bytearray: :param int length: Desired length to read. """ self._read_line() - assert ( - sock_num < FONA_MAX_SOCKETS - ), "Provided socket exceeds the maximum number of \ + assert sock_num < FONA_MAX_SOCKETS, "Provided socket exceeds the maximum number of \ sockets for the FONA module." if self._debug: print("* socket read") @@ -816,9 +768,7 @@ def socket_write(self, sock_num: int, buffer: bytes, timeout: int = 3000) -> boo :param int timeout: Socket write timeout, in milliseconds. """ self._read_line() - assert ( - sock_num < FONA_MAX_SOCKETS - ), "Provided socket exceeds the maximum number of \ + assert sock_num < FONA_MAX_SOCKETS, "Provided socket exceeds the maximum number of \ sockets for the FONA module." self._uart.reset_input_buffer() @@ -971,9 +921,8 @@ def _send_check_reply( if send is None: if not self._get_reply(prefix=prefix, suffix=suffix, timeout=timeout): return False - else: - if not self._get_reply(send, timeout=timeout): - return False + elif not self._get_reply(send, timeout=timeout): + return False if not self._buf == reply: return False @@ -1002,9 +951,7 @@ def _send_check_reply_quoted( return False return True - def _get_reply_quoted( - self, prefix: bytes, suffix: bytes, timeout: int - ) -> Tuple[int, bytes]: + def _get_reply_quoted(self, prefix: bytes, suffix: bytes, timeout: int) -> Tuple[int, bytes]: """Send prefix, ", suffix, ", and newline. Returns: Response (and also fills buffer with response). diff --git a/adafruit_fona/adafruit_fona_network.py b/adafruit_fona/adafruit_fona_network.py index 5d71985..050e7c5 100755 --- a/adafruit_fona/adafruit_fona_network.py +++ b/adafruit_fona/adafruit_fona_network.py @@ -13,8 +13,9 @@ """ try: - from typing import Optional, Tuple, Type from types import TracebackType + from typing import Optional, Tuple, Type + from adafruit_fona.adafruit_fona import FONA except ImportError: pass @@ -35,9 +36,7 @@ class CELLULAR: and APN password. """ - def __init__( - self, fona: FONA, apn: Tuple[str, Optional[str], Optional[str]] - ) -> None: + def __init__(self, fona: FONA, apn: Tuple[str, Optional[str], Optional[str]]) -> None: self._iface = fona self._apn = apn self._network_connected = False @@ -47,10 +46,10 @@ def __init__( # These are numbers defined in adafruit_fona FONA versions # For some reason, we can't import them from the adafruit_fona file - if self._iface.version in (0x4, 0x5): + if self._iface.version in {0x4, 0x5}: self._network_type = NET_CDMA - if self._iface.version in (0x2, 0x3, 0x4, 0x5): + if self._iface.version in {0x2, 0x3, 0x4, 0x5}: self._iface.gps = True self._has_gps = True @@ -79,18 +78,13 @@ def iccid(self) -> str: def is_attached(self) -> bool: """Returns if the modem is attached to the network.""" if self._network_type == NET_GSM: - if ( - self._has_gps - and self._iface.gps == 3 - and self._iface.network_status == 1 - ): + if self._has_gps and self._iface.gps == 3 and self._iface.network_status == 1: return True if not self._has_gps and self._iface.network_status == 1: return True - else: # Attach CDMA network - if self._iface.ue_system_info == 1 and self._iface.network_status == 1: - return True + elif self._iface.ue_system_info == 1 and self._iface.network_status == 1: + return True return False @property diff --git a/adafruit_fona/adafruit_fona_socket.py b/adafruit_fona/adafruit_fona_socket.py index c20c518..2de6825 100644 --- a/adafruit_fona/adafruit_fona_socket.py +++ b/adafruit_fona/adafruit_fona_socket.py @@ -12,22 +12,25 @@ * Author(s): ladyada, Brent Rubell """ + import gc import time + from micropython import const try: - from typing import Optional, Tuple, Sequence + from typing import Optional, Sequence, Tuple + from adafruit_fona.adafruit_fona import FONA except ImportError: pass -_the_interface = None # pylint: disable=invalid-name +_the_interface = None def set_interface(iface: FONA) -> None: """Helper to set the global internet interface.""" - global _the_interface # pylint: disable=global-statement, invalid-name + global _the_interface _the_interface = iface @@ -56,7 +59,6 @@ def htons(x: int) -> int: SOCKETS = [] -# pylint: disable=too-many-arguments, unused-argument def getaddrinfo(host, port: int, family=0, socktype=0, proto=0, flags=0): """Translate the host/port argument into a sequence of 5-tuples that contain all the necessary arguments for creating a socket connected to that service. @@ -76,7 +78,6 @@ def gethostbyname(hostname: str) -> str: return addr.strip('"') -# pylint: disable=invalid-name, redefined-builtin class socket: """A simplified implementation of the Python 'socket' class for connecting to a FONA cellular module. @@ -130,23 +131,17 @@ def inet_aton(self, ip_string: str) -> bytearray: self._buffer = bytearray(self._buffer) return self._buffer - def connect( - self, address: Tuple[str, int], conn_mode: Optional[int] = None - ) -> None: + def connect(self, address: Tuple[str, int], conn_mode: Optional[int] = None) -> None: """Connect to a remote socket at address. (The format of address depends on the address family — see above.) :param tuple address: Remote socket as a (host, port) tuple. :param int conn_mode: Connection mode (TCP/UDP) """ - assert ( - conn_mode != 0x03 - ), "Error: SSL/TLS is not currently supported by CircuitPython." + assert conn_mode != 0x03, "Error: SSL/TLS is not currently supported by CircuitPython." host, port = address - if not _the_interface.socket_connect( - self.socknum, host, port, conn_mode=self._sock_type - ): + if not _the_interface.socket_connect(self.socknum, host, port, conn_mode=self._sock_type): raise RuntimeError("Failed to connect to host", host) self._buffer = b"" diff --git a/adafruit_fona/fona_3g.py b/adafruit_fona/fona_3g.py index cd8c609..4515660 100755 --- a/adafruit_fona/fona_3g.py +++ b/adafruit_fona/fona_3g.py @@ -20,11 +20,14 @@ https://github.com/adafruit/circuitpython/releases """ + from micropython import const + from .adafruit_fona import FONA, REPLY_OK try: from typing import Optional, Tuple, Union + from busio import UART from digitalio import DigitalInOut @@ -62,9 +65,7 @@ def __init__( def set_baudrate(self, baudrate: int) -> bool: """Sets the FONA's UART baudrate.""" - if not self._send_check_reply( - b"AT+IPREX=" + str(baudrate).encode(), reply=REPLY_OK - ): + if not self._send_check_reply(b"AT+IPREX=" + str(baudrate).encode(), reply=REPLY_OK): return False return True @@ -108,7 +109,6 @@ def local_ip(self) -> Optional[str]: return None return self._buf - # pylint: disable=too-many-return-statements def set_gprs( self, apn: Optional[Tuple[str, Optional[str], Optional[str]]] = None, @@ -153,12 +153,8 @@ def set_gprs( if not self.local_ip: return True - else: - # reset PDP state - if not self._send_check_reply( - b"AT+NETCLOSE", reply=b"Network closed", timeout=20000 - ): - return False + elif not self._send_check_reply(b"AT+NETCLOSE", reply=b"Network closed", timeout=20000): + return False return True ### Socket API (TCP, UDP) ### @@ -174,9 +170,7 @@ def tx_timeout(self) -> bool: @tx_timeout.setter def tx_timeout(self, timeout: int) -> bool: self._read_line() - if not self._send_check_reply( - b"AT+CIPTIMEOUT=" + str(timeout).encode(), reply=REPLY_OK - ): + if not self._send_check_reply(b"AT+CIPTIMEOUT=" + str(timeout).encode(), reply=REPLY_OK): return False return True @@ -221,9 +215,7 @@ def get_socket(self) -> int: print("Allocated socket #%d" % socket) return socket - def socket_connect( - self, sock_num: int, dest: str, port: int, conn_mode: int = 0 - ) -> bool: + def socket_connect(self, sock_num: int, dest: str, port: int, conn_mode: int = 0) -> bool: """Connects to a destination IP address or hostname. By default, we use conn_mode TCP_MODE but we may also use UDP_MODE. @@ -233,21 +225,13 @@ def socket_connect( :param int conn_mode: Connection mode (TCP/UDP) """ if self._debug: - print( - "*** Socket connect, protocol={}, port={}, ip={}".format( - conn_mode, port, dest - ) - ) + print(f"*** Socket connect, protocol={conn_mode}, port={port}, ip={dest}") self._uart.reset_input_buffer() - assert ( - sock_num < FONA_MAX_SOCKETS - ), "Provided socket exceeds the maximum number of \ + assert sock_num < FONA_MAX_SOCKETS, "Provided socket exceeds the maximum number of \ sockets for the FONA module." self._send_check_reply(b"AT+CIPHEAD=0", reply=REPLY_OK) # do not show ip header - self._send_check_reply( - b"AT+CIPSRIP=0", reply=REPLY_OK - ) # do not show remote ip/port + self._send_check_reply(b"AT+CIPSRIP=0", reply=REPLY_OK) # do not show remote ip/port self._send_check_reply(b"AT+CIPRXGET=1", reply=REPLY_OK) # manually get data self._uart_write(b"AT+CIPOPEN=" + str(sock_num).encode()) @@ -267,9 +251,7 @@ def remote_ip(self, sock_num: int) -> str: :param int sock_num: Desired socket number """ self._read_line() - assert ( - sock_num < FONA_MAX_SOCKETS - ), "Provided socket exceeds the maximum number of \ + assert sock_num < FONA_MAX_SOCKETS, "Provided socket exceeds the maximum number of \ sockets for the FONA module." self._uart_write(b"AT+CIPOPEN?\r\n") @@ -290,19 +272,13 @@ def socket_write(self, sock_num: int, buffer: bytes, timeout: int = 120000) -> b :param int timeout: Socket write timeout, in milliseconds. Defaults to 120000ms. """ self._read_line() - assert ( - sock_num < FONA_MAX_SOCKETS - ), "Provided socket exceeds the maximum number of \ + assert sock_num < FONA_MAX_SOCKETS, "Provided socket exceeds the maximum number of \ sockets for the FONA module." self._uart.reset_input_buffer() self._uart_write( - b"AT+CIPSEND=" - + str(sock_num).encode() - + b"," - + str(len(buffer)).encode() - + b"\r\n" + b"AT+CIPSEND=" + str(sock_num).encode() + b"," + str(len(buffer)).encode() + b"\r\n" ) self._read_line() if self._buf[0] != 62: diff --git a/docs/api.rst b/docs/api.rst index 7846032..1e1d2e5 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -4,6 +4,9 @@ .. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py) .. use this format as the module name: "adafruit_foo.foo" +API Reference +############# + .. automodule:: adafruit_fona.adafruit_fona :members: diff --git a/docs/conf.py b/docs/conf.py index 02b2671..b700101 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,12 +1,10 @@ -# -*- coding: utf-8 -*- - # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries # # SPDX-License-Identifier: MIT +import datetime import os import sys -import datetime sys.path.insert(0, os.path.abspath("..")) @@ -52,9 +50,7 @@ creation_year = "2020" current_year = str(datetime.datetime.now().year) year_duration = ( - current_year - if current_year == creation_year - else creation_year + " - " + current_year + current_year if current_year == creation_year else creation_year + " - " + current_year ) copyright = year_duration + " Brent Rubell, ladyada" author = "Brent Rubell, ladyada" diff --git a/examples/fona_aio_post.py b/examples/fona_aio_post.py index eae6b5c..28e79c3 100644 --- a/examples/fona_aio_post.py +++ b/examples/fona_aio_post.py @@ -1,18 +1,19 @@ # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries # SPDX-License-Identifier: MIT -# pylint: disable=unused-import -from os import getenv import time +from os import getenv + +import adafruit_connection_manager +import adafruit_requests import board import busio import digitalio -import adafruit_connection_manager -import adafruit_requests -from adafruit_fona.adafruit_fona import FONA -from adafruit_fona.fona_3g import FONA3G + import adafruit_fona.adafruit_fona_network as network import adafruit_fona.adafruit_fona_socket as pool +from adafruit_fona.adafruit_fona import FONA +from adafruit_fona.fona_3g import FONA3G # Get FONA details and Adafruit IO keys, ensure these are setup in settings.toml # (visit io.adafruit.com if you need to create an account, or if you need your Adafruit IO key.) diff --git a/examples/fona_cheerlights.py b/examples/fona_cheerlights.py index d0a1096..68fc4d9 100755 --- a/examples/fona_cheerlights.py +++ b/examples/fona_cheerlights.py @@ -1,20 +1,21 @@ # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries # SPDX-License-Identifier: MIT -# pylint: disable=unused-import -from os import getenv import time +from os import getenv + +import adafruit_connection_manager +import adafruit_fancyled.adafruit_fancyled as fancy +import adafruit_requests import board import busio import digitalio import neopixel -import adafruit_connection_manager -import adafruit_requests -import adafruit_fancyled.adafruit_fancyled as fancy -from adafruit_fona.adafruit_fona import FONA -from adafruit_fona.fona_3g import FONA3G + import adafruit_fona.adafruit_fona_network as network import adafruit_fona.adafruit_fona_socket as pool +from adafruit_fona.adafruit_fona import FONA +from adafruit_fona.fona_3g import FONA3G # Get FONA details, ensure these are setup in settings.toml apn = getenv("apn") diff --git a/examples/fona_simpletest.py b/examples/fona_simpletest.py index f7db790..11af0a5 100644 --- a/examples/fona_simpletest.py +++ b/examples/fona_simpletest.py @@ -1,18 +1,19 @@ # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries # SPDX-License-Identifier: MIT -# pylint: disable=unused-import -from os import getenv import time +from os import getenv + +import adafruit_connection_manager +import adafruit_requests import board import busio import digitalio -import adafruit_connection_manager -import adafruit_requests -from adafruit_fona.adafruit_fona import FONA -from adafruit_fona.fona_3g import FONA3G + import adafruit_fona.adafruit_fona_network as network import adafruit_fona.adafruit_fona_socket as pool +from adafruit_fona.adafruit_fona import FONA +from adafruit_fona.fona_3g import FONA3G print("FONA Webclient Test") diff --git a/examples/fona_sms.py b/examples/fona_sms.py index a516265..18a9436 100755 --- a/examples/fona_sms.py +++ b/examples/fona_sms.py @@ -1,11 +1,12 @@ # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries # SPDX-License-Identifier: MIT -# pylint: disable=unused-import import time + import board import busio import digitalio + from adafruit_fona.adafruit_fona import FONA, FONA_3G_A, FONA_3G_E from adafruit_fona.fona_3g import FONA3G @@ -39,7 +40,7 @@ print("%d SMS's on SIM Card" % num_sms) # FONA3G SMS memory slots start at 0 -if fona.version in (FONA_3G_A, FONA_3G_E): +if fona.version in {FONA_3G_A, FONA_3G_E}: sms_idx = 0 else: # FONA800 and FONA808 SMS slots start at 1 sms_idx = 1 diff --git a/examples/fona_sms_response.py b/examples/fona_sms_response.py index 5595d19..b073832 100755 --- a/examples/fona_sms_response.py +++ b/examples/fona_sms_response.py @@ -1,11 +1,12 @@ # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries # SPDX-License-Identifier: MIT -# pylint: disable=unused-import import time + import board import busio import digitalio + from adafruit_fona.adafruit_fona import FONA from adafruit_fona.fona_3g import FONA3G @@ -38,7 +39,7 @@ sender, message = fona.receive_sms() if message: - print("Incoming SMS from {}: {}".format(sender, message)) + print(f"Incoming SMS from {sender}: {message}") # Reply back! print("Sending response...") diff --git a/ruff.toml b/ruff.toml new file mode 100644 index 0000000..b45e467 --- /dev/null +++ b/ruff.toml @@ -0,0 +1,108 @@ +# SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +target-version = "py38" +line-length = 100 + +[lint] +preview = true +select = ["I", "PL", "UP"] + +extend-select = [ + "D419", # empty-docstring + "E501", # line-too-long + "W291", # trailing-whitespace + "PLC0414", # useless-import-alias + "PLC2401", # non-ascii-name + "PLC2801", # unnecessary-dunder-call + "PLC3002", # unnecessary-direct-lambda-call + "E999", # syntax-error + "PLE0101", # return-in-init + "F706", # return-outside-function + "F704", # yield-outside-function + "PLE0116", # continue-in-finally + "PLE0117", # nonlocal-without-binding + "PLE0241", # duplicate-bases + "PLE0302", # unexpected-special-method-signature + "PLE0604", # invalid-all-object + "PLE0605", # invalid-all-format + "PLE0643", # potential-index-error + "PLE0704", # misplaced-bare-raise + "PLE1141", # dict-iter-missing-items + "PLE1142", # await-outside-async + "PLE1205", # logging-too-many-args + "PLE1206", # logging-too-few-args + "PLE1307", # bad-string-format-type + "PLE1310", # bad-str-strip-call + "PLE1507", # invalid-envvar-value + "PLE2502", # bidirectional-unicode + "PLE2510", # invalid-character-backspace + "PLE2512", # invalid-character-sub + "PLE2513", # invalid-character-esc + "PLE2514", # invalid-character-nul + "PLE2515", # invalid-character-zero-width-space + "PLR0124", # comparison-with-itself + "PLR0202", # no-classmethod-decorator + "PLR0203", # no-staticmethod-decorator + "UP004", # useless-object-inheritance + "PLR0206", # property-with-parameters + "PLR0904", # too-many-public-methods + "PLR0911", # too-many-return-statements + "PLR0912", # too-many-branches + "PLR0913", # too-many-arguments + "PLR0914", # too-many-locals + "PLR0915", # too-many-statements + "PLR0916", # too-many-boolean-expressions + "PLR1702", # too-many-nested-blocks + "PLR1704", # redefined-argument-from-local + "PLR1711", # useless-return + "C416", # unnecessary-comprehension + "PLR1733", # unnecessary-dict-index-lookup + "PLR1736", # unnecessary-list-index-lookup + + # ruff reports this rule is unstable + #"PLR6301", # no-self-use + + "PLW0108", # unnecessary-lambda + "PLW0120", # useless-else-on-loop + "PLW0127", # self-assigning-variable + "PLW0129", # assert-on-string-literal + "B033", # duplicate-value + "PLW0131", # named-expr-without-context + "PLW0245", # super-without-brackets + "PLW0406", # import-self + "PLW0602", # global-variable-not-assigned + "PLW0603", # global-statement + "PLW0604", # global-at-module-level + + # fails on the try: import typing used by libraries + #"F401", # unused-import + + "F841", # unused-variable + "E722", # bare-except + "PLW0711", # binary-op-exception + "PLW1501", # bad-open-mode + "PLW1508", # invalid-envvar-default + "PLW1509", # subprocess-popen-preexec-fn + "PLW2101", # useless-with-lock + "PLW3301", # nested-min-max +] + +ignore = [ + "PLR2004", # magic-value-comparison + "UP030", # format literals + "PLW1514", # unspecified-encoding + "PLR0913", # too-many-arguments + "PLR0915", # too-many-statements + "PLR0917", # too-many-positional-arguments + "PLR0904", # too-many-public-methods + "PLR0912", # too-many-branches + "PLR0916", # too-many-boolean-expressions + "PLR6301", # method-could-be-function + "PLR0911", # too-many-return-statements + "PLW0603", # global-statement +] + +[format] +line-ending = "lf"