Compare commits

..

14 Commits

Author SHA1 Message Date
c4a71de83f Formatted code 2023-04-04 13:30:00 +02:00
01bc746092 Merge branch 'master' into 2023.4
# Conflicts:
#	src/cpl_cli/.cpl/__init__.py
#	src/cpl_cli/__init__.py
#	src/cpl_cli/_templates/__init__.py
#	src/cpl_cli/_templates/build/__init__.py
#	src/cpl_cli/_templates/publish/__init__.py
#	src/cpl_cli/abc/__init__.py
#	src/cpl_cli/command/__init__.py
#	src/cpl_cli/configuration/__init__.py
#	src/cpl_cli/cpl-cli.json
#	src/cpl_cli/helper/__init__.py
#	src/cpl_cli/live_server/__init__.py
#	src/cpl_cli/migrations/__init__.py
#	src/cpl_cli/migrations/base/__init__.py
#	src/cpl_cli/migrations/service/__init__.py
#	src/cpl_cli/publish/__init__.py
#	src/cpl_cli/source_creator/__init__.py
#	src/cpl_cli/validators/__init__.py
#	src/cpl_core/__init__.py
#	src/cpl_core/application/__init__.py
#	src/cpl_core/configuration/__init__.py
#	src/cpl_core/console/__init__.py
#	src/cpl_core/cpl-core.json
#	src/cpl_core/database/__init__.py
#	src/cpl_core/database/connection/__init__.py
#	src/cpl_core/database/context/__init__.py
#	src/cpl_core/dependency_injection/__init__.py
#	src/cpl_core/dependency_injection/service_provider.py
#	src/cpl_core/dependency_injection/service_provider_abc.py
#	src/cpl_core/environment/__init__.py
#	src/cpl_core/logging/__init__.py
#	src/cpl_core/mailing/__init__.py
#	src/cpl_core/pipes/__init__.py
#	src/cpl_core/time/__init__.py
#	src/cpl_core/utils/__init__.py
#	src/cpl_discord/.cpl/__init__.py
#	src/cpl_discord/.cpl/schematic_discord_event.py
#	src/cpl_discord/__init__.py
#	src/cpl_discord/application/__init__.py
#	src/cpl_discord/command/__init__.py
#	src/cpl_discord/configuration/__init__.py
#	src/cpl_discord/container/__init__.py
#	src/cpl_discord/cpl-discord.json
#	src/cpl_discord/events/__init__.py
#	src/cpl_discord/helper/__init__.py
#	src/cpl_discord/service/__init__.py
#	src/cpl_discord/service/discord_bot_service.py
#	src/cpl_discord/service/discord_bot_service_abc.py
#	src/cpl_discord/service/discord_service.py
#	src/cpl_query/__init__.py
#	src/cpl_query/base/__init__.py
#	src/cpl_query/base/queryable_abc.py
#	src/cpl_query/cpl-query.json
#	src/cpl_query/enumerable/__init__.py
#	src/cpl_query/extension/__init__.py
#	src/cpl_query/iterable/__init__.py
2023-04-04 13:29:45 +02:00
43710717c9 Fixed cpl-discord deps 2023-03-11 01:33:56 +01:00
7bf5e25c5e Fixed typing 2023-03-06 19:03:35 +01:00
faa030df96 Fixed typing 2023-03-06 19:03:01 +01:00
8179508248 Added scheduled event support for cpl-discord 2023-02-13 16:58:46 +01:00
2c3664c1b9 Fixed schematic schematic 2023-01-15 10:01:19 +01:00
269f083662 Fixed static inject args order 2023-01-15 02:34:09 +01:00
8b40c65661 Fixed discord event schematic 2023-01-12 13:49:15 +01:00
7be3cf38dc Fixed cpl-cli deps 2023-01-12 09:05:36 +01:00
b18a7297a7 Build fix version 2023-01-12 08:58:05 +01:00
7f46fbe87a Added *args and **kwargs support to discord bot and DI 2023-01-12 08:57:01 +01:00
e0ca7c2ae6 Build fixed version 2023-01-07 15:03:21 +01:00
6389a940bc Fixed static di injection 2023-01-07 15:00:38 +01:00
14 changed files with 279 additions and 89 deletions

View File

@ -39,7 +39,7 @@ class Schematic(GenerateSchematicABC):
[] []
) )
""" """
return self.build_code_str(code, Name=self._class_name) return self.build_code_str(code, Name=self._class_name, NameLower=self._class_name.lower())
@classmethod @classmethod
def register(cls): def register(cls):

View File

@ -18,7 +18,8 @@ from cpl_core.type import T
class ServiceProvider(ServiceProviderABC): class ServiceProvider(ServiceProviderABC):
r"""Provider for the services r"""Provider for the services
Parameter: Parameter
---------
service_descriptors: list[:class:`cpl_core.dependency_injection.service_descriptor.ServiceDescriptor`] service_descriptors: list[:class:`cpl_core.dependency_injection.service_descriptor.ServiceDescriptor`]
Descriptor of the service Descriptor of the service
config: :class:`cpl_core.configuration.configuration_abc.ConfigurationABC` config: :class:`cpl_core.configuration.configuration_abc.ConfigurationABC`
@ -63,7 +64,7 @@ class ServiceProvider(ServiceProviderABC):
# raise Exception(f'Service {parameter.annotation} not found') # raise Exception(f'Service {parameter.annotation} not found')
def _get_services(self, t: type) -> list[Optional[object]]: def _get_services(self, t: type, *args, **kwargs) -> list[Optional[object]]:
implementations = [] implementations = []
for descriptor in self._service_descriptors: for descriptor in self._service_descriptors:
if descriptor.service_type == t or issubclass(descriptor.service_type, t): if descriptor.service_type == t or issubclass(descriptor.service_type, t):
@ -71,7 +72,7 @@ class ServiceProvider(ServiceProviderABC):
implementations.append(descriptor.implementation) implementations.append(descriptor.implementation)
continue continue
implementation = self.build_service(descriptor.service_type) implementation = self.build_service(descriptor.service_type, *args, **kwargs)
if descriptor.lifetime == ServiceLifetimeEnum.singleton: if descriptor.lifetime == ServiceLifetimeEnum.singleton:
descriptor.implementation = implementation descriptor.implementation = implementation
@ -107,7 +108,7 @@ class ServiceProvider(ServiceProviderABC):
return params return params
def build_service(self, service_type: type) -> object: def build_service(self, service_type: type, *args, **kwargs) -> object:
for descriptor in self._service_descriptors: for descriptor in self._service_descriptors:
if descriptor.service_type == service_type or issubclass(descriptor.service_type, service_type): if descriptor.service_type == service_type or issubclass(descriptor.service_type, service_type):
if descriptor.implementation is not None: if descriptor.implementation is not None:
@ -120,7 +121,7 @@ class ServiceProvider(ServiceProviderABC):
sig = signature(service_type.__init__) sig = signature(service_type.__init__)
params = self.build_by_signature(sig) params = self.build_by_signature(sig)
return service_type(*params) return service_type(*params, *args, **kwargs)
def set_scope(self, scope: ScopeABC): def set_scope(self, scope: ScopeABC):
self._scope = scope self._scope = scope
@ -131,7 +132,7 @@ class ServiceProvider(ServiceProviderABC):
) )
return sb.build() return sb.build()
def get_service(self, service_type: T) -> Optional[T]: def get_service(self, service_type: T, *args, **kwargs) -> Optional[T]:
result = self._find_service(service_type) result = self._find_service(service_type)
if result is None: if result is None:
@ -140,7 +141,7 @@ class ServiceProvider(ServiceProviderABC):
if result.implementation is not None: if result.implementation is not None:
return result.implementation return result.implementation
implementation = self.build_service(service_type) implementation = self.build_service(service_type, *args, **kwargs)
if ( if (
result.lifetime == ServiceLifetimeEnum.singleton result.lifetime == ServiceLifetimeEnum.singleton
or result.lifetime == ServiceLifetimeEnum.scoped or result.lifetime == ServiceLifetimeEnum.scoped
@ -150,7 +151,7 @@ class ServiceProvider(ServiceProviderABC):
return implementation return implementation
def get_services(self, service_type: T) -> list[Optional[T]]: def get_services(self, service_type: T, *args, **kwargs) -> list[Optional[T]]:
implementations = [] implementations = []
if typing.get_origin(service_type) != list: if typing.get_origin(service_type) != list:

View File

@ -25,14 +25,16 @@ class ServiceProviderABC(ABC):
pass pass
@abstractmethod @abstractmethod
def build_service(self, service_type: type) -> object: def build_service(self, service_type: type, *args, **kwargs) -> object:
r"""Creates instance of given type r"""Creates instance of given type
Parameter: Parameter
---------
instance_type: :class:`type` instance_type: :class:`type`
The type of the searched instance The type of the searched instance
Returns: Returns
-------
Object of the given type Object of the given type
""" """
pass pass
@ -41,7 +43,8 @@ class ServiceProviderABC(ABC):
def set_scope(self, scope: ScopeABC): def set_scope(self, scope: ScopeABC):
r"""Sets the scope of service provider r"""Sets the scope of service provider
Parameter: Parameter
---------
Object of type :class:`cpl_core.dependency_injection.scope_abc.ScopeABC` Object of type :class:`cpl_core.dependency_injection.scope_abc.ScopeABC`
Service scope Service scope
""" """
@ -51,33 +54,38 @@ class ServiceProviderABC(ABC):
def create_scope(self) -> ScopeABC: def create_scope(self) -> ScopeABC:
r"""Creates a service scope r"""Creates a service scope
Returns: Returns
-------
Object of type :class:`cpl_core.dependency_injection.scope_abc.ScopeABC` Object of type :class:`cpl_core.dependency_injection.scope_abc.ScopeABC`
""" """
pass pass
@abstractmethod @abstractmethod
def get_service(self, instance_type: Type[T]) -> Optional[T]: def get_service(self, instance_type: T, *args, **kwargs) -> Optional[T]:
r"""Returns instance of given type r"""Returns instance of given type
Parameter: Parameter
---------
instance_type: :class:`cpl_core.type.T` instance_type: :class:`cpl_core.type.T`
The type of the searched instance The type of the searched instance
Returns: Returns
-------
Object of type Optional[:class:`cpl_core.type.T`] Object of type Optional[:class:`cpl_core.type.T`]
""" """
pass pass
@abstractmethod @abstractmethod
def get_services(self, service_type: T) -> list[Optional[T]]: def get_services(self, service_type: T, *args, **kwargs) -> list[Optional[T]]:
r"""Returns instance of given type r"""Returns instance of given type
Parameter: Parameter
---------
instance_type: :class:`cpl_core.type.T` instance_type: :class:`cpl_core.type.T`
The type of the searched instance The type of the searched instance
Returns: Returns
-------
Object of type list[Optional[:class:`cpl_core.type.T`] Object of type list[Optional[:class:`cpl_core.type.T`]
""" """
pass pass
@ -86,10 +94,12 @@ class ServiceProviderABC(ABC):
def inject(cls, f=None): def inject(cls, f=None):
r"""Decorator to allow injection into static and class methods r"""Decorator to allow injection into static and class methods
Parameter: Parameter
---------
f: Callable f: Callable
Returns: Returns
-------
function function
""" """
if f is None: if f is None:
@ -100,7 +110,7 @@ class ServiceProviderABC(ABC):
if cls._provider is None: if cls._provider is None:
raise Exception(f"{cls.__name__} not build!") raise Exception(f"{cls.__name__} not build!")
injection = cls._provider.build_by_signature(signature(f)) injection = [x for x in cls._provider.build_by_signature(signature(f)) if x is not None]
return f(*injection, *args, **kwargs) return f(*args, *injection, **kwargs)
return inner return inner

View File

@ -11,15 +11,17 @@ class Event(GenerateSchematicABC):
GenerateSchematicABC.__init__(self, name, schematic, path) GenerateSchematicABC.__init__(self, name, schematic, path)
event = None event = None
event_class = None
from cpl_discord.discord_event_types_enum import DiscordEventTypesEnum from cpl_discord.discord_event_types_enum import DiscordEventTypesEnum
for event_type in DiscordEventTypesEnum: for event_type in DiscordEventTypesEnum:
event_name = event_type.value.__name__.replace("ABC", "") event_name = event_type.value.__name__.replace("ABC", "")
if event_name in name: if name.endswith(event_name):
name = name.replace(event_name, "") name = name.replace(event_name, "")
event = event_name event = event_name
event_class = event_type.value
break break
if event is None: if event is None:
@ -29,15 +31,28 @@ class Event(GenerateSchematicABC):
Console.write_line(f'\t{event_type.value.__name__.replace("ABC", "")}') Console.write_line(f'\t{event_type.value.__name__.replace("ABC", "")}')
sys.exit() sys.exit()
self._event_class = f"{event}ABC" self._event_class_name = f"{event}ABC"
self._name = f'{String.convert_to_snake_case(self._event_class.replace("ABC", ""))}_{schematic}.py' event_snake_case = String.convert_to_snake_case(self._event_class_name.replace("ABC", ""))
self._class_name = f'{self._event_class.replace("ABC", "")}{String.first_to_upper(schematic)}'
if event_snake_case.lower() not in dir(event_class):
Console.error(f"Error in event {event}: Function {event_snake_case} not found!")
sys.exit()
self._name = f"{event_snake_case}_{schematic}.py"
self._class_name = f'{self._event_class_name.replace("ABC", "")}{String.first_to_upper(schematic)}'
from inspect import signature
self._func_name = event_snake_case
self._signature = str(signature(getattr(event_class, event_snake_case)))[1:][:-1]
if name != "": if name != "":
self._name = f"{String.convert_to_snake_case(name)}_{self._name}" self._name = f"{String.convert_to_snake_case(name)}_{self._name}"
self._class_name = f"{String.first_to_upper(name)}{self._class_name}" self._class_name = f"{String.first_to_upper(name)}{self._class_name}"
def get_code(self) -> str: def get_code(self) -> str:
code = """\ code = """\
import discord
from cpl_core.logging import LoggerABC from cpl_core.logging import LoggerABC
from cpl_discord.events import $EventClass from cpl_discord.events import $EventClass
from cpl_discord.service import DiscordBotServiceABC from cpl_discord.service import DiscordBotServiceABC
@ -50,15 +65,21 @@ class Event(GenerateSchematicABC):
logger: LoggerABC, logger: LoggerABC,
bot: DiscordBotServiceABC, bot: DiscordBotServiceABC,
): ):
OnReadyABC.__init__(self) $EventClass.__init__(self)
self._logger = logger self._logger = logger
self._bot = bot self._bot = bot
async def on_ready(self): async def $Func($Signature):
pass pass
""" """
return self.build_code_str(code, Name=self._class_name, EventClass=self._event_class) return self.build_code_str(
code,
Name=self._class_name,
EventClass=self._event_class_name,
Func=self._func_name,
Signature=self._signature,
)
@classmethod @classmethod
def register(cls): def register(cls):

View File

@ -47,6 +47,11 @@ from cpl_discord.events.on_reaction_clear_emoji_abc import OnReactionClearEmojiA
from cpl_discord.events.on_reaction_remove_abc import OnReactionRemoveABC from cpl_discord.events.on_reaction_remove_abc import OnReactionRemoveABC
from cpl_discord.events.on_ready_abc import OnReadyABC from cpl_discord.events.on_ready_abc import OnReadyABC
from cpl_discord.events.on_resume_abc import OnResumeABC from cpl_discord.events.on_resume_abc import OnResumeABC
from cpl_discord.events.on_scheduled_event_create_abc import OnScheduledEventCreateABC
from cpl_discord.events.on_scheduled_event_delete_abc import OnScheduledEventDeleteABC
from cpl_discord.events.on_scheduled_event_update_abc import OnScheduledEventUpdateABC
from cpl_discord.events.on_scheduled_event_user_add_abc import OnScheduledEventUserAddABC
from cpl_discord.events.on_scheduled_event_user_remove_abc import OnScheduledEventUserRemoveABC
from cpl_discord.events.on_typing_abc import OnTypingABC from cpl_discord.events.on_typing_abc import OnTypingABC
from cpl_discord.events.on_user_update_abc import OnUserUpdateABC from cpl_discord.events.on_user_update_abc import OnUserUpdateABC
from cpl_discord.events.on_voice_state_update_abc import OnVoiceStateUpdateABC from cpl_discord.events.on_voice_state_update_abc import OnVoiceStateUpdateABC
@ -76,6 +81,11 @@ class DiscordEventTypesEnum(Enum):
on_guild_role_delete = OnGuildRoleDeleteABC on_guild_role_delete = OnGuildRoleDeleteABC
on_guild_role_update = OnGuildRoleUpdateABC on_guild_role_update = OnGuildRoleUpdateABC
on_guild_unavailable = OnGuildUnavailableABC on_guild_unavailable = OnGuildUnavailableABC
on_scheduled_event_create = OnScheduledEventCreateABC
on_scheduled_event_delete = OnScheduledEventDeleteABC
on_scheduled_event_update = OnScheduledEventUpdateABC
on_scheduled_event_user_add = OnScheduledEventUserAddABC
on_scheduled_event_user_remove = OnScheduledEventUserRemoveABC
on_guild_update = OnGuildUpdateABC on_guild_update = OnGuildUpdateABC
on_invite_create = OnInviteCreateABC on_invite_create = OnInviteCreateABC
on_invite_delete = OnInviteDeleteABC on_invite_delete = OnInviteDeleteABC

View File

@ -0,0 +1,12 @@
from abc import ABC, abstractmethod
import discord
class OnScheduledEventCreateABC(ABC):
@abstractmethod
def __init__(self):
pass
@abstractmethod
async def on_scheduled_event_create(self, event: discord.ScheduledEvent):
pass

View File

@ -0,0 +1,12 @@
from abc import ABC, abstractmethod
import discord
class OnScheduledEventDeleteABC(ABC):
@abstractmethod
def __init__(self):
pass
@abstractmethod
async def on_scheduled_event_delete(self, event: discord.ScheduledEvent):
pass

View File

@ -0,0 +1,12 @@
from abc import ABC, abstractmethod
import discord
class OnScheduledEventUpdateABC(ABC):
@abstractmethod
def __init__(self):
pass
@abstractmethod
async def on_scheduled_event_update(self, before: discord.ScheduledEvent, after: discord.ScheduledEvent):
pass

View File

@ -0,0 +1,12 @@
from abc import ABC, abstractmethod
import discord
class OnScheduledEventUserAddABC(ABC):
@abstractmethod
def __init__(self):
pass
@abstractmethod
async def on_scheduled_event_user_add(self, event: discord.ScheduledEvent, user: discord.User):
pass

View File

@ -0,0 +1,12 @@
from abc import ABC, abstractmethod
import discord
class OnScheduledEventUserRemoveABC(ABC):
@abstractmethod
def __init__(self):
pass
@abstractmethod
async def on_scheduled_event_user_remove(self, event: discord.ScheduledEvent, user: discord.User):
pass

View File

@ -21,6 +21,8 @@ class DiscordBotService(DiscordBotServiceABC):
env: ApplicationEnvironmentABC, env: ApplicationEnvironmentABC,
logging_st: LoggingSettings, logging_st: LoggingSettings,
discord_service: DiscordServiceABC, discord_service: DiscordServiceABC,
*args,
**kwargs,
): ):
# services # services
self._config = config self._config = config
@ -34,7 +36,12 @@ class DiscordBotService(DiscordBotServiceABC):
# setup super # setup super
DiscordBotServiceABC.__init__( DiscordBotServiceABC.__init__(
self, command_prefix=self._discord_settings.prefix, help_command=None, intents=discord.Intents().all() self,
*args,
command_prefix=self._discord_settings.prefix,
help_command=None,
intents=discord.Intents().all(),
**kwargs,
) )
self._base = super(DiscordBotServiceABC, self) self._base = super(DiscordBotServiceABC, self)

View File

@ -7,8 +7,8 @@ from cpl_query.extension.list import List
class DiscordBotServiceABC(commands.Bot): class DiscordBotServiceABC(commands.Bot):
def __init__(self, **kwargs): def __init__(self, *args, **kwargs):
commands.Bot.__init__(self, **kwargs) commands.Bot.__init__(self, *args, **kwargs)
@abstractmethod @abstractmethod
async def start_async(self): async def start_async(self):

View File

@ -57,6 +57,11 @@ from cpl_discord.events.on_reaction_clear_emoji_abc import OnReactionClearEmojiA
from cpl_discord.events.on_reaction_remove_abc import OnReactionRemoveABC from cpl_discord.events.on_reaction_remove_abc import OnReactionRemoveABC
from cpl_discord.events.on_ready_abc import OnReadyABC from cpl_discord.events.on_ready_abc import OnReadyABC
from cpl_discord.events.on_resume_abc import OnResumeABC from cpl_discord.events.on_resume_abc import OnResumeABC
from cpl_discord.events.on_scheduled_event_create_abc import OnScheduledEventCreateABC
from cpl_discord.events.on_scheduled_event_delete_abc import OnScheduledEventDeleteABC
from cpl_discord.events.on_scheduled_event_update_abc import OnScheduledEventUpdateABC
from cpl_discord.events.on_scheduled_event_user_add_abc import OnScheduledEventUserAddABC
from cpl_discord.events.on_scheduled_event_user_remove_abc import OnScheduledEventUserRemoveABC
from cpl_discord.events.on_typing_abc import OnTypingABC from cpl_discord.events.on_typing_abc import OnTypingABC
from cpl_discord.events.on_user_update_abc import OnUserUpdateABC from cpl_discord.events.on_user_update_abc import OnUserUpdateABC
from cpl_discord.events.on_voice_state_update_abc import OnVoiceStateUpdateABC from cpl_discord.events.on_voice_state_update_abc import OnVoiceStateUpdateABC
@ -337,6 +342,31 @@ class DiscordService(DiscordServiceABC, commands.Cog, metaclass=DiscordCogMeta):
self._logger.trace(__name__, f"Received on_guild_unavailable:\n\t{guild}") self._logger.trace(__name__, f"Received on_guild_unavailable:\n\t{guild}")
await self._handle_event(OnGuildUnavailableABC, guild) await self._handle_event(OnGuildUnavailableABC, guild)
@commands.Cog.listener()
async def on_scheduled_event_create(self, event: discord.ScheduledEvent):
self._logger.trace(__name__, f"Received on_scheduled_event_create:\n\t{event}")
await self._handle_event(OnScheduledEventCreateABC, event)
@commands.Cog.listener()
async def on_scheduled_event_delete(self, event: discord.ScheduledEvent):
self._logger.trace(__name__, f"Received on_scheduled_event_delete:\n\t{event}")
await self._handle_event(OnScheduledEventDeleteABC, event)
@commands.Cog.listener()
async def on_scheduled_event_update(self, before: discord.ScheduledEvent, after: discord.ScheduledEvent):
self._logger.trace(__name__, f"Received on_scheduled_event_update:\n\t{before}, {after}")
await self._handle_event(OnScheduledEventUpdateABC, before, after)
@commands.Cog.listener()
async def on_scheduled_event_user_add(self, event: discord.ScheduledEvent, user: discord.User):
self._logger.trace(__name__, f"Received on_scheduled_event_user_add:\n\t{event}, {user}")
await self._handle_event(OnScheduledEventUserAddABC, event, user)
@commands.Cog.listener()
async def on_scheduled_event_user_remove(self, event: discord.ScheduledEvent, user: discord.User):
self._logger.trace(__name__, f"Received on_scheduled_event_user_remove:\n\t{event}, {user}")
await self._handle_event(OnScheduledEventUserRemoveABC, event, user)
@commands.Cog.listener() @commands.Cog.listener()
async def on_voice_state_update( async def on_voice_state_update(
self, member: discord.Member, before: discord.VoiceState, after: discord.VoiceState self, member: discord.Member, before: discord.VoiceState, after: discord.VoiceState

View File

@ -21,11 +21,13 @@ class QueryableABC(Sequence):
def all(self, _func: Callable = None) -> bool: def all(self, _func: Callable = None) -> bool:
r"""Checks if every element of list equals result found by function r"""Checks if every element of list equals result found by function
Parameter: Parameter
---------
func: :class:`Callable` func: :class:`Callable`
selected value selected value
Returns: Returns
-------
bool bool
""" """
if _func is None: if _func is None:
@ -36,11 +38,13 @@ class QueryableABC(Sequence):
def any(self, _func: Callable = None) -> bool: def any(self, _func: Callable = None) -> bool:
r"""Checks if list contains result found by function r"""Checks if list contains result found by function
Parameter: Parameter
---------
func: :class:`Callable` func: :class:`Callable`
selected value selected value
Returns: Returns
-------
bool bool
""" """
if _func is None: if _func is None:
@ -51,11 +55,13 @@ class QueryableABC(Sequence):
def average(self, _func: Callable = None) -> Union[int, float, complex]: def average(self, _func: Callable = None) -> Union[int, float, complex]:
r"""Returns average value of list r"""Returns average value of list
Parameter: Parameter
---------
func: :class:`Callable` func: :class:`Callable`
selected value selected value
Returns: Returns
-------
Union[int, float, complex] Union[int, float, complex]
""" """
if _func is None and not is_number(self.type): if _func is None and not is_number(self.type):
@ -66,11 +72,13 @@ class QueryableABC(Sequence):
def contains(self, _value: object) -> bool: def contains(self, _value: object) -> bool:
r"""Checks if list contains value given by function r"""Checks if list contains value given by function
Parameter: Parameter
---------
value: :class:`object` value: :class:`object`
value value
Returns: Returns
-------
bool bool
""" """
if _value is None: if _value is None:
@ -81,11 +89,13 @@ class QueryableABC(Sequence):
def count(self, _func: Callable = None) -> int: def count(self, _func: Callable = None) -> int:
r"""Returns length of list or count of found elements r"""Returns length of list or count of found elements
Parameter: Parameter
---------
func: :class:`Callable` func: :class:`Callable`
selected value selected value
Returns: Returns
-------
int int
""" """
if _func is None: if _func is None:
@ -96,11 +106,13 @@ class QueryableABC(Sequence):
def distinct(self, _func: Callable = None) -> "QueryableABC": def distinct(self, _func: Callable = None) -> "QueryableABC":
r"""Returns list without redundancies r"""Returns list without redundancies
Parameter: Parameter
---------
func: :class:`Callable` func: :class:`Callable`
selected value selected value
Returns: Returns
-------
:class: `cpl_query.base.queryable_abc.QueryableABC` :class: `cpl_query.base.queryable_abc.QueryableABC`
""" """
if _func is None: if _func is None:
@ -121,11 +133,13 @@ class QueryableABC(Sequence):
def element_at(self, _index: int) -> any: def element_at(self, _index: int) -> any:
r"""Returns element at given index r"""Returns element at given index
Parameter: Parameter
---------
_index: :class:`int` _index: :class:`int`
index index
Returns: Returns
-------
Value at _index: any Value at _index: any
""" """
if _index is None: if _index is None:
@ -143,11 +157,13 @@ class QueryableABC(Sequence):
def element_at_or_default(self, _index: int) -> Optional[any]: def element_at_or_default(self, _index: int) -> Optional[any]:
r"""Returns element at given index or None r"""Returns element at given index or None
Parameter: Parameter
---------
_index: :class:`int` _index: :class:`int`
index index
Returns: Returns
-------
Value at _index: Optional[any] Value at _index: Optional[any]
""" """
if _index is None: if _index is None:
@ -161,7 +177,8 @@ class QueryableABC(Sequence):
def first(self) -> any: def first(self) -> any:
r"""Returns first element r"""Returns first element
Returns: Returns
-------
First element of list: any First element of list: any
""" """
if self.count() == 0: if self.count() == 0:
@ -172,7 +189,8 @@ class QueryableABC(Sequence):
def first_or_default(self) -> any: def first_or_default(self) -> any:
r"""Returns first element or None r"""Returns first element or None
Returns: Returns
-------
First element of list: Optional[any] First element of list: Optional[any]
""" """
if self.count() == 0: if self.count() == 0:
@ -183,7 +201,8 @@ class QueryableABC(Sequence):
def for_each(self, _func: Callable = None): def for_each(self, _func: Callable = None):
r"""Runs given function for each element of list r"""Runs given function for each element of list
Parameter: Parameter
---------
func: :class: `Callable` func: :class: `Callable`
function to call function to call
""" """
@ -196,7 +215,8 @@ class QueryableABC(Sequence):
def group_by(self, _func: Callable = None) -> "QueryableABC": def group_by(self, _func: Callable = None) -> "QueryableABC":
r"""Groups by func r"""Groups by func
Returns: Returns
-------
Grouped list[list[any]]: any Grouped list[list[any]]: any
""" """
if _func is None: if _func is None:
@ -219,7 +239,8 @@ class QueryableABC(Sequence):
def last(self) -> any: def last(self) -> any:
r"""Returns last element r"""Returns last element
Returns: Returns
-------
Last element of list: any Last element of list: any
""" """
if self.count() == 0: if self.count() == 0:
@ -230,7 +251,8 @@ class QueryableABC(Sequence):
def last_or_default(self) -> any: def last_or_default(self) -> any:
r"""Returns last element or None r"""Returns last element or None
Returns: Returns
-------
Last element of list: Optional[any] Last element of list: Optional[any]
""" """
if self.count() == 0: if self.count() == 0:
@ -241,11 +263,13 @@ class QueryableABC(Sequence):
def max(self, _func: Callable = None) -> object: def max(self, _func: Callable = None) -> object:
r"""Returns the highest value r"""Returns the highest value
Parameter: Parameter
---------
func: :class:`Callable` func: :class:`Callable`
selected value selected value
Returns: Returns
-------
object object
""" """
if _func is None and not is_number(self.type): if _func is None and not is_number(self.type):
@ -259,7 +283,8 @@ class QueryableABC(Sequence):
def median(self, _func=None) -> Union[int, float]: def median(self, _func=None) -> Union[int, float]:
r"""Return the median value of data elements r"""Return the median value of data elements
Returns: Returns
-------
Union[int, float] Union[int, float]
""" """
if _func is None: if _func is None:
@ -273,11 +298,13 @@ class QueryableABC(Sequence):
def min(self, _func: Callable = None) -> object: def min(self, _func: Callable = None) -> object:
r"""Returns the lowest value r"""Returns the lowest value
Parameter: Parameter
---------
func: :class:`Callable` func: :class:`Callable`
selected value selected value
Returns: Returns
-------
object object
""" """
if _func is None and not is_number(self.type): if _func is None and not is_number(self.type):
@ -288,15 +315,17 @@ class QueryableABC(Sequence):
return _func(min(self, key=_func)) return _func(min(self, key=_func))
def order_by(self, _func: Callable = None) -> "QueryableABC": def order_by(self, _func: Callable = None) -> "OrderedQueryableABC":
r"""Sorts elements by function in ascending order r"""Sorts elements by function in ascending order
Parameter: Parameter
---------
func: :class:`Callable` func: :class:`Callable`
selected value selected value
Returns: Returns
:class: `cpl_query.base.queryable_abc.QueryableABC` -------
:class: `cpl_query.base.ordered_queryable_abc.OrderedQueryableABC`
""" """
if _func is None: if _func is None:
_func = _default_lambda _func = _default_lambda
@ -305,15 +334,17 @@ class QueryableABC(Sequence):
return OrderedQueryable(self.type, sorted(self, key=_func), _func) 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) -> "OrderedQueryableABC":
r"""Sorts elements by function in descending order r"""Sorts elements by function in descending order
Parameter: Parameter
---------
func: :class:`Callable` func: :class:`Callable`
selected value selected value
Returns: Returns
:class: `cpl_query.base.queryable_abc.QueryableABC` -------
:class: `cpl_query.base.ordered_queryable_abc.OrderedQueryableABC`
""" """
if _func is None: if _func is None:
_func = _default_lambda _func = _default_lambda
@ -325,7 +356,8 @@ class QueryableABC(Sequence):
def reverse(self) -> "QueryableABC": def reverse(self) -> "QueryableABC":
r"""Reverses list r"""Reverses list
Returns: Returns
-------
:class: `cpl_query.base.queryable_abc.QueryableABC` :class: `cpl_query.base.queryable_abc.QueryableABC`
""" """
return type(self)(self._type, reversed(self._values)) return type(self)(self._type, reversed(self._values))
@ -333,7 +365,8 @@ class QueryableABC(Sequence):
def select(self, _func: Callable) -> "QueryableABC": def select(self, _func: Callable) -> "QueryableABC":
r"""Formats each element of list to a given format r"""Formats each element of list to a given format
Returns: Returns
-------
:class: `cpl_query.base.queryable_abc.QueryableABC` :class: `cpl_query.base.queryable_abc.QueryableABC`
""" """
if _func is None: if _func is None:
@ -344,7 +377,8 @@ class QueryableABC(Sequence):
def select_many(self, _func: Callable) -> "QueryableABC": def select_many(self, _func: Callable) -> "QueryableABC":
r"""Flattens resulting lists to one r"""Flattens resulting lists to one
Returns: Returns
-------
:class: `cpl_query.base.queryable_abc.QueryableABC` :class: `cpl_query.base.queryable_abc.QueryableABC`
""" """
# The line below is pain. I don't understand anything of it... # The line below is pain. I don't understand anything of it...
@ -354,10 +388,12 @@ class QueryableABC(Sequence):
def single(self) -> any: def single(self) -> any:
r"""Returns one single element of list r"""Returns one single element of list
Returns: Returns
-------
Found value: any Found value: any
Raises: Raises
------
ArgumentNoneException: when argument is None ArgumentNoneException: when argument is None
Exception: when argument is None or found more than one element Exception: when argument is None or found more than one element
""" """
@ -371,7 +407,8 @@ class QueryableABC(Sequence):
def single_or_default(self) -> Optional[any]: def single_or_default(self) -> Optional[any]:
r"""Returns one single element of list r"""Returns one single element of list
Returns: Returns
-------
Found value: Optional[any] Found value: Optional[any]
""" """
if self.count() > 1: if self.count() > 1:
@ -384,11 +421,13 @@ class QueryableABC(Sequence):
def skip(self, _index: int) -> "QueryableABC": def skip(self, _index: int) -> "QueryableABC":
r"""Skips all elements from index r"""Skips all elements from index
Parameter: Parameter
---------
_index: :class:`int` _index: :class:`int`
index index
Returns: Returns
-------
:class: `cpl_query.base.queryable_abc.QueryableABC` :class: `cpl_query.base.queryable_abc.QueryableABC`
""" """
if _index is None: if _index is None:
@ -399,11 +438,13 @@ class QueryableABC(Sequence):
def skip_last(self, _index: int) -> "QueryableABC": def skip_last(self, _index: int) -> "QueryableABC":
r"""Skips all elements after index r"""Skips all elements after index
Parameter: Parameter
---------
_index: :class:`int` _index: :class:`int`
index index
Returns: Returns
-------
:class: `cpl_query.base.queryable_abc.QueryableABC` :class: `cpl_query.base.queryable_abc.QueryableABC`
""" """
if _index is None: if _index is None:
@ -415,11 +456,13 @@ class QueryableABC(Sequence):
def sum(self, _func: Callable = None) -> Union[int, float, complex]: def sum(self, _func: Callable = None) -> Union[int, float, complex]:
r"""Sum of all values r"""Sum of all values
Parameter: Parameter
---------
func: :class:`Callable` func: :class:`Callable`
selected value selected value
Returns: Returns
-------
Union[int, float, complex] Union[int, float, complex]
""" """
if _func is None and not is_number(self.type): if _func is None and not is_number(self.type):
@ -438,11 +481,13 @@ class QueryableABC(Sequence):
r"""Splits the list by given function r"""Splits the list by given function
Parameter: Parameter
---------
func: :class:`Callable` func: :class:`Callable`
seperator seperator
Returns: Returns
-------
:class: `cpl_query.base.queryable_abc.QueryableABC` :class: `cpl_query.base.queryable_abc.QueryableABC`
""" """
groups = [] groups = []
@ -468,11 +513,13 @@ class QueryableABC(Sequence):
def take(self, _index: int) -> "QueryableABC": def take(self, _index: int) -> "QueryableABC":
r"""Takes all elements from index r"""Takes all elements from index
Parameter: Parameter
---------
_index: :class:`int` _index: :class:`int`
index index
Returns: Returns
-------
:class: `cpl_query.base.queryable_abc.QueryableABC` :class: `cpl_query.base.queryable_abc.QueryableABC`
""" """
if _index is None: if _index is None:
@ -483,11 +530,13 @@ class QueryableABC(Sequence):
def take_last(self, _index: int) -> "QueryableABC": def take_last(self, _index: int) -> "QueryableABC":
r"""Takes all elements after index r"""Takes all elements after index
Parameter: Parameter
---------
_index: :class:`int` _index: :class:`int`
index index
Returns: Returns
-------
:class: `cpl_query.base.queryable_abc.QueryableABC` :class: `cpl_query.base.queryable_abc.QueryableABC`
""" """
index = self.count() - _index index = self.count() - _index
@ -500,11 +549,13 @@ class QueryableABC(Sequence):
def where(self, _func: Callable = None) -> "QueryableABC": def where(self, _func: Callable = None) -> "QueryableABC":
r"""Select element by function r"""Select element by function
Parameter: Parameter
---------
func: :class:`Callable` func: :class:`Callable`
selected value selected value
Returns: Returns
-------
:class: `cpl_query.base.queryable_abc.QueryableABC` :class: `cpl_query.base.queryable_abc.QueryableABC`
""" """
if _func is None: if _func is None: