Add spacy.info module

Print info about spaCy installation, local setup and models. Allow
export in Markdown format to copy-paste into GitHub issues.
This commit is contained in:
ines 2017-03-18 13:01:16 +01:00
parent 0eafc0f2c6
commit e3e25c0a33

64
spacy/info.py Normal file
View File

@ -0,0 +1,64 @@
# coding: utf8
from __future__ import unicode_literals
import plac
import platform
import sys
from pathlib import Path
from . import about
from . import util
@plac.annotations(
model=("Model to download", "positional", None, str),
markdown=("Generate Markdown for GitHub issues", "flag", "md", str)
)
def main(model=None, markdown=False):
info(model, markdown)
def info(model=None, markdown=False):
"""Print info about spaCy installation and models for debugging."""
if model:
data = util.parse_package_meta(util.get_data_path(), model, require=True)
model_path = Path(__file__).parent / util.get_data_path() / model
if model_path.resolve() != model_path:
data['link'] = str(model_path)
data['source'] = str(model_path.resolve())
else:
data['source'] = str(model_path)
print_info(data, "model " + model, markdown)
else:
data = get_spacy_data()
print_info(data, "spaCy", markdown)
def print_info(data, title, markdown):
title = "Info about {title}".format(title=title)
if markdown:
util.print_markdown(data, title=title)
else:
util.print_table(data, title=title)
def get_spacy_data():
return {
'spaCy version': about.__version__,
'Location': str(Path(__file__).parent),
'Platform': platform.platform(),
'Python version': platform.python_version(),
'Installed models': ', '.join(list_models())
}
def list_models():
data_path = util.get_data_path()
return [f.parts[-1] for f in data_path.iterdir() if f.is_dir()]
if __name__ == '__main__':
plac.call(main)