Feiertagskalender: Optimierter Algorithmus für Liste von Bundesländern

[PhrozenByte]

Vielen Dank für die Umsetzung von #28 mit #32! 🎉 🚀 Ich hatte mir den Code zuvor nicht näher angesehen, dachte das sei eine eher kleine Änderung, war dann aber offensichtlich doch deutlich mehr Arbeit als gedacht - dafür nochmal ein extra Dankeschön! ❤️

Einen optionalen Aspekt von #28 möchte ich gerne nochmal kurz fürs Ortsfeld und die Beschreibung vorschlagen:

Die absolute Premium-Lösung wäre wenn dann noch eine kleine Prüflogik für "Alle Bundesländer" und "Alle Bundesländer außer <bis zu 5 Länder>" existieren würde, die dafür sorgt, dass bei (nahezu) bundesweiten Feiertagen nicht immer (fast) alle Bundesländer aufgezählt werden.

Für die Basisvariante dürfte es reichen die folgenden beiden Codezeilen auch in die build_location Methode fürs Ortsfeld einzubauen, nicht nur in build_description für die Beschreibung:

ics.tools/scripts/03_generate_public_holidays_ics.py

Lines 64 to 65 in 5a57c0c

	if set(ordered_codes) == ALL_STATE_CODES:
	return "Gilt in allen Bundesländern."

Für die Premiumvariante könnte man den Codepfad auch in eine kleine Helper-Methode auslagern, die die oben erwähnte Prüflogik für "Alle Bundesländer außer <bis zu 5 Länder>" realisiert. Hier ein kleines PoC (ungetestet):

def _excluded_state_codes(state_codes: list[str]) -> list[str] | None:
    excluded_codes = ALL_STATE_CODES - set(state_codes)
    return list(excluded_codes) if len(excluded_codes) <= 5 else None


def build_description(state_codes: list[str], own_state_code: str | None = None) -> str:
    excluded_codes = _excluded_state_codes(state_codes)
    if excluded_codes is not None:
        if not excluded_codes:
            return "Gilt in allen Bundesländern."
        excluded_names = [STATE_NAME_BY_CODE[code] for code in excluded_codes]
        return "\n".join(["Gilt in allen Bundesländern außer:"] + [f"- {state_name}" for state_name in excluded_names])

    ordered_codes = ordered_state_codes(state_codes, own_state_code=own_state_code)
    state_names = [STATE_NAME_BY_CODE[code] for code in ordered_codes]
    return "\n".join(["Gilt in:"] + [f"- {state_name}" for state_name in state_names])


def build_location(state_codes: list[str], own_state_code: str | None = None) -> str:
    excluded_codes = _excluded_state_codes(state_codes)
    if excluded_codes is not None:
        return "Alle Bundesländer" + ("" if not excluded_codes else " außer " + ", ".join(excluded_codes))

    ordered_codes = ordered_state_codes(state_codes, own_state_code=own_state_code)
    return ", ".join(ordered_codes)

Falls du das nicht für sinnvoll hältst: No hard feelings, danke nochmal!

[Skillkiller]

Hey,
danke für das Feedback zu #32 und den erneuten Vorschlag mit der "Negativ-Prüfung" (also aufzulisten, in welchen Bundesländern ein Feiertag nicht gilt).

Tatsächlich hatte ich genau diese Mechanik während der Implementierung von #32 bereits verprobt. Die Daten zeigen jedoch, dass es in der Praxis so gut wie keine Feiertage gibt, bei denen dieser Fall überhaupt eintritt.

Ein Blick auf die Verteilung der Bundesländer pro Feiertag macht das deutlich:

jq.exe '[.holidays[].states | length] | unique | reverse | .[0:10]' .\data\public_holidays\result\de.json
[
  16,
  9,
  6,
  5,
  3,
  2,
  1
]

Diese Ausgabe zeigt die Verteilung der gesetzlichen Feiertage nach der Anzahl der Bundesländer, in denen sie gleichzeitig gelten (absteigend sortiert und ohne Duplikate).
Man erkennt hieran sehr gut die Struktur der deutschen Feiertage: Während die bundesweiten Feiertage der Spitzenreiter mit 16 Bundesländern sind, folgt die nächste Stufe regionaler Feiertage bereits mit deutlichem Abstand bei nur noch 9 Bundesländern.

Für die Praxis bedeutet das:

• Bei einem bundesweiten Feiertag (16) schreiben wir ohnehin "Bundesweit".
• Bei der nächsten Stufe (9) gilt der Feiertag in 9 Ländern und in 7 Ländern nicht. Der optische Gewinn im Textfeld wäre bei 9 vs. 7 Ländern also minimal.

Für das Ortsfeld und die Beschreibung finde ich es daher intuitiver und sauberer, konsequent immer die Bundesländer aufzulisten, in denen der Feiertag tatsächlich gilt. Das vermeidet Verwirrung beim Nutzer.

Mich würde aber interessieren, wie du das siehst.

Grüße,
Sebastian

[PhrozenByte]

Sehr guter Punkt, ich habe mir die tatsächliche Verteilung gar nicht angesehen. Du hast natürlich vollkommen Recht, dass der Vorschlag dann wenig Sinn macht 👍

Dann möchte ich eigentlich nur vorschlagen auch beim Ortsfeld die "Alle Bundesländer"-Kurzform zu ergänzen und nicht alle Bundesländer einzeln aufzuzählen, also den folgenden Code auch bei build_location() zu integrieren (dann mit dem Text "Alle Bundesländer"):

ics.tools/scripts/03_generate_public_holidays_ics.py

Lines 64 to 65 in 5a57c0c

	if set(ordered_codes) == ALL_STATE_CODES:
	return "Gilt in allen Bundesländern."

Vielen Dank!