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
106 lines
4.5 KiB
Python
106 lines
4.5 KiB
Python
# Copyright (c) 2022 Kyle Schouviller (https://github.com/kyle0654) and the InvokeAI Team
|
|
from __future__ import annotations
|
|
|
|
from typing import TYPE_CHECKING
|
|
|
|
if TYPE_CHECKING:
|
|
from logging import Logger
|
|
|
|
from .board_image_records.board_image_records_base import BoardImageRecordStorageBase
|
|
from .board_images.board_images_base import BoardImagesServiceABC
|
|
from .board_records.board_records_base import BoardRecordStorageBase
|
|
from .boards.boards_base import BoardServiceABC
|
|
from .config import InvokeAIAppConfig
|
|
from .events.events_base import EventServiceBase
|
|
from .image_files.image_files_base import ImageFileStorageBase
|
|
from .image_records.image_records_base import ImageRecordStorageBase
|
|
from .images.images_base import ImageServiceABC
|
|
from .invocation_cache.invocation_cache_base import InvocationCacheBase
|
|
from .invocation_processor.invocation_processor_base import InvocationProcessorABC
|
|
from .invocation_queue.invocation_queue_base import InvocationQueueABC
|
|
from .invocation_stats.invocation_stats_base import InvocationStatsServiceBase
|
|
from .item_storage.item_storage_base import ItemStorageABC
|
|
from .latents_storage.latents_storage_base import LatentsStorageBase
|
|
from .model_manager.model_manager_base import ModelManagerServiceBase
|
|
from .names.names_base import NameServiceBase
|
|
from .session_processor.session_processor_base import SessionProcessorBase
|
|
from .session_queue.session_queue_base import SessionQueueBase
|
|
from .shared.graph import GraphExecutionState, LibraryGraph
|
|
from .urls.urls_base import UrlServiceBase
|
|
|
|
|
|
class InvocationServices:
|
|
"""Services that can be used by invocations"""
|
|
|
|
# TODO: Just forward-declared everything due to circular dependencies. Fix structure.
|
|
board_images: "BoardImagesServiceABC"
|
|
board_image_record_storage: "BoardImageRecordStorageBase"
|
|
boards: "BoardServiceABC"
|
|
board_records: "BoardRecordStorageBase"
|
|
configuration: "InvokeAIAppConfig"
|
|
events: "EventServiceBase"
|
|
graph_execution_manager: "ItemStorageABC[GraphExecutionState]"
|
|
graph_library: "ItemStorageABC[LibraryGraph]"
|
|
images: "ImageServiceABC"
|
|
image_records: "ImageRecordStorageBase"
|
|
image_files: "ImageFileStorageBase"
|
|
latents: "LatentsStorageBase"
|
|
logger: "Logger"
|
|
model_manager: "ModelManagerServiceBase"
|
|
processor: "InvocationProcessorABC"
|
|
performance_statistics: "InvocationStatsServiceBase"
|
|
queue: "InvocationQueueABC"
|
|
session_queue: "SessionQueueBase"
|
|
session_processor: "SessionProcessorBase"
|
|
invocation_cache: "InvocationCacheBase"
|
|
names: "NameServiceBase"
|
|
urls: "UrlServiceBase"
|
|
|
|
def __init__(
|
|
self,
|
|
board_images: "BoardImagesServiceABC",
|
|
board_image_records: "BoardImageRecordStorageBase",
|
|
boards: "BoardServiceABC",
|
|
board_records: "BoardRecordStorageBase",
|
|
configuration: "InvokeAIAppConfig",
|
|
events: "EventServiceBase",
|
|
graph_execution_manager: "ItemStorageABC[GraphExecutionState]",
|
|
graph_library: "ItemStorageABC[LibraryGraph]",
|
|
images: "ImageServiceABC",
|
|
image_files: "ImageFileStorageBase",
|
|
image_records: "ImageRecordStorageBase",
|
|
latents: "LatentsStorageBase",
|
|
logger: "Logger",
|
|
model_manager: "ModelManagerServiceBase",
|
|
processor: "InvocationProcessorABC",
|
|
performance_statistics: "InvocationStatsServiceBase",
|
|
queue: "InvocationQueueABC",
|
|
session_queue: "SessionQueueBase",
|
|
session_processor: "SessionProcessorBase",
|
|
invocation_cache: "InvocationCacheBase",
|
|
names: "NameServiceBase",
|
|
urls: "UrlServiceBase",
|
|
):
|
|
self.board_images = board_images
|
|
self.board_image_records = board_image_records
|
|
self.boards = boards
|
|
self.board_records = board_records
|
|
self.configuration = configuration
|
|
self.events = events
|
|
self.graph_execution_manager = graph_execution_manager
|
|
self.graph_library = graph_library
|
|
self.images = images
|
|
self.image_files = image_files
|
|
self.image_records = image_records
|
|
self.latents = latents
|
|
self.logger = logger
|
|
self.model_manager = model_manager
|
|
self.processor = processor
|
|
self.performance_statistics = performance_statistics
|
|
self.queue = queue
|
|
self.session_queue = session_queue
|
|
self.session_processor = session_processor
|
|
self.invocation_cache = invocation_cache
|
|
self.names = names
|
|
self.urls = urls
|