Public Member Functions
	__init__ (self, zip_filename, resources_dir, confirm_overwrite_callback)

	destination_actions (self)

	destination_pykrita (self)

	extract_actionfile (self, plugin)

	extract_desktop (self, plugin)

	extract_module (self, plugin)

	extract_plugin (self, plugin)

	get_destination_actionfile (self, plugin)

	get_destination_desktop (self, plugin)

	get_destination_module (self, plugin)

	get_plugin_info (self)

	get_source_actionfile (self, name)

	get_source_module (self, name)

	import_all (self)

	read_desktop_config (self, desktop_filename)

Public Attributes
	action_filenames

	archive

	confirm_overwrite_callback

	desktop_filenames

	destination_actions

	destination_pykrita

	resources_dir

Detailed Description

Import a Krita Python Plugin from a zip file into the given
directory.

The Importer makes barely any assumptions about the file structure
in the zip file. It will find one or more plugins with the
following strategy:

1. Find files with the ending `.desktop` and read the Python
   module name from them
2. Find directories that correspond to the Python module names
   and that contain an `__init__.py` file
3. Find files with ending `.action` that have matching
   `<Action name=...>` tags (these files are optional)
4. Extract the desktop- and action-files and the Python module
   directories into the corresponding pykrita and actions folders

Usage:

>>> importer = PluginImporter(
        '/path/to/plugin.zip',
        '/path/to/krita/resources/',
        confirm_overwrite_callback)
>>> imported = importer.import_all()

Definition at line 38 of file plugin_importer.py.

Constructor & Destructor Documentation

◆ init()

plugin_importer.plugin_importer.PluginImporter.__init__	(	self,
		zip_filename,
		resources_dir,
		confirm_overwrite_callback )

Initialise the importer.

:param zip_filename: Filename of the zip archive containing the
  plugin(s)
:param resources_dir: The Krita resources directory into which
  to extract the plugin(s)
:param confirm_overwrite_callback: A function that gets called
  if a plugin already exists in the resources directory. It gets
  called with a dictionary of information about the plugin and
  should return whether the user wants to overwrite the plugin
  (True) or not (False).

Definition at line 65 of file plugin_importer.py.

                 confirm_overwrite_callback):
 
        """Initialise the importer.
 
        :param zip_filename: Filename of the zip archive containing the
          plugin(s)
        :param resources_dir: The Krita resources directory into which
          to extract the plugin(s)
        :param confirm_overwrite_callback: A function that gets called
          if a plugin already exists in the resources directory. It gets
          called with a dictionary of information about the plugin and
          should return whether the user wants to overwrite the plugin
          (True) or not (False).
        """
 
        self.resources_dir = resources_dir
        self.confirm_overwrite_callback = confirm_overwrite_callback
        try:
            self.archive = zipfile.ZipFile(zip_filename)
        except(zipfile.BadZipFile, zipfile.LargeZipFile, OSError) as e:
            raise PluginReadError(str(e))
 
        self.desktop_filenames = []
        self.action_filenames = []
        for filename in self.archive.namelist():
            if filename.endswith('.desktop'):
                self.desktop_filenames.append(filename)
            if filename.endswith('.action'):
                self.action_filenames.append(filename)
 

Member Function Documentation

◆ destination_actions()

plugin_importer.plugin_importer.PluginImporter.destination_actions ( self )

Definition at line 104 of file plugin_importer.py.

    def destination_actions(self):
        dest = os.path.join(self.resources_dir, 'actions')
        if not os.path.exists(dest):
            os.mkdir(dest)
        return dest
 

References plugin_importer.plugin_importer.PluginImporter.resources_dir.

◆ destination_pykrita()

plugin_importer.plugin_importer.PluginImporter.destination_pykrita ( self )

Definition at line 97 of file plugin_importer.py.

    def destination_pykrita(self):
        dest = os.path.join(self.resources_dir, 'pykrita')
        if not os.path.exists(dest):
            os.mkdir(dest)
        return dest
 

References plugin_importer.plugin_importer.PluginImporter.resources_dir.

◆ extract_actionfile()

plugin_importer.plugin_importer.PluginImporter.extract_actionfile	(		self,
			plugin )

