Type annotations for boto3.ForecastService 1.14.0 service, generated by mypy-boto3-buider 2.1.0
Project description
mypy-boto3-forecast
Type annotations for boto3.ForecastService 1.14.0 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.1.0.
More information can be found on boto3-stubs page.
How to install
Make sure you have mypy installed and activated in your IDE.
Install boto3-stubs
for ForecastService
service.
python -m pip install boto3-stubs[forecast]
How to use
Client annotations
ForecastServiceClient
provides annotations for boto3.client("forecast")
.
import boto3
from mypy_boto3_forecast import ForecastServiceClient
client: ForecastServiceClient = boto3.client("forecast")
# now client usage is checked by mypy and IDE should provide code auto-complete
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: ForecastServiceClient = session.client("forecast")
Paginators annotations
mypy_boto3_forecast.paginator
module contains type annotations for all paginators.
from mypy_boto3_forecast import ForecastServiceClient
from mypy_boto3_forecast.paginator import (
ListDatasetGroupsPaginator,
ListDatasetImportJobsPaginator,
ListDatasetsPaginator,
ListForecastExportJobsPaginator,
ListForecastsPaginator,
ListPredictorsPaginator,
)
client: ForecastServiceClient = boto3.client("forecast")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_dataset_groups_paginator: ListDatasetGroupsPaginator = client.get_paginator("list_dataset_groups")
list_dataset_import_jobs_paginator: ListDatasetImportJobsPaginator = client.get_paginator("list_dataset_import_jobs")
list_datasets_paginator: ListDatasetsPaginator = client.get_paginator("list_datasets")
list_forecast_export_jobs_paginator: ListForecastExportJobsPaginator = client.get_paginator("list_forecast_export_jobs")
list_forecasts_paginator: ListForecastsPaginator = client.get_paginator("list_forecasts")
list_predictors_paginator: ListPredictorsPaginator = client.get_paginator("list_predictors")
Typed dictionations
mypy_boto3_forecast.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
from mypy_boto3_forecast.type_defs import CategoricalParameterRangeTypeDef, ...
def get_structure() -> CategoricalParameterRangeTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_forecast
and other installed services.
# Run this command after you add or remove service packages
python -m mypy_boto3
Generated type annotations provide overloads for boto3.client
and boto3.resource
,
boto3.Session.client
and boto3.Session.resource
functions,
so explicit type annotations are not needed.
mypy
supports function overloads as expectedPyCharm
also supports function overloads, but consumes a lot of RAM, use carefully if you have many services installedVSCode
does not currently support function overloads, use explicit type annotations
import boto3
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("forecast")
session_client = boto3.Session().client("forecast")
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
Hashes for mypy-boto3-forecast-1.14.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0e511406832c6a1017642aad9162f851e6666b8fa6647e914ef4876acd08f732 |
|
MD5 | 192e008a2512a7d94b10d97ce4c436fe |
|
BLAKE2b-256 | 8bb0f308a9f92836ff4a4da5fa21bf3a16fb8400840794320630104a078dc619 |
Hashes for mypy_boto3_forecast-1.14.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8a2db8f3004718922512a5033cd97c756e77355783fe57fedd3d04b20e6860ce |
|
MD5 | 207ad4c57e59b9c63594d5b81555da61 |
|
BLAKE2b-256 | 16405bcc92b74daa5bf242e6e9d103d457d4f05ba78c54b910cc047d9e6c2bb8 |