processors/debug.py

#   Copyright 2023 Google LLC
#
#   Licensed under the Apache License, Version 2.0 (the "License");
#   you may not use this file except in compliance with the License.
#   You may obtain a copy of the License at
#
#       http://www.apache.org/licenses/LICENSE-2.0
#
#   Unless required by applicable law or agreed to in writing, software
#   distributed under the License is distributed on an "AS IS" BASIS,
#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#   See the License for the specific language governing permissions and
#   limitations under the License.
from .base import Processor


class DebugProcessor(Processor):
    """
    Dumps Jinja variable state to output. Useful for debugging.
    """

    def get_default_config_key():
        return 'debug'

    def process(self, output_var='debug'):
        self.logger.debug(
            'Jinja variable state',
            extra={'jinja_environment': self.jinja_environment.globals})
        return {}