Create python API for CLOG #80072

New Issue

Mateusz Grzeliński · 2020-08-24T11:28:25+02:00

2020-08-24 11:28:25 +02:00

Status: Prototype is created but design is not set

Description
Big picture: Remove print functions from blender .py files, add integrate python logging module with blender info editor

Use cases:

there are many small python files with print, that reports error. This error can be tricky to track down, as path and line is not appended
reduce usage of system console
for addon developers to have nice feedback

Design:

use python built in logging module as much as posible
expose blender logging as handler bpy.utils.LogHandler. Loghandler inherits logging.Handler and is fully functional python class.

optional: expose individual log utilities for quick and easy: `bpy.utils.info("message")`, `bpy.utils.warning` and so on

Log integration would be enabled like any other blender log: --log "bke.*,bpy.my_addon"

Engineer plan:

Minimal use case:
** any log related UI is left for addon developer. If addon developer wants to expose log level in his user preferences, he will create separate property by himself.

import logging
import bpy
log = logging.getLogger("bpy.my_addon")  # add type for easy filtering in blender
log.addhandler(bpy.utils.log.LogHandler())  # integrate with blender
log.setLevel(logging.INFO)  # the rest of pythonic stuff

small extension for blender internal use:

import _bpy # hide it from users

# for blender internal usage, quick and easy, but always logs to "bpy.log"
_bpy.utils.log.error("hello")
_bpy.utils.log.warning("hello")
_bpy.utils.log.info("hello")
_bpy.utils.log.debug("hello")

experimental, requires more design: deeper integration with blender
automatically add handler inherit blender log settings
**

import bpy
import logging

log = bpy.utils.log.getLogger("bpy.my_addon")  # automatically add handler, inherit blender log settings and other magic
log.setLevel(logging.INFO)  # this becomes problematic as it conflicts with blender settings

=====Work plan=====

In order to utilize new filtering features available in info editor:

[] python log name must correspond to new CLG_LogType. Currently log types are stored in list what will not be efficient enough.
[] CLG_LogRecord assumes that file path is const char and python gives us path which need to be copied. Where to store that memory?
[] can we use global log context or do we need to create new one?

Minimal implementation is done in {D8688} but not all issues are solved.

{F8807983}

**Status:** Prototype is created but design is not set --- **Description** **Big picture:** Remove `print` functions from blender `.py` files, add integrate python `logging` module with blender info editor **Use cases**: * there are many small python files with print, that reports error. This error can be tricky to track down, as path and line is not appended * reduce usage of system console * for addon developers to have nice feedback **Design:** - use python built in `logging` module as much as posible - expose blender logging as handler `bpy.utils.LogHandler`. `Loghandler` inherits `logging.Handler` and is fully functional python class. # optional: expose individual log utilities for quick and easy: `bpy.utils.info("message")`, `bpy.utils.warning` and so on Log integration would be enabled like any other blender log: `--log "bke.*,bpy.my_addon"` **Engineer plan:** * Minimal use case: ** any log related UI is left for addon developer. If addon developer wants to expose log level in his user preferences, he will create separate property by himself. ```lang=python import logging import bpy log = logging.getLogger("bpy.my_addon") # add type for easy filtering in blender log.addhandler(bpy.utils.log.LogHandler()) # integrate with blender log.setLevel(logging.INFO) # the rest of pythonic stuff ``` * small extension for blender internal use: ```lang=python import _bpy # hide it from users # for blender internal usage, quick and easy, but always logs to "bpy.log" _bpy.utils.log.error("hello") _bpy.utils.log.warning("hello") _bpy.utils.log.info("hello") _bpy.utils.log.debug("hello") ``` * experimental, requires more design: deeper integration with blender **automatically add handler** inherit blender log settings ** ```lang=python import bpy import logging log = bpy.utils.log.getLogger("bpy.my_addon") # automatically add handler, inherit blender log settings and other magic log.setLevel(logging.INFO) # this becomes problematic as it conflicts with blender settings ``` =====Work plan===== In order to utilize new filtering features available in info editor: - [] python log name must correspond to new `CLG_LogType`. Currently log types are stored in list what will not be efficient enough. - [] `CLG_LogRecord` assumes that file path is `const char` and python gives us path which need to be copied. Where to store that memory? - [] can we use global log context or do we need to create new one? Minimal implementation is done in {D8688} but not all issues are solved. {F8807983}

Mateusz Grzeliński self-assigned this 2020-08-24 11:28:25 +02:00

Mateusz Grzeliński commented

2020-08-24 11:28:26 +02:00

Added subscriber: @grzelins