utils

Nota

Módulo encargado de realizar acciones sencillas y atómicas que pueden ser usados en muchos módulos.

path

utils.path.get_abs_path(path, relative_to)

Obtiene el path absoluto de path si es relativo

Parámetros

• path (str) – ruta

• relative_to (str) – relativa a

Devuelve

ruta absoluta del path

Tipo del valor devuelto

str

>> get_abs_path('../c.py', '../dir', 'C:\<username>\c.py')
'c.py'

utils.path.path_leaf(path)

Obtiene el nombre del fichero desde la ruta absoluta

Parámetros

path (str) – ruta absoluta del fichero

Devuelve

nombre del fichero

Tipo del valor devuelto

str

>> path_leaf('a/b/c.py')
'c.py'

stringify

utils.stringify.list_to_rst_modules(list_)

Combina los nombres de los módulos para formatearlos e incluirlos en un fichero .rst

Parámetros

list (list[str]) – lista con los nombres de los módulos

Devuelve

string formateada para .rst

Tipo del valor devuelto

str

>> list_to_rst_modules(['generators', 'identify', 'utils'])
"generators \n identify \n utils"

utils.stringify.generate_headline(text)

Genera la cabecer para los titulos formateados en .rst

Parámetros

text (str) – texto para el que generar la cabecera

Devuelve

cabecera para el texto

Tipo del valor devuelto

str

>> generate_headline('Welcome')
'==========='

utils.stringify.generate_sub_headline(text)

Genera la cabecer para los subtitulos formateados en .rst

Parámetros

text (str) – texto para el que generar la cabecera

Devuelve

cabecera para el texto

Tipo del valor devuelto

str

>> generate_sub_headline('Welcome')
'###########'

utils.stringify.generate_sub_sub_headline(text)

Genera la cabecer para los subsubtitulos formateados en .rst

Parámetros

text (str) – texto para el que generar la cabecera

Devuelve

cabecera para el texto

Tipo del valor devuelto

str

>> generate_sub_sub_headline('Welcome')
'***********'

utils.stringify.get_pyfile_header(pyfile)

Obtiene el nombre del fichero

Parámetros

pyfile (str) – nombre completo de la ruta del fichero .py

Devuelve

nombre del fichero

Tipo del valor devuelto

str

>> get_pyfile_header('../a/c.py')
'c'

utils.stringify.convert_path(path)

Escapa la ruta pasada por parámetros

Parámetros

path (str) – ruta

Devuelve

ruta escapada

Tipo del valor devuelto

str

>> convert_path('..\c.py')
'..\a\c.py'

utils.stringify.generate_mocks_stuff(mocks_list)

Convierte una lista a string

Parámetros

mocks_list – lista de las importaciones que no deben realizarse

Devuelve

lista en formato string

Tipo del valor devuelto

str

>> convert_path(['a', 'b'])
'['a', 'b']'