aboutsummaryrefslogtreecommitdiffstats
path: root/scripts/custom_code.py
blob: 6583d3b8f588f787500657739b21c7640c88e9ea (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
import modules.scripts as scripts
import gradio as gr

from modules.processing import Processed
from modules.shared import opts, cmd_opts, state

# An example custom script that allows you to make modifications to how the model object is handled. 
# These scripts appear in the lower-left dropdown menu on the txt2img and img2img tabs.
class Script(scripts.Script):

    # The title of the script. This is what will be displayed in the dropdown menu.
    def title(self):
        return "Custom code"


    # Determines when the script should be shown in the dropdown menu via the returned value. 
    # is_img2img is True if the current tab is img2img, and False if it is txt2img. Thus, return 
    # is_img2img to only show the script on the img2img tab.
    def show(self, is_img2img):
        return cmd_opts.allow_code


    # How the script's is displayed in the UI. See https://gradio.app/docs/#components 
    # for the different elements you can use and how to specify them. 
    # Each UI element can return a value, such as a boolean for a checkbox. 
    # The returned values are passed to the run method as parameters.
    def ui(self, is_img2img):
        code = gr.Textbox(label="Python code", visible=False, lines=1)

        return [code]


    # This is where the additional processing is implemented. The parameters include self, the 
    # model object (a StableDiffusionProcessing class, see processing.py), and the parameters 
    # returned by the ui method. 
    # Custom functions can be defined here, and additional libraries can be imported to be used 
    # in processing. The return value should be a Processed object, which is what is returned 
    # by the process_images method.
    def run(self, p, code):
        assert cmd_opts.allow_code, '--allow-code option must be enabled'

        display_result_data = [[], -1, ""]

        def display(imgs, s=display_result_data[1], i=display_result_data[2]):
            display_result_data[0] = imgs
            display_result_data[1] = s
            display_result_data[2] = i

        from types import ModuleType
        compiled = compile(code, '', 'exec')
        module = ModuleType("testmodule")
        module.__dict__.update(globals())
        module.p = p
        module.display = display
        exec(compiled, module.__dict__)

        return Processed(p, *display_result_data)