types-boto3-dsql 1.35.74__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.
Files changed (26) hide show
  1. types_boto3_dsql-1.35.74/LICENSE +21 -0
  2. types_boto3_dsql-1.35.74/PKG-INFO +475 -0
  3. types_boto3_dsql-1.35.74/README.md +441 -0
  4. types_boto3_dsql-1.35.74/setup.cfg +4 -0
  5. types_boto3_dsql-1.35.74/setup.py +56 -0
  6. types_boto3_dsql-1.35.74/types_boto3_dsql/__init__.py +41 -0
  7. types_boto3_dsql-1.35.74/types_boto3_dsql/__init__.pyi +40 -0
  8. types_boto3_dsql-1.35.74/types_boto3_dsql/__main__.py +42 -0
  9. types_boto3_dsql-1.35.74/types_boto3_dsql/client.py +240 -0
  10. types_boto3_dsql-1.35.74/types_boto3_dsql/client.pyi +236 -0
  11. types_boto3_dsql-1.35.74/types_boto3_dsql/literals.py +460 -0
  12. types_boto3_dsql-1.35.74/types_boto3_dsql/literals.pyi +458 -0
  13. types_boto3_dsql-1.35.74/types_boto3_dsql/paginator.py +63 -0
  14. types_boto3_dsql-1.35.74/types_boto3_dsql/paginator.pyi +58 -0
  15. types_boto3_dsql-1.35.74/types_boto3_dsql/py.typed +0 -0
  16. types_boto3_dsql-1.35.74/types_boto3_dsql/type_defs.py +211 -0
  17. types_boto3_dsql-1.35.74/types_boto3_dsql/type_defs.pyi +184 -0
  18. types_boto3_dsql-1.35.74/types_boto3_dsql/version.py +7 -0
  19. types_boto3_dsql-1.35.74/types_boto3_dsql/waiter.py +68 -0
  20. types_boto3_dsql-1.35.74/types_boto3_dsql/waiter.pyi +63 -0
  21. types_boto3_dsql-1.35.74/types_boto3_dsql.egg-info/PKG-INFO +475 -0
  22. types_boto3_dsql-1.35.74/types_boto3_dsql.egg-info/SOURCES.txt +24 -0
  23. types_boto3_dsql-1.35.74/types_boto3_dsql.egg-info/dependency_links.txt +1 -0
  24. types_boto3_dsql-1.35.74/types_boto3_dsql.egg-info/not-zip-safe +1 -0
  25. types_boto3_dsql-1.35.74/types_boto3_dsql.egg-info/requires.txt +3 -0
  26. types_boto3_dsql-1.35.74/types_boto3_dsql.egg-info/top_level.txt +1 -0
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2024 Vlad Emelianov
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,475 @@
1
+ Metadata-Version: 2.1
2
+ Name: types-boto3-dsql
3
+ Version: 1.35.74
4
+ Summary: Type annotations for boto3 AuroraDSQL 1.35.74 service generated with mypy-boto3-builder 8.5.0
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/types_boto3_docs/types_boto3_dsql/
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 dsql boto3-stubs type-annotations 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.14
27
+ Classifier: Programming Language :: Python :: 3 :: Only
28
+ Classifier: Programming Language :: Python :: Implementation :: CPython
29
+ Classifier: Typing :: Stubs Only
30
+ Requires-Python: >=3.8
31
+ Description-Content-Type: text/markdown
32
+ License-File: LICENSE
33
+ Requires-Dist: typing-extensions>=4.1.0; python_version < "3.12"
34
+
35
+ <a id="types-boto3-dsql"></a>
36
+
37
+ # types-boto3-dsql
38
+
39
+ [![PyPI - types-boto3-dsql](https://img.shields.io/pypi/v/types-boto3-dsql.svg?color=blue)](https://pypi.org/project/types-boto3-dsql/)
40
+ [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/types-boto3-dsql.svg?color=blue)](https://pypi.org/project/types-boto3-dsql/)
41
+ [![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/types_boto3_docs/)
42
+ [![PyPI - Downloads](https://static.pepy.tech/badge/types-boto3-dsql)](https://pypistats.org/packages/types-boto3-dsql)
43
+
44
+ ![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)
45
+
46
+ Type annotations for
47
+ [boto3 AuroraDSQL 1.35.74](https://pypi.org/project/boto3/) compatible with
48
+ [VSCode](https://code.visualstudio.com/),
49
+ [PyCharm](https://www.jetbrains.com/pycharm/),
50
+ [Emacs](https://www.gnu.org/software/emacs/),
51
+ [Sublime Text](https://www.sublimetext.com/),
52
+ [mypy](https://github.com/python/mypy),
53
+ [pyright](https://github.com/microsoft/pyright) and other tools.
54
+
55
+ Generated by
56
+ [mypy-boto3-builder 8.5.0](https://github.com/youtype/mypy_boto3_builder).
57
+
58
+ More information can be found on
59
+ [types-boto3](https://pypi.org/project/types-boto3/) page and in
60
+ [types-boto3-dsql docs](https://youtype.github.io/types_boto3_docs/types_boto3_dsql/).
61
+
62
+ See how it helps you find and fix potential bugs:
63
+
64
+ ![types-boto3 demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)
65
+
66
+ - [types-boto3-dsql](#types-boto3-dsql)
67
+ - [How to install](#how-to-install)
68
+ - [VSCode extension](#vscode-extension)
69
+ - [From PyPI with pip](#from-pypi-with-pip)
70
+ - [How to uninstall](#how-to-uninstall)
71
+ - [Usage](#usage)
72
+ - [VSCode](#vscode)
73
+ - [PyCharm](#pycharm)
74
+ - [Emacs](#emacs)
75
+ - [Sublime Text](#sublime-text)
76
+ - [Other IDEs](#other-ides)
77
+ - [mypy](#mypy)
78
+ - [pyright](#pyright)
79
+ - [Pylint compatibility](#pylint-compatibility)
80
+ - [Explicit type annotations](#explicit-type-annotations)
81
+ - [Client annotations](#client-annotations)
82
+ - [Paginators annotations](#paginators-annotations)
83
+ - [Waiters annotations](#waiters-annotations)
84
+ - [Literals](#literals)
85
+ - [Type definitions](#type-definitions)
86
+ - [How it works](#how-it-works)
87
+ - [What's new](#what's-new)
88
+ - [Implemented features](#implemented-features)
89
+ - [Latest changes](#latest-changes)
90
+ - [Versioning](#versioning)
91
+ - [Thank you](#thank-you)
92
+ - [Documentation](#documentation)
93
+ - [Support and contributing](#support-and-contributing)
94
+
95
+ <a id="how-to-install"></a>
96
+
97
+ ## How to install
98
+
99
+ <a id="vscode-extension"></a>
100
+
101
+ ### VSCode extension
102
+
103
+ Add
104
+ [AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide)
105
+ extension to your VSCode and run `AWS boto3: Quick Start` command.
106
+
107
+ Click `Modify` and select `boto3 common` and `AuroraDSQL`.
108
+
109
+ <a id="from-pypi-with-pip"></a>
110
+
111
+ ### From PyPI with pip
112
+
113
+ Install `types-boto3` for `AuroraDSQL` service.
114
+
115
+ ```bash
116
+ # install with boto3 type annotations
117
+ python -m pip install 'types-boto3[dsql]'
118
+
119
+
120
+ # Lite version does not provide session.client/resource overloads
121
+ # it is more RAM-friendly, but requires explicit type annotations
122
+ python -m pip install 'types-boto3-lite[dsql]'
123
+
124
+
125
+ # standalone installation
126
+ python -m pip install types-boto3-dsql
127
+ ```
128
+
129
+ <a id="how-to-uninstall"></a>
130
+
131
+ ## How to uninstall
132
+
133
+ ```bash
134
+ python -m pip uninstall -y types-boto3-dsql
135
+ ```
136
+
137
+ <a id="usage"></a>
138
+
139
+ ## Usage
140
+
141
+ <a id="vscode"></a>
142
+
143
+ ### VSCode
144
+
145
+ - Install
146
+ [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
147
+ - Install
148
+ [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
149
+ - Set `Pylance` as your Python Language Server
150
+ - Install `types-boto3[dsql]` in your environment:
151
+
152
+ ```bash
153
+ python -m pip install 'types-boto3[dsql]'
154
+ ```
155
+
156
+ Both type checking and code completion should now work. No explicit type
157
+ annotations required, write your `boto3` code as usual.
158
+
159
+ <a id="pycharm"></a>
160
+
161
+ ### PyCharm
162
+
163
+ > ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
164
+ > [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
165
+ > to use [types-boto3-lite](https://pypi.org/project/types-boto3-lite/) until
166
+ > the issue is resolved.
167
+
168
+ > ⚠️ If you experience slow performance and high CPU usage, try to disable
169
+ > `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
170
+ > [pyright](https://github.com/microsoft/pyright) instead.
171
+
172
+ > ⚠️ To continue using `PyCharm` type checker, you can try to replace
173
+ > `types-boto3` with
174
+ > [types-boto3-lite](https://pypi.org/project/types-boto3-lite/):
175
+
176
+ ```bash
177
+ pip uninstall types-boto3
178
+ pip install types-boto3-lite
179
+ ```
180
+
181
+ Install `types-boto3[dsql]` in your environment:
182
+
183
+ ```bash
184
+ python -m pip install 'types-boto3[dsql]'
185
+ ```
186
+
187
+ Both type checking and code completion should now work.
188
+
189
+ <a id="emacs"></a>
190
+
191
+ ### Emacs
192
+
193
+ - Install `types-boto3` with services you use in your environment:
194
+
195
+ ```bash
196
+ python -m pip install 'types-boto3[dsql]'
197
+ ```
198
+
199
+ - Install [use-package](https://github.com/jwiegley/use-package),
200
+ [lsp](https://github.com/emacs-lsp/lsp-mode/),
201
+ [company](https://github.com/company-mode/company-mode) and
202
+ [flycheck](https://github.com/flycheck/flycheck) packages
203
+ - Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package
204
+
205
+ ```elisp
206
+ (use-package lsp-pyright
207
+ :ensure t
208
+ :hook (python-mode . (lambda ()
209
+ (require 'lsp-pyright)
210
+ (lsp))) ; or lsp-deferred
211
+ :init (when (executable-find "python3")
212
+ (setq lsp-pyright-python-executable-cmd "python3"))
213
+ )
214
+ ```
215
+
216
+ - Make sure emacs uses the environment where you have installed `types-boto3`
217
+
218
+ Type checking should now work. No explicit type annotations required, write
219
+ your `boto3` code as usual.
220
+
221
+ <a id="sublime-text"></a>
222
+
223
+ ### Sublime Text
224
+
225
+ - Install `types-boto3[dsql]` with services you use in your environment:
226
+
227
+ ```bash
228
+ python -m pip install 'types-boto3[dsql]'
229
+ ```
230
+
231
+ - Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package
232
+
233
+ Type checking should now work. No explicit type annotations required, write
234
+ your `boto3` code as usual.
235
+
236
+ <a id="other-ides"></a>
237
+
238
+ ### Other IDEs
239
+
240
+ Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
241
+ should work.
242
+
243
+ <a id="mypy"></a>
244
+
245
+ ### mypy
246
+
247
+ - Install `mypy`: `python -m pip install mypy`
248
+ - Install `types-boto3[dsql]` in your environment:
249
+
250
+ ```bash
251
+ python -m pip install 'types-boto3[dsql]'
252
+ ```
253
+
254
+ Type checking should now work. No explicit type annotations required, write
255
+ your `boto3` code as usual.
256
+
257
+ <a id="pyright"></a>
258
+
259
+ ### pyright
260
+
261
+ - Install `pyright`: `npm i -g pyright`
262
+ - Install `types-boto3[dsql]` in your environment:
263
+
264
+ ```bash
265
+ python -m pip install 'types-boto3[dsql]'
266
+ ```
267
+
268
+ Optionally, you can install `types-boto3` to `typings` directory.
269
+
270
+ Type checking should now work. No explicit type annotations required, write
271
+ your `boto3` code as usual.
272
+
273
+ <a id="pylint-compatibility"></a>
274
+
275
+ ### Pylint compatibility
276
+
277
+ It is totally safe to use `TYPE_CHECKING` flag in order to avoid
278
+ `types-boto3-dsql` dependency in production. However, there is an issue in
279
+ `pylint` that it complains about undefined variables. To fix it, set all types
280
+ to `object` in non-`TYPE_CHECKING` mode.
281
+
282
+ ```python
283
+ from typing import TYPE_CHECKING
284
+
285
+ if TYPE_CHECKING:
286
+ from types_boto3_ec2 import EC2Client, EC2ServiceResource
287
+ from types_boto3_ec2.waiters import BundleTaskCompleteWaiter
288
+ from types_boto3_ec2.paginators import DescribeVolumesPaginator
289
+ else:
290
+ EC2Client = object
291
+ EC2ServiceResource = object
292
+ BundleTaskCompleteWaiter = object
293
+ DescribeVolumesPaginator = object
294
+
295
+ ...
296
+ ```
297
+
298
+ <a id="explicit-type-annotations"></a>
299
+
300
+ ## Explicit type annotations
301
+
302
+ <a id="client-annotations"></a>
303
+
304
+ ### Client annotations
305
+
306
+ `AuroraDSQLClient` provides annotations for `boto3.client("dsql")`.
307
+
308
+ ```python
309
+ from boto3.session import Session
310
+
311
+ from types_boto3_dsql import AuroraDSQLClient
312
+
313
+ client: AuroraDSQLClient = Session().client("dsql")
314
+
315
+ # now client usage is checked by mypy and IDE should provide code completion
316
+ ```
317
+
318
+ <a id="paginators-annotations"></a>
319
+
320
+ ### Paginators annotations
321
+
322
+ `types_boto3_dsql.paginator` module contains type annotations for all
323
+ paginators.
324
+
325
+ ```python
326
+ from boto3.session import Session
327
+
328
+ from types_boto3_dsql import AuroraDSQLClient
329
+ from types_boto3_dsql.paginator import ListClustersPaginator
330
+
331
+ client: AuroraDSQLClient = Session().client("dsql")
332
+
333
+ # Explicit type annotations are optional here
334
+ # Types should be correctly discovered by mypy and IDEs
335
+ list_clusters_paginator: ListClustersPaginator = client.get_paginator("list_clusters")
336
+ ```
337
+
338
+ <a id="waiters-annotations"></a>
339
+
340
+ ### Waiters annotations
341
+
342
+ `types_boto3_dsql.waiter` module contains type annotations for all waiters.
343
+
344
+ ```python
345
+ from boto3.session import Session
346
+
347
+ from types_boto3_dsql import AuroraDSQLClient
348
+ from types_boto3_dsql.waiter import ClusterActiveWaiter, ClusterNotExistsWaiter
349
+
350
+ client: AuroraDSQLClient = Session().client("dsql")
351
+
352
+ # Explicit type annotations are optional here
353
+ # Types should be correctly discovered by mypy and IDEs
354
+ cluster_active_waiter: ClusterActiveWaiter = client.get_waiter("cluster_active")
355
+ cluster_not_exists_waiter: ClusterNotExistsWaiter = client.get_waiter("cluster_not_exists")
356
+ ```
357
+
358
+ <a id="literals"></a>
359
+
360
+ ### Literals
361
+
362
+ `types_boto3_dsql.literals` module contains literals extracted from shapes that
363
+ can be used in user code for type checking.
364
+
365
+ Full list of `AuroraDSQL` Literals can be found in
366
+ [docs](https://youtype.github.io/types_boto3_docs/types_boto3_dsql/literals/).
367
+
368
+ ```python
369
+ from types_boto3_dsql.literals import ClusterActiveWaiterName
370
+
371
+
372
+ def check_value(value: ClusterActiveWaiterName) -> bool: ...
373
+ ```
374
+
375
+ <a id="type-definitions"></a>
376
+
377
+ ### Type definitions
378
+
379
+ `types_boto3_dsql.type_defs` module contains structures and shapes assembled to
380
+ typed dictionaries and unions for additional type checking.
381
+
382
+ Full list of `AuroraDSQL` TypeDefs can be found in
383
+ [docs](https://youtype.github.io/types_boto3_docs/types_boto3_dsql/type_defs/).
384
+
385
+ ```python
386
+ from types_boto3_dsql.type_defs import ClusterSummaryTypeDef
387
+
388
+
389
+ def get_value() -> ClusterSummaryTypeDef:
390
+ return {...}
391
+ ```
392
+
393
+ <a id="how-it-works"></a>
394
+
395
+ ## How it works
396
+
397
+ Fully automated
398
+ [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully
399
+ generates type annotations for each service, patiently waiting for `boto3`
400
+ updates. It delivers drop-in type annotations for you and makes sure that:
401
+
402
+ - All available `boto3` services are covered.
403
+ - Each public class and method of every `boto3` service gets valid type
404
+ annotations extracted from `botocore` schemas.
405
+ - Type annotations include up-to-date documentation.
406
+ - Link to documentation is provided for every method.
407
+ - Code is processed by [ruff](https://docs.astral.sh/ruff/) for readability.
408
+
409
+ <a id="what's-new"></a>
410
+
411
+ ## What's new
412
+
413
+ <a id="implemented-features"></a>
414
+
415
+ ### Implemented features
416
+
417
+ - Fully type annotated `boto3`, `botocore`, `aiobotocore` and `aioboto3`
418
+ libraries
419
+ - `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs`
420
+ compatibility
421
+ - `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type
422
+ annotations for each service
423
+ - Generated `TypeDefs` for each service
424
+ - Generated `Literals` for each service
425
+ - Auto discovery of types for `boto3.client` and `boto3.resource` calls
426
+ - Auto discovery of types for `session.client` and `session.resource` calls
427
+ - Auto discovery of types for `client.get_waiter` and `client.get_paginator`
428
+ calls
429
+ - Auto discovery of types for `ServiceResource` and `Resource` collections
430
+ - Auto discovery of types for `aiobotocore.Session.create_client` calls
431
+
432
+ <a id="latest-changes"></a>
433
+
434
+ ### Latest changes
435
+
436
+ Builder changelog can be found in
437
+ [Releases](https://github.com/youtype/mypy_boto3_builder/releases).
438
+
439
+ <a id="versioning"></a>
440
+
441
+ ## Versioning
442
+
443
+ `types-boto3-dsql` version is the same as related `boto3` version and follows
444
+ [PEP 440](https://www.python.org/dev/peps/pep-0440/) format.
445
+
446
+ <a id="thank-you"></a>
447
+
448
+ ## Thank you
449
+
450
+ - [Allie Fitter](https://github.com/alliefitter) for
451
+ [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/),
452
+ this package is based on top of his work
453
+ - [black](https://github.com/psf/black) developers for an awesome formatting
454
+ tool
455
+ - [Timothy Edmund Crosley](https://github.com/timothycrosley) for
456
+ [isort](https://github.com/PyCQA/isort) and how flexible it is
457
+ - [mypy](https://github.com/python/mypy) developers for doing all dirty work
458
+ for us
459
+ - [pyright](https://github.com/microsoft/pyright) team for the new era of typed
460
+ Python
461
+
462
+ <a id="documentation"></a>
463
+
464
+ ## Documentation
465
+
466
+ All services type annotations can be found in
467
+ [boto3 docs](https://youtype.github.io/types_boto3_docs/types_boto3_dsql/)
468
+
469
+ <a id="support-and-contributing"></a>
470
+
471
+ ## Support and contributing
472
+
473
+ This package is auto-generated. Please reports any bugs or request new features
474
+ in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/)
475
+ repository.