NXL Forge.Pendant que le marché rédige — nous livrons
Technique Odoo··5 min de lecture

Odoo 20 supprime get_param : vos paramètres système se typent

Odoo 20 retire get_param et set_param du modèle ir.config_parameter et les remplace par huit méthodes typées. Valeurs fausses conservées, défauts propres à chaque type, valeurs illisibles ramenées au défaut : trois comportements changent sans erreur visible. Voici notre méthode pour migrer les modules custom.

Odoo 20MigrationORMDéveloppement Odoo

Dans la plupart des modules Odoo que nous reprenons en migration, une ligne revient sans cesse : self.env['ir.config_parameter'].sudo().get_param('ma_cle'). Elle sert à lire une clé d'API, un délai, un drapeau d'activation. En Odoo 20, cette ligne lève une AttributeError. Les méthodes get_param et set_param n'existent plus dans le modèle ir.config_parameter de la branche 20.0, et elles sont remplacées par huit méthodes typées1.

Le changement est entré dans Odoo Online 19.1, sous l'intitulé « New API for ir.config_parameter » du changelog ORM officiel2. Les clients Odoo.sh et on-premise qui sont restés en 19.0 le découvrent donc d'un bloc en passant à la 20.

Ce que dit le code

Dans la branche 20.0, le fichier ir_config_parameter.py expose quatre lecteurs et quatre écrivains :

LectureDéfautÉcriture
get_str(key, default='')chaîne videset_str(key, value)
get_int(key, default=0)0set_int(key, value)
get_float(key, default=0.0)0.0set_float(key, value)
get_bool(key, default=False)Falseset_bool(key, value)

Le stockage, lui, ne bouge pas. Le champ value reste un fields.Text, et son aide indique que la valeur est une variable Python sérialisée en texte, avec quatre types acceptés (str, bool, int, float) et une valeur vide qui signifie « non défini ». La conversion se fait à la lecture, dans une méthode privée _convert, et le résultat est mis en cache par @api.ormcache('key', 'type_', cache='stable'). Le type fait donc partie de la clé de cache.

La pull request d'origine, #223180, liste quatre chemins d'écriture d'un paramètre : set_param direct, import XML, création d'un res.config.settings et modification dans l'interface3. Son auteur pointe un piège que nous avons tous écrit un jour. L'expression bool(get_param(key, True)) est toujours vraie, puisque la valeur "False" stockée en base reste une chaîne non vide. Le nouveau get_bool passe par str2bool, qui accepte y, yes, 1, true, t, on et leurs contraires, sans tenir compte de la casse4.

Trois comportements qui changent en silence

Le remplacement mécanique de get_param par get_str compile, mais il ne suffit pas. Trois différences touchent la logique métier.

Une valeur fausse ne supprime plus l'enregistrement. En 19.0, set_param(key, False) ou set_param(key, None) faisait un unlink() de la ligne existante5. En 20.0, _set convertit None en valeur vide et conserve l'enregistrement ainsi que son ir.model.data. Un module qui testait l'absence de la ligne via search([('key', '=', ...)]) pour savoir si une option était désactivée obtient désormais un résultat non vide.

Une valeur illisible renvoie le défaut. Si la base contient "abc" pour une clé lue avec get_int, la conversion échoue, Odoo journalise un avertissement « ir.config_parameter with key %s has invalid value %r for type %s » et renvoie la valeur par défaut fournie par l'appelant. Le code ne plante pas, ce qui est confortable en production. En contrepartie, une faute de saisie d'un administrateur passe inaperçue si personne ne surveille les logs.

Le défaut dépend du type. Avec get_param, l'absence de clé renvoyait False par défaut. Avec get_str, elle renvoie une chaîne vide, et get_int renvoie 0. Les tests du type if param is False: ou if param is None: deviennent faux sans prévenir.

Le modèle ajoute aussi deux verrous. Les clés listées dans _default_parameters (dont database.secret, database.uuid et web.base.url) ne peuvent plus être supprimées, et aucune clé ne peut être renommée par write. Les deux cas lèvent une ValidationError.

Comment migrer un module

Nous procédons en quatre passes sur chaque module custom.

  1. Inventaire. Un grep -rn "get_param\|set_param" sur le dépôt donne la liste. Il faut l'étendre aux fichiers JavaScript qui appelaient get_param par RPC, et aux scripts externes qui passaient par XML-RPC.
  2. Typage. Pour chaque clé, on choisit le type réel. Un délai en secondes passe en get_int, un taux en get_float, un interrupteur en get_bool. On supprime au passage les int(...), float(...) et safe_eval(...) qui entouraient l'ancien appel.
  3. Défauts. On vérifie que le défaut implicite du nouveau getter correspond à l'intention. Pour une clé d'API, get_str(key) renvoie '', et le test if not api_key: reste valide. Pour un seuil qui ne doit jamais valoir zéro, on passe un défaut explicite.
  4. Données en base. Avant la migration, une requête sur ir_config_parameter permet de repérer les valeurs incohérentes avec leur futur type. Les "True" et "False" passent sans souci dans str2bool. Les "Oui" ou "1.0" lus en entier, en revanche, finiront sur la valeur par défaut.

Côté droits, rien ne change sur le principe. Chaque getter commence par check_access('read'), et les appels depuis un contexte utilisateur standard gardent leur sudo().

Notre lecture

Ce changement est petit en lignes de code et large en surface. Sur les modules que nous auditons, les paramètres système portent souvent la configuration des connecteurs : URL d'un transporteur, jeton d'une plateforme de facturation, délai de synchronisation. Une erreur de type à cet endroit ne casse pas l'installation. Elle dégrade un flux, et on la découvre trois semaines plus tard.

La nouvelle API nous paraît plus saine. Elle met fin aux conversions bricolées et au faux booléen, et elle rend le type lisible à l'endroit de l'appel. Nous conseillons de la traiter comme une tâche de migration à part entière, avec sa propre revue, plutôt que comme un rechercher-remplacer glissé dans un lot plus large. Pour les intégrateurs qui maintiennent des modules sur plusieurs versions, un petit utilitaire de compatibilité qui appelle get_param en 19.0 et get_str ou get_int en 20.0 évite de dupliquer les branches.

Un point reste à surveiller. Le changelog officiel résume l'évolution en une ligne et ne mentionne pas la suppression de get_param. C'est le code de la branche 20.0 qui le montre. Nous vous recommandons de lire directement la source plutôt que le changelog avant de chiffrer une montée de version.

Sources

Footnotes

  1. Code source Odoo, branche 20.0, odoo/addons/base/models/ir_config_parameter.py. Ni get_param ni set_param n'y figurent. ↩

  2. Documentation Odoo 20.0, « Changelog » de la référence ORM, section Odoo Online version 19.1. ↩

  3. Pull request odoo/odoo #223180, « [IMP] base: improve ir.config_parameter », étiquetée 19.1, dont le dernier commit s'intitule « [REM] base: remove set_param, get_param ». ↩

  4. Code source Odoo, branche 20.0, odoo/tools/misc.py, fonction str2bool. ↩

  5. Code source Odoo, branche 19.0, odoo/addons/base/models/ir_config_parameter.py, méthode set_param. ↩

Sur le même thème

Votre idée mérite un vrai logiciel

Une question, un projet Odoo ?

Modules préconfigurés, intégration, sur-mesure — parlons-en sans engagement.