fparser.common.utils
====================

.. py:module:: fparser.common.utils

.. autoapi-nested-parse::

   Various utility functions.

   Permission to use, modify, and distribute this software is given under the
   terms of the NumPy License. See http://scipy.org.

   NO WARRANTY IS EXPRESSED OR IMPLIED.  USE AT YOUR OWN RISK.
   Author: Pearu Peterson <pearu@cens.ioc.ee>
   Created: May 2006



Attributes
----------

.. autoapisummary::

   fparser.common.utils.is_name


Exceptions
----------

.. autoapisummary::

   fparser.common.utils.ParseError
   fparser.common.utils.AnalyzeError


Classes
-------

.. autoapisummary::

   fparser.common.utils.classes


Functions
---------

.. autoapisummary::

   fparser.common.utils.split_comma
   fparser.common.utils.parse_array_spec
   fparser.common.utils.specs_split_comma
   fparser.common.utils.parse_bind
   fparser.common.utils.parse_result
   fparser.common.utils.get_module_file
   fparser.common.utils.str2stmt


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

.. py:exception:: ParseError

   Bases: :py:obj:`Exception`


   Common base class for all non-exit exceptions.


.. py:exception:: AnalyzeError

   Bases: :py:obj:`Exception`


   Common base class for all non-exit exceptions.


.. py:data:: is_name

.. py:function:: split_comma(line, item=None, comma=',', keep_empty=False, brackets=None)

   Split (an optionally bracketed) comma-separated list into
   items and return a list containing them. If supplied then
   brackets must be a list of containing two strings, the first
   being the opening bracket and the second the closing bracket.


.. py:function:: parse_array_spec(line, item=None)

.. py:function:: specs_split_comma(line, item=None, upper=False)

.. py:function:: parse_bind(line, item=None)

.. py:function:: parse_result(line, item=None)

.. py:function:: get_module_file(name, directory, _cache={})

.. py:function:: str2stmt(string, isfree=True, isstrict=False)

   Convert Fortran code to Statement tree.


.. py:class:: classes

   Bases: :py:obj:`type`


   Make classes available as attributes of this class.

   To add a class to the attributes list, one must use::

     class Name(metaclass=classes):

   in the definition of the class.

   In addition, apply the following tasks:

   * decorate analyze methods with show_item_on_failure