frameio 0.0.28__py3-none-any.whl

frameio/core/serialization.py

@@ -0,0 +1,276 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import collections
+import inspect
+import typing
+
+import pydantic
+import typing_extensions
+
+
+class FieldMetadata:
+    """
+    Metadata class used to annotate fields to provide additional information.
+
+    Example:
+    class MyDict(TypedDict):
+        field: typing.Annotated[str, FieldMetadata(alias="field_name")]
+
+    Will serialize: `{"field": "value"}`
+    To: `{"field_name": "value"}`
+    """
+
+    alias: str
+
+    def __init__(self, *, alias: str) -> None:
+        self.alias = alias
+
+
+def convert_and_respect_annotation_metadata(
+    *,
+    object_: typing.Any,
+    annotation: typing.Any,
+    inner_type: typing.Optional[typing.Any] = None,
+    direction: typing.Literal["read", "write"],
+) -> typing.Any:
+    """
+    Respect the metadata annotations on a field, such as aliasing. This function effectively
+    manipulates the dict-form of an object to respect the metadata annotations. This is primarily used for
+    TypedDicts, which cannot support aliasing out of the box, and can be extended for additional
+    utilities, such as defaults.
+
+    Parameters
+    ----------
+    object_ : typing.Any
+
+    annotation : type
+        The type we're looking to apply typing annotations from
+
+    inner_type : typing.Optional[type]
+
+    Returns
+    -------
+    typing.Any
+    """
+
+    if object_ is None:
+        return None
+    if inner_type is None:
+        inner_type = annotation
+
+    clean_type = _remove_annotations(inner_type)
+    # Pydantic models
+    if (
+        inspect.isclass(clean_type)
+        and issubclass(clean_type, pydantic.BaseModel)
+        and isinstance(object_, typing.Mapping)
+    ):
+        return _convert_mapping(object_, clean_type, direction)
+    # TypedDicts
+    if typing_extensions.is_typeddict(clean_type) and isinstance(object_, typing.Mapping):
+        return _convert_mapping(object_, clean_type, direction)
+
+    if (
+        typing_extensions.get_origin(clean_type) == typing.Dict
+        or typing_extensions.get_origin(clean_type) == dict
+        or clean_type == typing.Dict
+    ) and isinstance(object_, typing.Dict):
+        key_type = typing_extensions.get_args(clean_type)[0]
+        value_type = typing_extensions.get_args(clean_type)[1]
+
+        return {
+            key: convert_and_respect_annotation_metadata(
+                object_=value,
+                annotation=annotation,
+                inner_type=value_type,
+                direction=direction,
+            )
+            for key, value in object_.items()
+        }
+
+    # If you're iterating on a string, do not bother to coerce it to a sequence.
+    if not isinstance(object_, str):
+        if (
+            typing_extensions.get_origin(clean_type) == typing.Set
+            or typing_extensions.get_origin(clean_type) == set
+            or clean_type == typing.Set
+        ) and isinstance(object_, typing.Set):
+            inner_type = typing_extensions.get_args(clean_type)[0]
+            return {
+                convert_and_respect_annotation_metadata(
+                    object_=item,
+                    annotation=annotation,
+                    inner_type=inner_type,
+                    direction=direction,
+                )
+                for item in object_
+            }
+        elif (
+            (
+                typing_extensions.get_origin(clean_type) == typing.List
+                or typing_extensions.get_origin(clean_type) == list
+                or clean_type == typing.List
+            )
+            and isinstance(object_, typing.List)
+        ) or (
+            (
+                typing_extensions.get_origin(clean_type) == typing.Sequence
+                or typing_extensions.get_origin(clean_type) == collections.abc.Sequence
+                or clean_type == typing.Sequence
+            )
+            and isinstance(object_, typing.Sequence)
+        ):
+            inner_type = typing_extensions.get_args(clean_type)[0]
+            return [
+                convert_and_respect_annotation_metadata(
+                    object_=item,
+                    annotation=annotation,
+                    inner_type=inner_type,
+                    direction=direction,
+                )
+                for item in object_
+            ]
+
+    if typing_extensions.get_origin(clean_type) == typing.Union:
+        # We should be able to ~relatively~ safely try to convert keys against all
+        # member types in the union, the edge case here is if one member aliases a field
+        # of the same name to a different name from another member
+        # Or if another member aliases a field of the same name that another member does not.
+        for member in typing_extensions.get_args(clean_type):
+            object_ = convert_and_respect_annotation_metadata(
+                object_=object_,
+                annotation=annotation,
+                inner_type=member,
+                direction=direction,
+            )
+        return object_
+
+    annotated_type = _get_annotation(annotation)
+    if annotated_type is None:
+        return object_
+
+    # If the object is not a TypedDict, a Union, or other container (list, set, sequence, etc.)
+    # Then we can safely call it on the recursive conversion.
+    return object_
+
+
+def _convert_mapping(
+    object_: typing.Mapping[str, object],
+    expected_type: typing.Any,
+    direction: typing.Literal["read", "write"],
+) -> typing.Mapping[str, object]:
+    converted_object: typing.Dict[str, object] = {}
+    try:
+        annotations = typing_extensions.get_type_hints(expected_type, include_extras=True)
+    except NameError:
+        # The TypedDict contains a circular reference, so
+        # we use the __annotations__ attribute directly.
+        annotations = getattr(expected_type, "__annotations__", {})
+    aliases_to_field_names = _get_alias_to_field_name(annotations)
+    for key, value in object_.items():
+        if direction == "read" and key in aliases_to_field_names:
+            dealiased_key = aliases_to_field_names.get(key)
+            if dealiased_key is not None:
+                type_ = annotations.get(dealiased_key)
+        else:
+            type_ = annotations.get(key)
+        # Note you can't get the annotation by the field name if you're in read mode, so you must check the aliases map
+        #
+        # So this is effectively saying if we're in write mode, and we don't have a type, or if we're in read mode and we don't have an alias
+        # then we can just pass the value through as is
+        if type_ is None:
+            converted_object[key] = value
+        elif direction == "read" and key not in aliases_to_field_names:
+            converted_object[key] = convert_and_respect_annotation_metadata(
+                object_=value, annotation=type_, direction=direction
+            )
+        else:
+            converted_object[_alias_key(key, type_, direction, aliases_to_field_names)] = (
+                convert_and_respect_annotation_metadata(object_=value, annotation=type_, direction=direction)
+            )
+    return converted_object
+
+
+def _get_annotation(type_: typing.Any) -> typing.Optional[typing.Any]:
+    maybe_annotated_type = typing_extensions.get_origin(type_)
+    if maybe_annotated_type is None:
+        return None
+
+    if maybe_annotated_type == typing_extensions.NotRequired:
+        type_ = typing_extensions.get_args(type_)[0]
+        maybe_annotated_type = typing_extensions.get_origin(type_)
+
+    if maybe_annotated_type == typing_extensions.Annotated:
+        return type_
+
+    return None
+
+
+def _remove_annotations(type_: typing.Any) -> typing.Any:
+    maybe_annotated_type = typing_extensions.get_origin(type_)
+    if maybe_annotated_type is None:
+        return type_
+
+    if maybe_annotated_type == typing_extensions.NotRequired:
+        return _remove_annotations(typing_extensions.get_args(type_)[0])
+
+    if maybe_annotated_type == typing_extensions.Annotated:
+        return _remove_annotations(typing_extensions.get_args(type_)[0])
+
+    return type_
+
+
+def get_alias_to_field_mapping(type_: typing.Any) -> typing.Dict[str, str]:
+    annotations = typing_extensions.get_type_hints(type_, include_extras=True)
+    return _get_alias_to_field_name(annotations)
+
+
+def get_field_to_alias_mapping(type_: typing.Any) -> typing.Dict[str, str]:
+    annotations = typing_extensions.get_type_hints(type_, include_extras=True)
+    return _get_field_to_alias_name(annotations)
+
+
+def _get_alias_to_field_name(
+    field_to_hint: typing.Dict[str, typing.Any],
+) -> typing.Dict[str, str]:
+    aliases = {}
+    for field, hint in field_to_hint.items():
+        maybe_alias = _get_alias_from_type(hint)
+        if maybe_alias is not None:
+            aliases[maybe_alias] = field
+    return aliases
+
+
+def _get_field_to_alias_name(
+    field_to_hint: typing.Dict[str, typing.Any],
+) -> typing.Dict[str, str]:
+    aliases = {}
+    for field, hint in field_to_hint.items():
+        maybe_alias = _get_alias_from_type(hint)
+        if maybe_alias is not None:
+            aliases[field] = maybe_alias
+    return aliases
+
+
+def _get_alias_from_type(type_: typing.Any) -> typing.Optional[str]:
+    maybe_annotated_type = _get_annotation(type_)
+
+    if maybe_annotated_type is not None:
+        # The actual annotations are 1 onward, the first is the annotated type
+        annotations = typing_extensions.get_args(maybe_annotated_type)[1:]
+
+        for annotation in annotations:
+            if isinstance(annotation, FieldMetadata) and annotation.alias is not None:
+                return annotation.alias
+    return None
+
+
+def _alias_key(
+    key: str,
+    type_: typing.Any,
+    direction: typing.Literal["read", "write"],
+    aliases_to_field_names: typing.Dict[str, str],
+) -> str:
+    if direction == "read":
+        return aliases_to_field_names.get(key, key)
+    return _get_alias_from_type(type_=type_) or key

