mon-entreprise/publicodes

Publicode est un langage déclaratif pour encoder les algorithmes d'intérêt public. Il permet de réaliser des calculs généraux tout en fournissant une explication permettant de comprendre et de documenter ces calculs.

Publicode est adapté pour modéliser des domaines métiers complexes pouvant être décomposés en règles élémentaires simples (comme la législation socio-fiscale, un bilan carbone, un estimateur de rendement locatif, etc.).

Il permet de générer facilement des simulateurs web interactifs où l'on peut affiner progressivement le résultat affiché, et d'exposer une documentation du calcul explorable.

Projets phares

• mon-entreprise.fr utilise publicodes pour spécifier l'ensemble des calculs relatifs à la législation socio-fiscale en France. Le site permet entre autre de simuler une fiche de paie complète, de calculer les cotisations sociales pour un indépendant ou encore connaître le montant du chômage partiel.
• futur.eco utilise publicodes pour calculer les bilans carbone d'un grand nombre d'activités, plats, transports ou biens.
• Nos Gestes Climat utilise publicodes pour proposer un calculateur d'empreinte climat personnel de référence complètement ouvert

Syntaxe

Principe de base

La syntaxe de Publicode est basée sur le langage Yaml.

Un fichier Publicode contient une liste de règles identifiées par leur nom et possédant une formule de calcul :

prix d'un repas:
  formule: 10 €

Une formule de calcul peut faire référence à d'autres règles. Dans l'exemple suivant la règle prix total aura pour valeur 50 (= 5 * 10)

prix d'un repas:
  formule: 10 €

prix total:
  formule: 5 * prix d'un repas

Il s'agit d'un langage déclaratif : comme dans une formule d'un tableur le prix total sera recalculé automatiquement si le prix d'un repas change. L'ordre de définition des règles n'a pas d'importance.

Unités

Pour fiabiliser les calculs et faciliter leur compréhension, on peut préciser l'unité des valeurs littérales :

prix d'un repas:
  formule: 10 €/repas

nombre de repas:
  formule: 5 repas

prix total:
  formule: nombre de repas * prix d'un repas

Le calcul est inchangé mais on a indiqué que le "prix d'un repas" s'exprime en €/repas et que le "nombre de repas" est un nombre de repas. L'unité du prix total est inférée automatiquement comme étant en €. (€/repas * repas = €)

Ce système d'unité permet de typer les formules de calcul et de rejeter automatiquement des formules incohérentes :

prix d'un repas:
  formule: 10 €/repas

nombre de repas:
  formule: 5 repas

frais de réservation:
  formule: 1 €/repas

prix total:
  formule: nombre de repas * prix d'un repas + frais de réservation
# Erreur:
# La formule de "prix total" est invalide.

Dans l'exemple ci-dessus Publicode détecte une erreur car les termes de l'addition ont des unités incompatibles : d'un côté on a des € et de l'autre des €/repas. Comme dans les formules de Physique, cette incohérence d'unité témoigne d'une erreur de logique. Ici une manière de corriger l'erreur peut être de factoriser la variable "nombre de repas" dans la formule du "prix total".

prix total:
  formule: nombre de repas * (prix d'un repas + frais de réservation)

Attention : Il ne faut pas insérer d'espace autour de la barre oblique dans les unités, l'unité € / mois doit être notée €/mois

Conversion

Publicode convertit automatiquement les unités si besoin.

salaire:
  formule: 1500 €/mois

prime faible salaire:
  applicable si: salaire < 20 k€/an
  formule: 300€

On peut forcer la conversion des unités via la propriété unité, ou la notation suffixée [...].

salaire:
  unité: €/mois
  formule: 3200

salaire annuel:
  formule: salaire [k€/an]

Types de base disponibles pour la conversion :

• jour / mois / an
• € / k€

Pages d'explications

L'explication des règles est un des objectifs fondamentaux de Publicodes.

Chaque règle se voit générer automatiquement une page explicatives correspondante dans le front-end, contenant une information facilement digeste mise en regard des calculs eux-mêmes.

Plusieurs propriétés sont reprises dans ces pages d'explications :

• le titre, qui s'affiche en haut de la page. Par défaut on utilise le nom de la règle, mais la propriété titre permet de choisir un titre plus approprié ;
• la description qui peut être rédigée en Markdown et est généralement affichée comme paragraphe d'introduction sur la page. On utilise le caractère > pour indiquer au parseur Yaml que la description utilise du Markdown ;
• les références externes (documentation utile) affichées en bas de page et qui sont constituées d'une liste de liens avec une description.

ticket resto:
  titre: Prise en charge des titres-restaurants
  formule: 4 €/repas
  description: >
    L'employeur peut remettre des titres restaurants sous plusieurs formats:
    - ticket *papier*
    - carte à *puce*
    - appli *mobile*    
  références:
    Fiche service public: https://www.service-public.fr/professionnels-entreprises/vosdroits/F21059
    Fiche Urssaf: https://www.urssaf.fr/portail/home/taux-et-baremes/frais-professionnels/les-titres-restaurant.html

Voir aussi la rubrique sur les mécanismes.

Espaces de noms

Les espaces de noms sont utiles pour organiser un grand nombre de règles. On utilise le . pour exprimer la hiérarchie des noms.

prime de vacances:
  formule: taux * 1000 €

prime de vacances . taux:
  formule: 6%

Ici prime de vacances est à la fois une règle et un espace de noms. La variable taux est définie dans cet espace de noms et c'est elle qui est référencée dans la formule de calcul de la règle prime de vacances.

La règle prime de vacances est elle-même définie dans l'espace de nom racine.

On pourrait avoir une autre variable taux dans un espace de nom différent, sans que cela entre en conflit:

# Ceci n'entre pas dans le calcul de `prime de vacances` définie plus haut
autre prime . taux:
  formule: 19%

On dit que la formule de la règle prime de vacances fait référence à la règle prime de vacances . taux via le nom raccourci taux.

Pour faire référence à une règle hors de son espace de nom, on peut écrire le nom complet de cette règle:

prime de vacances v2:
  formule: autre prime . taux * 1000 €

Dans le cas d'espaces de noms imbriqués (à plus qu'un étage), le nom inscrit dans une règle donnée est recherché de plus en plus haut dans la hiérarchie des espaces de nom jusqu'à la racine.

contrat salarié . rémunération . primes . prime de vacances:
  formule: taux générique * 1000 €

contrat salarié . rémunération . taux générique:
  formule: 10%

Ici contrat salarié . rémunération . primes . prime de vacances va faire référence à contrat salarié . rémunération . taux générique trouvé deux espaces de noms plus haut, et va donc valoir 100 €.

Mécanismes

Les règles de calcul élémentaires sont extraites dans des "mécanismes" qui permettent de partager la logique de calcul et de générer une page d'explication spécifique par mécanisme.

Par exemple on a un mécanisme barème:

revenu imposable:
  formule: 54126 €

impôt sur le revenu:
  formule:
    barème:
      assiette: revenu imposable
      tranches:
        - taux: 0%
          plafond: 9807 €
        - taux: 14%
          plafond: 27086 €
        - taux: 30%
          plafond: 72617 €
        - taux: 41%
          plafond: 153783 €
        - taux: 45%

La syntaxe hiérarchique de Yaml permet d'imbriquer les mécanismes :

prime . fixe:
  formule: 1000€

prime . taux du bonus:
  formule: 20%

prime:
  formule:
    somme:
      - fixe
      - produit:
          assiette: fixe
          taux: taux du bonus

Aller à la liste des mécanismes existants

Applicabilité

On peut définir des conditions d'applicabilité des règles :

date de début:
  formule: 12/02/2020

ancienneté en fin d'année:
  formule:
    durée:
      depuis: date de début
      jusqu'à: 31/12/2020

prime de vacances:
  applicable si: ancienneté en fin d'année > 1 an
  formule: 200€

Ici si l'ancienneté est inférieure à un an la prime de vacances ne sera pas applicable. Les variables non applicables sont ignorées au niveau des mécanismes (par exemple le mécanisme somme comptera une prime non applicable comme valant zéro, voir la page spécifique aux mécanismes).

La syntaxe suivante est également valable:

dirigeant . assimilé salarié:
  formule: dirigeant = 'assimilé salarié'
  rend non applicable:
    - contrat salarié . convention collective

Remplacement

Certaines règles ne s'appliquent parfois que dans quelques situations particulières et modifier la définition des règles générales pour prendre en compte ces particularismes pose des problème de maintenabilité de la base de règle.

Publicode dispose d'un mécanisme de remplacement qui permet d'amender n'importe quelle règle existante sans avoir besoin de la modifier :

frais de repas:
  formule: 5 €/repas

convention hôtels cafés restaurants:
  formule: oui

convention hôtels cafés restaurants . frais de repas:
  remplace: frais de repas
  formule: 6 €/repas

montant repas mensuels:
  formule: 20 repas * frais de repas

On peut également choisir de remplacer uniquement dans un contexte donné:

a:
  formule: 10 min

b:
  formule: 20 min

règle nulle:
  remplace:
    - règle: a
      sauf dans: somme originale
    - règle: b
      dans: somme avec remplacements
  formule: 0

somme originale:
  formule: a + b

somme avec remplacements:
  formule: a + b

Références de paramètres

Si le mécanisme de remplacement permet de faire des substitutions de règles complètes, il est parfois utile de ne modifier qu'un seul paramètre d'une règle existante, par exemple modifier le facteur d'une multiplication tout en conservant le reste de sa définition inchangée.

Une première manière de faire consiste à extraire le paramètre en question dans une règle indépendante, le rendant ainsi accessible et modifiable depuis l'extérieur :

prime:
  formule:
    multiplication:
      assiette: 1000€
      taux: taux

prime . taux:
  formule: 5%

super-prime:
  remplace: prime . taux
  formule: 10%

Ce code fonctionne mais il nous oblige a créer une règle prime . taux qui n'est pas pertinente en tant qu'entité autonome (avec sa propre page de documentation, etc.), uniquement pour pouvoir la modifier avec un remplace. On a aussi introduit une indirection dans la définition de la prime en remplaçant une ligne explicite taux: 5% par une référence vers une règle tierce taux: taux, qui est loin d'être aussi claire.

Pour ce cas d'usage il est possible d'utiliser une référence de paramètre. On garde la définition de la prime inchangée et on annote l'argument auquel on veut accéder depuis l'extérieur avec le mot clé [ref] :

prime:
  formule:
    multiplication:
      assiette: 1000€
      taux [ref]: 5%

super-prime:
  remplace: prime . taux
  formule: 10%

Par défaut le paramètre est référencé avec son nom dans l'espace de nom de la règle, ici prime . taux. Il est possible de choisir un nom personnalisé :

prime:
  formule:
    multiplication:
      assiette: 1000€
      taux [ref taux bonus]: 5%

super-prime:
  remplace: prime . taux bonus
  formule: 10%

Lors d'une relecture future de la règle prime le mot clé [ref] indique explicitement que du code extérieur dépend du paramètre taux, ce a quoi il faut être vigilant en cas de ré-écriture.

La syntaxe suivante est équivalente :

prime:
  formule:
    multiplication:
      assiette: 1000€
      taux:
        définition: taux bonus
        formule: 5%

super-prime:
  remplace: prime . taux bonus
  formule: 10%

Évaluation

Le ticket https://github.com/betagouv/mon-entreprise/issues/796#issuecomment-569115296 détaille le fonctionnement de l'évaluation d'un fichier Publicode.