changed ValueError to ImportError (#5103)

# changed ValueError to ImportError Code cleaning. Fixed inconsistencies in ImportError handling. Sometimes it raises ImportError and sometime ValueError. I've changed all cases to the `raise ImportError` Also: - added installation instruction in the error message, where it missed; - fixed several installation instructions in the error message; - fixed several error handling in regards to the ImportError
langchain-ai · May 22, 2023 · c28cc0f · c28cc0f
1 parent 5e47c64
commit c28cc0f
Show file tree

Hide file tree

Showing 51 changed files with 141 additions and 133 deletions.
diff --git a/langchain/agents/agent_toolkits/pandas/base.py b/langchain/agents/agent_toolkits/pandas/base.py
@@ -34,7 +34,7 @@ def create_pandas_dataframe_agent(
     try:
         import pandas as pd
     except ImportError:
-        raise ValueError(
+        raise ImportError(
             "pandas package not found, please install with `pip install pandas`"
         )
 

diff --git a/langchain/cache.py b/langchain/cache.py
@@ -313,7 +313,7 @@ def init_gptcache(cache_obj: gptcache.Cache, llm str):
         try:
             import gptcache  # noqa: F401
         except ImportError:
-            raise ValueError(
+            raise ImportError(
                 "Could not import gptcache python package. "
                 "Please install it with `pip install gptcache`."
             )

diff --git a/langchain/chains/moderation.py b/langchain/chains/moderation.py
@@ -54,7 +54,7 @@ def validate_environment(cls, values: Dict) -> Dict:
                 openai.organization = openai_organization
             values["client"] = openai.Moderation
         except ImportError:
-            raise ValueError(
+            raise ImportError(
                 "Could not import openai python package. "
                 "Please install it with `pip install openai`."
             )

diff --git a/langchain/chat_models/azure_openai.py b/langchain/chat_models/azure_openai.py
@@ -86,7 +86,7 @@ def validate_environment(cls, values: Dict) -> Dict:
             if openai_organization:
                 openai.organization = openai_organization
         except ImportError:
-            raise ValueError(
+            raise ImportError(
                 "Could not import openai python package. "
                 "Please install it with `pip install openai`."
             )

diff --git a/langchain/document_loaders/apify_dataset.py b/langchain/document_loaders/apify_dataset.py
@@ -41,7 +41,7 @@ def validate_environment(cls, values: Dict) -> Dict:
 
             values["apify_client"] = ApifyClient()
         except ImportError:
-            raise ValueError(
+            raise ImportError(
                 "Could not import apify-client Python package. "
                 "Please install it with `pip install apify-client`."
             )

diff --git a/langchain/document_loaders/docugami.py b/langchain/document_loaders/docugami.py
@@ -63,7 +63,7 @@ def _parse_dgml(
         try:
             from lxml import etree
         except ImportError:
-            raise ValueError(
+            raise ImportError(
                 "Could not import lxml python package. "
                 "Please install it with `pip install lxml`."
             )
@@ -259,7 +259,7 @@ def _metadata_for_project(self, project: Dict) -> Dict:
                     try:
                         from lxml import etree
                     except ImportError:
-                        raise ValueError(
+                        raise ImportError(
                             "Could not import lxml python package. "
                             "Please install it with `pip install lxml`."
                         )

diff --git a/langchain/document_loaders/duckdb_loader.py b/langchain/document_loaders/duckdb_loader.py
@@ -33,7 +33,7 @@ def load(self) -> List[Document]:
         try:
             import duckdb
         except ImportError:
-            raise ValueError(
+            raise ImportError(
                 "Could not import duckdb python package. "
                 "Please install it with `pip install duckdb`."
             )

diff --git a/langchain/document_loaders/image_captions.py b/langchain/document_loaders/image_captions.py
@@ -39,7 +39,7 @@ def load(self) -> List[Document]:
         try:
             from transformers import BlipForConditionalGeneration, BlipProcessor
         except ImportError:
-            raise ValueError(
+            raise ImportError(
                 "`transformers` package not found, please install with "
                 "`pip install transformers`."
             )
@@ -66,7 +66,7 @@ def _get_captions_and_metadata(
         try:
             from PIL import Image
         except ImportError:
-            raise ValueError(
+            raise ImportError(
                 "`PIL` package not found, please install with `pip install pillow`"
             )
 

diff --git a/langchain/document_loaders/json_loader.py b/langchain/document_loaders/json_loader.py
@@ -42,7 +42,7 @@ def __init__(
         try:
             import jq  # noqa:F401
         except ImportError:
-            raise ValueError(
+            raise ImportError(
                 "jq package not found, please install it with `pip install jq`"
             )
 

diff --git a/langchain/document_loaders/notebook.py b/langchain/document_loaders/notebook.py
@@ -83,7 +83,7 @@ def load(
         try:
             import pandas as pd
         except ImportError:
-            raise ValueError(
+            raise ImportError(
                 "pandas is needed for Notebook Loader, "
                 "please install with `pip install pandas`"
             )

diff --git a/langchain/document_loaders/onedrive.py b/langchain/document_loaders/onedrive.py
@@ -77,7 +77,7 @@ def _auth(self) -> Type[Account]:
         try:
             from O365 import FileSystemTokenBackend
         except ImportError:
-            raise ValueError(
+            raise ImportError(
                 "O365 package not found, please install it with `pip install o365`"
             )
         if self.auth_with_token:

diff --git a/langchain/document_loaders/pdf.py b/langchain/document_loaders/pdf.py
@@ -103,7 +103,7 @@ def __init__(self, file_path: str) -> None:
         try:
             import pypdf  # noqa:F401
         except ImportError:
-            raise ValueError(
+            raise ImportError(
                 "pypdf package not found, please install it with " "`pip install pypdf`"
             )
         self.parser = PyPDFParser()
@@ -194,7 +194,7 @@ def __init__(self, file_path: str) -> None:
         try:
             from pdfminer.high_level import extract_text  # noqa:F401
         except ImportError:
-            raise ValueError(
+            raise ImportError(
                 "`pdfminer` package not found, please install it with "
                 "`pip install pdfminer.six`"
             )
@@ -222,7 +222,7 @@ def __init__(self, file_path: str):
         try:
             from pdfminer.high_level import extract_text_to_fp  # noqa:F401
         except ImportError:
-            raise ValueError(
+            raise ImportError(
                 "`pdfminer` package not found, please install it with "
                 "`pip install pdfminer.six`"
             )
@@ -256,7 +256,7 @@ def __init__(self, file_path: str) -> None:
         try:
             import fitz  # noqa:F401
         except ImportError:
-            raise ValueError(
+            raise ImportError(
                 "`PyMuPDF` package not found, please install it with "
                 "`pip install pymupdf`"
             )
@@ -375,7 +375,7 @@ def __init__(
         try:
             import pdfplumber  # noqa:F401
         except ImportError:
-            raise ValueError(
+            raise ImportError(
                 "pdfplumber package not found, please install it with "
                 "`pip install pdfplumber`"
             )

diff --git a/langchain/document_loaders/readthedocs.py b/langchain/document_loaders/readthedocs.py
@@ -19,9 +19,8 @@ def __init__(
         """Initialize path."""
         try:
             from bs4 import BeautifulSoup
-
         except ImportError:
-            raise ValueError(
+            raise ImportError(
                 "Could not import python packages. "
                 "Please install it with `pip install beautifulsoup4`. "
             )

diff --git a/langchain/document_loaders/s3_directory.py b/langchain/document_loaders/s3_directory.py
@@ -19,7 +19,7 @@ def load(self) -> List[Document]:
         try:
             import boto3
         except ImportError:
-            raise ValueError(
+            raise ImportError(
                 "Could not import boto3 python package. "
                 "Please install it with `pip install boto3`."
             )

diff --git a/langchain/document_loaders/s3_file.py b/langchain/document_loaders/s3_file.py
@@ -21,7 +21,7 @@ def load(self) -> List[Document]:
         try:
             import boto3
         except ImportError:
-            raise ValueError(
+            raise ImportError(
                 "Could not import `boto3` python package. "
                 "Please install it with `pip install boto3`."
             )

diff --git a/langchain/document_loaders/sitemap.py b/langchain/document_loaders/sitemap.py
@@ -58,7 +58,7 @@ def __init__(
         try:
             import lxml  # noqa:F401
         except ImportError:
-            raise ValueError(
+            raise ImportError(
                 "lxml package not found, please install it with " "`pip install lxml`"
             )
 
@@ -107,8 +107,9 @@ def load(self) -> List[Document]:
             try:
                 import bs4
             except ImportError:
-                raise ValueError(
-                    "bs4 package not found, please install it with " "`pip install bs4`"
+                raise ImportError(
+                    "beautifulsoup4 package not found, please install it"
+                    " with `pip install beautifulsoup4`"
                 )
             fp = open(self.web_path)
             soup = bs4.BeautifulSoup(fp, "xml")

diff --git a/langchain/document_loaders/srt.py b/langchain/document_loaders/srt.py
@@ -13,8 +13,8 @@ def __init__(self, file_path: str):
         try:
             import pysrt  # noqa:F401
         except ImportError:
-            raise ValueError(
-                "package `pysrt` not found, please install it with `pysrt`"
+            raise ImportError(
+                "package `pysrt` not found, please install it with `pip install pysrt`"
             )
         self.file_path = file_path
 

diff --git a/langchain/document_loaders/telegram.py b/langchain/document_loaders/telegram.py
@@ -226,7 +226,7 @@ def load(self) -> List[Document]:
                 nest_asyncio.apply()
                 asyncio.run(self.fetch_data_from_telegram())
             except ImportError:
-                raise ValueError(
+                raise ImportError(
                     """`nest_asyncio` package not found.
                     please install with `pip install nest_asyncio`
                     """
@@ -239,7 +239,7 @@ def load(self) -> List[Document]:
         try:
             import pandas as pd
         except ImportError:
-            raise ValueError(
+            raise ImportError(
                 """`pandas` package not found. 
                 please install with `pip install pandas`
                 """

diff --git a/langchain/document_loaders/twitter.py b/langchain/document_loaders/twitter.py
@@ -15,7 +15,7 @@ def _dependable_tweepy_import() -> tweepy:
     try:
         import tweepy
     except ImportError:
-        raise ValueError(
+        raise ImportError(
             "tweepy package not found, please install it with `pip install tweepy`"
         )
     return tweepy

diff --git a/langchain/document_loaders/url_playwright.py b/langchain/document_loaders/url_playwright.py
@@ -30,7 +30,7 @@ def __init__(
         try:
             import playwright  # noqa:F401
         except ImportError:
-            raise ValueError(
+            raise ImportError(
                 "playwright package not found, please install it with "
                 "`pip install playwright`"
             )

diff --git a/langchain/document_loaders/url_selenium.py b/langchain/document_loaders/url_selenium.py
@@ -40,15 +40,15 @@ def __init__(
         try:
             import selenium  # noqa:F401
         except ImportError:
-            raise ValueError(
+            raise ImportError(
                 "selenium package not found, please install it with "
                 "`pip install selenium`"
             )
 
         try:
             import unstructured  # noqa:F401
         except ImportError:
-            raise ValueError(
+            raise ImportError(
                 "unstructured package not found, please install it with "
                 "`pip install unstructured`"
             )

diff --git a/langchain/embeddings/cohere.py b/langchain/embeddings/cohere.py
@@ -48,7 +48,7 @@ def validate_environment(cls, values: Dict) -> Dict:
 
             values["client"] = cohere.Client(cohere_api_key)
         except ImportError:
-            raise ValueError(
+            raise ImportError(
                 "Could not import cohere python package. "
                 "Please install it with `pip install cohere`."
             )

diff --git a/langchain/embeddings/huggingface.py b/langchain/embeddings/huggingface.py
@@ -46,7 +46,7 @@ def __init__(self, **kwargs: Any):
             import sentence_transformers
 
         except ImportError as exc:
-            raise ValueError(
+            raise ImportError(
                 "Could not import sentence_transformers python package. "
                 "Please install it with `pip install sentence_transformers`."
             ) from exc

diff --git a/langchain/embeddings/jina.py b/langchain/embeddings/jina.py
@@ -34,7 +34,7 @@ def validate_environment(cls, values: Dict) -> Dict:
         try:
             import jina
         except ImportError:
-            raise ValueError(
+            raise ImportError(
                 "Could not import `jina` python package. "
                 "Please install it with `pip install jina`."
             )