mypy_boto3_builder の API リファレンス

mypy_boto3_builder (youtype/mypy_boto3_builder) の公開 API 400 件 —— クラス 101、関数 66、メソッド 233。実際のソースを静的解析して抽出した正確なシグネチャを掲載しています。

リポジトリ: youtype/mypy_boto3_builder

種別	件数
クラス	101
関数	66
メソッド	233

API 一覧

funcintegration.boto3_stubs.dynamodb_example.dynamodb_client_example() -> None

Integration test sample for DynamoDBClient.

funcintegration.boto3_stubs.dynamodb_example.main() -> None

Run examples.

funcintegration.boto3_stubs.ec2_example.ec2_client_example() -> None

Integration test sample for EC2Client.

funcintegration.boto3_stubs.ec2_example.ec2_resource_example() -> None

Integration test sample for EC2ServiceResource.

funcintegration.boto3_stubs.ec2_example.main() -> None

Run examples.

funcintegration.boto3_stubs.emr_example.emr_client_example() -> None

Integration test sample for EMRClient.

funcintegration.boto3_stubs.emr_example.main() -> None

Run examples.

funcintegration.boto3_stubs.iam_example.iam_client_example() -> None

Integration test sample for IAMClient.

funcintegration.boto3_stubs.iam_example.iam_resource_example() -> None

Integration test sample for IAMServiceResource.

funcintegration.boto3_stubs.iam_example.main() -> None

Run examples.

funcintegration.boto3_stubs.s3_example.main() -> None

Run examples.

funcintegration.boto3_stubs.s3_example.s3_client_example() -> None

Integration test sample for S3Client.

funcintegration.boto3_stubs.s3_example.s3_resource_example() -> None

Integration test sample for S3ServiceResource.

funcintegration.boto3_stubs.secretsmanager_example.main() -> None

Run examples.

funcintegration.boto3_stubs.sqs_example.main() -> None

Run examples.

funcintegration.boto3_stubs.sqs_example.sqs_resource_example() -> None

Integration test sample for SQSClient.

funcintegration.boto3_stubs_lite.s3_example.main() -> None

Run examples.

funcintegration.boto3_stubs_lite.s3_example.s3_client_example() -> None

Integration test sample for S3Client.

funcintegration.boto3_stubs_lite.s3_example.s3_resource_example() -> None

Integration test sample for S3ServiceResource.

funcintegration.types_aioboto3.s3_example.main() -> None

Run examples.

funcintegration.types_aioboto3.s3_example.s3_client_example() -> None

Integration test sample for S3Client.

funcintegration.types_aioboto3.s3_example.s3_resource_example() -> None

Integration test sample for S3ServiceResource.

funcintegration.types_aioboto3_lite.s3_example.main() -> None

Run examples.

funcintegration.types_aioboto3_lite.s3_example.s3_client_example() -> None

Integration test sample for S3Client.

funcintegration.types_aioboto3_lite.s3_example.s3_resource_example() -> None

Integration test sample for S3ServiceResource.

funcintegration.types_aiobotocore.s3_example.main() -> None

Run examples.

funcintegration.types_aiobotocore.s3_example.s3_client_example() -> None

Integration test sample for S3Client.

funcintegration.types_aiobotocore_lite.s3_example.main() -> None

Run examples.

funcintegration.types_aiobotocore_lite.s3_example.s3_client_example() -> None

Integration test sample for S3Client.

funcintegration.types_boto3.dynamodb_example.dynamodb_client_example() -> None

Integration test sample for DynamoDBClient.

funcintegration.types_boto3.dynamodb_example.main() -> None

Run examples.

funcintegration.types_boto3.ec2_example.ec2_client_example() -> None

Integration test sample for EC2Client.

funcintegration.types_boto3.ec2_example.ec2_resource_example() -> None

Integration test sample for EC2ServiceResource.

funcintegration.types_boto3.ec2_example.main() -> None

Run examples.

funcintegration.types_boto3.emr_example.emr_client_example() -> None

Integration test sample for EMRClient.

funcintegration.types_boto3.emr_example.main() -> None

Run examples.

funcintegration.types_boto3.iam_example.iam_client_example() -> None

Integration test sample for IAMClient.

funcintegration.types_boto3.iam_example.iam_resource_example() -> None

Integration test sample for IAMServiceResource.

funcintegration.types_boto3.iam_example.main() -> None

Run examples.

funcintegration.types_boto3.s3_example.main() -> None

Run examples.

funcintegration.types_boto3.s3_example.s3_client_example() -> None

Integration test sample for S3Client.

funcintegration.types_boto3.s3_example.s3_resource_example() -> None

Integration test sample for S3ServiceResource.

funcintegration.types_boto3.secretsmanager_example.main() -> None

Run examples.

funcintegration.types_boto3.sqs_example.main() -> None

Run examples.

funcintegration.types_boto3.sqs_example.sqs_resource_example() -> None

Integration test sample for SQSClient.

funcintegration.types_boto3_lite.s3_example.main() -> None

Run examples.

funcintegration.types_boto3_lite.s3_example.s3_client_example() -> None

Integration test sample for S3Client.

funcintegration.types_boto3_lite.s3_example.s3_resource_example() -> None

Integration test sample for S3ServiceResource.

classmypy_boto3_builder.boto3_ports.model.Action

A service operation action.

classmypy_boto3_builder.boto3_ports.model.Collection

A group of resources.

classmypy_boto3_builder.boto3_ports.model.Identifier

A resource identifier, given by its name.

classmypy_boto3_builder.boto3_ports.model.Request

A service operation action request.

methodmypy_boto3_builder.boto3_ports.model.ResourceModel.actions() -> list[Action]

Get a list of actions for this resource.

methodmypy_boto3_builder.boto3_ports.model.ResourceModel.identifiers() -> list[Identifier]

Get a list of resource identifiers.

methodmypy_boto3_builder.boto3_ports.model.ResourceModel.references() -> list[Action]

Get a list of reference resources.

methodmypy_boto3_builder.boto3_ports.model.ResourceModel.subresources() -> list[Action]

Get a list of sub-resources.

methodmypy_boto3_builder.boto3_ports.model.ResourceModel.waiters() -> list[Waiter]

Get a list of waiters for this resource.

methodmypy_boto3_builder.boto3_ports.model.ResponseResource.identifiers() -> list[Parameter]

A list of resource identifiers.

classmypy_boto3_builder.boto3_ports.model.Waiter

An event waiter specification.

classmypy_boto3_builder.chat.chat.Chat

Chat assistant.

method

mypy_boto3_builder.chat.chat.Chat.confirm(message:Message | str='', message_end:Message | str='', message_yes:Message | str='I agree', message_no:Message | str='I disagree') -> bool

Confirm a message.

methodmypy_boto3_builder.chat.chat.Chat.respond(message:Message | str) -> None

Respond as a User.

methodmypy_boto3_builder.chat.chat.Chat.say(message:Message | str) -> None

Say as a Bot.

method

mypy_boto3_builder.chat.chat.Chat.select(message:Message | str, choices:Sequence[Choice | str], *default:Choice | str | None=None, *message_end:Message | str='', *instruction:Message | str='') -> str

Select one item from list.

methodmypy_boto3_builder.chat.chat.Chat.select_output_path(message:Message | str, default:Path | None=None) -> Path

Ask to select an output directory.

classmypy_boto3_builder.chat.choice.Choice

Choice for select.

methodmypy_boto3_builder.chat.choice.Choice.answer() -> Message

Current answer.

methodmypy_boto3_builder.chat.choice.Choice.create(choice:Choice | str) -> Choice

Create choice from string.

methodmypy_boto3_builder.chat.choice.Choice.deselect() -> None

Deselect choice.

methodmypy_boto3_builder.chat.choice.Choice.is_selected() -> bool

Whether choice is selected.

methodmypy_boto3_builder.chat.choice.Choice.select(index:int=0) -> None

Select choice.

methodmypy_boto3_builder.chat.choice.Choice.tag() -> Message

Previous answers.

classmypy_boto3_builder.chat.enums.Library

Library type.

methodmypy_boto3_builder.chat.enums.Library.documentation_url() -> str

Link to documentation.

methodmypy_boto3_builder.chat.enums.Library.from_products(products:Iterable[Product]) -> 'Library | None'

Get library from product.

methodmypy_boto3_builder.chat.enums.Library.get_package_prefix() -> str

Get *.whl package name prefix.

methodmypy_boto3_builder.chat.enums.Library.product() -> Product

Get product.

methodmypy_boto3_builder.chat.enums.Library.product_library() -> ProductLibrary

Get product library.

methodmypy_boto3_builder.chat.enums.Library.text() -> Message

Get choice user text.

methodmypy_boto3_builder.chat.enums.Library.title() -> Message

Get choice title.

methodmypy_boto3_builder.chat.enums.Library.title_info() -> str

Get choice title.

classmypy_boto3_builder.chat.enums.PackageManager

Available package managers.

methodmypy_boto3_builder.chat.enums.PackageManager.get_install_cmd(whl_path:Path) -> str

Get install command.

methodmypy_boto3_builder.chat.enums.PackageManager.url() -> str

Get package manager URL.

classmypy_boto3_builder.chat.enums.ServiceActions

Available service actions.

classmypy_boto3_builder.chat.prompts.base_prompt.BasePrompt

Base wrapper for questionary.Question.

classmypy_boto3_builder.chat.prompts.base_prompt.BasePrompt.PatchedPromptSession

Patched PromptSession with custom message.

methodmypy_boto3_builder.chat.prompts.base_prompt.BasePrompt.ask() -> R

Ask a question and return a result.

methodmypy_boto3_builder.chat.prompts.base_prompt.BasePrompt.get_help_message() -> Message

Get help message.

methodmypy_boto3_builder.chat.prompts.base_prompt.BasePrompt.get_prompt_tokens() -> list[tuple[str, str]]

Get prompt tokens for PromptSession.

methodmypy_boto3_builder.chat.prompts.base_prompt.BasePrompt.get_question() -> Question

Create an underlying question.

classmypy_boto3_builder.chat.prompts.path_prompt.PathPrompt

Path prompt based on questionary.path.

classmypy_boto3_builder.chat.prompts.select_prompt.SelectPrompt

Select prompt based on questionary.path.

classmypy_boto3_builder.chat.text_style.TextStyle

prompt_toolkit style wrapper.

methodmypy_boto3_builder.chat.text_style.TextStyle.apply(message:Message | str) -> tuple[MessagePair, ...]

Apply styling for internal usage.

methodmypy_boto3_builder.chat.text_style.TextStyle.css() -> str

CSS properties for class.

methodmypy_boto3_builder.chat.text_style.TextStyle.get_style() -> Style

Generate prompt_toolkit.Style.

methodmypy_boto3_builder.chat.text_style.TextStyle.style() -> str

Class usage name.

methodmypy_boto3_builder.chat.text_style.TextStyle.stylize(message:Message | str) -> list[tuple[str, str]]

Stylize for prompt_toolkit.

methodmypy_boto3_builder.chat.text_style.TextStyle.wrap(message:str | float) -> MessagePair

Wrap message with style.

funcmypy_boto3_builder.chat.utils.as_message(message:Message | str) -> Message

Convert message or string to Message.

funcmypy_boto3_builder.chat.utils.as_string(message:Message | list[tuple[str, str]] | str) -> str

Convert message to string.

classmypy_boto3_builder.cli_parser.CLINamespace

CLI arguments namespace.

methodmypy_boto3_builder.cli_parser.CLINamespace.to_cmd() -> tuple[str, ...]

Convert namespace to shlex arguments.

classmypy_boto3_builder.cli_parser.EnumListAction

Argparse action for handling Enums.

funcmypy_boto3_builder.cli_parser.get_absolute_path(path:str) -> Path

Get absolute path from a string.

funcmypy_boto3_builder.cli_parser.parse_args(args:Sequence[str]) -> CLINamespace

Parse CLI arguments.

classmypy_boto3_builder.constants.StaticStubsPath

Static *.pyi files path.

classmypy_boto3_builder.constants.StaticStubsPullURL

Static *.pyi files zip download URL.

classmypy_boto3_builder.constants.TemplatePath

Template paths.

funcmypy_boto3_builder.debug.main() -> None

Profiling entrypoint.

classmypy_boto3_builder.enums.output_type.OutputType

Output type choice for CLI.

methodmypy_boto3_builder.enums.output_type.OutputType.is_packaged() -> bool

Whether output type is packaged for installation.

methodmypy_boto3_builder.enums.output_type.OutputType.is_preserved() -> bool

Check if output is preserved.

classmypy_boto3_builder.enums.product.Product

Product choice for CLI.

methodmypy_boto3_builder.enums.product.Product.get_library() -> ProductLibrary

Get library name.

methodmypy_boto3_builder.enums.product.Product.get_type() -> ProductType

Get product type.

classmypy_boto3_builder.enums.product_library.ProductLibrary

Product library choice for CLI.

methodmypy_boto3_builder.enums.product_library.ProductLibrary.get_chat_choice() -> str

Get chat choice.

methodmypy_boto3_builder.enums.product_library.ProductLibrary.get_library_name() -> str

Get library name.

classmypy_boto3_builder.enums.product_type.ProductType

Product type choice for CLI.

classmypy_boto3_builder.enums.service_module_name.ServiceModuleName

Enum for service modules.

methodmypy_boto3_builder.enums.service_module_name.ServiceModuleName.file_name() -> str

Module file name.

methodmypy_boto3_builder.enums.service_module_name.ServiceModuleName.stub_file_name() -> str

Module file name.

methodmypy_boto3_builder.enums.service_module_name.ServiceModuleName.template_name() -> str

Module template file name.

classmypy_boto3_builder.exceptions.AlreadyPublishedError

Error on already published package.

classmypy_boto3_builder.exceptions.BuildEnvError

Error during getting 3rd party data.

classmypy_boto3_builder.exceptions.BuildError

Error during build process.

classmypy_boto3_builder.exceptions.BuildInternalError

Error on invalid build.

classmypy_boto3_builder.exceptions.BuilderError

Base error for mypy_boto3_builder.

classmypy_boto3_builder.exceptions.JinjaManagerError

Base JinjaManager exception.

classmypy_boto3_builder.exceptions.ShapeParserError

Main error for ShapeParser.

classmypy_boto3_builder.exceptions.StructureError

Error on invalid internal structure.

classmypy_boto3_builder.exceptions.TypeAnnotationError

Error on invalid internal type annotation.

classmypy_boto3_builder.generators.aioboto3_generator.AioBoto3Generator

Generator for types-aioboto3 packages.

methodmypy_boto3_builder.generators.aioboto3_generator.AioBoto3Generator.generate_docs() -> None

Generate service and main docs.

methodmypy_boto3_builder.generators.aioboto3_generator.AioBoto3Generator.generate_full_stubs() -> NoReturn

Not implemented.

methodmypy_boto3_builder.generators.aioboto3_generator.AioBoto3Generator.generate_service_stubs() -> NoReturn

Not implemented.

classmypy_boto3_builder.generators.aiobotocore_generator.AioBotocoreGenerator

Generator for types-aiobotocore packages.

methodmypy_boto3_builder.generators.aiobotocore_generator.AioBotocoreGenerator.generate_docs() -> None

Generate service and main docs.

classmypy_boto3_builder.generators.base_generator.BaseGenerator

Base stubs/docs generator.

methodmypy_boto3_builder.generators.base_generator.BaseGenerator.cleanup_temporary_files() -> None

Cleanup temporary files.

methodmypy_boto3_builder.generators.base_generator.BaseGenerator.generate_custom_stubs() -> Package | None

Generate custom stubs.

methodmypy_boto3_builder.generators.base_generator.BaseGenerator.generate_docs() -> None

Generate service and main docs.

methodmypy_boto3_builder.generators.base_generator.BaseGenerator.generate_full_stubs() -> Package | None

Generate full stubs.

methodmypy_boto3_builder.generators.base_generator.BaseGenerator.generate_product(product_type:ProductType) -> None

Run generator for a product type.

methodmypy_boto3_builder.generators.base_generator.BaseGenerator.generate_service_stubs() -> list[ServicePackage]

Generate service stubs.

methodmypy_boto3_builder.generators.base_generator.BaseGenerator.generate_stubs() -> Package | None

Generate main stubs.

methodmypy_boto3_builder.generators.base_generator.BaseGenerator.generate_stubs_lite() -> Package | None

Generate main stubs.

methodmypy_boto3_builder.generators.base_generator.BaseGenerator.is_package_temporary() -> bool

Whether to preserve generated package.

methodmypy_boto3_builder.generators.base_generator.BaseGenerator.is_packaged() -> bool

Whether to build wheel or sdist.

methodmypy_boto3_builder.generators.base_generator.BaseGenerator.output_path() -> Path

Output path.

methodmypy_boto3_builder.generators.base_generator.BaseGenerator.service_package_data() -> BasePackageData

Service package data.

classmypy_boto3_builder.generators.boto34_generator.Boto34Generator

Generator for boto34 package.

methodmypy_boto3_builder.generators.boto34_generator.Boto34Generator.generate_custom_stubs() -> NoReturn

Not implemented.

methodmypy_boto3_builder.generators.boto34_generator.Boto34Generator.generate_docs() -> None

Not implemented.

methodmypy_boto3_builder.generators.boto34_generator.Boto34Generator.generate_full_stubs() -> NoReturn

Not implemented.

methodmypy_boto3_builder.generators.boto34_generator.Boto34Generator.generate_stubs() -> None

Generate boto34 services.

methodmypy_boto3_builder.generators.boto34_generator.Boto34Generator.generate_stubs_lite() -> NoReturn

Not implemented.

methodmypy_boto3_builder.generators.boto34_generator.Boto34Generator.service_package_data() -> BasePackageData

Service package data.

classmypy_boto3_builder.generators.boto3_generator.Boto3Generator

Generator for boto3-stubs packages.

methodmypy_boto3_builder.generators.boto3_generator.Boto3Generator.generate_custom_stubs() -> Package

Generate `types-boto3-custom` package.

methodmypy_boto3_builder.generators.boto3_generator.Boto3Generator.generate_docs() -> None

Generate service and docs.

methodmypy_boto3_builder.generators.boto3_generator.Boto3Generator.generate_full_stubs() -> Package | None

Generate `boto3-stubs-full` package.

methodmypy_boto3_builder.generators.boto3_generator.Boto3Generator.generate_stubs() -> TypesBoto3Package | None

Generate `boto3-stubs` package.

methodmypy_boto3_builder.generators.boto3_generator.Boto3Generator.generate_stubs_lite() -> Package | None

Generate `boto3-stubs-lite` package.

classmypy_boto3_builder.generators.mypy_boto3_generator.MypyBoto3Generator

Generator for mypy-boto3 package.

methodmypy_boto3_builder.generators.mypy_boto3_generator.MypyBoto3Generator.generate_custom_stubs() -> NoReturn

Not implemented.

methodmypy_boto3_builder.generators.mypy_boto3_generator.MypyBoto3Generator.generate_docs() -> None

Not implemented.

methodmypy_boto3_builder.generators.mypy_boto3_generator.MypyBoto3Generator.generate_full_stubs() -> NoReturn

Not implemented.

methodmypy_boto3_builder.generators.mypy_boto3_generator.MypyBoto3Generator.generate_stubs() -> MypyBoto3Package | None

Generate main stubs.

methodmypy_boto3_builder.generators.mypy_boto3_generator.MypyBoto3Generator.generate_stubs_lite() -> NoReturn

Not implemented.

classmypy_boto3_builder.generators.types_boto3_generator.TypesBoto3Generator

Generator for types-boto3 packages.

methodmypy_boto3_builder.generators.types_boto3_generator.TypesBoto3Generator.generate_docs() -> None

Generate service and main docs.

methodmypy_boto3_builder.generators.types_boto3_generator.TypesBoto3Generator.generate_stubs() -> TypesBoto3Package | None

Generate `types-boto3` package.

classmypy_boto3_builder.import_helpers.import_helper.Import

Wrapper for ImportString usage.

methodmypy_boto3_builder.import_helpers.import_helper.Import.from_parts(parent:str, *parts:str) -> ImportString

Create from string.

methodmypy_boto3_builder.import_helpers.import_helper.Import.from_str(import_string:str) -> ImportString

Create from string.

methodmypy_boto3_builder.import_helpers.import_helper.Import.local(module_name:str) -> ImportString

Create local import string.

classmypy_boto3_builder.import_helpers.import_parent.ImportParent

Enum with all parent imports.

methodmypy_boto3_builder.import_helpers.import_parent.ImportParent.is_builtins(parent_name:str) -> bool

Whether import is from Python `builtins` module.

methodmypy_boto3_builder.import_helpers.import_parent.ImportParent.is_third_party(parent_name:str) -> bool

Whether import is from 3rd party module.

classmypy_boto3_builder.import_helpers.import_record.ImportRecord

Helper for Python import strings.

methodmypy_boto3_builder.import_helpers.import_record.ImportRecord.copy() -> Self

Create a copy of the record.

methodmypy_boto3_builder.import_helpers.import_record.ImportRecord.get_local_name() -> str

Get local import name.

methodmypy_boto3_builder.import_helpers.import_record.ImportRecord.needs_sys_fallback() -> bool

Whether ImportString requires `sys` module.

methodmypy_boto3_builder.import_helpers.import_record.ImportRecord.render() -> str

Get rendered string.

methodmypy_boto3_builder.import_helpers.import_record.ImportRecord.render_name() -> str

Get rendered import name.

classmypy_boto3_builder.import_helpers.import_record_group.ImportRecordGroup

Group tool for ImportRecord sets.

methodmypy_boto3_builder.import_helpers.import_record_group.ImportRecordGroup.add(*records:ImportRecord) -> None

Add record to group.

classmypy_boto3_builder.import_helpers.import_string.ImportString

Wrapper for Python import strings.

methodmypy_boto3_builder.import_helpers.import_string.ImportString.is_local() -> bool

Whether import is from local module.

methodmypy_boto3_builder.import_helpers.import_string.ImportString.is_third_party() -> bool

Whether import is from 3rd party module.

methodmypy_boto3_builder.import_helpers.import_string.ImportString.is_type_defs() -> bool

Whether import is from `type_defs` module.

methodmypy_boto3_builder.import_helpers.import_string.ImportString.parent() -> str

Get first import string part or `builtins`.

methodmypy_boto3_builder.import_helpers.import_string.ImportString.render() -> str

Render to string.

methodmypy_boto3_builder.import_helpers.import_string.ImportString.startswith(other:'ImportString') -> bool

Whether import string starts with another import string.

classmypy_boto3_builder.jinja_manager.JinjaManager

Jinja2 `Environment` manager.

methodmypy_boto3_builder.jinja_manager.JinjaManager.get_template(template_path:Path) -> Template

Get `jinja2.Template`.

methodmypy_boto3_builder.jinja_manager.JinjaManager.update_globals(**kwargs:Any) -> None

Update global variables in `jinja2.Environment`.

funcmypy_boto3_builder.logger.disable_logger() -> None

Disable logger.

funcmypy_boto3_builder.logger.enable_logger() -> None

Enable logger.

funcmypy_boto3_builder.logger.get_logger() -> loguru.Logger

Get Logger instance.

funcmypy_boto3_builder.logger.setup_logger(level:int=logging.DEBUG, name:str=LOGGER_NAME) -> None

Set up logger.

func

mypy_boto3_builder.main.generate_product(product:Product, args:CLINamespace, service_names:Sequence[ServiceName], main_service_names:Sequence[ServiceName]) -> None

Generate a selected product.

