wrapperutils.py 33.5 KB
Newer Older
1
2
#!/usr/bin/env python
#
Paul McCarthy's avatar
Paul McCarthy committed
3
4
# wrapperutils.py - Functions and decorators used by the FSL wrapper
# functions.
5
6
7
#
# Author: Paul McCarthy <pauldmccarthy@gmail.com>
#
Paul McCarthy's avatar
Paul McCarthy committed
8
9
10
11
"""This module contains functions and decorators used by the FSL wrapper
functions.


12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
The :func:`cmdwrapper` and :func:`fslwrapper` functions are conenience
decorators which allow you to write your wrapper function such that it simply
generates the command-line needed to respectively run a standard shell
command or a FSL command. For example::


    @fslwrapper
    def fslreorient2std(input, output):
        return ['fslreorient2std', input, output]


When this ``fslreorient2std`` function is called, the ``fslwrapper`` decorator
will take care of invoking the command in a standardised way.


Paul McCarthy's avatar
Paul McCarthy committed
27
The :func:`applyArgStyle` function can be used to automatically convert
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
keyword arguments into command-line arguments, based on a set of standard
patterns. For example::


    @fslwrapper
    def flirt(src, ref, **kwargs):
        cmd  = ['flirt', '-in', src, '-ref', ref]
        return cmd + applyArgStyle('-=', **kwargs)


The :func:`fileOrImage` and :func:`fileOrArray` functions can be used to
decorate a wrapper function such that in-memory ``nibabel`` images or Numpy
arrays can be passed in as arguments - they will be automatically saved out to
files, and then the file names passed into the wrapper function. For exmaple::


    @fileOrImage('src', 'ref')
    @fslwrapper
    def flirt(src, ref, **kwargs):
        cmd  = ['flirt', '-in', src, '-ref', ref]
        return cmd + applyArgStyle('-=', **kwargs)


Now this ``flirt`` function can be called either with file names, or
``nibabel`` images.


55
56
57
58
59
60
61
.. note:: Because the :func:`fileOrImage` and :func:`fileOrArray` decorators
          manipulate the return value of the decorated function, they should
          be applied *after* any other decorators. Furthermore, if you need to
          apply both a ``fileOrImage`` and ``fileOrArray`` decorator to a
          function, they should be grouped together, e.g.::

              @fileOrImage('a', 'b')
Paul McCarthy's avatar
Paul McCarthy committed
62
              @fileOrArray('c', 'd')
63
64
65
66
67
              @fslwrapper
              def func(**kwargs):
                  ...


68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
Command outputs can also be loaded back into memory by using the special
:data:`LOAD` value when calling a wrapper function. For example::


    @fileOrImage('src', 'ref', 'out')
    @fslwrapper
    def flirt(src, ref, **kwargs):
        cmd  = ['flirt', '-in', src, '-ref', ref]
        return cmd + applyArgStyle('-=', **kwargs)


If we set the ``out`` argument to ``LOAD``, the output image will be loaded
and returned::

    src     = nib.load('src.nii')
    ref     = nib.load('ref.nii')
    aligned = flirt(src, ref, out=LOAD)['out']
Paul McCarthy's avatar
Paul McCarthy committed
85
"""
86
87


88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
import itertools as it
import os.path   as op
import              os
import              re
import              sys
import              glob
import              random
import              string
import              fnmatch
import              inspect
import              logging
import              tempfile
import              warnings
import              functools
import              collections
103
104
105

import            six
import nibabel as nib
Paul McCarthy's avatar
Paul McCarthy committed
106
import numpy   as np
107

108
import fsl.utils.run     as run
109
110
import fsl.utils.path    as fslpath
import fsl.utils.tempdir as tempdir
111
112
113
import fsl.data.image    as fslimage


114
115
116
log = logging.getLogger(__name__)


Paul McCarthy's avatar
Paul McCarthy committed
117
118
119
120
121
def _update_wrapper(wrapper, wrapped, *args, **kwargs):
    """Replacement for the built-in ``functools.update_wrapper``. This
    implementation ensures that the wrapper function has an attribute
    called ``__wrapped__``, which refers to the ``wrapped`` function.

122
    This custom function is only needed in Python versions < 3.4.
Paul McCarthy's avatar
Paul McCarthy committed
123
124
125
126
127
    """

    wrapper = functools.update_wrapper(wrapper, wrapped, *args, **kwargs)

    # Python >= 3.4 does things right
Paul McCarthy's avatar
Paul McCarthy committed
128
    if (sys.version_info[0] * 10 + sys.version_info[1]) < 34:
Paul McCarthy's avatar
Paul McCarthy committed
129
130
        wrapper.__wrapped__ = wrapped
    return wrapper
131
132


