[ENH]: Introduce junfer.typing module #392

Merged

synchon merged 7 commits from style/typing into main 2024-11-13 08:51:58 +00:00

Conversation 3 Commits 7 Files changed 41 +240 -171

synchon commented 2024-11-12 14:44:47 +00:00 (Migrated from github.com)

Copy link

• description of feature/fix
• tests added/passed
• add an entry for the latest changes

This PR introduces junifer.typing module for junifer-related type hints to be used internally and externally.

* [x] description of feature/fix * [x] tests added/passed * [x] add an entry for the latest changes This PR introduces `junifer.typing` module for junifer-related type hints to be used internally and externally.

codecov[bot] commented 2024-11-12 14:45:20 +00:00 (Migrated from github.com)

Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.31%. Comparing base (8c2de75) to head (c4e2c59).
Report is 8 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #392      +/-   ##
==========================================
- Coverage   87.46%   87.31%   -0.16%     
==========================================
  Files         129      129              
  Lines        5299     5235      -64     
  Branches      857      857              
==========================================
- Hits         4635     4571      -64     
  Misses        491      491              
  Partials      173      173              

Flag	Coverage Δ
docs	100.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
junifer/api/decorators.py	100.00% <ø> (ø)
junifer/api/functions.py	92.17% <ø> (-0.51%)	⬇️
junifer/datagrabber/multiple.py	91.22% <ø> (-0.16%)	⬇️
junifer/markers/base.py	94.82% <ø> (-0.09%)	⬇️
junifer/markers/brainprint.py	44.61% <ø> (-2.45%)	⬇️
junifer/markers/complexity/complexity_base.py	94.73% <ø> (-0.51%)	⬇️
junifer/markers/ets_rss.py	100.00% <ø> (ø)
junifer/markers/falff/_afni_falff.py	87.87% <ø> (-0.36%)	⬇️
junifer/markers/falff/_junifer_falff.py	93.02% <ø> (-0.16%)	⬇️
junifer/markers/falff/falff_base.py	66.66% <ø> (-1.91%)	⬇️
... and 20 more

## [Codecov](https://app.codecov.io/gh/juaml/junifer/pull/392?dropdown=coverage&src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) Report All modified and coverable lines are covered by tests :white_check_mark: > Project coverage is 87.31%. Comparing base [(`8c2de75`)](https://app.codecov.io/gh/juaml/junifer/commit/8c2de7518c5a05e87d480c74a3deac5a8cde0514?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) to head [(`c4e2c59`)](https://app.codecov.io/gh/juaml/junifer/commit/c4e2c59694049ccd543f6b56705e5a0b23810029?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml). > Report is 8 commits behind head on main. <details><summary>Additional details and impacted files</summary> [](https://app.codecov.io/gh/juaml/junifer/pull/392?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) ```diff @@ Coverage Diff @@ ## main #392 +/- ## ========================================== - Coverage 87.46% 87.31% -0.16% ========================================== Files 129 129 Lines 5299 5235 -64 Branches 857 857 ========================================== - Hits 4635 4571 -64 Misses 491 491 Partials 173 173 ``` | [Flag](https://app.codecov.io/gh/juaml/junifer/pull/392/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) | Coverage Δ | | |---|---|---| | [docs](https://app.codecov.io/gh/juaml/junifer/pull/392/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) | `100.00% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#carryforward-flags-in-the-pull-request-comment) to find out more. | [Files with missing lines](https://app.codecov.io/gh/juaml/junifer/pull/392?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) | Coverage Δ | | |---|---|---| | [junifer/api/decorators.py](https://app.codecov.io/gh/juaml/junifer/pull/392?src=pr&el=tree&filepath=junifer%2Fapi%2Fdecorators.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#diff-anVuaWZlci9hcGkvZGVjb3JhdG9ycy5weQ==) | `100.00% <ø> (ø)` | | | [junifer/api/functions.py](https://app.codecov.io/gh/juaml/junifer/pull/392?src=pr&el=tree&filepath=junifer%2Fapi%2Ffunctions.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#diff-anVuaWZlci9hcGkvZnVuY3Rpb25zLnB5) | `92.17% <ø> (-0.51%)` | :arrow_down: | | [junifer/datagrabber/multiple.py](https://app.codecov.io/gh/juaml/junifer/pull/392?src=pr&el=tree&filepath=junifer%2Fdatagrabber%2Fmultiple.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#diff-anVuaWZlci9kYXRhZ3JhYmJlci9tdWx0aXBsZS5weQ==) | `91.22% <ø> (-0.16%)` | :arrow_down: | | [junifer/markers/base.py](https://app.codecov.io/gh/juaml/junifer/pull/392?src=pr&el=tree&filepath=junifer%2Fmarkers%2Fbase.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#diff-anVuaWZlci9tYXJrZXJzL2Jhc2UucHk=) | `94.82% <ø> (-0.09%)` | :arrow_down: | | [junifer/markers/brainprint.py](https://app.codecov.io/gh/juaml/junifer/pull/392?src=pr&el=tree&filepath=junifer%2Fmarkers%2Fbrainprint.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#diff-anVuaWZlci9tYXJrZXJzL2JyYWlucHJpbnQucHk=) | `44.61% <ø> (-2.45%)` | :arrow_down: | | [junifer/markers/complexity/complexity\_base.py](https://app.codecov.io/gh/juaml/junifer/pull/392?src=pr&el=tree&filepath=junifer%2Fmarkers%2Fcomplexity%2Fcomplexity_base.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#diff-anVuaWZlci9tYXJrZXJzL2NvbXBsZXhpdHkvY29tcGxleGl0eV9iYXNlLnB5) | `94.73% <ø> (-0.51%)` | :arrow_down: | | [junifer/markers/ets\_rss.py](https://app.codecov.io/gh/juaml/junifer/pull/392?src=pr&el=tree&filepath=junifer%2Fmarkers%2Fets_rss.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#diff-anVuaWZlci9tYXJrZXJzL2V0c19yc3MucHk=) | `100.00% <ø> (ø)` | | | [junifer/markers/falff/\_afni\_falff.py](https://app.codecov.io/gh/juaml/junifer/pull/392?src=pr&el=tree&filepath=junifer%2Fmarkers%2Ffalff%2F_afni_falff.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#diff-anVuaWZlci9tYXJrZXJzL2ZhbGZmL19hZm5pX2ZhbGZmLnB5) | `87.87% <ø> (-0.36%)` | :arrow_down: | | [junifer/markers/falff/\_junifer\_falff.py](https://app.codecov.io/gh/juaml/junifer/pull/392?src=pr&el=tree&filepath=junifer%2Fmarkers%2Ffalff%2F_junifer_falff.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#diff-anVuaWZlci9tYXJrZXJzL2ZhbGZmL19qdW5pZmVyX2ZhbGZmLnB5) | `93.02% <ø> (-0.16%)` | :arrow_down: | | [junifer/markers/falff/falff\_base.py](https://app.codecov.io/gh/juaml/junifer/pull/392?src=pr&el=tree&filepath=junifer%2Fmarkers%2Ffalff%2Ffalff_base.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#diff-anVuaWZlci9tYXJrZXJzL2ZhbGZmL2ZhbGZmX2Jhc2UucHk=) | `66.66% <ø> (-1.91%)` | :arrow_down: | | ... and [20 more](https://app.codecov.io/gh/juaml/junifer/pull/392?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) | | </details>

