Add docstrings

.gitignore

@@ -0,0 +1,4 @@
+old/
+probe.py
+__pycache__
+.idea

VoidServiceControl/classes.py

@@ -0,0 +1,151 @@
+# -*- coding: utf-8 -*-
+from enum import Enum
+from os import listdir as ls
+from subprocess import run as execute
+from subprocess import PIPE
+from sys import argv
+
+from VoidServiceControl.env import *
+
+
+class Help(Exception):
+    def __str__(self) -> str:
+        """
+        Returns the program usage help
+        :return: Program usage help
+        """
+        return ("Usage:\n---\nvsc {e/enable/on/up} <service_name> - Run service and add it to autostart\nvsc {"
+                "d/disable/off/down <service_name> - Stop service and remove it from autostart")
+
+
+def Su() -> None:
+    """
+    Checks if the user has administrator rights
+    """
+    user = execute('whoami', shell=True, text=True, stdout=PIPE).stdout[:-1]
+    if user != 'root':
+        raise PermissionError("Error: Access denied")
+
+
+# Types of service actions
+class Action(Enum):
+    ENABLE = ["enable", "e", "on", "up"]
+    DISABLE = ["disable", "d", "off", "down"]
+
+
+# Types of run arguments
+class Arg(Enum):
+    HELP = ["--help", "-h", "help"]
+
+    @classmethod
+    def all(cls) -> list[str]:
+        """
+        Returns all types of run arguments
+        :return: All types of run arguments list
+        """
+        return cls.HELP.value + cls.__action()
+
+    @classmethod
+    def __action(cls) -> list[str]:
+        """
+        Returns all types of service actions
+        :return: All types of service actions list
+        """
+        actions = list(map(lambda action: action.value, Action))
+        out = []
+        for lst in actions:
+            out.extend(lst)
+        return out
+
+
+class Args(object):
+
+    def __init__(self) -> None:
+        self.__arguments = argv[1:]
+        self.__check()
+
+    def __check(self) -> None:
+        """
+        Checks the arguments
+        """
+        if len(self.__arguments) != 2 and self.__arguments[0] not in Arg.HELP.value:
+            raise TypeError("Error: Bad Usage")
+        if self.__arguments[0] in Arg.HELP.value:
+            raise Help()
+        if self.__arguments[0] not in Arg.all():
+            raise TypeError("Error: Invalid args")
+
+    def __action(self) -> Action:
+        """
+        Returns the action to the service
+        :return: Service action
+        """
+        actions = list(Action)
+        for action in actions:
+            if self.__arguments[0] in action.value:
+                return action
+
+    def __iter__(self):
+        yield self.__action()
+        yield self.__arguments[1]
+
+
+class Service(object):
+    __enabled = False
+
+    def __init__(self, name: str) -> None:
+        self.__name = name
+        self.__check()
+
+    def __check(self) -> None:
+        """
+        Checks if the service exists and is enabled
+        """
+        all_services = ls(SV_PATH)
+        enabled_services = ls(ENABLED_PATH)
+        if self.__name not in all_services:
+            raise ValueError(f"Error: Service {self.__name} doesn't exists")
+        if self.__name in enabled_services:
+            self.__enabled = True
+
+    def getname(self) -> str:
+        """
+        Returns the service name
+        :return: Service name
+        """
+        return self.__name
+
+    def enable(self) -> None:
+        """
+        Enable the service
+        """
+        if self.__enabled:
+            raise ValueError(f"Error: Service {self.__name} already enabled")
+        execute(f'ln -s {SV_PATH}/{self.__name} {ENABLED_PATH}/', shell=True)
+
+    def disable(self):
+        """
+        Disable the service
+        """
+        if not self.__enabled:
+            raise ValueError(f"Error: Service {self.__name} already disabled")
+        execute(f'rm {ENABLED_PATH}/{self.__name}', shell=True)
+
+
+class Interface(object):
+
+    def __init__(self, service: str) -> None:
+        self.service = Service(service)
+
+    def action(self, action: Action) -> None:
+        """
+        Performs an action on the service
+        :param action: Action on the service
+        """
+        match action:
+            case Action.ENABLE:
+                self.service.enable()
+                print(f"Service '{self.service.getname()}' successfully enabled")
+            case Action.DISABLE:
+                self.service.disable()
+                print(f"Service '{self.service.getname()}' successfully disabled")

VoidServiceControl/env.py

@@ -0,0 +1,6 @@
+# -*- coding: utf-8 -*-
+
+# Edit this file if you are using custom paths to Runit services
+
+SV_PATH = '/etc/sv'
+ENABLED_PATH = '/var/service'

vsc.py

@@ -1,81 +0,0 @@
-#!/usr/bin/python3
-# -*- coding: utf-8 -*-
-
-# Import
-import os, subprocess, sys
-
-# Const
-SV_PATH = '/etc/sv'
-ENABLED_PATH = '/var/service'
-
-# Access
-def su():
-    out = subprocess.run('whoami', shell=True, text=True, stdout=subprocess.PIPE)
-    user = out.stdout[:-1]
-    if user == 'root':
-        return True
-    else:
-        return False
-
-# Print help message 
-def helpmsg():
-    print('''
-Usage:
----
-vsc {e/enable/on/up} <service_name> - Run service and add it to autostart
-vsc {d/disable/off/down <service_name> - Stop service and remove it from autostart
----
-''')
-    sys.exit(1)
-
-# Check exec args
-def args_check():
-    args = sys.orig_argv[2:]
-    if len(args) == 2:
-        return args
-    elif len(args) == 1 and args[0] in ['--h','--help']:
-        helpmsg()
-    else:
-        return False
-
-# Check availability
-def availability(service, action):
-    all = os.listdir(SV_PATH)
-    enabled = os.listdir(ENABLED_PATH)
-    all = service in all
-    if all == False:
-        raise Exception(f"Service '{service}' doesn't exist")
-    if service in enabled:
-        if action == 'on':
-            raise Exception(f"Service '{service}' already enabled")
-        elif action == 'off':
-            return True
-    else:
-        if action == 'off':
-            raise Exception(f"Service '{service}' already disabled")
-        elif action == 'on':
-            return True
-
-# Main
-def main():
-    try:
-        args = args_check()
-        if args == False:
-            raise Exception('Bad usage. See --help')
-        if su() == False:
-            raise Exception('Access denied')
-        action, service = args
-        if action in ['enable','e','on','up']:
-            if availability(service,'on'):
-                subprocess.run(f'ln -s {SV_PATH}/{service} {ENABLED_PATH}/', shell=True)
-                print(f"Service '{service}' successfully enabled")
-        if action in ['disable','d','off','down']:
-            if availability(service,'off'):
-                subprocess.run(f'rm {ENABLED_PATH}/{service}', shell=True)
-                print(f"Service '{service}' successfully disabled")
-    except Exception as ex:
-        print(ex)
-        sys.exit(0)
-
-if __name__ == '__main__':
-    main()