convert NS* types to built-in python types

Author: infothrill

README.rst

@@ -15,6 +15,9 @@ implemented using the Objective C
 as well as the `launchd` command line utility. Therefore, this python package
 can only be used on `OS X <http://en.wikipedia.org/wiki/OS_X>`_
 
+The python objective C bridge contains some special types. This package strips
+off all non built-in type information and returns pure python data.
+
 Examples
 ========
 

launchd/__init__.py

@@ -2,3 +2,4 @@
 
 from .launchctl import jobs, LaunchdJob, load, unload, start, stop
 from . import plist
+from . import util

launchd/launchctl.py

@@ -4,6 +4,7 @@
 
 from .cmd import launchctl
 from .plist import discover_filename
+from .util import convert_NSDictionary_to_dict
 
 
 class LaunchdJob(object):
@@ -54,40 +55,37 @@ def properties(self):
         '''
         This is a lazily loaded dictionary containing the launchd runtime
         information of the job in question. Internally, this is retrieved
-        using `launchctl -x LABEL`. Keep in mind that some dictionary keys
-        are not always present (for example 'PID').
+        using ServiceManagement.SMJobCopyDictionary(). Keep in mind that
+        some dictionary keys are not always present (for example 'PID').
         If the job specified by the label cannot be found in launchd, then
         this method raises a ValueError exception.
         '''
+        if hasattr(self, '_nsproperties'):
+            self._properties = convert_NSDictionary_to_dict(self._nsproperties)
+            del self._nsproperties
+            #self._nsproperties = None
         if self._properties is None:
             self.refresh()
         return self._properties
 
     def exists(self):
-        from subprocess import CalledProcessError
-        try:
-            _ = job_properties(self.label)
-        except (CalledProcessError, ValueError):
-            return False
-        else:
-            return True
+        return ServiceManagement.SMJobCopyDictionary(None, self.label) != None
 
     def refresh(self):
-        from subprocess import CalledProcessError
-        try:
-            self._properties = job_properties(self.label)
-        except (CalledProcessError, ValueError):
+        val = ServiceManagement.SMJobCopyDictionary(None, self.label)
+        if val is None:
             self._reset()
-            raise ValueError("The job ('%s') does not exist!" % self.label)
+            raise ValueError("job '%s' does not exist" % self.label)
         else:
+            self._properties = convert_NSDictionary_to_dict(val)
             # update pid and laststatus attributes
-            if 'PID' in self._properties:
+            try:
                 self._pid = self._properties['PID']
-            else:
+            except KeyError:
                 self._pid = None
-            if 'LastExitStatus' in self._properties:
+            try:
                 self._laststatus = self._properties['LastExitStatus']
-            else:
+            except KeyError:
                 self._laststatus = None
 
     @property
@@ -101,28 +99,22 @@ def plistfilename(self):
         return self._plist_fname
 
 
-def job_properties(joblabel):
-    val = ServiceManagement.SMJobCopyDictionary(None, joblabel)
-    if val is None:
-        raise ValueError("job %s does not exist" % joblabel)
-    return dict(val)
-
-
 def jobs():
     for entry in ServiceManagement.SMCopyAllJobDictionaries(None):
-        if entry['Label'].startswith("0x"):
-            continue
         label = entry['Label']
-        if 'PID' in entry:
+        if label.startswith("0x"):
+            continue
+        try:
             pid = int(entry['PID'])
-        else:
+        except KeyError:
             pid = None
-        if 'LastExitStatus' in entry:
+        try:
             status = int(entry['LastExitStatus'])
-        else:
+        except KeyError:
             status = None
-        yield LaunchdJob(label, pid, status)
-
+        job = LaunchdJob(label, pid, status)
+        job._nsproperties = entry
+        yield job
 
 
 def start():

launchd/tests/launchctl.py

@@ -46,7 +46,7 @@ def test_launchd_jobs(self):
             self.assertTrue(isinstance(job, launchd.LaunchdJob))
             self.assertTrue(job.pid is None or isinstance(job.pid, int))
             self.assertTrue(job.laststatus is None or isinstance(job.laststatus, int))
-            self.assertTrue(isinstance(job.properties, dict))
+            self.assertTrue(isinstance(job.properties, dict), "props is not a dict: %s" % (type(job.properties)))
             self.assertTrue(job.plistfilename is None or isinstance(job.plistfilename, six.string_types))
             # the next 2 fail sometimes due to short lived processes that
             # have disappeared by the time we reach this test

launchd/util.py

@@ -0,0 +1,28 @@
+# -*- coding: utf-8 -*-
+
+from Foundation import NSDictionary, NSArray
+from objc._pythonify import OC_PythonLong, OC_PythonFloat
+from objc import pyobjc_unicode
+
+
+def convert_NS_to_python(val):
+    if isinstance(val, (pyobjc_unicode, str)):
+        return str(val)
+    elif isinstance(val, (OC_PythonLong, int)):
+        return int(val)
+    elif isinstance(val, (NSDictionary, dict)):
+        return convert_NSDictionary_to_dict(val)
+    elif isinstance(val, (NSArray, list, tuple)):
+        return convert_NSArray_to_tuple(val)
+    elif isinstance(val, (OC_PythonFloat,)):
+        return float(val)
+    else:
+        raise TypeError("Unknown type '%s': '%r'!" % (str(type(val)), repr(val)))
+
+
+def convert_NSArray_to_tuple(nsarray):
+    return ((convert_NS_to_python(val) for val in nsarray),)
+
+
+def convert_NSDictionary_to_dict(nsdict):
+    return {convert_NS_to_python(k): convert_NS_to_python(nsdict[k]) for k in nsdict}