| #!/usr/bin/env python3 |
| # Copyright 2022 Canonical Ltd. |
| # |
| # 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. |
| # |
| # For those usages not covered by the Apache License, Version 2.0 please |
| # contact: legal@canonical.com |
| # |
| # To get in touch with the maintainers, please contact: |
| # osm-charmers@lists.launchpad.net |
| # |
| # |
| # Learn more at: https://juju.is/docs/sdk |
| |
| """Define logging helpers.""" |
| |
| import functools |
| |
| |
| def log_event_handler(logger): |
| """Log with the provided logger when a event handler method is executed.""" |
| |
| def decorator(method): |
| @functools.wraps(method) |
| def decorated(self, event): |
| logger.info(f"* running {self.__class__.__name__}.{method.__name__}") |
| try: |
| return method(self, event) |
| finally: |
| logger.info(f"* completed {self.__class__.__name__}.{method.__name__}") |
| |
| return decorated |
| |
| return decorator |