Skip to content

feat: make it possible to add custom logging handler #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chrisdickinson merged 4 commits into from
Dec 16, 2023
Merged

feat: make it possible to add custom logging handler #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
629c863
feat: add custom logging
Nov 14, 2023
23420ef
fix: bump extism-sys dep; update poetry.lock
Dec 11, 2023
f3de34d
fix: upgrade to extism_sys rc7; match callback signature type
Dec 16, 2023
02b90e5
fix: use ExtismSize
Dec 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions example.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,9 @@
import hashlib
import pathlib

from extism import Function, host_fn, ValType, Plugin, set_log_file, Json
from extism import Function, host_fn, ValType, Plugin, set_log_custom, Json
from typing import Annotated

set_log_file("stderr", "trace")


@host_fn(user_data=b"Hello again!")
def hello_world(inp: Annotated[dict, Json], *a_string) -> Annotated[dict, Json]:
Expand All @@ -25,7 +23,8 @@ def count_vowels(data):


def main(args):
set_log_file("stderr", "trace")
logs = []
logBuffer = set_log_custom(lambda s: logs.append(s.strip()), "trace")
if len(args) > 1:
data = args[1].encode()
else:
Expand All @@ -48,6 +47,12 @@ def main(args):
assert j["count"] == count_vowels(data)
assert j["roundtrip"] == 1

# Drain logs and print
logBuffer.drain()
print("Dumping logs", len(logs))
for line in logs:
print(line)


if __name__ == "__main__":
main(sys.argv)
2 changes: 2 additions & 0 deletions extism/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
Error,
Plugin,
set_log_file,
set_log_custom,
extism_version,
host_fn,
Function,
Expand All @@ -24,6 +25,7 @@
"Error",
"CurrentPlugin",
"set_log_file",
"set_log_custom",
"extism_version",
"Memory",
"host_fn",
Expand Down
39 changes: 39 additions & 0 deletions extism/extism.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,45 @@ def set_log_file(
_lib.extism_log_file(file.encode(), c_level)


class CustomLogger:
def __init__(self, f):
self.callback = None
self.set_callback(f)

def set_callback(self, f):
@_ffi.callback("void(char*, ExtismSize)")
def callback(ptr, len):
f(_ffi.string(ptr, len).decode())

self.callback = callback

def drain(self):
if self.callback is not None:
_lib.extism_log_drain(self.callback)

def __del__(self):
self.drain()


def set_log_custom(
f, level: Optional[Literal["debug", "error", "trace", "warn"]] = None
):
"""
Enables buffered logging, this is a global configuration

:param f: The callback function, takes a string argument and no return value.
:param level: The debug level.

:returns: a CustomLogger with a `drain` method that can be used to handle the buffered logs.
"""
c_level = level or _ffi.NULL
if isinstance(level, str):
c_level = level.encode()

_lib.extism_log_custom(c_level)
return CustomLogger(f)


def extism_version() -> str:
"""
Gets the Extism version string
Expand Down
Loading