mypy-boto3-waf-regional 1.34.153__tar.gz → 1.35.93__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of mypy-boto3-waf-regional might be problematic. Click here for more details.
- {mypy_boto3_waf_regional-1.34.153 → mypy_boto3_waf_regional-1.35.93}/LICENSE +1 -1
- {mypy_boto3_waf_regional-1.34.153 → mypy_boto3_waf_regional-1.35.93}/PKG-INFO +80 -25
- {mypy_boto3_waf_regional-1.34.153 → mypy_boto3_waf_regional-1.35.93}/README.md +75 -21
- {mypy_boto3_waf_regional-1.34.153 → mypy_boto3_waf_regional-1.35.93}/mypy_boto3_waf_regional/__init__.py +3 -0
- {mypy_boto3_waf_regional-1.34.153 → mypy_boto3_waf_regional-1.35.93}/mypy_boto3_waf_regional/__init__.pyi +2 -0
- {mypy_boto3_waf_regional-1.34.153 → mypy_boto3_waf_regional-1.35.93}/mypy_boto3_waf_regional/__main__.py +11 -8
- {mypy_boto3_waf_regional-1.34.153 → mypy_boto3_waf_regional-1.35.93}/mypy_boto3_waf_regional/client.py +403 -333
- {mypy_boto3_waf_regional-1.34.153 → mypy_boto3_waf_regional-1.35.93}/mypy_boto3_waf_regional/client.pyi +402 -332
- {mypy_boto3_waf_regional-1.34.153 → mypy_boto3_waf_regional-1.35.93}/mypy_boto3_waf_regional/literals.py +31 -8
- {mypy_boto3_waf_regional-1.34.153 → mypy_boto3_waf_regional-1.35.93}/mypy_boto3_waf_regional/literals.pyi +29 -8
- mypy_boto3_waf_regional-1.35.93/mypy_boto3_waf_regional/type_defs.py +1468 -0
- mypy_boto3_waf_regional-1.35.93/mypy_boto3_waf_regional/type_defs.pyi +1251 -0
- mypy_boto3_waf_regional-1.35.93/mypy_boto3_waf_regional/version.py +7 -0
- {mypy_boto3_waf_regional-1.34.153 → mypy_boto3_waf_regional-1.35.93}/mypy_boto3_waf_regional.egg-info/PKG-INFO +80 -25
- {mypy_boto3_waf_regional-1.34.153 → mypy_boto3_waf_regional-1.35.93}/mypy_boto3_waf_regional.egg-info/requires.txt +1 -1
- {mypy_boto3_waf_regional-1.34.153 → mypy_boto3_waf_regional-1.35.93}/setup.py +8 -7
- mypy_boto3_waf_regional-1.34.153/mypy_boto3_waf_regional/type_defs.py +0 -1860
- mypy_boto3_waf_regional-1.34.153/mypy_boto3_waf_regional/type_defs.pyi +0 -1860
- mypy_boto3_waf_regional-1.34.153/mypy_boto3_waf_regional/version.py +0 -5
- {mypy_boto3_waf_regional-1.34.153 → mypy_boto3_waf_regional-1.35.93}/mypy_boto3_waf_regional/py.typed +0 -0
- {mypy_boto3_waf_regional-1.34.153 → mypy_boto3_waf_regional-1.35.93}/mypy_boto3_waf_regional.egg-info/SOURCES.txt +0 -0
- {mypy_boto3_waf_regional-1.34.153 → mypy_boto3_waf_regional-1.35.93}/mypy_boto3_waf_regional.egg-info/dependency_links.txt +0 -0
- {mypy_boto3_waf_regional-1.34.153 → mypy_boto3_waf_regional-1.35.93}/mypy_boto3_waf_regional.egg-info/not-zip-safe +0 -0
- {mypy_boto3_waf_regional-1.34.153 → mypy_boto3_waf_regional-1.35.93}/mypy_boto3_waf_regional.egg-info/top_level.txt +0 -0
- {mypy_boto3_waf_regional-1.34.153 → mypy_boto3_waf_regional-1.35.93}/setup.cfg +0 -0
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: mypy-boto3-waf-regional
|
|
3
|
-
Version: 1.
|
|
4
|
-
Summary: Type annotations for boto3
|
|
3
|
+
Version: 1.35.93
|
|
4
|
+
Summary: Type annotations for boto3 WAFRegional 1.35.93 service generated with mypy-boto3-builder 8.8.0
|
|
5
5
|
Home-page: https://github.com/youtype/mypy_boto3_builder
|
|
6
6
|
Author: Vlad Emelianov
|
|
7
7
|
Author-email: vlad.emelianov.nz@gmail.com
|
|
@@ -9,7 +9,7 @@ License: MIT License
|
|
|
9
9
|
Project-URL: Documentation, https://youtype.github.io/boto3_stubs_docs/mypy_boto3_waf_regional/
|
|
10
10
|
Project-URL: Source, https://github.com/youtype/mypy_boto3_builder
|
|
11
11
|
Project-URL: Tracker, https://github.com/youtype/mypy_boto3_builder/issues
|
|
12
|
-
Keywords: boto3 waf-regional type-annotations
|
|
12
|
+
Keywords: boto3 waf-regional boto3-stubs type-annotations mypy typeshed autocomplete
|
|
13
13
|
Classifier: Development Status :: 5 - Production/Stable
|
|
14
14
|
Classifier: Intended Audience :: Developers
|
|
15
15
|
Classifier: Environment :: Console
|
|
@@ -23,47 +23,49 @@ Classifier: Programming Language :: Python :: 3.10
|
|
|
23
23
|
Classifier: Programming Language :: Python :: 3.11
|
|
24
24
|
Classifier: Programming Language :: Python :: 3.12
|
|
25
25
|
Classifier: Programming Language :: Python :: 3.13
|
|
26
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
26
27
|
Classifier: Programming Language :: Python :: 3 :: Only
|
|
27
28
|
Classifier: Programming Language :: Python :: Implementation :: CPython
|
|
28
29
|
Classifier: Typing :: Stubs Only
|
|
29
30
|
Requires-Python: >=3.8
|
|
30
31
|
Description-Content-Type: text/markdown
|
|
31
32
|
License-File: LICENSE
|
|
32
|
-
Requires-Dist: typing-extensions
|
|
33
|
+
Requires-Dist: typing-extensions; python_version < "3.12"
|
|
33
34
|
|
|
34
35
|
<a id="mypy-boto3-waf-regional"></a>
|
|
35
36
|
|
|
36
37
|
# mypy-boto3-waf-regional
|
|
37
38
|
|
|
38
|
-
[](https://pypi.org/project/mypy-boto3-waf-regional)
|
|
39
|
-
[](https://pypi.org/project/mypy-boto3-waf-regional)
|
|
40
|
-
[](https://youtype.github.io/boto3_stubs_docs/
|
|
41
|
-
[](https://
|
|
39
|
+
[](https://pypi.org/project/mypy-boto3-waf-regional/)
|
|
40
|
+
[](https://pypi.org/project/mypy-boto3-waf-regional/)
|
|
41
|
+
[](https://youtype.github.io/boto3_stubs_docs/)
|
|
42
|
+
[](https://pypistats.org/packages/mypy-boto3-waf-regional)
|
|
42
43
|
|
|
43
44
|

|
|
44
45
|
|
|
45
46
|
Type annotations for
|
|
46
|
-
[boto3
|
|
47
|
-
|
|
47
|
+
[boto3 WAFRegional 1.35.93](https://pypi.org/project/boto3/) compatible with
|
|
48
|
+
[VSCode](https://code.visualstudio.com/),
|
|
48
49
|
[PyCharm](https://www.jetbrains.com/pycharm/),
|
|
49
50
|
[Emacs](https://www.gnu.org/software/emacs/),
|
|
50
51
|
[Sublime Text](https://www.sublimetext.com/),
|
|
51
52
|
[mypy](https://github.com/python/mypy),
|
|
52
53
|
[pyright](https://github.com/microsoft/pyright) and other tools.
|
|
53
54
|
|
|
54
|
-
Generated
|
|
55
|
-
[mypy-boto3-builder
|
|
55
|
+
Generated with
|
|
56
|
+
[mypy-boto3-builder 8.8.0](https://github.com/youtype/mypy_boto3_builder).
|
|
56
57
|
|
|
57
58
|
More information can be found on
|
|
58
59
|
[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
|
|
59
60
|
[mypy-boto3-waf-regional docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_waf_regional/).
|
|
60
61
|
|
|
61
|
-
See how it helps
|
|
62
|
+
See how it helps you find and fix potential bugs:
|
|
62
63
|
|
|
63
|
-

|
|
64
65
|
|
|
65
66
|
- [mypy-boto3-waf-regional](#mypy-boto3-waf-regional)
|
|
66
67
|
- [How to install](#how-to-install)
|
|
68
|
+
- [Generate locally (recommended)](<#generate-locally-(recommended)>)
|
|
67
69
|
- [VSCode extension](#vscode-extension)
|
|
68
70
|
- [From PyPI with pip](#from-pypi-with-pip)
|
|
69
71
|
- [How to uninstall](#how-to-uninstall)
|
|
@@ -75,6 +77,7 @@ See how it helps to find and fix potential bugs:
|
|
|
75
77
|
- [Other IDEs](#other-ides)
|
|
76
78
|
- [mypy](#mypy)
|
|
77
79
|
- [pyright](#pyright)
|
|
80
|
+
- [Pylint compatibility](#pylint-compatibility)
|
|
78
81
|
- [Explicit type annotations](#explicit-type-annotations)
|
|
79
82
|
- [Client annotations](#client-annotations)
|
|
80
83
|
- [Literals](#literals)
|
|
@@ -92,6 +95,21 @@ See how it helps to find and fix potential bugs:
|
|
|
92
95
|
|
|
93
96
|
## How to install
|
|
94
97
|
|
|
98
|
+
<a id="generate-locally-(recommended)"></a>
|
|
99
|
+
|
|
100
|
+
### Generate locally (recommended)
|
|
101
|
+
|
|
102
|
+
You can generate type annotations for `boto3` package locally with
|
|
103
|
+
`mypy_boto3_builder`. Use
|
|
104
|
+
[uv](https://docs.astral.sh/uv/getting-started/installation/) for build
|
|
105
|
+
isolation.
|
|
106
|
+
|
|
107
|
+
1. Run mypy-boto3-builder in your package root directory:
|
|
108
|
+
`uvx --with 'boto3==1.35.93' mypy_boto3_builder`
|
|
109
|
+
2. Select `boto3-stubs` AWS SDK.
|
|
110
|
+
3. Add `WAFRegional` service.
|
|
111
|
+
4. Use provided commands to install generated packages.
|
|
112
|
+
|
|
95
113
|
<a id="vscode-extension"></a>
|
|
96
114
|
|
|
97
115
|
### VSCode extension
|
|
@@ -112,12 +130,10 @@ Install `boto3-stubs` for `WAFRegional` service.
|
|
|
112
130
|
# install with boto3 type annotations
|
|
113
131
|
python -m pip install 'boto3-stubs[waf-regional]'
|
|
114
132
|
|
|
115
|
-
|
|
116
133
|
# Lite version does not provide session.client/resource overloads
|
|
117
134
|
# it is more RAM-friendly, but requires explicit type annotations
|
|
118
135
|
python -m pip install 'boto3-stubs-lite[waf-regional]'
|
|
119
136
|
|
|
120
|
-
|
|
121
137
|
# standalone installation
|
|
122
138
|
python -m pip install mypy-boto3-waf-regional
|
|
123
139
|
```
|
|
@@ -156,16 +172,31 @@ annotations required, write your `boto3` code as usual.
|
|
|
156
172
|
|
|
157
173
|
### PyCharm
|
|
158
174
|
|
|
159
|
-
|
|
175
|
+
> ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
|
|
176
|
+
> [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
|
|
177
|
+
> to use [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/) until
|
|
178
|
+
> the issue is resolved.
|
|
179
|
+
|
|
180
|
+
> ⚠️ If you experience slow performance and high CPU usage, try to disable
|
|
181
|
+
> `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
|
|
182
|
+
> [pyright](https://github.com/microsoft/pyright) instead.
|
|
183
|
+
|
|
184
|
+
> ⚠️ To continue using `PyCharm` type checker, you can try to replace
|
|
185
|
+
> `boto3-stubs` with
|
|
186
|
+
> [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/):
|
|
160
187
|
|
|
161
188
|
```bash
|
|
162
|
-
|
|
189
|
+
pip uninstall boto3-stubs
|
|
190
|
+
pip install boto3-stubs-lite
|
|
163
191
|
```
|
|
164
192
|
|
|
165
|
-
|
|
166
|
-
annotations **are required**.
|
|
193
|
+
Install `boto3-stubs[waf-regional]` in your environment:
|
|
167
194
|
|
|
168
|
-
|
|
195
|
+
```bash
|
|
196
|
+
python -m pip install 'boto3-stubs[waf-regional]'
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
Both type checking and code completion should now work.
|
|
169
200
|
|
|
170
201
|
<a id="emacs"></a>
|
|
171
202
|
|
|
@@ -230,7 +261,7 @@ should work.
|
|
|
230
261
|
- Install `boto3-stubs[waf-regional]` in your environment:
|
|
231
262
|
|
|
232
263
|
```bash
|
|
233
|
-
python -m pip install 'boto3-stubs[waf-regional]'
|
|
264
|
+
python -m pip install 'boto3-stubs[waf-regional]'
|
|
234
265
|
```
|
|
235
266
|
|
|
236
267
|
Type checking should now work. No explicit type annotations required, write
|
|
@@ -247,11 +278,36 @@ your `boto3` code as usual.
|
|
|
247
278
|
python -m pip install 'boto3-stubs[waf-regional]'
|
|
248
279
|
```
|
|
249
280
|
|
|
250
|
-
Optionally, you can install `boto3-stubs` to `typings`
|
|
281
|
+
Optionally, you can install `boto3-stubs` to `typings` directory.
|
|
251
282
|
|
|
252
283
|
Type checking should now work. No explicit type annotations required, write
|
|
253
284
|
your `boto3` code as usual.
|
|
254
285
|
|
|
286
|
+
<a id="pylint-compatibility"></a>
|
|
287
|
+
|
|
288
|
+
### Pylint compatibility
|
|
289
|
+
|
|
290
|
+
It is totally safe to use `TYPE_CHECKING` flag in order to avoid
|
|
291
|
+
`mypy-boto3-waf-regional` dependency in production. However, there is an issue
|
|
292
|
+
in `pylint` that it complains about undefined variables. To fix it, set all
|
|
293
|
+
types to `object` in non-`TYPE_CHECKING` mode.
|
|
294
|
+
|
|
295
|
+
```python
|
|
296
|
+
from typing import TYPE_CHECKING
|
|
297
|
+
|
|
298
|
+
if TYPE_CHECKING:
|
|
299
|
+
from mypy_boto3_ec2 import EC2Client, EC2ServiceResource
|
|
300
|
+
from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
|
|
301
|
+
from mypy_boto3_ec2.paginators import DescribeVolumesPaginator
|
|
302
|
+
else:
|
|
303
|
+
EC2Client = object
|
|
304
|
+
EC2ServiceResource = object
|
|
305
|
+
BundleTaskCompleteWaiter = object
|
|
306
|
+
DescribeVolumesPaginator = object
|
|
307
|
+
|
|
308
|
+
...
|
|
309
|
+
```
|
|
310
|
+
|
|
255
311
|
<a id="explicit-type-annotations"></a>
|
|
256
312
|
|
|
257
313
|
## Explicit type annotations
|
|
@@ -321,8 +377,7 @@ updates. It delivers drop-in type annotations for you and makes sure that:
|
|
|
321
377
|
annotations extracted from `botocore` schemas.
|
|
322
378
|
- Type annotations include up-to-date documentation.
|
|
323
379
|
- Link to documentation is provided for every method.
|
|
324
|
-
- Code is processed by [
|
|
325
|
-
[isort](https://github.com/PyCQA/isort) for readability.
|
|
380
|
+
- Code is processed by [ruff](https://docs.astral.sh/ruff/) for readability.
|
|
326
381
|
|
|
327
382
|
<a id="what's-new"></a>
|
|
328
383
|
|
|
@@ -2,35 +2,36 @@
|
|
|
2
2
|
|
|
3
3
|
# mypy-boto3-waf-regional
|
|
4
4
|
|
|
5
|
-
[](https://pypi.org/project/mypy-boto3-waf-regional)
|
|
6
|
-
[](https://pypi.org/project/mypy-boto3-waf-regional)
|
|
7
|
-
[](https://youtype.github.io/boto3_stubs_docs/
|
|
8
|
-
[](https://
|
|
5
|
+
[](https://pypi.org/project/mypy-boto3-waf-regional/)
|
|
6
|
+
[](https://pypi.org/project/mypy-boto3-waf-regional/)
|
|
7
|
+
[](https://youtype.github.io/boto3_stubs_docs/)
|
|
8
|
+
[](https://pypistats.org/packages/mypy-boto3-waf-regional)
|
|
9
9
|
|
|
10
10
|

|
|
11
11
|
|
|
12
12
|
Type annotations for
|
|
13
|
-
[boto3
|
|
14
|
-
|
|
13
|
+
[boto3 WAFRegional 1.35.93](https://pypi.org/project/boto3/) compatible with
|
|
14
|
+
[VSCode](https://code.visualstudio.com/),
|
|
15
15
|
[PyCharm](https://www.jetbrains.com/pycharm/),
|
|
16
16
|
[Emacs](https://www.gnu.org/software/emacs/),
|
|
17
17
|
[Sublime Text](https://www.sublimetext.com/),
|
|
18
18
|
[mypy](https://github.com/python/mypy),
|
|
19
19
|
[pyright](https://github.com/microsoft/pyright) and other tools.
|
|
20
20
|
|
|
21
|
-
Generated
|
|
22
|
-
[mypy-boto3-builder
|
|
21
|
+
Generated with
|
|
22
|
+
[mypy-boto3-builder 8.8.0](https://github.com/youtype/mypy_boto3_builder).
|
|
23
23
|
|
|
24
24
|
More information can be found on
|
|
25
25
|
[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
|
|
26
26
|
[mypy-boto3-waf-regional docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_waf_regional/).
|
|
27
27
|
|
|
28
|
-
See how it helps
|
|
28
|
+
See how it helps you find and fix potential bugs:
|
|
29
29
|
|
|
30
|
-

|
|
31
31
|
|
|
32
32
|
- [mypy-boto3-waf-regional](#mypy-boto3-waf-regional)
|
|
33
33
|
- [How to install](#how-to-install)
|
|
34
|
+
- [Generate locally (recommended)](<#generate-locally-(recommended)>)
|
|
34
35
|
- [VSCode extension](#vscode-extension)
|
|
35
36
|
- [From PyPI with pip](#from-pypi-with-pip)
|
|
36
37
|
- [How to uninstall](#how-to-uninstall)
|
|
@@ -42,6 +43,7 @@ See how it helps to find and fix potential bugs:
|
|
|
42
43
|
- [Other IDEs](#other-ides)
|
|
43
44
|
- [mypy](#mypy)
|
|
44
45
|
- [pyright](#pyright)
|
|
46
|
+
- [Pylint compatibility](#pylint-compatibility)
|
|
45
47
|
- [Explicit type annotations](#explicit-type-annotations)
|
|
46
48
|
- [Client annotations](#client-annotations)
|
|
47
49
|
- [Literals](#literals)
|
|
@@ -59,6 +61,21 @@ See how it helps to find and fix potential bugs:
|
|
|
59
61
|
|
|
60
62
|
## How to install
|
|
61
63
|
|
|
64
|
+
<a id="generate-locally-(recommended)"></a>
|
|
65
|
+
|
|
66
|
+
### Generate locally (recommended)
|
|
67
|
+
|
|
68
|
+
You can generate type annotations for `boto3` package locally with
|
|
69
|
+
`mypy_boto3_builder`. Use
|
|
70
|
+
[uv](https://docs.astral.sh/uv/getting-started/installation/) for build
|
|
71
|
+
isolation.
|
|
72
|
+
|
|
73
|
+
1. Run mypy-boto3-builder in your package root directory:
|
|
74
|
+
`uvx --with 'boto3==1.35.93' mypy_boto3_builder`
|
|
75
|
+
2. Select `boto3-stubs` AWS SDK.
|
|
76
|
+
3. Add `WAFRegional` service.
|
|
77
|
+
4. Use provided commands to install generated packages.
|
|
78
|
+
|
|
62
79
|
<a id="vscode-extension"></a>
|
|
63
80
|
|
|
64
81
|
### VSCode extension
|
|
@@ -79,12 +96,10 @@ Install `boto3-stubs` for `WAFRegional` service.
|
|
|
79
96
|
# install with boto3 type annotations
|
|
80
97
|
python -m pip install 'boto3-stubs[waf-regional]'
|
|
81
98
|
|
|
82
|
-
|
|
83
99
|
# Lite version does not provide session.client/resource overloads
|
|
84
100
|
# it is more RAM-friendly, but requires explicit type annotations
|
|
85
101
|
python -m pip install 'boto3-stubs-lite[waf-regional]'
|
|
86
102
|
|
|
87
|
-
|
|
88
103
|
# standalone installation
|
|
89
104
|
python -m pip install mypy-boto3-waf-regional
|
|
90
105
|
```
|
|
@@ -123,16 +138,31 @@ annotations required, write your `boto3` code as usual.
|
|
|
123
138
|
|
|
124
139
|
### PyCharm
|
|
125
140
|
|
|
126
|
-
|
|
141
|
+
> ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
|
|
142
|
+
> [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
|
|
143
|
+
> to use [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/) until
|
|
144
|
+
> the issue is resolved.
|
|
145
|
+
|
|
146
|
+
> ⚠️ If you experience slow performance and high CPU usage, try to disable
|
|
147
|
+
> `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
|
|
148
|
+
> [pyright](https://github.com/microsoft/pyright) instead.
|
|
149
|
+
|
|
150
|
+
> ⚠️ To continue using `PyCharm` type checker, you can try to replace
|
|
151
|
+
> `boto3-stubs` with
|
|
152
|
+
> [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/):
|
|
127
153
|
|
|
128
154
|
```bash
|
|
129
|
-
|
|
155
|
+
pip uninstall boto3-stubs
|
|
156
|
+
pip install boto3-stubs-lite
|
|
130
157
|
```
|
|
131
158
|
|
|
132
|
-
|
|
133
|
-
annotations **are required**.
|
|
159
|
+
Install `boto3-stubs[waf-regional]` in your environment:
|
|
134
160
|
|
|
135
|
-
|
|
161
|
+
```bash
|
|
162
|
+
python -m pip install 'boto3-stubs[waf-regional]'
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
Both type checking and code completion should now work.
|
|
136
166
|
|
|
137
167
|
<a id="emacs"></a>
|
|
138
168
|
|
|
@@ -197,7 +227,7 @@ should work.
|
|
|
197
227
|
- Install `boto3-stubs[waf-regional]` in your environment:
|
|
198
228
|
|
|
199
229
|
```bash
|
|
200
|
-
python -m pip install 'boto3-stubs[waf-regional]'
|
|
230
|
+
python -m pip install 'boto3-stubs[waf-regional]'
|
|
201
231
|
```
|
|
202
232
|
|
|
203
233
|
Type checking should now work. No explicit type annotations required, write
|
|
@@ -214,11 +244,36 @@ your `boto3` code as usual.
|
|
|
214
244
|
python -m pip install 'boto3-stubs[waf-regional]'
|
|
215
245
|
```
|
|
216
246
|
|
|
217
|
-
Optionally, you can install `boto3-stubs` to `typings`
|
|
247
|
+
Optionally, you can install `boto3-stubs` to `typings` directory.
|
|
218
248
|
|
|
219
249
|
Type checking should now work. No explicit type annotations required, write
|
|
220
250
|
your `boto3` code as usual.
|
|
221
251
|
|
|
252
|
+
<a id="pylint-compatibility"></a>
|
|
253
|
+
|
|
254
|
+
### Pylint compatibility
|
|
255
|
+
|
|
256
|
+
It is totally safe to use `TYPE_CHECKING` flag in order to avoid
|
|
257
|
+
`mypy-boto3-waf-regional` dependency in production. However, there is an issue
|
|
258
|
+
in `pylint` that it complains about undefined variables. To fix it, set all
|
|
259
|
+
types to `object` in non-`TYPE_CHECKING` mode.
|
|
260
|
+
|
|
261
|
+
```python
|
|
262
|
+
from typing import TYPE_CHECKING
|
|
263
|
+
|
|
264
|
+
if TYPE_CHECKING:
|
|
265
|
+
from mypy_boto3_ec2 import EC2Client, EC2ServiceResource
|
|
266
|
+
from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
|
|
267
|
+
from mypy_boto3_ec2.paginators import DescribeVolumesPaginator
|
|
268
|
+
else:
|
|
269
|
+
EC2Client = object
|
|
270
|
+
EC2ServiceResource = object
|
|
271
|
+
BundleTaskCompleteWaiter = object
|
|
272
|
+
DescribeVolumesPaginator = object
|
|
273
|
+
|
|
274
|
+
...
|
|
275
|
+
```
|
|
276
|
+
|
|
222
277
|
<a id="explicit-type-annotations"></a>
|
|
223
278
|
|
|
224
279
|
## Explicit type annotations
|
|
@@ -288,8 +343,7 @@ updates. It delivers drop-in type annotations for you and makes sure that:
|
|
|
288
343
|
annotations extracted from `botocore` schemas.
|
|
289
344
|
- Type annotations include up-to-date documentation.
|
|
290
345
|
- Link to documentation is provided for every method.
|
|
291
|
-
- Code is processed by [
|
|
292
|
-
[isort](https://github.com/PyCQA/isort) for readability.
|
|
346
|
+
- Code is processed by [ruff](https://docs.astral.sh/ruff/) for readability.
|
|
293
347
|
|
|
294
348
|
<a id="what's-new"></a>
|
|
295
349
|
|
|
@@ -13,10 +13,13 @@ Usage::
|
|
|
13
13
|
session = Session()
|
|
14
14
|
client: WAFRegionalClient = session.client("waf-regional")
|
|
15
15
|
```
|
|
16
|
+
|
|
17
|
+
Copyright 2025 Vlad Emelianov
|
|
16
18
|
"""
|
|
17
19
|
|
|
18
20
|
from .client import WAFRegionalClient
|
|
19
21
|
|
|
20
22
|
Client = WAFRegionalClient
|
|
21
23
|
|
|
24
|
+
|
|
22
25
|
__all__ = ("Client", "WAFRegionalClient")
|
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
"""
|
|
2
2
|
Main CLI entrypoint.
|
|
3
|
+
|
|
4
|
+
Copyright 2025 Vlad Emelianov
|
|
3
5
|
"""
|
|
4
6
|
|
|
5
7
|
import sys
|
|
@@ -9,14 +11,14 @@ def print_info() -> None:
|
|
|
9
11
|
"""
|
|
10
12
|
Print package info to stdout.
|
|
11
13
|
"""
|
|
12
|
-
|
|
13
|
-
"Type annotations for boto3
|
|
14
|
-
"Version: 1.
|
|
15
|
-
"Builder version:
|
|
14
|
+
sys.stdout.write(
|
|
15
|
+
"Type annotations for boto3 WAFRegional 1.35.93\n"
|
|
16
|
+
"Version: 1.35.93\n"
|
|
17
|
+
"Builder version: 8.8.0\n"
|
|
16
18
|
"Docs: https://youtype.github.io/boto3_stubs_docs/mypy_boto3_waf_regional//\n"
|
|
17
|
-
"Boto3 docs: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/waf-regional.html#
|
|
19
|
+
"Boto3 docs: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/waf-regional.html#wafregional\n"
|
|
18
20
|
"Other services: https://pypi.org/project/boto3-stubs/\n"
|
|
19
|
-
"Changelog: https://github.com/youtype/mypy_boto3_builder/releases"
|
|
21
|
+
"Changelog: https://github.com/youtype/mypy_boto3_builder/releases\n"
|
|
20
22
|
)
|
|
21
23
|
|
|
22
24
|
|
|
@@ -24,7 +26,7 @@ def print_version() -> None:
|
|
|
24
26
|
"""
|
|
25
27
|
Print package version to stdout.
|
|
26
28
|
"""
|
|
27
|
-
|
|
29
|
+
sys.stdout.write("1.35.93\n")
|
|
28
30
|
|
|
29
31
|
|
|
30
32
|
def main() -> None:
|
|
@@ -32,7 +34,8 @@ def main() -> None:
|
|
|
32
34
|
Main CLI entrypoint.
|
|
33
35
|
"""
|
|
34
36
|
if "--version" in sys.argv:
|
|
35
|
-
|
|
37
|
+
print_version()
|
|
38
|
+
return
|
|
36
39
|
print_info()
|
|
37
40
|
|
|
38
41
|
|