Summary

Fixes https://github.com/hynek/structlog/issues/619

render_to_log_kwargs reserves stackLevel when it should be stacklevel

python stdlib kwargs https://github.com/python/cpython/blob/main/Lib/logging/__init__.py#L1632

import structlog

structlog.configure(
    processors=[
        structlog.stdlib.render_to_log_kwargs,
    ],
    cache_logger_on_first_use=True,
)

log = structlog.get_logger()

log.info("test", stacklevel=2)  # doesn't error, but doesn't pass stacklevel to stdlib

log.info("test", stackLevel=2)  # errors as it passes stackLevel to stdlib

Traceback (most recent call last):
  File "C:\Users\user\Path\to\file.py", line 12, in <module>
    log.info("test", stacklevel=2)
  File "C:\Users\user\VirtualEnv\project\lib\site-packages\structlog\_log_levels.py", line 157, in meth
    return self._proxy_to_logger(name, event, **kw)
  File "C:\Users\user\VirtualEnv\project\lib\site-packages\structlog\_base.py", line 206, in _proxy_to_logger
    return getattr(self._logger, method_name)(*args, **kw)
TypeError: msg() got an unexpected keyword argument 'msg'

Pull Request Check List

[x] Do not open pull requests from your main branch – use a separate branch!
- There's a ton of footguns waiting if you don't heed this warning. You can still go back to your project, create a branch from your main branch, push it, and open the pull request from the new branch.
- This is not a pre-requisite for your your pull request to be accepted, but you have been warned.
[x] Added tests for changed code.
- The CI fails with less than 100% coverage.
[x] New APIs are added to our typing tests in api.py.
[x] Updated documentation for changed code.
- [x] New functions/classes have to be added to docs/api.rst by hand.
- [x] Changed/added classes/methods/functions have appropriate versionadded, versionchanged, or deprecated directives.
  - The next version is the second number in the current release + 1. The first number represents the current year. So if the current version on PyPI is 23.1.0, the next version is gonna be 23.2.0. If the next version is the first in the new year, it'll be 24.1.0.
[x] Documentation in .rst and .md files is written using semantic newlines.
[x] Changes (and possible deprecations) are documented in the changelog.
[x] Consider granting push permissions to the PR branch, so maintainers can fix minor issues themselves without pestering you.

hynek / structlog

fixes bug in render_to_log_kwargs #620

Summary

Pull Request Check List