p3lib 1.1.96__py3-none-any.whl → 1.1.98__py3-none-any.whl

p3lib/boot_manager.py

@@ -27,68 +27,68 @@ class BootManager(object):
         parser.add_argument(BootManager.CHECK_CMD_OPT,   help="Check the status of an auto started icons_gw instance.", action="store_true", default=False)
 
     @staticmethod
-    def HandleOptions(uio, options, enable_syslog, appName=None, restartSeconds=1):
+    def HandleOptions(uio, options, enable_syslog, serviceName=None, restartSeconds=1):
         """@brief Handle one of the bot manager command line options if the 
                   user passed it on the cmd line.
            @param uio A UIO instance.
            @param options As returned from parser.parse_args() where parser 
                           is an instance of argparse.ArgumentParser.
            @param enable_syslog True to enable systemd syslog output.
-           @param appName The name of the app. This is used as the service name. If not set then
-                          the name of the initially executed python file is used.
+           @param serviceName The name of the service. If not set then the name of the initially executed 
+                              python file is used.
            @param restartSeconds The number of seconds to sleep before restarting a service that has stopped (default=1).
            @return True if handled , False if not."""
         handled = False
         if options.check_auto_start:
-            BootManager.CheckAutoStartStatus(uio, appName)
+            BootManager.CheckAutoStartStatus(uio, serviceName)
             handled = True
             
         elif options.enable_auto_start:
-            BootManager.EnableAutoStart(uio, enable_syslog, appName, restartSeconds)
+            BootManager.EnableAutoStart(uio, enable_syslog, serviceName, restartSeconds)
             handled = True
             
         elif options.disable_auto_start:
-            BootManager.DisableAutoStart(uio, appName)
+            BootManager.DisableAutoStart(uio, serviceName)
             handled = True
 
         return handled
 
     @staticmethod
-    def EnableAutoStart(uio, enable_syslog, appName, restartSeconds):
+    def EnableAutoStart(uio, enable_syslog, serviceName, restartSeconds):
         """@brief Enable this program to auto start when the computer on which it is installed starts.
            @param uio A UIO instance.
            @param options As returned from parser.parse_args() where parser 
                           is an instance of argparse.ArgumentParser.
            @param enable_syslog True to enable systemd syslog output.
-           @param appName The name of the app. This is used as the service name. If not set then
-                          the name of the initially executed python file is used.
+           @param serviceName The name of the service. If not set then the name of the initially executed 
+                              python file is used.
            @param restartSeconds The number of seconds to sleep before restarting a service that has stopped (default=1)."""
-        bootManager = BootManager(uio=uio, ensureRootUser=True, appName=appName, restartSeconds=restartSeconds)
+        bootManager = BootManager(uio=uio, ensureRootUser=True, serviceName=serviceName, restartSeconds=restartSeconds)
         arsString = " ".join(sys.argv)
         bootManager.add(argString=arsString, enableSyslog=enable_syslog)
 
     @staticmethod
-    def DisableAutoStart(uio, appName):
+    def DisableAutoStart(uio, serviceName):
         """@brief Enable this program to auto start when the computer on which it is installed starts.
            @param uio A UIO instance.
-           @param appName The name of the app. This is used as the service name. If not set then
-                          the name of the initially executed python file is used."""
-        bootManager = BootManager(uio=uio, ensureRootUser=True, appName=appName)
+           @param serviceName The name of the service. If not set then the name of the initially executed 
+                              python file is used."""
+        bootManager = BootManager(uio=uio, ensureRootUser=True, serviceName=serviceName)
         bootManager.remove()
         
     @staticmethod
-    def CheckAutoStartStatus(uio, appName):
+    def CheckAutoStartStatus(uio, serviceName):
         """@brief Check the status of a process previously set to auto start.
            @param uio A UIO instance.
-           @param appName The name of the app. This is used as the service name. If not set then
-                          the name of the initially executed python file is used."""
-        bootManager = BootManager(uio=uio, appName=appName)
+           @param serviceName The name of the service. If not set then the name of the initially executed 
+                              python file is used."""
+        bootManager = BootManager(uio=uio, serviceName=serviceName)
         lines = bootManager.getStatus()
         if lines and len(lines) > 0:
             for line in lines:
                 uio.info(line)
         
