Escape string

Category: Text

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

Input / output: string → string

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

What it does

Escapes special characters in a string so that they do not cause conflicts. For example, Don't stop me now becomes Don\'t stop me now. Supports the following escape sequences:

  • \n (Line feed/newline)

  • \r (Carriage return)

  • \t (Horizontal tab)

  • \b (Backspace)

  • \f (Form feed)

  • \xnn (Hex, where n is 0-f)

  • \\ (Backslash)

  • \' (Single quote)

  • \" (Double quote)

  • \unnnn (Unicode character)

  • \u{nnnnnn} (Unicode code point)

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

Escape level

option

'Special chars'

'Special chars', 'Everything', 'Minimal'

1

Escape quote

option

'Single'

'Single', 'Double', 'Backtick'

2

JSON compatible

boolean

False

True or False

3

ES6 compatible

boolean

True

True or False

4

Uppercase hex

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 = ['Special chars', 'Single', False, True, False]
result = bake(input_value, [{"op": 'Escape string', "args": args}])
print(result)

Pipeline example

from pychef import Pipeline

args = ['Special chars', 'Single', False, True, False]
transform = Pipeline().then('Escape string', *args)
result = transform("example")

Dedicated operation module

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

from pychef.operations.by_operation.escape_string import run

result = run("example", tuple(['Special chars', 'Single', False, True, False]))
pychef.operations.by_operation.escape_string.run(value, args)

Run this operation using its shared internal implementation.

Parameters:

  • value (str | bytes)

  • args (Sequence[Any])

Return type:

str | bytes