This file is indexed.

/usr/lib/python3/dist-packages/pyutilib/workflow/tests/test_task.py is in python3-pyutilib 5.3.5-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
import logging
import os
from os.path import abspath, dirname
currdir = dirname(abspath(__file__))+os.sep

import pyutilib.th as unittest
import pyutilib.misc
from pyutilib.workflow import *

try:
    import json
    json_available=True
except:
    json_available=False

class Handler(logging.StreamHandler):

    def emit(self, record):
        raise RuntimeError(str(record))

handler = Handler()
logger = logging.getLogger('pyutilib.workflow')


class TestData(unittest.TestCase):

    def test1(self):
        """Print FunctorAPIData string"""
        data = FunctorAPIData()
        data.a = 1
        data.b = [1,2]
        data.c = FunctorAPIData()
        data.c.x = 1
        data.c.y = 2
        data.aa = 'here is more'
        data.clean()
        pyutilib.misc.setup_redirect(currdir+'test1.out')
        print(data)
        pyutilib.misc.reset_redirect()
        self.assertFileEqualsBaseline(currdir+'test1.out', currdir+'test1.txt')
        self.assertEquals(len(data._dirty_), 0)

    @unittest.skipIf(not json_available, "JSON not available")
    def test2(self):
        """Print FunctorAPIData representation"""
        data = FunctorAPIData()
        data.a = 1
        data.b = [1,2]
        data.c = FunctorAPIData()
        data.c.x = 1
        data.c.y = 2
        data['aa'] = 'here is more'
        data.clean()
        FILE = open(currdir+'test2.out','w')
        json.dump(data, FILE)
        FILE.close()
        self.assertMatchesJsonBaseline(currdir+'test2.out', currdir+'test2.txt')
        self.assertEquals(len(data._dirty_), 0)

    @unittest.expectedFailure
    def test_err1(self):
        """Unknown attribute"""
        data = FunctorAPIData()
        data._x

    @unittest.expectedFailure
    def test_err2(self):
        """Undeclared attribute"""
        data = FunctorAPIData()
        data.declare('a')
        data.x

    @unittest.expectedFailure
    def test_err3(self):
        """Undeclared attribute"""
        data = FunctorAPIData()
        data.declare(['a'])
        data.x


