feat: met le loyer d'un lot sur un axe de temps et le rapporte au mètre carré

La fiche d'un lot cumulait tout son historique en un chiffre. Une
révision de loyer, une vacance ou un décrochage y étaient donc
invisibles. Le bloc `loyer` remet les lignes sur un axe de temps, dont
l'unité est le mois loué et non le mois du compte rendu : un rappel de
mars facturé en avril décrit mars.

Trois formes de lignes cohabitent sous le même `type_ligne = "loyer"`,
et les confondre fausse la courbe :

- le loyer d'un mois, cas courant ;
- le loyer d'un trimestre, forme réelle des baux commerciaux du parc,
  réparti sur les mois qu'il couvre — sans quoi deux mois sur trois
  paraîtraient vides alors que le local est loué ;
- le prorata d'entrée, de sortie ou l'avoir, rattaché à son mois mais
  compté à part. Les additionner ferait passer un mois de changement de
  locataire pour un mois à loyer effondré.

Un mois sans ligne reste vide plutôt qu'à zéro : zéro dirait « loué
gratuitement », ce qu'aucun compte rendu ne dit. Un mois facturé
seulement au prorata est signalé comme transition, pour ne pas se
confondre avec une vacance.

Le mètre carré vient de la fiche saisie, qu'aucun PDF ne porte : tant
qu'elle manque, le ratio reste nul et la page renvoie vers la saisie.
Les médianes qui situent le lot rejouent exactement la même répartition
pour les autres lots — les calculer autrement ne voudrait rien dire — et
s'accompagnent toujours de leur effectif et du nombre de lots exclus
faute de surface.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
2026-08-21 22:38:41 +02:00
parent fa54d523a5
commit b1ff0812c1
4 changed files with 1050 additions and 1 deletions

View File

