woningwaardering 2.0.1

Berekent de punten van een woning op basis van het woningwaarderingsstelsel.

Woningwaardering

⚠️ Deze release kan gebruikt worden voor het berekenen van de woningwaardering volgens het woningwaarderingsstelsel voor zelfstandige woonruimten volgens het beleidsboek van de huurcommissie van juli 2024 (Wet Betaalbare Huur). Aan de berekeningen en output van deze package kunnen geen rechten worden ontleend. Raadpleeg de README, de toelichting op de implementatie van het beleidsboek en de openstaande issues aandachtig om de package op een constructieve manier te gebruiken en de resultaten correct te interpreteren.

📊 Status

Het Microservices team van Woonstad Rotterdam is in Q1 2024 begonnen met het ontwikkelen met een open-source Python-package waarmee het mogelijk wordt om het puntensysteem van het woningwaarderingsstelsel toe te passen. We gaan hierbij uit van de VERA-standaard [referentiedata v4.1.240629, openapi v4.1.5] van de corporatiesector voor de in- en output van de package. Dit project heeft drie hoofddoelen:

• het mogelijk maken van het berekenen van de woningwaardering op basis van een digitale representatie van een woning:
  • steeds meer woningcorperaties en bedrijven digitaliseren hun woningbestand, bijvoorbeeld met behulp van een bouwwerkinformatiemodel (BIM).
  • de combinatie van digitale representaties van woningen en deze package maakt het mogelijk om de woningwaardering in bulk te berekenen.
  • door deze package als API te gebruiken kan de woningwaardering in een webapplicatie worden geïntegreerd.
• om tot een completere en inzichtelijkere woningwaarderingsstelsel-berekening te komen dan die nu beschikbaar zijn via tools zoals bijvoorbeeld die van de huurcommissie.
• om als woningcorporatie of bedrijf te blijven voldoen aan de wetging zoals Wet Betaalbare Huur.

---

Voorbeeld van hoe wij de woningwaardering package gebruiken bij Woonstad Rotterdam.

---

Momenteel wordt er gewerkt aan de implementatie van de woningwaardering van onzelfstandige woonruimten volgens het gepubliceerde beleidsboek van de huurcommissie in juli 2024. Voor meer details over wat er precies is geïmplementeerd van het beleidsboek van juli 2024 voor zelfstandige woonruimten verwijzen wij naar de documentatie over de implementatie van dit beleidsboek. Voor meer informatie over hoe documentatie van het beleidsboek is gemaakt, verwijzen wij naar het hoofdstuk Implementatie beleidsboek huurcommissie in deze README.

Voor vragen kunt u contact opnemen met Product Owner en mede-developer van Team Microservices Tomer Gabay of één van de andere maintainers van deze repo.

Inhoudsopgave

• Woningwaardering
  • Inhoudsopgave
  • 1. Opzet woningwaardering-package
    • Implementatie beleidsboek huurcommissie
    • Repository-structuur
    • Design
    • Lookup tabellen
    • Warnings
      • Warning vs Exception
    • Gebruik
      • Optie 1; bijvoorbeeld via JSON bestand
      • Optie 2; via Python zelf
  • 2. Datamodel uitbreidingen
    • Ruimtedetailsoort kast
    • Verbonden ruimten
    • Gedeeld met aantal eenheden
    • Bouwkundige elementen
    • Verkoeld en verwarmd
    • Datum afsluiten huurovereenkomst
    • Aanbelfunctie met video- en audioverbinding
    • Installaties
    • Aantal
    • Parkeergelegenheden
  • 3. Contributing
    • Setup
    • Naamgeving van classes
      • Genereren opzet woningwaarderingstelsels en -groepen
      • Stelsels
      • Stelselgroepen
    • Releasemanagement
      • Versienummering
      • Releaseproces
    • Testing
      • Test coverage rapport
      • Conventies voor tests
      • Test modellen
    • Logger Guidelines
    • Datamodellen
      • Datamodellen uitbreiden
    • Referentiedata

1. Opzet woningwaardering-package

Implementatie beleidsboek huurcommissie

Voor het berekenen van een woningwaardering worden de beleidsboeken van de Nederlandse Huurcommissie voor de waarderingstelsels voor zelfstandige en onzelfstandige woningen gevolgd. De beleidsboeken van de Huurcommissie Nederland volgen Nederlandse wet- en regelgeving zoals beschreven in Artikel 14 van het "Besluit huurprijzen woonruimte".

Om berekeningen te maken met betrekking tot een woningwaardering wordt het gepubliceerde beleid vertaald naar Python-code. Een woningwaardering wordt gemaakt op basis van woningelementen. De stelselgroepen waarop gescoord wordt, zijn vastgelegd in het woningwaarderingstelselgroep op www.coraveraonline.nl. Deze worden aangehouden in de opzet van de woningwaardering-package. Voor elke stelselgroep wordt een apart Python-object gemaakt met een naam die overeenkomt met woningwaarderingstelselgroep.

De woningwaardering package volgt de beleidsboeken van de Nederlandse Huurcommissie en daarmee de Nederlandse wet en regelgeving m.b.t. het waarderen van woningen. Tijdens de ontwikkeling van deze package komt het voor dat we inconsistenties in de beleidsboeken vinden of dat er ruimte is voor interpretatie. Daarnaast kan het voorkomen dat dat de VERA modellen, met eventuele uitbreidingen, niet toereikend zijn om de stelselgroep voglens het beleidsboek tot op de letter nauwkeurig te implementeren. In implementatietoelichting-beleidsboeken onderbouwen wij hoe elke stelselgroep is geïmplementeerd en welke keuzes daarin gemaakt zijn.
In deze documenten wordt bijgehouden welke onderdelen van het beleidsboek wel en niet zijn geïmplementeerd per stelselgroep. De gepubliceerde tekst uit het beleidsboek wordt gekopieerd en wanneer een onderdeel niet in de code van de package is geïmplementeerd zal dit worden aangegeven met doorgestreepte tekst.
De reden van het niet implementeren van een regelonderdeel is vrijwel altijd dat het technisch niet mogelijk is op basis van het inputmodel van de VERA-standaard. Een voorbeeld hiervan is dat voor oppervlakte van vertrekken in 2024 de minimale breedte van een vertrek over de volledige lengte 1,5m moet zijn. Omdat wij de data van de minimale breedte over de volledige lengte niet binnenkrijgen via het inputmodel kunnen wij dit onderdeel van de regel niet implementeren. Dit betekent dat het aan de gebruiker is om met deze regelonderdelen rekening te houden bij het eenheid-inputmodel. Een deel van de deze regelonderdelen wordt al afgevangen indien het eenheid-inputmodel voldoet aan de NEN-norm. Regels die wel zijn geimplementeerd zijn niet doorgestreept. Keuzes die zijn gemaakt en of interpretaties die zijn gedaan, worden in een gemarkeerd blok weergegeven zoals hieronder is gedaan.

Dit is een tekstblok waarmee commentaar van een developer wordt aangegeven in het beleidsboek.

Repository-structuur

De repository-structuur is ingedeeld volgens de referentiedata van stelselgroepen van de VERA-standaard; eerst de stelsels (bijvoorbeeld zelfstandig, onzelfstandig) en vervolgens de stelselgroepen (bijvoorbeeld Energieprestatie, Wasgelegenheid). In de folders van de stelselgroepen bevindt zich de code voor het berekenen van de punten per stelselgroep.

Design

Het design van de woningwaardering-package is zo gekozen dat stelselgroep-objecten en bijbehorende regels modulair zijn.

Lookup tabellen

In lookup tabellen worden constanten en variabelen opgeslagen die nodig zijn bij het berekenen van de punten voor een stelselgroep. In de woningwaardering package wordt CSV gebruikt als bestandstype voor het opslaan van een lookup tabel. De keuze is op CSV gevallen omdat lookup data soms bestaat uit meerdere datarijen waardoor dit vaak minder leesbaar wordt wanneer dit bijvoorbeeld in json of yaml wordt opgeslagen.

Warnings

In de woningwaardering package worden UserWarnings gegenereerd wanneer de inputdata niet volledig of correct wordt aangeleverd. Deze waarschuwingen worden gegeven met een warning bericht en een type warning, bijvoorbeeld:

warnings.warn("Dit is een warning", UserWarning)

Standaard genereert de woningwaardering package een error wanneer een UserWarning wordt gegeven. Hoewel de package kan werken met incomplete data, is ervoor gekozen om standaard te falen bij incomplete inputdata, zodat de gebruiker hiervan op de hoogte wordt gebracht. Het is echter ook mogelijk om het warning filter terug te zetten naar de standaardinstellingen, waardoor een warning m.b.t. incomplete data niet leidt tot een error, maar slechts een warning:

warnings.simplefilter("default", UserWarning)

Alle waarschuwingen die worden gegenereerd met warnings.warn(), worden standaard gelogd met logger.warning() en weergegeven in het standaardfout bestand. Mocht door de gebruiker logging worden uitgezet, dan zullen de UserWarnings altijd te zien zijn voor de gebruiker in de output van de stderr.

Warning vs Exception

Er wordt doorgaans in de stelgroepversies gebruik gemaakt van warnings.warn() in plaats van het raisen van een exception. Hierdoor bestaat de mogelijkheid om stelselgroepen te berekenen voor stelselgroepen waarvoor de data wel compleet genoeg is, mits de warnings.simplefilter naar default is gezet.

Gebruik

Installeer de package met pip install woningwaardering. Vervolgens kun je de package importeren en gebruiken op verschillende manieren.

Optie 1; bijvoorbeeld via JSON bestand

import warnings
from datetime import date

from woningwaardering.stelsels import ZelfstandigeWoonruimten, utils
from woningwaardering.vera.bvg.generated import (
    EenhedenEenheid,
)

warnings.simplefilter("default", UserWarning)

stelsel = ZelfstandigeWoonruimten(
    peildatum=date(2024, 7, 1)  # bij niet meegeven wordt de huidige dag gebruikt.
)
with open(
    "tests/data/generiek/input/37101000032.json",
    "r+",
) as file:
    eenheid = EenhedenEenheid.model_validate_json(file.read())
    woningwaardering_resultaat = stelsel.bereken(eenheid)
    print(
        woningwaardering_resultaat.model_dump_json(
            by_alias=True, indent=2, exclude_none=True
        )
    )
    tabel = utils.naar_tabel(woningwaardering_resultaat)

    print(tabel)

Voorbeeld output in JSON

{
  "groepen": [
    {
      "criteriumGroep": {
        "stelsel": {
          "code": "ZEL",
          "naam": "Zelfstandige woonruimten"
        },
        "stelselgroep": {
          "code": "OVZ",
          "naam": "Oppervlakte van vertrekken"
        }
      },
      "punten": 141.0,
      "woningwaarderingen": [
        {
          "aantal": 21.05,
          "criterium": {
            "naam": "Slaapkamer 1",
            "meeteenheid": {
              "code": "M2",
              "naam": "Vierkante meter, m2"
            }
          }
        },
        {
          "aantal": 41.0,
          "criterium": {
            "naam": "Woonkamer",
            "meeteenheid": {
              "code": "M2",
              "naam": "Vierkante meter, m2"
            }
          }
        },
        {
          "aantal": 20.37,
          "criterium": {
            "naam": "Keuken",
            "meeteenheid": {
              "code": "M2",
              "naam": "Vierkante meter, m2"
            }
          }
        },
        {
          "aantal": 7.5,
          "criterium": {
            "naam": "Badruimte",
            "meeteenheid": {
              "code": "M2",
              "naam": "Vierkante meter, m2"
            }
          }
        },
        {
          "aantal": 15.98,
          "criterium": {
            "naam": "Slaapkamer 2",
            "meeteenheid": {
              "code": "M2",
              "naam": "Vierkante meter, m2"
            }
          }
        },
        {
          "aantal": 19.15,
          "criterium": {
            "naam": "Slaapkamer 3",
            "meeteenheid": {
              "code": "M2",
              "naam": "Vierkante meter, m2"
            }
          }
        },
        {
          "aantal": 15.82,
          "criterium": {
            "naam": "Slaapkamer 4",
            "meeteenheid": {
              "code": "M2",
              "naam": "Vierkante meter, m2"
            }
          }
        }
      ]
    },
    {
      "criteriumGroep": {
        "stelsel": {
          "code": "ZEL",
          "naam": "Zelfstandige woonruimten"
        },
        "stelselgroep": {
          "code": "OOZ",
          "naam": "Oppervlakte van overige ruimten"
        }
      },
      "punten": 5.25,
      "woningwaarderingen": [
        {
          "aantal": 6.65,
          "criterium": {
            "naam": "Berging",
            "meeteenheid": {
              "code": "M2",
              "naam": "Vierkante meter, m2"
            }
          }
        }
      ]
    },
    {
      "criteriumGroep": {
        "stelsel": {
          "code": "ZEL",
          "naam": "Zelfstandige woonruimten"
        },
        "stelselgroep": {
          "code": "VKV",
          "naam": "Verkoeling en verwarming"
        }
      },
      "punten": 14.0,
      "woningwaarderingen": [
        {
          "criterium": {
            "naam": "Slaapkamer 1 (verwarmd vertrek)"
          },
          "punten": 2.0
        },
        {
          "criterium": {
            "naam": "Woonkamer (verwarmd vertrek)"
          },
          "punten": 2.0
        },
        {
          "criterium": {
            "naam": "Keuken (verwarmd vertrek)"
          },
          "punten": 2.0
        },
        {
          "criterium": {
            "naam": "Badruimte (verwarmd vertrek)"
          },
          "punten": 2.0
        },
        {
          "criterium": {
            "naam": "Slaapkamer 2 (verwarmd vertrek)"
          },
          "punten": 2.0
        },
        {
          "criterium": {
            "naam": "Slaapkamer 3 (verwarmd vertrek)"
          },
          "punten": 2.0
        },
        {
          "criterium": {
            "naam": "Slaapkamer 4 (verwarmd vertrek)"
          },
          "punten": 2.0
        }
      ]
    },
    {
      "criteriumGroep": {
        "stelsel": {
          "code": "ZEL",
          "naam": "Zelfstandige woonruimten"
        },
        "stelselgroep": {
          "code": "BUI",
          "naam": "Buitenruimten"
        }
      },
      "punten": 15.0,
      "woningwaarderingen": [
        {
          "aantal": 3.14,
          "criterium": {
            "naam": "Balkon 1 (privé)",
            "meeteenheid": {
              "code": "M2",
              "naam": "Vierkante meter, m2"
            }
          },
          "punten": 1.1
        },
        {
          "aantal": 3.14,
          "criterium": {
            "naam": "Balkon 2 (privé)",
            "meeteenheid": {
              "code": "M2",
              "naam": "Vierkante meter, m2"
            }
          },
          "punten": 1.1
        },
        {
          "aantal": 49.11,
          "criterium": {
            "naam": "Tuin (privé)",
            "meeteenheid": {
              "code": "M2",
              "naam": "Vierkante meter, m2"
            }
          },
          "punten": 17.19
        },
        {
          "aantal": 15.93,
          "criterium": {
            "naam": "Dakterras (privé)",
            "meeteenheid": {
              "code": "M2",
              "naam": "Vierkante meter, m2"
            }
          },
          "punten": 5.57
        },
        {
          "criterium": {
            "naam": "Privé buitenruimten aanwezig"
          },
          "punten": 2.0
        },
        {
          "criterium": {
            "naam": "Maximaal 15 punten"
          },
          "punten": -12.0
        }
      ]
    },
    {
      "criteriumGroep": {
        "stelsel": {
          "code": "ZEL",
          "naam": "Zelfstandige woonruimten"
        },
        "stelselgroep": {
          "code": "ENE",
          "naam": "Energieprestatie"
        }
      },
      "punten": 22.0,
      "woningwaarderingen": [
        {
          "criterium": {
            "naam": "C (Energie-index)"
          },
          "punten": 22.0
        }
      ]
    },
    {
      "criteriumGroep": {
        "stelsel": {
          "code": "ZEL",
          "naam": "Zelfstandige woonruimten"
        },
        "stelselgroep": {
          "code": "KEU",
          "naam": "Keuken"
        }
      },
      "punten": 7.0,
      "woningwaarderingen": [
        {
          "aantal": 2700.0,
          "criterium": {
            "naam": "Keuken - Lengte aanrecht",
            "meeteenheid": {
              "code": "MIL",
              "naam": "Millimeter"
            }
          },
          "punten": 7.0
        }
      ]
    },
    {
      "criteriumGroep": {
        "stelsel": {
          "code": "ZEL",
          "naam": "Zelfstandige woonruimten"
        },
        "stelselgroep": {
          "code": "SAN",
          "naam": "Sanitair"
        }
      },
      "punten": 15.0,
      "woningwaarderingen": [
        {
          "aantal": 1.0,
          "criterium": {
            "naam": "Badruimte - Staand Toilet"
          },
          "punten": 2.0
        },
        {
          "aantal": 2.0,
          "criterium": {
            "naam": "Badruimte - Wastafel"
          },
          "punten": 2.0
        },
        {
          "aantal": 1.0,
          "criterium": {
            "naam": "Badruimte - Bad en douche"
          },
          "punten": 7.0
        },
        {
          "aantal": 1.0,
          "criterium": {
            "naam": "Toiletruimte - Staand Toilet"
          },
          "punten": 3.0
        },
        {
          "aantal": 1.0,
          "criterium": {
            "naam": "Toiletruimte - Wastafel"
          },
          "punten": 1.0
        }
      ]
    },
    {
      "criteriumGroep": {
        "stelsel": {
          "code": "ZEL",
          "naam": "Zelfstandige woonruimten"
        },
        "stelselgroep": {
          "code": "GPA",
          "naam": "Gemeenschappelijke parkeerruimten"
        }
      },
      "punten": 0.0,
      "woningwaarderingen": []
    },
    {
      "criteriumGroep": {
        "stelsel": {
          "code": "ZEL",
          "naam": "Zelfstandige woonruimten"
        },
        "stelselgroep": {
          "code": "GVR",
          "naam": "Gemeenschappelijke vertrekken, overige ruimten en voorzieningen"
        }
      },
      "punten": 0.0,
      "woningwaarderingen": []
    },
    {
      "criteriumGroep": {
        "stelsel": {
          "code": "ZEL",
          "naam": "Zelfstandige woonruimten"
        },
        "stelselgroep": {
          "code": "WOZ",
          "naam": "Punten voor de WOZ-waarde"
        }
      },
      "punten": 63.0,
      "woningwaarderingen": [
        {
          "criterium": {
            "naam": "Onderdeel I"
          },
          "punten": 44.21
        },
        {
          "criterium": {
            "naam": "Onderdeel II"
          },
          "punten": 19.03
        }
      ]
    },
    {
      "criteriumGroep": {
        "stelsel": {
          "code": "ZEL",
          "naam": "Zelfstandige woonruimten"
        },
        "stelselgroep": {
          "code": "BIJ",
          "naam": "Bijzondere voorzieningen"
        }
      },
      "punten": 0.0,
      "woningwaarderingen": []
    },
    {
      "criteriumGroep": {
        "stelsel": {
          "code": "ZEL",
          "naam": "Zelfstandige woonruimten"
        },
        "stelselgroep": {
          "code": "PMN",
          "naam": "Prijsopslag monumenten en nieuwbouw"
        }
      },
      "punten": 0.0,
      "woningwaarderingen": [],
      "opslagpercentage": 0.0
    }
  ],
  "maximaleHuur": 1779.24,
  "punten": 282.0,
  "stelsel": {
    "code": "ZEL",
    "naam": "Zelfstandige woonruimten"
  },
  "huurprijsopslag": 0.0,
  "maximaleHuurInclusiefOpslag": 1779.24
}

Voorbeeld output in tabel

+-----------------------------------+----------------------------------------------------+---------+---------------------+---------+---------+
| Groep                             | Naam                                               |  Aantal | Meeteenheid         |  Punten |  Opslag |
+-----------------------------------+----------------------------------------------------+---------+---------------------+---------+---------+
| Oppervlakte van vertrekken        | Slaapkamer 1                                       |   21.05 | Vierkante meter, m2 |         |         |
| Oppervlakte van vertrekken        | Woonkamer                                          |   41.00 | Vierkante meter, m2 |         |         |
| Oppervlakte van vertrekken        | Keuken                                             |   20.37 | Vierkante meter, m2 |         |         |
| Oppervlakte van vertrekken        | Badruimte                                          |    7.50 | Vierkante meter, m2 |         |         |
| Oppervlakte van vertrekken        | Slaapkamer 2                                       |   15.98 | Vierkante meter, m2 |         |         |
| Oppervlakte van vertrekken        | Slaapkamer 3                                       |   19.15 | Vierkante meter, m2 |         |         |
| Oppervlakte van vertrekken        | Slaapkamer 4                                       |   15.82 | Vierkante meter, m2 |         |         |
+-----------------------------------+----------------------------------------------------+---------+---------------------+---------+---------+
| Oppervlakte van vertrekken        | Subtotaal                                          |  140.87 | Vierkante meter, m2 |  141.00 |         |
+-----------------------------------+----------------------------------------------------+---------+---------------------+---------+---------+
| Oppervlakte van overige ruimten   | Berging                                            |    6.65 | Vierkante meter, m2 |         |         |
+-----------------------------------+----------------------------------------------------+---------+---------------------+---------+---------+
| Oppervlakte van overige ruimten   | Subtotaal                                          |    6.65 | Vierkante meter, m2 |    5.25 |         |
+-----------------------------------+----------------------------------------------------+---------+---------------------+---------+---------+
| Verkoeling en verwarming          | Slaapkamer 1 (verwarmd vertrek)                    |         |                     |    2.00 |         |
| Verkoeling en verwarming          | Woonkamer (verwarmd vertrek)                       |         |                     |    2.00 |         |
| Verkoeling en verwarming          | Keuken (verwarmd vertrek)                          |         |                     |    2.00 |         |
| Verkoeling en verwarming          | Badruimte (verwarmd vertrek)                       |         |                     |    2.00 |         |
| Verkoeling en verwarming          | Slaapkamer 2 (verwarmd vertrek)                    |         |                     |    2.00 |         |
| Verkoeling en verwarming          | Slaapkamer 3 (verwarmd vertrek)                    |         |                     |    2.00 |         |
| Verkoeling en verwarming          | Slaapkamer 4 (verwarmd vertrek)                    |         |                     |    2.00 |         |
+-----------------------------------+----------------------------------------------------+---------+---------------------+---------+---------+
| Verkoeling en verwarming          | Subtotaal                                          |         |                     |   14.00 |         |
+-----------------------------------+----------------------------------------------------+---------+---------------------+---------+---------+
| Buitenruimten                     | Balkon 1 (privé)                                   |    3.14 | Vierkante meter, m2 |    1.10 |         |
| Buitenruimten                     | Balkon 2 (privé)                                   |    3.14 | Vierkante meter, m2 |    1.10 |         |
| Buitenruimten                     | Tuin (privé)                                       |   49.11 | Vierkante meter, m2 |   17.19 |         |
| Buitenruimten                     | Dakterras (privé)                                  |   15.93 | Vierkante meter, m2 |    5.57 |         |
| Buitenruimten                     | Privé buitenruimten aanwezig                       |         |                     |    2.00 |         |
| Buitenruimten                     | Maximaal 15 punten                                 |         |                     |  -12.00 |         |
+-----------------------------------+----------------------------------------------------+---------+---------------------+---------+---------+
| Buitenruimten                     | Subtotaal                                          |         |                     |   15.00 |         |
+-----------------------------------+----------------------------------------------------+---------+---------------------+---------+---------+
| Energieprestatie                  | C (Energie-index)                                  |         |                     |   22.00 |         |
+-----------------------------------+----------------------------------------------------+---------+---------------------+---------+---------+
| Keuken                            | Keuken - Lengte aanrecht                           | 2700.00 | Millimeter          |    7.00 |         |
+-----------------------------------+----------------------------------------------------+---------+---------------------+---------+---------+
| Keuken                            | Subtotaal                                          | 2700.00 | Millimeter          |    7.00 |         |
+-----------------------------------+----------------------------------------------------+---------+---------------------+---------+---------+
| Sanitair                          | Badruimte - Staand Toilet                          |    1.00 |                     |    2.00 |         |
| Sanitair                          | Badruimte - Wastafel                               |    2.00 |                     |    2.00 |         |
| Sanitair                          | Badruimte - Bad en douche                          |    1.00 |                     |    7.00 |         |
| Sanitair                          | Toiletruimte - Staand Toilet                       |    1.00 |                     |    3.00 |         |
| Sanitair                          | Toiletruimte - Wastafel                            |    1.00 |                     |    1.00 |         |
+-----------------------------------+----------------------------------------------------+---------+---------------------+---------+---------+
| Sanitair                          | Subtotaal                                          |         |                     |   15.00 |         |
+-----------------------------------+----------------------------------------------------+---------+---------------------+---------+---------+
| Punten voor de WOZ-waarde         | Onderdeel I                                        |         |                     |   44.21 |         |
| Punten voor de WOZ-waarde         | Onderdeel II                                       |         |                     |   19.03 |         |
+-----------------------------------+----------------------------------------------------+---------+---------------------+---------+---------+
| Punten voor de WOZ-waarde         | Subtotaal                                          |         |                     |   63.00 |         |
+-----------------------------------+----------------------------------------------------+---------+---------------------+---------+---------+
| Zelfstandige woonruimten          | Afgerond totaal                                    |         |                     |  282.00 |         |
+-----------------------------------+----------------------------------------------------+---------+---------------------+---------+---------+
|                                   | Maximale huur                                      | 1779.24 | EUR                 |         |         |
+-----------------------------------+----------------------------------------------------+---------+---------------------+---------+---------+

Optie 2; via Python zelf

from datetime import date

from woningwaardering.stelsels import ZelfstandigeWoonruimten, utils
from woningwaardering.vera.bvg.generated import (
    BouwkundigElementenBouwkundigElement,
    EenhedenAdresBasis,
    EenhedenAdresseerbaarObjectBasisregistratie,
    EenhedenEenheid,
    EenhedenEnergieprestatie,
    EenhedenPand,
    EenhedenRuimte,
    EenhedenWoonplaats,
    EenhedenWozEenheid,
)
from woningwaardering.vera.referentiedata import (
    Bouwkundigelementdetailsoort,
    Bouwkundigelementsoort,
    Energielabel,
    Energieprestatiesoort,
    Energieprestatiestatus,
    Pandsoort,
    Ruimtedetailsoort,
    Ruimtesoort,
)

stelsel = ZelfstandigeWoonruimten(peildatum=date(2024, 7, 1))

eenheid = EenhedenEenheid(
    id="37101000032",
    bouwjaar=1924,
    adres=EenhedenAdresBasis(
        straatnaam="Nieuwe Boezemstraat",
        huisnummer="27",
        huisnummer_toevoeging="",
        postcode="3034PH",
        woonplaats=EenhedenWoonplaats(naam="ROTTERDAM"),
    ),
    adresseerbaarObjectBasisregistratie=EenhedenAdresseerbaarObjectBasisregistratie(
        id="0599010000485697", bagIdentificatie="0599010000485697"
    ),
    panden=[
        EenhedenPand(
            soort=Pandsoort.eengezinswoning.value,
        )
    ],
    woz_eenheden=[
        EenhedenWozEenheid(waardepeildatum=date(2022, 1, 1), vastgesteldeWaarde=618000),
        EenhedenWozEenheid(waardepeildatum=date(2023, 1, 1), vastgesteldeWaarde=643000),
    ],
    energieprestaties=[
        EenhedenEnergieprestatie(
            soort=Energieprestatiesoort.energie_index.value,
            status=Energieprestatiestatus.definitief.value,
            begindatum=date(2019, 2, 25),
            einddatum=date(2029, 2, 25),
            registratiedatum="2019-02-26T14:51:38+01:00",
            label=Energielabel.c.value,
            waarde="1.58",
        )
    ],
    gebruiksoppervlakte=187,
    ruimten=[
        EenhedenRuimte(
            id="Space_108014589",
            soort=Ruimtesoort.vertrek.value,
            detailSoort=Ruimtedetailsoort.slaapkamer.value,
            naam="Slaapkamer",
            inhoud=60.4048,
            oppervlakte=21.047,
            verwarmd=True,
            gemeenschappelijk=True,
        ),
        EenhedenRuimte(
            id="Space_108006229",
            soort=Ruimtesoort.vertrek.value,
            detailSoort=Ruimtedetailsoort.keuken.value,
            naam="Keuken",
            inhoud=57.4359,
            oppervlakte=20.3673,
            verwarmd=True,
            gemeenschappelijk=True,
            bouwkundigeElementen=[
                BouwkundigElementenBouwkundigElement(
                    id="Aanrecht_108006231",
                    naam="Aanrecht",
                    omschrijving="Aanrecht in Keuken",
                    soort=Bouwkundigelementsoort.voorziening.value,
                    detailSoort=Bouwkundigelementdetailsoort.aanrecht.value,
                    lengte=2700,
                )
            ],
        ),
    ],
)

woningwaardering_resultaat = stelsel.bereken(eenheid)
print(
    woningwaardering_resultaat.model_dump_json(
        by_alias=True, indent=2, exclude_none=True
    )
)
tabel = utils.naar_tabel(woningwaardering_resultaat)

print(tabel)

De output daarvan is een VERA woningwaarderingstelsel object. Dit object kan vervolgens worden omgezet naar een tabel zoals hierboven is gedaan.

Voorbeeld output in JSON

{
  "groepen": [
    {
      "criteriumGroep": {
        "stelsel": {
          "code": "ZEL",
          "naam": "Zelfstandige woonruimten"
        },
        "stelselgroep": {
          "code": "OVZ",
          "naam": "Oppervlakte van vertrekken"
        }
      },
      "punten": 41.0,
      "woningwaarderingen": [
        {
          "aantal": 21.05,
          "criterium": {
            "naam": "Slaapkamer",
            "meeteenheid": {
              "code": "M2",
              "naam": "Vierkante meter, m2"
            }
          }
        },
        {
          "aantal": 20.37,
          "criterium": {
            "naam": "Keuken",
            "meeteenheid": {
              "code": "M2",
              "naam": "Vierkante meter, m2"
            }
          }
        }
      ]
    },
    {
      "criteriumGroep": {
        "stelsel": {
          "code": "ZEL",
          "naam": "Zelfstandige woonruimten"
        },
        "stelselgroep": {
          "code": "OOZ",
          "naam": "Oppervlakte van overige ruimten"
        }
      },
      "punten": 0.0,
      "woningwaarderingen": []
    },
    {
      "criteriumGroep": {
        "stelsel": {
          "code": "ZEL",
          "naam": "Zelfstandige woonruimten"
        },
        "stelselgroep": {
          "code": "VKV",
          "naam": "Verkoeling en verwarming"
        }
      },
      "punten": 4.0,
      "woningwaarderingen": [
        {
          "criterium": {
            "naam": "Slaapkamer (verwarmd vertrek)"
          },
          "punten": 2.0
        },
        {
          "criterium": {
            "naam": "Keuken (verwarmd vertrek)"
          },
          "punten": 2.0
        }
      ]
    },
    {
      "criteriumGroep": {
        "stelsel": {
          "code": "ZEL",
          "naam": "Zelfstandige woonruimten"
        },
        "stelselgroep": {
          "code": "BUI",
          "naam": "Buitenruimten"
        }
      },
      "punten": -5.0,
      "woningwaarderingen": [
        {
          "criterium": {
            "naam": "Geen buitenruimten"
          },
          "punten": -5.0
        }
      ]
    },
    {
      "criteriumGroep": {
        "stelsel": {
          "code": "ZEL",
          "naam": "Zelfstandige woonruimten"
        },
        "stelselgroep": {
          "code": "ENE",
          "naam": "Energieprestatie"
        }
      },
      "punten": 22.0,
      "woningwaarderingen": [
        {
          "criterium": {
            "naam": "C (Energie-index)"
          },
          "punten": 22.0
        }
      ]
    },
    {
      "criteriumGroep": {
        "stelsel": {
          "code": "ZEL",
          "naam": "Zelfstandige woonruimten"
        },
        "stelselgroep": {
          "code": "KEU",
          "naam": "Keuken"
        }
      },
      "punten": 7.0,
      "woningwaarderingen": [
        {
          "aantal": 2700.0,
          "criterium": {
            "naam": "Keuken - Lengte aanrecht",
            "meeteenheid": {
              "code": "MIL",
              "naam": "Millimeter"
            }
          },
          "punten": 7.0
        }
      ]
    },
    {
      "criteriumGroep": {
        "stelsel": {
          "code": "ZEL",
          "naam": "Zelfstandige woonruimten"
        },
        "stelselgroep": {
          "code": "SAN",
          "naam": "Sanitair"
        }
      },
      "punten": 0.0,
      "woningwaarderingen": []
    },
    {
      "criteriumGroep": {
        "stelsel": {
          "code": "ZEL",
          "naam": "Zelfstandige woonruimten"
        },
        "stelselgroep": {
          "code": "WOZ",
          "naam": "Punten voor de WOZ-waarde"
        }
      },
      "punten": 112.0,
      "woningwaarderingen": [
        {
          "criterium": {
            "naam": "Onderdeel I"
          },
          "punten": 44.21
        },
        {
          "criterium": {
            "naam": "Onderdeel II"
          },
          "punten": 67.79
        }
      ]
    },
    {
      "criteriumGroep": {
        "stelsel": {
          "code": "ZEL",
          "naam": "Zelfstandige woonruimten"
        },
        "stelselgroep": {
          "code": "BIJ",
          "naam": "Bijzondere voorzieningen"
        }
      },
      "punten": 0.0,
      "woningwaarderingen": []
    },
    {
      "criteriumGroep": {
        "stelsel": {
          "code": "ZEL",
          "naam": "Zelfstandige woonruimten"
        },
        "stelselgroep": {
          "code": "PMN",
          "naam": "Prijsopslag monumenten en nieuwbouw"
        }
      },
      "punten": 0.0,
      "woningwaarderingen": [],
      "opslagpercentage": 0.0
    }
  ],
  "maximaleHuur": 1125.6,
  "punten": 181.0,
  "stelsel": {
    "code": "ZEL",
    "naam": "Zelfstandige woonruimten"
  },
  "huurprijsopslag": 0.0,
  "maximaleHuurInclusiefOpslag": 1125.6
}

Voorbeeld output in tabel

+----------------------------+-------------------------------+---------+---------------------+--------+--------+
| Groep                      | Naam                          |  Aantal | Meeteenheid         | Punten | Opslag |
+----------------------------+-------------------------------+---------+---------------------+--------+--------+
| Oppervlakte van vertrekken | Slaapkamer                    |   21.05 | Vierkante meter, m2 |        |        |
| Oppervlakte van vertrekken | Keuken                        |   20.37 | Vierkante meter, m2 |        |        |
+----------------------------+-------------------------------+---------+---------------------+--------+--------+
| Oppervlakte van vertrekken | Subtotaal                     |   41.42 | Vierkante meter, m2 |  41.00 |        |
+----------------------------+-------------------------------+---------+---------------------+--------+--------+
| Verkoeling en verwarming   | Slaapkamer (verwarmd vertrek) |         |                     |   2.00 |        |
| Verkoeling en verwarming   | Keuken (verwarmd vertrek)     |         |                     |   2.00 |        |
+----------------------------+-------------------------------+---------+---------------------+--------+--------+
| Verkoeling en verwarming   | Subtotaal                     |         |                     |   4.00 |        |
+----------------------------+-------------------------------+---------+---------------------+--------+--------+
| Buitenruimten              | Geen buitenruimten            |         |                     |  -5.00 |        |
+----------------------------+-------------------------------+---------+---------------------+--------+--------+
| Energieprestatie           | C (Energie-index)             |         |                     |  22.00 |        |
+----------------------------+-------------------------------+---------+---------------------+--------+--------+
| Keuken                     | Keuken - Lengte aanrecht      | 2700.00 | Millimeter          |   7.00 |        |
+----------------------------+-------------------------------+---------+---------------------+--------+--------+
| Keuken                     | Subtotaal                     | 2700.00 | Millimeter          |   7.00 |        |
+----------------------------+-------------------------------+---------+---------------------+--------+--------+
| Punten voor de WOZ-waarde  | Onderdeel I                   |         |                     |  44.21 |        |
| Punten voor de WOZ-waarde  | Onderdeel II                  |         |                     |  67.79 |        |
+----------------------------+-------------------------------+---------+---------------------+--------+--------+
| Punten voor de WOZ-waarde  | Subtotaal                     |         |                     | 112.00 |        |
+----------------------------+-------------------------------+---------+---------------------+--------+--------+
| Zelfstandige woonruimten   | Afgerond totaal               |         |                     | 181.00 |        |
+----------------------------+-------------------------------+---------+---------------------+--------+--------+
|                            | Maximale huur                 | 1125.60 | EUR                 |        |        |
+----------------------------+-------------------------------+---------+---------------------+--------+--------+

2. Datamodel uitbreidingen

Tijdens de ontwikkeling van de woningwaardering-package komt het voor dat de VERA modellen niet toereikend zijn om de punten voor een stelselgroep te berekenen. Daarom kunnen er indien nodig uitbreidingen gemaakt worden op de VERA modellen. In deze sectie onderbouwen en documenteren wij deze uitbreidingen. In de sectie Referentiedata wordt uitgelegd hoe uitbreidingen toe te voegen als contributor van dit project.

Ruimtedetailsoort kast

Binnen het woningwaarderingsstelsel mag onder bepaalde voorwaarden de oppervlakte van vaste kasten worden opgeteld bij de ruimte waar de deur van de kast zich bevindt. Als hier bij het inmeten geen rekening mee gehouden is, kan het attribuut verbonden_ruimten gebruikt worden om de met een ruimte verbonden vaste kasten mee te laten nemen in de waardering. Hiervoor is de VERA referentiedata binnen deze repository uitgebreid met ruimtedetailsoort Kast, code KAS.

Verbonden ruimten

Het attribuut verbonden_ruimten bevat de ruimten die in verbinding staan met de ruimte die het attribuut bezit. verbonden_ruimten wordt gebruikt bij het berekenen van de waardering van kasten en verwarming van ruimten. verbonden_ruimten heeft type Optional[list[EenhedenRuimte]] en is een uitbreiding op EenhedenRuimte. Voor deze uitbreiding staat een github issue open ter aanvulling op het VERA model.

Gedeeld met aantal eenheden

Het attribuut gedeeld_met_aantal_eenheden geeft het aantal eenheden weer waarmee een bepaalde ruimte wordt gedeeld. Dit attribuut wordt gebruikt bij het berekenen van de waardering van een gedeelde ruimte met ruimtedetailsoort berging. gedeeld_met_aantal_eenheden heeft als type Optional[int]. Er staat een github issue open voor deze aanvulling op het VERA model: https://github.com/Aedes-datastandaarden/vera-openapi/issues/44

Bouwkundige elementen

In de beleidsboeken wordt soms op basis van een bouwkundig element dat aanwezig is in een ruimte, een uitzondering of nuance op een regel besproken. Dit kan bijvoorbeeld tot gevolg hebben dat er punten in mindering worden gebracht, of punten extra gegeven worden. Bijvoorbeeld bij de berekening van de oppervlakte van een zolder als vertrek of als overige ruimte is er informatie nodig over de trap waarmee de zolder te bereiken is. Daartoe is het VERA model EenhedenRuimte uitgebreid met het attribuut bouwkundige_elementen met als type Optional[list[BouwkundigElementenBouwkundigElement]]. Er staat een github issue open om bouwkundige_elementen standaard in het VERA model toe te voegen: https://github.com/Aedes-datastandaarden/vera-openapi/issues/46

Verkoeld en verwarmd

In de VERA standaard is nog geen mogelijkheid om aan te geven of een ruimte verwarmd en/of verkoeld is. Het attribuut verwarmde_vertrekken_aantal bestaat wel, maar dit bestaat op niveau van de eenheid en daarin bestaat geen onderscheid tussen vertrekken en overige ruimten.
Hierom hebben wij twee boolean kenmerken toegevoegd aan EenhedenRuimte: verwarmd en verkoeld. Deze kenmerken geven aan of een ruimte verwarmd en/of verkoeld is.

Dit is aangekaart in deze twee issues:

• https://github.com/Aedes-datastandaarden/vera-openapi/issues/41
• https://github.com/Aedes-datastandaarden/vera-referentiedata/issues/100

Datum afsluiten huurovereenkomst

Voor een correcte waardering van rijksmonumenten dient de afsluitings datum van de huurovereenkomst opgegeven te worden. In de VERA standaard bestaat binnen het BVG domein geen model dat deze informatie bevat. Het VERA model EenhedenEenheid is uitgebreid met het attribuut datum_afsluiten_huurovereenkomst. Zie ook: https://github.com/Aedes-datastandaarden/vera-openapi/issues/69

Aanbelfunctie met video- en audioverbinding

De VERA-referentiedata biedt nog geen mogelijkheid om aan te geven dat een eenheid is voorzien van een aanbelfunctie met video- en audioverbinding. Daarom hebben we een nieuwe BOUWKUNDIGELEMENTDETAILSOORT toegevoegd. Om in aanmerking te komen voor waardering, moet dit bouwkundig element worden gespecificeerd voor een van de ruimten binnen de eenheid. Meer informatie is te vinden op: https://github.com/Aedes-datastandaarden/vera-referentiedata/issues/148

Installaties

Installaties zouden toegevoegd moeten worden aan het VERA model EenhedenRuimte. Het attribuut installaties bestaat al in de wiki, maar nog niet in de vera-openapi repository: https://github.com/Aedes-datastandaarden/vera-openapi/issues/70

Aantal

Het attribuut Eenhedenruimte.aantal is als uitbreiding op het VERA-model toegevoegd. Hierdoor is het mogelijk om aan te geven hoeveel van deze specifieke ruimte er zijn. Dit attribuut wordt uitsluitend gebruikt in het berekenen van de punten voor Gemeenschappelijke Parkeerruimten. Hier door is het niet nodig om elk parkeervak van een parkeergarage of parkeerterrein mee te geven aan een eenheid.

Parkeergelegenheden

Als uitbreiding op de referentiedata is de Ruimtesoort.Parkeergelegenheid toegevoegd. Daarnaast zijn er verschillende parkerruimten (Ruimtedetailsoort) toegevoegd. Deze uitbreidingen zijn overgenomen vanuit de github issue https://github.com/Aedes-datastandaarden/vera-referentiedata/issues/110#issuecomment-2190641829.

3. Contributing

Setup

Om de woningwaardering-package en de daarbij behorende developer dependencies te installeren, run onderstaand command:

git clone https://github.com/woonstadrotterdam/woningwaardering.git
cd woningwaardering
pip install -e ".[dev]"

Naamgeving van classes

Voor de naamgeving van de classes in de woningwaardering module volgen we de VERA referentiedata. Deze referentiedata is gedefinieerd in de referentiedata enums, te vinden onder woningwaardering/vera/referentiedata.

Genereren opzet woningwaarderingstelsels en -groepen

Om alle onderstaande naamgevingen correct en consequent door te voeren, is er een task beschikbaar die de opzet van een woningwaarderingstelsel en -groep volgens deze regels voor je kan aanmaken.

Zorg er voor dat Task en de dev dependencies zijn geïnstalleerd:

pip install -e ".[dev]"

Vervolgens voer je onderstaand command uit:

task genereer-opzet-woningwaarderinggroep

Dit script stelt je een aantal vragen, waarna de code voor het stelsel en de stelselgroep aangemaakt worden.

Stelsels

De namen voor de stelsels zijn te vinden in de Woningwaarderingstelsel Enum. Bijvoorbeeld: het stelsel voor zelfstandige woonruimten wordt aangeduid als Woningwaarderingstelsel.zelfstandige_woonruimten. De implementatie van dit Stelsel bevindt zich in woningwaardering/stelsels/zelfstandige_woonruimten/zelfstandige_woonruimten.py. De geldigheid van een stelsel wordt bepaald door de begin- en einddatum, die in de constructor van de corresponderende klasse worden vastgelegd.

Stelselgroepen

De namen voor de stelselgroepen zijn te vinden in de Woningwaarderingstelselgroep Enum. Bijvoorbeeld: de stelselgroep voor oppervlakte van vertrekken wordt aangeduid als Woningwaarderingstelselgroep.oppervlakte_van_vertrekken. De implementatie van deze Stelselgroep bevindt zich in woningwaardering/stelsels/zelfstandige_woonruimten/oppervlakte_van_vertrekken/oppervlakte_van_vertrekken.py. De geldigheid van een stelselgroep wordt bepaald door de begin- en einddatum, die in de constructor van de corresponderende klasse worden vastgelegd.

Releasemanagement

Versienummering

Voor versienummering maken we gebruik van SemVer:

Bij SemVer wordt een versienummer in de vorm MAJOR.MINOR.PATCH gebruikt, waarbij elk element als volgt wordt verhoogd:

• MAJOR wordt verhoogd bij incompatibele API-wijzigingen,
• MINOR wordt verhoogd bij het toevoegen van functionaliteit die compatibel is met de vorige versie, en
• PATCH wordt verhoogd bij compatibele bugfixes.

Er zijn aanvullende labels beschikbaar voor pre-release en build-metadata om toe te voegen aan het MAJOR.MINOR.PATCH-formaat.

Bijvoorbeeld: stel dat de huidige versie 0.1.3-alpha is.

• De suffix -alpha wordt gebruikt zolang de software nog niet volledig is, bijvoorbeeld zolang nog niet alle beoogde stelselgroepen geïmplementeerd zijn
• Wanneer een nieuwe release alleen compatibele bugfixes of updates van dependencies bevat, wordt de nieuwe versie 0.1.4-alpha
• Wanneer een nieuwe release ook compatibele nieuwe functionaliteit toevoegt, bijvoorbeeld de implementatie van een nieuwe stelselgroep, dan wordt de nieuwe versie 0.2.0-alpha.
• Wanneer alle beoogde stelselgroepen geïmplementeerd zijn, wordt de nieuwe versie 1.0.0-beta. De publieke api mag vanaf dan enkel nog backwards-compatible wijzigen.
• Wanneer de software volledig is en in productie genomen wordt, wordt de nieuwe versie 1.0.0
• Wanneer er een incompatible wijziging is in de VERA modellen, wordt de nieuwe versie 2.0.0, eventueel met het -alpha of -beta label, afhankelijk van de implementatiestatus.

Releaseproces

Om een nieuwe release te starten, moet er een Git tag aangemaak worden volgens het format v<versienummer>. De prefix v geeft aan dat de tag een versiepunt markeert.

Bijvoorbeeld:

$ git tag v0.2.3-alpha
$ git push --tags

Hiermee start het releaseproces, gedefinieerd in een GitHub workflow: .github/workflows/publish-to-pypi.ymls

In dit proces wordt een package aangemaakt met een Python versienummer, afgeleid van het SemVer nummer in de tag. Bijvoorbeeld: 0.2.3-alpha wordt 0.2.3a0

De package wordt eerst gepubliceerd op TestPyPi. Na goedkeuring wordt de package naar PyPi gepubliceerd. Daarna wordt er een release aangemaakt in GitHub, met een changelog met de titel en link naar alle pull requests die deel uitmaken van deze release.

Testing

Voor het testen van code wordt het pytest framework gebruikt. Meer informatie is te vinden over het framework. Passende tests worden altijd met de nieuw geschreven code opgeleverd. Er zijn verschillende "test-scopes" te bedenken, zoals het testen van details en specifieke functies. Daarnaast is het testen van een hele keten of stelselgroep-object ook vereist. Bij het opleveren van nieuwe code moet aan beide test-scopes gedacht worden.

Test coverage rapport

Na het uitvoeren van pytest wordt er een code coverage report getoond. Hierin is per file te zien welk percentage van de code in de files getest is. Daarnaast wordt de code coverage ook naar een file lcov.info geschreven. Die kan gebruikt worden in VSCode om de coverage weer te geven met een plugin zoals "Coverage Gutters".

Conventies voor tests

Tests worden toegevoegd aan de tests-folder in de root van de repository. Voor de structuur in de tests-folder wordt dezelfde structuur aangehouden als die in de woningwaardering-folder. De naam van het bestand waarin de tests staan geschreven is test_<file_name>.py. Elke testfunctie begint met test_, gevolgd door de naam van de functie of class die getest wordt, bijvoorbeeld def test_<functie_naam>() of def test_<ClassNaam>(). Hierin wordt de naam de van de functie of class exact gevolgd. Voor pytest is test_ een indicator om de functie te herkennen als een testfunctie.

Stel dat de functionaliteiten van woningwaardering/stelsels/zelfstandige_woonruimten/oppervlakte_van_vertrekken/oppervlakte_van_vertrekken.py getest moeten worden, dan is het pad naar het bijbehorende testbestand tests/stelsels/zelfstandige_woonruimten/oppervlakte_van_vertrekken/test_oppervlakte_van_vertrekken.py. In test_oppervlakte_van_vertrekken.py worden testfuncties geschreven met bijbehorende naamconventies. Hieronder is de functienaamconventie en python code weergegeven voor het testen van een losse functie (def losse_functie):

def test_losse_functie() -> None:
    assert losse_functie() == True

Als er een class getest wordt, bijvoorbeeld OppervlakteVanVertrekken, dan is de testfunctie opzet als volgt:

