color: add ColoredFormatter for more transparent coloring.
[pygrader.git] / pygrader / email.py
index aeb4da8e742a353a1f5f00cd31f74047971c8a72..4fbf70a33f955315e150266df398b0a51a291069 100644 (file)
@@ -29,9 +29,6 @@ import pgp_mime as _pgp_mime
 
 from . import ENCODING as _ENCODING
 from . import LOG as _LOG
-from .color import standard_colors as _standard_colors
-from .color import color_string as _color_string
-from .color import write_color as _write_color
 from .model.person import Person as _Person
 
 
@@ -49,8 +46,7 @@ def test_smtp(smtp, author, targets, msg=None):
     smtp.send_message(msg=msg)
 test_smtp.__test__ = False  # not a test for nose
 
-def send_emails(emails, smtp=None, use_color=None, debug_target=None,
-                dry_run=False):
+def send_emails(emails, smtp=None, debug_target=None, dry_run=False):
     """Iterate through `emails` and mail them off one-by-one
 
     >>> from email.mime.text import MIMEText
@@ -64,15 +60,12 @@ def send_emails(emails, smtp=None, use_color=None, debug_target=None,
     ...     emails.append(
     ...         (msg,
     ...          lambda status: stdout.write('SUCCESS: {}\\n'.format(status))))
-    >>> send_emails(emails, use_color=False, dry_run=True)
+    >>> send_emails(emails, dry_run=True)
     ... # doctest: +REPORT_UDIFF, +NORMALIZE_WHITESPACE
-    sending message to ['Moneypenny <mp@sis.gov.uk>', 'James Bond <007@sis.gov.uk>']...\tDRY-RUN
     SUCCESS: None
-    sending message to ['M <m@sis.gov.uk>', 'James Bond <007@sis.gov.uk>']...\tDRY-RUN
     SUCCESS: None
     """
     local_smtp = smtp is None
-    highlight,lowlight,good,bad = _standard_colors(use_color=use_color)
     for msg,callback in emails:
         sources = [
             _email_utils.formataddr(a) for a in _pgp_mime.email_sources(msg)]
@@ -84,10 +77,8 @@ def send_emails(emails, smtp=None, use_color=None, debug_target=None,
             # TODO: remove convert_content_transfer_encoding?
             #if msg.get('content-transfer-encoding', None) == 'base64':
             #    convert_content_transfer_encoding(msg, '8bit')
-            _LOG.debug(_color_string(
-                    '\n{}\n'.format(msg.as_string()), color=lowlight))
-        _write_color('sending message to {}...'.format(targets),
-                     color=highlight)
+            _LOG.debug('\n{}\n'.format(msg.as_string()))
+        _LOG.info('sending message to {}...'.format(targets))
         if not dry_run:
             try:
                 if local_smtp:
@@ -98,16 +89,16 @@ def send_emails(emails, smtp=None, use_color=None, debug_target=None,
                 if local_smtp:
                     smtp.quit()
             except:
-                _write_color('\tFAILED\n', bad)
+                _LOG.warning('failed to send message to {}'.format(targets))
                 if callback:
                     callback(False)
                 raise
             else:
-                _write_color('\tOK\n', good)
+                _LOG.info('sent message to {}'.format(targets))
                 if callback:
                     callback(True)
         else:
-            _write_color('\tDRY-RUN\n', good)
+            _LOG.info('dry run, so no message sent to {}'.format(targets))
             if callback:
                 callback(None)
 
@@ -164,7 +155,7 @@ def get_address(person, header=False):
         return _email_utils.formataddr((name, person.emails[0]))
     return _email_utils.formataddr((person.name, person.emails[0]))
 
-def _construct_email(author, targets, subject, message, cc=None):
+def construct_email(author, targets, subject, message, cc=None):
     if author.pgp_key:
         signers = [author.pgp_key]
     else:
@@ -210,14 +201,14 @@ def _construct_email(author, targets, subject, message, cc=None):
 
     return message
 
-def construct_email(author, targets, subject, text, cc=None):
+def construct_text_email(author, targets, subject, text, cc=None):
     r"""Build a text/plain email using `Person` instances
 
     >>> from pygrader.model.person import Person as Person
     >>> author = Person(name='Джон Доу', emails=['jdoe@a.gov.ru'])
     >>> targets = [Person(name='Jill', emails=['c@d.net'])]
     >>> cc = [Person(name='H.D.', emails=['hd@wall.net'])]
-    >>> msg = construct_email(author, targets, cc=cc,
+    >>> msg = construct_text_email(author, targets, cc=cc,
     ...     subject='Once upon a time', text='Bla bla bla...')
     >>> print(msg.as_string())  # doctest: +REPORT_UDIFF, +ELLIPSIS
     Content-Type: text/plain; charset="us-ascii"
@@ -235,7 +226,7 @@ def construct_email(author, targets, subject, text, cc=None):
 
     With unicode text:
 
-    >>> msg = construct_email(author, targets, cc=cc,
+    >>> msg = construct_text_email(author, targets, cc=cc,
     ...     subject='Once upon a time', text='Funky ✉.')
     >>> print(msg.as_string())  # doctest: +REPORT_UDIFF, +ELLIPSIS
     Content-Type: text/plain; charset="utf-8"
@@ -253,7 +244,7 @@ def construct_email(author, targets, subject, text, cc=None):
     <BLANKLINE>
     """
     message = _pgp_mime.encodedMIMEText(text)
-    return _construct_email(
+    return construct_email(
         author=author, targets=targets, subject=subject, message=message,
         cc=cc)
 
@@ -264,7 +255,7 @@ def construct_response(author, targets, subject, text, original, cc=None):
     >>> student = Person(name='Джон Доу', emails=['jdoe@a.gov.ru'])
     >>> assistant = Person(name='Jill', emails=['c@d.net'])
     >>> cc = [assistant]
-    >>> msg = construct_email(author=student, targets=[assistant],
+    >>> msg = construct_text_email(author=student, targets=[assistant],
     ...     subject='Assignment 1 submission', text='Bla bla bla...')
     >>> rsp = construct_response(author=assistant, targets=[student],
     ...     subject='Received assignment 1 submission', text='3 hours late',
@@ -305,6 +296,6 @@ def construct_response(author, targets, subject, text, original, cc=None):
     message = _MIMEMultipart('mixed')
     message.attach(_pgp_mime.encodedMIMEText(text))
     message.attach(_MIMEMessage(original))
-    return _construct_email(
+    return construct_email(
         author=author, targets=targets, subject=subject, message=message,
         cc=cc)