Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions .changelog/006.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: Event
ts: 2026-02-10 21:12:15.603395+00:00
type: additional_change
auto_generated: true
change_kind: base_class_added
details: added base class '_Model'
group: __ROOT__
---
name: Entity
ts: 2026-02-10 21:12:15.603408+00:00
type: additional_change
auto_generated: true
change_kind: base_class_added
details: added base class '_Model'
group: __ROOT__
---
name: StaticSettings
ts: 2026-02-10 21:12:15.603412+00:00
type: additional_change
auto_generated: true
change_kind: base_class_added
details: added base class 'BaseSettings'
group: __ROOT__
---
name: StaticSettings
ts: 2026-02-10 21:12:15.603414+00:00
type: additional_change
auto_generated: true
change_kind: default_added
details: 'field ''CACHE_DIR'' default added: None'
field_name: CACHE_DIR
group: __ROOT__
---
name: StaticSettings
ts: 2026-02-10 21:12:15.603417+00:00
type: additional_change
auto_generated: true
change_kind: default_added
details: 'field ''STATIC_DIR'' default added: None'
field_name: STATIC_DIR
group: __ROOT__
---
name: IgnoreFalsy
ts: 2026-02-10 21:12:15.603419+00:00
type: additional_change
auto_generated: true
change_kind: base_class_added
details: added base class 'BaseModel'
group: dump
1 change: 0 additions & 1 deletion .groups.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ groups:
owned_modules:
- pydantic_utils
owned_refs:
- pydantic_utils.BaseModelT
- pydantic_utils.UtcDatetime
- pydantic_utils.UtcDatetimeMs
- pydantic_utils.copy_and_validate
Expand Down
21 changes: 21 additions & 0 deletions docs/_root/entity.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Entity

