# pylint: disable=line-too-long,useless-suppression,too-many-lines
# coding=utf-8
# --------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# Code generated by Microsoft (R) Python Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
# --------------------------------------------------------------------------
# pylint: disable=protected-access, broad-except

import copy
import calendar
import decimal
import functools
import sys
import logging
import base64
import re
import typing
import enum
import email.utils
from datetime import datetime, date, time, timedelta, timezone
from json import JSONEncoder
import xml.etree.ElementTree as ET
from collections.abc import MutableMapping
import isodate
from azure.core.exceptions import DeserializationError
from azure.core import CaseInsensitiveEnumMeta
from azure.core.pipeline import PipelineResponse
from azure.core.serialization import _Null

from azure.core.rest import HttpResponse

if sys.version_info >= (3, 11):
    from typing import Self
else:
    from typing_extensions import Self

_LOGGER = logging.getLogger(__name__)

__all__ = ["SdkJSONEncoder", "Model", "rest_field", "rest_discriminator"]

TZ_UTC = timezone.utc
_T = typing.TypeVar("_T")
_NONE_TYPE = type(None)


def _timedelta_as_isostr(td: timedelta) -> str:
    """Converts a datetime.timedelta object into an ISO 8601 formatted string, e.g. 'P4DT12H30M05S'

    Function adapted from the Tin Can Python project: https://github.com/RusticiSoftware/TinCanPython

    :param timedelta td: The timedelta to convert
    :rtype: str
    :return: ISO8601 version of this timedelta
    """

    # Split seconds to larger units
    seconds = td.total_seconds()
    minutes, seconds = divmod(seconds, 60)
    hours, minutes = divmod(minutes, 60)
    days, hours = divmod(hours, 24)

    days, hours, minutes = list(map(int, (days, hours, minutes)))
    seconds = round(seconds, 6)

    # Build date
    date_str = ""
    if days:
        date_str = "%sD" % days

    if hours or minutes or seconds:
        # Build time
        time_str = "T"

        # Hours
        bigger_exists = date_str or hours
        if bigger_exists:
            time_str += "{:02}H".format(hours)

        # Minutes
        bigger_exists = bigger_exists or minutes
        if bigger_exists:
            time_str += "{:02}M".format(minutes)

        # Seconds
        try:
            if seconds.is_integer():
                seconds_string = "{:02}".format(int(seconds))
            else:
                # 9 chars long w/ leading 0, 6 digits after decimal
                seconds_string = "%09.6f" % seconds
                # Remove trailing zeros
                seconds_string = seconds_string.rstrip("0")
        except AttributeError:  # int.is_integer() raises
            seconds_string = "{:02}".format(seconds)

        time_str += "{}S".format(seconds_string)
    else:
        time_str = ""

    return "P" + date_str + time_str


def _serialize_bytes(o, format: typing.Optional[str] = None) -> str:
    encoded = base64.b64encode(o).decode()
    if format == "base64url":
        return encoded.strip("=").replace("+", "-").replace("/", "_")
    return encoded


def _serialize_duration(td: timedelta, format: typing.Optional[str] = None):
    """Serialize a timedelta to its wire representation.

    For the ``seconds``/``milliseconds`` encodings the value is converted to a
    numeric value, otherwise it falls back to an ISO 8601 duration string.

    :param timedelta td: The timedelta to serialize.
    :param str format: The duration encoding format.
    :rtype: int or float or str
    :return: serialized duration
    """
    seconds = td.total_seconds()
    if format == "duration-seconds-int":
        return int(seconds)
    if format == "duration-seconds-float":
        return seconds
    if format == "duration-milliseconds-int":
        return int(seconds * 1000)
    if format == "duration-milliseconds-float":
        return seconds * 1000
    return _timedelta_as_isostr(td)


def _serialize_datetime(o, format: typing.Optional[str] = None):
    if hasattr(o, "year") and hasattr(o, "hour"):
        if format == "rfc7231":
            return email.utils.format_datetime(o, usegmt=True)
        if format == "unix-timestamp":
            return int(calendar.timegm(o.utctimetuple()))

        # astimezone() fails for naive times in Python 2.7, so make make sure o is aware (tzinfo is set)
        if not o.tzinfo:
            iso_formatted = o.replace(tzinfo=TZ_UTC).isoformat()
        else:
            iso_formatted = o.astimezone(TZ_UTC).isoformat()
        # Replace the trailing "+00:00" UTC offset with "Z" (RFC 3339: https://www.ietf.org/rfc/rfc3339.txt)
        return iso_formatted.replace("+00:00", "Z")
    # Next try datetime.date or datetime.time
    return o.isoformat()


def _is_readonly(p):
    try:
        return p._visibility == ["read"]
    except AttributeError:
        return False


class SdkJSONEncoder(JSONEncoder):
    """A JSON encoder that's capable of serializing datetime objects and bytes."""

    def __init__(self, *args, exclude_readonly: bool = False, format: typing.Optional[str] = None, **kwargs):
        super().__init__(*args, **kwargs)
        self.exclude_readonly = exclude_readonly
        self.format = format

    def default(self, o):  # pylint: disable=too-many-return-statements
        if _is_model(o):
            if self.exclude_readonly:
                readonly_props = [p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p)]
                return {k: v for k, v in o.items() if k not in readonly_props}
            return dict(o.items())
        try:
            return super(SdkJSONEncoder, self).default(o)
        except TypeError:
            if isinstance(o, _Null):
                return None
            if isinstance(o, decimal.Decimal):
                return float(o)
            if isinstance(o, (bytes, bytearray)):
                return _serialize_bytes(o, self.format)
            try:
                # First try datetime.datetime
                return _serialize_datetime(o, self.format)
            except AttributeError:
                pass
            # Last, try datetime.timedelta
            try:
                return _timedelta_as_isostr(o)
            except AttributeError:
                # This will be raised when it hits value.total_seconds in the method above
                pass
            return super(SdkJSONEncoder, self).default(o)


_VALID_DATE = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" + r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?")
_VALID_RFC7231 = re.compile(
    r"(Mon|Tue|Wed|Thu|Fri|Sat|Sun),\s\d{2}\s"
    r"(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\s\d{4}\s\d{2}:\d{2}:\d{2}\sGMT"
)

_ARRAY_ENCODE_MAPPING = {
    "pipeDelimited": "|",
    "spaceDelimited": " ",
    "commaDelimited": ",",
    "newlineDelimited": "\n",
}


def _deserialize_array_encoded(delimit: str, attr):
    if isinstance(attr, str):
        if attr == "":
            return []
        return attr.split(delimit)
    return attr


def _deserialize_datetime(attr: typing.Union[str, datetime]) -> datetime:
    """Deserialize ISO-8601 formatted string into Datetime object.

    :param str attr: response string to be deserialized.
    :rtype: ~datetime.datetime
    :returns: The datetime object from that input
    """
    if isinstance(attr, datetime):
        # i'm already deserialized
        return attr
    attr = attr.upper()
    match = _VALID_DATE.match(attr)
    if not match:
        raise ValueError("Invalid datetime string: " + attr)

    check_decimal = attr.split(".")
    if len(check_decimal) > 1:
        decimal_str = ""
        for digit in check_decimal[1]:
            if digit.isdigit():
                decimal_str += digit
            else:
                break
        if len(decimal_str) > 6:
            attr = attr.replace(decimal_str, decimal_str[0:6])

    date_obj = isodate.parse_datetime(attr)
    test_utc = date_obj.utctimetuple()
    if test_utc.tm_year > 9999 or test_utc.tm_year < 1:
        raise OverflowError("Hit max or min date")
    return date_obj  # type: ignore[no-any-return]


def _deserialize_datetime_rfc7231(attr: typing.Union[str, datetime]) -> datetime:
    """Deserialize RFC7231 formatted string into Datetime object.

    :param str attr: response string to be deserialized.
    :rtype: ~datetime.datetime
    :returns: The datetime object from that input
    """
    if isinstance(attr, datetime):
        # i'm already deserialized
        return attr
    match = _VALID_RFC7231.match(attr)
    if not match:
        raise ValueError("Invalid datetime string: " + attr)

    return email.utils.parsedate_to_datetime(attr)


def _deserialize_datetime_unix_timestamp(attr: typing.Union[float, datetime]) -> datetime:
    """Deserialize unix timestamp into Datetime object.

    :param str attr: response string to be deserialized.
    :rtype: ~datetime.datetime
    :returns: The datetime object from that input
    """
    if isinstance(attr, datetime):
        # i'm already deserialized
        return attr
    return datetime.fromtimestamp(attr, TZ_UTC)


def _deserialize_date(attr: typing.Union[str, date]) -> date:
    """Deserialize ISO-8601 formatted string into Date object.
    :param str attr: response string to be deserialized.
    :rtype: date
    :returns: The date object from that input
    """
    # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception.
    if isinstance(attr, date):
        return attr
    return isodate.parse_date(attr, defaultmonth=None, defaultday=None)  # type: ignore


def _deserialize_time(attr: typing.Union[str, time]) -> time:
    """Deserialize ISO-8601 formatted string into time object.

    :param str attr: response string to be deserialized.
    :rtype: datetime.time
    :returns: The time object from that input
    """
    if isinstance(attr, time):
        return attr
    return isodate.parse_time(attr)  # type: ignore[no-any-return]


def _deserialize_bytes(attr):
    if isinstance(attr, (bytes, bytearray)):
        return attr
    return bytes(base64.b64decode(attr))


def _deserialize_bytes_base64(attr):
    if isinstance(attr, (bytes, bytearray)):
        return attr
    padding = "=" * (3 - (len(attr) + 3) % 4)  # type: ignore
    attr = attr + padding  # type: ignore
    encoded = attr.replace("-", "+").replace("_", "/")
    return bytes(base64.b64decode(encoded))


def _deserialize_duration(attr):
    if isinstance(attr, timedelta):
        return attr
    return isodate.parse_duration(attr)


def _deserialize_duration_numeric(attr, unit):
    if isinstance(attr, timedelta):
        return attr
    return timedelta(**{unit: float(attr)})


def _deserialize_decimal(attr):
    if isinstance(attr, decimal.Decimal):
        return attr
    return decimal.Decimal(str(attr))


def _deserialize_int_as_str(attr):
    if isinstance(attr, int):
        return attr
    return int(attr)


_DESERIALIZE_MAPPING = {
    datetime: _deserialize_datetime,
    date: _deserialize_date,
    time: _deserialize_time,
    bytes: _deserialize_bytes,
    bytearray: _deserialize_bytes,
    timedelta: _deserialize_duration,
    typing.Any: lambda x: x,
    decimal.Decimal: _deserialize_decimal,
}

_DESERIALIZE_MAPPING_WITHFORMAT = {
    "rfc3339": _deserialize_datetime,
    "rfc7231": _deserialize_datetime_rfc7231,
    "unix-timestamp": _deserialize_datetime_unix_timestamp,
    "base64": _deserialize_bytes,
    "base64url": _deserialize_bytes_base64,
    "duration-seconds-int": functools.partial(_deserialize_duration_numeric, unit="seconds"),
    "duration-seconds-float": functools.partial(_deserialize_duration_numeric, unit="seconds"),
    "duration-milliseconds-int": functools.partial(_deserialize_duration_numeric, unit="milliseconds"),
    "duration-milliseconds-float": functools.partial(_deserialize_duration_numeric, unit="milliseconds"),
}


def get_deserializer(annotation: typing.Any, rf: typing.Optional["_RestField"] = None):
    if annotation is int and rf and rf._format == "str":
        return _deserialize_int_as_str
    if annotation is str and rf and rf._format in _ARRAY_ENCODE_MAPPING:
        return functools.partial(_deserialize_array_encoded, _ARRAY_ENCODE_MAPPING[rf._format])
    if rf and rf._format:
        return _DESERIALIZE_MAPPING_WITHFORMAT.get(rf._format)
    return _DESERIALIZE_MAPPING.get(annotation)  # pyright: ignore


def _get_type_alias_type(module_name: str, alias_name: str):
    types = {
        k: v
        for k, v in sys.modules[module_name].__dict__.items()
        if isinstance(v, typing._GenericAlias)  # type: ignore
    }
    if alias_name not in types:
        return alias_name
    return types[alias_name]


def _get_model(module_name: str, model_name: str):
    models = {k: v for k, v in sys.modules[module_name].__dict__.items() if isinstance(v, type)}
    module_end = module_name.rsplit(".", 1)[0]
    models.update({k: v for k, v in sys.modules[module_end].__dict__.items() if isinstance(v, type)})
    if isinstance(model_name, str):
        model_name = model_name.split(".")[-1]
    if model_name not in models:
        return model_name
    return models[model_name]


_UNSET = object()


