leaf_engine.adapt.validation
============================

.. py:module:: leaf_engine.adapt.validation


Classes
-------

.. autoapisummary::

   leaf_engine.adapt.validation.Schema


Functions
---------

.. autoapisummary::

   leaf_engine.adapt.validation.is_lat_lon_tuple
   leaf_engine.adapt.validation.is_nn_flt
   leaf_engine.adapt.validation.is_nullable_flt
   leaf_engine.adapt.validation.validate_dfs


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

.. py:class:: Schema(schema: dict, strict_columns=True)

   .. py:method:: validate(df: pandas.DataFrame)


   .. py:attribute:: schema


   .. py:attribute:: strict_columns


.. py:function:: is_lat_lon_tuple(x)

.. py:function:: is_nn_flt(x)

.. py:function:: is_nullable_flt(x)

.. py:function:: validate_dfs(schema)

   Decorator for validating function inputs/outputs. Takes a dict containing
   Schema objects in the following format:
   {
       'in': [Schema_object1, Schema_object2...], # List of Schema objects
                                                   that positionally correspond
                                                   to the decorated functions'
                                                   arguments
       'out': single_Schema_object
   }
   For each Schema, validates the corresponding DataFrame. Only executes the
   decorated function if all inputs/outputs pass validation.