jkuhl/corrlib
1
0
Fork 0
Code Issues 11 Pull requests Releases Packages Activity Actions

add a docstring for time filter
Some checks failed
Pytest / pytest (3.14) (push) Successful in 1m18s
Details
Ruff / ruff (push) Failing after 1m2s
Details
Mypy / mypy (push) Successful in 1m14s
Details
Pytest / pytest (3.12) (push) Successful in 1m21s
Details
Pytest / pytest (3.13) (push) Successful in 1m15s
Details

Browse source
This commit is contained in:
Justus Kuhlmann 2026-03-26 17:25:57 +01:00
commit 81af9579dc
Signed by: jkuhl
GPG key ID: 00ED992DD79B85A6
1 changed files with 16 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

16
corrlib/find.py
View file

@ -66,6 +66,22 @@ def _project_lookup_by_id(db: Path, uuid: str) -> list[tuple[str, ...]]:
def _time_filter(results: pd.DataFrame, created_before: Optional[str]=None, created_after: Optional[Any]=None, updated_before: Optional[Any]=None, updated_after: Optional[Any]=None) -> pd.DataFrame:
"""
Filter the results from the database in terms of the creation and update times.
Parameters
----------
results: pd.DataFrame
The dataframe holding the unfilteres results from the database.
created_before: str
Contraint on the creation date in datetime.datetime.isoformat. Note that this is exclusive. The creation date has to be truly before the date and time given.
created_after: str
Contraint on the creation date in datetime.datetime.isoformat. Note that this is exclusive. The creation date has to be truly after the date and time given.
updated_before: str
Contraint on the creation date in datetime.datetime.isoformat. Note that this is exclusive. The date of the last update has to be truly before the date and time given.
updated_after: str
Contraint on the creation date in datetime.datetime.isoformat. Note that this is exclusive. The date of the last update has to be truly after the date and time given.
"""
drops = []
for ind in range(len(results)):
result = results.iloc[ind]