colawater.toolbox.quality_control.fids#

Quality control checks relating to facility identifiers.

Examples

res = find_incorrect_fids(layer, re.compile(r"^\d+example$"))
do_something(res)

res = find_duplicate_fids(layer)
do_something(res)

Module Contents#

Functions#

find_faulty(→ list[tuple[str, Optional[str]]])

Returns all incorrectly formatted facility identifiers matching a regular expression.

find_duplicate(→ list[tuple[str, Ellipsis]])

Returns all duplicate facility identifiers from the given layer.
colawater.toolbox.quality_control.fids.find_faulty(layer: arcpy._mp.Layer, regex: re.Pattern[Any]) → list[tuple[str, str | None]]#

Returns all incorrectly formatted facility identifiers matching a regular expression.

Parameters:

  • layer (arcpy._mp.Layer) – The layer to check.

  • regex (re.Pattern[Any]) – The regular expression to match against.

Returns:

The list of object IDs and incorrectly formatted facility identifiers.

Return type:

list[tuple[str, str]]

Raises:

ExecuteError – An error ocurred in the tool execution.

colawater.toolbox.quality_control.fids.find_duplicate(layer: arcpy._mp.Layer) → list[tuple[str, Ellipsis]]#

Returns all duplicate facility identifiers from the given layer.

Parameters:

layer (arcpy._mp.Layer) – The layer to check.

Returns:

The list of object IDs of duplicates, grouped by duplicate values at the zeroth index.

Return type:

list[tuple[str, …]]

Raises:

ExecuteError – An error ocurred in the tool execution.

Note

Writes result layer from Find Identical into scratch geodatabase.