Fix pylint issues

Author: gustavocidornelas

openlayer/llm_monitors.py

@@ -178,6 +178,7 @@ def stream_chunks():
                     start_time = time.time()
                     first_token_time = None
                     num_of_completion_tokens = None
+                    latency = None
                     try:
                         i = 0
                         for i, chunk in enumerate(chunks):

openlayer/tracing/enums.py

@@ -1,3 +1,5 @@
+"""Module with the enums used in the tracing module."""
+
 import enum
 
 

openlayer/tracing/steps.py

@@ -7,17 +7,24 @@
 
 
 class Step:
+    """Step, defined as a single function call being traced.
+
+    This is the base class for all the different types of steps that can be
+    used in a trace. Steps can also contain nested steps, which represent
+    function calls made within the parent step.
+    """
+
     def __init__(
         self,
         name: str,
         inputs: Optional[Any] = None,
         output: Optional[Any] = None,
-        metadata: Dict[str, any] = {},
+        metadata: Optional[Dict[str, any]] = None,
     ) -> None:
         self.name = name
         self.inputs = inputs
         self.output = output
-        self.metadata = metadata
+        self.metadata = metadata or {}
 
         self.step_type: enums.StepType = None
         self.start_time = time.time()
@@ -54,24 +61,28 @@ def to_dict(self) -> Dict[str, Any]:
 
 
 class UserCallStep(Step):
+    """User call step represents a generic user call in the trace."""
+
     def __init__(
         self,
         name: str,
         inputs: Optional[Any] = None,
         output: Optional[Any] = None,
-        metadata: Dict[str, any] = {},
+        metadata: Optional[Dict[str, any]] = None,
     ) -> None:
         super().__init__(name=name, inputs=inputs, output=output, metadata=metadata)
         self.step_type = enums.StepType.USER_CALL
 
 
 class ChatCompletionStep(Step):
+    """Chat completion step represents an LLM chat completion in the trace."""
+
     def __init__(
         self,
         name: str,
         inputs: Optional[Any] = None,
         output: Optional[Any] = None,
-        metadata: Dict[str, any] = {},
+        metadata: Optional[Dict[str, any]] = None,
     ) -> None:
         super().__init__(name=name, inputs=inputs, output=output, metadata=metadata)
 

openlayer/tracing/tracer.py

@@ -16,6 +16,7 @@
 _streamer = None
 try:
     _streamer = data_streamer.DataStreamer(publish=True)
+# pylint: disable=broad-except
 except Exception as exc:
     logger.error(
         "You have not provided enough information to upload traces to Openlayer."
@@ -34,7 +35,7 @@ def create_step(
     step_type: enums.StepType = enums.StepType.USER_CALL,
     inputs: Optional[Any] = None,
     output: Optional[Any] = None,
-    metadata: Dict[str, any] = {},
+    metadata: Optional[Dict[str, Any]] = None,
 ) -> Generator[steps.Step, None, None]:
     """Starts a trace and yields a Step object."""
     new_step: steps.Step = steps.step_factory(
@@ -50,7 +51,7 @@ def create_step(
         _current_trace.set(current_trace)  # Set the current trace in context
         current_trace.add_step(new_step)
     else:
-        logger.debug(f"Adding step {name} to parent step {parent_step.name}")
+        logger.debug("Adding step %s to parent step %s", name, parent_step.name)
         current_trace = _current_trace.get()
         parent_step.add_nested_step(new_step)
 
@@ -86,7 +87,7 @@ def create_step(
                     " Openlayer."
                 )
         else:
-            logger.debug(f"Ending step {name}")
+            logger.debug("Ending step %s", name)
 
 
 def add_openai_chat_completion_step_to_trace(**kwargs) -> None:
@@ -133,17 +134,19 @@ def wrapper(*func_args, **func_kwargs):
 
 
 # --------------------- Helper post-processing functions --------------------- #
-def process_trace_for_upload(trace: traces.Trace) -> Tuple[Dict[str, Any], List[str]]:
+def process_trace_for_upload(
+    trace_obj: traces.Trace,
+) -> Tuple[Dict[str, Any], List[str]]:
     """Post processing of the trace data before uploading to Openlayer.
 
     This is done to ensure backward compatibility with data on Openlayer.
     """
-    root_step = trace.steps[0]
+    root_step = trace_obj.steps[0]
 
     input_variables = root_step.inputs
     input_variable_names = list(input_variables.keys())
 
-    processed_steps = bubble_up_costs_and_tokens(trace.to_dict())
+    processed_steps = bubble_up_costs_and_tokens(trace_obj.to_dict())
 
     trace_data = {
         **input_variables,

openlayer/tracing/traces.py

@@ -6,6 +6,12 @@
 
 
 class Trace:
+    """Trace, defined as a sequence of steps.
+
+    Each step represents a function call being traced. Steps can also
+    contain nested steps, which represent function calls made within the
+    parent step."""
+
     def __init__(self):
         self.steps = []
         self.current_step = None