Have Rietveld.get_description() consistently strip CR and whitespace.

rietveld.py

 # coding: utf-8
 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 """Defines class Rietveld to easily access a rietveld instance.
 
 Security implications:
 
 The following hypothesis are made:
 - Rietveld enforces:
@@ skipping 64 matching lines @@
     return json.loads(
         self.get('/search?format=json&commit=2&closed=3&'
                  'keys_only=True&limit=1000&order=__key__'))['results']
 
   def close_issue(self, issue):
     """Closes the Rietveld issue for this changelist."""
     logging.info('closing issue %d' % issue)
     self.post("/%d/close" % issue, [('xsrf_token', self.xsrf_token())])
 
   def get_description(self, issue):
-    """Returns the issue's description."""
-    return self.get('/%d/description' % issue)
+    """Returns the issue's description.
+
+    Converts any CRLF into LF and strip extraneous whitespace.
+    """
+    return '\n'.join(self.get('/%d/description' % issue).strip().splitlines())

[iannucci, 2013/04/26 18:21:46]

So if it ended with a line ending, it won't have any line ending any more?

[M-A Ruel, 2013/04/26 18:23:53]

Exact, which is fine.

 
   def get_issue_properties(self, issue, messages):
     """Returns all the issue's metadata as a dictionary."""
     url = '/api/%d' % issue
     if messages:
       url += '?messages=true'
-    return json.loads(self.get(url))
+    data = json.loads(self.get(url))
+    data['description'] = '\n'.join(data['description'].strip().splitlines())

[iannucci, 2013/04/26 18:21:46]

Can description can be absent/None?

[M-A Ruel, 2013/04/26 18:23:53]

Not in the real API.

+    return data
 
   def get_patchset_properties(self, issue, patchset):
     """Returns the patchset properties."""
     url = '/api/%d/%d' % (issue, patchset)
     return json.loads(self.get(url))
 
   def get_file_content(self, issue, patchset, item):
     """Returns the content of a new file.
 
     Throws HTTP 302 exception if the file doesn't exist or is not a binary file.
@@ skipping 336 matching lines @@
     if not messages:
       # Assumes self._lookup uses deepcopy.
       del data['messages']
     return data
 
   def get_patchset_properties(self, issue, patchset):
     return self._lookup(
         'get_patchset_properties',
         (issue, patchset),
         super(CachingRietveld, self).get_patchset_properties)