types-boto3-dsql 1.41.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.
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 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,490 @@
1
+ Metadata-Version: 2.4
2
+ Name: types-boto3-dsql
3
+ Version: 1.41.0
4
+ Summary: Type annotations for boto3 AuroraDSQL 1.41.0 service generated with mypy-boto3-builder 8.12.0
5
+ Author-email: Vlad Emelianov <vlad.emelianov.nz@gmail.com>
6
+ License-Expression: MIT
7
+ Project-URL: Homepage, https://github.com/youtype/mypy_boto3_builder
8
+ Project-URL: Documentation, https://youtype.github.io/types_boto3_docs/types_boto3_dsql/
9
+ Project-URL: Source, https://github.com/youtype/mypy_boto3_builder
10
+ Project-URL: Tracker, https://github.com/youtype/mypy_boto3_builder/issues
11
+ Keywords: boto3,dsql,boto3-stubs,type-annotations,mypy,typeshed,autocomplete
12
+ Platform: any
13
+ Classifier: Development Status :: 5 - Production/Stable
14
+ Classifier: Intended Audience :: Developers
15
+ Classifier: Environment :: Console
16
+ Classifier: Natural Language :: English
17
+ Classifier: Operating System :: OS Independent
18
+ Classifier: Programming Language :: Python :: 3
19
+ Classifier: Programming Language :: Python :: 3.9
20
+ Classifier: Programming Language :: Python :: 3.10
21
+ Classifier: Programming Language :: Python :: 3.11
22
+ Classifier: Programming Language :: Python :: 3.12
23
+ Classifier: Programming Language :: Python :: 3.13
24
+ Classifier: Programming Language :: Python :: 3.14
25
+ Classifier: Programming Language :: Python :: 3 :: Only
26
+ Classifier: Programming Language :: Python :: Implementation :: CPython
27
+ Classifier: Typing :: Stubs Only
28
+ Requires-Python: >=3.9
29
+ Description-Content-Type: text/markdown
30
+ License-File: LICENSE
31
+ Requires-Dist: typing-extensions; python_version < "3.12"
32
+ Dynamic: license-file
33
+
34
+ <a id="types-boto3-dsql"></a>
35
+
36
+ # types-boto3-dsql
37
+
38
+ [![PyPI - types-boto3-dsql](https://img.shields.io/pypi/v/types-boto3-dsql.svg?color=blue)](https://pypi.org/project/types-boto3-dsql/)
39
+ [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/types-boto3-dsql.svg?color=blue)](https://pypi.org/project/types-boto3-dsql/)
40
+ [![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/types_boto3_docs/)
41
+ [![PyPI - Downloads](https://static.pepy.tech/badge/types-boto3-dsql)](https://pypistats.org/packages/types-boto3-dsql)
42
+
43
+ ![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)
44
+
45
+ Type annotations for [boto3 AuroraDSQL 1.41.0](https://pypi.org/project/boto3/)
46
+ compatible with [VSCode](https://code.visualstudio.com/),
47
+ [PyCharm](https://www.jetbrains.com/pycharm/),
48
+ [Emacs](https://www.gnu.org/software/emacs/),
49
+ [Sublime Text](https://www.sublimetext.com/),
50
+ [mypy](https://github.com/python/mypy),
51
+ [pyright](https://github.com/microsoft/pyright) and other tools.
52
+
53
+ Generated with
54
+ [mypy-boto3-builder 8.12.0](https://github.com/youtype/mypy_boto3_builder).
55
+
56
+ More information can be found on
57
+ [types-boto3](https://pypi.org/project/types-boto3/) page and in
58
+ [types-boto3-dsql docs](https://youtype.github.io/types_boto3_docs/types_boto3_dsql/).
59
+
60
+ See how it helps you find and fix potential bugs:
61
+
62
+ ![types-boto3 demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)
63
+
64
+ - [types-boto3-dsql](#types-boto3-dsql)
65
+ - [How to install](#how-to-install)
66
+ - [Generate locally (recommended)](<#generate-locally-(recommended)>)
67
+ - [VSCode extension](#vscode-extension)
68
+ - [From PyPI with pip](#from-pypi-with-pip)
69
+ - [How to uninstall](#how-to-uninstall)
70
+ - [Usage](#usage)
71
+ - [VSCode](#vscode)
72
+ - [PyCharm](#pycharm)
73
+ - [Emacs](#emacs)
74
+ - [Sublime Text](#sublime-text)
75
+ - [Other IDEs](#other-ides)
76
+ - [mypy](#mypy)
77
+ - [pyright](#pyright)
78
+ - [Pylint compatibility](#pylint-compatibility)
79
+ - [Explicit type annotations](#explicit-type-annotations)
80
+ - [Client annotations](#client-annotations)
81
+ - [Paginators annotations](#paginators-annotations)
82
+ - [Waiters annotations](#waiters-annotations)
83
+ - [Literals](#literals)
84
+ - [Type definitions](#type-definitions)
85
+ - [How it works](#how-it-works)
86
+ - [What's new](#what's-new)
87
+ - [Implemented features](#implemented-features)
88
+ - [Latest changes](#latest-changes)
89
+ - [Versioning](#versioning)
90
+ - [Thank you](#thank-you)
91
+ - [Documentation](#documentation)
92
+ - [Support and contributing](#support-and-contributing)
93
+
94
+ <a id="how-to-install"></a>
95
+
96
+ ## How to install
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.41.0' mypy-boto3-builder`
109
+ 2. Select `boto3` AWS SDK.
110
+ 3. Add `AuroraDSQL` service.
111
+ 4. Use provided commands to install generated packages.
112
+
113
+ <a id="vscode-extension"></a>
114
+
115
+ ### VSCode extension
116
+
117
+ Add
118
+ [AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide)
119
+ extension to your VSCode and run `AWS boto3: Quick Start` command.
120
+
121
+ Click `Modify` and select `boto3 common` and `AuroraDSQL`.
122
+
123
+ <a id="from-pypi-with-pip"></a>
124
+
125
+ ### From PyPI with pip
126
+
127
+ Install `types-boto3` for `AuroraDSQL` service.
128
+
129
+ ```bash
130
+ # install with boto3 type annotations
131
+ python -m pip install 'types-boto3[dsql]'
132
+
133
+ # Lite version does not provide session.client/resource overloads
134
+ # it is more RAM-friendly, but requires explicit type annotations
135
+ python -m pip install 'types-boto3-lite[dsql]'
136
+
137
+ # standalone installation
138
+ python -m pip install types-boto3-dsql
139
+ ```
140
+
141
+ <a id="how-to-uninstall"></a>
142
+
143
+ ## How to uninstall
144
+
145
+ ```bash
146
+ python -m pip uninstall -y types-boto3-dsql
147
+ ```
148
+
149
+ <a id="usage"></a>
150
+
151
+ ## Usage
152
+
153
+ <a id="vscode"></a>
154
+
155
+ ### VSCode
156
+
157
+ - Install
158
+ [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
159
+ - Install
160
+ [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
161
+ - Set `Pylance` as your Python Language Server
162
+ - Install `types-boto3[dsql]` in your environment:
163
+
164
+ ```bash
165
+ python -m pip install 'types-boto3[dsql]'
166
+ ```
167
+
168
+ Both type checking and code completion should now work. No explicit type
169
+ annotations required, write your `boto3` code as usual.
170
+
171
+ <a id="pycharm"></a>
172
+
173
+ ### PyCharm
174
+
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 [types-boto3-lite](https://pypi.org/project/types-boto3-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
+ > `types-boto3` with
186
+ > [types-boto3-lite](https://pypi.org/project/types-boto3-lite/):
187
+
188
+ ```bash
189
+ pip uninstall types-boto3
190
+ pip install types-boto3-lite
191
+ ```
192
+
193
+ Install `types-boto3[dsql]` in your environment:
194
+
195
+ ```bash
196
+ python -m pip install 'types-boto3[dsql]'
197
+ ```
198
+
199
+ Both type checking and code completion should now work.
200
+
201
+ <a id="emacs"></a>
202
+
203
+ ### Emacs
204
+
205
+ - Install `types-boto3` with services you use in your environment:
206
+
207
+ ```bash
208
+ python -m pip install 'types-boto3[dsql]'
209
+ ```
210
+
211
+ - Install [use-package](https://github.com/jwiegley/use-package),
212
+ [lsp](https://github.com/emacs-lsp/lsp-mode/),
213
+ [company](https://github.com/company-mode/company-mode) and
214
+ [flycheck](https://github.com/flycheck/flycheck) packages
215
+ - Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package
216
+
217
+ ```elisp
218
+ (use-package lsp-pyright
219
+ :ensure t
220
+ :hook (python-mode . (lambda ()
221
+ (require 'lsp-pyright)
222
+ (lsp))) ; or lsp-deferred
223
+ :init (when (executable-find "python3")
224
+ (setq lsp-pyright-python-executable-cmd "python3"))
225
+ )
226
+ ```
227
+
228
+ - Make sure emacs uses the environment where you have installed `types-boto3`
229
+
230
+ Type checking should now work. No explicit type annotations required, write
231
+ your `boto3` code as usual.
232
+
233
+ <a id="sublime-text"></a>
234
+
235
+ ### Sublime Text
236
+
237
+ - Install `types-boto3[dsql]` with services you use in your environment:
238
+
239
+ ```bash
240
+ python -m pip install 'types-boto3[dsql]'
241
+ ```
242
+
243
+ - Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package
244
+
245
+ Type checking should now work. No explicit type annotations required, write
246
+ your `boto3` code as usual.
247
+
248
+ <a id="other-ides"></a>
249
+
250
+ ### Other IDEs
251
+
252
+ Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
253
+ should work.
254
+
255
+ <a id="mypy"></a>
256
+
257
+ ### mypy
258
+
259
+ - Install `mypy`: `python -m pip install mypy`
260
+ - Install `types-boto3[dsql]` in your environment:
261
+
262
+ ```bash
263
+ python -m pip install 'types-boto3[dsql]'
264
+ ```
265
+
266
+ Type checking should now work. No explicit type annotations required, write
267
+ your `boto3` code as usual.
268
+
269
+ <a id="pyright"></a>
270
+
271
+ ### pyright
272
+
273
+ - Install `pyright`: `npm i -g pyright`
274
+ - Install `types-boto3[dsql]` in your environment:
275
+
276
+ ```bash
277
+ python -m pip install 'types-boto3[dsql]'
278
+ ```
279
+
280
+ Optionally, you can install `types-boto3` to `typings` directory.
281
+
282
+ Type checking should now work. No explicit type annotations required, write
283
+ your `boto3` code as usual.
284
+
285
+ <a id="pylint-compatibility"></a>
286
+
287
+ ### Pylint compatibility
288
+
289
+ It is totally safe to use `TYPE_CHECKING` flag in order to avoid
290
+ `types-boto3-dsql` dependency in production. However, there is an issue in
291
+ `pylint` that it complains about undefined variables. To fix it, set all types
292
+ to `object` in non-`TYPE_CHECKING` mode.
293
+
294
+ ```python
295
+ from typing import TYPE_CHECKING
296
+
297
+ if TYPE_CHECKING:
298
+ from types_boto3_ec2 import EC2Client, EC2ServiceResource
299
+ from types_boto3_ec2.waiters import BundleTaskCompleteWaiter
300
+ from types_boto3_ec2.paginators import DescribeVolumesPaginator
301
+ else:
302
+ EC2Client = object
303
+ EC2ServiceResource = object
304
+ BundleTaskCompleteWaiter = object
305
+ DescribeVolumesPaginator = object
306
+
307
+ ...
308
+ ```
309
+
310
+ <a id="explicit-type-annotations"></a>
311
+
312
+ ## Explicit type annotations
313
+
314
+ <a id="client-annotations"></a>
315
+
316
+ ### Client annotations
317
+
318
+ `AuroraDSQLClient` provides annotations for `boto3.client("dsql")`.
319
+
320
+ ```python
321
+ from boto3.session import Session
322
+
323
+ from types_boto3_dsql import AuroraDSQLClient
324
+
325
+ client: AuroraDSQLClient = Session().client("dsql")
326
+
327
+ # now client usage is checked by mypy and IDE should provide code completion
328
+ ```
329
+
330
+ <a id="paginators-annotations"></a>
331
+
332
+ ### Paginators annotations
333
+
334
+ `types_boto3_dsql.paginator` module contains type annotations for all
335
+ paginators.
336
+
337
+ ```python
338
+ from boto3.session import Session
339
+
340
+ from types_boto3_dsql import AuroraDSQLClient
341
+ from types_boto3_dsql.paginator import ListClustersPaginator
342
+
343
+ client: AuroraDSQLClient = Session().client("dsql")
344
+
345
+ # Explicit type annotations are optional here
346
+ # Types should be correctly discovered by mypy and IDEs
347
+ list_clusters_paginator: ListClustersPaginator = client.get_paginator("list_clusters")
348
+ ```
349
+
350
+ <a id="waiters-annotations"></a>
351
+
352
+ ### Waiters annotations
353
+
354
+ `types_boto3_dsql.waiter` module contains type annotations for all waiters.
355
+
356
+ ```python
357
+ from boto3.session import Session
358
+
359
+ from types_boto3_dsql import AuroraDSQLClient
360
+ from types_boto3_dsql.waiter import ClusterActiveWaiter, ClusterNotExistsWaiter
361
+
362
+ client: AuroraDSQLClient = Session().client("dsql")
363
+
364
+ # Explicit type annotations are optional here
365
+ # Types should be correctly discovered by mypy and IDEs
366
+ cluster_active_waiter: ClusterActiveWaiter = client.get_waiter("cluster_active")
367
+ cluster_not_exists_waiter: ClusterNotExistsWaiter = client.get_waiter("cluster_not_exists")
368
+ ```
369
+
370
+ <a id="literals"></a>
371
+
372
+ ### Literals
373
+
374
+ `types_boto3_dsql.literals` module contains literals extracted from shapes that
375
+ can be used in user code for type checking.
376
+
377
+ Full list of `AuroraDSQL` Literals can be found in
378
+ [docs](https://youtype.github.io/types_boto3_docs/types_boto3_dsql/literals/).
379
+
380
+ ```python
381
+ from types_boto3_dsql.literals import ClusterActiveWaiterName
382
+
383
+
384
+ def check_value(value: ClusterActiveWaiterName) -> bool: ...
385
+ ```
386
+
387
+ <a id="type-definitions"></a>
388
+
389
+ ### Type definitions
390
+
391
+ `types_boto3_dsql.type_defs` module contains structures and shapes assembled to
392
+ typed dictionaries and unions for additional type checking.
393
+
394
+ Full list of `AuroraDSQL` TypeDefs can be found in
395
+ [docs](https://youtype.github.io/types_boto3_docs/types_boto3_dsql/type_defs/).
396
+
397
+ ```python
398
+ # TypedDict usage example
399
+ from types_boto3_dsql.type_defs import ClusterSummaryTypeDef
400
+
401
+
402
+ def get_value() -> ClusterSummaryTypeDef:
403
+ return {
404
+ "identifier": ...,
405
+ }
406
+ ```
407
+
408
+ <a id="how-it-works"></a>
409
+
410
+ ## How it works
411
+
412
+ Fully automated
413
+ [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully
414
+ generates type annotations for each service, patiently waiting for `boto3`
415
+ updates. It delivers drop-in type annotations for you and makes sure that:
416
+
417
+ - All available `boto3` services are covered.
418
+ - Each public class and method of every `boto3` service gets valid type
419
+ annotations extracted from `botocore` schemas.
420
+ - Type annotations include up-to-date documentation.
421
+ - Link to documentation is provided for every method.
422
+ - Code is processed by [ruff](https://docs.astral.sh/ruff/) for readability.
423
+
424
+ <a id="what's-new"></a>
425
+
426
+ ## What's new
427
+
428
+ <a id="implemented-features"></a>
429
+
430
+ ### Implemented features
431
+
432
+ - Fully type annotated `boto3`, `botocore`, `aiobotocore` and `aioboto3`
433
+ libraries
434
+ - `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs`
435
+ compatibility
436
+ - `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type
437
+ annotations for each service
438
+ - Generated `TypeDefs` for each service
439
+ - Generated `Literals` for each service
440
+ - Auto discovery of types for `boto3.client` and `boto3.resource` calls
441
+ - Auto discovery of types for `session.client` and `session.resource` calls
442
+ - Auto discovery of types for `client.get_waiter` and `client.get_paginator`
443
+ calls
444
+ - Auto discovery of types for `ServiceResource` and `Resource` collections
445
+ - Auto discovery of types for `aiobotocore.Session.create_client` calls
446
+
447
+ <a id="latest-changes"></a>
448
+
449
+ ### Latest changes
450
+
451
+ Builder changelog can be found in
452
+ [Releases](https://github.com/youtype/mypy_boto3_builder/releases).
453
+
454
+ <a id="versioning"></a>
455
+
456
+ ## Versioning
457
+
458
+ `types-boto3-dsql` version is the same as related `boto3` version and follows
459
+ [Python Packaging version specifiers](https://packaging.python.org/en/latest/specifications/version-specifiers/).
460
+
461
+ <a id="thank-you"></a>
462
+
463
+ ## Thank you
464
+
465
+ - [Allie Fitter](https://github.com/alliefitter) for
466
+ [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/),
467
+ this package is based on top of his work
468
+ - [black](https://github.com/psf/black) developers for an awesome formatting
469
+ tool
470
+ - [Timothy Edmund Crosley](https://github.com/timothycrosley) for
471
+ [isort](https://github.com/PyCQA/isort) and how flexible it is
472
+ - [mypy](https://github.com/python/mypy) developers for doing all dirty work
473
+ for us
474
+ - [pyright](https://github.com/microsoft/pyright) team for the new era of typed
475
+ Python
476
+
477
+ <a id="documentation"></a>
478
+
479
+ ## Documentation
480
+
481
+ All services type annotations can be found in
482
+ [boto3 docs](https://youtype.github.io/types_boto3_docs/types_boto3_dsql/)
483
+
484
+ <a id="support-and-contributing"></a>
485
+
486
+ ## Support and contributing
487
+
488
+ This package is auto-generated. Please reports any bugs or request new features
489
+ in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/)
490
+ repository.