CkStringBuilder Python Reference Documentation

CkStringBuilder

A simple class for building strings. (Represents a mutable string of characters.)

Note: This class was introduced in Chilkat v9.5.0.58.

Object Creation

obj = chilkat.CkStringBuilder()

Properties

# intVal is an integer
intVal = stringBuilder.get_IntValue();
stringBuilder.put_IntValue(intVal);

Introduced in version 9.5.0.58

Returns the content of the string converted to an integer.

# boolVal is a boolean
boolVal = stringBuilder.get_LastMethodSuccess();
stringBuilder.put_LastMethodSuccess(boolVal);

Indicate whether the last method call succeeded or failed. A value of True indicates success, a value of False indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = True and failure = False.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to True. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

# intVal is an integer
intVal = stringBuilder.get_Length();

Introduced in version 9.5.0.58

The number of characters of the string contained within this instance.

# boolVal is a boolean
boolVal = stringBuilder.get_Utf8();
stringBuilder.put_Utf8(boolVal);

When set to True, all "const char *" arguments are interpreted as utf-8 strings. If set to False (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to True, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to False, all "const char *" return values are ANSI strings.

Methods

# value is a string
status = stringBuilder.Append(value);

Introduced in version 9.5.0.58

Appends a copy of the specified string to this instance.

Returns True for success, False for failure.

# binData is a CkBinData
# charset is a string
# offset is an integer
# numBytes is an integer
status = stringBuilder.AppendBd(binData, charset, offset, numBytes);

Introduced in version 9.5.0.64

Appends the contents of binData. The charset specifies the character encoding of the bytes contained in binData. The charset can be any of the supported encodings listed at Chilkat Supported Character Encodings. To append the entire contents of binData, set offset and numBytes equal to zero. To append a range of binData, set the offset and numBytes to specify the range.

Returns True for success, False for failure.

# binaryData is a CkByteData
# encoding is a string
status = stringBuilder.AppendEncoded(binaryData, encoding);

Introduced in version 9.5.0.58

Appends binary data using the encoding specified by encoding, such as "base64", "hex", etc.

Returns True for success, False for failure.

Hash the Contents of a File (SHA256 and other hash algorithms)

# value is an integer
status = stringBuilder.AppendInt(value);

Introduced in version 9.5.0.58

Appends the string representation of a specified 32-bit signed integer to this instance.

Returns True for success, False for failure.

# value is a 64-bit integer
status = stringBuilder.AppendInt64(value);

Introduced in version 9.5.0.58

Appends the string representation of a specified 64-bit signed integer to this instance.

Returns True for success, False for failure.

# value is a string
# crlf is a boolean
status = stringBuilder.AppendLine(value, crlf);

Introduced in version 9.5.0.65

Appends the value followed by a CRLF or LF to the end of the curent StringBuilder object. If crlf is True, then a CRLF line ending is used. Otherwise a LF line ending is used.

Returns True for success, False for failure.

# sb is a CkStringBuilder
status = stringBuilder.AppendSb(sb);

Introduced in version 9.5.0.62

Appends the contents of another StringBuilder to this instance.

Returns True for success, False for failure.

stringBuilder.Clear();

Introduced in version 9.5.0.58

Removes all characters from the current StringBuilder instance.

# str is a string
# caseSensitive is a boolean
retBool = stringBuilder.Contains(str, caseSensitive);

Introduced in version 9.5.0.58

Returns True if the str is contained within this object. For case sensitive matching, set caseSensitive equal to True. For case-insensitive, set caseSensitive equal to False.

# word is a string
# caseSensitive is a boolean
retBool = stringBuilder.ContainsWord(word, caseSensitive);

Introduced in version 9.5.0.69

Returns True if the word is contained within this object, but only if it is a whole word. This method is limited to finding whole words in strings that only contains characters in the Latin1 charset (i.e. iso-8859-1 or Windows-1252). A whole word can only contain alphanumeric chars where the alpha chars are restricted to those of the Latin1 alpha chars. (The underscore character is also considered part of a word.)

For case sensitive matching, set caseSensitive equal to True. For case-insensitive, set caseSensitive equal to False.

# str is a string
# caseSensitive is a boolean
retBool = stringBuilder.ContentsEqual(str, caseSensitive);

Introduced in version 9.5.0.62

Returns True if the contents of this object equals the str. Returns False if unequal. For case insensitive equality, set caseSensitive equal to False.

# sb is a CkStringBuilder
# caseSensitive is a boolean
retBool = stringBuilder.ContentsEqualSb(sb, caseSensitive);

Introduced in version 9.5.0.62

Returns True if the contents of this object equals the sb. Returns False if unequal. For case insensitive equality, set caseSensitive equal to False.

# encoding is a string
# charset is a string
status = stringBuilder.Decode(encoding, charset);

Introduced in version 9.5.0.62

Decodes and replaces the contents with the decoded string. The encoding can be set to any of the following strings: "base64", "hex", "quoted-printable" (or "qp"), "url", "base32", "Q", "B", "url_rc1738", "url_rfc2396", "url_rfc3986", "url_oauth", "uu", "modBase64", or "html" (for HTML entity encoding). The full up-to-date list of supported binary encodings is available at the link entitled "Supported Binary Encodings" below.

Note: This method can only be called if the encoded content decodes to a string. The charset indicates the charset to be used in intepreting the decoded bytes. For example, the charset can be "utf-8", "utf-16", "iso-8859-1", "shift_JIS", etc.

Returns True for success, False for failure.

JSON Escape and Unescape a String

# encoding is a string
# charset is a string
status = stringBuilder.Encode(encoding, charset);

Introduced in version 9.5.0.62

Encodes to base64, hex, quoted-printable, URL encoding, etc. The encoding can be set to any of the following strings: "base64", "hex", "quoted-printable" (or "qp"), "url", "base32", "Q", "B", "url_rc1738", "url_rfc2396", "url_rfc3986", "url_oauth", "uu", "modBase64", or "html" (for HTML entity encoding). The full up-to-date list of supported binary encodings is available at the link entitled "Supported Binary Encodings" below.

Returns True for success, False for failure.

Supported Binary Encodings

StringBuilder Encode

UN/EDIFACT Syntax Level A Encoding/Decoding

JSON Escape and Unescape a String

# substr is a string
# caseSensitive is a boolean
retBool = stringBuilder.EndsWith(substr, caseSensitive);

Introduced in version 9.5.0.62

Returns True if the string ends with substr. Otherwise returns False. The comparison is case sensitive if caseSensitive is True, and case insensitive if caseSensitive is False.

status = stringBuilder.EntityDecode();

Introduced in version 9.5.0.62

Decodes HTML entities. See HTML entities for more information about HTML entities.

Returns True for success, False for failure.

StringBuilder EntityDecode

# searchAfter is a string
# beginMark is a string
# endMark is a string
# outStr is a CkString (output)
status = stringBuilder.GetAfterBetween(searchAfter, beginMark, endMark, outStr);
retStr = stringBuilder.getAfterBetween(searchAfter, beginMark, endMark);

Introduced in version 9.5.0.62

Begin searching after the 1st occurrence of searchAfter is found, and then return the substring found between the next occurrence of beginMark and the next occurrence of endMark.

Returns True for success, False for failure.

StringBuilder GetAfterBetween

Implement Preprocessor #include with StringBuilder

# outStr is a CkString (output)
status = stringBuilder.GetAsString(outStr);
retStr = stringBuilder.getAsString();

Introduced in version 9.5.0.58

Returns the contents as a string.

Returns True for success, False for failure.

# beginMark is a string
# endMark is a string
# outStr is a CkString (output)
status = stringBuilder.GetBetween(beginMark, endMark, outStr);
retStr = stringBuilder.getBetween(beginMark, endMark);

Introduced in version 9.5.0.62

Returns the substring found between the 1st occurrence of beginMark and the next occurrence of endMark.

Returns True for success, False for failure.

StringBuilder GetBetween

# encoding is a string
# outBytes is a CkByteData (output)
status = stringBuilder.GetDecoded(encoding, outData);

Introduced in version 9.5.0.62

Decodes and returns the decoded bytes. The encoding can be set to any of the following strings: "base64", "hex", "quoted-printable" (or "qp"), "url", "base32", "Q", "B", "url_rc1738", "url_rfc2396", "url_rfc3986", "url_oauth", "uu", "modBase64", or "html" (for HTML entity encoding). The full up-to-date list of supported binary encodings is available at the link entitled "Supported Binary Encodings" below.

Returns True for success, False for failure.

# encoding is a string
# charset is a string
# outStr is a CkString (output)
status = stringBuilder.GetEncoded(encoding, charset, outStr);
retStr = stringBuilder.getEncoded(encoding, charset);

Introduced in version 9.5.0.62

Returns the string contents encoded in an encoding such as base64, hex, quoted-printable, or URL-encoding. The encoding can be set to any of the following strings: "base64", "hex", "quoted-printable" (or "qp"), "url", "base32", "Q", "B", "url_rc1738", "url_rfc2396", "url_rfc3986", "url_oauth", "uu", "modBase64", or "html" (for HTML entity encoding). The full up-to-date list of supported binary encodings is available at the link entitled "Supported Binary Encodings" below.

Note: The Encode method modifies the content of this object. The GetEncoded method leaves this object's content unmodified.

Returns True for success, False for failure.

Supported Binary Encodings

StringBuilder GetEncoded

StringBuilder Encode Charset

# index is an integer
# delimiterChar is a string
# exceptDoubleQuoted is a boolean
# exceptEscaped is a boolean
# outStr is a CkString (output)
status = stringBuilder.GetNth(index, delimiterChar, exceptDoubleQuoted, exceptEscaped, outStr);
retStr = stringBuilder.getNth(index, delimiterChar, exceptDoubleQuoted, exceptEscaped);

Introduced in version 9.5.0.62

Returns the Nth substring in string that is a list delimted by delimiterChar. The first substring is at index 0. If exceptDoubleQuoted is True, then the delimiter char found between double quotes is not treated as a delimiter. If exceptEscaped is True, then an escaped (with a backslash) delimiter char is not treated as a delimiter.

Returns True for success, False for failure.

StringBuilder GetNth

# numLines is an integer
# bCrlf is a boolean
# outStr is a CkString (output)
status = stringBuilder.LastNLines(numLines, bCrlf, outStr);
retStr = stringBuilder.lastNLines(numLines, bCrlf);

Introduced in version 9.5.0.62

Returns the last N lines of the text. If fewer than numLines lines exists, then all of the text is returned. If bCrlf is True, then the line endings of the returned string are converted to CRLF, otherwise the line endings are converted to LF-only.

Returns True for success, False for failure.

Get the Last N Lines of a StringBuilder

# path is a string
# charset is a string
status = stringBuilder.LoadFile(path, charset);

Introduced in version 9.5.0.62

Loads the contents of a file.

Returns True for success, False for failure.

# value is a string
status = stringBuilder.Prepend(value);

Introduced in version 9.5.0.61

Prepends a copy of the specified string to this instance.

Returns True for success, False for failure.

status = stringBuilder.PunyDecode();

Introduced in version 9.5.0.71

In-place decodes the string from punycode.

Returns True for success, False for failure.

status = stringBuilder.PunyEncode();

Introduced in version 9.5.0.71

In-place encodes the string to punycode.

Returns True for success, False for failure.

# value is a string
# replacement is a string
retInt = stringBuilder.Replace(value, replacement);

Introduced in version 9.5.0.58

Replaces all occurrences of a specified string in this instance with another specified string. Returns the number of replacements.

# beginMark is a string
# endMark is a string
# replacement is a string
# replaceMarks is a boolean
status = stringBuilder.ReplaceAllBetween(beginMark, endMark, replacement, replaceMarks);

Introduced in version 9.5.0.64

Replaces the first occurrence of the content found between beginMark and endMark with replacement. The beginMark and endMark are included in what is replaced if replaceMarks is True.

Returns True for success, False for failure.

Implement Preprocessor #include with StringBuilder

# beginMark is a string
# endMark is a string
# value is a string
# replacement is a string
retInt = stringBuilder.ReplaceBetween(beginMark, endMark, value, replacement);

Introduced in version 9.5.0.62

Replaces all occurrences of value with replacement, but only where value is found between beginMark and endMark. Returns the number of replacements made.

StringBuilder ReplaceBetween

# value is a string
# replacement is an integer
retInt = stringBuilder.ReplaceI(value, replacement);

Introduced in version 9.5.0.67

Replaces all occurrences of value with the decimal integer replacement. Returns the number of replacements.

# value is a string
# replacement is a string
retInt = stringBuilder.ReplaceWord(value, replacement);

Introduced in version 9.5.0.62

Replaces all word occurrences of a specified string in this instance with another specified string. Returns the number of replacements made.

Important: This method is limited to replacing whole words in strings that only contains characters in the Latin1 charset (i.e. iso-8859-1 or Windows-1252). A whole word can only contain alphanumeric chars where the alpha chars are restricted to those of the Latin1 alpha chars. (The underscore character is also considered part of a word.)

StringBuilder ReplaceWord

stringBuilder.SecureClear();

Introduced in version 9.5.0.67

Removes all characters from the current StringBuilder instance, and write zero bytes to the allocated memory before deallocating.

# index is an integer
# value is a string
# delimiterChar is a string
# exceptDoubleQuoted is a boolean
# exceptEscaped is a boolean
status = stringBuilder.SetNth(index, value, delimiterChar, exceptDoubleQuoted, exceptEscaped);

Introduced in version 9.5.0.62

Sets the Nth substring in string in a list delimted by delimiterChar. The first substring is at index 0. If exceptDoubleQuoted is True, then the delimiter char found between double quotes is not treated as a delimiter. If exceptEscaped is True, then an escaped (with a backslash) delimiter char is not treated as a delimiter.

Returns True for success, False for failure.

StringBuilder SetNth

# value is a string
status = stringBuilder.SetString(value);

Introduced in version 9.5.0.61

Sets this instance to a copy of the specified string.

Returns True for success, False for failure.

# substr is a string
# caseSensitive is a boolean
retBool = stringBuilder.StartsWith(substr, caseSensitive);

Introduced in version 9.5.0.62

Returns True if the string starts with substr. Otherwise returns False. The comparison is case sensitive if caseSensitive is True, and case insensitive if caseSensitive is False.

status = stringBuilder.ToCRLF();

Introduced in version 9.5.0.62

Converts line endings to CRLF (Windows) format.

Returns True for success, False for failure.

status = stringBuilder.ToLF();

Introduced in version 9.5.0.62

Converts line endings to LF-only (UNIX) format.

Returns True for success, False for failure.

status = stringBuilder.ToLowercase();

Introduced in version 9.5.0.62

Converts the contents to lowercase.

Returns True for success, False for failure.

status = stringBuilder.ToUppercase();

Introduced in version 9.5.0.62

Converts the contents to uppercase.

Returns True for success, False for failure.

status = stringBuilder.Trim();

Introduced in version 9.5.0.62

Trims whitespace from both ends of the string.

Returns True for success, False for failure.

status = stringBuilder.TrimInsideSpaces();

Introduced in version 9.5.0.62

Replaces all tabs, CR's, and LF's, with SPACE chars, and removes extra SPACE's so there are no occurances of more than one SPACE char in a row.

Returns True for success, False for failure.

# path is a string
# charset is a string
# emitBom is a boolean
status = stringBuilder.WriteFile(path, charset, emitBom);

Introduced in version 9.5.0.62

Writes the contents to a file. If emitBom is True, then the BOM (also known as a preamble), is emitted for charsets that define a BOM (such as utf-8, utf-16, utf-32, etc.)

Returns True for success, False for failure.