venv

1 files changed, 81 insertions, 0 deletions

diff --git a/venv/lib/python3.11/site-packages/litestar/_kwargs/parameter_definition.py b/venv/lib/python3.11/site-packages/litestar/_kwargs/parameter_definition.py
new file mode 100644
index 0000000..02b09fc
--- /dev/null
+++ b/venv/lib/python3.11/site-packages/litestar/_kwargs/parameter_definition.py
@@ -0,0 +1,81 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any, NamedTuple
+
+from litestar.enums import ParamType
+from litestar.params import ParameterKwarg
+
+if TYPE_CHECKING:
+    from litestar.typing import FieldDefinition
+
+__all__ = ("ParameterDefinition", "create_parameter_definition", "merge_parameter_sets")
+
+
+class ParameterDefinition(NamedTuple):
+    """Tuple defining a kwarg representing a request parameter."""
+
+    default: Any
+    field_alias: str
+    field_name: str
+    is_required: bool
+    is_sequence: bool
+    param_type: ParamType
+
+
+def create_parameter_definition(
+    field_definition: FieldDefinition,
+    field_name: str,
+    path_parameters: set[str],
+) -> ParameterDefinition:
+    """Create a ParameterDefinition for the given FieldDefinition.
+
+    Args:
+        field_definition: FieldDefinition instance.
+        field_name: The field's name.
+        path_parameters: A set of path parameter names.
+
+    Returns:
+        A ParameterDefinition tuple.
+    """
+    default = field_definition.default if field_definition.has_default else None
+    kwarg_definition = (
+        field_definition.kwarg_definition if isinstance(field_definition.kwarg_definition, ParameterKwarg) else None
+    )
+
+    field_alias = kwarg_definition.query if kwarg_definition and kwarg_definition.query else field_name
+    param_type = ParamType.QUERY
+
+    if field_name in path_parameters:
+        field_alias = field_name
+        param_type = ParamType.PATH
+    elif kwarg_definition and kwarg_definition.header:
+        field_alias = kwarg_definition.header
+        param_type = ParamType.HEADER
+    elif kwarg_definition and kwarg_definition.cookie:
+        field_alias = kwarg_definition.cookie
+        param_type = ParamType.COOKIE
+
+    return ParameterDefinition(
+        param_type=param_type,
+        field_name=field_name,
+        field_alias=field_alias,
+        default=default,
+        is_required=field_definition.is_required
+        and default is None
+        and not field_definition.is_optional
+        and not field_definition.is_any,
+        is_sequence=field_definition.is_non_string_sequence,
+    )
+
+
+def merge_parameter_sets(first: set[ParameterDefinition], second: set[ParameterDefinition]) -> set[ParameterDefinition]:
+    """Given two sets of parameter definitions, coming from different dependencies for example, merge them into a single
+    set.
+    """
+    result: set[ParameterDefinition] = first.intersection(second)
+    difference = first.symmetric_difference(second)
+    for param in difference:
+        # add the param if it's either required or no-other param in difference is the same but required
+        if param.is_required or not any(p.field_alias == param.field_alias and p.is_required for p in difference):
+            result.add(param)
+    return result