Make email options of find_interesting_reviews more flexible.

[kristof.beyls]

Summary

This enables a few requested improvements on the original review of this
script at https://reviews.llvm.org/D46192.

This introduces 2 new command line options:

• --email-report: This option enables specifying who to email the generated report to. This also enables not sending any email and only printing out the report on stdout by not specifying this option on the command line.
• --sender: this allows specifying the email address that will be used in the "From" email header.

I believe that with these options the script starts having the basic
features needed to run it well on a regular basis for a group of
developers.

[philip.pfaffe]

utils/Reviewing/find_interesting_reviews.py

591 ↗

(On Diff #150452)

Instead of taking and parsing comma separated values, why not use nargs='+'.

On the other hand, it'd be nice to rename the option to '--email-report', which optionally takes email addresses. If none are given, just send it to the email addresses passed to the email_addresses option.

[JDevlieghere]

LGTM with Philip's comment addressed.

utils/Reviewing/find_interesting_reviews.py

591 ↗

(On Diff #150452)

+1

[kristof.beyls]

utils/Reviewing/find_interesting_reviews.py

591 ↗

(On Diff #150452)

Thanks for those suggestions, @philip.pfaffe ! I've also taken your suggestion to rename the option to '--email-report', but went for "When the --email-report flag is not specified, do not send out any emails", to make sure it remains possible to run the script and get a report without sending it over email.

llvm/trunk/utils/Reviewing/find_interesting_reviews.py

for name, url in GIT_REPO_METADATA:
         dirname = os.path.join(git_repos_directory, name)
         if not os.path.exists(dirname):
             cmd = "git clone {0} {1}".format(url, dirname)
             output = get_git_cmd_output(cmd)
         cmd = "git -C {0} pull --rebase".format(dirname)
         output = get_git_cmd_output(cmd)
 
 
-def send_emails(email_addresses, msg):
+def send_emails(email_addresses, sender, msg):
     s = smtplib.SMTP()
     s.connect()
     for email_address in email_addresses:
         email_msg = email.mime.multipart.MIMEMultipart()
-        email_msg['From'] = ''
+        email_msg['From'] = sender
         email_msg['To'] = email_address
         email_msg['Subject'] = 'LLVM patches you may be able to review.'
-        email_msg.attach(email.mime.text.MIMEText(msg, 'plain'))
+        email_msg.attach(email.mime.text.MIMEText(msg.encode('utf-8'), 'plain'))
         # python 3.x: s.send_message(email_msg)
-        s.sendmail(email_msg['From'], email_msg['To'], msg)
+        s.sendmail(email_msg['From'], email_msg['To'], email_msg.as_string())
     s.quit()
 
 
 def filter_reviewers_to_report_for(people_to_look_for):
     # The below is just an example filter, to only report potential reviews
     # to do for the people that will receive the report email.
     return lambda potential_reviewers: [r for r in potential_reviewers
                                         if r[0] in people_to_look_for]
 
 
 def main():
     parser = argparse.ArgumentParser(
         description='Match open reviews to potential reviewers.')
     parser.add_argument(
         '--no-update-cache',
         dest='update_cache',
         action='store_false',
         default=True,
         help='Do not update cached Phabricator objects')
     parser.add_argument(
-        'email_addresses',
+        '--email-report',
+        dest='email_report',
+        nargs='*',
+        default="",
+        help="A email addresses to send the report to.")
+    parser.add_argument(
+        '--sender',
+        dest='sender',
+        default="",
+        help="The email address to use in 'From' on messages emailed out.")
+    parser.add_argument(
+        '--email-addresses',
+        dest='email_addresses',
         nargs='*',
         help="The email addresses (as known by LLVM git) of " +
         "the people to look for reviews for.")
     parser.add_argument('--verbose', '-v', action='count')
 
     args = parser.parse_args()
 
     if args.verbose >= 1:
         logging.basicConfig(level=logging.DEBUG)
 
     people_to_look_for = [e.decode('utf-8') for e in args.email_addresses]
+    logging.debug("Will look for reviews that following contributors could " +
+                  "review: {}".format(people_to_look_for))
+    logging.debug("Will email a report to: {}".format(args.email_report))
 
     phab = init_phab_connection()
 
     if args.update_cache:
         update_cache(phab)
 
     load_cache()
     update_git_repos()
     msg = print_most_recent_reviews(
         phab,
         days=1,
         filter_reviewers=filter_reviewers_to_report_for(people_to_look_for))
-    send_emails(people_to_look_for, msg)
+
+    if args.email_report != []:
+        send_emails(args.email_report, args.sender, msg)
 
 
 if __name__ == "__main__":
     main()