Skip to content

Commit cf0ee5e

Browse files
PauBadiaMclaude
andcommitted
fix: revert pandas.DataFrame in function signatures back to pd.DataFrame
Replacing type annotations broke runtime since only pd is imported. The Sphinx warning only applied to NumPy docstring types (fixed in _ranking.py); function signatures need a different approach. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent b8158a0 commit cf0ee5e

5 files changed

Lines changed: 22 additions & 22 deletions

File tree

src/gretapy/pl/_distance.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66

77
def cre_to_tss_distance(
8-
df: pandas.DataFrame,
8+
df: pd.DataFrame,
99
order: list | None = None,
1010
palette: str | None = None,
1111
thr_distance: int | None = 250_000,

src/gretapy/pl/_links.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ def _get_tss_window(gannot: pr.PyRanges, gene: str, w_size: int) -> pr.PyRanges:
3535
return tss_window
3636

3737

38-
def _get_gannot_data(gannot: pr.PyRanges, target: str, w_size: int, atac_var_names: pandas.Index):
38+
def _get_gannot_data(gannot: pr.PyRanges, target: str, w_size: int, atac_var_names: pd.Index):
3939
"""Extract genomic annotation data for plotting."""
4040
target_gr = gannot[gannot.df["Name"] == target]
4141
wind = _get_tss_window(gannot, target, w_size)
@@ -56,13 +56,13 @@ def _get_gannot_data(gannot: pr.PyRanges, target: str, w_size: int, atac_var_nam
5656
cre_chr, cre_start, cre_end = cre.split("-")
5757
if cre_chr == chromosome:
5858
cres_gr.append([cre_chr, cre_start, cre_end, cre])
59-
cres_gr = pr.PyRanges(pandas.DataFrame(cres_gr, columns=["Chromosome", "Start", "End", "Name"]))
59+
cres_gr = pr.PyRanges(pd.DataFrame(cres_gr, columns=["Chromosome", "Start", "End", "Name"]))
6060

6161
return x_min, x_max, gs_gr, tss, chromosome, strand, cres_gr
6262

6363

6464
def _plot_links(
65-
links: pandas.DataFrame,
65+
links: pd.DataFrame,
6666
tf: str,
6767
tss: int,
6868
strand: str,
@@ -191,7 +191,7 @@ def _plot_omic(
191191

192192
def links(
193193
mdata,
194-
grn: pandas.DataFrame | dict[str, pandas.DataFrame],
194+
grn: pd.DataFrame | dict[str, pd.DataFrame],
195195
target: str,
196196
tfs: list[str],
197197
gannot: pr.PyRanges | str = "hg38",
@@ -279,7 +279,7 @@ def links(
279279
gannot = gt.show_genome_annotation(organism=gannot)
280280

281281
# Normalize GRN input to dict
282-
if isinstance(grn, pandas.DataFrame):
282+
if isinstance(grn, pd.DataFrame):
283283
grn_dict = {"grn": grn}
284284
else:
285285
grn_dict = grn

src/gretapy/pl/_stats.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515

1616
def stats(
17-
df: pandas.DataFrame,
17+
df: pd.DataFrame,
1818
order: list | None = None,
1919
palette: str | None = None,
2020
**kwargs,

src/gretapy/pp/_check.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -117,8 +117,8 @@ def _check_metrics(
117117

118118

119119
def _check_grn(
120-
grn: pandas.DataFrame,
121-
) -> pandas.DataFrame:
120+
grn: pd.DataFrame,
121+
) -> pd.DataFrame:
122122
"""
123123
Validate GRN DataFrame structure.
124124
@@ -131,7 +131,7 @@ def _check_grn(
131131
-------
132132
Validated and deduplicated GRN DataFrame.
133133
"""
134-
assert isinstance(grn, pandas.DataFrame), f"grn must be pandas.DataFrame, got {type(grn)}"
134+
assert isinstance(grn, pd.DataFrame), f"grn must be pd.DataFrame, got {type(grn)}"
135135
assert {"source", "target"}.issubset(grn.columns), (
136136
f'grn must contain "source" and "target" column names, got {grn.columns}'
137137
)
@@ -187,7 +187,7 @@ def _check_dataset(
187187

188188
def _check_dts_grn(
189189
dataset: mu.MuData | ad.AnnData,
190-
grn: pandas.DataFrame,
190+
grn: pd.DataFrame,
191191
) -> None:
192192
"""
193193
Validate gene overlap between dataset and GRN.

src/gretapy/tl/_eval.py

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ def benchmark(
5454
metrics: str | list | None = None,
5555
min_edges: int = 5,
5656
verbose: bool = True,
57-
) -> pandas.DataFrame:
57+
) -> pd.DataFrame:
5858
"""
5959
Run the benchmark for one or multiple GRNs across one or multiple datasets.
6060
@@ -119,7 +119,7 @@ def benchmark(
119119
datasets={"PBMC": mudata_obj, "Lung": mudata_obj2},
120120
)
121121
"""
122-
# Validate grns: must be dict[str, dict[str, dict[str, pandas.DataFrame]]]
122+
# Validate grns: must be dict[str, dict[str, dict[str, pd.DataFrame]]]
123123
if not isinstance(grns, dict):
124124
raise ValueError(f"grns must be dict[str, dict[str, dict[str, DataFrame]]], got {type(grns)}")
125125
for grn_name, grn_inner in grns.items():
@@ -217,21 +217,21 @@ def benchmark(
217217
_log(f"Benchmark complete ({len(all_results)} result(s), {elapsed:.1f}s)", level="info", verbose=verbose)
218218
_log(_SEP, level="info", verbose=verbose)
219219
if not all_results:
220-
return pandas.DataFrame(columns=["grn", "organism", "dataset", "class", "task", "db", "precision", "recall", "f01"])
220+
return pd.DataFrame(columns=["grn", "organism", "dataset", "class", "task", "db", "precision", "recall", "f01"])
221221
return pd.concat(all_results, ignore_index=True)
222222

223223

224224
def eval_grn_dataset(
225225
organism: str,
226-
grn: pandas.DataFrame,
226+
grn: pd.DataFrame,
227227
dataset: str | mu.MuData | ad.AnnData,
228228
terms: dict | None,
229229
metrics: str | list | None = None,
230230
min_edges: int = 5,
231231
grn_name: str | None = None,
232232
dataset_name: str | None = None,
233233
verbose: bool = True,
234-
) -> pandas.DataFrame:
234+
) -> pd.DataFrame:
235235
"""
236236
Evaluate a GRN against a dataset using multiple metrics.
237237
@@ -290,7 +290,7 @@ def eval_grn_dataset(
290290
level="warning",
291291
verbose=verbose,
292292
)
293-
return pandas.DataFrame(columns=result_cols)
293+
return pd.DataFrame(columns=result_cols)
294294
# Resolve dataset_name for logging
295295
if dataset_name is None and isinstance(dataset, str):
296296
dataset_name = dataset
@@ -355,14 +355,14 @@ def eval_grn_dataset(
355355
_log(_SEP, level="info", verbose=verbose)
356356
_log(f"Evaluation complete{label_suffix} ({len(results)} metrics, {elapsed:.1f}s)", level="info", verbose=verbose)
357357
_log(_SEP, level="info", verbose=verbose)
358-
return pandas.DataFrame(results, columns=result_cols)
358+
return pd.DataFrame(results, columns=result_cols)
359359

360360

361361
def _run_metric(
362362
metric_type: str,
363363
db_name: str,
364-
grn: pandas.DataFrame,
365-
db: pandas.DataFrame | pr.PyRanges | ad.AnnData,
364+
grn: pd.DataFrame,
365+
db: pd.DataFrame | pr.PyRanges | ad.AnnData,
366366
genes: list,
367367
peaks: list,
368368
cats: list | None,
@@ -395,7 +395,7 @@ def _run_fileless_metric(
395395
metric_type: str,
396396
db_name: str,
397397
dataset: mu.MuData | ad.AnnData,
398-
grn: pandas.DataFrame,
398+
grn: pd.DataFrame,
399399
adata: ad.AnnData,
400400
is_mudata: bool,
401401
has_cre: bool,
@@ -412,7 +412,7 @@ def _run_fileless_metric(
412412
def _run_omics_metric(
413413
db_name: str,
414414
dataset: mu.MuData | ad.AnnData,
415-
grn: pandas.DataFrame,
415+
grn: pd.DataFrame,
416416
is_mudata: bool,
417417
has_cre: bool,
418418
verbose: bool = True,

0 commit comments

Comments
 (0)