Skip to content

Commit a2b8e2f

Browse files
authored
Merge pull request #148 from bymoye/result-as-tuple
change result and more optimizations
2 parents ee26552 + 5bf59e2 commit a2b8e2f

File tree

10 files changed

+319
-197
lines changed

10 files changed

+319
-197
lines changed

docs/components/results.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,9 @@ Currently there are two results:
1414
### Result
1515

1616
#### Parameters
17+
1718
- `custom_decoders`: custom decoders for unsupported types. [Read more](/usage/types/advanced_type_usage.md)
18-
- `as_tuple`: return result as a tuple instead of dict.
19+
- `as_tuple`: Headless tuple output
1920

2021
Get the result as a list of dicts
2122

@@ -32,14 +33,15 @@ async def main() -> None:
3233
list_dict_result: List[Dict[str, Any]] = query_result.result()
3334

3435
# Result as tuple
35-
list_tuple_result: List[Tuple[Tuple[str, typing.Any], ...]] = query_result.result(
36+
list_tuple_result: List[Tuple[str, typing.Any], ...] = query_result.result(
3637
as_tuple=True,
3738
)
3839
```
3940

4041
### As class
4142

4243
#### Parameters
44+
4345
- `as_class`: Custom class from Python.
4446
- `custom_decoders`: custom decoders for unsupported types. [Read more](/usage/types/advanced_type_usage.md)
4547

@@ -68,6 +70,7 @@ async def main() -> None:
6870
### Row Factory
6971

7072
#### Parameters
73+
7174
- `row_factory`: custom callable object.
7275
- `custom_decoders`: custom decoders for unsupported types. [Read more](/usage/types/advanced_type_usage.md)
7376

@@ -78,8 +81,9 @@ async def main() -> None:
7881
### Result
7982

8083
#### Parameters
84+
8185
- `custom_decoders`: custom decoders for unsupported types. [Read more](/usage/types/advanced_type_usage.md)
82-
- `as_tuple`: return result as a tuple instead of dict.
86+
- `as_tuple`: Headless tuple output
8387

8488
Get the result as a dict
8589

@@ -96,14 +100,15 @@ async def main() -> None:
96100
dict_result: Dict[str, Any] = query_result.result()
97101

98102
# Result as tuple
99-
tuple_result: Tuple[Tuple[str, typing.Any], ...] = query_result.result(
103+
tuple_result: Tuple[str, typing.Any] = query_result.result(
100104
as_tuple=True,
101105
)
102106
```
103107

104108
### As class
105109

106110
#### Parameters
111+
107112
- `as_class`: Custom class from Python.
108113
- `custom_decoders`: custom decoders for unsupported types. [Read more](/usage/types/advanced_type_usage.md)
109114

@@ -131,6 +136,7 @@ async def main() -> None:
131136
### Row Factory
132137

133138
#### Parameters
139+
134140
- `row_factory`: custom callable object.
135141
- `custom_decoders`: custom decoders for unsupported types. [Read more](/usage/types/advanced_type_usage.md)
136142

0 commit comments

Comments
 (0)