k3ut 0.1.16__tar.gz

k3ut-0.1.16/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 张炎泼
+
+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.

k3ut-0.1.16/PKG-INFO

@@ -0,0 +1,70 @@
+Metadata-Version: 2.4
+Name: k3ut
+Version: 0.1.16
+Summary: Unittest utilities with debug logging and test helpers
+Author-email: Zhang Yanpo <drdr.xp@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/pykit3/k3ut
+Project-URL: Documentation, https://k3ut.readthedocs.io
+Keywords: unittest,testing,debug,logging,utility
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: coverage; extra == "dev"
+Provides-Extra: publish
+Requires-Dist: build; extra == "publish"
+Requires-Dist: twine; extra == "publish"
+Requires-Dist: pk3; extra == "publish"
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.5; extra == "docs"
+Requires-Dist: mkdocs-material>=9.0; extra == "docs"
+Requires-Dist: mkdocstrings[python]>=0.24; extra == "docs"
+Dynamic: license-file
+
+# k3ut
+
+[![Build Status](https://travis-ci.com/pykit3/k3ut.svg?branch=master)](https://travis-ci.com/pykit3/k3ut)
+[![Documentation Status](https://readthedocs.org/projects/k3ut/badge/?version=stable)](https://k3ut.readthedocs.io/en/stable/?badge=stable)
+[![Package](https://img.shields.io/pypi/pyversions/k3ut)](https://pypi.org/project/k3ut)
+
+unittest util
+
+k3ut is a component of [pykit3] project: a python3 toolkit set.
+
+
+# Install
+
+```
+pip install k3ut
+```
+
+# Synopsis
+
+```python
+
+```
+
+#   Author
+
+Zhang Yanpo (张炎泼) <drdr.xp@gmail.com>
+
+#   Copyright and License
+
+The MIT License (MIT)
+
+Copyright (c) 2015 Zhang Yanpo (张炎泼) <drdr.xp@gmail.com>
+
+
+[pykit3]: https://github.com/pykit3

k3ut-0.1.16/README.md

@@ -0,0 +1,35 @@
+# k3ut
+
+[![Build Status](https://travis-ci.com/pykit3/k3ut.svg?branch=master)](https://travis-ci.com/pykit3/k3ut)
+[![Documentation Status](https://readthedocs.org/projects/k3ut/badge/?version=stable)](https://k3ut.readthedocs.io/en/stable/?badge=stable)
+[![Package](https://img.shields.io/pypi/pyversions/k3ut)](https://pypi.org/project/k3ut)
+
+unittest util
+
+k3ut is a component of [pykit3] project: a python3 toolkit set.
+
+
+# Install
+
+```
+pip install k3ut
+```
+
+# Synopsis
+
+```python
+
+```
+
+#   Author
+
+Zhang Yanpo (张炎泼) <drdr.xp@gmail.com>
+
+#   Copyright and License
+
+The MIT License (MIT)
+
+Copyright (c) 2015 Zhang Yanpo (张炎泼) <drdr.xp@gmail.com>
+
+
+[pykit3]: https://github.com/pykit3

k3ut-0.1.16/__init__.py

@@ -0,0 +1,225 @@
+"""
+unittest utility
+"""
+
+import inspect
+import logging
+import os
+import socket
+import sys
+import tempfile
+import time
+import unittest
+from importlib.metadata import version
+
+__version__ = version("k3ut")
+
+tmpdir = tempfile.gettempdir()
+
+_glb = {
+    "pykitut_logger": None,
+}
+
+debug_to_stderr = os.environ.get("UT_DEBUG") == "1"
+
+
+# TODO make this configurable
+# logging.basicConfig(level='INFO',
+#                     format='[%(asctime)s,%(process)d-%(thread)d,%(filename)s,%(lineno)d,%(levelname)s] %(message)s',
+#                     datefmt='%H:%M:%S'
+#                     )
+
+# logger = logging.getLogger('kazoo')
+# logger.setLevel('INFO')
+
+
+class Timer(object):
+    def __init__(self):
+        self.start = None
+        self.end = None
+
+    def __enter__(self):
+        self.start = time.time()
+        return self
+
+    def __exit__(self, errtype, errval, _traceback):
+        self.end = time.time()
+
+    def spent(self):
+        return (self.end or time.time()) - self.start
+
+
+class ContextFilter(logging.Filter):
+    """
+    Add correct func, line number, line info to log record.
+
+    To fix the issue that when test case function use dd() instead of
+    logger.debug(), logging alwasy print context info of dd(), but not the
+    caller test_xxx.
+    """
+
+    def filter(self, record):
+        # skip this function
+        stack = inspect.stack()[1:]
+
+        for i, (frame, path, ln, func, line, xx) in enumerate(stack):
+            if frame.f_globals.get("__name__") == "pykitut" and func == "dd":
+                # this frame is dd(), find the caller
+                _, path, ln, func, line, xx = stack[i + 1]
+
+                record._fn = os.path.basename(path)
+                record._ln = ln
+                record._func = func
+                return True
+
+        record._fn = record.filename
+        record._ln = record.lineno
+        record._func = record.funcName
+        return True
+
+
+def _init():
+    if _glb["pykitut_logger"] is not None:
+        return
+
+    log_name = "pykitut"
+    lvl = "DEBUG"
+    base_dir = tmpdir
+    log_fn = log_name + ".out"
+
+    logger = logging.getLogger(log_name)
+    logger.setLevel(lvl)
+
+    # do not add 2 handlers to one logger by default
+    if len(logger.handlers) == 0:
+        log_path = os.path.join(base_dir, log_fn)
+        fmt = "[%(asctime)s %(process)d-%(thread)d %(_fn)s:%(_ln)d %(_func)s] %(levelname)s %(message)s"
+        datefmt = "%H:%M:%S"
+
+        fh = logging.FileHandler(log_path)
+        fh.setFormatter(logging.Formatter(fmt=fmt, datefmt=datefmt))
+        logger.addHandler(fh)
+
+        logger.addFilter(ContextFilter())
+
+        if debug_to_stderr:
+            fmt = "[%(asctime)s %(process)d-%(thread)d %(_fn)s:%(_ln)d %(_func)s] %(levelname)s\n%(message)s"
+
+            stream = sys.stderr
+            stdhandler = logging.StreamHandler(stream)
+            stdhandler.setFormatter(logging.Formatter(fmt=fmt, datefmt=datefmt))
+            stdhandler.setLevel(lvl)
+
+            logger.addHandler(stdhandler)
+
+    _glb["pykitut_logger"] = logger
+
+
+def dd(*msg):
+    """
+    debug level logging in a test case function test_xx.
+
+    dd() write log to stdout if unittest verbosity is 2.
+    And dd always write log to log file in /tmp dir.
+    """
+
+    s = " ".join([str(x) for x in msg])
+
+    _init()
+
+    logger = _glb["pykitut_logger"]
+    if logger:
+        logger.debug(s)
+
+
+def get_ut_verbosity():
+    """
+    Return the verbosity setting of the currently running unittest
+    program, or 0 if none is running.
+    """
+
+    frame = _find_frame_by_self(unittest.TestProgram)
+    if frame is None:
+        return 0
+
+    self = frame.f_locals.get("self")
+
+    return self.verbosity
+
+
+def get_case_logger():
+    """
+    Get a case specific logger.
+    The logger name is: `<module>.<class>.<function>`,
+    such as: `pykit.strutil.test.test_strutil.TestStrutil.test_format_line`
+
+    It must be called inside a test_* function of unittest.TestCase, or no
+    correct module/class/function name can be found.
+    """
+
+    frame = _find_frame_by_self(unittest.TestCase)
+
+    self = frame.f_locals.get("self")
+
+    module_name = frame.f_globals.get("__name__")
+    class_name = self.__class__.__name__
+    func_name = frame.f_code.co_name
+
+    nm = module_name + "." + class_name + "." + func_name
+
+    logger = logging.getLogger(nm)
+    for f in logger.filters:
+        if isinstance(f, ContextFilter):
+            break
+    else:
+        logger.addFilter(ContextFilter())
+
+    return logger
+
+
+def _find_frame_by_self(clz):
+    """
+    Find the first frame on stack in which there is local variable 'self' of
+    type clz.
+    """
+
+    frame = inspect.currentframe()
+
+    while frame:
+        self = frame.f_locals.get("self")
+        if isinstance(self, clz):
+            return frame
+
+        frame = frame.f_back
+
+    return None
+
+
+def wait_listening(ip, port, timeout=15, interval=0.5):
+    # Wait at most `timeout` second for a tcp listening service to serve.
+
+    laste = None
+    for ii in range(40):
+        try:
+            sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+            sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
+            sock.connect((ip, port))
+            break
+        except socket.error as e:
+            dd("trying to connect to {0} failed".format(str((ip, port))))
+            sock.close()
+            time.sleep(0.4)
+            laste = e
+    else:
+        raise laste
+
+
+def has_env(kv):
+    # kv: KEY=value
+
+    k, v = kv.split("=", 1)
+    return os.environ.get(k) == v
+
+
+def pyver():
+    return sys.version

k3ut-0.1.16/k3ut.egg-info/PKG-INFO

@@ -0,0 +1,70 @@
+Metadata-Version: 2.4
+Name: k3ut
+Version: 0.1.16
+Summary: Unittest utilities with debug logging and test helpers
+Author-email: Zhang Yanpo <drdr.xp@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/pykit3/k3ut
+Project-URL: Documentation, https://k3ut.readthedocs.io
+Keywords: unittest,testing,debug,logging,utility
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: coverage; extra == "dev"
+Provides-Extra: publish
+Requires-Dist: build; extra == "publish"
+Requires-Dist: twine; extra == "publish"
+Requires-Dist: pk3; extra == "publish"
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.5; extra == "docs"
+Requires-Dist: mkdocs-material>=9.0; extra == "docs"
+Requires-Dist: mkdocstrings[python]>=0.24; extra == "docs"
+Dynamic: license-file
+
+# k3ut
+
+[![Build Status](https://travis-ci.com/pykit3/k3ut.svg?branch=master)](https://travis-ci.com/pykit3/k3ut)
+[![Documentation Status](https://readthedocs.org/projects/k3ut/badge/?version=stable)](https://k3ut.readthedocs.io/en/stable/?badge=stable)
+[![Package](https://img.shields.io/pypi/pyversions/k3ut)](https://pypi.org/project/k3ut)
+
+unittest util
+
+k3ut is a component of [pykit3] project: a python3 toolkit set.
+
+
+# Install
+
+```
+pip install k3ut
+```
+
+# Synopsis
+
+```python
+
+```
+
+#   Author
+
+Zhang Yanpo (张炎泼) <drdr.xp@gmail.com>
+
+#   Copyright and License
+
+The MIT License (MIT)
+
+Copyright (c) 2015 Zhang Yanpo (张炎泼) <drdr.xp@gmail.com>
+
+
+[pykit3]: https://github.com/pykit3

k3ut-0.1.16/k3ut.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE
+README.md
+__init__.py
+pyproject.toml
+./__init__.py
+k3ut.egg-info/PKG-INFO
+k3ut.egg-info/SOURCES.txt
+k3ut.egg-info/dependency_links.txt
+k3ut.egg-info/requires.txt
+k3ut.egg-info/top_level.txt
+test/test_ut.py

k3ut-0.1.16/k3ut.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

k3ut-0.1.16/k3ut.egg-info/requires.txt

@@ -0,0 +1,15 @@
+
+[dev]
+pytest>=7.0
+ruff
+coverage
+
+[docs]
+mkdocs>=1.5
+mkdocs-material>=9.0
+mkdocstrings[python]>=0.24
+
+[publish]
+build
+twine
+pk3

k3ut-0.1.16/k3ut.egg-info/top_level.txt

@@ -0,0 +1 @@
+k3ut

k3ut-0.1.16/pyproject.toml

@@ -0,0 +1,57 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "k3ut"
+version = "0.1.16"
+description = "Unittest utilities with debug logging and test helpers"
+readme = "README.md"
+license = {text = "MIT"}
+requires-python = ">=3.9"
+authors = [
+    { name = "Zhang Yanpo", email = "drdr.xp@gmail.com" }
+]
+keywords = ["unittest", "testing", "debug", "logging", "utility"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+dependencies = []
+
+[project.urls]
+Homepage = "https://github.com/pykit3/k3ut"
+Documentation = "https://k3ut.readthedocs.io"
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "ruff",
+    "coverage",
+]
+publish = [
+    "build",
+    "twine",
+    "pk3",
+]
+docs = [
+    "mkdocs>=1.5",
+    "mkdocs-material>=9.0",
+    "mkdocstrings[python]>=0.24",
+]
+
+[tool.setuptools]
+packages = ["k3ut"]
+
+[tool.setuptools.package-dir]
+k3ut = "."
+
+[tool.ruff]
+line-length = 120

k3ut-0.1.16/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

k3ut-0.1.16/test/test_ut.py

@@ -0,0 +1,10 @@
+import unittest
+
+import k3ut
+
+dd = k3ut.dd
+
+
+class TestProcError(unittest.TestCase):
+    def test_nothing(self):
+        pass