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

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


Attributes
----------

.. autoapisummary::

   geoprob_pipe.utils.df_validation.requirements.IsString


Classes
-------

.. autoapisummary::

   geoprob_pipe.utils.df_validation.requirements.IsInRange
   geoprob_pipe.utils.df_validation.requirements.IsIn


Functions
---------

.. autoapisummary::

   geoprob_pipe.utils.df_validation.requirements.is_string
   geoprob_pipe.utils.df_validation.requirements.is_in_range
   geoprob_pipe.utils.df_validation.requirements.is_not_null
   geoprob_pipe.utils.df_validation.requirements.is_null
   geoprob_pipe.utils.df_validation.requirements.is_in
   geoprob_pipe.utils.df_validation.requirements.is_integer
   geoprob_pipe.utils.df_validation.requirements.is_whole_number
   geoprob_pipe.utils.df_validation.requirements.is_numeric


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

.. py:function:: is_string(s)

.. py:data:: IsString

.. py:function:: is_in_range(left, right, inclusive = 'both')

.. py:class:: IsInRange(left, right, inclusive = 'both', filters = None, stop_validation_on_failure = False)

   Bases: :py:obj:`geoprob_pipe.utils.df_validation.requirement.ValidationRequirement`


.. py:function:: is_not_null(s)

.. py:function:: is_null(s)

.. py:function:: is_in(values)

.. py:class:: IsIn(values, filters = None, stop_validation_on_failure = False)

   Bases: :py:obj:`geoprob_pipe.utils.df_validation.requirement.ValidationRequirement`


.. py:function:: is_integer(s)

.. py:function:: is_whole_number(s)

.. py:function:: is_numeric(s)