spaCy/spacy/download.py

# coding: utf8
from __future__ import unicode_literals

import pip
import plac
import requests
from os import path
from .link import link
from . import about
from . import util


@plac.annotations(
    model=("Model to download", "positional", None, str),
    direct=("Force direct download", "flag", "d", bool)
)
def download(model=None, direct=False):
    """Download compatible model from default download path using pip."""

    check_error_depr(model)

    if direct:
        download_model('{m}/{m}.tar.gz'.format(m=model))
    else:
        model_name = about.__shortcuts__[model] if model in about.__shortcuts__ else model
        compatibility = get_compatibility()
        version = get_version(model_name, compatibility)
        download_model('{m}-{v}/{m}-{v}.tar.gz'.format(m=model_name, v=version))
        link(model_name, model, force=True)

def get_compatibility():
    version = about.__version__
    r = requests.get(about.__compatibility__)
    if r.status_code != 200:
        util.sys_exit(
            "Couldn't fetch compatibility table. Please find the right model for "
            "your spaCy installation (v{v}), and download it manually:".format(v=version),
            "python -m spacy.download [full model name + version] --direct",
            title="Server error ({c})".format(c=r.status_code))

    comp = r.json()['spacy']
    if version not in comp:
        util.sys_exit(
            "No compatible models found for v{v} of spaCy.".format(v=version),
            title="Compatibility error")
    else:
        return comp[version]


def get_version(model, comp):
    if model not in comp:
        util.sys_exit(
            "No compatible model found for "
            "{m} (spaCy v{v}).".format(m=model, v=about.__version__),
            title="Compatibility error")
    return comp[model][0]


def download_model(filename):
    util.print_msg("Downloading {f}".format(f=filename))
    download_url = path.join(about.__download_url__, filename)
    pip.main(['install', download_url])


def check_error_depr(model):
    if not model:
        util.sys_exit(
            "python -m spacy.download [name or shortcut]",
            title="Missing model name or shortcut")

    if model == 'all':
        util.sys_exit(
            "As of v1.7.0, the download all command is deprecated. Please "
            "download the models individually via spacy.download [model name] "
            "or pip install. For more info on this, see the documentation: "
            "{d}".format(d=about.__docs__),
            title="Deprecated command")


if __name__ == '__main__':
    plac.call(download)