[WiP] Internal storage implementation

.github/workflows/ci.yaml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.10", "3.11", "3.12"]
+        python-version: ["3.11", "3.12", "3.13"]
 
     steps:
       - name: Checkout repository

CONTRIBUTING.md

@@ -103,7 +103,7 @@ Exceptions:
 
 - Minor corrections and fixes to pull requests submitted by others.
 - While making a formal release, the release manager can make necessary, appropriate changes.
-- Small documentation changes that reinforce existing subject matter. Most commonly being, but not limited to spelling and grammar corrections.
+- Small documentation changes that reinforce existing subject. Most commonly being, but not limited to spelling and grammar corrections.
 
 ### Responsibilities
 

pyproject.toml

@@ -2,14 +2,15 @@
 name = "pysatl-experiment"
 version = "0.1.0"
 description = "package for PySATL math statistics experiments"
-authors = ["Ivan Pokhabov <vanek3372@gmail.com>"]
 license = "MIT"
+authors = ["Ivan Pokhabov <vanek3372@gmail.com>",
+           "Dmitrii Kuznetsov <dmitrvlkuznetsov@gmail.com>"]
 readme = "README.md"
 package-mode = true
 packages = [{include = "pysatl_experiment"}]
 
 [tool.poetry.dependencies]
-python = ">=3.10,<3.13"
+python = ">=3.11,<3.13"
 numpy = ">=1.25.1"
 scipy = ">=1.11.2"
 matplotlib = ">=3.8.0"
@@ -25,6 +26,7 @@ rich = "==13.9.4"
 click = ">=8.2.1"
 dacite = "==1.9.2"
 line_profiler = "5.0.0"
+psycopg2 = ">=2.9.10"
 pysatl-criterion = {path = "./pysatl_criterion"}
 
 [tool.poetry.group.dev.dependencies]
@@ -33,6 +35,7 @@ mkdocs = "1.6.1"
 mkdocs-material = "9.6.14"
 mdx-truly-sane-lists = "1.3"
 pymdown-extensions = "10.15"
+jinja2 = "3.1.6"
 mike = "2.1.3"
 isort = "6.0.1"
 coveralls = "4.0.1"
@@ -43,6 +46,7 @@ ruff = "0.11.12"
 pytest-mock = "3.14.1"
 pre-commit = "4.2.0"
 mypy = "^1.15.0"
+psycopg2 = "2.9.10"
 
 [tool.poetry.scripts]
 experiment = "pysatl_experiment.cli.cli.cli:cli"
@@ -80,5 +84,8 @@ max-complexity = 12
 [tool.ruff.lint.isort]
 lines-after-imports = 2
 
-[tool.mypy]
-ignore_missing_imports = true
+[tool.flake8]
+ignore = ["E121", "E123", "E126", "E24", "E203", "E704", "W503", "W504"]
+max-line-length = 120
+max-complexity = 12
+exclude = [".git", "__pycache__", ".eggs", "user_data", ".venv", ".env"]

pysatl_experiment/cli/cli/cli.py

@@ -14,6 +14,7 @@
 from pysatl_experiment.cli.commands.configure.show.show import show
 from pysatl_experiment.cli.commands.configure.significance_levels.significance_levels import significance_levels
 from pysatl_experiment.cli.commands.configure.storage_connection.storage_connection import storage_connection
+from pysatl_experiment.cli.commands.configure.storage_type.storage_type import storage_type
 from pysatl_experiment.cli.commands.create.create import create
 from pysatl_experiment.cli.shared import cli
 
@@ -28,6 +29,7 @@
 cli.add_command(generator_type)
 cli.add_command(executor_type)
 cli.add_command(report_builder_type)
+cli.add_command(storage_type)
 cli.add_command(sample_sizes)
 cli.add_command(monte_carlo_count)
 cli.add_command(significance_levels)

pysatl_experiment/cli/commands/common/common.py

