Skip to content

Python SDK Image Reference

upload (req, fileRoute, options)

Returns: Dictionary

Method used to upload image to the specified location on disk.

Parameters:


  • req

    The Python SDK contains 3 adapters (Django, Flask and Pyramid) and you can create your custom adapter by implementing BaseAdapter class:

    # Django adapter example.
    
    from froala_editor import BaseAdapter
    
    class DjangoAdapter(BaseAdapter):
    """
    Django Adapter: Check BaseAdapter to see what methods description.
    """
    
    def checkFile(self, fieldname):
      if fieldname not in self.request.FILES:
        raise Exception("File does not exist.")
    
    def getFilename(self, fieldname):
      self.checkFile(fieldname)
      return self.request.FILES[fieldname].name
    
    def getMimetype(self, fieldname):
      self.checkFile(fieldname)
      return self.request.FILES[fieldname].content_type
    
    def saveFile(self, fieldname, fullNamePath):
      self.checkFile(fieldname)
    
      with open(fullNamePath, 'wb+') as destination:
        for chunk in self.request.FILES[fieldname].chunks():
            destination.write(chunk)
    
    You should override all methods from BaseAdapter

    Type: Request Object that implements BaseAdapter interface.

  • fileRoute

    The server route where the image will be uploaded. This route must be public to be accessed by the editor.

    Type: String

  • options

    This parameter is optional. It can be used to pass custom options for the image upload.

    Type: Dictionary


options parameter:

  • fieldname

    The field name from the request object.

    Type:String
    Default:
    "file"
  • validation

    A dictionary or a function used to validate the uploaded image. The dictionary specifies the allowed image extensions through allowedExts and the allowed mime types through allowedMimeTypes. The function should be invoked with: filePath and mimetype.

    Type:Dictionary or Function
    Default:
    {
      'allowedExts': ['gif', 'jpeg', 'jpg', 'png', 'svg', 'blob'],
      'allowedMimeTypes': ['image/gif', 'image/jpeg', 'image/pjpeg', 'image/x-png', 'image/png', 'image/svg+xml']
    }
    
  • resize

    A string with custom options to scale the image. Available format is on Python Wand-Py library geometry. Example:

    '300x300'

    Type:String
    Default:
    NULL

Response

If the upload is completed successfully, the method returns a dictionary with the absolute path to the uploaded image. If an error occurs, the method throws an exception.

try:
  response = Image.upload(CustomAdapter(request), '/public/')
except Exception:
  response = {'error': str(sys.exc_info()[1])}
return HttpResponse(json.dumps(response), content_type="application/json")

delete (src)

Method used to delete an image from disk. Throws an exception if an error occurs.

Parameters:


  • src

    The image path available in the body of the request under src key.

    Type: String

list (folderPath, thumbPath)

Returns: Array of dictionaries

Method used to list all images from disk.

Parameters:


  • folderPath

    The path of the folder from where the images are being loaded is relative to the root of your application.

    Type: String

  • thumbPath

    This parameter is optional. The path of the folder from where the image thumbs are being loaded is relative to the root of your application.

    Type: String

Response

If the load is completed successfully, the method returns an array with dictionaries containing the image url, thumb and name. If an error occurs, the method throws an exception.

try:
  response = Image.list('/public/')
except Exception:
  response = {'error': str(sys.exc_info()[1])}