github-actions[bot] commented 2024-11-12 15:01:16 +00:00 (Migrated from github.com)

Copy link

PR Preview Action v1.4.8
Preview removed because the pull request was closed.
2024-11-13 09:04 UTC

[PR Preview Action](https://github.com/rossjrw/pr-preview-action) v1.4.8 :---: Preview removed because the pull request was closed. 2024-11-13 09:04 UTC <!-- Sticky Pull Request Commentpr-preview -->

fraimondo (Migrated from github.com) approved these changes 2024-11-12 17:46:50 +00:00

Sign in to join this conversation.

Reviewers

No reviewers

fraimondo

Labels

Clear labels   

CRITICAL

High Priority Issue

  

Stale

  

WIP

Work in progress

  

bug

Something isn't working

  

concept

Design/Implementation concepts

  

coordinate

Issues or pull requests related to coordinates (ROIs)

  

dataset

Issues or pull requests related to datagrabbers or datasets

  

dependencies

Pull requests that update a dependency file

  

documentation

Improvements or additions to documentation

  

duplicate

This issue or pull request already exists

  

enhancement

New feature or request

  

github_actions

Pull requests that update GitHub Actions code

  

good first issue

Good for newcomers

  

help wanted

Extra attention is needed

  

invalid

This doesn't seem right

  

maintenance

Issues or pull requests related to maintenance

  

maps

Issues or pull requests related to maps (probabilistic atlases)

  

marker

Issues or pull requests related to markers

  

mask

Issues or pull requests related to masks

  

on hold

Issue waiting on other issue(s)

  

parcellation

Issues or pull requests related to parcellations (deterministic atlases)

  

preprocess

Issues or pull requests related to preprocessors

  

question

Further information is requested

  

ready

Pull request is ready for review and merge

  

storage

Issues or pull requests related to marker storage or retrieval

  

template-space

Issues or pull requests related to template spaces

  

triage

New issues waiting to be reviewed

  

wontfix

This will not be worked on

No labels

CRITICAL

Stale

WIP

bug

concept

coordinate

dataset

dependencies

documentation

duplicate

enhancement

github_actions

good first issue

help wanted

invalid

maintenance

maps

marker

mask

on hold

parcellation

preprocess

question

ready

storage

template-space

triage

wontfix

Milestone

Clear milestone

No items

No milestone

0.0.6 (alpha 5)

Assignees

Clear assignees

No assignees

1 participant

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference

juaml/junifer!392

No description provided.