sh-edraft.de/sh_cpl
2
1
Fork 0
Code Issues 4 Pull Requests 1 Actions Packages Projects 1 Releases 12 Wiki Activity

Updated docs

Browse Source
This commit is contained in:
Sven Heidemann
2023-02-20 15:55:20 +01:00
parent 48d0daabf5
commit 9e28dce5ce
632 changed files with 10917 additions and 6775 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
src/cpl_query/__init__.py
View File

@@ -1,26 +1,26 @@
# -*- coding: utf-8 -*-
"""
cpl-query sh-edraft Common Python library Query
cpl-query CPL Queries
~~~~~~~~~~~~~~~~~~~
sh-edraft Common Python library Python integrated Queries
CPL Python integrated Queries
:copyright: (c) 2021 - 2023 sh-edraft.de
:license: MIT, see LICENSE for more details.
"""
__title__ = 'cpl_query'
__author__ = 'Sven Heidemann'
__license__ = 'MIT'
__copyright__ = 'Copyright (c) 2021 - 2023 sh-edraft.de'
__version__ = '2022.12.2.post1'
__title__ = "cpl_query"
__author__ = "Sven Heidemann"
__license__ = "MIT"
__copyright__ = "Copyright (c) 2021 - 2023 sh-edraft.de"
__version__ = "2023.2.0"
from collections import namedtuple
# imports:
VersionInfo = namedtuple('VersionInfo', 'major minor micro')
version_info = VersionInfo(major='2022', minor='12', micro='2.post1')
VersionInfo = namedtuple("VersionInfo", "major minor micro")
version_info = VersionInfo(major="2023", minor="2", micro="0")

18
src/cpl_query/base/__init__.py
View File

@@ -1,26 +1,26 @@
# -*- coding: utf-8 -*-
"""
cpl-query sh-edraft Common Python library Query
cpl-query CPL Queries
~~~~~~~~~~~~~~~~~~~
sh-edraft Common Python library Python integrated Queries
CPL Python integrated Queries
:copyright: (c) 2021 - 2023 sh-edraft.de
:license: MIT, see LICENSE for more details.
"""
__title__ = 'cpl_query.base'
__author__ = 'Sven Heidemann'
__license__ = 'MIT'
__copyright__ = 'Copyright (c) 2021 - 2023 sh-edraft.de'
__version__ = '2022.12.2.post1'
__title__ = "cpl_query.base"
__author__ = "Sven Heidemann"
__license__ = "MIT"
__copyright__ = "Copyright (c) 2021 - 2023 sh-edraft.de"
__version__ = "2023.2.0"
from collections import namedtuple
# imports:
VersionInfo = namedtuple('VersionInfo', 'major minor micro')
version_info = VersionInfo(major='2022', minor='12', micro='2.post1')
VersionInfo = namedtuple("VersionInfo", "major minor micro")
version_info = VersionInfo(major="2023", minor="2", micro="0")

7
src/cpl_query/base/ordered_queryable.py
View File

@@ -6,8 +6,7 @@ from cpl_query.iterable.iterable import Iterable
class OrderedQueryable(OrderedQueryableABC):
r"""Implementation of :class: `cpl_query.extension.Iterable` `cpl_query.extension.OrderedIterableABC`
"""
r"""Implementation of :class: `cpl_query.extension.Iterable` `cpl_query.extension.OrderedIterableABC`"""
def __init__(self, _t: type, _values: Iterable = None, _func: Callable = None):
OrderedQueryableABC.__init__(self, _t, _values, _func)
@@ -31,4 +30,6 @@ class OrderedQueryable(OrderedQueryableABC):
raise ArgumentNoneException(ExceptionArgument.func)
self._funcs.append(_func)
return OrderedQueryable(self.type, sorted(self, key=lambda *args: [f(*args) for f in self._funcs], reverse=True), _func)
return OrderedQueryable(
self.type, sorted(self, key=lambda *args: [f(*args) for f in self._funcs], reverse=True), _func
)

21
src/cpl_query/base/ordered_queryable_abc.py
View File

@@ -6,7 +6,6 @@ from cpl_query.base.queryable_abc import QueryableABC
class OrderedQueryableABC(QueryableABC):
@abstractmethod
def __init__(self, _t: type, _values: Iterable = None, _func: Callable = None):
QueryableABC.__init__(self, _t, _values)
@@ -15,29 +14,25 @@ class OrderedQueryableABC(QueryableABC):
self._funcs.append(_func)
@abstractmethod
def then_by(self, func: Callable) -> 'OrderedQueryableABC':
def then_by(self, func: Callable) -> "OrderedQueryableABC":
r"""Sorts OrderedList in ascending order by function
Parameter
---------
Parameter:
func: :class:`Callable`
Returns
-------
Returns:
list of :class:`cpl_query.iterable.ordered_iterable_abc.OrderedIterableABC`
"""
pass
@abstractmethod
def then_by_descending(self, func: Callable) -> 'OrderedQueryableABC':
def then_by_descending(self, func: Callable) -> "OrderedQueryableABC":
r"""Sorts OrderedList in descending order by function
Parameter
---------
Parameter:
func: :class:`Callable`
Returns
-------
Returns:
list of :class:`cpl_query.iterable.ordered_iterable_abc.OrderedIterableABC`
"""
pass

201
src/cpl_query/base/queryable_abc.py
View File

