Make _DownwardAlgorithm available as FastDownwardAlgorithm.

aibasel · Aug 7, 2023 · b5643f0 · b5643f0
1 parent 6650a2d
commit b5643f0
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 3 deletions.
diff --git a/docs/news.rst b/docs/news.rst
@@ -13,6 +13,7 @@ Lab
 Downward Lab
 ^^^^^^^^^^^^
 * Add *subdir* option for :class:`CachedFastDownwardRevision <downward.cached_revision.CachedFastDownwardRevision>` to support nested Fast Downward repos (Jendrik Seipp).
+* Make ``_DownwardAlgorithm`` available as :class:`FastDownwardAlgorithm <downward.experiment.FastDownwardAlgorithm>` (Jendrik Seipp).
 
 
 v7.3 (2023-03-03)

diff --git a/downward/experiment.py b/downward/experiment.py
@@ -86,6 +86,10 @@ def __eq__(self, other):
         )
 
 
+# Make class available under nicer name, but keep old name for backwards compatibility.
+FastDownwardAlgorithm = _DownwardAlgorithm
+
+
 class FastDownwardExperiment(Experiment):
     """Conduct a Fast Downward experiment.
 
@@ -300,7 +304,7 @@ def add_algorithm(
             "--overall-memory-limit",
             "3584M",
         ] + (driver_options or [])
-        algorithm = _DownwardAlgorithm(
+        algorithm = FastDownwardAlgorithm(
             name,
             CachedFastDownwardRevision(self.revision_cache, repo, rev, build_options),
             driver_options,

diff --git a/examples/downward/2020-09-11-B-bounded-cost.py b/examples/downward/2020-09-11-B-bounded-cost.py
@@ -7,7 +7,7 @@
 
 from downward import suites
 from downward.cached_revision import CachedFastDownwardRevision
-from downward.experiment import _DownwardAlgorithm, FastDownwardRun
+from downward.experiment import FastDownwardAlgorithm, FastDownwardRun
 from lab.experiment import Experiment, get_default_data_dir
 
 import project
@@ -79,7 +79,7 @@
             config_with_bound[-1] = config_with_bound[-1].replace(
                 "bound=BOUND", f"bound={upper_bound}"
             )
-            algo = _DownwardAlgorithm(
+            algo = FastDownwardAlgorithm(
                 algo_name,
                 cached_rev,
                 DRIVER_OPTIONS,