KOpeningHours

A library for parsing and evaluating OSM opening hours expressions. This library also includes python bindings.

Introduction

OSM opening hours expressions are used to describe when a feature is open/available or closed. This format is not only used in OpenStreetMap itself, but in various other data sources or APIs needing such a description as well.

See:

Supported Features

The parser and validator is fairly complete. However the evaluation feature has the following limitations.

So far only the time interval mode is supported, not the point in time mode.

Supported opening hours features are:

  • rule sequences
  • fallback rules
  • all rule modifiers and rule comments
  • time span, weekday, week, month, month day and year selectors
  • open-ended time spans
  • solar position based variable time events
  • public holiday selectors (based on KF5::Holidays)
  • variable date selectors

Still missing features:

  • comment preservation on intersecting close rules
  • wide range selector placeholder comments
  • school holiday selectors
  • open ended month ranges

Other Formats

Opening hours in the schema.org format can be read as well, via KOpeningHours::OpeningHours::fromJsonLd().

This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Oct 4 2024 12:07:24 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.