Skip to content

Add missing type hints for retry.py#3250

Merged
gerzse merged 7 commits into
redis:masterfrom
max-muoto:add-missing-type-hints-retry.py
Jul 3, 2024
Merged

Add missing type hints for retry.py#3250
gerzse merged 7 commits into
redis:masterfrom
max-muoto:add-missing-type-hints-retry.py

Conversation

@max-muoto
Copy link
Copy Markdown
Contributor

@max-muoto max-muoto commented May 27, 2024

Pull Request check-list

Please make sure to review and check all of these items:

  • Do tests and lints pass with this change?
  • Do the CI tests pass with this change (enable it first in your forked repo and wait for the github action build to finish)?
  • Is the new or changed code fully tested?
  • Is a documentation update included (if this change modifies existing APIs, or introduces new ones)?
  • Is there an example added to the examples folder (if applicable)?
  • Was the change added to CHANGES file?

NOTE: these things are not required to open a PR and can be done
afterwards / while the PR is open.

Description of change

Add missing type hints for the retry.py module.

gerzse
gerzse suggested changes May 28, 2024
View reviewed changes
Comment thread redis/retry.py Outdated
backoff,
retries,
supported_errors=(ConnectionError, TimeoutError, socket.timeout),
backoff: AbstractBackoff,
Copy link
Copy Markdown
Contributor

@gerzse gerzse May 28, 2024

Choose a reason for hiding this comment

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

Should AbstractBackoff be quoted here, when using if TYPE_CHECKING?

Tbh, it feels cleaner to just import AbstractBackoff always, it should not be a performance penalty.

Copy link
Copy Markdown
Contributor Author

@max-muoto max-muoto May 28, 2024

Choose a reason for hiding this comment

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

You're right, went ahead and quoted it: 1660336

It would be nicer to quote, just to avoid an unnecessary import which would slow down module init time.

Comment thread redis/retry.py Outdated
supported_errors=(ConnectionError, TimeoutError, socket.timeout),
backoff: AbstractBackoff,
retries: int,
supported_errors: tuple[type[Exception], ...] = (
Copy link
Copy Markdown
Contributor

@gerzse gerzse May 28, 2024

Choose a reason for hiding this comment

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

We support Python 3.8, where this is not yet available. You can use Tuple[Type[Exception], ...] and import them from typing.

Copy link
Copy Markdown
Contributor Author

@max-muoto max-muoto May 28, 2024

Choose a reason for hiding this comment

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

Ah yes, good catch!

Comment thread redis/retry.py Outdated

def update_supported_errors(self, specified_errors: list):
def update_supported_errors(
self, specified_errors: Iterable[type[Exception]]
Copy link
Copy Markdown
Contributor

@gerzse gerzse May 28, 2024

Choose a reason for hiding this comment

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

Same about supporting Python 3.8.

Copy link
Copy Markdown
Contributor Author

@max-muoto max-muoto May 28, 2024

Choose a reason for hiding this comment

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

8df463b

@max-muoto
Copy link
Copy Markdown
Contributor Author

max-muoto commented May 28, 2024

@gerzse Comments should be addressed.

@gerzse
Copy link
Copy Markdown
Contributor

gerzse commented Jun 14, 2024

@gerzse Comments should be addressed.

Thanks @max-muoto !

Getting picky now, but I run

mypy --python-version=3.8 redis/retry.py tests/test_retry.py tests/test_asyncio/test_retry.py

and it complains about BackoffMock class in the sync tests not being compatible with AbstractBackoff. Inheriting from AbstractBackoff, like in the async test should fix this.

@gerzse gerzse merged commit ee2a98b into redis:master Jul 3, 2024
gerzse pushed a commit to gerzse/redis-py that referenced this pull request Jul 11, 2024
@max-muoto
Add missing type hints for retry.py (redis#3250)
c7cf587 
Add missing type hints in the retry.py file and related tests.
gerzse pushed a commit that referenced this pull request Jul 11, 2024
@max-muoto @gerzse
Add missing type hints for retry.py (#3250)
511fda0 
Add missing type hints in the retry.py file and related tests.
agnesnatasya pushed a commit to agnesnatasya/redis-py that referenced this pull request Jul 20, 2024
@max-muoto @agnesnatasya
Add missing type hints for retry.py (redis#3250)
fffe330 
Add missing type hints in the retry.py file and related tests.
vladvildanov pushed a commit that referenced this pull request Sep 27, 2024
@max-muoto @vladvildanov
Add missing type hints for retry.py (#3250)
c8feb77 
Add missing type hints in the retry.py file and related tests.
vladvildanov pushed a commit that referenced this pull request Sep 27, 2024
@max-muoto @vladvildanov
Add missing type hints for retry.py (#3250)
2ac0b10 
Add missing type hints in the retry.py file and related tests.
vladvildanov pushed a commit that referenced this pull request Sep 27, 2024
@max-muoto @vladvildanov
Add missing type hints for retry.py (#3250)
17f2bd5 
Add missing type hints in the retry.py file and related tests.
Kakadus pushed a commit to Kakadus/redis-py that referenced this pull request Jan 10, 2025
@max-muoto @aiven-sal
Add missing type hints for retry.py (redis#3250)
6e43275 
Add missing type hints in the retry.py file and related tests.

Co-authored-by: Salvatore Mesoraca <salvatore.mesoraca@aiven.io>
Signed-off-by: Salvatore Mesoraca <salvatore.mesoraca@aiven.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@gerzse gerzse gerzse approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@max-muoto @gerzse