Skip to content

Fixed: Missing substring should raise ValueError not KeyError + try-except code cleanup #2691

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 17, 2018
Merged

Fixed: Missing substring should raise ValueError not KeyError + try-except code cleanup #2691

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c0d7cad
Fixed: Missing substring should raise ValueError not KeyError
kchawla-pi Sep 3, 2018
7f48e94
Reorganized exception catching in _strip_header() for better code cla…
kchawla-pi Sep 17, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion nipype/utils/spm_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,5 +59,5 @@ def _strip_header(doc):
except ValueError:
index = len(doc)
return doc[:index]
except KeyError as e:
except ValueError as e:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this whole block might be better rewritten as

    try:
        index = doc.index(hdr)
    except ValueError as e:
        raise_from(IOError('This docstring was not generated by Nipype!\n'), e)
    index += len(hdr)
    index += 1
    doc = doc[index:]
    try:
        index = doc.index(cruft)
    except ValueError:
        index = len(doc)
    return doc[:index]

This helps make clear where the exception is expected, and avoids catching unexpected exceptions.

raise_from(IOError('This docstring was not generated by Nipype!\n'), e)