# !/usr/bin/env python
#
# bases.py
"""
Useful base classes.
"""
#
# Copyright © 2020 Dominic Davis-Foster <dominic@davis-foster.co.uk>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
# DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
# OR OTHER DEALINGS IN THE SOFTWARE.
#
# UserList based on CPython.
# Licensed under the Python Software Foundation License Version 2.
# Copyright © 2001-2020 Python Software Foundation. All rights reserved.
# Copyright © 2000 BeOpen.com. All rights reserved.
# Copyright © 1995-2000 Corporation for National Research Initiatives. All rights reserved.
# Copyright © 1991-1995 Stichting Mathematisch Centrum. All rights reserved.
#
# stdlib
from abc import abstractmethod
from numbers import Real
from pprint import pformat
from typing import (
Any,
Dict,
Iterable,
Iterator,
List,
MutableSequence,
Optional,
SupportsFloat,
Tuple,
Type,
TypeVar,
Union,
overload
)
# this package
from domdf_python_tools._is_match import is_match_with
from domdf_python_tools.doctools import prettify_docstrings
from domdf_python_tools.typing import SupportsIndex
__all__ = [
"Dictable",
"NamedList",
"namedlist",
"UserList",
"UserFloat",
"Lineup",
"_V",
"_LU",
"_T",
"_S",
"_F",
]
_F = TypeVar("_F", bound="UserFloat")
_LU = TypeVar("_LU", bound="Lineup")
_S = TypeVar("_S", bound="UserList")
_T = TypeVar("_T")
_V = TypeVar("_V")
[docs]@prettify_docstrings
class Dictable(Iterable[Tuple[str, _V]]):
"""
The basic structure of a class that can be converted into a dictionary.
"""
@abstractmethod
def __init__(self, *args, **kwargs):
pass
[docs] def __repr__(self) -> str:
return super().__repr__()
[docs] def __str__(self) -> str:
return self.__repr__()
[docs] def __iter__(self) -> Iterator[Tuple[str, _V]]:
"""
Iterate over the attributes of the class.
"""
yield from self.__dict__.items()
def __getstate__(self) -> Dict[str, _V]:
return self.__dict__
def __setstate__(self, state):
self.__init__(**state) # type: ignore[misc]
def __copy__(self):
return self.__class__(**self.__dict__)
def __deepcopy__(self, memodict={}):
return self.__copy__()
@property
@abstractmethod
def __dict__(self):
return dict() # pragma: no cover (abc)
[docs] def __eq__(self, other) -> bool:
if isinstance(other, self.__class__):
return is_match_with(other.__dict__, self.__dict__)
return NotImplemented
[docs]@prettify_docstrings
class UserList(MutableSequence[_T]):
"""
Typed version of :class:`collections.UserList`.
Class that simulates a list. The instance’s contents are kept in a regular list,
which is accessible via the :attr:`~.UserList.data` attribute of :class:`~.UserList` instances.
The instance’s contents are initially set to a copy of list, defaulting to the empty list ``[]``.
.. versionadded:: 0.10.0
:param initlist: The initial values to populate the :class:`~.UserList` with.
:default initlist: ``[]``
.. latex:clearpage::
.. admonition:: Subclassing requirements
Subclasses of :class:`~.UserList` are expected to offer a constructor which can be called with
either no arguments or one argument. List operations which return a new sequence
attempt to create an instance of the actual implementation class. To do so,
it assumes that the constructor can be called with a single parameter, which is a
sequence object used as a data source.
If a derived class does not wish to comply with this requirement, all of the special
methods supported by this class will need to be overridden; please consult the
sources for information about the methods which need to be provided in that case.
"""
#: A real list object used to store the contents of the :class:`~domdf_python_tools.bases.UserList`.
data: List[_T]
def __init__(self, initlist: Optional[Iterable[_T]] = None):
self.data = []
if initlist is not None:
# XXX should this accept an arbitrary sequence?
if type(initlist) is type(self.data): # noqa: E721
self.data[:] = initlist
elif isinstance(initlist, UserList):
self.data[:] = initlist.data[:]
else:
self.data = list(initlist)
[docs] def __repr__(self) -> str:
return repr(self.data)
[docs] def __lt__(self, other: object) -> bool:
return self.data < self.__cast(other)
[docs] def __le__(self, other: object) -> bool:
return self.data <= self.__cast(other)
[docs] def __eq__(self, other: object) -> bool:
return self.data == self.__cast(other)
[docs] def __gt__(self, other: object) -> bool:
return self.data > self.__cast(other)
[docs] def __ge__(self, other: object) -> bool:
return self.data >= self.__cast(other)
@staticmethod
def __cast(other):
return other.data if isinstance(other, UserList) else other
[docs] def __contains__(self, item: object) -> bool:
return item in self.data
def __len__(self) -> int:
return len(self.data)
def __iter__(self) -> Iterator[_T]:
yield from self.data
@overload
def __getitem__(self, i: int) -> _T: ...
@overload
def __getitem__(self, i: slice) -> MutableSequence[_T]: ...
[docs] def __getitem__(self, i: Union[int, slice]) -> Union[_T, MutableSequence[_T]]:
if isinstance(i, slice):
return self.__class__(self.data[i])
else:
return self.data[i]
@overload
def __setitem__(self, i: int, o: _T) -> None: ...
@overload
def __setitem__(self, i: slice, o: Iterable[_T]) -> None: ...
[docs] def __setitem__(self, i: Union[int, slice], item: Union[_T, Iterable[_T]]) -> None:
self.data[i] = item # type: ignore[index, assignment]
[docs] def __delitem__(self, i: Union[int, slice]):
del self.data[i]
[docs] def __add__(self: _S, other: Iterable[_T]) -> _S:
if isinstance(other, UserList):
return self.__class__(self.data + other.data)
elif isinstance(other, type(self.data)):
return self.__class__(self.data + other)
return self.__class__(self.data + list(other))
[docs] def __radd__(self, other):
if isinstance(other, UserList):
return self.__class__(other.data + self.data)
elif isinstance(other, type(self.data)):
return self.__class__(other + self.data)
return self.__class__(list(other) + self.data)
def __iadd__(self: _S, other: Iterable[_T]) -> _S:
if isinstance(other, UserList):
self.data += other.data
elif isinstance(other, type(self.data)):
self.data += other
else:
self.data += list(other)
return self
[docs] def __mul__(self: _S, n: int) -> _S:
return self.__class__(self.data * n)
__rmul__ = __mul__
def __imul__(self: _S, n: int) -> _S:
self.data *= n
return self
def __copy__(self):
inst = self.__class__.__new__(self.__class__)
inst.__dict__.update(self.__dict__)
# Create a copy and avoid triggering descriptors
inst.__dict__["data"] = self.__dict__["data"][:]
return inst
[docs] def append(self, item: _T) -> None:
"""
Append ``item`` to the end of the :class:`~.domdf_python_tools.bases.UserList`.
"""
self.data.append(item)
[docs] def insert(self, i: int, item: _T) -> None:
"""
Insert ``item`` at position ``i`` in the :class:`~.domdf_python_tools.bases.UserList`.
"""
self.data.insert(i, item)
[docs] def pop(self, i: int = -1) -> _T:
"""
Removes and returns the item at index ``i``.
:raises IndexError: if list is empty or index is out of range.
"""
return self.data.pop(i)
[docs] def remove(self, item: _T) -> None:
"""
Removes the first occurrence of ``item`` from the list.
:param item:
:rtype:
:raises ValueError: if the item is not present.
.. latex:clearpage::
"""
self.data.remove(item)
[docs] def clear(self) -> None:
"""
Remove all items from the :class:`~.domdf_python_tools.bases.UserList`.
"""
self.data.clear()
[docs] def copy(self: _S) -> _S:
"""
Returns a copy of the :class:`~.domdf_python_tools.bases.UserList`.
"""
return self.__class__(self)
[docs] def count(self, item: _T) -> int:
"""
Returns the number of occurrences of ``item`` in the :class:`~.domdf_python_tools.bases.UserList`.
"""
return self.data.count(item)
[docs] def index(self, item: _T, *args: Any) -> int:
"""
Returns the index of the fist element matching ``item``.
:param item:
:param args:
:raises ValueError: if the item is not present.
"""
return self.data.index(item, *args)
[docs] def reverse(self) -> None:
"""
Reverse the list in place.
"""
self.data.reverse()
[docs] def sort(self, *, key=None, reverse: bool = False) -> None:
"""
Sort the list in ascending order and return :py:obj:`None`.
The sort is in-place (i.e. the list itself is modified) and stable (i.e. the
order of two equal elements is maintained).
If a key function is given, apply it once to each list item and sort them,
ascending or descending, according to their function values.
The reverse flag can be set to sort in descending order.
"""
self.data.sort(key=key, reverse=reverse)
[docs] def extend(self, other: Iterable[_T]) -> None:
"""
Extend the :class:`~.domdf_python_tools.bases.NamedList` by appending elements from ``other``.
:param other:
"""
if isinstance(other, UserList):
self.data.extend(other.data)
else:
self.data.extend(other)
[docs]@prettify_docstrings
class UserFloat(Real):
"""
Class which simulates a float.
.. versionadded:: 1.6.0
:param value: The values to initialise the :class:`~domdf_python_tools.bases.UserFloat` with.
"""
def __init__(self, value: Union[SupportsFloat, SupportsIndex, str, bytes, bytearray] = 0.0):
self._value = (float(value), )
[docs] def as_integer_ratio(self) -> Tuple[int, int]:
"""
Returns the float as a fraction.
"""
return float(self).as_integer_ratio()
[docs] def hex(self) -> str: # noqa: A003 # pylint: disable=redefined-builtin
"""
Returns the hexadecimal (base 16) representation of the float.
"""
return float(self).hex()
[docs] def is_integer(self) -> bool:
"""
Returns whether the float is an integer.
"""
return float(self).is_integer()
[docs] @classmethod
def fromhex(cls: Type[_F], string: str) -> _F:
"""
Create a floating-point number from a hexadecimal string.
:param string:
"""
return cls(float.fromhex(string))
[docs] def __add__(self: _F, other: float) -> _F:
return self.__class__(float(self).__add__(other))
[docs] def __sub__(self: _F, other: float) -> _F:
return self.__class__(float(self).__sub__(other))
[docs] def __mul__(self: _F, other: float) -> _F:
return self.__class__(float(self).__mul__(other))
[docs] def __floordiv__(self: _F, other: float) -> _F: # type: ignore[override]
return self.__class__(float(self).__floordiv__(other))
[docs] def __truediv__(self: _F, other: float) -> _F:
return self.__class__(float(self).__truediv__(other))
[docs] def __mod__(self: _F, other: float) -> _F:
return self.__class__(float(self).__mod__(other))
[docs] def __divmod__(self: _F, other: float) -> Tuple[_F, _F]:
return tuple(self.__class__(x) for x in float(self).__divmod__(other)) # type: ignore[return-value]
[docs] def __pow__(self: _F, other: float, mod=None) -> _F:
return self.__class__(float(self).__pow__(other, mod))
[docs] def __radd__(self: _F, other: float) -> _F:
return self.__class__(float(self).__radd__(other))
[docs] def __rsub__(self: _F, other: float) -> _F:
return self.__class__(float(self).__rsub__(other))
[docs] def __rmul__(self: _F, other: float) -> _F:
return self.__class__(float(self).__rmul__(other))
[docs] def __rfloordiv__(self: _F, other: float) -> _F: # type: ignore[override]
return self.__class__(float(self).__rfloordiv__(other))
[docs] def __rtruediv__(self: _F, other: float) -> _F:
return self.__class__(float(self).__rtruediv__(other))
[docs] def __rmod__(self: _F, other: float) -> _F:
return self.__class__(float(self).__rmod__(other))
[docs] def __rdivmod__(self: _F, other: float) -> Tuple[_F, _F]:
return tuple(self.__class__(x) for x in float(self).__rdivmod__(other)) # type: ignore
[docs] def __rpow__(self: _F, other: float, mod=None) -> _F:
return self.__class__(float(self).__rpow__(other, mod))
def __getnewargs__(self) -> Tuple[float]:
return self._value
[docs] def __trunc__(self) -> int:
"""
Truncates the float to an integer.
"""
return float(self).__trunc__()
[docs] def __round__(self, ndigits: Optional[int] = None) -> Union[int, float]: # type: ignore
"""
Round the :class:`~.UserFloat` to ``ndigits`` decimal places, defaulting to ``0``.
If ``ndigits`` is omitted or :py:obj:`None`, returns an :class:`int`,
otherwise returns a :class:`float`.
Rounds half toward even.
:param ndigits:
"""
return float(self).__round__(ndigits)
[docs] def __eq__(self, other: object) -> bool:
if isinstance(other, UserFloat) and not isinstance(other, float):
return self._value == other._value
else:
return float(self).__eq__(other)
[docs] def __ne__(self, other: object) -> bool:
if isinstance(other, UserFloat) and not isinstance(other, float):
return self._value != other._value
else:
return float(self).__ne__(other)
[docs] def __lt__(self, other: Union[float, "UserFloat"]) -> bool:
if isinstance(other, UserFloat) and not isinstance(other, float):
return self._value < other._value
else:
return float(self).__lt__(other)
[docs] def __le__(self, other: Union[float, "UserFloat"]) -> bool:
if isinstance(other, UserFloat) and not isinstance(other, float):
return self._value <= other._value
else:
return float(self).__le__(other)
[docs] def __gt__(self, other: Union[float, "UserFloat"]) -> bool:
if isinstance(other, UserFloat) and not isinstance(other, float):
return self._value > other._value
else:
return float(self).__gt__(other)
[docs] def __ge__(self, other: Union[float, "UserFloat"]) -> bool:
if isinstance(other, UserFloat) and not isinstance(other, float):
return self._value >= other._value
else:
return float(self).__ge__(other)
[docs] def __neg__(self: _F) -> _F:
return self.__class__(float(self).__neg__())
[docs] def __pos__(self: _F) -> _F:
return self.__class__(float(self).__pos__())
[docs] def __str__(self) -> str:
return str(float(self))
[docs] def __int__(self) -> int:
return int(float(self))
[docs] def __float__(self) -> float:
return self._value[0]
[docs] def __abs__(self: _F) -> _F:
return self.__class__(float(self).__abs__())
def __hash__(self) -> int:
return float(self).__hash__()
[docs] def __repr__(self) -> str:
return str(self)
def __ceil__(self):
raise NotImplementedError
def __floor__(self):
raise NotImplementedError
[docs] def __bool__(self) -> bool:
"""
Return ``self != 0``.
"""
return super().__bool__()
[docs] def __complex__(self) -> complex:
"""
Return :class:`complex(self) <complex>`.
.. code-block:: python
complex(self) == complex(float(self), 0)
"""
return super().__complex__()
[docs]@prettify_docstrings
class NamedList(UserList[_T]):
"""
A list with a name.
The name of the list is taken from the name of the subclass.
.. versionchanged:: 0.10.0
:class:`~.NamedList` now subclasses :class:`.UserList` rather than :class:`collections.UserList`.
"""
def __repr__(self) -> str:
return f"{super().__repr__()}"
def __str__(self) -> str:
return f"{self.__class__.__name__}{pformat(list(self))}"
[docs]def namedlist(name: str = "NamedList") -> Type[NamedList]:
"""
A factory function to return a custom list subclass with a name.
:param name: The name of the list.
"""
class cls(NamedList):
pass
cls.__name__ = name
return cls
[docs]class Lineup(UserList[_T]):
"""
List-like type with fluent methods and some star players.
.. latex:vspace:: -10px
"""
[docs] def replace(self: _LU, what: _T, with_: _T) -> _LU:
r"""
Replace the first instance of ``what`` with ``with_``.
:param what: The object to find and replace.
:param with\_: The new value for the position in the list.
"""
self[self.index(what)] = with_
return self
[docs] def sort( # type: ignore
self: _LU,
*,
key=None,
reverse: bool = False,
) -> _LU:
"""
Sort the list in ascending order and return the self.
The sort is in-place (i.e. the list itself is modified) and stable (i.e. the
order of two equal elements is maintained).
If a key function is given, apply it once to each list item and sort them,
ascending or descending, according to their function values.
The reverse flag can be set to sort in descending order.
"""
super().sort(key=key, reverse=reverse)
return self
[docs] def reverse(self: _LU) -> _LU: # type: ignore # noqa: D102
super().reverse()
return self
[docs] def append( # type: ignore # noqa: D102
self: _LU,
item: _T,
) -> _LU:
super().append(item)
return self
[docs] def extend( # type: ignore # noqa: D102
self: _LU,
other: Iterable[_T],
) -> _LU:
super().extend(other)
return self
[docs] def insert( # type: ignore # noqa: D102
self: _LU,
i: int,
item: _T,
) -> _LU:
super().insert(i, item)
return self
[docs] def remove( # type: ignore # noqa: D102
self: _LU,
item: _T,
) -> _LU:
super().remove(item)
return self
[docs] def clear(self: _LU) -> _LU: # type: ignore # noqa: D102
super().clear()
return self