FilesExpand file tree

 main

/

kernel_pydantic.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

56 lines (40 loc) · 2.04 KB

 main

/

kernel_pydantic.py

Copy path

Top

File metadata and controls

• Code
• Blame

56 lines (40 loc) · 2.04 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

# Copyright (c) Microsoft. All rights reserved.

from typing import Annotated, Any, ClassVar, TypeVar

from pydantic import BaseModel, ConfigDict, Field, UrlConstraints

from pydantic.networks import Url

from pydantic_settings import BaseSettings, SettingsConfigDict

HttpsUrl = Annotated[Url, UrlConstraints(max_length=2083, allowed_schemes=["https"])]

class KernelBaseModel(BaseModel):

"""Base class for all pydantic models in the SK."""

model_config = ConfigDict(populate_by_name=True, arbitrary_types_allowed=True, validate_assignment=True)

T = TypeVar("T", bound="KernelBaseSettings")

class KernelBaseSettings(BaseSettings):

"""Base class for all settings classes in the SK.

A subclass creates it's fields and overrides the env_prefix class variable

with the prefix for the environment variables.

In the case where a value is specified for the same Settings field in multiple ways,

the selected value is determined as follows (in descending order of priority):

- Arguments passed to the Settings class initializer.

- Environment variables, e.g. my_prefix_special_function as described above.

- Variables loaded from a dotenv (.env) file.

- Variables loaded from the secrets directory.

- The default field values for the Settings model.

"""

env_prefix: ClassVar[str] = ""

env_file_path: str | None = Field(None, exclude=True)

env_file_encoding: str = Field("utf-8", exclude=True)

model_config = SettingsConfigDict(

extra="ignore",

case_sensitive=False,

)

@classmethod

def create(cls: type["T"], **data: Any) -> "T":

"""Update the model_config with the prefix."""

cls.model_config["env_prefix"] = cls.env_prefix

if data.get("env_file_path"):

cls.model_config["env_file"] = data["env_file_path"]

else:

cls.model_config["env_file"] = ".env"

cls.model_config["env_file_encoding"] = data.get("env_file_encoding", "utf-8")

data = {k: v for k, v in data.items() if v is not None}

return cls(**data)