Skip to content

Commit a165ff3

Browse files
build: migrate from autopep8 to black/flake8 (#2334)
Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent ee23936 commit a165ff3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

87 files changed

+6453
-5322
lines changed

.flake8

+32
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,44 @@
11
[flake8]
22
ignore =
3+
# TODO(https://github.com/googleapis/gapic-generator-python/issues/2333): E123, E124
34
# Closing bracket mismatches opening bracket's line.
45
# This works poorly with type annotations in method declarations.
56
E123, E124
67
# Line over-indented for visual indent.
78
# This works poorly with type annotations in method declarations.
9+
# TODO(https://github.com/googleapis/gapic-generator-python/issues/2333): E126, E128, E131
810
E126, E128, E131
911
# Line break after binary operator.
1012
# This catches line breaks after "and" / "or" as a means of breaking up
1113
# long if statements, which PEP 8 explicitly encourages.
14+
# TODO(https://github.com/googleapis/gapic-generator-python/issues/2333): W504
1215
W504
16+
# TODO(https://github.com/googleapis/gapic-generator-python/issues/2333): E203
17+
E203
18+
# TODO(https://github.com/googleapis/gapic-generator-python/issues/2333): E501
19+
E501
20+
# TODO(https://github.com/googleapis/gapic-generator-python/issues/2333): E712
21+
E712
22+
# TODO(https://github.com/googleapis/gapic-generator-python/issues/2333): E711
23+
E711
24+
# TODO(https://github.com/googleapis/gapic-generator-python/issues/2333): E722
25+
E722
26+
# TODO(https://github.com/googleapis/gapic-generator-python/issues/2333): E741
27+
E741
28+
# TODO(https://github.com/googleapis/gapic-generator-python/issues/2333): F401
29+
F401
30+
# TODO(https://github.com/googleapis/gapic-generator-python/issues/2333): F541
31+
F541
32+
# TODO(https://github.com/googleapis/gapic-generator-python/issues/2333): F841
33+
F841
34+
# TODO(https://github.com/googleapis/gapic-generator-python/issues/2333): F811
35+
F811
36+
# TODO(https://github.com/googleapis/gapic-generator-python/issues/2333): W503
37+
W503
38+
# TODO(https://github.com/googleapis/gapic-generator-python/issues/2333): W291
39+
W291
40+
exclude =
41+
# Exclude golden files
42+
tests/integration
43+
# Exclude generated protobuf code
44+
*_pb2.py

.githooks/pre-commit

-13
Original file line numberDiff line numberDiff line change
@@ -93,19 +93,6 @@ if [ -x /usr/lib/git-core/google_hook ]; then
9393
/usr/lib/git-core/google_hook pre-commit "$@"
9494
fi
9595

96-
# Check Python format.
97-
if [ $NUM_PYTHON_FILES_CHANGED -gt 0 ]
98-
then
99-
echo_status "Running Python linter..."
100-
find gapic tests -name "*.py" -not -path 'tests/integration/goldens/*' | xargs autopep8 --diff --exit-code
101-
FORMAT_STATUS=$?
102-
if [ $FORMAT_STATUS != 0 ]
103-
then
104-
echo_error "Linting failed." "Please try again after running autopep8 on the gapic/ and tests/ directories."
105-
exit 1
106-
fi
107-
fi
108-
10996
# Check unit tests.
11097
if [ $NUM_PYTHON_FILES_CHANGED -gt 0 ] || [ $NUM_UNIT_GOLDEN_FILES_CHANGED -gt 0 ]
11198
then

.github/sync-repo-settings.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ branchProtectionRules:
6565
- 'goldens-lint'
6666
- 'goldens-prerelease'
6767
- 'goldens-unit'
68-
- 'style-check'
68+
- 'lint'
6969
- 'snippetgen'
7070
- 'unit (3.7)'
7171
- 'unit (3.8)'

.github/workflows/tests.yaml

+5-5
Original file line numberDiff line numberDiff line change
@@ -390,7 +390,7 @@ jobs:
390390
nox -f tests/integration/goldens/eventarc/noxfile.py -s prerelease_deps
391391
nox -f tests/integration/goldens/logging/noxfile.py -s prerelease_deps
392392
nox -f tests/integration/goldens/redis/noxfile.py -s prerelease_deps
393-
style-check:
393+
lint:
394394
runs-on: ubuntu-latest
395395
steps:
396396
- uses: actions/checkout@v4
@@ -399,9 +399,9 @@ jobs:
399399
with:
400400
python-version: "3.13"
401401
cache: 'pip'
402-
- name: Install autopep8
402+
- name: Install nox.
403403
run: |
404-
python -m pip install autopep8
405-
- name: Check diff
404+
python -m pip install nox
405+
- name: Run lint
406406
run: |
407-
find gapic tests -name "*.py" -not -path 'tests/**/goldens/*' | xargs autopep8 --diff --exit-code
407+
nox -s lint

.kokoro/docker/docs/requirements.txt

+30-30
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ argcomplete==3.5.3 \
88
--hash=sha256:2ab2c4a215c59fd6caaff41a869480a23e8f6a5f910b266c1808037f4e375b61 \
99
--hash=sha256:c12bf50eded8aebb298c7b7da7a5ff3ee24dffd9f5281867dfe1424b58c55392
1010
# via nox
11-
cachetools==5.5.1 \
12-
--hash=sha256:70f238fbba50383ef62e55c6aff6d9673175fe59f7c6782c7a0b9e38f4a9df95 \
13-
--hash=sha256:b76651fdc3b24ead3c648bbdeeb940c1b04d365b38b4af66788f9ec4a81d42bb
11+
cachetools==5.5.0 \
12+
--hash=sha256:02134e8439cdc2ffb62023ce1debca2944c3f289d66bb17ead3ab3dede74b292 \
13+
--hash=sha256:2cc24fb4cbe39633fb7badd9db9ca6295d766d9c2995f245725a46715d050f2a
1414
# via google-auth
15-
certifi==2025.1.31 \
16-
--hash=sha256:3d5da6925056f6f18f119200434a4780a94263f10d1c21d032a6f6b2baa20651 \
17-
--hash=sha256:ca78db4565a652026a4db2bcdf68f2fb589ea80d0be70e03929ed730746b84fe
15+
certifi==2024.12.14 \
16+
--hash=sha256:1275f7a45be9464efc1173084eaa30f866fe2e47d389406136d332ed4967ec56 \
17+
--hash=sha256:b650d30f370c2b724812bee08008be0c4163b163ddaec3f2546c1caf65f191db
1818
# via requests
1919
charset-normalizer==3.4.1 \
2020
--hash=sha256:0167ddc8ab6508fe81860a57dd472b2ef4060e8d378f0cc555707126830f2537 \
@@ -124,23 +124,23 @@ distlib==0.3.9 \
124124
--hash=sha256:47f8c22fd27c27e25a65601af709b38e4f0a45ea4fc2e710f65755fa8caaaf87 \
125125
--hash=sha256:a60f20dea646b8a33f3e7772f74dc0b2d0772d2837ee1342a00645c81edf9403
126126
# via virtualenv
127-
filelock==3.17.0 \
128-
--hash=sha256:533dc2f7ba78dc2f0f531fc6c4940addf7b70a481e269a5a3b93be94ffbe8338 \
129-
--hash=sha256:ee4e77401ef576ebb38cd7f13b9b28893194acc20a8e68e18730ba9c0e54660e
127+
filelock==3.16.1 \
128+
--hash=sha256:2082e5703d51fbf98ea75855d9d5527e33d8ff23099bec374a134febee6946b0 \
129+
--hash=sha256:c249fbfcd5db47e5e2d6d62198e565475ee65e4831e2561c8e313fa7eb961435
130130
# via virtualenv
131131
gcp-docuploader==0.6.5 \
132132
--hash=sha256:30221d4ac3e5a2b9c69aa52fdbef68cc3f27d0e6d0d90e220fc024584b8d2318 \
133133
--hash=sha256:b7458ef93f605b9d46a4bf3a8dc1755dad1f31d030c8679edf304e343b347eea
134134
# via -r requirements.in
135-
google-api-core==2.24.1 \
136-
--hash=sha256:bc78d608f5a5bf853b80bd70a795f703294de656c096c0968320830a4bc280f1 \
137-
--hash=sha256:f8b36f5456ab0dd99a1b693a40a31d1e7757beea380ad1b38faaf8941eae9d8a
135+
google-api-core==2.24.0 \
136+
--hash=sha256:10d82ac0fca69c82a25b3efdeefccf6f28e02ebb97925a8cce8edbfe379929d9 \
137+
--hash=sha256:e255640547a597a4da010876d333208ddac417d60add22b6851a0c66a831fcaf
138138
# via
139139
# google-cloud-core
140140
# google-cloud-storage
141-
google-auth==2.38.0 \
142-
--hash=sha256:8285113607d3b80a3f1543b75962447ba8a09fe85783432a784fdeef6ac094c4 \
143-
--hash=sha256:e7dae6694313f434a2727bf2906f27ad259bae090d7aa896590d86feec3d9d4a
141+
google-auth==2.37.0 \
142+
--hash=sha256:0054623abf1f9c83492c63d3f47e77f0a544caa3d40b2d98e099a611c2dd5d00 \
143+
--hash=sha256:42664f18290a6be591be5329a96fe30184be1a1badb7292a7f686a9659de9ca0
144144
# via
145145
# google-api-core
146146
# google-cloud-core
@@ -149,9 +149,9 @@ google-cloud-core==2.4.1 \
149149
--hash=sha256:9b7749272a812bde58fff28868d0c5e2f585b82f37e09a1f6ed2d4d10f134073 \
150150
--hash=sha256:a9e6a4422b9ac5c29f79a0ede9485473338e2ce78d91f2370c01e730eab22e61
151151
# via google-cloud-storage
152-
google-cloud-storage==3.0.0 \
153-
--hash=sha256:2accb3e828e584888beff1165e5f3ac61aa9088965eb0165794a82d8c7f95297 \
154-
--hash=sha256:f85fd059650d2dbb0ac158a9a6b304b66143b35ed2419afec2905ca522eb2c6a
152+
google-cloud-storage==2.19.0 \
153+
--hash=sha256:aeb971b5c29cf8ab98445082cbfe7b161a1f48ed275822f59ed3f1524ea54fba \
154+
--hash=sha256:cd05e9e7191ba6cb68934d8eb76054d9be4562aa89dbc4236feee4d7d51342b2
155155
# via gcp-docuploader
156156
google-crc32c==1.6.0 \
157157
--hash=sha256:05e2d8c9a2f853ff116db9706b4a27350587f341eda835f46db3c0a8c8ce2f24 \
@@ -188,17 +188,17 @@ google-resumable-media==2.7.2 \
188188
--hash=sha256:3ce7551e9fe6d99e9a126101d2536612bb73486721951e9562fee0f90c6ababa \
189189
--hash=sha256:5280aed4629f2b60b847b0d42f9857fd4935c11af266744df33d8074cae92fe0
190190
# via google-cloud-storage
191-
googleapis-common-protos==1.67.0 \
192-
--hash=sha256:21398025365f138be356d5923e9168737d94d46a72aefee4a6110a1f23463c86 \
193-
--hash=sha256:579de760800d13616f51cf8be00c876f00a9f146d3e6510e19d1f4111758b741
191+
googleapis-common-protos==1.66.0 \
192+
--hash=sha256:c3e7b33d15fdca5374cc0a7346dd92ffa847425cc4ea941d970f13680052ec8c \
193+
--hash=sha256:d7abcd75fabb2e0ec9f74466401f6c119a0b498e27370e9be4c94cb7e382b8ed
194194
# via google-api-core
195195
idna==3.10 \
196196
--hash=sha256:12f65c9b470abda6dc35cf8e63cc574b1c52b11df2c86030af0ac09b01b13ea9 \
197197
--hash=sha256:946d195a0d259cbba61165e88e65941f16e9b36ea6ddb97f00452bae8b1287d3
198198
# via requests
199-
nox==2025.2.9 \
200-
--hash=sha256:7d1e92d1918c6980d70aee9cf1c1d19d16faa71c4afe338fffd39e8a460e2067 \
201-
--hash=sha256:d50cd4ca568bd7621c2e6cbbc4845b3b7f7697f25d5fb0190ce8f4600be79768
199+
nox==2024.10.9 \
200+
--hash=sha256:1d36f309a0a2a853e9bccb76bbef6bb118ba92fa92674d15604ca99adeb29eab \
201+
--hash=sha256:7aa9dc8d1c27e9f45ab046ffd1c3b2c4f7c91755304769df231308849ebded95
202202
# via -r requirements.in
203203
packaging==24.2 \
204204
--hash=sha256:09abb1bccd265c01f4a3aa3f7a7db064b36514d2cba19a2f694fe6150451a759 \
@@ -208,9 +208,9 @@ platformdirs==4.3.6 \
208208
--hash=sha256:357fb2acbc885b0419afd3ce3ed34564c13c9b95c89360cd9563f73aa5e2b907 \
209209
--hash=sha256:73e575e1408ab8103900836b97580d5307456908a03e92031bab39e4554cc3fb
210210
# via virtualenv
211-
proto-plus==1.26.0 \
212-
--hash=sha256:6e93d5f5ca267b54300880fff156b6a3386b3fa3f43b1da62e680fc0c586ef22 \
213-
--hash=sha256:bf2dfaa3da281fc3187d12d224c707cb57214fb2c22ba854eb0c105a3fb2d4d7
211+
proto-plus==1.25.0 \
212+
--hash=sha256:c91fc4a65074ade8e458e95ef8bac34d4008daa7cce4a12d6707066fca648961 \
213+
--hash=sha256:fbb17f57f7bd05a68b7707e745e26528b0b3c34e378db91eef93912c54982d91
214214
# via google-api-core
215215
protobuf==5.29.3 \
216216
--hash=sha256:0a18ed4a24198528f2333802eb075e59dea9d679ab7a6c5efb017a59004d849f \
@@ -291,7 +291,7 @@ urllib3==2.3.0 \
291291
--hash=sha256:1cee9ad369867bfdbbb48b7dd50374c0967a0bb7710050facf0dd6911440e3df \
292292
--hash=sha256:f8c5449b3cf0861679ce7e0503c7b44b5ec981bec0d1d3795a07f1ba96f0204d
293293
# via requests
294-
virtualenv==20.29.2 \
295-
--hash=sha256:fdaabebf6d03b5ba83ae0a02cfe96f48a716f4fae556461d180825866f75b728 \
296-
--hash=sha256:febddfc3d1ea571bdb1dc0f98d7b45d24def7428214d4fb73cc486c9568cce6a
294+
virtualenv==20.28.1 \
295+
--hash=sha256:412773c85d4dab0409b83ec36f7a6499e72eaf08c80e81e9576bca61831c71cb \
296+
--hash=sha256:5d34ab240fdb5d21549b76f9e8ff3af28252f5499fb6d6f031adac4e5a8c5329
297297
# via nox

DEVELOPMENT.md

+1-11
Original file line numberDiff line numberDiff line change
@@ -23,17 +23,7 @@ Execute unit tests by running one of the sessions prefixed with `unit-`.
2323

2424
## Formatting
2525

26-
- Lint sources by running `autopep8`. The specific command is the following.
27-
28-
```
29-
find gapic tests -name "*.py" -not -path 'tests/**/goldens/*' | xargs autopep8 --diff --exit-code
30-
```
31-
32-
- Format sources in place:
33-
34-
```
35-
find gapic tests -name "*.py" -not -path 'tests/**/goldens/*' | xargs autopep8 --in-place
36-
```
26+
- Lint sources by running `nox -s blacken`. Use `nox -s lint` to run lint check.
3727

3828
## Integration Tests
3929

0 commit comments

Comments
 (0)