funcmypy_boto3_builder.main.get_generator(product:Product, kwargs:GeneratorKwargs) -> BaseGenerator

Get Generator class for a product.

func

mypy_boto3_builder.main.get_selected_service_names(selected:Iterable[str], available:Iterable[ServiceName]) -> list[ServiceName]

Get a list of selected service names.

funcmypy_boto3_builder.main.initialize_jinja_manager() -> None

Initialize Jinja manager with globals.

funcmypy_boto3_builder.main.main() -> None

CLI entrypoint.

funcmypy_boto3_builder.main.run(args:CLINamespace) -> None

Run builder.

classmypy_boto3_builder.package_data.BasePackageData

Generic package data.

methodmypy_boto3_builder.package_data.BasePackageData.get_library_chat_choice() -> str

Get package library chat choice.

methodmypy_boto3_builder.package_data.BasePackageData.get_library_name() -> str

Get PyPI library name.

methodmypy_boto3_builder.package_data.BasePackageData.get_library_version() -> str

Get underlying library version.

methodmypy_boto3_builder.package_data.BasePackageData.get_service_package_name(service_name:ServiceName) -> str

Get service package name.

methodmypy_boto3_builder.package_data.BasePackageData.get_service_pypi_name(service_name:ServiceName) -> str

Get service package PyPI name.

methodmypy_boto3_builder.package_data.BasePackageData.has_pypi_lite_package() -> bool

Check if package has lite version.

classmypy_boto3_builder.package_data.Boto3StubsCustomPackageData

boto3-stubs-custom package data.

methodmypy_boto3_builder.package_data.Boto3StubsCustomPackageData.get_service_pypi_name(service_name:ServiceName) -> str

Get service package PyPI name.

classmypy_boto3_builder.package_data.Boto3StubsFullPackageData

boto3-stubs-full package data.

methodmypy_boto3_builder.package_data.Boto3StubsFullPackageData.get_service_pypi_name(service_name:ServiceName) -> str

Get service package PyPI name.

classmypy_boto3_builder.package_data.Boto3StubsLitePackageData

boto3-stubs-lite package data.

classmypy_boto3_builder.package_data.Boto3StubsPackageData

boto3-stubs package data.

classmypy_boto3_builder.package_data.MypyBoto3PackageData

mypy-boto3 package data.

classmypy_boto3_builder.package_data.TypesAioBoto3CustomPackageData

types-aioboto3-custom package data.

methodmypy_boto3_builder.package_data.TypesAioBoto3CustomPackageData.get_service_pypi_name(service_name:ServiceName) -> str

Get service package PyPI name.

classmypy_boto3_builder.package_data.TypesAioBoto3LitePackageData

types-aioboto3-lite package data.

classmypy_boto3_builder.package_data.TypesAioBoto3PackageData

types-aioboto3 package data.

classmypy_boto3_builder.package_data.TypesAioBotocoreCustomPackageData

types-aiobotocore-custom package data.

methodmypy_boto3_builder.package_data.TypesAioBotocoreCustomPackageData.get_service_pypi_name(service_name:ServiceName) -> str

Get service package PyPI name.

classmypy_boto3_builder.package_data.TypesAioBotocoreFullPackageData

types-aiobotocore-full package data.

methodmypy_boto3_builder.package_data.TypesAioBotocoreFullPackageData.get_service_pypi_name(service_name:ServiceName) -> str

Get service package PyPI name.

classmypy_boto3_builder.package_data.TypesAioBotocoreLitePackageData

types-aiobotocore-lite package data.

classmypy_boto3_builder.package_data.TypesAioBotocorePackageData

types-aiobotocore package data.

classmypy_boto3_builder.package_data.TypesBoto3CustomPackageData

boto3-stubs-custom package data.

methodmypy_boto3_builder.package_data.TypesBoto3CustomPackageData.get_service_pypi_name(service_name:ServiceName) -> str

Get service package PyPI name.

classmypy_boto3_builder.package_data.TypesBoto3FullPackageData

boto3-stubs-full package data.

methodmypy_boto3_builder.package_data.TypesBoto3FullPackageData.get_service_pypi_name(service_name:ServiceName) -> str

Get service package PyPI name.

classmypy_boto3_builder.package_data.TypesBoto3LitePackageData

types-boto3-lite package data.

classmypy_boto3_builder.package_data.TypesBoto3PackageData

types-boto3 package data.

func

mypy_boto3_builder.parsers.mypy_boto3_package.parse_mypy_boto3_package(service_names:Iterable[ServiceName], version:str) -> MypyBoto3Package

Parse data for mypy-boto3 package.

funcmypy_boto3_builder.parsers.parse_references.parse_references(resource_model:ResourceModel) -> list[Attribute]

Extract references from boto3 resource.

func

mypy_boto3_builder.parsers.parse_wrapper_package.parse_types_boto3_package(service_names:Iterable[ServiceName], package_data:BasePackageData, version:str) -> TypesBoto3Package

Parse data for types-boto3 package.

classmypy_boto3_builder.parsers.resource_loader.ResourceLoader

Loader for botocore resource shapes.

methodmypy_boto3_builder.parsers.resource_loader.ResourceLoader.get_service_data(service_name:ServiceName) -> dict[str, Any]

Get botocore service data.

methodmypy_boto3_builder.parsers.resource_loader.ResourceLoader.has_service_resource(service_name:ServiceName) -> bool

Check if service has ServiceResource.

method

mypy_boto3_builder.parsers.resource_loader.ResourceLoader.load_paginators(service_name:ServiceName) -> PaginatorsShape | None

Load paginators shape.

method

mypy_boto3_builder.parsers.resource_loader.ResourceLoader.load_resources(service_name:ServiceName) -> ResourcesShape | None

Load resources shape.

methodmypy_boto3_builder.parsers.resource_loader.ResourceLoader.load_waiters(service_name:ServiceName) -> WaitersShape | None

Load waiters shape.

classmypy_boto3_builder.parsers.shape_parser.ShapeParser

Parser for botocore shape files.

methodmypy_boto3_builder.parsers.shape_parser.ShapeParser.fix_typed_dict_names() -> None