Definition at line 185 of file plugin_importer.py.

    def extract_actionfile(self, plugin):
        with open(self.get_destination_actionfile(plugin), 'wb') as f:
            f.write(self.archive.read(plugin['action']))
 

References KoQuaZipStore::Private.archive, plugin_importer.plugin_importer.PluginImporter.archive, and plugin_importer.plugin_importer.PluginImporter.get_destination_actionfile().

◆ extract_desktop()

plugin_importer.plugin_importer.PluginImporter.extract_desktop	(		self,
			plugin )

Definition at line 167 of file plugin_importer.py.

    def extract_desktop(self, plugin):
        with open(self.get_destination_desktop(plugin), 'wb') as f:
            f.write(self.archive.read(plugin['desktop']))
 

References KoQuaZipStore::Private.archive, plugin_importer.plugin_importer.PluginImporter.archive, and plugin_importer.plugin_importer.PluginImporter.get_destination_desktop().

◆ extract_module()

plugin_importer.plugin_importer.PluginImporter.extract_module	(		self,
			plugin )

Definition at line 171 of file plugin_importer.py.

    def extract_module(self, plugin):
        with TemporaryDirectory() as tmp_dir:
            for name in self.archive.namelist():
                if name.startswith(plugin['module']):
                    self.archive.extract(name, tmp_dir)
            module_dirname = os.path.join(
                tmp_dir, *plugin['module'].split('/'))
            try:
                shutil.rmtree(self.get_destination_module(plugin))
            except FileNotFoundError:
                pass
            shutil.copytree(module_dirname,
                            self.get_destination_module(plugin))
 

References KoQuaZipStore::Private.archive, plugin_importer.plugin_importer.PluginImporter.archive, and plugin_importer.plugin_importer.PluginImporter.get_destination_module().

◆ extract_plugin()

plugin_importer.plugin_importer.PluginImporter.extract_plugin	(		self,
			plugin )

Definition at line 189 of file plugin_importer.py.

    def extract_plugin(self, plugin):
        # Check if the plugin already exists in the source directory:
        if (os.path.exists(self.get_destination_desktop(plugin))
                or os.path.exists(self.get_destination_module(plugin))):
            confirmed = self.confirm_overwrite_callback(plugin)
            if not confirmed:
                return False
 
        self.extract_desktop(plugin)
        self.extract_module(plugin)
        if plugin['action']:
            self.extract_actionfile(plugin)
        return True
 

References plugin_importer.plugin_importer.PluginImporter.confirm_overwrite_callback, plugin_importer.plugin_importer.PluginImporter.extract_actionfile(), plugin_importer.plugin_importer.PluginImporter.extract_desktop(), plugin_importer.plugin_importer.PluginImporter.extract_module(), plugin_importer.plugin_importer.PluginImporter.get_destination_desktop(), and plugin_importer.plugin_importer.PluginImporter.get_destination_module().

◆ get_destination_actionfile()

plugin_importer.plugin_importer.PluginImporter.get_destination_actionfile	(		self,
			plugin )

Definition at line 117 of file plugin_importer.py.

    def get_destination_actionfile(self, plugin):
        return os.path.join(
            self.destination_actions, '%s.action' % plugin['name'])
 

◆ get_destination_desktop()

plugin_importer.plugin_importer.PluginImporter.get_destination_desktop	(		self,
			plugin )

Definition at line 113 of file plugin_importer.py.

    def get_destination_desktop(self, plugin):
        return os.path.join(
            self.destination_pykrita, '%s.desktop' % plugin['name'])
 

References plugin_importer.plugin_importer.PluginImporter.destination_pykrita(), and plugin_importer.plugin_importer.PluginImporter.destination_pykrita.

◆ get_destination_module()

plugin_importer.plugin_importer.PluginImporter.get_destination_module	(		self,
			plugin )

Definition at line 110 of file plugin_importer.py.

    def get_destination_module(self, plugin):
        return os.path.join(self.destination_pykrita, plugin['name'])
 

◆ get_plugin_info()

plugin_importer.plugin_importer.PluginImporter.get_plugin_info ( self )

