Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit b21a748

Browse files
authoredMay 17, 2025··
Merge pull request #14 from adafruit/use_ruff
change to ruff
2 parents 006c50e + 563fcd2 commit b21a748

11 files changed

+164
-471
lines changed
 

‎.gitattributes

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries
2+
#
3+
# SPDX-License-Identifier: Unlicense
4+
5+
.py text eol=lf
6+
.rst text eol=lf
7+
.txt text eol=lf
8+
.yaml text eol=lf
9+
.toml text eol=lf
10+
.license text eol=lf
11+
.md text eol=lf

‎.pre-commit-config.yaml

Lines changed: 11 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,21 @@
1-
# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò
1+
# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries
22
#
33
# SPDX-License-Identifier: Unlicense
44

55
repos:
6-
- repo: https://github.com/python/black
7-
rev: 23.3.0
8-
hooks:
9-
- id: black
10-
- repo: https://github.com/fsfe/reuse-tool
11-
rev: v1.1.2
12-
hooks:
13-
- id: reuse
146
- repo: https://github.com/pre-commit/pre-commit-hooks
15-
rev: v4.4.0
7+
rev: v4.5.0
168
hooks:
179
- id: check-yaml
1810
- id: end-of-file-fixer
1911
- id: trailing-whitespace
20-
- repo: https://github.com/pycqa/pylint
21-
rev: v2.17.4
12+
- repo: https://github.com/astral-sh/ruff-pre-commit
13+
rev: v0.3.4
2214
hooks:
23-
- id: pylint
24-
name: pylint (library code)
25-
types: [python]
26-
args:
27-
- --disable=consider-using-f-string
28-
exclude: "^(docs/|examples/|tests/|setup.py$)"
29-
- id: pylint
30-
name: pylint (example code)
31-
description: Run pylint rules on "examples/*.py" files
32-
types: [python]
33-
files: "^examples/"
34-
args:
35-
- --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code
36-
- id: pylint
37-
name: pylint (test code)
38-
description: Run pylint rules on "tests/*.py" files
39-
types: [python]
40-
files: "^tests/"
41-
args:
42-
- --disable=missing-docstring,consider-using-f-string,duplicate-code
15+
- id: ruff-format
16+
- id: ruff
17+
args: ["--fix"]
18+
- repo: https://github.com/fsfe/reuse-tool
19+
rev: v3.0.1
20+
hooks:
21+
- id: reuse

‎.pylintrc

Lines changed: 0 additions & 399 deletions
This file was deleted.

‎README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ Introduction
1313
:target: https://github.com/adafruit/Adafruit_CircuitPython_OAuth2/actions
1414
:alt: Build Status
1515

16-
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
17-
:target: https://github.com/psf/black
18-
:alt: Code Style: Black
16+
.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
17+
:target: https://github.com/astral-sh/ruff
18+
:alt: Code Style: Ruff
1919

2020
CircuitPython helper for OAuth2.0 authorization to access Google APIs.
2121

‎adafruit_oauth2.py

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,10 @@
2222
https://github.com/adafruit/circuitpython/releases
2323
2424
"""
25+
2526
try:
26-
from typing import Optional, List
27+
from typing import List, Optional
28+
2729
import adafruit_requests
2830
except ImportError:
2931
pass
@@ -42,7 +44,7 @@
4244
DEVICE_GRANT_TYPE = "&grant_type=urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Adevice_code"
4345

4446

45-
class OAuth2: # pylint: disable=too-many-arguments, too-many-instance-attributes
47+
class OAuth2:
4648
"""Implements OAuth2.0 authorization to access Google APIs via
4749
the OAuth 2.0 limited-input device application flow.
4850
https://developers.google.com/identity/protocols/oauth2/limited-input-device
@@ -101,9 +103,7 @@ def request_codes(self) -> None:
101103
"Content-Length": "0",
102104
}
103105
scope = " ".join(self._scopes)
104-
url = DEVICE_AUTHORIZATION_ENDPOINT + "?client_id={0}&scope={1}".format(
105-
self._client_id, scope
106-
)
106+
url = DEVICE_AUTHORIZATION_ENDPOINT + f"?client_id={self._client_id}&scope={scope}"
107107
response = self._requests.post(url, headers=headers)
108108
json_resp = response.json()
109109
response.close()
@@ -131,11 +131,9 @@ def wait_for_authorization(self) -> bool:
131131
"Content-Length": "0",
132132
}
133133
url = (
134-
"https://oauth2.googleapis.com/token?client_id={0}"
135-
"&client_secret={1}&device_code={2}"
136-
"&grant_type=urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Adevice_code".format(
137-
self._client_id, self._client_secret, self._device_code
138-
)
134+
f"https://oauth2.googleapis.com/token?client_id={self._client_id}"
135+
+ f"&client_secret={self._client_secret}&device_code={self._device_code}"
136+
+ "&grant_type=urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Adevice_code"
139137
)
140138

