Merge pull request #679 from blooop/feature/ty

Feature/ty

Author: blooop

.gitignore

@@ -187,4 +187,7 @@ docs/jupyter_execute*
 thumbnails/
 docs/autoapi/*
 .qodo
+
+# Auto-generated documentation excluded from type checking
+docs/reference/
 .devpod/

.pre-commit-config.yaml

@@ -48,9 +48,10 @@ repos:
       # Run the formatter.
       - id: ruff-format
         types_or: [ python, pyi ]
+
   # Checks for spelling mistakes
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.3.0 
+    rev: v2.3.0
     hooks:
       - id: codespell
         args: ['--write-changes','--skip=index.html',"--ignore-words=./codespell-ignore.txt"]

.tyignore

@@ -0,0 +1,2 @@
+docs/
+*.ipynb

bencher/bench_plot_server.py

@@ -79,7 +79,11 @@ def load_data_from_cache(self, bench_name: str) -> Tuple[BenchCfg, List[pn.panel
         )
 
     def serve(
-        self, bench_name: str, plots_instance: List[pn.panel], port: int = None, show: bool = True
+        self,
+        bench_name: str,
+        plots_instance: List[pn.panel],
+        port: int | None = None,
+        show: bool = True,
     ) -> Thread:
         """Launch a panel server to view results
 

bencher/bench_report.py

@@ -23,7 +23,7 @@ class GithubPagesCfg:
 class BenchReport(BenchPlotServer):
     def __init__(
         self,
-        bench_name: str = None,
+        bench_name: str | None = None,
     ) -> None:
         self.bench_name = bench_name
         self.pane = pn.Tabs(tabs_location="left", name=self.bench_name)
@@ -33,22 +33,24 @@ def append_title(self, title: str, new_tab: bool = True):
             return self.append_tab(pn.pane.Markdown(f"# {title}", name=title), title)
         return self.append_markdown(f"# {title}", title)
 
-    def append_markdown(self, markdown: str, name=None, width=800, **kwargs) -> pn.pane.Markdown:
+    def append_markdown(
+        self, markdown: str, name: str | None = None, width: int = 800, **kwargs
+    ) -> pn.pane.Markdown:
         if name is None:
             name = markdown
         md = pn.pane.Markdown(markdown, name=name, width=width, **kwargs)
         self.append(md, name)
         return md
 
-    def append(self, pane: pn.panel, name: str = None) -> None:
+    def append(self, pane: pn.panel, name: str | None = None) -> None:
         if len(self.pane) == 0:
             if name is None:
                 name = pane.name
             self.append_tab(pane, name)
         else:
             self.pane[-1].append(pane)
 
-    def append_col(self, pane: pn.panel, name: str = None) -> None:
+    def append_col(self, pane: pn.panel, name: str | None = None) -> None:
         if name is not None:
             col = pn.Column(pane, name=name)
         else:
@@ -58,13 +60,13 @@ def append_col(self, pane: pn.panel, name: str = None) -> None:
     def append_result(self, bench_res: BenchResult) -> None:
         self.append_tab(bench_res.plot(), bench_res.bench_cfg.title)
 
-    def append_tab(self, pane: pn.panel, name: str = None) -> None:
+    def append_tab(self, pane: pn.panel, name: str | None = None) -> None:
         if pane is not None:
             if name is None:
                 name = pane.name
             self.pane.append(pn.Column(pane, name=name))
 
-    def save_index(self, directory="", filename="index.html") -> Path:
+    def save_index(self, directory: str = "", filename: str = "index.html") -> Path:
         """Saves the result to index.html in the root folder so that it can be displayed by github pages.
 
         Returns:
@@ -75,7 +77,7 @@ def save_index(self, directory="", filename="index.html") -> Path:
     def save(
         self,
         directory: str | Path = "cachedir",
-        filename: str = None,
+        filename: str | None = None,
         in_html_folder: bool = True,
         **kwargs,
     ) -> Path:
@@ -108,7 +110,7 @@ def save(
         self.pane.save(filename=base_path, progress=True, embed=True, **kwargs)
         return base_path
 
-    def show(self, run_cfg: BenchRunCfg = None) -> Thread:  # pragma: no cover
+    def show(self, run_cfg: BenchRunCfg | None = None) -> Thread:  # pragma: no cover
         """Launches a webserver with plots of the benchmark results, blocking
 
         Args:
@@ -118,7 +120,8 @@ def show(self, run_cfg: BenchRunCfg = None) -> Thread:  # pragma: no cover
         if run_cfg is None:
             run_cfg = BenchRunCfg()
 
-        return BenchPlotServer().plot_server(self.bench_name, run_cfg, self.pane)
+        bench_name = self.bench_name or ""
+        return BenchPlotServer().plot_server(bench_name, run_cfg, self.pane)
 
     def publish_gh_pages(
         self,
@@ -154,7 +157,7 @@ def publish_gh_pages(
         return publish_url
 
     def publish(
-        self, remote_callback: Callable, branch_name: str = None, debug: bool = False
+        self, remote_callback: Callable, branch_name: str | None = None, debug: bool = False
     ) -> str:  # pragma: no cover
         """Publish the results as an html file by committing it to the bench_results branch in the current repo. If you have set up your repo with github pages or equivalent then the html file will be served as a viewable webpage.  This is an example of a callable to publish on github pages:
 

bencher/bench_runner.py

@@ -42,11 +42,11 @@ class BenchRunner:
 
     def __init__(
         self,
-        name: str | Benchable = None,
-        bench_class: ParametrizedSweep = None,
+        name: str | Benchable | None = None,
+        bench_class: ParametrizedSweep | None = None,
         run_cfg: BenchRunCfg | None = None,
-        publisher: Callable = None,
-        run_tag: str = None,
+        publisher: Callable | None = None,
+        run_tag: str | None = None,
     ) -> None:
         """Initialize a BenchRunner instance.
 
@@ -242,13 +242,13 @@ def run(
         # New unified parameters (level and repeats are starting values)
         level: int = 2,
         repeats: int = 1,
-        max_level: int = None,
-        max_repeats: int = None,
+        max_level: int | None = None,
+        max_repeats: int | None = None,
         # Legacy parameters for backward compatibility (deprecated)
-        min_level: int = None,
-        start_repeats: int = None,
+        min_level: int | None = None,
+        start_repeats: int | None = None,
         # Other parameters
-        run_cfg: BenchRunCfg = None,
+        run_cfg: BenchRunCfg | None = None,
         publish: bool = False,
         debug: bool = False,
         show: bool = False,
@@ -358,6 +358,7 @@ def run(
                         self.show_publish(report_to_publish, show, publish, save, debug)
                     self.results.append(res)
                 if grouped:
+                    assert report_level is not None
                     self.show_publish(report_level, show, publish, save, debug)
         return self.results
 
@@ -388,7 +389,7 @@ def show_publish(
 
     def show(
         self,
-        report: BenchReport = None,
+        report: BenchReport | None = None,
         show: bool = True,
         publish: bool = False,
         save: bool = False,

bencher/bencher.py

@@ -46,11 +46,11 @@
 class Bench(BenchPlotServer):
     def __init__(
         self,
-        bench_name: str = None,
-        worker: Callable | ParametrizedSweep = None,
-        worker_input_cfg: ParametrizedSweep = None,
-        run_cfg: BenchRunCfg = None,
-        report: BenchReport = None,
+        bench_name: str | None = None,
+        worker: Callable | ParametrizedSweep | None = None,
+        worker_input_cfg: ParametrizedSweep | None = None,
+        run_cfg: BenchRunCfg | None = None,
+        report: BenchReport | None = None,
     ) -> None:
         """Create a new Bench object for benchmarking a worker function with parametrized inputs.
 
@@ -146,7 +146,9 @@ def add_plot_callback(self, callback: Callable[[BenchResult], pn.panel], **kwarg
         self.plot_callbacks.append(partial(callback, **kwargs))
 
     def set_worker(
-        self, worker: Callable | ParametrizedSweep, worker_input_cfg: ParametrizedSweep = None
+        self,
+        worker: Callable | ParametrizedSweep,
+        worker_input_cfg: ParametrizedSweep | None = None,
     ) -> None:
         """Set the benchmark worker function and its input configuration.
 
@@ -174,15 +176,15 @@ def set_worker(
     def sweep_sequential(
         self,
         title: str = "",
-        input_vars: List[ParametrizedSweep] = None,
-        result_vars: List[ParametrizedSweep] = None,
-        const_vars: List[ParametrizedSweep] = None,
-        optimise_var: ParametrizedSweep = None,
-        run_cfg: BenchRunCfg = None,
+        input_vars: List[ParametrizedSweep] | None = None,
+        result_vars: List[ParametrizedSweep] | None = None,
+        const_vars: List[ParametrizedSweep] | None = None,
+        optimise_var: ParametrizedSweep | None = None,
+        run_cfg: BenchRunCfg | None = None,
         group_size: int = 1,
         iterations: int = 1,
-        relationship_cb: Callable = None,
-        plot_callbacks: List[Callable] | bool = None,
+        relationship_cb: Callable | None = None,
+        plot_callbacks: List[Callable] | bool | None = None,
     ) -> List[BenchResult]:
         """Run a sequence of benchmarks by sweeping through groups of input variables.
 
@@ -234,17 +236,17 @@ def sweep_sequential(
 
     def plot_sweep(
         self,
-        title: str = None,
-        input_vars: List[ParametrizedSweep] = None,
-        result_vars: List[ParametrizedSweep] = None,
-        const_vars: List[ParametrizedSweep] = None,
-        time_src: datetime = None,
-        description: str = None,
-        post_description: str = None,
+        title: str | None = None,
+        input_vars: List[ParametrizedSweep] | None = None,
+        result_vars: List[ParametrizedSweep] | None = None,
+        const_vars: List[ParametrizedSweep] | None = None,
+        time_src: datetime | None = None,
+        description: str | None = None,
+        post_description: str | None = None,
         pass_repeat: bool = False,
         tag: str = "",
-        run_cfg: BenchRunCfg = None,
-        plot_callbacks: List[Callable] | bool = None,
+        run_cfg: BenchRunCfg | None = None,
+        plot_callbacks: List[Callable] | bool | None = None,
         sample_order: SampleOrder = SampleOrder.INORDER,
     ) -> BenchResult:
         """The all-in-one function for benchmarking and results plotting.
@@ -439,7 +441,7 @@ def run_sweep(
         self,
         bench_cfg: BenchCfg,
         run_cfg: BenchRunCfg,
-        time_src: datetime = None,
+        time_src: datetime | None = None,
         sample_order: SampleOrder = SampleOrder.INORDER,
     ) -> BenchResult:
         """Execute a benchmark sweep based on the provided configuration.
@@ -538,7 +540,7 @@ def cache_results(self, bench_res: BenchResult, bench_cfg_hash: str) -> None:
         """Cache benchmark results to disk using the config hash as key."""
         self._collector.cache_results(bench_res, bench_cfg_hash, self.bench_cfg_hashes)
 
-    # def show(self, run_cfg: BenchRunCfg = None, pane: pn.panel = None) -> None:
+    # def show(self, run_cfg: BenchRunCfg | None = None, pane: pn.panel = None) -> None:
     #     """Launch a web server with plots of the benchmark results.
     #
     #     This method starts a Panel web server to display the benchmark results interactively.

bencher/example/example_holosweep.py

@@ -69,7 +69,7 @@ def plot_holo(self, plot=True) -> hv.core.ViewableElement:
         return None
 
 
-def example_holosweep(run_cfg: bch.BenchRunCfg = None) -> bch.Bench:
+def example_holosweep(run_cfg: bch.BenchRunCfg | None = None) -> bch.Bench:
     """Example using the new one-arg bench signature: bench(run_cfg).
 
     A report is created internally by Bench when not provided.

bencher/example/example_image_vid.py

@@ -2,7 +2,9 @@
 import bencher as bch
 
 
-def example_image_vid(run_cfg: bch.BenchRunCfg = None, report: bch.BenchReport = None) -> bch.Bench:
+def example_image_vid(
+    run_cfg: bch.BenchRunCfg | None = None, report: bch.BenchReport | None = None
+) -> bch.Bench:
     bench = BenchPolygons().to_bench(run_cfg, report)
     bench.add_plot_callback(bch.BenchResult.to_sweep_summary)
     bench.add_plot_callback(
@@ -33,8 +35,10 @@ def example_image_vid(run_cfg: bch.BenchRunCfg = None, report: bch.BenchReport =
 
 if __name__ == "__main__":
 
-    def simple(run_cfg: bch.BenchRunCfg = None, report: bch.BenchReport = None) -> bch.Bench:  # pylint: disable=unused-argument
-        bench = BenchPolygons().to_bench(bch.BenchRunCfg(level=4), report=report)
+    def simple(
+        run_cfg: bch.BenchRunCfg | None = None, report: bch.BenchReport | None = None
+    ) -> bch.Bench:
+        bench = BenchPolygons().to_bench(run_cfg or bch.BenchRunCfg(level=4), report=report)
         bench.plot_sweep(input_vars=["sides"])
         bench.plot_sweep(input_vars=["sides", "color"])
 
@@ -45,7 +49,7 @@ def simple(run_cfg: bch.BenchRunCfg = None, report: bch.BenchReport = None) -> b
         return bench
 
     def example_image_vid_sequential(
-        run_cfg: bch.BenchRunCfg = None, report: bch.BenchReport = None
+        run_cfg: bch.BenchRunCfg | None = None, report: bch.BenchReport | None = None
     ) -> bch.Bench:
         bench = BenchPolygons().to_bench(run_cfg, report)
         bench.add_plot_callback(bch.BenchResult.to_title)

bencher/example/example_workflow.py

@@ -58,7 +58,9 @@ def __call__(self, **kwargs):
 surf_y_max = -0.2
 
 
-def example_floats2D_workflow(run_cfg: bch.BenchRunCfg, bench: bch.Bench = None) -> bch.Bench:
+def example_floats2D_workflow(
+    run_cfg: bch.BenchRunCfg, bench: bch.Bench | None = None
+) -> bch.Bench:
     """Example of how to perform a 3D floating point parameter sweep
 
     Args:
@@ -93,7 +95,9 @@ def example_floats2D_workflow(run_cfg: bch.BenchRunCfg, bench: bch.Bench = None)
     return bench
 
 
-def example_floats3D_workflow(run_cfg: bch.BenchRunCfg, bench: bch.Bench = None) -> bch.Bench:
+def example_floats3D_workflow(
+    run_cfg: bch.BenchRunCfg, bench: bch.Bench | None = None
+) -> bch.Bench:
     """Example of how to perform a 3D floating point parameter sweep
 
     Args: