Skip to content

Commit

Permalink
Balckified the code
Browse files Browse the repository at this point in the history
  • Loading branch information
@DeekshaMohanty
DeekshaMohanty committed Sep 16, 2024
1 parent cf92b5a commit a95096c
Show file tree
Hide file tree
Showing 2 changed files with 73 additions and 27 deletions.
98 changes: 72 additions & 26 deletions tardis/io/logger/logger.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,18 @@
}

LOG_LEVEL_COLORS = {
logging.INFO: '#D3D3D3',
logging.WARNING: 'orange',
logging.ERROR: 'red',
logging.CRITICAL: 'orange',
logging.DEBUG: 'blue',
'default': 'black'
logging.INFO: "#D3D3D3",
logging.WARNING: "orange",
logging.ERROR: "red",
logging.CRITICAL: "orange",
logging.DEBUG: "blue",
"default": "black",
}

DEFAULT_LOG_LEVEL = "INFO"
DEFAULT_SPECIFIC_STATE = False


def logging_state(log_level, tardis_config, specific_log_level=None):
"""
Function to set the logging configuration for the simulation output
Expand All @@ -42,10 +43,12 @@ def logging_state(log_level, tardis_config, specific_log_level=None):
Allows setting specific logging levels. Logs of the `log_level` level would be output.
"""
if "debug" in tardis_config:
specific_log_level = (
tardis_config["debug"].get("specific_log_level", specific_log_level)
specific_log_level = tardis_config["debug"].get(
"specific_log_level", specific_log_level
)
logging_level = log_level or tardis_config["debug"].get(
"log_level", "INFO"
)
logging_level = log_level or tardis_config["debug"].get("log_level", "INFO")
if log_level and tardis_config["debug"].get("log_level"):
print(
"log_level is defined both in Functional Argument & YAML Configuration {debug section}"
Expand All @@ -65,7 +68,11 @@ def logging_state(log_level, tardis_config, specific_log_level=None):
)

logger = logging.getLogger("tardis")
tardis_loggers = [logging.getLogger(name) for name in logging.root.manager.loggerDict if name.startswith("tardis")]
tardis_loggers = [
logging.getLogger(name)
for name in logging.root.manager.loggerDict
if name.startswith("tardis")
]

if logging_level in LOGGING_LEVELS:
for logger in tardis_loggers:
Expand All @@ -77,15 +84,18 @@ def logging_state(log_level, tardis_config, specific_log_level=None):
logger.removeFilter(filter)

if specific_log_level:
filter_log = FilterLog([LOGGING_LEVELS[logging_level], logging.INFO, logging.DEBUG])
filter_log = FilterLog(

Check warning on line 87 in tardis/io/logger/logger.py

View check run for this annotation

Codecov / codecov/patch

tardis/io/logger/logger.py#L87 

Added line #L87 was not covered by tests
[LOGGING_LEVELS[logging_level], logging.INFO, logging.DEBUG]
)
for logger in tardis_loggers:
logger.addFilter(filter_log)
else:
for filter in logger.filters:
for logger in tardis_loggers:
logger.removeFilter(filter)

def create_output_widget(height='300px'):

def create_output_widget(height="300px"):
"""
Creates an Output widget with the specified layout.
Expand All @@ -99,15 +109,17 @@ def create_output_widget(height='300px'):
ipywidgets.Output
Configured Output widget.
"""
return Output(layout=Layout(height=height, overflow_y='auto'))
return Output(layout=Layout(height=height, overflow_y="auto"))


log_outputs = {
"WARNING/ERROR": create_output_widget(),
"INFO": create_output_widget(),
"DEBUG": create_output_widget(),
"ALL": create_output_widget()
"ALL": create_output_widget(),
}


def create_and_display_log_tab(log_outputs):
"""
Creates a Tab widget for logging outputs and displays it.
Expand All @@ -117,14 +129,22 @@ def create_and_display_log_tab(log_outputs):
log_outputs : dict
Dictionary containing Output widgets for different log levels.
"""
tab = Tab(children=[log_outputs["WARNING/ERROR"], log_outputs["INFO"], log_outputs["DEBUG"], log_outputs["ALL"]])
tab = Tab(
children=[
log_outputs["WARNING/ERROR"],
log_outputs["INFO"],
log_outputs["DEBUG"],
log_outputs["ALL"],
]
)
tab.set_title(0, "WARNING/ERROR")
tab.set_title(1, "INFO")
tab.set_title(2, "DEBUG")
tab.set_title(3, "ALL")

display(tab)


def remove_ansi_escape_sequences(text):
"""
Remove ANSI escape sequences from a string.
Expand All @@ -139,8 +159,9 @@ def remove_ansi_escape_sequences(text):
str
The cleaned string without ANSI escape sequences.
"""
ansi_escape = re.compile(r'\x1B[@-_][0-?]*[ -/]*[@-~]')
return ansi_escape.sub('', text)
ansi_escape = re.compile(r"\x1B[@-_][0-?]*[ -/]*[@-~]")
return ansi_escape.sub("", text)


class WidgetHandler(logging.Handler):
"""
Expand All @@ -151,6 +172,7 @@ class WidgetHandler(logging.Handler):
logging.Handler : class
Inherits from the logging.Handler class.
"""

def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)

Expand All @@ -166,9 +188,11 @@ def emit(self, record):
log_entry = self.format(record)
clean_log_entry = remove_ansi_escape_sequences(log_entry)

color = LOG_LEVEL_COLORS.get(record.levelno, LOG_LEVEL_COLORS['default'])
color = LOG_LEVEL_COLORS.get(
record.levelno, LOG_LEVEL_COLORS["default"]
)

parts = clean_log_entry.split(' ', 2)
parts = clean_log_entry.split(" ", 2)
if len(parts) > 2:
prefix = parts[0]
levelname = parts[1]
Expand All @@ -179,18 +203,39 @@ def emit(self, record):

if record.levelno in (logging.WARNING, logging.ERROR):
with log_outputs["WARNING/ERROR"]:
display(HTML(f"<pre style='white-space: pre-wrap; word-wrap: break-word;'>{html_output}</pre>"))
display(
HTML(
f"<pre style='white-space: pre-wrap; word-wrap: break-word;'>{html_output}</pre>"
)
)
elif record.levelno == logging.INFO:
with log_outputs["INFO"]:
display(HTML(f"<pre style='white-space: pre-wrap; word-wrap: break-word;'>{html_output}</pre>"))
display(
HTML(
f"<pre style='white-space: pre-wrap; word-wrap: break-word;'>{html_output}</pre>"
)
)
elif record.levelno == logging.DEBUG:
with log_outputs["DEBUG"]:
display(HTML(f"<pre style='white-space: pre-wrap; word-wrap: break-word;'>{html_output}</pre>"))
display(
HTML(
f"<pre style='white-space: pre-wrap; word-wrap: break-word;'>{html_output}</pre>"
)
)
with log_outputs["ALL"]:
display(HTML(f"<pre style='white-space: pre-wrap; word-wrap: break-word;'>{html_output}</pre>"))
display(
HTML(
f"<pre style='white-space: pre-wrap; word-wrap: break-word;'>{html_output}</pre>"
)
)


widget_handler = WidgetHandler()
widget_handler.setFormatter(logging.Formatter('%(name)s [%(levelname)s] %(message)s (%(filename)s:%(lineno)d)'))
widget_handler.setFormatter(
logging.Formatter(
"%(name)s [%(levelname)s] %(message)s (%(filename)s:%(lineno)d)"
)
)

logging.captureWarnings(True)
logger = logging.getLogger("tardis")
Expand All @@ -208,6 +253,7 @@ def emit(self, record):
logging.getLogger("py.warnings").addHandler(widget_handler)
create_and_display_log_tab(log_outputs)


class FilterLog(object):
"""
Filter Log Class for Filtering Logging Output to a particular level.
Expand All @@ -217,6 +263,7 @@ class FilterLog(object):
log_levels : list
List of log levels to be filtered.
"""

def __init__(self, log_levels):
self.log_levels = log_levels

Check warning on line 268 in tardis/io/logger/logger.py

View check run for this annotation

Codecov / codecov/patch

tardis/io/logger/logger.py#L268 

Added line #L268 was not covered by tests

Expand All @@ -235,4 +282,3 @@ def filter(self, log_record):
True if the log record's level is in the specified log_levels, False otherwise.
"""
return log_record.levelno in self.log_levels

Check warning on line 284 in tardis/io/logger/logger.py

View check run for this annotation

Codecov / codecov/patch

tardis/io/logger/logger.py#L284 

Added line #L284 was not covered by tests

2 changes: 1 addition & 1 deletion tardis/simulation/base.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -626,7 +626,7 @@ def log_plasma_state(
plasma_state_log["w"] = dilution_factor
plasma_state_log["next_w"] = next_dilution_factor
plasma_state_log.columns.name = "Shell No."

output_df = ""
plasma_output = plasma_state_log.iloc[::log_sampling].to_string(
float_format=lambda x: f"{x:.3g}",
Expand Down

0 comments on commit a95096c

Please sign in to comment.