class _MyMutableMapping(MutableMapping[str, typing.Any]):
    def __init__(self, data: dict[str, typing.Any]) -> None:
        self._data = data

    def __contains__(self, key: typing.Any) -> bool:
        return key in self._data

    def __getitem__(self, key: str) -> typing.Any:
        # If this key has been deserialized (for mutable types), we need to handle serialization
        if hasattr(self, "_attr_to_rest_field"):
            cache_attr = f"_deserialized_{key}"
            if hasattr(self, cache_attr):
                rf = _get_rest_field(getattr(self, "_attr_to_rest_field"), key)
                if rf:
                    value = self._data.get(key)
                    if isinstance(value, (dict, list, set)):
                        # For mutable types, serialize and return
                        # But also update _data with serialized form and clear flag
                        # so mutations via this returned value affect _data
                        serialized = _serialize(value, rf._format)
                        # If serialized form is same type (no transformation needed),
                        # return _data directly so mutations work
                        if isinstance(serialized, type(value)) and serialized == value:
                            return self._data.get(key)
                        # Otherwise return serialized copy and clear flag
                        try:
                            object.__delattr__(self, cache_attr)
                        except AttributeError:
                            pass
                        # Store serialized form back
                        self._data[key] = serialized
                        return serialized
        return self._data.__getitem__(key)

    def __setitem__(self, key: str, value: typing.Any) -> None:
        # Clear any cached deserialized value when setting through dictionary access
        cache_attr = f"_deserialized_{key}"
        try:
            object.__delattr__(self, cache_attr)
        except AttributeError:
            pass
        self._data.__setitem__(key, value)

    def __delitem__(self, key: str) -> None:
        self._data.__delitem__(key)

    def __iter__(self) -> typing.Iterator[typing.Any]:
        return self._data.__iter__()

    def __len__(self) -> int:
        return self._data.__len__()

    def __ne__(self, other: typing.Any) -> bool:
        return not self.__eq__(other)

    def keys(self) -> typing.KeysView[str]:
        """
        :returns: a set-like object providing a view on the mapping's keys
        :rtype: ~typing.KeysView
        """
        return self._data.keys()

    def values(self) -> typing.ValuesView[typing.Any]:
        """
        :returns: an object providing a view on the mapping's values
        :rtype: ~typing.ValuesView
        """
        return self._data.values()

    def items(self) -> typing.ItemsView[str, typing.Any]:
        """
        :returns: a set-like object providing a view on the mapping's items
        :rtype: ~typing.ItemsView
        """
        return self._data.items()

    def get(self, key: str, default: typing.Any = None) -> typing.Any:
        """
        Get the value for key if key is in the dictionary, else default.
        :param str key: The key to look up.
        :param any default: The value to return if key is not in the dictionary. Defaults to None
        :returns: The value for key if key is in the dictionary, else default.
        :rtype: any
        """
        try:
            return self[key]
        except KeyError:
            return default

    @typing.overload
    def pop(self, key: str) -> typing.Any: ...  # pylint: disable=arguments-differ

    @typing.overload
    def pop(self, key: str, default: _T) -> _T: ...  # pylint: disable=signature-differs

    @typing.overload
    def pop(self, key: str, default: typing.Any) -> typing.Any: ...  # pylint: disable=signature-differs

    def pop(self, key: str, default: typing.Any = _UNSET) -> typing.Any:
        """
        Removes specified key and return the corresponding value.
        :param str key: The key to pop.
        :param any default: The value to return if key is not in the dictionary
        :returns: The value corresponding to the key.
        :rtype: any
        :raises KeyError: If key is not found and default is not given.
        """
        if default is _UNSET:
            return self._data.pop(key)
        return self._data.pop(key, default)

    def popitem(self) -> tuple[str, typing.Any]:
        """
        Removes and returns some (key, value) pair
        :returns: The (key, value) pair.
        :rtype: tuple
        :raises KeyError: if the dictionary is empty.
        """
        return self._data.popitem()

    def clear(self) -> None:
        """
        Remove all items from the dictionary.
        """
        self._data.clear()

    def update(self, *args: typing.Any, **kwargs: typing.Any) -> None:  # pylint: disable=arguments-differ
        """
        Update the dictionary from a mapping or an iterable of key-value pairs.
        :param any args: Either a mapping object or an iterable of key-value pairs.
        """
        self._data.update(*args, **kwargs)

    @typing.overload
    def setdefault(self, key: str, default: None = None) -> None: ...

    @typing.overload
    def setdefault(self, key: str, default: typing.Any) -> typing.Any: ...  # pylint: disable=signature-differs

    def setdefault(self, key: str, default: typing.Any = _UNSET) -> typing.Any:
        """
        Return the value for key if key is in the dictionary; otherwise set the key to
        default and return default.
        :param str key: The key to look up.
        :param any default: The value to set if key is not in the dictionary
        :returns: The value for key if key is in the dictionary, else default.
        :rtype: any
        """
        if default is _UNSET:
            return self._data.setdefault(key)
        return self._data.setdefault(key, default)

    def __eq__(self, other: typing.Any) -> bool:
        if isinstance(other, _MyMutableMapping):
            return self._data == other._data
        try:
            other_model = self.__class__(other)
        except Exception:
            return False
        return self._data == other_model._data

    def __repr__(self) -> str:
        return str(self._data)


def _is_model(obj: typing.Any) -> bool:
    return getattr(obj, "_is_model", False)


def _serialize(o, format: typing.Optional[str] = None):  # pylint: disable=too-many-return-statements
    if isinstance(o, list):
        if format in _ARRAY_ENCODE_MAPPING and all(isinstance(x, str) for x in o):
            return _ARRAY_ENCODE_MAPPING[format].join(o)
        return [_serialize(x, format) for x in o]
    if isinstance(o, dict):
        return {k: _serialize(v, format) for k, v in o.items()}
    if isinstance(o, set):
        return {_serialize(x, format) for x in o}
    if isinstance(o, tuple):
        return tuple(_serialize(x, format) for x in o)
    if isinstance(o, (bytes, bytearray)):
        return _serialize_bytes(o, format)
    if isinstance(o, decimal.Decimal):
        return float(o)
    if isinstance(o, enum.Enum):
        return o.value
    if isinstance(o, int):
        if format == "str":
            return str(o)
        return o
    try:
        # First try datetime.datetime
        return _serialize_datetime(o, format)
    except AttributeError:
        pass
    # Last, try datetime.timedelta
    try:
        return _serialize_duration(o, format)
    except AttributeError:
        # This will be raised when it hits value.total_seconds in the method above
        pass
    return o


def _get_rest_field(attr_to_rest_field: dict[str, "_RestField"], rest_name: str) -> typing.Optional["_RestField"]:
    try:
        return next(rf for rf in attr_to_rest_field.values() if rf._rest_name == rest_name)
    except StopIteration:
        return None


def _create_value(rf: typing.Optional["_RestField"], value: typing.Any) -> typing.Any:
    if not rf:
        return _serialize(value, None)
    if rf._is_multipart_file_input:
        return value
    if rf._is_model:
        return _deserialize(rf._type, value)
    if isinstance(value, ET.Element):
        value = _deserialize(rf._type, value)
    return _serialize(value, rf._format)


# ============================================================================
# Fast-path scalar deserializer functions for rest_field(deserializer=...)
# These are referenced from rest_field declarations to bypass the generic
# _deserialize -> _deserialize_with_callable chain.
# Only simple/primitive types — no models or container types.
# ============================================================================


def _xml_deser_str(value):
    if isinstance(value, ET.Element):
        return value.text or ""
    return str(value) if value is not None else None


def _xml_deser_int(value):
    if isinstance(value, ET.Element):
        return int(value.text) if value.text else None
    return int(value) if value is not None else None


def _xml_deser_float(value):
    if isinstance(value, ET.Element):
        return float(value.text) if value.text else None
    return float(value) if value is not None else None


def _xml_deser_bool(value):
    if isinstance(value, ET.Element):
        text = value.text
    else:
        text = value
    if text is None:
        return None
    if text in (True, False):
        return text
    return text.lower() == "true"


# pylint: disable=docstring-missing-param
def _xml_deser_bytes(value):
    """Deserialize bytes from XML (base64)."""
    if isinstance(value, ET.Element):
        text = value.text
    else:
        text = value
    if text is None:
        return None
    return _deserialize_bytes(text)


def _xml_deser_bytes_base64url(value):
    """Deserialize bytes from XML (base64url)."""
    if isinstance(value, ET.Element):
        text = value.text
    else:
        text = value
    if text is None:
        return None
    return _deserialize_bytes_base64(text)


def _xml_deser_datetime(value):
    """Deserialize a datetime from XML (ISO 8601 / rfc3339)."""
    if isinstance(value, ET.Element):
        text = value.text
    else:
        text = value
    if text is None:
        return None
    return _deserialize_datetime(text)


def _xml_deser_datetime_rfc7231(value):
    """Deserialize a datetime from XML (RFC7231 format)."""
    if isinstance(value, ET.Element):
        text = value.text
    else:
        text = value
    if text is None:
        return None
    return _deserialize_datetime_rfc7231(text)


def _xml_deser_datetime_unix_timestamp(value):
    """Deserialize a datetime from XML (Unix timestamp)."""
    if isinstance(value, ET.Element):
        text = value.text
    else:
        text = value
    if text is None:
        return None
    return _deserialize_datetime_unix_timestamp(float(text))


def _xml_deser_date(value):
    """Deserialize a date from XML (ISO 8601)."""
    if isinstance(value, ET.Element):
        text = value.text
    else:
        text = value
    if text is None:
        return None
    return _deserialize_date(text)


def _xml_deser_time(value):
    """Deserialize a time from XML (ISO 8601)."""
    if isinstance(value, ET.Element):
        text = value.text
    else:
        text = value
    if text is None:
        return None
    return _deserialize_time(text)


def _xml_deser_duration(value):
    """Deserialize a timedelta from XML (ISO 8601 duration)."""
    if isinstance(value, ET.Element):
        text = value.text
    else:
        text = value
    if text is None:
        return None
    return _deserialize_duration(text)


def _xml_deser_decimal(value):
    """Deserialize a Decimal from XML."""
    if isinstance(value, ET.Element):
        text = value.text
    else:
        text = value
    if text is None:
        return None
    return _deserialize_decimal(text)


def _xml_deser_enum_or_str(enum_cls, value):
    """Deserialize a Union[EnumType, str] from XML."""
    text = value.text if isinstance(value, ET.Element) else value
    if text is None:
        return None
    try:
        return enum_cls(text)
    except ValueError:
        return text


def _extract_xml_model_type(rf_type):
    """Extract the concrete Model class from a resolved rf._type partial chain.

    Unwraps ``Optional[Model]`` and ``_deserialize_model(Model, ...)``
    wrappers.  Only handles Model and Optional[Model] — other composite
    types (List, Dict, Union, etc.) return None and fall through to the
    generic ``_deserialize`` path at runtime.
    """
    if rf_type is None:
        return None
    if isinstance(rf_type, type) and _is_model(rf_type):
        return rf_type
    if not isinstance(rf_type, functools.partial):
        return None
    func = rf_type.func
    args = rf_type.args
    if func is _deserialize_with_optional and args:
        return _extract_xml_model_type(args[0])
    if func is _deserialize_model and args:
        cls = args[0]
        return cls if isinstance(cls, type) and _is_model(cls) else None
    return None


def _build_xml_field_plan(  # pylint: disable=docstring-missing-return, docstring-missing-rtype, unused-variable
    cls, attr_to_rest_field: dict
) -> list:
    """Build a precomputed XML field plan for fast _init_from_xml iteration.

    Called once per model class in __new__. Returns a list of tuples:
        (rest_name, xml_name, kind, deser, rf_type, is_optional, items_name)

    kind: 0=wrapped, 1=attribute, 2=unwrapped, 3=text

    For Model and Optional[Model] fields that lack a scalar
    ``_deserializer``, this function precomputes the Model class as the
    deserializer so ``_init_from_xml`` can call ``ModelClass(element)``
    directly instead of going through the expensive
    ``_get_deserialize_callable_from_annotation`` chain at runtime.
    """
    model_meta = getattr(cls, "_xml", {})
    model_ns = model_meta.get("ns") or model_meta.get("namespace")
    plan = []

    for rf in attr_to_rest_field.values():
        prop_meta = getattr(rf, "_xml", {})
        deser = rf._deserializer

        xml_name = prop_meta.get("name", rf._rest_name)
        xml_ns = _resolve_xml_ns(prop_meta, model_meta)
        if xml_ns:
            xml_name = "{" + xml_ns + "}" + xml_name

        is_optional = rf._is_optional

        # For Model / Optional[Model] fields without a scalar deserializer,
        # precompute the Model class as the deserializer.
        if deser is None and rf._type is not None:
            model_cls = _extract_xml_model_type(rf._type)
            if model_cls is not None:
                deser = model_cls

        if prop_meta.get("attribute", False):
            plan.append((rf._rest_name, xml_name, 1, deser, rf._type, is_optional, None))
        elif prop_meta.get("unwrapped", False):
            items_name = prop_meta.get("itemsName")
            if items_name:
                items_ns = prop_meta.get("itemsNs")
                if items_ns is not None:
                    xml_ns = items_ns
                if xml_ns:
                    items_name = "{" + xml_ns + "}" + items_name
            else:
                items_name = xml_name
            plan.append((rf._rest_name, xml_name, 2, deser, rf._type, is_optional, items_name))
        elif prop_meta.get("text", False):
            plan.append((rf._rest_name, xml_name, 3, deser, rf._type, is_optional, None))
        else:
            plan.append((rf._rest_name, xml_name, 0, deser, rf._type, is_optional, None))

    return plan


# pylint: enable=docstring-missing-param
class Model(_MyMutableMapping):
    _is_model = True
    # label whether current class's _attr_to_rest_field has been calculated
    # could not see _attr_to_rest_field directly because subclass inherits it from parent class
    _calculated: set[str] = set()

    def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None:
        class_name = self.__class__.__name__
        if len(args) > 1:
            raise TypeError(f"{class_name}.__init__() takes 2 positional arguments but {len(args) + 1} were given")
        dict_to_pass: dict[str, typing.Any] = {}
        if args:
            if isinstance(args[0], ET.Element):
                dict_to_pass.update(self._init_from_xml(args[0]))
            else:
                dict_to_pass.update(
                    {k: _create_value(_get_rest_field(self._attr_to_rest_field, k), v) for k, v in args[0].items()}
                )
        else:
            non_attr_kwargs = [k for k in kwargs if k not in self._attr_to_rest_field]
            if non_attr_kwargs:
                # actual type errors only throw the first wrong keyword arg they see, so following that.
                raise TypeError(f"{class_name}.__init__() got an unexpected keyword argument '{non_attr_kwargs[0]}'")
            dict_to_pass.update(
                {
                    self._attr_to_rest_field[k]._rest_name: _create_value(self._attr_to_rest_field[k], v)
                    for k, v in kwargs.items()
                    if v is not None
                }
            )
        # Apply client default values for fields the caller didn't set so that
        # defaults are part of `_data` and therefore included during serialization.
        for rf in self._attr_to_rest_field.values():
            if rf._default is _UNSET:
                continue
            if rf._rest_name in dict_to_pass:
                continue
            dict_to_pass[rf._rest_name] = _create_value(rf, rf._default)
        super().__init__(dict_to_pass)

    def _init_from_xml(  # pylint: disable=too-many-branches, too-many-statements
        self, element: ET.Element
    ) -> dict[str, typing.Any]:
        """Deserialize an XML element into a dict mapping rest field names to values.

        :param ET.Element element: The XML element to deserialize from.
        :returns: A dictionary of rest_name to deserialized value pairs.
        :rtype: dict
        """
        result: dict[str, typing.Any] = {}
        existed_attr_keys: list[str] = []

        field_plan = getattr(self, "_xml_field_plan", None)
        if field_plan:
            for rest_name, xml_name, kind, deser, rf_type, is_optional, items_name in field_plan:
                if kind == 0:  # wrapped element (most common)
                    item = element.find(xml_name)
                    if item is not None:
                        existed_attr_keys.append(xml_name)
                        if deser:
                            result[rest_name] = deser(item)
                        else:
                            result[rest_name] = _deserialize(rf_type, item)
                elif kind == 1:  # attribute
                    attr_val = element.get(xml_name)
                    if attr_val is not None:
                        existed_attr_keys.append(xml_name)
                        if deser:
                            result[rest_name] = deser(attr_val)
                        else:
                            result[rest_name] = attr_val
                elif kind == 2:  # unwrapped array
                    items = element.findall(items_name)  # pyright: ignore
                    if len(items) > 0:
                        existed_attr_keys.append(items_name)
                        if deser:
                            result[rest_name] = deser(items)
                        else:
                            result[rest_name] = _deserialize(rf_type, items)
                    elif not is_optional:
                        existed_attr_keys.append(items_name)
                        result[rest_name] = []
                elif kind == 3:  # text
                    if element.text is not None:
                        if deser:
                            result[rest_name] = deser(element.text)
                        else:
                            result[rest_name] = element.text
        else:
            model_meta = getattr(self, "_xml", {})
            for rf in self._attr_to_rest_field.values():
                prop_meta = getattr(rf, "_xml", {})
                xml_name = prop_meta.get("name", rf._rest_name)
                xml_ns = _resolve_xml_ns(prop_meta, model_meta)
                if xml_ns:
                    xml_name = "{" + xml_ns + "}" + xml_name

                # attribute
                if prop_meta.get("attribute", False) and element.get(xml_name) is not None:
                    existed_attr_keys.append(xml_name)
                    result[rf._rest_name] = _deserialize(rf._type, element.get(xml_name))
                    continue

                # unwrapped element is array
                if prop_meta.get("unwrapped", False):
                    _items_name = prop_meta.get("itemsName")
                    if _items_name:
                        xml_name = _items_name
                        _items_ns = prop_meta.get("itemsNs")
                        if _items_ns is not None:
                            xml_ns = _items_ns
                        if xml_ns:
                            xml_name = "{" + xml_ns + "}" + xml_name
                    items = element.findall(xml_name)  # pyright: ignore
                    if len(items) > 0:
                        existed_attr_keys.append(xml_name)
                        result[rf._rest_name] = _deserialize(rf._type, items)
                    elif not rf._is_optional:
                        existed_attr_keys.append(xml_name)
                        result[rf._rest_name] = []
                    continue

                # text element is primitive type
                if prop_meta.get("text", False):
                    if element.text is not None:
                        result[rf._rest_name] = _deserialize(rf._type, element.text)
                    continue

                # wrapped element could be normal property or array
                item = element.find(xml_name)
                if item is not None:
                    existed_attr_keys.append(xml_name)
                    result[rf._rest_name] = _deserialize(rf._type, item)

        # rest thing is additional properties
        for e in element:
            if e.tag not in existed_attr_keys:
                result[e.tag] = _convert_element(e)

        return result

    def copy(self) -> "Model":
        return Model(self.__dict__)

    def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> Self:
        if f"{cls.__module__}.{cls.__qualname__}" not in cls._calculated:
            # we know the last nine classes in mro are going to be 'Model', '_MyMutableMapping', 'MutableMapping',
            # 'Mapping', 'Collection', 'Sized', 'Iterable', 'Container' and 'object'
            mros = cls.__mro__[:-9][::-1]  # ignore parents, and reverse the mro order
            attr_to_rest_field: dict[str, _RestField] = {  # map attribute name to rest_field property
                k: v for mro_class in mros for k, v in mro_class.__dict__.items() if k[0] != "_" and hasattr(v, "_type")
            }
            annotations = {
                k: v
                for mro_class in mros
                if hasattr(mro_class, "__annotations__")
                for k, v in mro_class.__annotations__.items()
            }
            for attr, rf in attr_to_rest_field.items():
                rf._module = cls.__module__
                if not rf._type:
                    rf._type = rf._get_deserialize_callable_from_annotation(annotations.get(attr, None))
                if not rf._rest_name_input:
                    rf._rest_name_input = attr
            cls._attr_to_rest_field: dict[str, _RestField] = dict(attr_to_rest_field.items())
            # Build XML field plan for fast _init_from_xml (only for XML models)
            if getattr(cls, "_xml", None):
                cls._xml_field_plan = _build_xml_field_plan(cls, attr_to_rest_field)
            cls._calculated.add(f"{cls.__module__}.{cls.__qualname__}")

        return super().__new__(cls)

    def __init_subclass__(cls, discriminator: typing.Optional[str] = None) -> None:
        for base in cls.__bases__:
            if hasattr(base, "__mapping__"):
                base.__mapping__[discriminator or cls.__name__] = cls  # type: ignore

    @classmethod
    def _get_discriminator(cls, exist_discriminators) -> typing.Optional["_RestField"]:
        for v in cls.__dict__.values():
            if isinstance(v, _RestField) and v._is_discriminator and v._rest_name not in exist_discriminators:
                return v
        return None

    @classmethod
    def _deserialize(cls, data, exist_discriminators):
        if not hasattr(cls, "__mapping__"):
            return cls(data)
        discriminator = cls._get_discriminator(exist_discriminators)
        if discriminator is None:
            return cls(data)
        exist_discriminators.append(discriminator._rest_name)
        if isinstance(data, ET.Element):
            model_meta = getattr(cls, "_xml", {})
            prop_meta = getattr(discriminator, "_xml", {})
            xml_name = prop_meta.get("name", discriminator._rest_name)
            xml_ns = _resolve_xml_ns(prop_meta, model_meta)
            if xml_ns:
                xml_name = "{" + xml_ns + "}" + xml_name

            if data.get(xml_name) is not None:
                discriminator_value = data.get(xml_name)
            else:
                discriminator_value = data.find(xml_name).text  # pyright: ignore
        else:
            discriminator_value = data.get(discriminator._rest_name)
        mapped_cls = cls.__mapping__.get(discriminator_value, cls)  # pyright: ignore # pylint: disable=no-member
        return mapped_cls._deserialize(data, exist_discriminators)

    def as_dict(self, *, exclude_readonly: bool = False) -> dict[str, typing.Any]:
        """Return a dict that can be turned into json using json.dump.

        :keyword bool exclude_readonly: Whether to remove the readonly properties.
        :returns: A dict JSON compatible object
        :rtype: dict
        """

        result = {}
        readonly_props = []
        if exclude_readonly:
            readonly_props = [p._rest_name for p in self._attr_to_rest_field.values() if _is_readonly(p)]
        for k, v in self.items():
            if exclude_readonly and k in readonly_props:  # pyright: ignore
                continue
            is_multipart_file_input = False
            try:
                is_multipart_file_input = next(
                    rf for rf in self._attr_to_rest_field.values() if rf._rest_name == k
                )._is_multipart_file_input
            except StopIteration:
                pass
            result[k] = v if is_multipart_file_input else Model._as_dict_value(v, exclude_readonly=exclude_readonly)
        return result

    @staticmethod
    def _as_dict_value(v: typing.Any, exclude_readonly: bool = False) -> typing.Any:
        if v is None or isinstance(v, _Null):
            return None
        if isinstance(v, (list, tuple, set)):
            return type(v)(Model._as_dict_value(x, exclude_readonly=exclude_readonly) for x in v)
        if isinstance(v, dict):
            return {dk: Model._as_dict_value(dv, exclude_readonly=exclude_readonly) for dk, dv in v.items()}
        return v.as_dict(exclude_readonly=exclude_readonly) if hasattr(v, "as_dict") else v


def _deserialize_model(model_deserializer: typing.Optional[typing.Callable], obj):
    if _is_model(obj):
        return obj
    return _deserialize(model_deserializer, obj)


def _deserialize_with_optional(if_obj_deserializer: typing.Optional[typing.Callable], obj):
    if obj is None:
        return obj
    return _deserialize_with_callable(if_obj_deserializer, obj)


def _deserialize_with_union(deserializers, obj):
    for deserializer in deserializers:
        try:
            return _deserialize(deserializer, obj)
        except DeserializationError:
            pass
    raise DeserializationError()


def _deserialize_dict(
    value_deserializer: typing.Optional[typing.Callable],
    module: typing.Optional[str],
    obj: dict[typing.Any, typing.Any],
):
    if obj is None:
        return obj
    if isinstance(obj, ET.Element):
        obj = {child.tag: child for child in obj}
    return {k: _deserialize(value_deserializer, v, module) for k, v in obj.items()}


def _deserialize_multiple_sequence(
    entry_deserializers: list[typing.Optional[typing.Callable]],
    module: typing.Optional[str],
    obj,
):
    if obj is None:
        return obj
    return type(obj)(_deserialize(deserializer, entry, module) for entry, deserializer in zip(obj, entry_deserializers))


def _is_array_encoded_deserializer(deserializer: functools.partial) -> bool:
    return (
        isinstance(deserializer, functools.partial)
        and isinstance(deserializer.args[0], functools.partial)
        and deserializer.args[0].func == _deserialize_array_encoded  # pylint: disable=comparison-with-callable
    )


def _deserialize_sequence(
    deserializer: typing.Optional[typing.Callable],
    module: typing.Optional[str],
    obj,
):
    if obj is None:
        return obj
    if isinstance(obj, ET.Element):
        obj = list(obj)

    # encoded string may be deserialized to sequence
    if isinstance(obj, str) and isinstance(deserializer, functools.partial):
        # for list[str]
        if _is_array_encoded_deserializer(deserializer):
            return deserializer(obj)

        # for list[Union[...]]
        if isinstance(deserializer.args[0], list):
            for sub_deserializer in deserializer.args[0]:
                if _is_array_encoded_deserializer(sub_deserializer):
                    return sub_deserializer(obj)

    return type(obj)(_deserialize(deserializer, entry, module) for entry in obj)


def _sorted_annotations(types: list[typing.Any]) -> list[typing.Any]:
    return sorted(
        types,
        key=lambda x: hasattr(x, "__name__") and x.__name__.lower() in ("str", "float", "int", "bool"),
    )


def _get_deserialize_callable_from_annotation(  # pylint: disable=too-many-return-statements, too-many-statements, too-many-branches
    annotation: typing.Any,
    module: typing.Optional[str],
    rf: typing.Optional["_RestField"] = None,
) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]:
    if not annotation:
        return None

    # is it a type alias?
    if isinstance(annotation, str):
        if module is not None:
            annotation = _get_type_alias_type(module, annotation)

    # is it a forward ref / in quotes?
    if isinstance(annotation, (str, typing.ForwardRef)):
        try:
            model_name = annotation.__forward_arg__  # type: ignore
        except AttributeError:
            model_name = annotation
        if module is not None:
            annotation = _get_model(module, model_name)  # type: ignore

    try:
        if module and _is_model(annotation):
            if rf:
                rf._is_model = True

            return functools.partial(_deserialize_model, annotation)  # pyright: ignore
    except Exception:
        pass

    # is it a literal?
    try:
        if annotation.__origin__ is typing.Literal:  # pyright: ignore
            return None
    except AttributeError:
        pass

    # is it optional?
    try:
        if any(a is _NONE_TYPE for a in annotation.__args__):  # pyright: ignore
            if rf:
                rf._is_optional = True
            if len(annotation.__args__) <= 2:  # pyright: ignore
                if_obj_deserializer = _get_deserialize_callable_from_annotation(
                    next(a for a in annotation.__args__ if a is not _NONE_TYPE), module, rf  # pyright: ignore
                )

                return functools.partial(_deserialize_with_optional, if_obj_deserializer)
            # the type is Optional[Union[...]], we need to remove the None type from the Union
            annotation_copy = copy.copy(annotation)
            annotation_copy.__args__ = [a for a in annotation_copy.__args__ if a is not _NONE_TYPE]  # pyright: ignore
            return _get_deserialize_callable_from_annotation(annotation_copy, module, rf)
    except AttributeError:
        pass

    # is it union?
    if getattr(annotation, "__origin__", None) is typing.Union:
        # initial ordering is we make `string` the last deserialization option, because it is often them most generic
        deserializers = [
            _get_deserialize_callable_from_annotation(arg, module, rf)
            for arg in _sorted_annotations(annotation.__args__)  # pyright: ignore
        ]

        return functools.partial(_deserialize_with_union, deserializers)

    try:
        annotation_name = (
            annotation.__name__ if hasattr(annotation, "__name__") else annotation._name  # pyright: ignore
        )
        if annotation_name.lower() == "dict":
            value_deserializer = _get_deserialize_callable_from_annotation(
                annotation.__args__[1], module, rf  # pyright: ignore
            )

            return functools.partial(
                _deserialize_dict,
                value_deserializer,
                module,
            )
    except (AttributeError, IndexError):
        pass
    try:
        annotation_name = (
            annotation.__name__ if hasattr(annotation, "__name__") else annotation._name  # pyright: ignore
        )
        if annotation_name.lower() in ["list", "set", "tuple", "sequence"]:
            if len(annotation.__args__) > 1:  # pyright: ignore
                entry_deserializers = [
                    _get_deserialize_callable_from_annotation(dt, module, rf)
                    for dt in annotation.__args__  # pyright: ignore
                ]
                return functools.partial(_deserialize_multiple_sequence, entry_deserializers, module)
            deserializer = _get_deserialize_callable_from_annotation(
                annotation.__args__[0], module, rf  # pyright: ignore
            )

            return functools.partial(_deserialize_sequence, deserializer, module)
    except (TypeError, IndexError, AttributeError, SyntaxError):
        pass

    def _deserialize_default(
        deserializer,
        obj,
    ):
        if obj is None:
            return obj
        try:
            return _deserialize_with_callable(deserializer, obj)
        except Exception:
            pass
        return obj

    if get_deserializer(annotation, rf):
        return functools.partial(_deserialize_default, get_deserializer(annotation, rf))

    return functools.partial(_deserialize_default, annotation)


def _deserialize_with_callable(
    deserializer: typing.Optional[typing.Callable[[typing.Any], typing.Any]],
    value: typing.Any,
):  # pylint: disable=too-many-return-statements
    try:
        if value is None or isinstance(value, _Null):
            return None
        if isinstance(value, ET.Element):
            if deserializer is str:
                return value.text or ""
            if deserializer is int:
                return int(value.text) if value.text else None
            if deserializer is float:
                return float(value.text) if value.text else None
            if deserializer is bool:
                return value.text == "true" if value.text else None
            if deserializer and deserializer in _DESERIALIZE_MAPPING.values():
                return deserializer(value.text) if value.text else None
            if deserializer and deserializer in _DESERIALIZE_MAPPING_WITHFORMAT.values():
                return deserializer(value.text) if value.text else None
        if deserializer is None:
            return value
        if deserializer in [int, float, bool]:
            return deserializer(value)
        if isinstance(deserializer, CaseInsensitiveEnumMeta):
            try:
                return deserializer(value.text if isinstance(value, ET.Element) else value)
            except ValueError:
                # for unknown value, return raw value
                return value.text if isinstance(value, ET.Element) else value
        if isinstance(deserializer, type) and issubclass(deserializer, Model):
            return deserializer._deserialize(value, [])
        return typing.cast(typing.Callable[[typing.Any], typing.Any], deserializer)(value)
    except Exception as e:
        raise DeserializationError() from e


def _deserialize(
    deserializer: typing.Any,
    value: typing.Any,
    module: typing.Optional[str] = None,
    rf: typing.Optional["_RestField"] = None,
    format: typing.Optional[str] = None,
) -> typing.Any:
    if isinstance(value, PipelineResponse):
        value = value.http_response.json()
    if rf is None and format:
        rf = _RestField(format=format)
    if not isinstance(deserializer, functools.partial):
        deserializer = _get_deserialize_callable_from_annotation(deserializer, module, rf)
    return _deserialize_with_callable(deserializer, value)


def _failsafe_deserialize(
    deserializer: typing.Any,
    response: HttpResponse,
    module: typing.Optional[str] = None,
    rf: typing.Optional["_RestField"] = None,
    format: typing.Optional[str] = None,
) -> typing.Any:
    try:
        return _deserialize(deserializer, response.json(), module, rf, format)
    except Exception:  # pylint: disable=broad-except
        _LOGGER.warning(
            "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True
        )
        return None


def _failsafe_deserialize_xml(
    deserializer: typing.Any,
    response: HttpResponse,
) -> typing.Any:
    try:
        return _deserialize_xml(deserializer, response.text())
    except Exception:  # pylint: disable=broad-except
        _LOGGER.warning(
            "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True
        )
        return None


# pylint: disable=too-many-instance-attributes
class _RestField:
    def __init__(
        self,
        *,
        name: typing.Optional[str] = None,
        type: typing.Optional[typing.Callable] = None,  # pylint: disable=redefined-builtin
        is_discriminator: bool = False,
        visibility: typing.Optional[list[str]] = None,
        default: typing.Any = _UNSET,
        format: typing.Optional[str] = None,
        is_multipart_file_input: bool = False,
        xml: typing.Optional[dict[str, typing.Any]] = None,
        deserializer: typing.Optional[typing.Callable] = None,
    ):
        self._type = type
        self._rest_name_input = name
        self._module: typing.Optional[str] = None
        self._is_discriminator = is_discriminator
        self._visibility = visibility
        self._is_model = False
        self._is_optional = False
        self._default = default
        self._format = format
        self._is_multipart_file_input = is_multipart_file_input
        self._xml = xml if xml is not None else {}
        self._deserializer = deserializer

    @property
    def _class_type(self) -> typing.Any:
        result = getattr(self._type, "args", [None])[0]
        # type may be wrapped by nested functools.partial so we need to check for that
        if isinstance(result, functools.partial):
            return getattr(result, "args", [None])[0]
        return result

    @property
    def _rest_name(self) -> str:
        if self._rest_name_input is None:
            raise ValueError("Rest name was never set")
        return self._rest_name_input

    def __get__(self, obj: Model, type=None):  # pylint: disable=redefined-builtin
        # by this point, type and rest_name will have a value bc we default
        # them in __new__ of the Model class
        # Use _data.get() directly to avoid triggering __getitem__ which clears the cache
        item = obj._data.get(self._rest_name, _UNSET)
        if item is _UNSET:
            # Field not set by user; return the client default if one exists, otherwise None
            return self._default if self._default is not _UNSET else None
        if item is None:
            return item
        if self._is_model:
            return item

        # For mutable types, we want mutations to directly affect _data
        # Check if we've already deserialized this value
        cache_attr = f"_deserialized_{self._rest_name}"
        if hasattr(obj, cache_attr):
            # Return the value from _data directly (it's been deserialized in place)
            return obj._data.get(self._rest_name)

        # Fast path: use _deserializer directly (avoids _serialize/_deserialize chain)
        if self._deserializer:
            deserialized = self._deserializer(item)
        else:
            deserialized = _deserialize(self._type, _serialize(item, self._format), rf=self)

        # For mutable types, store the deserialized value back in _data
        # so mutations directly affect _data
        if isinstance(deserialized, (dict, list, set)):
            obj._data[self._rest_name] = deserialized
            object.__setattr__(obj, cache_attr, True)  # Mark as deserialized
            return deserialized

        return deserialized

    def __set__(self, obj: Model, value) -> None:
        # Clear the cached deserialized object when setting a new value
        cache_attr = f"_deserialized_{self._rest_name}"
        if hasattr(obj, cache_attr):
            object.__delattr__(obj, cache_attr)

        if value is None:
            # we want to wipe out entries if users set attr to None
            try:
                obj.__delitem__(self._rest_name)
            except KeyError:
                pass
            return
        if self._is_model:
            if not _is_model(value):
                value = _deserialize(self._type, value)
            obj.__setitem__(self._rest_name, value)
            return
        obj.__setitem__(self._rest_name, _serialize(value, self._format))

    def _get_deserialize_callable_from_annotation(
        self, annotation: typing.Any
    ) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]:
        return _get_deserialize_callable_from_annotation(annotation, self._module, self)


def rest_field(
    *,
    name: typing.Optional[str] = None,
    type: typing.Optional[typing.Callable] = None,  # pylint: disable=redefined-builtin
    visibility: typing.Optional[list[str]] = None,
    default: typing.Any = _UNSET,
    format: typing.Optional[str] = None,
    is_multipart_file_input: bool = False,
    xml: typing.Optional[dict[str, typing.Any]] = None,
    deserializer: typing.Optional[typing.Callable] = None,
) -> typing.Any:
    return _RestField(
        name=name,
        type=type,
        visibility=visibility,
        default=default,
        format=format,
        is_multipart_file_input=is_multipart_file_input,
        xml=xml,
        deserializer=deserializer,
    )


def rest_discriminator(
    *,
    name: typing.Optional[str] = None,
    type: typing.Optional[typing.Callable] = None,  # pylint: disable=redefined-builtin
    visibility: typing.Optional[list[str]] = None,
    xml: typing.Optional[dict[str, typing.Any]] = None,
) -> typing.Any:
    return _RestField(name=name, type=type, is_discriminator=True, visibility=visibility, xml=xml)


def serialize_xml(model: Model, exclude_readonly: bool = False) -> str:
    """Serialize a model to XML.

    :param Model model: The model to serialize.
    :param bool exclude_readonly: Whether to exclude readonly properties.
    :returns: The XML representation of the model.
    :rtype: str
    """
    return ET.tostring(_get_element(model, exclude_readonly), encoding="unicode")  # type: ignore


def _get_xml_ns(meta: dict[str, typing.Any]) -> typing.Optional[str]:
    """Return the XML namespace from a metadata dict, checking both 'ns' (old-style) and 'namespace' (DPG) keys.

    :param dict meta: The metadata dictionary to extract namespace from.
    :returns: The namespace string if 'ns' or 'namespace' key is present, None otherwise.
    :rtype: str or None
    """
    ns = meta.get("ns")
    if ns is None:
        ns = meta.get("namespace")
    return ns


def _resolve_xml_ns(
    prop_meta: dict[str, typing.Any], model_meta: typing.Optional[dict[str, typing.Any]] = None
) -> typing.Optional[str]:
    """Resolve XML namespace for a property, falling back to model namespace when appropriate.

    Checks the property metadata first; if no namespace is found and the model does not declare
    an explicit prefix, falls back to the model-level namespace.

    :param dict prop_meta: The property metadata dictionary.
    :param dict model_meta: The model metadata dictionary, used as fallback.
    :returns: The resolved namespace string, or None.
    :rtype: str or None
    """
    ns = _get_xml_ns(prop_meta)
    if ns is None and model_meta is not None and not model_meta.get("prefix"):
        ns = _get_xml_ns(model_meta)
    return ns


