Merge pull request #14 from Xiao75896453/feat/account_password_manage…

…ment/orm_db_migration

feat (account_password_management): Set ORM and DB migration tool

alembic.ini

@@ -0,0 +1,116 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+# Use forward slashes (/) also on windows to provide an os agnostic path
+script_location = projects\account_password_management\alembic
+
+# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
+# Uncomment the line below if you want the files to be prepended with date and time
+# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file
+# for all available tokens
+# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
+
+# sys.path path, will be prepended to sys.path if present.
+# defaults to the current working directory.
+prepend_sys_path = .
+
+# timezone to use when rendering the date within the migration file
+# as well as the filename.
+# If specified, requires the python>=3.9 or backports.zoneinfo library.
+# Any required deps can installed by adding `alembic[tz]` to the pip requirements
+# string value is passed to ZoneInfo()
+# leave blank for localtime
+# timezone =
+
+# max length of characters to apply to the "slug" field
+# truncate_slug_length = 40
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+# set to 'true' to allow .pyc and .pyo files without
+# a source .py file to be detected as revisions in the
+# versions/ directory
+# sourceless = false
+
+# version location specification; This defaults
+# to projects\account_password_management\alembic/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path.
+# The path separator used here should be the separator specified by "version_path_separator" below.
+# version_locations = %(here)s/bar:%(here)s/bat:projects\account_password_management\alembic/versions
+
+# version path separator; As mentioned above, this is the character used to split
+# version_locations. The default within new alembic.ini files is "os", which uses os.pathsep.
+# If this key is omitted entirely, it falls back to the legacy behavior of splitting on spaces and/or commas.
+# Valid values for version_path_separator are:
+#
+# version_path_separator = :
+# version_path_separator = ;
+# version_path_separator = space
+version_path_separator = os  # Use os.pathsep. Default configuration used for new projects.
+
+# set to 'true' to search source files recursively
+# in each "version_locations" directory
+# new in Alembic version 1.10
+# recursive_version_locations = false
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+sqlalchemy.url = driver://user:pass@localhost/dbname
+
+
+[post_write_hooks]
+# post_write_hooks defines scripts or Python functions that are run
+# on newly generated revision scripts.  See the documentation for further
+# detail and examples
+
+# format using "black" - use the console_scripts runner, against the "black" entrypoint
+# hooks = black
+# black.type = console_scripts
+# black.entrypoint = black
+# black.options = -l 79 REVISION_SCRIPT_FILENAME
+
+# lint with attempts to fix using "ruff" - use the exec runner, execute a binary
+# hooks = ruff
+# ruff.type = exec
+# ruff.executable = %(here)s/.venv/bin/ruff
+# ruff.options = --fix REVISION_SCRIPT_FILENAME
+
+# Logging configuration
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARN
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARN
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

lib/db_engine/db_interface.py

@@ -0,0 +1,28 @@
+from abc import ABC, abstractmethod
+
+
+class DBInterface(ABC):
+    def __init__(self, base, engine) -> None:
+        self.__base = base
+        self.__engine = engine
+
+    def get_db_session(self):
+        db_session = self.create_db_session()
+
+        try:
+            yield db_session
+        finally:
+            db_session.close()
+
+    @abstractmethod
+    def create_db_session(self):
+        pass
+
+    def get_base(self):
+        return self.__base
+
+    def get_base_metadata(self):
+        return self.__base.metadata
+
+    def get_engine(self):
+        return self.__engine

lib/db_engine/sqlalchemy.py

@@ -0,0 +1,76 @@
+from dataclasses import dataclass
+
+from sqlalchemy import create_engine
+from sqlalchemy.ext.declarative import declarative_base
+from sqlalchemy.orm import sessionmaker
+
+from lib.db_engine.db_interface import DBInterface
+
+
+@dataclass
+class DBUrlParameter:
+    driver_name: str
+    user: str
+    password: str
+    host: str
+    port: int
+    database: str
+    driver: str | None = None
+
+
+@dataclass
+class DBConnectionParameter:
+    pool_size: int
+    max_overflow: int
+    pool_recycle: int
+
+
+class SqlAlchemy(DBInterface):
+    def __init__(
+        self,
+        db_url_parameter: DBUrlParameter,
+        db_connection_parameter: DBConnectionParameter,
+    ) -> None:
+        # create a SQLAlchemy "engine"
+        self.__set_db_rul(db_url_parameter)
+
+        self.__engine = create_engine(
+            self.__db_url,
+            pool_size=db_connection_parameter.pool_size,
+            max_overflow=db_connection_parameter.max_overflow,
+            pool_recycle=db_connection_parameter.pool_recycle,
+        )
+        # Later we will inherit from this class to create each of the database models or classes
+        # (the ORM models)
+        self.__base = declarative_base()
+
+        # Each instance of the SessionLocal class will be a database session.
+        # The class itself is not a database session yet.
+        # But once we create an instance of the SessionLocal class,
+        # this instance will be the actual database session.
+        self.__session = sessionmaker(
+            autocommit=False, autoflush=False, bind=self.__engine
+        )
+
+        super().__init__(base=self.__base, engine=self.__engine)
+
+    def __set_db_rul(self, db_url_parameter: DBUrlParameter) -> None:
+        db_url = (
+            rf"{db_url_parameter.driver_name}://"
+            + f"{db_url_parameter.user}:{db_url_parameter.password}"
+            + f"@{db_url_parameter.host}:{db_url_parameter.port}/{db_url_parameter.database}"
+        )
+
+        if db_url_parameter.driver:
+            db_url += f"?driver={db_url_parameter.driver}"
+
+        self.__db_url = db_url
+
+    def get_db_url(self) -> str:
+        return self.__db_url
+
+    def create_db_session(self):
+        return self.__session()
+
+    def drop_all_tables(self) -> None:
+        super().get_base().metadata.drop_all(bind=super().get_engine())