Loglan-Core 0.2.5__tar.gz → 0.3.0__tar.gz

{Loglan-Core-0.2.5 → loglan_core-0.3.0/Loglan_Core.egg-info}/PKG-INFO

@@ -1,14 +1,14 @@
 Metadata-Version: 2.1
 Name: Loglan-Core
-Version: 0.2.5
+Version: 0.3.0
 Summary: Loglan Dictionary Database Model for SQLAlchemy
 Home-page: https://github.com/torrua/loglan_core
-Download-URL: https://github.com/torrua/loglan_core/archive/0.2.5.tar.gz
+Download-URL: https://github.com/torrua/loglan_core/archive/0.3.0.tar.gz
 Author: torrua
 Author-email: torrua@gmail.com
 License: MIT
 Keywords: Loglan,Dictionary,Database,Model,LOD
-Classifier: Development Status :: 4 - Beta
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Science/Research
 Classifier: Topic :: Database
@@ -26,14 +26,17 @@ Requires-Dist: sqlalchemy>=2.0.21
 ![Codecov](https://img.shields.io/codecov/c/github/torrua/loglan_core?logo=Codecov&logoColor=%23F01F7A&label=codecov)
 ![Scrutinizer code quality (GitHub/Bitbucket)](https://img.shields.io/scrutinizer/quality/g/torrua/loglan_core/main?logo=Scrutinizer%20CI&logoColor=%238A9296&label=Scrutinizer%20CC&link=https%3A%2F%2Fscrutinizer-ci.com%2Fg%2Ftorrua%2Floglan_core%2F%3Fbranch%3Dmain)
 ![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability-percentage/torrua/loglan_core?logo=Code%20Climate)
-[![Pylint](https://github.com/torrua/loglan_core/actions/workflows/pylint.yml/badge.svg)](https://github.com/torrua/loglan_core/actions/workflows/pylint.yml)
+![pylint](https://img.shields.io/badge/PyLint-10.00-brightgreen?logo=python&logoColor=white)
 [![Pytest](https://github.com/torrua/loglan_core/actions/workflows/pytest.yml/badge.svg)](https://github.com/torrua/loglan_core/actions/workflows/pytest.yml)
-![pylint](https://img.shields.io/badge/pylint-9.95-yellow?logo=python&logoColor=white)
+![Bandit Status](https://img.shields.io/github/actions/workflow/status/torrua/loglan_core/bandit.yml?label=bandit)
+![Black Status](https://img.shields.io/github/actions/workflow/status/torrua/loglan_core/black.yml?label=Black&labelColor=black)
+
 ![PyPI - Downloads](https://img.shields.io/pypi/dm/loglan_core?color=yellow)
 ![PyPI - Version](https://img.shields.io/pypi/v/loglan-core?logo=PyPi&logoColor=%23FFFFFF)
 ![GitHub License](https://img.shields.io/github/license/torrua/loglan_core)
 
 
+
 # SQLAlchemy Database Model for Loglan Dictionary
 
 This project represent a SQLAlchemy database model for the dictionary of [constructed language Loglan](http://www.loglan.org/). 

{Loglan-Core-0.2.5 → loglan_core-0.3.0}/Loglan_Core.egg-info/SOURCES.txt

@@ -20,7 +20,6 @@ loglan_core/syllable.py
 loglan_core/table_names.py
 loglan_core/type.py
 loglan_core/word.py
-loglan_core/word_source.py
 loglan_core/word_spell.py
 loglan_core/addons/__init__.py
 loglan_core/addons/base_selector.py
@@ -28,6 +27,7 @@ loglan_core/addons/definition_selector.py
 loglan_core/addons/export_word_converter.py
 loglan_core/addons/exporter.py
 loglan_core/addons/key_selector.py
+loglan_core/addons/utils.py
 loglan_core/addons/word_linker.py
 loglan_core/addons/word_selector.py
 loglan_core/addons/word_sourcer.py

{Loglan-Core-0.2.5/Loglan_Core.egg-info → loglan_core-0.3.0}/PKG-INFO

@@ -1,14 +1,14 @@
 Metadata-Version: 2.1
 Name: Loglan-Core
-Version: 0.2.5
+Version: 0.3.0
 Summary: Loglan Dictionary Database Model for SQLAlchemy
 Home-page: https://github.com/torrua/loglan_core
-Download-URL: https://github.com/torrua/loglan_core/archive/0.2.5.tar.gz
+Download-URL: https://github.com/torrua/loglan_core/archive/0.3.0.tar.gz
 Author: torrua
 Author-email: torrua@gmail.com
 License: MIT
 Keywords: Loglan,Dictionary,Database,Model,LOD
-Classifier: Development Status :: 4 - Beta
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Science/Research
 Classifier: Topic :: Database
@@ -26,14 +26,17 @@ Requires-Dist: sqlalchemy>=2.0.21
 ![Codecov](https://img.shields.io/codecov/c/github/torrua/loglan_core?logo=Codecov&logoColor=%23F01F7A&label=codecov)
 ![Scrutinizer code quality (GitHub/Bitbucket)](https://img.shields.io/scrutinizer/quality/g/torrua/loglan_core/main?logo=Scrutinizer%20CI&logoColor=%238A9296&label=Scrutinizer%20CC&link=https%3A%2F%2Fscrutinizer-ci.com%2Fg%2Ftorrua%2Floglan_core%2F%3Fbranch%3Dmain)
 ![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability-percentage/torrua/loglan_core?logo=Code%20Climate)
-[![Pylint](https://github.com/torrua/loglan_core/actions/workflows/pylint.yml/badge.svg)](https://github.com/torrua/loglan_core/actions/workflows/pylint.yml)
+![pylint](https://img.shields.io/badge/PyLint-10.00-brightgreen?logo=python&logoColor=white)
 [![Pytest](https://github.com/torrua/loglan_core/actions/workflows/pytest.yml/badge.svg)](https://github.com/torrua/loglan_core/actions/workflows/pytest.yml)
-![pylint](https://img.shields.io/badge/pylint-9.95-yellow?logo=python&logoColor=white)
+![Bandit Status](https://img.shields.io/github/actions/workflow/status/torrua/loglan_core/bandit.yml?label=bandit)
+![Black Status](https://img.shields.io/github/actions/workflow/status/torrua/loglan_core/black.yml?label=Black&labelColor=black)
+
 ![PyPI - Downloads](https://img.shields.io/pypi/dm/loglan_core?color=yellow)
 ![PyPI - Version](https://img.shields.io/pypi/v/loglan-core?logo=PyPi&logoColor=%23FFFFFF)
 ![GitHub License](https://img.shields.io/github/license/torrua/loglan_core)
 
 
+
 # SQLAlchemy Database Model for Loglan Dictionary
 
 This project represent a SQLAlchemy database model for the dictionary of [constructed language Loglan](http://www.loglan.org/). 

{Loglan-Core-0.2.5 → loglan_core-0.3.0}/README.md

@@ -3,14 +3,17 @@
 ![Codecov](https://img.shields.io/codecov/c/github/torrua/loglan_core?logo=Codecov&logoColor=%23F01F7A&label=codecov)
 ![Scrutinizer code quality (GitHub/Bitbucket)](https://img.shields.io/scrutinizer/quality/g/torrua/loglan_core/main?logo=Scrutinizer%20CI&logoColor=%238A9296&label=Scrutinizer%20CC&link=https%3A%2F%2Fscrutinizer-ci.com%2Fg%2Ftorrua%2Floglan_core%2F%3Fbranch%3Dmain)
 ![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability-percentage/torrua/loglan_core?logo=Code%20Climate)
-[![Pylint](https://github.com/torrua/loglan_core/actions/workflows/pylint.yml/badge.svg)](https://github.com/torrua/loglan_core/actions/workflows/pylint.yml)
+![pylint](https://img.shields.io/badge/PyLint-10.00-brightgreen?logo=python&logoColor=white)
 [![Pytest](https://github.com/torrua/loglan_core/actions/workflows/pytest.yml/badge.svg)](https://github.com/torrua/loglan_core/actions/workflows/pytest.yml)
-![pylint](https://img.shields.io/badge/pylint-9.95-yellow?logo=python&logoColor=white)
+![Bandit Status](https://img.shields.io/github/actions/workflow/status/torrua/loglan_core/bandit.yml?label=bandit)
+![Black Status](https://img.shields.io/github/actions/workflow/status/torrua/loglan_core/black.yml?label=Black&labelColor=black)
+
 ![PyPI - Downloads](https://img.shields.io/pypi/dm/loglan_core?color=yellow)
 ![PyPI - Version](https://img.shields.io/pypi/v/loglan-core?logo=PyPi&logoColor=%23FFFFFF)
 ![GitHub License](https://img.shields.io/github/license/torrua/loglan_core)
 
 
+
 # SQLAlchemy Database Model for Loglan Dictionary
 
 This project represent a SQLAlchemy database model for the dictionary of [constructed language Loglan](http://www.loglan.org/). 

{Loglan-Core-0.2.5 → loglan_core-0.3.0}/loglan_core/__init__.py

@@ -2,6 +2,8 @@
 Main point for export DB models
 """
 
+# fmt: off
+
 __author__ = "torrua"
 __copyright__ = "Copyright 2024, loglan_core project"
 __email__ = "torrua@gmail.com"
@@ -19,7 +21,7 @@ from loglan_core.setting import BaseSetting as Setting
 from loglan_core.syllable import BaseSyllable as Syllable
 from loglan_core.type import BaseType as Type
 from loglan_core.word import BaseWord as Word
-from loglan_core.word_source import BaseWordSource as WordSource
 from loglan_core.word_spell import BaseWordSpell as WordSpell
+
 from loglan_core.base import BaseModel as Base
 from loglan_core.addons.word_selector import WordSelector

loglan_core-0.3.0/loglan_core/addons/base_selector.py

@@ -0,0 +1,202 @@
+"""
+This module provides a base selector for SQLAlchemy
+"""
+
+from __future__ import annotations
+
+from typing import Any, Type
+from typing_extensions import Self
+
+from sqlalchemy import Select, BinaryExpression
+from sqlalchemy.orm import Session, InstrumentedAttribute
+
+from loglan_core.base import BaseModel
+
+
+class BaseSelector(Select):  # pylint: disable=too-many-ancestors
+    """
+    A custom base selector that inherits from SQLAlchemy's Select class.
+    This class provides methods to execute a session and fetch results
+    in different ways. It also provides a way to fetch many results.
+
+    Methods:
+    --------
+    execute(session: Session) -> ResultProxy:
+        Executes the session and returns the result.
+
+    all(session: Session) -> List[ResultRow]:
+        Executes the session and returns all the results.
+
+    scalar(session: Session) -> Any:
+        Executes the session and returns a scalar result.
+
+    fetchmany(session: Session, size: int | None = None) -> List[ResultRow]:
+        Executes the session and fetches a specified number of results.
+
+    condition_by_attribute(
+        class_: Type[BaseModel],
+        attr: InstrumentedAttribute | str,
+        value: Any,
+        is_sqlite: bool = False,
+        case_sensitive: bool = False,
+    ) -> BinaryExpression:
+        Creates a filter to select items by a specific attribute value.
+        Support wildcard and case-sensitive search.
+    """
+
+    def execute(self, session: Session):
+        """
+        Executes the given session and returns the result.
+
+        Args:
+        session (Session): SQLAlchemy Session object.
+
+        Returns:
+        ResultProxy: The result of the executed session.
+        """
+        return session.execute(self)
+
+    def all(self, session: Session):
+        """
+        Executes the given session and returns all the results as a list.
+
+        Args:
+        session (Session): SQLAlchemy Session object.
+
+        Returns:
+        List[ResultRow]: All the results of the executed session.
+        """
+        return self.execute(session).scalars().all()
+
+    def scalar(self, session: Session):
+        """
+        Executes the given session and returns a scalar result.
+
+        Args:
+        session (Session): SQLAlchemy Session object.
+
+        Returns:
+        Any: The scalar result of the executed session.
+        """
+        return self.execute(session).scalar()
+
+    def fetchmany(self, session: Session, size: int | None = None):
+        """
+        Executes the given session and fetches a specified number of results.
+
+        Args:
+        session (Session): SQLAlchemy Session object.
+        size (int, optional): Number of results to fetch. If None, fetches all results.
+
+        Returns:
+        List[ResultRow]: The fetched results.
+        """
+        return self.execute(session).scalars().fetchmany(size)
+
+    @classmethod
+    def condition_by_attribute(
+        cls,
+        class_: Type[BaseModel],
+        attr: InstrumentedAttribute | str,
+        value: Any,
+        is_sqlite: bool = False,
+        case_sensitive: bool = False,
+    ) -> BinaryExpression:
+        """
+        Applies a filter to select words by a specific attribute value.
+
+        Args:
+            class_ (BaseModel): The class to select from.
+            attr (str): The attribute to filter by.
+            value (Any): The value of the attribute to filter by.
+            is_sqlite (bool): If SQLite is being used. Defaults to False.
+            case_sensitive (bool): Whether the search should be case-sensitive.
+                Defaults to False.
+        Returns:
+            BaseSelector: A query with the filter applied.
+        """
+
+        cls._is_class_acceptable(class_)
+        attr = cls._get_attr(class_, attr)
+
+        value = str(value).replace("*", "%")
+
+        if case_sensitive:
+            return attr.op("GLOB")(value) if is_sqlite else attr.like(value)
+        return attr.ilike(value)
+
+    @staticmethod
+    def _get_attr(
+        class_: Type[BaseModel],
+        attr: InstrumentedAttribute | str,
+    ) -> InstrumentedAttribute:
+        """
+        Gets the attribute from the class.
+
+        Args:
+            class_ (BaseModel): The class to get the attribute from.
+            attr (str | InstrumentedAttribute): The attribute to get.
+
+        Raises:
+            AttributeError: If the attribute is not found in the class.
+
+        Returns:
+            InstrumentedAttribute: The attribute from the class.
+        """
+        if isinstance(attr, str):
+            try:
+                return getattr(class_, attr)
+            except AttributeError as exc:
+                raise AttributeError(
+                    f"Provided attribute={attr} is not an attribute of {class_}"
+                ) from exc
+        return attr
+
+    @staticmethod
+    def _is_class_acceptable(class_: Type[BaseModel]):
+        """
+        Checks if the class is an instance of BaseModel or its child.
+
+        Args:
+            class_ (Type[BaseModel]): The class to check.
+
+        Raises:
+            ValueError: If the class is not an instance of BaseModel or its child.
+        """
+        if not issubclass(class_, BaseModel):
+            raise ValueError(
+                f"Provided class_={class_} is not a {BaseModel} or its child"
+            )
+
+    def by_attrs(
+        self,
+        class_: Type[BaseModel],
+        is_sqlite: bool = False,
+        case_sensitive: bool = False,
+        **kwargs,
+    ) -> Self:
+        """
+        Selects all words by a set of attributes.
+
+        Args:
+            class_ (Type[BaseModel]): The class to select from.
+            is_sqlite (bool): If SQLite is being used. Defaults to False.
+            case_sensitive (bool): Whether the search should be case-sensitive.
+                Defaults to False.
+            **kwargs: A set of attributes to filter by.
+
+        Returns:
+            BaseSelector: A query with the filter applied.
+        """
+        return self.where(
+            *{
+                self.condition_by_attribute(
+                    class_,
+                    k,
+                    v,
+                    is_sqlite=is_sqlite,
+                    case_sensitive=case_sensitive,
+                )
+                for k, v in kwargs.items()
+            }
+        )

{Loglan-Core-0.2.5 → loglan_core-0.3.0}/loglan_core/addons/definition_selector.py

@@ -11,9 +11,16 @@ Classes:
 
 from __future__ import annotations
 
-from sqlalchemy import select
+from typing import cast
+
+from sqlalchemy import select, true
 
 from loglan_core.addons.base_selector import BaseSelector
+from loglan_core.addons.utils import (
+    filter_word_by_event_id,
+    filter_key_by_word_cs,
+    filter_key_by_language,
+)
 from loglan_core.connect_tables import t_connect_keys
 from loglan_core.definition import BaseDefinition
 from loglan_core.key import BaseKey
@@ -86,10 +93,10 @@ class DefinitionSelector(BaseSelector):  # pylint: disable=too-many-ancestors
             select(self.class_.id)
             .join(t_connect_keys)
             .join(BaseWord)
-            .where(BaseWord.filter_by_event_id(event_id))
+            .where(filter_word_by_event_id(event_id))
             .scalar_subquery()
         )
-        return self.where(self.class_.id.in_(subquery))
+        return cast(DefinitionSelector, self.where(self.class_.id.in_(subquery)))
 
     def by_key(
         self,
@@ -111,17 +118,13 @@ class DefinitionSelector(BaseSelector):  # pylint: disable=too-many-ancestors
         """
 
         search_key = key.word if isinstance(key, BaseKey) else str(key)
-        filter_key = BaseKey.filter_by_key_cs(
-            search_key, case_sensitive, self.is_sqlite
-        )
-        filter_language = BaseKey.filter_by_language(
+        filter_key = filter_key_by_word_cs(search_key, case_sensitive, self.is_sqlite)
+        filter_language = filter_key_by_language(
             key.language if isinstance(key, BaseKey) else language
         )
 
-        statement = self.join(self.class_.relationship_keys).filter(
-            filter_key, filter_language
-        )
-        return statement.distinct()
+        statement = self.join(self.class_.keys).filter(filter_key, filter_language)
+        return cast(DefinitionSelector, statement.distinct())
 
     def by_language(self, language: str | None = None) -> DefinitionSelector:
         """
@@ -134,4 +137,5 @@ class DefinitionSelector(BaseSelector):  # pylint: disable=too-many-ancestors
         Returns:
             DefinitionSelector: The filtered DefinitionSelector instance.
         """
-        return self.filter(self.class_.filter_language(language))
+        filter_language = self.class_.language == language if language else true()
+        return cast(DefinitionSelector, self.filter(filter_language))

{Loglan-Core-0.2.5 → loglan_core-0.3.0}/loglan_core/addons/export_word_converter.py

@@ -1,6 +1,7 @@
 """
 This module contains ExportWordConverter for Word model of LOD.
 """
+
 from loglan_core.word import BaseWord
 
 
@@ -59,7 +60,9 @@ class ExportWordConverter:
         Returns:
             str: A string with the names of the complexes separated by a vertical bar.
         """
-        return " | ".join(cpx.name for cpx in self.word.complexes)
+        return " | ".join(
+            cpx.name for cpx in self.word.derivatives if cpx.type.group == "Cpx"
+        )
 
     @property
     def e_affixes(self) -> str:
@@ -69,7 +72,11 @@ class ExportWordConverter:
         Returns:
             str: A string containing all affixes of the word with hyphens removed.
         """
-        return " ".join(afx.name.replace("-", "") for afx in self.word.affixes).strip()
+        return " ".join(
+            afx.name.replace("-", "")
+            for afx in self.word.derivatives
+            if afx.type.type_x == "Affix"
+        ).strip()
 
     @property
     def e_djifoa(self) -> str:

{Loglan-Core-0.2.5 → loglan_core-0.3.0}/loglan_core/addons/exporter.py

@@ -2,8 +2,8 @@
 This module contains an "Export extensions" for LOD dictionary SQL model.
 Add export() function to db object for returning its text string presentation.
 """
-from typing import Iterable, Callable, Type
 
+from typing import Iterable, Callable, Type
 
 from loglan_core.addons.export_word_converter import ExportWordConverter
 from loglan_core.author import BaseAuthor
@@ -42,6 +42,9 @@ class Exporter:
         ValueError: If the object type is not supported for export.
     """
 
+    FORMAT_DATE_EVENT = "%m/%d/%Y"
+    FORMAT_DATE_SETTING = "%d.%m.%Y %H:%M:%S"
+
     @classmethod
     def export(cls, obj, separator: str = DEFAULT_SEPARATOR) -> str:
         """
@@ -102,8 +105,8 @@ class Exporter:
         """
         return obj.abbreviation, obj.full_name, obj.notes
 
-    @staticmethod
-    def export_event(obj: BaseEvent) -> tuple:
+    @classmethod
+    def export_event(cls, obj: BaseEvent) -> tuple:
         """
         Prepare Event data for exporting to text file
 
@@ -113,7 +116,7 @@ class Exporter:
         return (
             obj.event_id,
             obj.name,
-            obj.date.strftime("%m/%d/%Y"),  # TODO Add format as class constant
+            obj.date.strftime(cls.FORMAT_DATE_EVENT),
             obj.definition,
             obj.annotation,
             obj.suffix,
@@ -127,10 +130,10 @@ class Exporter:
         Returns:
             tuple: elements for export
         """
-        return obj.name, obj.type, str(obj.allowed)
+        return obj.name, obj.type_, str(obj.allowed)
 
-    @staticmethod
-    def export_setting(obj: BaseSetting) -> tuple:
+    @classmethod
+    def export_setting(cls, obj: BaseSetting) -> tuple:
         """
         Prepare Setting data for exporting to text file
 
@@ -138,7 +141,7 @@ class Exporter:
             tuple: elements for export
         """
         return (
-            obj.date.strftime("%d.%m.%Y %H:%M:%S"),  # TODO Add format as class constant
+            obj.date.strftime(cls.FORMAT_DATE_SETTING),
             obj.db_version,
             obj.last_word_id,
             obj.db_release,
@@ -153,7 +156,7 @@ class Exporter:
             tuple: elements for export
         """
         return (
-            obj.type,
+            obj.type_,
             obj.type_x,
             obj.group,
             str(obj.parentable),
@@ -175,7 +178,7 @@ class Exporter:
         origin = ewc.stringer(obj.origin)
         return (
             obj.id_old,
-            obj.type.type,
+            obj.type.type_,
             obj.type.type_x,
             ewc.e_affixes,
             match,

{Loglan-Core-0.2.5 → loglan_core-0.3.0}/loglan_core/addons/key_selector.py

@@ -23,9 +23,16 @@ This allows for flexible and powerful querying of keys in a codebase.
 
 from __future__ import annotations
 
+from typing import cast
+
 from sqlalchemy import select
 
 from loglan_core.addons.base_selector import BaseSelector
+from loglan_core.addons.utils import (
+    filter_word_by_event_id,
+    filter_key_by_word_cs,
+    filter_key_by_language,
+)
 from loglan_core.connect_tables import t_connect_keys
 from loglan_core.definition import BaseDefinition
 from loglan_core.key import BaseKey
@@ -87,10 +94,10 @@ class KeySelector(BaseSelector):  # pylint: disable=too-many-ancestors
             .join(t_connect_keys)
             .join(BaseDefinition)
             .join(BaseWord)
-            .where(BaseWord.filter_by_event_id(event_id))
+            .where(filter_word_by_event_id(event_id))
             .scalar_subquery()
         )
-        return self.where(self.class_.id.in_(subquery))
+        return cast(KeySelector, self.where(self.class_.id.in_(subquery)))
 
     def by_key(self, key: str, case_sensitive: bool = False) -> KeySelector:
         """
@@ -104,8 +111,9 @@ class KeySelector(BaseSelector):  # pylint: disable=too-many-ancestors
         Returns:
             KeySelector: The filtered KeySelector instance.
         """
-        return self.where(
-            self.class_.filter_by_key_cs(key, case_sensitive, self.is_sqlite)
+        return cast(
+            KeySelector,
+            self.where(filter_key_by_word_cs(key, case_sensitive, self.is_sqlite)),
         )
 
     def by_language(self, language: str | None = None) -> KeySelector:
@@ -119,4 +127,28 @@ class KeySelector(BaseSelector):  # pylint: disable=too-many-ancestors
         Returns:
             KeySelector: The filtered KeySelector instance.
         """
-        return self.where(self.class_.filter_by_language(language))
+        return cast(KeySelector, self.where(filter_key_by_language(language)))
+
+    def by_word_id(self, word_id: int) -> KeySelector:
+        """
+        Filters the keys by the given word ID.
+
+        Args:
+            word_id (int): The identifier of the word to filter by.
+
+        Returns:
+            KeySelector: The filtered KeySelector instance.
+
+        Keep in mind that duplicated keys from related definitions
+        will be counted with ```.count()``` but excluded from ```.all()``` request
+
+        """
+        return cast(
+            KeySelector,
+            self.distinct()
+            .join(t_connect_keys)
+            .join(BaseDefinition, BaseDefinition.id == t_connect_keys.c.DID)
+            .join(BaseWord, BaseWord.id == BaseDefinition.word_id)
+            .filter(BaseWord.id == word_id)
+            .order_by(BaseKey.word.asc()),
+        )

loglan_core-0.3.0/loglan_core/addons/utils.py

@@ -0,0 +1,61 @@
+"""
+This module provides utility functions for the loglan_core package.
+"""
+
+from __future__ import annotations
+
+from sqlalchemy import select, true, func
+from sqlalchemy.sql.elements import BinaryExpression
+from sqlalchemy.sql.elements import BooleanClauseList
+from sqlalchemy.sql.expression import ColumnElement
+
+from loglan_core.event import BaseEvent
+from loglan_core.key import BaseKey
+from loglan_core.word import BaseWord
+
+
+def filter_word_by_event_id(event_id: int | None) -> BooleanClauseList:
+    """
+    Returns a filter condition to select words associated with a specific event.
+
+    Args:
+        event_id: The id of the event to filter by. Defaults to None.
+
+    Returns:
+        BooleanClauseList: A filter condition to select words associated with a specific event.
+    """
+    latest_id = select(func.max(BaseEvent.event_id)).scalar_subquery()
+    event_id_filter = event_id or latest_id
+    start_id_condition = BaseWord.event_start_id <= event_id_filter
+    end_id_condition = (
+        BaseWord.event_end_id > event_id_filter
+    ) | BaseWord.event_end_id.is_(None)
+    return start_id_condition & end_id_condition
+
+
+def filter_key_by_word_cs(
+    key: str,
+    case_sensitive: bool = False,
+    is_sqlite: bool = False,
+) -> BinaryExpression:
+    """case sensitive name filter"""
+    key = str(key).replace("*", "%")
+    return (
+        (BaseKey.word.op("GLOB")(key) if is_sqlite else BaseKey.word.like(key))
+        if case_sensitive
+        else BaseKey.word.ilike(key)
+    )
+
+
+def filter_key_by_language(language: str | None = None) -> ColumnElement[bool]:
+    """
+    Filter the language of the base key.
+
+    Args:
+        language (str or None): The language to filter by.
+        If None, no language filter will be applied.
+
+    Returns:
+        ColumnElement[bool]: A filter condition for the base key's language.
+    """
+    return (BaseKey.language == language) if language else true()