medcat.tokenizing.spacy_impl.utils

Functions:

• ensure_spacy_model –

  Ensure the specified spacy model exists.

• has_spacy_model –

  Checks if the spacy model is available.

Attributes:

• logger –

logger module-attribute

logger = getLogger(__name__)

ensure_spacy_model

ensure_spacy_model(model_name: str) -> None

Ensure the specified spacy model exists.

If the model does not currently exist, it will attempt downloading it.

Parameters:

• model_name

  (str) –

  The spacy model name.

Source code in medcat-v2/medcat/tokenizing/spacy_impl/utils.py

def ensure_spacy_model(model_name: str) -> None:
    """Ensure the specified spacy model exists.

    If the model does not currently exist, it will attempt downloading it.

    Args:
        model_name (str): The spacy model name.
    """
    if has_spacy_model(model_name):
        return
    import subprocess
    # running in subprocess so that we can catch the exception
    # if the model name is unknown. Otherwise we'd just be bumped
    # out of python (sys.exit).
    cmd = f"{sys.executable} -m spacy download {model_name}"
    logger.info("Installing the spacy model %s using the CLI command "
                "'%s'", model_name, cmd)
    try:
        subprocess.run(
            cmd.split(" "), check=True, capture_output=True, text=True)
    except subprocess.CalledProcessError as err:
        if ("requests.exceptions.ConnectionError" in err.stderr and
                "Failed to resolve" in err.stderr):
            logger.warning(
                "Unable to ensure the existing of spacy model '%s'. "
                "Internet seems to be unavailable. If the model "
                "does not provide its own implementation (it should), "
                "subsequent usage may prove problematic. Underlying error:\n"
                "%s", model_name, err.stderr, exc_info=err)
        else:
            raise err

has_spacy_model

has_spacy_model(model_name: str) -> bool

Checks if the spacy model is available.

Parameters:

• model_name

  (str) –

  The model name.

Returns:

• bool ( bool ) –

  True if the model is available, False otherwise.

Source code in medcat-v2/medcat/tokenizing/spacy_impl/utils.py

def has_spacy_model(model_name: str) -> bool:
    """Checks if the spacy model is available.

    Args:
        model_name (str): The model name.

    Returns:
        bool: True if the model is available, False otherwise.
    """
    import spacy.util
    return model_name in spacy.util.get_installed_models()