Skip to content

Add FAQ explaining why Pydantic is not used #1489

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 3 commits into
base: master
Choose a base branch
from

Conversation

AnasHasan786
Copy link

@AnasHasan786 AnasHasan786 commented Jun 1, 2025

Description

Added an FAQ entry explaining why the project avoids using Pydantic, highlighting reasons such as dependency minimization, avoiding version conflicts, and preferring built-in alternatives like TypedDict.

Checklist

Code Changes

  • Add test cases to all the changes you introduce
  • Run poetry all locally to ensure this change passes linter check and tests
  • Manually test the changes:
    • Verify the feature/bug fix works as expected in real-world scenarios
    • Test edge cases and error conditions
    • Ensure backward compatibility is maintained
    • Document any manual testing steps performed
  • Update the documentation for the changes

Documentation Changes

  • Run poetry doc locally to ensure the documentation pages render correctly
  • Check and fix any broken links (internal or external) in the documentation

Expected Behavior

The FAQ page should render correctly and clearly explain why Pydantic is not used in the project.

Steps to Test This Pull Request

  1. Run poetry doc
  2. Visit the generated documentation site and open faq.md
  3. Confirm the new entry is present and correctly formatted

Additional Context

Closes #1488

@AnasHasan786 AnasHasan786 force-pushed the Added-FAQ-about-Pydantic branch from 7af5bb3 to a5073f2 Compare June 1, 2025 10:49
@bearomorphism
Copy link
Contributor

Hi @AnasHasan786 , please follow the Conventional Commit pattern in your commit messages.

doc(faq): explain why Pydantic is not used

Closes #1488 

@bearomorphism
Copy link
Contributor

And please run the following commands to setup pre-commit hooks in your local environment.

poetry setup-pre-commit

Hope this helps!

@AnasHasan786 AnasHasan786 force-pushed the Added-FAQ-about-Pydantic branch from 91dd39d to f4b7d4e Compare June 1, 2025 11:18
Copy link

codecov bot commented Jun 1, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.62%. Comparing base (120d514) to head (c253330).
Report is 657 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1489      +/-   ##
==========================================
+ Coverage   97.33%   97.62%   +0.28%     
==========================================
  Files          42       57      +15     
  Lines        2104     2653     +549     
==========================================
+ Hits         2048     2590     +542     
- Misses         56       63       +7     
Flag Coverage Δ
unittests 97.62% <ø> (+0.28%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Mention why we don't use pydantic in FAQ
2 participants