identify

Nota

Módulo encargado de la identificación de la estructura del proyecto a documentar.

data

class identify.data.Module(name, python_files, submodules, filename)

Un módulo es un paquete contenedor de python

>> print(myModule)
|--Root
    |--generators
        |----generators.makefiles.py
        |----generators.rst_file.py
        |----generators.sphinx_config_file.py
        |----generators.sphinx_structure.py
    |--i18n
        |----i18n.dictionary.py
        |--locales
            |----i18n.locales.es.py
    |--identify
        |----identify.data.py
        |----identify.packages.py
        |----identify.project_structure.py
    |--utils
        |----utils.path.py
        |----utils.stringify.py

Parámetros

• name (str) – Nombre del módulo python

• python_files (list[PythonFile]) – ficheros .py dentro del módulo python

• submodules (list[Module]) – submodulos

• filename (str) – nombre del fichero .rst de salida del módulo

is_leaf()

Comprueba si el paquete es un paquete sin submódulos

Devuelve

True si lo es, False en otro caso

Tipo del valor devuelto

bool

class identify.data.PythonFile(name, classes)

Un PythonFile es la representación de un fichero python, que contiene su nombre y las clases que implementa

Parámetros

• name (str) – nombre del fichero .py

• classes (list[str]) – clases que implementa el fichero

packages

identify.packages.is_package(folder)

Comprueba si una carpeta es un paquete python

Parámetros

folder (str) – ruta de la carpeta

Devuelve

True si es un paquete, False en otro caso

Tipo del valor devuelto

bool

>> is_package('../pydoc')
'True'

identify.packages.get_folder_name(path)

Obtiene el nombra de la carpeta de la ruta especificada

Parámetros

path (str) – ruta

Devuelve

nombre de la carpeta de la ruta

Tipo del valor devuelto

str

>> get_folder_name('../myfolder/pydoc')
'pydoc'

project_structure

identify.project_structure.identify_structure(root_folder, excludes, ignores, modules_structure=None, name='Root')

Identifica la estructura del proyecto a documentar

Parámetros

• root_folder (str) – carpeta raíz

• excludes (list) – lista de elementos a excluir

• ignores (list) – lista de elementos a ignorar

• modules_structure (list) – lista de los módulos ya recorridos

• name (str) – nombre del nodo

Devuelve

devuelve el módulo raíz root con todos sus submódulos

Tipo del valor devuelto

Module

>> identify_structure('../myfolder/pydoc')
|--Root
    |--generators
        |----generators.makefiles.py
        |----generators.rst_file.py
        |----generators.sphinx_config_file.py
        |----generators.sphinx_structure.py
    |--i18n
        |----i18n.dictionary.py
        |--locales
            |----i18n.locales.es.py
    |--identify
        |----identify.data.py
        |----identify.packages.py
        |----identify.project_structure.py
    |--utils
        |----utils.path.py
        |----utils.stringify.py

identify.project_structure.get_classes(pyfile_path)

Obtiene las clases que están dentro de un fichero python

Parámetros

pyfile_path (str) – nombre del fichero a inspeccionar

Devuelve

devuelve una lista con todas las clases dentro de un fichero python

Tipo del valor devuelto

list

>> get_classes('./data.py')
['Module', 'PythonFile']