flake8 tests, check-manifest, safety

Author: infothrill

.github/workflows/tests.yml

@@ -16,4 +16,4 @@ jobs:
           python3 -m pip install --upgrade pip
           pip3 install tox
       - name: Test with tox
-        run: tox -e py39
+        run: tox -e py39,style

example.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Example script showing how to install and remove plist based launchd jobs
+Example script showing how to install and remove plist based launchd jobs.
 """
 
 import sys
@@ -10,64 +10,64 @@
 
 
 def install(label, plist):
-    '''
-    Utility function to store a new .plist file and load it
+    """
+    Store a new .plist file and load it.
 
     :param label: job label
     :param plist: a property list dictionary
-    '''
+    """
     fname = launchd.plist.write(label, plist)
     launchd.load(fname)
 
 
 def uninstall(label):
-    '''
-    Utility function to remove a .plist file and unload it
+    """
+    Remove a .plist file and unload it.
 
     :param label: job label
-    '''
+    """
     if launchd.LaunchdJob(label).exists():
         fname = launchd.plist.discover_filename(label)
         launchd.unload(fname)
         os.unlink(fname)
 
 
 def main():
-    myplist = dict(
-              Disabled=False,
-              Label="testlaunchdwrapper_python",
-              Nice=-15,
-              OnDemand=True,
-              ProgramArguments=["/bin/bash", "-c", "sleep 1 && echo 'Hello World' && exit 0"],
-              RunAtLoad=True,
-              ServiceDescription="runs a sample command",
-              ServiceIPC=False,
-              )
+    myplist = {
+        "Disabled": False,
+        "Label": "testlaunchdwrapper_python",
+        "Nice": -15,
+        "OnDemand": True,
+        "ProgramArguments": ["/bin/bash", "-c", "sleep 1 && echo 'Hello World' && exit 0"],
+        "RunAtLoad": True,
+        "ServiceDescription": "runs a sample command",
+        "ServiceIPC": False,
+    }
 
     import time
-    label = myplist['Label']
+    label = myplist["Label"]
     job = launchd.LaunchdJob(label)
     if not job.exists():
-        print("'%s' is not loaded in launchd. Installing..." % (label))
+        print("'%s' is not loaded in launchd. Installing..." % (label))  # noqa: T001
         install(label, myplist)
         while job.pid is not None:
-            print("Alive! PID = %s" % job.pid)
+            print("Alive! PID = %s" % job.pid)  # noqa: T001
             job.refresh()
             time.sleep(0.2)
     else:
         if job.pid is None:
-            print("'%s' is loaded but not currently running" % (job.label))
+            print("'%s' is loaded but not currently running" % (job.label))  # noqa: T001
         else:
-            print("'%s' is loaded and currently running: PID = %s" % (job.label, job.pid))
+            print("'%s' is loaded and currently running: PID = %s" % (job.label, job.pid))  # noqa: T001
             while job.pid is not None:
-                print("Alive! PID = %s" % job.pid)
+                print("Alive! PID = %s" % job.pid)  # noqa: T001
                 job.refresh()
                 time.sleep(0.2)
 
-    print("Uninstalling again...")
+    print("Uninstalling again...")  # noqa: T001
     uninstall(label)
     return 0
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     sys.exit(main())

launchd/__init__.py

@@ -1,9 +1,9 @@
 # -*- coding: utf-8 -*-
 
-__author__ = 'Paul Kremer'
-__email__ = 'paul@spurious.biz'
-__version__ = '0.2.0'
+__author__ = "Paul Kremer"
+__email__ = "paul@spurious.biz"
+__version__ = "0.2.0"
 
-from .launchctl import jobs, LaunchdJob, load, unload
-from . import plist
-from . import util
+from .launchctl import jobs, LaunchdJob, load, unload  # noqa: F401
+from . import plist  # noqa: F401
+from . import util  # noqa: F401

launchd/cmd.py

@@ -1,27 +1,28 @@
 # -*- coding: utf-8 -*-
 
-import subprocess
+import subprocess  # noqa: S404
 
 import six
 
 
 def launchctl(subcommand, *args):
