Source code for pyani.scripts.subcommands.subcmd_listdeps

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# (c) University of Strathclyde 2020
# Author: Leighton Pritchard
#
# Contact:
# leighton.pritchard@strath.ac.uk
#
# Leighton Pritchard,
# Strathclyde Institute for Pharmacy and Biomedical Sciences,
# 161 Cathedral Street,
# Glasgow,
# G4 0RE
# Scotland,
# UK
#
# The MIT License
#
# Copyright (c) 2020 University of Strathclyde
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
"""Provides the listdeps subcommand for pyani."""

import logging
import platform
import sys

from argparse import Namespace

from pyani.dependencies import (
    get_requirements,
    get_dev_requirements,
    get_pip_requirements,
    get_tool_versions,
)


[docs]def subcmd_listdeps(args: Namespace) -> int: """Reports dependency versions to logger. :param args: Namespace, received command-line arguments """ # If the -v argument is provided, we don't want to have two # streams writing to STDOUT logger = logging.getLogger(__name__) # Adding this handler means we bypass the default logging # formatter, and write straight to the terminal as stdout if not args.verbose: handler = logging.StreamHandler(sys.stdout) handler.setLevel(logging.INFO) logger.addHandler(handler) # System information logger.info("System information") logger.info("\tPlatorm==%s", platform.platform()) logger.info("\tPython==%s", sys.version) # Pyani dependencies logger.info("Installed pyani Python dependendencies...") for package, version, loc in get_requirements(): logger.info("\t%s==%s (%s)", package, version, loc) logger.info("Installed pyani development dependendencies...") for package, version, loc in get_dev_requirements(): logger.info("\t%s==%s (%s)", package, version, loc) logger.info("Installed pyani pip-install dependendencies...") for package, version, loc in get_pip_requirements(): logger.info("\t%s==%s (%s)", package, version, loc) logger.info("Installed third-party tool versions...") for tool, version in get_tool_versions(): logger.info("\t%s==%s", tool, version) return 0