@@ -53,9 +53,10 @@ def create_storage_path(storage_name: str) -> str:
     :return: path to the storage.
     """
 
+    # TODO: add support for link!
     # pysatl-experiment/.storage
     storage_dir = Path(__file__).resolve().parents[4] / ".storage"
-    storage_file_name = f"{storage_name}.sqlite"
+    storage_file_name = f"{storage_name}.sqlite"  # TODO: different storages
 
     storage_path = storage_dir / storage_file_name
 

pysatl_experiment/cli/commands/configure/storage_connection/storage_connection.py

@@ -19,6 +19,8 @@ def storage_connection(ctx: Context, connection: str) -> None:
     :param connection: storage connection.
     """
 
+    # TODO: add support for different remote storages
+
     experiment_name, experiment_config = get_experiment_name_and_config(ctx)
 
     storage_path = create_storage_path(connection)

pysatl_experiment/cli/commands/configure/storage_type/storage_type.py

@@ -0,0 +1,29 @@
+from click import Context, argument, echo, pass_context
+
+from pysatl_experiment.cli.commands.common.common import get_experiment_name_and_config, save_experiment_config
+from pysatl_experiment.cli.commands.configure.configure import configure
+
+
+@configure.command()
+@argument("store_type")
+@pass_context
+def storage_type(ctx: Context, store_type: str) -> None:
+    """
+    Configure storage type.
+
+    :param ctx: context.
+    :param store_type: storage type.
+    """
+
+    # TODO: add support for remote storage
+
+    experiment_name, experiment_config = get_experiment_name_and_config(ctx)
+
+    # TODO
+    storage_type_lower = store_type.lower()
+    experiment_config["storage_type"] = storage_type_lower
+    # TODO
+
+    save_experiment_config(ctx, experiment_name, experiment_config)
+
+    echo(f"Report builder type of the experiment '{experiment_name}' is set to '{storage_type_lower}'.")

pysatl_experiment/configuration/experiment_config/experiment_config.py

@@ -6,6 +6,7 @@
 from pysatl_experiment.configuration.model.report_mode.report_mode import ReportMode
 from pysatl_experiment.configuration.model.run_mode.run_mode import RunMode
 from pysatl_experiment.configuration.model.step_type.step_type import StepType
+from pysatl_experiment.configuration.model.storage_type.storage_type import StorageType
 
 
 @dataclass
@@ -16,6 +17,7 @@ class ExperimentConfig:
 
     experiment_type: ExperimentType
     storage_connection: str
+    storage_type: StorageType
     run_mode: RunMode
     hypothesis: Hypothesis
     generator_type: StepType

pysatl_experiment/configuration/model/storage_type/storage_type.py

@@ -0,0 +1,10 @@
+from enum import Enum
+
+
+class StorageType(Enum):
+    """
+    Internal storage.
+    """
+
+    SQLITE = "sqlite"
+    POSTGRESQL = "postgresql"

pysatl_experiment/exceptions.py

@@ -16,3 +16,9 @@ class ConfigurationError(OperationalException):
     """
     Configuration error. Usually caused by invalid configuration.
     """
+
+
+class StorageError(OperationalException):  # TODO: description!!!
+    """
+    Storage error. Used in storage creation.
+    """

pysatl_experiment/factory/model/abstract_experiment_factory/abstract_experiment_factory.py

@@ -18,14 +18,14 @@
 from pysatl_experiment.experiment.generator.generators import ExponentialGenerator, NormalGenerator, WeibullGenerator
 from pysatl_experiment.experiment_new.experiment_steps.experiment_steps import ExperimentSteps
 from pysatl_experiment.experiment_new.model.experiment_step.experiment_step import IExperimentStep
