from __future__ import annotations

import copy
import json
import warnings
from collections.abc import Iterable, Iterator, Mapping, MutableMapping
from importlib import import_module
from logging import getLogger
from pprint import pformat
from typing import TYPE_CHECKING, Any, TypeAlias, cast

from scrapy.exceptions import ScrapyDeprecationWarning
from scrapy.settings import default_settings
from scrapy.utils.misc import load_object
from scrapy.utils.python import global_object_name

logger = getLogger(__name__)

# The key types are restricted in BaseSettings._get_key() to ones supported by JSON,
# see https://github.com/scrapy/scrapy/issues/5383.
_SettingsKey: TypeAlias = bool | float | int | str | None

if TYPE_CHECKING:
    from types import ModuleType

    # https://github.com/python/typing/issues/445#issuecomment-1131458824
    from _typeshed import SupportsItems

    # typing.Self requires Python 3.11
    from typing_extensions import Self

    _SettingsInput: TypeAlias = SupportsItems[_SettingsKey, Any] | str | None


SETTINGS_PRIORITIES: dict[str, int] = {
    "default": 0,
    "command": 10,
    "addon": 15,
    "project": 20,
    "spider": 30,
    "cmdline": 40,
}


def get_settings_priority(priority: int | str) -> int:
    """
    Small helper function that looks up a given string priority in the
    :attr:`~scrapy.settings.SETTINGS_PRIORITIES` dictionary and returns its
    numerical value, or directly returns a given numerical priority.
    """
    if isinstance(priority, str):
        return SETTINGS_PRIORITIES[priority]
    return priority


class SettingsAttribute:
    """Class for storing data related to settings attributes.

    This class is intended for internal usage, you should try Settings class
    for settings configuration, not this one.
    """

    def __init__(self, value: Any, priority: int):
        self.value: Any = value
        self.priority: int
        if isinstance(self.value, BaseSettings):
            self.priority = max(self.value.maxpriority(), priority)
        else:
            self.priority = priority

    def set(self, value: Any, priority: int) -> None:
        """Sets value if priority is higher or equal than current priority."""
        if priority >= self.priority:
            if isinstance(self.value, BaseSettings):
                value = BaseSettings(value, priority=priority)
            self.value = value
            self.priority = priority

    def __repr__(self) -> str:
        return f"<SettingsAttribute value={self.value!r} priority={self.priority}>"


