Add more formatting options for my_activity.py

my_activity.py

 #!/usr/bin/env python
 # 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.
 
 """Get stats about your activity.
 
 Example:
   - my_activity.py  for stats for the current week (last week on mondays).
   - my_activity.py -Q  for stats for last quarter.
@@ skipping 779 matching lines @@
     except ImportError:
       print "Failed to import WebKit committer list, skipping WebKit checks."
       self.webkit_repo = None
       return
 
     if not webkit_account(self.user):
       email = self.user + "@chromium.org"
       print "No %s in committers.py, skipping WebKit checks." % email
       self.webkit_repo = None
 
+  def print_heading(self, heading):
+    print
+    print self.options.output_format_heading.format(heading=heading)
+
   def print_change(self, change):
     optional_values = {
         'reviewers': ', '.join(change['reviewers'])
     }
     self.print_generic(self.options.output_format,
                        self.options.output_format_changes,
                        change['header'],
                        change['review_url'],
                        change['author'],
                        optional_values)
@@ skipping 77 matching lines @@
       self.changes += self.rietveld_search(instance, owner=self.user)
 
     for instance in gerrit_instances:
       self.changes += self.gerrit_search(instance, owner=self.user)
 
     for instance in git_instances:
       self.changes += self.git_search(instance, owner=self.user)
 
   def print_changes(self):
     if self.changes:
-      print '\nChanges:'
+      self.print_heading('Changes')
       for change in self.changes:
         self.print_change(change)
 
   def get_reviews(self):
     for instance in rietveld_instances:
       self.reviews += self.rietveld_search(instance, reviewer=self.user)
 
     for instance in gerrit_instances:
       reviews = self.gerrit_search(instance, reviewer=self.user)
       reviews = filter(lambda r: not username(r['owner']) == self.user, reviews)
       self.reviews += reviews
 
     for instance in git_instances:
       self.reviews += self.git_search(instance, reviewer=self.user)
 
   def print_reviews(self):
     if self.reviews:
-      print '\nReviews:'
+      self.print_heading('Reviews')
       for review in self.reviews:
         self.print_review(review)
 
   def get_issues(self):
     for project in google_code_projects:
       self.issues += self.google_code_issue_search(project)
 
     for instance in bugzilla_instances:
       self.issues += self.bugzilla_issues(instance, self.user)
 
   def print_issues(self):
     if self.issues:
-      print '\nIssues:'
+      self.print_heading('Issues')
       for issue in self.issues:
         self.print_issue(issue)
 
   def process_activities(self):
     # If a webkit bug was a review, don't list it as an issue.
     ids = {}
     for review in self.reviews + self.changes:
       if 'webkit_bug_id' in review:
         ids[review['webkit_bug_id']] = True
 
@@ skipping 85 matching lines @@
       'additional variable {reviewers}')
   output_format_group.add_option(
       '--output-format-issues', metavar='<format>',
       default=None,
       help='Specifies the format to use when printing issues. Supports the '
            'additional variable {owner}.')
   output_format_group.add_option(
       '--output-format-reviews', metavar='<format>',
       default=None,
       help='Specifies the format to use when printing reviews.')
+  output_format_group.add_option(
+      '--output-format-heading', metavar='<format>',
+      default=u'{heading}:',
+      help='Specifies the format to use when printing headings.')
+  output_format_group.add_option(
+      '--markdown', action='store_true',

[deymo, 2013/12/17 01:38:16]

I'm up for a '-m' short option as well. It looks like is free and --markdown
should be common enough to deserve it.

[jsbell, 2013/12/17 18:59:55]

Done.

+      help='Use markdown-friendly output formats')

[deymo, 2013/12/17 01:38:16]

hmm... I'd add a note about the fact that this overrides --output-format but not
--output-format-*.

[jsbell, 2013/12/17 18:59:55]

Done.

   parser.add_option_group(output_format_group)
 
   # Remove description formatting
   parser.format_description = (
       lambda _: parser.description)  # pylint: disable=E1101
 
   options, args = parser.parse_args()
   options.local_user = os.environ.get('USER')
   if args:
     parser.error('Args unsupported')
@@ skipping 12 matching lines @@
     else:
       begin, end = (get_week_of(datetime.today() - timedelta(days=1)))
   else:
     begin = datetime.strptime(options.begin, '%m/%d/%y')
     if options.end:
       end = datetime.strptime(options.end, '%m/%d/%y')
     else:
       end = datetime.today()
   options.begin, options.end = begin, end
 
+  if options.markdown:
+    options.output_format = ' * [{title}]({url})'
+    options.output_format_heading = '## {heading} ##'

[deymo, 2013/12/17 01:38:16]

I think that ## is too high. When the snippets are sent by email on reports this
heading will be bigger than the name of the reporter, which confuses the
reading.

I suggest using ###

[jsbell, 2013/12/17 18:59:55]

Done.

+
   print 'Searching for activity by %s' % options.user
   print 'Using range %s to %s' % (options.begin, options.end)
 
   my_activity = MyActivity(options)
 
   if not (options.changes or options.reviews or options.issues):
     options.changes = True
     options.issues = True
     options.reviews = True
 
@@ skipping 20 matching lines @@
   print '\n\n\n'
 
   my_activity.print_changes()
   my_activity.print_reviews()
   my_activity.print_issues()
   return 0
 
 
 if __name__ == '__main__':
   sys.exit(main())