mirror of
https://github.com/invoke-ai/InvokeAI
synced 2024-08-30 20:32:17 +00:00
402cf9b0ee
Refactor services folder/module structure.
**Motivation**
While working on our services I've repeatedly encountered circular imports and a general lack of clarity regarding where to put things. The structure introduced goes a long way towards resolving those issues, setting us up for a clean structure going forward.
**Services**
Services are now in their own folder with a few files:
- `services/{service_name}/__init__.py`: init as needed, mostly empty now
- `services/{service_name}/{service_name}_base.py`: the base class for the service
- `services/{service_name}/{service_name}_{impl_type}.py`: the default concrete implementation of the service - typically one of `sqlite`, `default`, or `memory`
- `services/{service_name}/{service_name}_common.py`: any common items - models, exceptions, utilities, etc
Though it's a bit verbose to have the service name both as the folder name and the prefix for files, I found it is _extremely_ confusing to have all of the base classes just be named `base.py`. So, at the cost of some verbosity when importing things, I've included the service name in the filename.
There are some minor logic changes. For example, in `InvocationProcessor`, instead of assigning the model manager service to a variable to be used later in the file, the service is used directly via the `Invoker`.
**Shared**
Things that are used across disparate services are in `services/shared/`:
- `default_graphs.py`: previously in `services/`
- `graphs.py`: previously in `services/`
- `paginatation`: generic pagination models used in a few services
- `sqlite`: the `SqliteDatabase` class, other sqlite-specific things
49 lines
1.4 KiB
Python
49 lines
1.4 KiB
Python
import sqlite3
|
|
import threading
|
|
from logging import Logger
|
|
|
|
from invokeai.app.services.config import InvokeAIAppConfig
|
|
|
|
sqlite_memory = ":memory:"
|
|
|
|
|
|
class SqliteDatabase:
|
|
conn: sqlite3.Connection
|
|
lock: threading.Lock
|
|
_logger: Logger
|
|
_config: InvokeAIAppConfig
|
|
|
|
def __init__(self, config: InvokeAIAppConfig, logger: Logger):
|
|
self._logger = logger
|
|
self._config = config
|
|
|
|
if self._config.use_memory_db:
|
|
location = sqlite_memory
|
|
logger.info("Using in-memory database")
|
|
else:
|
|
db_path = self._config.db_path
|
|
db_path.parent.mkdir(parents=True, exist_ok=True)
|
|
location = str(db_path)
|
|
self._logger.info(f"Using database at {location}")
|
|
|
|
self.conn = sqlite3.connect(location, check_same_thread=False)
|
|
self.lock = threading.Lock()
|
|
self.conn.row_factory = sqlite3.Row
|
|
|
|
if self._config.log_sql:
|
|
self.conn.set_trace_callback(self._logger.debug)
|
|
|
|
self.conn.execute("PRAGMA foreign_keys = ON;")
|
|
|
|
def clean(self) -> None:
|
|
try:
|
|
self.lock.acquire()
|
|
self.conn.execute("VACUUM;")
|
|
self.conn.commit()
|
|
self._logger.info("Cleaned database")
|
|
except Exception as e:
|
|
self._logger.error(f"Error cleaning database: {e}")
|
|
raise e
|
|
finally:
|
|
self.lock.release()
|