mypy-boto3-batch 1.34.128__tar.gz → 1.38.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (31) hide show
  1. {mypy_boto3_batch-1.34.128 → mypy_boto3_batch-1.38.0}/LICENSE +1 -1
  2. {mypy_boto3_batch-1.34.128/mypy_boto3_batch.egg-info → mypy_boto3_batch-1.38.0}/PKG-INFO +107 -29
  3. mypy_boto3_batch-1.34.128/PKG-INFO → mypy_boto3_batch-1.38.0/README.md +88 -57
  4. {mypy_boto3_batch-1.34.128 → mypy_boto3_batch-1.38.0}/mypy_boto3_batch/__init__.py +13 -0
  5. {mypy_boto3_batch-1.34.128 → mypy_boto3_batch-1.38.0}/mypy_boto3_batch/__init__.pyi +12 -0
  6. {mypy_boto3_batch-1.34.128 → mypy_boto3_batch-1.38.0}/mypy_boto3_batch/__main__.py +11 -8
  7. mypy_boto3_batch-1.38.0/mypy_boto3_batch/client.py +521 -0
  8. mypy_boto3_batch-1.38.0/mypy_boto3_batch/client.pyi +518 -0
  9. {mypy_boto3_batch-1.34.128 → mypy_boto3_batch-1.38.0}/mypy_boto3_batch/literals.py +49 -13
  10. {mypy_boto3_batch-1.34.128 → mypy_boto3_batch-1.38.0}/mypy_boto3_batch/literals.pyi +47 -13
  11. mypy_boto3_batch-1.38.0/mypy_boto3_batch/paginator.py +226 -0
  12. mypy_boto3_batch-1.38.0/mypy_boto3_batch/paginator.pyi +204 -0
  13. mypy_boto3_batch-1.38.0/mypy_boto3_batch/type_defs.py +1735 -0
  14. mypy_boto3_batch-1.38.0/mypy_boto3_batch/type_defs.pyi +1545 -0
  15. mypy_boto3_batch-1.38.0/mypy_boto3_batch/version.py +7 -0
  16. mypy_boto3_batch-1.34.128/README.md → mypy_boto3_batch-1.38.0/mypy_boto3_batch.egg-info/PKG-INFO +135 -24
  17. {mypy_boto3_batch-1.34.128 → mypy_boto3_batch-1.38.0}/mypy_boto3_batch.egg-info/requires.txt +1 -1
  18. {mypy_boto3_batch-1.34.128 → mypy_boto3_batch-1.38.0}/setup.py +8 -7
  19. mypy_boto3_batch-1.34.128/mypy_boto3_batch/client.py +0 -499
  20. mypy_boto3_batch-1.34.128/mypy_boto3_batch/client.pyi +0 -496
  21. mypy_boto3_batch-1.34.128/mypy_boto3_batch/paginator.py +0 -151
  22. mypy_boto3_batch-1.34.128/mypy_boto3_batch/paginator.pyi +0 -145
  23. mypy_boto3_batch-1.34.128/mypy_boto3_batch/type_defs.py +0 -1973
  24. mypy_boto3_batch-1.34.128/mypy_boto3_batch/type_defs.pyi +0 -1973
  25. mypy_boto3_batch-1.34.128/mypy_boto3_batch/version.py +0 -5
  26. {mypy_boto3_batch-1.34.128 → mypy_boto3_batch-1.38.0}/mypy_boto3_batch/py.typed +0 -0
  27. {mypy_boto3_batch-1.34.128 → mypy_boto3_batch-1.38.0}/mypy_boto3_batch.egg-info/SOURCES.txt +0 -0
  28. {mypy_boto3_batch-1.34.128 → mypy_boto3_batch-1.38.0}/mypy_boto3_batch.egg-info/dependency_links.txt +0 -0
  29. {mypy_boto3_batch-1.34.128 → mypy_boto3_batch-1.38.0}/mypy_boto3_batch.egg-info/not-zip-safe +0 -0
  30. {mypy_boto3_batch-1.34.128 → mypy_boto3_batch-1.38.0}/mypy_boto3_batch.egg-info/top_level.txt +0 -0
  31. {mypy_boto3_batch-1.34.128 → mypy_boto3_batch-1.38.0}/setup.cfg +0 -0
@@ -1,6 +1,6 @@
1
1
  MIT License
2
2
 
3
- Copyright (c) 2024 Vlad Emelianov
3
+ Copyright (c) 2025 Vlad Emelianov
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  of this software and associated documentation files (the "Software"), to deal
@@ -1,7 +1,7 @@
1
- Metadata-Version: 2.1
1
+ Metadata-Version: 2.4
2
2
  Name: mypy-boto3-batch