-    def __init__(self, uio=None, allowRootUser=True, ensureRootUser=False, appName=None, restartSeconds=1):
+    def __init__(self, uio=None, allowRootUser=True, ensureRootUser=False, serviceName=None, restartSeconds=1):
         """@brief Constructor
            @param uio A UIO instance to display user output. If unset then no output
                   is displayed to user.
@@ -98,15 +98,15 @@ class BootManager(object):
                   the installed program should be installed for the root 
                   user on Linux systems.
            @param ensureRootUser If True the current user must be root user (Linux systems).
-           @param appName The name of the app. This is used as the service name. If not set then
-                          the name of the initially executed python file is used.
+           @param serviceName The name of the service. If not set then the name of the initially executed 
+                              python file is used.
            @param restartSeconds The number of seconds to sleep before restarting a service that has stopped (default=1)."""
         self._uio = uio
         self._allowRootUser=allowRootUser
         self._osName = platform.system()
         self._platformBootManager = None
         if self._osName == BootManager.LINUX_OS_NAME:
-            self._platformBootManager = LinuxBootManager(uio, self._allowRootUser, ensureRootUser, appName, restartSeconds)
+            self._platformBootManager = LinuxBootManager(uio, self._allowRootUser, ensureRootUser, serviceName, restartSeconds)
         else:
             raise Exception("{} is an unsupported OS.".format(self._osName) )
 
@@ -174,13 +174,13 @@ class LinuxBootManager(object):
             raise Exception(f"{serviceFolder} folder not found.")
         return serviceFolder
 
-    def __init__(self, uio, allowRootUser, ensureRootUser, appName, restartSeconds):
+    def __init__(self, uio, allowRootUser, ensureRootUser, serviceName, restartSeconds):
         """@brief Constructor
            @param uio A UIO instance to display user output. If unset then no output is displayed to user.
            @param allowRootUser If True then allow root user to to auto start programs.
            @param ensureRootUser If True the current user must be root user.
-           @param appName The name of the app. This is used as the systemd service name. If not set then
-                          the name of the initially executed python file is used.
+           @param serviceName The name of the service. If not set then the name of the initially executed 
+                              python file is used.
            @param restartSeconds The number of seconds to sleep before restarting a service that has stopped."""
         self._uio = uio
         self._logFile = None
@@ -202,7 +202,7 @@ class LinuxBootManager(object):
             self._cmdLinePrefix = self._systemCtlBin
         self._username = getpass.getuser()
         self._serviceFolder = LinuxBootManager.GetServiceFolder(self._rootMode)
-        self._appName = appName
+        self._serviceName = serviceName
         self._restartSeconds = restartSeconds
 
     def _getInstallledStartupScript(self):
@@ -275,34 +275,38 @@ class LinuxBootManager(object):
         if not os.path.isdir(exePath):
             self._fatalError("{} path not found".format(exePath))
 
-        # If the appName was set in the constructor then use this.
-        if self._appName:
-            appName = self._appName
+        appName = os.path.basename(exeFile)
+        if len(appName) == 0:
+            self._fatalError("No app found to execute.")
 
-        # Else we use the initially executed python file.
-        else:
-
-            appName = os.path.basename(exeFile)
-            if len(appName) == 0:
-                self._fatalError("No app found to execute.")
+        absApp = os.path.join(exePath, appName)
+        if not os.path.isfile( absApp ):
+            self._fatalError("{} file not found.".format(absApp) )
 
-            absApp = os.path.join(exePath, appName)
-            if not os.path.isfile( absApp ):
-                self._fatalError("{} file not found.".format(absApp) )
-
-            appName = appName.replace(".py", "")
-            if self._rootMode:
-                # We can only save to /var/log/ is we are root user.
-                self._logFile = os.path.join(LinuxBootManager.LOG_PATH, appName)
+        appName = appName.replace(".py", "")
+        if self._rootMode:
+            # We can only save to /var/log/ is we are root user.
+            self._logFile = os.path.join(LinuxBootManager.LOG_PATH, appName)
 
         return (appName, absApp)
 
