module pixeltable.functions.string

Pixeltable UDFs for StringType. It closely follows the Pandas pandas.Series.str API. Example:

import pixeltable as pxt

t = pxt.get_table(...)
t.select(t.str_col.capitalize()).collect()

udf capitalize()

capitalize(self: String) -> String

Return string with its first character capitalized and the rest lowercased. Equivalent to str.capitalize().

udf casefold()

casefold(self: String) -> String

Return a casefolded copy of string. Equivalent to str.casefold().

udf center()

center(self: String, width: Int, fillchar: String = ' ') -> String

Return a centered string of length width. Equivalent to str.center(). Parameters:

width (Int): Total width of the resulting string.
fillchar (String): Character used for padding.

udf contains()

contains(self: String, substr: String, case: Bool = True) -> Bool

Test if string contains a substring. Parameters:

substr (String): string literal or regular expression
case (Bool): if False, ignore case

udf contains_re()

contains_re(self: String, pattern: String, flags: Int = 0) -> Bool

Test if string contains a regular expression pattern. Parameters:

pattern (String): regular expression pattern
flags (Int): flags for the re module

udf count()

count(self: String, pattern: String, flags: Int = 0) -> Int

Count occurrences of pattern or regex. Parameters:

pattern (String): string literal or regular expression
flags (Int): flags for the re module

udf endswith()

endswith(self: String, substr: String) -> Bool

Return True if the string ends with the specified suffix, otherwise return False. Equivalent to str.endswith(). Parameters:

substr (String): string literal

udf fill()

fill(self: String, width: Int) -> String

Wraps the single paragraph in string, and returns a single string containing the wrapped paragraph. Equivalent to textwrap.fill(). Parameters:

width (Int): Maximum line width.
kwargs (Any): Additional keyword arguments to pass to textwrap.fill().

udf find()

find(
    self: String,
    substr: String,
    start: Int = 0,
    end: Int | None = None
) -> Int

Return the lowest index in string where substr is found within the slice s[start:end]. Equivalent to str.find(). Parameters:

substr (String): substring to search for
start (Int): slice start
end (Int | None): slice end

udf findall()

findall(self: String, pattern: String, flags: Int = 0) -> Json

Find all occurrences of a regular expression pattern in string. Equivalent to re.findall(). Parameters:

pattern (String): regular expression pattern
flags (Int): flags for the re module

udf format()

format(self: String) -> String

Perform string formatting. Equivalent to str.format().

udf fullmatch()

fullmatch(
    self: String,
    pattern: String,
    case: Bool = True,
    flags: Int = 0
) -> Bool

Determine if string fully matches a regular expression. Equivalent to re.fullmatch(). Parameters:

pattern (String): regular expression pattern
case (Bool): if False, ignore case
flags (Int): flags for the re module

udf index()

index(
    self: String,
    substr: String,
    start: Int = 0,
    end: Int | None = None
) -> Int

Return the lowest index in string where substr is found within the slice [start:end]. Raises ValueError if substr is not found. Equivalent to str.index(). Parameters:

substr (String): substring to search for
start (Int): slice start
end (Int | None): slice end

udf isalnum()

isalnum(self: String) -> Bool