Definition at line 146 of file plugin_importer.py.

    def get_plugin_info(self):
        names = []
        for filename in self.desktop_filenames:
            config = self.read_desktop_config(filename)
            try:
                name = config['Desktop Entry']['X-KDE-Library']
                ui_name = config['Desktop Entry']['Name']
            except KeyError as e:
                raise PluginReadError(
                    'Desktop file: Key %s not found' % str(e))
            module = self.get_source_module(name)
            if module:
                names.append({
                    'name': name,
                    'ui_name': ui_name,
                    'desktop': filename,
                    'module': module,
                    'action': self.get_source_actionfile(name)
                })
        return names
 

References plugin_importer.plugin_importer.PluginImporter.desktop_filenames, plugin_importer.plugin_importer.PluginImporter.get_source_actionfile(), plugin_importer.plugin_importer.PluginImporter.get_source_module(), and plugin_importer.plugin_importer.PluginImporter.read_desktop_config().

◆ get_source_actionfile()

plugin_importer.plugin_importer.PluginImporter.get_source_actionfile	(		self,
			name )

Definition at line 130 of file plugin_importer.py.

    def get_source_actionfile(self, name):
        for filename in self.action_filenames:
            _, actionfilename = os.path.split(filename)
            if actionfilename == '%s.action' % name:
                return filename
 

References plugin_importer.plugin_importer.PluginImporter.action_filenames.

◆ get_source_module()

plugin_importer.plugin_importer.PluginImporter.get_source_module	(		self,
			name )

Definition at line 121 of file plugin_importer.py.

    def get_source_module(self, name):
        namelist = self.archive.namelist()
        for filename in namelist:
            if (filename.endswith('/%s/' % name)
                    or filename == '%s/' % name):
                # Sanity check: There should be an __init__.py inside
                if ('%s__init__.py' % filename) in namelist:
                    return filename
 

References KoQuaZipStore::Private.archive, and plugin_importer.plugin_importer.PluginImporter.archive.

◆ import_all()

plugin_importer.plugin_importer.PluginImporter.import_all ( self )

Imports all plugins from the zip archive.

Returns a list of imported plugins.

Definition at line 203 of file plugin_importer.py.

    def import_all(self):
        """Imports all plugins from the zip archive.
 
        Returns a list of imported plugins.
        """
 
        plugins = self.get_plugin_info()
        if not plugins:
            raise NoPluginsFoundException(i18n('No plugins found in archive'))
 
        imported = []
        for plugin in plugins:
            success = self.extract_plugin(plugin)
            if success:
                imported.append(plugin)
 
        return imported
 
 

References plugin_importer.plugin_importer.PluginImporter.extract_plugin(), and plugin_importer.plugin_importer.PluginImporter.get_plugin_info().

◆ read_desktop_config()

plugin_importer.plugin_importer.PluginImporter.read_desktop_config	(		self,
			desktop_filename )

Definition at line 136 of file plugin_importer.py.

    def read_desktop_config(self, desktop_filename):
        config = ConfigParser()
        try:
            config.read_string(
                self.archive.read(desktop_filename).decode('utf-8'))
        except ConfigParserError as e:
            raise PluginReadError(
                '%s: %s' % (i18n('Desktop file'), str(e)))
        return config
 

References KoQuaZipStore::Private.archive, and plugin_importer.plugin_importer.PluginImporter.archive.

Member Data Documentation

◆ action_filenames

plugin_importer.plugin_importer.PluginImporter.action_filenames

Definition at line 89 of file plugin_importer.py.

◆ archive

plugin_importer.plugin_importer.PluginImporter.archive

Definition at line 84 of file plugin_importer.py.

◆ confirm_overwrite_callback

plugin_importer.plugin_importer.PluginImporter.confirm_overwrite_callback

Definition at line 82 of file plugin_importer.py.

◆ desktop_filenames

plugin_importer.plugin_importer.PluginImporter.desktop_filenames

Definition at line 88 of file plugin_importer.py.

◆ destination_actions

plugin_importer.plugin_importer.PluginImporter.destination_actions

Definition at line 119 of file plugin_importer.py.

◆ destination_pykrita

plugin_importer.plugin_importer.PluginImporter.destination_pykrita

Definition at line 111 of file plugin_importer.py.

◆ resources_dir

plugin_importer.plugin_importer.PluginImporter.resources_dir

Definition at line 81 of file plugin_importer.py.

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

plugins/python/plugin_importer/plugin_importer.py

Public Member Functions

Public Attributes