String

Collection

Store text written in quotes or converted with str(value). Strings cannot be changed in place; string methods return new values. Positions and length count Unicode code points: an emoji is one position, but a letter with a separate accent or a joined emoji can use several.

Syntax

String

This class cannot be constructed directly.

Returns

—

Example

name = "Start"
if name:
    first_char = name[0]
    text(first_char)

Methods

24 methods

String.literal

Creation Method

Create text directly with single or double quotes.

Syntax

"hello"

Parameters

Name	Description
`textString`	String content between quotes. Required · Positional or named No default

Returns

String — A new string value.

Example

label = "Start"
text(label)

String.cast

Creation Method

Convert a value to text. Large collections or deeply nested values are shortened with markers showing omitted content; a string passed directly is unchanged.

Syntax

str(value, /)

Parameters

Name	Description
`valueAny?`	Value to convert into text. Required · Positional only No default

Returns

String — Converted text value.

Example

attempt = 3
line = str(attempt)

String.length

Method

Count how many characters are in the string.

Syntax

len(string, /)

Parameters

Name	Description
`stringString`	String value to count. Required · Positional only No default

Returns

Int — Character count.

Example

label = "Play"
count = len(label)        # returns 4

String.index_access

Method

Read one character by position, starting at 0. Negative indexes count from the end: -1 is the last position.

Syntax

string[index]

Parameters

Name	Description
`stringString`	Source string. Required · Positional or named No default
`indexInt`	Character position: 0 is first, -1 is last. Required · Positional only No default

Returns

String — One-character string. Raises IndexError when the position is outside the string.

Example

label = "Play"
first = label[0]          # returns 'P'
last = label[-1]          # returns 'y'

String.slice

Method

Return a new string from start up to, but not including, end. Negative indexes count from the end. Omitted bounds select the whole string in the step direction.

Syntax

string[start:end[:step]]

Parameters

Name	Description
`startInt?`	First character index to include. Optional · Positional only Default: `start of string`
`endInt`	Stop before this character index. Optional · Positional only Default: `end of string`
`stepInt`	Distance between characters. Cannot be 0; negative values read backward. Optional · Positional only Default: `1`

Returns

String — A new string slice, clamped to the available range.

Example

label = "abcdef"
middle = label[1:4]       # returns 'bcd'
tail = label[-3:]         # returns 'def'
reverse = label[::-1]     # returns 'fedcba'

String.lower_method

Method

Return a lowercase copy of the string.

Syntax

string.lower()

Returns

String — Lowercase string.

Example

label = "PLAY"
text(label.lower())

String.upper_method

Method

Return an uppercase copy of the string.

Syntax

string.upper()

Returns

String — Uppercase string.

Example

label = "play"
text(label.upper())

String.strip_method

Method

Trim whitespace, or the provided characters, from both ends.

Syntax

string.strip(chars=None, /)

Parameters

Name	Description
`charsString?`	Remove any of these characters repeatedly at the selected ends, not the whole chars string as a prefix or suffix. Optional · Positional only Default: `None`

Returns

String — Trimmed string.

Example

label = "  Play  "
clean = label.strip()

String.lstrip_method

Method

Trim whitespace, or the provided characters, from the left side.

Syntax

string.lstrip(chars=None, /)

Parameters

Name	Description
`charsString?`	Remove any of these characters repeatedly at the selected ends, not the whole chars string as a prefix or suffix. Optional · Positional only Default: `None`

Returns

String — Left-trimmed string.

Example

label = "...Play"
clean = label.lstrip(".")

String.rstrip_method

Method

Trim whitespace, or the provided characters, from the right side.

Syntax

string.rstrip(chars=None, /)

Parameters

Name	Description
`charsString?`	Remove any of these characters repeatedly at the selected ends, not the whole chars string as a prefix or suffix. Optional · Positional only Default: `None`

Returns

String — Right-trimmed string.

Example

label = "Play..."
clean = label.rstrip(".")

String.startswith_method

Method

Check whether the selected part starts with prefix, with case preserved.

Syntax

string.startswith(prefix, start=0, stop=len(string), /)

Parameters

Name	Description
`prefixString \| tuple`	Text, or a tuple of possible texts; True if any matches the beginning. Required · Positional only No default
`startInt?`	First position to include, starting at 0. Negative values count from the end; out-of-range bounds are limited to the available range. Optional · Positional only Default: `0`
`stopInt?`	Stop before this position. Negative values count from the end; out-of-range bounds are limited to the available range. Optional · Positional only Default: `len(string)`

Returns

Boolean — true when the prefix matches.

Example

label = "Play"
ready = label.startswith("Pl")

String.endswith_method

Method

Check whether the selected part ends with suffix, with case preserved.

Syntax

string.endswith(suffix, start=0, stop=len(string), /)

Parameters

Name	Description
`suffixString \| tuple`	Text, or a tuple of possible texts; True if any matches the end. Required · Positional only No default
`startInt?`	First position to include, starting at 0. Negative values count from the end; out-of-range bounds are limited to the available range. Optional · Positional only Default: `0`
`stopInt?`	Stop before this position. Negative values count from the end; out-of-range bounds are limited to the available range. Optional · Positional only Default: `len(string)`