+    def _getServiceName(self):
+        """@brief Get the name of the service.
+           @return The name of the service."""
+        if self._serviceName:
+            serviceName = self._serviceName
+        else:
+            appName, _ = self._getApp()
+            serviceName = appName
+        return "{}.service".format(serviceName)
+
     def _getServiceFile(self, appName):
         """@brief Get the name of the service file.
            @param appName The name of the app to execute.
            @return The absolute path to the service file """
-        serviceName = "{}.service".format(appName)
+        serviceName = self._getServiceName()
         serviceFile = os.path.join(self._serviceFolder, serviceName)
+        self._uio.info(f"SERVICE FILE: {serviceFile}")
         return serviceFile
 
     def add(self, user, argString=None, enableSyslog=False):
@@ -321,8 +325,9 @@ class LinuxBootManager(object):
             user = self._username
 
         appName, absApp = self._getApp()
+        serviceName = self._getServiceName()
 
-        serviceFile = self._getServiceFile(appName)
+        serviceFile = self._getServiceFile(serviceName)
 
         lines = []
         lines.append("[Unit]")
@@ -372,12 +377,12 @@ class LinuxBootManager(object):
 
         cmd = "{} daemon-reload".format(self._cmdLinePrefix)
         self._runLocalCmd(cmd)
-        cmd = "{} enable {}".format(self._cmdLinePrefix, appName)
-        self._info("Enabled {} on restart".format(appName))
+        cmd = "{} enable {}".format(self._cmdLinePrefix, serviceName)
+        self._info("Enabled {} on restart".format(serviceName))
         self._runLocalCmd(cmd)
-        cmd = "{} start {}".format(self._cmdLinePrefix, appName)
+        cmd = "{} start {}".format(self._cmdLinePrefix, serviceName)
         self._runLocalCmd(cmd)
-        self._info("Started {}".format(appName))
+        self._info("Started {}".format(serviceName))
 
     def remove(self):
         """@brief Remove the executable file to the processes started at boot time.
@@ -385,29 +390,30 @@ class LinuxBootManager(object):
                   named the same as the python file executed without the .py suffix."""
         appName, _ = self._getApp()
 
+        serviceName = self._getServiceName()
         serviceFile = self._getServiceFile(appName)
         if os.path.isfile(serviceFile):
-            cmd = "{} disable {}".format(self._cmdLinePrefix, appName)
+            cmd = "{} disable {}".format(self._cmdLinePrefix, serviceName)
             self._runLocalCmd(cmd)
-            self._info("Disabled {} on restart".format(appName))
+            self._info("Disabled {} on restart".format(serviceName))
 
-            cmd = "{} stop {}".format(self._cmdLinePrefix, appName)
+            cmd = "{} stop {}".format(self._cmdLinePrefix, serviceName)
             self._runLocalCmd(cmd)
-            self._info("Stopped {}".format(appName))
+            self._info("Stopped {}".format(serviceName))
 
             os.remove(serviceFile)
             self._log("Removed {}".format(serviceFile))
         else:
-            self._info("{} service not found".format(appName))
+            self._info("{} service not found".format(serviceName))
 
     def getStatusLines(self):
         """@brief Get a status report.
            @return Lines of text indicating the status of a previously started process."""
-        appName, _ = self._getApp()
+        serviceName = self._getServiceName()
         if self._rootMode:
-            p = Popen([self._systemCtlBin, 'status', appName], stdin=PIPE, stdout=PIPE, stderr=PIPE)
+            p = Popen([self._systemCtlBin, 'status', serviceName], stdin=PIPE, stdout=PIPE, stderr=PIPE)
         else:
-            p = Popen([self._systemCtlBin, '--user', 'status', appName], stdin=PIPE, stdout=PIPE, stderr=PIPE)
+            p = Popen([self._systemCtlBin, '--user', 'status', serviceName], stdin=PIPE, stdout=PIPE, stderr=PIPE)
         output, err = p.communicate(b"input data that is passed to subprocess' stdin")
         response = output.decode() + "\n" + err.decode()
         lines = response.split("\n")

