plugin_importer.plugin_downloader Namespace Reference

Classes
class	PluginDownloadError

Functions
	download_plugin (url, dest_dir)
	get_zipurl (url)
	get_zipurl_github (base_path)
	is_zip (url)

Function Documentation

download_plugin()

plugin_importer.plugin_downloader.download_plugin	(		url,
			dest_dir )

Download a plugin from a given URL into the given directory.

``url`` may either point directly to a zip location (on any site),
or to a github repository.

Returns full path of the downloaded zip file.

Definition at line 75 of file plugin_downloader.py.

def download_plugin(url, dest_dir):
    """Download a plugin from a given URL into the given directory.
 
    ``url`` may either point directly to a zip location (on any site),
    or to a github repository.
 
    Returns full path of the downloaded zip file.
    """
 
    dest_path = os.path.join(dest_dir, 'plugin.zip')
    zip_url, headers = get_zipurl(url)
    headers['User-Agent'] = 'krita-plugin-importer'
 
    try:
        request = urllib.request.Request(zip_url, headers=headers)
        with urllib.request.urlopen(request) as source:
            with open(dest_path, 'wb') as destination:
                destination.write(source.read())
    except Exception as e:
        raise PluginDownloadError(str(e))
    return dest_path

References plugin_importer.plugin_downloader.get_zipurl().

get_zipurl()

plugin_importer.plugin_downloader.get_zipurl

(

url

)

Guess the zip location from a given URL.

Definition at line 61 of file plugin_downloader.py.

def get_zipurl(url):
    """Guess the zip location from a given URL."""
 
    if is_zip(url):
        return (url, {})
 
    parsed = urllib.parse.urlparse(url)
    if parsed.netloc == 'github.com':
        return get_zipurl_github(parsed.path)
 
    raise PluginDownloadError(
        i18n('Could not determine download link from URL'))
 
 

References plugin_importer.plugin_downloader.get_zipurl_github(), and plugin_importer.plugin_downloader.is_zip().

get_zipurl_github()

plugin_importer.plugin_downloader.get_zipurl_github

(

base_path

)

Guess the zip location from a github url

Definition at line 50 of file plugin_downloader.py.

def get_zipurl_github(base_path):
    """Guess the zip location from a github url"""
 
    url = None
    split = base_path.split('/')
    if len(split) > 2:
        url = (f'https://api.github.com/repos/{split[1]}/{split[2]}/'
               'zipball/master')
    return (url, {'Accept': 'application/vnd.github.v3+json'})
 
 

is_zip()

plugin_importer.plugin_downloader.is_zip

(

url

)

Check if the given URL is a direct link to a zip file

Definition at line 31 of file plugin_downloader.py.

def is_zip(url):
    """Check if the given URL is a direct link to a zip file"""
 
    MTYPE = 'application/zip'
 
    # This just goes by the ending of the url string:
    if mimetypes.guess_type(url)[0] == MTYPE:
        return True
 
    # Could still be a zip, so check the HTTP headers:
    try:
        request = urllib.request.Request(url, method='HEAD')
        response = urllib.request.urlopen(request)
    except Exception as e:
        raise PluginDownloadError(str(e))
 
    return response.getheader('Content-Type') == MTYPE