<!-- === DO_NOT_EDIT: pkg-ext entity_def === -->
## class: Entity
- [source](../../model_lib/model_base.py#L58)
> **Since:** 0.100.0

```python
class Entity(_Model):
...
```
<!-- === OK_EDIT: pkg-ext entity_def === -->

<!-- === DO_NOT_EDIT: pkg-ext entity_changes === -->
### Changes

| Version | Change |
|---------|--------|
| unreleased | added base class '_Model' |
| 0.100.0 | Made public |
<!-- === OK_EDIT: pkg-ext entity_changes === -->
21 changes: 21 additions & 0 deletions docs/_root/event.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Event

<!-- === DO_NOT_EDIT: pkg-ext event_def === -->
## class: Event
- [source](../../model_lib/model_base.py#L54)
> **Since:** 0.100.0

```python
class Event(_Model):
...
```
<!-- === OK_EDIT: pkg-ext event_def === -->

<!-- === DO_NOT_EDIT: pkg-ext event_changes === -->
### Changes

| Version | Change |
|---------|--------|
| unreleased | added base class '_Model' |
| 0.100.0 | Made public |
<!-- === OK_EDIT: pkg-ext event_changes === -->
33 changes: 2 additions & 31 deletions docs/_root/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,36 +4,7 @@
<!-- === OK_EDIT: pkg-ext header === -->

<!-- === DO_NOT_EDIT: pkg-ext symbols === -->
- [`Entity`](#entity_def)
- [`Event`](#event_def)
- [Entity](./entity.md)
- [Event](./event.md)
- [StaticSettings](./staticsettings.md)
<!-- === OK_EDIT: pkg-ext symbols === -->

<!-- === DO_NOT_EDIT: pkg-ext symbol_details_header === -->
## Symbol Details
<!-- === OK_EDIT: pkg-ext symbol_details_header === -->

<!-- === DO_NOT_EDIT: pkg-ext entity_def === -->
<a id="entity_def"></a>

### class: `Entity`
- [source](../../model_lib/model_base.py#L58)
> **Since:** 0.100.0

```python
class Entity(_Model):
...
```
<!-- === OK_EDIT: pkg-ext entity_def === -->
<!-- === DO_NOT_EDIT: pkg-ext event_def === -->
<a id="event_def"></a>

### class: `Event`
- [source](../../model_lib/model_base.py#L54)
> **Since:** 0.100.0

```python
class Event(_Model):
...
```
<!-- === OK_EDIT: pkg-ext event_def === -->
7 changes: 5 additions & 2 deletions docs/_root/staticsettings.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@

```python
class StaticSettings(BaseSettings):
STATIC_DIR: Path | None
CACHE_DIR: Path | None
STATIC_DIR: Path | None = None
CACHE_DIR: Path | None = None
SKIP_APP_NAME: bool = False
```
<!-- === OK_EDIT: pkg-ext staticsettings_def === -->
Expand All @@ -34,6 +34,9 @@ class StaticSettings(BaseSettings):

| Version | Change |
|---------|--------|
| unreleased | field 'STATIC_DIR' default added: None |
| unreleased | field 'CACHE_DIR' default added: None |
| unreleased | added base class 'BaseSettings' |
| 0.102.0 | field 'STATIC_DIR' default removed (was: PydanticUndefined) |
| 0.102.0 | field 'STATIC_DIR' type: Path -> Path | None |
| 0.102.0 | field 'CACHE_DIR' default removed (was: PydanticUndefined) |
Expand Down
21 changes: 21 additions & 0 deletions docs/dump/ignorefalsy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# IgnoreFalsy

<!-- === DO_NOT_EDIT: pkg-ext ignorefalsy_def === -->
## class: IgnoreFalsy
- [source](../../model_lib/dump_functions.py#L17)
> **Since:** 0.100.0

```python
class IgnoreFalsy(BaseModel):
...
```
<!-- === OK_EDIT: pkg-ext ignorefalsy_def === -->

<!-- === DO_NOT_EDIT: pkg-ext ignorefalsy_changes === -->
### Changes

| Version | Change |
|---------|--------|
| unreleased | added base class 'BaseModel' |
| 0.100.0 | Made public |
<!-- === OK_EDIT: pkg-ext ignorefalsy_changes === -->
32 changes: 19 additions & 13 deletions docs/dump/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<!-- === OK_EDIT: pkg-ext header === -->

<!-- === DO_NOT_EDIT: pkg-ext symbols === -->
- [`IgnoreFalsy`](#ignorefalsy_def)
- [IgnoreFalsy](./ignorefalsy.md)
- [`dump_as_dict`](#dump_as_dict_def)
- [`dump_as_list`](#dump_as_list_def)
- [`dump_as_str`](#dump_as_str_def)
Expand All @@ -14,18 +14,6 @@
## Symbol Details
<!-- === OK_EDIT: pkg-ext symbol_details_header === -->

<!-- === DO_NOT_EDIT: pkg-ext ignorefalsy_def === -->
<a id="ignorefalsy_def"></a>

### class: `IgnoreFalsy`
- [source](../../model_lib/dump_functions.py#L17)
> **Since:** 0.100.0

```python
class IgnoreFalsy(BaseModel):
...
```
<!-- === OK_EDIT: pkg-ext ignorefalsy_def === -->
<!-- === DO_NOT_EDIT: pkg-ext dump_as_dict_def === -->
<a id="dump_as_dict_def"></a>

Expand All @@ -37,6 +25,12 @@ class IgnoreFalsy(BaseModel):
def dump_as_dict(instance: object) -> dict:
...
```

### Changes

| Version | Change |
|---------|--------|
| 0.100.0 | Made public |
<!-- === OK_EDIT: pkg-ext dump_as_dict_def === -->
<!-- === DO_NOT_EDIT: pkg-ext dump_as_list_def === -->
<a id="dump_as_list_def"></a>
Expand All @@ -49,6 +43,12 @@ def dump_as_dict(instance: object) -> dict:
def dump_as_list(instance: Iterable[~ModelT]) -> list:
...
```

### Changes

| Version | Change |
|---------|--------|
| 0.100.0 | Made public |
<!-- === OK_EDIT: pkg-ext dump_as_list_def === -->
<!-- === DO_NOT_EDIT: pkg-ext dump_as_str_def === -->
<a id="dump_as_str_def"></a>
Expand All @@ -64,4 +64,10 @@ def dump_as_str(instance: object, format: FileFormat | str) -> str:

>>> dump_as_str('', "json")
''

### Changes

| Version | Change |
|---------|--------|
| 0.100.0 | Made public |
<!-- === OK_EDIT: pkg-ext dump_as_str_def === -->
51 changes: 37 additions & 14 deletions docs/fields/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
<!-- === OK_EDIT: pkg-ext header === -->

<!-- === DO_NOT_EDIT: pkg-ext symbols === -->
- [`BaseModelT`](#basemodelt_def)
- [`UtcDatetime`](#utcdatetime_def)
- [`UtcDatetimeMs`](#utcdatetimems_def)
- [`copy_and_validate`](#copy_and_validate_def)
Expand All @@ -28,6 +27,12 @@
def copy_and_validate(model: ~BaseModelT, **updates) -> ~BaseModelT:
...
```

### Changes

| Version | Change |
|---------|--------|
| 0.100.0 | Made public |
<!-- === OK_EDIT: pkg-ext copy_and_validate_def === -->
<!-- === DO_NOT_EDIT: pkg-ext env_var_name_def === -->
<a id="env_var_name_def"></a>
Expand All @@ -40,6 +45,12 @@ def copy_and_validate(model: ~BaseModelT, **updates) -> ~BaseModelT:
def env_var_name(settings: BaseSettings | type[BaseSettings], field_name: str) -> str:
...
```

### Changes

| Version | Change |
|---------|--------|
| 0.100.0 | Made public |
<!-- === OK_EDIT: pkg-ext env_var_name_def === -->
<!-- === DO_NOT_EDIT: pkg-ext env_var_names_def === -->
<a id="env_var_names_def"></a>
Expand All @@ -52,6 +63,12 @@ def env_var_name(settings: BaseSettings | type[BaseSettings], field_name: str) -
def env_var_names(settings: BaseSettings | type[BaseSettings]) -> list[str]:
...
```

### Changes

| Version | Change |
|---------|--------|
| 0.100.0 | Made public |
<!-- === OK_EDIT: pkg-ext env_var_names_def === -->
<!-- === DO_NOT_EDIT: pkg-ext field_names_def === -->
<a id="field_names_def"></a>
Expand All @@ -64,6 +81,12 @@ def env_var_names(settings: BaseSettings | type[BaseSettings]) -> list[str]:
def field_names(model_type: type[BaseModel] | BaseModel) -> list[str]:
...
```

### Changes

| Version | Change |
|---------|--------|
| 0.100.0 | Made public |
<!-- === OK_EDIT: pkg-ext field_names_def === -->
<!-- === DO_NOT_EDIT: pkg-ext utcdatetime_def === -->
<a id="utcdatetime_def"></a>
Expand All @@ -73,8 +96,14 @@ def field_names(model_type: type[BaseModel] | BaseModel) -> list[str]:
> **Since:** 0.101.0

```python
UtcDatetime = typing.Annotated[<class 'datetime.datetime'>, AfterValidator(func=ensure_timezone)]
UtcDatetime = typing.Annotated[<class 'datetime.datetime'>, AfterValidator(func=<function ensure_timezone>)]
```

### Changes

| Version | Change |
|---------|--------|
| 0.101.0 | Made public |
<!-- === OK_EDIT: pkg-ext utcdatetime_def === -->
<!-- === DO_NOT_EDIT: pkg-ext utcdatetimems_def === -->
<a id="utcdatetimems_def"></a>
Expand All @@ -84,18 +113,12 @@ UtcDatetime = typing.Annotated[<class 'datetime.datetime'>, AfterValidator(func=
> **Since:** 0.101.0

```python
UtcDatetimeMs = typing.Annotated[<class 'datetime.datetime'>, AfterValidator(func=as_ms_precision_utc)]
UtcDatetimeMs = typing.Annotated[<class 'datetime.datetime'>, AfterValidator(func=<function as_ms_precision_utc>)]
```
<!-- === OK_EDIT: pkg-ext utcdatetimems_def === -->

<!-- === DO_NOT_EDIT: pkg-ext basemodelt_def === -->
<a id="basemodelt_def"></a>

### type_alias: `BaseModelT`
- [source](../../model_lib/pydantic_utils.py)
> **Since:** 0.100.0
### Changes

```python
BaseModelT = ~BaseModelT
```
<!-- === OK_EDIT: pkg-ext basemodelt_def === -->
| Version | Change |
|---------|--------|
| 0.101.0 | Made public |
<!-- === OK_EDIT: pkg-ext utcdatetimems_def === -->
Loading