Merge pull request #62 from homebysix/python-black

Consider using Python Black for automatic formatting consistency

Author: magnusviri

jamf/admin.py

@@ -6,10 +6,10 @@
 Modifications by Tony Williams ([email protected]) (ARW)
 """
 
-__author__ = 'Sam Forester'
-__email__ = '[email protected]'
-__copyright__ = 'Copyright (c) 2020 University of Utah, Marriott Library'
-__license__ = 'MIT'
+__author__ = "Sam Forester"
+__email__ = "[email protected]"
+__copyright__ = "Copyright (c) 2020 University of Utah, Marriott Library"
+__license__ = "MIT"
 __version__ = "0.4.7"
 
 import html.parser
@@ -27,20 +27,24 @@
 
 LOGLEVEL = logging.INFO
 
-#pylint: disable=unnecessary-pass
+# pylint: disable=unnecessary-pass
 class Error(Exception):
-    """ just passing through """
+    """just passing through"""
+
     pass
 
 
-#pylint: disable=super-init-not-called
+# pylint: disable=super-init-not-called
 class APIError(Error):
-    """ Error in our call """
+    """Error in our call"""
+
     def __init__(self, response):
         self.response = response
         err = parse_html_error(response.text)
-        self.message = ": ".join(err) or 'failed'
-        print(f"{response}: {response.request.method} - {response.url}: \n{self.message}")
+        self.message = ": ".join(err) or "failed"
+        print(
+            f"{response}: {response.request.method} - {response.url}: \n{self.message}"
+        )
 
     def __getattr__(self, attr):
         """
@@ -54,8 +58,10 @@ def __str__(self):
 
 
 class Singleton(type):
-    """ allows us to share a single object """
+    """allows us to share a single object"""
+
     _instances = {}
+
     def __call__(cls, *a, **kw):
         if cls not in cls._instances:
             cls._instances[cls] = super(Singleton, cls).__call__(*a, **kw)
@@ -66,14 +72,12 @@ class API(metaclass=Singleton):
     """
     Class for making api calls to JSS
     """
+
     session = False
 
-    def __init__(self,
-                 config_path=None,
-                 hostname=None,
-                 username=None,
-                 password=None,
-                 prompt=True):
+    def __init__(
+        self, config_path=None, hostname=None, username=None, password=None, prompt=True
+    ):
         """
         Create requests.Session with JSS address and authentication
 
@@ -88,25 +92,27 @@ def __init__(self,
         self.log = logging.getLogger(f"{__name__}.API")
         self.log.setLevel(LOGLEVEL)
         # Load Prefs and Init session
-        conf = config.Config(config_path=config_path,
-                             hostname=hostname,
-                             username=username,
-                             password=password,
-                             prompt=prompt)
+        conf = config.Config(
+            config_path=config_path,
+            hostname=hostname,
+            username=username,
+            password=password,
+            prompt=prompt,
+        )
         hostname = hostname or conf.hostname
         username = username or conf.username
         password = password or conf.password
 
         if not hostname and not username and not password:
             print("No jamf hostname or credentials could be found.")
             exit(1)
-        if hostname[-1] == '/':
+        if hostname[-1] == "/":
             self.url = f"{hostname}JSSResource"
         else:
             self.url = f"{hostname}/JSSResource"
         self.session = requests.Session()
         self.session.auth = (username, password)
-        self.session.headers.update({'Accept': 'application/xml'})
+        self.session.headers.update({"Accept": "application/xml"})
 
     def get(self, endpoint, raw=False):
         """
@@ -229,7 +235,8 @@ def __del__(self):
             self.log.debug("closing session")
             self.session.close()
 
-#pylint: disable=too-few-public-methods, abstract-method
+
+# pylint: disable=too-few-public-methods, abstract-method
 class _DummyTag:
     """
     Minimal mock implementation of bs4.element.Tag (only has text attribute)
@@ -238,6 +245,7 @@ class _DummyTag:
     >>> eg.text
     'some text'
     """
+
     def __init__(self, text):
         self.text = text
 
