Skip to content

Chore/update 2 #3

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

Open
wants to merge 93 commits into
base: master
Choose a base branch
from
Open

Chore/update 2 #3

wants to merge 93 commits into from

Conversation

v4rgas
Copy link

@v4rgas v4rgas commented May 9, 2025

No description provided.

domdent and others added 30 commits August 6, 2024 14:46
…leware

📝 Tweak middleware code sample `time.time()` to `time.perf_counter()`
Bumps [pypa/gh-action-pypi-publish](https://github.com/pypa/gh-action-pypi-publish) from 1.9.0 to 1.10.0.
- [Release notes](https://github.com/pypa/gh-action-pypi-publish/releases)
- [Commits](pypa/gh-action-pypi-publish@v1.9.0...v1.10.0)

---
updated-dependencies:
- dependency-name: pypa/gh-action-pypi-publish
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
…t` GH action (fastapi#12118)

* include-hidden-files when uploading coverage files

* include-hidden-files when building docs
Bumps [pillow](https://github.com/python-pillow/Pillow) from 10.3.0 to 10.4.0.
- [Release notes](https://github.com/python-pillow/Pillow/releases)
- [Changelog](https://github.com/python-pillow/Pillow/blob/main/CHANGES.rst)
- [Commits](python-pillow/Pillow@10.3.0...10.4.0)

---
updated-dependencies:
- dependency-name: pillow
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
BORA040126 and others added 25 commits September 8, 2024 01:35
* ⬆ [pre-commit.ci] pre-commit autoupdate

updates:
- [github.com/astral-sh/ruff-pre-commit: v0.6.3 → v0.6.4](astral-sh/ruff-pre-commit@v0.6.3...v0.6.4)

* bump ruff in tests requirements as well

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: svlandeg <svlandeg@github.com>
Bumps [tiangolo/issue-manager](https://github.com/tiangolo/issue-manager) from 0.5.0 to 0.5.1.
- [Release notes](https://github.com/tiangolo/issue-manager/releases)
- [Commits](tiangolo/issue-manager@0.5.0...0.5.1)

---
updated-dependencies:
- dependency-name: tiangolo/issue-manager
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Copy link

blar-app bot commented May 9, 2025

Blar's eyes are on this PR! Time to frog-ify the code and jump into review.

@blar-app blar-app bot added size XL Pull Request size is Extra Large Impact XS The PR impact is very low labels May 9, 2025
Copy link

blar-app bot commented May 9, 2025

This PR updates documentation and internal code to recommend using time.perf_counter() instead of time.time() for precise timing measurements in middlewares. It also includes various updates such as dependency upgrades, translation additions for multiple languages, and new feature support, notably adding support for Pydantic models in form parameters in FastAPI. The changes improve timing accuracy, expand internationalization, and enhance framework capabilities with new Pydantic-related features, alongside maintenance updates and dependency management improvements.

Pull Request Impact: 2
We measure the impact of a Pull Request on the codebase by counting the number of references to the changed code.

🔄 File Changes Overview
File Description
README.md Updated sponsor link for Coherence in documentation to a new URL.
docs/en/docs/deployment/cloud.md Updated the external link for Coherence in the documentation to point to the new URL, changing the HTML anchor tag accordingly.
docs/en/docs/environment-variables.md Removed an unnecessary comment line that explained how the Python system finds the Python program in a specific directory, which was redundant given the surrounding context.
docs/en/docs/release-notes.md The file was updated with documentation edits, including changing a timer function to time.perf_counter(), and various release notes, internal refactors, translation additions, and dependency updates across multiple FastAPI versions.
docs/en/docs/tutorial/middleware.md Updated documentation to recommend using time.perf_counter() instead of time.time() for measuring durations in middlewares, including a tip with a link to the Python documentation.
docs/en/docs/tutorial/request-form-models.md Added documentation on using Pydantic models for form fields in FastAPI, including how to declare models, handle extra fields, and verify in the docs UI; also mentioned support since FastAPI 0.113.0 and 0.114.0.
docs/en/overrides/main.html Updated the sponsorship link for Coherence in the documentation to point to the new website URL.
docs/ko/docs/project-generation.md Added a detailed Korean description for the Full Stack FastAPI Template, highlighting its features, technological stack, and deployment options.
docs/nl/docs/features.md The file contains detailed information about FastAPI's features, including its basis on open standards like OpenAPI and JSON Schema, automatic documentation with Swagger UI and ReDoc, modern Python support, editor support, validation, security, dependency injection, plug-ins, and integration with Starlette and Pydantic. The changes primarily add this comprehensive documentation content.
docs/nl/docs/python-types.md The file provides an introduction and detailed tutorial on Python type hints, including their motivation, declaration, use with collections, classes, and Pydantic models, as well as integration with FastAPI. It explains how type hints improve editor support, error checking, and validation in FastAPI applications.
docs/pt/docs/advanced/security/index.md Added a section about advanced security functionalities, including a note that these are not necessarily 'advanced' and may be relevant for various use cases, emphasizing reading the main security guide first.
docs/pt/docs/advanced/testing-events.md Added a new test case demonstrating how to initialize and close the FastAPI application in tests using TestClient with a 'with' statement.
docs/pt/docs/environment-variables.md Added a comprehensive guide in Portuguese on environment variables, explaining what they are, how to create and read them in different shells and Python, their typical use cases, and details about special variables like PATH. The document also covers setting environment variables temporarily and permanently, their types, validation, and their role in system behavior.
docs/pt/docs/tutorial/debugging.md Added a new tutorial section on debugging FastAPI applications, covering how to connect debuggers like Visual Studio Code and PyCharm, and explaining the use of __name__ == "__main__" for running the app with uvicorn.
docs/pt/docs/tutorial/testing.md The file was entirely added and contains a comprehensive tutorial on testing FastAPI applications using Starlette's TestClient, including setup instructions, code examples, and best practices for writing and organizing tests.
docs/pt/docs/virtual-environments.md The file provides a detailed guide on how to create and manage virtual environments for Python projects, including commands for creating, activating, verifying, and deactivating virtual environments, as well as installing packages within them. It emphasizes best practices for dependency management and avoiding conflicts between project environments.
docs/zh/docs/project-generation.md Replaced the detailed project description with a concise summary of the FastAPI full-stack template, highlighting its tech stack, features, and integrations.
docs_src/middleware/tutorial001.py The code was updated to measure processing time using 'time.perf_counter()' instead of 'time.time()' for more precise timing in middleware.
docs_src/request_form_models/tutorial001.py Added a new FastAPI route '/login/' that accepts form data with username and password fields, using Pydantic model for validation.
docs_src/request_form_models/tutorial001_an.py Added a new POST endpoint '/login/' to the FastAPI application that accepts form data for username and password, utilizing Pydantic models and FastAPI forms to capture and return the submitted data.
📃 Unreviewed files The following files were not reviewed by the agent:
File path
.github/labeler.yml
.github/workflows/build-docs.yml
.github/workflows/issue-manager.yml
.github/workflows/publish.yml
.github/workflows/test.yml
.pre-commit-config.yaml
docs/en/data/external_links.yml
docs/en/data/sponsors.yml
docs/en/mkdocs.yml
📊 Impact Summary This tables shows the impact of the changes in the codebase
File path Name Impact Type of impact
docs_src/request_form_models/tutorial001_an.py FormData 1 Added
docs_src/request_form_models/tutorial001.py FormData 1 Added
⚙️ Configuration Changes The following tables show the changes made to the .yaml and .yml files:
  • .github/labeler.yml
    The configuration excludes 'docs/en/data/sponsors.yml' and 'docs/en/overrides/main.html' from coverage in 'docs' and 'internal' sections, respectively. These files are now explicitly ignored in relevant file glob patterns.
  • .github/workflows/build-docs.yml
    Added 'include-hidden-files: true' to the 'with' parameters in the job, likely to include hidden files in the documentation site build process.
  • .github/workflows/issue-manager.yml
    Updated schedule cron timing, added pull-requests permission, upgraded issue-manager action to version 0.5.1, and renamed 'changes-requested' to 'waiting' with modified message.
  • .github/workflows/publish.yml
    Updated the PyPI publish GitHub Action version from v1.9.0 to v1.10.1 to incorporate latest updates and improvements.
  • .github/workflows/test.yml
    Updated pip install command to use '--upgrade' for both Pydantic v2 and other versions, ensuring proper package upgrade behavior. Added 'include-hidden-files: true' to coverage upload steps to include hidden files.
  • .pre-commit-config.yaml
    Updated the revision of the 'ruff-pre-commit' hook from v0.6.2 to v0.6.4.
  • docs/en/data/external_links.yml
    Added two new articles authored by Shubhendra Kushwaha on advanced SQLAlchemy techniques, with links to Medium articles. No other configuration inconsistencies detected.
  • docs/en/data/sponsors.yml
    Updated the URL for Coherence in the sponsorship section to redirect to the homepage instead of a specific documentation page. No other configuration inconsistencies detected.
  • docs/en/mkdocs.yml
    A new entry 'tutorial/request-form-models.md' has been added to the 'nav' list in the configuration.
📜 Blar Instructions

Blar Commands

  • Comment -blar --review triggers a review of the Pull Request, analyzing only the unreviewed commits since the last review.
  • Comment -blar --review --force to receive a complete review of the entire Pull Request, reanalyzing all commits.

Tags Explanation

  • 🐛 Debugger Agent Issues:
    These issues are identified by our Debugger Agent, which focuses on detecting bugs and errors in your code.
    Solutions for 🐛 issues are available upon request using the -blar --fix command.

  • ⚡ Optimizer Agent Issues:
    These issues focus on identifying inefficient database queries that can impact performance.
    Solutions for ⚡ issues are available upon request using the -blar --fix command.

  • 🛡️ Cyber Security Agent Issues:
    These issues focus on identifying potential security vulnerabilities in your code.
    Solutions for 🛡️ issues are available upon request using the -blar --fix command.

  • 🎨 Design Pattern Reviewer Agent Issues:
    These issues highlight concerns related to improper or suboptimal use of design patterns, evaluated based on rules set in the wiki.
    Solutions for 🎨 issues are available upon request using the -blar --fix command.

Copy link

blar-app bot commented May 9, 2025

✅ No debugger issues found 🐛
❕ It looks like we couldn't find any design patterns in the Wiki for this repository. Let's add some at: app.blar.io/wiki

Review's done! 🚀 Check out the feedback and let me know if you need anything! – Blar

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Impact XS The PR impact is very low size XL Pull Request size is Extra Large
Projects
None yet
Development

Successfully merging this pull request may close these issues.