Data validation for Request media, headers, query, and cookies

tabotkevin commented 4 months ago

check examples/request_validation.py

""" Decorator for parsing and validating input schema. Supports both Pydantic and Marshmallow.

Usage:: """


  import time

  from pydantic import BaseModel
  from marshmallow import Schema, fields
  import responder

  class Item(BaseModel)
      name: str

  @api.schema("HeaderSchema")
  class HeaderSchema(Schema):
      x_version = fields.String(data_key="X-Version", required=True)

  api = responder.API()

  @api.route("/book_headers")
  @api.arguments(HeaderSchema, location="headers")
  async def pydantic_headers(req, resp, *, headers):
      print(headers)
      resp.text = "headers verified"

   r = api.requests.post("http://;/book_headers", headers={"X-Version": "2.5.6"})

  @api.route("/create")
  @api.media(Item)
  def create_item(req, resp, *, data):
      @api.background.task
      def process_item(item):
          time.sleep(2)
          print(item)   # e.g {"name": "Monster Hunter"}

      process_item(data)
      resp.media = {"msg": "created"}

Summary by CodeRabbit

New Features
- Introduced request validation functionality for handling HTTP requests with support for Pydantic and Marshmallow schemas.
- Enhanced response content by directly assigning the data object in API responses.
Refactor
- Refactored and improved the clarity and maintainability of decorators for parsing and validating input schemas in the API.
- Updated the logic for handling data validation and parsing, including support for different request locations.
Bug Fixes
- Fixed the use of decorators in response validation to ensure proper handling of /create and /all routes.
Tests
- Updated tests to reflect changes in decorators for creating and retrieving items, books, and schemas.

coderabbitai[bot] commented 4 months ago

Walkthrough

The recent overhaul primarily enhances data handling within a Python web application, focusing on the Responder framework. It streamlines the process of validating HTTP requests and responses with updated decorators and improved schema validation for both Pydantic and Marshmallow. Additionally, it refines the API's response mechanism and restructures error handling and request parsing for better maintainability and clarity.

Changes

File(s)	Summary
`examples/hello_data.py`	Altered response data assignment from `data.model_dump()` to directly using the `data` object.
`examples/request_validation.py`	Introduced handling for HTTP requests with schema validation and routing based on various criteria.
`examples/response_validation.py`, `tests/test_responder.py`	Replaced `@api.ensure` with `@api.response` decorators for routes.
`responder/api.py`, `responder/models.py`	Refactored decorators for input schema parsing and validation, enhanced error handling and request parsing.

🐰✨

In the realm of code, where data streams flow,
A rabbit hopped in, with changes in tow.
Schemas aligned, with validation so keen,
Paths now clear, where once errors had been.
With each line refined, a celebration we weave,
For a web more robust, in Responder we believe.
🌟🐾

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with CodeRabbit: - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit-tests for this file.` - 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 tests 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 tests.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` 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 a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@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. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - 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/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.

kennethreitz commented 4 months ago

i like this!

kennethreitz commented 4 months ago

ai music summary: https://app.suno.ai/song/ffef460e-2ee4-472e-a4b9-c897c0198829

kennethreitz / responder