fix: feedback review

Signed-off-by: va <va@us.ibm.com>

Author: vabarbosa

python/beeai_framework/tools/tool.py

@@ -14,7 +14,6 @@
 
 
 import inspect
-import re
 from abc import ABC, abstractmethod
 from collections.abc import Callable
 from typing import Any, Generic, TypeVar
@@ -27,6 +26,7 @@
 from beeai_framework.retryable import Retryable, RetryableConfig, RetryableContext, RetryableInput
 from beeai_framework.tools.errors import ToolError, ToolInputValidationError
 from beeai_framework.utils import BeeLogger
+from beeai_framework.utils.strings import to_safe_word
 
 logger = BeeLogger(__name__)
 
@@ -197,10 +197,8 @@ class FunctionTool(Tool):
 
         def __init__(self, options: dict[str, Any] | None = None) -> None:
             super().__init__(options)
-            # replace any non-alphanumeric char with _
-            formatted_name = re.sub(r"\W+", "_", self.name).lower()
             self.emitter = Emitter.root().child(
-                namespace=["tool", "custom", formatted_name],
+                namespace=["tool", "custom", to_safe_word(self.name)],
                 creator=self,
             )
 

python/beeai_framework/utils/strings.py

@@ -46,3 +46,8 @@ def create_strenum(name: str, keys: Sequence[str]) -> type[StrEnum]:
 
 def to_json(input: Any, *, indent: int | None = None) -> str:
     return json.dumps(input, ensure_ascii=False, default=lambda o: o.__dict__, sort_keys=True, indent=indent)
+
+
+def to_safe_word(phrase: str) -> str:
+    # replace any non-alphanumeric char with _
+    return re.sub(r"\W+", "_", phrase).lower()

python/beeai_framework/workflows/workflow.py

@@ -14,7 +14,6 @@
 
 import asyncio
 import inspect
-import re
 from collections.abc import Awaitable, Callable
 from dataclasses import field
 from typing import Any, ClassVar, Final, Generic, Literal
@@ -27,6 +26,7 @@
 from beeai_framework.emitter.emitter import Emitter
 from beeai_framework.errors import FrameworkError
 from beeai_framework.utils.models import ModelLike, check_model, to_model, to_model_optional
+from beeai_framework.utils.strings import to_safe_word
 from beeai_framework.utils.types import MaybeAsync
 from beeai_framework.workflows.errors import WorkflowError
 
@@ -84,10 +84,8 @@ def __init__(self, schema: type[T], name: str = "Workflow") -> None:
         self._steps: dict[K, WorkflowStepDefinition[T, K]] = {}
         self._start_step: K | None = None
 
-        # replace any non-alphanumeric char with _
-        formatted_name = re.sub(r"\W+", "_", self._name).lower()
         self.emitter = Emitter.root().child(
-            namespace=["workflow", formatted_name],
+            namespace=["workflow", to_safe_word(self._name)],
             creator=self,
         )