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

   1 #!/usr/bin/env python
   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]
  28                   for i in range(0, 12, 2))
  29     return str(x.decode('ascii'))
  30
  31
  32 class MACAddress():
  33     def __init__(self, mac):
  34         '''MAC Address as a text-string (aa:bb:cc:dd:ee:ff) or 6 bytes'''
  35         # Of course Python 2 doesn't distinguish str from bytes
  36         if type(mac) is bytes and len(mac) == 6:
  37             self.mac_binary = mac
  38             self.mac_string = mac_ntop(mac)
  39         else:
  40             self.mac_binary = mac_pton(mac)
  41             self.mac_string = mac
  42
  43     @property
  44     def packed(self):
  45         return self.mac_binary
  46
  47     def __len__(self):
  48         return 6
  49
  50     def __str__(self):
  51         return self.mac_string
  52
  53     def __repr__(self):
  54         return '%s(%s)' % (self.__class__.__name__, self.mac_string)