3
- Version: 1.34.128
4
- Summary: Type annotations for boto3.Batch 1.34.128 service generated with mypy-boto3-builder 7.24.0
3
+ Version: 1.38.0
4
+ Summary: Type annotations for boto3 Batch 1.38.0 service generated with mypy-boto3-builder 8.10.1
5
5
  Home-page: https://github.com/youtype/mypy_boto3_builder
6
6
  Author: Vlad Emelianov
7
7
  Author-email: vlad.emelianov.nz@gmail.com
@@ -9,7 +9,7 @@ License: MIT License
9
9
  Project-URL: Documentation, https://youtype.github.io/boto3_stubs_docs/mypy_boto3_batch/
10
10
  Project-URL: Source, https://github.com/youtype/mypy_boto3_builder
11
11
  Project-URL: Tracker, https://github.com/youtype/mypy_boto3_builder/issues
12
- Keywords: boto3 batch type-annotations botocore mypy typeshed autocomplete
12
+ Keywords: boto3 batch boto3-stubs type-annotations mypy typeshed autocomplete
13
13
  Classifier: Development Status :: 5 - Production/Stable
14
14
  Classifier: Intended Audience :: Developers
15
15
  Classifier: Environment :: Console
@@ -23,47 +23,61 @@ Classifier: Programming Language :: Python :: 3.10
23
23
  Classifier: Programming Language :: Python :: 3.11
24
24
  Classifier: Programming Language :: Python :: 3.12
25
25
  Classifier: Programming Language :: Python :: 3.13
26
+ Classifier: Programming Language :: Python :: 3.14
26
27
  Classifier: Programming Language :: Python :: 3 :: Only
27
28
  Classifier: Programming Language :: Python :: Implementation :: CPython
28
29
  Classifier: Typing :: Stubs Only
29
30
  Requires-Python: >=3.8
30
31
  Description-Content-Type: text/markdown
31
32
  License-File: LICENSE
32
- Requires-Dist: typing-extensions>=4.1.0; python_version < "3.12"
33
+ Requires-Dist: typing-extensions; python_version < "3.12"
34
+ Dynamic: author
35
+ Dynamic: author-email
36
+ Dynamic: classifier
37
+ Dynamic: description
38
+ Dynamic: description-content-type
39
+ Dynamic: home-page
40
+ Dynamic: keywords
41
+ Dynamic: license
42
+ Dynamic: license-file
43
+ Dynamic: project-url
44
+ Dynamic: requires-dist
45
+ Dynamic: requires-python
46
+ Dynamic: summary
33
47
 
34
48
  <a id="mypy-boto3-batch"></a>
35
49
 
36
50
  # mypy-boto3-batch
37
51
 