Fix typed dict names to avoid duplicates.

methodmypy_boto3_builder.parsers.shape_parser.ShapeParser.get_client_method_map() -> dict[str, Method]

Get client methods from shape.

methodmypy_boto3_builder.parsers.shape_parser.ShapeParser.get_identifier_attributes(resource_name:str) -> list[Attribute]

Get attributes for Resource identifiers.

methodmypy_boto3_builder.parsers.shape_parser.ShapeParser.get_paginate_method(paginator_name:str) -> Method

Get Paginator `paginate` method.

methodmypy_boto3_builder.parsers.shape_parser.ShapeParser.get_paginator_names() -> list[str]

Get available paginator names.

methodmypy_boto3_builder.parsers.shape_parser.ShapeParser.get_paginator_subscript(paginator_name:str) -> FakeAnnotation

Get Paginator return class.

methodmypy_boto3_builder.parsers.shape_parser.ShapeParser.get_resource_load_method(method_name:str='load') -> Method

Get Resource `load` or `reload` method.

methodmypy_boto3_builder.parsers.shape_parser.ShapeParser.get_resource_method_map(resource_name:str) -> dict[str, Method]

Get methods for Resource.

methodmypy_boto3_builder.parsers.shape_parser.ShapeParser.get_resource_model(resource_name:str) -> ResourceModel

Get service resource model.

methodmypy_boto3_builder.parsers.shape_parser.ShapeParser.get_service_resource_method_map() -> dict[str, Method]

Get methods for ServiceResource.

methodmypy_boto3_builder.parsers.shape_parser.ShapeParser.get_service_resource_model() -> ResourceModel

Get service resource model.

methodmypy_boto3_builder.parsers.shape_parser.ShapeParser.get_subresource_names() -> list[str]

Get available subresource names.

methodmypy_boto3_builder.parsers.shape_parser.ShapeParser.get_wait_method(waiter_name:str) -> Method

Get Waiter `wait` method.

methodmypy_boto3_builder.parsers.shape_parser.ShapeParser.get_waiter_names() -> list[str]

Get Waiter class names.

methodmypy_boto3_builder.parsers.shape_parser.ShapeParser.has_service_resource() -> bool

Check if service has ServiceResource.

methodmypy_boto3_builder.parsers.shape_parser.ShapeParser.resource_name() -> str

Parsed resource name.

classmypy_boto3_builder.parsers.shape_parser_types.ActionShape

Action shape.

classmypy_boto3_builder.parsers.shape_parser_types.HasShape

Has shape.

classmypy_boto3_builder.parsers.shape_parser_types.IdentifierShape

Identifier shape.

classmypy_boto3_builder.parsers.shape_parser_types.PaginatorShape

Paginator shape.

classmypy_boto3_builder.parsers.shape_parser_types.PaginatorsShape

Paginators shape.

classmypy_boto3_builder.parsers.shape_parser_types.ParamShape

Param shape.

classmypy_boto3_builder.parsers.shape_parser_types.RequestShape

Request shape.

classmypy_boto3_builder.parsers.shape_parser_types.ResourceShape

Resource shape.

classmypy_boto3_builder.parsers.shape_parser_types.ResourcesShape

Resources shape.

classmypy_boto3_builder.parsers.shape_parser_types.SubResourceShape

SubResource shape.

classmypy_boto3_builder.parsers.shape_parser_types.WaiterShape

Waiter shape.

classmypy_boto3_builder.parsers.shape_parser_types.WaitersShape

Waiters shape.

classmypy_boto3_builder.parsers.typed_dict_map.TypedDictMap

Wrapper for TypedDict maps.

methodmypy_boto3_builder.parsers.typed_dict_map.TypedDictMap.add(item:TypeTypedDict) -> None

Add new item.

methodmypy_boto3_builder.parsers.typed_dict_map.TypedDictMap.iterate_by_name(name:str) -> Generator[TypeTypedDict]

Iterate over items matched by real dict name.

methodmypy_boto3_builder.parsers.typed_dict_map.TypedDictMap.rename(item:TypeTypedDict, new_name:str) -> None

Rename item and change mapping.

classmypy_boto3_builder.postprocessors.aioboto3.AioBoto3Postprocessor

Postprocessor for aioboto3 classes and methods.

methodmypy_boto3_builder.postprocessors.aiobotocore.AioBotocorePostprocessor.process_package() -> None

Convert all methods to asynchronous.

classmypy_boto3_builder.postprocessors.base.BasePostprocessor

Base postprocessor for classes and methods.

methodmypy_boto3_builder.postprocessors.base.BasePostprocessor.extend_literals() -> None

Add extra literals.

methodmypy_boto3_builder.postprocessors.base.BasePostprocessor.generate_docstrings() -> None

Generate all docstrings.

methodmypy_boto3_builder.postprocessors.base.BasePostprocessor.process_package() -> None

Postprocess built package.

classmypy_boto3_builder.postprocessors.botocore.BotocorePostprocessor

Postprocessor for botocore classes and methods.

methodmypy_boto3_builder.postprocessors.botocore.BotocorePostprocessor.process_package() -> None

Leave package as it is.

classmypy_boto3_builder.service_name.ServiceName

Description for boto3 service.

methodmypy_boto3_builder.service_name.ServiceName.boto3_doc_link() -> str

Link to boto3 docs.

methodmypy_boto3_builder.service_name.ServiceName.boto3_doc_link_parent() -> str

Link to boto3 docs parent directory.

methodmypy_boto3_builder.service_name.ServiceName.boto3_name() -> str

Boto3 package name.

methodmypy_boto3_builder.service_name.ServiceName.extras_name() -> str

Extras name for subpackage installation.

methodmypy_boto3_builder.service_name.ServiceName.get_client_name() -> str

Get Client name.

methodmypy_boto3_builder.service_name.ServiceName.get_service_resource_name() -> str

Get ServiceResource name.

methodmypy_boto3_builder.service_name.ServiceName.import_name() -> str

Safe mudule import name.