Paul McCarthy's avatar
Paul McCarthy committed
133
134
135
136
137
138
def _unwrap(func):
    """Replacement for the built-in ``inspect.unwrap`` function, which
    is not present in Python versions prior to 3.4.
    """

    # Python >= 3.4 has an inspect.unwrap function
Paul McCarthy's avatar
Paul McCarthy committed
139
    if (sys.version_info[0] * 10 + sys.version_info[1]) >= 34:
Paul McCarthy's avatar
Paul McCarthy committed
140
141
142
143
144
145
146
147
148
        return inspect.unwrap(func)

    # Otherwise we follow the __wrapped__ chain ourselves
    if hasattr(func, '__wrapped__'):
        return _unwrap(func.__wrapped__)

    return func


149
150
151
152
153
154
def cmdwrapper(func):
    """This decorator can be used on functions which generate a command line.
    It will pass the return value of the function to the
    :func:`fsl.utils.run.run` function in a standardised manner.
    """
    def wrapper(*args, **kwargs):
155
        submit = kwargs.pop('submit', None)
156
157
158
159
        stderr = kwargs.pop('stderr', True)
        log    = kwargs.pop('log',    {'tee' : True})
        cmd    = func(*args, **kwargs)
        return run.run(cmd, stderr=stderr, log=log, submit=submit)
160
161
162
163
164
165
166
167
168
    return _update_wrapper(wrapper, func)


def fslwrapper(func):
    """This decorator can be used on functions which generate a FSL command
    line. It will pass the return value of the function to the
    :func:`fsl.utils.run.runfsl` function in a standardised manner.
    """
    def wrapper(*args, **kwargs):
169
        submit = kwargs.pop('submit', None)
170
171
172
173
        stderr = kwargs.pop('stderr', True)
        log    = kwargs.pop('log',    {'tee' : True})
        cmd    = func(*args, **kwargs)
        return run.runfsl(cmd, stderr=stderr, log=log, submit=submit)
174
175
176
    return _update_wrapper(wrapper, func)


Paul McCarthy's avatar
Paul McCarthy committed
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
SHOW_IF_TRUE = object()
"""Constant to be used in the ``valmap`` passed to the :func:`applyArgStyle`
function.

When a ``SHOW_IF_TRUE`` argument is ``True``, it is added to the generated
command line arguments.
"""


HIDE_IF_TRUE = object()
"""Constant to be used in the ``valmap`` passed to the :func:`applyArgStyle`
function.

When a ``HIDE_IF_TRUE`` argument is ``True``, it is suppressed from the
generated command line arguments.
"""
193
194


195
def applyArgStyle(style, valsep=None, argmap=None, valmap=None, **kwargs):
Paul McCarthy's avatar
Paul McCarthy committed
196
197
198
199
    """Turns the given ``kwargs`` into command line options. This function
    is intended to be used to automatically generate command line options
    from arguments passed into a Python function.

200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
    The ``style`` and ``valsep`` arguments control how key-value pairs
    are converted into command-line options:


    =========  ==========  ===========================
    ``style``  ``valsep``  Result
    =========  ==========  ===========================
    ``'-'``    ' '         ``-name val1 val2 val3``
    ``'-'``    '"'         ``-name "val1 val2 val3"``
    ``'-'``    ','         ``-name val1,val2,val3``
    ``'--'``   ' '         ``--name val1 val2 val3``
    ``'--'``   '"'         ``--name "val1 val2 val3"``
    ``'--'``   ','         ``--name val1,val2,val3``
    ``'-='``   ' '         Not supported
    ``'-='``   '"'         ``-name="val1 val2 val3"``
    ``'-='``   ','         ``-name=val1,val2,val3``
    ``'--='``  ' '         Not supported
    ``'--='``  '"'         ``--name="val1 val2 val3"``
    ``'--='``  ','         ``--name=val1,val2,val3``
    =========  ==========  ===========================


Paul McCarthy's avatar
Paul McCarthy committed
222
    :arg style:  Controls how the ``kwargs`` are converted into command-line
223
224
225
226
227
                 options - must be one of ``'-'``, ``'--'``, ``'-='``, or
                 ``'--='``.

    :arg valsep: Controls how the values passed to command-line options
                 which expect multiple arguments are delimited - must be
228
229
                 one of ``' '``, ``','`` or ``'"'``. Defaults to ``' '``
                 if ``'=' not in style``, ``','`` otherwise.
Paul McCarthy's avatar
Paul McCarthy committed
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252

    :arg argmap: Dictionary of ``{kwarg-name : cli-name}`` mappings. This can
                 be used if you want to use different argument names in your
                 Python function for the command-line options.

    :arg valmap: Dictionary of ``{cli-name : value}`` mappings. This can be
                 used to define specific semantics for some command-line
                 options. Acceptable values for ``value`` are as follows

                  - :data:`SHOW_IF_TRUE` - if the argument is present, and
                    ``True`` in ``kwargs``, the command line option
                    will be added (without any arguments).

                  - :data:`HIDE_IF_TRUE` - if the argument is present, and
                    ``False`` in ``kwargs``, the command line option
                    will be added (without any arguments).

                  - Any other constant value. If the argument is present
                    in ``kwargs``, its command-line option will be
                    added, with the constant value as its argument.

                 The argument for any options not specified in the ``valmap``
                 will be converted into strings.
253

Paul McCarthy's avatar
Paul McCarthy committed
254
255
256
257
258
    :arg kwargs: Arguments to be converted into command-line options.

    :returns:    A list containing the generated command-line options.
    """

259
260
261
262
    if valsep is None:
        if '=' in style: valsep = ','
        else:            valsep = ' '

Paul McCarthy's avatar
Paul McCarthy committed
263
264
    if style not in ('-', '--', '-=', '--='):
        raise ValueError('Invalid style: {}'.format(style))
265
266
267
268
269
270
271
272
273
    if valsep not in (' ', ',', '"'):
        raise ValueError('Invalid valsep: {}'.format(valsep))

    # we don't handle the case where '=' in
    # style, and valsep == ' ', because no
    # sane CLI app would do this. Right?
    if '=' in style and valsep == ' ':
        raise ValueError('Incompatible style and valsep: s={} v={}'.format(
            style, valsep))
Paul McCarthy's avatar
Paul McCarthy committed
274
275
276
277
278

    if argmap is None: argmap = {}
    if valmap is None: valmap = {}

    def fmtarg(arg):
279
280
281
282
        if   style in ('-',  '-='):  arg =  '-{}'.format(arg)
        elif style in ('--', '--='): arg = '--{}'.format(arg)
        return arg

283
    # always returns a sequence
Paul McCarthy's avatar
Paul McCarthy committed
284
    def fmtval(val):
285
286
        if     isinstance(val, collections.Sequence) and \
           not isinstance(val, six.string_types):
287
288
289
290
291

            val = [str(v) for v in val]
            if   valsep == ' ': return val
            elif valsep == '"': return [' '   .join(val)]
            else:               return [valsep.join(val)]
292
        else:
293
294
295
296
297
298
299
300
            return [str(val)]

    # val is assumed to be a sequence
    def fmtargval(arg, val):
        # if '=' in style, val will
        # always be a single string
        if '=' in style: return ['{}={}'.format(arg, val[0])]
        else:            return [arg] + val
301
302
303
304
305
306

    args = []

    for k, v in kwargs.items():

        k    = argmap.get(k, k)
Paul McCarthy's avatar
Paul McCarthy committed
307
308
309
        mapv = valmap.get(k, fmtval(v))
        k    = fmtarg(k)

310

311
312
313
314
        if mapv in (SHOW_IF_TRUE, HIDE_IF_TRUE):
            if (mapv is SHOW_IF_TRUE and     v) or \
               (mapv is HIDE_IF_TRUE and not v):
                args.append(k)
315
        else:
316
            args.extend(fmtargval(k, mapv))
317
318
319
320

    return args


321
def namedPositionals(func, args):
322
    """Given a function, and a sequence of positional arguments destined
323
    for that function, identifies the name for each positional argument.
324
    Variable positional arguments are given an automatic name.
325

326
327
    :arg func: Function which will accept ``args`` as positionals.
    :arg args: Tuple of positional arguments to be passed to ``func``.
328
    """
Paul McCarthy's avatar
Paul McCarthy committed
329

330
331
332
333
334
335
336
337
338
339
    # Current implementation will
    # result in naming collisions
    # for something like this:
    #
    # def func(args0, *args):
    #     ...
    # because of automatic vararg
    # naming. But who would write
    # a function like that anyway?

340
341
    # Remove any decorators
    # from the function
Paul McCarthy's avatar
Paul McCarthy committed
342
343
    func = _unwrap(func)

344
345
346
    # getargspec is the only way to
    # get the names of positional
    # arguments in Python 2.x.
Paul McCarthy's avatar
Paul McCarthy committed
347
    if sys.version_info[0] < 3:
348
349
350
        spec     = inspect.getargspec(func)
        argnames = spec.args
        varargs  = spec.varargs
Paul McCarthy's avatar
Paul McCarthy committed
351

352
353
    # But getargspec is deprecated
    # in python 3.x
Paul McCarthy's avatar
Paul McCarthy committed
354
355
356
357
358
359
    else:

        # getfullargspec is deprecated in
        # python 3.5, but not in python 3.6.
        with warnings.catch_warnings():
            warnings.filterwarnings('ignore', category=DeprecationWarning)
360
361
362
            spec     = inspect.getfullargspec(func)
            argnames = spec.args
            varargs  = spec.varargs
363

364
365
366
    # we only care about the arguments
    # that are being passed in
    argnames = argnames[:len(args)]
367

368
369
370
371
    # make up names for varargs
    nvarargs = len(args) - len(argnames)
    if varargs is not None and nvarargs > 0:
        argnames += ['{}{}'.format(varargs, i) for i in range(nvarargs)]
372

373
    return argnames
374
375


Paul McCarthy's avatar
Paul McCarthy committed
376
LOAD = object()
Paul McCarthy's avatar
Paul McCarthy committed
377
378
"""Constant used by the :class:`_FileOrThing` class to indicate that an output
file should be loaded into memory and returned as a Python object.
379
380
381
"""


Paul McCarthy's avatar
Paul McCarthy committed
382
383
384
385
386
387
388
389
390
391
class _FileOrThing(object):
    """Decorator which ensures that certain arguments which are passed into the
    decorated function are always passed as file names. Both positional and
    keyword arguments can be specified.


    The ``_FileOrThing`` class is not intended to be used directly - see the
    :func:`fileOrImage` and :func:`fileOrArray` decorator functions for more
    details.

392

Paul McCarthy's avatar
Paul McCarthy committed
393
394
395
396
397
398
399
400
401
402
403
404
    These decorators are intended for functions which wrap a command-line tool,
    i.e. where some inputs/outputs need to be specified as file names.


    **Inputs**


    Any arguments which are not of type ``Thing`` are passed through to the
    decorated function unmodified.  Arguments which are of type ``Thing`` are
    saved to a temporary file, and the name of that file is passed to the
    function.

405

Paul McCarthy's avatar
Paul McCarthy committed
406
    **Outputs**
407
408


Paul McCarthy's avatar
Paul McCarthy committed
409
    If an argument is given the special :data:`LOAD` value, it is assumed
Paul McCarthy's avatar
Paul McCarthy committed
410
411
412
    to be an output argument. In this case, it is replaced with a temporary
    file name then, after the function has completed, that file is loaded
    into memory, and the value returned (along with the function's output,
Paul McCarthy's avatar
Paul McCarthy committed
413
    and any other arguments with a value of ``LOAD``).
Paul McCarthy's avatar
Paul McCarthy committed
414
415
416
417
418
419


    **Return value**


    Functions decorated with a ``_FileOrThing`` decorator will always return a
420
421
422
423
424
    ``dict``-like object, where the function's actual return value is
    accessible via an attribute called `output`. All output arguments with a
    value of ``LOAD`` will be present as dictionary entries, with the keyword
    argument names used as keys. Any ``LOAD``ed output arguments which were not
    generated by the function will not be present in the dictionary.
Paul McCarthy's avatar
Paul McCarthy committed
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448


    **Example**


    As an example of using the ``fileOrArray`` decorator on a function
    which concatenates two files containing affine transformations, and
    saves the output to a file::

        # if atob, btoc, or output are passed
        # in as arrays, they are converted to
        # file names.
        @fileOrArray('atob', 'btoc', 'output')
        def concat(atob, btoc, output=None):

            # inputs are guaranteed to be files
            atob = np.loadtxt(atob)
            btoc = np.loadtxt(atoc)

            atoc = np.dot(btoc, atob)

            if output is not None:
                np.savetxt(output, atoc)

449
450
            return 'Done'

Paul McCarthy's avatar
Paul McCarthy committed
451
452
453
454

    Because we have decorated the ``concat`` function with :func:`fileToArray`,
    it can be called with either file names, or Numpy arrays::

455

Paul McCarthy's avatar
Paul McCarthy committed
456
457
        # All arguments are passed through
        # unmodified - the output will be
458
        # saved to a file called atoc.mat.
Paul McCarthy's avatar
Paul McCarthy committed
459
460
        concat('atob.txt', 'btoc.txt', 'atoc.mat')

461
462
463
464
465
466
467
468
469
        # The function's return value
        # is accessed via an attribute called
        # "output" on the dict
        assert concat('atob.txt', 'btoc.txt', 'atoc.mat').output == 'Done'

        # Outputs to be loaded into memory
        # are returned in a dictionary,
        # with argument names as keys.
        atoc = concat('atob.txt', 'btoc.txt', LOAD)['atoc']
Paul McCarthy's avatar
Paul McCarthy committed
470

471
472
473
474
475
476
477
478
479
        # In-memory inputs are saved to
        # temporary files, and those file
        # names are passed to the concat
        # function.
        atoc = concat(np.diag([2, 2, 2, 0]),
                      np.diag([3, 3, 3, 3]), LOAD)['atoc']


    **Using with other decorators**
Paul McCarthy's avatar
Paul McCarthy committed
480
481
482
483
484
485
486
487
488


    ``_FileOrThing`` decorators can be chained with other ``_FileOrThing``
    decorators, and other decorators.  When multiple ``_FileOrThing``
    decorators are used on a single function, the outputs from each decorator
    are merged together into a single dict-like object.


    ``_FileOrThing`` decorators can be used with any other decorators
489
490
    **as long as** they do not manipulate the return value, and as long as
    the ``_FileOrThing`` decorators are adjacent to each other.
491
492
493
    """


