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

GunicornWebWorker subclasses can config AppRunner #4720

Conversation

bmbouter
Copy link
Contributor

Currently there is no way to configure the Application Runner created by
the aiohttp.GunicornWebWorker.

This allows GunicornWebWorker subclasses to configure its
ApplicationRunner by introducing the
GunicornWebWorker._get_application_runner_instance method.

What do these changes do?

This implements Design 1 from this request for comment, comment #2988 (comment)

Are there changes in behavior for the user?

No

Related issue number

#2988

Checklist

  • I think the code is well written
  • Unit tests for the changes exist
  • Documentation reflects the changes
  • If you provide code modification, please add yourself to CONTRIBUTORS.txt
    • The format is <Name> <Surname>.
    • Please keep alphabetical order, the file is sorted by names.
  • Add a new news fragment into the CHANGES folder
    • name it <issue_id>.<type> for example (588.bugfix)
    • if you don't have an issue_id change it to the pr id after creating the pr
    • ensure type is one of the following:
      • .feature: Signifying a new feature.
      • .bugfix: Signifying a bug fix.
      • .doc: Signifying a documentation improvement.
      • .removal: Signifying a deprecation or removal of public API.
      • .misc: A ticket has been closed, but it is not of interest to users.
    • Make sure to use full sentences with correct case and punctuation, for example: "Fix issue with non-ascii contents in doctest text files."

Currently there is no way to configure the Application Runner created by
the `aiohttp.GunicornWebWorker`.

This allows `GunicornWebWorker` subclasses to configure its
`ApplicationRunner` by introducing the
`GunicornWebWorker._get_application_runner_instance` method.
@bmbouter bmbouter requested a review from asvetlov as a code owner April 27, 2020 21:04
@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Apr 27, 2020
@CLAassistant

This comment has been minimized.

Copy link
Member

@asvetlov asvetlov left a comment

Choose a reason for hiding this comment

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

The PR doesn't pass the linter CI checks.
Sorry, I cannot accept it as-is.

@@ -207,6 +201,17 @@ def _get_valid_log_format(self, source_format: str) -> str:
else:
return source_format

def _get_application_runner_instance(self, app, **kwargs):
Copy link
Member

Choose a reason for hiding this comment

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

The method should be documented and type hinted.

Copy link
Member

Choose a reason for hiding this comment

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

How **kwargs are used? I see it is always an empty dict.

@bmbouter
Copy link
Contributor Author

Our project uses a locally patched workaround. I'd still like to see this accepted so we don't have to carry it, but I'm unable to finish it so I'll close for now.

@bmbouter bmbouter closed this Apr 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bot:chronographer:provided There is a change note present in this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants