hats.io.validation
==================

.. py:module:: hats.io.validation


Functions
---------

.. autoapisummary::

   hats.io.validation.is_valid_catalog
   hats.io.validation.is_valid_collection
   hats.io.validation.is_collection_info_valid


Module Contents
---------------

.. py:function:: is_valid_catalog(pointer: str | pathlib.Path | upath.UPath, strict: bool = False, fail_fast: bool = False, verbose: bool = True) -> bool

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

   NB: This method uses logging to issue INFO, WARNING, and ERROR
   messages. Configure your logging environment to appropriately
   channel messages.

   :Parameters:

       **pointer** : str | Path | UPath
           pointer to base catalog directory

       **strict** : bool
           should we perform additional checking that every optional
           file exists, and contains valid, consistent information, AS WELL AS
           all expected data partitions for the catalog's partitions.
           (Default value = False)

       **fail_fast** : bool
           DEPRECATED - will be removed in a future version.

       **verbose** : bool
           DEPRECATED - will be removed in a future version.



   :Returns:

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











   ..
       !! processed by numpydoc !!

.. py:function:: is_valid_collection(pointer: str | pathlib.Path | upath.UPath, strict: bool = False, fail_fast: bool = False, verbose: bool = True) -> bool

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

   NB: This method uses logging to issue INFO, WARNING, and ERROR
   messages. Configure your logging environment to appropriately
   channel messages.

   :Parameters:

       **pointer** : str | Path | UPath
           pointer to base catalog collection directory

       **strict** : bool
           should we perform additional checking that every optional
           file exists, and contains valid, consistent information, AS WELL
           AS strict checking on all sub-catalogs (primary, margin, and index).
           (Default value = False)

       **fail_fast** : bool
           DEPRECATED - will be removed in a future version.

       **verbose** : bool
           DEPRECATED - will be removed in a future version.



   :Returns:

       bool
           True if the collection properties are valid, and all sub-catalogs pass
           validation.











   ..
       !! processed by numpydoc !!

.. py:function:: is_collection_info_valid(pointer: str | pathlib.Path | upath.UPath) -> bool

   
   Checks if collection.properties file is valid for a given base catalog pointer
















   ..
       !! processed by numpydoc !!