import platform from pathlib import Path from wasabi import msg import srsly from .validate import get_model_pkgs from .. import util from .. import about def info( model: ("Optional model name", "positional", None, str) = None, markdown: ("Generate Markdown for GitHub issues", "flag", "md", str) = False, silent: ("Don't print anything (just return)", "flag", "s") = False, ): """ Print info about spaCy installation. If a model is speficied as an argument, print model information. Flag --markdown prints details in Markdown for easy copy-pasting to GitHub issues. """ if model: if util.is_package(model): model_path = util.get_package_path(model) else: model_path = model meta_path = model_path / "meta.json" if not meta_path.is_file(): msg.fail("Can't find model meta.json", meta_path, exits=1) meta = srsly.read_json(meta_path) if model_path.resolve() != model_path: meta["link"] = str(model_path) meta["source"] = str(model_path.resolve()) else: meta["source"] = str(model_path) if not silent: title = f"Info about model '{model}'" model_meta = { k: v for k, v in meta.items() if k not in ("accuracy", "speed") } if markdown: print_markdown(model_meta, title=title) else: msg.table(model_meta, title=title) return meta all_models, _ = get_model_pkgs() data = { "spaCy version": about.__version__, "Location": str(Path(__file__).parent.parent), "Platform": platform.platform(), "Python version": platform.python_version(), "Models": ", ".join( f"{m['name']} ({m['version']})" for m in all_models.values() ), } if not silent: title = "Info about spaCy" if markdown: print_markdown(data, title=title) else: msg.table(data, title=title) return data def print_markdown(data, title=None): """Print data in GitHub-flavoured Markdown format for issues etc. data (dict or list of tuples): Label/value pairs. title (str / None): Title, will be rendered as headline 2. """ markdown = [] for key, value in data.items(): if isinstance(value, str) and Path(value).exists(): continue markdown.append(f"* **{key}:** {value}") if title: print(f"\n## {title}") print("\n{}\n".format("\n".join(markdown)))