mypy-boto3-geo-maps 1.35.52__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) 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,392 @@
1
+ Metadata-Version: 2.1
2
+ Name: mypy-boto3-geo-maps
3
+ Version: 1.35.52
4
+ Summary: Type annotations for boto3.LocationServiceMapsV2 1.35.52 service generated with mypy-boto3-builder 8.1.4
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_geo_maps/
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 geo-maps 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
+ <a id="mypy-boto3-geo-maps"></a>
35
+
36
+ # mypy-boto3-geo-maps
37
+
38
+ [![PyPI - mypy-boto3-geo-maps](https://img.shields.io/pypi/v/mypy-boto3-geo-maps.svg?color=blue)](https://pypi.org/project/mypy-boto3-geo-maps)
39
+ [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-geo-maps.svg?color=blue)](https://pypi.org/project/mypy-boto3-geo-maps)
40
+ [![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_geo_maps/)
41
+ [![PyPI - Downloads](https://static.pepy.tech/badge/mypy-boto3-geo-maps)](https://pepy.tech/project/mypy-boto3-geo-maps)
42
+
43
+ ![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)
44
+
45
+ Type annotations for
46
+ [boto3.LocationServiceMapsV2 1.35.52](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/geo-maps.html#LocationServiceMapsV2)
47
+ service compatible with [VSCode](https://code.visualstudio.com/),
48
+ [PyCharm](https://www.jetbrains.com/pycharm/),
49
+ [Emacs](https://www.gnu.org/software/emacs/),
50
+ [Sublime Text](https://www.sublimetext.com/),
51
+ [mypy](https://github.com/python/mypy),
52
+ [pyright](https://github.com/microsoft/pyright) and other tools.
53
+
54
+ Generated by
55
+ [mypy-boto3-builder 8.1.4](https://github.com/youtype/mypy_boto3_builder).
56
+
57
+ More information can be found on
58
+ [boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
59
+ [mypy-boto3-geo-maps docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_geo_maps/).
60
+
61
+ See how it helps to find and fix potential bugs:
62
+
63
+ ![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)
64
+
65
+ - [mypy-boto3-geo-maps](#mypy-boto3-geo-maps)
66
+ - [How to install](#how-to-install)
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
+ - [Explicit type annotations](#explicit-type-annotations)
79
+ - [Client annotations](#client-annotations)
80
+ - [Literals](#literals)
81
+ - [Type definitions](#type-definitions)
82
+ - [How it works](#how-it-works)
83
+ - [What's new](#what's-new)
84
+ - [Implemented features](#implemented-features)
85
+ - [Latest changes](#latest-changes)
86
+ - [Versioning](#versioning)
87
+ - [Thank you](#thank-you)
88
+ - [Documentation](#documentation)
89
+ - [Support and contributing](#support-and-contributing)
90
+
91
+ <a id="how-to-install"></a>
92
+
93
+ ## How to install
94
+
95
+ <a id="vscode-extension"></a>
96
+
97
+ ### VSCode extension
98
+
99
+ Add
100
+ [AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide)
101
+ extension to your VSCode and run `AWS boto3: Quick Start` command.
102
+
103
+ Click `Modify` and select `boto3 common` and `LocationServiceMapsV2`.
104
+
105
+ <a id="from-pypi-with-pip"></a>
106
+
107
+ ### From PyPI with pip
108
+
109
+ Install `boto3-stubs` for `LocationServiceMapsV2` service.
110
+
111
+ ```bash
112
+ # install with boto3 type annotations
113
+ python -m pip install 'boto3-stubs[geo-maps]'
114
+
115
+
116
+ # Lite version does not provide session.client/resource overloads
117
+ # it is more RAM-friendly, but requires explicit type annotations
118
+ python -m pip install 'boto3-stubs-lite[geo-maps]'
119
+
120
+
121
+ # standalone installation
122
+ python -m pip install mypy-boto3-geo-maps
123
+ ```
124
+
125
+ <a id="how-to-uninstall"></a>
126
+
127
+ ## How to uninstall
128
+
129
+ ```bash
130
+ python -m pip uninstall -y mypy-boto3-geo-maps
131
+ ```
132
+
133
+ <a id="usage"></a>
134
+
135
+ ## Usage
136
+
137
+ <a id="vscode"></a>
138
+
139
+ ### VSCode
140
+
141
+ - Install
142
+ [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
143
+ - Install
144
+ [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
145
+ - Set `Pylance` as your Python Language Server
146
+ - Install `boto3-stubs[geo-maps]` in your environment:
147
+
148
+ ```bash
149
+ python -m pip install 'boto3-stubs[geo-maps]'
150
+ ```
151
+
152
+ Both type checking and code completion should now work. No explicit type
153
+ annotations required, write your `boto3` code as usual.
154
+
155
+ <a id="pycharm"></a>
156
+
157
+ ### PyCharm
158
+
159
+ Install `boto3-stubs-lite[geo-maps]` in your environment:
160
+
161
+ ```bash
162
+ python -m pip install 'boto3-stubs-lite[geo-maps]'
163
+ ```
164
+
165
+ Both type checking and code completion should now work. Explicit type
166
+ annotations **are required**.
167
+
168
+ Use `boto3-stubs` package instead for implicit type discovery.
169
+
170
+ <a id="emacs"></a>
171
+
172
+ ### Emacs
173
+
174
+ - Install `boto3-stubs` with services you use in your environment:
175
+
176
+ ```bash
177
+ python -m pip install 'boto3-stubs[geo-maps]'
178
+ ```
179
+
180
+ - Install [use-package](https://github.com/jwiegley/use-package),
181
+ [lsp](https://github.com/emacs-lsp/lsp-mode/),
182
+ [company](https://github.com/company-mode/company-mode) and
183
+ [flycheck](https://github.com/flycheck/flycheck) packages
184
+ - Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package
185
+
186
+ ```elisp
187
+ (use-package lsp-pyright
188
+ :ensure t
189
+ :hook (python-mode . (lambda ()
190
+ (require 'lsp-pyright)
191
+ (lsp))) ; or lsp-deferred
192
+ :init (when (executable-find "python3")
193
+ (setq lsp-pyright-python-executable-cmd "python3"))
194
+ )
195
+ ```
196
+
197
+ - Make sure emacs uses the environment where you have installed `boto3-stubs`
198
+
199
+ Type checking should now work. No explicit type annotations required, write
200
+ your `boto3` code as usual.
201
+
202
+ <a id="sublime-text"></a>
203
+
204
+ ### Sublime Text
205
+
206
+ - Install `boto3-stubs[geo-maps]` with services you use in your environment:
207
+
208
+ ```bash
209
+ python -m pip install 'boto3-stubs[geo-maps]'
210
+ ```
211
+
212
+ - Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package
213
+
214
+ Type checking should now work. No explicit type annotations required, write
215
+ your `boto3` code as usual.
216
+
217
+ <a id="other-ides"></a>
218
+
219
+ ### Other IDEs
220
+
221
+ Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
222
+ should work.
223
+
224
+ <a id="mypy"></a>
225
+
226
+ ### mypy
227
+
228
+ - Install `mypy`: `python -m pip install mypy`
229
+ - Install `boto3-stubs[geo-maps]` in your environment:
230
+
231
+ ```bash
232
+ python -m pip install 'boto3-stubs[geo-maps]'
233
+ ```
234
+
235
+ Type checking should now work. No explicit type annotations required, write
236
+ your `boto3` code as usual.
237
+
238
+ <a id="pyright"></a>
239
+
240
+ ### pyright
241
+
242
+ - Install `pyright`: `npm i -g pyright`
243
+ - Install `boto3-stubs[geo-maps]` in your environment:
244
+
245
+ ```bash
246
+ python -m pip install 'boto3-stubs[geo-maps]'
247
+ ```
248
+
249
+ Optionally, you can install `boto3-stubs` to `typings` directory.
250
+
251
+ Type checking should now work. No explicit type annotations required, write
252
+ your `boto3` code as usual.
253
+
254
+ <a id="explicit-type-annotations"></a>
255
+
256
+ ## Explicit type annotations
257
+
258
+ <a id="client-annotations"></a>
259
+
260
+ ### Client annotations
261
+
262
+ `LocationServiceMapsV2Client` provides annotations for
263
+ `boto3.client("geo-maps")`.
264
+
265
+ ```python
266
+ from boto3.session import Session
267
+
268
+ from mypy_boto3_geo_maps import LocationServiceMapsV2Client
269
+
270
+ client: LocationServiceMapsV2Client = Session().client("geo-maps")
271
+
272
+ # now client usage is checked by mypy and IDE should provide code completion
273
+ ```
274
+
275
+ <a id="literals"></a>
276
+
277
+ ### Literals
278
+
279
+ `mypy_boto3_geo_maps.literals` module contains literals extracted from shapes
280
+ that can be used in user code for type checking.
281
+
282
+ Full list of `LocationServiceMapsV2` Literals can be found in
283
+ [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_geo_maps/literals/).
284
+
285
+ ```python
286
+ from mypy_boto3_geo_maps.literals import ColorSchemeType
287
+
288
+
289
+ def check_value(value: ColorSchemeType) -> bool: ...
290
+ ```
291
+
292
+ <a id="type-definitions"></a>
293
+
294
+ ### Type definitions
295
+
296
+ `mypy_boto3_geo_maps.type_defs` module contains structures and shapes assembled
297
+ to typed dictionaries and unions for additional type checking.
298
+
299
+ Full list of `LocationServiceMapsV2` TypeDefs can be found in
300
+ [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_geo_maps/type_defs/).
301
+
302
+ ```python
303
+ from mypy_boto3_geo_maps.type_defs import GetGlyphsRequestRequestTypeDef
304
+
305
+
306
+ def get_value() -> GetGlyphsRequestRequestTypeDef:
307
+ return {...}
308
+ ```
309
+
310
+ <a id="how-it-works"></a>
311
+
312
+ ## How it works
313
+
314
+ Fully automated
315
+ [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully
316
+ generates type annotations for each service, patiently waiting for `boto3`
317
+ updates. It delivers drop-in type annotations for you and makes sure that:
318
+
319
+ - All available `boto3` services are covered.
320
+ - Each public class and method of every `boto3` service gets valid type
321
+ annotations extracted from `botocore` schemas.
322
+ - Type annotations include up-to-date documentation.
323
+ - Link to documentation is provided for every method.
324
+ - Code is processed by [ruff](https://docs.astral.sh/ruff/) for readability.
325
+
326
+ <a id="what's-new"></a>
327
+
328
+ ## What's new
329
+
330
+ <a id="implemented-features"></a>
331
+
332
+ ### Implemented features
333
+
334
+ - Fully type annotated `boto3`, `botocore`, `aiobotocore` and `aioboto3`
335
+ libraries
336
+ - `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs`
337
+ compatibility
338
+ - `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type
339
+ annotations for each service
340
+ - Generated `TypeDefs` for each service
341
+ - Generated `Literals` for each service
342
+ - Auto discovery of types for `boto3.client` and `boto3.resource` calls
343
+ - Auto discovery of types for `session.client` and `session.resource` calls
344
+ - Auto discovery of types for `client.get_waiter` and `client.get_paginator`
345
+ calls
346
+ - Auto discovery of types for `ServiceResource` and `Resource` collections
347
+ - Auto discovery of types for `aiobotocore.Session.create_client` calls
348
+
349
+ <a id="latest-changes"></a>
350
+
351
+ ### Latest changes
352
+
353
+ Builder changelog can be found in
354
+ [Releases](https://github.com/youtype/mypy_boto3_builder/releases).
355
+
356
+ <a id="versioning"></a>
357
+
358
+ ## Versioning
359
+
360
+ `mypy-boto3-geo-maps` version is the same as related `boto3` version and
361
+ follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format.
362
+
363
+ <a id="thank-you"></a>
364
+
365
+ ## Thank you
366
+
367
+ - [Allie Fitter](https://github.com/alliefitter) for
368
+ [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/),
369
+ this package is based on top of his work
370
+ - [black](https://github.com/psf/black) developers for an awesome formatting
371
+ tool
372
+ - [Timothy Edmund Crosley](https://github.com/timothycrosley) for
373
+ [isort](https://github.com/PyCQA/isort) and how flexible it is
374
+ - [mypy](https://github.com/python/mypy) developers for doing all dirty work
375
+ for us
376
+ - [pyright](https://github.com/microsoft/pyright) team for the new era of typed
377
+ Python
378
+
379
+ <a id="documentation"></a>
380
+
381
+ ## Documentation
382
+
383
+ All services type annotations can be found in
384
+ [boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_geo_maps/)
385
+
386
+ <a id="support-and-contributing"></a>
387
+
388
+ ## Support and contributing
389
+
390
+ This package is auto-generated. Please reports any bugs or request new features
391
+ in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/)
392
+ repository.