feat: use standard logging

Author: pamapa

fritzbox/CSV.py

@@ -17,6 +17,7 @@
 #
 
 import csv
+import logging
 
 # fritzbox
 import fritzbox.phonebook
@@ -50,18 +51,18 @@ def __iter__(self):
         return self
 
 
-def find_delimiter(filname, debug=False):
+def find_delimiter(filname, logger: logging.Logger):
   with open(filname, 'r') as f:
     line = f.readline()
     semi_cnt = line.count(";")
     comma_cnt = line.count(",")
     delimiter = ","
     if semi_cnt >  comma_cnt: delimiter = ";"
-    if debug: print("Correct delimiter is '%s'" % delimiter)
+    logger.debug("Correct delimiter is '%s'" % delimiter)
     return delimiter
 
 
-def find_encoding(filname, delimiter, debug=False):
+def find_encoding(filname, delimiter, logger: logging.Logger):
   all_encoding = [
     "utf-8", "iso-8859-1", "iso-8859-2", "iso-8859-15",
     "iso-8859-3", "us-ascii", "windows-1250", "windows-1252",
@@ -71,7 +72,7 @@ def find_encoding(filname, delimiter, debug=False):
   csv_reader = None
   while csv_reader == None:  
     next_encoding = all_encoding[encoding_index]
-    if debug: print("Trying %s" % (next_encoding))
+    logger.debug("Trying %s" % (next_encoding))
     csv_file = open(filname, "rt")
     csv_reader = FindEncodingDictReader(csv_file, delimiter=delimiter, encoding=next_encoding)
     try:
@@ -82,7 +83,7 @@ def find_encoding(filname, delimiter, debug=False):
       csv_reader = None
       encoding_index = encoding_index + 1
 
-  if debug: print("Correct encoding is %s" % next_encoding)
+  logger.debug("Correct encoding is %s" % next_encoding)
   csv_file.close()
   return next_encoding
 
@@ -113,15 +114,15 @@ def getEntityPerson(fields):
   return fritzbox.phonebook.Person(givenName, familyName)
 
 
-def parse_csv(filename, delimiter, encoding, debug=False):
+def parse_csv(filename, delimiter, encoding, logger: logging.Logger):
   csv_file = open(filename, "rt")
   csv_reader = FindEncodingDictReader(csv_file, delimiter=delimiter, encoding=encoding)
 
   phoneBook = fritzbox.phonebook.Phonebook()
   for (line, fields) in enumerate(csv_reader):
-    #if debug: print(fields)
+    #logger.debug(fields)
     person = getEntityPerson(fields)
-    #if debug: print(person)
+    #logger.debug(person)
 
     # phone number: CardDav to Fritz!Box
     map_number_names = {
@@ -175,10 +176,10 @@ def parse_csv(filename, delimiter, encoding, debug=False):
 
 
 class Import(object):
-  def get_books(self, filename, vipGroups, debug=False):
-    delimiter = find_delimiter(filename, debug=debug)
-    encoding = find_encoding(filename, delimiter, debug=debug)
-    book = parse_csv(filename, delimiter, encoding, debug=debug)
+  def get_books(self, filename, vipGroups, logger: logging.Logger=logging.getLogger()):
+    delimiter = find_delimiter(filename, logger)
+    encoding = find_encoding(filename, delimiter, logger)
+    book = parse_csv(filename, delimiter, encoding, logger)
     books = fritzbox.phonebook.Phonebooks()
     books.addPhonebook(book)
     return books

fritzbox/CardDAV.py

@@ -16,6 +16,7 @@
 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 #
 
+import logging
 import requests
 import urllib.parse
 import xml.etree.ElementTree as ET
@@ -34,19 +35,19 @@ def _raise_for_status_code(self, resp):
       raise requests.exceptions.HTTPError(msg)
 
 
-  def _get_xml(self, session, url_dav, settings, debug=False):
+  def _get_xml(self, session, url_dav, settings, logger: logging.Logger):
     response = session.request('PROPFIND', url_dav, headers=[], **settings)
     self._raise_for_status_code(response)
-    #if debug: print("Response: %s" % response.content)
+    #logger.debug("Response: %s" % response.content)
     if response.headers['DAV'].count('addressbook') == 0:
         raise Exception("URL is not a CardDAV resource")
     return response.content
 
 
-  def _process_xml(self, xml, debug=False):
+  def _process_xml(self, xml, logger: logging.Logger):
     namespace = "{DAV:}"
     root = ET.XML(xml)
-    #if debug: print("root: %s" % ET.tostring(root, "utf-8"))
+    #logger.debug("root: %s" % ET.tostring(root, "utf-8"))
     hrefs = dict()
     for response in root:
       if response.tag != namespace + "response":
@@ -72,18 +73,18 @@ def _process_xml(self, xml, debug=False):
     return hrefs
 
 
-  def _get_vcard(self, session, url_vcard, settings, debug=False):
-    if debug: print("_get_vcard(%s)" % url_vcard)
+  def _get_vcard(self, session, url_vcard, settings, logger: logging.Logger):
+    logger.debug("_get_vcard(%s)" % url_vcard)
     response = session.get(url_vcard, headers=[], **settings)
     self._raise_for_status_code(response)
-    #if debug: print("Response: %s" % response.content)
+    #logger.debug("Response: %s" % response.content)
     ret = vobject.readOne(response.content.decode())
     return ret
 
 
   def get_books(self, url, username, password, vipGroups, picture_path,
-                conn_auth="basic", conn_verify=True, debug=False):
-    if debug: print("get_books(%s)" % url)
+                conn_auth="basic", conn_verify=True, logger: logging.Logger=logging.getLogger()):
+    logger.debug("get_books(%s)" % url)
 
     # url base
     url_split = urllib.parse.urlparse(url)
@@ -95,18 +96,17 @@ def get_books(self, url, username, password, vipGroups, picture_path,
       settings["auth"] = (username, password)
     elif conn_auth == "digest":
       from requests.auth import HTTPDigestAuth
-      settings["auth"] = HTTPDigestAuth(user, passwd)
+      settings["auth"] = HTTPDigestAuth(username, password)
 
     session = requests.session()
-    xml = self._get_xml(session, url, settings, debug)
-    hrefs = self._process_xml(xml, debug)
+    xml = self._get_xml(session, url, settings, logger)
+    hrefs = self._process_xml(xml, logger)
 
     # convert into vcard objects
     cards = []
     for href in hrefs.keys():
-      cards.append(self._get_vcard(session, url_base + href, settings, debug))
+      cards.append(self._get_vcard(session, url_base + href, settings, logger))
 
     vcf = fritzbox.VCF.Import()
-    books = vcf.get_books_by_cards(cards, vipGroups, picture_path, debug=debug)
+    books = vcf.get_books_by_cards(cards, vipGroups, picture_path, logger)
     return books
-

fritzbox/LDIF.py

@@ -16,45 +16,45 @@
 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 #
 
+import logging
 from ldif import LDIFParser
 
 # fritzbox
 import fritzbox.phonebook
 
 
 class ParseGroups(LDIFParser):
-  def __init__(self, infile, vipGroupArray, debug=False):
+  def __init__(self, infile, vipGroupArray, logger: logging.Logger):
     LDIFParser.__init__(self, infile)
     self.vipGroupDict = {}
     for g in vipGroupArray:
       self.vipGroupDict[g] = []
-    self._debug = debug
+    self._logger = logger
 
   def _handle(self, dn, entry):
-    #debug(entry)
+    #self._logger.debug(entry)
     cn = self._get_value(entry, "cn")
     oc = entry["objectclass"]
     if cn and len(oc) == 2 and oc[0] == "top" and oc[1] == "groupOfNames":
-      #debug(cn)      
+      #self._logger.debug(cn)
       if cn in self.vipGroupDict:
         for m in entry["member"]:
-          #debug(m)
+          #self._logger.debug(m)
           self.vipGroupDict[cn].append(m)
 
   def _get_value(self, entry, name):
     return entry[name][0] if name in entry else None
 
 
 class ParsePersons(LDIFParser):
-  def __init__(self, infile, vipGroupDict, debug=False):
+  def __init__(self, infile, vipGroupDict, logger: logging.Logger):
       LDIFParser.__init__(self, infile)
       self.phoneBook = fritzbox.phonebook.Phonebook()
       self._vipGroupDict = vipGroupDict
-      self._debug = debug
+      self._logger = logger
 
   def handle(self, dn, entry):
-    if self._debug:
-      print("entry: %s" % entry)
+    self._logger.debug("entry: %s" % entry)
     cn = self._get_value(entry, "cn")
 
     category = self._get_category(entry, cn)
@@ -120,14 +120,14 @@ def _get_services(self, entry):
 
 
 class Import(object):
-  def get_books(self, filename, vipGroupArray, debug=False):
+  def get_books(self, filename, vipGroupArray, logger: logging.Logger=logging.getLogger()):
     # parse groups
-    parser = ParseGroups(open(filename, "rb"), vipGroupArray, debug=debug)
+    parser = ParseGroups(open(filename, "rb"), vipGroupArray, logger)
     parser.parse()
     vipGroupDict = parser.vipGroupDict
 
     # parse persons
-    parser = ParsePersons(open(filename, "rb"), vipGroupDict, debug)
+    parser = ParsePersons(open(filename, "rb"), vipGroupDict, logger)
     parser.parse()
     phoneBook = parser.phoneBook
 

fritzbox/VCF.py

@@ -22,6 +22,7 @@
 import re
 import codecs
 import vobject
+import logging
 
 from PIL import Image
 from PIL import ImageOps
@@ -31,16 +32,16 @@
 
 
 class Import(object):
-  def get_books(self, filename, vipGroups, picture_path, debug=False):
+  def get_books(self, filename, vipGroups, picture_path, logger: logging.Logger=logging.getLogger()):
     cards = []
     with codecs.open(filename, "r", "utf-8") as infile:
       data = infile.read()
       for card in vobject.readComponents(data):
         cards.append(card)
-    return self.get_books_by_cards(cards, vipGroups, picture_path, debug)
+    return self.get_books_by_cards(cards, vipGroups, picture_path, logger)
 
 
-  def get_books_by_cards(self, cards, vipGroups, picture_path, debug=False):
+  def get_books_by_cards(self, cards, vipGroups, picture_path, logger: logging.Logger):
     # phone number: CardDav to Fritz!Box
     map_number_types = {
       "work":   "work",
@@ -63,7 +64,7 @@ def get_books_by_cards(self, cards, vipGroups, picture_path, debug=False):
 
     book = fritzbox.phonebook.Phonebook()
     for card in cards: # card: vobject.base.Component
-      #print (card)
+      #logger.debug(card)
 
       # name
       givenName = ""
@@ -79,8 +80,8 @@ def get_books_by_cards(self, cards, vipGroups, picture_path, debug=False):
           familyName = tmp_split[1]
         else:
           givenName = tmp
-        print("Warning: N field missing, using FN field instead: '%s'" % givenName)
-      #print("Name: %s %s" % (givenName, familyName))
+        logger.warn("N field missing, using FN field instead: '%s'" % givenName)
+      #logger.debug("Name: %s %s" % (givenName, familyName))
 
       # category
       category = 0
@@ -99,7 +100,7 @@ def get_books_by_cards(self, cards, vipGroups, picture_path, debug=False):
         params_types = child.params.get("TYPE", [])
         itype = self._get_params_type(params_types, map_number_types)
         if itype is None:
-          print("Warning: Phone number missing/unsupported TYPE, using 'home' instead (%s %s, %s)" % (givenName, familyName, params_types))
+          logger.warn("Phone number missing/unsupported TYPE, using 'home' instead (%s %s, %s)" % (givenName, familyName, params_types))
           itype = "home"
 
         ntype = map_number_types[itype]
@@ -116,7 +117,7 @@ def get_books_by_cards(self, cards, vipGroups, picture_path, debug=False):
         params_types = child.params.get("TYPE", [])
         itype = self._get_params_type(params_types, map_email_types)
         if itype is None:
-          print("Warning: Email missing/unsupported TYPE, using 'home' instead (%s %s, %s)" % (givenName, familyName, params_types))
+          logger.warn("Email missing/unsupported TYPE, using 'home' instead (%s %s, %s)" % (givenName, familyName, params_types))
           itype = "home"
 
         etype = map_email_types[itype]
@@ -130,10 +131,10 @@ def get_books_by_cards(self, cards, vipGroups, picture_path, debug=False):
         params_types = card.photo.params.get("TYPE", [])
         itype = self._get_params_type(params_types, map_image_types)
         if itype is None:
-          print("Error: Not supported photo type (%s %s): '%s'" % (givenName, familyName, params_types))
+          logger.error("Not supported photo type (%s %s): '%s'" % (givenName, familyName, params_types))
           continue
         if card.photo.encoding_param.lower() != "b":
-          print("Error: Unknown photo encoding (%s %s): '%s'" % (givenName, familyName, card.photo.encoding_param.lower()))
+          logger.error("Unknown photo encoding (%s %s): '%s'" % (givenName, familyName, card.photo.encoding_param.lower()))
           continue
 
         if not os.path.exists(picture_path):
@@ -161,10 +162,10 @@ def get_books_by_cards(self, cards, vipGroups, picture_path, debug=False):
         max_size = (128, 128)
         width, height = img.size
         if width != height:
-          print("Warning: Photo not square (%s %s %s): make it square with %s" % (givenName, familyName, img.size, max_size))
+          logger.warn("Photo not square (%s %s %s): make it square with %s" % (givenName, familyName, img.size, max_size))
           img = ImageOps.fit(img, max_size, Image.BICUBIC)
         elif img.size > max_size:
-          print("Warning: Photo too big (%s %s %s): resize to %s" % (givenName, familyName, img.size, max_size))
+          logger.warn("Photo too big (%s %s %s): resize to %s" % (givenName, familyName, img.size, max_size))
           img = img.resize(max_size, Image.BICUBIC)
 
         # remove alpha channel if there

fritzbox/phonebook.py

@@ -94,7 +94,7 @@ def calculateMainNumber(self):
           found = True
           break
       if found: break
-          
+
   def getXML(self):
     xml = ET.Element("telephony")
     for ntype in self.numberDict:

requirements.txt

@@ -1,5 +1,8 @@
 beautifulsoup4==4.12.2
 fritzconnection==1.13.2
 lxml==5.0.0
+pillow==10.2.0
+python-ldap==3.4.4
 requests==2.31.0
+vobject==0.9.6.1