141139
# Blocking loop to poll endpoint
@@ -176,13 +174,11 @@ def refresh_access_token(self) -> bool:
176174
"Content-Length": "0",
177175
}
178176
url = (
179-
"https://oauth2.googleapis.com/token?client_id={0}&client_secret={1}"
180-
"&grant_type=refresh_token&refresh_token={2}".format(
181-
self._client_id, self._client_secret, self.refresh_token
182-
)
177+
f"https://oauth2.googleapis.com/token?client_id={self._client_id}&client_secret={self._client_secret}"
178+
+ f"&grant_type=refresh_token&refresh_token={self.refresh_token}"
183179
)
184180
resp = self._requests.post(url, headers=headers)
185-
if resp.status_code in (400, 404):
181+
if resp.status_code in {400, 404}:
186182
return False
187183
json_resp = resp.json()
188184
resp.close()

‎docs/api.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,8 @@
44
.. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py)
55
.. use this format as the module name: "adafruit_foo.foo"
66
7+
API Reference
8+
#############
9+
710
.. automodule:: adafruit_oauth2
811
:members:

‎docs/conf.py

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
1-
# -*- coding: utf-8 -*-
2-
31
# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
42
#
53
# SPDX-License-Identifier: MIT
64

5+
import datetime
76
import os
87
import sys
9-
import datetime
108

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

@@ -51,9 +49,7 @@
5149
creation_year = "2021"
5250
current_year = str(datetime.datetime.now().year)
5351
year_duration = (
54-
current_year
55-
if current_year == creation_year
56-
else creation_year + " - " + current_year
52+
current_year if current_year == creation_year else creation_year + " - " + current_year
5753
)
5854
copyright = year_duration + " Brent Rubell"
5955
author = "Brent Rubell"

‎examples/oauth2_simpletest.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@
22
#
33
# SPDX-License-Identifier: Unlicense
44

5-
from os import getenv
65
import ssl
7-
import wifi
8-
import socketpool
6+
from os import getenv
7+
98
import adafruit_requests
9+
import socketpool
10+
import wifi
11+
1012
from adafruit_oauth2 import OAuth2
1113

1214
# Get WiFi details and Google keys, ensure these are setup in settings.toml
@@ -38,9 +40,7 @@
3840
# long enough to handle the user_code and verification_url.
3941
# Details in link below:
4042
# https://developers.google.com/identity/protocols/oauth2/limited-input-device#displayingthecode
41-
print(
42-
"1) Navigate to the following URL in a web browser:", google_auth.verification_url
43-
)
43+
print("1) Navigate to the following URL in a web browser:", google_auth.verification_url)
4444
print("2) Enter the following code:", google_auth.user_code)
4545

4646
# Poll Google's authorization server

‎examples/oauth2_simpletest_cpython.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,12 @@
22
#
33
# SPDX-License-Identifier: Unlicense
44

5-
from os import getenv
65
import socket
76
import ssl
7+
from os import getenv
8+
89
import adafruit_requests
10+
911
from adafruit_oauth2 import OAuth2
1012

1113
# Get Google keys, ensure these are setup in settings.toml
@@ -29,9 +31,7 @@
2931
# long enough to handle the user_code and verification_url.
3032
# Details in link below:
3133
# https://developers.google.com/identity/protocols/oauth2/limited-input-device#displayingthecode
32-
print(
33-
"1) Navigate to the following URL in a web browser:", google_auth.verification_url
34-
)
34+
print("1) Navigate to the following URL in a web browser:", google_auth.verification_url)
3535
print("2) Enter the following code:", google_auth.user_code)
3636

3737
# Poll Google's authorization server

‎examples/oauth2_simpletest_esp32spi.py

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,14 @@
33
# SPDX-License-Identifier: Unlicense
44

55
from os import getenv
6+
7+
import adafruit_connection_manager
8+
import adafruit_requests
69
import board
710
import busio
8-
from digitalio import DigitalInOut
9-
import adafruit_connection_manager
1011
from adafruit_esp32spi import adafruit_esp32spi
12+
from digitalio import DigitalInOut
1113

12-
import adafruit_requests
1314
from adafruit_oauth2 import OAuth2
1415

1516
# Get WiFi details and Google keys, ensure these are setup in settings.toml
@@ -54,9 +55,7 @@
5455
# long enough to handle the user_code and verification_url.
5556
# Details in link below:
5657
# https://developers.google.com/identity/protocols/oauth2/limited-input-device#displayingthecode
57-
print(
58-
"1) Navigate to the following URL in a web browser:", google_auth.verification_url
59-
)
58+
print("1) Navigate to the following URL in a web browser:", google_auth.verification_url)
6059
print("2) Enter the following code:", google_auth.user_code)
6160

