mirror of
https://github.com/explosion/spaCy.git
synced 2024-11-11 04:08:09 +03:00
d4cc736b7c
* Go back to using requests instead of urllib (closes #2320)
Fewer dependencies are good, but this one was simply causing too many other problems around SSL verification and Python 2/3 compatibility. requests is a popular enough package that it's okay for spaCy to depend on it – and this will hopefully make model downloads less flakey.
* Only download model if not installed (see #1456)
Use #egg=model==version to allow pip to check for existing installations. The download is only started if no installation matching the package/version is found. Fixes a long-standing inconvenience.
* Pass additional options to pip when installing model (resolves #1456)
Treat all additional arguments passed to the download command as pip options to allow user to customise the command. For example:
python -m spacy download en --user
* Add CLI option to enable installing model package dependencies
* Revert "Add CLI option to enable installing model package dependencies"
This reverts commit 9336ffe695.
* Update documentation
87 lines
3.2 KiB
Python
87 lines
3.2 KiB
Python
# coding: utf8
|
|
from __future__ import unicode_literals
|
|
|
|
import plac
|
|
import requests
|
|
import os
|
|
import subprocess
|
|
import sys
|
|
|
|
from ._messages import Messages
|
|
from .link import link
|
|
from ..util import prints, get_package_path
|
|
from .. import about
|
|
|
|
|
|
@plac.annotations(
|
|
model=("model to download, shortcut or name)", "positional", None, str),
|
|
direct=("force direct download. Needs model name with version and won't "
|
|
"perform compatibility check", "flag", "d", bool),
|
|
pip_args=("additional arguments to be passed to `pip install` when "
|
|
"installing the model"))
|
|
def download(model, direct=False, *pip_args):
|
|
"""
|
|
Download compatible model from default download path using pip. Model
|
|
can be shortcut, model name or, if --direct flag is set, full model name
|
|
with version.
|
|
"""
|
|
if direct:
|
|
dl = download_model('{m}/{m}.tar.gz#egg={m}'.format(m=model), pip_args)
|
|
else:
|
|
shortcuts = get_json(about.__shortcuts__, "available shortcuts")
|
|
model_name = shortcuts.get(model, model)
|
|
compatibility = get_compatibility()
|
|
version = get_version(model_name, compatibility)
|
|
dl = download_model('{m}-{v}/{m}-{v}.tar.gz#egg={m}=={v}'
|
|
.format(m=model_name, v=version), pip_args)
|
|
if dl != 0: # if download subprocess doesn't return 0, exit
|
|
sys.exit(dl)
|
|
try:
|
|
# Get package path here because link uses
|
|
# pip.get_installed_distributions() to check if model is a
|
|
# package, which fails if model was just installed via
|
|
# subprocess
|
|
package_path = get_package_path(model_name)
|
|
link(model_name, model, force=True, model_path=package_path)
|
|
except:
|
|
# Dirty, but since spacy.download and the auto-linking is
|
|
# mostly a convenience wrapper, it's best to show a success
|
|
# message and loading instructions, even if linking fails.
|
|
prints(Messages.M001.format(name=model_name), title=Messages.M002)
|
|
|
|
|
|
def get_json(url, desc):
|
|
r = requests.get(url)
|
|
if r.status_code != 200:
|
|
prints(Messages.M004.format(desc=desc, version=about.__version__),
|
|
title=Messages.M003.format(code=r.status_code), exits=1)
|
|
return r.json()
|
|
|
|
|
|
def get_compatibility():
|
|
version = about.__version__
|
|
version = version.rsplit('.dev', 1)[0]
|
|
comp_table = get_json(about.__compatibility__, "compatibility table")
|
|
comp = comp_table['spacy']
|
|
if version not in comp:
|
|
prints(Messages.M006.format(version=version), title=Messages.M005,
|
|
exits=1)
|
|
return comp[version]
|
|
|
|
|
|
def get_version(model, comp):
|
|
model = model.rsplit('.dev', 1)[0]
|
|
if model not in comp:
|
|
prints(Messages.M007.format(name=model, version=about.__version__),
|
|
title=Messages.M005, exits=1)
|
|
return comp[model][0]
|
|
|
|
|
|
def download_model(filename, user_pip_args=None):
|
|
download_url = about.__download_url__ + '/' + filename
|
|
pip_args = ['--no-cache-dir', '--no-deps']
|
|
if user_pip_args:
|
|
pip_args.extend(user_pip_args)
|
|
cmd = [sys.executable, '-m', 'pip', 'install'] + pip_args + [download_url]
|
|
return subprocess.call(cmd, env=os.environ.copy())
|