Returns

Boolean — true when the suffix matches.

Example

label = "Play"
ready = label.endswith("ay")

String.find_method

Method

Find the first substring index, or return -1 when absent.

Syntax

string.find(sub, start=0, stop=len(string), /)

Parameters

Name	Description
`subString`	Substring to find. Required · Positional only No default
`startInt?`	First position to search, starting at 0. Negative values count from the end; out-of-range bounds are limited to the available range. Optional · Positional only Default: `0`
`stopInt?`	Stop searching before this position. Negative values count from the end; out-of-range bounds are limited to the available range. Optional · Positional only Default: `len(string)`

Returns

Int — First matching position in the original string, starting at 0, or -1 if absent.

Example

label = "start button"
index = label.find("button")

String.index_method

Method

Return the first matching position in the original string, or raise ValueError if sub is absent from the selected part.

Syntax

string.index(sub, start=0, stop=len(string), /)

Parameters

Name	Description
`subString`	Substring that must exist. Required · Positional only No default
`startInt?`	First position to search, starting at 0. Negative values count from the end; out-of-range bounds are limited to the available range. Optional · Positional only Default: `0`
`stopInt?`	Stop searching before this position. Negative values count from the end; out-of-range bounds are limited to the available range. Optional · Positional only Default: `len(string)`

Returns

Int — First matching index.

Example

label = "start button"
index = label.index("button")

String.replace_method

Method

Return a copy with occurrences of old text replaced.

Syntax

string.replace(old, new, /, count=-1)

Parameters

Name	Description
`oldString`	Text to replace, without overlapping matches. An empty string inserts new at character boundaries, subject to count. Required · Positional only No default
`newString`	Replacement text. Required · Positional only No default
`countInt`	Maximum replacements; negative means all. Optional · Positional or named Default: `-1`

Returns

String — Updated string copy.

Example

label = "start start"
once = label.replace("start", "play", 1)

String.split_method

Method

Return a list of text parts split at sep. With sep=None, runs of whitespace form one separator and leading whitespace is skipped; after maxsplit splits, the rest is kept as one part.

Syntax

string.split(sep=None, maxsplit=-1)

Parameters

Name	Description
`sepString?`	Separator text; an empty separator raises ValueError. None splits on runs of whitespace instead. Optional · Positional or named Default: `None`
`maxsplitInt`	Maximum split count; negative means all. Optional · Positional or named Default: `-1`

Returns

list — List of string parts.

Example

raw = "a,b,c"
parts = raw.split(",")

String.join_method

Method

Join strings from a source you can loop through, placing this string between them. An item that is not a string raises an error.

Syntax

string.join(iterable, /)

Parameters

Name	Description
`iterableIterable<String>`	String values to join. Required · Positional only No default

Returns

String — Joined string.

Example

parts = ["a", "b", "c"]
line = ",".join(parts)

String.count_method

Method

Count non-overlapping substring occurrences.

Syntax

string.count(sub, start=0, stop=len(string), /)

Parameters

Name	Description
`subString`	Text to count. An empty string matches each boundary, so the count is the selected part length plus 1. Required · Positional only No default
`startInt?`	First position to count from, starting at 0. Negative values count from the end; out-of-range bounds are limited to the available range. Optional · Positional only Default: `0`
`stopInt?`	Stop counting before this position. Negative values count from the end; out-of-range bounds are limited to the available range. Optional · Positional only Default: `len(string)`

Returns

Int — Occurrence count.

Example

label = "banana"
count = label.count("an")

String.isalpha_method

Method

Check whether the string is non-empty and all characters are letters.

Syntax

string.isalpha()

Returns

Boolean — true for letters only.

Example

label = "Play"
ok = label.isalpha()

String.isdigit_method

Method

Check whether the string is non-empty and all characters are Unicode digits, including superscript and circled digits.

Syntax

string.isdigit()

Returns

Boolean — true for digits only.

Example

value = "123"
ok = value.isdigit()

String.isalnum_method

Method

Check whether the string is non-empty and every character is a Unicode letter or numeric character, including fractions.

Syntax

string.isalnum()

Returns

Boolean — True for letters or numeric characters only; False for an empty string.

Example

value = "A123"
ok = value.isalnum()

String.isspace_method

Method

Check whether the string is non-empty and all characters are whitespace.

Syntax

string.isspace()

Returns

Boolean — true for whitespace only.

Example

value = "   "
ok = value.isspace()

String.for_loop

Method

Iterate characters from left to right.

Syntax

for ch in string:

Parameters

Name	Description
`chString`	Current character in the loop. Required · Positional or named No default
`stringString`	String to iterate. Required · Positional or named No default

Returns

None — No direct return value. Executes once per character.

Example

word = "Go"
for ch in word:
    text(ch)

String.truthy_check

Method

Check whether the string is empty or not.

Syntax

if string | if not string

Parameters

Name	Description
`stringString`	String used in the condition. Required · Positional or named No default

Returns

Boolean condition — true when non-empty, false when empty.

Example

value = ""
if not value:
    text("empty")