File size: 4,125 Bytes
8a79f2e |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 |
# -*- coding: utf-8 -*-
from __future__ import absolute_import, division, print_function, unicode_literals
from future.utils import raise_from, string_types
from builtins import (bytes, str, open, super, range,
zip, round, input, int, pow, object)
import os
import shutil
import traceback
from termcolor import colored
import colorama
colorama.init()
import gslab_make.private.messages as messages
import gslab_make.private.metadata as metadata
from gslab_make.private.exceptionclasses import CritError, ColoredError
from gslab_make.private.utility import get_path, format_message, norm_path, open_yaml
def _check_os(osname = os.name):
"""Check OS is either POSIX or NT.
Parameters
----------
osname : str, optional
Name of OS. Defaults to ``os.name``.
Returns
-------
None
"""
if osname not in ['posix', 'nt']:
raise CritError(messages.crit_error_unknown_system % osname)
def update_executables(paths, osname = None):
""".. Update executable names using user configuration file.
Updates executable names with executables listed in file ``config_user``.
Note
----
Executable names are used by :ref:`program functions <program functions>`.
Parameters
----------
paths : dict
Dictionary of paths. Dictionary should contain values for all keys listed below.
osname : str, optional
Name of OS. Defaults to ``os.name``.
Path Keys
---------
config_user : str
Path of user configuration file.
Returns
-------
None
"""
osname = osname if osname else os.name # https://github.com/sphinx-doc/sphinx/issues/759
try:
config_user = get_path(paths, 'config_user')
config_user = open_yaml(config_user)
_check_os(osname)
if config_user['local']['executables']:
metadata.default_executables[osname].update(config_user['local']['executables'])
except:
error_message = 'Error with update_executables. Traceback can be found below.'
error_message = format_message(error_message)
raise_from(ColoredError(error_message, traceback.format_exc()), None)
def update_paths(paths):
""".. Update paths using user configuration file.
Updates dictionary ``paths`` with externals listed in file ``config_user``.
Note
----
The ``paths`` argument for :ref:`sourcing functions<sourcing functions>` is used not only to get
default paths for writing/logging, but also to
`string format <https://docs.python.org/3.4/library/string.html#format-string-syntax>`__
sourcing instructions.
Parameters
----------
paths : dict
Dictionary of paths to update.
Dictionary should ex-ante contain values for all keys listed below.
Path Keys
---------
config_user : str
Path of user configuration file.
Returns
-------
paths : dict
Dictionary of updated paths.
"""
try:
config_user = get_path(paths, 'config_user')
config_user = open_yaml(config_user)
if config_user['external']:
paths.update(config_user['external'])
return(paths)
except:
error_message = 'Error with update_paths. Traceback can be found below.'
error_message = format_message(error_message)
raise_from(ColoredError(error_message, traceback.format_exc()), None)
def copy_output(file, copy_dir):
""".. Copy output file.
Copies output ``file`` to directory ``copy_dir`` with user prompt to confirm copy.
Parameters
----------
file : str
Path of file to copy.
copy_dir : str
Directory to copy file.
Returns
-------
None
"""
file = norm_path(file)
copy_dir = norm_path(copy_dir)
message = colored(messages.warning_copy, color = 'cyan')
upload = input(message % (file, copy_dir))
if upload.lower().strip() == "yes":
shutil.copy(file, copy_dir)
__all__ = ['update_executables', 'update_paths', 'copy_output']
|