<commit_before>Augmenter Configuration Objects
===============================

These configuration objects are predefined in the Augmenter modules
or can be defined or overriden by configuration elements in the
augmenter map.

.. module:: pyrseas.augment.function

Configuration Functions
-----------------------

A :class:`CfgFunction` class specifies a function to be used by other
augmenter objects.  For example, this includes procedures to be
invoked by triggers used to maintain audit columns.  The
:class:`CfgFunctionDict` class holds all the :class:`CfgFunction`
objects, indexed by the function name and its arguments.  A
:class:`CfgFunctionSource` class represents the source code for a
function or part of that source code.  A :class:`CfgFunctionSegment`
class specifies a segment of the function code that is logically
repeatable.  For example, a function template (see below) may
act --generically-- on several columns of a target table.  Each column
name can be defined in a function segment.  A
:class:`CfgFunctionTemplate` class represents the source code for a
function, which may include segments or other elements that can be
substituted in the final result.  The class
:class:`CfgFunctionSourceDict` holds all the templates and segments
currently defined.

.. autoclass:: CfgFunction

.. automethod:: CfgFunction.adjust_name

.. automethod:: CfgFunction.apply

.. autoclass:: CfgFunctionDict

.. automethod:: CfgFunctionDict.from_map

.. autoclass:: CfgFunctionSource

.. autoclass:: CfgFunctionSourceSegment

.. automethod:: CfgFunctionSourceSegment.replace

.. autoclass:: CfgFunctionTemplate

.. autoclass:: CfgFunctionSourceDict


.. module:: pyrseas.augment.column

Configuration Columns
---------------------
<commit_msg>Correct CfgFunctionSourceSegment to CfgFunctionSegment. [ci skip]<commit_after>Augmenter Configuration Objects
===============================

These configuration objects are predefined in the Augmenter modules
or can be defined or overriden by configuration elements in the
augmenter map.

.. module:: pyrseas.augment.function

Configuration Functions
-----------------------

A :class:`CfgFunction` class specifies a function to be used by other
augmenter objects.  For example, this includes procedures to be
invoked by triggers used to maintain audit columns.  The
:class:`CfgFunctionDict` class holds all the :class:`CfgFunction`
objects, indexed by the function name and its arguments.  A
:class:`CfgFunctionSource` class represents the source code for a
function or part of that source code.  A :class:`CfgFunctionSegment`
class specifies a segment of the function code that is logically
repeatable.  For example, a function template (see below) may
act --generically-- on several columns of a target table.  Each column
name can be defined in a function segment.  A
:class:`CfgFunctionTemplate` class represents the source code for a
function, which may include segments or other elements that can be
substituted in the final result.  The class
:class:`CfgFunctionSourceDict` holds all the templates and segments
currently defined.

.. autoclass:: CfgFunction

.. automethod:: CfgFunction.adjust_name

.. automethod:: CfgFunction.apply

.. autoclass:: CfgFunctionDict

.. automethod:: CfgFunctionDict.from_map

.. autoclass:: CfgFunctionSource

.. autoclass:: CfgFunctionSegment

.. automethod:: CfgFunctionSegment.replace

.. autoclass:: CfgFunctionTemplate

.. autoclass:: CfgFunctionSourceDict


.. module:: pyrseas.augment.column

Configuration Columns
---------------------

{'fraction_non_alphanumeric': 0.103789592760181, 'fraction_numerical': 0.0, 'mean_word_length': 4.466769706336939, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1026497', 'n_tokens_mistral': 908, 'n_tokens_neox': 864, 'n_words': 385}