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

Method "HTTPClient.wait()" defined but unused #48

Open
uniqueg opened this issue Feb 11, 2023 · 3 comments
Open

Method "HTTPClient.wait()" defined but unused #48

uniqueg opened this issue Feb 11, 2023 · 3 comments
Assignees
Milestone

Comments

@uniqueg
Copy link
Collaborator

uniqueg commented Feb 11, 2023

It seems that the HTTPClient.wait() method is defined but not used anywhere.

The method seems to handle timeouts. However, currently the timeout paramter is directly passed to requests, and timeouts are handled as expected. Therefore, I think the method and corresponding tests can be removed.

@uniqueg uniqueg added this to the 0.5.0 milestone Feb 11, 2023
@uniqueg uniqueg linked a pull request Feb 11, 2023 that will close this issue
@uniqueg uniqueg self-assigned this Feb 12, 2023
@kellrott
Copy link
Contributor

My read is that this method is provided to the user to allow them to easily block until a task is done.

@kellrott
Copy link
Contributor

Example of being used by a library: https://github.com/ohsu-comp-bio/tesseract/blob/master/tesseract/future.py#L33

@uniqueg
Copy link
Collaborator Author

uniqueg commented Mar 1, 2023

Alright, makes sense. Would have probably helped to read the code properly :)

I will add a description of this use case in the docs in #49 and provide full unit tests in #52. And I will close the open PR as that is relying on false assumptions.

(But I will leave this issue open until the docs and unit tests are addressed)

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 a pull request may close this issue.

2 participants