plugin_importer.plugin_importer_extension.PluginImporterExtension Class Reference

Inheritance diagram for plugin_importer.plugin_importer_extension.PluginImporterExtension:

Public Member Functions
	__init__ (self, parent)
	activate_plugins (self, plugins)
	confirm_activate (self, plugins)
	confirm_overwrite (self, plugin)
	createActions (self, window)
	display_errors (self, error)
	do_import (self, zipfile)
	get_resources_dir (self)
	import_plugin_from_file (self)
	import_plugin_from_web (self)
	setup (self)

Public Attributes
	import_plugin_from_file
	import_plugin_from_web
	parent

Detailed Description

Definition at line 23 of file plugin_importer_extension.py.

Constructor & Destructor Documentation

__init__()

plugin_importer.plugin_importer_extension.PluginImporterExtension.__init__	(		self,
			parent )

Definition at line 25 of file plugin_importer_extension.py.

    def __init__(self, parent):
        super().__init__(parent)
        self.parent = parent
 

References plugin_importer.plugin_importer_extension.PluginImporterExtension.__init__().

Member Function Documentation

activate_plugins()

plugin_importer.plugin_importer_extension.PluginImporterExtension.activate_plugins	(		self,
			plugins )

Definition at line 85 of file plugin_importer_extension.py.

    def activate_plugins(self, plugins):
        for plugin in plugins:
            Application.writeSetting(
                'python',
                'enable_%s' % plugin['name'],
                'true')
 

confirm_activate()

plugin_importer.plugin_importer_extension.PluginImporterExtension.confirm_activate	(		self,
			plugins )

Definition at line 53 of file plugin_importer_extension.py.

    def confirm_activate(self, plugins):
        txt = [
            '<p>',
            i18n('The following plugins were imported:'),
            '</p>',
            '<ul>'
        ]
        for plugin in plugins:
            txt.append('<li>%s</li>' % plugin['ui_name'])
 
        txt.append('</ul>')
        txt.append('<p><strong>')
        txt.append(i18n(
            'Enable plugins now? (Requires restart)'))
        txt.append('</strong></p>')
 
        reply = QMessageBox.question(
            self.parent.activeWindow().qwindow(),
            i18n('Activate Plugins?'),
            ('\n').join(txt),
            QMessageBox.StandardButton.Yes | QMessageBox.StandardButton.No)
        return reply == QMessageBox.StandardButton.Yes
 

References KoShape.parent(), KisNodeDummy.parent(), KUndo2Model.parent(), KoShape::Private.parent, KoToolProxyPrivate.parent, KisForestDetail::RootNodeImpl< Node< T > >.parent, KisForestDetail::RootNodeImpl< Node< T > >< T >.parent, KisForestDetail::RootNodeImpl< Node< T > >< KoSvgTextContentElement >.parent, KisForestDetail::RootNodeImpl< Base >.parent, KisForestDetail::RootNodeImpl< Node< T > >< FontFamilyNode >.parent, KisLayerUtils::RemoveNodeHelper::ReplacementNode.parent, KisNode.parent, KisPaintDevice::Private.parent, KisMementoItem.parent(), StoryboardChild.parent(), EnhancedPathParameter.parent(), KoPathPoint.parent(), KoRTree< KoShape * >::Node.parent(), KoRTree< T >::Node.parent(), KisNode.parent(), KisProjectionLeaf.parent(), KisForestDetail::ChildIterator< T, is_const >.parent, KoFileDialog.parent, KDEPrivate::ToolBarHandler::Private.parent, FontStyleModel.parent(), KoFontGlyphModel.parent(), KisFiltersModel.parent(), KoZoomAction.parent, KisKXMLGUI::ContainerNode.parent, KisAnimCurvesChannelsModel.parent(), KisUndoModel.parent(), FontAxesModel.parent(), KisNodeModel.parent(), StoryboardModel.parent(), OpenTypeFeatureModel.parent(), mikro.PyQtClass.parent(), ExrLayerInfoBase.parent, KDcrawIface::RExpanderBox.parent, channels2layers.channels2layers.ChannelsToLayers.parent, filtermanager.components.filtermanagertreeitem.FilterManagerTreeItem.parent(), plugin_importer.plugin_importer_extension.PluginImporterExtension.parent, scripter.ui_scripter.actions.closeaction.closeaction.CloseAction.parent(), scripter.ui_scripter.actions.debugaction.debugaction.DebugAction.parent(), scripter.ui_scripter.actions.newaction.newaction.NewAction.parent(), scripter.ui_scripter.actions.openaction.openaction.OpenAction.parent(), scripter.ui_scripter.actions.reloadaction.reloadaction.ReloadAction.parent(), scripter.ui_scripter.actions.runaction.runaction.RunAction.parent(), scripter.ui_scripter.actions.saveaction.saveaction.SaveAction.parent(), scripter.ui_scripter.actions.saveasaction.saveasaction.SaveAsAction.parent(), scripter.ui_scripter.actions.settingsaction.settingsaction.SettingsAction.parent(), filtermanager.components.filtermanagertreemodel.FilterManagerTreeModel.parent(), DefaultToolTextPropertiesInterface.parent, SvgTextCursorPropertyInterface::Private.parent, and TagFilterProxyModelQmlWrapper::Private.parent.

confirm_overwrite()

plugin_importer.plugin_importer_extension.PluginImporterExtension.confirm_overwrite	(		self,
			plugin )

Definition at line 44 of file plugin_importer_extension.py.

    def confirm_overwrite(self, plugin):
        reply = QMessageBox.question(
            self.parent.activeWindow().qwindow(),
            i18n('Overwrite Plugin'),
            i18n('The plugin "%s" already exists. Overwrite it?') % (
                plugin['ui_name']),
            QMessageBox.StandardButton.Yes | QMessageBox.StandardButton.No)
        return reply == QMessageBox.StandardButton.Yes
 

References KoShape.parent(), KisNodeDummy.parent(), KUndo2Model.parent(), KoShape::Private.parent, KoToolProxyPrivate.parent, KisForestDetail::RootNodeImpl< Node< T > >.parent, KisForestDetail::RootNodeImpl< Node< T > >< T >.parent, KisForestDetail::RootNodeImpl< Node< T > >< KoSvgTextContentElement >.parent, KisForestDetail::RootNodeImpl< Base >.parent, KisForestDetail::RootNodeImpl< Node< T > >< FontFamilyNode >.parent, KisLayerUtils::RemoveNodeHelper::ReplacementNode.parent, KisNode.parent, KisPaintDevice::Private.parent, KisMementoItem.parent(), StoryboardChild.parent(), EnhancedPathParameter.parent(), KoPathPoint.parent(), KoRTree< KoShape * >::Node.parent(), KoRTree< T >::Node.parent(), KisNode.parent(), KisProjectionLeaf.parent(), KisForestDetail::ChildIterator< T, is_const >.parent, KoFileDialog.parent, KDEPrivate::ToolBarHandler::Private.parent, FontStyleModel.parent(), KoFontGlyphModel.parent(), KisFiltersModel.parent(), KoZoomAction.parent, KisKXMLGUI::ContainerNode.parent, KisAnimCurvesChannelsModel.parent(), KisUndoModel.parent(), FontAxesModel.parent(), KisNodeModel.parent(), StoryboardModel.parent(), OpenTypeFeatureModel.parent(), mikro.PyQtClass.parent(), ExrLayerInfoBase.parent, KDcrawIface::RExpanderBox.parent, channels2layers.channels2layers.ChannelsToLayers.parent, filtermanager.components.filtermanagertreeitem.FilterManagerTreeItem.parent(), plugin_importer.plugin_importer_extension.PluginImporterExtension.parent, scripter.ui_scripter.actions.closeaction.closeaction.CloseAction.parent(), scripter.ui_scripter.actions.debugaction.debugaction.DebugAction.parent(), scripter.ui_scripter.actions.newaction.newaction.NewAction.parent(), scripter.ui_scripter.actions.openaction.openaction.OpenAction.parent(), scripter.ui_scripter.actions.reloadaction.reloadaction.ReloadAction.parent(), scripter.ui_scripter.actions.runaction.runaction.RunAction.parent(), scripter.ui_scripter.actions.saveaction.saveaction.SaveAction.parent(), scripter.ui_scripter.actions.saveasaction.saveasaction.SaveAsAction.parent(), scripter.ui_scripter.actions.settingsaction.settingsaction.SettingsAction.parent(), filtermanager.components.filtermanagertreemodel.FilterManagerTreeModel.parent(), DefaultToolTextPropertiesInterface.parent, SvgTextCursorPropertyInterface::Private.parent, and TagFilterProxyModelQmlWrapper::Private.parent.

createActions()

plugin_importer.plugin_importer_extension.PluginImporterExtension.createActions	(		self,
			window )

