__init__.py 1.2 KB

1234567891011121314151617181920212223242526272829303132333435
  1. # Copyright 2019 The Matrix.org Foundation C.I.C.
  2. #
  3. # Licensed under the Apache License, Version 2.0 (the "License");
  4. # you may not use this file except in compliance with the License.
  5. # You may obtain a copy of the License at
  6. #
  7. # http://www.apache.org/licenses/LICENSE-2.0
  8. #
  9. # Unless required by applicable law or agreed to in writing, software
  10. # distributed under the License is distributed on an "AS IS" BASIS,
  11. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. # See the License for the specific language governing permissions and
  13. # limitations under the License.
  14. import logging
  15. from tests.unittest import TestCase
  16. class LoggerCleanupMixin(TestCase):
  17. def get_logger(self, handler: logging.Handler) -> logging.Logger:
  18. """
  19. Attach a handler to a logger and add clean-ups to remove revert this.
  20. """
  21. # Create a logger and add the handler to it.
  22. logger = logging.getLogger(__name__)
  23. logger.addHandler(handler)
  24. # Ensure the logger actually logs something.
  25. logger.setLevel(logging.INFO)
  26. # Ensure the logger gets cleaned-up appropriately.
  27. self.addCleanup(logger.removeHandler, handler)
  28. self.addCleanup(logger.setLevel, logging.NOTSET)
  29. return logger