mirror of
https://github.com/ets-labs/python-dependency-injector.git
synced 2024-11-22 01:26:51 +03:00
Fixed some usages in documentation and tests
This commit is contained in:
parent
3bb4eea9c8
commit
cace03daba
|
@ -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.*
|
||||
|
||||
|
|
|
@ -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):
|
||||
|
|
|
@ -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):
|
||||
|
|
|
@ -11,7 +11,7 @@ mypy
|
|||
pyyaml
|
||||
httpx
|
||||
fastapi
|
||||
pydantic
|
||||
pydantic-settings
|
||||
numpy
|
||||
scipy
|
||||
boto3
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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()
|
||||
|
||||
|
|
Loading…
Reference in New Issue
Block a user