Definition at line 32 of file plugin_importer_extension.py.

    def createActions(self, window):
        action = window.createAction(
            'plugin_importer_file',
            i18n('Import Python Plugin from File...'),
            'tools/scripts')
        action.triggered.connect(self.import_plugin_from_file)
        action = window.createAction(
            'plugin_importer_web',
            i18n('Import Python Plugin from Web...'),
            'tools/scripts')
        action.triggered.connect(self.import_plugin_from_web)
 

display_errors()

plugin_importer.plugin_importer_extension.PluginImporterExtension.display_errors	(		self,
			error )

Definition at line 76 of file plugin_importer_extension.py.

    def display_errors(self, error):
        msg = '<p>%s</p><pre>%s</pre>' % (
            i18n('Error during import:'),
            html.escape(str(error)))
        QMessageBox.warning(
            self.parent.activeWindow().qwindow(),
            i18n('Error'),
            msg)
 

References KoShape.parent(), KisNodeDummy.parent(), KUndo2Model.parent(), KoShape::Private.parent, KoToolProxyPrivate.parent, KisForestDetail::RootNodeImpl< Node< T > >.parent, KisForestDetail::RootNodeImpl< Node< T > >< T >.parent, KisForestDetail::RootNodeImpl< Node< T > >< KoSvgTextContentElement >.parent, KisForestDetail::RootNodeImpl< Base >.parent, KisForestDetail::RootNodeImpl< Node< T > >< FontFamilyNode >.parent, KisLayerUtils::RemoveNodeHelper::ReplacementNode.parent, KisNode.parent, KisPaintDevice::Private.parent, KisMementoItem.parent(), StoryboardChild.parent(), EnhancedPathParameter.parent(), KoPathPoint.parent(), KoRTree< KoShape * >::Node.parent(), KoRTree< T >::Node.parent(), KisNode.parent(), KisProjectionLeaf.parent(), KisForestDetail::ChildIterator< T, is_const >.parent, KoFileDialog.parent, KDEPrivate::ToolBarHandler::Private.parent, FontStyleModel.parent(), KoFontGlyphModel.parent(), KisFiltersModel.parent(), KoZoomAction.parent, KisKXMLGUI::ContainerNode.parent, KisAnimCurvesChannelsModel.parent(), KisUndoModel.parent(), FontAxesModel.parent(), KisNodeModel.parent(), StoryboardModel.parent(), OpenTypeFeatureModel.parent(), mikro.PyQtClass.parent(), ExrLayerInfoBase.parent, KDcrawIface::RExpanderBox.parent, channels2layers.channels2layers.ChannelsToLayers.parent, filtermanager.components.filtermanagertreeitem.FilterManagerTreeItem.parent(), plugin_importer.plugin_importer_extension.PluginImporterExtension.parent, scripter.ui_scripter.actions.closeaction.closeaction.CloseAction.parent(), scripter.ui_scripter.actions.debugaction.debugaction.DebugAction.parent(), scripter.ui_scripter.actions.newaction.newaction.NewAction.parent(), scripter.ui_scripter.actions.openaction.openaction.OpenAction.parent(), scripter.ui_scripter.actions.reloadaction.reloadaction.ReloadAction.parent(), scripter.ui_scripter.actions.runaction.runaction.RunAction.parent(), scripter.ui_scripter.actions.saveaction.saveaction.SaveAction.parent(), scripter.ui_scripter.actions.saveasaction.saveasaction.SaveAsAction.parent(), scripter.ui_scripter.actions.settingsaction.settingsaction.SettingsAction.parent(), filtermanager.components.filtermanagertreemodel.FilterManagerTreeModel.parent(), DefaultToolTextPropertiesInterface.parent, SvgTextCursorPropertyInterface::Private.parent, and TagFilterProxyModelQmlWrapper::Private.parent.

do_import()

plugin_importer.plugin_importer_extension.PluginImporterExtension.do_import	(		self,
			zipfile )

Definition at line 129 of file plugin_importer_extension.py.

    def do_import(self, zipfile):
        try:
            imported = PluginImporter(
                zipfile,
                self.get_resources_dir(),
                self.confirm_overwrite
            ).import_all()
        except PluginImportError as e:
            self.display_errors(e)
            return
 
        if imported:
            activate = self.confirm_activate(imported)
            if activate:
                self.activate_plugins(imported)

