File size: 19,578 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 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 |
# -*- 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 traceback
from termcolor import colored
import colorama
colorama.init()
import gslab_make.private.metadata as metadata
from gslab_make.private.exceptionclasses import ColoredError
from gslab_make.private.movedirective import MoveList
from gslab_make.private.utility import get_path, format_message
from gslab_make.write_logs import write_to_makelog
def _create_links(paths,
file_list):
""".. Create symlinks from list of files containing linking instructions.
Create symbolic links using instructions contained in files of list ``file_list``.
Instructions are `string formatted <https://docs.python.org/3.4/library/string.html#format-string-syntax>`__
using paths dictionary ``paths``. Symbolic links are written in directory ``move_dir``.
Status messages are appended to file ``makelog``.
Parameters
----------
paths : dict
Dictionary of paths. Dictionary should contain values for all keys listed below.
Dictionary additionally used to string format linking instructions.
file_list : str, list
File or list of files containing linking instructions.
Path Keys
---------
move_dir : str
Directory to write links.
makelog : str
Path of makelog.
Returns
-------
source_map : list
List of (source, destination) for each symlink created.
"""
move_dir = get_path(paths, 'move_dir')
move_list = MoveList(file_list, move_dir, paths)
if move_list.move_directive_list:
os.makedirs(move_dir)
source_map = move_list.create_symlinks()
else:
source_map = []
return(source_map)
def _create_copies(paths,
file_list):
""".. Create copies from list of files containing copying instructions.
Create copies using instructions contained in files of list ``file_list``.
Instructions are `string formatted <https://docs.python.org/3.4/library/string.html#format-string-syntax>`__
using paths dictionary ``paths``. Copies are written in directory ``move_dir``.
Status messages are appended to file ``makelog``.
Parameters
----------
paths : dict
Dictionary of paths. Dictionary should contain values for all keys listed below.
Dictionary additionally used to string format copying instructions.
file_list : str, list
File or list of files containing copying instructions.
Path Keys
---------
move_dir : str
Directory to write copies.
makelog : str
Path of makelog.
Returns
-------
source_map : list
List of (source, destination) for each copy created.
"""
move_dir = get_path(paths, 'move_dir')
move_list = MoveList(file_list, move_dir, paths)
if move_list.move_directive_list:
os.makedirs(move_dir)
source_map = move_list.create_copies()
else:
source_map = []
return(source_map)
def link_inputs(paths,
file_list):
""".. Create symlinks to inputs from list of files containing linking instructions.
Create symbolic links using instructions contained in files of list ``file_list``.
Instructions are `string formatted <https://docs.python.org/3.4/library/string.html#format-string-syntax>`__
using paths dictionary ``paths``. Symbolic links are written in directory ``input_dir``.
Status messages are appended to file ``makelog``.
Instruction files on how to create symbolic links (destinations) from targets (sources)
should be formatted in the following way.
.. code-block:: md
# Each line of instruction should contain a destination and source delimited by a `|`
# Lines beginning with # are ignored
destination | source
.. Note::
Symbolic links can be created to both files and directories.
.. Note::
Instruction files can be specified with the * shell pattern
(see `here <https://www.gnu.org/software/findutils/manual/html_node/find_html/Shell-Pattern-Matching.html>`__).
Destinations and their sources can also be specified with the * shell pattern.
The number of wildcards must be the same for both destinations and sources.
Parameters
----------
paths : dict
Dictionary of paths. Dictionary should contain values for all keys listed below.
Dictionary additionally used to string format linking instructions.
file_list : str, list
File or list of files containing linking instructions.
Path Keys
---------
input_dir : str
Directory to write symlinks.
makelog : str
Path of makelog.
Returns
-------
source_map : list
List of (source, destination) for each symlink created.
Example
-------
Suppose you call the following function.
.. code-block:: python
link_inputs(paths, ['file1'], formatting_dict)
Suppose ``paths`` contained the following values.
.. code-block:: md
paths = {'root': '/User/root/',
'makelog': 'make.log',
'input_dir': 'input'}
Now suppose instruction file ``file1`` contained the following text.
.. code-block:: md
destination1 | {root}/source1
The ``{root}`` in the instruction file would be string formatted using ``paths``.
Therefore, the function would parse the instruction as:
.. code-block:: md
destination1 | /User/root/source1
Example
-------
The following code would use instruction files ``file1`` and ``file2`` to create symbolic links.
.. code-block:: python
link_inputs(paths, ['file1', 'file2'])
Suppose instruction file ``file1`` contained the following text.
.. code-block:: md
destination1 | source1
destination2 | source2
Symbolic links ``destination1`` and ``destination1`` would be created in directory ``paths['input_dir']``.
Their targets would be ``source1`` and ``source2``, respectively.
Example
-------
Suppose you have the following targets.
.. code-block:: md
source1
source2
source3
Specifying ``destination* | source*`` in one of your instruction files would
create the following symbolic links in ``paths['input_dir']``.
.. code-block:: md
destination1
destination2
destination3
"""
try:
paths['move_dir'] = get_path(paths, 'input_dir')
source_map = _create_links(paths, file_list)
message = 'Input links successfully created!'
write_to_makelog(paths, message)
print(colored(message, metadata.color_success))
return(source_map)
except:
error_message = 'An error was encountered with `link_inputs`. Traceback can be found below.'
error_message = format_message(error_message)
write_to_makelog(paths, error_message + '\n\n' + traceback.format_exc())
raise_from(ColoredError(error_message, traceback.format_exc()), None)
def link_externals(paths,
file_list):
""".. Create symlinks to externals from list of files containing linking instructions.
Create symbolic links using instructions contained in files of list ``file_list``.
Instructions are `string formatted <https://docs.python.org/3.4/library/string.html#format-string-syntax>`__
using paths dictionary ``paths``. Symbolic links are written in directory ``external_dir``.
Status messages are appended to file ``makelog``.
Instruction files on how to create symbolic links (destinations) from targets (sources)
should be formatted in the following way.
.. code-block:: md
# Each line of instruction should contain a destination and source delimited by a `|`
# Lines beginning with # are ignored
destination | source
.. Note::
Symbolic links can be created to both files and directories.
.. Note::
Instruction files can be specified with the * shell pattern
(see `here <https://www.gnu.org/software/findutils/manual/html_node/find_html/Shell-Pattern-Matching.html>`__).
Destinations and their sources can also be specified with the * shell pattern.
The number of wildcards must be the same for both destinations and sources.
Parameters
----------
paths : dict
Dictionary of paths. Dictionary should contain values for all keys listed below.
Dictionary additionally used to string format linking instructions.
file_list : str, list
File or list of files containing linking instructions.
Path Keys
---------
external_dir : str
Directory to write symlinks.
makelog : str
Path of makelog.
Returns
-------
source_map : list
List of (source, destination) for each symlink created.
Example
-------
Suppose you call the following function.
.. code-block:: python
link_externals(paths, ['file1'], formatting_dict)
Suppose ``paths`` contained the following values.
.. code-block:: md
paths = {'root': '/User/root/',
'makelog': 'make.log',
'input_dir': 'input'}
Now suppose instruction file ``file1`` contained the following text.
.. code-block:: md
destination1 | {root}/source1
The ``{root}`` in the instruction file would be string formatted using ``paths``.
Therefore, the function would parse the instruction as:
.. code-block:: md
destination1 | /User/root/source1
Example
-------
The following code would use instruction files ``file1`` and ``file2`` to create symbolic links.
.. code-block:: python
link_externals(paths, ['file1', 'file2'])
Suppose instruction file ``file1`` contained the following text.
.. code-block:: md
destination1 | source1
destination2 | source2
Symbolic links ``destination1`` and ``destination1`` would be created in directory ``paths['external_dir']``.
Their targets would be ``source1`` and ``source2``, respectively.
Example
-------
Suppose you have the following targets.
.. code-block:: md
source1
source2
source3
Specifying ``destination* | source*`` in one of your instruction files would
create the following symbolic links in ``paths['external_dir']``.
.. code-block:: md
destination1
destination2
destination3
"""
try:
paths['move_dir'] = get_path(paths, 'external_dir')
source_map = _create_links(paths, file_list)
message = 'External links successfully created!'
write_to_makelog(paths, message)
print(colored(message, metadata.color_success))
return(source_map)
except:
error_message = 'An error was encountered with `link_externals`. Traceback can be found below.'
error_message = format_message(error_message)
write_to_makelog(paths, error_message + '\n\n' + traceback.format_exc())
raise_from(ColoredError(error_message, traceback.format_exc()), None)
def copy_inputs(paths,
file_list):
""".. Create copies to inputs from list of files containing copying instructions.
Create copies using instructions contained in files of list ``file_list``.
Instructions are `string formatted <https://docs.python.org/3.4/library/string.html#format-string-syntax>`__
using paths dictionary ``paths``. Copies are written in directory ``input_dir``.
Status messages are appended to file ``makelog``.
Instruction files on how to create copies (destinations) from targets (sources)
should be formatted in the following way.
.. code-block:: md
# Each line of instruction should contain a destination and source delimited by a `|`
# Lines beginning with # are ignored
destination | source
.. Note::
Instruction files can be specified with the * shell pattern
(see `here <https://www.gnu.org/software/findutils/manual/html_node/find_html/Shell-Pattern-Matching.html>`__).
Destinations and their sources can also be specified with the * shell pattern.
The number of wildcards must be the same for both destinations and sources.
Parameters
----------
paths : dict
Dictionary of paths. Dictionary should contain values for all keys listed below.
Dictionary additionally used to string format copying instructions.
file_list : str, list
File or list of files containing copying instructions.
Path Keys
---------
input_dir : str
Directory to write copies.
makelog : str
Path of makelog.
Returns
-------
source_map : list
List of (source, destination) for each copy created.
Example
-------
Suppose you call the following function.
.. code-block:: python
copy_inputs(paths, ['file1'], formatting_dict)
Suppose ``paths`` contained the following values.
.. code-block:: md
paths = {'root': '/User/root/',
'makelog': 'make.log',
'input_dir': 'input'}
Now suppose instruction file ``file1`` contained the following text.
.. code-block:: md
destination1 | {root}/source1
The ``{root}`` in the instruction file would be string formatted using ``paths``.
Therefore, the function would parse the instruction as:
.. code-block:: md
destination1 | /User/root/source1
Example
-------
The following code would use instruction files ``file1`` and ``file2`` to create copies.
.. code-block:: python
copy_inputs(paths, ['file1', 'file2'])
Suppose instruction file ``file1`` contained the following text.
.. code-block:: md
destination1 | source1
destination2 | source2
Copies ``destination1`` and ``destination1`` would be created in directory ``paths['input_dir']``.
Their targets would be ``source1`` and ``source2``, respectively.
Example
-------
Suppose you have the following targets.
.. code-block:: md
source1
source2
source3
Specifying ``destination* | source*`` in one of your instruction files would
create the following copies in ``paths['input_dir']``.
.. code-block:: md
destination1
destination2
destination3
"""
try:
paths['move_dir'] = get_path(paths, 'input_dir')
source_map = _create_copies(paths, file_list)
message = 'Input copies successfully created!'
write_to_makelog(paths, message)
print(colored(message, metadata.color_success))
return(source_map)
except:
error_message = 'An error was encountered with `copy_inputs`. Traceback can be found below.'
error_message = format_message(error_message)
write_to_makelog(paths, error_message + '\n\n' + traceback.format_exc())
raise_from(ColoredError(error_message, traceback.format_exc()), None)
def copy_externals(paths,
file_list):
""".. Create copies to externals from list of files containing copying instructions.
Create copies using instructions contained in files of list ``file_list``.
Instructions are `string formatted <https://docs.python.org/3.4/library/string.html#format-string-syntax>`__
using paths dictionary ``paths``. Copies are written in directory ``external_dir``.
Status messages are appended to file ``makelog``.
Instruction files on how to create copies (destinations) from targets (sources)
should be formatted in the following way.
.. code-block:: md
# Each line of instruction should contain a destination and source delimited by a `|`
# Lines beginning with # are ignored
destination | source
.. Note::
Instruction files can be specified with the * shell pattern
(see `here <https://www.gnu.org/software/findutils/manual/html_node/find_html/Shell-Pattern-Matching.html>`__).
Destinations and their sources can also be specified with the * shell pattern.
The number of wildcards must be the same for both destinations and sources.
Parameters
----------
paths : dict
Dictionary of paths. Dictionary should contain values for all keys listed below.
Dictionary additionally used to string format copying instructions.
file_list : str, list
File or list of files containing copying instructions.
Path Keys
---------
external_dir : str
Directory to write copies.
makelog : str
Path of makelog.
Returns
-------
source_map : list
List of (source, destination) for each copy created.
Example
-------
Suppose you call the following function.
.. code-block:: python
copy_externals(paths, ['file1'], formatting_dict)
Suppose ``paths`` contained the following values.
.. code-block:: md
paths = {'root': '/User/root/',
'makelog': 'make.log',
'input_dir': 'input'}
Now suppose instruction file ``file1`` contained the following text.
.. code-block:: md
destination1 | {root}/source1
The ``{root}`` in the instruction file would be string formatted using ``paths``.
Therefore, the function would parse the instruction as:
.. code-block:: md
destination1 | /User/root/source1
Example
-------
The following code would use instruction files ``file1`` and ``file2`` to create copies.
.. code-block:: python
copy_externals(paths, ['file1', 'file2'])
Suppose instruction file ``file1`` contained the following text.
.. code-block:: md
destination1 | source1
destination2 | source2
Copies ``destination1`` and ``destination1`` would be created in directory ``paths['external_dir']``.
Their targets would be ``source1`` and ``source2``, respectively.
Example
-------
Suppose you have the following targets.
.. code-block:: md
source1
source2
source3
Specifying ``destination* | source*`` in one of your instruction files would
create the following copies in ``paths['external_dir']``.
.. code-block:: md
destination1
destination2
destination3
"""
try:
paths['move_dir'] = get_path(paths, 'external_dir')
source_map = _create_copies(paths, file_list)
message = 'External copies successfully created!'
write_to_makelog(paths, message)
print(colored(message, metadata.color_success))
return(source_map)
except:
error_message = 'An error was encountered with `copy_externals`. Traceback can be found below.'
error_message = format_message(error_message)
write_to_makelog(paths, error_message + '\n\n' + traceback.format_exc())
raise_from(ColoredError(error_message, traceback.format_exc()), None)
__all__ = ['link_inputs', 'link_externals', 'copy_inputs', 'copy_externals'] |