pkn 0.1.2__tar.gz → 0.1.4__tar.gz

{pkn-0.1.2 → pkn-0.1.4}/.gitignore

@@ -4,8 +4,12 @@ __pycache__/
 *$py.class
 
 # C extensions
+*.a
 *.so
+*.obj
 *.dll
+*.exp
+*.lib
 
 # Distribution / packaging
 .Python
@@ -29,8 +33,6 @@ share/python-wheels/
 MANIFEST
 
 # PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
 *.manifest
 *.spec
 
@@ -81,11 +83,7 @@ ipython_config.py
 .python-version
 
 # pipenv
-#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
-#   However, in case of collaboration, if having platform-specific dependencies or dependencies
-#   having no cross-platform support, pipenv may install dependencies that don't work, or not
-#   install all needed dependencies.
-#Pipfile.lock
+Pipfile.lock
 
 # PEP 582; used by e.g. github.com/David-OConnor/pyflow
 __pypackages__/
@@ -125,19 +123,36 @@ dmypy.json
 .pyre/
 
 # Documentation
-docs/_build/
 /site
+index.md
+docs/_build/
+docs/src/_build/
 docs/api
 docs/index.md
-_template/labextension
+docs/html
+docs/jupyter_execute
+index.md
+
+# JS
+js/coverage
+js/dist
+js/lib
+js/node_modules
+js/test-results
+js/playwright-report
+js/*.tgz
+pkn/extension
 
 # Jupyter
 .ipynb_checkpoints
 .autoversion
+!pkn/extension/pkn.json
+!pkn/extension/install.json
+pkn/nbextension
+pkn/labextension
 
 # Mac
 .DS_Store
 
 # Rust
 target
-

{pkn-0.1.2 → pkn-0.1.4}/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2024 the pkn authors
+   Copyright 2025 1kbgz
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

{pkn-0.1.2 → pkn-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pkn
-Version: 0.1.2
+Version: 0.1.4
 Summary: My Pocket Knife
 Project-URL: Repository, https://github.com/1kbgz/pkn
 Project-URL: Homepage, https://github.com/1kbgz/pkn
@@ -15,15 +15,21 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Requires-Python: >=3.9
+Requires-Dist: ccflow
+Requires-Dist: colorlog
 Requires-Dist: pydantic
 Provides-Extra: develop
 Requires-Dist: build; extra == 'develop'
 Requires-Dist: bump-my-version; extra == 'develop'
 Requires-Dist: check-manifest; extra == 'develop'
+Requires-Dist: codespell<2.5,>=2.4; extra == 'develop'
 Requires-Dist: hatchling; extra == 'develop'
+Requires-Dist: mdformat-tables>=1; extra == 'develop'
+Requires-Dist: mdformat<0.8,>=0.7.22; extra == 'develop'
 Requires-Dist: pytest; extra == 'develop'
 Requires-Dist: pytest-cov; extra == 'develop'
 Requires-Dist: ruff; extra == 'develop'
@@ -36,13 +42,12 @@ Description-Content-Type: text/markdown
 
 My Pocket Knife
 
-[![Build Status](https://github.com/1kbgz/pkn/actions/workflows/build.yml/badge.svg?branch=main&event=push)](https://github.com/1kbgz/pkn/actions/workflows/build.yml)
+[![Build Status](https://github.com/1kbgz/pkn/actions/workflows/build.yaml/badge.svg?branch=main&event=push)](https://github.com/1kbgz/pkn/actions/workflows/build.yaml)
 [![codecov](https://codecov.io/gh/1kbgz/pkn/branch/main/graph/badge.svg)](https://codecov.io/gh/1kbgz/pkn)
 [![License](https://img.shields.io/github/license/1kbgz/pkn)](https://github.com/1kbgz/pkn)
 [![PyPI](https://img.shields.io/pypi/v/pkn.svg)](https://pypi.python.org/pypi/pkn)
 
 ## Overview
 
-
 > [!NOTE]
 > This library was generated using [copier](https://copier.readthedocs.io/en/stable/) from the [Base Python Project Template repository](https://github.com/python-project-templates/base).

{pkn-0.1.2 → pkn-0.1.4}/README.md

@@ -2,13 +2,12 @@
 
 My Pocket Knife
 
-[![Build Status](https://github.com/1kbgz/pkn/actions/workflows/build.yml/badge.svg?branch=main&event=push)](https://github.com/1kbgz/pkn/actions/workflows/build.yml)
+[![Build Status](https://github.com/1kbgz/pkn/actions/workflows/build.yaml/badge.svg?branch=main&event=push)](https://github.com/1kbgz/pkn/actions/workflows/build.yaml)
 [![codecov](https://codecov.io/gh/1kbgz/pkn/branch/main/graph/badge.svg)](https://codecov.io/gh/1kbgz/pkn)
 [![License](https://img.shields.io/github/license/1kbgz/pkn)](https://github.com/1kbgz/pkn)
 [![PyPI](https://img.shields.io/pypi/v/pkn.svg)](https://pypi.python.org/pypi/pkn)
 
 ## Overview
 
-
 > [!NOTE]
 > This library was generated using [copier](https://copier.readthedocs.io/en/stable/) from the [Base Python Project Template repository](https://github.com/python-project-templates/base).

pkn-0.1.4/pkn/__init__.py

@@ -0,0 +1,4 @@
+from .logging import *
+from .pydantic import *
+
+__version__ = "0.1.4"

pkn-0.1.4/pkn/logging/__init__.py

@@ -0,0 +1,59 @@
+from importlib.machinery import ModuleSpec, SourceFileLoader
+from inspect import currentframe
+from logging import Logger, getLogger as baseGetLogger
+from logging.config import dictConfig
+from typing import Literal, Union
+
+__all__ = ("default", "getLogger")
+
+LogLevelStr = Literal["CRITICAL", "FATAL", "ERROR", "WARNING", "WARN", "INFO", "DEBUG", "NOTSET"]
+LogLevelInt = Literal[50, 40, 30, 20, 10, 0]
+LogLevel = Union[LogLevelStr, LogLevelInt]
+
+
+def default(
+    file: str = "output.log",
+    console_level: LogLevel = "INFO",
+    file_level: LogLevel = "DEBUG",
+) -> None:
+    config = dict(
+        version=1,
+        disable_existing_loggers=False,
+        formatters={
+            "simple": {"format": "[%(asctime)s][%(threadName)s][%(name)s][%(levelname)s]: %(message)s"},
+            "colorlog": {
+                "()": "colorlog.ColoredFormatter",
+                "format": "[%(cyan)s%(asctime)s%(reset)s][%(threadName)s][%(blue)s%(name)s%(reset)s][%(log_color)s%(levelname)s%(reset)s]: %(message)s",
+                "log_colors": {
+                    "DEBUG": "white",
+                    "INFO": "green",
+                    "WARNING": "yellow",
+                    "ERROR": "red",
+                    "CRITICAL": "red",
+                },
+            },
+            "whenAndWhere": {"format": "[%(asctime)s][%(threadName)s][%(name)s][%(filename)s:%(lineno)d][%(levelname)s]: %(message)s"},
+        },
+        handlers={
+            "console": {"level": console_level, "class": "ccflow.utils.logging.StreamHandler", "formatter": "colorlog", "stream": "ext://sys.stdout"},
+        },
+        root={"handlers": ["console"], "level": "DEBUG"},
+    )
+    if file:
+        config["handlers"]["file"] = {"level": file_level, "class": "ccflow.FileHandler", "formatter": "whenAndWhere", "filename": file}
+    dictConfig(config)
+
+
+def getLogger() -> Logger:
+    # Get fully qualified module name of parent caller
+    cur_frame = currentframe()
+    caller_frame = cur_frame.f_back
+
+    spec = caller_frame.f_globals["__spec__"]
+    loader = caller_frame.f_globals["__loader__"] or spec
+
+    if isinstance(loader, SourceFileLoader):
+        module_name = loader.name
+    elif spec and isinstance(spec, ModuleSpec):
+        module_name = spec.name
+    return baseGetLogger(module_name)

pkn-0.1.4/pkn/pydantic/__init__.py

@@ -0,0 +1,3 @@
+from .generic import *
+from .paths import *
+from .roots import *

pkn-0.1.4/pkn/pydantic/paths.py

@@ -0,0 +1,41 @@
+from importlib import import_module
+from types import FunctionType, MethodType
+from typing import Annotated, Optional
+
+from pydantic import BeforeValidator, PlainSerializer
+
+__all__ = (
+    "get_import_path",
+    "serialize_path_as_string",
+    "ImportPath",
+    "CallablePath",
+)
+
+
+def get_import_path(path: str) -> type:
+    if isinstance(path, type):
+        return path
+    elif isinstance(path, (FunctionType, MethodType)):
+        return path
+    if not isinstance(path, str):
+        raise TypeError(path)
+    module, call = path.rsplit(".", 1)
+    return getattr(import_module(module), call)
+
+
+def serialize_path_as_string(value: type) -> Optional[str]:
+    if value is None:
+        return None
+    if hasattr(value, "__module__") and hasattr(value, "__qualname__"):
+        return f"{value.__module__}.{value.__qualname__}"
+    if hasattr(value, "__name__"):
+        return f"{value.__module__}.{value.__name__}"
+    if hasattr(value, "__class__") and hasattr(value.__class__, "__name__"):
+        return f"{value.__class__.__module__}.{value.__class__.__name__}"
+    if hasattr(value, "__class__") and hasattr(value.__class__, "__qualname__"):
+        return f"{value.__class__.__module__}.{value.__class__.__qualname__}"
+    raise TypeError(f"Could not derive module and name for {value}")
+
+
+ImportPath = Annotated[type, BeforeValidator(get_import_path), PlainSerializer(serialize_path_as_string, when_used="json", return_type=str)]
+CallablePath = Annotated[object, BeforeValidator(get_import_path), PlainSerializer(serialize_path_as_string, when_used="json", return_type=str)]

pkn-0.1.4/pkn/tests/logging/test_logging.py

@@ -0,0 +1,21 @@
+from unittest.mock import patch
+
+from pkn import default, getLogger
+
+
+def test():
+    default()
+    logger = getLogger()
+    logger.critical("This is a test log message.")
+
+
+class TestLogger:
+    def test_logging(self):
+        # Patch standard out and look at log message
+        with patch("sys.stdout") as mock_stdout:
+            default()
+            logger = getLogger()
+            logger.critical("This is a test log message.")
+            assert mock_stdout.write.call_args[0][0].endswith(
+                "\x1b[0m][MainThread][\x1b[34mpkn.tests.logging.test_logging\x1b[0m][\x1b[31mCRITICAL\x1b[0m]: This is a test log message.\x1b[0m\n"
+            )

pkn-0.1.4/pkn/tests/pydantic/test_paths.py

@@ -0,0 +1,36 @@
+from pydantic import BaseModel
+
+from pkn.pydantic import CallablePath, ImportPath
+
+
+def foo():
+    return "foo"
+
+
+class MyType: ...
+
+
+class MyModel(BaseModel):
+    typ: ImportPath
+    foo: CallablePath
+
+
+def test_get_import_path_inst():
+    m = MyModel(typ=MyType, foo=foo)
+    assert m.typ == MyType
+    assert m.foo == foo
+
+
+def test_get_import_path_string():
+    m = MyModel(typ="pkn.tests.pydantic.test_paths.MyType", foo="pkn.tests.pydantic.test_paths.foo")
+    assert m.typ == MyType
+    assert m.foo == foo
+
+
+def test_serialize():
+    m = MyModel(typ="pkn.tests.pydantic.test_paths.MyType", foo="pkn.tests.pydantic.test_paths.foo")
+    assert m.model_dump() == {
+        "typ": MyType,
+        "foo": foo,
+    }
+    assert m.model_dump_json() == ('{"typ":"pkn.tests.pydantic.test_paths.MyType","foo":"pkn.tests.pydantic.test_paths.foo"}')

{pkn-0.1.2 → pkn-0.1.4}/pyproject.toml

@@ -8,7 +8,7 @@ authors = [{name = "the pkn authors", email = "t.paine154@gmail.com"}]
 description = "My Pocket Knife"
 readme = "README.md"
 license = { text = "Apache-2.0" }
-version = "0.1.2"
+version = "0.1.4"
 requires-python = ">=3.9"
 keywords = []
 
@@ -23,9 +23,12 @@ classifiers = [
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
 ]
 
 dependencies = [
+    "ccflow",
+    "colorlog",
     "pydantic",
 ]
 
@@ -34,7 +37,10 @@ develop = [
     "build",
     "bump-my-version",
     "check-manifest",
+    "codespell>=2.4,<2.5",
     "hatchling",
+    "mdformat>=0.7.22,<0.8",
+    "mdformat-tables>=1",
     "pytest",
     "pytest-cov",
     "ruff",
@@ -50,9 +56,10 @@ Repository = "https://github.com/1kbgz/pkn"
 Homepage = "https://github.com/1kbgz/pkn"
 
 [tool.bumpversion]
-current_version = "0.1.2"
+current_version = "0.1.4"
 commit = true
 tag = true
+commit_args = "-s"
 
 [[tool.bumpversion.files]]
 filename = "pkn/__init__.py"
@@ -66,7 +73,7 @@ replace = 'version = "{new_version}"'
 
 [tool.check-manifest]
 ignore = [
-    ".copier-answers.yml",
+    ".copier-answers.yaml",
     "Makefile",
     "docs/**/*",
 ]

pkn-0.1.2/pkn/__init__.py

@@ -1,3 +0,0 @@
-from .pydantic import *
-
-__version__ = "0.1.2"

pkn-0.1.2/pkn/pydantic/__init__.py

@@ -1 +0,0 @@
-from .roots import *