BaseSettings has been moved to the pydantic-settings package

[syedamaann]

Description of Changes

Summarize the changes made by this PR

This pull request addresses compatibility issues with Pydantic 2.x by updating the import paths for BaseSettings. Pydantic version 2.x has moved BaseSettings to a separate package called pydantic-settings. This PR ensures that our codebase is compatible with both Pydantic versions 1.x and 2.x.

Improvements & Bug Fixes

• Updated the import statements to check Pydantic's version and import BaseSettings from pydantic-settings if Pydantic version 2.x is detected, maintaining compatibility with earlier versions by defaulting to the existing import paths.

New Functionality

• N/A

Test Plan

How are these changes tested?

• Tests have been updated to reflect the new import logic. All existing tests related to configuration and initialization pass using pytest.
• Manual testing was performed to ensure that the application correctly identifies the Pydantic version and imports BaseSettings appropriately without any import errors.
• Continuous Integration (CI) pipelines have been adjusted to test both environments: one with Pydantic 1.x and another with Pydantic 2.x to ensure cross-version compatibility.

Documentation Changes

Are all docstrings for user-facing APIs updated if required? Do we need to make documentation changes in the docs repository?

• Docstrings within the module have been updated to reflect the changes in import logic and the new dependency requirement (pydantic-settings for Pydantic 2.x).
• Action required: Update the installation guide in the docs repository to instruct users on installing pydantic-settings when using Pydantic 2.x. This should include guidance on conditional dependency management depending on the Pydantic version used.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
chroma	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 2, 2024 9:01pm

[github-actions]

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

• Can you think of any use case in which the code does not behave as intended? Have they been tested?
• Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
• If appropriate, are there adequate property based tests?
• If appropriate, are there adequate unit tests?
• Should any logging, debugging, tracing information be added or removed?
• Are error messages user-friendly?
• Have all documentation changes needed been made?
• Have all non-obvious changes been commented?

System Compatibility

• Are there any potential impacts on other parts of the system or backward compatibility?
• Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

• Is this code of a unexpectedly high quality (Readability, Modularity, Intuitiveness)

[tazarov]

@syedamaann, thanks for this. There are still things to clear up before we can move in this direction. Have a look at #2137.