@@ -2,7 +2,12 @@ from typing import Optional, Callable, Union, Iterable
from cpl_query._helper import is_number
from cpl_query.base.sequence import Sequence
from cpl_query.exceptions import InvalidTypeException, ArgumentNoneException, ExceptionArgument, IndexOutOfRangeException
from cpl_query.exceptions import (
InvalidTypeException,
ArgumentNoneException,
ExceptionArgument,
IndexOutOfRangeException,
)
def _default_lambda(x: object) -> object:
@@ -10,20 +15,17 @@ def _default_lambda(x: object) -> object:
class QueryableABC(Sequence):
def __init__(self, t: type, values: Iterable = None):
Sequence.__init__(self, t, values)
def all(self, _func: Callable = None) -> bool:
r"""Checks if every element of list equals result found by function
Parameter
---------
Parameter:
func: :class:`Callable`
selected value
Returns
-------
Returns:
bool
"""
if _func is None:
@@ -34,13 +36,11 @@ class QueryableABC(Sequence):
def any(self, _func: Callable = None) -> bool:
r"""Checks if list contains result found by function
Parameter
---------
Parameter:
func: :class:`Callable`
selected value
Returns
-------
Returns:
bool
"""
if _func is None:
@@ -51,13 +51,11 @@ class QueryableABC(Sequence):
def average(self, _func: Callable = None) -> Union[int, float, complex]:
r"""Returns average value of list
Parameter
---------
Parameter:
func: :class:`Callable`
selected value
Returns
-------
Returns:
Union[int, float, complex]
"""
if _func is None and not is_number(self.type):
@@ -68,13 +66,11 @@ class QueryableABC(Sequence):
def contains(self, _value: object) -> bool:
r"""Checks if list contains value given by function
Parameter
---------
Parameter:
value: :class:`object`
value
Returns
-------
Returns:
bool
"""
if _value is None:
@@ -85,13 +81,11 @@ class QueryableABC(Sequence):
def count(self, _func: Callable = None) -> int:
r"""Returns length of list or count of found elements
Parameter
---------
Parameter:
func: :class:`Callable`
selected value
Returns
-------
Returns:
int
"""
if _func is None:
@@ -99,16 +93,14 @@ class QueryableABC(Sequence):
return self.where(_func).count()
def distinct(self, _func: Callable = None) -> 'QueryableABC':
def distinct(self, _func: Callable = None) -> "QueryableABC":
r"""Returns list without redundancies
Parameter
---------
Parameter:
func: :class:`Callable`
selected value
Returns
-------
Returns:
:class: `cpl_query.base.queryable_abc.QueryableABC`
"""
if _func is None:
@@ -129,13 +121,11 @@ class QueryableABC(Sequence):
def element_at(self, _index: int) -> any:
r"""Returns element at given index
Parameter
---------
Parameter:
_index: :class:`int`
index
Returns
-------
Returns:
Value at _index: any
"""
if _index is None:
@@ -153,13 +143,11 @@ class QueryableABC(Sequence):
def element_at_or_default(self, _index: int) -> Optional[any]:
r"""Returns element at given index or None
Parameter
---------
Parameter:
_index: :class:`int`
index
Returns
-------
Returns:
Value at _index: Optional[any]
"""
if _index is None:
@@ -173,8 +161,7 @@ class QueryableABC(Sequence):
def first(self) -> any:
r"""Returns first element
Returns
-------
Returns:
First element of list: any
"""
if self.count() == 0:
@@ -185,8 +172,7 @@ class QueryableABC(Sequence):
def first_or_default(self) -> any:
r"""Returns first element or None
Returns
-------
Returns:
First element of list: Optional[any]
"""
if self.count() == 0:
@@ -197,8 +183,7 @@ class QueryableABC(Sequence):
def for_each(self, _func: Callable = None):
r"""Runs given function for each element of list
Parameter
---------
Parameter:
func: :class: `Callable`
function to call
"""
@@ -208,11 +193,10 @@ class QueryableABC(Sequence):
return self
def group_by(self, _func: Callable = None) -> 'QueryableABC':
def group_by(self, _func: Callable = None) -> "QueryableABC":
r"""Groups by func
Returns
-------
Returns:
Grouped list[list[any]]: any
"""
if _func is None:
@@ -235,8 +219,7 @@ class QueryableABC(Sequence):
def last(self) -> any:
r"""Returns last element
Returns
-------
Returns:
Last element of list: any
"""
if self.count() == 0:
@@ -247,8 +230,7 @@ class QueryableABC(Sequence):
def last_or_default(self) -> any:
r"""Returns last element or None
Returns
-------
Returns:
Last element of list: Optional[any]
"""
if self.count() == 0:
@@ -259,13 +241,11 @@ class QueryableABC(Sequence):
def max(self, _func: Callable = None) -> object:
r"""Returns the highest value
Parameter
---------
Parameter:
func: :class:`Callable`
selected value
Returns
-------
Returns:
object
"""
if _func is None and not is_number(self.type):
@@ -279,8 +259,7 @@ class QueryableABC(Sequence):
def median(self, _func=None) -> Union[int, float]:
r"""Return the median value of data elements
Returns
-------
Returns:
Union[int, float]
"""
if _func is None:
@@ -289,22 +268,16 @@ class QueryableABC(Sequence):
result = self.order_by(_func).select(_func).to_list()
length = len(result)
i = int(length / 2)
return (
result[i]
if length % 2 == 1
else (float(result[i - 1]) + float(result[i])) / float(2)
)
return result[i] if length % 2 == 1 else (float(result[i - 1]) + float(result[i])) / float(2)
def min(self, _func: Callable = None) -> object:
r"""Returns the lowest value
Parameter
---------
Parameter:
func: :class:`Callable`
selected value
Returns
-------
Returns:
object
"""
if _func is None and not is_number(self.type):
@@ -315,56 +288,52 @@ class QueryableABC(Sequence):
return _func(min(self, key=_func))
def order_by(self, _func: Callable = None) -> 'QueryableABC':
def order_by(self, _func: Callable = None) -> "QueryableABC":
r"""Sorts elements by function in ascending order
Parameter
---------
Parameter:
func: :class:`Callable`
selected value
Returns
-------
Returns:
:class: `cpl_query.base.queryable_abc.QueryableABC`
"""
if _func is None:
_func = _default_lambda
from cpl_query.base.ordered_queryable import OrderedQueryable
return OrderedQueryable(self.type, sorted(self, key=_func), _func)
def order_by_descending(self, _func: Callable = None) -> 'QueryableABC':
def order_by_descending(self, _func: Callable = None) -> "QueryableABC":
r"""Sorts elements by function in descending order
Parameter
---------
Parameter:
func: :class:`Callable`
selected value
Returns
-------
Returns:
:class: `cpl_query.base.queryable_abc.QueryableABC`
"""
if _func is None:
_func = _default_lambda
from cpl_query.base.ordered_queryable import OrderedQueryable
return OrderedQueryable(self.type, sorted(self, key=_func, reverse=True), _func)
def reverse(self) -> 'QueryableABC':
def reverse(self) -> "QueryableABC":
r"""Reverses list
Returns
-------
Returns:
:class: `cpl_query.base.queryable_abc.QueryableABC`
"""
return type(self)(self._type, reversed(self._values))
def select(self, _func: Callable) -> 'QueryableABC':
def select(self, _func: Callable) -> "QueryableABC":
r"""Formats each element of list to a given format
Returns
-------
Returns:
:class: `cpl_query.base.queryable_abc.QueryableABC`
"""
if _func is None:
@@ -372,11 +341,10 @@ class QueryableABC(Sequence):
return type(self)(object, [_func(_o) for _o in self])
def select_many(self, _func: Callable) -> 'QueryableABC':
def select_many(self, _func: Callable) -> "QueryableABC":
r"""Flattens resulting lists to one
Returns
-------
Returns:
:class: `cpl_query.base.queryable_abc.QueryableABC`
"""
# The line below is pain. I don't understand anything of it...
@@ -386,46 +354,41 @@ class QueryableABC(Sequence):
def single(self) -> any:
r"""Returns one single element of list
Returns
-------
Returns:
Found value: any
Raises
------
Raises:
ArgumentNoneException: when argument is None
Exception: when argument is None or found more than one element
"""
if self.count() > 1:
raise Exception('Found more than one element')
raise Exception("Found more than one element")
elif self.count() == 0:
raise Exception('Found no element')
raise Exception("Found no element")
return self._values[0]
def single_or_default(self) -> Optional[any]:
r"""Returns one single element of list
Returns
-------
Returns:
Found value: Optional[any]
"""
if self.count() > 1:
raise Exception('Index out of range')
raise Exception("Index out of range")
elif self.count() == 0:
return None
return self._values[0]
def skip(self, _index: int) -> 'QueryableABC':
def skip(self, _index: int) -> "QueryableABC":
r"""Skips all elements from index
Parameter
---------
Parameter:
_index: :class:`int`
index
Returns
-------
Returns:
:class: `cpl_query.base.queryable_abc.QueryableABC`
"""
if _index is None:
@@ -433,16 +396,14 @@ class QueryableABC(Sequence):
return type(self)(self.type, self._values[_index:])
def skip_last(self, _index: int) -> 'QueryableABC':
def skip_last(self, _index: int) -> "QueryableABC":
r"""Skips all elements after index
Parameter
---------
Parameter:
_index: :class:`int`
index
Returns
-------
Returns:
:class: `cpl_query.base.queryable_abc.QueryableABC`
"""
if _index is None:
@@ -454,13 +415,11 @@ class QueryableABC(Sequence):
def sum(self, _func: Callable = None) -> Union[int, float, complex]:
r"""Sum of all values
Parameter
---------
Parameter:
func: :class:`Callable`
selected value
Returns
-------
Returns:
Union[int, float, complex]
"""
if _func is None and not is_number(self.type):
@@ -475,17 +434,15 @@ class QueryableABC(Sequence):
return result
def split(self, _func: Callable) -> 'QueryableABC':
def split(self, _func: Callable) -> "QueryableABC":
r"""Splits the list by given function
Parameter
---------
Parameter:
func: :class:`Callable`
seperator
Returns
-------
Returns:
:class: `cpl_query.base.queryable_abc.QueryableABC`
"""
groups = []
@@ -508,16 +465,14 @@ class QueryableABC(Sequence):
return type(self)(self._type, query_groups)
def take(self, _index: int) -> 'QueryableABC':
def take(self, _index: int) -> "QueryableABC":
r"""Takes all elements from index
Parameter
---------
Parameter:
_index: :class:`int`
index
Returns
-------
Returns:
:class: `cpl_query.base.queryable_abc.QueryableABC`
"""
if _index is None:
@@ -525,16 +480,14 @@ class QueryableABC(Sequence):
return type(self)(self._type, self._values[:_index])
def take_last(self, _index: int) -> 'QueryableABC':
def take_last(self, _index: int) -> "QueryableABC":
r"""Takes all elements after index
Parameter
---------
Parameter:
_index: :class:`int`
index
Returns
-------
Returns:
:class: `cpl_query.base.queryable_abc.QueryableABC`
"""
index = self.count() - _index
@@ -544,16 +497,14 @@ class QueryableABC(Sequence):
return type(self)(self._type, self._values[index:])
def where(self, _func: Callable = None) -> 'QueryableABC':
def where(self, _func: Callable = None) -> "QueryableABC":
r"""Select element by function
Parameter
---------
Parameter:
func: :class:`Callable`
selected value
Returns
-------
Returns:
:class: `cpl_query.base.queryable_abc.QueryableABC`
"""
if _func is None:

33
src/cpl_query/base/sequence.py
View File

@@ -3,7 +3,6 @@ from typing import Iterable
class Sequence(ABC):
@abstractmethod
def __init__(self, t: type, values: Iterable = None):
if values is None:
@@ -30,7 +29,7 @@ class Sequence(ABC):
return _t
def __repr__(self):
return f'<{type(self).__name__} {self.to_list().__repr__()}>'
return f"<{type(self).__name__} {self.to_list().__repr__()}>"
@property
def type(self) -> type:
@@ -40,33 +39,35 @@ class Sequence(ABC):
if self._type == any:
return
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 (
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}")
def to_list(self) -> list:
r"""Converts :class: `cpl_query.base.sequence_abc.SequenceABC` to :class: `list`
Returns
-------
Returns:
:class: `list`
"""
return [x for x in self._values]
def copy(self) -> 'Sequence':
def copy(self) -> "Sequence":
r"""Creates a copy of sequence
Returns
-------
Returns:
Sequence
"""
return type(self)(self._type, self.to_list())
@classmethod
def empty(cls) -> 'Sequence':
def empty(cls) -> "Sequence":
r"""Returns an empty sequence
Returns
-------
Returns:
Sequence object that contains no elements
"""
return cls(object, [])
@@ -74,12 +75,10 @@ class Sequence(ABC):
def index_of(self, _object: object) -> int:
r"""Returns the index of given element
Returns
-------
Returns:
Index of object
Raises
-------
Raises:
IndexError if object not in sequence
"""
for i, o in enumerate(self):
@@ -89,5 +88,5 @@ class Sequence(ABC):
raise IndexError
@classmethod
def range(cls, start: int, length: int) -> 'Sequence':
def range(cls, start: int, length: int) -> "Sequence":
return cls(int, range(start, length))

13
src/cpl_query/cpl-query.json
View File

@@ -2,14 +2,14 @@
"ProjectSettings": {
"Name": "cpl-query",
"Version": {
"Major": "2022",
"Minor": "12",
"Micro": "2.post1"
"Major": "2023",
"Minor": "2",
"Micro": "0"
},
"Author": "Sven Heidemann",
"AuthorEmail": "sven.heidemann@sh-edraft.de",
"Description": "sh-edraft Common Python library Query",
"LongDescription": "sh-edraft Common Python library Python integrated Queries",
"Description": "CPL Queries",
"LongDescription": "CPL Python integrated Queries",
"URL": "https://www.sh-edraft.de",
"CopyrightDate": "2021 - 2023",
"CopyrightName": "sh-edraft.de",
@@ -37,7 +37,8 @@
"PackageData": {
"cpl_query": [
".cpl/*.py"
]},
]
},
"ProjectReferences": []
}
}

18
src/cpl_query/enumerable/__init__.py
View File

@@ -1,21 +1,21 @@
# -*- coding: utf-8 -*-
"""
cpl-query sh-edraft Common Python library Query
cpl-query CPL Queries
~~~~~~~~~~~~~~~~~~~
sh-edraft Common Python library Python integrated Queries
CPL Python integrated Queries
:copyright: (c) 2021 - 2023 sh-edraft.de
:license: MIT, see LICENSE for more details.
"""
__title__ = 'cpl_query.enumerable'
__author__ = 'Sven Heidemann'
__license__ = 'MIT'
__copyright__ = 'Copyright (c) 2021 - 2023 sh-edraft.de'
__version__ = '2022.12.2.post1'
__title__ = "cpl_query.enumerable"
__author__ = "Sven Heidemann"
__license__ = "MIT"
__copyright__ = "Copyright (c) 2021 - 2023 sh-edraft.de"
__version__ = "2023.2.0"
from collections import namedtuple
@@ -24,5 +24,5 @@ from collections import namedtuple
from .enumerable import Enumerable
from .enumerable_abc import EnumerableABC
VersionInfo = namedtuple('VersionInfo', 'major minor micro')
version_info = VersionInfo(major='2022', minor='12', micro='2.post1')
VersionInfo = namedtuple("VersionInfo", "major minor micro")
version_info = VersionInfo(major="2023", minor="2", micro="0")

3
src/cpl_query/enumerable/enumerable.py
View File

@@ -6,8 +6,7 @@ def _default_lambda(x: object):
class Enumerable(EnumerableABC):
r"""Implementation of :class: `cpl_query.enumerable.enumerable_abc.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)

9
src/cpl_query/enumerable/enumerable_abc.py
View File

@@ -4,19 +4,18 @@ from cpl_query.base.queryable_abc import QueryableABC
class EnumerableABC(QueryableABC):
r"""ABC to define functions on list
"""
r"""ABC to define functions on list"""
@abstractmethod
def __init__(self, t: type = None, values: list = None):
QueryableABC.__init__(self, t, values)
def to_iterable(self) -> 'IterableABC':
def to_iterable(self) -> "IterableABC":
r"""Converts :class: `cpl_query.enumerable.enumerable_abc.EnumerableABC` to :class: `cpl_query.iterable.iterable_abc.IterableABC`
Returns
-------
Returns:
:class: `cpl_query.iterable.iterable_abc.IterableABC`
"""
from cpl_query.iterable.iterable import Iterable
return Iterable(self._type, self.to_list())

26
src/cpl_query/exceptions.py
View File

@@ -3,37 +3,33 @@ from enum import Enum
# models
class ExceptionArgument(Enum):
list = 'list'
func = 'func'
type = 'type'
value = 'value'
index = 'index'
list = "list"
func = "func"
type = "type"
value = "value"
index = "index"
# exceptions
class ArgumentNoneException(Exception):
r"""Exception when argument is None
"""
r"""Exception when argument is None"""
def __init__(self, arg: ExceptionArgument):
Exception.__init__(self, f'argument {arg} is None')
Exception.__init__(self, f"argument {arg} is None")
class IndexOutOfRangeException(Exception):
r"""Exception when index is out of range
"""
r"""Exception when index is out of range"""
def __init__(self, err: str = None):
Exception.__init__(self, f'List index out of range' if err is None else err)
Exception.__init__(self, f"List index out of range" if err is None else err)
class InvalidTypeException(Exception):
r"""Exception when type is invalid
"""
r"""Exception when type is invalid"""
pass
class WrongTypeException(Exception):
r"""Exception when type is unexpected
"""
r"""Exception when type is unexpected"""
pass

18
src/cpl_query/extension/__init__.py
View File

@@ -1,21 +1,21 @@
# -*- coding: utf-8 -*-
"""
cpl-query sh-edraft Common Python library Query
cpl-query CPL Queries
~~~~~~~~~~~~~~~~~~~
sh-edraft Common Python library Python integrated Queries
CPL Python integrated Queries
:copyright: (c) 2021 - 2023 sh-edraft.de
:license: MIT, see LICENSE for more details.
"""
__title__ = 'cpl_query.extension'
__author__ = 'Sven Heidemann'
__license__ = 'MIT'
__copyright__ = 'Copyright (c) 2021 - 2023 sh-edraft.de'
__version__ = '2022.12.2.post1'
__title__ = "cpl_query.extension"
__author__ = "Sven Heidemann"
__license__ = "MIT"
__copyright__ = "Copyright (c) 2021 - 2023 sh-edraft.de"
__version__ = "2023.2.0"
from collections import namedtuple
@@ -23,5 +23,5 @@ from collections import namedtuple
# imports:
from .list import List
VersionInfo = namedtuple('VersionInfo', 'major minor micro')
version_info = VersionInfo(major='2022', minor='12', micro='2.post1')
VersionInfo = namedtuple("VersionInfo", "major minor micro")
version_info = VersionInfo(major="2023", minor="2", micro="0")

15
src/cpl_query/extension/list.py
View File

@@ -4,8 +4,7 @@ from cpl_query.iterable.iterable import Iterable
class List(Iterable):
r"""Implementation of :class: `cpl_query.extension.iterable.Iterable`
"""
r"""Implementation of :class: `cpl_query.extension.iterable.Iterable`"""
def __init__(self, t: type = None, values: Iterator = None):
Iterable.__init__(self, t, values)
@@ -19,22 +18,22 @@ class List(Iterable):
def __delitem__(self, *args):
self._values.__delitem__(*args)
def to_enumerable(self) -> 'EnumerableABC':
def to_enumerable(self) -> "EnumerableABC":
r"""Converts :class: `cpl_query.iterable.iterable_abc.IterableABC` to :class: `cpl_query.enumerable.enumerable_abc.EnumerableABC`
Returns
-------
Returns:
:class: `cpl_query.enumerable.enumerable_abc.EnumerableABC`
"""
from cpl_query.enumerable.enumerable import Enumerable
return Enumerable(self._type, self.to_list())
def to_iterable(self) -> 'IterableABC':
def to_iterable(self) -> "IterableABC":
r"""Converts :class: `cpl_query.enumerable.enumerable_abc.EnumerableABC` to :class: `cpl_query.iterable.iterable_abc.IterableABC`
Returns
-------
Returns:
:class: `cpl_query.iterable.iterable_abc.IterableABC`
"""
from cpl_query.iterable.iterable import Iterable
return Iterable(self._type, self.to_list())

18
src/cpl_query/iterable/__init__.py
View File

@@ -1,21 +1,21 @@
# -*- coding: utf-8 -*-
"""
cpl-query sh-edraft Common Python library Query
cpl-query CPL Queries
~~~~~~~~~~~~~~~~~~~
sh-edraft Common Python library Python integrated Queries
CPL Python integrated Queries
:copyright: (c) 2021 - 2023 sh-edraft.de
:license: MIT, see LICENSE for more details.
"""
__title__ = 'cpl_query.iterable'
__author__ = 'Sven Heidemann'
__license__ = 'MIT'
__copyright__ = 'Copyright (c) 2021 - 2023 sh-edraft.de'
__version__ = '2022.12.2.post1'
__title__ = "cpl_query.iterable"
__author__ = "Sven Heidemann"
__license__ = "MIT"
__copyright__ = "Copyright (c) 2021 - 2023 sh-edraft.de"
__version__ = "2023.2.0"
from collections import namedtuple
@@ -24,5 +24,5 @@ from collections import namedtuple
from .iterable_abc import IterableABC
from .iterable import Iterable
VersionInfo = namedtuple('VersionInfo', 'major minor micro')
version_info = VersionInfo(major='2022', minor='12', micro='2.post1')
VersionInfo = namedtuple("VersionInfo", "major minor micro")
version_info = VersionInfo(major="2023", minor="2", micro="0")

1
src/cpl_query/iterable/iterable.py
View File

@@ -8,6 +8,5 @@ def _default_lambda(x: object):
class Iterable(IterableABC):
def __init__(self, t: type = None, values: TIterable = None):
IterableABC.__init__(self, t, values)

27
src/cpl_query/iterable/iterable_abc.py
View File

@@ -5,8 +5,7 @@ from cpl_query.base.queryable_abc import QueryableABC
class IterableABC(QueryableABC):
r"""ABC to define functions on list
"""
r"""ABC to define functions on list"""
@abstractmethod
def __init__(self, t: type = None, values: Iterable = None):
@@ -20,18 +19,18 @@ class IterableABC(QueryableABC):
def add(self, _object: object):
r"""Adds element to list
Parameter
---------
Parameter:
_object: :class:`object`
value
"""
self._check_type(_object)
self._values.append(_object)
def extend(self, __iterable: Iterable) -> 'IterableABC':
def extend(self, __iterable: Iterable) -> "IterableABC":
r"""Adds elements of given list to list
Parameter
---------
Parameter:
__iterable: :class: `cpl_query.extension.iterable.Iterable`
index
"""
@@ -42,8 +41,8 @@ class IterableABC(QueryableABC):
def remove(self, _object: object):
r"""Removes element from list
Parameter
---------
Parameter:
_object: :class:`object`
value
"""
@@ -54,19 +53,19 @@ class IterableABC(QueryableABC):
def remove_at(self, _index: int):
r"""Removes element from list
Parameter
---------
Parameter:
_object: :class:`object`
value
"""
self._values.pop(_index)
def to_enumerable(self) -> 'EnumerableABC':
def to_enumerable(self) -> "EnumerableABC":
r"""Converts :class: `cpl_query.iterable.iterable_abc.IterableABC` to :class: `cpl_query.enumerable.enumerable_abc.EnumerableABC`
Returns
-------
Returns:
:class: `cpl_query.enumerable.enumerable_abc.EnumerableABC`
"""
from cpl_query.enumerable.enumerable import Enumerable
return Enumerable(self._type, self.to_list())