494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
    class _Results(dict):
        """A custom ``dict`` type used to return outputs from a function
        decorated with ``_FileOrThing``. All outputs are stored as dictionary
        items, with the argument name as key, and the output object (the
        "thing") as value.

        The decorated function's actual return value is accessible via the
        :meth:`output` property.
        """
        def __init__(self, output):
            self.__output = output

        @property
        def output(self):
            """Access the return value of the decorated function. """
            return self.__output


512
513
514
515
516
517
    def __init__(self,
                 func,
                 prepIn,
                 prepOut,
                 load,
                 removeExt,
Paul McCarthy's avatar
Paul McCarthy committed
518
519
                 *args,
                 **kwargs):
Paul McCarthy's avatar
Paul McCarthy committed
520
521
        """Initialise a ``_FileOrThing`` decorator.

522
523
524
525
        :arg func:      The function to be decorated.

        :arg prepIn:    Function which returns a file name to be used in
                        place of an input argument.
526

527
528
        :arg prepOut:   Function which generates a file name to use for
                        arguments that were set to :data:`LOAD`.
Paul McCarthy's avatar
Paul McCarthy committed
529

530
531
532
        :arg load:      Function which is called to load items for arguments
                        that were set to :data:`LOAD`. Must accept a file path
                        as its sole argument.
533

534
535
536
        :arg removeExt: Function which can remove a file extension from a file
                        path.

Paul McCarthy's avatar
Paul McCarthy committed
537
538
539
540
541
542
543
544
545
546
        :arg outprefix: Must be passed as a keyword argument. The name of a
                        positional or keyword argument to the function, which
                        specifies an output file name prefix.  All other
                        arguments with names that begin with this prefix may
                        be interpreted as things to ``LOAD``.

        All other positional arguments are interpreted as the names of the
        arguments to the function which will be handled by this
        ``_FileOrThing`` decorator. If not provided, *all* arguments passed to
        the function will be handled.
547

548
549
550
551
552
553

        The ``prepIn`` and ``prepOut`` functions must accept the following
        positional arguments:

          - A directory in which all temporary input/output files should be
            stored
Paul McCarthy's avatar
Paul McCarthy committed
554

555
556
557
558
          - The name of the keyword argument to be processed

          - The argument value that was passed in
        """
559
560
561
562
        self.__func      = func
        self.__prepIn    = prepIn
        self.__prepOut   = prepOut
        self.__load      = load
563
        self.__removeExt = removeExt
Paul McCarthy's avatar
Paul McCarthy committed
564
565
        self.__things    = args
        self.__outprefix = kwargs.get('outprefix', None)
Paul McCarthy's avatar
Paul McCarthy committed
566
567


568
    def __call__(self, *args, **kwargs):
569
        """Function which calls ``func``, ensuring that any arguments of
Paul McCarthy's avatar
Paul McCarthy committed
570
        type ``Thing`` are saved to temporary files, and any arguments
Paul McCarthy's avatar
Paul McCarthy committed
571
        with the value :data:`LOAD` are loaded and returned.
572

573
        All other arguments are passed through to ``func``.
574
        """
Paul McCarthy's avatar
Paul McCarthy committed
575

576
577
        func     = self.__func
        argnames = namedPositionals(func, args)
578

579
580
581
582
583
584
585
586
587
588
        # If this _FileOrThing is being called
        # by another _FileOrThing don't create
        # another working directory. We do this
        # sneakily, by setting an attribute on
        # the wrapped function which stores the
        # current working directory.
        wrapped     = _unwrap(func)
        fot_workdir = getattr(wrapped, '_fot_workdir', None)
        parent      = fot_workdir is None

589
        # Create a tempdir to store any temporary
Paul McCarthy's avatar
Paul McCarthy committed
590
        # input/output things, but don't change
591
592
        # into it, as file paths passed to the
        # function may be relative.
593
        with tempdir.tempdir(changeto=False, override=fot_workdir) as td:
594

595
596
            log.debug('Redirecting LOADed outputs to %s', td)

597
598
            # Replace any things with file names.
            # Also get a list of LOAD outputs
599
            args = self.__prepareArgs(parent, td, argnames, args, kwargs)