def test_OppervlakteVanVertrekken():
    opp_v_v = OppervlakteVanVertrekken()
    assert self.opp_v_v.functie_een() == 1
    assert self.opp_v_v.functie_twee() == 2

Test modellen

Om de woningwaardering-package zo nauwkeurig mogelijk te testen, zijn er eenheidmodellen (in .json format) toegevoegd in tests/data/.... De modellen volgen de VERA standaard en dienen als een testinput voor de geschreven tests. Omdat er gewerkt wordt met peildata en de berekening van een stelselgroep per jaar kan veranderen worden de outputmodellen per jaar opgeslagen. Zie bijvoorbeeld de folder tests/data/zelfstandige_woonruimten/output/peildatum/2024-01-01. Deze bevat de output voor de inputmodellen met als peildatum 2024-01-01 of later. Op deze manier kunnen dezelfde inputmodellen in tests met verschillende peildata getest worden. De resulterende outputs zijn met de hand nagerekend om de kwaliteit van de tests te garanderen.

Om heel specifieke regelgeving uit het beleidsboek te testen, kunnen er handmatig test modellen gemaakt worden. Deze test modellen worden opgeslagen in de test folder van een stelselgroep waarvoor de specifieke regelgeving die getest wordt. Zie bijvoorbeeld tests/data/zelfstandige_woonruimten/stelselgroepen/oppervlakte_van_vertrekken/input/gedeelde_berging.json: hier is een gedeelde berging gedefinieerd om een specifieke set van regels in oppervlakte_van_vertrekken te testen.

Logger Guidelines

In de woningwaardering package wordt de logger van loguru gebruikt voor logging. Voor het developen in de woningwaardering package worden de logging levels DEBUG, INFO, WARNING en ERROR gebruikt. De verschillende levels worden gebruikt voor de verschillende types van logging, zoals beschreven in de python 3.11 documentatie. Hieronder is de tabel van de python documentatie gekopieerd waarin de verschillende logging levels staan beschreven. De tabel is aangevuld met de kolom "Gebruik Woningwaardering Package", waarin wordt aangegeven met voorbeelden welke soort logging gedaan wordt op de verschillende logging levels.

Level	Numerieke waarde	Wat het betekent / Wanneer te gebruiken	Gebruik Woningwaardering Package
NOTSET	0	Wanneer ingesteld op een logger, geeft dit aan dat bovenliggende loggers geraadpleegd moeten worden om het effectieve niveau te bepalen. Als dit nog steeds NOTSET oplevert, worden alle gebeurtenissen gelogd. Wanneer ingesteld op een handler, worden alle gebeurtenissen afgehandeld.	Wordt niet gebruikt in de woningwaardering package.
DEBUG	10	Gedetailleerde informatie, meestal alleen van belang voor een ontwikkelaar die een probleem probeert te diagnosticeren.	Wordt alleen gebruikt om details weer the geven aan een developer. bijvoorbeeld: wat een functie terug geeft of welke type een variabele heeft.
INFO	20	Bevestiging dat alles werkt zoals verwacht.	Bevat beschrijvingen van de werking van de code. Bijvoorbeeld: Het berekende resultaat voor een stelselgroep of welke code op basis van de input data wordt gerund.
WARNING	30	Een indicatie dat er iets onverwachts is gebeurd, of dat er in de nabije toekomst een probleem kan optreden (bijv. 'schijfruimte bijna vol'). De software werkt nog steeds zoals verwacht.	Een warning wordt gelogd wanneer er bijvoorbeeld iets mist in de input data of een functie deprecated is. Dit kan er toe leiden dat bepaalde code niet uitgevoerd kan worden. Voor warnings aan de package gebruiker, wordt altijd warnings.warn() gebruikt. Zie het kopje warnings voor meer informatie over het geven van warnings voor gebruikers en hoe hier mee omgegaan wordt.
ERROR	40	Vanwege een ernstiger probleem heeft de software een bepaalde functie niet kunnen uitvoeren.	Een error wordt in de woningwaardering package gelogd wanneer het gedrag verwacht is en de error een extra toelichting nodig heeft. Wanneer een error kritiek is voor het functioneren van de package wordt deze error geraisd. Ook kan het voorkomen dat de verwachte error toegestaan is. Dit kan bijvoorbeeld in een try/except patroon. Er kan dan gekozen worden om de error te loggen maar niet te raisen. Hierdoor kan het programma wel doorgaan en is het wel duidelijk dat er een exception heeft plaatsgevonden. Zoals een error geraisd kan worden en het programma kan laten stoppen, zo kunnen warnings ook geraisd worden om het progromma te stoppen.
CRITICAL	50	Een ernstige fout, die aangeeft dat het programma zelf mogelijk niet meer kan blijven draaien.	Wordt niet gebruikt in de woningwaardering package.

Datamodellen

De datamodellen in de woningwaardering package zijn gebaseerd op de OpenAPI-specificatie van het VERA BVG domein.

Wanneer je deze modellen wilt bijwerken, zorg er dan voor dat Task en de dev dependencies zijn geïnstalleerd:

pip install -e ".[dev]"

Vervolgens kan je met dit commando de modellen in deze repository bijwerken:

task genereer-vera-bvg-modellen

De classes voor deze modellen worden gegeneerd in woningwaardering/vera/bvg/generated.py

Datamodellen uitbreiden

Wanneer de VERA modellen niet toereikend zijn om de woningwaardering te berekenen, kan het VERA model uitgebreid worden.

Maak hiervoor altijd eerst een issue aan in de VERA OpenApi repository.

Maak vervolgens in de map woningwaardering/vera/bvg/model_uitbreidingen een class aan met de missende attributen. De naamgeving voor deze classes is: _{classNaam}.

Zet in de class bij het toegevoegde attribuut een comment met een link naar het issue in de VERA OpenApi repository zodat duidelijk is waar de toevoeging voor dient, en we kunnen volgen of de aanpassing is doorgevoerd in de VERA modellen.

Daarnaast neem je in de class een docstring op met uitleg over het gebruik en doel van de uitbreiding.

Bijvoorbeeld: voor het uitbreiden van de class EenhedenRuimte maak je een class _EenhedenRuimte aan:

from typing import Optional

from pydantic import BaseModel, Field


class _EenhedenRuimte(BaseModel):
    # https://github.com/Aedes-datastandaarden/vera-openapi/issues/44
    gedeeld_met_aantal_eenheden: Optional[int] = Field(
        default=None, alias="gedeeldMetAantalEenheden"
    )
    """
    Het aantal eenheden waarmee deze ruimte wordt gedeeld. Deze waarde wordt gebruikt bij het berekenen van de waardering van een gedeelde ruimte met ruimtedetailsoort berging.
    """

De task genereer-vera-bvg-modellen zal de body van deze classes samenvoegen met de gelijknamige VERA class en zo de toegevoegde attributen beschikbaar maken.

Referentiedata

We maken gebruik van de VERA Referentiedata.

Wanneer je de referentiedata wilt bijwerken, zorg er dan voor dat Task is geïnstalleerd

Vervolgens kan je met dit commando de referentiedata in deze repository bijwerken:

task genereer-vera-referentiedata

De referentiedata wordt gegenereerd in woningwaardering/vera/referentiedata