class BaseSettings(MutableMapping[_SettingsKey, Any]):
    """
    Instances of this class behave like dictionaries, but store priorities
    along with their ``(key, value)`` pairs, and can be frozen (i.e. marked
    immutable).

    Key-value entries can be passed on initialization with the ``values``
    argument, and they would take the ``priority`` level (unless ``values`` is
    already an instance of :class:`~scrapy.settings.BaseSettings`, in which
    case the existing priority levels will be kept).  If the ``priority``
    argument is a string, the priority name will be looked up in
    :attr:`~scrapy.settings.SETTINGS_PRIORITIES`. Otherwise, a specific integer
    should be provided.

    Once the object is created, new settings can be loaded or updated with the
    :meth:`~scrapy.settings.BaseSettings.set` method, and can be accessed with
    the square bracket notation of dictionaries, or with the
    :meth:`~scrapy.settings.BaseSettings.get` method of the instance and its
    value conversion variants. When requesting a stored key, the value with the
    highest priority will be retrieved.
    """

    __default = object()

    def __init__(self, values: _SettingsInput = None, priority: int | str = "project"):
        self.frozen: bool = False
        self.attributes: dict[_SettingsKey, SettingsAttribute] = {}
        if values:
            self.update(values, priority)

    def __getitem__(self, opt_name: _SettingsKey) -> Any:
        if opt_name not in self:
            return None
        return self.attributes[opt_name].value

    def __contains__(self, name: Any) -> bool:
        return name in self.attributes

    def add_to_list(self, name: _SettingsKey, item: Any) -> None:
        """Append *item* to the :class:`list` setting with the specified *name*
        if *item* is not already in that list.

        This change is applied regardless of the priority of the *name*
        setting. The setting priority is not affected by this change either.
        """
        value: list[str] = self.getlist(name)
        if item not in value:
            self.set(name, [*value, item], self.getpriority(name) or 0)

    def remove_from_list(self, name: _SettingsKey, item: Any) -> None:
        """Remove *item* from the :class:`list` setting with the specified
        *name*.

        If *item* is missing, raise :exc:`ValueError`.

        This change is applied regardless of the priority of the *name*
        setting. The setting priority is not affected by this change either.
        """
        value: list[str] = self.getlist(name)
        if item not in value:
            raise ValueError(f"{item!r} not found in the {name} setting ({value!r}).")
        self.set(name, [v for v in value if v != item], self.getpriority(name) or 0)

    def get(self, name: _SettingsKey, default: Any = None) -> Any:  # pylint: disable=arguments-renamed
        """
        Get a setting value without affecting its original type.

        :param name: the setting name
        :type name: str

        :param default: the value to return if no setting is found
        :type default: object
        """
        if name == "CONCURRENT_REQUESTS_PER_IP" and (
            isinstance(self[name], int) and self[name] != 0
        ):
            warnings.warn(
                "The CONCURRENT_REQUESTS_PER_IP setting is deprecated, use CONCURRENT_REQUESTS_PER_DOMAIN instead.",
                ScrapyDeprecationWarning,
                stacklevel=2,
            )

        if name == "DNS_RESOLVER":
            warnings.warn(
                "The DNS_RESOLVER setting is deprecated, please use "
                "TWISTED_DNS_RESOLVER instead.",
                ScrapyDeprecationWarning,
                stacklevel=2,
            )

        return self[name] if self[name] is not None else default

    def getbool(self, name: _SettingsKey, default: bool = False) -> bool:
        """
        Get a setting value as a boolean.

        ``1``, ``'1'``, `True`` and ``'True'`` return ``True``,
        while ``0``, ``'0'``, ``False``, ``'False'`` and ``None`` return ``False``.

        For example, settings populated through environment variables set to
        ``'0'`` will return ``False`` when using this method.

        :param name: the setting name
        :type name: str

        :param default: the value to return if no setting is found
        :type default: object
        """
        got = self.get(name, default)
        try:
            return bool(int(got))
        except ValueError:
            if got in {"True", "true"}:
                return True
            if got in {"False", "false"}:
                return False
            raise ValueError(
                "Supported values for boolean settings "
                "are 0/1, True/False, '0'/'1', "
                "'True'/'False' and 'true'/'false'"
            ) from None

    def getint(self, name: _SettingsKey, default: int = 0) -> int:
        """
        Get a setting value as an int.

        :param name: the setting name
        :type name: str

        :param default: the value to return if no setting is found
        :type default: object
        """
        return int(self.get(name, default))

    def getfloat(self, name: _SettingsKey, default: float = 0.0) -> float:
        """
        Get a setting value as a float.

        :param name: the setting name
        :type name: str

        :param default: the value to return if no setting is found
        :type default: object
        """
        return float(self.get(name, default))

    def getlist(
        self, name: _SettingsKey, default: list[Any] | None = None
    ) -> list[Any]:
        """
        Get a setting value as a list. If the setting original type is a list,
        a copy of it will be returned. If it's a string it will be split by
        ",". If it is an empty string, an empty list will be returned.

        For example, settings populated through environment variables set to
        ``'one,two'`` will return a list ['one', 'two'] when using this method.

        :param name: the setting name
        :type name: str

        :param default: the value to return if no setting is found
        :type default: object
        """
        value = self.get(name, default or [])
        if not value:
            return []
        if isinstance(value, str):
            value = value.split(",")
        return list(value)

    def getdict(
        self, name: _SettingsKey, default: dict[Any, Any] | None = None
    ) -> dict[Any, Any]:
        """
        Get a setting value as a dictionary. If the setting original type is a
        dictionary, a copy of it will be returned. If it is a string it will be
        evaluated as a JSON dictionary. In the case that it is a
        :class:`~scrapy.settings.BaseSettings` instance itself, it will be
        converted to a dictionary, containing all its current settings values
        as they would be returned by :meth:`~scrapy.settings.BaseSettings.get`,
        and losing all information about priority and mutability.

        :param name: the setting name
        :type name: str

        :param default: the value to return if no setting is found
        :type default: object
        """
        value = self.get(name, default or {})
        if isinstance(value, str):
            value = json.loads(value)
        return dict(value)

    def getdictorlist(
        self,
        name: _SettingsKey,
        default: dict[Any, Any] | list[Any] | tuple[Any] | None = None,
    ) -> dict[Any, Any] | list[Any]:
        """Get a setting value as either a :class:`dict` or a :class:`list`.

        If the setting is already a dict or a list, a copy of it will be
        returned.

        If it is a string it will be evaluated as JSON, or as a comma-separated
        list of strings as a fallback.

        For example, settings populated from the command line will return:

        -   ``{'key1': 'value1', 'key2': 'value2'}`` if set to
            ``'{"key1": "value1", "key2": "value2"}'``

        -   ``['one', 'two']`` if set to ``'["one", "two"]'`` or ``'one,two'``

        :param name: the setting name
        :type name: string

        :param default: the value to return if no setting is found
        :type default: any
        """
        value = self.get(name, default)
        if value is None:
            return {}
        if isinstance(value, str):
            try:
                value_loaded = json.loads(value)
                if not isinstance(value_loaded, (dict, list)):
                    raise ValueError(
                        f"JSON string for setting '{name}' must evaluate to a dict or list, "
                        f"got {type(value_loaded).__name__}: {value_loaded!r}"
                    )
                return value_loaded
            except ValueError:
                return value.split(",")
        if isinstance(value, tuple):
            return list(value)
        if not isinstance(value, (dict, list)):
            raise ValueError(
                f"Setting '{name}' must be a dict, list, tuple, or string, "
                f"got {type(value).__name__}: {value!r}"
            )
        return copy.deepcopy(value)

    def getwithbase(self, name: _SettingsKey) -> BaseSettings:
        """Get a composition of a dictionary-like setting and its ``_BASE``
        counterpart.

        Use
        :meth:`~scrapy.settings.BaseSettings.get_component_priority_dict_with_base`
        instead if the setting is a :ref:`component priority dictionary
        <component-priority-dictionaries>`.

        :param name: name of the dictionary-like setting
        :type name: str
        """
        if not isinstance(name, str):
            raise ValueError(f"Base setting key must be a string, got {name}")
        compbs = BaseSettings()
        compbs.update(self[name + "_BASE"])
        compbs.update(self[name])
        return compbs

    def get_component_priority_dict_with_base(self, name: _SettingsKey) -> BaseSettings:
        """Get a composition of a component priority dictionary setting and
        its ``_BASE`` counterpart.

        Keys are resolved to their import path for deduplication and then
        restored to their latest input representation.

        :param name: name of the component priority dictionary setting
        :type name: str
        """
        if not isinstance(name, str):
            raise ValueError(f"Base setting key must be a string, got {name}")

        normalized_keys = {}
        obj_keys = set()

        def track_loaded_key(k: Any) -> None:
            if k not in obj_keys:
                obj_keys.add(k)
                return
            logger.warning(
                f"Setting {name} contains multiple keys that refer to the "
                f"same object: {global_object_name(k)}. Only the last one will "
                f"be kept."
            )

        def normalize_key(key: Any) -> Any:
            try:
                loaded_key = load_object(key)
            except (NameError, TypeError, ValueError):
                loaded_key = key
            else:
                import_path = global_object_name(loaded_key)
                normalized_keys[import_path] = key
                key = import_path
            track_loaded_key(loaded_key)
            return key

        def restore_key(k: str) -> Any:
            return normalized_keys.get(k, k)

        result = dict(self[name + "_BASE"] or {})
        override = {normalize_key(k): v for k, v in (self[name] or {}).items()}
        result.update(override)
        return BaseSettings(
            {restore_key(k): v for k, v in result.items() if v is not None}
        )

    def getpriority(self, name: _SettingsKey) -> int | None:
        """
        Return the current numerical priority value of a setting, or ``None`` if
        the given ``name`` does not exist.

        :param name: the setting name
        :type name: str
        """
        if name not in self:
            return None
        return self.attributes[name].priority

    def maxpriority(self) -> int:
        """
        Return the numerical value of the highest priority present throughout
        all settings, or the numerical value for ``default`` from
        :attr:`~scrapy.settings.SETTINGS_PRIORITIES` if there are no settings
        stored.
        """
        if len(self) > 0:
            return max(cast("int", self.getpriority(name)) for name in self)
        return get_settings_priority("default")

    def replace_in_component_priority_dict(
        self,
        name: _SettingsKey,
        old_cls: type,
        new_cls: type,
        priority: int | None = None,
    ) -> None:
        """Replace *old_cls* with *new_cls* in the *name* :ref:`component
        priority dictionary <component-priority-dictionaries>`.

        If *old_cls* is missing, or has :data:`None` as value, :exc:`KeyError`
        is raised.

        If *old_cls* was present as an import string, even more than once,
        those keys are dropped and replaced by *new_cls*.

        If *priority* is specified, that is the value assigned to *new_cls* in
        the component priority dictionary. Otherwise, the value of *old_cls* is
        used. If *old_cls* was present multiple times (possible with import
        strings) with different values, the value assigned to *new_cls* is one
        of them, with no guarantee about which one it is.

        This change is applied regardless of the priority of the *name*
        setting. The setting priority is not affected by this change either.
        """
        component_priority_dict = self.getdict(name)
        old_priority = None
        for cls_or_path in tuple(component_priority_dict):
            if load_object(cls_or_path) != old_cls:
                continue
            if (old_priority := component_priority_dict.pop(cls_or_path)) is None:
                break
        if old_priority is None:
            raise KeyError(
                f"{old_cls} not found in the {name} setting ({component_priority_dict!r})."
            )
        component_priority_dict[new_cls] = (
            old_priority if priority is None else priority
        )
        self.set(name, component_priority_dict, priority=self.getpriority(name) or 0)

    def __setitem__(self, name: _SettingsKey, value: Any) -> None:
        self.set(name, value)

    def set(
        self, name: _SettingsKey, value: Any, priority: int | str = "project"
    ) -> None:
        """
        Store a key/value attribute with a given priority.

        Settings should be populated *before* configuring the Crawler object
        (through the :meth:`~scrapy.crawler.Crawler.configure` method),
        otherwise they won't have any effect.

        :param name: the setting name
        :type name: str

        :param value: the value to associate with the setting
        :type value: object

        :param priority: the priority of the setting. Should be a key of
            :attr:`~scrapy.settings.SETTINGS_PRIORITIES` or an integer
        :type priority: str or int
        """
        self._assert_mutability()
        priority = get_settings_priority(priority)
        if name not in self:
            if isinstance(value, SettingsAttribute):
                self.attributes[name] = value
            else:
                self.attributes[name] = SettingsAttribute(value, priority)
        else:
            self.attributes[name].set(value, priority)

    def set_in_component_priority_dict(
        self, name: _SettingsKey, cls: type, priority: int | None
    ) -> None:
        """Set the *cls* component in the *name* :ref:`component priority
        dictionary <component-priority-dictionaries>` setting with *priority*.

        If *cls* already exists, its value is updated.

        If *cls* was present as an import string, even more than once, those
        keys are dropped and replaced by *cls*.

        This change is applied regardless of the priority of the *name*
        setting. The setting priority is not affected by this change either.
        """
        component_priority_dict = self.getdict(name)
        for cls_or_path in tuple(component_priority_dict):
            if not isinstance(cls_or_path, str):
                continue
            _cls = load_object(cls_or_path)
            if _cls == cls:
                del component_priority_dict[cls_or_path]
        component_priority_dict[cls] = priority
        self.set(name, component_priority_dict, self.getpriority(name) or 0)

    def setdefault(  # pylint: disable=arguments-renamed
        self,
        name: _SettingsKey,
        default: Any = None,
        priority: int | str = "project",
    ) -> Any:
        if name not in self:
            self.set(name, default, priority)
            return default

        return self.attributes[name].value

    def setdefault_in_component_priority_dict(
        self, name: _SettingsKey, cls: type, priority: int | None
    ) -> None:
        """Set the *cls* component in the *name* :ref:`component priority
        dictionary <component-priority-dictionaries>` setting with *priority*
        if not already defined (even as an import string).

        If *cls* is not already defined, it is set regardless of the priority
        of the *name* setting. The setting priority is not affected by this
        change either.
        """
        component_priority_dict = self.getdict(name)
        for cls_or_path in tuple(component_priority_dict):
            if load_object(cls_or_path) == cls:
                return
        component_priority_dict[cls] = priority
        self.set(name, component_priority_dict, self.getpriority(name) or 0)

    def setdict(self, values: _SettingsInput, priority: int | str = "project") -> None:
        self.update(values, priority)

    def setmodule(
        self, module: ModuleType | str, priority: int | str = "project"
    ) -> None:
        """
        Store settings from a module with a given priority.

        This is a helper function that calls
        :meth:`~scrapy.settings.BaseSettings.set` for every globally declared
        uppercase variable of ``module`` with the provided ``priority``.

        :param module: the module or the path of the module
        :type module: types.ModuleType or str

        :param priority: the priority of the settings. Should be a key of
            :attr:`~scrapy.settings.SETTINGS_PRIORITIES` or an integer
        :type priority: str or int
        """
        self._assert_mutability()
        if isinstance(module, str):
            module = import_module(module)
        for key in dir(module):
            if key.isupper():
                self.set(key, getattr(module, key), priority)

    # BaseSettings.update() doesn't support all inputs that MutableMapping.update() supports
    def update(self, values: _SettingsInput, priority: int | str = "project") -> None:  # type: ignore[override]
        """
        Store key/value pairs with a given priority.

        This is a helper function that calls
        :meth:`~scrapy.settings.BaseSettings.set` for every item of ``values``
        with the provided ``priority``.

        If ``values`` is a string, it is assumed to be JSON-encoded and parsed
        into a dict with ``json.loads()`` first. If it is a
        :class:`~scrapy.settings.BaseSettings` instance, the per-key priorities
        will be used and the ``priority`` parameter ignored. This allows
        inserting/updating settings with different priorities with a single
        command.

        :param values: the settings names and values
        :type values: dict or string or :class:`~scrapy.settings.BaseSettings`

        :param priority: the priority of the settings. Should be a key of
            :attr:`~scrapy.settings.SETTINGS_PRIORITIES` or an integer
        :type priority: str or int
        """
        self._assert_mutability()
        if isinstance(values, str):
            values = cast("dict[_SettingsKey, Any]", json.loads(values))
        if values is not None:
            if isinstance(values, BaseSettings):
                for name, value in values.items():
                    self.set(name, value, cast("int", values.getpriority(name)))
            else:
                for name, value in values.items():
                    self.set(name, value, priority)

    def delete(self, name: _SettingsKey, priority: int | str = "project") -> None:
        if name not in self:
            raise KeyError(name)
        self._assert_mutability()
        priority = get_settings_priority(priority)
        if priority >= cast("int", self.getpriority(name)):
            del self.attributes[name]

    def __delitem__(self, name: _SettingsKey) -> None:
        self._assert_mutability()
        del self.attributes[name]

    def _assert_mutability(self) -> None:
        if self.frozen:
            raise TypeError("Trying to modify an immutable Settings object")

    def copy(self) -> Self:
        """
        Make a deep copy of current settings.

        This method returns a new instance of the :class:`Settings` class,
        populated with the same values and their priorities.

        Modifications to the new object won't be reflected on the original
        settings.
        """
        return copy.deepcopy(self)

    def freeze(self) -> None:
        """
        Disable further changes to the current settings.

        After calling this method, the present state of the settings will become
        immutable. Trying to change values through the :meth:`~set` method and
        its variants won't be possible and will be alerted.
        """
        self.frozen = True

    def frozencopy(self) -> Self:
        """
        Return an immutable copy of the current settings.

        Alias for a :meth:`~freeze` call in the object returned by :meth:`copy`.
        """
        copy = self.copy()
        copy.freeze()
        return copy

    def __iter__(self) -> Iterator[_SettingsKey]:
        return iter(self.attributes)

    def __len__(self) -> int:
        return len(self.attributes)

    def _to_dict(self) -> dict[_SettingsKey, Any]:
        return {
            self._get_key(k): (v._to_dict() if isinstance(v, BaseSettings) else v)
            for k, v in self.items()
        }

    def _get_key(self, key_value: Any) -> _SettingsKey:
        return (
            key_value
            if isinstance(key_value, (bool, float, int, str, type(None)))
            else str(key_value)
        )

    def copy_to_dict(self) -> dict[_SettingsKey, Any]:
        """
        Make a copy of current settings and convert to a dict.

        This method returns a new dict populated with the same values
        and their priorities as the current settings.

        Modifications to the returned dict won't be reflected on the original
        settings.

        This method can be useful for example for printing settings
        in Scrapy shell.
        """
        settings = self.copy()
        return settings._to_dict()

    # https://ipython.readthedocs.io/en/stable/config/integrating.html#pretty-printing
    def _repr_pretty_(self, p: Any, cycle: bool) -> None:
        if cycle:
            p.text(repr(self))
        else:
            p.text(pformat(self.copy_to_dict()))

    def pop(self, name: _SettingsKey, default: Any = __default) -> Any:  # pylint: disable=arguments-renamed
        try:
            value = self.attributes[name].value
        except KeyError:
            if default is self.__default:
                raise
            return default
        del self[name]
        return value