frameio/core/unchecked_base_model.py

@@ -0,0 +1,376 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import inspect
+import typing
+import uuid
+
+import pydantic
+import typing_extensions
+from .pydantic_utilities import (
+    IS_PYDANTIC_V2,
+    ModelField,
+    UniversalBaseModel,
+    get_args,
+    get_origin,
+    is_literal_type,
+    is_union,
+    parse_date,
+    parse_datetime,
+    parse_obj_as,
+)
+from .serialization import get_field_to_alias_mapping
+from pydantic_core import PydanticUndefined
+
+
+class UnionMetadata:
+    discriminant: str
+
+    def __init__(self, *, discriminant: str) -> None:
+        self.discriminant = discriminant
+
+
+Model = typing.TypeVar("Model", bound=pydantic.BaseModel)
+
+
+class UncheckedBaseModel(UniversalBaseModel):
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow")  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            extra = pydantic.Extra.allow
+
+    @classmethod
+    def model_construct(
+        cls: typing.Type["Model"],
+        _fields_set: typing.Optional[typing.Set[str]] = None,
+        **values: typing.Any,
+    ) -> "Model":
+        # Fallback construct function to the specified override below.
+        return cls.construct(_fields_set=_fields_set, **values)
+
+    # Allow construct to not validate model
+    # Implementation taken from: https://github.com/pydantic/pydantic/issues/1168#issuecomment-817742836
+    @classmethod
+    def construct(
+        cls: typing.Type["Model"],
+        _fields_set: typing.Optional[typing.Set[str]] = None,
+        **values: typing.Any,
+    ) -> "Model":
+        m = cls.__new__(cls)
+        fields_values = {}
+
+        if _fields_set is None:
+            _fields_set = set(values.keys())
+
+        fields = _get_model_fields(cls)
+        populate_by_name = _get_is_populate_by_name(cls)
+        field_aliases = get_field_to_alias_mapping(cls)
+
+        for name, field in fields.items():
+            # Key here is only used to pull data from the values dict
+            # you should always use the NAME of the field to for field_values, etc.
+            # because that's how the object is constructed from a pydantic perspective
+            key = field.alias
+            if (key is None or field.alias == name) and name in field_aliases:
+                key = field_aliases[name]
+
+            if key is None or (key not in values and populate_by_name):  # Added this to allow population by field name
+                key = name
+
+            if key in values:
+                if IS_PYDANTIC_V2:
+                    type_ = field.annotation  # type: ignore # Pydantic v2
+                else:
+                    type_ = typing.cast(typing.Type, field.outer_type_)  # type: ignore # Pydantic < v1.10.15
+
+                fields_values[name] = (
+                    construct_type(object_=values[key], type_=type_) if type_ is not None else values[key]
+                )
+                _fields_set.add(name)
+            else:
+                default = _get_field_default(field)
+                fields_values[name] = default
+
+                # If the default values are non-null act like they've been set
+                # This effectively allows exclude_unset to work like exclude_none where
+                # the latter passes through intentionally set none values.
+                if default != None and default != PydanticUndefined:
+                    _fields_set.add(name)
+
+        # Add extras back in
+        extras = {}
+        pydantic_alias_fields = [field.alias for field in fields.values()]
+        internal_alias_fields = list(field_aliases.values())
+        for key, value in values.items():
+            # If the key is not a field by name, nor an alias to a field, then it's extra
+            if (key not in pydantic_alias_fields and key not in internal_alias_fields) and key not in fields:
+                if IS_PYDANTIC_V2:
+                    extras[key] = value
+                else:
+                    _fields_set.add(key)
+                    fields_values[key] = value
+
+        object.__setattr__(m, "__dict__", fields_values)
+
+        if IS_PYDANTIC_V2:
+            object.__setattr__(m, "__pydantic_private__", None)
+            object.__setattr__(m, "__pydantic_extra__", extras)
+            object.__setattr__(m, "__pydantic_fields_set__", _fields_set)
+        else:
+            object.__setattr__(m, "__fields_set__", _fields_set)
+            m._init_private_attributes()  # type: ignore # Pydantic v1
+        return m
+
+
+def _validate_collection_items_compatible(collection: typing.Any, target_type: typing.Type[typing.Any]) -> bool:
+    """
+    Validate that all items in a collection are compatible with the target type.
+
+    Args:
+        collection: The collection to validate (list, set, or dict values)
+        target_type: The target type to validate against
+
+    Returns:
+        True if all items are compatible, False otherwise
+    """
+    if inspect.isclass(target_type) and issubclass(target_type, pydantic.BaseModel):
+        for item in collection:
+            try:
+                # Try to validate the item against the target type
+                if isinstance(item, dict):
+                    parse_obj_as(target_type, item)
+                else:
+                    # If it's not a dict, it might already be the right type
+                    if not isinstance(item, target_type):
+                        return False
+            except Exception:
+                return False
+    return True
+
+
+def _convert_undiscriminated_union_type(union_type: typing.Type[typing.Any], object_: typing.Any) -> typing.Any:
+    inner_types = get_args(union_type)
+    if typing.Any in inner_types:
+        return object_
+
+    for inner_type in inner_types:
+        # Handle lists of objects that need parsing
+        if get_origin(inner_type) is list and isinstance(object_, list):
+            list_inner_type = get_args(inner_type)[0]
+            try:
+                if inspect.isclass(list_inner_type) and issubclass(list_inner_type, pydantic.BaseModel):
+                    # Validate that all items in the list are compatible with the target type
+                    if _validate_collection_items_compatible(object_, list_inner_type):
+                        parsed_list = [parse_obj_as(object_=item, type_=list_inner_type) for item in object_]
+                        return parsed_list
+            except Exception:
+                pass
+
+        try:
+            if inspect.isclass(inner_type) and issubclass(inner_type, pydantic.BaseModel):
+                # Attempt a validated parse until one works
+                return parse_obj_as(inner_type, object_)
+        except Exception:
+            continue
+
+    # If none of the types work, try matching literal fields first, then fall back
+    # First pass: try types where all literal fields match the object's values
+    for inner_type in inner_types:
+        if inspect.isclass(inner_type) and issubclass(inner_type, pydantic.BaseModel):
+            fields = _get_model_fields(inner_type)
+            literal_fields_match = True
+
+            for field_name, field in fields.items():
+                # Check if this field has a Literal type
+                if IS_PYDANTIC_V2:
+                    field_type = field.annotation  # type: ignore # Pydantic v2
+                else:
+                    field_type = field.outer_type_  # type: ignore # Pydantic v1
+
+                if is_literal_type(field_type):  # type: ignore[arg-type]
+                    field_default = _get_field_default(field)
+                    name_or_alias = get_field_to_alias_mapping(inner_type).get(field_name, field_name)
+                    # Get the value from the object
+                    if isinstance(object_, dict):
+                        object_value = object_.get(name_or_alias)
+                    else:
+                        object_value = getattr(object_, name_or_alias, None)
+
+                    # If the literal field value doesn't match, this type is not a match
+                    if object_value is not None and field_default != object_value:
+                        literal_fields_match = False
+                        break
+
+            # If all literal fields match, try to construct this type
+            if literal_fields_match:
+                try:
+                    return construct_type(object_=object_, type_=inner_type)
+                except Exception:
+                    continue
+
+    # Second pass: if no literal matches, just return the first successful cast
+    for inner_type in inner_types:
+        try:
+            return construct_type(object_=object_, type_=inner_type)
+        except Exception:
+            continue
+
+
+def _convert_union_type(type_: typing.Type[typing.Any], object_: typing.Any) -> typing.Any:
+    base_type = get_origin(type_) or type_
+    union_type = type_
+    if base_type == typing_extensions.Annotated:  # type: ignore[comparison-overlap]
+        union_type = get_args(type_)[0]
+        annotated_metadata = get_args(type_)[1:]
+        for metadata in annotated_metadata:
+            if isinstance(metadata, UnionMetadata):
+                try:
+                    # Cast to the correct type, based on the discriminant
+                    for inner_type in get_args(union_type):
+                        try:
+                            objects_discriminant = getattr(object_, metadata.discriminant)
+                        except:
+                            objects_discriminant = object_[metadata.discriminant]
+                        if inner_type.__fields__[metadata.discriminant].default == objects_discriminant:
+                            return construct_type(object_=object_, type_=inner_type)
+                except Exception:
+                    # Allow to fall through to our regular union handling
+                    pass
+    return _convert_undiscriminated_union_type(union_type, object_)
+
+
+def construct_type(*, type_: typing.Type[typing.Any], object_: typing.Any) -> typing.Any:
+    """
+    Here we are essentially creating the same `construct` method in spirit as the above, but for all types, not just
+    Pydantic models.
+    The idea is to essentially attempt to coerce object_ to type_ (recursively)
+    """
+    # Short circuit when dealing with optionals, don't try to coerces None to a type
+    if object_ is None:
+        return None
+
+    base_type = get_origin(type_) or type_
+    is_annotated = base_type == typing_extensions.Annotated  # type: ignore[comparison-overlap]
+    maybe_annotation_members = get_args(type_)
+    is_annotated_union = is_annotated and is_union(get_origin(maybe_annotation_members[0]))
+
+    if base_type == typing.Any:  # type: ignore[comparison-overlap]
+        return object_
+
+    if base_type == dict:
+        if not isinstance(object_, typing.Mapping):
+            return object_
+
+        key_type, items_type = get_args(type_)
+        d = {
+            construct_type(object_=key, type_=key_type): construct_type(object_=item, type_=items_type)
+            for key, item in object_.items()
+        }
+        return d
+
+    if base_type == list:
+        if not isinstance(object_, list):
+            return object_
+
+        inner_type = get_args(type_)[0]
+        return [construct_type(object_=entry, type_=inner_type) for entry in object_]
+
+    if base_type == set:
+        if not isinstance(object_, set) and not isinstance(object_, list):
+            return object_
+
+        inner_type = get_args(type_)[0]
+        return {construct_type(object_=entry, type_=inner_type) for entry in object_}
+
+    if is_union(base_type) or is_annotated_union:
+        return _convert_union_type(type_, object_)
+
+    # Cannot do an `issubclass` with a literal type, let's also just confirm we have a class before this call
+    if (
+        object_ is not None
+        and not is_literal_type(type_)
+        and (
+            (inspect.isclass(base_type) and issubclass(base_type, pydantic.BaseModel))
+            or (
+                is_annotated
+                and inspect.isclass(maybe_annotation_members[0])
+                and issubclass(maybe_annotation_members[0], pydantic.BaseModel)
+            )
+        )
+    ):
+        if IS_PYDANTIC_V2:
+            return type_.model_construct(**object_)
+        else:
+            return type_.construct(**object_)
+
+    if base_type == dt.datetime:
+        try:
+            return parse_datetime(object_)
+        except Exception:
+            return object_
+
+    if base_type == dt.date:
+        try:
+            return parse_date(object_)
+        except Exception:
+            return object_
+
+    if base_type == uuid.UUID:
+        try:
+            return uuid.UUID(object_)
+        except Exception:
+            return object_
+
+    if base_type == int:
+        try:
+            return int(object_)
+        except Exception:
+            return object_
+
+    if base_type == bool:
+        try:
+            if isinstance(object_, str):
+                stringified_object = object_.lower()
+                return stringified_object == "true" or stringified_object == "1"
+
+            return bool(object_)
+        except Exception:
+            return object_
+
+    return object_
+
+
+def _get_is_populate_by_name(model: typing.Type["Model"]) -> bool:
+    if IS_PYDANTIC_V2:
+        return model.model_config.get("populate_by_name", False)  # type: ignore # Pydantic v2
+    return model.__config__.allow_population_by_field_name  # type: ignore # Pydantic v1
+
+
+PydanticField = typing.Union[ModelField, pydantic.fields.FieldInfo]
+
+
+# Pydantic V1 swapped the typing of __fields__'s values from ModelField to FieldInfo
+# And so we try to handle both V1 cases, as well as V2 (FieldInfo from model.model_fields)
+def _get_model_fields(
+    model: typing.Type["Model"],
+) -> typing.Mapping[str, PydanticField]:
+    if IS_PYDANTIC_V2:
+        return model.model_fields  # type: ignore # Pydantic v2
+    else:
+        return model.__fields__  # type: ignore # Pydantic v1
+
+
+def _get_field_default(field: PydanticField) -> typing.Any:
+    try:
+        value = field.get_default()  # type: ignore # Pydantic < v1.10.15
+    except:
+        value = field.default
+    if IS_PYDANTIC_V2:
+        from pydantic_core import PydanticUndefined
+
+        if value == PydanticUndefined:
+            return None
+        return value
+    return value

frameio/environment.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+
+
+class FrameioEnvironment(enum.Enum):
+    DEFAULT = "https://api.frame.io"