fparser
=======

.. py:module:: fparser


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/fparser/_version/index
   /autoapi/fparser/api/index
   /autoapi/fparser/common/index
   /autoapi/fparser/conftest/index
   /autoapi/fparser/one/index
   /autoapi/fparser/scripts/index
   /autoapi/fparser/two/index


Attributes
----------

.. autoapisummary::

   fparser.__version__


Functions
---------

.. autoapisummary::

   fparser._get_version
   fparser.log_decode_error_handler


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

.. py:function:: _get_version()

   :returns: the version of this package.
   :rtype: str


.. py:data:: __version__

.. py:function:: log_decode_error_handler(err)

   A custom error handler for use when reading files. Removes any
   characters that cause decoding errors and logs the error.

   :returns: 2-tuple containing replacement for bad chars (an empty string               and the position from where encoding should continue.
   :rtype: Tuple[str, int]