Merge branch 'fix/optional-text-requirements' into fix/data-types-imports

Author: briangreunke

dreadnode/scorers/classification.py

@@ -3,7 +3,7 @@
 from dreadnode.meta import Config
 from dreadnode.metric import Metric
 from dreadnode.scorers import Scorer
-from dreadnode.util import clean_str, warn_at_user_stacklevel
+from dreadnode.util import clean_str, generate_import_error_msg, warn_at_user_stacklevel
 
 # Global cache for pipelines
 g_transformer_pipeline_cache: dict[str, t.Any] = {}
@@ -30,9 +30,7 @@ def zero_shot_classification(
         model_name: The name of the zero-shot model from Hugging Face Hub.
         name: Name of the scorer.
     """
-    transformers_error_msg = (
-        "Transformers dependency is not installed. Install with: pip install transformers"
-    )
+    transformers_error_msg = generate_import_error_msg("transformers", "training")
 
     try:
         from transformers import pipeline  # type: ignore[import-not-found]

dreadnode/scorers/pii.py

@@ -4,7 +4,7 @@
 from dreadnode.metric import Metric
 from dreadnode.scorers import Scorer
 from dreadnode.scorers.contains import contains
-from dreadnode.util import warn_at_user_stacklevel
+from dreadnode.util import generate_import_error_msg, warn_at_user_stacklevel
 
 if t.TYPE_CHECKING:
     from presidio_analyzer import AnalyzerEngine  # type: ignore[import-not-found]
@@ -103,13 +103,10 @@ def detect_pii_with_presidio(
         invert: Invert the score (1.0 for no PII, 0.0 for PII detected).
         name: Name of the scorer.
     """
-    presidio_import_error_msg = (
-        "Presidio dependencies are not installed. "
-        "Install with: pip install presidio-analyzer presidio-anonymizer 'spacy[en_core_web_lg]'"
-    )
+    presidio_import_error_msg = generate_import_error_msg("presidio-analyzer", "text")
 
     try:
-        import presidio_analyzer  # type: ignore[import-not-found,unused-ignore]
+        import presidio_analyzer  # type: ignore[import-not-found]
     except ImportError:
         warn_at_user_stacklevel(presidio_import_error_msg, UserWarning)
 

dreadnode/scorers/sentiment.py

@@ -6,7 +6,7 @@
 from dreadnode.meta import Config
 from dreadnode.metric import Metric
 from dreadnode.scorers.base import Scorer
-from dreadnode.util import warn_at_user_stacklevel
+from dreadnode.util import generate_import_error_msg, warn_at_user_stacklevel
 
 Sentiment = t.Literal["positive", "negative", "neutral"]
 
@@ -29,7 +29,7 @@ def sentiment(
         target: The desired sentiment to score against.
         name: Name of the scorer.
     """
-    textblob_import_error_msg = "TextBlob dependency is not installed. Install with: pip install textblob && python -m textblob.download_corpora"
+    textblob_import_error_msg = generate_import_error_msg("textblob", "text")
 
     try:
         from textblob import TextBlob  # type: ignore[import-not-found]

dreadnode/scorers/similarity.py

@@ -5,7 +5,7 @@
 from dreadnode.metric import Metric
 from dreadnode.scorers.base import Scorer
 from dreadnode.scorers.util import cosine_similarity
-from dreadnode.util import warn_at_user_stacklevel
+from dreadnode.util import generate_import_error_msg, warn_at_user_stacklevel
 
 if t.TYPE_CHECKING:
     from sentence_transformers import (  # type: ignore[import-not-found]
@@ -88,7 +88,7 @@ def similarity_with_rapidfuzz(
         score_cutoff: Optional score cutoff below which to return 0.0.
         name: Name of the scorer.
     """
-    rapidfuzz_import_error_msg = "RapidFuzz dependency is not installed. Please install it with: pip install rapidfuzz or dreadnode[text]"
+    rapidfuzz_import_error_msg = generate_import_error_msg("rapidfuzz", "text")
     try:
         from rapidfuzz import fuzz, utils  # type: ignore[import-not-found]
     except ImportError:
@@ -182,7 +182,7 @@ def string_distance(
         normalize: Normalize distances and convert to similarity scores.
         name: Name of the scorer.
     """
-    rapidfuzz_import_error_msg = "RapidFuzz dependency is not installed. Please install it with: pip install rapidfuzz or dreadnode[text]"
+    rapidfuzz_import_error_msg = generate_import_error_msg("rapidfuzz", "text")
 
     try:
         from rapidfuzz import distance  # type: ignore[import-not-found]
@@ -251,7 +251,7 @@ def similarity_with_tf_idf(reference: str, *, name: str = "similarity") -> "Scor
         reference: The reference text (e.g., expected output).
         name: Name of the scorer.
     """
-    sklearn_import_error_msg = "scikit-learn dependency is not installed. Please install it with: pip install scikit-learn or dreadnode[text]"
+    sklearn_import_error_msg = generate_import_error_msg("scikit-learn", "text")
 
     try:
         from sklearn.feature_extraction.text import (  # type: ignore[import-not-found]
@@ -303,7 +303,7 @@ def similarity_with_sentence_transformers(
         model_name: The name of the sentence-transformer model to use.
         name: Name of the scorer.
     """
-    sentence_transformers_error_msg = "Sentence transformers dependency is not installed. Please install it with: pip install sentence-transformers or dreadnode[training]"
+    sentence_transformers_error_msg = generate_import_error_msg("sentence-transformers", "training")
 
     try:
         from sentence_transformers import (  # type: ignore[import-not-found]
@@ -367,7 +367,7 @@ def similarity_with_litellm(
                   or self-hosted models.
         name: Name of the scorer.
     """
-    litellm_import_error_msg = "litellm dependency is not installed. Please install it with: pip install litellm or dreadnode[text]"
+    litellm_import_error_msg = generate_import_error_msg("litellm", "text")
     try:
         import litellm
     except ImportError:
@@ -430,7 +430,7 @@ def bleu(
         weights: Weights for unigram, bigram, etc. Must sum to 1.
         name: Name of the scorer.
     """
-    nltk_import_error_msg = "NLTK dependency is not installed. Install with: pip install nltk && python -m nltk.downloader punkt"
+    nltk_import_error_msg = generate_import_error_msg("nltk", "text")
 
     try:
         import nltk  # type: ignore[import-not-found]

dreadnode/util.py

@@ -154,6 +154,13 @@ def format_dict(data: dict[str, t.Any], max_length: int = 80) -> str:
     return f"{{{formatted}}}"
 
 
+def generate_import_error_msg(package_name: str, extras_name: str) -> str:
+    return (
+        f"Missing required package '{package_name}'. "
+        f"Please install it with: pip install {package_name} or dreadnode[{extras_name}]"
+    )
+
+
 # Types