600
            args, kwargs, outprefix, outfiles, prefixes = args
601

602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
            # The prefix/patterns may be
            # overridden by a parent FoT
            outprefix = getattr(wrapped, '_fot_outprefix', outprefix)
            prefixes  = getattr(wrapped, '_fot_prefixes',  prefixes)

            # if there are any other FileOrThings
            # in the decorator chain, get them to
            # use our working directory, and
            # prefixes, instead of creating their
            # own.
            if parent:
                setattr(wrapped, '_fot_workdir',   td)
                setattr(wrapped, '_fot_outprefix', outprefix)
                setattr(wrapped, '_fot_prefixes',  prefixes)

617
            # Call the function
618
619
620
621
622
623
624
625
626
627
628
            try:
                result = func(*args, **kwargs)

            finally:
                # if we're the top-level FileOrThing
                # decorator, remove the attributes we
                # added above.
                if parent:
                    delattr(wrapped, '_fot_workdir')
                    delattr(wrapped, '_fot_outprefix')
                    delattr(wrapped, '_fot_prefixes')
629

630
631
            return self.__generateResult(
                td, result, outprefix, outfiles, prefixes)
632
633


634
    def __prepareArgs(self, parent, workdir, argnames, args, kwargs):
635
636
637
638
639
        """Prepares all input and output arguments to be passed to the
        decorated function. Any arguments with a value of :data:`LOAD` are
        passed to the ``prepOut`` function specified at :meth:`__init__`.
        All other arguments are passed through the ``prepIn`` function.

640
641
642
        :arg parent:  ``True`` if this ``_FileOrThing`` is the first in a
                      chain of ``_FileOrThing`` decorators.

643
644
        :arg workdir: Directory in which all temporary files should be stored.

645
646
647
        :arg args:    Positional arguments to be passed to the decorated
                      function.

648
649
650
651
        :arg kwargs:  Keyword arguments to be passed to the decorated function.

        :returns:     A tuple containing:

652
653
654
                        - An updated copy of ``args``.

                        - An updated copy of ``kwargs``.
655

656
657
658
659
660
661
662
                        - The output file prefix that was actually passed in
                          (it is subsequently modified so that prefixed outputs
                          are redirected to a temporary location). All prefixed
                          outputs that are not ``LOAD``ed should be moved into
                          this directory. ``None`` if there is no output
                          prefix.

663
664
                        - A dictionary of ``{ name : filename }`` mappings,
                          for all arguments with a value of ``LOAD``.
665

666
667
                        - A dictionary   ``{ filepat : replstr }`` paths, for
                          all output-prefix arguments with a value of ``LOAD``.
668
669
        """

670
671
672
673
        # These containers keep track
        # of output files which are to
        # be loaded into memory
        outfiles      = dict()
674
        prefixedFiles = dict()
675

676
677
678
        allargs  = {k : v for k, v in zip(argnames, args)}
        allargs.update(kwargs)

679
680
681
682
        # Has an output prefix been specified?
        prefix     = allargs.get(self.__outprefix, None)
        realPrefix = None

683
684
685
686
687
688
689
        # Prefixed outputs are only
        # managed by the parent
        # _FileOrthing in a chain of
        # FoT decorators.
        if not parent:
            prefix = None

690
691
692
693
694
695
696
697
698
699
        # If so, replace it with a new output
        # prefix which will redirect all output
        # to the temp dir.
        #
        # Importantly, here we assume that the
        # underlying function (and hence the
        # underlying command-line tool) will
        # accept an output prefix which contains
        # a directory path.
        if prefix is not None:
700
701
702
703
704
705
706
707
708
709

            # If prefix is set to LOAD,
            # all generated output files
            # should be loaded - we use a
            # randomly generated prefix,
            # and add it to prefixedFiles,
            # so that every file which
            # starts with it will be
            # loaded.
            if prefix is LOAD:
710
711
712
                prefix                = random.sample(string.ascii_letters, 10)
                prefix                = ''.join(prefix)
                prefixedFiles[prefix] = self.__outprefix
713

714
            realPrefix                = prefix
715
716
717
            fakePrefix                = op.join(workdir, prefix)
            allargs[self.__outprefix] = fakePrefix

718
719
            log.debug('Replacing output prefix: %s -> %s',
                      realPrefix, fakePrefix)
720

721
722
723
724
            # If the prefix specifies a
            # directory, make sure it
            # exists (remember that we're
            # in a temporary directory)
725
726
727
            pdir = op.dirname(fakePrefix)
            if pdir != '' and not op.exists(pdir):
                os.makedirs(pdir)
728

729
730
        if len(self.__things) > 0: things = self.__things
        else:                      things = allargs.keys()
731

732
        for name, val in list(allargs.items()):
733

734
735
736
737
738
            # don't process the
            # outprefix argument
            if name == self.__outprefix:
                continue

739
            # is this argument referring
740
            # to a prefixed output?
741
742
            isprefixed = (prefix is not None and
                          name.startswith(prefix))
743

744
            if not (isprefixed or name in things):
745
746
                continue

747
748
749
750
            # Prefixed output files may only
            # be given a value of LOAD
            if isprefixed and val is not LOAD:
                raise ValueError('Cannot specify name of prefixed file - the '
751
752
                                 'name is defined by the output prefix: '
                                 '{}'.format(name))
753

754
            if val is LOAD:
755

756
757
758
759
760
761
762
                # this argument refers to an output
                # that is generated from the output
                # prefix argument, and doesn't map
                # directly to an argument of the
                # function. So we don't pass it
                # through.
                if isprefixed:
763
                    prefixedFiles[name] = name
764
765
766
767
768
                    allargs.pop(name)

                # regular output-file argument
                else:
                    outfile = self.__prepOut(workdir, name, val)
769
                    outfiles[name] = outfile
770
                    allargs[ name] = outfile
Paul McCarthy's avatar
Paul McCarthy committed
771

772
            # Assumed to be an input file
773
            else:
774
775
                # sequences may be
                # accepted for inputs
776
777
778
779
780
781
782
783
784
                if isinstance(val, (list, tuple)):
                    infile = list(val)
                    for i, v in enumerate(val):
                        v = self.__prepIn(workdir, name, v)
                        if v is not None:
                            infile[i] = v

                else:
                    infile = self.__prepIn(workdir, name, val)
Paul McCarthy's avatar
Paul McCarthy committed
785

786
                if infile is not None:
787
788
                    allargs[name] = infile

789
790
791
        if realPrefix is not None and len(prefixedFiles) == 0:
            allargs[self.__outprefix] = realPrefix

792
793
        args   = [allargs.pop(k) for k in argnames]
        kwargs = allargs
794

795
        return args, kwargs, realPrefix, outfiles, prefixedFiles
796
797


798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
    def __generateResult(
            self, workdir, result, outprefix, outfiles, prefixes):
        """Loads function outputs and returns a :class:`_Results` object.

        Called by :meth:`__call__` after the decorated function has been
        called. Figures out what files should be loaded, and loads them into
        a ``_Results`` object.

        :arg workdir:   Directory which contains the function outputs.
        :arg result:    Function return value.
        :arg outprefix: Original output prefix that was passed into the
                        function (or ``None`` if one wasn't passed)
        :arg outfiles:  Dictionary containing output files to be loaded (see
                        :meth:`__prepareArgs`).
        :arg prefixes:  Dictionary containing output-prefix patterns to be
                        loaded (see :meth:`__prepareArgs`).

        :returns:       A ``_Results`` object containing all loaded outputs.
        """

        # make a _Results object to store
        # the output. If we are decorating
        # another _FileOrThing, the
        # results will get merged together
        # into a single _Results dict.
        if not isinstance(result, _FileOrThing._Results):
            result = _FileOrThing._Results(result)

        # Load the LOADed outputs
        for oname, ofile in outfiles.items():

            log.debug('Loading output %s: %s', oname, ofile)

            if op.exists(ofile): oval = self.__load(ofile)
            else:                oval = None

            result[oname] = oval

        # No output prefix - we're done
        if outprefix is None or len(prefixes) == 0:
            return result

        # Load or move output-prefixed files.
        # Find all files with a name that
        # matches the prefix that was passed
        # in (recursing into matching sub-
        # directories too).
        allPrefixed = glob.glob(op.join(workdir, '{}*'.format(outprefix)))
        allPrefixed = [fslpath.allFiles(f) if op.isdir(f) else [f]
                       for f in allPrefixed]

        for prefixed in it.chain(*allPrefixed):
            fullpath = prefixed
            prefixed = op.relpath(prefixed, workdir)

            for prefPat, prefName in prefixes.items():
                if not fnmatch.fnmatch(prefixed, '{}*'.format(prefPat)):
                    continue

                log.debug('Loading prefixed output %s [%s]: %s',
                          prefPat, prefName, prefixed)

                # if the load function returns
                # None, this file is probably
                # not of the correct type.
                fval = self.__load(fullpath)
                if fval is not None:
                    prefixed = self.__removeExt(prefixed)
Paul McCarthy's avatar
Paul McCarthy committed
866
                    prefPat  = prefPat.replace('\\', '\\\\')
867
868
869
870
871
872
873
                    prefixed = re.sub('^' + prefPat, prefName, prefixed)
                    result[prefixed] = fval
                    break

        return result


