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.

Sign up for GitHub

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

Jump to bottom

[tests] utils: refactor type-hint signatures. #12144

Merged
merged 7 commits into from
Mar 20, 2024
Merged

[tests] utils: refactor type-hint signatures. #12144

merged 7 commits into from
Mar 20, 2024

Conversation

jayaddison
Copy link
Contributor

Feature or Bugfix

  • Refactoring

Purpose

Detail

  • Consolidate to provision of a single http_server utility method, with tls_enabled as a boolean flag.
  • Rework a few type hints, attempting to make them easier to understand.

Relates

@jayaddison jayaddison requested a review from picnixz March 19, 2024 17:04
@jayaddison jayaddison mentioned this pull request Mar 19, 2024
Merged
picnixz
picnixz reviewed Mar 20, 2024
View reviewed changes
tests/utils.py Outdated Show resolved Hide resolved
tests/utils.py Outdated Show resolved Hide resolved
jayaddison and others added 2 commits March 20, 2024 10:25
@jayaddison @picnixz
[tests] utils: make http_server 'tls_enabled' parameter keyword-only.
643cfb0 
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
@jayaddison
[tests] utils: move module-level attribute below __future__ import, b…
31d79df 
…efore other imports (PEP8)
danieleades
danieleades approved these changes Mar 20, 2024
View reviewed changes
Copy link
Contributor

@danieleades danieleades left a comment

Choose a reason for hiding this comment

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

LGTM

@jayaddison
Copy link
Contributor Author

Thanks @danieleades!

picnixz
picnixz approved these changes Mar 20, 2024
View reviewed changes
tests/utils.py Outdated
@@ -1,17 +1,19 @@
from __future__ import annotations

import contextlib
__all__ = ["http_server"]

Copy link
Member

@picnixz picnixz Mar 20, 2024 •
edited

Choose a reason for hiding this comment

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

I think there should be 1 line after and not two (but I'm not sure with the diff)

chrisjsewell
chrisjsewell reviewed Mar 20, 2024
View reviewed changes
tests/utils.py Outdated Show resolved Hide resolved
chrisjsewell
chrisjsewell approved these changes Mar 20, 2024
View reviewed changes
Copy link
Member

@chrisjsewell chrisjsewell left a comment

Choose a reason for hiding this comment

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

a few minor nitpicks, but otherwise all good thanks

@jayaddison
Copy link
Contributor Author

Thanks @chrisjsewell!

@chrisjsewell
Copy link
Member

shall we merge this @jayaddison?

@jayaddison
Copy link
Contributor Author

@chrisjsewell yep, this is ready to merge from my perspective 👍

@chrisjsewell chrisjsewell merged commit b7f708d into sphinx-doc:master Mar 20, 2024
22 checks passed
@jayaddison
Copy link
Contributor Author

Thank you!

@jayaddison jayaddison deleted the refactor/test-utils-http-server-signatures branch March 20, 2024 23:32
@jayaddison jayaddison mentioned this pull request Mar 22, 2024
Closed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 21, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@chrisjsewell chrisjsewell chrisjsewell approved these changes

@picnixz picnixz picnixz approved these changes

@danieleades danieleades danieleades approved these changes

Assignees
No one assigned
Labels
internals:refactoring type:tests
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@jayaddison @chrisjsewell @picnixz @danieleades