further refactoring, type defintions and version bump, updated manpage

1 files changed, 32 insertions, 25 deletions

diff --git a/ascension/ascension.py b/ascension/ascension.py
index 3f035db..8815d5f 100644
--- a/ascension/ascension.py
+++ b/ascension/ascension.py
@@ -82,7 +82,12 @@ class Ascender():
     """
     Class that provides migration for any given domain
     """
-    def __init__(self, domain, transferns, port, flags, minimum):
+    def __init__(self,
+                 domain: str,
+                 transferns: str,
+                 port: str,
+                 flags: str,
+                 minimum: str) -> None:
         self.domain = domain
         if domain[-1] == '.':
             self.domain = self.domain[:-1]
@@ -97,7 +102,7 @@ class Ascender():
         self.minimum = int(minimum)
         self.subzonedict = dict()
 
-    def bootstrap_zone(self):
+    def bootstrap_zone(self) -> None:
         """
         Creates the zone in gnunet
         """
@@ -108,7 +113,9 @@ class Ascender():
         except sp.CalledProcessError:
             logging.info("Zone %s already exists!", self.domain)
 
-    def get_dns_zone_serial(self, domain, resolver=None):
+    def get_dns_zone_serial(self,
+                            domain: str,
+                            resolver=None) -> dns.rdatatype.SOA:
         """
         Gets the current serial for a given zone
         :param domain: Domain to query for in DNS
@@ -154,7 +161,7 @@ class Ascender():
                     self.transferns = str(soa_record[2].mname)
             return soa_record[2].serial
 
-    def add_records_to_gns(self):
+    def add_records_to_gns(self) -> None:
         """
         Extracts records from zone and adds them to GNS
         :raises AttributeError: When getting incomplete data
@@ -347,7 +354,9 @@ class Ascender():
         logging.info("All records have been added!")
 
     @staticmethod
-    def add_recordline_to_gns(recordline, zonename, label):
+    def add_recordline_to_gns(recordline: list,
+                              zonename: str,
+                              label: str) -> None:
         """
         Replaces records in zone or adds them if not
         :param recordline: records to replace as list in form
@@ -370,7 +379,11 @@ class Ascender():
             logging.info("successfully added record with command %s",
                          ' '.join(ret.args))
 
-    def transform_to_gns_format(self, record, rdtype, zonename, label):
+    def transform_to_gns_format(self,
+                                record: dns.rdata.Rdata,
+                                rdtype: dns.rdata.Rdata,
+                                zonename: str,
+                                label: str) -> tuple:
         """
         Transforms value of record to GNS compatible format
         :param record: record to transform
@@ -469,7 +482,7 @@ class Ascender():
             logging.info("Did not transform record of type: %s", rdtype)
         return (rdtype, value, label)
 
-    def get_gns_zone_serial(self):
+    def get_gns_zone_serial(self) -> int:
         """
         Fetches the zones serial from GNS
         :returns: serial of the SOA record in GNS
@@ -481,24 +494,16 @@ class Ascender():
             serial = serial.decode()
         except sp.CalledProcessError:
             serial = ""
-            soa_serial = None
+            soa_serial = 0
         soapattern = re.compile(r'.+\s(\d+),\d+,\d+,\d+,\d+', re.M)
         if re.findall(soapattern, serial):
             soa_serial = re.findall(soapattern, serial)[0]
         else:
-            soa_serial = None
+            soa_serial = 0
         return soa_serial
 
-    def get_zone_soa_expiry(self):
-        """
-        Extracts the current serial from the class SOA
-        :returns: refresh time of the current SOA record
-        """
-        ttlpattern = re.compile(r'.+\s\d+\s(\d+)\s\d+\s\d+\s\d+', re.M)
-        return re.findall(ttlpattern, str(self.soa[2]))
-
     @staticmethod
-    def get_zone_soa(zone):
+    def get_zone_soa(zone) -> dns.rdatatype.SOA:
         """
         Fetches soa record from zone a given zone
         :param zone: A dnspython zone
@@ -510,7 +515,7 @@ class Ascender():
                 soa = soarecord
         return soa
 
-    def add_soa_record_to_gns(self, record):
+    def add_soa_record_to_gns(self, record) -> None:
         """
         Adds a SOA record to GNS
         :param record: The record to add
@@ -539,7 +544,7 @@ class Ascender():
         self.add_recordline_to_gns(recordline, self.domain, str(label))
 
     @staticmethod
-    def create_zone_and_get_pkey(zonestring):
+    def create_zone_and_get_pkey(zonestring: str) -> str:
         """
         Creates the zone in zonestring and returns pkey
         :param zonestring: The label name of the zone
@@ -569,7 +574,10 @@ class Ascender():
         return pkey_zone
 
     @staticmethod
-    def add_pkey_record_to_zone(pkey, domain, label, ttl):
+    def add_pkey_record_to_zone(pkey: str,
+                                domain: str,
+                                label: str,
+                                ttl: str) -> None:
         """
         Adds the pkey of the subzone to the parent zone
         :param pkey: the public key of the child zone
@@ -600,10 +608,9 @@ class Ascender():
                             label, domain)
         #logging.warning("PKEY record %s already exists in %s", label, domain)
 
-    def create_zone_hierarchy(self):
+    def create_zone_hierarchy(self) -> None:
         """
         Creates the zone hierarchy in GNS for label
-        :param label: the split record to create zones for
         """
         domain = self.domain
 
@@ -624,13 +631,13 @@ def main():
     Initializes object and handles arguments
     """
     # argument parsing from docstring definition
-    args = docopt.docopt(__doc__, version='Ascension 0.5.0')
+    args = docopt.docopt(__doc__, version='Ascension 0.6.0')
 
     # argument parsing
     debug = args['--debug']
     domain = args.get('<domain>', None)
     transferns = args['<transferns>'] if args['<transferns>'] else None
-    port = args['<port>'] if args['<port>'] else 53
+    port = args['<port>'] if args['<port>'] else "53"
     flags = "p" if args.get('--public') else "n"
     standalone = bool(args.get('--standalone'))
     minimum = args['--minimum-ttl']