TST: pprint(dict) for docstring.

Author: Ben Cipollini

nipype/interfaces/ants/registration.py

@@ -380,7 +380,7 @@ class Registration(ANTSCommand):
     """
     Examples
     --------
-    >>> import copy
+    >>> import copy, pprint
     >>> from nipype.interfaces.ants import Registration
     >>> reg = Registration()
     >>> reg.inputs.fixed_image = 'fixed1.nii'
@@ -443,15 +443,32 @@ class Registration(ANTSCommand):
     >>> reg4.inputs.initialize_transforms_per_stage = True
     >>> reg4.inputs.collapse_output_transforms = True
     >>> outputs = reg4._list_outputs()
-    >>> outputs  # doctest: +ELLIPSIS
-    {'reverse_invert_flags': [], 'inverse_composite_transform': '.../nipype/testing/data/output_InverseComposite.h5', 'warped_image': '.../nipype/testing/data/output_warped_image.nii.gz', 'inverse_warped_image': <undefined>, 'forward_invert_flags': [], 'reverse_transforms': [], 'save_state': <undefined>, 'composite_transform': '.../nipype/testing/data/output_Composite.h5', 'forward_transforms': []}
+    >>> pprint.pprint(outputs)  # doctest: +ELLIPSIS, +NORMALIZE_WHITESPACE
+    {'composite_transform': '.../nipype/testing/data/output_Composite.h5',
+     'forward_invert_flags': [],
+     'forward_transforms': [],
+     'inverse_composite_transform': '.../nipype/testing/data/output_InverseComposite.h5',
+     'inverse_warped_image': <undefined>,
+     'reverse_invert_flags': [],
+     'reverse_transforms': [],
+     'save_state': <undefined>,
+     'warped_image': '.../nipype/testing/data/output_warped_image.nii.gz'}
 
     >>> # Test collapse transforms flag
     >>> reg4b = copy.deepcopy(reg4)
     >>> reg4b.inputs.write_composite_transform = False
     >>> outputs = reg4b._list_outputs()
-    >>> outputs  # doctest: +ELLIPSIS
-    {'reverse_invert_flags': [True, False], 'inverse_composite_transform': <undefined>, 'warped_image': '.../nipype/testing/data/output_warped_image.nii.gz', 'inverse_warped_image': <undefined>, 'forward_invert_flags': [False, False], 'reverse_transforms': ['.../nipype/testing/data/output_0GenericAffine.mat', '.../nipype/testing/data/output_1InverseWarp.nii.gz'], 'save_state': <undefined>, 'composite_transform': <undefined>, 'forward_transforms': ['.../nipype/testing/data/output_0GenericAffine.mat', '.../nipype/testing/data/output_1Warp.nii.gz']}
+    >>> pprint.pprint(outputs)  # doctest: +ELLIPSIS, +NORMALIZE_WHITESPACE
+    {'composite_transform': <undefined>,
+     'forward_invert_flags': [False, False],
+     'forward_transforms': ['.../nipype/testing/data/output_0GenericAffine.mat',
+     '.../nipype/testing/data/output_1Warp.nii.gz'],
+     'inverse_composite_transform': <undefined>,
+     'inverse_warped_image': <undefined>,
+     'reverse_invert_flags': [True, False],
+     'reverse_transforms': ['.../nipype/testing/data/output_0GenericAffine.mat', '.../nipype/testing/data/output_1InverseWarp.nii.gz'],
+     'save_state': <undefined>,
+     'warped_image': '.../nipype/testing/data/output_warped_image.nii.gz'}
     >>> reg4b.aggregate_outputs()  # doctest: +SKIP
 
     >>> # Test multiple metrics per stage

nipype/interfaces/base.py

@@ -1343,16 +1343,18 @@ class must be instantiated with a command argument
 
     Examples
     --------
-
+    >>> import pprint
     >>> from nipype.interfaces.base import CommandLine
     >>> cli = CommandLine(command='ls', environ={'DISPLAY': ':1'})
     >>> cli.inputs.args = '-al'
     >>> cli.cmdline
     'ls -al'
 
-    >>> cli.inputs.trait_get()  # doctest: +NORMALIZE_WHITESPACE
-    {'ignore_exception': False, 'terminal_output': 'stream',
-     'environ': {'DISPLAY': ':1'}, 'args': '-al'}
+    >>> pprint.pprint(cli.inputs.trait_get())  # doctest: +NORMALIZE_WHITESPACE
+    {'args': '-al',
+     'environ': {'DISPLAY': ':1'},
+     'ignore_exception': False,
+     'terminal_output': 'stream'}
 
     >>> cli.inputs.get_hashval()
     ([('args', '-al')], '11c37f97649cd61627f4afe5136af8c0')

nipype/interfaces/io.py

@@ -917,12 +917,13 @@ class SelectFiles(IOBase):
     Examples
     --------
 
+    >>> import pprint
     >>> from nipype import SelectFiles, Node
     >>> templates={"T1": "{subject_id}/struct/T1.nii",
     ...            "epi": "{subject_id}/func/f[0, 1].nii"}
     >>> dg = Node(SelectFiles(templates), "selectfiles")
     >>> dg.inputs.subject_id = "subj1"
-    >>> dg.outputs.get()
+    >>> pprint.pprint(dg.outputs.get())  # doctest: +NORMALIZE_WHITESPACE
     {'T1': <undefined>, 'epi': <undefined>}
 
     The same thing with dynamic grabbing of specific files:
@@ -2147,16 +2148,17 @@ class JSONFileGrabber(IOBase):
     Example
     -------
 
+    >>> import pprint
     >>> from nipype.interfaces.io import JSONFileGrabber
     >>> jsonSource = JSONFileGrabber()
     >>> jsonSource.inputs.defaults = {'param1': 'overrideMe', 'param3': 1.0}
     >>> res = jsonSource.run()
-    >>> res.outputs.get()
-    {'param3': 1.0, 'param1': 'overrideMe'}
+    >>> pprint.pprint(res.outputs.get())
+    {'param1': 'overrideMe', 'param3': 1.0}
     >>> jsonSource.inputs.in_file = 'jsongrabber.txt'
     >>> res = jsonSource.run()
-    >>> res.outputs.get()
-    {'param3': 1.0, 'param2': 4, 'param1': 'exampleStr'}
+    >>> pprint.pprint(res.outputs.get())  # doctest: +NORMALIZE_WHITESPACE
+    {'param1': u'exampleStr', 'param2': 4, 'param3': 1.0}
 
 
     """