Inmersión en Python

    print "\n".join(["%s %s" %
                      (method.ljust(spacing),
                       processFunc(str(getattr(object, method).__doc__)))
                     for method in methodList])

Advierta que esto es una sola orden dividida en varias líneas, pero sin utilizar el carácter de continuación de línea (“\”). ¿Recuerda cuando dije que algunas expresiones pueden dividirse en varias líneas sin usar la barra inversa? Una lista por comprensión es una de estas expresiones, ya que la expresión completa está entre corchetes.

Vamos a tomarlo por el final y recorrerlo hacia atrás. El fragmento

for method in methodList

nos muestra que esto es una lista por comprensión. Como ya sabe, methodList es una lista de todos los métodos que nos interesan de object. De modo que estamos recorriendo esta lista con la variable method.

Ejemplo 4.22. Obtención de una cadena de documentación de forma dinámica

>>> import odbchelper
>>> object = odbchelper                   
>>> method = 'buildConnectionString'      
>>> getattr(object, method)               
<function buildConnectionString at 010D6D74>
>>> print getattr(object, method).__doc__ 
Crea una cadena de conexión partiendo de un diccionario de parámetros.

    Devuelve una cadena.

	En la función info, object es el objeto sobre el que pedimos ayuda, pasado como argumento.
	Cuando recorremos methodList, method es el nombre del método actual.
	Usando la función getattr obtenemos una referencia a la función método del módulo objeto.
	Ahora, mostrar la cadena de documentación del método es fácil.

La siguiente pieza del puzzle es el uso de str con la cadena de documentación. Como recordará usted, str es una función incorporada que convierte datos en cadenas. Pero una cadena de documentación es siempre una cadena luego, ¿por qué molestarse en usar la función str? La respuesta es que no todas las funciones tienen una cadena de documentación, y en este caso su atributo __doc__ es None.

Ejemplo 4.23. ¿Por qué usar str con una cadena de documentación?

>>> >>> def foo(): print 2
>>> >>> foo()
2
>>> >>> foo.__doc__     
>>> foo.__doc__ == None 
True
>>> str(foo.__doc__)    
'None'

	Se puede definir de forma trivial una función que no tenga cadena de documentación, de manera que su atributo __doc__ es None. Para más confusión, si se evalúa directamente el atributo __doc__ el IDE de Python no muestra nada en absoluto, lo cual tiene sentido si se piensa bien, pero es poco práctico.
	Se puede verificar que el valor del atributo __doc__ es realmente None comparándolo directamente.
	Con el uso de la función str se toma el valor nulo y se devuelve su representación como cadena, 'None'.

	En SQL, se utiliza IS NULL en vez de = NULL para comparar un valor nulo. En Python puede usar tanto == None como is None, pero is None es más rápido.

Ahora que estamos seguros de tener una cadena podemos pasarla a processFunc, que hemos definido como una función que unifica o no el espacio en blanco. Ahora se ve por qué es importante utilizar str para convertir el valor None en su representación como cadena. processFunc asume que su argumento es una cadena y llama a su método split, y esto fallaría si le pasamos None, ya que None no tiene un método split.

Yendo más atrás, verá que estamos utilizando el formato de cadenas de nuevo para concatenar el valor de retorno de processFunc con el valor de retorno del método ljust de method. Éste es un nuevo método de cadena que no hemos visto antes.

Ejemplo 4.24. Presentación de ljust

>>> s = 'buildConnectionString'
>>> s.ljust(30) 
'buildConnectionString         '
>>> s.ljust(20) 
'buildConnectionString'

	ljust rellena la cadena con espacios hasta la longitud indicada. Esto lo usa la función info para hacer dos columnas y alinear todas las cadenas de documentación en la segunda columna.
	Si la longitud indicada es menor que la longitud de la cadena, ljust devuelve simplemente la cadena sin cambios. Nunca corta la cadena.

Casi hemos terminado. Dados el nombre del método ajustado con espacios usando ljust y la cadena de documentación (posiblemente con el espacio blanco unificado) que resultó de la llamada a processFunc, concatenamos las dos y obtenemos una única cadena. Como estamos recorriendo methodList, terminamos con una lista de cadenas. Utilizando el método join de la cadena "\n", unimos esta lista en una única cadena con cada elemento de la lista en una línea diferente, y mostramos el resultado.

Ejemplo 4.25. Mostrar una List

>>> li = ['a', 'b', 'c']
>>> print "\n".join(li) 
a
b
c

Éste es también un útil truco de depuración cuando se trabaja con listas. Y en Python, siempre se trabaja con listas.

Ésta es la última pieza del puzzle. Ya debería entender perfectamente este código.

    print "\n".join(["%s %s" %
                      (method.ljust(spacing),
                       processFunc(str(getattr(object, method).__doc__)))
                     for method in methodList])