874
def fileOrImage(*args, **kwargs):
Paul McCarthy's avatar
Paul McCarthy committed
875
876
    """Decorator which can be used to ensure that any NIfTI images are saved
    to file, and output images can be loaded and returned as ``nibabel``
877
    image objects or :class:`.Image` objects.
Paul McCarthy's avatar
Paul McCarthy committed
878
879
    """

880
881
882
883
884
885
    # keep track of the input argument
    # types on each call, so we know
    # whether to return a fsl.Image or
    # a nibabel image
    intypes = []

886
    def prepIn(workdir, name, val):
Paul McCarthy's avatar
Paul McCarthy committed
887

888
        infile = None
Paul McCarthy's avatar
Paul McCarthy committed
889

890
891
892
893
894
895
        if isinstance(val, (fslimage.Image, nib.nifti1.Nifti1Image)):
            intypes.append(type(val))

        if isinstance(val, fslimage.Image):
            val = val.nibImage

Paul McCarthy's avatar
Paul McCarthy committed
896
        if isinstance(val, nib.nifti1.Nifti1Image):
897
            infile = val.get_filename()
Paul McCarthy's avatar
Paul McCarthy committed
898
899
900

            # in-memory image - we have
            # to save it out to a file
901
902
            if infile is None:
                hd, infile = tempfile.mkstemp(fslimage.defaultExt())
Paul McCarthy's avatar
Paul McCarthy committed
903
                os.close(hd)
904
                val.to_filename(infile)
Paul McCarthy's avatar
Paul McCarthy committed
905

906
        return infile
Paul McCarthy's avatar
Paul McCarthy committed
907

908
909
    def prepOut(workdir, name, val):
        return op.join(workdir, '{}.nii.gz'.format(name))
Paul McCarthy's avatar
Paul McCarthy committed
910

911
    def load(path):
912
913
914
915

        if not fslimage.looksLikeImage(path):
            return None

Paul McCarthy's avatar
Paul McCarthy committed
916
917
        # create an independent in-memory
        # copy of the image file
918
        img = nib.load(path, mmap=False)
919
920
921
922
923
924
925
926
927
928
929
930
931
932

        # if any arguments were fsl images,
        # that takes precedence.
        if fslimage.Image in intypes:
            return fslimage.Image(img.get_data(), header=img.header)
        # but if all inputs were file names,
        # nibabel takes precedence
        elif nib.nifti1.Nifti1Image in intypes or len(intypes) == 0:
            return nib.nifti1.Nifti1Image(img.get_data(), None, img.header)

        # this function should not be called
        # under any other circumstances
        else:
            raise RuntimeError('Cannot handle type: {}'.format(intypes))
Paul McCarthy's avatar
Paul McCarthy committed
933

934
    def decorator(func):
935
936
937
938
939
940
941
        fot = _FileOrThing(func,
                           prepIn,
                           prepOut,
                           load,
                           fslimage.removeExt,
                           *args,
                           **kwargs)
942
943

        def wrapper(*args, **kwargs):
944
945
946
            result = fot(*args, **kwargs)
            intypes[:] = []
            return result
947
948
949
950

        return _update_wrapper(wrapper, func)

    return decorator
Paul McCarthy's avatar
Paul McCarthy committed
951
952


953
def fileOrArray(*args, **kwargs):
Paul McCarthy's avatar
Paul McCarthy committed
954
955
956
957
    """Decorator which can be used to ensure that any Numpy arrays are saved
    to text files, and output files can be loaded and returned as Numpy arrays.
    """

958
    def prepIn(workdir, name, val):
Paul McCarthy's avatar
Paul McCarthy committed
959

960
        infile = None
Paul McCarthy's avatar
Paul McCarthy committed
961
962

        if isinstance(val, np.ndarray):
963
            hd, infile = tempfile.mkstemp('.txt')
Paul McCarthy's avatar
Paul McCarthy committed
964
            os.close(hd)
965
            np.savetxt(infile, val, fmt='%0.18f')
Paul McCarthy's avatar
Paul McCarthy committed
966

967
        return infile
Paul McCarthy's avatar
Paul McCarthy committed
968

969
970
    def prepOut(workdir, name, val):
        return op.join(workdir, '{}.txt'.format(name))
Paul McCarthy's avatar
Paul McCarthy committed
971

972
973
974
    def load(path):
        try:              return np.loadtxt(path)
        except Exception: return None
Paul McCarthy's avatar
Paul McCarthy committed
975

976
    def decorator(func):
977
978
979
980
981
982
983
        fot = _FileOrThing(func,
                           prepIn,
                           prepOut,
                           load,
                           fslpath.removeExt,
                           *args,
                           **kwargs)
984
985
986
987
988
989
990

        def wrapper(*args, **kwargs):
            return fot(*args, **kwargs)

        return _update_wrapper(wrapper, func)

    return decorator