geoprob_pipe.utils.df_validation
================================

.. py:module:: geoprob_pipe.utils.df_validation


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/geoprob_pipe/utils/df_validation/column/index
   /autoapi/geoprob_pipe/utils/df_validation/dataframe/index
   /autoapi/geoprob_pipe/utils/df_validation/filters/index
   /autoapi/geoprob_pipe/utils/df_validation/requirement/index
   /autoapi/geoprob_pipe/utils/df_validation/requirements/index


Classes
-------

.. autoapisummary::

   geoprob_pipe.utils.df_validation.DataFrameValidation
   geoprob_pipe.utils.df_validation.ColumnValidation
   geoprob_pipe.utils.df_validation.ValidationRequirement


Package Contents
----------------

.. py:class:: DataFrameValidation(df, label, columns_validations, required_columns = None)

   .. py:attribute:: label
      :type:  str


   .. py:attribute:: df
      :type:  pandas.DataFrame


   .. py:attribute:: required_columns
      :type:  Optional[List[str]]
      :value: None



   .. py:attribute:: columns_validations
      :type:  List[geoprob_pipe.utils.df_validation.column.ColumnValidation]


   .. py:attribute:: df_failures
      :type:  Optional[pandas.DataFrame]
      :value: None



   .. py:method:: _run_required_columns()


   .. py:method:: _run_column_validation()


   .. py:method:: run()


   .. py:method:: to_excel(directory)


.. py:class:: ColumnValidation(column_name, requirements)

   .. py:attribute:: column_name


   .. py:attribute:: requirements


.. py:class:: ValidationRequirement(requirement, failure_msg, filters = None, stop_validation_on_failure = False)

   .. py:attribute:: requirement


   .. py:attribute:: filters
      :value: None



   .. py:attribute:: failure_msg


   .. py:attribute:: stop_validation_on_failure
      :type:  bool
      :value: False



   .. py:method:: validate(df, column)