Да бисмо могли да приступимо Гимповим функцијама, почињемо са import gi. Овај модул може да сазна које су функције доступне у сваком модулу дефинисаном путем „интроспекције објеката“. За нас то значи да увозимо све модуле повезане са Гимпом који нам могу затребати путем позива gi.repository.

За основну функционалност могу бити довољни само модули Gimp и GimpUi. Ако желите да покренете свој прикључак из линије наредби, GimpUi вам чак није ни потребан. Почнимо са примером.

#!/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
      

Почињемо увозом модула sys, који нам је потребан на крају за приступ sys.argv, након чега import gi говори Пајтону да треба да учита модул gi. Овај модул се користи да омогући приступ специфичним Гимповим функцијама путем „интроспекције објеката“.

У следећој линији говоримо модулу gi да захтевамо да верзија Гимповог АПИ-ја буде 3.0. (Овај прикључак неће радити са старијим верзијама Гимпа.) Следећа линија захтева увоз свих функција, класа итд. из модула Gimp.

Следећа два реда раде исту ствар за GimpUi. GimpUi садржи све елементе везане за корисничко сучеље за ГИМП. Ако планирате да направите прикључак који ће се позивати само са линије наредби, онда вам ово неће требати. Завршавамо са увозом GLib-а, који ће нам касније требати за приступ GLib.Error-у.

Постоје и други опциони модули које такође можете користити, као што је Gegl и многи други, али овде нећемо улазити у то.

ГИМП треба да зна које су функције доступне, коју функционалност подржавају и коју локацију менија да користе. За то дефинишемо класу која је изведена из класе Gimp.PlugIn.

Минимални прикључак мора имати барем следеће функције дефинисане у овој класи:

Сада ћемо ући у мало више детаља. Испод није укључен први део Пајтон кода који је приказан изнад. Ово приказује само основни распоред ваше класе.

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())
      

Погледајмо изблиза do_query_procedures. У реду return [ "jb-plug-in-first-try" ] говоримо ГИМП-у који је назив наше процедуре: зовемо је „jb-plug-in-first-try“. Ово је назив који ће бити приказан у ГИМП-овом Прегледнику процедура.

У прикључку можете имати дефинисано више од једне процедуре. У том случају бисте навели све називе, раздвојене зарезом.

Добра је пракса да све своје процедуре започнете својим иницијалима или неком другом препознатљивом и јединственом ознаком. На тај начин је мање вероватно да ће ваш назив бити исти као нечији туђи прикључак, што може збунити ГИМП. Осим тога, слободни сте да га назовете како желите.

Затим говоримо ГИМП-у да не подржавамо преводе враћањем False у позиву do_set_i18n. Шта треба да урадите када желите да ваш прикључак буде преведен је изван оквира овог упутства.

Метод do_create_procedure је место где се врши већина иницијализације за ГИМП.

Сваки прикључак се покреће позивом Gimp.main.

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

Једина ствар коју треба да промените у овој линији за ваш прикључак је назив класе вашег прикључка, овде назване „MyFirstPlugin“.

Испод представљамо целу пајтон скрипту, која би требало да ради, под условом да јој је дат исправан назив у директоријуму са истим називом на месту које Гимп познаје. Приказаће поруку „Hello world!“ у конзоли за грешке или у искачућем прозорчету.

#!/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)