DEV Community

Rafnix Guzmán
Rafnix Guzmán

Posted on • Originally published at blog.rafnixg.dev on

Shell de Odoo: Domina Operaciones Avanzadas, Integración de Librerías y Automatización de Tareas

#automation #cli #python #tutorial

En un post anterior, exploramos los conceptos bsicos de la shell de la CLI de Odoo y cmo configurar IPython como REPL para mejorar nuestra experiencia de desarrollo. Ahora, profundizaremos en el uso de la shell de Odoo, abordando temas ms avanzados y descubriendo cmo sacarle el mximo provecho a esta poderosa herramienta.

El propsito de este post es proporcionar una gua completa para los desarrolladores de Odoo que deseen llevar sus habilidades al siguiente nivel y dominar el uso de la shell en sus proyectos. A lo largo del artculo, cubriremos temas como acceso avanzado, operaciones avanzadas, integracin de libreras externas, automatizacin de tareas y seguridad en la shell de Odoo.

Acceso avanzado a la shell de Odoo

La shell de Odoo es una herramienta poderosa que nos permite interactuar con el sistema Odoo y ejecutar tareas de desarrollo y administracin. En esta seccin, profundizaremos en algunas tcnicas avanzadas para acceder y utilizar la shell de Odoo de manera ms efectiva.

Uso de diferentes archivos de configuracin

En ocasiones, puede ser til tener diferentes archivos de configuracin para distintos entornos o propsitos. Por ejemplo, podras querer tener un archivo de configuracin especfico para trabajar con la shell de Odoo, que incluya parmetros ajustados para este propsito, como el nmero de workers, los lmites de memoria y los puertos XML-RPC y Longpolling.

Para utilizar un archivo de configuracin especfico al acceder a la shell de Odoo, simplemente especifica la ruta del archivo con el parmetro -c al ejecutar el comando odoo-bin shell. Por ejemplo:

./odoo-bin shell -c /path/to/your/custom/odoo.conf
Enter fullscreen mode Exit fullscreen mode

Asegrate de que tu archivo de configuracin personalizado incluye todos los parmetros necesarios para que la shell de Odoo funcione correctamente.

Acceso remoto a la shell de Odoo

En algunos casos, es posible que desees acceder a la shell de Odoo en un servidor remoto, en lugar de ejecutarla localmente. Para hacer esto, puedes utilizar una herramienta como ssh para establecer una conexin segura con el servidor remoto y acceder a la shell de Odoo desde all.

Primero, asegrate de tener ssh instalado en tu mquina local y que tienes acceso al servidor remoto con las credenciales adecuadas. Luego, ejecuta el siguiente comando para establecer una conexin ssh con el servidor remoto:

ssh user@remote-server-ip
Enter fullscreen mode Exit fullscreen mode

Una vez que hayas iniciado sesin en el servidor remoto, navega hasta el directorio de instalacin de Odoo y sigue los pasos habituales para acceder a la shell de Odoo utilizando el comando odoo-bin shell y el archivo de configuracin deseado.

Al utilizar el acceso remoto a la shell de Odoo, ten en cuenta las implicaciones de seguridad y sigue las mejores prcticas para proteger tus datos y evitar accesos no autorizados.

Operaciones avanzadas en la shell de Odoo

La shell de Odoo ofrece muchas posibilidades para realizar tareas de desarrollo y administracin de manera eficiente. En esta seccin, abordaremos algunas operaciones avanzadas que puedes realizar en la shell de Odoo, lo que te permitir aprovechar an ms esta herramienta.

Actualizacin de mdulos desde la shell

Es posible actualizar mdulos directamente desde la shell de Odoo. Para actualizar un mdulo existente, utiliza el mtodo button_upgrade() en el mdulo que deseas actualizar:

module = env['ir.module.module'].search([('name', '=', 'my_module')])
module.button_upgrade()
Enter fullscreen mode Exit fullscreen mode

Donde 'my_module' es el nombre del modulo que deseo actualizar.

Importacin y exportacin de datos en formatos CSV

La shell de Odoo tambin facilita la importacin y exportacin de datos en formatos CSV y XML. Para importar datos desde un archivo CSV, sigue estos pasos:

  1. Instala la librera csv en tu entorno de Odoo.

  2. Utiliza la siguiente estructura para leer y procesar el archivo CSV:

import csv

with open('data.csv', 'r') as csvfile:
    reader = csv.DictReader(csvfile)
    for row in reader:
        # Procesa cada fila del archivo CSV
Enter fullscreen mode Exit fullscreen mode

Para exportar datos a un archivo CSV, puedes utilizar un enfoque similar:

import csv

with open('data.csv', 'w') as csvfile:
    fieldnames = ['field1', 'field2', 'field3']
    writer = csv.DictWriter(csvfile, fieldnames=fieldnames)

    writer.writeheader()
    for record in records:
        # Escribe cada registro en el archivo CSV
Enter fullscreen mode Exit fullscreen mode

Para trabajar con datos en formato XML, puedes utilizar libreras como lxml o xml.etree.ElementTree.

Trabajo con registros y campos relacionales

La shell de Odoo facilita el trabajo con registros y campos relacionales. Para acceder a un campo relacional (por ejemplo, un campo Many2one), simplemente utiliza la notacin de punto:

record = env['res.partner'].browse(1)
print(record.parent_id)
print(record.company_id.name)
Enter fullscreen mode Exit fullscreen mode

Para acceder a campos relacionales inversos (por ejemplo, campos One2many o Many2many), utiliza la misma notacin de punto:

record = env['res.partner'].browse(1)
print(record.child_ids)
for child in record.child_ids:
    print(child.id)
Enter fullscreen mode Exit fullscreen mode

Bsqueda y manipulacin de registros con filtros y operadores avanzados

La shell de Odoo te permite buscar y manipular registros utilizando filtros y operadores avanzados usando la notacion de domains de Odoo. Por ejemplo, puedes utilizar el operador like para buscar registros que coincidan con un patrn especfico:

records = env['res.partner'].search([('name', 'like', 'R%')])
Enter fullscreen mode Exit fullscreen mode

Tambin puedes combinar mltiples criterios de bsqueda utilizando operadores lgicos como & (AND) y | (OR):

records = env['res.partner'].search(['&', ('name', 'like', 'R%'), ('country_id.code', '=', 'PE')])
Enter fullscreen mode Exit fullscreen mode

Uso de contextos

Los contextos en Odoo son una herramienta til para personalizar el comportamiento de las operaciones en funcin de ciertos parmetros, como el idioma o el usuario. Puedes utilizar contextos para realizar consultas en diferentes idiomas o para aplicar filtros especficos a nivel de usuario.

Por ejemplo, para buscar registros en un idioma especfico, puedes pasar el cdigo de idioma en el contexto:

records = env['res.partner'].with_context(lang='es_ES').search([])
Enter fullscreen mode Exit fullscreen mode

Esto retornar los registros traducidos al idioma especificado en el contexto (en este caso, espaol).

Tambin puedes utilizar contextos para aplicar filtros especficos a nivel de usuario. Por ejemplo, si deseas buscar registros que solo sean visibles para un usuario especfico, puedes hacer lo siguiente:

user_id = 2 # ID del usuario especfico
user = env['res.users'].browse(user_id)
records = env['res.partner'].with_context(user=user).search([])
Enter fullscreen mode Exit fullscreen mode

Esto retornar los registros de socios comerciales que solo son visibles para el usuario con ID 2.

Integracin de libreras externas en la shell de Odoo

La shell de Odoo es un entorno interactivo de Python, lo que significa que puedes importar y utilizar libreras externas de Python para mejorar y ampliar la funcionalidad de la shell. En esta seccin, exploraremos cmo utilizar algunas libreras tiles para el anlisis y tratamiento de datos y tambin mencionaremos otras libreras que podran resultar de inters.

Uso de Pandas para el anlisis y tratamiento de datos

Pandas es una biblioteca de Python popular y poderosa que ofrece estructuras de datos y herramientas de anlisis de datos. Su integracin en la shell de Odoo puede ser til para realizar anlisis de datos y para trabajar con grandes conjuntos de registros.

Para utilizar Pandas en la shell de Odoo, primero debes instalarla en tu entorno de Python:

pip install pandas
Enter fullscreen mode Exit fullscreen mode

Una vez instalada, puedes importar Pandas en la shell de Odoo y empezar a utilizar sus funciones. Por ejemplo, puedes utilizar la funcin DataFrame de Pandas para convertir un conjunto de registros de Odoo en un DataFrame de Pandas:

import pandas as pd

partners = env['res.partner'].search([])
data = []

for partner in partners:
    data.append({
        'id': partner.id,
        'name': partner.name,
        'email': partner.email,
        'country': partner.country_id.name,
    })

df = pd.DataFrame(data)
Enter fullscreen mode Exit fullscreen mode

Ahora que tienes un DataFrame de Pandas, puedes utilizar todas las funciones y herramientas de anlisis de datos que ofrece Pandas. Por ejemplo, puedes realizar agrupaciones, filtrados, ordenamientos y mucho ms.

Otras libreras tiles para mejorar el trabajo en la shell

Adems de Pandas, hay muchas otras libreras de Python que pueden ser tiles en la shell de Odoo. A continuacin, se mencionan algunas de ellas:

  1. NumPy : Esta biblioteca es muy til para realizar clculos matemticos y estadsticos en conjuntos de datos. Puedes utilizar NumPy junto con Pandas para llevar a cabo anlisis avanzados en tus datos de Odoo.

  2. Requests : Requests es una biblioteca popular para realizar solicitudes HTTP en Python. Puedes utilizarla en la shell de Odoo para interactuar con servicios web y APIs externas.

  3. OpenPyXL : OpenPyXL es una biblioteca de Python para leer y escribir archivos Excel. Puedes utilizarla en la shell de Odoo para importar y exportar datos en formato Excel.

Estas son solo algunas de las muchas libreras disponibles para Python que pueden mejorar tu experiencia de trabajo en la shell de Odoo. No dudes en explorar otras libreras y adaptarlas a tus necesidades especficas.

Automatizacin de tareas con la shell de Odoo

Una de las ventajas de trabajar con la shell de Odoo es la posibilidad de automatizar tareas y procesos. En esta seccin, exploraremos cmo ejecutar scripts y comandos desde archivos externos y cmo programar tareas automatizadas y cron jobs desde la shell.

Ejecucin de scripts y comandos desde archivos externos

En lugar de ejecutar comandos individualmente en la shell de Odoo, puedes crear un archivo de script de Python que contenga una serie de comandos y ejecutar ese archivo. Esto facilita la automatizacin y la reutilizacin de cdigo.

Para ejecutar un script de Python usando el entorno de Odoo, debemos crear primero un script wrapper que nos permita ejecutar nuestros scripts inyectando el entorno de odoo. sigue estos pasos:

  1. Crea un archivo llamado odoo_wrapper.py con el siguiente contenido:

  2. Crea un archivo de script de Python (por ejemplo, mi_script.py) con una funcin llamada run que reciba un argumento env:

def run(env):
    # Tus comandos aqui, utilizando la variable 'env' para acceder a la API de Odoo
    # Este archivo puede ser todo lo complejo que tu quieras
    # Para probar usemos esto de ejemplo:
    partners = env['res.partner'].search([])
    print("Numero de contactos:", len(partners))
Enter fullscreen mode Exit fullscreen mode

  1. Desde la lnea de comandos, navega hasta el directorio donde se encuentra el archivo odoo_wrapper.py.

  2. Ejecuta el siguiente comando para ejecutar el archivo odoo_wrapper.py y que a su vez ejecute tu archivo mi_script.py:

python3 odoo_wrapper.py /path/to/mi_script.py
Enter fullscreen mode Exit fullscreen mode

El archivo odoo_wrapper.py se encargar de ejecutar el archivo mi_script.py utilizando la API de Odoo y la base de datos especificada en el archivo de configuracin. La funcin run en tu archivo mi_script.py se ejecutar con el entorno de Odoo proporcionado.

Programacin de tareas automatizadas y cron jobs desde la shell

La shell de Odoo tambin te permite programar tareas automatizadas y cron jobs directamente desde la shell. Estas tareas se ejecutarn en intervalos especficos y pueden ser tiles para automatizar procesos como copias de seguridad, actualizaciones, sincronizaciones y ms.

Para programar una tarea automatizada o un cron job desde la shell de Odoo, sigue estos pasos:

  1. En la shell de Odoo, accede al modelo ir.cron:

  2. Crea un nuevo registro de cron job utilizando el mtodo create() y proporciona los detalles necesarios, como el nombre, el modelo, el mtodo y el intervalo de tiempo:

ir_cron.create({
    'name': 'Mi Cron Job',
    'model_id': env.ref('base.model_res_partner').id,
    'state': 'code',
    'code': "model.my_custom_method()",
    'interval_number': 1,
    'interval_type': 'days',
    'numbercall': -1,
    'doall': False,
    'active': True,
})
Enter fullscreen mode Exit fullscreen mode

En este ejemplo, hemos creado un cron job que ejecutar el mtodo my_custom_method() en el modelo res.partner cada da. Puedes personalizar los parmetros segn tus necesidades.

Una vez creada la tarea, se ejecutar automticamente segn el intervalo de tiempo especificado. Puedes verificar y administrar las tareas automatizadas y los cron jobs en la interfaz web de Odoo, bajo Configuracin > Tcnico > Automatizacin > Tareas programadas.

Seguridad y buenas prcticas en el uso de la shell de Odoo

Recomendaciones para proteger la informacin y evitar accesos no autorizados

Cuando trabajamos con la shell de Odoo, es importante tener en cuenta la seguridad y garantizar que la informacin y los datos estn protegidos. A continuacin, se presentan algunas recomendaciones para proteger la informacin y evitar accesos no autorizados:

  1. Controlar el acceso a la shell de Odoo : Limita el acceso a la shell de Odoo a los usuarios que realmente necesitan usarla. Asegrate de que las credenciales de inicio de sesin y los permisos estn configurados correctamente para restringir el acceso solo a los usuarios autorizados.

  2. Proteger el archivo de configuracin : El archivo de configuracin de Odoo puede contener informacin sensible, como contraseas de base de datos y otros datos de configuracin. Asegrate de proteger este archivo mediante permisos de lectura y escritura adecuados y almacenarlo en una ubicacin segura.

  3. Hacer copias de seguridad de los datos : Realiza copias de seguridad peridicas de la base de datos de Odoo y almacena estas copias de seguridad en un lugar seguro y protegido. Esto te permitir restaurar los datos en caso de un problema de seguridad o una prdida de datos accidental.

Uso responsable de la shell en entornos de produccin

Es importante utilizar la shell de Odoo de manera responsable en entornos de produccin para evitar problemas y garantizar la estabilidad del sistema. Aqu hay algunas pautas para usar la shell de Odoo de manera responsable:

  1. Evitar cambios en tiempo real en entornos de produccin : Aunque la shell de Odoo permite realizar cambios en tiempo real en la base de datos y el sistema, estos cambios pueden tener consecuencias imprevistas. Siempre es mejor realizar cambios en un entorno de desarrollo o prueba antes de aplicarlos en un entorno de produccin.

  2. Limitar el uso de la shell en entornos de produccin : Utiliza la shell de Odoo en entornos de produccin solo cuando sea necesario y por el tiempo estrictamente necesario. Evita dejar sesiones de shell abiertas innecesariamente.

  3. Registrar y auditar el uso de la shell : Mantn un registro de quin accede a la shell de Odoo y qu acciones se realizan en la shell. Estos registros pueden ser tiles para identificar problemas de seguridad y realizar auditoras.

  4. Seguir las mejores prcticas de desarrollo : Al utilizar la shell de Odoo para desarrollar mdulos y realizar cambios en la plataforma, sigue las mejores prcticas de desarrollo de Odoo para garantizar un cdigo seguro, eficiente y fcil de mantener.

Conclusin

En este artculo, se profundizado en el uso y la configuracin de la shell de Odoo para aprovechar su potencial y mejorar nuestras habilidades en el desarrollo y la gestin de Odoo. Hemos cubierto temas esenciales como el acceso avanzado a la shell, la realizacin de operaciones avanzadas, la integracin de libreras externas, la automatizacin de tareas y la implementacin de medidas de seguridad y buenas prcticas.

Espero que este artculo te haya proporcionado una comprensin ms profunda del potencial de la shell de Odoo y te haya equipado con el conocimiento necesario para aprovechar sus capacidades en tus proyectos. Te invitos a aplicar y experimentar con lo aprendido, y a compartir tus experiencias y conocimientos con otros miembros de la comunidad Odoo.

Top comments (0)