explicit-python 2.5.0__py3-none-any.whl → 3.1.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
explicit/adapters/db.py CHANGED
@@ -1,11 +1,15 @@
1
1
  """Абстракции адаптера СУБД."""
2
- from abc import ABCMeta
3
- from abc import abstractmethod
4
- from typing import Any
5
2
 
3
+ from abc import (
4
+ ABCMeta,
5
+ abstractmethod,
6
+ )
7
+ from typing import (
8
+ Any,
9
+ )
6
10
 
7
- class AbstractSpecification(metaclass=ABCMeta):
8
11
 
12
+ class AbstractSpecification(metaclass=ABCMeta):
9
13
  """Набор условий для проверки соответствия объекта этим условиям."""
10
14
 
11
15
  @abstractmethod
@@ -18,7 +22,6 @@ class AbstractSpecification(metaclass=ABCMeta):
18
22
 
19
23
 
20
24
  class AbstractRepository(metaclass=ABCMeta):
21
-
22
25
  """Репозиторий - абстракция над хранилищем данных (БД).
23
26
 
24
27
  Должен содержать методы получения объектов со всеми вариантами выборки:
explicit/adapters/fs.py CHANGED
@@ -1,9 +1,11 @@
1
1
  """Абстракции адаптера к хранилищу файлов."""
2
- from abc import ABC
3
2
 
3
+ from abc import (
4
+ ABC,
5
+ )
4
6
 
5
- class AbstractAdapter(ABC):
6
7
 
8
+ class AbstractAdapter(ABC):
7
9
  """Абстрактный адаптер к хранилищу файлов.
8
10
 
9
11
  .. code-block:: python
@@ -1,10 +1,12 @@
1
1
  """Абстракции адаптера обмена сообщениями."""
2
- from abc import ABC
3
- from abc import abstractmethod
4
2
 
3
+ from abc import (
4
+ ABC,
5
+ abstractmethod,
6
+ )
5
7
 
6
- class AbstractAdapter(ABC):
7
8
 
9
+ class AbstractAdapter(ABC):
8
10
  @abstractmethod
9
11
  def publish(self, message, *args, **kwargs):
10
12
  raise NotImplementedError()
@@ -1,6 +1,9 @@
1
1
  """Дополнения для моделей предметной области."""
2
- from .fields import identifier
3
- from .fields import uuid_identifier
2
+
3
+ from .fields import (
4
+ identifier,
5
+ uuid_identifier,
6
+ )
4
7
 
5
8
 
6
9
  __all__ = [
@@ -1,7 +1,12 @@
1
1
  """Поля модели предметной области."""
2
- from uuid import uuid4
3
2
 
4
- from pydantic.fields import Field
3
+ from uuid import (
4
+ uuid4,
5
+ )
6
+
7
+ from pydantic.fields import (
8
+ Field,
9
+ )
5
10
 
6
11
 
7
12
  def identifier(**kwargs):
@@ -9,12 +14,10 @@ def identifier(**kwargs):
9
14
  None,
10
15
  title='Идентификатор',
11
16
  description=(
12
- 'Идентификатор записи. '
13
- 'Может отсутствовать у создаваемых объектов, '
14
- 'но обязан присутствовать у существующих.'
17
+ 'Идентификатор записи. Может отсутствовать у создаваемых объектов, но обязан присутствовать у существующих.'
15
18
  ),
16
19
  gt=0,
17
- **kwargs
20
+ **kwargs,
18
21
  )
19
22
 
20
23
 
@@ -23,9 +26,7 @@ def uuid_identifier(**kwargs):
23
26
  default_factory=uuid4,
24
27
  title='Идентификатор UUID',
25
28
  description=(
26
- 'Идентификатор записи. '
27
- 'Может отсутствовать у создаваемых объектов, '
28
- 'но обязан присутствовать у существующих.'
29
+ 'Идентификатор записи. Может отсутствовать у создаваемых объектов, но обязан присутствовать у существующих.'
29
30
  ),
30
- **kwargs
31
+ **kwargs,
31
32
  )
@@ -1,15 +1,21 @@
1
1
  """Реестр событий по топикам."""
2
- from collections import defaultdict
3
- from dataclasses import dataclass
4
- from typing import TYPE_CHECKING
5
- from typing import Dict
6
- from typing import Type
7
- from typing import Union
2
+
8
3
  import logging
