mypy-boto3-kinesis 1.35.26__tar.gz → 1.36.0__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.
- {mypy_boto3_kinesis-1.35.26 → mypy_boto3_kinesis-1.36.0}/LICENSE +1 -1
- {mypy_boto3_kinesis-1.35.26/mypy_boto3_kinesis.egg-info → mypy_boto3_kinesis-1.36.0}/PKG-INFO +90 -23
- mypy_boto3_kinesis-1.35.26/PKG-INFO → mypy_boto3_kinesis-1.36.0/README.md +72 -51
- mypy_boto3_kinesis-1.35.26/mypy_boto3_kinesis/__init__.pyi → mypy_boto3_kinesis-1.36.0/mypy_boto3_kinesis/__init__.py +3 -0
- mypy_boto3_kinesis-1.35.26/mypy_boto3_kinesis/__init__.py → mypy_boto3_kinesis-1.36.0/mypy_boto3_kinesis/__init__.pyi +2 -1
- {mypy_boto3_kinesis-1.35.26 → mypy_boto3_kinesis-1.36.0}/mypy_boto3_kinesis/__main__.py +11 -8
- {mypy_boto3_kinesis-1.35.26 → mypy_boto3_kinesis-1.36.0}/mypy_boto3_kinesis/client.py +115 -111
- {mypy_boto3_kinesis-1.35.26 → mypy_boto3_kinesis-1.36.0}/mypy_boto3_kinesis/client.pyi +115 -110
- mypy_boto3_kinesis-1.35.26/mypy_boto3_kinesis/literals.pyi → mypy_boto3_kinesis-1.36.0/mypy_boto3_kinesis/literals.py +32 -10
- mypy_boto3_kinesis-1.35.26/mypy_boto3_kinesis/literals.py → mypy_boto3_kinesis-1.36.0/mypy_boto3_kinesis/literals.pyi +30 -12
- {mypy_boto3_kinesis-1.35.26 → mypy_boto3_kinesis-1.36.0}/mypy_boto3_kinesis/paginator.py +56 -38
- {mypy_boto3_kinesis-1.35.26 → mypy_boto3_kinesis-1.36.0}/mypy_boto3_kinesis/paginator.pyi +53 -37
- mypy_boto3_kinesis-1.36.0/mypy_boto3_kinesis/type_defs.py +686 -0
- mypy_boto3_kinesis-1.36.0/mypy_boto3_kinesis/type_defs.pyi +599 -0
- mypy_boto3_kinesis-1.36.0/mypy_boto3_kinesis/version.py +7 -0
- mypy_boto3_kinesis-1.35.26/mypy_boto3_kinesis/waiter.pyi → mypy_boto3_kinesis-1.36.0/mypy_boto3_kinesis/waiter.py +21 -11
- mypy_boto3_kinesis-1.35.26/mypy_boto3_kinesis/waiter.py → mypy_boto3_kinesis-1.36.0/mypy_boto3_kinesis/waiter.pyi +16 -16
- mypy_boto3_kinesis-1.35.26/README.md → mypy_boto3_kinesis-1.36.0/mypy_boto3_kinesis.egg-info/PKG-INFO +118 -18
- {mypy_boto3_kinesis-1.35.26 → mypy_boto3_kinesis-1.36.0}/mypy_boto3_kinesis.egg-info/requires.txt +1 -1
- {mypy_boto3_kinesis-1.35.26 → mypy_boto3_kinesis-1.36.0}/setup.py +7 -6
- mypy_boto3_kinesis-1.35.26/mypy_boto3_kinesis/type_defs.py +0 -848
- mypy_boto3_kinesis-1.35.26/mypy_boto3_kinesis/type_defs.pyi +0 -847
- mypy_boto3_kinesis-1.35.26/mypy_boto3_kinesis/version.py +0 -5
- {mypy_boto3_kinesis-1.35.26 → mypy_boto3_kinesis-1.36.0}/mypy_boto3_kinesis/py.typed +0 -0
- {mypy_boto3_kinesis-1.35.26 → mypy_boto3_kinesis-1.36.0}/mypy_boto3_kinesis.egg-info/SOURCES.txt +0 -0
- {mypy_boto3_kinesis-1.35.26 → mypy_boto3_kinesis-1.36.0}/mypy_boto3_kinesis.egg-info/dependency_links.txt +0 -0
- {mypy_boto3_kinesis-1.35.26 → mypy_boto3_kinesis-1.36.0}/mypy_boto3_kinesis.egg-info/not-zip-safe +0 -0
- {mypy_boto3_kinesis-1.35.26 → mypy_boto3_kinesis-1.36.0}/mypy_boto3_kinesis.egg-info/top_level.txt +0 -0
- {mypy_boto3_kinesis-1.35.26 → mypy_boto3_kinesis-1.36.0}/setup.cfg +0 -0
{mypy_boto3_kinesis-1.35.26/mypy_boto3_kinesis.egg-info → mypy_boto3_kinesis-1.36.0}/PKG-INFO
RENAMED
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
Metadata-Version: 2.
|
|
1
|
+
Metadata-Version: 2.2
|
|
2
2
|
Name: mypy-boto3-kinesis
|
|
3
|
-
Version: 1.
|
|
4
|
-
Summary: Type annotations for boto3
|
|
3
|
+
Version: 1.36.0
|
|
4
|
+
Summary: Type annotations for boto3 Kinesis 1.36.0 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_kinesis/
|
|
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 kinesis type-annotations
|
|
12
|
+
Keywords: boto3 kinesis 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,60 @@ 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"
|
|
34
|
+
Dynamic: author
|
|
35
|
+
Dynamic: author-email
|
|
36
|
+
Dynamic: classifier
|
|
37
|
+
Dynamic: description
|
|
38
|
+
Dynamic: description-content-type
|
|
39
|
+
Dynamic: home-page
|
|
40
|
+
Dynamic: keywords
|
|
41
|
+
Dynamic: license
|
|
42
|
+
Dynamic: project-url
|
|
43
|
+
Dynamic: requires-dist
|
|
44
|
+
Dynamic: requires-python
|
|
45
|
+
Dynamic: summary
|
|
33
46
|
|
|
34
47
|
<a id="mypy-boto3-kinesis"></a>
|
|
35
48
|
|
|
36
49
|
# mypy-boto3-kinesis
|
|
37
50
|
|
|
38
|
-
[](https://pypi.org/project/mypy-boto3-kinesis)
|
|
39
|
-
[](https://pypi.org/project/mypy-boto3-kinesis)
|
|
40
|
-
[](https://youtype.github.io/boto3_stubs_docs/
|
|
41
|
-
[](https://
|
|
51
|
+
[](https://pypi.org/project/mypy-boto3-kinesis/)
|
|
52
|
+
[](https://pypi.org/project/mypy-boto3-kinesis/)
|
|
53
|
+
[](https://youtype.github.io/boto3_stubs_docs/)
|
|
54
|
+
[](https://pypistats.org/packages/mypy-boto3-kinesis)
|
|
42
55
|
|
|
43
56
|

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

|
|
64
76
|
|
|
65
77
|
- [mypy-boto3-kinesis](#mypy-boto3-kinesis)
|
|
66
78
|
- [How to install](#how-to-install)
|
|
79
|
+
- [Generate locally (recommended)](<#generate-locally-(recommended)>)
|
|
67
80
|
- [VSCode extension](#vscode-extension)
|
|
68
81
|
- [From PyPI with pip](#from-pypi-with-pip)
|
|
69
82
|
- [How to uninstall](#how-to-uninstall)
|
|
@@ -75,6 +88,7 @@ See how it helps to find and fix potential bugs:
|
|
|
75
88
|
- [Other IDEs](#other-ides)
|
|
76
89
|
- [mypy](#mypy)
|
|
77
90
|
- [pyright](#pyright)
|
|
91
|
+
- [Pylint compatibility](#pylint-compatibility)
|
|
78
92
|
- [Explicit type annotations](#explicit-type-annotations)
|
|
79
93
|
- [Client annotations](#client-annotations)
|
|
80
94
|
- [Paginators annotations](#paginators-annotations)
|
|
@@ -94,6 +108,21 @@ See how it helps to find and fix potential bugs:
|
|
|
94
108
|
|
|
95
109
|
## How to install
|
|
96
110
|
|
|
111
|
+
<a id="generate-locally-(recommended)"></a>
|
|
112
|
+
|
|
113
|
+
### Generate locally (recommended)
|
|
114
|
+
|
|
115
|
+
You can generate type annotations for `boto3` package locally with
|
|
116
|
+
`mypy_boto3_builder`. Use
|
|
117
|
+
[uv](https://docs.astral.sh/uv/getting-started/installation/) for build
|
|
118
|
+
isolation.
|
|
119
|
+
|
|
120
|
+
1. Run mypy-boto3-builder in your package root directory:
|
|
121
|
+
`uvx --with 'boto3==1.36.0' mypy_boto3_builder`
|
|
122
|
+
2. Select `boto3-stubs` AWS SDK.
|
|
123
|
+
3. Add `Kinesis` service.
|
|
124
|
+
4. Use provided commands to install generated packages.
|
|
125
|
+
|
|
97
126
|
<a id="vscode-extension"></a>
|
|
98
127
|
|
|
99
128
|
### VSCode extension
|
|
@@ -114,12 +143,10 @@ Install `boto3-stubs` for `Kinesis` service.
|
|
|
114
143
|
# install with boto3 type annotations
|
|
115
144
|
python -m pip install 'boto3-stubs[kinesis]'
|
|
116
145
|
|
|
117
|
-
|
|
118
146
|
# Lite version does not provide session.client/resource overloads
|
|
119
147
|
# it is more RAM-friendly, but requires explicit type annotations
|
|
120
148
|
python -m pip install 'boto3-stubs-lite[kinesis]'
|
|
121
149
|
|
|
122
|
-
|
|
123
150
|
# standalone installation
|
|
124
151
|
python -m pip install mypy-boto3-kinesis
|
|
125
152
|
```
|
|
@@ -158,16 +185,31 @@ annotations required, write your `boto3` code as usual.
|
|
|
158
185
|
|
|
159
186
|
### PyCharm
|
|
160
187
|
|
|
161
|
-
|
|
188
|
+
> ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
|
|
189
|
+
> [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
|
|
190
|
+
> to use [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/) until
|
|
191
|
+
> the issue is resolved.
|
|
192
|
+
|
|
193
|
+
> ⚠️ If you experience slow performance and high CPU usage, try to disable
|
|
194
|
+
> `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
|
|
195
|
+
> [pyright](https://github.com/microsoft/pyright) instead.
|
|
196
|
+
|
|
197
|
+
> ⚠️ To continue using `PyCharm` type checker, you can try to replace
|
|
198
|
+
> `boto3-stubs` with
|
|
199
|
+
> [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/):
|
|
162
200
|
|
|
163
201
|
```bash
|
|
164
|
-
|
|
202
|
+
pip uninstall boto3-stubs
|
|
203
|
+
pip install boto3-stubs-lite
|
|
165
204
|
```
|
|
166
205
|
|
|
167
|
-
|
|
168
|
-
|
|
206
|
+
Install `boto3-stubs[kinesis]` in your environment:
|
|
207
|
+
|
|
208
|
+
```bash
|
|
209
|
+
python -m pip install 'boto3-stubs[kinesis]'
|
|
210
|
+
```
|
|
169
211
|
|
|
170
|
-
|
|
212
|
+
Both type checking and code completion should now work.
|
|
171
213
|
|
|
172
214
|
<a id="emacs"></a>
|
|
173
215
|
|
|
@@ -253,6 +295,31 @@ Optionally, you can install `boto3-stubs` to `typings` directory.
|
|
|
253
295
|
Type checking should now work. No explicit type annotations required, write
|
|
254
296
|
your `boto3` code as usual.
|
|
255
297
|
|
|
298
|
+
<a id="pylint-compatibility"></a>
|
|
299
|
+
|
|
300
|
+
### Pylint compatibility
|
|
301
|
+
|
|
302
|
+
It is totally safe to use `TYPE_CHECKING` flag in order to avoid
|
|
303
|
+
`mypy-boto3-kinesis` dependency in production. However, there is an issue in
|
|
304
|
+
`pylint` that it complains about undefined variables. To fix it, set all types
|
|
305
|
+
to `object` in non-`TYPE_CHECKING` mode.
|
|
306
|
+
|
|
307
|
+
```python
|
|
308
|
+
from typing import TYPE_CHECKING
|
|
309
|
+
|
|
310
|
+
if TYPE_CHECKING:
|
|
311
|
+
from mypy_boto3_ec2 import EC2Client, EC2ServiceResource
|
|
312
|
+
from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
|
|
313
|
+
from mypy_boto3_ec2.paginators import DescribeVolumesPaginator
|
|
314
|
+
else:
|
|
315
|
+
EC2Client = object
|
|
316
|
+
EC2ServiceResource = object
|
|
317
|
+
BundleTaskCompleteWaiter = object
|
|
318
|
+
DescribeVolumesPaginator = object
|
|
319
|
+
|
|
320
|
+
...
|
|
321
|
+
```
|
|
322
|
+
|
|
256
323
|
<a id="explicit-type-annotations"></a>
|
|
257
324
|
|
|
258
325
|
## Explicit type annotations
|
|
@@ -1,69 +1,36 @@
|
|
|
1
|
-
Metadata-Version: 2.1
|
|
2
|
-
Name: mypy-boto3-kinesis
|
|
3
|
-
Version: 1.35.26
|
|
4
|
-
Summary: Type annotations for boto3.Kinesis 1.35.26 service generated with mypy-boto3-builder 8.1.2
|
|
5
|
-
Home-page: https://github.com/youtype/mypy_boto3_builder
|
|
6
|
-
Author: Vlad Emelianov
|
|
7
|
-
Author-email: vlad.emelianov.nz@gmail.com
|
|
8
|
-
License: MIT License
|
|
9
|
-
Project-URL: Documentation, https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/
|
|
10
|
-
Project-URL: Source, https://github.com/youtype/mypy_boto3_builder
|
|
11
|
-
Project-URL: Tracker, https://github.com/youtype/mypy_boto3_builder/issues
|
|
12
|
-
Keywords: boto3 kinesis type-annotations botocore mypy typeshed autocomplete
|
|
13
|
-
Classifier: Development Status :: 5 - Production/Stable
|
|
14
|
-
Classifier: Intended Audience :: Developers
|
|
15
|
-
Classifier: Environment :: Console
|
|
16
|
-
Classifier: License :: OSI Approved :: MIT License
|
|
17
|
-
Classifier: Natural Language :: English
|
|
18
|
-
Classifier: Operating System :: OS Independent
|
|
19
|
-
Classifier: Programming Language :: Python :: 3
|
|
20
|
-
Classifier: Programming Language :: Python :: 3.8
|
|
21
|
-
Classifier: Programming Language :: Python :: 3.9
|
|
22
|
-
Classifier: Programming Language :: Python :: 3.10
|
|
23
|
-
Classifier: Programming Language :: Python :: 3.11
|
|
24
|
-
Classifier: Programming Language :: Python :: 3.12
|
|
25
|
-
Classifier: Programming Language :: Python :: 3.13
|
|
26
|
-
Classifier: Programming Language :: Python :: 3 :: Only
|
|
27
|
-
Classifier: Programming Language :: Python :: Implementation :: CPython
|
|
28
|
-
Classifier: Typing :: Stubs Only
|
|
29
|
-
Requires-Python: >=3.8
|
|
30
|
-
Description-Content-Type: text/markdown
|
|
31
|
-
License-File: LICENSE
|
|
32
|
-
Requires-Dist: typing-extensions>=4.1.0; python_version < "3.12"
|
|
33
|
-
|
|
34
1
|
<a id="mypy-boto3-kinesis"></a>
|
|
35
2
|
|
|
36
3
|
# mypy-boto3-kinesis
|
|
37
4
|
|
|
38
|
-
[](https://pypi.org/project/mypy-boto3-kinesis)
|
|
39
|
-
[](https://pypi.org/project/mypy-boto3-kinesis)
|
|
40
|
-
[](https://youtype.github.io/boto3_stubs_docs/
|
|
41
|
-
[](https://
|
|
5
|
+
[](https://pypi.org/project/mypy-boto3-kinesis/)
|
|
6
|
+
[](https://pypi.org/project/mypy-boto3-kinesis/)
|
|
7
|
+
[](https://youtype.github.io/boto3_stubs_docs/)
|
|
8
|
+
[](https://pypistats.org/packages/mypy-boto3-kinesis)
|
|
42
9
|
|
|
43
10
|

|
|
44
11
|
|
|
45
|
-
Type annotations for
|
|
46
|
-
[
|
|
47
|
-
service compatible with [VSCode](https://code.visualstudio.com/),
|
|
12
|
+
Type annotations for [boto3 Kinesis 1.36.0](https://pypi.org/project/boto3/)
|
|
13
|
+
compatible with [VSCode](https://code.visualstudio.com/),
|
|
48
14
|
[PyCharm](https://www.jetbrains.com/pycharm/),
|
|
49
15
|
[Emacs](https://www.gnu.org/software/emacs/),
|
|
50
16
|
[Sublime Text](https://www.sublimetext.com/),
|
|
51
17
|
[mypy](https://github.com/python/mypy),
|
|
52
18
|
[pyright](https://github.com/microsoft/pyright) and other tools.
|
|
53
19
|
|
|
54
|
-
Generated
|
|
55
|
-
[mypy-boto3-builder 8.
|
|
20
|
+
Generated with
|
|
21
|
+
[mypy-boto3-builder 8.8.0](https://github.com/youtype/mypy_boto3_builder).
|
|
56
22
|
|
|
57
23
|
More information can be found on
|
|
58
24
|
[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
|
|
59
25
|
[mypy-boto3-kinesis docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/).
|
|
60
26
|
|
|
61
|
-
See how it helps
|
|
27
|
+
See how it helps you find and fix potential bugs:
|
|
62
28
|
|
|
63
|
-

|
|
64
30
|
|
|
65
31
|
- [mypy-boto3-kinesis](#mypy-boto3-kinesis)
|
|
66
32
|
- [How to install](#how-to-install)
|
|
33
|
+
- [Generate locally (recommended)](<#generate-locally-(recommended)>)
|
|
67
34
|
- [VSCode extension](#vscode-extension)
|
|
68
35
|
- [From PyPI with pip](#from-pypi-with-pip)
|
|
69
36
|
- [How to uninstall](#how-to-uninstall)
|
|
@@ -75,6 +42,7 @@ See how it helps to find and fix potential bugs:
|
|
|
75
42
|
- [Other IDEs](#other-ides)
|
|
76
43
|
- [mypy](#mypy)
|
|
77
44
|
- [pyright](#pyright)
|
|
45
|
+
- [Pylint compatibility](#pylint-compatibility)
|
|
78
46
|
- [Explicit type annotations](#explicit-type-annotations)
|
|
79
47
|
- [Client annotations](#client-annotations)
|
|
80
48
|
- [Paginators annotations](#paginators-annotations)
|
|
@@ -94,6 +62,21 @@ See how it helps to find and fix potential bugs:
|
|
|
94
62
|
|
|
95
63
|
## How to install
|
|
96
64
|
|
|
65
|
+
<a id="generate-locally-(recommended)"></a>
|
|
66
|
+
|
|
67
|
+
### Generate locally (recommended)
|
|
68
|
+
|
|
69
|
+
You can generate type annotations for `boto3` package locally with
|
|
70
|
+
`mypy_boto3_builder`. Use
|
|
71
|
+
[uv](https://docs.astral.sh/uv/getting-started/installation/) for build
|
|
72
|
+
isolation.
|
|
73
|
+
|
|
74
|
+
1. Run mypy-boto3-builder in your package root directory:
|
|
75
|
+
`uvx --with 'boto3==1.36.0' mypy_boto3_builder`
|
|
76
|
+
2. Select `boto3-stubs` AWS SDK.
|
|
77
|
+
3. Add `Kinesis` service.
|
|
78
|
+
4. Use provided commands to install generated packages.
|
|
79
|
+
|
|
97
80
|
<a id="vscode-extension"></a>
|
|
98
81
|
|
|
99
82
|
### VSCode extension
|
|
@@ -114,12 +97,10 @@ Install `boto3-stubs` for `Kinesis` service.
|
|
|
114
97
|
# install with boto3 type annotations
|
|
115
98
|
python -m pip install 'boto3-stubs[kinesis]'
|
|
116
99
|
|
|
117
|
-
|
|
118
100
|
# Lite version does not provide session.client/resource overloads
|
|
119
101
|
# it is more RAM-friendly, but requires explicit type annotations
|
|
120
102
|
python -m pip install 'boto3-stubs-lite[kinesis]'
|
|
121
103
|
|
|
122
|
-
|
|
123
104
|
# standalone installation
|
|
124
105
|
python -m pip install mypy-boto3-kinesis
|
|
125
106
|
```
|
|
@@ -158,16 +139,31 @@ annotations required, write your `boto3` code as usual.
|
|
|
158
139
|
|
|
159
140
|
### PyCharm
|
|
160
141
|
|
|
161
|
-
|
|
142
|
+
> ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
|
|
143
|
+
> [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
|
|
144
|
+
> to use [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/) until
|
|
145
|
+
> the issue is resolved.
|
|
146
|
+
|
|
147
|
+
> ⚠️ If you experience slow performance and high CPU usage, try to disable
|
|
148
|
+
> `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
|
|
149
|
+
> [pyright](https://github.com/microsoft/pyright) instead.
|
|
150
|
+
|
|
151
|
+
> ⚠️ To continue using `PyCharm` type checker, you can try to replace
|
|
152
|
+
> `boto3-stubs` with
|
|
153
|
+
> [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/):
|
|
162
154
|
|
|
163
155
|
```bash
|
|
164
|
-
|
|
156
|
+
pip uninstall boto3-stubs
|
|
157
|
+
pip install boto3-stubs-lite
|
|
165
158
|
```
|
|
166
159
|
|
|
167
|
-
|
|
168
|
-
annotations **are required**.
|
|
160
|
+
Install `boto3-stubs[kinesis]` in your environment:
|
|
169
161
|
|
|
170
|
-
|
|
162
|
+
```bash
|
|
163
|
+
python -m pip install 'boto3-stubs[kinesis]'
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
Both type checking and code completion should now work.
|
|
171
167
|
|
|
172
168
|
<a id="emacs"></a>
|
|
173
169
|
|
|
@@ -253,6 +249,31 @@ Optionally, you can install `boto3-stubs` to `typings` directory.
|
|
|
253
249
|
Type checking should now work. No explicit type annotations required, write
|
|
254
250
|
your `boto3` code as usual.
|
|
255
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-kinesis` dependency in production. However, there is an issue in
|
|
258
|
+
`pylint` that it complains about undefined variables. To fix it, set all types
|
|
259
|
+
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
|
+
|
|
256
277
|
<a id="explicit-type-annotations"></a>
|
|
257
278
|
|
|
258
279
|
## Explicit type annotations
|
|
@@ -27,6 +27,8 @@ Usage::
|
|
|
27
27
|
list_stream_consumers_paginator: ListStreamConsumersPaginator = client.get_paginator("list_stream_consumers")
|
|
28
28
|
list_streams_paginator: ListStreamsPaginator = client.get_paginator("list_streams")
|
|
29
29
|
```
|
|
30
|
+
|
|
31
|
+
Copyright 2025 Vlad Emelianov
|
|
30
32
|
"""
|
|
31
33
|
|
|
32
34
|
from .client import KinesisClient
|
|
@@ -40,6 +42,7 @@ from .waiter import StreamExistsWaiter, StreamNotExistsWaiter
|
|
|
40
42
|
|
|
41
43
|
Client = KinesisClient
|
|
42
44
|
|
|
45
|
+
|
|
43
46
|
__all__ = (
|
|
44
47
|
"Client",
|
|
45
48
|
"DescribeStreamPaginator",
|
|
@@ -27,6 +27,8 @@ Usage::
|
|
|
27
27
|
list_stream_consumers_paginator: ListStreamConsumersPaginator = client.get_paginator("list_stream_consumers")
|
|
28
28
|
list_streams_paginator: ListStreamsPaginator = client.get_paginator("list_streams")
|
|
29
29
|
```
|
|
30
|
+
|
|
31
|
+
Copyright 2025 Vlad Emelianov
|
|
30
32
|
"""
|
|
31
33
|
|
|
32
34
|
from .client import KinesisClient
|
|
@@ -40,7 +42,6 @@ from .waiter import StreamExistsWaiter, StreamNotExistsWaiter
|
|
|
40
42
|
|
|
41
43
|
Client = KinesisClient
|
|
42
44
|
|
|
43
|
-
|
|
44
45
|
__all__ = (
|
|
45
46
|
"Client",
|
|
46
47
|
"DescribeStreamPaginator",
|
|
@@ -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: 8.
|
|
14
|
+
sys.stdout.write(
|
|
15
|
+
"Type annotations for boto3 Kinesis 1.36.0\n"
|
|
16
|
+
"Version: 1.36.0\n"
|
|
17
|
+
"Builder version: 8.8.0\n"
|
|
16
18
|
"Docs: https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis//\n"
|
|
17
|
-
"Boto3 docs: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html#
|
|
19
|
+
"Boto3 docs: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html#kinesis\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.36.0\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
|
|