Regex

RegexExtract

Bases: ExtractionMethod

Takes an input string and a regex with named capture groups and returns a dictionary of the values extracted using the named capture groups.

Method name: regex

Example configuration

.. code-block:: yaml

- method: regex
  inputs:
    regex: ^(?:[^_]*_){2}(?P<datetime>\d*)

noqa: W605

Source code in extraction_methods/plugins/regex.py

class RegexExtract(ExtractionMethod):
    """
    Takes an input string and a regex with
    named capture groups and returns a dictionary of the values
    extracted using the named capture groups.

    **Method name:** ``regex``

    Example configuration:
        .. code-block:: yaml

            - method: regex
              inputs:
                regex: ^(?:[^_]*_){2}(?P<datetime>\d*)

    # noqa: W605
    """

    input_class = RegexInput

    @update_input
    def run(self, body: dict[str, Any]) -> dict[str, Any]:

        result = re.search(rf"{self.input.regex}", self.input.input_term)

        if result:
            body |= result.groupdict()

        else:
            LOGGER.debug("No matches found for regex extract")

        return body

RegexInput

Bases: Input

Model for Regex Input.

Parameters:

Name	Type	Description	Default
input_term	str	term for method to run on.	'$uri'
regex	str	The regular expression to match against.	required

Source code in extraction_methods/plugins/regex.py

class RegexInput(Input):
    """
    Model for Regex Input.
    """

    input_term: str = Field(
        default="$uri",
        description="term for method to run on.",
    )
    regex: str = Field(
        description="The regular expression to match against.",
    )