OEKZident.de/ovdashboard
2
0
Fork 0
Code Releases 1 Packages Activity

docstrings

Browse source
This commit is contained in:
Jörn-Michael Miehe 2023-10-26 19:20:46 +02:00
parent 246f8b8cac
commit f424ad25a4
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
api/ovdashboard_api/routers/v1/_list_manager.py
View file

@ -34,6 +34,10 @@ class ListManager:
prefix: str, prefix: str,
names: list[str] = Depends(lister.func), names: list[str] = Depends(lister.func),
) -> list[str]: ) -> list[str]:
"""
Filters `names` from an async source for names starting with a given prefix.
"""
if isinstance(names, params.Depends): if isinstance(names, params.Depends):
names = await lister.func() names = await lister.func()
@ -45,6 +49,12 @@ class ListManager:
prefix: str, prefix: str,
names: list[str] = Depends(_filter_fn), names: list[str] = Depends(_filter_fn),
) -> str: ) -> str:
"""
Determines if a given prefix is unique in the async produced list `names`.
On success, produces the unique name with that prefix. Otherwise, throws a HTTPException.
"""
if isinstance(names, params.Depends): if isinstance(names, params.Depends):
names = await _filter_fn(prefix) names = await _filter_fn(prefix)