RIAssigner.utils
================

.. py:module:: RIAssigner.utils


Attributes
----------

.. autoapisummary::

   RIAssigner.utils.T


Functions
---------

.. autoapisummary::

   RIAssigner.utils.get_first_common_element
   RIAssigner.utils.define_separator
   RIAssigner.utils.get_extension
   RIAssigner.utils.is_sorted
   RIAssigner.utils.clean_column_names


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

.. py:data:: T

.. py:function:: get_first_common_element(first: Iterable[T], second: Iterable[T]) -> T

   Get first common element from two lists.

   :param first: First list.
   :type first: Iterable[T]
   :param second: Second list.
   :type second: Iterable[T]

   :returns: First common element or None if no common element is found.
   :rtype: T


.. py:function:: define_separator(filename: str) -> str

   Select separator for data values based on filename extension.

   :param filename: Filename for which to get the separator.
   :type filename: str

   :returns: Separator for data values.
   :rtype: str


.. py:function:: get_extension(filename: str) -> str

   Get extension of filename.

   :param filename: Filename for which to get the extension.
   :type filename: str

   :returns: Filename extension.
   :rtype: str


.. py:function:: is_sorted(values) -> bool

   Check if values are sorted in ascending order.

   :param values: Values to check
   :type values: Any

   :returns: True if sorted.
   :rtype: bool


.. py:function:: clean_column_names(column_names: List[str]) -> List[str]

   Clean column names by removing leading and trailing whitespaces, converting to lowercase.

   :param column_names: List of column names to clean.
   :type column_names: List[str]

   :returns: List of cleaned column names.
   :rtype: List[str]