2017-03-16 16:01:51 +00:00
|
|
|
# coding: utf8
|
|
|
|
from __future__ import unicode_literals
|
|
|
|
|
2017-05-22 10:28:58 +00:00
|
|
|
import plac
|
2017-03-18 11:59:21 +00:00
|
|
|
from pathlib import Path
|
2017-05-22 10:28:58 +00:00
|
|
|
|
2017-05-07 21:25:29 +00:00
|
|
|
from ..compat import symlink_to, path2str
|
|
|
|
from ..util import prints
|
2017-03-18 14:14:48 +00:00
|
|
|
from .. import util
|
2017-03-16 16:01:51 +00:00
|
|
|
|
|
|
|
|
2017-05-22 10:28:58 +00:00
|
|
|
@plac.annotations(
|
|
|
|
origin=("package name or local path to model", "positional", None, str),
|
|
|
|
link_name=("name of shortuct link to create", "positional", None, str),
|
2017-10-27 12:38:39 +00:00
|
|
|
force=("force overwriting of existing link", "flag", "f", bool))
|
2018-01-03 19:48:12 +00:00
|
|
|
def link(_cmd, origin, link_name, force=False, model_path=None):
|
2017-05-27 18:01:46 +00:00
|
|
|
"""
|
|
|
|
Create a symlink for models within the spacy/data directory. Accepts
|
2017-05-22 10:28:58 +00:00
|
|
|
either the name of a pip package, or the local path to the model data
|
|
|
|
directory. Linking models allows loading them via spacy.load(link_name).
|
|
|
|
"""
|
2017-05-07 21:25:29 +00:00
|
|
|
if util.is_package(origin):
|
2017-06-04 11:45:50 +00:00
|
|
|
model_path = util.get_package_path(origin)
|
2017-03-16 16:01:51 +00:00
|
|
|
else:
|
2017-08-09 09:52:38 +00:00
|
|
|
model_path = Path(origin) if model_path is None else Path(model_path)
|
2017-04-16 18:53:25 +00:00
|
|
|
if not model_path.exists():
|
2017-05-07 21:25:29 +00:00
|
|
|
prints("The data should be located in %s" % path2str(model_path),
|
2017-05-22 10:28:58 +00:00
|
|
|
title="Can't locate model data", exits=1)
|
2017-10-18 22:53:49 +00:00
|
|
|
data_path = util.get_data_path()
|
|
|
|
if not data_path or not data_path.exists():
|
|
|
|
spacy_loc = Path(__file__).parent.parent
|
|
|
|
prints("Make sure a directory `/data` exists within your spaCy "
|
|
|
|
"installation and try again. The data directory should be "
|
|
|
|
"located here:", path2str(spacy_loc), exits=1,
|
|
|
|
title="Can't find the spaCy data path to create model symlink")
|
2017-03-18 17:57:31 +00:00
|
|
|
link_path = util.get_data_path() / link_name
|
|
|
|
if link_path.exists() and not force:
|
2017-05-07 21:25:29 +00:00
|
|
|
prints("To overwrite an existing link, use the --force flag.",
|
2017-05-22 10:28:58 +00:00
|
|
|
title="Link %s already exists" % link_name, exits=1)
|
2017-03-18 17:57:31 +00:00
|
|
|
elif link_path.exists():
|
|
|
|
link_path.unlink()
|
2017-04-15 10:11:16 +00:00
|
|
|
try:
|
|
|
|
symlink_to(link_path, model_path)
|
|
|
|
except:
|
2017-05-07 21:25:29 +00:00
|
|
|
# This is quite dirty, but just making sure other errors are caught.
|
|
|
|
prints("Creating a symlink in spacy/data failed. Make sure you have "
|
|
|
|
"the required permissions and try re-running the command as "
|
2017-10-27 12:38:39 +00:00
|
|
|
"admin, or use a virtualenv. You can still import the model as "
|
|
|
|
"a module and call its load() method, or create the symlink "
|
|
|
|
"manually.",
|
2017-05-07 21:25:29 +00:00
|
|
|
"%s --> %s" % (path2str(model_path), path2str(link_path)),
|
|
|
|
title="Error: Couldn't link model to '%s'" % link_name)
|
2017-04-16 20:28:16 +00:00
|
|
|
raise
|
2017-05-07 21:25:29 +00:00
|
|
|
prints("%s --> %s" % (path2str(model_path), path2str(link_path)),
|
2017-06-04 11:45:50 +00:00
|
|
|
"You can now load the model via spacy.load('%s')" % link_name,
|
2017-05-07 21:25:29 +00:00
|
|
|
title="Linking successful")
|