För att kunna komma åt GIMP-funktioner startar vi med import gi. Denna modul kan avgöra vilka funktioner som är tillgängliga i varje modul som definieras genom ”objektintrospektion”. Vad detta betyder för oss är att vi importerar alla GIMP-relaterade moduler som vi kan behöva genom anrop till gi.repository.

För grundläggande funktionalitet kan modulerna Gimp och GimpUi vara tillräckligt. Om du vill köra din insticksmodul från kommandoraden behöver du inte ens GimpUi. Låt oss börja med ett exempel.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
#   GIMP - The GNU Image Manipulation Program
#   Copyright (C) 1995 Spencer Kimball and Peter Mattis
#
#   gimp-tutorial-plug-in.py
#   sample plug-in to illustrate the Python plug-in writing tutorial
#   Copyright (C) 2023 Jacob Boerema
#
#   This program is free software: you can redistribute it and/or modify
#   it under the terms of the GNU General Public License as published by
#   the Free Software Foundation; either version 3 of the License, or
#   (at your option) any later version.
#
#   This program is distributed in the hope that it will be useful,
#   but WITHOUT ANY WARRANTY; without even the implied warranty of
#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#   GNU General Public License for more details.
#
#   You should have received a copy of the GNU General Public License
#   along with this program.  If not, see <https://www.gnu.org/licenses/>.

import sys

import gi
gi.require_version('Gimp', '3.0')
from gi.repository import Gimp
gi.require_version('GimpUi', '3.0')
from gi.repository import GimpUi
from gi.repository import GLib
      

Vi börjar med att importera sys, vilket vi behöver i slutet för åtkomst till sys.argv, efter det säger import gi till Python att det behöver läsa in modulen gi. Denna modul används för att aktivera åtkomst till GIMP-specifika funktioner genom ”objektintrospektion”.

På nästa rad säger vi till gi att vi kräver att GIMPs API-version ska vara version 3.0. (Denna insticksmodul kommer inte fungera med äldre versioner av GIMP.) Raden efter begär att importera all funktioner, klasser och så vidare från modulen Gimp.

De följande två raderna gör samma sak för GimpUi. GimpUi innehåller alla gränssnittsrelaterade element för GIMP. Om du planerar att göra en insticksmodul som endast kommer anropas från kommandoraden så behöver du inte detta. Vi avslutar med att importera GLib vilket vi kommer behöva senare för åtkomst till GLib.Error.

Det finns andra valfria moduler som du också kan använda, såsom Gegl och många andra, men vi kommer inte gå in på det här.

GIMP behöver veta vilka funktioner som finns tillgängliga, vilken funktionalitet de stöder, och vilken menyplats att använda. För det definierar vi en klass som härleds från klassen Gimp.PlugIn.

En minimal insticksmodul behöver att åtminstone följande funktioner är definierade i denna klass:

Vi kommer nu gå in i lite djupare detalj. Vad som inte visas nedan är den första delen av Python-koden som visades ovan. Detta visar endast den grundläggande layouten för din klass.

class MyFirstPlugin (Gimp.PlugIn):
    def do_query_procedures(self):
        return [ "jb-plug-in-first-try" ]

    def do_set_i18n (self, name):
        return False

    def do_create_procedure(self, name):
        procedure = Gimp.ImageProcedure.new(self, name,
                                            Gimp.PDBProcType.PLUGIN,
                                            self.run, None)

        procedure.set_image_types("*")

        procedure.set_menu_label("My first Python plug-in")
        procedure.add_menu_path('<Image>/Filters/Tutorial/')

        procedure.set_documentation("My first Python plug-in tryout",
                                    "My first Python 3 plug-in for GIMP 3",
                                    name)
        procedure.set_attribution("Your name", "Your name", "2023")

        return procedure

    def run(self, procedure, run_mode, image, drawables, config, run_data):
        Gimp.message("Hello world!")
        # do what you want to do, then, in case of success, return:
        return procedure.new_return_values(Gimp.PDBStatusType.SUCCESS, GLib.Error())
      

Låt oss ta en närmare titt på do_create_procedures. På raden return [ "jb-plug-in-first-try" ] säger vi till GIMP vad namnet på vår procedur är: vi kallar den "jb-plug-in-first-try". Detta är namnet som kommer visas i GIMPs procedurbläddrare.

Du kan ha mer än en procedur definierad i en insticksmodul. I det fallet skulle du lista alla namn, separerade av ett kommatecken.

Det är god sed att börja alla dina procedurer med dina initialer eller någon annan igenkännbar och unik tagg. På detta sätt är det mindre troligt att ditt namn kommer vara detsamma som någon annans insticksmodul, vilket kan förvirra GIMP. Förutom det är du fri att kalla den vad du vill.

Härnäst säger vi till GIMP att vi inte stöder översättningar genom att returnera False i anropen till do_set_i18n. Vad du ska göra när du vill att din insticksmodul ska översättas är utanför omfånget av denna handledning.

Metoden do_create_procedure är var det mesta initierandet för GIMP görs.

Varje insticksmodul startas av ett anrop till Gimp.main.

        Gimp.main(MyFirstPlugin.__gtype__, sys.argv)
      

Det enda du behöver ändra i denna rad för din insticksmodul är namnet på insticksmodulens klass, här kallad ”MyFirstPlugin”.

Nedan presenterar vi hela Python-skriptet, vilket bör köra, förutsatt att det ges rätt namn i en katalog med samma namn på en plats som GIMP känner till. Det kommer visa meddelandet ”Hello world!” i felkonsolen eller i en poppuppdialog.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
#   GIMP - The GNU Image Manipulation Program
#   Copyright (C) 1995 Spencer Kimball and Peter Mattis
#
#   gimp-tutorial-plug-in.py
#   sample plug-in to illustrate the Python plug-in writing tutorial
#   Copyright (C) 2023 Jacob Boerema
#
#   This program is free software: you can redistribute it and/or modify
#   it under the terms of the GNU General Public License as published by
#   the Free Software Foundation; either version 3 of the License, or
#   (at your option) any later version.
#
#   This program is distributed in the hope that it will be useful,
#   but WITHOUT ANY WARRANTY; without even the implied warranty of
#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#   GNU General Public License for more details.
#
#   You should have received a copy of the GNU General Public License
#   along with this program.  If not, see <https://www.gnu.org/licenses/>.

import sys

import gi
gi.require_version('Gimp', '3.0')
from gi.repository import Gimp
gi.require_version('GimpUi', '3.0')
from gi.repository import GimpUi

from gi.repository import GLib

class MyFirstPlugin (Gimp.PlugIn):
    def do_query_procedures(self):
        return [ "jb-plug-in-first-try" ]

    def do_set_i18n (self, name):
        return False

    def do_create_procedure(self, name):
        procedure = Gimp.ImageProcedure.new(self, name,
                                            Gimp.PDBProcType.PLUGIN,
                                            self.run, None)

        procedure.set_image_types("*")

        procedure.set_menu_label("My first Python plug-in")
        procedure.add_menu_path('<Image>/Filters/Tutorial/')

        procedure.set_documentation("My first Python plug-in tryout",
                                    "My first Python 3 plug-in for GIMP 3.0",
                                    name)
        procedure.set_attribution("Your name", "Your name", "2023")

        return procedure

    def run(self, procedure, run_mode, image, drawables, config, run_data):
        Gimp.message("Hello world!")
        # do what you want to do, then, in case of success, return:
        return procedure.new_return_values(Gimp.PDBStatusType.SUCCESS, GLib.Error())

Gimp.main(MyFirstPlugin.__gtype__, sys.argv)