Find / Replace

Category: Text

Status: Registered and callable in the CyberChef 11.3.0 compatibility inventory.

Input / output: string → string

Background: https://wikipedia.org/wiki/Regular_expression

What it does

Replaces all occurrences of the first string with the second. Includes support for regular expressions (regex), simple strings and extended strings (which support n, r, t, b, f and escaped hex bytes using x notation, e.g. x00 for a null byte).

Note

Status here means the operation name is implemented and callable. It does not by itself promise byte-for-byte parity for every upstream option. See Compatibility and current status for the verified scope and known boundaries.

Arguments and options

Arguments are positional. Keep their order when using bake() or Pipeline.then().

Index

Name

UI type

PyChef default

Accepted values / format

0

Find

toggleString

{'string': '', 'option': 'Regex'}

''

1

Replace

binaryString

''

''

2

Global match

boolean

True

True or False

3

Case insensitive

boolean

False

True or False

4

Multiline matching

boolean

True

True or False

5

Dot matches all

boolean

False

True or False

Recipe template

Important

This is a call template built from the documented defaults. Replace placeholder values such as empty keys, paths, patterns, or lookup data before running it.

from pychef import bake

input_value = "example"
args = [{'string': '', 'option': 'Regex'}, '', True, False, True, False]
result = bake(input_value, [{"op": 'Find / Replace', "args": args}])
print(result)

Pipeline example

from pychef import Pipeline

args = [{'string': '', 'option': 'Regex'}, '', True, False, True, False]
transform = Pipeline().then('Find / Replace', *args)
result = transform("example")

Dedicated operation module

The registered entry point lives in pychef.operations.by_operation.find_replace. Direct calls receive the input value and a positional argument tuple:

from pychef.operations.by_operation.find_replace import run

result = run("example", tuple([{'string': '', 'option': 'Regex'}, '', True, False, True, False]))
pychef.operations.by_operation.find_replace.run(value, args)

Run this operation using its shared internal implementation.

Parameters:
  • value (str | bytes)

  • args (Sequence[Any])

Return type:

str | bytes