Hi,
I went through code and made a working version. I believe there's no way to close the image with Python after saving it as a PNG.
I went through code and made a working version. I believe there's no way to close the image with Python after saving it as a PNG.
Code:
#!/usr/bin/env python3
import gi
import os
import sys
gi.require_version('Gimp', '3.0')
from gi.repository import Gio, Gimp, GLib # noqa
HARD_CODED_PATH = 'e:\\scans\\inpic\\puzzle\\done\\new'
def export_png_file(image, gio_file, properties):
"""
Export an image with a 'Gio.File' as a png file-type.
image: Gimp.Image
gio_file: Gio.File
properties: list
[(property str, property value)]
from Gimp's Python Procedure Browser
Properties (property str, property value):
('run-mode', Gimp.RunMode.NONINTERACTIVE)
('options', options)
('interlaced', interlaced)
('compression', compression)
('bkgd', bkgd)
('offs', offs)
('phys', phys)
('time', time)
('save-transparent', save_transparent)
('optimize-palette', optimize_palette)
('format', format)
('include-exif', include_exif)
('include-iptc', include_iptc)
('include-xmp', include_xmp)
('include-color-profile', include_color_profile)
('include-thumbnail', include_thumbnail)
('include-comment', include_comment)
Return:
Gimp.PDBStatusType
"""
procedure = Gimp.get_pdb().lookup_procedure('file-png-export')
config = procedure.create_config()
config.set_property('image', image)
config.set_property('file', gio_file)
for q in properties:
config.set_property(*q)
result = procedure.run(config)
return result.index(0)
def failed(procedure):
return procedure.new_return_values(
Gimp.PDBStatusType.CALLING_ERROR, GLib.Error()
)
class ExportPng(Gimp.PlugIn):
def do_query_procedures(self):
return ['python-fu-exportPng']
def do_create_procedure(self, name):
procedure = Gimp.ImageProcedure.new(
self, name, Gimp.PDBProcType.PLUGIN, self.run, None
)
procedure.set_image_types('*')
procedure.set_documentation(
'Saves file to e:/scans/inpic/puzzle/done/new/#.png\n'
'It then closes the image.',
)
procedure.set_menu_label('_ExportPngClose...')
procedure.add_menu_path('<Image>/File')
procedure.set_attribution('Leonard', 'Leonard', '2026')
return procedure
def run(self, procedure, run_mode, image, n_drawables, drawables, args):
"""
Commented-out but save for future use.
I find this easier to use than the console.
Pipe print statements to an error file.
import time
error_file = sys.stderr = sys.stdout = open("D:\\error.txt", 'a')
_start = f"\nExportPng, {time.ctime()}"
_end = "_" * (80 - len(_start))
print(f"{_start}{_end}")
"""
if image is None:
Gimp.message('This plug-in requires an opened image.')
return failed(procedure)
# Get the original image filename
image_file = image.get_file()
if image_file:
original_file_path = image_file.get_path()
else:
# Handle images that haven't been saved yet.
Gimp.message(
"Image has no filename.\n"
"Please save the original file first."
)
return failed(procedure)
# Use pathlib to easily handle path components.
original_path, file_name = os.path.split(original_file_path)
new_file_name = os.path.splitext(file_name)[0] + '.png'
full_export_path = os.path.join(HARD_CODED_PATH, new_file_name)
Gimp.message(f'full export path: {full_export_path}')
# file_png_save requires a Gio.File object for GIMP 3.x
gio_file = Gio.file_new_for_path(full_export_path)
Gimp.message('Export file initialized.')
# Export the visible image data.
result = export_png_file(
image,
gio_file,
[
('format', 'rgba8'),
('interlaced', False),
('save-transparent', True),
('time', False)
]
)
if result != Gimp.PDBStatusType.SUCCESS:
return failed(procedure)
Gimp.message('The png file was saved.')
# error_file.close() # Commented-out but save for future use.
return Gimp.ValueArray.new(
GLib.Value(Gimp.PDBStatusType.SUCCESS, None)
)
Gimp.main(ExportPng.__gtype__, sys.argv)