pytilpack 0.1.0__tar.gz

pytilpack-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 aki.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pytilpack-0.1.0/PKG-INFO

@@ -0,0 +1,42 @@
+Metadata-Version: 2.1
+Name: pytilpack
+Version: 0.1.0
+Summary: Python Utility Pack
+Home-page: https://github.com/ak110/pytilpack
+License: MIT
+Author: aki.
+Author-email: mark@aur.ll.to
+Requires-Python: >=3.11,<4.0
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3 :: Only
+Provides-Extra: all
+Provides-Extra: flask
+Provides-Extra: openai
+Provides-Extra: sqlalchemy
+Provides-Extra: tqdm
+Requires-Dist: flask (>=2.2) ; extra == "all" or extra == "flask"
+Requires-Dist: openai (>=1.25) ; extra == "all" or extra == "openai"
+Requires-Dist: sqlalchemy (>=2.0) ; extra == "all" or extra == "sqlalchemy"
+Requires-Dist: tqdm (>=4.66) ; extra == "all" or extra == "tqdm"
+Description-Content-Type: text/markdown
+
+# pytilpack
+
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Lint&Test](https://github.com/ak110/pytilpack/actions/workflows/python-app.yml/badge.svg)](https://github.com/ak110/pytilpack/actions/workflows/python-app.yml)
+[![PyPI version](https://badge.fury.io/py/pytilpack.svg)](https://badge.fury.io/py/pytilpack)
+
+Pythonの各種ライブラリのユーティリティ集。
+
+## インストール
+
+```bash
+pip install pytilpack
+```
+

pytilpack-0.1.0/README.md

@@ -0,0 +1,13 @@
+# pytilpack
+
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Lint&Test](https://github.com/ak110/pytilpack/actions/workflows/python-app.yml/badge.svg)](https://github.com/ak110/pytilpack/actions/workflows/python-app.yml)
+[![PyPI version](https://badge.fury.io/py/pytilpack.svg)](https://badge.fury.io/py/pytilpack)
+
+Pythonの各種ライブラリのユーティリティ集。
+
+## インストール
+
+```bash
+pip install pytilpack
+```

pytilpack-0.1.0/pyproject.toml

@@ -0,0 +1,80 @@
+[tool.poetry]
+name = "pytilpack"
+version = "0.1.0"  # using poetry-dynamic-versioning
+description = "Python Utility Pack"
+license = "MIT"
+authors = ["aki. <mark@aur.ll.to>"]
+readme = "README.md"
+homepage = "https://github.com/ak110/pytilpack"
+classifiers = [
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3 :: Only",
+]
+
+[tool.poetry-dynamic-versioning]
+enable = false
+style = "pep440"
+
+[tool.poetry.dependencies]
+python = ">=3.11,<4.0"
+flask = {version = ">=2.2", optional = true}
+openai = {version = ">=1.25", optional = true}
+sqlalchemy = {version = ">=2.0", optional = true}
+tqdm = {version = ">=4.66", optional = true}
+
+[tool.poetry.group.dev.dependencies]
+pyfltr = "*"
+
+[tool.poetry.extras]
+all = [
+    "flask",
+    "openai",
+    "sqlalchemy",
+    "tqdm",
+]
+flask = ["flask"]
+openai = ["openai"]
+sqlalchemy = ["sqlalchemy"]
+tqdm = ["tqdm"]
+
+[build-system]
+requires = ["poetry-core>=1.0.0", "poetry-dynamic-versioning"]
+build-backend = "poetry_dynamic_versioning.backend"
+
+[tool.pyfltr]
+pyupgrade-args = ["--py311-plus"]
+pylint-args = ["--jobs=4"]
+
+[tool.isort]
+# https://black.readthedocs.io/en/stable/guides/using_black_with_other_tools.html#isort
+# https://pycqa.github.io/isort/docs/configuration/options.html
+profile = "black"
+
+[tool.black]
+# https://black.readthedocs.io/en/stable/usage_and_configuration/the_basics.html
+target-version = ['py311']
+skip-magic-trailing-comma = true
+
+[tool.flake8]
+# https://black.readthedocs.io/en/stable/guides/using_black_with_other_tools.html#flake8
+# https://flake8.pycqa.org/en/latest/user/configuration.html
+max-line-length = 128
+extend-ignore = "E203,"
+
+[tool.mypy]
+# https://mypy.readthedocs.io/en/stable/config_file.html
+allow_redefinition = true
+check_untyped_defs = true
+ignore_missing_imports = true
+strict_optional = true
+strict_equality = true
+warn_no_return = true
+warn_redundant_casts = true
+warn_unused_configs = true
+show_error_codes = true
+
+[tool.pytest.ini_options]
+# https://docs.pytest.org/en/latest/reference/reference.html#ini-options-ref
+addopts = "--showlocals -p no:cacheprovider"

pytilpack-0.1.0/pytilpack/flask_.py

@@ -0,0 +1,61 @@
+"""Flask関連のユーティリティ。"""
+
+import base64
+import logging
+import pathlib
+import secrets
+import urllib.parse
+
+import flask
+
+logger = logging.getLogger(__name__)
+
+
+def generate_secret_key(cache_path: str | pathlib.Path) -> bytes:
+    """シークレットキーの作成/取得。
+
+    既にcache_pathに保存済みならそれを返し、でなくば作成する。
+
+    """
+    cache_path = pathlib.Path(cache_path)
+    cache_path.parent.mkdir(parents=True, exist_ok=True)
+    with cache_path.open("a+b") as secret:
+        secret.seek(0)
+        secret_key = secret.read()
+        if not secret_key:
+            secret_key = secrets.token_bytes()
+            secret.write(secret_key)
+            secret.flush()
+        return secret_key
+
+
+def data_url(data: bytes, mime_type: str) -> str:
+    """小さい画像などのバイナリデータをURLに埋め込んだものを作って返す。
+
+    Args:
+        data: 埋め込むデータ
+        mime_type: 例：'image/png'
+
+    """
+    b64 = base64.b64encode(data).decode("ascii")
+    return f"data:{mime_type};base64,{b64}"
+
+
+def get_next_url() -> str:
+    """flask_loginのnextパラメータ用のURLを返す。"""
+    path = flask.request.script_root + flask.request.path
+    query_string = flask.request.query_string.decode("utf-8")
+    next_ = f"{path}?{query_string}" if query_string else path
+    return next_
+
+
+def get_safe_url(target: str, host_url: str, default_url: str) -> str:
+    """ログイン時のリダイレクトとして安全なURLを返す。"""
+    if target is None or target == "":
+        return default_url
+    ref_url = urllib.parse.urlparse(host_url)
+    test_url = urllib.parse.urlparse(urllib.parse.urljoin(host_url, target))
+    if test_url.scheme not in ("http", "https") or ref_url.netloc != test_url.netloc:
+        logger.warning(f"Invalid next url: {target}")
+        return default_url
+    return target

pytilpack-0.1.0/pytilpack/openai_.py

@@ -0,0 +1,121 @@
+"""OpenAI Python Library用のユーティリティ集。"""
+
+import openai
+import openai.types.chat
+
+import pytilpack.python_
+
+
+def gather_chunks(
+    chunks: list[openai.types.chat.ChatCompletionChunk],
+) -> openai.types.chat.ChatCompletion:
+    """ストリーミングのチャンクを結合する。"""
+    max_choices = max(len(chunk.choices) for chunk in chunks)
+    choices = [_make_choice(chunks, i) for i in range(max_choices)]
+    return openai.types.chat.ChatCompletion(
+        id=chunks[0].id,
+        choices=choices,
+        created=chunks[0].created,
+        model=chunks[0].model,
+        object="chat.completion",
+        system_fingerprint=chunks[0].system_fingerprint,
+    )
+
+
+def _make_choice(
+    chunks: list[openai.types.chat.ChatCompletionChunk], i: int
+) -> openai.types.chat.chat_completion.Choice:
+    """ストリーミングのチャンクからChoiceを作成する。"""
+    logprobs = pytilpack.python_.coalesce(
+        c.choices[i].logprobs for c in chunks if len(c.choices) >= i
+    )
+    return openai.types.chat.chat_completion.Choice(
+        finish_reason=pytilpack.python_.coalesce(
+            (c.choices[i].finish_reason for c in chunks if len(c.choices) >= i), "stop"
+        ),
+        index=i,
+        logprobs=(
+            None
+            if logprobs is None
+            else openai.types.chat.chat_completion.ChoiceLogprobs(
+                content=logprobs.content
+            )
+        ),
+        message=openai.types.chat.ChatCompletionMessage(
+            content="".join(
+                pytilpack.python_.remove_none(
+                    c.choices[i].delta.content for c in chunks if len(c.choices) >= i
+                )
+            ),
+            # role=pytilpack.python_.coalesce(
+            #     (c.choices[i].delta.role for c in chunks if len(c.choices) >= i),
+            #     "assistant",
+            # ),
+            role="assistant",
+            function_call=_make_function_call(
+                pytilpack.python_.remove_none(
+                    c.choices[i].delta.function_call
+                    for c in chunks
+                    if len(c.choices) >= i
+                )
+            ),
+            tool_calls=_make_tool_calls(
+                pytilpack.python_.remove_none(
+                    c.choices[i].delta.tool_calls for c in chunks if len(c.choices) >= i
+                )
+            ),
+        ),
+    )
+
+
+def _make_function_call(
+    deltas: list[openai.types.chat.chat_completion_chunk.ChoiceDeltaFunctionCall],
+) -> openai.types.chat.chat_completion_message.FunctionCall | None:
+    """ChoiceDeltaFunctionCallを作成する。"""
+    if len(deltas) == 0:
+        return None
+    return openai.types.chat.chat_completion_message.FunctionCall(
+        arguments="".join(d.arguments for d in deltas if d.arguments is not None),
+        name="".join(d.name for d in deltas if d.name is not None),
+    )
+
+
+def _make_tool_calls(
+    deltas_list: list[
+        list[openai.types.chat.chat_completion_chunk.ChoiceDeltaToolCall]
+    ],
+) -> (
+    list[openai.types.chat.chat_completion_message.ChatCompletionMessageToolCall] | None
+):
+    """list[ChoiceDeltaToolCall]を作成する。"""
+    if len(deltas_list) == 0:
+        return None
+    max_tool_calls = max(len(deltas) for deltas in deltas_list)
+    if max_tool_calls == 0:
+        return None
+    return [_make_tool_call(deltas_list, i) for i in range(max_tool_calls)]
+
+
+def _make_tool_call(
+    deltas_list: list[
+        list[openai.types.chat.chat_completion_chunk.ChoiceDeltaToolCall]
+    ],
+    i: int,
+) -> openai.types.chat.chat_completion_message.ChatCompletionMessageToolCall:
+    """ChoiceDeltaToolCallを作成する。"""
+    deltas_list = [deltas for deltas in deltas_list if len(deltas) >= i]
+    functions = pytilpack.python_.remove_none(
+        deltas[i].function for deltas in deltas_list
+    )
+    return openai.types.chat.chat_completion_message.ChatCompletionMessageToolCall(
+        id=pytilpack.python_.coalesce((deltas[i].id for deltas in deltas_list), ""),
+        function=openai.types.chat.chat_completion_message_tool_call.Function(
+            arguments="".join(
+                pytilpack.python_.remove_none(f.arguments for f in functions)
+            ),
+            name="".join(pytilpack.python_.remove_none(f.name for f in functions)),
+        ),
+        type=pytilpack.python_.coalesce(
+            (deltas[i].type for deltas in deltas_list), "function"
+        ),
+    )

pytilpack-0.1.0/pytilpack/python_.py

@@ -0,0 +1,28 @@
+"""Pythonのユーティリティ集。"""
+
+import typing
+
+T = typing.TypeVar("T")
+
+
+@typing.overload
+def coalesce(iterable: typing.Iterable[T | None], default: None = None) -> T:
+    pass
+
+
+@typing.overload
+def coalesce(iterable: typing.Iterable[T | None], default: T) -> T:
+    pass
+
+
+def coalesce(iterable: typing.Iterable[T | None], default: T | None = None) -> T | None:
+    """Noneでない最初の要素を取得する。"""
+    for item in iterable:
+        if item is not None:
+            return item
+    return default
+
+
+def remove_none(iterable: typing.Iterable[T | None]) -> list[T]:
+    """Noneを除去する。"""
+    return [item for item in iterable if item is not None]

pytilpack-0.1.0/pytilpack/sqlalchemy_.py

@@ -0,0 +1,76 @@
+"""SQLAlchemy用のユーティリティ集。"""
+
+import logging
+import time
+import typing
+
+import sqlalchemy
+
+logger = logging.getLogger(__name__)
+
+
+def register_ping():
+    """コネクションプールの切断対策。"""
+
+    @sqlalchemy.event.listens_for(sqlalchemy.pool.Pool, "checkout")
+    def _ping_connection(dbapi_connection, connection_record, connection_proxy):
+        """コネクションプールの切断対策。"""
+        _ = connection_record, connection_proxy  # noqa
+        cursor = dbapi_connection.cursor()
+        try:
+            cursor.execute("SELECT 1")
+        except Exception as e:
+            raise sqlalchemy.exc.DisconnectionError() from e
+        finally:
+            cursor.close()
+
+
+class IDMixin:
+    """models.Class.query.get()がdeprecatedになるため"""
+
+    @classmethod
+    def get_by_id(
+        cls: type[typing.Self], id_: int, for_update: bool = False
+    ) -> typing.Self | None:
+        """IDを元にインスタンスを取得。"""
+        q = cls.query.filter(cls.id == id_)  # type: ignore
+        if for_update:
+            q = q.with_for_update()
+        return q.one_or_none()
+
+
+def wait_for_connection(url: str, timeout: float = 10.0) -> None:
+    """DBに接続可能になるまで待機する。"""
+    failed = False
+    start_time = time.time()
+    while True:
+        try:
+            engine = sqlalchemy.create_engine(url)
+            try:
+                with engine.connect() as connection:
+                    result = connection.execute(sqlalchemy.text("SELECT 1"))
+                try:
+                    # 接続成功
+                    if failed:
+                        logger.info("DB接続成功")
+                    break
+                finally:
+                    result.close()
+            finally:
+                engine.dispose()
+        except Exception:
+            # 接続失敗
+            if not failed:
+                failed = True
+                logger.info(f"DB接続待機中 . . . (URL: {url})")
+            if time.time() - start_time >= timeout:
+                raise
+            time.sleep(1)
+
+
+def safe_close(session: sqlalchemy.orm.Session):
+    """例外を出さずにセッションをクローズ。"""
+    try:
+        session.close()
+    except Exception:
+        pass

pytilpack-0.1.0/pytilpack/tqdm_.py

@@ -0,0 +1,24 @@
+"""tqdm用のユーティリティ集。"""
+
+import logging
+
+import tqdm
+
+
+class TqdmStreamHandler(logging.StreamHandler):
+    """tqdm対応のStreamHandler。
+
+    使用例::
+        import pytilpack.tqdm_
+
+        logging.basicConfig(
+            level=logging.INFO,
+            format="[%(levelname)s] %(message)s",
+            handlers=[pytilpack.tqdm_.TqdmStreamHandler()],
+        )
+
+    """
+
+    def emit(self, record):
+        with tqdm.tqdm.external_write_mode(file=self.stream):
+            super().emit(record)