lt-utils 0.0.1.dev0__tar.gz

lt_utils-0.0.1.dev0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

lt_utils-0.0.1.dev0/PKG-INFO

@@ -0,0 +1,34 @@
+Metadata-Version: 2.4
+Name: lt-utils
+Version: 0.0.1.dev0
+Summary: Collection of utilities for file, type, and basic logic handling across Python projects.
+Home-page: https://github.com/gr1336/lt-utils/
+Author: gr1336
+License: Apache Software License (Apache-2.0)
+Classifier: Development Status :: 1 - Planning
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Utilities
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.26.4
+Requires-Dist: markdown2==2.5.*
+Requires-Dist: markdownify==1.1.0
+Requires-Dist: pyperclip>=1.8.2
+Requires-Dist: textblob>=0.18.0
+Requires-Dist: pyyaml>=6.0.0
+Requires-Dist: nltk==3.9.*
+Requires-Dist: scikit-learn>=1.4.0
+Requires-Dist: spacy<4,>3.5
+Requires-Dist: numba<0.70,>=0.60.0
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: summary
+
+Collection of utilities for file, type, and basic logic handling across Python projects.

lt_utils-0.0.1.dev0/README.md

@@ -0,0 +1 @@
+Collection of utilities for file, type, and basic logic handling across Python projects.

lt_utils-0.0.1.dev0/lt_utils/__init__.py

@@ -0,0 +1,11 @@
+from . import common, files_ops, math_ops, misc_utils, texts_ops, types_utils
+
+__all__ = [
+    "common",
+    "files_ops",
+    "math_ops",
+    "misc_utils",
+    "texts_ops",
+    "types_utils",
+]
+__version__ = "0.0.1dev"

lt_utils-0.0.1.dev0/lt_utils/_internal/texts/nlp_stuff.py

@@ -0,0 +1,96 @@
+__all__ = ["nlp_instance", "nltk"]
+import subprocess
+import nltk
+import spacy
+from ...common import *
+
+
+class NPLP_BASE:
+    """To avoid re-trying to download nltk more than once per session"""
+
+    spc: spacy.Language = None
+    spc_model: str = None
+
+    nltk_modules = {
+        "stopwords": False,
+        "wordnet": False,
+        "cmudict": False,
+        "punkt": False,
+        "punkt_tab": False,
+        "averaged_perceptron_tagger": False,
+        "maxent_ne_chunker": False,
+        "words": False,
+        "maxent_ne_chunker_tab": False,
+    }
+
+    def __init__(self):
+        self.is_initialized = False
+
+    def initialize_spacy(
+        self,
+        model: Optional[
+            Literal[
+                "en_core_web_md",
+                "en_core_web_lg",
+            ]
+        ] = None,
+    ):
+        try:
+            if model is None:
+                model = "en_core_web_md"
+                if self.spc is None:
+                    self.spc = spacy.load("en_core_web_md", disable=["parser", "ner"])
+                    self.spc_model = "en_core_web_md"
+                return
+
+            if self.spc_model == model:
+                return
+            self.spc = spacy.load(model, disable=["parser", "ner"])
+            self.spc_model = model
+        except OSError:
+            print("Model not found, trying to install it!")
+            res = subprocess.run(
+                f"python -m spacy download {model}",
+                shell=True,
+                stdout=subprocess.DEVNULL,
+                stderr=subprocess.STDOUT,
+            )
+
+            self.spc = spacy.load(model, disable=["parser", "ner"])
+            self.spc_model = model
+
+    def initialize_nltk(
+        self,
+        module_name: Literal[
+            "stopwords",
+            "wordnet",
+            "cmudict",
+            "punkt",
+            "punkt_tab",
+            "averaged_perceptron_tagger",
+            "maxent_ne_chunker",
+            "words",
+            "maxent_ne_chunker_tab",
+            "all",
+        ] = "all",
+    ):
+        # TODO: Make this as standard way to handle installation, remove the "all" from the list of options, thus saving space.
+        # Removing the self.is_initialized and using 'nltk_modules' modules to check if they are already installled or not.
+        if self.is_initialized:
+            return
+        for _nllib in [
+            "stopwords",
+            "wordnet",
+            "cmudict",
+            "punkt",
+            "punkt_tab",
+            "averaged_perceptron_tagger",
+            "maxent_ne_chunker",
+            "words",
+            "maxent_ne_chunker_tab",
+        ]:
+            nltk.download(_nllib, quiet=True)
+        self.is_initialized = True
+
+
+nlp_instance = NPLP_BASE()

lt_utils-0.0.1.dev0/lt_utils/_internal/texts/requoter.py

@@ -0,0 +1,115 @@
+__all__ = ["requoter"]
+
+import re
+from typing import List
+
+_SINGLE_QUOTES_MAP = {
+    96: "'",
+    8216: "'",
+    8217: "'",
+    8219: "'",
+    10075: "'",
+    10076: "'",
+}
+
+_DOUBLE_QUOTES_MAP = {
+    8220: '"',
+    8221: '"',
+    8222: '"',
+    10080: '"',
+    12317: '"',
+    12318: '"',
+    12319: '"',
+    65282: '"',
+}
+
+
+def _get_quotes(text: str) -> List[int]:
+    """
+    Count and return the total quotes and their indexes in the given text.
+
+    Args:
+        text (str): The input text.
+
+    Returns:
+        Tuple[int, List[int]]: A tuple containing the total quotes and their indexes.
+    """
+    return [i for i, char in enumerate(text) if char == '"']
+
+
+def _clear_subquotes(text: str) -> str:
+    """
+    Remove sub-quotes and return the modified text.
+
+    Args:
+        text (str): The input text.
+
+    Returns:
+        str: The modified text without sub-quotes.
+    """
+    return re.sub("''", "'", text.translate(_SINGLE_QUOTES_MAP))
+
+
+def _simplify_quotes(text: str, simplify_everything: bool = False) -> str:
+    """
+    Replace special quotation marks with simple double quotes in the given text.
+
+    Args:
+        text (str): The input text.
+
+    Returns:
+        str: The text with special quotation marks replaced by simple double quotes.
+    """
+    res = re.sub('""', '"', text.translate(_DOUBLE_QUOTES_MAP))
+    if simplify_everything:
+        return _clear_subquotes(res)
+    return res
+
+
+def _update_text(positions: List[int], text: str, q1: str = "“", q2: str = "”") -> str:
+    """
+    Update the text by enclosing specified positions with given quotation marks.
+
+    Args:
+        positions (List[int]): A list of positions where quotation marks should be applied.
+        text (str): The input text.
+        q1 (str, optional): The opening quotation mark. Defaults to "“".
+        q2 (str, optional): The closing quotation mark. Defaults to "”".
+
+    Returns:
+        str: The updated text with specified positions enclosed by the given quotation marks.
+    """
+    split_version = [positions[i : i + 2] for i in range(0, len(positions), 2)]
+    for pair in split_version:
+        if len(pair) == 2:
+            text = (
+                text[: pair[0]]
+                + q1
+                + text[pair[0] + 1 : pair[1]]
+                + q2
+                + text[pair[1] + 1 :]
+            )
+        elif len(pair) == 1:
+            text = text[: pair[0]] + "" + text[pair[0] + 1 :]
+    return text
+
+
+def requoter(input_text: str, use_simple: bool = False) -> str:
+    """
+    Process the input text, fixing and changing the quotation style.
+
+    Args:
+        input_text (str): The text input that will be converted.
+        use_simple (bool, optional): If `True`, It will return the text with the simply quotes instead of the special markings. Defaults to False.
+
+    Returns:
+        str: The processed text with fixed and changed quotation style.
+    """
+    input_text = _simplify_quotes(input_text, use_simple)
+    if use_simple:
+        return input_text
+
+    positions = _get_quotes(input_text)
+    if not positions:
+        return input_text.replace("'", "’")
+    return _update_text(positions, input_text).replace("'", "’")

lt_utils-0.0.1.dev0/lt_utils/_internal/texts/splitter.py

@@ -0,0 +1,88 @@
+__all__ = ["SplitText"]
+
+import re
+
+
+class SplitText:
+    def __init__(self):
+        self._reset()
+
+    def _reset(self):
+        self.rv = []
+        self.split_pos = []
+        self.pos = -1
+        self.current = ""
+        self.in_quote = False
+
+    def seek(self, delta):
+        is_neg = delta < 0
+        for _ in range(abs(delta)):
+            if is_neg:
+                self.pos -= 1
+                self.current = self.current[:-1]
+            else:
+                self.pos += 1
+                self.current += self.text[self.pos]
+            if self.text[self.pos] in '"“”':
+                self.in_quote = not self.in_quote
+        return self.text[self.pos]
+
+    def peek(self, delta):
+        p = self.pos + delta
+        return self.text[p] if p < self.end_pos and p >= 0 else ""
+
+    def commit(self):
+        self.rv.append(self.current)
+        self.current = ""
+        self.split_pos = []
+
+    def __call__(
+        self,
+        text: str,
+        desired_length: int = 100,
+        max_length: int = 200,
+    ) -> list[str]:
+
+        self._reset()
+        self.text = text
+        self.end_pos = len(self.text) - 1
+        self.max_length = max_length
+        self.desired_length = desired_length
+        while self.pos < self.end_pos:
+            c = self.seek(1)
+            if len(self.current) >= self.max_length:
+                if len(self.split_pos) > 0 and len(self.current) > (
+                    self.desired_length / 2
+                ):
+                    d = self.pos - self.split_pos[-1]
+                    self.seek(-d)
+                else:
+                    while (
+                        c not in "!?.\n "
+                        and self.pos > 0
+                        and len(self.current) > self.desired_length
+                    ):
+                        c = self.seek(-1)
+                self.commit()
+            elif not self.in_quote and (
+                c in "!?\n" or (c == "." and self.peek(1) in "\n ")
+            ):
+                while (
+                    self.pos < len(self.text) - 1
+                    and len(self.current) < self.max_length
+                    and self.peek(1) in "!?."
+                ):
+                    c = self.seek(1)
+                self.split_pos.append(self.pos)
+                if len(self.current) >= self.desired_length:
+                    self.commit()
+            elif self.in_quote and self.peek(1) == '"“”' and self.peek(2) in "\n ":
+                self.seek(2)
+                self.split_pos.append(self.pos)
+        self.rv.append(self.current)
+        self.rv = [s.strip() for s in self.rv]
+        self.rv = [
+            s for s in self.rv if len(s) > 0 and not re.match(r"^[\s\.,;:!?]*$", s)
+        ]
+
+        return self.rv

lt_utils-0.0.1.dev0/lt_utils/common.py

@@ -0,0 +1,102 @@
+__all__ = [
+    "ABC",
+    "abstractmethod",
+    "Union",
+    "Literal",
+    "Optional",
+    "Callable",
+    "Dict",
+    "List",
+    "Tuple",
+    "Mapping",
+    "Set",
+    "TypedDict",
+    "TypeAlias",
+    "AnyStr",
+    "Array",
+    "Path",
+    "Deque",
+    "Any",
+    "TypeGuard",
+    "TYPE_CHECKING",
+    "Annotated",
+    "ClassVar",
+    "Sequence",
+    "namedtuple",
+    "OrderedDict",
+    "overload",
+    "TypeVar",
+    "DefaultDict",
+    "AbstractSet",
+    "Generator",
+    "NamedTuple",
+    "PathType",
+    "Iterable",
+    "Iterator",
+    "Sized",
+    "Text",
+    "Self",
+    "NotRequired",
+    "NoReturn",
+    "PathLike",
+    "Unpack",
+    "Number",
+    "Type",
+    "T",
+    # related functions
+    "get_args",
+    "get_origin",
+    "get_overloads",
+    "get_type_hints",
+]
+
+from abc import ABC, abstractmethod
+
+from typing import (
+    Any,
+    Union,
+    Optional,
+    Literal,
+    Callable,
+    Generator,
+    NamedTuple,
+    Iterable,
+    Iterator,
+    Sized,
+    Dict,
+    List,
+    Tuple,
+    Type,
+    Mapping,
+    Set,
+    Deque,
+    DefaultDict,
+    TypedDict,
+    TypeAlias,
+    TypeGuard,
+    NotRequired,
+    TYPE_CHECKING,
+    Sequence,
+    TypeVar,
+    Annotated,
+    AbstractSet,
+    NoReturn,
+    ClassVar,
+    Unpack,
+    Self,
+    overload,
+    get_args,
+    get_origin,
+    get_overloads,
+    get_type_hints,
+)
+from numbers import Number
+from collections import namedtuple, OrderedDict
+from pathlib import Path
+from os import PathLike
+
+T = TypeVar("T")  # Any type.
+PathType: TypeAlias = Union[PathLike, str, bytes]
+Text: TypeAlias = Union[str, bytes]
+AnyStr: TypeAlias = Union[bytes, str]
+Array: TypeAlias = Union[list, tuple]