Source code for pyani.scripts.subcommands.subcmd_createdb

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# (c) The James Hutton Institute 2017-2019
# (c) University of Strathclyde 2019-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) 2017-2019 The James Hutton Institute
# Copyright (c) 2019-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 createdb subcommand for pyani."""

import logging

from argparse import Namespace

from pyani import pyani_orm


[docs]def subcmd_createdb(args: Namespace) -> int: """Create an empty pyani database. :param args: Namespace, command-line arguments :param logger: logging object """ # Create logger logger = logging.getLogger(__name__) # If the database exists, raise an error rather than overwrite if args.dbpath.is_file(): if not args.force: logger.error("Database %s already exists (exiting)", args.dbpath) raise SystemError(1) logger.warning("Database %s already exists - overwriting", args.dbpath) args.dbpath.unlink() # If the path to the database doesn't exist, create it if not args.dbpath.parent.is_dir(): logger.info("Creating database directory %s", args.dbpath.parent) args.dbpath.parent.mkdir(parents=True, exist_ok=True) # Create the empty database logger.info("Creating pyani database at %s", args.dbpath) pyani_orm.create_db(args.dbpath) return 0