first commit

.gitignore

@@ -0,0 +1,140 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+.venv*
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+.venv*
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+.vscode/
+.idea/
+
+.DS_Store
+
+# Ruff
+.ruff_cache
+
+# Spell checker config
+cspell.json

Makefile

@@ -0,0 +1,10 @@
+.PHONY: quality style
+
+quality:
+	black --check .
+	ruff .
+	mypy .
+
+style:
+	black .
+	ruff . --fix

app.py

@@ -0,0 +1,53 @@
+#!/usr/bin/env python
+
+import json
+import pathlib
+import tempfile
+
+import gradio as gr
+from gradio_client import Client
+
+
+client = Client("runwayml/stable-diffusion-v1-5")
+
+
+def generate(prompt: str) -> tuple[str, list[str]]:
+    negative_prompt = ""
+    guidance_scale = 9.0
+    out_dir = client.predict(prompt, fn_index=1)
+
+    config = {
+        "prompt": prompt,
+        "negative_prompt": negative_prompt,
+        "guidance_scale": guidance_scale,
+    }
+    with tempfile.NamedTemporaryFile(mode="w", suffix=".json", delete=False) as config_file:
+        json.dump(config, config_file)
+
+    with (pathlib.Path(out_dir) / "captions.json").open() as f:
+        paths = list(json.load(f).keys())
+    return paths
+
+
+with gr.Blocks(css="style.css") as demo:
+    with gr.Group():
+        prompt = gr.Text(show_label=False, placeholder="Prompt")
+        gallery = gr.Gallery(
+            show_label=False,
+            columns=2,
+            rows=2,
+            height="600px",
+            object_fit="scale-down",
+        )
+
+    prompt.submit(
+        fn=generate,
+        inputs=prompt,
+        outputs=gallery,
+    )
+
+    with gr.Tab("Past generations"):
+        gr.Markdown("building...")
+
+if __name__ == "__main__":
+    demo.launch()

gallery_history.py

@@ -0,0 +1,122 @@
+"""
+How to use:
+1. Create a Space with a Persistent Storage attached. Filesystem will be available under `/data`.
+2. Add `hf_oauth: true` to the Space metadata (README.md). Make sure to have Gradio>=3.41.0 configured.
+3. Add `HISTORY_FOLDER` as a Space variable (example. `"/data/history"`).
+4. Add `filelock` as dependency in `requirements.txt`.
+5. Add history gallery to your Gradio app:
+    a. Add imports: `from gallery_history import fetch_gallery_history, show_gallery_history`
+    a. Add `history = show_gallery_history()` within `gr.Blocks` context.
+    b. Add `.then(fn=fetch_gallery_history, inputs=[prompt, result], outputs=history)` on the generate event.
+"""
+import json
+import os
+import shutil
+from pathlib import Path
+from typing import Dict, List, Optional, Tuple
+from uuid import uuid4
+
+import gradio as gr
+from filelock import FileLock
+
+
+_folder = os.environ.get("HISTORY_FOLDER")
+if _folder is None:
+    print(
+        "'HISTORY_FOLDER' environment variable not set. User history will be saved "
+        "locally and will be lost when the Space instance is restarted."
+    )
+    _folder = Path(__file__).parent / "history"
+HISTORY_FOLDER_PATH = Path(_folder)
+
+IMAGES_FOLDER_PATH = HISTORY_FOLDER_PATH / "images"
+IMAGES_FOLDER_PATH.mkdir(parents=True, exist_ok=True)
+
+
+def show_gallery_history():
+    gr.Markdown(
+        "## Your past generations\n\n(Log in to keep a gallery of your previous generations."
+        " Your history will be saved and available on your next visit.)"
+    )
+    with gr.Column():
+        with gr.Row():
+            gr.LoginButton(min_width=250)
+            gr.LogoutButton(min_width=250)
+        gallery = gr.Gallery(
+            label="Past images",
+            show_label=True,
+            elem_id="gallery",
+            object_fit="contain",
+            columns=3,
+            height=300,
+            preview=False,
+            show_share_button=False,
+            show_download_button=False,
+        )
+        gr.Markdown("Make sure to save your images from time to time, this gallery may be deleted in the future.")
+        gallery.attach_load_event(fetch_gallery_history, every=None)
+        return gallery
+
+
+def fetch_gallery_history(
+    prompt: Optional[str] = None,
+    result: Optional[Dict] = None,
+    user: Optional[gr.OAuthProfile] = None,
+):
+    if user is None:
+        return []
+    try:
+        if prompt is not None and result is not None:  # None values means no new images
+            return _update_user_history(user["preferred_username"], [(item["name"], prompt) for item in result])
+        else:
+            return _read_user_history(user["preferred_username"])
+    except Exception as e:
+        raise gr.Error(f"Error while fetching history: {e}") from e
+
+
+####################
+# Internal helpers #
+####################
+
+
+def _read_user_history(username: str) -> List[Tuple[str, str]]:
+    """Return saved history for that user."""
+    with _user_lock(username):
+        path = _user_history_path(username)
+        if path.exists():
+            return json.loads(path.read_text())
+        return []  # No history yet
+
+
+def _update_user_history(username: str, new_images: List[Tuple[str, str]]) -> List[Tuple[str, str]]:
+    """Update history for that user and return it."""
+    with _user_lock(username):
+        # Read existing
+        path = _user_history_path(username)
+        if path.exists():
+            images = json.loads(path.read_text())
+        else:
+            images = []  # No history yet
+
+        # Copy images to persistent folder
+        images = [(_copy_image(src_path), prompt) for src_path, prompt in new_images] + images
+
+        # Save and return
+        path.write_text(json.dumps(images))
+        return images
+
+
+def _user_history_path(username: str) -> Path:
+    return HISTORY_FOLDER_PATH / f"{username}.json"
+
+
+def _user_lock(username: str) -> FileLock:
+    """Ensure history is not corrupted if concurrent calls."""
+    return FileLock(f"{_user_history_path(username)}.lock")
+
+
+def _copy_image(src: str) -> str:
+    """Copy image to the persistent storage."""
+    dst = IMAGES_FOLDER_PATH / f"{uuid4().hex}_{Path(src).name}"  # keep file ext
+    shutil.copyfile(src, dst)
+    return str(dst)

pyproject.toml

@@ -0,0 +1,19 @@
+[tool.black]
+line-length = 119
+target_version = ['py37', 'py38', 'py39', 'py310']
+preview = true
+
+[tool.mypy]
+ignore_missing_imports = true
+no_implicit_optional = true
+scripts_are_modules = true
+
+[tool.ruff]
+# Ignored rules:
+#   "E501" -> line length violation
+ignore = ["E501"]
+select = ["E", "F", "I", "W"]
+line-length = 119
+
+[tool.ruff.isort]
+lines-after-imports = 2

requirements.txt

@@ -0,0 +1,7 @@
+gradio>=3.44
+huggingface_hub>=0.17
+
+# dev-deps
+ruff
+black
+mypy

setup.cfg

@@ -0,0 +1,16 @@
+[isort]
+default_section = FIRSTPARTY
+ensure_newline_before_comments = True
+force_grid_wrap = 0
+include_trailing_comma = True
+known_third_party = gradio
+
+line_length = 119
+lines_after_imports = 2
+multi_line_output = 3
+use_parentheses = True
+
+[flake8]
+exclude = .git,__pycache__,old,build,dist,.venv*
+ignore = B028, E203, E501, E741, W503
+max-line-length = 119