-    '''
-    A minimal wrapper to call the launchctl binary and capture the output
+    """
+    Call the launchctl binary and capture the output.
+
     :param subcommand: string
-    '''
+    """
     if not isinstance(subcommand, six.string_types):
         raise ValueError("Argument is invalid: %r" % repr(subcommand))
     if isinstance(subcommand, six.text_type):
-        subcommand = subcommand.encode('utf-8')
+        subcommand = subcommand.encode("utf-8")
 
     cmd = ["launchctl", subcommand]
     for arg in args:
         if isinstance(arg, six.string_types):
             if isinstance(arg, six.text_type):
-                cmd.append(arg.encode('utf-8'))
+                cmd.append(arg.encode("utf-8"))
             else:
                 cmd.append(arg)
         else:
             raise ValueError("Argument is invalid: %r" % repr(arg))
-    return subprocess.check_output(cmd, stdin=None, stderr=subprocess.STDOUT, shell=False)
+    return subprocess.check_output(cmd, stdin=None, stderr=subprocess.STDOUT, shell=False)  # noqa: S603

launchd/launchctl.py

@@ -8,24 +8,23 @@
 
 
 class LaunchdJob(object):
-    '''
-    Custom class that allows us to lazily query the properties
-    of the LaunchdJob when accessed.
-    '''
-    def __init__(self, label, pid=-1, laststatus=''):
-        '''
+    """
+    Class to lazily query the properties of the LaunchdJob when accessed.
+    """
+    def __init__(self, label, pid=-1, laststatus=""):
+        """
         Instantiate a LaunchdJob instance. Only the label is required.
         If no pid or laststatus are specified, they will be queried when
         accessed.
 
         :param label: required string job label
         :param pid: optional int, if known. Can be None.
         :param laststatus: optional int, if known. Can be None.
-        '''
+        """
         self._label = label
         if pid != -1:  # -1 indicates no value specified
             self._pid = pid
-        if laststatus != '':
+        if laststatus != "":
             self._laststatus = laststatus
         self._properties = None
         self._plist_fname = None
@@ -53,15 +52,15 @@ def laststatus(self):
 
     @property
     def properties(self):
-        '''
-        This is a lazily loaded dictionary containing the launchd runtime
-        information of the job in question. Internally, this is retrieved
-        using ServiceManagement.SMJobCopyDictionary(). Keep in mind that
-        some dictionary keys are not always present (for example 'PID').
+        """
+        Lazily load dictionary with launchd runtime information.
+
+        Internally, this is retrieved 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'):
+        """
+        if hasattr(self, "_nsproperties"):
             self._properties = convert_NSDictionary_to_dict(self._nsproperties)
             del self._nsproperties
             # self._nsproperties = None
@@ -80,36 +79,37 @@ def refresh(self):
             self._properties = convert_NSDictionary_to_dict(val)
             # update pid and laststatus attributes
             try:
-                self._pid = self._properties['PID']
+                self._pid = self._properties["PID"]
             except KeyError:
                 self._pid = None
             try:
-                self._laststatus = self._properties['LastExitStatus']
+                self._laststatus = self._properties["LastExitStatus"]
             except KeyError:
                 self._laststatus = None
 
     @property
     def plistfilename(self):
-        '''
-        This is a lazily detected absolute filename of the corresponding
-        property list file (*.plist). None if it doesn't exist.
-        '''
+        """
+        Lazily detect absolute filename of the property list file.
+
+        Return None if it doesn't exist.
+        """
         if self._plist_fname is None:
             self._plist_fname = discover_filename(self.label)
         return self._plist_fname
 
 
 def jobs():
     for entry in ServiceManagement.SMCopyAllJobDictionaries(None):
-        label = entry['Label']
+        label = entry["Label"]
         if label.startswith("0x"):
             continue
         try:
-            pid = int(entry['PID'])
+            pid = int(entry["PID"])
         except KeyError:
             pid = None
         try:
-            laststatus = int(entry['LastExitStatus'])
+            laststatus = int(entry["LastExitStatus"])
         except KeyError:
             laststatus = None
         job = LaunchdJob(label, pid, laststatus)

launchd/plist.py

@@ -10,11 +10,11 @@
 DAEMON_OS = 5
 
 PLIST_LOCATIONS = {
-    USER: '~/Library/LaunchAgents',  # Per-user agents provided by the user.
-    USER_ADMIN: '/Library/LaunchAgents',  # Per-user agents provided by the administrator.
-    DAEMON_ADMIN: '/Library/LaunchDaemons',  # System-wide daemons provided by the administrator.
-    USER_OS: '/System/Library/LaunchAgents',  # Per-user agents provided by Mac OS X.
-    DAEMON_OS: '/System/Library/LaunchDaemons',  # System-wide daemons provided by Mac OS X.
+    USER: "~/Library/LaunchAgents",  # Per-user agents provided by the user.
+    USER_ADMIN: "/Library/LaunchAgents",  # Per-user agents provided by the administrator.
+    DAEMON_ADMIN: "/Library/LaunchDaemons",  # System-wide daemons provided by the administrator.
+    USER_OS: "/System/Library/LaunchAgents",  # Per-user agents provided by Mac OS X.
+    DAEMON_OS: "/System/Library/LaunchDaemons",  # System-wide daemons provided by Mac OS X.
 }
 
 
@@ -27,15 +27,15 @@ def compute_filename(label, scope):
 
 
 def discover_filename(label, scopes=None):
