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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
|
"""Code for interacting with Django settings."""
from typing import Optional, cast
from django.conf import settings
from typing_extensions import TypedDict
class StrawberryDjangoSettings(TypedDict):
"""Dictionary defining the shape `settings.STRAWBERRY_DJANGO` should have.
All settings are optional and have defaults as described in their docstrings and
defined in `DEFAULT_DJANGO_SETTINGS`.
"""
#: If True, field descriptions will be fetched from the
#: corresponding model field's `help_text` attribute.
FIELD_DESCRIPTION_FROM_HELP_TEXT: bool
#: If True, type descriptions will be fetched from the
#: corresponding model model's docstring.
TYPE_DESCRIPTION_FROM_MODEL_DOCSTRING: bool
#: If True, fields with `choices` will have automatically generate
#: an enum of possibilities instead of being exposed as `String`
GENERATE_ENUMS_FROM_CHOICES: bool
#: Set a custom default name for CUD mutations input type.
MUTATIONS_DEFAULT_ARGUMENT_NAME: str
#: If True, mutations will default to handling django errors by default
#: when no option is passed to the field itself.
MUTATIONS_DEFAULT_HANDLE_ERRORS: bool
#: If True, `auto` fields that refer to model ids will be mapped to
#: `relay.GlobalID` instead of `strawberry.ID` for types and filters.
MAP_AUTO_ID_AS_GLOBAL_ID: bool
#: Set a primary key default field name for Django CRUD resolvers.
DEFAULT_PK_FIELD_NAME: str
#: If True, deprecated way of using filters will be working
USE_DEPRECATED_FILTERS: bool
#: The default limit for pagination when not provided. Can be set to `None`
#: to set it to unlimited.
PAGINATION_DEFAULT_LIMIT: Optional[int]
#: If True, filters used in mutations can be omitted
ALLOW_MUTATIONS_WITHOUT_FILTERS: bool
DEFAULT_DJANGO_SETTINGS = StrawberryDjangoSettings(
FIELD_DESCRIPTION_FROM_HELP_TEXT=False,
TYPE_DESCRIPTION_FROM_MODEL_DOCSTRING=False,
GENERATE_ENUMS_FROM_CHOICES=False,
MUTATIONS_DEFAULT_ARGUMENT_NAME="data",
MUTATIONS_DEFAULT_HANDLE_ERRORS=False,
MAP_AUTO_ID_AS_GLOBAL_ID=False,
DEFAULT_PK_FIELD_NAME="pk",
USE_DEPRECATED_FILTERS=False,
PAGINATION_DEFAULT_LIMIT=100,
ALLOW_MUTATIONS_WITHOUT_FILTERS=False,
)
def strawberry_django_settings() -> StrawberryDjangoSettings:
"""Get strawberry django settings.
Return the dictionary from `settings.STRAWBERRY_DJANGO`, with defaults
for missing keys.
Preferred to direct access for the type hints and defaults.
"""
defaults = DEFAULT_DJANGO_SETTINGS
return cast(
"StrawberryDjangoSettings",
{**defaults, **getattr(settings, "STRAWBERRY_DJANGO", {})},
)
|
