diff --git a/python_template_server/db/__init__.py b/python_template_server/db/__init__.py index 275b2e5..1646711 100644 --- a/python_template_server/db/__init__.py +++ b/python_template_server/db/__init__.py @@ -1 +1,7 @@ """Database manager classes for servers using this template.""" + +from .base_database_manager import BaseDatabaseManager + +__all__ = [ + "BaseDatabaseManager", +] diff --git a/python_template_server/db/base_database_manager.py b/python_template_server/db/base_database_manager.py index a390115..4d3b59c 100644 --- a/python_template_server/db/base_database_manager.py +++ b/python_template_server/db/base_database_manager.py @@ -11,7 +11,10 @@ class BaseDatabaseManager(ABC): - """Manager class for database operations.""" + """Manager class for database operations. + + Subclasses must implement the `db_url` property to provide the correct database URL. + """ def __init__(self, db_config: DatabaseConfig) -> None: """Initialize the database manager.""" @@ -25,4 +28,4 @@ def __init__(self, db_config: DatabaseConfig) -> None: @property @abstractmethod def db_url(self) -> str: - """Get the database URL.""" + """Get the database URL using the `DatabaseConfig.db_url()` method.""" diff --git a/tests/db/test_base_database_manager.py b/tests/db/test_base_database_manager.py index f678062..a5de736 100644 --- a/tests/db/test_base_database_manager.py +++ b/tests/db/test_base_database_manager.py @@ -5,7 +5,7 @@ import pytest from sqlalchemy import Engine -from python_template_server.db.base_database_manager import BaseDatabaseManager +from python_template_server.db import BaseDatabaseManager from python_template_server.models import DatabaseConfig MOCK_DB_FILENAME = "test.db"