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

Decorators: Added validate_params decorator #4

Closed Seluj78 closed 1 month ago

Seluj78 commented 1 month ago

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The updates introduce a new Flask route /create-user with enhanced input parameter validation using a custom validate_params decorator. This decorator, added to the flask_utils module, ensures that the user creation request parameters are correctly typed and optionally allows empty values. Additionally, comprehensive tests have been included to validate the decorator's functionality across various scenarios.

Changes

File Path Change Summary
README.md Added a new Flask route /create-user with parameter validation using validate_params.
flask_utils/__init__.py Updated version to "0.2.0" and included the validate_params decorator from flask_utils.decorators.
flask_utils/decorators.py Introduced the validate_params decorator and helper functions for parameter type checking.
tests/test_validate_params.py Added test cases for the validate_params decorator covering various scenarios and parameter types.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant FlaskApp
    participant validate_params
    participant UserService

    Client->>FlaskApp: POST /create-user
    FlaskApp->>validate_params: Validate request parameters
    validate_params-->>FlaskApp: Parameters valid/invalid
    alt Valid Parameters
        FlaskApp->>UserService: Create user with parameters
        UserService-->>FlaskApp: User created
        FlaskApp-->>Client: 200 OK
    else Invalid Parameters
        FlaskApp-->>Client: 400 Bad Request
    end

Poem

In the world of Flask, a route anew,
With validate_params, our checks grew.
User creation now pristine and bright,
Errors caught, everything just right.
Tests abound to keep code tight,
In this update, we find delight.
🐇✨


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.