Skip to content
Snippets Groups Projects
Commit 469f1afc authored by Anton Joubert's avatar Anton Joubert
Browse files

SAR-54 Auto format code with black

Command:  `black --line-length 100 --exclude docs .`
parent c5b171a8
No related branches found
No related tags found
No related merge requests found
...@@ -3,53 +3,43 @@ ...@@ -3,53 +3,43 @@
from setuptools import setup from setuptools import setup
with open('README.md') as readme_file: with open("README.md") as readme_file:
readme = readme_file.read() readme = readme_file.read()
setup( setup(
name='ska_logging', name="ska_logging",
version='0.1.0', version="0.1.0",
description="", description="",
long_description=readme + '\n\n', long_description=readme + "\n\n",
author='Anton Joubert', author="Anton Joubert",
author_email='ajoubert+ska@ska.ac.za', author_email="ajoubert+ska@ska.ac.za",
url='https://gitlab.com/ska-telescope/ska-logging', url="https://gitlab.com/ska-telescope/ska-logging",
packages=[ packages=["ska_logging"],
'ska_logging', package_dir={"ska_logging": "ska_logging"},
],
package_dir={'ska_logging':
'ska_logging'},
include_package_data=True, include_package_data=True,
license="BSD license", license="BSD license",
zip_safe=False, zip_safe=False,
classifiers=[ classifiers=[
'Development Status :: 2 - Pre-Alpha', "Development Status :: 2 - Pre-Alpha",
'Intended Audience :: Developers', "Intended Audience :: Developers",
'License :: OSI Approved :: BSD License', "License :: OSI Approved :: BSD License",
'Natural Language :: English', "Natural Language :: English",
'Programming Language :: Python :: 3', "Programming Language :: Python :: 3",
'Programming Language :: Python :: 3.5', "Programming Language :: Python :: 3.5",
'Programming Language :: Python :: 3.6', "Programming Language :: Python :: 3.6",
'Programming Language :: Python :: 3.7', "Programming Language :: Python :: 3.7",
'Programming Language :: Python :: 3.8', "Programming Language :: Python :: 3.8",
], ],
python_requires='>=3.5', python_requires=">=3.5",
test_suite='tests', test_suite="tests",
install_requires=[], install_requires=[],
setup_requires=[ setup_requires=[
# dependency for `python setup.py test` # dependency for `python setup.py test`
'pytest-runner', "pytest-runner",
# dependencies for `python setup.py build_sphinx` # dependencies for `python setup.py build_sphinx`
'sphinx', "sphinx",
'recommonmark' "recommonmark",
],
tests_require=[
'pytest',
'pytest-cov',
'pytest-json-report',
'pycodestyle',
], ],
extras_require={ tests_require=["pytest", "pytest-cov", "pytest-json-report", "pycodestyle"],
'dev': ['prospector[with_pyroma]', 'yapf', 'isort'], extras_require={"dev": ["prospector[with_pyroma]", "yapf", "isort"]},
}
) )
...@@ -2,12 +2,10 @@ ...@@ -2,12 +2,10 @@
"""Module init code.""" """Module init code."""
__all__ = ( __all__ = ("configure_logging",)
'configure_logging', __version__ = "0.1.0"
) __author__ = "Anton Joubert"
__version__ = '0.1.0' __email__ = "ajoubert+ska@ska.ac.za"
__author__ = 'Anton Joubert'
__email__ = 'ajoubert+ska@ska.ac.za'
from .configuration import configure_logging from .configuration import configure_logging
...@@ -43,23 +43,19 @@ _LOGGING_CONFIG = { ...@@ -43,23 +43,19 @@ _LOGGING_CONFIG = {
"disable_existing_loggers": False, "disable_existing_loggers": False,
"formatters": { "formatters": {
"default": { "default": {
'()': _UTCFormatter, "()": _UTCFormatter,
"format": _FORMAT_STR_NO_TAGS, "format": _FORMAT_STR_NO_TAGS,
"datefmt": "%Y-%m-%dT%H:%M:%S", "datefmt": "%Y-%m-%dT%H:%M:%S",
}, }
}, },
"handlers": { "handlers": {
"console": { "console": {
"class": "logging.StreamHandler", "class": "logging.StreamHandler",
"formatter": "default", "formatter": "default",
"stream": "ext://sys.stdout", "stream": "ext://sys.stdout",
},
},
"root": {
"handlers": ["console"],
"filters": [],
"level": "INFO",
} }
},
"root": {"handlers": ["console"], "filters": [], "level": "INFO"},
} }
...@@ -101,11 +97,7 @@ def configure_logging(level=None, tags_filter=None, overrides=None): ...@@ -101,11 +97,7 @@ def configure_logging(level=None, tags_filter=None, overrides=None):
if level: if level:
config["root"]["level"] = level config["root"]["level"] = level
if tags_filter: if tags_filter:
config["filters"] = { config["filters"] = {"tags": {"()": tags_filter}}
"tags": {
"()": tags_filter,
}
}
for handler in config["handlers"].values(): for handler in config["handlers"].values():
filters = handler.get("filters", []) filters = handler.get("filters", [])
if "tags" not in filters: if "tags" not in filters:
......
...@@ -62,17 +62,11 @@ class AppendHandler(logging.Handler): ...@@ -62,17 +62,11 @@ class AppendHandler(logging.Handler):
"""Override configuration for recording loggers""" """Override configuration for recording loggers"""
RECORDER_OVERRIDES = { RECORDER_OVERRIDES = {
"handlers": { "handlers": {"recorder": {"()": AppendHandler, "formatter": "default"}},
"recorder": { "root": {"handlers": ["console", "recorder"]},
"()": AppendHandler,
"formatter": "default",
}
},
"root": {
"handlers": ["console", "recorder"],
}
} }
@pytest.mark.usefixtures("reset_logging") @pytest.mark.usefixtures("reset_logging")
class TestConfigureLogging: class TestConfigureLogging:
"""Tests for :func:`~ska_logging.configuration.configure_logging`.""" """Tests for :func:`~ska_logging.configuration.configure_logging`."""
...@@ -100,6 +94,7 @@ class TestConfigureLogging: ...@@ -100,6 +94,7 @@ class TestConfigureLogging:
@pytest.fixture @pytest.fixture
def recording_tags_logger(self): def recording_tags_logger(self):
"""Return user logger like :func:`recording_logger`, but including tags filter.""" """Return user logger like :func:`recording_logger`, but including tags filter."""
class MyFilter(logging.Filter): class MyFilter(logging.Filter):
def filter(self, record): def filter(self, record):
record.tags = "key1:value1,key2:value2" record.tags = "key1:value1,key2:value2"
...@@ -124,12 +119,12 @@ class TestConfigureLogging: ...@@ -124,12 +119,12 @@ class TestConfigureLogging:
def test_configure_logging_set_log_level_int(self): def test_configure_logging_set_log_level_int(self):
configure_logging(level=logging.DEBUG) configure_logging(level=logging.DEBUG)
logger = logging.getLogger('ska.logger.test') logger = logging.getLogger("ska.logger.test")
assert logger.getEffectiveLevel() == logging.DEBUG assert logger.getEffectiveLevel() == logging.DEBUG
def test_configure_logging_set_log_level_string(self): def test_configure_logging_set_log_level_string(self):
configure_logging(level="WARNING") configure_logging(level="WARNING")
logger = logging.getLogger('ska.logger.test') logger = logging.getLogger("ska.logger.test")
assert logger.getEffectiveLevel() == logging.WARNING assert logger.getEffectiveLevel() == logging.WARNING
def test_configure_logging_default_uses_utc_time(self, recording_logger): def test_configure_logging_default_uses_utc_time(self, recording_logger):
...@@ -152,7 +147,7 @@ class TestConfigureLogging: ...@@ -152,7 +147,7 @@ class TestConfigureLogging:
assert "%(tags)s" in formatter._fmt assert "%(tags)s" in formatter._fmt
def test_configure_logging_tags_filter_emits_tags_value(self, recording_tags_logger): def test_configure_logging_tags_filter_emits_tags_value(self, recording_tags_logger):
recording_tags_logger.info('Tags message') recording_tags_logger.info("Tags message")
recorder = get_named_handler(recording_tags_logger, "recorder") recorder = get_named_handler(recording_tags_logger, "recorder")
record = recorder.records[0] record = recorder.records[0]
log_message = recorder.logs[0] log_message = recorder.logs[0]
...@@ -161,15 +156,8 @@ class TestConfigureLogging: ...@@ -161,15 +156,8 @@ class TestConfigureLogging:
def test_configure_logging_override(self): def test_configure_logging_override(self):
overrides = { overrides = {
"handlers": { "handlers": {"test": {"class": "logging.StreamHandler", "formatter": "default"}},
"test": { "root": {"handlers": ["console", "test"]},
"class": "logging.StreamHandler",
"formatter": "default",
}
},
"root": {
"handlers": ["console", "test"],
}
} }
configure_logging(overrides=overrides) configure_logging(overrides=overrides)
logger = logging.getLogger() logger = logging.getLogger()
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment