Type annotations for boto3.ForecastService 1.14.37 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-forecast
Type annotations for boto3.ForecastService 1.14.37 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.2.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
from mypy_boto3_forecast.paginator import (
ListDatasetGroupsPaginator,
ListDatasetImportJobsPaginator,
ListDatasetsPaginator,
ListForecastExportJobsPaginator,
ListForecastsPaginator,
ListPredictorsPaginator,
)
from mypy_boto3_forecast.type_defs import CategoricalParameterRangeTypeDef, ...
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.
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.
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
# 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.37.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0f0cc3957aa91b3c281e5197d350c5868f77be27027ecfd42ca7bfef8704a9a6 |
|
MD5 | c89c8b68778d2d337da9fc1a5624796b |
|
BLAKE2b-256 | 302521883a41f3c415283056240f733c6eac5e93522d6d6995632303cc481088 |
Hashes for mypy_boto3_forecast-1.14.37.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ec85cdc710f339393a915d32b9e02f126d9aeda3ab230a95f858c7e28e55f8fa |
|
MD5 | 99f2c1fca4e5e76122ece493e8f4590e |
|
BLAKE2b-256 | 5a6f19ffcc69cae2967868cdd53f326fb7281ee0e68e5b477783bfda50627a70 |