Update Black and lint the codebase to improve code quality and consis… (vocodedev#541)

arpagon · web-flow · commit cfd2eb44308c · 2024-05-03T15:27:36.000-07:00
* Update Black and lint the codebase to improve code quality and consistency, closes vocodedev#450 * Remove logger from telephony_server initialization
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,13 +1,13 @@
 repos:
--   repo: https://github.com/psf/black
-    rev: 23.1.0
-    hooks:
-    -   id: black
--   repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.8.0
-    hooks:
-    -   id: mypy
-        args: [--ignore-missing-imports, ./]
-        language: system
-        pass_filenames: false
-        stages: [pre-push]
+    - repo: https://github.com/psf/black
+      rev: 24.4.2
+      hooks:
+          - id: black
+    - repo: https://github.com/pre-commit/mirrors-mypy
+      rev: v1.8.0
+      hooks:
+          - id: mypy
+            args: [--ignore-missing-imports, ./]
+            language: system
+            pass_filenames: false
+            stages: [pre-push]
diff --git a/apps/telephony_app/main.py b/apps/telephony_app/main.py
@@ -73,7 +73,6 @@
                 account_sid=os.environ["TWILIO_ACCOUNT_SID"],
                 auth_token=os.environ["TWILIO_AUTH_TOKEN"],
             ),
-            logger=logger,
         )
     ],
     agent_factory=SpellerAgentFactory(),
diff --git a/contributing.md b/contributing.md
@@ -40,7 +40,7 @@ If you submit a PR, we'd love to feature your contribution on Twitter so please
 
 ## Linting and Typechecking
 
