search

Seluj78 / flask-utils

Various Flask utilities that I find useful in my projects
GNU General Public License v3.0
2 stars 1 forks source link

Core: Flask-Utils is now an extension #26

Closed Seluj78 closed 1 month ago

Seluj78 commented 1 month ago

📚 Documentation preview 📚: https://flask-utils--26.org.readthedocs.build/en/26/

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The recent updates introduce the FlaskUtils class for enhanced error handling in Flask applications, replace the error handler registration function, and update the Sphinx documentation theme and requirements. Additionally, the validate_params function now dynamically adjusts its behavior based on error handler registration. Tests have been added to verify the new functionality.

Changes

File(s) Change Summary
docs/requirements.txt Added Pallets-Sphinx-Themes and updated sphinx-rtd-theme to 1.3.0rc1.
docs/source/api.rst Added Extension section for flask_utils.extension and _register_error_handlers function.
docs/source/conf.py Changed HTML theme to "flask" and added "pallets_sphinx_themes" extension.
flask_utils/__init__.py Updated __version__ to "0.5.0", removed register_error_handlers, added FlaskUtils.
flask_utils/decorators.py Updated validate_params to dynamically choose error handling based on FlaskUtils.
flask_utils/errors/__init__.py Renamed register_error_handlers to _register_error_handlers and updated documentation.
flask_utils/extension.py Introduced FlaskUtils class with init_app method for error handler registration.
tests/conftest.py Updated imports and replaced register_error_handlers call with FlaskUtils(app).
tests/test_extension.py Added tests for FlaskUtils, covering initialization and error handling registration.

Poem

In the land of Flask, new utils arise,
With handlers for errors, a pleasant surprise.
Themes updated, docs now gleam,
Extensions tested, a developer's dream.
Version bumped, to five-oh we soar,
FlaskUtils now reigns, forevermore. 🌟

Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.