stormwater_monitoring_datasheet_extraction.lib.schema.checks package

Submodules

stormwater_monitoring_datasheet_extraction.lib.schema.checks.dataframe_checks module

Schema dataframe checks.

stormwater_monitoring_datasheet_extraction.lib.schema.checks.dataframe_checks.datetime_lt_now(df, date_col, time_col, date_format, time_format)

Checks if each date:time is before now.

Parameters:
  • df (DataFrame) – The DataFrame containing the date and time columns.

  • date_col (str) – The name of the date column.

  • time_col (str) – The name of the time column.

  • date_format (str) – The format string for parsing the date.

  • time_format (str) – The format string for parsing the time.

Returns:

time is on or before now.

Return type:

A boolean Series indicating whether each date

stormwater_monitoring_datasheet_extraction.lib.schema.checks.field_checks module

Schema field checks.

stormwater_monitoring_datasheet_extraction.lib.schema.checks.field_checks.date_le_today(series)

Every date is on or before today.

Return type:

Series[bool]

stormwater_monitoring_datasheet_extraction.lib.schema.checks.field_checks.is_valid_date(series, date_format)

Every date parses with the given format.

Return type:

Series[bool]

stormwater_monitoring_datasheet_extraction.lib.schema.checks.field_checks.is_valid_time(series, format)

Every time parses with the given format.

Return type:

Series[bool]

stormwater_monitoring_datasheet_extraction.lib.schema.checks.relational module

Checks across the whole schema, between tables, e.g. referential integrity.

stormwater_monitoring_datasheet_extraction.lib.schema.checks.relational.validate_site_creek_map(site_type_map, creek_type_map)

Validate the site and creek type maps.

Checks mutual referential integrity.

Parameters:
  • site_type_map (DataFrame[Site]) – A DataFrame mapping site IDs to their outfall types.

  • creek_type_map (DataFrame[Creek]) – A DataFrame mapping creek site IDs to their creek types.

Return type:

None

Module contents

Schema checks.