-We use [`black`](https://black.readthedocs.io/en/stable/) for linting. If you're using VSCode, code should auto-format automatically. Otherwise, run the following script before pushing:
+We use [`black`](https://black.readthedocs.io/en/stable/) for linting. If you're using [VSCode](https://code.visualstudio.com/docs/editor/codebasics#_formatting), code should auto-format automatically. Otherwise, run the following script before pushing:
 
 ```
 make lint_diff
diff --git a/playground/streaming/tracing_utils.py b/playground/streaming/tracing_utils.py
@@ -51,12 +51,13 @@ def get_final_metrics(scope_metrics, final_spans=None):
                 agent_str = metric_name.split(".", 1)[1].rsplit(".", 1)[0]
                 generate_total_key = f"agent.{agent_str}.generate_total"
                 respond_total_key = f"agent.{agent_str}.respond_total"
-                final_metrics[
-                    f"agent.{agent_str}.characters_per_second"
-                ] = raw_metric.value / (
-                    sum(final_spans[generate_total_key])
-                    if generate_total_key in final_spans
-                    else sum(final_spans[respond_total_key])
+                final_metrics[f"agent.{agent_str}.characters_per_second"] = (
+                    raw_metric.value
+                    / (
+                        sum(final_spans[generate_total_key])
+                        if generate_total_key in final_spans
+                        else sum(final_spans[respond_total_key])
+                    )
                 )
             else:
                 try:
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -48,7 +48,7 @@ langchain-community = "^0.0.16"
 
 
 [tool.poetry.group.lint.dependencies]
-black = "^23.1.0"
+black = "^24.4.2"
 
 
 [tool.poetry.group.dev.dependencies]
diff --git a/vocode/helpers.py b/vocode/helpers.py
@@ -40,9 +40,11 @@ def create_streaming_microphone_input_and_speaker_output(
 ):
     return _create_microphone_input_and_speaker_output(
         microphone_class=StreamingMicrophoneInput,
-        speaker_class=BlockingStreamingSpeakerOutput
-        if use_blocking_speaker_output
-        else StreamingSpeakerOutput,
+        speaker_class=(
+            BlockingStreamingSpeakerOutput
+            if use_blocking_speaker_output
+            else StreamingSpeakerOutput
+        ),
         use_default_devices=use_default_devices,
         input_device_name=input_device_name,
         output_device_name=output_device_name,
diff --git a/vocode/streaming/action/transfer_call.py b/vocode/streaming/action/transfer_call.py
@@ -31,7 +31,9 @@ class TransferCall(
         TransferCallActionConfig, TransferCallParameters, TransferCallResponse
     ]
 ):
-    description: str = "transfers the call. use when you need to connect the active call to another phone line."
+    description: str = (
+        "transfers the call. use when you need to connect the active call to another phone line."
+    )
     parameters_type: Type[TransferCallParameters] = TransferCallParameters
     response_type: Type[TransferCallResponse] = TransferCallResponse
 
diff --git a/vocode/streaming/action/worker.py b/vocode/streaming/action/worker.py
@@ -46,12 +46,16 @@ async def process(self, item: InterruptibleEvent[ActionInput]):
                 conversation_id=action_input.conversation_id,
                 action_input=action_input,
                 action_output=action_output,
-                vonage_uuid=action_input.vonage_uuid
-                if isinstance(action_input, VonagePhoneCallActionInput)
-                else None,
-                twilio_sid=action_input.twilio_sid
-                if isinstance(action_input, TwilioPhoneCallActionInput)
-                else None,
+                vonage_uuid=(
+                    action_input.vonage_uuid
+                    if isinstance(action_input, VonagePhoneCallActionInput)
+                    else None
+                ),
+                twilio_sid=(
+                    action_input.twilio_sid
+                    if isinstance(action_input, TwilioPhoneCallActionInput)
+                    else None
+                ),
                 is_quiet=action.quiet,
             )
         )
diff --git a/vocode/streaming/agent/base_agent.py b/vocode/streaming/agent/base_agent.py
@@ -140,9 +140,9 @@ def __init__(
         interruptible_event_factory: InterruptibleEventFactory = InterruptibleEventFactory(),
         logger: Optional[logging.Logger] = None,
     ):
-        self.input_queue: asyncio.Queue[
-            InterruptibleEvent[AgentInput]
-        ] = asyncio.Queue()
+        self.input_queue: asyncio.Queue[InterruptibleEvent[AgentInput]] = (
+            asyncio.Queue()
+        )
         self.output_queue: asyncio.Queue[
             InterruptibleAgentResponseEvent[AgentResponse]
         ] = asyncio.Queue()
@@ -154,9 +154,9 @@ def __init__(
             interruptible_event_factory=interruptible_event_factory,
         )
         self.action_factory = action_factory
-        self.actions_queue: asyncio.Queue[
-            InterruptibleEvent[ActionInput]
-        ] = asyncio.Queue()
+        self.actions_queue: asyncio.Queue[InterruptibleEvent[ActionInput]] = (
+            asyncio.Queue()
+        )
         self.logger = logger or logging.getLogger(__name__)
         self.goodbye_model = None
         if self.agent_config.end_conversation_on_goodbye:
diff --git a/vocode/streaming/agent/factory.py b/vocode/streaming/agent/factory.py
@@ -20,7 +20,7 @@
     InformationRetrievalAgentConfig,
     LLMAgentConfig,
     RESTfulUserImplementedAgentConfig,
-    LlamacppAgentConfig
+    LlamacppAgentConfig,
 )
 
 
diff --git a/vocode/streaming/agent/gpt4all_agent.py b/vocode/streaming/agent/gpt4all_agent.py
@@ -10,9 +10,11 @@ def __init__(self, agent_config: GPT4AllAgentConfig):
         self.turn_based_agent = TurnBasedGPT4AllAgent(
             model_path=agent_config.model_path,
             system_prompt=agent_config.prompt_preamble,
-            initial_message=agent_config.initial_message.text
-            if agent_config.initial_message
-            else None,
+            initial_message=(
+                agent_config.initial_message.text
+                if agent_config.initial_message
+                else None
+            ),
         )
 
     async def respond(
diff --git a/vocode/streaming/agent/utils.py b/vocode/streaming/agent/utils.py
@@ -50,9 +50,11 @@ async def collate_response_async(
             possible_list_item = bool(re.match(r"^\d+[ .]", buffer))
             ends_with_money = bool(re.findall(r"\$\d+.$", buffer))
             if re.findall(
-                list_item_ending_pattern
-                if possible_list_item
-                else sentence_endings_pattern,
+                (
+                    list_item_ending_pattern
+                    if possible_list_item
+                    else sentence_endings_pattern
+                ),
                 token,
             ):
                 if not ends_with_money:
@@ -88,12 +90,16 @@ async def openai_get_tokens(gen) -> AsyncGenerator[Union[str, FunctionFragment],
             yield token
         elif "function_call" in delta and delta["function_call"] is not None:
             yield FunctionFragment(
-                name=delta["function_call"]["name"]
-                if "name" in delta["function_call"]
-                else "",
-                arguments=delta["function_call"]["arguments"]
-                if "arguments" in delta["function_call"]
-                else "",
+                name=(
+                    delta["function_call"]["name"]
+                    if "name" in delta["function_call"]
+                    else ""
+                ),
+                arguments=(
+                    delta["function_call"]["arguments"]
+                    if "arguments" in delta["function_call"]
+                    else ""
+                ),
             )
 
 
diff --git a/vocode/streaming/client_backend/conversation.py b/vocode/streaming/client_backend/conversation.py
@@ -78,9 +78,11 @@ def get_conversation(
             agent=self.agent_thunk(),
             synthesizer=synthesizer,
             conversation_id=start_message.conversation_id,
-            events_manager=TranscriptEventManager(output_device, self.logger)
-            if start_message.subscribe_transcript
-            else None,
+            events_manager=(
+                TranscriptEventManager(output_device, self.logger)
+                if start_message.subscribe_transcript
+                else None
+            ),
             logger=self.logger,
         )
 
diff --git a/vocode/streaming/models/events.py b/vocode/streaming/models/events.py
@@ -38,4 +38,4 @@ class RecordingEvent(Event, type=EventType.RECORDING):
 
 class ActionEvent(Event, type=EventType.ACTION):
     action_input: Optional[dict] = None
-    action_output: Optional[dict] = None
+    action_output: Optional[dict] = None
diff --git a/vocode/streaming/output_device/base_output_device.py b/vocode/streaming/output_device/base_output_device.py
@@ -11,7 +11,7 @@ def start(self):
 
     def consume_nonblocking(self, chunk: bytes):
         raise NotImplemented
-    
+
     def maybe_send_mark_nonblocking(self, message):
         pass
 
diff --git a/vocode/streaming/output_device/websocket_output_device.py b/vocode/streaming/output_device/websocket_output_device.py
@@ -9,7 +9,6 @@
 from vocode.streaming.models.transcript import TranscriptEvent
 
 
-
 class WebsocketOutputDevice(BaseOutputDevice):
     def __init__(
         self, ws: WebSocket, sampling_rate: int, audio_encoding: AudioEncoding
diff --git a/vocode/streaming/synthesizer/base_synthesizer.py b/vocode/streaming/synthesizer/base_synthesizer.py
@@ -248,12 +248,12 @@ async def experimental_mp3_streaming_output_generator(
         chunk_size: int,
         create_speech_span: Optional[Span],
     ) -> AsyncGenerator[SynthesisResult.ChunkResult, None]:
-        miniaudio_worker_input_queue: asyncio.Queue[
-            Union[bytes, None]
-        ] = asyncio.Queue()
-        miniaudio_worker_output_queue: asyncio.Queue[
-            Tuple[bytes, bool]
-        ] = asyncio.Queue()
+        miniaudio_worker_input_queue: asyncio.Queue[Union[bytes, None]] = (
+            asyncio.Queue()
+        )
+        miniaudio_worker_output_queue: asyncio.Queue[Tuple[bytes, bool]] = (
+            asyncio.Queue()
+        )
         miniaudio_worker = MiniaudioWorker(
             self.synthesizer_config,
             chunk_size,
diff --git a/vocode/streaming/transcriber/assembly_ai_transcriber.py b/vocode/streaming/transcriber/assembly_ai_transcriber.py
@@ -8,7 +8,11 @@
 from urllib.parse import urlencode
 from vocode import getenv
 
-from vocode.streaming.models.transcriber import AssemblyAITranscriberConfig, TimeEndpointingConfig, PunctuationEndpointingConfig
+from vocode.streaming.models.transcriber import (
+    AssemblyAITranscriberConfig,
+    TimeEndpointingConfig,
+    PunctuationEndpointingConfig,
+)
 from vocode.streaming.models.websocket import AudioMessage
 from vocode.streaming.transcriber.base_transcriber import (
     BaseAsyncTranscriber,
@@ -57,13 +61,22 @@ def __init__(
         self.buffer = bytearray()
         self.audio_cursor = 0
 
-        if isinstance(self.transcriber_config.endpointing_config, (TimeEndpointingConfig, PunctuationEndpointingConfig)):
-            self.transcriber_config.end_utterance_silence_threshold_milliseconds = int(self.transcriber_config.endpointing_config.time_cutoff_seconds * 1000)
+        if isinstance(
+            self.transcriber_config.endpointing_config,
+            (TimeEndpointingConfig, PunctuationEndpointingConfig),
+        ):
+            self.transcriber_config.end_utterance_silence_threshold_milliseconds = int(
+                self.transcriber_config.endpointing_config.time_cutoff_seconds * 1000
+            )
         self.terminate_msg = json.dumps({"terminate_session": True})
         self.end_utterance_silence_threshold_msg = (
-            None if self.transcriber_config.end_utterance_silence_threshold_milliseconds is None 
+            None
+            if self.transcriber_config.end_utterance_silence_threshold_milliseconds
+            is None
             else json.dumps(
-                {"end_utterance_silence_threshold": self.transcriber_config.end_utterance_silence_threshold_milliseconds}
+                {
+                    "end_utterance_silence_threshold": self.transcriber_config.end_utterance_silence_threshold_milliseconds
+                }
             )
         )
 
diff --git a/vocode/streaming/transcriber/azure_transcriber.py b/vocode/streaming/transcriber/azure_transcriber.py
diff --git a/vocode/streaming/transcriber/base_transcriber.py b/vocode/streaming/transcriber/base_transcriber.py
diff --git a/vocode/streaming/utils/__init__.py b/vocode/streaming/utils/__init__.py
diff --git a/vocode/streaming/utils/conversation_logger_adapter.py b/vocode/streaming/utils/conversation_logger_adapter.py
diff --git a/vocode/turn_based/synthesizer/base_synthesizer.py b/vocode/turn_based/synthesizer/base_synthesizer.py
diff --git a/vocode/turn_based/synthesizer/coqui_synthesizer.py b/vocode/turn_based/synthesizer/coqui_synthesizer.py

Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,6 @@`
`73`	`73`	`account_sid=os.environ["TWILIO_ACCOUNT_SID"],`
`74`	`74`	`auth_token=os.environ["TWILIO_AUTH_TOKEN"],`
`75`	`75`	`),`
`76`		`- logger=logger,`
`77`	`76`	`)`
`78`	`77`	`],`
`79`	`78`	`agent_factory=SpellerAgentFactory(),`