types-docker

• Add return types for secret model operations (#16185)

• Use TypedDict and SupportsGet for kwargs_from_context (#16132)

• Fix context.Context methods (#16133)

• Use optional-dependencies for third-party packages (#16089)

• Replace NoReturn with Never (#16079)

• Replace *args and **kwargs with explicit parameters (#16045)

• Update to 7.2.* (#16029)

Avoid class-scope name collisions in stubs (#15994)

Class members such as list, type, cursor, Model, and datetime shadow the builtins, classes, or modules referenced by nearby annotations. ty then resolves those annotations to Unknown, which can hide invalid calls in APIs including docker, sqlite3, psycopg2, Markdown, and requests.

Qualify shadowed builtins and use private aliases for colliding imports and classes. This removes 15 stdlib and 120 third-party collision diagnostics under ty 0.0.58, restores the affected public types, and fixes four existing psycopg2 type assertions.

Upgrade black to 26.5.0 (#15801)

[docker] Remove @override decorators (#15764)

Import some items from typing instead of typing_extensions (#15711)

Part of #13782

[docker] Improve type annotations in api.swarm (#15629)

Use dashes instead of underscores for METADATA.toml field names (#15614)

[docker] Add missing type annotations in docker.types (#15566)

Rename requires to dependencies in METADATA files (#15594)

Update most test/lint dependencies (#15582)

Update mypy to 1.20.0 (#15588)

[docker] Fix incomplete types in models and add missing method (#15565)

Add @type_check_only to stub-only private classes in various third-party stubs (#15535)

[docker] Fix Container.attach() return type (#15155)

Fix docker exec types (#15097)

[docker-py] Add fallback exec_start overload (#15098)

[docker-py] Add some missing types (#15084)

[docker-py] Fix the type of Model and Collection client attribute (#15083)

[docker-py] Fix Container.top() return type (#15067)

[docker-py] Add str type to named parameter in Image.save() method (#15068)

[docker-py] Add some return types to DockerClient method (#15069)

[docker] Fix some incomplete types (#14817)

Fix docker mount source type (#14726)

The source of a mount can be None e.g. if the type is tmpfs. The parse_mount_string also sets source=None in some cases

[docker] Add default value for detach parameter of ContainerCollection.create (#14666)

Add missing defaults to third-party stubs (#14617)

Mark stub-only private symbols as @type_check_only in third-party stubs (#14545)

[docker] load() accepts bytes streams (#14366)

Expand type stubs for Docker container device read/write bps/iops (#14092)

Replace Incomplete | None = None in third party stubs (#14063)

Improve docker.types (#13809)

Co-authored-by: Avasam samuel.06@hotmail.com

Improve docker.utils (#13808)

Fix missed type hints in docker containers.pyi (#13136)

Previously, Container.exec_run and Container.get_archive missed type hints on cmd and path arguments, respectively. Added type hints based on docstring.

[docker-py] Fix 'volumes' argument type hint for 'run' and 'create' functions in containers.pyi (#12594)

chunk_size parameter of get_image accepts None (#12560)

Bump mypy to 1.11.1 (#12463)

[docker] Add restart_policy type annotation to Container model (#12366)

[docker] Update ports type annotation (#12284)

Specify stream type of Docker logs (#12214)

Co-authored-by: Alex Waygood Alex.Waygood@Gmail.com

Allow users of docker run, create to not give name/version (#12234)

Add kwarg types to Docker container run and create (#12216)

Add Container wait return type at Docker model layer (#12217)

Also, improve type for the API layer. Previously, the type accounted for a 404 response. However, in the 404 case, a docker.errors.NotFound exception is raised.

Add more keyword argument types for Docker pull (#12210)

Add parameter types to docker.models.images.ImageCollection.build (#12196)

Introduce stubs-only module docker._types.

Add return types to docker container run (#12206)

Add more specific types to Docker network inspect/get equivalent methods (#12188)

Add types for container and net_id parameters in docker/api/network (#12042)

Add parameter types to docker's NetworkCollection create (#12190)

Add more precise types in docker.types.containers (#12191)

Use more specific types for Docker create_network (#12187)

Add some types for Docker.api.network.NetworkApiMixing.create_network parameters (#12156)

See implementation at https://github.com/docker/docker-py/blob/a3652028b1ead708bd9191efb286f909ba6c2a49/docker/api/network.py#L40

[docker] Add a number of types to docker.models.containers.Container (#12077)

[docker] Annotate Container.stop() (#12052)

Update docker to 7.1.x (#12068)

Add types to docker.models.containers.Container.logs (#12044)

Add keyword argument types to docker.models.containers.Container.wait() (#12037)

Add return type for Docker Container wait (#12036)

Add types to parameters for Docker Network.disconnect (#12007)

Add types for Docker client from_env kwargs (#11989)

Fix type of Docker BuildError.build_log (#11917)

In working this out I also had a go at changing the json_stream functions used to create every BuildError in docker-py.

There are two BuildErrors raised in docker-py, both in https://github.com/docker/docker-py/blob/b6464dbed92b14b2c61d5ee49805fce041a3e083/docker/models/images.py#L304-L315

result_stream, internal_stream = itertools.tee(json_stream(resp))
for chunk in internal_stream:
    if 'error' in chunk:
        raise BuildError(chunk['error'], result_stream)
    if 'stream' in chunk:
        match = re.search(
            r'(^Successfully built |sha256:)([0-9a-f]+)$',
            chunk['stream']
        )
        if match:
            image_id = match.group(2)
    last_event = chunk
if image_id:
    return (self.get(image_id), result_stream)
raise BuildError(last_event or 'Unknown', result_stream)

Add a number of types to docker.models.containers (#11912)

Add many types to docker.api.container (#11911)

Add types to all "container" parameters in docker.api.container (#11908)

Add remaining parameter types to docker.api.container logs (#11907)

Add return type to Docker Container.logs (#11888)

Add return type for Docker container start (#11905)

Fix "tail" parameter type for Docker container logs (#11906)

Allow Image type for docker container run image parameter (#11900)

Add some types to Docker ContainerCollection parameters (#11857)

Add return type to Docker Container.stop (#11869)

We can see at https://github.com/docker/docker-py/blob/b6464dbed92b14b2c61d5ee49805fce041a3e083/docker/models/containers.py#L452 that this returns the return value of self.client.api.stop.

We can see at https://github.com/docker/docker-py/blob/b6464dbed92b14b2c61d5ee49805fce041a3e083/docker/api/container.py#L1187 that this returns None.

Add return type to Docker Container.remove (#11868)