{p3lib-1.1.96.dist-info → p3lib-1.1.98.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: p3lib
-Version: 1.1.96
+Version: 1.1.98
 Summary: A group of python modules for networking, plotting data, config storage, automating boot scripts, ssh access and user input output.
 Home-page: https://github.com/pjaos/p3lib
 Author: Paul Austen

{p3lib-1.1.96.dist-info → p3lib-1.1.98.dist-info}/RECORD

@@ -2,7 +2,7 @@ p3lib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 p3lib/ate.py,sha256=_BiqMUYNAlp4O8MkP_PAUe62Bzd8dzV4Ipv62OFS6Ok,4759
 p3lib/bokeh_auth.py,sha256=zi_Hty2WkCJVNQ4sINNRo5FBXujuJky9phyoF6M55ms,15180
 p3lib/bokeh_gui.py,sha256=55sajP_x9O1lE0uP3w3-T5f2oMzk7jSolLqxlEdLeLg,40245
-p3lib/boot_manager.py,sha256=3Jlpg1Dn-Od9o3isZ-E-Tu_1-YZwmpELan7nFIrpJ_I,19425
+p3lib/boot_manager.py,sha256=l7WlaoIRt4cu2jAdCs3FnDeNO2v2jzqideNZ3qg2r_4,19652
 p3lib/conduit.py,sha256=jPkjdtyCx2I6SFqcEo8y2g7rgnZ-jNY7oCuYIETzT5Q,6046
 p3lib/database_if.py,sha256=XKu1w3zftGbj4Rh54wrWJnoCtqHkhCzJUPN2S70XIKg,11915
 p3lib/helper.py,sha256=xTKPgpziwr4zyaoc0sjZRFr0M91fo7Tok_nSAvtiTZE,12020
@@ -15,8 +15,8 @@ p3lib/pconfig.py,sha256=82rX7zvJVbSFtYYHvhj9I6GTdpjf9v73fNs9WQE-5ik,35388
 p3lib/ssh.py,sha256=OyoAQ_h1L2RfkjTAChDrvLFfl4Fe_gBNdX5rvK-wKiw,42125
 p3lib/table_plot.py,sha256=RPncwVlGUkkx5Fw0dHQedXo0TSPlTi__VrJBDzaMsuI,32116
 p3lib/uio.py,sha256=Aaxc99XiE3d2f9vLjaN-bZsckoNxay5t0ujdK6PXGrw,23265
-p3lib-1.1.96.dist-info/LICENSE,sha256=igqTy5u0kVWM1n-NUZMvAlinY6lVjAXKoag0okkS8V8,1067
-p3lib-1.1.96.dist-info/METADATA,sha256=9J2tVWSBvTAoeO9QPgMjgOlaLiYeDLgG_E6_rR39NTA,918
-p3lib-1.1.96.dist-info/WHEEL,sha256=OVMc5UfuAQiSplgO0_WdW7vXVGAt9Hdd6qtN4HotdyA,91
-p3lib-1.1.96.dist-info/top_level.txt,sha256=SDCpXYh-19yCFp4Z8ZK4B-3J4NvTCJElZ42NPgcR6-U,6
-p3lib-1.1.96.dist-info/RECORD,,
+p3lib-1.1.98.dist-info/LICENSE,sha256=igqTy5u0kVWM1n-NUZMvAlinY6lVjAXKoag0okkS8V8,1067
+p3lib-1.1.98.dist-info/METADATA,sha256=WFRcH8Vj2UU7yFKB7WSeK36IU2lnGh-t9oo6RxSLGmk,918
+p3lib-1.1.98.dist-info/WHEEL,sha256=OVMc5UfuAQiSplgO0_WdW7vXVGAt9Hdd6qtN4HotdyA,91
+p3lib-1.1.98.dist-info/top_level.txt,sha256=SDCpXYh-19yCFp4Z8ZK4B-3J4NvTCJElZ42NPgcR6-U,6
+p3lib-1.1.98.dist-info/RECORD,,