How to run python scripts using gimpfu from command line?

by

To run a python script you don’t need to have it register as a plugin. IMHO you should even avoid this, this unnecessarily pollutes Gimp’s menus and procedure name space. Here is an example:

The batch script (saved as batch.py):

#!/usr/bin/python
# -*- coding: iso-8859-15 -*-

import os, glob, sys, time
from gimpfu import *


def process(infile):
        print "Processing file %s " % infile
        image = pdb.gimp_file_load(infile, infile, run_mode=RUN_NONINTERACTIVE)
        drawable = image.active_layer

        print "File %s loaded OK" % infile
        pdb.plug_in_photocopy(image, drawable,8.,0.8,0.2,0.2)
        pdb.plug_in_cartoon(image, drawable, 7.,0.2)
        outfile=os.path.join('processed',os.path.basename(infile))
        outfile=os.path.join(os.path.dirname(infile),outfile)
        print "Saving to %s" % outfile
        pdb.file_jpeg_save(image, drawable, outfile, outfile, "0.5",0,1,0,"",0,1,0,0)
        print "Saved to %s" % outfile
        pdb.gimp_image_delete(image)


def run(directory):
        start=time.time()
        print "Running on directory \"%s\"" % directory
#   os.mkdir(os.path.join(directory,'processed'))
        for infile in glob.glob(os.path.join(directory, '*.jpg')):
                process(infile)
        end=time.time()
        print "Finished, total processing time: %.2f seconds" % (end-start)


if __name__ == "__main__":
        print "Running as __main__ with args: %s" % sys.argv

To call it:

gimp -idf --batch-interpreter python-fu-eval -b "import sys;sys.path=['.']+sys.path;import batch;batch.run('./images')" -b "pdb.gimp_quit(1)"

The parameters in slow-motion:

  • -idf: work without user interface, and load neither data nor fonts (you may perhaps need to keep the fonts to load pdfs)
  • --batch-interpreter python-fu-eval: whatever follows -b is Python, not script-fu
  • "import sys;sys.path=['.']+sys.path;import batch;batch.run('./images')": the code that we ask Gimp to execute, namely:
    • import sys;sys.path=['.']+sys.path;: extend the import path to include the current directory
    • import batch;: import the file with our script, which is now in a directory which is part of the path.
    • batch.run('./images'): call the run() function of the batch module we imported, giving it the name of a directory containing the images to process.
  • -b "pdb.gimp_quit(1)": another piece of python: exit when done.

Note how the command line cleverly uses double and single quotes to pass all parameters to Gimp and then to Python(*). And yes, you can use forward slashes as file separators in Windows.

To debug, matters are bit complicated in Windows because there is no always a stdout stream. Things that can help:

  • remove the -i parameter temporarily so that you get the UI and perhaps a chance to see messages.
  • Add --verbose which makes Gimp start a secondary console window.
  • There are other tricks to see messages listed here.
  • You can also start Gimp normally and run your script from the Python-fu console (Filters>Python-fu>Console). You will have to extend the path and import the file “manually”.

(*) In a Linux/OSX shell one would do the opposite: single quotes for the shell, double quotes for Python.

More Related Contents:

  1. Pygame window not responding after a few seconds
  2. pip install fails with “connection error: [SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed (_ssl.c:598)”
  3. Python rounding error with float numbers [duplicate]
  4. How do I keep Python print from adding newlines or spaces? [duplicate]
  5. subprocess wildcard usage
  6. socket.error: [Errno 10013] An attempt was made to access a socket in a way forbidden by its access permissions
  7. Pandas/Python: Set value of one column based on value in another column
  8. PyWin32 and Python 3.8.0
  9. Python float – str – float weirdness
  10. Changing iteration variable inside for loop in Python [duplicate]
  11. What do I do when I need a self referential dictionary?
  12. Use groupby in Pandas to count things in one column in comparison to another
  13. Python: list of lists
  14. In Python, what happens when you import inside of a function? [duplicate]
  15. Parsing datetime in Python..?
  16. scikit-learn GridSearchCV with multiple repetitions
  17. How can I use executemany to insert into MySQL a list of dictionaries in Python
  18. Installing MySQL-python
  19. Visual Studio Code – How to add multiple paths to python path?
  20. How to make a sunburst plot in R or Python?
  21. AttributeError: ‘list’ object has no attribute ‘click’ – Selenium Webdriver
  22. “TypeError: string indices must be integers” when getting data of a stock from Yahoo Finance using Pandas Datareader
  23. Build the full path filename in Python
  24. What is the difference between ‘content’ and ‘text’
  25. Python: Replace with regex
  26. Python Requests – SSL error for client side cert
  27. pandas to_sql all columns as nvarchar
  28. How does str.startswith really work?
  29. Best way to remove elements from a list
  30. ElementTree findall() returning empty list

Leave a Comment