Skip to content

Add protected pprint.PrettyPrinter methods #14228

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

tobixx
Copy link

@tobixx tobixx commented Jun 6, 2025

Protected method types are needed for sub-classing support. Else mypy complains like:
"PrettyPrinter" has no attribute "_format_dict_items".

Added more protected methods

This comment has been minimized.

This comment has been minimized.

Copy link
Collaborator

@srittau srittau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm sorry for the late response. Comments below.

Comment on lines +114 to +116
def _format(
self, object: object, stream: IO[str], indent: int, allowance: int, context: dict[int, int], level: int
) -> None: ...
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IO is generally not recommended to use in argument annotations. From looking at the code, only write() seems to be called on the stream, so SupportsWrite (from _typeshed) seems like a suitable replacement.

Affects the methods below as well.

Comment on lines +148 to +150
def _readable(self, object: object, context: dict[int, int]) -> bool: ...
def _recursive(self, object: object, context: dict[int, int]) -> bool: ...
def _depth(self, object: object, context: dict[int, int]) -> int: ...
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These seem to be attributes, not methods.

Copy link
Contributor

github-actions bot commented Jul 7, 2025

According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants