tensorneko-util 0.3.19__tar.gz → 0.3.21__tar.gz

{tensorneko_util-0.3.19 → tensorneko_util-0.3.21}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tensorneko_util
-Version: 0.3.19
+Version: 0.3.21
 Summary: The Utils for Library TensorNeko.
 Home-page: https://github.com/ControlNet/tensorneko
 Author: ControlNet

{tensorneko_util-0.3.19 → tensorneko_util-0.3.21}/README.md

@@ -12,7 +12,7 @@
 <div align="center">    
     <a href="https://www.python.org/"><img src="https://img.shields.io/pypi/pyversions/tensorneko?style=flat-square"></a>
     <a href="https://pytorch.org/"><img src="https://img.shields.io/badge/PyTorch-%3E%3D1.9.0-EE4C2C?style=flat-square&logo=pytorch"></a>
-    <a href="https://www.pytorchlightning.ai/"><img src="https://img.shields.io/badge/Lightning-2.0.*%20|%202.1.*%20|%202.2.*-792EE5?style=flat-square&logo=lightning"></a>
+    <a href="https://www.pytorchlightning.ai/"><img src="https://img.shields.io/badge/Lightning-2.*-792EE5?style=flat-square&logo=lightning"></a>
 </div>
 
 <div align="center">
@@ -49,7 +49,7 @@ pipx install tensorneko_tool  # or `pip install tensorneko_tool`
 
 Then you can use the CLI tools `tensorneko` in the terminal.
 
-## Neko Layers, Modules and Architectures
+## Layers, Modules and Architectures
 
 Build an MLP with linear layers. The activation and normalization will be placed in the hidden layers.
 
@@ -138,7 +138,7 @@ print(f(torch.rand(16)).shape)
 # torch.Size([1])
 ```
 
-## Neko IO
+## IO
 
 Easily load and save different modal data.
 
@@ -188,7 +188,7 @@ neko.io.write.json("path/to/json.json", json_obj)
 Besides, the read/write for `mat` and `pickle` files is also supported.
 
 
-## Neko preprocessing
+## Preprocessing
 
 ```python
 import tensorneko as neko
@@ -215,7 +215,7 @@ if `ffmpeg` is available, you can use below ffmpeg wrappers.
 - `resample_video_fps`
 - `mp32wav`
 
-## Neko Visualization
+## Visualization
 
 ### Variable Web Watcher
 Start a web server to watch the variable status when the program (e.g. training, inference, data preprocessing) is running.
@@ -366,14 +366,14 @@ trainer = neko.NekoTrainer(log_every_n_steps=100, gpus=1, logger=model.name, pre
 trainer.fit(model, dm)
 ```
 
-## Neko Callbacks
+## Callbacks
 
 Some simple but useful pytorch-lightning callbacks are provided.
 
 - `DisplayMetricsCallback`
 - `EarlyStoppingLR`: Early stop training when learning rate reaches threshold.
 
-## Neko Notebook Helpers
+## Notebook Helpers
 Here are some helper functions to better interact with Jupyter Notebook.
 ```python
 import tensorneko as neko
@@ -385,7 +385,7 @@ neko.notebook.display.audio("path/to/audio.wav")
 neko.notebook.display.code("path/to/code.java")
 ```
 
-## Neko Debug Tools
+## Debug Tools
 
 Get the default values from `ArgumentParser` args. It's convenient to use this in the notebook.
 ```python
@@ -401,7 +401,7 @@ print(args.integers)  # [1, 2, 3]
 print(args.accumulate)  # <function sum at ...>
 ```
 
-## Neko Evaluation
+## Evaluation
 
 Some metrics function for evaluation are provided.
 
@@ -412,8 +412,36 @@ Some metrics function for evaluation are provided.
 - `ssim_video`
 - `ssim_image`
 
+## Message (Access to other services)
 
-## Neko Utilities
+### Gotify
+
+Send a message to the Gotify server.
+
+The title, URL and APP_TOKEN is the environment variable `GOTIFY_TITLE`, `GOTIFY_URL` and `GOTIFY_TOKEN`, or overwritten 
+in the function arguments.
+
+```python
+from tensorneko.msg import gotify
+gotify.push("This is a test message", "<URL>", "<APP_TOKEN>")
+# then the message will be sent to the Gotify server.
+# title = "<HOST_NAME>", message = "This is a test message", priority = 0
+```
+
+### Postgres
+
+Require the `psycopg` package. Provide one single function to execute one SQL query with a temp connection.
+
+The database URL is the environment variable `DB_URL`, or overwritten in the function arguments.
+```python
+from tensorneko.msg import postgres
+result = postgres.execute("<SQL>", "<DB_URL>")
+# also async version is provided
+result = await postgres.execute_async("<SQL>", "<DB_URL>")
+```
+
+
+## Utilities
 
 ### Misc functions
 

{tensorneko_util-0.3.19 → tensorneko_util-0.3.21}/src/tensorneko_util/io/json/json_writer.py

@@ -9,7 +9,7 @@ from .._path_conversion import _path2str
 class JsonWriter:
 
     @staticmethod
-    def _write_json(path: str, obj: Union[dict, list], encoding: str = "UTF-8", indent: int = 4,
+    def _write_json(path: str, obj: Union[dict, list], encoding: str = "UTF-8", indent: int = 2,
         ensure_ascii: bool = False, fast: bool = True
     ) -> None:
         if not fast:
@@ -28,7 +28,7 @@ class JsonWriter:
                 file.write(orjson.dumps(obj, option=option))
 
     @classmethod
-    def to(cls, path: Union[str, Path], obj: Union[dict, list, object], encoding: str = "UTF-8", indent: int = 4,
+    def to(cls, path: Union[str, Path], obj: Union[dict, list, object], encoding: str = "UTF-8", indent: int = 2,
         ensure_ascii: bool = False, fast: bool = True
     ) -> None:
         """
@@ -68,7 +68,7 @@ class JsonWriter:
         else:
             raise TypeError("Not implemented type. Only support dict, list, json_data.")
 
-    def __new__(cls, path: Union[str, Path], obj: Union[dict, list, object], encoding: str = "UTF-8", indent: int = 4,
+    def __new__(cls, path: Union[str, Path], obj: Union[dict, list, object], encoding: str = "UTF-8", indent: int = 2,
         ensure_ascii: bool = False, fast: bool = True
     ) -> None:
         """Alias of :meth:`~tensorneko.io.json.json_writer.JsonWriter.to`."""

tensorneko_util-0.3.21/src/tensorneko_util/msg/__init__.py

@@ -0,0 +1,9 @@
+from . import gotify
+
+__all__ = ["gotify"]
+
+try:
+    from . import postgres
+    __all__.append("postgres")
+except ImportError:
+    pass

{tensorneko_util-0.3.19 → tensorneko_util-0.3.21}/src/tensorneko_util/msg/gotify.py

@@ -6,7 +6,7 @@ from typing import Optional
 from urllib.error import HTTPError
 
 
-def push_gotify(message: str, url: Optional[str] = None, token: Optional[str] = None, title: Optional[str] = None,
+def push(message: str, url: Optional[str] = None, token: Optional[str] = None, title: Optional[str] = None,
     priority: int = 0
 ):
     """
@@ -21,7 +21,7 @@ def push_gotify(message: str, url: Optional[str] = None, token: Optional[str] =
 
     Examples::
 
-        push_gotify("This is a test message", "<URL>", "<APP_TOKEN>")
+        push("This is a test message", "<URL>", "<APP_TOKEN>")
         # then the message will be sent to the Gotify server.
         # title = "<HOST_NAME>", message = "This is a test message", priority = 0
 

tensorneko_util-0.3.21/src/tensorneko_util/msg/postgres.py

@@ -0,0 +1,66 @@
+import os
+from typing import Any, List, Optional, Tuple
+
+import psycopg
+
+
+def execute(sql: str, db_url: Optional[str] = None) -> Optional[List[Tuple[Any, ...]]]:
+    """
+    Execute a PostgreSQL database SQL query.
+
+    Args:
+        sql (``str``): The SQL query to be executed.
+        db_url (``str``, optional): The URL of the PostgreSQL database. The default value is environment variable DB_URL.
+
+    Returns:
+        ``list[tuple] | None``: The result of the query. If the query is not a SELECT query, then it will return None.
+
+    Examples::
+
+        result = execute("SELECT * FROM table_name", "postgresql://user:password@localhost:5432/db_name")
+        # then the result will be a list of tuples.
+
+        execute("INSERT INTO table_name (column1, column2) VALUES (value1, value2)", "postgresql://user:password@localhost:5432/db_name")
+        # then the execute will be executed and committed.
+    """
+    db_url = db_url or os.environ.get("DB_URL")
+
+    with psycopg.Connection.connect(db_url) as conn:
+        with conn.cursor() as cur:
+            cur.execute(sql)
+            conn.commit()
+            if cur.description:
+                return cur.fetchall()
+            return None
+
+
+async def execute_async(sql: str, db_url: Optional[str] = None) -> Optional[List[Tuple[Any, ...]]]:
+    """
+    Execute a PostgreSQL database SQL query with async.
+
+    Args:
+        sql (``str``): The SQL query to be executed.
+        db_url (``str``, optional): The URL of the PostgreSQL database. The default value is environment variable DB_URL.
+
+    Returns:
+        ``list[tuple] | None``: The result of the query. If the query is not a SELECT query, then it will return None.
+
+    Examples::
+
+        result = await execute_async("SELECT * FROM table_name", "postgresql://user:password@localhost:5432/db_name")
+        # then the result will be a list of tuples.
+
+        await execute_async("INSERT INTO table_name (column1, column2) VALUES (value1, value2)")
+        # then the execute will be executed
+    """
+    db_url = db_url or os.environ.get("DB_URL")
+
+    if db_url is None:
+        raise ValueError("DB_URL environment variable is not set.")
+
+    async with await psycopg.AsyncConnection.connect(db_url, autocommit=True) as conn:
+        async with conn.cursor() as cur:
+            await cur.execute(sql)
+            if cur.description:
+                return await cur.fetchall()
+            return None

tensorneko_util-0.3.21/src/tensorneko_util/version.txt

@@ -0,0 +1 @@
+0.3.21