Changeset c269bc7 for server/lib/ippattribute.py

Timestamp:

Mar 7, 2011, 7:47:42 PM (13 years ago)

Author:

Jessica B. Hamrick <jhamrick@…>

Branches:

no-cups

Children:

fa0d0ef

Parents:

5cfb358

git-author:

Jessica B. Hamrick <jhamrick@…> (03/07/11 19:47:42)

git-committer:

Jessica B. Hamrick <jhamrick@…> (03/07/11 19:47:42)

Message:

Update API for Value, Attribute, and AttributeGroup?

File:

• server/lib/ippattribute.py (modified) (4 diffs)

server/lib/ippattribute.py

@@ -40 +40 @@
     """
 
-    def __init__(self, name, values):
-        """
-        Initialize an Attribute.
+    def __init__(self, name=None, values=[]):
+        """
+        Initialize an Attribute.  This function can be called in three
+        different ways:
+
+            Attribute() -- creates an empty Attribute
+
+            Attribute(name) -- creates an empty Attribute with a name
+
+            Attribute(name, values) -- creates an Attribute
+            initialized with a name and list of values
         
         Arguments:
@@ -51 +59 @@
         """
 
-        # make sure name isn't empty
-        assert name is not None
-         
-        # make sure the list of values isn't empty
-        assert len(values) > 0
-        # make sure each value is a Value
-        for value in values: assert isinstance(value, Value)
-         
-        self.name = name
-        self.values = values
-
-    def toBinaryData(self):
+        if name is not None:
+            assert isinstance(name, str), \
+                   "Attribute name must be a string!"
+        for value in values:
+            assert isinstance(value, Value), \
+                   "Value must be of type Value"
+
+        self.name = None
+        self.values = None
+
+        if name is not None:
+            self.name = name
+        if name is not None and len(values) > 0:
+            self.values = values
+            self.binary = self.pack()
+            self.verify()
+
+    def pack(self):
         """
         Packs the attribute data into binary data.
         """
+
+        assert self.name is not None, \
+               "cannot pack unnamed attribute!"
+        assert len(self.values) > 0, \
+               "cannot pack empty attribute!"
 
         # get the binary data for all the values
         values = []
+        length = 0
         for v, i in zip(self.values, xrange(len(self.values))):
 
@@ -79 +99 @@
 
             # get the value length and binary value
-            value_length, value_bin = v.valueToBinary()
+            value_length, value_bin = v.pack()
 
             logger.debug("dumping name_length : %i" % name_length)
             logger.debug("dumping name : %s" % self.name)
             logger.debug("dumping value_length : %i" % value_length)
-            logger.debug("dumping value : %s" % v.value)
+            logger.debug("dumping value : %s" % v.getValue())
 
             # the value tag in binary
-            value_tag_bin = struct.pack('>b', v.value_tag)
+            value_tag_bin = struct.pack('>b', v.getValueTag())
 
             # the name length in binary
@@ -109 +129 @@
                                        value_length_bin,
                                        value_bin]))
+
+            length += 2            # name-length
+            length += name_length  # name
+            length += value_length # value
                 
-        # concatenate everything together and return it
-        return ''.join(values)
+        # concatenate everything together and return it along with the
+        # total length of the attribute
+        return length, ''.join(values)
+
+    def getName(self):
+        """
+        Get the attribute's name.
+        """
+        
+        return self.name
+
+    def getValues(self):
+        """
+        Get the list of values contained in the attribute.
+        """
+        
+        return self.values
+
+    def setName(self, name):
+        """
+        Set the attribute's name.
+        """
+
+        assert isinstance(name, str), \
+               "name must be a string!"
+        
+        self.name = name
+
+    def setValues(self, values):
+        """
+        Set the list of values contained in the attribute.
+        """
+
+        for v in values:
+            assert isinstance(v, Value), \
+                   "value must be of type Value!"
+        
+        self.values = values
+
+    def addValue(self, value):
+        """
+        Add a new value to the list of values contained in the
+        attribute."
+
+        assert isinstance(value, Value), \
+               "value must be of type Value!"
+
+        self.values.append(value)
+
+    def getSize(self):
+        """
+        Gets the total size of the attribute.
+        """
+
+        size = 2 + len(self.name)
+        for v in self.values:
+            size += v.getTotalSize()
+
+    def verify(self):
+        """
+        Check to make sure that the Attribute is valid.  This means
+        that is should have a name and a list of values, and that its
+        binary representation should match up to the stored binary
+        representation.
+        """
+        
+        assert self.name is not None, \
+               "attribute has no name!"
+        assert len(self.value) > 0, \
+               "attribute has no values!"
+
+        size, bindata = self.pack()
+
+        assert size == self.getSize(), \
+               "pack size does not match self.getSize()!"
+        assert bindata == self.binary_data, \
+               "packed binary data does not match self.binary_data!"
+
+    def __str__(self):
+        if len(self.values) > 0:
+            values = [str(v) for v in self.values]
+        else:
+            values = "None"
+
+        if self.name is None:
+            name = "None"
+        else:
+            name = self.name
+        
+        return "%s: %s" % (name, str(values))