el método .show_tree (mostrar árbol)

El Método `show_tree` (Mostrar Árbol)

El método show_tree te permite visualizar, ya sea por tu terminal o como salida en tu IDE, todos los archivos actualmente en tu pipeline. Está diseñado como una versión simple y análoga del comando 'tree' de UNIX.

Esta introducción al método show_tree está dividida en las siguientes secciones:

Argumentos del Método show_tree
Ejemplo del Método show_tree
El Operador Comodín y la Raíz Global

Argumentos del Metodo `show_tree`

El método show_tree toma un argumento (requerido):

symbolic_directory_path (str) - El directorio en el sistema Krixik cuyo contenido quieres visualizar. Si se usa el operador comodín como sufijo, este directorio se convierte en la raíz del árbol visualizado.

Ejemplo del Metodo `show_tree`

Primero debes crear un pipeline sobre el cual puedas ejecutar este ejemplo. Un pipeline que consiste de un solo módulo parser funcionará bien. Usa el método create_pipeline para crearlo:

# crea un pipeline para este ejemplo con un módulo parser
pipeline = krixik.create_pipeline(name="metodo_show_tree_1_parser", module_chain=["parser"])

Para facilitar las cosas, establece la ubicación de un archivo y guárdalo como una variable; luego usarás el mismo archivo varias veces pero con diferentes nombres. Lo haces de la siguiente manera:

# define la ruta a un archivo de entrada en tu directorio de ejemplos
test_file = data_dir + "input/1984_muy_corto.txt"

Ahora usa el método process para procesar el archivo por el pipeline varias veces, pero con file_name diferente cada vez. Observa la estructura de symbolic_directory_paths que se va creando:

# procesa el mismo archivo por el pipeline varias veces
process_output = pipeline.process(
    local_file_path=test_file,  # indícale a Krixik que quieres el archivo antes definido y guardado en una variable
    local_save_directory=data_dir + "output",  # el directorio local en el que se guardará el archivo de salida
    expire_time=60 * 30,  # process data will be deleted from the Krixik system in 30 minutes
    wait_for_process=True,  # espera que el proceso termine antes de devolver control del IDE al usuario
    verbose=False,  # no mostrar actualizaciones de proceso al ejecutar el código
    symbolic_directory_path="/mi/ruta/personalizada",
    file_name="archivo_num_uno.txt",
)

process_output = pipeline.process(
    local_file_path=test_file,  # indícale a Krixik que quieres el archivo antes definido y guardado en una variable
    local_save_directory=data_dir + "output",  # el directorio local en el que se guardará el archivo de salida
    expire_time=60 * 30,  # process data will be deleted from the Krixik system in 30 minutes
    wait_for_process=True,  # espera que el proceso termine antes de devolver control del IDE al usuario
    verbose=False,  # no mostrar actualizaciones de proceso al ejecutar el código
    symbolic_directory_path="/mi/ruta/personalizada",
    file_name="archivo_num_dos.txt",
)

process_output = pipeline.process(
    local_file_path=test_file,  # indícale a Krixik que quieres el archivo antes definido y guardado en una variable
    local_save_directory=data_dir + "output",  # el directorio local en el que se guardará el archivo de salida
    expire_time=60 * 30,  # process data will be deleted from the Krixik system in 30 minutes
    wait_for_process=True,  # espera que el proceso termine antes de devolver control del IDE al usuario
    verbose=False,  # no mostrar actualizaciones de proceso al ejecutar el código
    symbolic_directory_path="/mi/ruta/personalizada/subdir",
    file_name="archivo_num_tres.txt",
)

Ahora puedes visualizar la estructura de directorios de tu pipeline con el método show_tree.

En este ejemplo usarás el operador comodín * para crear la raíz global en symbolic_directory_path, cosa que será explicada en breve.

# visualiza la estructura de directorios de tu pipeline con la raíz global
show_tree_output = pipeline.show_tree(symbolic_directory_path="/*")

/
└── /my
    └── /custom
        └── /path
            ├── file_num_one.txt
            ├── file_num_two.txt
            └── /subpath
                └── file_num_three.txt

Verás que los nombres de directorios están precedidos por el símbolo barra (/) y que los nombres de los archivos no. Esto te permite fácilmente diferenciar entre el uno y el otro en la salida de este método.

El Operador Comodin y la Raiz Global

El operador comodín es el asterisco: *

Al igual que con el método list (lista), el método semantic_search (búsqueda semántica) y el método keyword_search, puedes usar el operador comodín * en el argumento symbolic_directory_path para el método show_tree.

El operador comodín * puede usarse como sufijo en el método show_tree si deseas mostrar la estructura del árbol debajo de cierto directorio. La sintaxis de esto se vería así:

# uso del operador comodín * en symbolic_direcctory_path
symbolic_directory_path='/home/files/studies*'

Usar este symbolic_directory_path con el método show_tree generaría una visualización de la estructura de directorios bajo /home/files/studies.

La máxima expresión del operador comodín * en symbolic_directory_path se llama "la raíz global". Es simplemente una barra seguida de un operador comodín * (/*), incluye todos los archivos en tu pipeline, y se ve así:

# ejemplo de cómo se ve la raíz global
symbolic_directory_path='/*'

Como puedes ver en la salida de código anterior, usar la raíz global con el método show_tree devuelve una visualización de la estructura de directorio completa de tu pipeline.

el método .show_tree (mostrar árbol)