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

Use flask app.extensions for storing registry #73

Merged
merged 3 commits into from
Feb 26, 2024

Conversation

alexrudy
Copy link
Contributor

@alexrudy alexrudy commented Feb 25, 2024

Summary

As discussed in #71 and #72, move registry from app.config to app.extensions

Flask provides app.extensions as a specific place for extensions to store state, and many flask extensions do that (e.g. Flask-SQLAlchemy). This seems like the right place to store svcs state.

app.config is usually filled with things which might be set from an external config.py file, environment variable, or some other source. I often even like to be able to render these things back to e.g. JSON to save the current configuration for debugging.

Pull Request Check List

  • Typos aside (please, always submit typo fixes!), I understand that this pull request may be closed in case there was no previous discussion.
  • Do not open pull requests from your main branch – use a separate branch!
    • There's a ton of footguns waiting if you don't heed this warning. You can still go back to your project, create a branch from your main branch, push it, and open the pull request from the new branch.
    • This is not a pre-requisite for your your pull request to be accepted, but you have been warned.
  • Added tests for changed code.
    • The CI fails with less than 100% coverage.
  • New APIs are added to our typing tests at https://github.com/hynek/svcs/blob/main/tests/typing/.
  • Updated documentation for changed code.
    • [-] New functions/classes have to be added to docs/core-concepts.md or one of the integration guides by hand.
    • [-] Changed/added classes/methods/functions have appropriate versionadded, versionchanged, or deprecated directives.
      • The next version is the second number in the current release + 1. The first number represents the current year. So if the current version on PyPI is 23.1.0, the next version is gonna be 23.2.0. If the next version is the first in the new year, it'll be 24.1.0.
  • Documentation in .rst and .md files is written using semantic newlines.
  • Changes (and possible deprecations) are documented in the changelog.
  • Consider granting push permissions to the PR branch, so maintainers can fix minor issues themselves without pestering you.

@alexrudy alexrudy changed the title Use flask app.extensions for storing registry (#72) Use flask app.extensions for storing registry Feb 25, 2024
@alexrudy alexrudy force-pushed the flask-extension branch 2 times, most recently from a1be774 to e90f9ac Compare February 25, 2024 20:05
Flask provides [`app.extensions`][extensions] as a specific place for
extensions to store state, and many flask extensions do that (e.g.
Flask-SQLAlchemy). This seems like the right place to store `svcs` state.

`app.config` is usually filled with things which might be set from an external
`config.py` file, environment variable, or some other source. I often even like
to be able to render these things back to e.g. JSON to save the current
configuration for debugging.

[extensions]: https://flask.palletsprojects.com/en/3.0.x/api/#flask.Flask.extensions
CHANGELOG.md Outdated Show resolved Hide resolved
Copy link
Owner

@hynek hynek left a comment

Choose a reason for hiding this comment

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

Awesome, thanks!

@hynek hynek enabled auto-merge (squash) February 26, 2024 04:38
@hynek hynek merged commit 012b6a9 into hynek:main Feb 26, 2024
15 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.

None yet

2 participants