4
+ from collections import (
5
+ defaultdict,
6
+ )
7
+ from dataclasses import (
8
+ dataclass,
9
+ )
10
+ from typing import (
11
+ TYPE_CHECKING,
12
+ )
9
13
 
10
14
 
11
15
  if TYPE_CHECKING:
12
- from explicit.messagebus.events import Event
16
+ from explicit.messagebus.events import (
17
+ Event,
18
+ )
13
19
 
14
20
  logger = logging.getLogger(__name__)
15
21
  logger.setLevel(logging.INFO)
@@ -28,21 +34,21 @@ class Message:
28
34
 
29
35
 
30
36
  class Registry:
31
-
32
37
  """Реестр событий по топикам."""
33
38
 
34
- _registry: Dict[str, list[Type['Event']]]
39
+ _registry: dict[str, list[type['Event']]]
35
40
 
36
41
  def __init__(self):
37
42
  self._registry = defaultdict(list)
38
43
 
39
- def register(self, topic: str, *events: Type['Event']) -> None:
44
+ def register(self, topic: str, *events: type['Event']) -> None:
40
45
  """Регистрирует сопоставление топика с типом события."""
41
46
  self._registry[topic].extend(events)
42
47
 
43
- def resolve(self, message: Message) -> Union['Event', None]:
44
- """
45
- Определяет подходящий тип события и возвращает экземпляр для передачи на обработку в шину событий либо None.
48
+ def resolve(self, message: Message) -> 'Event | None':
49
+ """Определяет подходящий тип события.
50
+
51
+ Возвращает экземпляр для передачи на обработку в шину событий либо None.
46
52
  """
47
53
  event = None
48
54
 
@@ -1,28 +1,54 @@
1
1
  """Объекты предметной области."""
2
- from .factories import AbstractDomainFactory
3
- from .factories import DTOBase
4
- from .fields import Field
5
- from .model import HasUnsetValues
6
- from .model import Unset
7
- from .model import asdict
8
- from .model import is_unset
9
- from .model import unset
10
- from .model import unset_validator
11
- from .types import Bool
12
- from .types import Date
13
- from .types import Int
14
- from .types import NoneBool
15
- from .types import NoneDate
16
- from .types import NoneInt
17
- from .types import NoneStr
18
- from .types import NoneUnsetUUID
19
- from .types import Str
20
- from .types import UnsetUUID
2
+
3
+ from .factories import (
4
+ AbstractDomainFactory,
5
+ DTOBase,
6
+ )
7
+ from .fields import (
8
+ Field,
9
+ get_field_attribute,
10
+ get_field_title,
11
+ )
12
+ from .model import (
13
+ HasUnsetValues,
14
+ Unset,
15
+ asdict,
16
+ is_unset,
17
+ unset,
18
+ )
19
+ from .types import (
20
+ Bool,
21
+ Date,
22
+ Int,
23
+ NoneBool,
24
+ NoneDate,
25
+ NoneInt,
26
+ NoneStr,
27
+ NoneUnsetUUID,
28
+ Str,
29
+ UnsetUUID,
30
+ )
21
31
 
22
32
 
23
33
  __all__ = [
24
- 'AbstractDomainFactory', 'DTOBase',
25
- 'Unset', 'unset', 'is_unset', 'unset_validator', 'HasUnsetValues', 'asdict',
34
+ 'AbstractDomainFactory',
35
+ 'DTOBase',
36
+ 'Unset',
37
+ 'unset',
38
+ 'is_unset',
39
+ 'HasUnsetValues',
40
+ 'asdict',
26
41
  'Field',
27
- 'UnsetUUID', 'Bool', 'Date', 'Int', 'NoneBool', 'NoneDate', 'NoneInt', 'NoneStr', 'NoneUnsetUUID', 'Str'
42
+ 'get_field_title',
43
+ 'get_field_attribute',
44
+ 'UnsetUUID',
45
+ 'Bool',
46
+ 'Date',
47
+ 'Int',
48
+ 'NoneBool',
49
+ 'NoneDate',
50
+ 'NoneInt',
51
+ 'NoneStr',
52
+ 'NoneUnsetUUID',
53
+ 'Str',
28
54
  ]
@@ -1,14 +1,18 @@
1
1
  """Объекты передачи данных."""
2
- from abc import ABCMeta
3
- from abc import abstractmethod
2
+
3
+ from abc import (
4
+ ABCMeta,
5
+ abstractmethod,
6
+ )
4
7
 
5
8
  from pydantic.main import BaseModel # pylint: disable=no-name-in-module
6
9
 
7
- from .model import HasUnsetValues
10
+ from .model import (
11
+ HasUnsetValues,
12
+ )
8
13
 
9
14
 
10
15
  class DTOBase(HasUnsetValues, BaseModel):
11
-
12
16
  """Базовый объект передачи данных.
13
17
 
14
18
  .. code-block::python
@@ -18,12 +22,8 @@ class DTOBase(HasUnsetValues, BaseModel):
18
22
 
19
23
  """
20
24
 
21
- class Config:
22
- arbitrary_types_allowed = False
23
-
24
25
 
25
26
  class AbstractDomainFactory(metaclass=ABCMeta):
26
-
27
27
  @abstractmethod
28
28
  def create(self, data):
29
29
  """Сборка объекта модели предметной области из переданных данных.
explicit/domain/fields.py CHANGED
@@ -1,9 +1,67 @@
1
1
  """Набор полей объектов предметной области."""
2
- from functools import partial
3
2
 
4
- from pydantic import Field as DefaultField
3
+ from functools import (
4
+ partial,
5
+ )
6
+ from typing import (
7
+ Any,
8
+ )
5
9
 
6
- from .model import unset
10
+ from pydantic import (
11
+ Field as DefaultField,
12
+ )
7
13
 
14
+ from .model import (
15
+ unset,
16
+ )
8
17
 
9
- Field = partial(DefaultField, default=unset)
18
+
19
+ Field = partial(DefaultField, default=unset) # pylint: disable=invalid-name
20
+
21
+
22
+ def get_field_title(cls: type, name: str) -> str:
23
+ """Возвращает заголовок поля pydantic-модели или pydantic-датакласса.
24
+
25
+ Если заголовок не задан, возвращает имя поля.
26
+
27
+ .. code-block:: python
28
+
29
+ @dataclass
30
+ class User:
31
+ username: str = Field(title='Логин')
32
+ email: str
33
+
34
+
35
+ get_field_title(User, 'username') == 'Логин'
36
+ get_field_title(User, 'email') == 'email'
37
+
38
+ """
39
+ return cls.__pydantic_fields__[name].title or name # type: ignore[attr-defined]
40
+
41
+
42
+ def get_field_attribute(cls: type, name: str, attribute: str) -> Any:
43
+ """Возвращает атрибут поля pydantic-модели или pydantic-датакласса.
44
+
45
+ Ограничения (``max_length``, ``ge``, ``max_digits`` и т.п.) pydantic хранит не в самом поле,
46
+ а в его метаданных, поэтому атрибут ищется и там.
47
+
48
+ .. code-block:: python
49
+
50
+ @dataclass
51
+ class User:
52
+ username: str = Field(title='Логин', max_length=50)
53
+
54
+
55
+ get_field_attribute(User, 'username', 'max_length') == 50
56
+
57
+ Raises:
58
+ AttributeError: если атрибут у поля не задан.
59
+
60
+ """
61
+ field = cls.__pydantic_fields__[name] # type: ignore[attr-defined]
62
+ if (value := getattr(field, attribute, None)) is not None:
63
+ return value
64
+ for meta in field.metadata:
65
+ if (value := getattr(meta, attribute, None)) is not None:
66
+ return value
67
+ raise AttributeError(f'У поля {cls.__name__}.{name} не задан атрибут {attribute}')
explicit/domain/model.py CHANGED
@@ -1,21 +1,34 @@
1
1
  """Вспомогательные утилиты и типы предметной области."""
2
- from dataclasses import asdict as asdict_
3
- from typing import TYPE_CHECKING
4
- from typing import Any
5
- from typing import ClassVar
6
- from typing import Dict
7
- from typing import Generic
8
- from typing import Protocol
9
- from typing import TypeVar
10
- from typing import Union
11
2
 
