common-util-py 0.0.23__py3-none-any.whl

cli/__init__.py

@@ -0,0 +1,22 @@
+# -*- coding: utf-8 -*-
+"""
+cli module
+"""
+
+import subprocess
+from . import timeout
+
+
+def run(command):
+    """
+    Run a command and return the output and error.
+    """
+    # bashCommand = "cwm --rdf test.rdf --ntriples > test.nt"
+    with subprocess.Popen(command.split(), stdout=subprocess.PIPE) as process:
+        output, error = process.communicate()
+    return (output, error)
+
+
+__all__ = [
+    "timeout",
+]

cli/test_timeout.py

@@ -0,0 +1,98 @@
+# -*- coding: utf-8 -*-
+"""
+Unit tests for timeout.py
+"""
+
+from unittest import mock
+import sys
+import subprocess
+import signal
+
+import pytest
+
+from cli import timeout
+
+
+def test_timeout_exception():
+    """Test that TimeoutException is raised by the handler."""
+    with pytest.raises(timeout.TimeoutException):
+        timeout.timeout_handler(signal.SIGALRM, None)
+
+
+def test_cuda_exception():
+    """Test CUDAException can be raised and caught."""
+    with pytest.raises(timeout.CUDAException):
+        raise timeout.CUDAException("CUDA error detected")
+
+
+def test_env_timeout(monkeypatch):
+    """Test TIMEOUT_NO_ACTIVITY_SECONDS env var parsing."""
+    monkeypatch.setenv("TIMEOUT_NO_ACTIVITY_SECONDS", "123")
+    import importlib
+    from cli import timeout as t_reload
+
+    importlib.reload(t_reload)
+    assert t_reload.TIMEOUT_NO_ACTIVITY_SECONDS == 123
+
+
+def test_execute_keyboard_interrupt(monkeypatch):
+    """Test execute handles KeyboardInterrupt and exits loop."""
+
+    class DummyProc:
+        """Patch subprocess.Popen to simulate a process"""
+
+        def __init__(self):
+            self.stdout = mock.Mock()
+            self.stdout.readline = mock.Mock(side_effect=KeyboardInterrupt)
+
+        def __enter__(self):
+            return self
+
+        def __exit__(self, exc_type, exc_val, exc_tb):
+            return False
+
+        def send_signal(self, sig):
+            """Send signal to process"""
+
+        def wait(self, timeout=None):
+            """Wait for process to finish"""
+
+    monkeypatch.setattr(subprocess, "Popen", lambda *a, **k: DummyProc())
+    # Patch signal.signal and signal.alarm to do nothing
+    monkeypatch.setattr(signal, "signal", lambda *a, **k: None)
+    monkeypatch.setattr(signal, "alarm", lambda *a, **k: None)
+    # Should exit cleanly
+    timeout.execute([sys.executable, "-c", "print('ok')"])
+
+
+'''
+def test_execute_timeout(monkeypatch):
+    """Test execute handles TimeoutException and restarts once."""
+    class DummyProc:
+        def __init__(self):
+            self.stdout = mock.Mock()
+            self.stdout.readline = mock.Mock(side_effect=["line", "", TimeoutError])
+        def __enter__(self): return self
+        def __exit__(self, exc_type, exc_val, exc_tb): return False
+        def send_signal(self, sig): pass
+        def wait(self, timeout=None): pass
+
+    monkeypatch.setattr(subprocess, "Popen", lambda *a, **k: DummyProc())
+    monkeypatch.setattr(signal, "signal", lambda *a, **k: None)
+    monkeypatch.setattr(signal, "alarm", lambda *a, **k: None)
+
+    # Add a counter to break the loop after one restart
+    call_count = {"count": 0}
+    orig_execute = timeout.execute
+
+    def limited_execute(cmd):
+        if call_count["count"] > 0:
+            return  # Exit after first restart
+        call_count["count"] += 1
+        return orig_execute(cmd)
+
+    with mock.patch("cli.timeout.logging") as mock_log:
+        monkeypatch.setattr(timeout, "execute", limited_execute)
+        timeout.execute([sys.executable, "-c", "print('ok')"])
+        assert mock_log.error.called
+'''

cli/timeout.py

@@ -0,0 +1,82 @@
+# -*- coding: utf-8 -*-
+"""
+Timeout script for CUDA applications
+
+Only work for linux since it use singal.SIGALRM
+"""
+
+import logging
+import os
+import signal
+import subprocess
+import sys
+
+
+logging.basicConfig(
+    level=logging.INFO, format="%(asctime)s [%(levelname)s] %(message)s"
+)
+
+try:
+    TIMEOUT_NO_ACTIVITY_SECONDS = int(os.getenv("TIMEOUT_NO_ACTIVITY_SECONDS", "60"))
+except (ValueError, TypeError):
+    TIMEOUT_NO_ACTIVITY_SECONDS = 60
+
+
+class CUDAException(Exception):
+    """CUDA error exception"""
+
+
+class TimeoutException(Exception):
+    """Time out exception"""
+
+
+def timeout_handler(signum, frame):
+    """Timeout handler"""
+    raise TimeoutException(
+        f"No activity from app for {TIMEOUT_NO_ACTIVITY_SECONDS} seconds"
+    )
+
+
+def execute(cmd):
+    """
+    Execute a command, restarting on CUDA errors or inactivity.
+    Args:
+        cmd (list): The command and arguments to run as a subprocess.
+    """
+    signal.signal(signal.SIGALRM, timeout_handler)
+
+    shutdown = False
+    while not shutdown:
+        with subprocess.Popen(
+            cmd,
+            bufsize=0,  # unbuffered so immediately print out
+            stdout=subprocess.PIPE,
+            stderr=subprocess.STDOUT,
+            universal_newlines=True,
+        ) as proc:
+            try:
+                signal.alarm(TIMEOUT_NO_ACTIVITY_SECONDS)
+                for line in iter(proc.stdout.readline, ""):
+                    line = line.strip()
+                    logging.info(line)
+                    if line.startswith("CUDA error"):
+                        raise CUDAException("****** Restarting due to CUDA error")
+                    signal.alarm(TIMEOUT_NO_ACTIVITY_SECONDS)
+            except (CUDAException, TimeoutException) as e:
+                logging.error(str(e))
+            except KeyboardInterrupt:
+                shutdown = True
+
+        signal.alarm(0)
+
+        proc.send_signal(signal.SIGINT)
+
+        try:
+            proc.wait(timeout=15)
+        except subprocess.TimeoutExpired:
+            logging.error("app didn't shutdown within 5 seconds")
+            proc.kill()
+
+
+if __name__ == "__main__":
+    execute(sys.argv[1:])

common_util_py-0.0.23.dist-info/METADATA

@@ -0,0 +1,122 @@
+Metadata-Version: 2.4
+Name: common_util_py
+Version: 0.0.23
+Summary: Common Python utility modules
+Home-page: https://github.com/jasonwee/common-util-py
+Author: Jason Wee
+Author-email: Jason Wee <peichieh@gmail.com>
+Maintainer-email: Jason Wee <peichieh@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/jasonwee/common-util-py
+Project-URL: Documentation, https://jasonwee.github.io/common-util-py/
+Project-URL: Source, https://github.com/jasonwee/common-util-py
+Project-URL: Tracker, https://github.com/jasonwee/common-util-py/issues
+Keywords: utilities,common,python,sql,weetech
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyMySQL>=1.1.1
+Requires-Dist: matrix-nio>=0.20.0
+Requires-Dist: SQLAlchemy>=2.0.41
+Requires-Dist: mysql-connector-python>=9.4.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.4.1; extra == "dev"
+Requires-Dist: twine>=6.1.0; extra == "dev"
+Requires-Dist: ruff>=0.12.7; extra == "dev"
+Requires-Dist: mypy>=1.17.1; extra == "dev"
+Requires-Dist: build>=1.3.0; extra == "dev"
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+
+## common-util-py
+Common utilities in Python
+
+## How to install
+The following commands show how to install `common-util-py` using pip within a Python virtual environment. To see which versions of Python are supported by `common-util-py`, see (here)[#tested-installation-via-pypi-on-the-following-python-versions].
+```sh
+$ python3 -m venv py313_env
+$ source py313_env/bin/activate
+$ pip install .[dev]
+$ # or
+$ virtualenv --python=/usr/bin/python3 py39_env
+$ source env_py39/bin/activate
+$ pip install .
+$ # or
+$ python3.8 -m venv env_py38
+$ source env_py38/bin/activate
+$ pip install .
+```
+
+## How to build
+To create a source distribution, run the following commands:
+```sh
+$ source py313_env/bin/activate
+$ python3 setup.py --help-commands
+$ python3 setup.py sdist
+```
+
+## How to test
+Initially we were using `nosetests` and have since migrated to `pytest`.
+```sh
+$ # deprecated
+$ # python setup.py test
+$ # python setup.py nosetests
+$ # nose is replace by pytest since python3.13
+$ pytest
+```
+
+read more [here](https://nose.readthedocs.io/en/latest/setuptools_integration.html)
+
+
+* https://www.codingforentrepreneurs.com/blog/pipenv-virtual-environments-for-python/
+* https://packaging.python.org/
+* https://betterscientificsoftware.github.io/python-for-hpc/tutorials/python-pypi-packaging/
+
+## How to upload to PyPI (Python Package Index)
+First, build a source distribution and then install the `twine` package.
+```sh
+$ python setup.py sdist
+$ pip install twine
+```
+Then, use twine to upload the package to PyPI.
+```sh
+$ twine upload --repository-url https://test.pypi.org/legacy/ dist/*
+```
+or
+```sh
+$ twine upload --config-file ~/.pypirc -r testpypi dist/common_util_py-0.0.1.tar.gz
+```
+
+## Test install
+Install from Test PyPI
+```sh
+$ pip install --index-url https://test.pypi.org/simple/ common-util-py
+```
+Install from Local Distribution.
+```sh
+$ pip install dist/common_util_py-<version>.tar.gz
+```
+
+## Legacy
+To generate `requirements.txt` and `requirements-dev.txt` from `pyproject.toml`, run the following command.
+```
+pip install pip-tools
+pip-compile --extra dev pyproject.toml -o requirements-dev.txt
+pip-compile pyproject.toml -o requirements.txt
+```
+
+## Tested installation via PyPI on the following Python versions:
+| Python Version  | tested installed  |
+| --------------- |:-----------------:|
+| 3.9             | Yes               |
+| 3.10            | Yes               |
+| 3.11            | Yes               |
+| 3.12            | Yes               |
+| 3.13            | Yes               |
+| 3.14            | Upcoming          |
+
+

common_util_py-0.0.23.dist-info/RECORD

@@ -0,0 +1,40 @@
+cli/__init__.py,sha256=mJdF-4PJ3gauSin8ApdXNp26TuqLxMKJWkgDL2_FV0Y,416
+cli/test_timeout.py,sha256=5gXZjmNzLPN0YakqDyY5nd5H7dEO9aGWyBD_oA4tG0E,3052
+cli/timeout.py,sha256=nrTkP19FmXqP7d6TxJ5HDlUBuyIA65ri94s1b4U86Mk,2147
+common_util_py-0.0.23.dist-info/licenses/LICENSE,sha256=tAkwu8-AdEyGxGoSvJ2gVmQdcicWw3j1ZZueVV74M-E,11357
+db/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+db/mysql.py,sha256=0qt5B_HGBZJPF5tORb2MT8YqdaWkpee3xt9C0vc4XBc,2765
+db/sql.py,sha256=RLMywkKp7I6s6f1xWGg0p0rVA8fWozy_cxSny7VRkdQ,2182
+fastapi/BackgroundTasks/client2.py,sha256=hnjrnFmVQWuJ6HdJH18rfddte1O3nUvEu7a7CNGuv9U,233
+fastapi/BackgroundTasks/main.py,sha256=NKN8UkjKl36KEJ8DgluqZN97JiTELvpHShPEtCaaGm4,425
+fastapi/BackgroundTasks/main1.py,sha256=uoiAGVcRopO-2-BOFMnXIqG1iB-8PG2GJWVHNODpTvU,872
+fastapi/BackgroundTasks/main2.py,sha256=_2GacHnDCJEMLKS6YL06O9hVe1xhObeeP62p2JJzFK8,1033
+fastapi/BackgroundTasks_middleware/main.py,sha256=pY21sdvZCLAmb8IcWop15jQ3OmzuNLnGz1eYcs2b9AU,758
+fastapi/middleware/main.py,sha256=V3KPGgkx298W4ZH_gvWnA-BijTkkXes6PDFYSSEvLec,430
+files/__init__.py,sha256=OAbkL4M6JDke2ujbZHAAex5h0s0k7UdSo7aT-lMLh0g,893
+files/json_file.py,sha256=ruwd6-7iS0ZchLUO1cSVPi8BjwB1eWJqN0CPuPmuSmM,2082
+files/test_files.py,sha256=ewrQUX7_7uGJ3zLkN9cQD2053jpw8QxkPcj148uiuJk,1681
+files/test_json_file.py,sha256=ucVdfBWhHlt9zNYh4dcyBpUmFrG3SKzKnRHfEOguU_k,3508
+httpclient/__init__.py,sha256=r8pQvFdTGhWdS0VIrVKXk1sLbd2mFT8WD4RkuUgBKGE,301
+httpclient/test_httpclient.py,sha256=dLRAGha1RVpwV5VbEIWugTx-_luTrxRq0PZIJc8ftoM,1157
+httpclient/get/sample.py,sha256=v0nJ1hEGDBdlPGCqrZ7dJdqBen00q3Utrde0FjIgr_A,2687
+ip/__init__.py,sha256=2B6ToWPs593njpJTN5n7jzNOExdwciR1u3nCZ3Mzifg,128
+ip/hostname.py,sha256=leebDReN8WVaZbpneRrBSxaIO9_pbvcVKnx1Mo8oxH0,338
+ip/ipv4.py,sha256=2Y_zdAjHT7vWyqSy3FUFWnX33gT58mvtLsX8MFnJl4I,124
+ip/ipv6.py,sha256=KOlZi3_JRzmkSEWqjzTDjgXkKJm99iqtCYIKVx8sVdo,141
+logger/__init__.py,sha256=D5WV7VuN2p5MRFfk7weoz1zA67lQLcPu0tZt6fTzxpM,21
+logger/log.py,sha256=H0zcjFj_M5Ic0_lCILmTOv9ZWYp9GJglMk0WNaP9V6w,124
+mailer/__init__.py,sha256=oUg_X7U9m90TFAHoz2gTdeIb1KTWeecaHN3vZ4dxjTg,245
+mailer/email.py,sha256=qP8maqksmD3GTTqgLF-EgBM7uyZ4WUbhkSEvb65us08,125
+mailer/gmail.py,sha256=RfJevrXZVlJEWYB9ti7jowQVsC5aPvVTleFDwsuMNS4,119
+mailer/mailer.py,sha256=6An48dE2ZCUh-mcLoiuxBzhgtlBCromDJD2IbzwhdkU,3172
+mailer/test_email_address.py,sha256=JmW6xe3AwMxS81acXIMFe9sQRrw6-vKa90D9El4sh9Y,2640
+maths/__init__.py,sha256=EAY_KunuK4gm3BoFWvTuabGglJ32KSpGEtoxmWNge1Y,83
+matrixclient/__init__.py,sha256=j3bhYSB4GZWKG0kQUg56lGdiamppiDgCJKcjzjIRU6c,718
+matrixclient/htmlmsg.py,sha256=xyKTwkPTUxS3zW7uIj208D03PHvNBr5KYv4uEfYkhkw,2915
+matrixclient/matrixclient.py,sha256=JeeXIc6agxmvVRtn86Gdi8kWfMNrRGXMs67vorN-ngM,12106
+wt_datetime/__init__.py,sha256=sOvcKaYy5kr12K3jkzqEURuv1MZauy6mxofkp1a2Mkg,161
+common_util_py-0.0.23.dist-info/METADATA,sha256=XzlmvMn8I9rzgvKswK4Mc-tHnyMaoL_zp6RxpdrEYS4,3864
+common_util_py-0.0.23.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+common_util_py-0.0.23.dist-info/top_level.txt,sha256=BYe73Xz5srTYKSfq6Dw7gbQM6CmWfccLpa8yyo-IoGU,80
+common_util_py-0.0.23.dist-info/RECORD,,

common_util_py-0.0.23.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

common_util_py-0.0.23.dist-info/licenses/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.

common_util_py-0.0.23.dist-info/top_level.txt

@@ -0,0 +1,11 @@
+cli
+db
+fastapi
+files
+httpclient
+ip
+logger
+mailer
+maths
+matrixclient
+wt_datetime

db/mysql.py

@@ -0,0 +1,79 @@
+import mysql.connector
+
+# pip install mysql-connector-python
+# https://www.w3schools.com/python/python_mysql_getstarted.asp
+class Mysql:
+
+    def __init__(self, host, username, password):
+        self.host = host
+        self.username = username
+        self.password = password
+
+        self.mydb = mysql.connector.connect(
+            host = self.host,
+            user = self.username,
+            password = self.password
+        )
+
+    # create
+    def create(self, statement, vals=()):
+        # create database mydb
+        # show databases
+        # CREATE TABLE customers (name VARCHAR(255), address VARCHAR(255))
+        #"INSERT INTO customers (name, address) VALUES (%s, %s)" | ("John", "Highway 21")
+        # "DROP TABLE customers"
+        # "DROP TABLE IF EXISTS customers"
+        cursor = self.mydb.cursor()
+        if vals:
+            cursor.execute(statement, vals)
+            self.mydb.commit()
+            return cursor.rowcount
+        else:
+            cursor.execute(statement)
+
+    # read
+    def read(self, statement, vals=()):
+        # SELECT * FROM customers
+        # SELECT name, address FROM customers
+        # SELECT * FROM customers WHERE address ='Park Lane 38'
+        # SELECT * FROM customers WHERE address = %s | ("Yellow Garden 2", )
+        # SELECT * FROM customers ORDER BY name
+        # SELECT * FROM customers ORDER BY name DESC
+        # SELECT * FROM customers LIMIT 5
+        # SELECT * FROM customers LIMIT 5 OFFSET 2
+        # "SELECT users.name AS user, products.name AS favorite FROM users INNER JOIN products ON users.fav = products.id
+        cursor = self.mydb.cursor()
+        if vals:
+            cursor.execute(statement, vals)
+        else:
+            cursor.execute(statement)
+        results = cursor.fetchall()
+        return results
+
+    # update
+    def update(self, statement, vals=()):
+        # "UPDATE customers SET address = 'Canyon 123' WHERE address = 'Valley 345'"
+        # "UPDATE customers SET address = %s WHERE address = %s" | ("Valley 345", "Canyon 123")
+        cursor = self.mydb.cursor()
+        if vals:
+            cursor.execute(statement, val)
+        else:
+            cursor.execute(statement)
+        self.mydb.commit()
+        return cursor.rowcount
+
+    # delete
+    def delete(self, statement, vals=()):
+        # DELETE FROM customers WHERE address = 'Mountain 21'
+        # DELETE FROM customers WHERE address = %s | ("Yellow Garden 2", )
+        cursor = self.mydb.cursor()
+        if vals:
+            cursor.execute(statement, vals)
+        else:
+            cursor.execute(statement)
+        self.mydb.commit()
+        return cursor.rowcount
+
+    # general method, just return cursor, let caller do it.
+    def get_cursor(self):
+        return self.mydb.cursor()