class Settings(BaseSettings):
    """
    This object stores Scrapy settings for the configuration of internal
    components, and can be used for any further customization.

    It is a direct subclass and supports all methods of
    :class:`~scrapy.settings.BaseSettings`. Additionally, after instantiation
    of this class, the new object will have the global default settings
    described on :ref:`topics-settings-ref` already populated.
    """

    def __init__(self, values: _SettingsInput = None, priority: int | str = "project"):
        # Do not pass kwarg values here. We don't want to promote user-defined
        # dicts, and we want to update, not replace, default dicts with the
        # values given by the user
        super().__init__()
        self.setmodule(default_settings, "default")
        # Promote default dictionaries to BaseSettings instances for per-key
        # priorities
        for name, val in self.items():
            if isinstance(val, dict):
                self.set(name, BaseSettings(val, "default"), "default")
        self.update(values, priority)


def iter_default_settings() -> Iterable[tuple[str, Any]]:
    """Return the default settings as an iterator of (name, value) tuples"""
    for name in dir(default_settings):
        if name.isupper():
            yield name, getattr(default_settings, name)


def overridden_settings(
    settings: Mapping[_SettingsKey, Any],
) -> Iterable[tuple[str, Any]]:
    """Return an iterable of the settings that have been overridden"""
    for name, defvalue in iter_default_settings():
        value = settings[name]
        if not isinstance(defvalue, dict) and value != defvalue:
            yield name, value
