mypy-boto3-glue
Type annotations for boto3 Glue 1.43.100 compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.
Generated with mypy-boto3-builder 8.12.0.
More information can be found on boto3-stubs page and in mypy-boto3-glue docs.
See how it helps you find and fix potential bugs:
- mypy-boto3-glue
How to install
Generate locally (recommended)
You can generate type annotations for boto3 package locally with
mypy-boto3-builder. Use
uv for build
isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.43.100' mypy-boto3-builder - Select
boto3-stubsAWS SDK. - Add
Glueservice. - Use provided commands to install generated packages.
VSCode extension
Add
AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start command.
Click Modify and select boto3 common and Glue.
From PyPI with pip
Install boto3-stubs for Glue service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[glue]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[glue]'
# standalone installation
python -m pip install mypy-boto3-glue
How to uninstall
python -m pip uninstall -y mypy-boto3-glue
Usage
VSCode
- Install Python extension
- Install Pylance extension
- Set
Pylanceas your Python Language Server - Install
boto3-stubs[glue]in your environment:
python -m pip install 'boto3-stubs[glue]'
Both type checking and code completion should now work. No explicit type
annotations required, write your boto3 code as usual.
PyCharm
⚠️ Due to slow PyCharm performance on
Literaloverloads (issue PY-40997), it is recommended to use boto3-stubs-lite until the issue is resolved.
⚠️ If you experience slow performance and high CPU usage, try to disable
PyCharmtype checker and use mypy or pyright instead.
⚠️ To continue using
PyCharmtype checker, you can try to replaceboto3-stubswith boto3-stubs-lite:
pip uninstall boto3-stubs
pip install boto3-stubs-lite
Install boto3-stubs[glue] in your environment:
python -m pip install 'boto3-stubs[glue]'
Both type checking and code completion should now work.
Emacs
- Install
boto3-stubswith services you use in your environment:
python -m pip install 'boto3-stubs[glue]'
- 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
boto3-stubs
Type checking should now work. No explicit type annotations required, write
your boto3 code as usual.
Sublime Text
- Install
boto3-stubs[glue]with services you use in your environment:
python -m pip install 'boto3-stubs[glue]'
- Install LSP-pyright package
Type checking should now work. No explicit type annotations required, write
your boto3 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
boto3-stubs[glue]in your environment:
python -m pip install 'boto3-stubs[glue]'
Type checking should now work. No explicit type annotations required, write
your boto3 code as usual.
pyright
- Install
pyright:npm i -g pyright - Install
boto3-stubs[glue]in your environment:
python -m pip install 'boto3-stubs[glue]'
Optionally, you can install boto3-stubs to typings directory.
Type checking should now work. No explicit type annotations required, write
your boto3 code as usual.
Pylint compatibility
It is totally safe to use TYPE_CHECKING flag in order to avoid
mypy-boto3-glue dependency in production. However, there is an issue in
pylint that it complains about undefined variables. To fix it, set all types
to object in non-TYPE_CHECKING mode.
from typing import TYPE_CHECKING
if TYPE_CHECKING:
from mypy_boto3_ec2 import EC2Client, EC2ServiceResource
from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
from mypy_boto3_ec2.paginators import DescribeVolumesPaginator
else:
EC2Client = object
EC2ServiceResource = object
BundleTaskCompleteWaiter = object
DescribeVolumesPaginator = object
...
Explicit type annotations
Client annotations
GlueClient provides annotations for boto3.client("glue").
from boto3.session import Session
from mypy_boto3_glue import GlueClient
client: GlueClient = Session().client("glue")
# now client usage is checked by mypy and IDE should provide code completion
Paginators annotations
mypy_boto3_glue.paginator module contains type annotations for all
paginators.
from boto3.session import Session
from mypy_boto3_glue import GlueClient
from mypy_boto3_glue.paginator import (
DescribeEntityPaginator,
GetClassifiersPaginator,
GetConnectionsPaginator,
GetCrawlerMetricsPaginator,
GetCrawlersPaginator,
GetDatabasesPaginator,
GetDevEndpointsPaginator,
GetJobRunsPaginator,
GetJobsPaginator,
GetPartitionIndexesPaginator,
GetPartitionsPaginator,
GetResourcePoliciesPaginator,
GetSecurityConfigurationsPaginator,
GetTableVersionsPaginator,
GetTablesPaginator,
GetTriggersPaginator,
GetUserDefinedFunctionsPaginator,
GetWorkflowRunsPaginator,
ListAssetTypesPaginator,
ListBlueprintsPaginator,
ListConnectionTypesPaginator,
ListEntitiesPaginator,
ListFormTypesPaginator,
ListGlossariesPaginator,
ListGlossaryTermsPaginator,
ListIterableFormsPaginator,
ListJobsPaginator,
ListMaterializedViewRefreshTaskRunsPaginator,
ListRegistriesPaginator,
ListSchemaVersionsPaginator,
ListSchemasPaginator,
ListTableOptimizerRunsPaginator,
ListTriggersPaginator,
ListUsageProfilesPaginator,
ListWorkflowsPaginator,
SearchAssetsPaginator,
)
client: GlueClient = Session().client("glue")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
describe_entity_paginator: DescribeEntityPaginator = client.get_paginator("describe_entity")
get_classifiers_paginator: GetClassifiersPaginator = client.get_paginator("get_classifiers")
get_connections_paginator: GetConnectionsPaginator = client.get_paginator("get_connections")
get_crawler_metrics_paginator: GetCrawlerMetricsPaginator = client.get_paginator(
"get_crawler_metrics"
)
get_crawlers_paginator: GetCrawlersPaginator = client.get_paginator("get_crawlers")
get_databases_paginator: GetDatabasesPaginator = client.get_paginator("get_databases")
get_dev_endpoints_paginator: GetDevEndpointsPaginator = client.get_paginator("get_dev_endpoints")
get_job_runs_paginator: GetJobRunsPaginator = client.get_paginator("get_job_runs")
get_jobs_paginator: GetJobsPaginator = client.get_paginator("get_jobs")
get_partition_indexes_paginator: GetPartitionIndexesPaginator = client.get_paginator(
"get_partition_indexes"
)
get_partitions_paginator: GetPartitionsPaginator = client.get_paginator("get_partitions")
get_resource_policies_paginator: GetResourcePoliciesPaginator = client.get_paginator(
"get_resource_policies"
)
get_security_configurations_paginator: GetSecurityConfigurationsPaginator = client.get_paginator(
"get_security_configurations"
)
get_table_versions_paginator: GetTableVersionsPaginator = client.get_paginator("get_table_versions")
get_tables_paginator: GetTablesPaginator = client.get_paginator("get_tables")
get_triggers_paginator: GetTriggersPaginator = client.get_paginator("get_triggers")
get_user_defined_functions_paginator: GetUserDefinedFunctionsPaginator = client.get_paginator(
"get_user_defined_functions"
)
get_workflow_runs_paginator: GetWorkflowRunsPaginator = client.get_paginator("get_workflow_runs")
list_asset_types_paginator: ListAssetTypesPaginator = client.get_paginator("list_asset_types")
list_blueprints_paginator: ListBlueprintsPaginator = client.get_paginator("list_blueprints")
list_connection_types_paginator: ListConnectionTypesPaginator = client.get_paginator(
"list_connection_types"
)
list_entities_paginator: ListEntitiesPaginator = client.get_paginator("list_entities")
list_form_types_paginator: ListFormTypesPaginator = client.get_paginator("list_form_types")
list_glossaries_paginator: ListGlossariesPaginator = client.get_paginator("list_glossaries")
list_glossary_terms_paginator: ListGlossaryTermsPaginator = client.get_paginator(
"list_glossary_terms"
)
list_iterable_forms_paginator: ListIterableFormsPaginator = client.get_paginator(
"list_iterable_forms"
)
list_jobs_paginator: ListJobsPaginator = client.get_paginator("list_jobs")
list_materialized_view_refresh_task_runs_paginator: ListMaterializedViewRefreshTaskRunsPaginator = (
client.get_paginator("list_materialized_view_refresh_task_runs")
)
list_registries_paginator: ListRegistriesPaginator = client.get_paginator("list_registries")
list_schema_versions_paginator: ListSchemaVersionsPaginator = client.get_paginator(
"list_schema_versions"
)
list_schemas_paginator: ListSchemasPaginator = client.get_paginator("list_schemas")
list_table_optimizer_runs_paginator: ListTableOptimizerRunsPaginator = client.get_paginator(
"list_table_optimizer_runs"
)
list_triggers_paginator: ListTriggersPaginator = client.get_paginator("list_triggers")
list_usage_profiles_paginator: ListUsageProfilesPaginator = client.get_paginator(
"list_usage_profiles"
)
list_workflows_paginator: ListWorkflowsPaginator = client.get_paginator("list_workflows")
search_assets_paginator: SearchAssetsPaginator = client.get_paginator("search_assets")
Literals
mypy_boto3_glue.literals module contains literals extracted from shapes that
can be used in user code for type checking.
Full list of Glue Literals can be found in
docs.
from mypy_boto3_glue.literals import AdditionalOptionKeysType
def check_value(value: AdditionalOptionKeysType) -> bool: ...
Type definitions
mypy_boto3_glue.type_defs module contains structures and shapes assembled to
typed dictionaries and unions for additional type checking.
Full list of Glue TypeDefs can be found in
docs.
# TypedDict usage example
from mypy_boto3_glue.type_defs import NotificationPropertyTypeDef
def get_value() -> NotificationPropertyTypeDef:
return {
"NotifyDelayAfter": ...,
}
How it works
Fully automated
mypy-boto3-builder carefully
generates type annotations for each service, patiently waiting for boto3
updates. It delivers drop-in type annotations for you and makes sure that:
- All available
boto3services are covered. - Each public class and method of every
boto3service gets valid type annotations extracted frombotocoreschemas. - Type annotations include up-to-date documentation.
- Link to documentation is provided for every method.
- Code is processed by ruff for readability.
What's new
Implemented features
- Fully type annotated
boto3,botocore,aiobotocoreandaioboto3libraries mypy,pyright,VSCode,PyCharm,Sublime TextandEmacscompatibilityClient,ServiceResource,Resource,WaiterPaginatortype annotations for each service- Generated
TypeDefsfor each service - Generated
Literalsfor each service - Auto discovery of types for
boto3.clientandboto3.resourcecalls - Auto discovery of types for
session.clientandsession.resourcecalls - Auto discovery of types for
client.get_waiterandclient.get_paginatorcalls - Auto discovery of types for
ServiceResourceandResourcecollections - Auto discovery of types for
aiobotocore.Session.create_clientcalls
Latest changes
Builder changelog can be found in Releases.
Versioning
mypy-boto3-glue version is the same as related boto3 version and follows
Python Packaging version specifiers.
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 boto3 docs
Support and contributing
This package is auto-generated. Please reports any bugs or request new features in mypy-boto3-builder repository.
1 maintainer
Release files for mypy-boto3-glue 1.43.100
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mypy_boto3_glue-1.43.100.tar.gz | 153.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mypy_boto3_glue-1.43.100-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 308.4 kB
Release files / mypy_boto3_glue-1.43.100.tar.gz
| Download URL | mypy_boto3_glue-1.43.100.tar.gz |
|---|---|
| Size | 153.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f7c9e3c3b894fdf5d6b04c3d7de9f7b24b7c8db9fd18dadba93caa48d30380f1
|
|
BLAKE2b-256 checksum How to use checksums |
e127700d04e1b567a8b2548172040e7ad2c899741b9b8470ac6158f372a32986
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.15
|
Release files / mypy_boto3_glue-1.43.100-py3-none-any.whl
| Download URL | mypy_boto3_glue-1.43.100-py3-none-any.whl |
|---|---|
| Size | 155.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
104b3d95133e10b4ad825432cfeeeb97ec56d5bb7ee70509ffc2a6a749b45a03
|
|
BLAKE2b-256 checksum How to use checksums |
14bf781db91d144e0f2a4c91649499722de9b57f6a3c251b34d339820f3f7f0f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.15
|