-from pysatl_experiment.persistence.experiment.sqlite.sqlite import SQLiteExperimentStorage
 from pysatl_experiment.persistence.model.experiment.experiment import ExperimentQuery, IExperimentStorage
 from pysatl_experiment.persistence.model.power.power import PowerQuery
 from pysatl_experiment.persistence.model.random_values.random_values import IRandomValuesStorage, RandomValuesAllQuery
 from pysatl_experiment.persistence.model.time_complexity.time_complexity import TimeComplexityQuery
-from pysatl_experiment.persistence.power.sqlite.sqlite import SQLitePowerStorage
-from pysatl_experiment.persistence.random_values.sqlite.sqlite import SQLiteRandomValuesStorage
-from pysatl_experiment.persistence.time_complexity.sqlite.sqlite import SQLiteTimeComplexityStorage
+from pysatl_experiment.persistence.storage.experiment.sqlite.sqlite import SQLiteExperimentStorage
+from pysatl_experiment.persistence.storage.power.sqlite.sqlite import SQLitePowerStorage
+from pysatl_experiment.persistence.storage.random_values.sqlite.sqlite import SQLiteRandomValuesStorage
+from pysatl_experiment.persistence.storage.time_complexity.sqlite.sqlite import SQLiteTimeComplexityStorage
 
 
 D = TypeVar("D", contravariant=True, bound=ExperimentData)
@@ -434,7 +434,7 @@ def _init_data_storage(self) -> IRandomValuesStorage:
         """
 
         storage_connection = self.experiment_data.config.storage_connection
-        data_storage = SQLiteRandomValuesStorage(storage_connection)
+        data_storage = SQLiteRandomValuesStorage(storage_connection)  # TODO: improve smh
         data_storage.init()
 
         return data_storage
@@ -447,7 +447,7 @@ def _init_experiment_storage(self) -> IExperimentStorage:
         """
 
         storage_connection = self.experiment_data.config.storage_connection
-        data_storage = SQLiteExperimentStorage(storage_connection)
+        data_storage = SQLiteExperimentStorage(storage_connection)  # TODO: improve smh
         data_storage.init()
 
         return data_storage
@@ -459,7 +459,7 @@ def _init_result_storage(self) -> RS:
         :return: result storage.
         """
 
-        experiment_type = self.experiment_data.config.experiment_type
+        experiment_type = self.experiment_data.config.experiment_type  # TODO: improve smh
         storage_connection = self.experiment_data.config.storage_connection
         if experiment_type == ExperimentType.CRITICAL_VALUE:
             limit_distribution_storage = SQLiteLimitDistributionStorage(storage_connection)

pysatl_experiment/persistence/model/power/power.py

@@ -33,4 +33,22 @@ class IPowerStorage(IDataStorage[PowerModel, PowerQuery], Protocol):
     Power storage interface.
     """
 
-    pass
+    def init(self) -> None:
+        """
+        Initialize SQLite power storage and create tables.
+        """
+
+    def insert_data(self, data: PowerModel) -> None:
+        """
+        Insert or replace a power entry.
+        """
+
+    def get_data(self, query: PowerQuery) -> PowerModel | None:
+        """
+        Retrieve power data matching the query.
+        """
+
+    def delete_data(self, query: PowerQuery) -> None:
+        """
+        Delete power data matching the query.
+        """

pysatl_experiment/persistence/model/time_complexity/time_complexity.py

@@ -27,4 +27,22 @@ class ITimeComplexityStorage(IDataStorage[TimeComplexityModel, TimeComplexityQue
     Time complexity storage interface.
     """
 
-    pass
+    def init(self) -> None:
+        """
+        Initialize SQLite time complexity storage and create tables.
+        """
+
+    def insert_data(self, data: TimeComplexityModel) -> None:
+        """
+        Insert or replace time complexity data.
+        """
+
+    def get_data(self, query: TimeComplexityQuery) -> TimeComplexityModel | None:
+        """
+        Get time complexity data matching the query.
+        """
+
+    def delete_data(self, query: TimeComplexityQuery) -> None:
+        """
+        Delete time complexity data matching the query.
+        """