.. _`Sort List`:

.. _`org.sysess.sympathy.list.sortlist`:

Sort List
~~~~~~~~~

.. image:: sort_list.svg
   :width: 48


Sort List of items using a Python key function that determines order.
For details about how to write the key function see: `Key functions
<https://docs.python.org/2/howto/sorting.html#key-functions>`_. Have a look
at the :ref:`Data type APIs<datatypeapis>` to see what methods and
attributes are available on the data type that you are working with.

Example with port type == [adaf] and item type == adaf:

    Sorting input produced by Random ADAFs:

      lambda item: item.meta['meta_col0'].value()

*Ports*:

    **Inputs**:

        :list: [<a>]

            List to be sorted

    **Outputs**:

        :list: [<a>]

            Sorted List

*Configuration*:

    **sort_function**
        Python key function that determines order.
    **reverse**
        Use descending (reverse) order.

.. automodule:: node_list_operations

.. class:: SortList