class TestAPI(unittest.TestCase):

    @classmethod
    def setUpClass(cls):
        # Disable the pyutilib.workflow logging handler
        if len(logger.handlers) > 0:
            cls._handler = logger.handlers[0]
            logger.removeHandler(cls._handler)
        else:
            cls._handler = None
        logger.addHandler(handler)

    @classmethod
    def tearDownClass(cls):
        # Re-enable the pyutilib.workflow logging handler
        logger.removeHandler(handler)
        if not cls._handler is None:
            logger.addHandler(cls._handler)

    def test1(self):
        """Simple test: no keyword arguments or return values"""
        @functor_api
        def test1(data):
            """
            Required:
                data: input data
            """
            data.a = 2
            data.b[0] = 2
        #
        options = FunctorAPIData()
        options.a = 1
        options.b = [1,2]
        retval = test1(options)
        self.assertEquals(retval.data.a, 2)
        self.assertEquals(retval.data.b, [2,2])
        retval = test1(data=options)
        self.assertEquals(retval.data.a, 2)
        self.assertEquals(retval.data.b, [2,2])
        #
        self.assertTrue('test1' in FunctorAPIFactory.services())

    def test1a(self):
        """Simple test: no keyword arguments or return values"""
        @functor_api
        def test1a(data):
            """
            Required:
                data: input data
            Return:
                data: output data
            """
            data.a = 2
            data.b[0] = 2
        #
        options = FunctorAPIData()
        options.a = 1
        options.b = [1,2]
        retval = test1a(options)
        self.assertEquals(retval.data.a, 2)
        self.assertEquals(retval.data.b, [2,2])
        retval = test1a(data=options)
        self.assertEquals(retval.data.a, 2)
        self.assertEquals(retval.data.b, [2,2])

    def test1b(self):
        """Simple test: data keyword argument, no return values"""
        @functor_api
        def test1b(data=None):
            data.a = 2
            data.b[0] = 2
        #
        options = FunctorAPIData()
        options.a = 1
        options.b = [1,2]
        retval = test1b(options)
        self.assertEquals(retval.data.a, 2)
        self.assertEquals(retval.data.b, [2,2])
        retval = test1b(data=options)
        self.assertEquals(retval.data.a, 2)
        self.assertEquals(retval.data.b, [2,2])

    def test2(self):
        """Simple test: no keyword arguments, returning data"""
        @functor_api
        def test2(data):
            data.a = 2
            data.b[0] = 2
            return data
        #
        options = FunctorAPIData()
        options.a = 1
        options.b = [1,2]
        retval = test2(options)
        self.assertEquals(retval.data.a, 2)
        self.assertEquals(retval.data.b, [2,2])
        retval = test2(data=options)
        self.assertEquals(retval.data.a, 2)
        self.assertEquals(retval.data.b, [2,2])

    def test2a(self):
        """Simple test: no keyword arguments, returning data"""
        @functor_api
        def test2a(data):
            """
            Required:
                data: input data
            Return:
                data: output data
            """
            data.a = 2
            data.b[0] = 2
            return data
        #
        options = FunctorAPIData()
        options.a = 1
        options.b = [1,2]
        retval = test2a(options)
        self.assertEquals(retval.data.a, 2)
        self.assertEquals(retval.data.b, [2,2])
        retval = test2a(data=options)
        self.assertEquals(retval.data.a, 2)
        self.assertEquals(retval.data.b, [2,2])

    def test3(self):
        """Simple test: keyword arguments, no return values"""
        @functor_api
        def test3(data, x=1, y=2):
            """
            Required:
                data: input data
                x: integer
            Optional:
                y: integer
            """
            data.a = y
            data.b[0] = x
        #
        options = FunctorAPIData()
        options.a = 1
        options.b = [1,2]
        retval = test3(options, x=2)
        self.assertEquals(retval.data.a, 2)
        self.assertEquals(retval.data.b, [2,2])
        retval = test3(data=options, x=2)
        self.assertEquals(retval.data.a, 2)
        self.assertEquals(retval.data.b, [2,2])

    def test3a(self):
        """Simple test: keyword arguments, no return values"""
        @functor_api
        def test3a(x=1, y=2, data=None):
            """
            Required:
                data: input data
                x: integer
            Optional:
                y: integer
            """
            data.a = y
            data.b[0] = x
        #
        options = FunctorAPIData()
        options.a = 1
        options.b = [1,2]
        retval = test3a(options, x=2)
        self.assertEquals(retval.data.a, 2)
        self.assertEquals(retval.data.b, [2,2])
        retval = test3a(data=options, x=2)
        self.assertEquals(retval.data.a, 2)
        self.assertEquals(retval.data.b, [2,2])

    def test4(self):
        """Simple test: keyword arguments, simple return value"""
        @functor_api
        def test4(data, x=1, y=2):
            """
            Required:
                data: input data
                x: integer
            Optional:
                y: integer
            Return:
                data: output data
            """
            data.a = y
            data.b[0] = x
            return data
        #
        options = FunctorAPIData()
        options.a = 1
        options.b = [1,2]
        retval = test4(options, x=2)
        self.assertEquals(retval.data.a, 2)
        self.assertEquals(retval.data.b, [2,2])
        retval = test4(data=options, x=2)
        self.assertEquals(retval.data.a, 2)
        self.assertEquals(retval.data.b, [2,2])

    def test5(self):
        """Simple test: keyword arguments, non-data return values"""
        @functor_api(outputs=('z'))
        def test5(data, x=1, y=2):
            """
            Required:
                data: input data
                x: integer
            Optional:
                y: integer
            Return:
                data: output data
                z: integer
            """
            data.a = y
            data.b[0] = x
            return FunctorAPIData(z=x)
        #
        options = FunctorAPIData()
        options.a = 1
        options.b = [1,2]
        retval = test5(options, x=2)
        self.assertEquals(retval.data.a, 2)
        self.assertEquals(retval.data.b, [2,2])
        retval = test5(data=options, x=2)
        self.assertEquals(retval.data.a, 2)
        self.assertEquals(retval.data.b, [2,2])
        self.assertEquals(retval.z, 2)

    def test6(self):
        """Simple test: keyword arguments, non-data return values with data"""
        @functor_api(outputs=('z'))
        def test6(data, x=1, y=2):
            """
            Required:
                data: input data
                x: integer
            Optional:
                y: integer
            Return:
                data: output data
                z: integer
            """
            data.a = y
            data.b[0] = x
            return FunctorAPIData(data=data, z=x)
        #
        options = FunctorAPIData()
        options.a = 1
        options.b = [1,2]
        retval = test6(options, x=2)
        self.assertEquals(retval.data.a, 2)
        self.assertEquals(retval.data.b, [2,2])
        retval = test6(data=options, x=2)
        self.assertEquals(retval.data.a, 2)
        self.assertEquals(retval.data.b, [2,2])
        self.assertEquals(retval.z, 2)

    def test5a(self):
        """Outputs specified in docstring: keyword arguments, non-data return values"""
        @functor_api
        def test5a(data, x=1, y=2):
            """
            Required:
                data: input data
                x: integer
            Optional:
                y: integer
            Return:
                data: output data
                z: integer
            """
            data.a = y
            data.b[0] = x
            return FunctorAPIData(z=x)
        #
        options = FunctorAPIData()
        options.a = 1
        options.b = [1,2]
        retval = test5a(options, x=2)
        self.assertEquals(retval.data.a, 2)
        self.assertEquals(retval.data.b, [2,2])
        retval = test5a(data=options, x=2)
        self.assertEquals(retval.data.a, 2)
        self.assertEquals(retval.data.b, [2,2])
        self.assertEquals(retval.z, 2)

    def test6a(self):
        """Outputs specified in docstring: keyword arguments, non-data return values with data"""
        @functor_api
        def test6a(data, x=1, y=2):
            """
            Required:
                data: input data
                x: integer
            Optional:
                y: integer
            Return:
                data: output data
                z: integer
            """
            data.a = y
            data.b[0] = x
            return FunctorAPIData(data=data, z=x)
        #
        options = FunctorAPIData()
        options.a = 1
        options.b = [1,2]
        retval = test6a(options, x=2)
        self.assertEquals(retval.data.a, 2)
        self.assertEquals(retval.data.b, [2,2])
        retval = test6a(data=options, x=2)
        self.assertEquals(retval.data.a, 2)
        self.assertEquals(retval.data.b, [2,2])
        self.assertEquals(retval.z, 2)

    def test7a(self):
        """Test with dict data"""
        @functor_api
        def test7a(data, x=1, y=2):
            """
            Required:
                data: input data
                x: integer
            Optional:
                y: integer
            """
            data.a = y
            data.b[0] = x
        #
        options = {}
        options['a'] = 1
        options['b'] = [1,2]
        retval = test7a(options, x=2)
        self.assertEquals(retval.data.a, 2)
        self.assertEquals(retval.data.b, [2,2])
        retval = test7a(data=options, x=2)
        self.assertEquals(retval.data.a, 2)
        self.assertEquals(retval.data.b, [2,2])

    def test7b(self):
        """Test with dict data and return a dictionary"""
        @functor_api
        def test7b(data, x=1, y=2):
            """
            Required:
                data: input data
                x: integer
            Optional:
                y: integer
            """
            data.a = y
            data.b[0] = x
            return {'data':data}
        #
        options = {}
        options['a'] = 1
        options['b'] = [1,2]
        retval = test7b(options, x=2)
        self.assertEquals(retval.data.a, 2)
        self.assertEquals(retval.data.b, [2,2])
        retval = test7b(data=options, x=2)
        self.assertEquals(retval.data.a, 2)
        self.assertEquals(retval.data.b, [2,2])

    def test7c(self):
        """Test with dict data and return a dictionary"""
        @functor_api
        def test7c(data, x=1, y=2):
            """
            Required:
                data: input data
                x: integer
            Optional:
                y: integer
            Return:
                z: integer
            """
            data.a = y
            data.b[0] = x
            return {'data':data, 'z':x}
        #
        options = {}
        options['a'] = 1
        options['b'] = [1,2]
        retval = test7c(options, x=2)
        self.assertEquals(retval.data.a, 2)
        self.assertEquals(retval.data.b, [2,2])
        retval = test7c(data=options, x=2)
        self.assertEquals(retval.data.a, 2)
        self.assertEquals(retval.data.b, [2,2])
        self.assertEquals(retval.z, 2)

    def test8(self):
        """Simple test with required nested data"""
        @functor_api
        def test8(data):
            """
            Required:
                data: input data
                data.foo.bar:
            """
            data.foo.foo = 3
            #data.a = 2
            #data.b[0] = 2
        #
        options = FunctorAPIData()
        options.foo = FunctorAPIData()
        options.foo.bar = 1
        options.a = 1
        options.b = [1,2]
        retval = test8(options)
        self.assertEquals(retval.data.a, 1)
        self.assertEquals(retval.data.b, [1,2])
        self.assertEquals(retval.data.foo.foo, 3)
        #retval = test8(data=options)
        #self.assertEquals(retval.data.a, 2)
        #self.assertEquals(retval.data.b, [2,2])

    def test9(self):
        """Simple test: no keyword arguments or return values"""
        @functor_api
        def test9(data):
            """
            This is the
            short
            documentation.

            This

            is
  
            the
  
            long documentation.
            Required:
                data: multiline
                      description of 
                      input data object
                data.a: More data
            """
            data.a = 2
            data.b[0] = 2
        #
        options = FunctorAPIData()
        options.a = 1
        options.b = [1,2]
        retval = test9(options)
        self.assertEquals(retval.data.a, 2)
        self.assertEquals(retval.data.b, [2,2])
        retval = test9(data=options)
        self.assertEquals(retval.data.a, 2)
        self.assertEquals(retval.data.b, [2,2])
        #
        self.assertTrue('test1' in FunctorAPIFactory.services())
        self.assertEquals(test9.__short_doc__, 'This is the\nshort\ndocumentation.')
        self.assertEquals(test9.__long_doc__, 'This\n\nis\n\nthe\n\nlong documentation.')

    @unittest.expectedFailure
    def test10(self):
        """Simple test: no keyword arguments or return values"""
        @functor_api
        def test10(data=None, x=1):
            """
            Required:
                x: 
            Optional:
                data:
            """
            return FunctorAPIData(z=2*x)
        #
        retval = test10(x=3)
        self.assertEquals(retval.z, 6)

    @unittest.expectedFailure
    def test_err1(self):
        """Expect an error when variable length arguments are supported"""
        @functor_api
        def err1(*args): pass

    @unittest.expectedFailure
    def test_err2(self):
        """Expect an error when variable length keyword arguments are supported"""
        @functor_api
        def err2(**kwargs): pass
    
    @unittest.expectedFailure
    def test_err3(self):
        """Expect an error when return value is not None or Options()"""
        @functor_api
        def err3(data):
            return 1
        f(FunctorAPIData())

    @unittest.expectedFailure
    def test_err4(self):
        """Expect an error when no data argument is specified"""
        @functor_api
        def err4(data):
            data.a = 2
            data.b[0] = 2
        test1()

    @unittest.expectedFailure
    def test_err5(self):
        """Expect an error when an unspecified return value is given"""
        @functor_api
        def err5(data):
            return FunctorAPIData(z=None)
        f(FunctorAPIData())

    @unittest.expectedFailure
    def test_err6(self):
        """Expect an error when no data argument is specified"""
        @functor_api
        def err6(): pass
        f(FunctorAPIData())

    @unittest.expectedFailure
    def test_err7a(self):
        """Argument missing from docstring"""
        @functor_api
        def err7a(data, x=1, y=2):
            """
            Optional:
                y: integer
            """
            pass
    
    @unittest.expectedFailure
    def test_err7b(self):
        """Argument missing from docstring"""
        @functor_api
        def err7b(data, x=1, y=2):
            """
            Required:
                x: integer
            """
            pass
    
    @unittest.expectedFailure
    def test_err7c(self):
        """Argument missing from docstring"""
        @functor_api(outputs=('z'))
        def err7c(data, x=1, y=2):
            """
            Required:
                x: integer
            Optional:
                y: integer
            """
            return FunctorAPIData(z=1)
    
    @unittest.expectedFailure
    def test_err7A(self):
        """Unexpected required argument"""
        @functor_api
        def err7A(data, x=1, y=2):
            """
            Required:
                x: integer
                bad: integer
            Optional:
                y: integer
            """
            pass
    
    @unittest.expectedFailure
    def test_err7B(self):
        """Argument missing from docstring"""
        @functor_api
        def err7B(data, x=1, y=2):
            """
            Required:
                x: integer
            Optional:
                y: integer
                bad: integer
            """
            pass
    
    @unittest.expectedFailure
    def test_err7C(self):
        """Argument missing from docstring"""
        @functor_api(outputs=('z'))
        def err7C(data, x=1, y=2):
            """
            Required:
                x: integer
            Optional:
                y: integer
            Return:
                z: integer
                bad: integer
            """
            return FunctorAPIData(z=1)
    
    @unittest.expectedFailure
    def test_err8a(self):
        """Missing nested value"""
        @functor_api
        def err8a(data):
            """
            Required:
                data.x: integer
            """
            pass
        err8a(FunctorAPIData())
    
    @unittest.expectedFailure
    def test_err8b(self):
        """Nested value with None value"""
        @functor_api
        def err8b(data):
            """
            Required:
                data.x: integer
            """
            pass
        err8b(FunctorAPIData(data=FunctorAPIData()))
    
    @unittest.expectedFailure
    def test_err8c(self):
        """Nested value with None value"""
        @functor_api
        def err8c(data):
            """
            Required:
                data.x.y: integer
            """
            pass
        err8c(FunctorAPIData(x={}))
    
    @unittest.expectedFailure
    def test_err9(self):
        """Redefinied test functions"""
        @functor_api
        def err9(data):
            pass
        @functor_api
        def err9(data):
            pass
    
    @unittest.expectedFailure
    def test_err10(self):
        """Simple test with required nested data"""
        @functor_api
        def err10(data):
            """
            Required:
                data: input data
                data.foo.bar:
            """
            data.foo.foo = 3
            data.a = 2
        #
        options = FunctorAPIData()
        options.foo = FunctorAPIData()
        options.foo.bar = 1
        options.a = 1
        options.b = [1,2]
        retval = err10(options)
        self.assertEquals(retval.data.a, 1)
        self.assertEquals(retval.data.b, [1,2])
        self.assertEquals(retval.data.foo.foo, 3)

    @unittest.expectedFailure
    def test_err10a(self):
        """Expect an error when the same functor is defined twice"""
        @functor_api
        def err10a(data): pass

        @functor_api
        def err10a(data): pass

    @unittest.expectedFailure
    def test_err10b(self):
        """Expect an error when the same functor is defined twice"""
        @functor_api(namespace='foo')
        def err10b(data): pass

        @functor_api(namespace='foo')
        def err10b(data): pass

    @unittest.expectedFailure
    def test_err11(self):
        """Expect an error when 'data' is not defined when it is required"""
        @functor_api
        def err11(data=None, x=1):
            """
            Required:
                data: 
                x: 
            """
        err11(x=2)

    @unittest.expectedFailure
    def test_err12(self):
        """Expect an error when multiple data options are provided"""
        @functor_api
        def err12(data): pass
        err12({}, {})

    @unittest.expectedFailure
    def test_err13(self):
        """Expect an error when returning something other than None, FunctorAPIData or a dict object"""
        @functor_api
        def err13(data):
            return set()
        err13({})

if __name__ == "__main__":
    unittest.main()