6261
# Poll Google's authorization server

‎ruff.toml

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
# SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries
2+
#
3+
# SPDX-License-Identifier: MIT
4+
5+
target-version = "py38"
6+
line-length = 100
7+
8+
[lint]
9+
preview = true
10+
select = ["I", "PL", "UP"]
11+
12+
extend-select = [
13+
"D419", # empty-docstring
14+
"E501", # line-too-long
15+
"W291", # trailing-whitespace
16+
"PLC0414", # useless-import-alias
17+
"PLC2401", # non-ascii-name
18+
"PLC2801", # unnecessary-dunder-call
19+
"PLC3002", # unnecessary-direct-lambda-call
20+
"E999", # syntax-error
21+
"PLE0101", # return-in-init
22+
"F706", # return-outside-function
23+
"F704", # yield-outside-function
24+
"PLE0116", # continue-in-finally
25+
"PLE0117", # nonlocal-without-binding
26+
"PLE0241", # duplicate-bases
27+
"PLE0302", # unexpected-special-method-signature
28+
"PLE0604", # invalid-all-object
29+
"PLE0605", # invalid-all-format
30+
"PLE0643", # potential-index-error
31+
"PLE0704", # misplaced-bare-raise
32+
"PLE1141", # dict-iter-missing-items
33+
"PLE1142", # await-outside-async
34+
"PLE1205", # logging-too-many-args
35+
"PLE1206", # logging-too-few-args
36+
"PLE1307", # bad-string-format-type
37+
"PLE1310", # bad-str-strip-call
38+
"PLE1507", # invalid-envvar-value
39+
"PLE2502", # bidirectional-unicode
40+
"PLE2510", # invalid-character-backspace
41+
"PLE2512", # invalid-character-sub
42+
"PLE2513", # invalid-character-esc
43+
"PLE2514", # invalid-character-nul
44+
"PLE2515", # invalid-character-zero-width-space
45+
"PLR0124", # comparison-with-itself
46+
"PLR0202", # no-classmethod-decorator
47+
"PLR0203", # no-staticmethod-decorator
48+
"UP004", # useless-object-inheritance
49+
"PLR0206", # property-with-parameters
50+
"PLR0904", # too-many-public-methods
51+
"PLR0911", # too-many-return-statements
52+
"PLR0912", # too-many-branches
53+
"PLR0913", # too-many-arguments
54+
"PLR0914", # too-many-locals
55+
"PLR0915", # too-many-statements
56+
"PLR0916", # too-many-boolean-expressions
57+
"PLR1702", # too-many-nested-blocks
58+
"PLR1704", # redefined-argument-from-local
59+
"PLR1711", # useless-return
60+
"C416", # unnecessary-comprehension
61+
"PLR1733", # unnecessary-dict-index-lookup
62+
"PLR1736", # unnecessary-list-index-lookup
63+
64+
# ruff reports this rule is unstable
65+
#"PLR6301", # no-self-use
66+
67+
"PLW0108", # unnecessary-lambda
68+
"PLW0120", # useless-else-on-loop
69+
"PLW0127", # self-assigning-variable
70+
"PLW0129", # assert-on-string-literal
71+
"B033", # duplicate-value
72+
"PLW0131", # named-expr-without-context
73+
"PLW0245", # super-without-brackets
74+
"PLW0406", # import-self
75+
"PLW0602", # global-variable-not-assigned
76+
"PLW0603", # global-statement
77+
"PLW0604", # global-at-module-level
78+
79+
# fails on the try: import typing used by libraries
80+
#"F401", # unused-import
81+
82+
"F841", # unused-variable
83+
"E722", # bare-except
84+
"PLW0711", # binary-op-exception
85+
"PLW1501", # bad-open-mode
86+
"PLW1508", # invalid-envvar-default
87+
"PLW1509", # subprocess-popen-preexec-fn
88+
"PLW2101", # useless-with-lock
89+
"PLW3301", # nested-min-max
90+
]
91+
92+
ignore = [
93+
"PLR2004", # magic-value-comparison
94+
"UP030", # format literals
95+
"PLW1514", # unspecified-encoding
96+
"PLR0913", # too-many-arguments
97+
"PLR0915", # too-many-statements
98+
"PLR0917", # too-many-positional-arguments
99+
"PLR0904", # too-many-public-methods
100+
"PLR0912", # too-many-branches
101+
"PLR0916", # too-many-boolean-expressions
102+
"PLR6301", # could-be-static no-self-use
103+
"PLC0415", # import outside toplevel
104+
"PLC2701", # private import
105+
]
106+
107+
[format]
108+
line-ending = "lf"

0 commit comments

Comments
 (0)
Please sign in to comment.