Skip to content

Overload bids2table signature for specific return types #39

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

Closed
shnizzedy wants to merge 2 commits into from
Closed

Overload bids2table signature for specific return types #39

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a4bcf5e
Overload signature for specific return type
shnizzedy Aug 13, 2024
5363e47
Move overload to stub file
shnizzedy Aug 13, 2024
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
34 changes: 34 additions & 0 deletions bids2table/_b2t.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
from typing import List, Literal, Optional, overload

from elbow.typing import StrOrPath

from bids2table.table import BIDSTable

@overload
def bids2table(
root: StrOrPath,
*,
with_meta: bool = True,
persistent: bool = False,
index_path: Optional[StrOrPath] = None,
exclude: Optional[List[str]] = None,
incremental: bool = False,
overwrite: bool = False,
workers: Optional[int] = None,
worker_id: Optional[int] = None,
return_table: Literal[True] = True,
) -> BIDSTable: ...
@overload
def bids2table(
root: StrOrPath,
*,
with_meta: bool = True,
persistent: bool = False,
index_path: Optional[StrOrPath] = None,
exclude: Optional[List[str]] = None,
incremental: bool = False,
overwrite: bool = False,
workers: Optional[int] = None,
worker_id: Optional[int] = None,
return_table: Literal[False],
) -> None: ...