Skip to content

Commit c63a7fe

Browse files
add missing import for format_context_trace, update docs
1 parent 54adc3c commit c63a7fe

File tree

3 files changed

+10
-11
lines changed

3 files changed

+10
-11
lines changed

databind.core/src/databind/core/__init__.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
__version__ = "4.2.8"
22

3-
from .context import Context, Direction, Location
3+
from .context import Context, Direction, Location, format_context_trace
44
from .converter import ConversionError, Converter, DelegateToClassmethodConverter, Module, NoMatchingConverter
55
from .mapper import ObjectMapper
66
from .schema import Schema, convert_dataclass_to_schema, convert_to_schema, convert_typed_dict_to_schema
@@ -44,6 +44,7 @@
4444
"Direction",
4545
"ExtraKeys",
4646
"Flattened",
47+
"format_context_trace",
4748
"get_annotation_setting",
4849
"get_class_setting",
4950
"get_class_settings",

docs/content/core/basic-usage.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,7 @@ from dataclasses import dataclass
1212
from urllib.parse import urlparse
1313
from typing import Any
1414

15-
from databind.core.context import Context
16-
from databind.core.converter import Converter
15+
from databind.core import Context, Converter
1716

1817

1918
@dataclass
@@ -44,7 +43,7 @@ class URI:
4443
To use this new converter, you need to register it to an {@pylink databind.core.mapper.ObjectMapper} instance.
4544

4645
```python
47-
from databind.core.mapper import ObjectMapper
46+
from databind.core import ObjectMapper
4847

4948
mapper = ObjectMapper()
5049
mapper.module.register(URI.URIConverter())
@@ -65,7 +64,7 @@ convenient methods to access settings that are relevant for the current value be
6564

6665
```python
6766
# ...
68-
from databind.core.settings import BooleanSetting
67+
from databind.core import BooleanSetting
6968

7069

7170
@dataclass
@@ -100,7 +99,7 @@ The setting can now be specified when serializing a `URI` instance as a global s
10099
```python
101100
# ...
102101

103-
from databind.core.converter import NoMatchingConverter
102+
from databind.core import NoMatchingConverter
104103
from pytest import raises
105104

106105
# When the setting is not enabled, the converter raises a NotImplementedError, having databind search for

docs/content/json/examples/unknown-keys.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ When using this setting, you can also record any unexpected keys so you can repo
1111
```py
1212
# cat <<EOF | python -
1313
from dataclasses import dataclass
14-
from databind.core.settings import ExtraKeys
14+
from databind.core import ExtraKeys
1515
from databind.json import load
1616

1717
@ExtraKeys()
@@ -31,7 +31,7 @@ assert load({"a": 42, "b": "ignored"}, MyClass) == MyClass(42)
3131
```py
3232
# cat <<EOF | python -
3333
from dataclasses import dataclass
34-
from databind.core.settings import ExtraKeys
34+
from databind.core import ExtraKeys
3535
from databind.json import load
3636
from typing_extensions import Annotated
3737

@@ -63,7 +63,7 @@ except for those that have a different setting "closer by" (you can use `ExtraKe
6363
```py
6464
# cat <<EOF | python -
6565
from dataclasses import dataclass
66-
from databind.core.settings import ExtraKeys
66+
from databind.core import ExtraKeys
6767
from databind.json import load
6868

6969
@dataclass
@@ -81,8 +81,7 @@ warn about unused keys in a payload.
8181
```py
8282
# cat <<EOF | python -
8383
from dataclasses import dataclass
84-
from databind.core.settings import ExtraKeys
85-
from databind.core.context import format_context_trace
84+
from databind.core import format_context_trace, ExtraKeys
8685
from databind.json import load
8786

8887
@dataclass

0 commit comments

Comments
 (0)