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
60 lines
1.2 KiB
Python
60 lines
1.2 KiB
Python
from abc import ABC, abstractmethod
|
|
|
|
from invokeai.app.services.board_records.board_records_common import BoardChanges
|
|
from invokeai.app.services.shared.pagination import OffsetPaginatedResults
|
|
|
|
from .boards_common import BoardDTO
|
|
|
|
|
|
class BoardServiceABC(ABC):
|
|
"""High-level service for board management."""
|
|
|
|
@abstractmethod
|
|
def create(
|
|
self,
|
|
board_name: str,
|
|
) -> BoardDTO:
|
|
"""Creates a board."""
|
|
pass
|
|
|
|
@abstractmethod
|
|
def get_dto(
|
|
self,
|
|
board_id: str,
|
|
) -> BoardDTO:
|
|
"""Gets a board."""
|
|
pass
|
|
|
|
@abstractmethod
|
|
def update(
|
|
self,
|
|
board_id: str,
|
|
changes: BoardChanges,
|
|
) -> BoardDTO:
|
|
"""Updates a board."""
|
|
pass
|
|
|
|
@abstractmethod
|
|
def delete(
|
|
self,
|
|
board_id: str,
|
|
) -> None:
|
|
"""Deletes a board."""
|
|
pass
|
|
|
|
@abstractmethod
|
|
def get_many(
|
|
self,
|
|
offset: int = 0,
|
|
limit: int = 10,
|
|
) -> OffsetPaginatedResults[BoardDTO]:
|
|
"""Gets many boards."""
|
|
pass
|
|
|
|
@abstractmethod
|
|
def get_all(
|
|
self,
|
|
) -> list[BoardDTO]:
|
|
"""Gets all boards."""
|
|
pass
|