Added logic to support recursive searching of upstream visits #725
Conversation
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## main #725 +/- ##
==========================================
+ Coverage 46.01% 46.02% +0.01%
==========================================
Files 91 91
Lines 9625 9633 +8
Branches 1256 1259 +3
==========================================
+ Hits 4429 4434 +5
- Misses 4977 4978 +1
- Partials 219 221 +2 🚀 New features to boost your workflow:
|
| if partial_match | ||
| else search_string == entry.name | ||
| ): | ||
| current_upstream_visits[entry.name] = Path(entry.path) |
There was a problem hiding this comment.
I'm not keen on this as it is modifying something from outside the scope of the function
There was a problem hiding this comment.
That's fair. I've re-written it so that it creates a dictionary within the scope of the function, updates it recursively, before returning it to the outer function.
| partial_match=partial_match, | ||
| max_depth=max_depth - 1, | ||
| ) | ||
| continue |
There was a problem hiding this comment.
Is the continue needed here?
There was a problem hiding this comment.
No, it's not needed. I think I had it there as a visual reminder that the if-block logic ended here. Will remove it.
…t recursively, and return it instead of using a variable from outside the function scope
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| if partial_match | ||
| else search_string == entry.name | ||
| ): | ||
| result[entry.name] = Path(entry.path) |
Check failure
Code scanning / CodeQL
Modification of parameter with default Error
The current logic for
find_upstream_visitslooks only in the folder specified. This is a problem as it means that, in the event the data is saved by year, the machine config will have to be updated with the new year, and access to the old year's data will be lost.To circumvent this, we implement recursive searching logic, such that Murfey will recursively search through the a specified number of layers in the stated data directory to find matches for the current visit. This solution allows for the current
upstream_data_directorieskey format to be kept as-is, while future-proofing the code as the years go by, allowing past visits to continue to be exposed until they are deleted from the system.