.. _`Rename File`:

.. _`org.sysess.sympathy.files.renamefile`:

Rename File
~~~~~~~~~~~

.. image:: rename.svg
   :width: 48


Rename one file using a new filename.

*Input ports*:
    :port1: datasource

        File to rename

*Output ports*:
    :port1: datasource

        Path to renamed file

*Configuration*:
    **Filename** (filename)
        Manually enter a filename, if not using a regular expression
    **Regex** (use_regex)
        Turn on/off naming using a regular expression
    **Search** (pattern)
        Specify the regular expression that will be used for matching
    **Replace** (replace)
        The string to replace the match found with the regular expression
    **Do not raise exceptions** (error)
        If a file operation fails, do not raise an exception

.. automodule:: node_file_operations

.. class:: RenameFile