@@ -0,0 +1,384 @@
"""Le loyer d'un lot mois par mois, et ce qu'il vaut au mètre carré.
Le reste de la fiche d'un lot cumule tout l'historique en un chiffre. Ce module
fait l'inverse : il remet le loyer sur un axe de temps, seule façon de voir une
révision, une vacance ou un décrochage.
**L'axe est le mois loué, pas le mois du compte rendu.** Un loyer de mars
facturé en mars et un rappel de mars facturé en avril ne décrivent pas le même
mois ; classer par date de document mettrait le second sur avril et ferait un
faux creux suivi d'un faux pic.
Trois formes de lignes cohabitent dans ``revenus`` sous le même
``type_ligne = "loyer"``, et les confondre fausse la courbe :
- le **loyer d'un mois** (01/03 → 31/03), cas courant ;
- le **loyer d'un trimestre** (01/10 → 31/12), forme réelle des baux
commerciaux du parc. Le laisser sur son seul mois de début creuserait deux
mois sur trois ; il est donc réparti à parts égales sur les mois couverts.
Ce n'est pas une clé de répartition inventée : la période est portée par le
compte rendu, et diviser un montant par le nombre de mois qu'il couvre ne
suppose rien de plus que ce que la ligne dit déjà ;
- le **prorata** (22/06 → 30/06 à l'entrée d'un locataire, 18/10 → 18/10 pour
un avoir), qui ne vaut pas un mois plein. Il est rattaché à son mois mais
compté à part du loyer : additionner les deux ferait passer un mois de
changement de locataire pour un mois à loyer effondré, et un mois annulé par
avoir pour un mois où le loyer aurait baissé.
La frontière tient à la période : commencer un premier de mois et finir un
dernier de mois, c'est couvrir des mois entiers, donc porter un loyer. Tout le
reste est un prorata, rattaché à son mois quand il y tient — et écarté quand il
chevauche plusieurs mois sans les couvrir (14/03 → 31/08, régularisation), car
aucun mois ne peut alors le revendiquer.
Un mois sans loyer plein mais avec un prorata n'est donc pas une vacance : c'est
un mois de transition, et la fiche le distingue au lieu de le confondre avec un
trou.
Le mètre carré vient de la fiche saisie (`lot_caracteristiques.surface`), pas
des comptes rendus qui l'ignorent. Sans surface, le ratio vaut ``None`` et non
zéro : la page montre le trou plutôt que d'afficher un loyer au m² de 0 €.
"""
from calendar import monthrange
from dataclasses import dataclass, field
from datetime import date
from sqlalchemy import select
from sqlalchemy.orm import Session
from ..database.models import Immeuble, Lot, LotCaracteristiques, Revenu
from ..services.referentiel import TYPE_LOT_EFFECTIF, joindre_fiche
#: Type des lignes portant un loyer. Les rappels et les régularisations
#: (`rappel_loyer`, `divers`) décrivent des rattrapages, pas le loyer d'un mois :
#: la chronologie de la fiche les montre déjà, la courbe les laisse dehors.
TYPE_LIGNE_LOYER = "loyer"
#: Sous ce nombre de lots comparables, une médiane décrit surtout le hasard.
#: Elle reste calculée et affichée avec son effectif — le lecteur tranche.
EFFECTIF_MEDIANE_FIABLE = 3
def mois_de(jour: date) -> str:
"""Le mois d'une date, au format ``2026-01``."""
return f"{jour.year:04d}-{jour.month:02d}"
def mois_suivant(mois: str) -> str:
"""Le mois d'après, même format."""
annee, numero = (int(part) for part in mois.split("-"))
return f"{annee + 1:04d}-01" if numero == 12 else f"{annee:04d}-{numero + 1:02d}"
def mois_entiers(debut: date | None, fin: date | None) -> list[str]:
"""Les mois entiers que couvre la période, vide si elle en couvre aucun.
Une période part du premier jour d'un mois et s'arrête au dernier jour d'un
mois : elle couvre alors ces mois-là, un ou plusieurs. Sinon, c'est un
prorata, et aucun mois ne lui appartient entièrement.
"""
if debut is None or fin is None or fin < debut:
return []
if debut.day != 1 or fin.day != monthrange(fin.year, fin.month)[1]:
return []
mois, dernier = mois_de(debut), mois_de(fin)
couverts = [mois]
while mois != dernier:
mois = mois_suivant(mois)
couverts.append(mois)
return couverts
@dataclass
class MoisLoue:
"""Ce qu'un mois a été facturé, charges et proratas à part."""
mois: str
#: Loyer hors charges pour un mois plein. `None` quand aucune ligne ne
#: couvre le mois entier : le lot est vacant, sorti de la gestion, en
#: changement de locataire, ou son compte rendu manque. Zéro dirait « loué
#: gratuitement », ce qu'aucun document ne dit.
loyer: float | None = None
#: Provisions sur charges appelées avec le loyer plein.
charges: float | None = None
#: Facturé au prorata sur ce mois : entrée ou sortie en cours de mois,
#: avoir. `None` s'il n'y en a pas. Tenu hors du loyer, qui doit rester
#: comparable d'un mois à l'autre.
prorata: float | None = None
#: Vrai quand le loyer vient d'une ligne pluri-mensuelle répartie.
reparti: bool = False
@property
def en_transition(self) -> bool:
"""Mois sans loyer plein mais facturé au prorata : pas une vacance."""
return self.loyer is None and self.prorata is not None
@dataclass
class LigneEcartee:
"""Une ligne de loyer qu'aucun mois ne peut revendiquer.
Elle chevauche plusieurs mois sans en couvrir aucun entièrement : une
régularisation rétroactive. La rendre telle quelle laisse le lecteur la
rapprocher de la chronologie, où elle figure aussi.
"""
periode_debut: date | None
periode_fin: date | None
loyers: float
charges: float
@dataclass
class Serie:
"""La suite des mois loués d'un lot, et ce qui n'a pas pu y entrer."""
mois: list[MoisLoue] = field(default_factory=list)
ecartees: list[LigneEcartee] = field(default_factory=list)
def repartir(lignes) -> Serie:
"""Range des lignes de loyer sur l'axe des mois.
Args:
lignes: itérable de ``(periode_debut, periode_fin, loyers, provisions)``
Returns:
La série des mois observés, du plus ancien au plus récent, trous
compris ; et les lignes écartées faute de couvrir des mois entiers.
"""
cumul: dict[str, MoisLoue] = {}
ecartees: list[LigneEcartee] = []
for debut, fin, loyers, provisions in lignes:
couverts = mois_entiers(debut, fin)
if not couverts:
# Un prorata tient dans un mois ; au-delà, c'est une régularisation
# rétroactive qu'aucun mois ne peut recevoir.
if debut is not None and fin is not None and mois_de(debut) == mois_de(fin):
point = cumul.setdefault(mois_de(debut), MoisLoue(mois=mois_de(debut)))
point.prorata = (point.prorata or 0.0) + (loyers or 0.0)
else:
ecartees.append(
LigneEcartee(
periode_debut=debut,
periode_fin=fin,
loyers=loyers or 0.0,
charges=provisions or 0.0,
)
)
continue
part_loyer = (loyers or 0.0) / len(couverts)
part_charges = (provisions or 0.0) / len(couverts)
for mois in couverts:
point = cumul.setdefault(mois, MoisLoue(mois=mois))
point.loyer = (point.loyer or 0.0) + part_loyer
point.charges = (point.charges or 0.0) + part_charges
point.reparti = point.reparti or len(couverts) > 1
if not cumul:
return Serie(ecartees=ecartees)
# Les mois sans aucune ligne restent dans la suite, à `None` : un trou dans
# la courbe se voit, un mois absent de l'axe passerait inaperçu.
serie: list[MoisLoue] = []
mois, dernier = min(cumul), max(cumul)
while True:
point = cumul.get(mois, MoisLoue(mois=mois))
if point.loyer is not None:
point.loyer = round(point.loyer, 2)
point.charges = round(point.charges or 0.0, 2)
if point.prorata is not None:
point.prorata = round(point.prorata, 2)
serie.append(point)
if mois == dernier:
break
mois = mois_suivant(mois)
return Serie(mois=serie, ecartees=ecartees)
@dataclass
class Palier:
"""Une période pendant laquelle le loyer n'a pas bougé."""
mois_debut: str
mois_fin: str
loyer: float
def paliers(serie: list[MoisLoue]) -> list[Palier]:
"""Découpe la série aux changements de loyer.
Un mois sans loyer plein ferme le palier en cours : reprendre au même
montant après une vacance, c'est un nouveau bail qui se trouve tomber au
même prix, pas un loyer qui n'aurait jamais bougé.
Le centime tranche l'égalité — les montants viennent de divisions par le
nombre de mois d'un trimestre, où un tiers d'euro ne retombe pas juste.
"""
trouves: list[Palier] = []
for point in serie:
if point.loyer is None:
continue
en_cours = trouves[-1] if trouves else None
continu = (
en_cours is not None
and abs(en_cours.loyer - point.loyer) < 0.01
and mois_suivant(en_cours.mois_fin) == point.mois
)
if continu:
en_cours.mois_fin = point.mois
else:
trouves.append(
Palier(mois_debut=point.mois, mois_fin=point.mois, loyer=point.loyer)
)
return trouves
def variation(depuis: float | None, vers: float | None) -> float | None:
"""Écart en pourcentage entre deux loyers, `None` si l'un manque."""
if not depuis or vers is None:
return None
return round((vers - depuis) / abs(depuis) * 100, 2)
def loyer_au_m2(loyer: float | None, surface: float | None) -> float | None:
"""Loyer mensuel hors charges rapporté au mètre carré.
`None` dès qu'un des deux manque : la fiche du lot n'est pas saisie, ou le
mois n'a pas de loyer. Une surface nulle ou négative est traitée comme
absente — elle ne peut venir que d'une saisie fautive.
"""
if loyer is None or surface is None or surface <= 0:
return None
return round(loyer / surface, 2)
def mediane(valeurs: list[float]) -> float | None:
"""Médiane d'un échantillon, `None` s'il est vide.
Médiane et non moyenne : sur trente lots, un local commercial suffit à
tirer une moyenne loin de ce que paye un appartement.
"""
if not valeurs:
return None
ordonnees = sorted(valeurs)
milieu = len(ordonnees) // 2
if len(ordonnees) % 2:
return round(ordonnees[milieu], 2)
return round((ordonnees[milieu - 1] + ordonnees[milieu]) / 2, 2)
def _lignes_de_loyer(session: Session, lot_id: int | None = None):
"""Les lignes de loyer, par lot : période et montants.
Sans `lot_id`, tout le parc en une requête — la comparaison a besoin des
trente lots à la fois, et les interroger un par un ferait trente allers.
"""
stmt = select(
Revenu.lot_id,
Revenu.periode_debut,
Revenu.periode_fin,
Revenu.loyers,
Revenu.provisions,
).where(Revenu.type_ligne == TYPE_LIGNE_LOYER)
if lot_id is not None:
stmt = stmt.where(Revenu.lot_id == lot_id)
par_lot: dict[int, list] = {}
for ligne_lot, debut, fin, loyers, provisions in session.execute(stmt):
par_lot.setdefault(ligne_lot, []).append((debut, fin, loyers, provisions))
return par_lot
def serie_du_lot(session: Session, lot_id: int) -> Serie:
"""Les mois loués d'un lot, du premier au dernier connu."""
return repartir(_lignes_de_loyer(session, lot_id).get(lot_id, []))
@dataclass
class LotComparable:
"""Un lot du parc ramené à son loyer au m² sur un mois donné.
Porte sa surface autant que son ratio : le loyer au m² décroît fortement
avec la taille du logement — sur le parc, un studio de 21 m² se loue près du
double au m² d'un T3 de 106 m². Une comparaison qui perd la surface compare
donc des choses qui n'ont pas à l'être.
"""
lot_id: int
immeuble_id: int
immeuble_code: str | None
numero: str
type_lot: str | None
surface: float
loyer_m2: float
@dataclass
class Parc:
"""Ce que le parc permet de comparer, et ce qu'il ne permet pas."""
comparables: list[LotComparable] = field(default_factory=list)
#: Lots loués ce mois-là mais dont la fiche n'a pas de surface. Ils ne
#: peuvent pas entrer dans une comparaison au m² ; les taire ferait passer
#: une médiane sur trois lots pour une médiane sur tout le parc.
sans_surface: int = 0
def parc_du_mois(session: Session, mois: str) -> Parc:
"""Loyer au m² de chaque lot loué le mois donné.
Passe par la même répartition que la fiche d'un lot : une médiane calculée
autrement que les chiffres qu'elle situe ne voudrait rien dire.
"""
lots = session.execute(
joindre_fiche(
select(
Lot.id,
Lot.immeuble_id,
Immeuble.code,
Lot.numero,
TYPE_LOT_EFFECTIF,
LotCaracteristiques.surface,
).join(Immeuble, Immeuble.id == Lot.immeuble_id)
)
).all()
# Toutes les lignes de loyer du parc en une requête : les répartir lot par
# lot depuis la base ferait une trentaine d'allers pour un seul affichage.
lignes_par_lot = _lignes_de_loyer(session)
parc = Parc()
for lot_id, immeuble_id, immeuble_code, numero, type_lot, surface in lots:
serie = repartir(lignes_par_lot.get(lot_id, []))
point = next((p for p in serie.mois if p.mois == mois), None)
if point is None or point.loyer is None or point.loyer <= 0:
continue
ratio = loyer_au_m2(point.loyer, surface)
if ratio is None:
parc.sans_surface += 1
continue
parc.comparables.append(
LotComparable(
lot_id=lot_id,
immeuble_id=immeuble_id,
immeuble_code=immeuble_code,
numero=numero,
type_lot=type_lot,
surface=surface,
loyer_m2=ratio,
)
)
return parc