Commit d0efb4d
authored
fix(generator): move version checks after __all__ in __init__.py temlate (#18100)
This PR updates the `__init__.py.j2` template to place runtime checks
(`api_core.check_python_version()` and
`api_core.check_dependency_versions()`) at the very end of the file
after `__all__`.
In `gapic-generator 1.38.0`, runtime version and dependency checks were
placed immediately before `__all__`. This created an execution boundary
in the middle of the module:
* When post-processing scripts or handwritten extensions (such as
`SpeechHelpers` in `google-cloud-speech` or `VisionHelpers` in
`google-cloud-vision`) inject helper imports or wrap client classes
prior to `__all__`, linters (Flake8 and Ruff) flag `E402: Module level
import not at top of file`.
* Moving the checks to after `__all__` ensures all module imports remain
contiguous at the top of the file, complying with PEP 8 import ordering
and eliminating the need for `# noqa: E402` annotations in
post-processing.
* Module import semantics remain identical: Python executes the file
top-to-bottom, so environment checks still run immediately upon import
and abort if incompatible versions are detected.1 parent 1e3f7bb commit d0efb4d
9 files changed
Lines changed: 28 additions & 27 deletions
File tree
- packages/gapic-generator
- gapic/templates/%namespace/%name_%version/%sub
- tests/integration/goldens
- asset/google/cloud/asset_v1
- credentials/google/iam/credentials_v1
- eventarc/google/cloud/eventarc_v1
- logging_internal/google/cloud/logging_v2
- logging/google/cloud/logging_v2
- redis_selective/google/cloud/redis_v1
- redis/google/cloud/redis_v1
- storagebatchoperations/google/cloud/storagebatchoperations_v1
Lines changed: 4 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
60 | 60 | | |
61 | 61 | | |
62 | 62 | | |
63 | | - | |
64 | | - | |
65 | | - | |
66 | 63 | | |
67 | 64 | | |
68 | 65 | | |
| |||
90 | 87 | | |
91 | 88 | | |
92 | 89 | | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
93 | 94 | | |
Lines changed: 3 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
118 | 118 | | |
119 | 119 | | |
120 | 120 | | |
121 | | - | |
122 | | - | |
123 | | - | |
124 | 121 | | |
125 | 122 | | |
126 | 123 | | |
| |||
206 | 203 | | |
207 | 204 | | |
208 | 205 | | |
| 206 | + | |
| 207 | + | |
| 208 | + | |
Lines changed: 3 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
44 | 44 | | |
45 | 45 | | |
46 | 46 | | |
47 | | - | |
48 | | - | |
49 | | - | |
50 | 47 | | |
51 | 48 | | |
52 | 49 | | |
| |||
59 | 56 | | |
60 | 57 | | |
61 | 58 | | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
Lines changed: 3 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
116 | 116 | | |
117 | 117 | | |
118 | 118 | | |
119 | | - | |
120 | | - | |
121 | | - | |
122 | 119 | | |
123 | 120 | | |
124 | 121 | | |
| |||
193 | 190 | | |
194 | 191 | | |
195 | 192 | | |
| 193 | + | |
| 194 | + | |
| 195 | + | |
Lines changed: 3 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
120 | 120 | | |
121 | 121 | | |
122 | 122 | | |
123 | | - | |
124 | | - | |
125 | | - | |
126 | 123 | | |
127 | 124 | | |
128 | 125 | | |
| |||
207 | 204 | | |
208 | 205 | | |
209 | 206 | | |
| 207 | + | |
| 208 | + | |
| 209 | + | |
Lines changed: 3 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
120 | 120 | | |
121 | 121 | | |
122 | 122 | | |
123 | | - | |
124 | | - | |
125 | | - | |
126 | 123 | | |
127 | 124 | | |
128 | 125 | | |
| |||
207 | 204 | | |
208 | 205 | | |
209 | 206 | | |
| 207 | + | |
| 208 | + | |
| 209 | + | |
Lines changed: 3 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
62 | 62 | | |
63 | 63 | | |
64 | 64 | | |
65 | | - | |
66 | | - | |
67 | | - | |
68 | 65 | | |
69 | 66 | | |
70 | 67 | | |
| |||
96 | 93 | | |
97 | 94 | | |
98 | 95 | | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
Lines changed: 3 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
55 | 55 | | |
56 | 56 | | |
57 | 57 | | |
58 | | - | |
59 | | - | |
60 | | - | |
61 | 58 | | |
62 | 59 | | |
63 | 60 | | |
| |||
82 | 79 | | |
83 | 80 | | |
84 | 81 | | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
Lines changed: 3 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
64 | 64 | | |
65 | 65 | | |
66 | 66 | | |
67 | | - | |
68 | | - | |
69 | | - | |
70 | 67 | | |
71 | 68 | | |
72 | 69 | | |
| |||
99 | 96 | | |
100 | 97 | | |
101 | 98 | | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
0 commit comments