Merge branch 'main' into main

.github/workflows/python-checks.yml

@@ -62,7 +62,7 @@ jobs:
 
       - name: install ruff
         if: ${{ steps.changed-files.outputs.python_any_changed == 'true' || inputs.always_run == true }}
-        run: pip install ruff
+        run: pip install ruff==0.6.0
         shell: bash
 
       - name: ruff check

installer/templates/invoke.sh.in

@@ -17,7 +17,7 @@
 set -eu
 
 # Ensure we're in the correct folder in case user's CWD is somewhere else
-scriptdir=$(dirname "$0")
+scriptdir=$(dirname $(readlink -f "$0"))
 cd "$scriptdir"
 
 . .venv/bin/activate

invokeai/app/api/routers/style_presets.py

@@ -1,10 +1,11 @@
+import csv
 import io
 import json
 import traceback
 from typing import Optional
 
 import pydantic
-from fastapi import APIRouter, File, Form, HTTPException, Path, UploadFile
+from fastapi import APIRouter, File, Form, HTTPException, Path, Response, UploadFile
 from fastapi.responses import FileResponse
 from PIL import Image
 from pydantic import BaseModel, Field
@@ -13,12 +14,15 @@
 from invokeai.app.api.routers.model_manager import IMAGE_MAX_AGE
 from invokeai.app.services.style_preset_images.style_preset_images_common import StylePresetImageFileNotFoundException
 from invokeai.app.services.style_preset_records.style_preset_records_common import (
+    InvalidPresetImportDataError,
     PresetData,
     PresetType,
     StylePresetChanges,
     StylePresetNotFoundError,
     StylePresetRecordWithImage,
     StylePresetWithoutId,
+    UnsupportedFileTypeError,
+    parse_presets_from_file,
 )
 
 
@@ -225,3 +229,48 @@ async def get_style_preset_image(
         return response
     except Exception:
         raise HTTPException(status_code=404)
+
+
+@style_presets_router.get(
+    "/export",
+    operation_id="export_style_presets",
+    responses={200: {"content": {"text/csv": {}}, "description": "A CSV file with the requested data."}},
+    status_code=200,
+)
+async def export_style_presets():
+    # Create an in-memory stream to store the CSV data
+    output = io.StringIO()
+    writer = csv.writer(output)
+
+    # Write the header
+    writer.writerow(["name", "prompt", "negative_prompt"])
+
+    style_presets = ApiDependencies.invoker.services.style_preset_records.get_many(type=PresetType.User)
+
+    for preset in style_presets:
+        writer.writerow([preset.name, preset.preset_data.positive_prompt, preset.preset_data.negative_prompt])
+
+    csv_data = output.getvalue()
+    output.close()
+
+    return Response(
+        content=csv_data,
+        media_type="text/csv",
+        headers={"Content-Disposition": "attachment; filename=prompt_templates.csv"},
+    )
+
+
+@style_presets_router.post(
+    "/import",
+    operation_id="import_style_presets",
+)
+async def import_style_presets(file: UploadFile = File(description="The file to import")):
+    try:
+        style_presets = await parse_presets_from_file(file)
+        ApiDependencies.invoker.services.style_preset_records.create_many(style_presets)
+    except InvalidPresetImportDataError as e:
+        ApiDependencies.invoker.services.logger.error(traceback.format_exc())
+        raise HTTPException(status_code=400, detail=str(e))
+    except UnsupportedFileTypeError as e:
+        ApiDependencies.invoker.services.logger.error(traceback.format_exc())
+        raise HTTPException(status_code=415, detail=str(e))

invokeai/app/services/style_preset_records/default_style_presets.json

@@ -3,143 +3,143 @@
     "name": "Photography (General)",
     "type": "default",
     "preset_data": {
-      "positive_prompt": "[prompt]. photography. f/2.8 macro photo, bokeh, photorealism",
+      "positive_prompt": "{prompt}. photography. f/2.8 macro photo, bokeh, photorealism",
       "negative_prompt": "painting, digital art. sketch, blurry"
     }
   },
   {
     "name": "Photography (Studio Lighting)",
     "type": "default",
     "preset_data": {
-      "positive_prompt": "[prompt], photography. f/8 photo. centered subject, studio lighting.",
+      "positive_prompt": "{prompt}, photography. f/8 photo. centered subject, studio lighting.",
       "negative_prompt": "painting, digital art. sketch, blurry"
     }
   },
   {
     "name": "Photography (Landscape)",
     "type": "default",
     "preset_data": {
-      "positive_prompt": "[prompt], landscape photograph, f/12, lifelike,  highly detailed.",
+      "positive_prompt": "{prompt}, landscape photograph, f/12, lifelike,  highly detailed.",
       "negative_prompt": "painting, digital art. sketch, blurry"
     }
   },
   {
     "name": "Photography (Portrait)",
     "type": "default",
     "preset_data": {
-      "positive_prompt": "[prompt]. photography. portraiture. catch light in eyes. one flash. rembrandt lighting. Soft box. dark shadows. High contrast. 80mm lens. F2.8.",
+      "positive_prompt": "{prompt}. photography. portraiture. catch light in eyes. one flash. rembrandt lighting. Soft box. dark shadows. High contrast. 80mm lens. F2.8.",
       "negative_prompt": "painting, digital art. sketch, blurry"
     }
   },
   {
     "name": "Photography (Black and White)",
     "type": "default",
     "preset_data": {
-      "positive_prompt": "[prompt] photography. natural light. 80mm lens. F1.4. strong contrast, hard light. dark contrast. blurred background. black and white",
+      "positive_prompt": "{prompt} photography. natural light. 80mm lens. F1.4. strong contrast, hard light. dark contrast. blurred background. black and white",
       "negative_prompt": "painting, digital art. sketch, colour+"
     }
   },
   {
     "name": "Architectural Visualization",
     "type": "default",
     "preset_data": {
-      "positive_prompt": "[prompt]. architectural photography, f/12, luxury, aesthetically pleasing form and function.",
+      "positive_prompt": "{prompt}. architectural photography, f/12, luxury, aesthetically pleasing form and function.",
       "negative_prompt": "painting, digital art. sketch, blurry"
     }
   },
   {
     "name": "Concept Art (Fantasy)",
     "type": "default",
     "preset_data": {
-      "positive_prompt": "concept artwork of a [prompt]. (digital painterly art style)++, mythological, (textured 2d dry media brushpack)++, glazed brushstrokes, otherworldly. painting+, illustration+",
+      "positive_prompt": "concept artwork of a {prompt}. (digital painterly art style)++, mythological, (textured 2d dry media brushpack)++, glazed brushstrokes, otherworldly. painting+, illustration+",
       "negative_prompt": "photo. distorted, blurry, out of focus. sketch. (cgi, 3d.)++"
     }
   },
   {
     "name": "Concept Art (Sci-Fi)",
     "type": "default",
     "preset_data": {
-      "positive_prompt": "(concept art)++, [prompt], (sleek futurism)++, (textured 2d dry media)++, metallic highlights, digital painting style",
+      "positive_prompt": "(concept art)++, {prompt}, (sleek futurism)++, (textured 2d dry media)++, metallic highlights, digital painting style",
       "negative_prompt": "photo. distorted, blurry, out of focus. sketch. (cgi, 3d.)++"
     }
   },
   {
     "name": "Concept Art (Character)",
     "type": "default",
     "preset_data": {
-      "positive_prompt": "(character concept art)++, stylized painterly digital painting of [prompt], (painterly, impasto. Dry brush.)++",
+      "positive_prompt": "(character concept art)++, stylized painterly digital painting of {prompt}, (painterly, impasto. Dry brush.)++",
       "negative_prompt": "photo. distorted, blurry, out of focus. sketch. (cgi, 3d.)++"
     }
   },
   {
     "name": "Concept Art (Painterly)",
     "type": "default",
     "preset_data": {
-      "positive_prompt": "[prompt] oil painting. high contrast. impasto. sfumato. chiaroscuro. Palette knife.",
+      "positive_prompt": "{prompt} oil painting. high contrast. impasto. sfumato. chiaroscuro. Palette knife.",
       "negative_prompt": "photo. smooth. border. frame"
     }
   },
   {
     "name": "Environment Art",
     "type": "default",
     "preset_data": {
-      "positive_prompt": "[prompt] environment artwork, hyper-realistic digital painting style with cinematic composition, atmospheric, depth and detail, voluminous. textured dry brush 2d media",
+      "positive_prompt": "{prompt} environment artwork, hyper-realistic digital painting style with cinematic composition, atmospheric, depth and detail, voluminous. textured dry brush 2d media",
       "negative_prompt": "photo, distorted, blurry, out of focus. sketch."
     }
   },
   {
     "name": "Interior Design (Visualization)",
     "type": "default",
     "preset_data": {
-      "positive_prompt": "[prompt] interior design photo, gentle shadows, light mid-tones, dimension, mix of smooth and textured surfaces, focus on negative space and clean lines, focus",
+      "positive_prompt": "{prompt} interior design photo, gentle shadows, light mid-tones, dimension, mix of smooth and textured surfaces, focus on negative space and clean lines, focus",
       "negative_prompt": "photo, distorted. sketch."
     }
   },
   {
     "name": "Product Rendering",
     "type": "default",
     "preset_data": {
-      "positive_prompt": "[prompt] high quality product photography, 3d rendering with key lighting, shallow depth of field, simple plain background, studio lighting.",
+      "positive_prompt": "{prompt} high quality product photography, 3d rendering with key lighting, shallow depth of field, simple plain background, studio lighting.",
       "negative_prompt": "blurry, sketch, messy, dirty. unfinished."
     }
   },
   {
     "name": "Sketch",
     "type": "default",
     "preset_data": {
-      "positive_prompt": "[prompt] black and white pencil drawing, off-center composition, cross-hatching for shadows, bold strokes, textured paper. sketch+++",
+      "positive_prompt": "{prompt} black and white pencil drawing, off-center composition, cross-hatching for shadows, bold strokes, textured paper. sketch+++",
       "negative_prompt": "blurry, photo, painting, color. messy, dirty. unfinished. frame, borders."
     }
   },
   {
     "name": "Line Art",
     "type": "default",
     "preset_data": {
-      "positive_prompt": "[prompt] Line art. bold outline. simplistic. white background. 2d",
+      "positive_prompt": "{prompt} Line art. bold outline. simplistic. white background. 2d",
       "negative_prompt": "photo. digital art. greyscale. solid black. painting"
     }
   },
   {
     "name": "Anime",
     "type": "default",
     "preset_data": {
-      "positive_prompt": "[prompt] anime++, bold outline, cel-shaded coloring, shounen, seinen",
+      "positive_prompt": "{prompt} anime++, bold outline, cel-shaded coloring, shounen, seinen",
       "negative_prompt": "(photo)+++. greyscale. solid black. painting"
     }
   },
   {
     "name": "Illustration",
     "type": "default",
     "preset_data": {
-      "positive_prompt": "[prompt] illustration, bold linework, illustrative details, vector art style, flat coloring",
+      "positive_prompt": "{prompt} illustration, bold linework, illustrative details, vector art style, flat coloring",
       "negative_prompt": "(photo)+++. greyscale. painting, black and white."
     }
   },
   {
     "name": "Vehicles",
     "type": "default",
     "preset_data": {
-      "positive_prompt": "A weird futuristic normal auto, [prompt] elegant design, nice color, nice wheels",
+      "positive_prompt": "A weird futuristic normal auto, {prompt} elegant design, nice color, nice wheels",
       "negative_prompt": "sketch. digital art. greyscale. painting"
     }
   }

invokeai/app/services/style_preset_records/style_preset_records_base.py

@@ -1,6 +1,7 @@
 from abc import ABC, abstractmethod
 
 from invokeai.app.services.style_preset_records.style_preset_records_common import (
+    PresetType,
     StylePresetChanges,
     StylePresetRecordDTO,
     StylePresetWithoutId,
@@ -20,6 +21,11 @@ def create(self, style_preset: StylePresetWithoutId) -> StylePresetRecordDTO:
         """Creates a style preset."""
         pass
 
+    @abstractmethod
+    def create_many(self, style_presets: list[StylePresetWithoutId]) -> None:
+        """Creates many style presets."""
+        pass
+
     @abstractmethod
     def update(self, style_preset_id: str, changes: StylePresetChanges) -> StylePresetRecordDTO:
         """Updates a style preset."""
@@ -31,6 +37,6 @@ def delete(self, style_preset_id: str) -> None:
         pass
 
     @abstractmethod
-    def get_many(self) -> list[StylePresetRecordDTO]:
+    def get_many(self, type: PresetType | None = None) -> list[StylePresetRecordDTO]:
         """Gets many workflows."""
         pass

invokeai/app/services/style_preset_records/style_preset_records_common.py

@@ -1,7 +1,12 @@
+import codecs
+import csv
+import json
 from enum import Enum
 from typing import Any, Optional
 
-from pydantic import BaseModel, Field, TypeAdapter
+import pydantic
+from fastapi import UploadFile
+from pydantic import AliasChoices, BaseModel, ConfigDict, Field, TypeAdapter
 
 from invokeai.app.util.metaenum import MetaEnum
 
@@ -49,3 +54,85 @@ def from_dict(cls, data: dict[str, Any]) -> "StylePresetRecordDTO":
 
 class StylePresetRecordWithImage(StylePresetRecordDTO):
     image: Optional[str] = Field(description="The path for image")
+
+
+class StylePresetImportRow(BaseModel):
+    name: str = Field(min_length=1, description="The name of the preset.")
+    positive_prompt: str = Field(
+        default="",
+        description="The positive prompt for the preset.",
+        validation_alias=AliasChoices("positive_prompt", "prompt"),
+    )
+    negative_prompt: str = Field(default="", description="The negative prompt for the preset.")
+
+    model_config = ConfigDict(str_strip_whitespace=True, extra="forbid")
+
+
+StylePresetImportList = list[StylePresetImportRow]
+StylePresetImportListTypeAdapter = TypeAdapter(StylePresetImportList)
+
+
+class UnsupportedFileTypeError(ValueError):
+    """Raised when an unsupported file type is encountered"""
+
+    pass
+
+
+class InvalidPresetImportDataError(ValueError):
+    """Raised when invalid preset import data is encountered"""
+
+    pass
+
+
+async def parse_presets_from_file(file: UploadFile) -> list[StylePresetWithoutId]:
+    """Parses style presets from a file. The file must be a CSV or JSON file.
+
+    If CSV, the file must have the following columns:
+    - name
+    - prompt (or positive_prompt)
+    - negative_prompt
+
+    If JSON, the file must be a list of objects with the following keys:
+    - name
+    - prompt (or positive_prompt)
+    - negative_prompt
+
+    Args:
+        file (UploadFile): The file to parse.
+
+    Returns:
+        list[StylePresetWithoutId]: The parsed style presets.
+
+    Raises:
+        UnsupportedFileTypeError: If the file type is not supported.
+        InvalidPresetImportDataError: If the data in the file is invalid.
+    """
+    if file.content_type not in ["text/csv", "application/json"]:
+        raise UnsupportedFileTypeError()
+
+    if file.content_type == "text/csv":
+        csv_reader = csv.DictReader(codecs.iterdecode(file.file, "utf-8"))
+        data = list(csv_reader)
+    else:  # file.content_type == "application/json":
+        json_data = await file.read()
+        data = json.loads(json_data)
+
+    try:
+        imported_presets = StylePresetImportListTypeAdapter.validate_python(data)
+
+        style_presets: list[StylePresetWithoutId] = []
+
+        for imported in imported_presets:
+            preset_data = PresetData(positive_prompt=imported.positive_prompt, negative_prompt=imported.negative_prompt)
+            style_preset = StylePresetWithoutId(name=imported.name, preset_data=preset_data, type=PresetType.User)
+            style_presets.append(style_preset)
+    except pydantic.ValidationError as e:
+        if file.content_type == "text/csv":
+            msg = "Invalid CSV format: must include columns 'name', 'prompt', and 'negative_prompt' and name cannot be blank"
+        else:  # file.content_type == "application/json":
+            msg = "Invalid JSON format: must be a list of objects with keys 'name', 'prompt', and 'negative_prompt' and name cannot be blank"
+        raise InvalidPresetImportDataError(msg) from e
+    finally:
+        file.file.close()
+
+    return style_presets