ChannelId Class

A ChannelId represents a channel and optional sub-channel in the format 'channel:sub_channel'.

Constructor

ChannelId()

Parameters

Name	Description
value	Default value: None

Keyword-Only Parameters

Name	Description
channel	Default value: None
sub_channel	Default value: None

Methods

__init__	Initialize a ChannelId instance.
__new__	Create a new ChannelId instance.
capitalize	Return a capitalized version of the string. More specifically, make the first character have upper case and the rest lower case.
casefold	Return a version of the string suitable for caseless comparisons.
center	Return a centered string of length width. Padding is done using the specified fill character (default is a space).
count	Return the number of non-overlapping occurrences of substring sub in string S[start:end]. Optional arguments start and end are interpreted as in slice notation.
encode	Encode the string using the codec registered for encoding. encoding The encoding in which to encode the string. errors The error handling scheme to use for encoding errors. The default is 'strict' meaning that encoding errors raise a UnicodeEncodeError. Other possible values are 'ignore', 'replace' and 'xmlcharrefreplace' as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.
endswith	Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.
expandtabs	Return a copy where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.
find	Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation. Return -1 on failure.
format	Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces ('{' and '}').
format_map	Return a formatted version of S, using substitutions from mapping. The substitutions are identified by braces ('{' and '}').
index	Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation. Raises ValueError when the substring is not found.
isalnum	Return True if the string is an alpha-numeric string, False otherwise. A string is alpha-numeric if all characters in the string are alpha-numeric and there is at least one character in the string.
isalpha	Return True if the string is an alphabetic string, False otherwise. A string is alphabetic if all characters in the string are alphabetic and there is at least one character in the string.
isascii	Return True if all characters in the string are ASCII, False otherwise. ASCII characters have code points in the range U+0000-U+007F. Empty string is ASCII too.
isdecimal	Return True if the string is a decimal string, False otherwise. A string is a decimal string if all characters in the string are decimal and there is at least one character in the string.
isdigit	Return True if the string is a digit string, False otherwise. A string is a digit string if all characters in the string are digits and there is at least one character in the string.
isidentifier	Return True if the string is a valid Python identifier, False otherwise. Call keyword.iskeyword(s) to test whether string s is a reserved identifier, such as "def" or "class".
islower	Return True if the string is a lowercase string, False otherwise. A string is lowercase if all cased characters in the string are lowercase and there is at least one cased character in the string.
isnumeric	Return True if the string is a numeric string, False otherwise. A string is numeric if all characters in the string are numeric and there is at least one character in the string.
isprintable	Return True if the string is printable, False otherwise. A string is printable if all of its characters are considered printable in repr() or if it is empty.
isspace	Return True if the string is a whitespace string, False otherwise. A string is whitespace if all characters in the string are whitespace and there is at least one character in the string.
istitle	Return True if the string is a title-cased string, False otherwise. In a title-cased string, upper- and title-case characters may only follow uncased characters and lowercase characters only cased ones.
isupper	Return True if the string is an uppercase string, False otherwise. A string is uppercase if all cased characters in the string are uppercase and there is at least one cased character in the string.
join	Concatenate any number of strings. The string whose method is called is inserted in between each given string. The result is returned as a new string. Example: '.'.join(['ab', 'pq', 'rs']) -> 'ab.pq.rs'
ljust	Return a left-justified string of length width. Padding is done using the specified fill character (default is a space).
lower	Return a copy of the string converted to lowercase.
lstrip	Return a copy of the string with leading whitespace removed. If chars is given and not None, remove characters in chars instead.
maketrans	Return a translation table usable for str.translate(). If there is only one argument, it must be a dictionary mapping Unicode ordinals (integers) or characters to Unicode ordinals, strings or None. Character keys will be then converted to ordinals. If there are two arguments, they must be strings of equal length, and in the resulting dictionary, each character in x will be mapped to the character at the same position in y. If there is a third argument, it must be a string, whose characters will be mapped to None in the result.
partition	Partition the string into three parts using the given separator. This will search for the separator in the string. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it. If the separator is not found, returns a 3-tuple containing the original string and two empty strings.
removeprefix	Return a str with the given prefix string removed if present. If the string starts with the prefix string, return string[len(prefix):]. Otherwise, return a copy of the original string.
removesuffix	Return a str with the given suffix string removed if present. If the string ends with the suffix string and that suffix is not empty, return string[:-len(suffix)]. Otherwise, return a copy of the original string.
replace	Return a copy with all occurrences of substring old replaced by new. count Maximum number of occurrences to replace. -1 (the default value) means replace all occurrences. If the optional argument count is given, only the first count occurrences are replaced.
rfind	Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation. Return -1 on failure.
rindex	Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation. Raises ValueError when the substring is not found.
rjust	Return a right-justified string of length width. Padding is done using the specified fill character (default is a space).
rpartition	Partition the string into three parts using the given separator. This will search for the separator in the string, starting at the end. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it. If the separator is not found, returns a 3-tuple containing two empty strings and the original string.
rsplit	Return a list of the substrings in the string, using sep as the separator string. sep The separator used to split the string. When set to None (the default value), will split on any whitespace character (including n r t f and spaces) and will discard empty strings from the result. maxsplit Maximum number of splits. -1 (the default value) means no limit. Splitting starts at the end of the string and works to the front.
rstrip	Return a copy of the string with trailing whitespace removed. If chars is given and not None, remove characters in chars instead.
split	Return a list of the substrings in the string, using sep as the separator string. sep The separator used to split the string. When set to None (the default value), will split on any whitespace character (including n r t f and spaces) and will discard empty strings from the result. maxsplit Maximum number of splits. -1 (the default value) means no limit. Splitting starts at the front of the string and works to the end. Note, str.split() is mainly useful for data that has been intentionally delimited. With natural text that includes punctuation, consider using the regular expression module.
splitlines	Return a list of the lines in the string, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.
startswith	Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.
strip	Return a copy of the string with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead.
swapcase	Convert uppercase characters to lowercase and lowercase characters to uppercase.
title	Return a version of the string where each word is titlecased. More specifically, words start with uppercased characters and all remaining cased characters have lower case.
translate	Replace each character in the string using the given translation table. table Translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, strings, or None. The table must implement lookup/indexing via getitem, for instance a dictionary or list. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.
upper	Return a copy of the string converted to uppercase.
zfill	Pad a numeric string with zeros on the left, to fill a field of the given width. The string is never truncated.

__init__

Initialize a ChannelId instance.

__init__(value: str | None = None, *, channel: str | None = None, sub_channel: str | None = None) -> None

Parameters

Name	Description
value	str | None The full channel ID string in the format 'channel:sub_channel'. Must be provided if channel is not provided. Default value: None
channel Required	str | None The main channel string. Must be provided if value is not provided.
sub_channel Required	str | None The sub-channel string.

Keyword-Only Parameters

Name	Description
channel	Default value: None
sub_channel	Default value: None

Returns

Type	Description
None

Exceptions

Type	Description
ValueError	If the input parameters are invalid. value and channel cannot both be provided.

__new__

Create a new ChannelId instance.

static __new__(cls, value: str | None = None, *, channel: str | None = None, sub_channel: str | None = None) -> ChannelId

Parameters

Name	Description
value	str | None The full channel ID string in the format 'channel:sub_channel'. Must be provided if channel is not provided. Default value: None
channel Required	str | None The main channel string. Must be provided if value is not provided. Must not contain ':', as it delimits channels and sub channels.
sub_channel Required	str | None The sub-channel string.

Keyword-Only Parameters

Name	Description
channel	Default value: None
sub_channel	Default value: None

Returns

Type	Description
ChannelId	A new ChannelId instance.

Exceptions

Type	Description
ValueError	If the input parameters are invalid. value and channel cannot both be provided.

capitalize

Return a capitalized version of the string.

More specifically, make the first character have upper case and the rest lower case.

capitalize()

casefold

Return a version of the string suitable for caseless comparisons.

casefold()

center

Return a centered string of length width.

Padding is done using the specified fill character (default is a space).

center(width, fillchar=' ', /)

Positional-Only Parameters

Name	Description
width Required
fillchar	Default value:

count

Return the number of non-overlapping occurrences of substring sub in string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

count(sub, [start, [end]]) -> int

encode

Encode the string using the codec registered for encoding.

encoding The encoding in which to encode the string.

errors The error handling scheme to use for encoding errors. The default is 'strict' meaning that encoding errors raise a UnicodeEncodeError. Other possible values are 'ignore', 'replace' and 'xmlcharrefreplace' as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

encode(encoding='utf-8', errors='strict')

Parameters

Name	Description
encoding	Default value: utf-8
errors	Default value: strict

endswith

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

endswith(suffix, [start, [end]]) -> bool

expandtabs

Return a copy where all tab characters are expanded using spaces.

If tabsize is not given, a tab size of 8 characters is assumed.

expandtabs(tabsize=8)

Parameters

Name	Description
tabsize	Default value: 8

find

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

find(sub, [start, [end]]) -> int

format

Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces ('{' and '}').

format(*args, **kwargs) -> str

format_map

Return a formatted version of S, using substitutions from mapping. The substitutions are identified by braces ('{' and '}').

format_map(mapping) -> str

index

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

index(sub, [start, [end]]) -> int

isalnum

Return True if the string is an alpha-numeric string, False otherwise.

A string is alpha-numeric if all characters in the string are alpha-numeric and there is at least one character in the string.

isalnum()

isalpha

Return True if the string is an alphabetic string, False otherwise.

A string is alphabetic if all characters in the string are alphabetic and there is at least one character in the string.

isalpha()

isascii

Return True if all characters in the string are ASCII, False otherwise.

ASCII characters have code points in the range U+0000-U+007F. Empty string is ASCII too.

isascii()

isdecimal

Return True if the string is a decimal string, False otherwise.

A string is a decimal string if all characters in the string are decimal and there is at least one character in the string.

isdecimal()

isdigit

Return True if the string is a digit string, False otherwise.

A string is a digit string if all characters in the string are digits and there is at least one character in the string.

isdigit()

isidentifier

Return True if the string is a valid Python identifier, False otherwise.

Call keyword.iskeyword(s) to test whether string s is a reserved identifier, such as "def" or "class".

isidentifier()

islower

Return True if the string is a lowercase string, False otherwise.

A string is lowercase if all cased characters in the string are lowercase and there is at least one cased character in the string.

islower()

isnumeric

Return True if the string is a numeric string, False otherwise.

A string is numeric if all characters in the string are numeric and there is at least one character in the string.

isnumeric()

isprintable

Return True if the string is printable, False otherwise.

A string is printable if all of its characters are considered printable in repr() or if it is empty.

isprintable()

isspace

Return True if the string is a whitespace string, False otherwise.

A string is whitespace if all characters in the string are whitespace and there is at least one character in the string.

isspace()

istitle

Return True if the string is a title-cased string, False otherwise.

In a title-cased string, upper- and title-case characters may only follow uncased characters and lowercase characters only cased ones.

istitle()

isupper

Return True if the string is an uppercase string, False otherwise.

A string is uppercase if all cased characters in the string are uppercase and there is at least one cased character in the string.

isupper()

join

Concatenate any number of strings.

The string whose method is called is inserted in between each given string. The result is returned as a new string.

Example: '.'.join(['ab', 'pq', 'rs']) -> 'ab.pq.rs'

join(iterable, /)

Positional-Only Parameters

Name	Description
iterable Required

ljust

Return a left-justified string of length width.

Padding is done using the specified fill character (default is a space).

ljust(width, fillchar=' ', /)

Positional-Only Parameters

Name	Description
width Required
fillchar	Default value:

lower

Return a copy of the string converted to lowercase.

lower()

lstrip

Return a copy of the string with leading whitespace removed.

If chars is given and not None, remove characters in chars instead.

lstrip(chars=None, /)

Positional-Only Parameters

Name	Description
chars	Default value: None

maketrans

Return a translation table usable for str.translate().

If there is only one argument, it must be a dictionary mapping Unicode ordinals (integers) or characters to Unicode ordinals, strings or None. Character keys will be then converted to ordinals. If there are two arguments, they must be strings of equal length, and in the resulting dictionary, each character in x will be mapped to the character at the same position in y. If there is a third argument, it must be a string, whose characters will be mapped to None in the result.

static maketrans()

partition

Partition the string into three parts using the given separator.

This will search for the separator in the string. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing the original string and two empty strings.

partition(sep, /)

Positional-Only Parameters

Name	Description
sep Required

removeprefix

Return a str with the given prefix string removed if present.

If the string starts with the prefix string, return string[len(prefix):]. Otherwise, return a copy of the original string.

removeprefix(prefix, /)

Positional-Only Parameters

Name	Description
prefix Required

removesuffix

Return a str with the given suffix string removed if present.

If the string ends with the suffix string and that suffix is not empty, return string[:-len(suffix)]. Otherwise, return a copy of the original string.

removesuffix(suffix, /)

Positional-Only Parameters

Name	Description
suffix Required

replace

Return a copy with all occurrences of substring old replaced by new.

count Maximum number of occurrences to replace. -1 (the default value) means replace all occurrences.

If the optional argument count is given, only the first count occurrences are replaced.

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

Positional-Only Parameters

Name	Description
old Required
new Required
count	Default value: -1

rfind

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rfind(sub, [start, [end]]) -> int

rindex

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

rindex(sub, [start, [end]]) -> int

rjust

Return a right-justified string of length width.

Padding is done using the specified fill character (default is a space).

rjust(width, fillchar=' ', /)

Positional-Only Parameters

Name	Description
width Required
fillchar	Default value:

rpartition

Partition the string into three parts using the given separator.

This will search for the separator in the string, starting at the end. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing two empty strings and the original string.

rpartition(sep, /)

Positional-Only Parameters

Name	Description
sep Required

rsplit

Return a list of the substrings in the string, using sep as the separator string.

sep The separator used to split the string.

  When set to None (the default value), will split on any whitespace
  character (including n r t f and spaces) and will discard
  empty strings from the result.

maxsplit Maximum number of splits. -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rsplit(sep=None, maxsplit=-1)

Parameters

Name	Description
sep	Default value: None
maxsplit	Default value: -1

rstrip

Return a copy of the string with trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

rstrip(chars=None, /)

Positional-Only Parameters

Name	Description
chars	Default value: None

split

Return a list of the substrings in the string, using sep as the separator string.

sep The separator used to split the string.

  When set to None (the default value), will split on any whitespace
  character (including n r t f and spaces) and will discard
  empty strings from the result.

maxsplit Maximum number of splits. -1 (the default value) means no limit.

Splitting starts at the front of the string and works to the end.

Note, str.split() is mainly useful for data that has been intentionally delimited. With natural text that includes punctuation, consider using the regular expression module.

split(sep=None, maxsplit=-1)

Parameters

Name	Description
sep	Default value: None
maxsplit	Default value: -1

splitlines

Return a list of the lines in the string, breaking at line boundaries.

Line breaks are not included in the resulting list unless keepends is given and true.

splitlines(keepends=False)

Parameters

Name	Description
keepends	Default value: False

startswith

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

startswith(prefix, [start, [end]]) -> bool

strip

Return a copy of the string with leading and trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

strip(chars=None, /)

Positional-Only Parameters

Name	Description
chars	Default value: None

swapcase

Convert uppercase characters to lowercase and lowercase characters to uppercase.

swapcase()

title

Return a version of the string where each word is titlecased.

More specifically, words start with uppercased characters and all remaining cased characters have lower case.

title()

translate

Replace each character in the string using the given translation table.

table Translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, strings, or None.

The table must implement lookup/indexing via getitem, for instance a dictionary or list. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.

translate(table, /)

Positional-Only Parameters

Name	Description
table Required

upper

Return a copy of the string converted to uppercase.

upper()

zfill

Pad a numeric string with zeros on the left, to fill a field of the given width.

The string is never truncated.

zfill(width, /)

Positional-Only Parameters

Name	Description
width Required

Attributes

channel

work'.

sub_channel

work'. May be None.