2022.10.9 - Enumerable & List (#105) #106

Merged
edraft merged 9 commits from 2022.10.9 into 2022.10 2022-09-15 18:21:25 +02:00
16 changed files with 368 additions and 95 deletions
Showing only changes of commit 28adcc4e49 - Show all commits

View File

View File

@ -1,26 +1,8 @@
from abc import ABC, abstractmethod
from typing import Optional, Callable, Union, Iterable
from abc import abstractmethod, ABC
from typing import Optional, Callable, Union
class IterableABC(ABC, list):
r"""ABC to define functions on list
"""
@abstractmethod
def __init__(self, t: type = None, values: list = None):
list.__init__(self)
if t == any:
t = None
self._type = t
if values is not None:
for value in values:
self.append(value)
@property
def type(self) -> type:
return self._type
class QueryableABC(ABC):
@abstractmethod
def all(self, func: Callable) -> bool:
@ -52,22 +34,6 @@ class IterableABC(ABC, list):
"""
pass
def append(self, __object: object) -> None:
r"""Adds element to list
Parameter
---------
__object: :class:`object`
value
"""
if self._type is not None and type(__object) != self._type and not isinstance(type(__object), self._type) and not issubclass(type(__object), self._type):
raise Exception(f'Unexpected type: {type(__object)}\nExpected type: {self._type}')
if len(self) == 0 and self._type is None:
self._type = type(__object)
super().append(__object)
@abstractmethod
def average(self, func: Callable = None) -> Union[int, float, complex]:
r"""Returns average value of list
@ -114,7 +80,7 @@ class IterableABC(ABC, list):
pass
@abstractmethod
def distinct(self, func: Callable = None) -> 'IterableABC':
def distinct(self, func: Callable = None) -> 'QueryableABC':
r"""Returns list without redundancies
Parameter
@ -124,7 +90,7 @@ class IterableABC(ABC, list):
Returns
-------
:class: `cpl_query.extension.iterable_abc.IterableABC`
:class: `cpl_query.base.queryable_abc.QueryableABC`
"""
pass
@ -158,19 +124,6 @@ class IterableABC(ABC, list):
"""
pass
def extend(self, __iterable: Iterable) -> 'IterableABC':
r"""Adds elements of given list to list
Parameter
---------
__iterable: :class: `cpl_query.extension.iterable.Iterable`
index
"""
for value in __iterable:
self.append(value)
return self
@abstractmethod
def last(self) -> any:
r"""Returns last element
@ -253,7 +206,7 @@ class IterableABC(ABC, list):
pass
@abstractmethod
def order_by(self, func: Callable) -> 'IterableABC':
def order_by(self, func: Callable) -> 'QueryableABC':
r"""Sorts elements by function in ascending order
Parameter
@ -263,12 +216,12 @@ class IterableABC(ABC, list):
Returns
-------
:class: `cpl_query.extension.iterable_abc.IterableABC`
:class: `cpl_query.base.queryable_abc.QueryableABC`
"""
pass
@abstractmethod
def order_by_descending(self, func: Callable) -> 'IterableABC':
def order_by_descending(self, func: Callable) -> 'QueryableABC':
r"""Sorts elements by function in descending order
Parameter
@ -278,35 +231,37 @@ class IterableABC(ABC, list):
Returns
-------
:class: `cpl_query.extension.iterable_abc.IterableABC`
:class: `cpl_query.base.queryable_abc.QueryableABC`
"""
pass
@abstractmethod
def reverse(self) -> 'IterableABC':
def reverse(self) -> 'QueryableABC':
r"""Reverses list
Returns
-------
:class: `cpl_query.extension.iterable_abc.IterableABC`
:class: `cpl_query.base.queryable_abc.QueryableABC`
"""
pass
def select(self, _f: Callable) -> 'IterableABC':
@abstractmethod
def select(self, _f: Callable) -> 'QueryableABC':
r"""Formats each element of list to a given format
Returns
-------
:class: `cpl_query.extension.iterable_abc.IterableABC`
:class: `cpl_query.base.queryable_abc.QueryableABC`
"""
pass
def select_many(self, _f: Callable) -> 'IterableABC':
@abstractmethod
def select_many(self, _f: Callable) -> 'QueryableABC':
r"""Flattens resulting lists to one
Returns
-------
:class: `cpl_query.extension.iterable_abc.IterableABC`
:class: `cpl_query.base.queryable_abc.QueryableABC`
"""
pass
@ -336,7 +291,7 @@ class IterableABC(ABC, list):
pass
@abstractmethod
def skip(self, index: int) -> 'IterableABC':
def skip(self, index: int) -> 'QueryableABC':
r"""Skips all elements from index
Parameter
@ -346,12 +301,12 @@ class IterableABC(ABC, list):
Returns
-------
:class: `cpl_query.extension.iterable_abc.IterableABC`
:class: `cpl_query.base.queryable_abc.QueryableABC`
"""
pass
@abstractmethod
def skip_last(self, index: int) -> 'IterableABC':
def skip_last(self, index: int) -> 'QueryableABC':
r"""Skips all elements after index
Parameter
@ -361,7 +316,7 @@ class IterableABC(ABC, list):
Returns
-------
:class: `cpl_query.extension.iterable_abc.IterableABC`
:class: `cpl_query.base.queryable_abc.QueryableABC`
"""
pass
@ -381,7 +336,7 @@ class IterableABC(ABC, list):
pass
@abstractmethod
def take(self, index: int) -> 'IterableABC':
def take(self, index: int) -> 'QueryableABC':
r"""Takes all elements from index
Parameter
@ -391,12 +346,12 @@ class IterableABC(ABC, list):
Returns
-------
:class: `cpl_query.extension.iterable_abc.IterableABC`
:class: `cpl_query.base.queryable_abc.QueryableABC`
"""
pass
@abstractmethod
def take_last(self, index: int) -> 'IterableABC':
def take_last(self, index: int) -> 'QueryableABC':
r"""Takes all elements after index
Parameter
@ -406,21 +361,12 @@ class IterableABC(ABC, list):
Returns
-------
:class: `cpl_query.extension.iterable_abc.IterableABC`
:class: `cpl_query.base.queryable_abc.QueryableABC`
"""
pass
def to_list(self) -> list:
r"""Converts :class: `cpl_query.extension.iterable_abc.IterableABC` to :class: `list`
Returns
-------
:class: `list`
"""
return list(self)
@abstractmethod
def where(self, func: Callable) -> 'IterableABC':
def where(self, func: Callable) -> 'QueryableABC':
r"""Select element by function
Parameter
@ -430,6 +376,6 @@ class IterableABC(ABC, list):
Returns
-------
:class: `cpl_query.extension.iterable_abc.IterableABC`
:class: `cpl_query.base.queryable_abc.QueryableABC`
"""
pass

View File

View File

@ -0,0 +1,127 @@
import itertools
from abc import abstractmethod
from typing import Union
from cpl_query.enumerable.enumerable_values import EnumerableValues
class EnumerableABC:
@abstractmethod
def __init__(self, t: type = None, values: Union[list, iter] = None):
if t == any:
t = None
self._type = t
self._values = EnumerableValues(values)
self._remove_error_check = True
def set_remove_error_check(self, _value: bool):
r"""Set flag to check if element exists before removing
"""
self._remove_error_check = _value
def __len__(self):
return len(self._values)
def __iter__(self):
return iter(self._values)
def next(self):
return next(self._values)
def __next__(self):
return self.next()
def __getitem__(self, n) -> object:
r"""Gets item in enumerable at specified zero-based index
Parameter
--------
n: the index of the item to get
Returns
-------
The element at the specified index.
Raises
------
IndexError if n > number of elements in the iterable
"""
for i, e in enumerate(self):
if i == n:
return e
def __repr__(self):
return f'<EnumerableABC {list(self).__repr__()}>'
@property
def type(self) -> type:
return self._type
def add(self, __object: object) -> None:
r"""Adds an element to the enumerable.
"""
if self._type is not None and type(__object) != self._type and not isinstance(type(__object), self._type) and not issubclass(type(__object), self._type):
raise Exception(f'Unexpected type: {type(__object)}\nExpected type: {self._type}')
if len(self) == 0 and self._type is None:
self._type = type(__object)
self._values = EnumerableValues([*self._values, __object])
def count(self) -> int:
r"""Returns count of elements
Returns
-------
int
"""
return sum(1 for element in self)
def clear(self):
r"""Removes all elements
"""
del self._values
self._values = []
@staticmethod
def empty():
r"""Returns an empty enumerable
Returns
-------
Enumerable object that contains no elements
"""
return EnumerableABC()
@staticmethod
def range(start: int, length: int) -> 'EnumerableABC':
return EnumerableABC(int, range(start, start + length, 1))
def remove(self, __object: object) -> None:
r"""Removes element from list
Parameter
---------
__object: :class:`object`
value
Raises
---------
`Element not found` when element does not exist. Check can be deactivated by calling <enumerable>.set_remove_error_check(False)
"""
if self._remove_error_check and __object not in self._values:
raise Exception('Element not found')
# self._values.remove(__object)
self._values = EnumerableValues([x for x in self.to_list() if x != __object])
def to_list(self) -> list:
r"""Converts :class: `cpl_query.enumerable.enumerable_abc.EnumerableABC` to :class: `list`
Returns
-------
:class: `list`
"""
return [x for x in self]

View File

@ -0,0 +1,31 @@
import io
import itertools
class EnumerableValues:
def __init__(self, data):
if data is None:
data = []
if not hasattr(data, '__iter__'):
raise TypeError('RepeatableIterable must be instantiated with an iterable object')
is_generator = hasattr(data, 'gi_running') or isinstance(data, io.TextIOBase)
self._data = data if not is_generator else [i for i in data]
self._len = sum(1 for item in self._data)
self.cycle = itertools.cycle(self._data)
def __len__(self):
return self._len
def __iter__(self):
i = 0
while i < len(self):
yield next(self.cycle)
i += 1
def __next__(self):
return self.next()
def next(self):
return next(self.cycle)

View File

@ -21,11 +21,7 @@ from collections import namedtuple
# imports:
from .iterable_abc import IterableABC
from .iterable import Iterable
from .list import List
from .ordered_iterable_abc import OrderedIterableABC
from .ordered_iterable import OrderedIterable
VersionInfo = namedtuple('VersionInfo', 'major minor micro')
version_info = VersionInfo(major='2022', minor='10', micro='2')

View File

@ -0,0 +1,9 @@
from cpl_query.enumerable.enumerable_abc import EnumerableABC
class LazyList(EnumerableABC):
r"""Implementation of :class: `cpl_query.enumerable.enumerable_abc.EnumerableABC`
"""
def __init__(self, t: type = None, values: list = None):
EnumerableABC.__init__(self, t, values)

View File

@ -1,4 +1,4 @@
from cpl_query.extension.iterable import Iterable
from cpl_query.iterable.iterable import Iterable
class List(Iterable):

View File

@ -0,0 +1,30 @@
# -*- coding: utf-8 -*-
"""
cpl-query sh-edraft Common Python library Query
~~~~~~~~~~~~~~~~~~~
sh-edraft Common Python library Python integrated Queries
:copyright: (c) 2021 - 2022 sh-edraft.de
:license: MIT, see LICENSE for more details.
"""
__title__ = 'cpl_query.iterable'
__author__ = 'Sven Heidemann'
__license__ = 'MIT'
__copyright__ = 'Copyright (c) 2021 - 2022 sh-edraft.de'
__version__ = '2022.10.2'
from collections import namedtuple
# imports:
from .iterable_abc import IterableABC
from .iterable import Iterable
from .ordered_iterable_abc import OrderedIterableABC
from .ordered_iterable import OrderedIterable
VersionInfo = namedtuple('VersionInfo', 'major minor micro')
version_info = VersionInfo(major='2022', minor='10', micro='2')

View File

@ -1,7 +1,7 @@
from typing import Callable, Optional, Union
from cpl_query.extension.iterable_abc import IterableABC
from cpl_query.extension.ordered_iterable_abc import OrderedIterableABC
from cpl_query.iterable.iterable_abc import IterableABC
from cpl_query.iterable.ordered_iterable_abc import OrderedIterableABC
from cpl_query.query import Query
@ -57,13 +57,13 @@ class Iterable(IterableABC):
def order_by(self, func: Callable) -> OrderedIterableABC:
res = Query.order_by(self, func)
from cpl_query.extension.ordered_iterable import OrderedIterable
from cpl_query.iterable.ordered_iterable import OrderedIterable
res.__class__ = OrderedIterable
return res
def order_by_descending(self, func: Callable) -> OrderedIterableABC:
res = Query.order_by_descending(self, func)
from cpl_query.extension.ordered_iterable import OrderedIterable
from cpl_query.iterable.ordered_iterable import OrderedIterable
res.__class__ = OrderedIterable
return res

View File

@ -0,0 +1,64 @@
from abc import ABC, abstractmethod
from typing import Optional, Callable, Union, Iterable
from cpl_query.base.queryable_abc import QueryableABC
from cpl_query.enumerable.enumerable_abc import EnumerableABC
class IterableABC(QueryableABC, list):
r"""ABC to define functions on list
"""
@abstractmethod
def __init__(self, t: type = None, values: list = None):
list.__init__(self)
if t == any:
t = None
self._type = t
if values is not None:
for value in values:
self.append(value)
@property
def type(self) -> type:
return self._type
def append(self, __object: object) -> None:
r"""Adds element to list
Parameter
---------
__object: :class:`object`
value
"""
if self._type is not None and type(__object) != self._type and not isinstance(type(__object), self._type) and not issubclass(type(__object), self._type):
raise Exception(f'Unexpected type: {type(__object)}\nExpected type: {self._type}')
if len(self) == 0 and self._type is None:
self._type = type(__object)
super().append(__object)
def extend(self, __iterable: Iterable) -> 'IterableABC':
r"""Adds elements of given list to list
Parameter
---------
__iterable: :class: `cpl_query.extension.iterable.Iterable`
index
"""
for value in __iterable:
self.append(value)
return self
def to_list(self) -> list:
r"""Converts :class: `cpl_query.enumerable.enumerable_abc.EnumerableABC` to :class: `list`
Returns
-------
:class: `list`
"""
return list(self)

View File

@ -1,7 +1,7 @@
from collections.abc import Callable
from cpl_query.extension.iterable import Iterable
from cpl_query.extension.ordered_iterable_abc import OrderedIterableABC
from cpl_query.iterable.iterable import Iterable
from cpl_query.iterable.ordered_iterable_abc import OrderedIterableABC
from cpl_query.query import Query

View File

@ -1,7 +1,7 @@
from abc import abstractmethod
from collections.abc import Callable
from cpl_query.extension.iterable_abc import IterableABC
from cpl_query.iterable.iterable_abc import IterableABC
class OrderedIterableABC(IterableABC):

View File

@ -2,8 +2,8 @@ from typing import Callable, Union, Optional
from cpl_query._helper import is_number
from cpl_query.exceptions import ArgumentNoneException, ExceptionArgument, InvalidTypeException, IndexOutOfRangeException
from cpl_query.extension.iterable_abc import IterableABC
from cpl_query.extension.ordered_iterable_abc import OrderedIterableABC
from cpl_query.iterable.iterable_abc import IterableABC
from cpl_query.iterable.ordered_iterable_abc import OrderedIterableABC
class Query:

View File

@ -0,0 +1,68 @@
import unittest
from cpl_query.extension.lazy_list import LazyList
from cpl_query.extension.list import List
class EnumerableTestCase(unittest.TestCase):
def setUp(self) -> None:
self._list = LazyList(int)
def _clear(self):
self._list.clear()
self.assertEqual(self._list, [])
def test_append(self):
self._list.add(1)
self._list.add(2)
self._list.add(3)
self.assertEqual(self._list.to_list(), [1, 2, 3])
self.assertRaises(Exception, lambda v: self._list.add(v), '3')
def test_default(self):
self.assertEqual(LazyList.empty().to_list(), [])
self.assertEqual(LazyList.range(0, 100).to_list(), list(range(0, 100)))
def test_iter(self):
n = 0
elements = LazyList.range(0, 100)
while n < 100:
self.assertEqual(elements.next(), n)
n += 1
def test_for(self):
n = 0
for i in LazyList.range(0, 100):
self.assertEqual(i, n)
n += 1
def test_get(self):
self._list.add(1)
self._list.add(2)
self._list.add(3)
self.assertEqual(self._list[2], [1, 2, 3][2])
def test_count(self):
self._list.add(1)
self._list.add(2)
self._list.add(3)
self.assertEqual(self._list.count(), 3)
def test_remove(self):
old_values = self._list._values
self._list.add(1)
self.assertNotEqual(old_values, self._list._values)
self._list.add(2)
self._list.add(3)
self.assertEqual(self._list.to_list(), [1, 2, 3])
self.assertRaises(Exception, lambda v: self._list.add(v), '3')
old_values = self._list._values
self._list.remove(3)
self.assertNotEqual(old_values, self._list._values)
self.assertEqual(self._list.to_list(), [1, 2])
self.assertRaises(Exception, lambda v: self._list.add(v), '3')

View File

@ -1,5 +1,6 @@
import unittest
from unittests_query.enumerable_test_case import EnumerableTestCase
from unittests_query.iterable_test_case import IterableTestCase
from unittests_query.query_test_case import QueryTestCase
@ -11,6 +12,7 @@ class QueryTestSuite(unittest.TestSuite):
loader = unittest.TestLoader()
self.addTests(loader.loadTestsFromTestCase(QueryTestCase))
self.addTests(loader.loadTestsFromTestCase(EnumerableTestCase))
self.addTests(loader.loadTestsFromTestCase(IterableTestCase))
def run(self, *args):