Updated docs

This commit is contained in:
2023-02-20 15:55:20 +01:00
parent 48d0daabf5
commit 9e28dce5ce
632 changed files with 10917 additions and 6775 deletions

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")

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())