diff options
| author | CoprDistGit <infra@openeuler.org> | 2023-04-11 08:29:57 +0000 |
|---|---|---|
| committer | CoprDistGit <infra@openeuler.org> | 2023-04-11 08:29:57 +0000 |
| commit | 542b8ec8286ce8f0e44d57e672fd078089d860e9 (patch) | |
| tree | bf33bad6906d71fce708a2e6616430f28b178490 /python-mypy-boto3-codecommit.spec | |
| parent | f62f460751221ac6332d6fc13225a79ffbd20346 (diff) | |
automatic import of python-mypy-boto3-codecommit
Diffstat (limited to 'python-mypy-boto3-codecommit.spec')
| -rw-r--r-- | python-mypy-boto3-codecommit.spec | 1972 |
1 files changed, 1972 insertions, 0 deletions
diff --git a/python-mypy-boto3-codecommit.spec b/python-mypy-boto3-codecommit.spec new file mode 100644 index 0000000..f51fd1b --- /dev/null +++ b/python-mypy-boto3-codecommit.spec @@ -0,0 +1,1972 @@ +%global _empty_manifest_terminate_build 0 +Name: python-mypy-boto3-codecommit +Version: 1.26.0.post1 +Release: 1 +Summary: Type annotations for boto3.CodeCommit 1.26.0 service generated with mypy-boto3-builder 7.11.10 +License: MIT License +URL: https://github.com/youtype/mypy_boto3_builder +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/54/c1/45bf7d4903ca142ba8913053ebff0d907049a2b10c0cc8088e9e166390e8/mypy-boto3-codecommit-1.26.0.post1.tar.gz +BuildArch: noarch + +Requires: python3-typing-extensions + +%description +<a id="mypy-boto3-codecommit"></a> + +# mypy-boto3-codecommit + +[](https://pypi.org/project/mypy-boto3-codecommit) +[](https://pypi.org/project/mypy-boto3-codecommit) +[](https://mypy-boto3-builder.readthedocs.io/) +[](https://pypistats.org/packages/mypy-boto3-codecommit) + + + +Type annotations for +[boto3.CodeCommit 1.26.0](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/codecommit.html#CodeCommit) +service compatible with [VSCode](https://code.visualstudio.com/), +[PyCharm](https://www.jetbrains.com/pycharm/), +[Emacs](https://www.gnu.org/software/emacs/), +[Sublime Text](https://www.sublimetext.com/), +[mypy](https://github.com/python/mypy), +[pyright](https://github.com/microsoft/pyright) and other tools. + +Generated by +[mypy-boto3-builder 7.11.10](https://github.com/youtype/mypy_boto3_builder). + +More information can be found on +[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in +[mypy-boto3-codecommit docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_codecommit/). + +See how it helps to find and fix potential bugs: + + + +- [mypy-boto3-codecommit](#mypy-boto3-codecommit) + - [How to install](#how-to-install) + - [VSCode extension](#vscode-extension) + - [From PyPI with pip](#from-pypi-with-pip) + - [How to uninstall](#how-to-uninstall) + - [Usage](#usage) + - [VSCode](#vscode) + - [PyCharm](#pycharm) + - [Emacs](#emacs) + - [Sublime Text](#sublime-text) + - [Other IDEs](#other-ides) + - [mypy](#mypy) + - [pyright](#pyright) + - [Explicit type annotations](#explicit-type-annotations) + - [Client annotations](#client-annotations) + - [Paginators annotations](#paginators-annotations) + - [Literals](#literals) + - [Typed dictionaries](#typed-dictionaries) + - [How it works](#how-it-works) + - [What's new](#what's-new) + - [Implemented features](#implemented-features) + - [Latest changes](#latest-changes) + - [Versioning](#versioning) + - [Thank you](#thank-you) + - [Documentation](#documentation) + - [Support and contributing](#support-and-contributing) + +<a id="how-to-install"></a> + +## How to install + +<a id="vscode-extension"></a> + +### VSCode extension + +Add +[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide) +extension to your VSCode and run `AWS boto3: Quick Start` command. + +Click `Modify` and select `boto3 common` and `CodeCommit`. + +<a id="from-pypi-with-pip"></a> + +### From PyPI with pip + +Install `boto3-stubs` for `CodeCommit` service. + +```bash +# install with boto3 type annotations +python -m pip install 'boto3-stubs[codecommit]' + + +# 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[codecommit]' + + +# standalone installation +python -m pip install mypy-boto3-codecommit +``` + +<a id="how-to-uninstall"></a> + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-codecommit +``` + +<a id="usage"></a> + +## Usage + +<a id="vscode"></a> + +### VSCode + +- Install + [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) +- Install + [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) +- Set `Pylance` as your Python Language Server +- Install `boto3-stubs[codecommit]` in your environment: + +```bash +python -m pip install 'boto3-stubs[codecommit]' +``` + +Both type checking and code completion should now work. No explicit type +annotations required, write your `boto3` code as usual. + +<a id="pycharm"></a> + +### PyCharm + +Install `boto3-stubs-lite[codecommit]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[codecommit]'` +``` + +Both type checking and code completion should now work. Explicit type +annotations **are required**. + +Use `boto3-stubs` package instead for implicit type discovery. + +<a id="emacs"></a> + +### Emacs + +- Install `boto3-stubs` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[codecommit]' +``` + +- Install [use-package](https://github.com/jwiegley/use-package), + [lsp](https://github.com/emacs-lsp/lsp-mode/), + [company](https://github.com/company-mode/company-mode) and + [flycheck](https://github.com/flycheck/flycheck) packages +- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package + +```elisp +(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. + +<a id="sublime-text"></a> + +### Sublime Text + +- Install `boto3-stubs[codecommit]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[codecommit]' +``` + +- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="other-ides"></a> + +### Other IDEs + +Not tested, but as long as your IDE supports `mypy` or `pyright`, everything +should work. + +<a id="mypy"></a> + +### mypy + +- Install `mypy`: `python -m pip install mypy` +- Install `boto3-stubs[codecommit]` in your environment: + +```bash +python -m pip install 'boto3-stubs[codecommit]'` +``` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="pyright"></a> + +### pyright + +- Install `pyright`: `npm i -g pyright` +- Install `boto3-stubs[codecommit]` in your environment: + +```bash +python -m pip install 'boto3-stubs[codecommit]' +``` + +Optionally, you can install `boto3-stubs` to `typings` folder. + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="explicit-type-annotations"></a> + +## Explicit type annotations + +<a id="client-annotations"></a> + +### Client annotations + +`CodeCommitClient` provides annotations for `boto3.client("codecommit")`. + +```python +from boto3.session import Session + +from mypy_boto3_codecommit import CodeCommitClient + +client: CodeCommitClient = Session().client("codecommit") + +# now client usage is checked by mypy and IDE should provide code completion +``` + +<a id="paginators-annotations"></a> + +### Paginators annotations + +`mypy_boto3_codecommit.paginator` module contains type annotations for all +paginators. + +```python +from boto3.session import Session + +from mypy_boto3_codecommit import CodeCommitClient +from mypy_boto3_codecommit.paginator import ( + DescribePullRequestEventsPaginator, + GetCommentsForComparedCommitPaginator, + GetCommentsForPullRequestPaginator, + GetDifferencesPaginator, + ListBranchesPaginator, + ListPullRequestsPaginator, + ListRepositoriesPaginator, +) + +client: CodeCommitClient = Session().client("codecommit") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +describe_pull_request_events_paginator: DescribePullRequestEventsPaginator = client.get_paginator( + "describe_pull_request_events" +) +get_comments_for_compared_commit_paginator: GetCommentsForComparedCommitPaginator = ( + client.get_paginator("get_comments_for_compared_commit") +) +get_comments_for_pull_request_paginator: GetCommentsForPullRequestPaginator = client.get_paginator( + "get_comments_for_pull_request" +) +get_differences_paginator: GetDifferencesPaginator = client.get_paginator("get_differences") +list_branches_paginator: ListBranchesPaginator = client.get_paginator("list_branches") +list_pull_requests_paginator: ListPullRequestsPaginator = client.get_paginator("list_pull_requests") +list_repositories_paginator: ListRepositoriesPaginator = client.get_paginator("list_repositories") +``` + +<a id="literals"></a> + +### Literals + +`mypy_boto3_codecommit.literals` module contains literals extracted from shapes +that can be used in user code for type checking. + +```python +from mypy_boto3_codecommit.literals import ( + ApprovalStateType, + ChangeTypeEnumType, + ConflictDetailLevelTypeEnumType, + ConflictResolutionStrategyTypeEnumType, + DescribePullRequestEventsPaginatorName, + FileModeTypeEnumType, + GetCommentsForComparedCommitPaginatorName, + GetCommentsForPullRequestPaginatorName, + GetDifferencesPaginatorName, + ListBranchesPaginatorName, + ListPullRequestsPaginatorName, + ListRepositoriesPaginatorName, + MergeOptionTypeEnumType, + ObjectTypeEnumType, + OrderEnumType, + OverrideStatusType, + PullRequestEventTypeType, + PullRequestStatusEnumType, + RelativeFileVersionEnumType, + ReplacementTypeEnumType, + RepositoryTriggerEventEnumType, + SortByEnumType, + CodeCommitServiceName, + ServiceName, + ResourceServiceName, + PaginatorName, + RegionName, +) + + +def check_value(value: ApprovalStateType) -> bool: + ... +``` + +<a id="typed-dictionaries"></a> + +### Typed dictionaries + +`mypy_boto3_codecommit.type_defs` module contains structures and shapes +assembled to typed dictionaries for additional type checking. + +```python +from mypy_boto3_codecommit.type_defs import ( + ApprovalRuleEventMetadataTypeDef, + ApprovalRuleOverriddenEventMetadataTypeDef, + ApprovalRuleTemplateTypeDef, + OriginApprovalRuleTemplateTypeDef, + ApprovalStateChangedEventMetadataTypeDef, + ApprovalTypeDef, + AssociateApprovalRuleTemplateWithRepositoryInputRequestTypeDef, + BatchAssociateApprovalRuleTemplateWithRepositoriesErrorTypeDef, + BatchAssociateApprovalRuleTemplateWithRepositoriesInputRequestTypeDef, + ResponseMetadataTypeDef, + BatchDescribeMergeConflictsErrorTypeDef, + BatchDescribeMergeConflictsInputRequestTypeDef, + BatchDisassociateApprovalRuleTemplateFromRepositoriesErrorTypeDef, + BatchDisassociateApprovalRuleTemplateFromRepositoriesInputRequestTypeDef, + BatchGetCommitsErrorTypeDef, + BatchGetCommitsInputRequestTypeDef, + BatchGetRepositoriesInputRequestTypeDef, + RepositoryMetadataTypeDef, + BlobMetadataTypeDef, + BranchInfoTypeDef, + CommentTypeDef, + LocationTypeDef, + UserInfoTypeDef, + FileModesTypeDef, + FileSizesTypeDef, + IsBinaryFileTypeDef, + MergeOperationsTypeDef, + ObjectTypesTypeDef, + DeleteFileEntryTypeDef, + ReplaceContentEntryTypeDef, + SetFileModeEntryTypeDef, + CreateApprovalRuleTemplateInputRequestTypeDef, + CreateBranchInputRequestTypeDef, + FileMetadataTypeDef, + CreatePullRequestApprovalRuleInputRequestTypeDef, + TargetTypeDef, + CreateRepositoryInputRequestTypeDef, + DeleteApprovalRuleTemplateInputRequestTypeDef, + DeleteBranchInputRequestTypeDef, + DeleteCommentContentInputRequestTypeDef, + DeleteFileInputRequestTypeDef, + DeletePullRequestApprovalRuleInputRequestTypeDef, + DeleteRepositoryInputRequestTypeDef, + DescribeMergeConflictsInputRequestTypeDef, + PaginatorConfigTypeDef, + DescribePullRequestEventsInputRequestTypeDef, + DisassociateApprovalRuleTemplateFromRepositoryInputRequestTypeDef, + EvaluatePullRequestApprovalRulesInputRequestTypeDef, + EvaluationTypeDef, + FileTypeDef, + FolderTypeDef, + GetApprovalRuleTemplateInputRequestTypeDef, + GetBlobInputRequestTypeDef, + GetBranchInputRequestTypeDef, + GetCommentInputRequestTypeDef, + GetCommentReactionsInputRequestTypeDef, + GetCommentsForComparedCommitInputRequestTypeDef, + GetCommentsForPullRequestInputRequestTypeDef, + GetCommitInputRequestTypeDef, + GetDifferencesInputRequestTypeDef, + GetFileInputRequestTypeDef, + GetFolderInputRequestTypeDef, + SubModuleTypeDef, + SymbolicLinkTypeDef, + GetMergeCommitInputRequestTypeDef, + GetMergeConflictsInputRequestTypeDef, + GetMergeOptionsInputRequestTypeDef, + GetPullRequestApprovalStatesInputRequestTypeDef, + GetPullRequestInputRequestTypeDef, + GetPullRequestOverrideStateInputRequestTypeDef, + GetRepositoryInputRequestTypeDef, + GetRepositoryTriggersInputRequestTypeDef, + RepositoryTriggerTypeDef, + ListApprovalRuleTemplatesInputRequestTypeDef, + ListAssociatedApprovalRuleTemplatesForRepositoryInputRequestTypeDef, + ListBranchesInputRequestTypeDef, + ListPullRequestsInputRequestTypeDef, + ListRepositoriesForApprovalRuleTemplateInputRequestTypeDef, + ListRepositoriesInputRequestTypeDef, + RepositoryNameIdPairTypeDef, + ListTagsForResourceInputRequestTypeDef, + MergeBranchesByFastForwardInputRequestTypeDef, + MergeHunkDetailTypeDef, + MergeMetadataTypeDef, + MergePullRequestByFastForwardInputRequestTypeDef, + OverridePullRequestApprovalRulesInputRequestTypeDef, + PostCommentReplyInputRequestTypeDef, + PullRequestCreatedEventMetadataTypeDef, + PullRequestSourceReferenceUpdatedEventMetadataTypeDef, + PullRequestStatusChangedEventMetadataTypeDef, + PutCommentReactionInputRequestTypeDef, + SourceFileSpecifierTypeDef, + PutFileInputRequestTypeDef, + ReactionValueFormatsTypeDef, + RepositoryTriggerExecutionFailureTypeDef, + TagResourceInputRequestTypeDef, + UntagResourceInputRequestTypeDef, + UpdateApprovalRuleTemplateContentInputRequestTypeDef, + UpdateApprovalRuleTemplateDescriptionInputRequestTypeDef, + UpdateApprovalRuleTemplateNameInputRequestTypeDef, + UpdateCommentInputRequestTypeDef, + UpdateDefaultBranchInputRequestTypeDef, + UpdatePullRequestApprovalRuleContentInputRequestTypeDef, + UpdatePullRequestApprovalStateInputRequestTypeDef, + UpdatePullRequestDescriptionInputRequestTypeDef, + UpdatePullRequestStatusInputRequestTypeDef, + UpdatePullRequestTitleInputRequestTypeDef, + UpdateRepositoryDescriptionInputRequestTypeDef, + UpdateRepositoryNameInputRequestTypeDef, + ApprovalRuleTypeDef, + BatchAssociateApprovalRuleTemplateWithRepositoriesOutputTypeDef, + CreateApprovalRuleTemplateOutputTypeDef, + CreateUnreferencedMergeCommitOutputTypeDef, + DeleteApprovalRuleTemplateOutputTypeDef, + DeleteFileOutputTypeDef, + DeletePullRequestApprovalRuleOutputTypeDef, + DeleteRepositoryOutputTypeDef, + EmptyResponseMetadataTypeDef, + GetApprovalRuleTemplateOutputTypeDef, + GetBlobOutputTypeDef, + GetFileOutputTypeDef, + GetMergeCommitOutputTypeDef, + GetMergeOptionsOutputTypeDef, + GetPullRequestApprovalStatesOutputTypeDef, + GetPullRequestOverrideStateOutputTypeDef, + ListApprovalRuleTemplatesOutputTypeDef, + ListAssociatedApprovalRuleTemplatesForRepositoryOutputTypeDef, + ListBranchesOutputTypeDef, + ListPullRequestsOutputTypeDef, + ListRepositoriesForApprovalRuleTemplateOutputTypeDef, + ListTagsForResourceOutputTypeDef, + MergeBranchesByFastForwardOutputTypeDef, + MergeBranchesBySquashOutputTypeDef, + MergeBranchesByThreeWayOutputTypeDef, + PutFileOutputTypeDef, + PutRepositoryTriggersOutputTypeDef, + UpdateApprovalRuleTemplateContentOutputTypeDef, + UpdateApprovalRuleTemplateDescriptionOutputTypeDef, + UpdateApprovalRuleTemplateNameOutputTypeDef, + BatchDisassociateApprovalRuleTemplateFromRepositoriesOutputTypeDef, + BatchGetRepositoriesOutputTypeDef, + CreateRepositoryOutputTypeDef, + GetRepositoryOutputTypeDef, + DifferenceTypeDef, + DeleteBranchOutputTypeDef, + GetBranchOutputTypeDef, + DeleteCommentContentOutputTypeDef, + GetCommentOutputTypeDef, + PostCommentReplyOutputTypeDef, + UpdateCommentOutputTypeDef, + CommentsForComparedCommitTypeDef, + CommentsForPullRequestTypeDef, + PostCommentForComparedCommitInputRequestTypeDef, + PostCommentForComparedCommitOutputTypeDef, + PostCommentForPullRequestInputRequestTypeDef, + PostCommentForPullRequestOutputTypeDef, + CommitTypeDef, + ConflictMetadataTypeDef, + ConflictResolutionTypeDef, + CreateCommitOutputTypeDef, + CreatePullRequestInputRequestTypeDef, + DescribePullRequestEventsInputDescribePullRequestEventsPaginateTypeDef, + GetCommentsForComparedCommitInputGetCommentsForComparedCommitPaginateTypeDef, + GetCommentsForPullRequestInputGetCommentsForPullRequestPaginateTypeDef, + GetDifferencesInputGetDifferencesPaginateTypeDef, + ListBranchesInputListBranchesPaginateTypeDef, + ListPullRequestsInputListPullRequestsPaginateTypeDef, + ListRepositoriesInputListRepositoriesPaginateTypeDef, + EvaluatePullRequestApprovalRulesOutputTypeDef, + GetFolderOutputTypeDef, + GetRepositoryTriggersOutputTypeDef, + PutRepositoryTriggersInputRequestTypeDef, + TestRepositoryTriggersInputRequestTypeDef, + ListRepositoriesOutputTypeDef, + MergeHunkTypeDef, + PullRequestMergedStateChangedEventMetadataTypeDef, + PullRequestTargetTypeDef, + PutFileEntryTypeDef, + ReactionForCommentTypeDef, + TestRepositoryTriggersOutputTypeDef, + CreatePullRequestApprovalRuleOutputTypeDef, + UpdatePullRequestApprovalRuleContentOutputTypeDef, + GetDifferencesOutputTypeDef, + GetCommentsForComparedCommitOutputTypeDef, + GetCommentsForPullRequestOutputTypeDef, + BatchGetCommitsOutputTypeDef, + GetCommitOutputTypeDef, + GetMergeConflictsOutputTypeDef, + CreateUnreferencedMergeCommitInputRequestTypeDef, + MergeBranchesBySquashInputRequestTypeDef, + MergeBranchesByThreeWayInputRequestTypeDef, + MergePullRequestBySquashInputRequestTypeDef, + MergePullRequestByThreeWayInputRequestTypeDef, + ConflictTypeDef, + DescribeMergeConflictsOutputTypeDef, + PullRequestEventTypeDef, + PullRequestTypeDef, + CreateCommitInputRequestTypeDef, + GetCommentReactionsOutputTypeDef, + BatchDescribeMergeConflictsOutputTypeDef, + DescribePullRequestEventsOutputTypeDef, + CreatePullRequestOutputTypeDef, + GetPullRequestOutputTypeDef, + MergePullRequestByFastForwardOutputTypeDef, + MergePullRequestBySquashOutputTypeDef, + MergePullRequestByThreeWayOutputTypeDef, + UpdatePullRequestDescriptionOutputTypeDef, + UpdatePullRequestStatusOutputTypeDef, + UpdatePullRequestTitleOutputTypeDef, +) + + +def get_structure() -> ApprovalRuleEventMetadataTypeDef: + return {...} +``` + +<a id="how-it-works"></a> + +## How it works + +Fully automated +[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully +generates type annotations for each service, patiently waiting for `boto3` +updates. It delivers a drop-in type annotations for you and makes sure that: + +- All available `boto3` services are covered. +- Each public class and method of every `boto3` service gets valid type + annotations extracted from the documentation (blame `botocore` 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](https://github.com/psf/black) and + [isort](https://github.com/PyCQA/isort) for readability. + +<a id="what's-new"></a> + +## What's new + +<a id="implemented-features"></a> + +### Implemented features + +- Fully type annotated `boto3`, `botocore` and `aiobotocore` libraries +- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs` + compatibility +- `Client`, `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` and `boto3.session` calls +- Auto discovery of types for `session.client` and `session.session` calls +- Auto discovery of types for `client.get_waiter` and `client.get_paginator` + calls +- Auto discovery of types for `ServiceResource` and `Resource` collections +- Auto discovery of types for `aiobotocore.Session.create_client` calls + +<a id="latest-changes"></a> + +### Latest changes + +Builder changelog can be found in +[Releases](https://github.com/youtype/mypy_boto3_builder/releases). + +<a id="versioning"></a> + +## Versioning + +`mypy-boto3-codecommit` version is the same as related `boto3` version and +follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format. + +<a id="thank-you"></a> + +## Thank you + +- [Allie Fitter](https://github.com/alliefitter) for + [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/), + this package is based on top of his work +- [black](https://github.com/psf/black) developers for an awesome formatting + tool +- [Timothy Edmund Crosley](https://github.com/timothycrosley) for + [isort](https://github.com/PyCQA/isort) and how flexible it is +- [mypy](https://github.com/python/mypy) developers for doing all dirty work + for us +- [pyright](https://github.com/microsoft/pyright) team for the new era of typed + Python + +<a id="documentation"></a> + +## Documentation + +All services type annotations can be found in +[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_codecommit/) + +<a id="support-and-contributing"></a> + +## Support and contributing + +This package is auto-generated. Please reports any bugs or request new features +in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/) +repository. + + +%package -n python3-mypy-boto3-codecommit +Summary: Type annotations for boto3.CodeCommit 1.26.0 service generated with mypy-boto3-builder 7.11.10 +Provides: python-mypy-boto3-codecommit +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-mypy-boto3-codecommit +<a id="mypy-boto3-codecommit"></a> + +# mypy-boto3-codecommit + +[](https://pypi.org/project/mypy-boto3-codecommit) +[](https://pypi.org/project/mypy-boto3-codecommit) +[](https://mypy-boto3-builder.readthedocs.io/) +[](https://pypistats.org/packages/mypy-boto3-codecommit) + + + +Type annotations for +[boto3.CodeCommit 1.26.0](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/codecommit.html#CodeCommit) +service compatible with [VSCode](https://code.visualstudio.com/), +[PyCharm](https://www.jetbrains.com/pycharm/), +[Emacs](https://www.gnu.org/software/emacs/), +[Sublime Text](https://www.sublimetext.com/), +[mypy](https://github.com/python/mypy), +[pyright](https://github.com/microsoft/pyright) and other tools. + +Generated by +[mypy-boto3-builder 7.11.10](https://github.com/youtype/mypy_boto3_builder). + +More information can be found on +[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in +[mypy-boto3-codecommit docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_codecommit/). + +See how it helps to find and fix potential bugs: + + + +- [mypy-boto3-codecommit](#mypy-boto3-codecommit) + - [How to install](#how-to-install) + - [VSCode extension](#vscode-extension) + - [From PyPI with pip](#from-pypi-with-pip) + - [How to uninstall](#how-to-uninstall) + - [Usage](#usage) + - [VSCode](#vscode) + - [PyCharm](#pycharm) + - [Emacs](#emacs) + - [Sublime Text](#sublime-text) + - [Other IDEs](#other-ides) + - [mypy](#mypy) + - [pyright](#pyright) + - [Explicit type annotations](#explicit-type-annotations) + - [Client annotations](#client-annotations) + - [Paginators annotations](#paginators-annotations) + - [Literals](#literals) + - [Typed dictionaries](#typed-dictionaries) + - [How it works](#how-it-works) + - [What's new](#what's-new) + - [Implemented features](#implemented-features) + - [Latest changes](#latest-changes) + - [Versioning](#versioning) + - [Thank you](#thank-you) + - [Documentation](#documentation) + - [Support and contributing](#support-and-contributing) + +<a id="how-to-install"></a> + +## How to install + +<a id="vscode-extension"></a> + +### VSCode extension + +Add +[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide) +extension to your VSCode and run `AWS boto3: Quick Start` command. + +Click `Modify` and select `boto3 common` and `CodeCommit`. + +<a id="from-pypi-with-pip"></a> + +### From PyPI with pip + +Install `boto3-stubs` for `CodeCommit` service. + +```bash +# install with boto3 type annotations +python -m pip install 'boto3-stubs[codecommit]' + + +# 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[codecommit]' + + +# standalone installation +python -m pip install mypy-boto3-codecommit +``` + +<a id="how-to-uninstall"></a> + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-codecommit +``` + +<a id="usage"></a> + +## Usage + +<a id="vscode"></a> + +### VSCode + +- Install + [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) +- Install + [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) +- Set `Pylance` as your Python Language Server +- Install `boto3-stubs[codecommit]` in your environment: + +```bash +python -m pip install 'boto3-stubs[codecommit]' +``` + +Both type checking and code completion should now work. No explicit type +annotations required, write your `boto3` code as usual. + +<a id="pycharm"></a> + +### PyCharm + +Install `boto3-stubs-lite[codecommit]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[codecommit]'` +``` + +Both type checking and code completion should now work. Explicit type +annotations **are required**. + +Use `boto3-stubs` package instead for implicit type discovery. + +<a id="emacs"></a> + +### Emacs + +- Install `boto3-stubs` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[codecommit]' +``` + +- Install [use-package](https://github.com/jwiegley/use-package), + [lsp](https://github.com/emacs-lsp/lsp-mode/), + [company](https://github.com/company-mode/company-mode) and + [flycheck](https://github.com/flycheck/flycheck) packages +- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package + +```elisp +(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. + +<a id="sublime-text"></a> + +### Sublime Text + +- Install `boto3-stubs[codecommit]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[codecommit]' +``` + +- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="other-ides"></a> + +### Other IDEs + +Not tested, but as long as your IDE supports `mypy` or `pyright`, everything +should work. + +<a id="mypy"></a> + +### mypy + +- Install `mypy`: `python -m pip install mypy` +- Install `boto3-stubs[codecommit]` in your environment: + +```bash +python -m pip install 'boto3-stubs[codecommit]'` +``` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="pyright"></a> + +### pyright + +- Install `pyright`: `npm i -g pyright` +- Install `boto3-stubs[codecommit]` in your environment: + +```bash +python -m pip install 'boto3-stubs[codecommit]' +``` + +Optionally, you can install `boto3-stubs` to `typings` folder. + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="explicit-type-annotations"></a> + +## Explicit type annotations + +<a id="client-annotations"></a> + +### Client annotations + +`CodeCommitClient` provides annotations for `boto3.client("codecommit")`. + +```python +from boto3.session import Session + +from mypy_boto3_codecommit import CodeCommitClient + +client: CodeCommitClient = Session().client("codecommit") + +# now client usage is checked by mypy and IDE should provide code completion +``` + +<a id="paginators-annotations"></a> + +### Paginators annotations + +`mypy_boto3_codecommit.paginator` module contains type annotations for all +paginators. + +```python +from boto3.session import Session + +from mypy_boto3_codecommit import CodeCommitClient +from mypy_boto3_codecommit.paginator import ( + DescribePullRequestEventsPaginator, + GetCommentsForComparedCommitPaginator, + GetCommentsForPullRequestPaginator, + GetDifferencesPaginator, + ListBranchesPaginator, + ListPullRequestsPaginator, + ListRepositoriesPaginator, +) + +client: CodeCommitClient = Session().client("codecommit") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +describe_pull_request_events_paginator: DescribePullRequestEventsPaginator = client.get_paginator( + "describe_pull_request_events" +) +get_comments_for_compared_commit_paginator: GetCommentsForComparedCommitPaginator = ( + client.get_paginator("get_comments_for_compared_commit") +) +get_comments_for_pull_request_paginator: GetCommentsForPullRequestPaginator = client.get_paginator( + "get_comments_for_pull_request" +) +get_differences_paginator: GetDifferencesPaginator = client.get_paginator("get_differences") +list_branches_paginator: ListBranchesPaginator = client.get_paginator("list_branches") +list_pull_requests_paginator: ListPullRequestsPaginator = client.get_paginator("list_pull_requests") +list_repositories_paginator: ListRepositoriesPaginator = client.get_paginator("list_repositories") +``` + +<a id="literals"></a> + +### Literals + +`mypy_boto3_codecommit.literals` module contains literals extracted from shapes +that can be used in user code for type checking. + +```python +from mypy_boto3_codecommit.literals import ( + ApprovalStateType, + ChangeTypeEnumType, + ConflictDetailLevelTypeEnumType, + ConflictResolutionStrategyTypeEnumType, + DescribePullRequestEventsPaginatorName, + FileModeTypeEnumType, + GetCommentsForComparedCommitPaginatorName, + GetCommentsForPullRequestPaginatorName, + GetDifferencesPaginatorName, + ListBranchesPaginatorName, + ListPullRequestsPaginatorName, + ListRepositoriesPaginatorName, + MergeOptionTypeEnumType, + ObjectTypeEnumType, + OrderEnumType, + OverrideStatusType, + PullRequestEventTypeType, + PullRequestStatusEnumType, + RelativeFileVersionEnumType, + ReplacementTypeEnumType, + RepositoryTriggerEventEnumType, + SortByEnumType, + CodeCommitServiceName, + ServiceName, + ResourceServiceName, + PaginatorName, + RegionName, +) + + +def check_value(value: ApprovalStateType) -> bool: + ... +``` + +<a id="typed-dictionaries"></a> + +### Typed dictionaries + +`mypy_boto3_codecommit.type_defs` module contains structures and shapes +assembled to typed dictionaries for additional type checking. + +```python +from mypy_boto3_codecommit.type_defs import ( + ApprovalRuleEventMetadataTypeDef, + ApprovalRuleOverriddenEventMetadataTypeDef, + ApprovalRuleTemplateTypeDef, + OriginApprovalRuleTemplateTypeDef, + ApprovalStateChangedEventMetadataTypeDef, + ApprovalTypeDef, + AssociateApprovalRuleTemplateWithRepositoryInputRequestTypeDef, + BatchAssociateApprovalRuleTemplateWithRepositoriesErrorTypeDef, + BatchAssociateApprovalRuleTemplateWithRepositoriesInputRequestTypeDef, + ResponseMetadataTypeDef, + BatchDescribeMergeConflictsErrorTypeDef, + BatchDescribeMergeConflictsInputRequestTypeDef, + BatchDisassociateApprovalRuleTemplateFromRepositoriesErrorTypeDef, + BatchDisassociateApprovalRuleTemplateFromRepositoriesInputRequestTypeDef, + BatchGetCommitsErrorTypeDef, + BatchGetCommitsInputRequestTypeDef, + BatchGetRepositoriesInputRequestTypeDef, + RepositoryMetadataTypeDef, + BlobMetadataTypeDef, + BranchInfoTypeDef, + CommentTypeDef, + LocationTypeDef, + UserInfoTypeDef, + FileModesTypeDef, + FileSizesTypeDef, + IsBinaryFileTypeDef, + MergeOperationsTypeDef, + ObjectTypesTypeDef, + DeleteFileEntryTypeDef, + ReplaceContentEntryTypeDef, + SetFileModeEntryTypeDef, + CreateApprovalRuleTemplateInputRequestTypeDef, + CreateBranchInputRequestTypeDef, + FileMetadataTypeDef, + CreatePullRequestApprovalRuleInputRequestTypeDef, + TargetTypeDef, + CreateRepositoryInputRequestTypeDef, + DeleteApprovalRuleTemplateInputRequestTypeDef, + DeleteBranchInputRequestTypeDef, + DeleteCommentContentInputRequestTypeDef, + DeleteFileInputRequestTypeDef, + DeletePullRequestApprovalRuleInputRequestTypeDef, + DeleteRepositoryInputRequestTypeDef, + DescribeMergeConflictsInputRequestTypeDef, + PaginatorConfigTypeDef, + DescribePullRequestEventsInputRequestTypeDef, + DisassociateApprovalRuleTemplateFromRepositoryInputRequestTypeDef, + EvaluatePullRequestApprovalRulesInputRequestTypeDef, + EvaluationTypeDef, + FileTypeDef, + FolderTypeDef, + GetApprovalRuleTemplateInputRequestTypeDef, + GetBlobInputRequestTypeDef, + GetBranchInputRequestTypeDef, + GetCommentInputRequestTypeDef, + GetCommentReactionsInputRequestTypeDef, + GetCommentsForComparedCommitInputRequestTypeDef, + GetCommentsForPullRequestInputRequestTypeDef, + GetCommitInputRequestTypeDef, + GetDifferencesInputRequestTypeDef, + GetFileInputRequestTypeDef, + GetFolderInputRequestTypeDef, + SubModuleTypeDef, + SymbolicLinkTypeDef, + GetMergeCommitInputRequestTypeDef, + GetMergeConflictsInputRequestTypeDef, + GetMergeOptionsInputRequestTypeDef, + GetPullRequestApprovalStatesInputRequestTypeDef, + GetPullRequestInputRequestTypeDef, + GetPullRequestOverrideStateInputRequestTypeDef, + GetRepositoryInputRequestTypeDef, + GetRepositoryTriggersInputRequestTypeDef, + RepositoryTriggerTypeDef, + ListApprovalRuleTemplatesInputRequestTypeDef, + ListAssociatedApprovalRuleTemplatesForRepositoryInputRequestTypeDef, + ListBranchesInputRequestTypeDef, + ListPullRequestsInputRequestTypeDef, + ListRepositoriesForApprovalRuleTemplateInputRequestTypeDef, + ListRepositoriesInputRequestTypeDef, + RepositoryNameIdPairTypeDef, + ListTagsForResourceInputRequestTypeDef, + MergeBranchesByFastForwardInputRequestTypeDef, + MergeHunkDetailTypeDef, + MergeMetadataTypeDef, + MergePullRequestByFastForwardInputRequestTypeDef, + OverridePullRequestApprovalRulesInputRequestTypeDef, + PostCommentReplyInputRequestTypeDef, + PullRequestCreatedEventMetadataTypeDef, + PullRequestSourceReferenceUpdatedEventMetadataTypeDef, + PullRequestStatusChangedEventMetadataTypeDef, + PutCommentReactionInputRequestTypeDef, + SourceFileSpecifierTypeDef, + PutFileInputRequestTypeDef, + ReactionValueFormatsTypeDef, + RepositoryTriggerExecutionFailureTypeDef, + TagResourceInputRequestTypeDef, + UntagResourceInputRequestTypeDef, + UpdateApprovalRuleTemplateContentInputRequestTypeDef, + UpdateApprovalRuleTemplateDescriptionInputRequestTypeDef, + UpdateApprovalRuleTemplateNameInputRequestTypeDef, + UpdateCommentInputRequestTypeDef, + UpdateDefaultBranchInputRequestTypeDef, + UpdatePullRequestApprovalRuleContentInputRequestTypeDef, + UpdatePullRequestApprovalStateInputRequestTypeDef, + UpdatePullRequestDescriptionInputRequestTypeDef, + UpdatePullRequestStatusInputRequestTypeDef, + UpdatePullRequestTitleInputRequestTypeDef, + UpdateRepositoryDescriptionInputRequestTypeDef, + UpdateRepositoryNameInputRequestTypeDef, + ApprovalRuleTypeDef, + BatchAssociateApprovalRuleTemplateWithRepositoriesOutputTypeDef, + CreateApprovalRuleTemplateOutputTypeDef, + CreateUnreferencedMergeCommitOutputTypeDef, + DeleteApprovalRuleTemplateOutputTypeDef, + DeleteFileOutputTypeDef, + DeletePullRequestApprovalRuleOutputTypeDef, + DeleteRepositoryOutputTypeDef, + EmptyResponseMetadataTypeDef, + GetApprovalRuleTemplateOutputTypeDef, + GetBlobOutputTypeDef, + GetFileOutputTypeDef, + GetMergeCommitOutputTypeDef, + GetMergeOptionsOutputTypeDef, + GetPullRequestApprovalStatesOutputTypeDef, + GetPullRequestOverrideStateOutputTypeDef, + ListApprovalRuleTemplatesOutputTypeDef, + ListAssociatedApprovalRuleTemplatesForRepositoryOutputTypeDef, + ListBranchesOutputTypeDef, + ListPullRequestsOutputTypeDef, + ListRepositoriesForApprovalRuleTemplateOutputTypeDef, + ListTagsForResourceOutputTypeDef, + MergeBranchesByFastForwardOutputTypeDef, + MergeBranchesBySquashOutputTypeDef, + MergeBranchesByThreeWayOutputTypeDef, + PutFileOutputTypeDef, + PutRepositoryTriggersOutputTypeDef, + UpdateApprovalRuleTemplateContentOutputTypeDef, + UpdateApprovalRuleTemplateDescriptionOutputTypeDef, + UpdateApprovalRuleTemplateNameOutputTypeDef, + BatchDisassociateApprovalRuleTemplateFromRepositoriesOutputTypeDef, + BatchGetRepositoriesOutputTypeDef, + CreateRepositoryOutputTypeDef, + GetRepositoryOutputTypeDef, + DifferenceTypeDef, + DeleteBranchOutputTypeDef, + GetBranchOutputTypeDef, + DeleteCommentContentOutputTypeDef, + GetCommentOutputTypeDef, + PostCommentReplyOutputTypeDef, + UpdateCommentOutputTypeDef, + CommentsForComparedCommitTypeDef, + CommentsForPullRequestTypeDef, + PostCommentForComparedCommitInputRequestTypeDef, + PostCommentForComparedCommitOutputTypeDef, + PostCommentForPullRequestInputRequestTypeDef, + PostCommentForPullRequestOutputTypeDef, + CommitTypeDef, + ConflictMetadataTypeDef, + ConflictResolutionTypeDef, + CreateCommitOutputTypeDef, + CreatePullRequestInputRequestTypeDef, + DescribePullRequestEventsInputDescribePullRequestEventsPaginateTypeDef, + GetCommentsForComparedCommitInputGetCommentsForComparedCommitPaginateTypeDef, + GetCommentsForPullRequestInputGetCommentsForPullRequestPaginateTypeDef, + GetDifferencesInputGetDifferencesPaginateTypeDef, + ListBranchesInputListBranchesPaginateTypeDef, + ListPullRequestsInputListPullRequestsPaginateTypeDef, + ListRepositoriesInputListRepositoriesPaginateTypeDef, + EvaluatePullRequestApprovalRulesOutputTypeDef, + GetFolderOutputTypeDef, + GetRepositoryTriggersOutputTypeDef, + PutRepositoryTriggersInputRequestTypeDef, + TestRepositoryTriggersInputRequestTypeDef, + ListRepositoriesOutputTypeDef, + MergeHunkTypeDef, + PullRequestMergedStateChangedEventMetadataTypeDef, + PullRequestTargetTypeDef, + PutFileEntryTypeDef, + ReactionForCommentTypeDef, + TestRepositoryTriggersOutputTypeDef, + CreatePullRequestApprovalRuleOutputTypeDef, + UpdatePullRequestApprovalRuleContentOutputTypeDef, + GetDifferencesOutputTypeDef, + GetCommentsForComparedCommitOutputTypeDef, + GetCommentsForPullRequestOutputTypeDef, + BatchGetCommitsOutputTypeDef, + GetCommitOutputTypeDef, + GetMergeConflictsOutputTypeDef, + CreateUnreferencedMergeCommitInputRequestTypeDef, + MergeBranchesBySquashInputRequestTypeDef, + MergeBranchesByThreeWayInputRequestTypeDef, + MergePullRequestBySquashInputRequestTypeDef, + MergePullRequestByThreeWayInputRequestTypeDef, + ConflictTypeDef, + DescribeMergeConflictsOutputTypeDef, + PullRequestEventTypeDef, + PullRequestTypeDef, + CreateCommitInputRequestTypeDef, + GetCommentReactionsOutputTypeDef, + BatchDescribeMergeConflictsOutputTypeDef, + DescribePullRequestEventsOutputTypeDef, + CreatePullRequestOutputTypeDef, + GetPullRequestOutputTypeDef, + MergePullRequestByFastForwardOutputTypeDef, + MergePullRequestBySquashOutputTypeDef, + MergePullRequestByThreeWayOutputTypeDef, + UpdatePullRequestDescriptionOutputTypeDef, + UpdatePullRequestStatusOutputTypeDef, + UpdatePullRequestTitleOutputTypeDef, +) + + +def get_structure() -> ApprovalRuleEventMetadataTypeDef: + return {...} +``` + +<a id="how-it-works"></a> + +## How it works + +Fully automated +[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully +generates type annotations for each service, patiently waiting for `boto3` +updates. It delivers a drop-in type annotations for you and makes sure that: + +- All available `boto3` services are covered. +- Each public class and method of every `boto3` service gets valid type + annotations extracted from the documentation (blame `botocore` 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](https://github.com/psf/black) and + [isort](https://github.com/PyCQA/isort) for readability. + +<a id="what's-new"></a> + +## What's new + +<a id="implemented-features"></a> + +### Implemented features + +- Fully type annotated `boto3`, `botocore` and `aiobotocore` libraries +- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs` + compatibility +- `Client`, `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` and `boto3.session` calls +- Auto discovery of types for `session.client` and `session.session` calls +- Auto discovery of types for `client.get_waiter` and `client.get_paginator` + calls +- Auto discovery of types for `ServiceResource` and `Resource` collections +- Auto discovery of types for `aiobotocore.Session.create_client` calls + +<a id="latest-changes"></a> + +### Latest changes + +Builder changelog can be found in +[Releases](https://github.com/youtype/mypy_boto3_builder/releases). + +<a id="versioning"></a> + +## Versioning + +`mypy-boto3-codecommit` version is the same as related `boto3` version and +follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format. + +<a id="thank-you"></a> + +## Thank you + +- [Allie Fitter](https://github.com/alliefitter) for + [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/), + this package is based on top of his work +- [black](https://github.com/psf/black) developers for an awesome formatting + tool +- [Timothy Edmund Crosley](https://github.com/timothycrosley) for + [isort](https://github.com/PyCQA/isort) and how flexible it is +- [mypy](https://github.com/python/mypy) developers for doing all dirty work + for us +- [pyright](https://github.com/microsoft/pyright) team for the new era of typed + Python + +<a id="documentation"></a> + +## Documentation + +All services type annotations can be found in +[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_codecommit/) + +<a id="support-and-contributing"></a> + +## Support and contributing + +This package is auto-generated. Please reports any bugs or request new features +in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/) +repository. + + +%package help +Summary: Development documents and examples for mypy-boto3-codecommit +Provides: python3-mypy-boto3-codecommit-doc +%description help +<a id="mypy-boto3-codecommit"></a> + +# mypy-boto3-codecommit + +[](https://pypi.org/project/mypy-boto3-codecommit) +[](https://pypi.org/project/mypy-boto3-codecommit) +[](https://mypy-boto3-builder.readthedocs.io/) +[](https://pypistats.org/packages/mypy-boto3-codecommit) + + + +Type annotations for +[boto3.CodeCommit 1.26.0](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/codecommit.html#CodeCommit) +service compatible with [VSCode](https://code.visualstudio.com/), +[PyCharm](https://www.jetbrains.com/pycharm/), +[Emacs](https://www.gnu.org/software/emacs/), +[Sublime Text](https://www.sublimetext.com/), +[mypy](https://github.com/python/mypy), +[pyright](https://github.com/microsoft/pyright) and other tools. + +Generated by +[mypy-boto3-builder 7.11.10](https://github.com/youtype/mypy_boto3_builder). + +More information can be found on +[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in +[mypy-boto3-codecommit docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_codecommit/). + +See how it helps to find and fix potential bugs: + + + +- [mypy-boto3-codecommit](#mypy-boto3-codecommit) + - [How to install](#how-to-install) + - [VSCode extension](#vscode-extension) + - [From PyPI with pip](#from-pypi-with-pip) + - [How to uninstall](#how-to-uninstall) + - [Usage](#usage) + - [VSCode](#vscode) + - [PyCharm](#pycharm) + - [Emacs](#emacs) + - [Sublime Text](#sublime-text) + - [Other IDEs](#other-ides) + - [mypy](#mypy) + - [pyright](#pyright) + - [Explicit type annotations](#explicit-type-annotations) + - [Client annotations](#client-annotations) + - [Paginators annotations](#paginators-annotations) + - [Literals](#literals) + - [Typed dictionaries](#typed-dictionaries) + - [How it works](#how-it-works) + - [What's new](#what's-new) + - [Implemented features](#implemented-features) + - [Latest changes](#latest-changes) + - [Versioning](#versioning) + - [Thank you](#thank-you) + - [Documentation](#documentation) + - [Support and contributing](#support-and-contributing) + +<a id="how-to-install"></a> + +## How to install + +<a id="vscode-extension"></a> + +### VSCode extension + +Add +[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide) +extension to your VSCode and run `AWS boto3: Quick Start` command. + +Click `Modify` and select `boto3 common` and `CodeCommit`. + +<a id="from-pypi-with-pip"></a> + +### From PyPI with pip + +Install `boto3-stubs` for `CodeCommit` service. + +```bash +# install with boto3 type annotations +python -m pip install 'boto3-stubs[codecommit]' + + +# 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[codecommit]' + + +# standalone installation +python -m pip install mypy-boto3-codecommit +``` + +<a id="how-to-uninstall"></a> + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-codecommit +``` + +<a id="usage"></a> + +## Usage + +<a id="vscode"></a> + +### VSCode + +- Install + [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) +- Install + [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) +- Set `Pylance` as your Python Language Server +- Install `boto3-stubs[codecommit]` in your environment: + +```bash +python -m pip install 'boto3-stubs[codecommit]' +``` + +Both type checking and code completion should now work. No explicit type +annotations required, write your `boto3` code as usual. + +<a id="pycharm"></a> + +### PyCharm + +Install `boto3-stubs-lite[codecommit]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[codecommit]'` +``` + +Both type checking and code completion should now work. Explicit type +annotations **are required**. + +Use `boto3-stubs` package instead for implicit type discovery. + +<a id="emacs"></a> + +### Emacs + +- Install `boto3-stubs` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[codecommit]' +``` + +- Install [use-package](https://github.com/jwiegley/use-package), + [lsp](https://github.com/emacs-lsp/lsp-mode/), + [company](https://github.com/company-mode/company-mode) and + [flycheck](https://github.com/flycheck/flycheck) packages +- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package + +```elisp +(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. + +<a id="sublime-text"></a> + +### Sublime Text + +- Install `boto3-stubs[codecommit]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[codecommit]' +``` + +- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="other-ides"></a> + +### Other IDEs + +Not tested, but as long as your IDE supports `mypy` or `pyright`, everything +should work. + +<a id="mypy"></a> + +### mypy + +- Install `mypy`: `python -m pip install mypy` +- Install `boto3-stubs[codecommit]` in your environment: + +```bash +python -m pip install 'boto3-stubs[codecommit]'` +``` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="pyright"></a> + +### pyright + +- Install `pyright`: `npm i -g pyright` +- Install `boto3-stubs[codecommit]` in your environment: + +```bash +python -m pip install 'boto3-stubs[codecommit]' +``` + +Optionally, you can install `boto3-stubs` to `typings` folder. + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="explicit-type-annotations"></a> + +## Explicit type annotations + +<a id="client-annotations"></a> + +### Client annotations + +`CodeCommitClient` provides annotations for `boto3.client("codecommit")`. + +```python +from boto3.session import Session + +from mypy_boto3_codecommit import CodeCommitClient + +client: CodeCommitClient = Session().client("codecommit") + +# now client usage is checked by mypy and IDE should provide code completion +``` + +<a id="paginators-annotations"></a> + +### Paginators annotations + +`mypy_boto3_codecommit.paginator` module contains type annotations for all +paginators. + +```python +from boto3.session import Session + +from mypy_boto3_codecommit import CodeCommitClient +from mypy_boto3_codecommit.paginator import ( + DescribePullRequestEventsPaginator, + GetCommentsForComparedCommitPaginator, + GetCommentsForPullRequestPaginator, + GetDifferencesPaginator, + ListBranchesPaginator, + ListPullRequestsPaginator, + ListRepositoriesPaginator, +) + +client: CodeCommitClient = Session().client("codecommit") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +describe_pull_request_events_paginator: DescribePullRequestEventsPaginator = client.get_paginator( + "describe_pull_request_events" +) +get_comments_for_compared_commit_paginator: GetCommentsForComparedCommitPaginator = ( + client.get_paginator("get_comments_for_compared_commit") +) +get_comments_for_pull_request_paginator: GetCommentsForPullRequestPaginator = client.get_paginator( + "get_comments_for_pull_request" +) +get_differences_paginator: GetDifferencesPaginator = client.get_paginator("get_differences") +list_branches_paginator: ListBranchesPaginator = client.get_paginator("list_branches") +list_pull_requests_paginator: ListPullRequestsPaginator = client.get_paginator("list_pull_requests") +list_repositories_paginator: ListRepositoriesPaginator = client.get_paginator("list_repositories") +``` + +<a id="literals"></a> + +### Literals + +`mypy_boto3_codecommit.literals` module contains literals extracted from shapes +that can be used in user code for type checking. + +```python +from mypy_boto3_codecommit.literals import ( + ApprovalStateType, + ChangeTypeEnumType, + ConflictDetailLevelTypeEnumType, + ConflictResolutionStrategyTypeEnumType, + DescribePullRequestEventsPaginatorName, + FileModeTypeEnumType, + GetCommentsForComparedCommitPaginatorName, + GetCommentsForPullRequestPaginatorName, + GetDifferencesPaginatorName, + ListBranchesPaginatorName, + ListPullRequestsPaginatorName, + ListRepositoriesPaginatorName, + MergeOptionTypeEnumType, + ObjectTypeEnumType, + OrderEnumType, + OverrideStatusType, + PullRequestEventTypeType, + PullRequestStatusEnumType, + RelativeFileVersionEnumType, + ReplacementTypeEnumType, + RepositoryTriggerEventEnumType, + SortByEnumType, + CodeCommitServiceName, + ServiceName, + ResourceServiceName, + PaginatorName, + RegionName, +) + + +def check_value(value: ApprovalStateType) -> bool: + ... +``` + +<a id="typed-dictionaries"></a> + +### Typed dictionaries + +`mypy_boto3_codecommit.type_defs` module contains structures and shapes +assembled to typed dictionaries for additional type checking. + +```python +from mypy_boto3_codecommit.type_defs import ( + ApprovalRuleEventMetadataTypeDef, + ApprovalRuleOverriddenEventMetadataTypeDef, + ApprovalRuleTemplateTypeDef, + OriginApprovalRuleTemplateTypeDef, + ApprovalStateChangedEventMetadataTypeDef, + ApprovalTypeDef, + AssociateApprovalRuleTemplateWithRepositoryInputRequestTypeDef, + BatchAssociateApprovalRuleTemplateWithRepositoriesErrorTypeDef, + BatchAssociateApprovalRuleTemplateWithRepositoriesInputRequestTypeDef, + ResponseMetadataTypeDef, + BatchDescribeMergeConflictsErrorTypeDef, + BatchDescribeMergeConflictsInputRequestTypeDef, + BatchDisassociateApprovalRuleTemplateFromRepositoriesErrorTypeDef, + BatchDisassociateApprovalRuleTemplateFromRepositoriesInputRequestTypeDef, + BatchGetCommitsErrorTypeDef, + BatchGetCommitsInputRequestTypeDef, + BatchGetRepositoriesInputRequestTypeDef, + RepositoryMetadataTypeDef, + BlobMetadataTypeDef, + BranchInfoTypeDef, + CommentTypeDef, + LocationTypeDef, + UserInfoTypeDef, + FileModesTypeDef, + FileSizesTypeDef, + IsBinaryFileTypeDef, + MergeOperationsTypeDef, + ObjectTypesTypeDef, + DeleteFileEntryTypeDef, + ReplaceContentEntryTypeDef, + SetFileModeEntryTypeDef, + CreateApprovalRuleTemplateInputRequestTypeDef, + CreateBranchInputRequestTypeDef, + FileMetadataTypeDef, + CreatePullRequestApprovalRuleInputRequestTypeDef, + TargetTypeDef, + CreateRepositoryInputRequestTypeDef, + DeleteApprovalRuleTemplateInputRequestTypeDef, + DeleteBranchInputRequestTypeDef, + DeleteCommentContentInputRequestTypeDef, + DeleteFileInputRequestTypeDef, + DeletePullRequestApprovalRuleInputRequestTypeDef, + DeleteRepositoryInputRequestTypeDef, + DescribeMergeConflictsInputRequestTypeDef, + PaginatorConfigTypeDef, + DescribePullRequestEventsInputRequestTypeDef, + DisassociateApprovalRuleTemplateFromRepositoryInputRequestTypeDef, + EvaluatePullRequestApprovalRulesInputRequestTypeDef, + EvaluationTypeDef, + FileTypeDef, + FolderTypeDef, + GetApprovalRuleTemplateInputRequestTypeDef, + GetBlobInputRequestTypeDef, + GetBranchInputRequestTypeDef, + GetCommentInputRequestTypeDef, + GetCommentReactionsInputRequestTypeDef, + GetCommentsForComparedCommitInputRequestTypeDef, + GetCommentsForPullRequestInputRequestTypeDef, + GetCommitInputRequestTypeDef, + GetDifferencesInputRequestTypeDef, + GetFileInputRequestTypeDef, + GetFolderInputRequestTypeDef, + SubModuleTypeDef, + SymbolicLinkTypeDef, + GetMergeCommitInputRequestTypeDef, + GetMergeConflictsInputRequestTypeDef, + GetMergeOptionsInputRequestTypeDef, + GetPullRequestApprovalStatesInputRequestTypeDef, + GetPullRequestInputRequestTypeDef, + GetPullRequestOverrideStateInputRequestTypeDef, + GetRepositoryInputRequestTypeDef, + GetRepositoryTriggersInputRequestTypeDef, + RepositoryTriggerTypeDef, + ListApprovalRuleTemplatesInputRequestTypeDef, + ListAssociatedApprovalRuleTemplatesForRepositoryInputRequestTypeDef, + ListBranchesInputRequestTypeDef, + ListPullRequestsInputRequestTypeDef, + ListRepositoriesForApprovalRuleTemplateInputRequestTypeDef, + ListRepositoriesInputRequestTypeDef, + RepositoryNameIdPairTypeDef, + ListTagsForResourceInputRequestTypeDef, + MergeBranchesByFastForwardInputRequestTypeDef, + MergeHunkDetailTypeDef, + MergeMetadataTypeDef, + MergePullRequestByFastForwardInputRequestTypeDef, + OverridePullRequestApprovalRulesInputRequestTypeDef, + PostCommentReplyInputRequestTypeDef, + PullRequestCreatedEventMetadataTypeDef, + PullRequestSourceReferenceUpdatedEventMetadataTypeDef, + PullRequestStatusChangedEventMetadataTypeDef, + PutCommentReactionInputRequestTypeDef, + SourceFileSpecifierTypeDef, + PutFileInputRequestTypeDef, + ReactionValueFormatsTypeDef, + RepositoryTriggerExecutionFailureTypeDef, + TagResourceInputRequestTypeDef, + UntagResourceInputRequestTypeDef, + UpdateApprovalRuleTemplateContentInputRequestTypeDef, + UpdateApprovalRuleTemplateDescriptionInputRequestTypeDef, + UpdateApprovalRuleTemplateNameInputRequestTypeDef, + UpdateCommentInputRequestTypeDef, + UpdateDefaultBranchInputRequestTypeDef, + UpdatePullRequestApprovalRuleContentInputRequestTypeDef, + UpdatePullRequestApprovalStateInputRequestTypeDef, + UpdatePullRequestDescriptionInputRequestTypeDef, + UpdatePullRequestStatusInputRequestTypeDef, + UpdatePullRequestTitleInputRequestTypeDef, + UpdateRepositoryDescriptionInputRequestTypeDef, + UpdateRepositoryNameInputRequestTypeDef, + ApprovalRuleTypeDef, + BatchAssociateApprovalRuleTemplateWithRepositoriesOutputTypeDef, + CreateApprovalRuleTemplateOutputTypeDef, + CreateUnreferencedMergeCommitOutputTypeDef, + DeleteApprovalRuleTemplateOutputTypeDef, + DeleteFileOutputTypeDef, + DeletePullRequestApprovalRuleOutputTypeDef, + DeleteRepositoryOutputTypeDef, + EmptyResponseMetadataTypeDef, + GetApprovalRuleTemplateOutputTypeDef, + GetBlobOutputTypeDef, + GetFileOutputTypeDef, + GetMergeCommitOutputTypeDef, + GetMergeOptionsOutputTypeDef, + GetPullRequestApprovalStatesOutputTypeDef, + GetPullRequestOverrideStateOutputTypeDef, + ListApprovalRuleTemplatesOutputTypeDef, + ListAssociatedApprovalRuleTemplatesForRepositoryOutputTypeDef, + ListBranchesOutputTypeDef, + ListPullRequestsOutputTypeDef, + ListRepositoriesForApprovalRuleTemplateOutputTypeDef, + ListTagsForResourceOutputTypeDef, + MergeBranchesByFastForwardOutputTypeDef, + MergeBranchesBySquashOutputTypeDef, + MergeBranchesByThreeWayOutputTypeDef, + PutFileOutputTypeDef, + PutRepositoryTriggersOutputTypeDef, + UpdateApprovalRuleTemplateContentOutputTypeDef, + UpdateApprovalRuleTemplateDescriptionOutputTypeDef, + UpdateApprovalRuleTemplateNameOutputTypeDef, + BatchDisassociateApprovalRuleTemplateFromRepositoriesOutputTypeDef, + BatchGetRepositoriesOutputTypeDef, + CreateRepositoryOutputTypeDef, + GetRepositoryOutputTypeDef, + DifferenceTypeDef, + DeleteBranchOutputTypeDef, + GetBranchOutputTypeDef, + DeleteCommentContentOutputTypeDef, + GetCommentOutputTypeDef, + PostCommentReplyOutputTypeDef, + UpdateCommentOutputTypeDef, + CommentsForComparedCommitTypeDef, + CommentsForPullRequestTypeDef, + PostCommentForComparedCommitInputRequestTypeDef, + PostCommentForComparedCommitOutputTypeDef, + PostCommentForPullRequestInputRequestTypeDef, + PostCommentForPullRequestOutputTypeDef, + CommitTypeDef, + ConflictMetadataTypeDef, + ConflictResolutionTypeDef, + CreateCommitOutputTypeDef, + CreatePullRequestInputRequestTypeDef, + DescribePullRequestEventsInputDescribePullRequestEventsPaginateTypeDef, + GetCommentsForComparedCommitInputGetCommentsForComparedCommitPaginateTypeDef, + GetCommentsForPullRequestInputGetCommentsForPullRequestPaginateTypeDef, + GetDifferencesInputGetDifferencesPaginateTypeDef, + ListBranchesInputListBranchesPaginateTypeDef, + ListPullRequestsInputListPullRequestsPaginateTypeDef, + ListRepositoriesInputListRepositoriesPaginateTypeDef, + EvaluatePullRequestApprovalRulesOutputTypeDef, + GetFolderOutputTypeDef, + GetRepositoryTriggersOutputTypeDef, + PutRepositoryTriggersInputRequestTypeDef, + TestRepositoryTriggersInputRequestTypeDef, + ListRepositoriesOutputTypeDef, + MergeHunkTypeDef, + PullRequestMergedStateChangedEventMetadataTypeDef, + PullRequestTargetTypeDef, + PutFileEntryTypeDef, + ReactionForCommentTypeDef, + TestRepositoryTriggersOutputTypeDef, + CreatePullRequestApprovalRuleOutputTypeDef, + UpdatePullRequestApprovalRuleContentOutputTypeDef, + GetDifferencesOutputTypeDef, + GetCommentsForComparedCommitOutputTypeDef, + GetCommentsForPullRequestOutputTypeDef, + BatchGetCommitsOutputTypeDef, + GetCommitOutputTypeDef, + GetMergeConflictsOutputTypeDef, + CreateUnreferencedMergeCommitInputRequestTypeDef, + MergeBranchesBySquashInputRequestTypeDef, + MergeBranchesByThreeWayInputRequestTypeDef, + MergePullRequestBySquashInputRequestTypeDef, + MergePullRequestByThreeWayInputRequestTypeDef, + ConflictTypeDef, + DescribeMergeConflictsOutputTypeDef, + PullRequestEventTypeDef, + PullRequestTypeDef, + CreateCommitInputRequestTypeDef, + GetCommentReactionsOutputTypeDef, + BatchDescribeMergeConflictsOutputTypeDef, + DescribePullRequestEventsOutputTypeDef, + CreatePullRequestOutputTypeDef, + GetPullRequestOutputTypeDef, + MergePullRequestByFastForwardOutputTypeDef, + MergePullRequestBySquashOutputTypeDef, + MergePullRequestByThreeWayOutputTypeDef, + UpdatePullRequestDescriptionOutputTypeDef, + UpdatePullRequestStatusOutputTypeDef, + UpdatePullRequestTitleOutputTypeDef, +) + + +def get_structure() -> ApprovalRuleEventMetadataTypeDef: + return {...} +``` + +<a id="how-it-works"></a> + +## How it works + +Fully automated +[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully +generates type annotations for each service, patiently waiting for `boto3` +updates. It delivers a drop-in type annotations for you and makes sure that: + +- All available `boto3` services are covered. +- Each public class and method of every `boto3` service gets valid type + annotations extracted from the documentation (blame `botocore` 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](https://github.com/psf/black) and + [isort](https://github.com/PyCQA/isort) for readability. + +<a id="what's-new"></a> + +## What's new + +<a id="implemented-features"></a> + +### Implemented features + +- Fully type annotated `boto3`, `botocore` and `aiobotocore` libraries +- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs` + compatibility +- `Client`, `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` and `boto3.session` calls +- Auto discovery of types for `session.client` and `session.session` calls +- Auto discovery of types for `client.get_waiter` and `client.get_paginator` + calls +- Auto discovery of types for `ServiceResource` and `Resource` collections +- Auto discovery of types for `aiobotocore.Session.create_client` calls + +<a id="latest-changes"></a> + +### Latest changes + +Builder changelog can be found in +[Releases](https://github.com/youtype/mypy_boto3_builder/releases). + +<a id="versioning"></a> + +## Versioning + +`mypy-boto3-codecommit` version is the same as related `boto3` version and +follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format. + +<a id="thank-you"></a> + +## Thank you + +- [Allie Fitter](https://github.com/alliefitter) for + [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/), + this package is based on top of his work +- [black](https://github.com/psf/black) developers for an awesome formatting + tool +- [Timothy Edmund Crosley](https://github.com/timothycrosley) for + [isort](https://github.com/PyCQA/isort) and how flexible it is +- [mypy](https://github.com/python/mypy) developers for doing all dirty work + for us +- [pyright](https://github.com/microsoft/pyright) team for the new era of typed + Python + +<a id="documentation"></a> + +## Documentation + +All services type annotations can be found in +[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_codecommit/) + +<a id="support-and-contributing"></a> + +## Support and contributing + +This package is auto-generated. Please reports any bugs or request new features +in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/) +repository. + + +%prep +%autosetup -n mypy-boto3-codecommit-1.26.0.post1 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-mypy-boto3-codecommit -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Tue Apr 11 2023 Python_Bot <Python_Bot@openeuler.org> - 1.26.0.post1-1 +- Package Spec generated |
