Skip to content

structlog 25.5.0

Version history | Download JSON

  • PyPI https://pypi.org/project/structlog/
    Repository https://github.com/hynek/structlog

  • py.typed

  • Coverage

    %%{init: {"pie": {"textPosition": 0.85}, "theme": "neutral", "themeVariables": {"pieStrokeWidth": "1px"}}}%%
pie title
    "Typed" : 532
    "Any" : 128
    "Untyped" : 40
    • 94.3% coverage
    • 76.0% coverage (strict)
    • 700 typable
      • 532 typed
      • 40 untyped
      • 128 Any

  • Typables

    %%{init: {"pie": {"textPosition": 0.85}, "theme": "neutral", "themeVariables": {"pieStrokeWidth": "1px"}}}%%
pie title
    "functions" : 126
    "classes" : 528
    "other" : 10
    • 43 functions (+0 overloads)
      • 83 parameters
    • 50 classes
      • 183 methods (+0 overloads)
        • 317 parameters
      • 17 properties
    • 18 modules
      • 10 attrs

Modules

Module Coverage Coverage (strict) Typables Ignores
structlog 0.0% 0.0% 0 1
structlog._base 96.4% 82.1% 28 0
structlog._config 100.0% 80.8% 26 0
structlog._generic 100.0% 80.0% 5 0
structlog._log_levels 100.0% 75.0% 4 0
structlog._native 100.0% 100.0% 2 0
structlog._output 94.4% 88.9% 108 0
structlog.contextvars 94.1% 82.4% 17 0
structlog.dev 90.5% 88.9% 63 1
structlog.exceptions 0.0% 0.0% 0 0
structlog.processors 90.0% 88.9% 90 0
structlog.stdlib 96.0% 68.2% 201 0
structlog.testing 100.0% 30.4% 56 0
structlog.threadlocal 95.5% 81.8% 22 0
structlog.tracebacks 82.1% 76.9% 39 1
structlog.twisted 97.0% 75.8% 33 0
structlog.types 0.0% 0.0% 0 0
structlog.typing 100.0% 100.0% 6 0

Incomplete Annotations

structlog._base (1 missing, 4 any)

Symbol Typable Typed Any
meth BoundLoggerBase.init 4 3 0
meth BoundLoggerBase.bind 2 2 1
meth BoundLoggerBase.new 2 2 1
meth BoundLoggerBase._proxy_to_logger 4 4 2

structlog._config (0 missing, 5 any)

Symbol Typable Typed Any
func get_logger 3 3 3
func wrap_logger 8 8 2

structlog._generic (0 missing, 1 any)

Symbol Typable Typed Any
meth BoundLogger.getattr 2 2 1

structlog._log_levels (0 missing, 1 any)

Symbol Typable Typed Any
func add_log_level 4 4 1

structlog._output (6 missing, 6 any)

Symbol Typable Typed Any
meth WriteLoggerFactory.init 2 1 0
meth WriteLoggerFactory.call 2 2 1
meth WriteLogger.init 2 1 0
meth WriteLogger.setstate 2 2 1
meth BytesLoggerFactory.init 2 1 0
meth BytesLoggerFactory.call 2 2 1
meth PrintLoggerFactory.init 2 1 0
meth PrintLoggerFactory.call 2 2 1
meth BytesLogger.init 2 1 0
meth BytesLogger.setstate 2 2 1
meth PrintLogger.init 2 1 0
meth PrintLogger.setstate 2 2 1

structlog.contextvars (1 missing, 2 any)

Symbol Typable Typed Any
func bound_contextvars 2 2 1
attr STRUCTLOG_KEY_PREFIX_LEN 1 0 0
func bind_contextvars 2 2 1

structlog.dev (6 missing, 1 any)

Symbol Typable Typed Any
meth ConsoleRenderer.init 13 12 0
meth ConsoleRenderer._repr 2 2 1
attr ConsoleRenderer.exception_formatter 1 0 0
attr ConsoleRenderer.columns 1 0 0
func rich_traceback 3 0 0

structlog.processors (9 missing, 1 any)

