trigger 2.2.6__tar.gz → 2.3.0__tar.gz

{trigger-2.2.6/trigger.egg-info → trigger-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: trigger
-Version: 2.2.6
+Version: 2.3.0
 Summary: Network automation toolkit for managing network devices
 Author-email: Jathan McCollum <jathan@gmail.com>
 License-Expression: BSD-3-Clause
@@ -13,7 +13,7 @@ Requires-Python: <3.12,>=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
 License-File: AUTHORS.md
-Requires-Dist: IPy>=1.01
+Requires-Dist: netaddr<2,>=1.0.0
 Requires-Dist: cryptography>=41.0.0
 Requires-Dist: Twisted>=22.10.0
 Requires-Dist: crochet>=2.0.0

{trigger-2.2.6 → trigger-2.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "trigger"
-version = "2.2.6"
+version = "2.3.0"
 description = "Network automation toolkit for managing network devices"
 readme = "README.md"
 license = "BSD-3-Clause"
@@ -18,7 +18,7 @@ classifiers = [
     "Framework :: Twisted",
 ]
 dependencies = [
-    "IPy>=1.01",
+    "netaddr>=1.0.0,<2",
     "cryptography>=41.0.0",
     "Twisted>=22.10.0",
     "crochet>=2.0.0",

{trigger-2.2.6 → trigger-2.3.0}/trigger/acl/ios.py

@@ -27,7 +27,7 @@ class Remark(Comment):  # noqa: F405
 # Build a table to unwind Cisco's weird inverse netmask.
 # TODO (jathan): These don't actually get sorted properly, but it doesn't seem
 # to have mattered up until now. Worth looking into it at some point, though.
-inverse_mask_table = dict([(make_inverse_mask(x), x) for x in range(33)])  # noqa: F405
+inverse_mask_table = {str(make_inverse_mask(x)): x for x in range(33)}  # noqa: F405
 
 
 def handle_ios_match(a):  # noqa: D103, PLR0912
@@ -129,7 +129,7 @@ rules.update(  # noqa: F405
         ),
         "ipv4_inverse_mask": (
             literals(inverse_mask_table),  # noqa: F405
-            lambda x: inverse_mask_table[TIP(x)],  # noqa: F405
+            lambda x: inverse_mask_table[x],
         ),
         "kw_ip": ('"ip"', None),
         S("ios_match"): (  # noqa: F405

{trigger-2.2.6 → trigger-2.3.0}/trigger/acl/support.py

@@ -29,15 +29,12 @@ support the various modules for parsing. This file is not meant to by used by it
 import contextlib
 from typing import ClassVar
 
-import IPy
+import netaddr
 
 from trigger import exceptions
 
 from .dicts import *  # noqa: F403
 
-# Python 2/3 compatibility
-unicode = str
-
 # Temporary resting place for comments, so the rest of the parser can
 # ignore them.  Yes, this makes the library not thread-safe.
 Comments = []
@@ -130,13 +127,13 @@ def do_dscp_lookup(arg):  # noqa: D103
 
 
 def make_inverse_mask(prefixlen):
-    """Return an IP object of the inverse mask of the CIDR prefix.
+    """Return an IP address object of the inverse mask of the CIDR prefix.
 
     :param prefixlen:
         CIDR prefix
     """
     inverse_bits = 2 ** (32 - prefixlen) - 1
-    return TIP(inverse_bits)
+    return netaddr.IPAddress(inverse_bits)
 
 
 def strip_comments(tags):  # noqa: D103
@@ -431,12 +428,13 @@ class RangeList:
         return self.data.__iter__()
 
 
-class TIP(IPy.IP):
-    """Class based on IPy.IP, but with extensions for Trigger.
+class TIP(netaddr.IPNetwork):
+    """Class based on netaddr.IPNetwork, but with extensions for Trigger.
 
     Currently, only the only extension is the ability to negate a network
     block. Only used internally within the parser, as it's not complete
-    (doesn't interact well with IPy.IP objects). Does not handle IPv6 yet.
+    (doesn't interact well with netaddr.IPNetwork objects). Does not handle
+    IPv6 yet.
     """
 
     def __init__(self, data, **kwargs):  # noqa: D107
@@ -448,7 +446,7 @@ class TIP(IPy.IP):
         inactive = getattr(data, "inactive", False)
 
         # Is data a string?
-        if isinstance(data, (str, unicode)):
+        if isinstance(data, str):
             d = data.split()
             # This means we got something like "1.2.3.4 except" or "inactive:
             # 1.2.3.4'
@@ -471,87 +469,101 @@ class TIP(IPy.IP):
 
         self.negated = negated  # Set 'negated' variable
         self.inactive = inactive  # Set 'inactive' variable
-        IPy.IP.__init__(self, data, **kwargs)
 
-        # Make it print prefixes for /32, /128 if we're negated or inactive (and
-        # therefore assuming we're being used in a Juniper ACL.)
-        if self.negated or self.inactive:
-            self.NoPrefixForSingleIp = False
+        # Expand partial IPv4 addresses like "10/8" → "10.0.0.0/8"
+        if isinstance(data, str) and "/" in data:
+            parts = data.split("/")
+            addr_part = parts[0]
+            # Only apply to IPv4 (no colons in address part)
+            if ":" not in addr_part:
+                octets = addr_part.split(".")
+                while len(octets) < 4:  # noqa: PLR2004
+                    octets.append("0")
+                data = ".".join(octets) + "/" + parts[1]
+
+        super().__init__(data, **kwargs)
 
     def _compare_to(self, other):
         """Helper method for comparison. Returns -1, 0, or 1."""  # noqa: D401
-        # Regular IPy sorts by prefix length before network base, but Juniper
-        # (our baseline) does not. We also need comparisons to be different for
-        # negation. Following Juniper's sorting, use IP compare, and then break
+        # Following Juniper's sorting, use IP compare, and then break
         # ties where negated < not negated.
-        # Python 3: Implement cmp() logic inline
-        if self.ip < other.ip:
+        self_first = self.first
+        if hasattr(other, "first"):
+            other_first = other.first
+        else:
+            return NotImplemented
+        if self_first < other_first:
             diff = -1
-        elif self.ip > other.ip:
+        elif self_first > other_first:
             diff = 1
         else:
             diff = 0
 
         if diff == 0:
             # If the same IP, compare by prefixlen
-            if self.prefixlen() < other.prefixlen():
+            if self.prefixlen < other.prefixlen:
                 diff = -1
-            elif self.prefixlen() > other.prefixlen():
+            elif self.prefixlen > other.prefixlen:
                 diff = 1
             else:
                 diff = 0
 
         # If both negated, they're the same
-        if self.negated == other.negated:
+        other_negated = getattr(other, "negated", False)
+        if self.negated == other_negated:
             return diff
         # Sort to make negated < not negated
         return -1 if self.negated else 1
-        # Return the base comparison
 
     def __lt__(self, other):  # noqa: D105
-        return self._compare_to(other) < 0
+        result = self._compare_to(other)
+        if result is NotImplemented:
+            return NotImplemented
+        return result < 0
 
     def __le__(self, other):  # noqa: D105
-        return self._compare_to(other) <= 0
+        result = self._compare_to(other)
+        if result is NotImplemented:
+            return NotImplemented
+        return result <= 0
 
     def __gt__(self, other):  # noqa: D105
-        return self._compare_to(other) > 0
+        result = self._compare_to(other)
+        if result is NotImplemented:
+            return NotImplemented
+        return result > 0
 
     def __ge__(self, other):  # noqa: D105
-        return self._compare_to(other) >= 0
+        result = self._compare_to(other)
+        if result is NotImplemented:
+            return NotImplemented
+        return result >= 0
 
     def __eq__(self, other):  # noqa: D105
-        return self._compare_to(other) == 0
+        result = self._compare_to(other)
+        if result is NotImplemented:
+            return NotImplemented
+        return result == 0
 
     def __ne__(self, other):  # noqa: D105
-        return self._compare_to(other) != 0
+        result = self._compare_to(other)
+        if result is NotImplemented:
+            return NotImplemented
+        return result != 0
 
     def __hash__(self):  # noqa: D105
-        # Make TIP hashable for use in sets and as dict keys
-        # Base hash on IP address, prefix length, and negation status
-        return hash((str(self.ip), self.prefixlen(), self.negated, self.inactive))
+        return hash((self.first, self.prefixlen, self.negated, self.inactive))
 
     def __repr__(self):  # noqa: D105
-        # Just stick an 'except' at the end if except is set since we don't
-        # code to accept this in the constructor really just provided, for now,
-        # as a debugging aid.
-        rs = IPy.IP.__repr__(self)
-        if self.negated:
-            # Insert ' except' into the repr. (Yes, it's a hack!)
-            rs = rs.split("'")
-            rs[1] += " except"
-            rs = "'".join(rs)  # Restore original repr
-        if self.inactive:
-            # Insert 'inactive: ' into the repr. (Yes, it's also a hack!)
-            rs = rs.split("'")
-            rs[1] = "inactive: " + rs[1]
-            rs = "'".join(rs)  # Restore original repr
-        return rs
+        return f"TIP('{self!s}')"
 
     def __str__(self):  # noqa: D105
-        # IPy is not a new-style class, so the following doesn't work:
-        # return super(TIP, self).__str__()  # noqa: ERA001
-        rs = IPy.IP.__str__(self)
+        # Show prefix for all networks, but omit for single hosts (/32, /128)
+        # unless negated or inactive (Juniper ACL style needs prefix)
+        if self.prefixlen in (32, 128) and not self.negated and not self.inactive:
+            rs = str(self.ip)
+        else:
+            rs = f"{self.network}/{self.prefixlen}"
         if self.negated:
             rs += " except"
         if self.inactive:
@@ -566,9 +578,39 @@ class TIP(IPy.IP):
         # If one item is negated, it's never contained.
         if xor:
             return False
-        matched = IPy.IP.__contains__(self, item)
+        matched = super().__contains__(item)
         return matched ^ self.negated
 
+    # Prevent netaddr's iteration/subscript protocol from interfering with
+    # RangeList, which would otherwise treat TIP as a sequence of integers.
+    def __iter__(self):  # noqa: D105
+        msg = f"'{type(self).__name__}' object is not iterable"
+        raise TypeError(msg)
+
+    def __getitem__(self, index):  # noqa: D105
+        msg = f"'{type(self).__name__}' object is not subscriptable"
+        raise TypeError(msg)
+
+    def __len__(self):  # noqa: D105
+        msg = f"'{type(self).__name__}' object has no len()"
+        raise TypeError(msg)
+
+    # Compatibility methods for code that uses IPy-style API
+    def net(self):
+        """Return the network address as an IPAddress object."""
+        return self.network
+
+    def strNormal(self, mode=0):
+        """Return string representation compatible with IPy's strNormal.
+
+        :param mode:
+            0 = address without prefix for host, with prefix for network
+            1 = address with prefix always
+        """
+        if mode == 0 and self.prefixlen in (32, 128):
+            return str(self.ip)
+        return f"{self.network}/{self.prefixlen}"
+
 
 class Comment:
     """Container for inline comments."""
@@ -1246,8 +1288,12 @@ class Matches(MyDict):
             return "%s-%s" % pair  # noqa: UP031  # Tuples back to ranges.
         except TypeError:
             with contextlib.suppress(AttributeError):
-                # Make it print prefixes for /32, /128
-                pair.NoPrefixForSingleIp = False
+                # Force prefix display for /32 and /128 in JunOS output
+                if hasattr(pair, "prefixlen") and pair.prefixlen in (32, 128):
+                    result = f"{pair.network}/{pair.prefixlen}"
+                    if getattr(pair, "negated", False):
+                        result += " except"
+                    return result
         return str(pair)
 
     def ios_port_str(self, ports):
@@ -1286,12 +1332,12 @@ class Matches(MyDict):
                 raise exceptions.VendorSupportLacking(
                     msg,
                 )
-            if addr.prefixlen() == 0:
+            if addr.prefixlen == 0:
                 a.append("any")
-            elif addr.prefixlen() == 32:  # noqa: PLR2004
+            elif addr.prefixlen == 32:  # noqa: PLR2004
                 a.append(f"host {addr.net()}")
             else:
-                inverse_mask = make_inverse_mask(addr.prefixlen())
+                inverse_mask = make_inverse_mask(addr.prefixlen)
                 a.append(f"{addr.net()} {inverse_mask}")
         return a
 

{trigger-2.2.6 → trigger-2.3.0}/trigger/acl/tools.py

@@ -9,9 +9,8 @@ import tempfile
 from collections import defaultdict
 from pathlib import Path
 
-import IPy
-
 from trigger.acl.parser import *  # noqa: F403
+from trigger.acl.support import TIP
 from trigger.conf import settings
 
 # Defaults
@@ -667,10 +666,10 @@ class ACLScript:
     def _add_addr(self, to, src):
         if isinstance(src, list):
             for x in src:
-                if IPy.IP(x) not in to:
-                    to.append(IPy.IP(x))
-        elif IPy.IP(src) not in to:
-            to.append(IPy.IP(src))
+                if TIP(x) not in to:
+                    to.append(TIP(x))
+        elif TIP(src) not in to:
+            to.append(TIP(src))
 
     def _add_port(self, to, src):
         if isinstance(src, list):

{trigger-2.2.6 → trigger-2.3.0}/trigger/cmds.py

@@ -11,11 +11,12 @@ import collections
 import itertools
 from xml.etree.ElementTree import Element, SubElement
 
-from IPy import IP
+from netaddr import IPNetwork as IP
 from twisted.internet import defer, task
 from twisted.python import log
 
 from trigger import exceptions
+from trigger.acl.support import TIP
 from trigger.conf import settings
 from trigger.netdevices import NetDevices
 from trigger.utils.templates import (
@@ -808,12 +809,13 @@ class NetACLInfo(Commando):
         super().__init__(**args)
 
     def IPsubnet(self, addr):
-        """Given '172.20.1.4/24', return IP('172.20.1.0/24')."""
-        return IP(addr, make_net=True)
+        """Given '172.20.1.4/24', return TIP('172.20.1.0/24')."""
+        net = IP(addr)
+        return TIP(f"{net.network}/{net.prefixlen}")
 
     def IPhost(self, addr):
-        """Given '172.20.1.4/24', return IP('172.20.1.4/32')."""
-        return IP(addr[: addr.index("/")])  # Only keep before "/"
+        """Given '172.20.1.4/24', return TIP('172.20.1.4/32')."""
+        return TIP(addr[: addr.index("/")])  # Only keep before "/"
 
     # =======================================
     # Vendor-specific generate (to_)/parse (from_) methods
@@ -1165,14 +1167,14 @@ def _make_ipy(nets):
     """Given a list of 2-tuples of (address, netmask), returns a list of
     IP address objects.
     """  # noqa: D205
-    return [IP(addr) for addr, mask in nets]
+    return [TIP(addr) for addr, mask in nets]
 
 
 def _make_cidrs(nets):
     """Given a list of 2-tuples of (address, netmask), returns a list CIDR
     blocks.
     """  # noqa: D205
-    return [IP(addr).make_net(mask) for addr, mask in nets]
+    return [TIP(IP(f"{addr}/{mask}").cidr) for addr, mask in nets]
 
 
 def _dump_interfaces(idict):

{trigger-2.2.6 → trigger-2.3.0}/trigger/conf/global_settings.py

@@ -9,7 +9,7 @@ import os
 import socket
 from pathlib import Path
 
-import IPy
+import netaddr
 
 # ===============================
 # Global Settings
@@ -67,9 +67,9 @@ TFTP_HOST = ""
 # Add internally owned networks here. All network blocks owned/operated and
 # considered part of your network should be included.
 INTERNAL_NETWORKS = [
-    IPy.IP("10.0.0.0/8"),
-    IPy.IP("172.16.0.0/12"),
-    IPy.IP("192.168.0.0/16"),
+    netaddr.IPNetwork("10.0.0.0/8"),
+    netaddr.IPNetwork("172.16.0.0/12"),
+    netaddr.IPNetwork("192.168.0.0/16"),
 ]
 
 # A dictionary keyed by manufacturer name containing a list of the device types

{trigger-2.2.6 → trigger-2.3.0}/trigger/netscreen.py

@@ -3,7 +3,7 @@ Broken apart from acl.parser because the approaches are vastly different from ea
 other.
 """  # noqa: D205
 
-import IPy
+import netaddr
 
 from trigger import exceptions
 from trigger.acl.parser import (
@@ -555,11 +555,11 @@ class NSAddressBook(NetScreen):
         self.any = NSAddress(name="ANY")
 
     def find(self, address, zone):  # noqa: D102
-        if not self.entries.has_key(zone):
+        if zone not in self.entries:
             return None
 
         for nsaddr in self.entries[zone]:
-            if isinstance(address, IPy.IP):
+            if isinstance(address, netaddr.IPNetwork):
                 if nsaddr.addr == address:
                     return nsaddr
             elif isinstance(address, str):
@@ -646,7 +646,7 @@ class NSAddress(NetScreen):
             self.zone,
             self.name,
             self.addr.strNormal(0),
-            self.addr.netmask(),
+            str(self.addr.netmask),
             self.comment,
         )
         return [output]
@@ -808,7 +808,7 @@ class NSPolicy(NetScreen):
         addr = TIP(address)
         found = address_book.find(addr, zone)
         if not found:
-            if addr.prefixlen() == 32:  # noqa: PLR2004
+            if addr.prefixlen == 32:  # noqa: PLR2004
                 name = f"h{addr.strNormal(0)}"
             else:
                 name = f"n{addr.strNormal()}"

{trigger-2.2.6 → trigger-2.3.0/trigger.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: trigger
-Version: 2.2.6
+Version: 2.3.0
 Summary: Network automation toolkit for managing network devices
 Author-email: Jathan McCollum <jathan@gmail.com>
 License-Expression: BSD-3-Clause
@@ -13,7 +13,7 @@ Requires-Python: <3.12,>=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
 License-File: AUTHORS.md
-Requires-Dist: IPy>=1.01
+Requires-Dist: netaddr<2,>=1.0.0
 Requires-Dist: cryptography>=41.0.0
 Requires-Dist: Twisted>=22.10.0
 Requires-Dist: crochet>=2.0.0

{trigger-2.2.6 → trigger-2.3.0}/trigger.egg-info/requires.txt

@@ -1,4 +1,4 @@
-IPy>=1.01
+netaddr<2,>=1.0.0
 cryptography>=41.0.0
 Twisted>=22.10.0
 crochet>=2.0.0