38
- [![PyPI - mypy-boto3-batch](https://img.shields.io/pypi/v/mypy-boto3-batch.svg?color=blue)](https://pypi.org/project/mypy-boto3-batch)
39
- [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-batch.svg?color=blue)](https://pypi.org/project/mypy-boto3-batch)
40
- [![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_batch/)
41
- [![PyPI - Downloads](https://static.pepy.tech/badge/mypy-boto3-batch)](https://pepy.tech/project/mypy-boto3-batch)
52
+ [![PyPI - mypy-boto3-batch](https://img.shields.io/pypi/v/mypy-boto3-batch.svg?color=blue)](https://pypi.org/project/mypy-boto3-batch/)
53
+ [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-batch.svg?color=blue)](https://pypi.org/project/mypy-boto3-batch/)
54
+ [![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/boto3_stubs_docs/)
55
+ [![PyPI - Downloads](https://static.pepy.tech/badge/mypy-boto3-batch)](https://pypistats.org/packages/mypy-boto3-batch)
42
56
 
43
57
  ![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)
44
58
 
45
- Type annotations for
46
- [boto3.Batch 1.34.128](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/batch.html#Batch)
47
- service compatible with [VSCode](https://code.visualstudio.com/),
59
+ Type annotations for [boto3 Batch 1.38.0](https://pypi.org/project/boto3/)
60
+ compatible with [VSCode](https://code.visualstudio.com/),
48
61
  [PyCharm](https://www.jetbrains.com/pycharm/),
49
62
  [Emacs](https://www.gnu.org/software/emacs/),
50
63
  [Sublime Text](https://www.sublimetext.com/),
51
64
  [mypy](https://github.com/python/mypy),
52
65
  [pyright](https://github.com/microsoft/pyright) and other tools.
53
66
 
54
- Generated by
55
- [mypy-boto3-builder 7.24.0](https://github.com/youtype/mypy_boto3_builder).
67
+ Generated with
68
+ [mypy-boto3-builder 8.10.1](https://github.com/youtype/mypy_boto3_builder).
56
69
 
57
70
  More information can be found on
58
71
  [boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
59
72
  [mypy-boto3-batch docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_batch/).
60
73
 
61
- See how it helps to find and fix potential bugs:
74
+ See how it helps you find and fix potential bugs:
62
75
 
63
- ![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)
76
+ ![types-boto3 demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)
64
77
 
65
78
  - [mypy-boto3-batch](#mypy-boto3-batch)
66
79
  - [How to install](#how-to-install)
80
+ - [Generate locally (recommended)](<#generate-locally-(recommended)>)
67
81
  - [VSCode extension](#vscode-extension)
68
82
  - [From PyPI with pip](#from-pypi-with-pip)
69
83
  - [How to uninstall](#how-to-uninstall)
@@ -75,6 +89,7 @@ See how it helps to find and fix potential bugs:
75
89
  - [Other IDEs](#other-ides)
76
90
  - [mypy](#mypy)
77
91
  - [pyright](#pyright)
92
+ - [Pylint compatibility](#pylint-compatibility)
78
93
  - [Explicit type annotations](#explicit-type-annotations)
79
94
  - [Client annotations](#client-annotations)
80
95
  - [Paginators annotations](#paginators-annotations)
@@ -93,6 +108,21 @@ See how it helps to find and fix potential bugs:
93
108
 
94
109
  ## How to install
95
110
 
111
+ <a id="generate-locally-(recommended)"></a>
112
+
113
+ ### Generate locally (recommended)
114
+
115
+ You can generate type annotations for `boto3` package locally with
116
+ `mypy-boto3-builder`. Use
117
+ [uv](https://docs.astral.sh/uv/getting-started/installation/) for build
118
+ isolation.
119
+
120
+ 1. Run mypy-boto3-builder in your package root directory:
121
+ `uvx --with 'boto3==1.38.0' mypy-boto3-builder`
122
+ 2. Select `boto3-stubs` AWS SDK.
123
+ 3. Add `Batch` service.
124
+ 4. Use provided commands to install generated packages.
125
+
96
126
  <a id="vscode-extension"></a>
97
127
 
98
128
  ### VSCode extension
@@ -113,12 +143,10 @@ Install `boto3-stubs` for `Batch` service.
113
143
  # install with boto3 type annotations
114
144
  python -m pip install 'boto3-stubs[batch]'
115
145
 
116
-
117
146
  # Lite version does not provide session.client/resource overloads
118
147
  # it is more RAM-friendly, but requires explicit type annotations
119
148
  python -m pip install 'boto3-stubs-lite[batch]'
120
149
 
121
-
122
150
  # standalone installation
123
151
  python -m pip install mypy-boto3-batch
124
152
  ```
@@ -157,16 +185,31 @@ annotations required, write your `boto3` code as usual.
157
185
 
158
186
  ### PyCharm
159
187
 
160
- Install `boto3-stubs-lite[batch]` in your environment:
188
+ > ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
189
+ > [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
190
+ > to use [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/) until
191
+ > the issue is resolved.
192
+
193
+ > ⚠️ If you experience slow performance and high CPU usage, try to disable
194
+ > `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
195
+ > [pyright](https://github.com/microsoft/pyright) instead.
196
+
197
+ > ⚠️ To continue using `PyCharm` type checker, you can try to replace
198
+ > `boto3-stubs` with
199
+ > [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/):
161
200
 
162
201
  ```bash
163
- python -m pip install 'boto3-stubs-lite[batch]'`
202
+ pip uninstall boto3-stubs
203
+ pip install boto3-stubs-lite
164
204
  ```
165
205
 
166
- Both type checking and code completion should now work. Explicit type
167
- annotations **are required**.
206
+ Install `boto3-stubs[batch]` in your environment:
168
207
 
169
- Use `boto3-stubs` package instead for implicit type discovery.
208
+ ```bash
209
+ python -m pip install 'boto3-stubs[batch]'
210
+ ```
211
+
212
+ Both type checking and code completion should now work.
170
213
 
171
214
  <a id="emacs"></a>
172
215
 
@@ -230,7 +273,7 @@ should work.
230
273
  - Install `boto3-stubs[batch]` in your environment:
231
274
 
232
275
  ```bash
233
- python -m pip install 'boto3-stubs[batch]'`
276
+ python -m pip install 'boto3-stubs[batch]'
234
277
  ```
235
278
 
236
279
  Type checking should now work. No explicit type annotations required, write
@@ -247,11 +290,36 @@ your `boto3` code as usual.
247
290
  python -m pip install 'boto3-stubs[batch]'
248
291
  ```
249
292
 
250
- Optionally, you can install `boto3-stubs` to `typings` folder.
293
+ Optionally, you can install `boto3-stubs` to `typings` directory.
251
294
 
252
295
  Type checking should now work. No explicit type annotations required, write
253
296
  your `boto3` code as usual.
254
297
 
298
+ <a id="pylint-compatibility"></a>
299
+
300
+ ### Pylint compatibility
301
+
302
+ It is totally safe to use `TYPE_CHECKING` flag in order to avoid
303
+ `mypy-boto3-batch` dependency in production. However, there is an issue in
304
+ `pylint` that it complains about undefined variables. To fix it, set all types
305
+ to `object` in non-`TYPE_CHECKING` mode.
306
+
307
+ ```python
308
+ from typing import TYPE_CHECKING
309
+
310
+ if TYPE_CHECKING:
311
+ from mypy_boto3_ec2 import EC2Client, EC2ServiceResource
312
+ from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
313
+ from mypy_boto3_ec2.paginators import DescribeVolumesPaginator
314
+ else:
315
+ EC2Client = object
316
+ EC2ServiceResource = object
317
+ BundleTaskCompleteWaiter = object
318
+ DescribeVolumesPaginator = object
319
+
320
+ ...
321
+ ```
322
+
255
323
  <a id="explicit-type-annotations"></a>
256
324
 
257
325
  ## Explicit type annotations
@@ -287,6 +355,8 @@ from mypy_boto3_batch.paginator import (
287
355
  DescribeComputeEnvironmentsPaginator,
288
356
  DescribeJobDefinitionsPaginator,
289
357
  DescribeJobQueuesPaginator,
358
+ ListConsumableResourcesPaginator,
359
+ ListJobsByConsumableResourcePaginator,
290
360
  ListJobsPaginator,
291
361
  ListSchedulingPoliciesPaginator,
292
362
  )
@@ -304,6 +374,12 @@ describe_job_definitions_paginator: DescribeJobDefinitionsPaginator = client.get
304
374
  describe_job_queues_paginator: DescribeJobQueuesPaginator = client.get_paginator(
305
375
  "describe_job_queues"
306
376
  )
377
+ list_consumable_resources_paginator: ListConsumableResourcesPaginator = client.get_paginator(
378
+ "list_consumable_resources"
379
+ )
380
+ list_jobs_by_consumable_resource_paginator: ListJobsByConsumableResourcePaginator = (
381
+ client.get_paginator("list_jobs_by_consumable_resource")
382
+ )
307
383
  list_jobs_paginator: ListJobsPaginator = client.get_paginator("list_jobs")
308
384
  list_scheduling_policies_paginator: ListSchedulingPoliciesPaginator = client.get_paginator(
309
385
  "list_scheduling_policies"
@@ -338,11 +414,14 @@ Full list of `Batch` TypeDefs can be found in
338
414
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_batch/type_defs/).
339
415
 
340
416
  ```python
417
+ # TypedDict usage example
341
418
  from mypy_boto3_batch.type_defs import ArrayPropertiesDetailTypeDef
342
419
 
343
420
 
344
421
  def get_value() -> ArrayPropertiesDetailTypeDef:
345
- return {...}
422
+ return {
423
+ "statusSummary": ...,
424
+ }
346
425
  ```
347
426
 
348
427
  <a id="how-it-works"></a>
@@ -359,8 +438,7 @@ updates. It delivers drop-in type annotations for you and makes sure that:
359
438
  annotations extracted from `botocore` schemas.
360
439
  - Type annotations include up-to-date documentation.
361
440
  - Link to documentation is provided for every method.
362
- - Code is processed by [black](https://github.com/psf/black) and
363
- [isort](https://github.com/PyCQA/isort) for readability.
441
+ - Code is processed by [ruff](https://docs.astral.sh/ruff/) for readability.
364
442
 
365
443
  <a id="what's-new"></a>
366
444
 
@@ -397,7 +475,7 @@ Builder changelog can be found in
397
475
  ## Versioning
398
476
 
399
477
  `mypy-boto3-batch` version is the same as related `boto3` version and follows
400
- [PEP 440](https://www.python.org/dev/peps/pep-0440/) format.
478
+ [Python Packaging version specifiers](https://packaging.python.org/en/latest/specifications/version-specifiers/).
401
479
 
402
480
  <a id="thank-you"></a>
403
481
 
@@ -1,69 +1,36 @@
1
- Metadata-Version: 2.1
2
- Name: mypy-boto3-batch
3
- Version: 1.34.128
4
- Summary: Type annotations for boto3.Batch 1.34.128 service generated with mypy-boto3-builder 7.24.0
5
- Home-page: https://github.com/youtype/mypy_boto3_builder
6
- Author: Vlad Emelianov
7
- Author-email: vlad.emelianov.nz@gmail.com
8
- License: MIT License
9
- Project-URL: Documentation, https://youtype.github.io/boto3_stubs_docs/mypy_boto3_batch/
10
- Project-URL: Source, https://github.com/youtype/mypy_boto3_builder
11
- Project-URL: Tracker, https://github.com/youtype/mypy_boto3_builder/issues
12
- Keywords: boto3 batch type-annotations botocore mypy typeshed autocomplete
13
- Classifier: Development Status :: 5 - Production/Stable
14
- Classifier: Intended Audience :: Developers
15
- Classifier: Environment :: Console
16
- Classifier: License :: OSI Approved :: MIT License
17
- Classifier: Natural Language :: English
18
- Classifier: Operating System :: OS Independent
19
- Classifier: Programming Language :: Python :: 3
20
- Classifier: Programming Language :: Python :: 3.8
21
- Classifier: Programming Language :: Python :: 3.9
22
- Classifier: Programming Language :: Python :: 3.10
23
- Classifier: Programming Language :: Python :: 3.11
24
- Classifier: Programming Language :: Python :: 3.12
25
- Classifier: Programming Language :: Python :: 3.13
26
- Classifier: Programming Language :: Python :: 3 :: Only
27
- Classifier: Programming Language :: Python :: Implementation :: CPython
28
- Classifier: Typing :: Stubs Only
29
- Requires-Python: >=3.8
30
- Description-Content-Type: text/markdown
31
- License-File: LICENSE
32
- Requires-Dist: typing-extensions>=4.1.0; python_version < "3.12"
33
-
34
1
  <a id="mypy-boto3-batch"></a>
35
2
 
36
3
  # mypy-boto3-batch
37
4
 
38
- [![PyPI - mypy-boto3-batch](https://img.shields.io/pypi/v/mypy-boto3-batch.svg?color=blue)](https://pypi.org/project/mypy-boto3-batch)
39
- [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-batch.svg?color=blue)](https://pypi.org/project/mypy-boto3-batch)
40
- [![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_batch/)
41
- [![PyPI - Downloads](https://static.pepy.tech/badge/mypy-boto3-batch)](https://pepy.tech/project/mypy-boto3-batch)
5
+ [![PyPI - mypy-boto3-batch](https://img.shields.io/pypi/v/mypy-boto3-batch.svg?color=blue)](https://pypi.org/project/mypy-boto3-batch/)
6
+ [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-batch.svg?color=blue)](https://pypi.org/project/mypy-boto3-batch/)
7
+ [![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/boto3_stubs_docs/)
8
+ [![PyPI - Downloads](https://static.pepy.tech/badge/mypy-boto3-batch)](https://pypistats.org/packages/mypy-boto3-batch)
42
9
 
43
10
  ![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)
44
11
 
45
- Type annotations for
46
- [boto3.Batch 1.34.128](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/batch.html#Batch)
47
- service compatible with [VSCode](https://code.visualstudio.com/),
12
+ Type annotations for [boto3 Batch 1.38.0](https://pypi.org/project/boto3/)
13
+ compatible with [VSCode](https://code.visualstudio.com/),
48
14
  [PyCharm](https://www.jetbrains.com/pycharm/),
49
15
  [Emacs](https://www.gnu.org/software/emacs/),
50
16
  [Sublime Text](https://www.sublimetext.com/),
51
17
  [mypy](https://github.com/python/mypy),
52
18
  [pyright](https://github.com/microsoft/pyright) and other tools.
53
19
 
54
- Generated by
55
- [mypy-boto3-builder 7.24.0](https://github.com/youtype/mypy_boto3_builder).
20
+ Generated with
21
+ [mypy-boto3-builder 8.10.1](https://github.com/youtype/mypy_boto3_builder).
56
22
 
57
23
  More information can be found on
58
24
  [boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
59
25
  [mypy-boto3-batch docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_batch/).
60
26
 
61
- See how it helps to find and fix potential bugs:
27
+ See how it helps you find and fix potential bugs:
62
28
 
63
- ![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)
29
+ ![types-boto3 demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)
64
30
 
65
31
  - [mypy-boto3-batch](#mypy-boto3-batch)
66
32
  - [How to install](#how-to-install)
33
+ - [Generate locally (recommended)](<#generate-locally-(recommended)>)
67
34
  - [VSCode extension](#vscode-extension)
68
35
  - [From PyPI with pip](#from-pypi-with-pip)
69
36
  - [How to uninstall](#how-to-uninstall)
@@ -75,6 +42,7 @@ See how it helps to find and fix potential bugs:
75
42
  - [Other IDEs](#other-ides)
76
43
  - [mypy](#mypy)
77
44
  - [pyright](#pyright)
45
+ - [Pylint compatibility](#pylint-compatibility)
78
46
  - [Explicit type annotations](#explicit-type-annotations)
79
47
  - [Client annotations](#client-annotations)
80
48
  - [Paginators annotations](#paginators-annotations)
@@ -93,6 +61,21 @@ See how it helps to find and fix potential bugs:
93
61
 
94
62
  ## How to install
95
63
 
64
+ <a id="generate-locally-(recommended)"></a>
65
+
66
+ ### Generate locally (recommended)
67
+
68
+ You can generate type annotations for `boto3` package locally with
69
+ `mypy-boto3-builder`. Use
70
+ [uv](https://docs.astral.sh/uv/getting-started/installation/) for build
71
+ isolation.
72
+
73
+ 1. Run mypy-boto3-builder in your package root directory:
74
+ `uvx --with 'boto3==1.38.0' mypy-boto3-builder`
75
+ 2. Select `boto3-stubs` AWS SDK.
76
+ 3. Add `Batch` service.
77
+ 4. Use provided commands to install generated packages.
78
+
96
79
  <a id="vscode-extension"></a>
97
80
 
98
81
  ### VSCode extension
@@ -113,12 +96,10 @@ Install `boto3-stubs` for `Batch` service.
113
96
  # install with boto3 type annotations
114
97
  python -m pip install 'boto3-stubs[batch]'
115
98
 
116
-
117
99
  # Lite version does not provide session.client/resource overloads
118
100
  # it is more RAM-friendly, but requires explicit type annotations
119
101
  python -m pip install 'boto3-stubs-lite[batch]'
120
102
 
121
-
122
103
  # standalone installation
123
104
  python -m pip install mypy-boto3-batch
124
105
  ```
@@ -157,16 +138,31 @@ annotations required, write your `boto3` code as usual.
157
138
 
158
139
  ### PyCharm
159
140
 
160
- Install `boto3-stubs-lite[batch]` in your environment:
141
+ > ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
142
+ > [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
143
+ > to use [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/) until
144
+ > the issue is resolved.
145
+
146
+ > ⚠️ If you experience slow performance and high CPU usage, try to disable
147
+ > `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
148
+ > [pyright](https://github.com/microsoft/pyright) instead.
149
+
150
+ > ⚠️ To continue using `PyCharm` type checker, you can try to replace
151
+ > `boto3-stubs` with
152
+ > [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/):
161
153
 
162
154
  ```bash
163
- python -m pip install 'boto3-stubs-lite[batch]'`
155
+ pip uninstall boto3-stubs
156
+ pip install boto3-stubs-lite
164
157
  ```
165
158
 
166
- Both type checking and code completion should now work. Explicit type
167
- annotations **are required**.
159
+ Install `boto3-stubs[batch]` in your environment:
160
+
161
+ ```bash
162
+ python -m pip install 'boto3-stubs[batch]'
163
+ ```
168
164
 
169
- Use `boto3-stubs` package instead for implicit type discovery.
165
+ Both type checking and code completion should now work.
170
166
 
171
167
  <a id="emacs"></a>
172
168
 
@@ -230,7 +226,7 @@ should work.
230
226
  - Install `boto3-stubs[batch]` in your environment:
231
227
 
232
228
  ```bash
233
- python -m pip install 'boto3-stubs[batch]'`
229
+ python -m pip install 'boto3-stubs[batch]'
234
230
  ```
235
231
 
236
232
  Type checking should now work. No explicit type annotations required, write
@@ -247,11 +243,36 @@ your `boto3` code as usual.
247
243
  python -m pip install 'boto3-stubs[batch]'
248
244
  ```
249
245
 
250
- Optionally, you can install `boto3-stubs` to `typings` folder.
246
+ Optionally, you can install `boto3-stubs` to `typings` directory.
251
247
 
252
248
  Type checking should now work. No explicit type annotations required, write
253
249
  your `boto3` code as usual.
254
250
 
251
+ <a id="pylint-compatibility"></a>
252
+
253
+ ### Pylint compatibility
254
+
255
+ It is totally safe to use `TYPE_CHECKING` flag in order to avoid
256
+ `mypy-boto3-batch` dependency in production. However, there is an issue in
257
+ `pylint` that it complains about undefined variables. To fix it, set all types
258
+ to `object` in non-`TYPE_CHECKING` mode.
259
+
260
+ ```python
261
+ from typing import TYPE_CHECKING
262
+
263
+ if TYPE_CHECKING:
264
+ from mypy_boto3_ec2 import EC2Client, EC2ServiceResource
265
+ from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
266
+ from mypy_boto3_ec2.paginators import DescribeVolumesPaginator
267
+ else:
268
+ EC2Client = object
269
+ EC2ServiceResource = object
270
+ BundleTaskCompleteWaiter = object
271
+ DescribeVolumesPaginator = object
272
+
273
+ ...
274
+ ```
275
+
255
276
  <a id="explicit-type-annotations"></a>
256
277
 
257
278
  ## Explicit type annotations
@@ -287,6 +308,8 @@ from mypy_boto3_batch.paginator import (
287
308
  DescribeComputeEnvironmentsPaginator,
288
309
  DescribeJobDefinitionsPaginator,
289
310
  DescribeJobQueuesPaginator,
311
+ ListConsumableResourcesPaginator,
312
+ ListJobsByConsumableResourcePaginator,
290
313
  ListJobsPaginator,
291
314
  ListSchedulingPoliciesPaginator,
292
315
  )
@@ -304,6 +327,12 @@ describe_job_definitions_paginator: DescribeJobDefinitionsPaginator = client.get
304
327
  describe_job_queues_paginator: DescribeJobQueuesPaginator = client.get_paginator(
305
328
  "describe_job_queues"
306
329
  )
330
+ list_consumable_resources_paginator: ListConsumableResourcesPaginator = client.get_paginator(
331
+ "list_consumable_resources"
332
+ )
333
+ list_jobs_by_consumable_resource_paginator: ListJobsByConsumableResourcePaginator = (
334
+ client.get_paginator("list_jobs_by_consumable_resource")
335
+ )
307
336
  list_jobs_paginator: ListJobsPaginator = client.get_paginator("list_jobs")
308
337
  list_scheduling_policies_paginator: ListSchedulingPoliciesPaginator = client.get_paginator(
309
338
  "list_scheduling_policies"
@@ -338,11 +367,14 @@ Full list of `Batch` TypeDefs can be found in
338
367
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_batch/type_defs/).
339
368
 
340
369
  ```python
370
+ # TypedDict usage example
341
371
  from mypy_boto3_batch.type_defs import ArrayPropertiesDetailTypeDef
342
372
 
343
373
 
344
374
  def get_value() -> ArrayPropertiesDetailTypeDef:
345
- return {...}
375
+ return {
376
+ "statusSummary": ...,
377
+ }
346
378
  ```
347
379
 
348
380
  <a id="how-it-works"></a>
@@ -359,8 +391,7 @@ updates. It delivers drop-in type annotations for you and makes sure that:
359
391
  annotations extracted from `botocore` schemas.
360
392
  - Type annotations include up-to-date documentation.
361
393
  - Link to documentation is provided for every method.
362
- - Code is processed by [black](https://github.com/psf/black) and
363
- [isort](https://github.com/PyCQA/isort) for readability.
394
+ - Code is processed by [ruff](https://docs.astral.sh/ruff/) for readability.
364
395
 
365
396
  <a id="what's-new"></a>
366
397
 
@@ -397,7 +428,7 @@ Builder changelog can be found in
397
428
  ## Versioning
398
429
 
399
430
  `mypy-boto3-batch` version is the same as related `boto3` version and follows
400
- [PEP 440](https://www.python.org/dev/peps/pep-0440/) format.
431
+ [Python Packaging version specifiers](https://packaging.python.org/en/latest/specifications/version-specifiers/).
401
432
 
402
433
  <a id="thank-you"></a>
403
434
 
@@ -1,6 +1,10 @@
1
1
  """
2
2
  Main interface for batch service.
3
3
 
4
+ [Documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_batch/)
5
+
6
+ Copyright 2025 Vlad Emelianov
7
+
4
8
  Usage::
5
9
 
6
10
  ```python
@@ -11,6 +15,8 @@ Usage::
11
15
  DescribeComputeEnvironmentsPaginator,
12
16
  DescribeJobDefinitionsPaginator,
13
17
  DescribeJobQueuesPaginator,
18
+ ListConsumableResourcesPaginator,
19
+ ListJobsByConsumableResourcePaginator,
14
20
  ListJobsPaginator,
15
21
  ListSchedulingPoliciesPaginator,
16
22
  )
@@ -21,6 +27,8 @@ Usage::
21
27
  describe_compute_environments_paginator: DescribeComputeEnvironmentsPaginator = client.get_paginator("describe_compute_environments")
22
28
  describe_job_definitions_paginator: DescribeJobDefinitionsPaginator = client.get_paginator("describe_job_definitions")
23
29
  describe_job_queues_paginator: DescribeJobQueuesPaginator = client.get_paginator("describe_job_queues")
30
+ list_consumable_resources_paginator: ListConsumableResourcesPaginator = client.get_paginator("list_consumable_resources")
31
+ list_jobs_by_consumable_resource_paginator: ListJobsByConsumableResourcePaginator = client.get_paginator("list_jobs_by_consumable_resource")
24
32
  list_jobs_paginator: ListJobsPaginator = client.get_paginator("list_jobs")
25
33
  list_scheduling_policies_paginator: ListSchedulingPoliciesPaginator = client.get_paginator("list_scheduling_policies")
26
34
  ```
@@ -31,18 +39,23 @@ from .paginator import (
31
39
  DescribeComputeEnvironmentsPaginator,
32
40
  DescribeJobDefinitionsPaginator,
33
41
  DescribeJobQueuesPaginator,
42
+ ListConsumableResourcesPaginator,
43
+ ListJobsByConsumableResourcePaginator,
34
44
  ListJobsPaginator,
35
45
  ListSchedulingPoliciesPaginator,
36
46
  )
37
47
 
38
48
  Client = BatchClient
39
49
 
50
+
40
51
  __all__ = (
41
52
  "BatchClient",
42
53
  "Client",
43
54
  "DescribeComputeEnvironmentsPaginator",
44
55
  "DescribeJobDefinitionsPaginator",
45
56
  "DescribeJobQueuesPaginator",
57
+ "ListConsumableResourcesPaginator",
58
+ "ListJobsByConsumableResourcePaginator",
46
59
  "ListJobsPaginator",
47
60
  "ListSchedulingPoliciesPaginator",
48
61
  )
@@ -1,6 +1,10 @@
1
1
  """
2
2
  Main interface for batch service.
3
3
 
4
+ [Documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_batch/)
5
+
6
+ Copyright 2025 Vlad Emelianov
7
+
4
8
  Usage::
5
9
 
6
10
  ```python
@@ -11,6 +15,8 @@ Usage::
11
15
  DescribeComputeEnvironmentsPaginator,
12
16
  DescribeJobDefinitionsPaginator,
13
17
  DescribeJobQueuesPaginator,
18
+ ListConsumableResourcesPaginator,
19
+ ListJobsByConsumableResourcePaginator,
14
20
  ListJobsPaginator,
15
21
  ListSchedulingPoliciesPaginator,
16
22
  )
@@ -21,6 +27,8 @@ Usage::
21
27
  describe_compute_environments_paginator: DescribeComputeEnvironmentsPaginator = client.get_paginator("describe_compute_environments")
22
28
  describe_job_definitions_paginator: DescribeJobDefinitionsPaginator = client.get_paginator("describe_job_definitions")
23
29
  describe_job_queues_paginator: DescribeJobQueuesPaginator = client.get_paginator("describe_job_queues")
30
+ list_consumable_resources_paginator: ListConsumableResourcesPaginator = client.get_paginator("list_consumable_resources")
31
+ list_jobs_by_consumable_resource_paginator: ListJobsByConsumableResourcePaginator = client.get_paginator("list_jobs_by_consumable_resource")
24
32
  list_jobs_paginator: ListJobsPaginator = client.get_paginator("list_jobs")
25
33
  list_scheduling_policies_paginator: ListSchedulingPoliciesPaginator = client.get_paginator("list_scheduling_policies")
26
34
  ```
@@ -31,6 +39,8 @@ from .paginator import (
31
39
  DescribeComputeEnvironmentsPaginator,
32
40
  DescribeJobDefinitionsPaginator,
33
41
  DescribeJobQueuesPaginator,
42
+ ListConsumableResourcesPaginator,
43
+ ListJobsByConsumableResourcePaginator,
34
44
  ListJobsPaginator,
35
45
  ListSchedulingPoliciesPaginator,
36
46
  )
@@ -43,6 +53,8 @@ __all__ = (
43
53
  "DescribeComputeEnvironmentsPaginator",
44
54
  "DescribeJobDefinitionsPaginator",
45
55
  "DescribeJobQueuesPaginator",
56
+ "ListConsumableResourcesPaginator",
57
+ "ListJobsByConsumableResourcePaginator",
46
58
  "ListJobsPaginator",
47
59
  "ListSchedulingPoliciesPaginator",
48
60
  )