microsoft · bpkroth · May 28, 2025 · May 28, 2025 · May 28, 2025 · May 28, 2025
@@ -13,6 +13,7 @@ This document contains some notes on how to use [`alembic`](https://alembic.sqla
    > In the remainder of this document we should some examples for different DB types.
    > Pick the one you're targeting and stick with it thru the example.
    > You may need to repeat the process several times to test all of them.
+   >
    > - [ ] TODO: Add scripts to automatically do this for several different backend engines all at once.
 
    For instance:
@@ -63,21 +64,21 @@ This document contains some notes on how to use [`alembic`](https://alembic.sqla
       mlos_bench --storage storage/postgresql.jsonc --create-update-storage-schema-only --password=password
       ```
 
-2. Now, adjust the [`mlos_bench/storage/sql/schema.py`](../schema.py) file to reflect the new desired schema.
+1. Now, adjust the [`mlos_bench/storage/sql/schema.py`](../schema.py) file to reflect the new desired schema.
 
    > Keep each change small and atomic.
    > For example, if you want to add a new column, do that in one change.
    > If you want to rename a column, do that in another change.
 
-3. Generate a new migration script with the following command:
+1. Generate a new migration script with the following command:
 
    ```sh
    alembic revision --autogenerate -m "CHANGEME: Descriptive text about the change."
    ```
 
-4. Review the generated migration script in the [`mlos_bench/storage/sql/alembic/versions`](./versions/) directory.
+1. Review the generated migration script in the [`mlos_bench/storage/sql/alembic/versions`](./versions/) directory.
 
-5. Verify that the migration script works by running the following command:
+1. Verify that the migration script works by running the following command:
 
    ```sh
    # sqlite
@@ -116,22 +117,22 @@ This document contains some notes on how to use [`alembic`](https://alembic.sqla
 
    > Use different CLI clients for targeting other engines.
 
-6. If the migration script works, commit the changes to the [`mlos_bench/storage/sql/schema.py`](../schema.py) and [`mlos_bench/storage/sql/alembic/versions`](./versions/) files.
+1. If the migration script works, commit the changes to the [`mlos_bench/storage/sql/schema.py`](../schema.py) and [`mlos_bench/storage/sql/alembic/versions`](./versions/) files.
 
    > Be sure to update the latest version in the [`test_storage_schemas.py`](../../../tests/storage/test_storage_schemas.py) file as well.
 
-7. Cleanup any server instances you started.
+1. Cleanup any server instances you started.
 
-    For instance:
+   For instance:
 
-    ```sh
-    rm mlos_bench/storage/sql/mlos_bench.sqlite
-    ```
+   ```sh
+   rm mlos_bench/storage/sql/mlos_bench.sqlite
+   ```
 
-    ```sh
-    docker kill mysql-alembic
-    ```
+   ```sh
+   docker kill mysql-alembic
+   ```
 
-8. Merge that to the `main` branch.
+1. Merge that to the `main` branch.
 
-9. Might be good to cut a new `mlos_bench` release at this point as well.
+1. Might be good to cut a new `mlos_bench` release at this point as well.
@@ -15,7 +15,7 @@
 from pytest_docker.plugin import get_docker_services
 
 from mlos_bench.environments.mock_env import MockEnv
-from mlos_bench.tests import SEED, tunable_groups_fixtures, resolve_host_name
+from mlos_bench.tests import SEED, resolve_host_name, tunable_groups_fixtures
 from mlos_bench.tunables.tunable_groups import TunableGroups
 
 # pylint: disable=redefined-outer-name

@@ -7,7 +7,6 @@
 from dataclasses import dataclass
 from subprocess import run
 
-
 # The SSH test server port and name.
 # See Also: docker-compose.yml
 SSH_TEST_SERVER_PORT = 2254
@@ -18,7 +17,8 @@
 
 @dataclass
 class SshTestServerInfo:
-    """A data class for SshTestServerInfo.
+    """
+    A data class for SshTestServerInfo.
 
     See Also
     --------

@@ -7,7 +7,6 @@
 from dataclasses import dataclass
 from subprocess import run
 
-
 # The DB servers' names and other connection info.
 # See Also: docker-compose.yml
 
@@ -20,7 +19,8 @@
 
 @dataclass
 class SqlTestServerInfo:
-    """A data class for SqlTestServerInfo.
+    """
+    A data class for SqlTestServerInfo.
 
     See Also
     --------

@@ -4,16 +4,16 @@
 #
 """Test fixtures for mlos_bench storage."""
 
-from contextlib import contextmanager
 import json
 import os
 import tempfile
 from collections.abc import Generator
+from contextlib import contextmanager
 from importlib.resources import files
 from random import seed as rand_seed
 
-from filelock import FileLock
 import pytest
+from filelock import FileLock
 from pytest_docker.plugin import Services as DockerServices
 
 from mlos_bench.optimizers.mock_optimizer import MockOptimizer
@@ -23,19 +23,19 @@
 from mlos_bench.storage.base_experiment_data import ExperimentData
 from mlos_bench.storage.sql.storage import SqlStorage
 from mlos_bench.storage.storage_factory import from_config
-from mlos_bench.util import path_join
 from mlos_bench.tests import SEED, wait_docker_service_healthy
 from mlos_bench.tests.storage import (
     CONFIG_TRIAL_REPEAT_COUNT,
     MAX_TRIALS,
     TRIAL_RUNNER_COUNT,
 )
 from mlos_bench.tests.storage.sql import (
-    SqlTestServerInfo,
     MYSQL_TEST_SERVER_NAME,
     PGSQL_TEST_SERVER_NAME,
+    SqlTestServerInfo,
 )
 from mlos_bench.tunables.tunable_groups import TunableGroups
+from mlos_bench.util import path_join
 
 # pylint: disable=redefined-outer-name
 
@@ -48,9 +48,7 @@ def mysql_storage_info(
     docker_compose_project_name: str,
     locked_docker_services: DockerServices,
 ) -> SqlTestServerInfo:
-    """
-    Fixture for getting mysql storage connection info.
-    """
+    """Fixture for getting mysql storage connection info."""
     storage_info = SqlTestServerInfo(
         compose_project_name=docker_compose_project_name,
         service_name=MYSQL_TEST_SERVER_NAME,
@@ -71,9 +69,7 @@ def postgres_storage_info(
     docker_compose_project_name: str,
     locked_docker_services: DockerServices,
 ) -> SqlTestServerInfo:
-    """
-    Fixture for getting postgres storage connection info.
-    """
+    """Fixture for getting postgres storage connection info."""
     storage_info = SqlTestServerInfo(
         compose_project_name=docker_compose_project_name,
         service_name=PGSQL_TEST_SERVER_NAME,

@@ -5,9 +5,8 @@
 """Test sql schemas for mlos_bench storage."""
 
 import pytest
-from pytest_lazy_fixtures.lazy_fixture import lf as lazy_fixture
-
 from alembic.migration import MigrationContext
+from pytest_lazy_fixtures.lazy_fixture import lf as lazy_fixture
 from sqlalchemy import inspect
 
 from mlos_bench.storage.sql.storage import SqlStorage

@@ -14,8 +14,8 @@
 
 from mlos_bench.environments.status import Status
 from mlos_bench.storage.base_storage import Storage
-from mlos_bench.tunables.tunable_groups import TunableGroups
 from mlos_bench.tests import DOCKER
+from mlos_bench.tunables.tunable_groups import TunableGroups
 
 docker_dbms_fixtures = []
 if DOCKER: