Changeset 5c5fe6d

Timestamp:

Dec 17, 2011, 5:52:59 PM (13 years ago)

Author:

Jessica B. Hamrick <jhamrick@…>

Branches:

no-cups

Children:

287d6ec

Parents:

5d24a81

git-author:

Jessica B. Hamrick <jhamrick@…> (12/17/11 17:52:59)

git-committer:

Jessica B. Hamrick <jhamrick@…> (12/17/11 17:52:59)

Message:

Comment formatting standardization

Location:

server/lib/gutenbach

Files:

• ipp/attribute.py (modified) (5 diffs)
• ipp/attributegroup.py (modified) (6 diffs)
• ipp/constants.py (modified) (14 diffs)
• ipp/request.py (modified) (5 diffs)
• ipp/value.py (modified) (9 diffs)
• server/__init__.py (modified) (1 prop)

server/lib/gutenbach/ipp/attribute.py

@@ -8 +8 @@
 
 class Attribute(object):
-    """
-    In addition to what the RFC reports, an attribute has an
-    'attribute tag', which specifies what type of attribute it is.
-    It is 1 bytes long, and comes before the list of values.
+    """In addition to what the RFC reports, an attribute has an
+    'attribute tag', which specifies what type of attribute it is.  It
+    is 1 bytes long, and comes before the list of values.
 
     From RFC 2565:
@@ -38 +37 @@
     |                     value                   |   w bytes |
     -----------------------------------------------------------
+
     """
 
     def __init__(self, name=None, values=None):
-        """
-        Initialize an Attribute.  This function can be called in three
-        different ways:
+        """Initialize an Attribute.  This function can be called in
+        three different ways:
 
             Attribute() -- creates an empty Attribute
@@ -57 +56 @@
 
             values -- a list of Values.  May not be empty.
+
         """
 
@@ -73 +73 @@
     @property
     def packed_value(self):
-        """
-        Packs the attribute data into binary data.
+        """Packs the attribute data into binary data.
+        
         """
 
@@ -132 +132 @@
     @property
     def packed_value_size(self):
+        """Gets the total size of the attribute.
+        
         """
-        Gets the total size of the attribute.
-        """
+
         return len(self.packed_value)
 

server/lib/gutenbach/ipp/attributegroup.py

@@ -8 +8 @@
 
 class AttributeGroup(object):
-    """
-    An AttributeGroup consists of an attribute-group-tag, followed by
-    a sequence of Attributes. According to RFC 2565, "Within an
+    """An AttributeGroup consists of an attribute-group-tag, followed
+    by a sequence of Attributes. According to RFC 2565, 'Within an
     attribute-sequence, if two attributes have the same name, the
-    first occurrence MUST be ignored.", so we can effectively treat
+    first occurrence MUST be ignored.', so we can effectively treat
     this as an ordered dictionary.
+    
     """
 
     def __init__(self, attribute_group_tag=None, attributes=[]):
-        """
-        Initialize an AttributeGroup.  An AttributeGroup can be
+        """Initialize an AttributeGroup.  An AttributeGroup can be
         initialized in three ways:
 
@@ -31 +30 @@
 
             attributes -- a list of attributes
+
         """
 
@@ -43 +43 @@
 
     def __getitem__(self, name):
-        """
-        Returns a list of attributes which have name 'name'.
+        """Returns a list of attributes which have name 'name'.
+        
         """
         
@@ -62 +62 @@
 
     def __setitem__(self, name, attribute):
-        """
-        Sets an attribute in the attribute group. Note that the key is
-        ignored and the attribute is queried for its name.
+        """Sets an attribute in the attribute group. Note that the key
+        is ignored and the attribute is queried for its name.
+        
         """
 
@@ -77 +77 @@
 
     def extend(self, attributes):
-        """
-        Sets the attributes for the attribute group.
+        """Sets the attributes for the attribute group.
+        
         """
 
@@ -93 +93 @@
     @property
     def packed_value(self):
-        """
-        Convert the AttributeGroup to binary.
+        """Convert the AttributeGroup to binary.
+        
         """
 

server/lib/gutenbach/ipp/constants.py

@@ -2 +2 @@
 
 class Misc():
-    """
-    Miscellaneous config options for the IPP server.
+    """Miscellaneous config options for the IPP server.
+    
     """
     
@@ -12 +12 @@
 
 class JobStates():
-    """
-    Job state codes, as defined by RFC 2911, Section 4.3.7
+    """Job state codes, as defined by RFC 2911, Section 4.3.7
+    
     """
     
@@ -27 +27 @@
 
 class PrinterStates():
-    """
-    Printer state codes, as defined by RFC 2911, Section 4.4.11
+    """Printer state codes, as defined by RFC 2911, Section 4.4.11
+    
     """
 
@@ -38 +38 @@
 
 class Operations():
-    """
-    IPP and CUPS IPP Operations, as defined in various RFCs:
+    """IPP and CUPS IPP Operations, as defined in various RFCs:
 
         0x0002 - 0x0012      RFC 2911 (Section 4.4.15)
@@ -46 +45 @@
         0x0022 - 0x0031      RFC 3998 (Section 14.3)
         0x4000 - 0x4027      CUPS IPP Actions
+        
     """
 
@@ -120 +120 @@
 
 class SuccessCodes():
-    """
-    Success status codes as defined in RFC 2911, Section 13
+    """Success status codes as defined in RFC 2911, Section 13
+    
     """
     
@@ -135 +135 @@
 
 class ClientErrorCodes():
-    """
-    Client error codes as defined in RFC 2911, Section 13
+    """Client error codes as defined in RFC 2911, Section 13
+    
     """
     
@@ -167 +167 @@
 
 class ServerErrorCodes():
-    """
-    Server error codes as defined in RFC 2911, Section 13
+    """Server error codes as defined in RFC 2911, Section 13
+    
     """
 
@@ -189 +189 @@
 
 class CUPSPrinterType():
-    """
-    Printer types as defined by cups_ptype_e in the CUPS API
+    """Printer types as defined by cups_ptype_e in the CUPS API
     specification:
     
     http://www.cups.org/documentation.php/doc-1.3/api-cups.html#cups_ptype_e
+    
     """
 
@@ -232 +232 @@
 
 class AttributeTags():
-    """
-    Contains constants for the attribute IPP tags, as defined by RFC
-    2565.
+    """Contains constants for the attribute IPP tags, as defined by
+    RFC 2565.
+    
     """
     
@@ -249 +249 @@
 
 class OutOfBandTags():
-    """
-    Contains constants for the out-of-band value IPP tags, as defined
-    by RFC 2565.
+    """Contains constants for the out-of-band value IPP tags, as
+    defined by RFC 2565.
+    
     """
     
@@ -265 +265 @@
 
 class IntegerTags():
-    """
-    Contains constants for the integer value IPP tags, as defined by
-    RFC 2565.
+    """Contains constants for the integer value IPP tags, as defined
+    by RFC 2565.
+    
     """
     
@@ -278 +278 @@
 
 class OctetStringTags():
-    """
-    Contains constants for the octetString value IPP tags, as defined
-    by RFC 2565.
+    """Contains constants for the octetString value IPP tags, as
+    defined by RFC 2565.
+    
     """
     
@@ -295 +295 @@
 
 class CharacterStringTags():
-    """
-    Contains constants for the character-string value IPP tags, as
+    """Contains constants for the character-string value IPP tags, as
     defined by RFC 2565.
+    
     """
     

server/lib/gutenbach/ipp/request.py

@@ -11 +11 @@
 
 class Request():
-    """
-    From RFC 2565:
+    """From RFC 2565:
     
     The encoding for an operation request or response consists of:
@@ -32 +31 @@
     |                     data                    |   q bytes  - optional
     -----------------------------------------------
+
     """
 
@@ -39 +39 @@
     def __init__(self, version=None, operation_id=None, request_id=None,
                  attribute_groups=[], data=None, request=None, length=sys.maxint):
-        """
-        Create a Request.  Takes either the segments of the request
+        """Create a Request.  Takes either the segments of the request
         separately, or a file handle for the request to parse.  If the
         file handle is passed in, all other arguments are ignored.
@@ -65 +64 @@
             request -- a file handle that supports the read()
                        operation
+
         """
 
@@ -198 +198 @@
     @property
     def packed_value(self):
-        """
-        Packs the value data into binary data.
+        """Packs the value data into binary data.
+        
         """
 

server/lib/gutenbach/ipp/value.py

@@ -7 +7 @@
 logger = logging.getLogger(__name__)
 
-def setter(prop):
-    def f(func):
-        return property(prop.fget, func, prop.fdel, prop.__doc__)
-    return f
-
 class Value(object):
-    """
-    An IPP value consists of a tag and a value.
+    """An IPP value consists of a tag and a value.
 
     From RFC 2565:
@@ -26 +20 @@
      |                     value                   |   v bytes
      -----------------------------------------------    
+
     """
 
     def __init__(self, value_tag=None, value=None):
-        """
-        Initialize a Value.  There are three different ways you can
+        """Initialize a Value.  There are three different ways you can
         call this method:
 
@@ -48 +42 @@
             value -- variable size, containing the actual value.
             It should be a string or number.
+
         """
 
@@ -62 +57 @@
     @classmethod
     def unpack(cls, value_tag, packed_value):
-        """Unpack a binary IPP value
-
-        Unpacks a binary string into a Value object.
+        """Unpack a binary IPP value into a Value object.
 
         """
@@ -71 +64 @@
     @staticmethod
     def _unpack(value_tag, packed_value):
-        """
-        Given self.value_tag and self.packed_value, unpack the binary
-        value into either a string or number.  These values MUST NOT
-        be null.
+        """Given self.value_tag and self.packed_value, unpack the
+        binary value into either a string or number.  These values
+        MUST NOT be null.
 
         Returns: unpacked value
@@ -170 +162 @@
     @property
     def packed_value(self):
-        """
-        Given self.value_tag and self.value, pack the value into
+        """Given self.value_tag and self.value, pack the value into
         binary form.  These values MUST NOT be null.
 
@@ -270 +261 @@
         return packed_value
 
-    @setter(packed_value)
+    @packed_value.setter
     def packed_value(self, packed_value):
         """Replace a value using a new packed value
@@ -281 +272 @@
     @property
     def packed_value_size(self):
-        """
-        Get the size of the value in bytes.
+        """Get the size of the value in bytes.
+        
         """
         
@@ -289 +280 @@
     @property
     def total_size(self):
-        """
-        Get the total size of the IPP value.
+        """Get the total size of the IPP value.
+        
         """