methodmypy_boto3_builder.service_name.ServiceName.underscore_name() -> str

Python-friendly service name.

classmypy_boto3_builder.service_name.ServiceNameCatalog

Finder for botocore services by name.

methodmypy_boto3_builder.service_name.ServiceNameCatalog.add(name:str, class_name:str) -> ServiceName

Add new ServiceName to catalog or modify existing one.

methodmypy_boto3_builder.service_name.ServiceNameCatalog.to_str(service_name:ServiceName) -> str

Represent ServiceName as string for lookups.

classmypy_boto3_builder.structures.argument.Argument

Method or function argument.

methodmypy_boto3_builder.structures.argument.Argument.copy() -> Self

Deep copy argument.

methodmypy_boto3_builder.structures.argument.Argument.is_kwflag() -> bool

Whether argument is a `*` keywords separator.

methodmypy_boto3_builder.structures.argument.Argument.iterate_types() -> Generator[FakeAnnotation]

Extract required type annotations.

methodmypy_boto3_builder.structures.argument.Argument.kwflag() -> Self

Create `*` keywords separator.

methodmypy_boto3_builder.structures.argument.Argument.render() -> str

Render argument to a string.

methodmypy_boto3_builder.structures.argument.Argument.self() -> Self

Create `self` argument.

classmypy_boto3_builder.structures.attribute.Attribute

Class or module attribute.

methodmypy_boto3_builder.structures.attribute.Attribute.copy() -> Self

Deep copy attribute.

methodmypy_boto3_builder.structures.attribute.Attribute.iterate_types() -> Generator[FakeAnnotation]

Iterate over all type annotations used.

methodmypy_boto3_builder.structures.attribute.Attribute.render() -> str

Render to a string.

classmypy_boto3_builder.structures.base_class.BaseClass

Base class for ClassRecord.

methodmypy_boto3_builder.structures.base_class.BaseClass.render() -> str

Render for usage as class base.

classmypy_boto3_builder.structures.client.Client

Service Client.

methodmypy_boto3_builder.structures.client.Client.alias_name() -> str

Class alias name for safe import.

methodmypy_boto3_builder.structures.client.Client.boto3_doc_link() -> str

List to boto3 docs page.

methodmypy_boto3_builder.structures.client.Client.get_all_names() -> list[str]

Get a list of names for `__all__` statement.

methodmypy_boto3_builder.structures.client.Client.get_exceptions_property() -> Method

Generate Client exceptions property.

methodmypy_boto3_builder.structures.client.Client.own_methods() -> Iterator[Method]

Get a list of auto-generated methods.

classmypy_boto3_builder.structures.collection.Collection

Boto3 ServiceResource or Resource collection.

methodmypy_boto3_builder.structures.collection.Collection.boto3_doc_link() -> str

Link to boto3 docs.

methodmypy_boto3_builder.structures.collection.Collection.boto3_doc_link_parent() -> str

Link to boto3 docs parent directory.

methodmypy_boto3_builder.structures.collection.Collection.iterate_types() -> Generator[FakeAnnotation]

Iterate over all type annotations.

classmypy_boto3_builder.structures.function.Function

Module-level function.

methodmypy_boto3_builder.structures.function.Function.body() -> str

Function body as a string.

methodmypy_boto3_builder.structures.function.Function.boto3_doc_link() -> str

Link to boto3 docs.

methodmypy_boto3_builder.structures.function.Function.copy() -> Self

Deep copy function.

methodmypy_boto3_builder.structures.function.Function.get_required_import_records() -> set[ImportRecord]

Extract required import records.

methodmypy_boto3_builder.structures.function.Function.has_arguments() -> bool

Whether function has arguments.

methodmypy_boto3_builder.structures.function.Function.has_boto3_doc_link() -> bool

Whether boto3_doc_link is set.

methodmypy_boto3_builder.structures.function.Function.has_request_type_annotation() -> bool

Whether request_type_annotation is set.

methodmypy_boto3_builder.structures.function.Function.iterate_types() -> Iterator[FakeAnnotation]

Iterate over required type annotations.

methodmypy_boto3_builder.structures.function.Function.remove_argument(*names:str) -> Self

Remove argument by name or names.

methodmypy_boto3_builder.structures.function.Function.returns_none() -> bool

Whether return type is None.

methodmypy_boto3_builder.structures.function.Function.set_boto3_doc_link(link:str) -> None

Set link to boto3 docs.

methodmypy_boto3_builder.structures.function.Function.short_docstring() -> str

Docstring without documentation links.

classmypy_boto3_builder.structures.method.Method

Class method.

methodmypy_boto3_builder.structures.method.Method.get_self_argument() -> Argument | None

Get `self` or `cls` argument.

methodmypy_boto3_builder.structures.method.Method.has_arguments() -> bool

Whether method has arguments.

classmypy_boto3_builder.structures.package.Package

Parent class for all package structures.

methodmypy_boto3_builder.structures.package.Package.botocore_version() -> str

Botocore version.

methodmypy_boto3_builder.structures.package.Package.directory_name() -> str

Directory name to store generated package.

methodmypy_boto3_builder.structures.package.Package.essential_service_names() -> list[ServiceName]

List of services maked as essential.

methodmypy_boto3_builder.structures.package.Package.get_classifiers() -> list[str]

Get classifiers for package.

methodmypy_boto3_builder.structures.package.Package.get_local_doc_link() -> str

Get link to local docs.

methodmypy_boto3_builder.structures.package.Package.get_module_name(service_name:ServiceName) -> str

Get service module name.

methodmypy_boto3_builder.structures.package.Package.get_service_local_doc_link(service_name:ServiceName) -> str

Get link to service local docs.

methodmypy_boto3_builder.structures.package.Package.get_service_pypi_name(service_name:ServiceName) -> str

Get PyPI package name for a service package.

methodmypy_boto3_builder.structures.package.Package.has_main_package() -> bool

Check if package has main package.

methodmypy_boto3_builder.structures.package.Package.library_chat_choice() -> str

Package library chat choice.

