FCP-INDI / C-PAC

Configurable Pipeline for the Analysis of Connectomes
https://fcp-indi.github.io/
GNU Lesser General Public License v3.0
61 stars 39 forks source link

🥅 Raise an error instead of returning `None` where a dict is expected #2079

Closed shnizzedy closed 3 months ago

shnizzedy commented 3 months ago

Fixes

Fixes https://github.com/FCP-INDI/C-PAC/pull/2059#discussion_r1472295222 by @shnizzedy with https://github.com/FCP-INDI/C-PAC/pull/2059#discussion_r1483106483 by @nx10

Description

https://github.com/FCP-INDI/C-PAC/blob/85737a19957a212586de173fb18d5ffe0ad6ed40/CPAC/nuisance/utils/utils.py#L639-L640 It hasn't seemed to cause a problem, but I don't understand why this case would return None instead of pipeline_resource_pool or {}

If no one knows you could turn it into an error? Maybe it just never happens?

This just changes that return None into a raise LookupError

Checklist

Developer Certificate of Origin

Developer Certificate of Origin ``` Developer Certificate of Origin Version 1.1 Copyright (C) 2004, 2006 The Linux Foundation and its contributors. 1 Letterman Drive Suite D4700 San Francisco, CA, 94129 Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Developer's Certificate of Origin 1.1 By making a contribution to this project, I certify that: (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it. (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved. ```
nx10 commented 3 months ago

Just to add some motivation:

If this ever happens it will likely lead to an exception or wrong behaviour downstream. Raising an exception is in line with 'fail fast' and shows us directly what caused it.