From cace03daba5a3e03667ace4aa1819d94c8c0b031 Mon Sep 17 00:00:00 2001 From: Arian Amiri Date: Sun, 18 Feb 2024 16:28:52 -0500 Subject: [PATCH] Fixed some usages in documentation and tests --- docs/providers/configuration.rst | 14 +++++++------- .../configuration/configuration_pydantic.py | 9 ++++++--- .../configuration/configuration_pydantic_init.py | 7 ++++--- requirements-dev.txt | 2 +- tests/typing/configuration.py | 2 +- .../configuration/test_from_pydantic_py36.py | 5 +++-- tox.ini | 2 +- 7 files changed, 23 insertions(+), 18 deletions(-) diff --git a/docs/providers/configuration.rst b/docs/providers/configuration.rst index 3e4696f1..1b2c3099 100644 --- a/docs/providers/configuration.rst +++ b/docs/providers/configuration.rst @@ -183,7 +183,7 @@ See also: :ref:`configuration-envs-interpolation`. Loading from a Pydantic settings -------------------------------- -``Configuration`` provider can load configuration from a ``pydantic`` settings object using the +``Configuration`` provider can load configuration from a ``pydantic-settings`` Settings object using the :py:meth:`Configuration.from_pydantic` method: .. literalinclude:: ../../examples/providers/configuration/configuration_pydantic.py @@ -191,14 +191,14 @@ Loading from a Pydantic settings :lines: 3- :emphasize-lines: 31 -To get the data from pydantic settings ``Configuration`` provider calls ``Settings.dict()`` method. +To get the data from pydantic settings ``Configuration`` provider calls ``Settings.model_dump()`` method. If you need to pass an argument to this call, use ``.from_pydantic()`` keyword arguments. .. code-block:: python container.config.from_pydantic(Settings(), exclude={"optional"}) -Alternatively, you can provide a ``pydantic`` settings object over the configuration provider argument. In that case, +Alternatively, you can provide a ``pydantic-settings`` Settings object over the configuration provider argument. In that case, the container will call ``config.from_pydantic()`` automatically: .. code-block:: python @@ -215,15 +215,15 @@ the container will call ``config.from_pydantic()`` automatically: .. note:: - ``Dependency Injector`` doesn't install ``pydantic`` by default. + ``Dependency Injector`` doesn't install ``pydantic-settings`` by default. You can install the ``Dependency Injector`` with an extra dependency:: - pip install dependency-injector[pydantic] + pip install dependency-injector[pydantic-settings] - or install ``pydantic`` directly:: + or install ``pydantic-settings`` directly:: - pip install pydantic + pip install pydantic-settings *Don't forget to mirror the changes in the requirements file.* diff --git a/examples/providers/configuration/configuration_pydantic.py b/examples/providers/configuration/configuration_pydantic.py index aaed5d26..84c6d52e 100644 --- a/examples/providers/configuration/configuration_pydantic.py +++ b/examples/providers/configuration/configuration_pydantic.py @@ -2,8 +2,11 @@ import os +from typing import Annotated + from dependency_injector import containers, providers -from pydantic import BaseSettings, Field +from pydantic import Field +from pydantic_settings import BaseSettings # Emulate environment variables os.environ["AWS_ACCESS_KEY_ID"] = "KEY" @@ -12,8 +15,8 @@ os.environ["AWS_SECRET_ACCESS_KEY"] = "SECRET" class AwsSettings(BaseSettings): - access_key_id: str = Field(env="aws_access_key_id") - secret_access_key: str = Field(env="aws_secret_access_key") + access_key_id: str = Field(alias="aws_access_key_id") + secret_access_key: str = Field(alias="aws_secret_access_key") class Settings(BaseSettings): diff --git a/examples/providers/configuration/configuration_pydantic_init.py b/examples/providers/configuration/configuration_pydantic_init.py index f904d9df..981ef3f9 100644 --- a/examples/providers/configuration/configuration_pydantic_init.py +++ b/examples/providers/configuration/configuration_pydantic_init.py @@ -3,7 +3,8 @@ import os from dependency_injector import containers, providers -from pydantic import BaseSettings, Field +from pydantic import Field +from pydantic_settings import BaseSettings # Emulate environment variables os.environ["AWS_ACCESS_KEY_ID"] = "KEY" @@ -12,8 +13,8 @@ os.environ["AWS_SECRET_ACCESS_KEY"] = "SECRET" class AwsSettings(BaseSettings): - access_key_id: str = Field(env="aws_access_key_id") - secret_access_key: str = Field(env="aws_secret_access_key") + access_key_id: str = Field(alias="aws_access_key_id") + secret_access_key: str = Field(alias="aws_secret_access_key") class Settings(BaseSettings): diff --git a/requirements-dev.txt b/requirements-dev.txt index 2c101e8c..8b4ff967 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -11,7 +11,7 @@ mypy pyyaml httpx fastapi -pydantic +pydantic-settings numpy scipy boto3 diff --git a/tests/typing/configuration.py b/tests/typing/configuration.py index 386689d2..5a0d3d28 100644 --- a/tests/typing/configuration.py +++ b/tests/typing/configuration.py @@ -1,7 +1,7 @@ from pathlib import Path from dependency_injector import providers -from pydantic import BaseSettings as PydanticSettings +from pydantic_settings import BaseSettings as PydanticSettings # Test 1: to check the getattr diff --git a/tests/unit/providers/configuration/test_from_pydantic_py36.py b/tests/unit/providers/configuration/test_from_pydantic_py36.py index f5a2c97e..dfb05e0a 100644 --- a/tests/unit/providers/configuration/test_from_pydantic_py36.py +++ b/tests/unit/providers/configuration/test_from_pydantic_py36.py @@ -1,6 +1,7 @@ """Configuration.from_pydantic() tests.""" import pydantic +import pydantic_settings from dependency_injector import providers, errors from pytest import fixture, mark, raises @@ -13,7 +14,7 @@ class Section12(pydantic.BaseModel): value2 = 2 -class Settings1(pydantic.BaseSettings): +class Settings1(pydantic_settings.BaseSettings): section1 = Section11() section2 = Section12() @@ -27,7 +28,7 @@ class Section3(pydantic.BaseModel): value3 = 3 -class Settings2(pydantic.BaseSettings): +class Settings2(pydantic_settings.BaseSettings): section1 = Section21() section3 = Section3() diff --git a/tox.ini b/tox.ini index f436345c..034e9b89 100644 --- a/tox.ini +++ b/tox.ini @@ -16,7 +16,7 @@ deps= mypy_boto3_s3 extras= yaml - pydantic + pydantic-settings flask aiohttp commands = pytest -c tests/.configs/pytest.ini