Register

Category: Flow control

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

Input / output: string → string

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

What it does

Extract data from the input and store it in registers which can then be passed into subsequent operations as arguments. Regular expression capture groups are used to select the data to extract. To use registers in arguments, refer to them using the notation $Rn where n is the register number, starting at 0. For example: Input: Test Extractor: (.*) Argument: $R0 becomes Test Registers can be escaped in arguments using a backslash. e.g. \$R0 would become $R0 rather than Test.

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`	Extractor	`binaryString`	`'([\\s\\S]*)'`	`'([\\s\\S]*)'`
`1`	Case insensitive	`boolean`	`True`	`True` or `False`
`2`	Multiline matching	`boolean`	`False`	`True` or `False`
`3`	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 = ['([\\s\\S]*)', True, False, False]
result = bake(input_value, [{"op": 'Register', "args": args}])
print(result)

Pipeline example

from pychef import Pipeline

args = ['([\\s\\S]*)', True, False, False]
transform = Pipeline().then('Register', *args)
result = transform("example")

Dedicated operation module

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

from pychef.operations.by_operation.register import run

result = run("example", tuple(['([\\s\\S]*)', True, False, False]))

pychef.operations.by_operation.register.run(value, args)

Run this operation using its shared internal implementation.

Parameters:

value (str | bytes)
args (Sequence[Any])

Return type:

str | bytes