Skip to content

exceptions

langroid/exceptions.py

LangroidImportError(package=None, extra=None, error='', *args)

Bases: ImportError

Parameters:

Name Type Description Default
package str

The name of the package to import.

 None
extra str

The name of the extras package required for this import.

 None
error str

The error message to display. Depending on context, we can set this by capturing the ImportError message.

 ''
Source code in langroid/exceptions.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
def __init__(
    self,
    package: Optional[str] = None,
    extra: Optional[str] = None,
    error: str = "",
    *args: object,
) -> None:
    """
    Generate helpful warning when attempting to import package or module.

    Args:
        package (str): The name of the package to import.
        extra (str): The name of the extras package required for this import.
        error (str): The error message to display. Depending on context, we
            can set this by capturing the ImportError message.

    """
    if error == "" and package is not None:
        error = f"{package} is not installed by default with Langroid.\n"

    if extra:
        install_help = f"""
            If you want to use it, please install langroid 
            with the `{extra}` extra, for example:

            If you are using pip:
            pip install "langroid[{extra}]"

            For multiple extras, you can separate them with commas:
            pip install "langroid[{extra},another-extra]"

            If you are using Poetry:
            poetry add langroid --extras "{extra}"

            For multiple extras with Poetry, list them with spaces:
            poetry add langroid --extras "{extra} another-extra"

            If you are working within the langroid dev env (which uses Poetry),
            you can do:
            poetry install -E "{extra}" 
            or if you want to include multiple extras:
            poetry install -E "{extra} another-extra"
            """
    else:
        install_help = """
            If you want to use it, please install it in the same
            virtual environment as langroid.
            """
    msg = error + install_help

    super().__init__(msg, *args)