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: Added base files + custom errors #1

Closed Seluj78 closed 1 month ago

Seluj78 commented 1 month ago

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

[!WARNING]

Rate limit exceeded

@Seluj78 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 3 minutes and 29 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between 603146593a2c78a03e57f62c86ab490b1238c7fe and 811550a457afac6f4347f5e476dbd94793fc0b1e.

Walkthrough

The changes introduce configurations for linting, testing, and error handling in a Flask project. New files include .flake8, GitHub Actions workflow, .gitignore, pre-commit hooks, and various scripts for version checking and commit message linting. Error handling classes and tests for Flask applications are also added. These updates aim to enhance code quality, streamline development processes, and ensure robust error management.

Changes

Files/Paths Change Summary
.flake8, .pre-commit-config.yaml Configuration for Flake8 linter and pre-commit hooks, including updates to linting tools and adding new hooks.
.github/workflows/tests.yml GitHub Actions workflow for running tests on pull requests and pushes to the main branch.
.gitignore, pyproject.toml, tox.ini Git and project configuration files for ignoring specific files, setting up project metadata, and defining test environments.
README.md, flask_utils/__init__.py Introduced Flask utilities and error handling functions/classes.
flask_utils/errors/... Added various error handling classes and functions for different HTTP errors.
pytest.ini, requirements-dev.txt, requirements.txt Configuration for pytest and development dependencies.
scripts/check_version.py, scripts/lint-commit.sh Scripts for checking version increments and linting commit messages.
tests/conftest.py, tests/test_erorr_handlers.py Fixtures and test cases for error handling in Flask applications.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant FlaskApp
    participant ErrorHandler
    participant TestSuite

    User->>FlaskApp: Sends Request
    FlaskApp->>ErrorHandler: Triggers Error
    ErrorHandler->>FlaskApp: Returns Error Response
    FlaskApp->>User: Sends Error Response

    TestSuite->>FlaskApp: Run Tests
    FlaskApp->>ErrorHandler: Simulate Error
    ErrorHandler->>TestSuite: Returns Test Result
    TestSuite->>TestSuite: Validate Results

Poem

In the land of code, a rabbit hops, With linting tools and error stops. Testing flows with every push, Ensuring code has that perfect hush. 🐰✨ In Flask's embrace, errors tamed, A joyful dance, in code proclaimed.


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.