Skip to content

Returns string values with all regular expression meta characters escaped

Source code

Description

Returns string values with all regular expression meta characters escaped

Usage

<Expr>$str$escape_regex()

Value

A polars expression

Examples

library("polars")

df <- pl$DataFrame(text = c("abc", "def", NA, r"(abc(\w+))"))
df$with_columns(escaped = pl$col("text")$str$escape_regex())
#> shape: (4, 2)
#> ┌──────────┬──────────────┐
#> │ text     ┆ escaped      │
#> │ ---      ┆ ---          │
#> │ str      ┆ str          │
#> ╞══════════╪══════════════╡
#> │ abc      ┆ abc          │
#> │ def      ┆ def          │
#> │ null     ┆ null         │
#> │ abc(\w+) ┆ abc\(\\w\+\) │
#> └──────────┴──────────────┘