methodmypy_boto3_builder.structures.package.Package.library_name() -> str

PyPI library package name.

methodmypy_boto3_builder.structures.package.Package.library_version() -> str

Library version.

methodmypy_boto3_builder.structures.package.Package.max_library_version() -> str

Minimum required library version.

methodmypy_boto3_builder.structures.package.Package.min_library_version() -> str

Minimum required library version.

methodmypy_boto3_builder.structures.package.Package.min_python_version() -> str

Minimum required python version.

methodmypy_boto3_builder.structures.package.Package.name() -> str

Package name.

methodmypy_boto3_builder.structures.package.Package.pypi_name() -> str

PyPI package name.

methodmypy_boto3_builder.structures.package.Package.service_name() -> ServiceName

Service name for the package.

methodmypy_boto3_builder.structures.package.Package.version() -> str

Package version.

classmypy_boto3_builder.structures.package_extra.PackageExtra

Package extra entry.

classmypy_boto3_builder.structures.package_url.PackageURL

Package links structure.

methodmypy_boto3_builder.structures.package_url.PackageURL.docs() -> str

Documentation link.

methodmypy_boto3_builder.structures.package_url.PackageURL.library_pypi() -> str

Get link to PyPI underlying library.

methodmypy_boto3_builder.structures.package_url.PackageURL.montly_downloads_badge() -> str

PyPi monthly downloads badge.

methodmypy_boto3_builder.structures.package_url.PackageURL.pepy() -> str

PePy project link.

methodmypy_boto3_builder.structures.package_url.PackageURL.pepy_badge() -> str

PePy total downloads badge.

methodmypy_boto3_builder.structures.package_url.PackageURL.pypi() -> str

Get link to PyPI.

methodmypy_boto3_builder.structures.package_url.PackageURL.pypi_badge() -> str

Package name badge from shields.io.

methodmypy_boto3_builder.structures.package_url.PackageURL.pypistats() -> str

PePy project link.

methodmypy_boto3_builder.structures.package_url.PackageURL.rtd_badge() -> str

ReadTheDocs badge from shields.io.

methodmypy_boto3_builder.structures.package_url.PackageURL.stubs_full_pypi() -> str

Get link to PyPI full version of stubs.

methodmypy_boto3_builder.structures.package_url.PackageURL.stubs_lite_pypi() -> str

Get link to PyPI lite version of stubs.

methodmypy_boto3_builder.structures.package_url.PackageURL.stubs_pypi() -> str

Get link to PyPI lite version of stubs.

classmypy_boto3_builder.structures.packages.boto34_package.Boto34Package

Structure for boto34 package.

methodmypy_boto3_builder.structures.packages.boto34_package.Boto34Package.get_property_name(service_name:ServiceName) -> str

Get property name for service.

methodmypy_boto3_builder.structures.packages.boto34_package.Boto34Package.name() -> str

Package name.

methodmypy_boto3_builder.structures.packages.boto34_package.Boto34Package.pypi_name() -> str

PyPI package name.

classmypy_boto3_builder.structures.packages.mypy_boto3_package.MypyBoto3Package

Structure for mypy-boto3 package.

classmypy_boto3_builder.structures.packages.service_package.ServicePackage

Parsed Service package.

methodmypy_boto3_builder.structures.packages.service_package.ServicePackage.client() -> Client

Service Client.

methodmypy_boto3_builder.structures.packages.service_package.ServicePackage.extract_literals() -> list[TypeLiteral]

Extract literals from children.

methodmypy_boto3_builder.structures.packages.service_package.ServicePackage.get_local_doc_link() -> str

Get link to local docs.

method

mypy_boto3_builder.structures.packages.service_package.ServicePackage.iterate_named_unions(limit:int | None=None) -> Iterator[TypeUnion]

Iterate over all unions.

method

mypy_boto3_builder.structures.packages.service_package.ServicePackage.iterate_typed_dicts(limit:int | None=None) -> Iterator[TypeTypedDict]

Iterate over all typed dicts.

methodmypy_boto3_builder.structures.packages.service_package.ServicePackage.name() -> str

Package name.

methodmypy_boto3_builder.structures.packages.service_package.ServicePackage.validate() -> None

Validate parsed module.

classmypy_boto3_builder.structures.packages.types_aioboto3_package.TypesAioBoto3Package

Structure for types-aioboto3 module.

classmypy_boto3_builder.structures.packages.types_boto3_package.TypesBoto3Package

Structure for types-boto3 module.

methodmypy_boto3_builder.structures.packages.types_boto3_package.TypesBoto3Package.get_all_names() -> list[str]

Get names for `__all__` directive.

classmypy_boto3_builder.structures.packages.wrapper_package.WrapperPackage

Main package module data.

methodmypy_boto3_builder.structures.packages.wrapper_package.WrapperPackage.description() -> str

Package description.

methodmypy_boto3_builder.structures.packages.wrapper_package.WrapperPackage.get_all_names() -> list[str]

Get names for `__all__` directive.

method

mypy_boto3_builder.structures.packages.wrapper_package.WrapperPackage.get_short_description(prefix:str='Type annotations') -> str

Get short description for the package.

methodmypy_boto3_builder.structures.packages.wrapper_package.WrapperPackage.set_description(value:str) -> None

Set package description.

classmypy_boto3_builder.structures.paginator.Paginator

Boto3 client Paginator.

methodmypy_boto3_builder.structures.paginator.Paginator.boto3_doc_link() -> str

Link to boto3 docs.

methodmypy_boto3_builder.structures.paginator.Paginator.get_client_method() -> Method

Get `get_paginator` method for `Client`.

methodmypy_boto3_builder.structures.paginator.Paginator.get_sort_key() -> str

Sort paginators by name.

この情報について

掲載しているシグネチャは youtype/mypy_boto3_builder の公開ソースコードを Python の ast モジュールで静的解析し、引数名・デフォルト値・型注釈・戻り値型をそのまま抽出したものです。実装コードは保存していません。詳しくは仕組みの解説をご覧ください。

収録ライブラリ一覧（全 805 件）へ戻る