src/vpp-api/python/vpp_papi/macaddress.py

   1 #!/usr/bin/env python3
   2 #
   3 # Copyright (c) 2016 Cisco and/or its affiliates.
   4 # Licensed under the Apache License, Version 2.0 (the "License");
   5 # you may not use this file except in compliance with the License.
   6 # You may obtain a copy of the License at:
   7 #
   8 #     http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 # Unless required by applicable law or agreed to in writing, software
  11 # distributed under the License is distributed on an "AS IS" BASIS,
  12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 # See the License for the specific language governing permissions and
  14 # limitations under the License.
  15 #
  16
  17 import binascii
  18
  19
  20 def mac_pton(s):
  21     """Convert MAC address as text to binary"""
  22     return binascii.unhexlify(s.replace(":", ""))
  23
  24
  25 def mac_ntop(binary):
  26     """Convert MAC address as binary to text"""
  27     x = b":".join(binascii.hexlify(binary)[i : i + 2] for i in range(0, 12, 2))
  28     return str(x.decode("ascii"))
  29
  30
  31 class MACAddress:
  32     def __init__(self, mac):
  33         """MAC Address as a text-string (aa:bb:cc:dd:ee:ff) or 6 bytes"""
  34         # Of course Python 2 doesn't distinguish str from bytes
  35         if type(mac) is bytes and len(mac) == 6:
  36             self.mac_binary = mac
  37             self.mac_string = mac_ntop(mac)
  38         else:
  39             self.mac_binary = mac_pton(mac)
  40             self.mac_string = mac
  41
  42     @property
  43     def packed(self):
  44         return self.mac_binary
  45
  46     def __len__(self):
  47         return 6
  48
  49     def __str__(self):
  50         return self.mac_string
  51
  52     def __repr__(self):
  53         return "%s(%s)" % (self.__class__.__name__, self.mac_string)
  54
  55     def __eq__(self, other):
  56         if not isinstance(other, MACAddress):
  57             try:
  58                 # if it looks like a mac address, we'll take it.
  59                 # (allows for equality with scapy hw-addresses)
  60                 return self.mac_binary == MACAddress(other).mac_binary
  61             except Exception:
  62                 return NotImplemented
  63         return self.mac_binary == other.mac_binary
  64
  65     def __ne__(self, other):
  66         return not self == other
  67
  68     def __hash__(self):
  69         return hash(self.mac_binary)