References plugin_importer.plugin_importer_extension.PluginImporterExtension.activate_plugins(), plugin_importer.plugin_importer_extension.PluginImporterExtension.confirm_activate(), plugin_importer.plugin_importer_extension.PluginImporterExtension.confirm_overwrite(), plugin_importer.plugin_importer_extension.PluginImporterExtension.display_errors(), and plugin_importer.plugin_importer_extension.PluginImporterExtension.get_resources_dir().

get_resources_dir()

plugin_importer.plugin_importer_extension.PluginImporterExtension.get_resources_dir

(

self

)

Definition at line 92 of file plugin_importer_extension.py.

    def get_resources_dir(self):
        return Krita.instance().getAppDataLocation()
 

References Krita.instance().

import_plugin_from_file()

plugin_importer.plugin_importer_extension.PluginImporterExtension.import_plugin_from_file

(

self

)

Definition at line 116 of file plugin_importer_extension.py.

    def import_plugin_from_file(self):
        zipfile = FileDialog.getOpenFileName(
            self.parent.activeWindow().qwindow(),
            i18n('Import Plugin'),
            os.path.expanduser('~'),
            '%s (*.zip)' % i18n('Zip Archives')
        )
 
        if not zipfile:
            return
 
        self.do_import(zipfile)
 

References plugin_importer.plugin_importer_extension.PluginImporterExtension.do_import(), FileDialog.getOpenFileName(), KoShape::Private.parent, KoToolProxyPrivate.parent, KisForestDetail::RootNodeImpl< Base >.parent, KisForestDetail::RootNodeImpl< Node< T > >< KoSvgTextContentElement >.parent, KisForestDetail::RootNodeImpl< Node< T > >< T >.parent, KisForestDetail::RootNodeImpl< Node< T > >< FontFamilyNode >.parent, KisForestDetail::RootNodeImpl< Node< T > >.parent, KisMementoItem.parent(), StoryboardChild.parent(), EnhancedPathParameter.parent(), KoPathPoint.parent(), KoRTree< T >::Node.parent(), KoRTree< KoShape * >::Node.parent(), KoShape.parent(), KisNode.parent(), KisProjectionLeaf.parent(), KisNodeDummy.parent(), KisForestDetail::ChildIterator< T, is_const >.parent, KUndo2Model.parent(), KoFontGlyphModel.parent(), KisLayerUtils::RemoveNodeHelper::ReplacementNode.parent, KisNode.parent, KisPaintDevice::Private.parent, KisFiltersModel.parent(), KoZoomAction.parent, KoFileDialog.parent, KDEPrivate::ToolBarHandler::Private.parent, KisKXMLGUI::ContainerNode.parent, FontStyleModel.parent(), KisAnimCurvesChannelsModel.parent(), KisUndoModel.parent(), FontAxesModel.parent(), KisNodeModel.parent(), StoryboardModel.parent(), OpenTypeFeatureModel.parent(), mikro.PyQtClass.parent(), ExrLayerInfoBase.parent, KDcrawIface::RExpanderBox.parent, channels2layers.channels2layers.ChannelsToLayers.parent, filtermanager.components.filtermanagertreeitem.FilterManagerTreeItem.parent(), plugin_importer.plugin_importer_extension.PluginImporterExtension.parent, scripter.ui_scripter.actions.closeaction.closeaction.CloseAction.parent(), scripter.ui_scripter.actions.debugaction.debugaction.DebugAction.parent(), scripter.ui_scripter.actions.newaction.newaction.NewAction.parent(), scripter.ui_scripter.actions.openaction.openaction.OpenAction.parent(), scripter.ui_scripter.actions.reloadaction.reloadaction.ReloadAction.parent(), scripter.ui_scripter.actions.runaction.runaction.RunAction.parent(), scripter.ui_scripter.actions.saveaction.saveaction.SaveAction.parent(), scripter.ui_scripter.actions.saveasaction.saveasaction.SaveAsAction.parent(), scripter.ui_scripter.actions.settingsaction.settingsaction.SettingsAction.parent(), filtermanager.components.filtermanagertreemodel.FilterManagerTreeModel.parent(), DefaultToolTextPropertiesInterface.parent, SvgTextCursorPropertyInterface::Private.parent, and TagFilterProxyModelQmlWrapper::Private.parent.

import_plugin_from_web()

plugin_importer.plugin_importer_extension.PluginImporterExtension.import_plugin_from_web

(

self

)

