Skip to content

Commit

Permalink
Changes:
Browse files Browse the repository at this point in the history
- document typing support
  • Loading branch information
devkral committed Nov 15, 2024
1 parent 7d9b52c commit 7e9c3bc
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions docs/specials.md
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,34 @@ settings = cast("EdgySettings", SettingsForward())

__all__ = ["settings"]

```


## Typings

Monkay is fully typed and its main class Monkay is a Generic supporting 2 type parameters:

`INSTANCE` and `SETTINGS`



```python
from pydantic_settings import BaseSettings
from monkay import Monkay

class Instance: ...


class Settings(BaseSettings): ...


# type Monkay more strict
monkay = Monkay[Instance, Settings](
globals(),
# provide settings object via class
settings_path=Settings,
)



```

0 comments on commit 7e9c3bc

Please sign in to comment.