Return True if all characters in the string are alphanumeric and there is at least one character, False otherwise. Equivalent to [str.isalnum()](https://docs.python.org/3/library/stdtypes.html#str.isalnum

udf isalpha()

isalpha(self: String) -> Bool

Return True if all characters in the string are alphabetic and there is at least one character, False otherwise. Equivalent to str.isalpha().

udf isascii()

isascii(self: String) -> Bool

Return True if the string is empty or all characters in the string are ASCII, False otherwise. Equivalent to str.isascii().

udf isdecimal()

isdecimal(self: String) -> Bool

Return True if all characters in the string are decimal characters and there is at least one character, False otherwise. Equivalent to str.isdecimal().

udf isdigit()

isdigit(self: String) -> Bool

Return True if all characters in the string are digits and there is at least one character, False otherwise. Equivalent to str.isdigit().

udf isidentifier()

isidentifier(self: String) -> Bool

Return True if the string is a valid identifier according to the language definition, False otherwise. Equivalent to str.isidentifier()

udf islower()

islower(self: String) -> Bool

Return True if all cased characters in the string are lowercase and there is at least one cased character, False otherwise. Equivalent to str.islower()

udf isnumeric()

isnumeric(self: String) -> Bool

Return True if all characters in the string are numeric characters, False otherwise. Equivalent to str.isnumeric()

udf isspace()

isspace(self: String) -> Bool

Return True if there are only whitespace characters in the string and there is at least one character, False otherwise. Equivalent to str.isspace()

udf istitle()

istitle(self: String) -> Bool

Return True if the string is a titlecased string and there is at least one character, False otherwise. Equivalent to str.istitle()

udf isupper()

isupper(self: String) -> Bool

Return True if all cased characters in the string are uppercase and there is at least one cased character, False otherwise. Equivalent to str.isupper()

udf join()

join(sep: String, elements: Json) -> String

Return a string which is the concatenation of the strings in elements. Equivalent to str.join()

udf len()

len(self: String) -> Int

Return the number of characters in the string. Equivalent to len(str)

udf ljust()

ljust(self: String, width: Int, fillchar: String = ' ') -> String

Return the string left-justified in a string of length width. Equivalent to str.ljust() Parameters:

width (Int): Minimum width of resulting string; additional characters will be filled with character defined in fillchar.
fillchar (String): Additional character for filling.

udf lower()

lower(self: String) -> String

Return a copy of the string with all the cased characters converted to lowercase. Equivalent to str.lower()

udf lstrip()

lstrip(self: String, chars: String | None = None) -> String

Return a copy of the string with leading characters removed. The chars argument is a string specifying the set of characters to be removed. If omitted or None, whitespace characters are removed. Equivalent to str.lstrip() Parameters:

chars (String | None): The set of characters to be removed.

udf match()

match(
    self: String,
    pattern: String,
    case: Bool = True,
    flags: Int = 0
) -> Bool

Determine if string starts with a match of a regular expression Parameters:

pattern (String): regular expression pattern
case (Bool): if False, ignore case
flags (Int): flags for the re module

udf normalize()

normalize(self: String, form: String) -> String

Return the Unicode normal form. Equivalent to unicodedata.normalize() Parameters:

form (String): Unicode normal form ('NFC', 'NFKC', 'NFD', 'NFKD')

udf pad()

pad(
    self: String,
    width: Int,
    side: String = 'left',
    fillchar: String = ' '
) -> String

Pad string up to width Parameters:

width (Int): Minimum width of resulting string; additional characters will be filled with character defined in fillchar.
side (String): Side from which to fill resulting string ('left', 'right', 'both')
fillchar (String): Additional character for filling

udf partition()

partition(self: String, sep: String = ' ') -> Json

Splits string at the first occurrence of sep, and returns 3 elements containing the part before the separator, the separator itself, and the part after the separator. If the separator is not found, return 3 elements containing string itself, followed by two empty strings.

udf removeprefix()

removeprefix(self: String, prefix: String) -> String

Remove prefix. If the prefix is not present, returns string.

udf removesuffix()

removesuffix(self: String, suffix: String) -> String

Remove suffix. If the suffix is not present, returns string.

udf repeat()

repeat(self: String, n: Int) -> String

Repeat string n times.

udf replace()

replace(
    self: String,
    substr: String,
    repl: String,
    n: Int | None = None
) -> String

Replace occurrences of substr with repl. Equivalent to str.replace(). Parameters:

substr (String): string literal
repl (String): replacement string
n (Int | None): number of replacements to make (if None, replace all occurrences)

udf replace_re()

replace_re(
    self: String,
    pattern: String,
    repl: String,
    n: Int | None = None,
    flags: Int = 0
) -> String

Replace occurrences of a regular expression pattern with repl. Equivalent to re.sub(). Parameters:

pattern (String): regular expression pattern
repl (String): replacement string
n (Int | None): number of replacements to make (if None, replace all occurrences)
flags (Int): flags for the re module

udf reverse()

reverse(self: String) -> String

Return a reversed copy of the string. Equivalent to str[::-1].

udf rfind()

rfind(
    self: String,
    substr: String,
    start: Int | None = 0,
    end: Int | None = None
) -> Int

Return the highest index where substr is found, such that substr is contained within [start:end]. Equivalent to str.rfind(). Parameters:

substr (String): substring to search for
start (Int | None): slice start
end (Int | None): slice end

udf rindex()

rindex(
    self: String,
    substr: String,
    start: Int | None = 0,
    end: Int | None = None
) -> Int

Return the highest index where substr is found, such that substr is contained within [start:end]. Raises ValueError if substr is not found. Equivalent to str.rindex().

udf rjust()

rjust(self: String, width: Int, fillchar: String = ' ') -> String

Return the string right-justified in a string of length width. Equivalent to str.rjust(). Parameters:

width (Int): Minimum width of resulting string.
fillchar (String): Additional character for filling.

udf rpartition()

rpartition(self: String, sep: String = ' ') -> Json

This method splits string at the last occurrence of sep, and returns a list containing the part before the separator, the separator itself, and the part after the separator.

udf rstrip()

rstrip(self: String, chars: String | None = None) -> String

Return a copy of string with trailing characters removed. Equivalent to str.rstrip(). Parameters:

chars (String | None): The set of characters to be removed. If omitted or None, whitespace characters are removed.

udf slice()

slice(
    self: String,
    start: Int | None = None,
    stop: Int | None = None,
    step: Int | None = None
) -> String

Return a slice. Parameters:

start (Int | None): slice start
stop (Int | None): slice end
step (Int | None): slice step

udf slice_replace()

slice_replace(
    self: String,
    start: Int | None = None,
    stop: Int | None = None,
    repl: String | None = None
) -> String

Replace a positional slice with another value. Parameters:

start (Int | None): slice start
stop (Int | None): slice end
repl (String | None): replacement value

udf startswith()

startswith(self: String, substr: String) -> Int

Return True if string starts with substr, otherwise return False. Equivalent to str.startswith(). Parameters:

substr (String): string literal

udf strip()

strip(self: String, chars: String | None = None) -> String

Return a copy of string with leading and trailing characters removed. Equivalent to str.strip(). Parameters:

chars (String | None): The set of characters to be removed. If omitted or None, whitespace characters are removed.

udf swapcase()

swapcase(self: String) -> String

Return a copy of string with uppercase characters converted to lowercase and vice versa. Equivalent to str.swapcase().

udf title()

title(self: String) -> String

Return a titlecased version of string, i.e. words start with uppercase characters, all remaining cased characters are lowercase. Equivalent to str.title().

udf upper()

upper(self: String) -> String

Return a copy of string converted to uppercase. Equivalent to str.upper().

udf wrap()

wrap(self: String, width: Int) -> Json

Wraps the single paragraph in string so every line is at most width characters long. Returns a list of output lines, without final newlines. Equivalent to textwrap.fill(). Parameters:

width (Int): Maximum line width.
kwargs (Any): Additional keyword arguments to pass to textwrap.fill().

​module pixeltable.functions.string

​udf capitalize()

​udf casefold()

​udf center()

​udf contains()

​udf contains_re()

​udf count()

​udf endswith()

​udf fill()

​udf find()

​udf findall()

​udf format()

​udf fullmatch()

​udf index()

​udf isalnum()

​udf isalpha()

​udf isascii()

​udf isdecimal()

​udf isdigit()

​udf isidentifier()

​udf islower()

​udf isnumeric()

​udf isspace()

​udf istitle()

​udf isupper()

​udf join()

​udf len()

​udf ljust()

​udf lower()

​udf lstrip()

​udf match()

​udf normalize()

​udf pad()

​udf partition()

​udf removeprefix()

​udf removesuffix()

​udf repeat()

​udf replace()

​udf replace_re()

​udf reverse()

​udf rfind()

​udf rindex()

​udf rjust()

​udf rpartition()

​udf rstrip()

​udf slice()

​udf slice_replace()

​udf startswith()

​udf strip()

​udf swapcase()

​udf title()

​udf upper()

​udf wrap()