12
- from pydantic import validator
13
- from pydantic.main import BaseModel
14
- from pydantic.validators import _VALIDATORS
3
+ from typing import (
4
+ TYPE_CHECKING,
5
+ Any,
6
+ ClassVar,
7
+ Generic,
8
+ Protocol,
9
+ TypeVar,
10
+ )
11
+
12
+ from pydantic import (
13
+ ConfigDict,
14
+ GetCoreSchemaHandler,
15
+ SerializerFunctionWrapHandler,
16
+ TypeAdapter,
17
+ model_serializer,
18
+ )
19
+ from pydantic.main import (
20
+ BaseModel,
21
+ )
22
+ from pydantic_core import (
23
+ CoreSchema,
24
+ core_schema,
25
+ )
15
26
 
16
27
 
17
28
  if TYPE_CHECKING:
18
- from pydantic.typing import AbstractSetIntStr
29
+ from pydantic.main import (
30
+ IncEx,
31
+ )
19
32
 
20
33
 
21
34
  class __IsDataclass(Protocol): # pylint: disable=invalid-name
@@ -23,15 +36,15 @@ class __IsDataclass(Protocol): # pylint: disable=invalid-name
23
36
 
24
37
  Лучший из известных способов сделать соответствующую подсказку.
25
38
  """
26
- __dataclass_fields__: ClassVar[Dict]
39
+
40
+ __dataclass_fields__: ClassVar[dict]
27
41
 
28
42
 
29
43
  T = TypeVar('T')
30
44
 
31
45
 
32
46
  class __SingletonMeta(type, Generic[T]): # pylint: disable=invalid-name
33
-
34
- _instances: 'Dict[__SingletonMeta[T], T]' = {} # pylint: disable=invalid-sequence-index
47
+ _instances: 'dict[__SingletonMeta[T], T]' = {} # pylint: disable=invalid-sequence-index
35
48
 
36
49
  def __call__(cls: '__SingletonMeta', *args, **kwargs):
37
50
  if cls not in cls._instances:
@@ -64,31 +77,43 @@ class Unset(metaclass=__SingletonMeta):
64
77
  def __repr__(self):
65
78
  return '<unset>'
66
79
 
80
+ def __reduce__(self):
81
+ """Сериализация экземпляра.
67
82
 
68
- unset = Unset() # Sentinel value
83
+ Возвращает имя глобальной переменной модуля, поэтому copy, deepcopy
84
+ и pickle возвращают тот же экземпляр, а не его копию.
69
85
 
86
+ Например:
70
87
 
71
- def is_unset(obj) -> bool:
72
- return isinstance(obj, Unset)
88
+ assert deepcopy(unset) is unset
89
+ assert pickle.loads(pickle.dumps(unset)) is unset
73
90
 
91
+ """
92
+ return 'unset'
74
93
 
75
- def unset_validator(v):
76
- return v
94
+ @classmethod
95
+ def __get_pydantic_core_schema__( # pylint: disable=unused-argument
96
+ cls, source_type: Any, handler: GetCoreSchemaHandler
97
+ ) -> CoreSchema:
98
+ return core_schema.is_instance_schema(cls)
77
99
 
78
100
 
79
- _VALIDATORS.append((Unset, [unset_validator]))
101
+ unset = Unset() # Sentinel value
80
102
 
81
103
 
82
- class HasUnsetValues(BaseModel):
104
+ def is_unset(obj) -> bool:
105
+ return isinstance(obj, Unset)
106
+
83
107
 
108
+ class HasUnsetValues(BaseModel):
84
109
  """Примесь к моделям, значения которых могут быть не заданы."""
85
110
 
86
- @validator('*', pre=True)
87
- def _unset_validator(cls, v): # pylint: disable=no-self-argument
88
- return v
111
+ # Вложенные модели сериализуются по фактическому типу, а не по объявленному в аннотации поля.
112
+ model_config = ConfigDict(polymorphic_serialization=True)
89
113
 
90
- def dict(self, *args, **kwargs):
91
- """Формирует словарь из данных объекта, отбрасывая не установленные значения.
114
+ @model_serializer(mode='wrap')
115
+ def _drop_unset(self, handler: SerializerFunctionWrapHandler) -> dict[str, Any]:
116
+ """Отбрасывает не установленные значения при сериализации, в т.ч. во вложенных моделях.
92
117
 
93
118
  .. code-block:: python
94
119
 
@@ -96,32 +121,29 @@ class HasUnsetValues(BaseModel):
96
121
  series = unset
97
122
  number = unser
98
123
 
99
- DocumentDTO(number='1').dict() == {'number': '1'}
124
+
125
+ DocumentDTO(number='1').model_dump() == {'number': '1'}
100
126
 
101
127
  """
102
- return dict(
103
- (k, v)
104
- for k, v in super().dict(*args, **kwargs).items()
105
- if not is_unset(v)
106
- )
128
+ return {k: v for k, v in handler(self).items() if not is_unset(v)}
107
129
 
108
130
 
109
131
  def filter_unset(d: Any):
110
132
  if not isinstance(d, dict):
111
133
  return d
112
134
 
113
- return dict(
114
- (k, filter_unset(v))
115
- for k, v in d.items() if not is_unset(v)
116
- )
135
+ return dict((k, filter_unset(v)) for k, v in d.items() if not is_unset(v))
136
+
137
+
138
+ # Разворачивает в словари модели и датаклассы на любом уровне вложенности, в т.ч. модели внутри датаклассов.
139
+ _any_adapter = TypeAdapter(Any)
117
140
 
118
141
 
119
142
  def asdict(
120
- obj: Union[__IsDataclass, 'HasUnsetValues'],
121
- include: Union['AbstractSetIntStr', None] = None,
122
- exclude: Union['AbstractSetIntStr', None] = None,
143
+ obj: __IsDataclass | HasUnsetValues,
144
+ include: 'IncEx | None' = None,
145
+ exclude: 'IncEx | None' = None,
123
146
  ) -> dict:
124
-
125
147
  """Формирует словарь из данных объекта, отбрасывая не установленные значения.
126
148
 
127
149
  .. code-block:: python
@@ -131,22 +153,8 @@ def asdict(
131
153
  series = unset
132
154
  number = unser
133
155
 
156
+
134
157
  asdict(Document(number='1')) == {'number': '1'}
135
158
 
136
159
  """
137
-
138
- if isinstance(obj, BaseModel):
139
- data = obj.dict(exclude=exclude, include=include)
140
-
141
- else:
142
- unfiltered_data = asdict_(obj)
143
- data = dict(
144
- (k, v)
145
- for k, v in unfiltered_data.items()
146
- if (
147
- k in (include or unfiltered_data) and
148
- k not in (exclude or ())
149
- )
150
- )
151
-
152
- return filter_unset(data)
160
+ return filter_unset(_any_adapter.dump_python(obj, include=include, exclude=exclude))
explicit/domain/types.py CHANGED
@@ -13,24 +13,28 @@
13
13
  snils_num: NoneStr = Field(alias='snils')
14
14
 
15
15
  """
16
- from typing import Union
17
- from uuid import UUID as UUID_
16
+
18
17
  import datetime
18
+ from uuid import (
19
+ UUID as UUID_,
20
+ )
19
21
 
20
- from .model import Unset
22
+ from .model import (
23
+ Unset,
24
+ )
21
25
 
22
26
 
23
- Bool = Union[bool, Unset]
24
- NoneBool = Union[Bool, None]
27
+ Bool = bool | Unset
28
+ NoneBool = Bool | None
25
29
 
26
- Str = Union[str, Unset]
27
- NoneStr = Union[Str, None]
30
+ Str = str | Unset
31
+ NoneStr = Str | None
28
32
 
29
- Int = Union[int, Unset]
30
- NoneInt = Union[Int, None]
33
+ Int = int | Unset
34
+ NoneInt = Int | None
31
35
 
32
- Date = Union[datetime.date, Unset]
33
- NoneDate = Union[Date, None]
36
+ Date = datetime.date | Unset
37
+ NoneDate = Date | None
34
38
 
35
- UnsetUUID = Union[UUID_, Unset] # pylint: disable=invalid-name
36
- NoneUnsetUUID = Union[UnsetUUID, None] # pylint: disable=invalid-name
39
+ UnsetUUID = UUID_ | Unset # pylint: disable=invalid-name
40
+ NoneUnsetUUID = UnsetUUID | None # pylint: disable=invalid-name