joe di castro

Enviar un correo electrónico con Python

joe di castro — Sun, 08 May 2011 13:29:00 +0200

Existen varias maneras de enviar un correo electrónico a través de Python, por ejemplo empleando el modulo smtplib de la librería estándar de Python. Si estamos en Linux y contamos con un servidor de correo funcionando, enviar un correo puede ser algo tan sencillo como este script:

#!/usr/bin/env python
# -*- coding: utf8 -*-

import os
import socket
import smtplib

def send_mail_local(subject, text):
    """Send a mail to the user's local mailbox."""
    # Set the local mail address for the script' user
    email = "@".join([os.getenv("LOGNAME"), socket.gethostname()])
    msg = ("From: {0}\nTo: {0}\nSubject: {1}\n{2}".format(email, subject, text))
    server = smtplib.SMTP("localhost")
    server.sendmail(email, email, msg)
    server.quit()
    return

def main():
    """Main section"""

    send_mail_local("Comprobando el envío de correo localmente",
                    "Si puedes leer esto, tu servidor local SMTP está OK")

    print("Comprueba el correo en tu buzón local {0}\nEste normalmente se "
          "encuentra situado en /var/mail/{1}".
          format("@".join([os.getenv("LOGNAME"), socket.gethostname()]),
                 os.getenv("LOGNAME")))

if __name__ == "__main__":
    main()

Que si lo ejecutamos, nos generará una salida por consola como esta:

Comprueba el correo en tu buzón local tuusuario@tumaquina
Este normalmente se encuentra situado en /var/mail/tuusuario

Y tendrás en la bandeja de correo de tu usuario en la maquina algo como esto:

De:     tuusuario@tumaquina
Para:   tuusuario@tumaquina
Asunto:     Comprobando el envío de correo localmente
Fecha:  Sun, 08 May 2011 12:57:30 +0200

Si puedes leer esto, tu servidor local SMTP está OK

Es algo realmente sencillo, y la mayoría de las lineas sirven para construir el ejemplo, lo que realmente hace el trabajo, y solo necesita el modulo smtplib para funcionar es esto:

server = smtplib.SMTP("localhost")
server.sendmail(email, email, msg)
server.quit()

Pero si lo que queremos es enviar correos más complejos, con adjuntos, empleando servidores SMTP externos y enviar con copia (CC) ó copia oculta (CCO) a varios usuarios, entonces ya necesitamos emplear las opciones del modulo email que nos permite hacer prácticamente cualquier tarea relacionada con los correos electronicos. Para estas situaciones desarrolle en su día una función que ha cubierto todas las situaciones que se me han dado hasta ahora. Además devuelve mensajes de error allí donde algo puede ir mal.

# The more complete solution. This adds the Cc: (Carbon Copy) and Bcc: (Blind 
# Carbon Copy) fields and the ability to add attachments. 
def send_email(subject, text, send_from="", dest_to=None, attachments=None,
               send_cc=None, send_bcc=None, server="localhost", port=25,
               user="", passwd=""):
    """Send a email with(out) attachment(s) enabling CC and BCC fields.

    Arguments:
        (str) subject -- the mail's subject
        (str) text -- the message's text
        (str) send_from -- a sender's email address (default "")
        (list) dest_to -- a list of receivers' email addresses ("")
        (list) attachments -- a list of attachments files (default None)
        (list) send_cc -- a list of carbon copy's email addresses (def. None)
        (list) send_bcc -- a list of blind carbon copy's email addresses (None)
        (str) server -- the smtp server (default "localhost")
        (int) port -- the smtp server port (default 25)
        (str) user -- the smtp server user (default "")
        (str) passwd --the smtp server password (default "")

    If "send_from" or "dest_to" are empty or None, then script user's mailbox 
    is assumed instead. Useful for logging scripts

    """
    local_email = "@".join([os.getenv("LOGNAME"), socket.gethostname()])
    send_from = send_from if send_from else local_email
    dest_to = dest_to if dest_to else [local_email]

    dest_to_addrs = dest_to # receivers mails including to, cc and bcc fields
    message = MIMEMultipart()
    message["Subject"] = subject
    message["From"] = send_from
    message["To"] = COMMASPACE.join(dest_to)
    if send_cc:
        message["Cc"] = COMMASPACE.join(send_cc)
        dest_to_addrs += send_cc
    if send_bcc:
        dest_to_addrs += send_bcc
    message["Date"] = formatdate(localtime=True)
    message.preamble = "You'll not see this in a MIME-aware mail reader.\n"
    message.attach(MIMEText(text))

    # For all type of attachments
    if attachments:
        for att_file in attachments:
            with open(att_file, "rb") as attmnt:
                att = MIMEBase("application", "octet-stream")
                att.set_payload(attmnt.read())
            encoders.encode_base64(att)
            att.add_header("content-disposition", "attachment",
                           filename=os.path.basename(att_file))
            message.attach(att)

    # initialize the mail server
    smtp_server = smtplib.SMTP()
    # Connect to mail server
    try:
        smtp_server.connect(server, port)
    except socket.gaierror:
        print("mail error", "Wrong server, are you sure is correct?")
    except socket.error:
        print("mail error", "Server unavailable or connection refused")
    # Login in mail server
    if server != "localhost":
        try:
            smtp_server.login(user, passwd)
        except smtplib.SMTPAuthenticationError:
            print("mail error", "Authentication error")
        except smtplib.SMTPException:
            print("mail error", "No suitable authentication method")
    # Send mail
    try:
        smtp_server.sendmail(send_from, dest_to_addrs, message.as_string())
    except smtplib.SMTPRecipientsRefused:
        print("mail error", "All recipients were refused."
              "Nobody got the mail.")
    except smtplib.SMTPSenderRefused:
        print("mail error", "The server didn’t accept the from_addr")
    except smtplib.SMTPDataError:
        print("mail error", "An unexpected error code, Data refused")
    # Disconnect from server
    smtp_server.quit()

Para las situaciones en las que no disponemos de un servidor de correo SMTP funcionando, podemos montar uno temporalmente para realizar pruebas. La tarea puede tan sencilla como recurrir a uno de los python one-liners que mencionaba en Python one-liners. Potencia en una sola línea.

python -m smtpd -n -c DebuggingServer localhost:8025

que es exactamente lo mismo que hace este script que empleo habitualmente para las mismas funciones (me permite montar un segundo servidor SMTP en un puerto distinto sin necesitar permisos de administrador, lo que me permite llamarlo desde otros scripts). Emplear una u otra forma, pues ya depende de uno.

#!/usr/bin/env python
# -*- coding: utf8 -*-

import smtpd
import asyncore

def smtp_server(port):
    """Starts a smtp server for test purposes."""
    smtpd.DebuggingServer(("localhost", port), None)

smtp_server(8025)
try:
    asyncore.loop()
except KeyboardInterrupt:
    pass

El código completo con ejemplos de estas funciones, se puede encontrar en mi repositorio Python Recipes que se encuentra alojado en github.

Python one-liners. Potencia en una sola línea

joe di castro — Mon, 02 May 2011 22:18:00 +0200

Un one-liner propiamente dicho es un comando de la consola que ejecuta una determinada función en "una sola línea de texto". En Python esto se consigue con una única orden de línea de comandos que llama al interprete y ejecuta los argumentos que le pasemos en la misma. Aunque también se les denomina así a veces a funciones lambda y funciones que han sido reducidas a una sola linea de código.

Un ejemplo de python one-liner es uno de los más famosos:

python -m this

Y que nos devuelve el popular Zen of Python:

The Zen of Python, by Tim Peters

Beautiful is better than ugly.
Explicit is better than implicit.
Simple is better than complex.
Complex is better than complicated.
Flat is better than nested.
Sparse is better than dense.
Readability counts.
Special cases aren't special enough to break the rules.
Although practicality beats purity.
Errors should never pass silently.
Unless explicitly silenced.
In the face of ambiguity, refuse the temptation to guess.
There should be one-- and preferably only one --obvious way to do it.
Although that way may not be obvious at first unless you're Dutch.
Now is better than never.
Although never is often better than *right* now.
If the implementation is hard to explain, it's a bad idea.
If the implementation is easy to explain, it may be a good idea.
Namespaces are one honking great idea -- let's do more of those!

Pero existen varios one-liners muy útiles que nos pueden hacer la vida más fácil para determinadas tareas.

Iniciar un servidor web y compartir un directorio

python -m SimpleHTTPServer

Si ejecutamos este one-liner se iniciará un servidor web en el puerto 8000 de nuestra dirección local (localhost o 127.0.0.1) que nos servirá los archivos del directorio donde lo ejecutemos. Para ello solo tenemos que acceder desde nuestro navegador a la dirección http://localhost:8000 o http://127.0.0.1. Para interrumpir el servicio basta con que interrumpamos el programa con Ctrl+C. Si quisiéramos emplear un puerto distinto de 8000, por ejemplo 8080, solo tenemos que indicarselo:

python -m SimpleHTTPServer 8080

Iniciar un servidor SMTP

python -m smtpd -n -c DebuggingServer localhost:25

Con este comando iniciamos un servidor de correo SMTP. Es básico, pero puede ser muy útil para crear un entorno temporal de pruebas. Dependiendo de la configuración de nuestro sistema, es muy probable que necesitemos ejecutar este comando como administrador (root). Si ya tenemos corriendo un servidor de correo en ese puerto, podemos cambiarlo por otro (eg: 2525)

Iniciar un servidor FTP

python -m pyftpdlib.ftpserver

Para poder ejecutar este comando es necesario tener instalada la librería pyftpdlib. Debemos además ser usuario con permisos de administrador de la maquina para poder iniciar este servidor. Una vez ejecutado tendremos un servidor FTP de solo lectura en el directorio en el que lo iniciemos.

Ejecutar un cliente FTP

python -m ftplib

Si ejecutamos este comando, nos devolverá la ayuda con los argumentos necesarios para poder conectarnos a un servidor FTP.

Abrir una página web en el navegador

python -m webbrowser http://joedicastro.com

Nos abrirá la dirección web que le indiquemos en el navegador web predeterminado de nuestro equipo.

Obtener el código fuente de una página web

python -m urllib http://example.com

Esto nos imprime en pantalla el código fuente (HTML) de una dirección web.

Eliminar las etiquetas HTML de un fichero HTML

python -m htmllib test.html

Esto nos imprime el contenido del fichero test-html pero sin mostrarnos las etiquetas HTML, solo texto plano. Algo parecido a lo que hace un navegador en modo texto como links, pero de forma estática.

Comparar dos directorios

python -m filecmp dir_1 dir_2

De esta manera podemos comparar dos directorios. El resultado será un resumen de que ficheros son iguales, cuales diferentes y lo mismo con los subdirectorios.

Identificar la plataforma

python -c 'from sys import platform; print platform'

Este nos sirve para identificar la plataforma sobre la que se ejecuta el comando (Windows, Linux, ...) No es de mucha utilidad, pero nos sirve como curiosidad. Otra opción más simple y que nos devuelve un resultado más completo sería:

python -m platform

Obtener el nombre de la maquina (hostname)

python -c 'from socket import gethostname; print gethostname()'

python -c 'import platform; print platform.node()'

Cualquiera de estos dos one-liners nos devolverán el nombre de la maquina en que los ejecutemos.

Imprimir el calendario del año en curso

python -m calendar

Imprime en pantalla el calendario de todo el año. Para conocer más opciones, como imprimir el calendario de otro año, mes, etc añadir la opción -h al final de la línea.

Mostrar los módulos empleados en un script

python -m modulefinder script.py

De esta manera podemos no solo saber que módulos son importados por el script, si no que además nos muestra su ruta en el sistema de archivos.

Aquí he mencionado solo algunos que empleo con cierta frecuencia o que me han parecido reseñables, pero existen bastantes más. Una buena pista es que la mayoría hace uso de los módulos de la librería estándar de Python.

Como funciona

Básicamente se trata de llamar al interprete Python utilizando uno de los siguientes argumentos:

-c: Lo que seguiría a esta opción sería un programa Python encerrado entre comillas. Por ejemplo, el primer ejemplo quedaría de este modo, python -c 'import this'
-m: Está opción llama a un modulo de python, que puede a su vez tener distintas opciones y argumentos, y lo ejecuta como script. Por ejemplo: python -m locale

HTTPS Server

Este no es un one-liner en Python, pero sirve como complemento a los distintos servidores que hemos visto que se podían iniciar con mucha facilidad gracias a Python. Este código inicia un servidor HTTPS en Python en el puerto 4443 de la dirección local. Lo suyo sería iniciarlo en el puerto 443, y se puede hacer simplemente cambiándolo, pero se necesitan entonces permisos de administrador para iniciarlo.

import BaseHTTPServer, SimpleHTTPServer
import ssl

httpd = BaseHTTPServer.HTTPServer(('localhost', 4443),
                                  SimpleHTTPServer.SimpleHTTPRequestHandler)
httpd.socket = ssl.wrap_socket (httpd.socket, 
                                certfile='path/to/localhost.pem', 
                                server_side=True)
httpd.serve_forever()

El código es original de Martin Pitt y me ha servido en más de una ocasión para probar un script.

Editar una página web con javascript

No es un one-liner escrito en Python, si no en javascript, pero lo menciono aquí a modo de curiosidad porque siempre me ha parecido curioso y aparentemente inútil, pero tiene sus aplicaciones (alguna broma ha caído gracias a él).

javascript:document.body.contentEditable='true'; document.designMode='on'; void 0

Para ejecutarlo es muy sencillo. Abrimos nuestro navegador web favorito, abrimos la página web que deseamos editar y luego simplemente sustituimos el texto de la barra de direcciones por el de este one-liner y pulsamos Enter. Ahora podemos editar la página web como si fuera un procesador de texto.