def _set_xml_attribute(element: ET.Element, name: str, value: typing.Any, prop_meta: dict[str, typing.Any]) -> None:
    """Set an XML attribute on an element, handling namespace prefix registration.

    :param ET.Element element: The element to set the attribute on.
    :param str name: The default attribute name (wire name).
    :param any value: The attribute value.
    :param dict prop_meta: The property metadata dictionary.
    """
    xml_name = prop_meta.get("name", name)
    _attr_ns = _get_xml_ns(prop_meta)
    if _attr_ns:
        _attr_prefix = prop_meta.get("prefix")
        if _attr_prefix:
            _safe_register_namespace(_attr_prefix, _attr_ns)
        xml_name = "{" + _attr_ns + "}" + xml_name
    element.set(xml_name, _get_primitive_type_value(value))


def _get_element(
    o: typing.Any,
    exclude_readonly: bool = False,
    parent_meta: typing.Optional[dict[str, typing.Any]] = None,
    wrapped_element: typing.Optional[ET.Element] = None,
) -> typing.Union[ET.Element, list[ET.Element]]:
    if _is_model(o):
        model_meta = getattr(o, "_xml", {})

        # if prop is a model, then use the prop element directly, else generate a wrapper of model
        if wrapped_element is None:
            # When serializing as an array item (parent_meta is set), check if the parent has an
            # explicit itemsName. This ensures correct element names for unwrapped arrays (where
            # the element tag is the property/items name, not the model type name).
            _items_name = parent_meta.get("itemsName") if parent_meta is not None else None
            element_name = _items_name if _items_name else (model_meta.get("name") or o.__class__.__name__)
            _model_ns = _get_xml_ns(model_meta)
            wrapped_element = _create_xml_element(
                element_name,
                model_meta.get("prefix"),
                _model_ns,
            )

        readonly_props = []
        if exclude_readonly:
            readonly_props = [p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p)]

        for k, v in o.items():
            # do not serialize readonly properties
            if exclude_readonly and k in readonly_props:
                continue

            prop_rest_field = _get_rest_field(o._attr_to_rest_field, k)
            if prop_rest_field:
                prop_meta = getattr(prop_rest_field, "_xml").copy()
                # use the wire name as xml name if no specific name is set
                if prop_meta.get("name") is None:
                    prop_meta["name"] = k
            else:
                # additional properties will not have rest field, use the wire name as xml name
                prop_meta = {"name": k}

            # Propagate model namespace to properties only for old-style "ns"-keyed models.
            # DPG-generated models use the "namespace" key and explicitly declare namespace on
            # each property that needs it, so propagation is intentionally skipped for them.
            if prop_meta.get("ns") is None and model_meta.get("ns"):
                prop_meta["ns"] = model_meta.get("ns")
                prop_meta["prefix"] = model_meta.get("prefix")

            if prop_meta.get("unwrapped", False):
                # unwrapped could only set on array
                wrapped_element.extend(_get_element(v, exclude_readonly, prop_meta))
            elif prop_meta.get("text", False):
                # text could only set on primitive type
                wrapped_element.text = _get_primitive_type_value(v)
            elif prop_meta.get("attribute", False):
                _set_xml_attribute(wrapped_element, k, v, prop_meta)
            else:
                # other wrapped prop element
                wrapped_element.append(_get_wrapped_element(v, exclude_readonly, prop_meta))
        return wrapped_element
    if isinstance(o, list):
        return [_get_element(x, exclude_readonly, parent_meta) for x in o]  # type: ignore
    if isinstance(o, dict):
        result = []
        _dict_ns = _get_xml_ns(parent_meta) if parent_meta else None
        for k, v in o.items():
            result.append(
                _get_wrapped_element(
                    v,
                    exclude_readonly,
                    {
                        "name": k,
                        "ns": _dict_ns,
                        "prefix": parent_meta.get("prefix") if parent_meta else None,
                    },
                )
            )
        return result

    # primitive case need to create element based on parent_meta
    if parent_meta:
        _items_ns = parent_meta.get("itemsNs")
        if _items_ns is None:
            _items_ns = _get_xml_ns(parent_meta)
        return _get_wrapped_element(
            o,
            exclude_readonly,
            {
                "name": parent_meta.get("itemsName", parent_meta.get("name")),
                "prefix": parent_meta.get("itemsPrefix", parent_meta.get("prefix")),
                "ns": _items_ns,
            },
        )

    raise ValueError("Could not serialize value into xml: " + o)


def _get_wrapped_element(
    v: typing.Any,
    exclude_readonly: bool,
    meta: typing.Optional[dict[str, typing.Any]],
) -> ET.Element:
    _meta_ns = _get_xml_ns(meta) if meta else None
    wrapped_element = _create_xml_element(
        meta.get("name") if meta else None, meta.get("prefix") if meta else None, _meta_ns
    )
    if isinstance(v, (dict, list)):
        wrapped_element.extend(_get_element(v, exclude_readonly, meta))
    elif _is_model(v):
        _get_element(v, exclude_readonly, meta, wrapped_element)
    else:
        wrapped_element.text = _get_primitive_type_value(v)
    return wrapped_element  # type: ignore[no-any-return]


def _get_primitive_type_value(v) -> str:
    if v is True:
        return "true"
    if v is False:
        return "false"
    if isinstance(v, _Null):
        return ""
    return str(v)


def _safe_register_namespace(prefix: str, ns: str) -> None:
    """Register an XML namespace prefix, handling reserved prefix patterns.

    Some prefixes (e.g. 'ns2') match Python's reserved 'ns\\d+' pattern used for
    auto-generated prefixes, causing register_namespace to raise ValueError.
    Falls back to directly registering in the internal namespace map.

    :param str prefix: The namespace prefix to register.
    :param str ns: The namespace URI.
    """
    try:
        ET.register_namespace(prefix, ns)
    except ValueError:
        _ns_map = getattr(ET, "_namespace_map", None)
        if _ns_map is not None:
            _ns_map[ns] = prefix


def _create_xml_element(
    tag: typing.Any, prefix: typing.Optional[str] = None, ns: typing.Optional[str] = None
) -> ET.Element:
    if prefix and ns:
        _safe_register_namespace(prefix, ns)
    if ns:
        return ET.Element("{" + ns + "}" + tag)
    return ET.Element(tag)


def _deserialize_xml(
    deserializer: typing.Any,
    value: str,
) -> typing.Any:
    element = ET.fromstring(value)  # nosec
    if _is_model(deserializer):
        return deserializer._deserialize(element, [])
    return _deserialize(deserializer, element)


def _convert_element(e: ET.Element):
    # dict case
    if len(e.attrib) > 0 or len({child.tag for child in e}) > 1:
        dict_result: dict[str, typing.Any] = {}
        for child in e:
            if dict_result.get(child.tag) is not None:
                if isinstance(dict_result[child.tag], list):
                    dict_result[child.tag].append(_convert_element(child))
                else:
                    dict_result[child.tag] = [dict_result[child.tag], _convert_element(child)]
            else:
                dict_result[child.tag] = _convert_element(child)
        dict_result.update(e.attrib)
        return dict_result
    # array case
    if len(e) > 0:
        array_result: list[typing.Any] = []
        for child in e:
            array_result.append(_convert_element(child))
        return array_result
    # primitive case
    return e.text
