drawbotPackage.py

import os
import shutil
import AppKit
import attr
from plistlib import readPlist, writePlist
from distutils.version import LooseVersion
import tempfile

from drawBot.scriptTools import ScriptRunner

"""
DrawBot support for .drawbot packages.

* Read and build packages.
* Run packages

    MyTool.drawbot (package)
        info.plist
        lib/
            main.py
            anotherScript.py
            anImage.jpg

    info.plist
        name: optional, default to <name>.drawBot
        version: optional, default to 0.0, but advised to set
        developer: optional, default to None
        developerURL: optional, default to None
        requiresVersion: optional, default to all versions
        mainScript: optional, default to 'lib/main.py' if this isn't specified?)

"""

drawBotVersion = AppKit.NSBundle.mainBundle().infoDictionary()["CFBundleShortVersionString"]
drawBotVersion  = LooseVersion(drawBotVersion)


@attr.s(slots=True)
class DrawBotPackageInfo(object):
    
    name = attr.ib(default="", init=False, type=str, validator=attr.validators.instance_of(str))
    version = attr.ib(default="0.0", init=False, type=str, validator=attr.validators.instance_of(str))
    developer = attr.ib(default="", init=False, type=str, validator=attr.validators.instance_of(str))
    developerURL = attr.ib(default="", init=False, type=str, validator=attr.validators.instance_of(str))
    requiresVersion = attr.ib(default="0.0", init=False, type=str, validator=attr.validators.instance_of(str))
    mainScript = attr.ib(default="main.py", init=False, type=str, validator=attr.validators.instance_of(str))
    
    def asDict(self):
        """
        Return only keys which are different from the defaults.
        """
        defaults = attr.asdict(self.__class__())
        data = attr.asdict(self)
        for key, value in defaults.items():
            if data[key] == value:
                del data[key]
        return data
    
    def fromDict(self, data):
        """
        Set data from dict.
        """
        for key, value in data.items():
            setattr(self, key, value)
    

class DrawBotPackage(object):

    def __init__(self, path=None):
        self.path = path
        self.info = DrawBotPackageInfo()
        self._readInfo()
    
    def _readInfo(self):
        """
        Read the info.plist if the file is availble.
        """
        # get the info.plist path
        infoPath = self.infoPath()
        if infoPath and os.path.exists(infoPath):
            info = readPlist(infoPath)
            self.info.fromDict(info)
            # validate incoming info
            attr.validate(self.info)

    def infoPath(self):
        """
        Return the info.plist path.
        Return None if there is no root path.
        """
        if self.path:
            return os.path.join(self.path, "info.plist")
        return None
    
    def mainScriptPath(self):
        """
        Return the main scripting python file path.
        Return None if ther is no root path.
        """
        if self.path:
            return os.path.join(self.path, "lib", self.info.mainScript)
        return None      
    
    def run(self):
        """
        Execute the .drawBot package.
        Return if executing was succesfull with a report on failure.
        """
        # check if the package can run in this version of DrawBot
        if LooseVersion(self.info.requiresVersion) > drawBotVersion:
            return False, "Requires a newer version of DrawBot (%s)." % self.info.requiresVersion
        # get the main scriptin path
        path = self.mainScriptPath()
        if path is None:
            return False, "Cannot execute an empty package"
        if not os.path.exists(path):
            return False, "Cannot find '%s'" % path
        # run the script
        ScriptRunner(path=path)
        return True, ""
        
    def buildPackage(self, destinationPath, scriptRoot):
        """
        Build a .drawbot package
        """
        if not destinationPath.endswith(".drawbot"):
            return False, "The path to save the package must have a .drawbot file extension."
        # check if the script root exists
        if not os.path.exists(scriptRoot):
            return False, "Cannot find the script root '%s'" % scriptRoot
        # build packages in temp folder
        tempDir = tempfile.mkdtemp()
        # set the temp folder
        self.path = tempDir
        # validate info
        attr.validate(self.info)
        # write the plist
        infoData = self.info.asDict()
        # only write info that is different from 
        if infoData:
            writePlist(infoData, self.infoPath())
        # build lib root path
        libRoot = os.path.join(self.path, "lib")
        # copy the script root
        shutil.copytree(scriptRoot, libRoot)
        # remove existing destination paths
        if os.path.exists(destinationPath):
            shutil.rmtree(destinationPath)
        # copy the temp to the destination path
        shutil.copytree(tempDir, destinationPath)
        # remove the temp
        shutil.rmtree(tempDir)
        # set the destination path
        self.path = destinationPath
        return True, ""


####

# an empty package
p = DrawBotPackage()
print(p.path)
print(p.info.name)
print(p.infoPath())
print(p.info)

# create on the deskop such a file
tempScriptDir = tempfile.mkdtemp()
with open(os.path.join(tempScriptDir, "main.py"), "w") as f:
    f.write("print('hello world! Im running from a .drawbot package!!')")
    
packagePath = os.path.expanduser(os.path.join("~", "Desktop", "simple.drawbot"))
package = DrawBotPackage()
package.buildPackage(packagePath, tempScriptDir)
shutil.rmtree(tempScriptDir)

p = DrawBotPackage(packagePath)
print(p.path)
print(p.info.name)
print(p.infoPath())
print(p.info)
print(p.run())