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 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
|
import asyncio
import builtins
import contextlib
import datetime
import io
import logging
import os
import pathlib
import re
import sys
import threading
import time
import traceback
import warnings
from typing import NamedTuple
import freezegun
import pytest
import loguru
if sys.version_info < (3, 5, 3):
def run(coro):
loop = asyncio.new_event_loop()
asyncio.set_event_loop(loop)
res = loop.run_until_complete(coro)
loop.close()
asyncio.set_event_loop(None)
return res
asyncio.run = run
elif sys.version_info < (3, 7):
def run(coro):
loop = asyncio.new_event_loop()
res = loop.run_until_complete(coro)
loop.close()
asyncio.set_event_loop(None)
return res
asyncio.run = run
if sys.version_info < (3, 6):
@pytest.fixture
def tmp_path(tmp_path):
return pathlib.Path(str(tmp_path))
if sys.version_info >= (3, 6):
from pytest_mypy_plugins.item import YamlTestItem
def _fix_positional_only_args(item: YamlTestItem):
"""Remove forward-slash marker from the expected output for Python 3.6."""
for output in item.expected_output:
output.message = output.message.replace(", /", "")
# Also patch the "severity" attribute because there is a parsing bug in the plugin.
output.severity = output.severity.replace(", /", "")
def _fix_builtins_uppercase(item: YamlTestItem):
"""Adapt case of builtins from the expected output for Python 3.6 to 3.8."""
for output in item.expected_output:
for builtin in ["dict", "list", "set", "tuple"]:
# Quite hacky, but should work for all tested cases.
pattern = re.compile(r"(?<![a-zA-Z0-9.])" + builtin + r"\[")
replacement = builtin.capitalize() + "["
output.message = pattern.sub(replacement, output.message)
output.severity = pattern.sub(replacement, output.severity)
def _add_mypy_config(item: YamlTestItem):
"""Add some extra options to the mypy configuration for Python 3.7+."""
item.additional_mypy_config += "\n".join(
[
"show_error_codes = false",
"force_union_syntax = true",
]
)
def pytest_collection_modifyitems(config, items):
"""Modify the tests to ensure they produce the same output regardless of Python version."""
for item in items:
if not isinstance(item, YamlTestItem):
continue
if sys.version_info >= (3, 7):
_add_mypy_config(item)
else:
_fix_positional_only_args(item)
if sys.version_info < (3, 9):
_fix_builtins_uppercase(item)
@contextlib.contextmanager
def new_event_loop_context():
loop = asyncio.new_event_loop()
try:
yield loop
finally:
loop.close()
@contextlib.contextmanager
def set_event_loop_context(loop):
asyncio.set_event_loop(loop)
try:
yield
finally:
asyncio.set_event_loop(None)
def parse(text, *, strip=False, strict=True):
parser = loguru._colorizer.AnsiParser()
parser.feed(text)
tokens = parser.done(strict=strict)
if strip:
return parser.strip(tokens)
return parser.colorize(tokens, "")
def check_dir(dir, *, files=None, size=None):
actual_files = set(dir.iterdir())
seen = set()
if size is not None:
assert len(actual_files) == size
if files is not None:
assert len(actual_files) == len(files)
for name, content in files:
filepath = dir / name
assert filepath in actual_files
assert filepath not in seen
if content is not None:
assert filepath.read_text() == content
seen.add(filepath)
class StubStream(io.StringIO):
def fileno(self):
return 1
class StreamIsattyTrue(StubStream):
def isatty(self):
return True
class StreamIsattyFalse(StubStream):
def isatty(self):
return False
class StreamIsattyException(StubStream):
def isatty(self):
raise RuntimeError
class StreamFilenoException(StreamIsattyTrue):
def fileno(self):
raise RuntimeError
@contextlib.contextmanager
def default_threading_excepthook():
if not hasattr(threading, "excepthook"):
yield
return
# Pytest added "PytestUnhandledThreadExceptionWarning", we need to
# remove it temporarily for some tests checking exceptions in threads.
def excepthook(args):
print("Exception in thread:", file=sys.stderr, flush=True)
traceback.print_exception(
args.exc_type, args.exc_value, args.exc_traceback, file=sys.stderr
)
old_excepthook = threading.excepthook
threading.excepthook = excepthook
yield
threading.excepthook = old_excepthook
@pytest.fixture(scope="session", autouse=True)
def check_env_variables():
for var in os.environ:
if var.startswith("LOGURU_"):
warnings.warn(
"A Loguru environment variable has been detected "
"and may interfere with the tests: '%s'" % var,
RuntimeWarning,
stacklevel=1,
)
@pytest.fixture(autouse=True)
def reset_logger():
def reset():
loguru.logger.remove()
loguru.logger.__init__(
loguru._logger.Core(), None, 0, False, False, False, False, True, [], {}
)
loguru._logger.context.set({})
reset()
yield
reset()
@pytest.fixture
def writer():
def w(message):
w.written.append(message)
w.written = []
w.read = lambda: "".join(w.written)
w.clear = lambda: w.written.clear()
return w
@pytest.fixture
def sink_with_logger():
class SinkWithLogger:
def __init__(self, logger):
self.logger = logger
self.out = ""
def write(self, message):
self.logger.info(message)
self.out += message
return SinkWithLogger
@pytest.fixture
def freeze_time(monkeypatch):
ctimes = {}
freezegun_localtime = freezegun.api.fake_localtime
builtins_open = builtins.open
fakes = {"zone": "UTC", "offset": 0, "include_tm_zone": True}
def fake_localtime(t=None):
fix_struct = os.name == "nt" and sys.version_info < (3, 6)
struct_time_attributes = [
("tm_year", int),
("tm_mon", int),
("tm_mday", int),
("tm_hour", int),
("tm_min", int),
("tm_sec", int),
("tm_wday", int),
("tm_yday", int),
("tm_isdst", int),
("tm_zone", str),
("tm_gmtoff", int),
]
if not fakes["include_tm_zone"]:
struct_time_attributes = struct_time_attributes[:-2]
struct_time = NamedTuple("struct_time", struct_time_attributes)._make
elif fix_struct:
struct_time = NamedTuple("struct_time", struct_time_attributes)._make
else:
struct_time = time.struct_time
struct = freezegun_localtime(t)
override = {"tm_zone": fakes["zone"], "tm_gmtoff": fakes["offset"]}
attributes = []
for attribute, _ in struct_time_attributes:
if attribute in override:
value = override[attribute]
else:
value = getattr(struct, attribute)
attributes.append(value)
return struct_time(attributes)
def patched_open(filepath, *args, **kwargs):
if not os.path.exists(filepath):
tz = datetime.timezone(datetime.timedelta(seconds=fakes["offset"]), name=fakes["zone"])
ctimes[filepath] = datetime.datetime.now().replace(tzinfo=tz).timestamp()
return builtins_open(filepath, *args, **kwargs)
@contextlib.contextmanager
def freeze_time(date, timezone=("UTC", 0), *, include_tm_zone=True):
# Freezegun does not behave very well with UTC and timezones, see spulec/freezegun#348.
# In particular, "now(tz=utc)" does not return the converted datetime.
# For this reason, we re-implement date parsing here to properly handle aware date using
# the optional "tz_offset" argument.
if isinstance(date, str):
for accepted_format in ["%Y-%m-%d", "%Y-%m-%d %H:%M:%S", "%Y-%m-%d %H:%M:%S.%f"]:
try:
date = datetime.datetime.strptime(date, accepted_format)
break
except ValueError:
pass
if not isinstance(date, datetime.datetime) or date.tzinfo is not None:
raise ValueError("Unsupported date provided")
zone, offset = timezone
tz_offset = datetime.timedelta(seconds=offset)
tzinfo = datetime.timezone(tz_offset, zone)
date = date.replace(tzinfo=tzinfo)
with monkeypatch.context() as context:
context.setitem(fakes, "zone", zone)
context.setitem(fakes, "offset", offset)
context.setitem(fakes, "include_tm_zone", include_tm_zone)
context.setattr(loguru._file_sink, "get_ctime", ctimes.__getitem__)
context.setattr(loguru._file_sink, "set_ctime", ctimes.__setitem__)
context.setattr(builtins, "open", patched_open)
# Freezegun does not permit to override timezone name.
context.setattr(freezegun.api, "fake_localtime", fake_localtime)
with freezegun.freeze_time(date, tz_offset=tz_offset) as frozen:
yield frozen
return freeze_time
@contextlib.contextmanager
def make_logging_logger(name, handler, fmt="%(message)s", level="DEBUG"):
logging_logger = logging.getLogger(name)
logging_logger.setLevel(level)
formatter = logging.Formatter(fmt)
handler.setLevel(level)
handler.setFormatter(formatter)
logging_logger.addHandler(handler)
try:
yield logging_logger
finally:
logging_logger.removeHandler(handler)
def _simulate_f_globals_name_absent(monkeypatch):
"""Simulate execution in Dask environment, where "__name__" is not available in globals."""
getframe_ = loguru._get_frame.load_get_frame_function()
def patched_getframe(*args, **kwargs):
frame = getframe_(*args, **kwargs)
frame.f_globals.pop("__name__", None)
return frame
with monkeypatch.context() as context:
context.setattr(loguru._logger, "get_frame", patched_getframe)
yield
def _simulate_no_frame_available(monkeypatch):
"""Simulate execution in Cython, where there is no stack frame to retrieve."""
def patched_getframe(*args, **kwargs):
raise ValueError("Call stack is not deep enough (dummy)")
with monkeypatch.context() as context:
context.setattr(loguru._logger, "get_frame", patched_getframe)
yield
@pytest.fixture(params=[_simulate_f_globals_name_absent, _simulate_no_frame_available])
def incomplete_frame_context(request, monkeypatch):
"""Simulate different scenarios where the stack frame is incomplete or entirely absent."""
yield from request.param(monkeypatch)
|