Type annotations for aiobotocore.S3Outposts 2.3.4 service generated with mypy-boto3-builder 7.10.0
Project description
types-aiobotocore-s3outposts
Type annotations for aiobotocore.S3Outposts 2.3.4 service compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.
Generated by mypy-boto3-builder 7.10.0.
More information can be found on types-aiobotocore page and in types-aiobotocore-s3outposts docs.
See how it helps to find and fix potential bugs:
How to install
From PyPI with pip
Install types-aiobotocore
for S3Outposts
service.
# install with aiobotocore type annotations
python -m pip install 'types-aiobotocore[s3outposts]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-aiobotocore-lite[s3outposts]'
# standalone installation
python -m pip install types-aiobotocore-s3outposts
How to uninstall
python -m pip uninstall -y types-aiobotocore-s3outposts
Usage
VSCode
- Install Python extension
- Install Pylance extension
- Set
Pylance
as your Python Language Server - Install
types-aiobotocore[s3outposts]
in your environment:
python -m pip install 'types-aiobotocore[s3outposts]'
Both type checking and code completion should now work. No explicit type
annotations required, write your aiobotocore
code as usual.
PyCharm
Install types-aiobotocore-lite[s3outposts]
in your environment:
python -m pip install 'types-aiobotocore-lite[s3outposts]'`
Both type checking and code completion should now work. Explicit type annotations are required.
Use types-aiobotocore
package instead for implicit type discovery.
Emacs
- Install
types-aiobotocore
with services you use in your environment:
python -m pip install 'types-aiobotocore[s3outposts]'
- Install use-package, lsp, company and flycheck packages
- Install lsp-pyright package
(use-package lsp-pyright
:ensure t
:hook (python-mode . (lambda ()
(require 'lsp-pyright)
(lsp))) ; or lsp-deferred
:init (when (executable-find "python3")
(setq lsp-pyright-python-executable-cmd "python3"))
)
- Make sure emacs uses the environment where you have installed
types-aiobotocore
Type checking should now work. No explicit type annotations required, write
your aiobotocore
code as usual.
Sublime Text
- Install
types-aiobotocore[s3outposts]
with services you use in your environment:
python -m pip install 'types-aiobotocore[s3outposts]'
- Install LSP-pyright package
Type checking should now work. No explicit type annotations required, write
your aiobotocore
code as usual.
Other IDEs
Not tested, but as long as your IDE supports mypy
or pyright
, everything
should work.
mypy
- Install
mypy
:python -m pip install mypy
- Install
types-aiobotocore[s3outposts]
in your environment:
python -m pip install 'types-aiobotocore[s3outposts]'`
Type checking should now work. No explicit type annotations required, write
your aiobotocore
code as usual.
pyright
- Install
pyright
:npm i -g pyright
- Install
types-aiobotocore[s3outposts]
in your environment:
python -m pip install 'types-aiobotocore[s3outposts]'
Optionally, you can install types-aiobotocore
to typings
folder.
Type checking should now work. No explicit type annotations required, write
your aiobotocore
code as usual.
Explicit type annotations
Client annotations
S3OutpostsClient
provides annotations for
session.create_client("s3outposts")
.
from aiobotocore.session import get_session
from types_aiobotocore_s3outposts import S3OutpostsClient
session = get_session()
async with session.create_client("s3outposts") as client:
client: S3OutpostsClient
# now client usage is checked by mypy and IDE should provide code completion
Paginators annotations
types_aiobotocore_s3outposts.paginator
module contains type annotations for
all paginators.
from aiobotocore.session import get_session
from types_aiobotocore_s3outposts import S3OutpostsClient
from types_aiobotocore_s3outposts.paginator import (
ListEndpointsPaginator,
ListSharedEndpointsPaginator,
)
session = get_session()
async with session.create_client("s3outposts") as client:
client: S3OutpostsClient
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_endpoints_paginator: ListEndpointsPaginator = client.get_paginator("list_endpoints")
list_shared_endpoints_paginator: ListSharedEndpointsPaginator = client.get_paginator("list_shared_endpoints")
```
### Literals
`types_aiobotocore_s3outposts.literals` module contains literals extracted from shapes
that can be used in user code for type checking.
```python
from types_aiobotocore_s3outposts.literals import (
EndpointAccessTypeType,
EndpointStatusType,
ListEndpointsPaginatorName,
ListSharedEndpointsPaginatorName,
S3OutpostsServiceName,
ServiceName,
ResourceServiceName,
PaginatorName,
RegionName,
)
def check_value(value: EndpointAccessTypeType) -> bool:
...
Typed dictionaries
types_aiobotocore_s3outposts.type_defs
module contains structures and shapes
assembled to typed dictionaries for additional type checking.
from types_aiobotocore_s3outposts.type_defs import (
CreateEndpointRequestRequestTypeDef,
ResponseMetadataTypeDef,
DeleteEndpointRequestRequestTypeDef,
NetworkInterfaceTypeDef,
PaginatorConfigTypeDef,
ListEndpointsRequestRequestTypeDef,
ListSharedEndpointsRequestRequestTypeDef,
CreateEndpointResultTypeDef,
EmptyResponseMetadataTypeDef,
EndpointTypeDef,
ListEndpointsRequestListEndpointsPaginateTypeDef,
ListSharedEndpointsRequestListSharedEndpointsPaginateTypeDef,
ListEndpointsResultTypeDef,
ListSharedEndpointsResultTypeDef,
)
def get_structure() -> CreateEndpointRequestRequestTypeDef:
return {
...
}
How it works
Fully automated
mypy-boto3-builder carefully
generates type annotations for each service, patiently waiting for
aiobotocore
updates. It delivers a drop-in type annotations for you and makes
sure that:
- All available
aiobotocore
services are covered. - Each public class and method of every
aiobotocore
service gets valid type annotations extracted from the documentation (blamebotocore
docs if types are incorrect). - Type annotations include up-to-date documentation.
- Link to documentation is provided for every method.
- Code is processed by black and isort for readability.
What's new
Implemented features
- Fully type annotated
boto3
,botocore
andaiobotocore
libraries mypy
,pyright
,VSCode
,PyCharm
,Sublime Text
andEmacs
compatibilityClient
,ServiceResource
,Resource
,Waiter
Paginator
type annotations for each service- Generated
TypeDefs
for each service - Generated
Literals
for each service - Auto discovery of types for
boto3.client
andboto3.session
calls - Auto discovery of types for
session.client
andsession.session
calls - Auto discovery of types for
client.get_waiter
andclient.get_paginator
calls - Auto discovery of types for
ServiceResource
andResource
collections - Auto discovery of types for
aiobotocore.Session.create_client
calls
Latest changes
Builder changelog can be found in Releases.
Versioning
types-aiobotocore-s3outposts
version is the same as related aiobotocore
version and follows PEP 440
format.
Thank you
- Allie Fitter for boto3-type-annotations, this package is based on top of his work
- black developers for an awesome formatting tool
- Timothy Edmund Crosley for isort and how flexible it is
- mypy developers for doing all dirty work for us
- pyright team for the new era of typed Python
Documentation
All services type annotations can be found in aiobotocore docs
Support and contributing
This package is auto-generated. Please reports any bugs or request new features in mypy-boto3-builder repository.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file types-aiobotocore-s3outposts-2.3.4.post2.tar.gz
.
File metadata
- Download URL: types-aiobotocore-s3outposts-2.3.4.post2.tar.gz
- Upload date:
- Size: 14.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.10.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ece21c7474946fd1a62f7533004f3c3e511817919cc2c023f5629692b38d1449 |
|
MD5 | 13d5042793f7ccda6ca7f4f42b8e2546 |
|
BLAKE2b-256 | d35c5cf275a36258d797a55712441a01cae5698fd6717d8fe4733a8d59308dab |
File details
Details for the file types_aiobotocore_s3outposts-2.3.4.post2-py3-none-any.whl
.
File metadata
- Download URL: types_aiobotocore_s3outposts-2.3.4.post2-py3-none-any.whl
- Upload date:
- Size: 20.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.10.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4923eb206e1e8cd4e4476c0e3c4b551f9ac243e09dba9740554a250ac2696e46 |
|
MD5 | f9b4b65f1d2af23659dfc8604d08b227 |
|
BLAKE2b-256 | a8eadf0d315e0c6dd37f895d5054faae4ebfdf0940b29504ce4053fd687dec87 |