Skip to content
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

Add type annotations to Dogstatsd.timed function and TimedContextManagerDecorator class #866

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

soceanainn
Copy link

Requirements for Contributing to this repository

  • Fill out the template below. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
  • The pull request must only fix one issue, or add one feature, at the time.
  • The pull request must update the test suite to demonstrate the changed functionality.
  • After you create the pull request, all status checks must be pass before a maintainer reviews your contribution. For more details, please see CONTRIBUTING.

What does this PR do?

Fixes #797 by adding some types to Dogstatsd.timed() function.

Description of the Change

  1. Provides some types to Dogstatsd.timed() function and TimedContextDecoratorManager.
  2. This does not fully solve the issue with types not being preserved when using timed as a decorator, but typing that correctly requires features (typing.TypeVar, typing.ParamSpec and typing.overload) that are not available in earlier versions of Python supported by this library.

Alternate Designs

N/A

Possible Drawbacks

None.

Verification Process

Ran tox -e mypy and ensured it passed.

Additional Notes

Release Notes

Review checklist (to be filled by reviewers)

  • Feature or bug fix MUST have appropriate tests (unit, integration, etc...)
  • PR title must be written as a CHANGELOG entry (see why)
  • Files changes must correspond to the primary purpose of the PR as described in the title (small unrelated changes should have their own PR)
  • PR must have one changelog/ label attached. If applicable it should have the backward-incompatible label attached.
  • PR should not have do-not-merge/ label attached.
  • If Applicable, issue must have kind/ and severity/ labels attached at least.

@soceanainn soceanainn requested review from a team as code owners November 5, 2024 18:04
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.

Type statsd.timed
1 participant