1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
|
import asyncio
import contextlib
import datetime
import logging
import pickle
import pytest
from loguru import logger
from .conftest import parse
def print_(message):
print(message, end="")
async def async_print(msg):
print_(msg)
@contextlib.contextmanager
def copied_logger_though_pickle(logger):
pickled = pickle.dumps(logger)
unpickled = pickle.loads(pickled)
try:
yield unpickled
finally:
unpickled.remove()
class StreamHandler:
def __init__(self, flushable=False, stoppable=False):
if flushable:
self.flush = self._flush
if stoppable:
self.stop = self._stop
self.wrote = ""
self.flushed = False
self.stopped = False
def write(self, message):
self.wrote += message
def _flush(self):
self.flushed = True
def _stop(self):
self.stopped = True
class MockLock:
def __enter__(self):
pass
def __exit__(self, *excinfo):
pass
class StandardHandler(logging.Handler):
def __init__(self, level):
super().__init__(level)
self.written = ""
def emit(self, record):
self.written += record.getMessage()
def acquire(self):
pass
def release(self):
pass
def createLock(self): # noqa: N802
self.lock = MockLock()
def format_function(record):
return "-> <red>{message}</red>"
def filter_function(record):
return "[PASS]" in record["message"]
def patch_function(record):
record["extra"]["foo"] = "bar"
def rotation_function(message, file):
pass
def retention_function(files):
pass
def compression_function(path):
pass
def test_pickling_function_handler(capsys):
logger.add(print_, format="{level} - {function} - {message}")
with copied_logger_though_pickle(logger) as dupe_logger:
dupe_logger.debug("A message")
out, err = capsys.readouterr()
assert out == "DEBUG - test_pickling_function_handler - A message\n"
assert err == ""
def test_pickling_coroutine_function_handler(capsys):
logger.add(async_print, format="{level} - {function} - {message}")
with copied_logger_though_pickle(logger) as dupe_logger:
async def async_debug():
dupe_logger.debug("A message")
await dupe_logger.complete()
asyncio.run(async_debug())
out, err = capsys.readouterr()
assert out == "DEBUG - async_debug - A message\n"
assert err == ""
@pytest.mark.parametrize("flushable", [True, False])
@pytest.mark.parametrize("stoppable", [True, False])
def test_pickling_stream_handler(flushable, stoppable):
stream = StreamHandler(flushable, stoppable)
logger.add(stream, format="{level} - {function} - {message}")
with copied_logger_though_pickle(logger) as dupe_logger:
dupe_logger.debug("A message")
stream = next(iter(dupe_logger._core.handlers.values()))._sink._stream
assert stream.wrote == "DEBUG - test_pickling_stream_handler - A message\n"
assert stream.flushed == flushable
assert stream.stopped == stoppable
def test_pickling_standard_handler():
handler = StandardHandler(logging.NOTSET)
logger.add(handler, format="{level} - {function} - {message}")
with copied_logger_though_pickle(logger) as dupe_logger:
dupe_logger.debug("A message")
handler = next(iter(dupe_logger._core.handlers.values()))._sink._handler
assert handler.written == "DEBUG - test_pickling_standard_handler - A message"
def test_pickling_standard_handler_root_logger_not_picklable(monkeypatch, capsys):
def reduce_protocol():
raise TypeError("Not picklable")
with monkeypatch.context() as context:
context.setattr(logging.getLogger(), "__reduce__", reduce_protocol, raising=False)
handler = StandardHandler(logging.NOTSET)
logger.add(handler, format="=> {message}", catch=False)
with copied_logger_though_pickle(logger) as dupe_logger:
logger.info("Ok")
dupe_logger.info("Ok")
out, err = capsys.readouterr()
assert out == ""
assert err == ""
assert handler.written == "=> Ok"
def test_pickling_file_handler(tmp_path):
file = tmp_path / "test.log"
logger.add(file, format="{level} - {function} - {message}", delay=True)
with copied_logger_though_pickle(logger) as dupe_logger:
dupe_logger.debug("A message")
assert file.read_text() == "DEBUG - test_pickling_file_handler - A message\n"
@pytest.mark.parametrize(
"rotation",
[
1000,
"daily",
datetime.timedelta(minutes=60),
datetime.time(hour=12, minute=00, second=00),
"200 MB",
"10:00",
"5 hours",
rotation_function,
],
)
def test_pickling_file_handler_rotation(tmp_path, rotation):
file = tmp_path / "test.log"
logger.add(file, format="{level} - {function} - {message}", delay=True, rotation=rotation)
with copied_logger_though_pickle(logger) as dupe_logger:
dupe_logger.debug("A message")
assert file.read_text() == "DEBUG - test_pickling_file_handler_rotation - A message\n"
@pytest.mark.parametrize(
"retention", [1000, datetime.timedelta(hours=13), "10 days", retention_function]
)
def test_pickling_file_handler_retention(tmp_path, retention):
file = tmp_path / "test.log"
logger.add(file, format="{level} - {function} - {message}", delay=True, retention=retention)
with copied_logger_though_pickle(logger) as dupe_logger:
dupe_logger.debug("A message")
assert file.read_text() == "DEBUG - test_pickling_file_handler_retention - A message\n"
@pytest.mark.parametrize("compression", ["zip", "gz", "tar", compression_function])
def test_pickling_file_handler_compression(tmp_path, compression):
file = tmp_path / "test.log"
logger.add(file, format="{level} - {function} - {message}", delay=True, compression=compression)
with copied_logger_though_pickle(logger) as dupe_logger:
dupe_logger.debug("A message")
assert file.read_text() == "DEBUG - test_pickling_file_handler_compression - A message\n"
def test_pickling_no_handler(writer):
with copied_logger_though_pickle(logger) as dupe_logger:
dupe_logger.add(writer, format="{level} - {function} - {message}")
dupe_logger.debug("A message")
assert writer.read() == "DEBUG - test_pickling_no_handler - A message\n"
def test_pickling_handler_not_serializable():
logger.add(lambda m: None)
with pytest.raises((pickle.PicklingError, AttributeError), match="Can't (pickle|get local)"):
pickle.dumps(logger)
def test_pickling_filter_function(capsys):
logger.add(print_, format="{message}", filter=filter_function)
with copied_logger_though_pickle(logger) as dupe_logger:
dupe_logger.info("Nope")
dupe_logger.info("[PASS] Yes")
out, err = capsys.readouterr()
assert out == "[PASS] Yes\n"
assert err == ""
@pytest.mark.parametrize("filter", ["", "tests"])
def test_pickling_filter_name(capsys, filter):
logger.add(print_, format="{message}", filter=filter)
with copied_logger_though_pickle(logger) as dupe_logger:
dupe_logger.info("A message")
out, err = capsys.readouterr()
assert out == "A message\n"
assert err == ""
@pytest.mark.parametrize("colorize", [True, False])
def test_pickling_format_string(capsys, colorize):
logger.add(print_, format="-> <red>{message}</red>", colorize=colorize)
with copied_logger_though_pickle(logger) as dupe_logger:
dupe_logger.info("The message")
out, err = capsys.readouterr()
assert out == parse("-> <red>The message</red>\n", strip=not colorize)
assert err == ""
@pytest.mark.parametrize("colorize", [True, False])
def test_pickling_format_function(capsys, colorize):
logger.add(print_, format=format_function, colorize=colorize)
with copied_logger_though_pickle(logger) as dupe_logger:
dupe_logger.info("The message")
out, err = capsys.readouterr()
assert out == parse("-> <red>The message</red>", strip=not colorize)
assert err == ""
def test_pickling_filter_function_not_serializable():
logger.add(print, filter=lambda r: True)
with pytest.raises((pickle.PicklingError, AttributeError), match="Can't (pickle|get local)"):
pickle.dumps(logger)
def test_pickling_format_function_not_serializable():
logger.add(print, format=lambda r: "{message}")
with pytest.raises((pickle.PicklingError, AttributeError), match="Can't (pickle|get local)"):
pickle.dumps(logger)
def test_pickling_bound_logger(writer):
bound_logger = logger.bind(foo="bar")
with copied_logger_though_pickle(bound_logger) as dupe_logger:
dupe_logger.add(writer, format="{extra[foo]}")
dupe_logger.info("Test")
assert writer.read() == "bar\n"
def test_pickling_patched_logger(writer):
patched_logger = logger.patch(patch_function)
with copied_logger_though_pickle(patched_logger) as dupe_logger:
dupe_logger.add(writer, format="{extra[foo]}")
dupe_logger.info("Test")
assert writer.read() == "bar\n"
def test_remove_after_pickling(capsys):
i = logger.add(print_, format="{message}")
logger.info("A")
with copied_logger_though_pickle(logger) as dupe_logger:
dupe_logger.remove(i)
dupe_logger.info("B")
out, err = capsys.readouterr()
assert out == "A\n"
assert err == ""
def test_pickling_logging_method(capsys):
logger.add(print_, format="{level} - {function} - {message}")
pickled = pickle.dumps(logger.critical)
func = pickle.loads(pickled)
func("A message")
out, err = capsys.readouterr()
assert out == "CRITICAL - test_pickling_logging_method - A message\n"
assert err == ""
def test_pickling_log_method(capsys):
logger.add(print_, format="{level} - {function} - {message}")
pickled = pickle.dumps(logger.log)
func = pickle.loads(pickled)
func(19, "A message")
out, err = capsys.readouterr()
assert out == "Level 19 - test_pickling_log_method - A message\n"
assert err == ""
@pytest.mark.parametrize(
"method",
[
logger.add,
logger.remove,
logger.catch,
logger.opt,
logger.bind,
logger.patch,
logger.level,
logger.disable,
logger.enable,
logger.configure,
logger.parse,
logger.exception,
],
)
def test_pickling_no_error(method):
pickled = pickle.dumps(method)
unpickled = pickle.loads(pickled)
assert unpickled
|