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

feat: Add type hints to stream module #2166

Merged
merged 5 commits into from
Aug 15, 2023
Merged

Conversation

copalco
Copy link
Contributor

@copalco copalco commented Aug 9, 2023

Summary of Changes

Replace this text with a high-level summary of the changes included in this PR.

Related Issues

Please reference here any issue #'s that are relevant to this PR, or simply enter "N/A" if this PR does not relate to any existing issues.

Pull Request Checklist

This is just a reminder about the most common mistakes. Please make sure that you tick all appropriate boxes. But please read our contribution guide at least once; it will save you a few review cycles!

If an item doesn't apply to your pull request, check it anyway to make it apparent that there's nothing to do.

  • Applied changes to both WSGI and ASGI code paths and interfaces (where applicable).
  • Added tests for changed code.
  • Prefixed code comments with GitHub nick and an appropriate prefix.
  • Coding style is consistent with the rest of the framework.
  • Updated documentation for changed code.
    • Added docstrings for any new classes, functions, or modules.
    • Updated docstrings for any modifications to existing code.
    • Updated both WSGI and ASGI docs (where applicable).
    • Added references to new classes, functions, or modules to the relevant RST file under docs/.
    • Updated all relevant supporting documentation files under docs/.
    • A copyright notice is included at the top of any new modules (using your own name or the name of your organization).
    • Changed/added classes/methods/functions have appropriate versionadded, versionchanged, or deprecated directives.
  • Changes (and possible deprecations) have towncrier news fragments under docs/_newsfragments/, with the file name format {issue_number}.{fragment_type}.rst. (Run towncrier --draft to ensure it renders correctly.)

If you have any questions to any of the points above, just submit and ask! This checklist is here to help you, not to deter you from contributing!

PR template inspired by the attrs project.

Copy link
Member

@CaselIT CaselIT left a comment

Choose a reason for hiding this comment

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

nice work, thanks!

falcon/stream.py Outdated Show resolved Hide resolved
pyproject.toml Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Aug 10, 2023

Codecov Report

Merging #2166 (e2554f2) into master (0c68df3) will not change coverage.
The diff coverage is 100.00%.

❗ Current head e2554f2 differs from pull request most recent head 54b427a. Consider uploading reports for the commit 54b427a to get more accurate results

@@            Coverage Diff            @@
##            master     #2166   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           62        62           
  Lines         6830      6833    +3     
  Branches      1098      1098           
=========================================
+ Hits          6830      6833    +3     
Files Changed Coverage Δ
falcon/stream.py 100.00% <100.00%> (ø)

CaselIT
CaselIT previously approved these changes Aug 10, 2023
@CaselIT CaselIT requested a review from vytas7 August 10, 2023 22:04
Copy link
Member

@vytas7 vytas7 left a comment

Choose a reason for hiding this comment

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

LGTM bar CI failures (and one cosmetic nitpick).

We normally don't merge with failing CI, so that ASGI tutorial error needs to be addressed separately assuming it is not caused by this PR. I can take a look at it. But the import grouping failure does seem to be introduced by this changeset.

falcon/stream.py Show resolved Hide resolved
falcon/stream.py Outdated Show resolved Hide resolved
Copy link
Member

@vytas7 vytas7 left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for this improvement!
(Particularly appreciated as typing ain't my forte 😅)

@vytas7 vytas7 merged commit f00722a into falconry:master Aug 15, 2023
35 checks passed
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.

3 participants