fix: typing in podman.domain.containers_run

[dklimpel]

fixes:

• Incorrect and incomplete type annotations for container.run() #589

[dklimpel]

/assign vrothberg

[vrothberg]

@jwhonce PTAL

[jwhonce]

/approve

[Copilot]

Pull Request Overview

This PR fixes typing issues in the podman.domain.containers_run module by resolving type inconsistencies and adding type ignore comments where necessary. The changes enable removal of this module from mypy's ignore list.

Key changes:

• Corrected return type annotation to use Generator[bytes, None, None] instead of Generator[str, None, None]
• Renamed image variable to image_id for clarity after extracting the ID from Image objects
• Added type ignore comments for dynamic attribute access

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File	Description
pyproject.toml	Removed podman.domain.containers_run from mypy ignore list
podman/domain/containers_run.py	Fixed return type annotations and variable naming, added type ignore comments for unresolved dynamic attributes

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[Copilot]

Inconsistent return types in Union: Generator yields bytes but Iterator yields str. Both should yield the same type for consistency. Consider changing to Union[Container, Union[Generator[bytes, None, None], Iterator[bytes]]].

Suggested change

	) -> Union[Container, Union[Generator[bytes, None, None], Iterator[str]]]:
	) -> Union[Container, Union[Generator[bytes, None, None], Iterator[bytes]]]:

[Copilot]

The type: ignore[return-value] comment masks a type mismatch. The return type should be explicitly defined or the function signature should be updated to accurately reflect all possible return types (Container, Generator, Iterator, bytes, or None).

[jwhonce]

@dklimpel Should the Iterator also be updated to return bytes, as copilot suggests? The ignores are acceptable to me.

[dklimpel]

@dklimpel Should the Iterator also be updated to return bytes, as copilot suggests? The ignores are acceptable to me.

I would only fix this one issue. For a decision if the iterator is a str or bytes it needs a deep dive.

EDIT:
From a conceptual point of view, it makes sense to have standardized return types. container.logs also returns bytes. I will adjust it.

[jwhonce]

LGTM

[inknos]

/lgtm

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dklimpel, inknos, jwhonce

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [inknos,jwhonce]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment