class_docstr: Creates an image component that can be used to upload and edit images (as an input) or display images (as an output).
  Preprocessing: passes the uploaded images as a dictionary with keys: `background`, `layers`, and `composite`. The values corresponding to `background` and `composite` are images, while `layers` is a list of images. The images are of type PIL.Image, np.array, or str filepath, depending on the `type` parameter.
  Postprocessing: expects a dictionary with keys: `background`, `layers`, and `composite`. The values corresponding to `background` and `composite` should be images or None, while `layers` should be a list of images. Images can be of type PIL.Image, np.array, or str filepath/URL. Or, the value can be simply a single image, in which case it will be used as the background.
  Examples-format: a dictionary with keys: `background`, `layers`, and `composite`. The values corresponding to `background` and `composite` should be strings or None, while `layers` should be a list of strings. The image corresponding to `composite`, if not None, is used as the example image. Otherwise, the image corresonding to `background` is used. The strings should be filepaths or URLs. Or, the value can be simply a single string filepath/URL to an image, which is used directly as the example image.
  Demos: image_editor
class_docstr_tok: ["Creates","an","image","component","that","can","be","used","to","upload","and","edit","images","(","as","an","input",")","or","display","images","(","as","an","output",")",".","Preprocessing",":","passes","the","uploaded","images","as","a","dictionary","with","keys",":","`","background","`",",","`","layers","`",",","and","`","composite","`",".","The","values","corresponding","to","`","background","`","and","`","composite","`","are","images",",","while","`","layers","`","is","a","list","of","images",".","The","images","are","of","type","PIL.Image",",","np.array",",","or","str","filepath",",","depending","on","the","`","type","`","parameter",".","Postprocessing",":","expects","a","dictionary","with","keys",":","`","background","`",",","`","layers","`",",","and","`","composite","`",".","The","values","corresponding","to","`","background","`","and","`","composite","`","should","be","images","or","None",",","while","`","layers","`","should","be","a","list","of","images",".","Images","can","be","of","type","PIL.Image",",","np.array",",","or","str","filepath\/URL",".","Or",",","the","value","can","be","simply","a","single","image",",","in","which","case","it","will","be","used","as","the","background",".","Examples-format",":","a","dictionary","with","keys",":","`","background","`",",","`","layers","`",",","and","`","composite","`",".","The","values","corresponding","to","`","background","`","and","`","composite","`","should","be","strings","or","None",",","while","`","layers","`","should","be","a","list","of","strings",".","The","image","corresponding","to","`","composite","`",",","if","not","None",",","is","used","as","the","example","image",".","Otherwise",",","the","image","corresonding","to","`","background","`","is","used",".","The","strings","should","be","filepaths","or","URLs",".","Or",",","the","value","can","be","simply","a","single","string","filepath\/URL","to","an","image",",","which","is","used","directly","as","the","example","image",".","Demos",":","image_editor"]
docstr: Parameters:
      value: Optional initial image(s) to populate the image editor. Should be a dictionary with keys: `background`, `layers`, and `composite`. The values corresponding to `background` and `composite` should be images or None, while `layers` should be a list of images. Images can be of type PIL.Image, np.array, or str filepath/URL. Or, the value can be a callable, in which case the function will be called whenever the app loads to set the initial value of the component.
      height: The height of the displayed images, specified in pixels if a number is passed, or in CSS units if a string is passed.
      width: The width of the displayed images, specified in pixels if a number is passed, or in CSS units if a string is passed.
      image_mode: "RGB" if color, or "L" if black and white. See https://pillow.readthedocs.io/en/stable/handbook/concepts.html for other supported image modes and their meaning.
      sources: List of sources that can be used to set the background image. "upload" creates a box where user can drop an image file, "webcam" allows user to take snapshot from their webcam, "clipboard" allows users to paste an image from the clipboard.
      type: The format the images are converted to before being passed into the prediction function. "numpy" converts the images to numpy arrays with shape (height, width, 3) and values from 0 to 255, "pil" converts the images to PIL image objects, "filepath" passes images as str filepaths to temporary copies of the images.
      label: The label for this component. Appears above the component and is also used as the header if there are a table of examples for this component. If None and used in a `gr.Interface`, the label will be the name of the parameter this component is assigned to.
      every: If `value` is a callable, run the function 'every' number of seconds while the client connection is open. Has no effect otherwise. Queue must be enabled. The event can be accessed (e.g. to cancel it) via this component's .load_event attribute.
      show_label: if True, will display label.
      show_download_button: If True, will display button to download image.
      container: If True, will place the component in a container - providing some extra padding around the border.
      scale: relative width compared to adjacent Components in a Row. For example, if Component A has scale=2, and Component B has scale=1, A will be twice as wide as B. Should be an integer.
      min_width: minimum pixel width, will wrap if not sufficient screen space to satisfy this value. If a certain scale value results in this Component being narrower than min_width, the min_width parameter will be respected first.
      interactive: if True, will allow users to upload and edit an image; if False, can only be used to display images. If not provided, this is inferred based on whether the component is used as an input or output.
      visible: If False, component will be hidden.
      elem_id: An optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles.
      elem_classes: An optional list of strings that are assigned as the classes of this component in the HTML DOM. Can be used for targeting CSS styles.
      render: If False, component will not render be rendered in the Blocks context. Should be used if the intention is to assign event listeners now but render the component later.
      mirror_webcam: If True webcam will be mirrored. Default is True.
      show_share_button: If True, will show a share icon in the corner of the component that allows user to share outputs to Hugging Face Spaces Discussions. If False, icon does not appear. If set to None (default behavior), then the icon appears if this Gradio app is launched on Spaces, but not otherwise.
      crop_size: The size of the crop box in pixels. If a tuple, the first value is the width and the second value is the height. If a string, the value must be a ratio in the form `width:height` (e.g. "16:9").
      transforms: The transforms tools to make available to users. "crop" allows the user to crop the image.
      eraser: The options for the eraser tool in the image editor. Should be an instance of the `gr.Eraser` class, or None to use the default settings. Can also be False to hide the eraser tool.
      brush: The options for the brush tool in the image editor. Should be an instance of the `gr.Brush` class, or None to use the default settings. Can also be False to hide the brush tool, which will also hide the eraser tool.
docstr_tok: ["Parameters",":","value",":","Optional","initial","image","(","s",")","to","populate","the","image","editor",".","Should","be","a","dictionary","with","keys",":","`","background","`",",","`","layers","`",",","and","`","composite","`",".","The","values","corresponding","to","`","background","`","and","`","composite","`","should","be","images","or","None",",","while","`","layers","`","should","be","a","list","of","images",".","Images","can","be","of","type","PIL.Image",",","np.array",",","or","str","filepath\/URL",".","Or",",","the","value","can","be","a","callable",",","in","which","case","the","function","will","be","called","whenever","the","app","loads","to","set","the","initial","value","of","the","component",".","height",":","The","height","of","the","displayed","images",",","specified","in","pixels","if","a","number","is","passed",",","or","in","CSS","units","if","a","string","is","passed",".","width",":","The","width","of","the","displayed","images",",","specified","in","pixels","if","a","number","is","passed",",","or","in","CSS","units","if","a","string","is","passed",".","image_mode",":","``","RGB","''","if","color",",","or","``","L","''","if","black","and","white",".","See","https",":","\/\/pillow.readthedocs.io\/en\/stable\/handbook\/concepts.html","for","other","supported","image","modes","and","their","meaning",".","sources",":","List","of","sources","that","can","be","used","to","set","the","background","image",".","``","upload","''","creates","a","box","where","user","can","drop","an","image","file",",","``","webcam","''","allows","user","to","take","snapshot","from","their","webcam",",","``","clipboard","''","allows","users","to","paste","an","image","from","the","clipboard",".","type",":","The","format","the","images","are","converted","to","before","being","passed","into","the","prediction","function",".","``","numpy","''","converts","the","images","to","numpy","arrays","with","shape","(","height",",","width",",","3",")","and","values","from","0","to","255",",","``","pil","''","converts","the","images","to","PIL","image","objects",",","``","filepath","''","passes","images","as","str","filepaths","to","temporary","copies","of","the","images",".","label",":","The","label","for","this","component",".","Appears","above","the","component","and","is","also","used","as","the","header","if","there","are","a","table","of","examples","for","this","component",".","If","None","and","used","in","a","`","gr.Interface","`",",","the","label","will","be","the","name","of","the","parameter","this","component","is","assigned","to",".","every",":","If","`","value","`","is","a","callable",",","run","the","function","'every","'","number","of","seconds","while","the","client","connection","is","open",".","Has","no","effect","otherwise",".","Queue","must","be","enabled",".","The","event","can","be","accessed","(","e.g",".","to","cancel","it",")","via","this","component","'s",".load_event","attribute",".","show_label",":","if","True",",","will","display","label",".","show_download_button",":","If","True",",","will","display","button","to","download","image",".","container",":","If","True",",","will","place","the","component","in","a","container","-","providing","some","extra","padding","around","the","border",".","scale",":","relative","width","compared","to","adjacent","Components","in","a","Row",".","For","example",",","if","Component","A","has","scale=2",",","and","Component","B","has","scale=1",",","A","will","be","twice","as","wide","as","B",".","Should","be","an","integer",".","min_width",":","minimum","pixel","width",",","will","wrap","if","not","sufficient","screen","space","to","satisfy","this","value",".","If","a","certain","scale","value","results","in","this","Component","being","narrower","than","min_width",",","the","min_width","parameter","will","be","respected","first",".","interactive",":","if","True",",","will","allow","users","to","upload","and","edit","an","image",";","if","False",",","can","only","be","used","to","display","images",".","If","not","provided",",","this","is","inferred","based","on","whether","the","component","is","used","as","an","input","or","output",".","visible",":","If","False",",","component","will","be","hidden",".","elem_id",":","An","optional","string","that","is","assigned","as","the","id","of","this","component","in","the","HTML","DOM",".","Can","be","used","for","targeting","CSS","styles",".","elem_classes",":","An","optional","list","of","strings","that","are","assigned","as","the","classes","of","this","component","in","the","HTML","DOM",".","Can","be","used","for","targeting","CSS","styles",".","render",":","If","False",",","component","will","not","render","be","rendered","in","the","Blocks","context",".","Should","be","used","if","the","intention","is","to","assign","event","listeners","now","but","render","the","component","later",".","mirror_webcam",":","If","True","webcam","will","be","mirrored",".","Default","is","True",".","show_share_button",":","If","True",",","will","show","a","share","icon","in","the","corner","of","the","component","that","allows","user","to","share","outputs","to","Hugging","Face","Spaces","Discussions",".","If","False",",","icon","does","not","appear",".","If","set","to","None","(","default","behavior",")",",","then","the","icon","appears","if","this","Gradio","app","is","launched","on","Spaces",",","but","not","otherwise",".","crop_size",":","The","size","of","the","crop","box","in","pixels",".","If","a","tuple",",","the","first","value","is","the","width","and","the","second","value","is","the","height",".","If","a","string",",","the","value","must","be","a","ratio","in","the","form","`","width",":","height","`","(","e.g",".","``","16:9","''",")",".","transforms",":","The","transforms","tools","to","make","available","to","users",".","``","crop","''","allows","the","user","to","crop","the","image",".","eraser",":","The","options","for","the","eraser","tool","in","the","image","editor",".","Should","be","an","instance","of","the","`","gr.Eraser","`","class",",","or","None","to","use","the","default","settings",".","Can","also","be","False","to","hide","the","eraser","tool",".","brush",":","The","options","for","the","brush","tool","in","the","image","editor",".","Should","be","an","instance","of","the","`","gr.Brush","`","class",",","or","None","to","use","the","default","settings",".","Can","also","be","False","to","hide","the","brush","tool",",","which","will","also","hide","the","eraser","tool","."]
code: def __init__(
      self,
      value: EditorValue | ImageType | None = None,
      *,
      height: int | str | None = None,
      width: int | str | None = None,
      image_mode: Literal[
          "1",
          "L",
          "P",
          "RGB",
          "RGBA",
          "CMYK",
          "YCbCr",
          "LAB",
          "HSV",
          "I",
          "F",
      ] = "RGBA",
      sources: Iterable[Literal["upload", "webcam", "clipboard"]] = (
          "upload",
          "webcam",
          "clipboard",
      ),
      type: Literal["numpy", "pil", "filepath"] = "numpy",
      label: str | None = None,
      every: float | None = None,
      show_label: bool | None = None,
      show_download_button: bool = True,
      container: bool = True,
      scale: int | None = None,
      min_width: int = 160,
      interactive: bool | None = None,
      visible: bool = True,
      elem_id: str | None = None,
      elem_classes: list[str] | str | None = None,
      render: bool = True,
      mirror_webcam: bool = True,
      show_share_button: bool | None = None,
      _selectable: bool = False,
      crop_size: tuple[int | float, int | float] | str | None = None,
      transforms: Iterable[Literal["crop"]] = ("crop",),
      eraser: Eraser | None | Literal[False] = None,
      brush: Brush | None | Literal[False] = None,
  ):
      """
      Parameters:
          value: Optional initial image(s) to populate the image editor. Should be a dictionary with keys: `background`, `layers`, and `composite`. The values corresponding to `background` and `composite` should be images or None, while `layers` should be a list of images. Images can be of type PIL.Image, np.array, or str filepath/URL. Or, the value can be a callable, in which case the function will be called whenever the app loads to set the initial value of the component.
          height: The height of the displayed images, specified in pixels if a number is passed, or in CSS units if a string is passed.
          width: The width of the displayed images, specified in pixels if a number is passed, or in CSS units if a string is passed.
          image_mode: "RGB" if color, or "L" if black and white. See https://pillow.readthedocs.io/en/stable/handbook/concepts.html for other supported image modes and their meaning.
          sources: List of sources that can be used to set the background image. "upload" creates a box where user can drop an image file, "webcam" allows user to take snapshot from their webcam, "clipboard" allows users to paste an image from the clipboard.
          type: The format the images are converted to before being passed into the prediction function. "numpy" converts the images to numpy arrays with shape (height, width, 3) and values from 0 to 255, "pil" converts the images to PIL image objects, "filepath" passes images as str filepaths to temporary copies of the images.
          label: The label for this component. Appears above the component and is also used as the header if there are a table of examples for this component. If None and used in a `gr.Interface`, the label will be the name of the parameter this component is assigned to.
          every: If `value` is a callable, run the function 'every' number of seconds while the client connection is open. Has no effect otherwise. Queue must be enabled. The event can be accessed (e.g. to cancel it) via this component's .load_event attribute.
          show_label: if True, will display label.
          show_download_button: If True, will display button to download image.
          container: If True, will place the component in a container - providing some extra padding around the border.
          scale: relative width compared to adjacent Components in a Row. For example, if Component A has scale=2, and Component B has scale=1, A will be twice as wide as B. Should be an integer.
          min_width: minimum pixel width, will wrap if not sufficient screen space to satisfy this value. If a certain scale value results in this Component being narrower than min_width, the min_width parameter will be respected first.
          interactive: if True, will allow users to upload and edit an image; if False, can only be used to display images. If not provided, this is inferred based on whether the component is used as an input or output.
          visible: If False, component will be hidden.
          elem_id: An optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles.
          elem_classes: An optional list of strings that are assigned as the classes of this component in the HTML DOM. Can be used for targeting CSS styles.
          render: If False, component will not render be rendered in the Blocks context. Should be used if the intention is to assign event listeners now but render the component later.
          mirror_webcam: If True webcam will be mirrored. Default is True.
          show_share_button: If True, will show a share icon in the corner of the component that allows user to share outputs to Hugging Face Spaces Discussions. If False, icon does not appear. If set to None (default behavior), then the icon appears if this Gradio app is launched on Spaces, but not otherwise.
          crop_size: The size of the crop box in pixels. If a tuple, the first value is the width and the second value is the height. If a string, the value must be a ratio in the form `width:height` (e.g. "16:9").
          transforms: The transforms tools to make available to users. "crop" allows the user to crop the image.
          eraser: The options for the eraser tool in the image editor. Should be an instance of the `gr.Eraser` class, or None to use the default settings. Can also be False to hide the eraser tool.
          brush: The options for the brush tool in the image editor. Should be an instance of the `gr.Brush` class, or None to use the default settings. Can also be False to hide the brush tool, which will also hide the eraser tool.
      """
      self._selectable = _selectable
      self.mirror_webcam = mirror_webcam
      valid_types = ["numpy", "pil", "filepath"]
      if type not in valid_types:
          raise ValueError(
              f"Invalid value for parameter `type`: {type}. Please choose from one of: {valid_types}"
          )
      self.type = type
      self.height = height
      self.width = width
      self.image_mode = image_mode
      valid_sources = ["upload", "webcam", "clipboard"]
      if isinstance(sources, str):
          sources = [sources]  # type: ignore
      for source in sources:
          if source not in valid_sources:
              raise ValueError(
                  f"`sources` must be a list consisting of elements in {valid_sources}"
              )
      self.sources = sources
  
      self.show_download_button = show_download_button
  
      self.show_share_button = (
          (utils.get_space() is not None)
          if show_share_button is None
          else show_share_button
      )
  
      self.crop_size = crop_size
      self.transforms = transforms
      self.eraser = Eraser() if eraser is None else eraser
      self.brush = Brush() if brush is None else brush
  
      super().__init__(
          label=label,
          every=every,
          show_label=show_label,
          container=container,
          scale=scale,
          min_width=min_width,
          interactive=interactive,
          visible=visible,
          elem_id=elem_id,
          elem_classes=elem_classes,
          render=render,
          value=value,
      )
  
imports: from __future__ import annotations
  import dataclasses
  import warnings
  from pathlib import Path
  from typing import Any, Iterable, List, Literal, Optional, TypedDict, Union, cast
  import numpy
  from gradio_client.documentation import document, set_documentation_group
  from PIL import Image
  import gradio.image_utils
  from gradio import utils
  from gradio.components.base import Component
  from gradio.data_classes import FileData, GradioModel
  from gradio.events import Events
label_desc: Use image node_id 1 to create a new ImageEditor object from inherited base classes: Component with example: obj = ImageEditor(value)