hipscat.io.validation

Module Contents

Functions

is_valid_catalog(→ bool)	Checks if a catalog is valid for a given base catalog pointer
is_catalog_info_valid(→ bool)	Checks if catalog_info is valid for a given base catalog pointer
is_partition_info_valid(→ bool)	Checks if partition_info is valid for a given base catalog pointer
is_metadata_valid(→ bool)	Checks if _metadata is valid for a given base catalog pointer

is_valid_catalog(pointer: hipscat.io.file_io.file_pointer.FilePointer, storage_options: Dict[Any, Any] | None = None) → bool

Checks if a catalog is valid for a given base catalog pointer

Parameters:

• pointer (FilePointer) – pointer to base catalog directory

• storage_options – dictionary that contains abstract filesystem credentials

Returns:

True if both the catalog_info and partition_info files are valid, False otherwise

is_catalog_info_valid(pointer: hipscat.io.file_io.file_pointer.FilePointer, storage_options: Dict[Any, Any] | None = None) → bool

Checks if catalog_info is valid for a given base catalog pointer

Parameters:

• pointer (FilePointer) – pointer to base catalog directory

• storage_options – dictionary that contains abstract filesystem credentials

Returns:

True if the catalog_info file exists, and it is correctly formatted, False otherwise

is_partition_info_valid(pointer: hipscat.io.file_io.file_pointer.FilePointer, storage_options: Dict[Any, Any] | None = None) → bool

Checks if partition_info is valid for a given base catalog pointer

Parameters:

• pointer (FilePointer) – pointer to base catalog directory

• storage_options – dictionary that contains abstract filesystem credentials

Returns:

True if the partition_info file exists, False otherwise

is_metadata_valid(pointer: hipscat.io.file_io.file_pointer.FilePointer, storage_options: Dict[Any, Any] | None = None) → bool

Checks if _metadata is valid for a given base catalog pointer

Parameters:

• pointer (FilePointer) – pointer to base catalog directory

• storage_options – dictionary that contains abstract filesystem credentials

Returns:

True if the _metadata file exists, False otherwise