-    '''
+    """
     Check the filesystem for the existence of a .plist file matching the job label.
     Optionally specify one or more scopes to search (default all).
 
     :param label: string
     :param scope: tuple or list or oneOf(USER, USER_ADMIN, DAEMON_ADMIN, USER_OS, DAEMON_OS)
-    '''
+    """
     if scopes is None:
-        scopes = [k for k in PLIST_LOCATIONS]
+        scopes = list(PLIST_LOCATIONS)
     elif not isinstance(scopes, (list, tuple)):
         scopes = (scopes, )
     for thisscope in scopes:
@@ -46,20 +46,19 @@ def discover_filename(label, scopes=None):
 
 
 def read(label, scope=None):
-    with open(discover_filename(label, scope), 'rb') as f:
+    with open(discover_filename(label, scope), "rb") as f:
         return plistlib.load(f)
 
 
 def write(label, plist, scope=USER):
-    '''
-    Writes the given property list to the appropriate file on disk and returns
-    the absolute filename.
+    """
+    Write the property list to file on disk and return filename.
 
     Creates the underlying parent directory structure if missing.
     :param plist: dict
     :param label: string
     :param scope: oneOf(USER, USER_ADMIN, DAEMON_ADMIN, USER_OS, DAEMON_OS)
-    '''
+    """
     os.makedirs(compute_directory(scope), mode=0o755, exist_ok=True)
     fname = compute_filename(label, scope)
     with open(fname, "wb") as f:

launchd/tests/cmd.py

@@ -16,7 +16,7 @@ def tearDown(self):
         unittest.TestCase.tearDown(self)
 
     def testlaunchctl_invalid_args(self):
-        self.assertRaises(ValueError, cmd.launchctl, ['foo'])
+        self.assertRaises(ValueError, cmd.launchctl, ["foo"])
 
     def testlaunchctl_list(self):
         stdout = cmd.launchctl("list").decode("utf-8")

launchd/tests/launchctl.py

@@ -9,16 +9,16 @@
 import launchd
 
 
-launchdtestplist = dict(
-          Disabled=False,
-          Label="testlaunchdwrapper_python",
-          Nice=-15,
-          OnDemand=True,
-          ProgramArguments=["/bin/bash", "-c", "echo 'Hello World' && exit 0"],
-          RunAtLoad=True,
-          ServiceDescription="runs a sample command",
-          ServiceIPC=False,
-          )
+launchdtestplist = {
+    "Disabled": False,
+    "Label": "testlaunchdwrapper_python",
+    "Nice": -15,
+    "OnDemand": True,
+    "ProgramArguments": ["/bin/bash", "-c", "echo 'Hello World' && exit 0"],
+    "RunAtLoad": True,
+    "ServiceDescription": "runs a sample command",
+    "ServiceIPC": False,
+}
 
 
 class LaunchctlTestCase(unittest.TestCase):
@@ -31,10 +31,10 @@ def tearDown(self):
 
     @unittest.skipUnless(sys.platform.startswith("darwin"), "requires OS X")
     def test_examples(self):
-        activejobs = [job for job in launchd.jobs() if job.pid is not None]
-        inactivejobs = [job for job in launchd.jobs() if job.pid is None]
-        errorjobs = [job for job in launchd.jobs() if job.laststatus != 0 and job.laststatus is not None]
-        ondemandjobs = [job for job in launchd.jobs() if job.properties['OnDemand'] is True]
+        [job for job in launchd.jobs() if job.pid is not None]  # activejobs
+        [job for job in launchd.jobs() if job.pid is None]  # inactivejobs
+        [job for job in launchd.jobs() if job.laststatus != 0 and job.laststatus is not None]  # errorjobs
+        [job for job in launchd.jobs() if job.properties["OnDemand"] is True]  # ondemandjobs
 
     @unittest.skipUnless(sys.platform.startswith("darwin"), "requires OS X")
     def test_launchd_jobs(self):
@@ -50,8 +50,8 @@ def test_launchd_jobs(self):
             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
-            self.assertTrue('PID' in job.properties if job.pid is not None else True)
-            self.assertTrue('PID' not in job.properties if job.pid is None else True)
+            self.assertTrue("PID" in job.properties if job.pid is not None else True)
+            self.assertTrue("PID" not in job.properties if job.pid is None else True)
         self.assertTrue(count > 0)
 
     @unittest.skipUnless(sys.platform.startswith("darwin"), "requires OS X")
@@ -67,8 +67,8 @@ def test_launchd_lazy_constructor(self):
         label = "com.apple.Finder"
         job = launchd.LaunchdJob(label)
         self.assertTrue(job.exists())
-        self.assertFalse(hasattr(job, '_pid'))
-        self.assertFalse(hasattr(job, '_laststatus'))
+        self.assertFalse(hasattr(job, "_pid"))
+        self.assertFalse(hasattr(job, "_laststatus"))
         self.assertEqual(None, job._properties)
         job.refresh()
         self.assertNotEqual(None, job._pid)