Symbol Typable Typed Any
meth KeyValueRenderer.init 5 4 0
attr dict_tracebacks 1 0 0
attr ExceptionPrettyPrinter.format_exception 1 0 0
meth JSONRenderer.init 3 3 1
meth EventRenamer.init 3 2 0
attr EventRenamer.to 1 0 0
attr EventRenamer.replace_by 1 0 0
attr format_exc_info 1 0 0
meth LogfmtRenderer.init 5 4 0
attr LogfmtRenderer.bool_as_flag 1 0 0

structlog.stdlib (8 missing, 56 any)

Symbol Typable Typed Any
attr PositionalArgumentsFormatter.remove_positional_args 1 0 0
meth BoundLogger.bind 2 2 1
meth BoundLogger.new 2 2 1
meth BoundLogger.debug 4 4 3
meth BoundLogger.info 4 4 3
meth BoundLogger.warning 4 4 3
meth BoundLogger.warn 4 4 3
meth BoundLogger.error 4 4 3
meth BoundLogger.critical 4 4 3
meth BoundLogger.fatal 4 4 3
meth BoundLogger.exception 4 4 3
meth BoundLogger.log 5 5 3
meth BoundLogger._proxy_to_logger 5 5 2
meth BoundLogger.makeRecord 10 10 1
meth BoundLogger.adebug 4 4 2
meth BoundLogger.ainfo 4 4 2
meth BoundLogger.awarning 4 4 2
meth BoundLogger.aerror 4 4 2
meth BoundLogger.acritical 4 4 2
meth BoundLogger.afatal 4 4 2
meth BoundLogger.aexception 4 4 2
meth BoundLogger.alog 5 5 3
prop BoundLogger.parent 1 1 1
prop BoundLogger.handlers 1 1 1
meth ProcessorFormatter.init 11 11 2
attr ProcessorFormatter.foreign_pre_chain 1 0 0
attr ProcessorFormatter.keep_exc_info 1 0 0
attr ProcessorFormatter.keep_stack_info 1 0 0
attr ProcessorFormatter.logger 1 0 0
attr ProcessorFormatter.pass_foreign_args 1 0 0
attr ProcessorFormatter.use_get_message 1 0 0
func get_logger 3 3 2
meth LoggerFactory.init 2 1 0
meth LoggerFactory.call 2 2 1

structlog.testing (0 missing, 39 any)

Symbol Typable Typed Any
meth ReturnLogger.msg 3 3 3
meth ReturnLogger.log 3 3 3
meth ReturnLogger.debug 3 3 3
meth ReturnLogger.info 3 3 3
meth ReturnLogger.warn 3 3 3
meth ReturnLogger.warning 3 3 3
meth ReturnLogger.fatal 3 3 3
meth ReturnLogger.failure 3 3 3
meth ReturnLogger.err 3 3 3
meth ReturnLogger.error 3 3 3
meth ReturnLogger.critical 3 3 3
meth ReturnLogger.exception 3 3 3
meth ReturnLoggerFactory.call 2 2 1
meth CapturingLoggerFactory.call 2 2 1
meth CapturingLogger.getattr 2 2 1

structlog.threadlocal (1 missing, 3 any)

Symbol Typable Typed Any
func bind_threadlocal 2 2 1
func bound_threadlocal 2 2 1
func tmp_bind 3 3 1
attr ThreadLocal 1 0 0

structlog.tracebacks (7 missing, 2 any)

Symbol Typable Typed Any
func safe_str 2 2 1
attr ExceptionDictTransformer.show_locals 1 0 0
attr ExceptionDictTransformer.locals_max_length 1 0 0
attr ExceptionDictTransformer.locals_max_string 1 0 0
attr ExceptionDictTransformer.locals_hide_dunder 1 0 0
attr ExceptionDictTransformer.locals_hide_sunder 1 0 0
attr ExceptionDictTransformer.max_frames 1 0 0
attr ExceptionDictTransformer.use_rich 1 0 0
func to_repr 5 5 1

structlog.twisted (1 missing, 7 any)

Symbol Typable Typed Any
attr ReprWrapper.string 1 0 0
meth BoundLogger.msg 3 3 2
meth BoundLogger.err 3 3 2
meth JSONLogObserverWrapper.init 2 2 1
meth EventAdapter.call 4 4 1
meth LoggerFactory.call 2 2 1

Type-Ignore Comments

Flavor Count
type: ignore[assignment] 3