Definition at line 95 of file plugin_importer_extension.py.

    def import_plugin_from_web(self):
        infotext = i18n(
            '<p><strong>Enter download URL</strong></p>'
            '<p>For example:'
            '<ul>'
            '<li>Zip download link (http://example.com/plugin.zip)</li>'
            '<li>Github repository (https://github.com/test/plugin)</li>'
        )
        url = QInputDialog.getText(
            self.parent.activeWindow().qwindow(),
            i18n('Import Plugin'),
            infotext)[0]
        if url:
            with tempfile.TemporaryDirectory() as tmpdir:
                try:
                    zipfile = download_plugin(url=url, dest_dir=tmpdir)
                except PluginDownloadError as e:
                    self.display_errors(e)
                    return
                self.do_import(zipfile)
 

References plugin_importer.plugin_importer_extension.PluginImporterExtension.display_errors(), plugin_importer.plugin_importer_extension.PluginImporterExtension.do_import(), KoShape::Private.parent, KoToolProxyPrivate.parent, KisForestDetail::RootNodeImpl< Node< T > >.parent, KisForestDetail::RootNodeImpl< Node< T > >< T >.parent, KisForestDetail::RootNodeImpl< Node< T > >< KoSvgTextContentElement >.parent, KisForestDetail::RootNodeImpl< Node< T > >< FontFamilyNode >.parent, KisForestDetail::RootNodeImpl< Base >.parent, KisLayerUtils::RemoveNodeHelper::ReplacementNode.parent, KisNode.parent, KisPaintDevice::Private.parent, KisMementoItem.parent(), StoryboardChild.parent(), EnhancedPathParameter.parent(), KoPathPoint.parent(), KoRTree< KoShape * >::Node.parent(), KoRTree< T >::Node.parent(), KoShape.parent(), KisNode.parent(), KisProjectionLeaf.parent(), KisNodeDummy.parent(), KisForestDetail::ChildIterator< T, is_const >.parent, FontStyleModel.parent(), KUndo2Model.parent(), KoFontGlyphModel.parent(), KisFiltersModel.parent(), KisAnimCurvesChannelsModel.parent(), KisUndoModel.parent(), FontAxesModel.parent(), KisNodeModel.parent(), KoZoomAction.parent, KoFileDialog.parent, KDEPrivate::ToolBarHandler::Private.parent, KisKXMLGUI::ContainerNode.parent, StoryboardModel.parent(), OpenTypeFeatureModel.parent(), mikro.PyQtClass.parent(), ExrLayerInfoBase.parent, KDcrawIface::RExpanderBox.parent, channels2layers.channels2layers.ChannelsToLayers.parent, filtermanager.components.filtermanagertreeitem.FilterManagerTreeItem.parent(), plugin_importer.plugin_importer_extension.PluginImporterExtension.parent, scripter.ui_scripter.actions.closeaction.closeaction.CloseAction.parent(), scripter.ui_scripter.actions.debugaction.debugaction.DebugAction.parent(), scripter.ui_scripter.actions.newaction.newaction.NewAction.parent(), scripter.ui_scripter.actions.openaction.openaction.OpenAction.parent(), scripter.ui_scripter.actions.reloadaction.reloadaction.ReloadAction.parent(), scripter.ui_scripter.actions.runaction.runaction.RunAction.parent(), scripter.ui_scripter.actions.saveaction.saveaction.SaveAction.parent(), scripter.ui_scripter.actions.saveasaction.saveasaction.SaveAsAction.parent(), scripter.ui_scripter.actions.settingsaction.settingsaction.SettingsAction.parent(), filtermanager.components.filtermanagertreemodel.FilterManagerTreeModel.parent(), DefaultToolTextPropertiesInterface.parent, SvgTextCursorPropertyInterface::Private.parent, and TagFilterProxyModelQmlWrapper::Private.parent.

setup()

plugin_importer.plugin_importer_extension.PluginImporterExtension.setup

(

self

)

Definition at line 29 of file plugin_importer_extension.py.

    def setup(self):
        pass
 

Member Data Documentation

import_plugin_from_file

plugin_importer.plugin_importer_extension.PluginImporterExtension.import_plugin_from_file

Definition at line 37 of file plugin_importer_extension.py.

import_plugin_from_web

plugin_importer.plugin_importer_extension.PluginImporterExtension.import_plugin_from_web

Definition at line 42 of file plugin_importer_extension.py.

parent

plugin_importer.plugin_importer_extension.PluginImporterExtension.parent

Definition at line 27 of file plugin_importer_extension.py.

---

The documentation for this class was generated from the following file:

• plugins/python/plugin_importer/plugin_importer_extension.py