@@ -250,6 +258,7 @@ class JSSErrorParser(html.parser.HTMLParser):
     ['Unauthorized', 'The request requires user authentication',
      'You can get technical details here. {...}']
     """
+
     def __init__(self, _html):
         super().__init__()
         self._data = {}
@@ -265,7 +274,7 @@ def find_all(self, tag):
         """
         return self._data.get(tag, [])
 
-    #pylint: disable=attribute-defined-outside-init
+    # pylint: disable=attribute-defined-outside-init
     def handle_data(self, data):
         """
         override HTMLParser().handle_data()
@@ -284,6 +293,7 @@ def handle_endtag(self, tag):
         self._data.setdefault(tag, [])
         self._data[tag].append(self._dummytag)
 
+
 def parse_html_error(error):
     """
     Get meaningful error information from JSS Error response HTML
@@ -298,4 +308,4 @@ def parse_html_error(error):
     #        'You can get technical details here. (...)']
     # NOTE: get first two <p> tags from HTML error response
     #       3rd <p> is always 'You can get technical details here...'
-    return [t.text for t in soup.find_all('p')][0:2]
+    return [t.text for t in soup.find_all("p")][0:2]

jamf/api.py

@@ -4,32 +4,35 @@
 Configuration for jamfutil
 """
 
-__author__ = 'Sam Forester'
-__email__ = '[email protected]'
-__copyright__ = 'Copyright (c) 2020 University of Utah, Marriott Library'
-__license__ = 'MIT'
+__author__ = "Sam Forester"
+__email__ = "[email protected]"
+__copyright__ = "Copyright (c) 2020 University of Utah, Marriott Library"
+__license__ = "MIT"
 __version__ = "1.2.4"
 
 import getpass
 import logging
 import plistlib
 import keyring
 from os import path, remove
-LINUX_PREFS_TILDA = '~/.edu.utah.mlib.jamfutil.plist'
-MACOS_PREFS_TILDA = '~/Library/Preferences/edu.utah.mlib.jamfutil.plist'
-AUTOPKG_PREFS_TILDA = '~/Library/Preferences/com.github.autopkg.plist'
-JAMF_PREFS = '/Library/Preferences/com.jamfsoftware.jamf.plist'
+
+LINUX_PREFS_TILDA = "~/.edu.utah.mlib.jamfutil.plist"
+MACOS_PREFS_TILDA = "~/Library/Preferences/edu.utah.mlib.jamfutil.plist"
+AUTOPKG_PREFS_TILDA = "~/Library/Preferences/com.github.autopkg.plist"
+JAMF_PREFS = "/Library/Preferences/com.jamfsoftware.jamf.plist"
 logging.getLogger(__name__).addHandler(logging.NullHandler())
 
 
 class Config:
-    def __init__(self,
-                 config_path=None,
-                 hostname=None,
-                 username=None,
-                 password=None,
-                 prompt=False,
-                 explain=False):
+    def __init__(
+        self,
+        config_path=None,
+        hostname=None,
+        username=None,
+        password=None,
+        prompt=False,
+        explain=False,
+    ):
         self.log = logging.getLogger(f"{__name__}.{self.__class__.__name__}")
         self.prompt = prompt
         self.hostname = hostname
@@ -42,39 +45,39 @@ def __init__(self,
                 autopkg_prefs = path.expanduser(AUTOPKG_PREFS_TILDA)
                 if path.exists(macos_prefs):
                     if explain:
-                        print("Using macos: "+macos_prefs)
+                        print("Using macos: " + macos_prefs)
                     config_path = macos_prefs
                 elif path.exists(linux_prefs):
                     if explain:
-                        print("Using linux: "+linux_prefs)
+                        print("Using linux: " + linux_prefs)
                     config_path = linux_prefs
                 elif path.exists(autopkg_prefs):
                     if explain:
-                        print("Using autopkg: "+autopkg_prefs)
+                        print("Using autopkg: " + autopkg_prefs)
                     config_path = autopkg_prefs
                 elif path.exists(JAMF_PREFS):
                     if explain:
-                        print("Using jamf: "+JAMF_PREFS)
+                        print("Using jamf: " + JAMF_PREFS)
                     config_path = JAMF_PREFS
                 else:
                     if explain:
-                        print("Using "+macos_prefs+" but it doesn't exist yet.")
+                        print("Using " + macos_prefs + " but it doesn't exist yet.")
                     config_path = macos_prefs
             elif explain:
-                    print("Using "+config_path+" because you said so.")
+                print("Using " + config_path + " because you said so.")
 
-            if config_path[0] == '~':
+            if config_path[0] == "~":
                 config_path = path.expanduser(config_path)
                 if explain:
-                    print("Expanding the path. Using "+config_path)
+                    print("Expanding the path. Using " + config_path)
 
             if not self.hostname and not self.username and not self.password:
                 if path.exists(config_path):
-                    fptr = open(config_path, 'rb')
+                    fptr = open(config_path, "rb")
                     prefs = plistlib.load(fptr)
                     fptr.close()
-                    if 'JSSHostname' in prefs:
-                        if 'Credentials' in prefs:
+                    if "JSSHostname" in prefs:
+                        if "Credentials" in prefs:
                             cmessage = f"""
 ATTENTION
 To improve security with storing credentials used with the jctl tool, we have
@@ -87,15 +90,16 @@ def __init__(self,
 the "./jamf/setconfig.py" script.
 """
                             raise Exception(cmessage)
-                        self.hostname = prefs['JSSHostname']
-                        self.username = prefs['Username']
-                        self.password = keyring.get_password(self.hostname,
-                                                             self.username)
-                    elif 'JSS_URL' in prefs:
+                        self.hostname = prefs["JSSHostname"]
+                        self.username = prefs["Username"]
+                        self.password = keyring.get_password(
+                            self.hostname, self.username
+                        )
+                    elif "JSS_URL" in prefs:
                         self.hostname = prefs["JSS_URL"]
                         self.username = prefs["API_USERNAME"]
                         self.password = prefs["API_PASSWORD"]
-                    elif 'jss_url' in prefs:
+                    elif "jss_url" in prefs:
                         self.hostname = prefs["jss_url"]
                         # No auth in that file
                 else:
@@ -112,16 +116,13 @@ def __init__(self,
             if not self.password:
                 self.password = getpass.getpass()
         elif not self.hostname and not self.username and not self.password:
-            raise Exception('No jamf config file could be found and prompt is off.')
+            raise Exception("No jamf config file could be found and prompt is off.")
 
     def save(self, config_path=None):
         keyring.set_password(self.hostname, self.username, self.password)
-        data = {
-            'JSSHostname': self.hostname,
-            'Username': self.username
-        }
+        data = {"JSSHostname": self.hostname, "Username": self.username}
         self.log.info(f"saving: {config_path}")
-        fptr = open(config_path, 'wb')
+        fptr = open(config_path, "wb")
         plistlib.dump(data, fptr)
         fptr.close()
 
@@ -131,4 +132,4 @@ def reset(self, path):
 
 
 def prompt_hostname():
-    return input('Hostname (don\'t forget https:// and :8443): ')
+    return input("Hostname (don't forget https:// and :8443): ")

jamf/config.py

@@ -4,10 +4,10 @@
 XML and JSON data conversion functions
 """
 
-__author__ = 'Sam Forester'
-__email__ = '[email protected]'
-__copyright__ = 'Copyright (c) 2019 University of Utah, Marriott Library'
-__license__ = 'MIT'
+__author__ = "Sam Forester"
+__email__ = "[email protected]"
+__copyright__ = "Copyright (c) 2019 University of Utah, Marriott Library"
+__license__ = "MIT"
 __version__ = "0.2.2"
 
 from xml.etree import cElementTree as ElementTree
@@ -16,7 +16,8 @@
 
 
 class Error(Exception):
-    """ just passing through """
+    """just passing through"""
+
     pass
 
 
@@ -35,7 +36,7 @@ def etree_to_dict(elem):
                 defd[key].append(val)
         result = {
             elem.tag: {
-                key:val[0] if len(val) == 1 else val for key, val in defd.items()
+                key: val[0] if len(val) == 1 else val for key, val in defd.items()
             }
         }
     elif elem.text:
@@ -49,7 +50,7 @@ def dict_to_xml(data):
     :returns:  xml string
     """
     if isinstance(data, dict):
-        xml_str = ''
+        xml_str = ""
         for key, value in data.items():
             if value is None:
                 xml_str += f"<{key}/>"