Python: package IndexedRedis.fields

IndexedRedis.fields

Package Contents

FieldValueTypes
b64
bytes_field
chain
classic
compressed
fixedpoint
foreign
null
pickle_field
raw
unicode_field

Classes



builtins.str(builtins.object)

IRField

IndexedRedis.fields.b64.IRBase64Field
IndexedRedis.fields.bytes_field.IRBytesField
IndexedRedis.fields.classic.IRClassicField
IndexedRedis.fields.compressed.IRCompressedField
IndexedRedis.fields.fixedpoint.IRFixedPointField
IndexedRedis.fields.foreign.IRForeignLinkFieldBase

IndexedRedis.fields.foreign.IRForeignLinkField

IndexedRedis.fields.foreign.IRForeignMultiLinkField

IndexedRedis.fields.pickle_field.IRPickleField
IndexedRedis.fields.raw.IRRawField
IndexedRedis.fields.unicode_field.IRUnicodeField

IndexedRedis.fields.null.IRNullType

builtins.type(builtins.object)

IndexedRedis.fields.FieldValueTypes.IRJsonValue

datetime.datetime(datetime.date)

IndexedRedis.fields.FieldValueTypes.IRDatetimeValue

class IRBase64Field(IndexedRedis.fields.IRField)

    IRBase64Field - Encode/Decode data automatically into base64 for storage and from for retrieval. Data will be found on the object in bytes format (right after assignment, after fetching, etc). To convert to another format,   use an IRFieldChain.   Like, use it with an IRUnicodeField as the far left to have it be a utf-16 value, or use IRField(valueType=str) for a string, or IRField(valueType=int) for int, etc.   An IRBytesField is indexable and the index is forced to be hashed

Method resolution order:

IRBase64Field

IndexedRedis.fields.IRField

builtins.str

builtins.object

Methods defined here:

__init__(self, name='', defaultValue=irNull, encoding=None)
__init__ - Create an IRBase64Field object. @param name <str> - Field name @param defaultValue <any> (Default irNull) - Default value of field @param encoding <None/str> (default None) - An explicit encoding to use when converting to bytes. If None, the global defaultIREncoding will be used. An IRBytesField is indexable and the index is forced to be hashed

copy(self)
copy - Create a copy of this IRField.   Each subclass should implement this, as you'll need to pass in the args to constructor. @return <IRField (or subclass)> - Another IRField that has all the same values as this one.

Static methods defined here:

__new__(self, name='', defaultValue=irNull, encoding=None)
Create and return a new object.  See help(type) for accurate signature.

Data and other attributes defined here:

CAN_INDEX = True

hashIndex = True

Methods inherited from IndexedRedis.fields.IRField:

__repr__(self)
__repr__ - Return an object-representation string of this field instance. You should NOT need to extend this on your IRField, instead just implement _getReprProperties   to return your type's specific properties associated with this instance.   @see _getReprProperties

convert = _deprecated_wrapper(*args, **kwargs)

fromInput(self, value)
fromInput - Convert the value from input (like assigning this through constructor or as an item assignment on the object @param value - Value to convert @return - Converted value

fromStorage(self, value)
fromStorage - Convert the value from storage to the value type. @param value - Value to convert @return - The converted value

getDefaultValue(self)
getDefaultValue - Gets the default value associated with this field.   This is the value used when no value has been explicitly set.   @return - The default value

toIndex(self, value)
toIndex - An optional method which will return the value prepped for index. By default, "toStorage" will be called. If you provide "hashIndex=True" on the constructor, the field will be md5summed for indexing purposes. This is useful for large strings, etc.

toStorage(self, value)
toStorage - Convert the value to a string representation for storage.   The default implementation will work here for basic types. @param value - The value of the item to convert @return A string value suitable for storing.

Data descriptors inherited from IndexedRedis.fields.IRField:

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

isIndexHashed

isIndexHashed - Returns if the index value should be hashed @return <bool> - True if this field should be hashed before indexing / filtering

name

name - Property, return this field's name @return <str> - Field name

Data and other attributes inherited from IndexedRedis.fields.IRField:

defaultValue = irNull

Methods inherited from builtins.str:

__add__(self, value, /)
Return self+value.

__contains__(self, key, /)
Return key in self.

__eq__(self, value, /)
Return self==value.

__format__(...)
S.__format__(format_spec) -> str Return a formatted version of S as described by format_spec.

__ge__(self, value, /)
Return self>=value.

__getattribute__(self, name, /)
Return getattr(self, name).

__getitem__(self, key, /)
Return self[key].

__getnewargs__(...)

__gt__(self, value, /)
Return self>value.

__hash__(self, /)
Return hash(self).

__iter__(self, /)
Implement iter(self).

__le__(self, value, /)
Return self<=value.

__len__(self, /)
Return len(self).

__lt__(self, value, /)
Return self<value.

__mod__(self, value, /)
Return self%value.

__mul__(self, value, /)
Return self*value.n

__ne__(self, value, /)
Return self!=value.

__rmod__(self, value, /)
Return value%self.

__rmul__(self, value, /)
Return self*value.

__sizeof__(...)
S.__sizeof__() -> size of S in memory, in bytes

__str__(self, /)
Return str(self).

capitalize(...)
S.capitalize() -> str Return a capitalized version of S, i.e. make the first character have upper case and the rest lower case.

casefold(...)
S.casefold() -> str Return a version of S suitable for caseless comparisons.

center(...)
S.center(width[, fillchar]) -> str Return S centered in a string of length width. Padding is done using the specified fill character (default is a space)

count(...)
S.count(sub[, start[, end]]) -> int 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(...)
S.encode(encoding='utf-8', errors='strict') -> bytes Encode S using the codec registered for encoding. Default encoding is 'utf-8'. errors may be given to set a different error handling scheme. 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(...)
S.endswith(suffix[, start[, end]]) -> bool 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(...)
S.expandtabs(tabsize=8) -> str Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find(...)
S.find(sub[, start[, end]]) -> int 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(...)
S.format(*args, **kwargs) -> str Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces ('{' and '}').

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

index(...)
S.index(sub[, start[, end]]) -> int Like S.find() but raise ValueError when the substring is not found.

isalnum(...)
S.isalnum() -> bool Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha(...)
S.isalpha() -> bool Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal(...)
S.isdecimal() -> bool Return True if there are only decimal characters in S, False otherwise.

isdigit(...)
S.isdigit() -> bool Return True if all characters in S are digits and there is at least one character in S, False otherwise.

isidentifier(...)
S.isidentifier() -> bool Return True if S is a valid identifier according to the language definition. Use keyword.iskeyword() to test for reserved identifiers such as "def" and "class".

islower(...)
S.islower() -> bool Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric(...)
S.isnumeric() -> bool Return True if there are only numeric characters in S, False otherwise.

isprintable(...)
S.isprintable() -> bool Return True if all characters in S are considered printable in repr() or S is empty, False otherwise.

isspace(...)
S.isspace() -> bool Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle(...)
S.istitle() -> bool Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper(...)
S.isupper() -> bool Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

join(...)
S.join(iterable) -> str Return a string which is the concatenation of the strings in the iterable.  The separator between elements is S.

ljust(...)
S.ljust(width[, fillchar]) -> str Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower(...)
S.lower() -> str Return a copy of the string S converted to lowercase.

lstrip(...)
S.lstrip([chars]) -> str Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead.

partition(...)
S.partition(sep) -> (head, sep, tail) Search for the separator sep in S, and return the part before it, the separator itself, and the part after it.  If the separator is not found, return S and two empty strings.

replace(...)
S.replace(old, new[, count]) -> str Return a copy of S with all occurrences of substring old replaced by new.  If the optional argument count is given, only the first count occurrences are replaced.

rfind(...)
S.rfind(sub[, start[, end]]) -> int 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(...)
S.rindex(sub[, start[, end]]) -> int Like S.rfind() but raise ValueError when the substring is not found.

rjust(...)
S.rjust(width[, fillchar]) -> str Return S right-justified in a string of length width. Padding is done using the specified fill character (default is a space).

rpartition(...)
S.rpartition(sep) -> (head, sep, tail) Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it.  If the separator is not found, return two empty strings and S.

rsplit(...)
S.rsplit(sep=None, maxsplit=-1) -> list of strings Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front.  If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip(...)
S.rstrip([chars]) -> str Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead.

split(...)
S.split(sep=None, maxsplit=-1) -> list of strings Return a list of the words in S, using sep as the delimiter string.  If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines(...)
S.splitlines([keepends]) -> list of strings Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith(...)
S.startswith(prefix[, start[, end]]) -> bool 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(...)
S.strip([chars]) -> str Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead.

swapcase(...)
S.swapcase() -> str Return a copy of S with uppercase characters converted to lowercase and vice versa.

title(...)
S.title() -> str Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate(...)
S.translate(table) -> str Return a copy of the string S in which each character has been mapped through the given translation table. The table must implement lookup/indexing via __getitem__, for instance a dictionary or list, mapping Unicode ordinals to Unicode ordinals, strings, or None. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.

upper(...)
S.upper() -> str Return a copy of S converted to uppercase.

zfill(...)
S.zfill(width) -> str Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Static methods inherited from builtins.str:

maketrans(x, y=None, z=None, /)
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.

class IRBytesField(IndexedRedis.fields.IRField)

    IRBytesField - Ensure the data is always "bytes" type. Similar to IRRawField, except IRRawField does not touch encoding, this forces to bytes. This is replacement for BINARY_FIELDS An IRBytesField is indexable, and the index is forced to be hashed.

Method resolution order:

IRBytesField

IndexedRedis.fields.IRField

builtins.str

builtins.object

Methods defined here:

__init__(self, name='', defaultValue=irNull, encoding=None)
__init__ - Create an IRBytesField object @param name <str> - Field name @param defaultValue <any> default irNull - Default value for this field @param encoding <None/str> - If None, defaultIREncoding will be used when converting to bytes,   otherwise you can provide an explicit encoding An IRBytesField is indexable, and the index is forced to be hashed.

copy(self)
copy - Create a copy of this IRField.   Each subclass should implement this, as you'll need to pass in the args to constructor. @return <IRField (or subclass)> - Another IRField that has all the same values as this one.

Static methods defined here:

__new__(self, name='', defaultValue=irNull, encoding=None)
Create and return a new object.  See help(type) for accurate signature.

Data and other attributes defined here:

CAN_INDEX = True

hashIndex = True

Methods inherited from IndexedRedis.fields.IRField:

__repr__(self)
__repr__ - Return an object-representation string of this field instance. You should NOT need to extend this on your IRField, instead just implement _getReprProperties   to return your type's specific properties associated with this instance.   @see _getReprProperties

convert = _deprecated_wrapper(*args, **kwargs)

fromInput(self, value)
fromInput - Convert the value from input (like assigning this through constructor or as an item assignment on the object @param value - Value to convert @return - Converted value

fromStorage(self, value)
fromStorage - Convert the value from storage to the value type. @param value - Value to convert @return - The converted value

getDefaultValue(self)
getDefaultValue - Gets the default value associated with this field.   This is the value used when no value has been explicitly set.   @return - The default value

toIndex(self, value)
toIndex - An optional method which will return the value prepped for index. By default, "toStorage" will be called. If you provide "hashIndex=True" on the constructor, the field will be md5summed for indexing purposes. This is useful for large strings, etc.

toStorage(self, value)
toStorage - Convert the value to a string representation for storage.   The default implementation will work here for basic types. @param value - The value of the item to convert @return A string value suitable for storing.

Data descriptors inherited from IndexedRedis.fields.IRField:

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

isIndexHashed

isIndexHashed - Returns if the index value should be hashed @return <bool> - True if this field should be hashed before indexing / filtering

name

name - Property, return this field's name @return <str> - Field name

Data and other attributes inherited from IndexedRedis.fields.IRField:

defaultValue = irNull

Methods inherited from builtins.str:

__add__(self, value, /)
Return self+value.

__contains__(self, key, /)
Return key in self.

__eq__(self, value, /)
Return self==value.

__format__(...)
S.__format__(format_spec) -> str Return a formatted version of S as described by format_spec.

__ge__(self, value, /)
Return self>=value.

__getattribute__(self, name, /)
Return getattr(self, name).

__getitem__(self, key, /)
Return self[key].

__getnewargs__(...)

__gt__(self, value, /)
Return self>value.

__hash__(self, /)
Return hash(self).

__iter__(self, /)
Implement iter(self).

__le__(self, value, /)
Return self<=value.

__len__(self, /)
Return len(self).

__lt__(self, value, /)
Return self<value.

__mod__(self, value, /)
Return self%value.

__mul__(self, value, /)
Return self*value.n

__ne__(self, value, /)
Return self!=value.

__rmod__(self, value, /)
Return value%self.

__rmul__(self, value, /)
Return self*value.

__sizeof__(...)
S.__sizeof__() -> size of S in memory, in bytes

__str__(self, /)
Return str(self).

capitalize(...)
S.capitalize() -> str Return a capitalized version of S, i.e. make the first character have upper case and the rest lower case.

casefold(...)
S.casefold() -> str Return a version of S suitable for caseless comparisons.

center(...)
S.center(width[, fillchar]) -> str Return S centered in a string of length width. Padding is done using the specified fill character (default is a space)

count(...)
S.count(sub[, start[, end]]) -> int 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(...)
S.encode(encoding='utf-8', errors='strict') -> bytes Encode S using the codec registered for encoding. Default encoding is 'utf-8'. errors may be given to set a different error handling scheme. 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(...)
S.endswith(suffix[, start[, end]]) -> bool 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(...)
S.expandtabs(tabsize=8) -> str Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find(...)
S.find(sub[, start[, end]]) -> int 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(...)
S.format(*args, **kwargs) -> str Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces ('{' and '}').

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

index(...)
S.index(sub[, start[, end]]) -> int Like S.find() but raise ValueError when the substring is not found.

isalnum(...)
S.isalnum() -> bool Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha(...)
S.isalpha() -> bool Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal(...)
S.isdecimal() -> bool Return True if there are only decimal characters in S, False otherwise.

isdigit(...)
S.isdigit() -> bool Return True if all characters in S are digits and there is at least one character in S, False otherwise.

isidentifier(...)
S.isidentifier() -> bool Return True if S is a valid identifier according to the language definition. Use keyword.iskeyword() to test for reserved identifiers such as "def" and "class".

islower(...)
S.islower() -> bool Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric(...)
S.isnumeric() -> bool Return True if there are only numeric characters in S, False otherwise.

isprintable(...)
S.isprintable() -> bool Return True if all characters in S are considered printable in repr() or S is empty, False otherwise.

isspace(...)
S.isspace() -> bool Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle(...)
S.istitle() -> bool Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper(...)
S.isupper() -> bool Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

join(...)
S.join(iterable) -> str Return a string which is the concatenation of the strings in the iterable.  The separator between elements is S.

ljust(...)
S.ljust(width[, fillchar]) -> str Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower(...)
S.lower() -> str Return a copy of the string S converted to lowercase.

lstrip(...)
S.lstrip([chars]) -> str Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead.

partition(...)
S.partition(sep) -> (head, sep, tail) Search for the separator sep in S, and return the part before it, the separator itself, and the part after it.  If the separator is not found, return S and two empty strings.

replace(...)
S.replace(old, new[, count]) -> str Return a copy of S with all occurrences of substring old replaced by new.  If the optional argument count is given, only the first count occurrences are replaced.

rfind(...)
S.rfind(sub[, start[, end]]) -> int 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(...)
S.rindex(sub[, start[, end]]) -> int Like S.rfind() but raise ValueError when the substring is not found.

rjust(...)
S.rjust(width[, fillchar]) -> str Return S right-justified in a string of length width. Padding is done using the specified fill character (default is a space).

rpartition(...)
S.rpartition(sep) -> (head, sep, tail) Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it.  If the separator is not found, return two empty strings and S.

rsplit(...)
S.rsplit(sep=None, maxsplit=-1) -> list of strings Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front.  If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip(...)
S.rstrip([chars]) -> str Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead.

split(...)
S.split(sep=None, maxsplit=-1) -> list of strings Return a list of the words in S, using sep as the delimiter string.  If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines(...)
S.splitlines([keepends]) -> list of strings Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith(...)
S.startswith(prefix[, start[, end]]) -> bool 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(...)
S.strip([chars]) -> str Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead.

swapcase(...)
S.swapcase() -> str Return a copy of S with uppercase characters converted to lowercase and vice versa.

title(...)
S.title() -> str Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate(...)
S.translate(table) -> str Return a copy of the string S in which each character has been mapped through the given translation table. The table must implement lookup/indexing via __getitem__, for instance a dictionary or list, mapping Unicode ordinals to Unicode ordinals, strings, or None. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.

upper(...)
S.upper() -> str Return a copy of S converted to uppercase.

zfill(...)
S.zfill(width) -> str Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Static methods inherited from builtins.str:

maketrans(x, y=None, z=None, /)
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.

class IRClassicField(IndexedRedis.fields.IRField)

    IRClassicField - The IRField type which behaves like the "classic" IndexedRedis string-named fields. This will store and retrieve data encoding into the default encoding (@see IndexedRedis.compat_str.setDefaultIREncoding) and have a default value of empty string. An IRClassicField is indexable, but there is no option to hash the index.

Method resolution order:

IRClassicField

IndexedRedis.fields.IRField

builtins.str

builtins.object

Methods defined here:

__init__(self, name='')
__init__ - Create an IRClassicField.   This field behaves as a plain string entry in FIELDS did prior to 5.0.0.   The default value is empty string, and it stores strings using defaultIREncoding.   Consider changing to an IRField or one of the other many types.   @param name <str> - Field name

copy(self)
copy - Create a copy of this IRField.   Each subclass should implement this, as you'll need to pass in the args to constructor. @return <IRField (or subclass)> - Another IRField that has all the same values as this one.

Static methods defined here:

__new__(self, name='')
Create and return a new object.  See help(type) for accurate signature.

Data and other attributes defined here:

CAN_INDEX = True

Methods inherited from IndexedRedis.fields.IRField:

__repr__(self)
__repr__ - Return an object-representation string of this field instance. You should NOT need to extend this on your IRField, instead just implement _getReprProperties   to return your type's specific properties associated with this instance.   @see _getReprProperties

convert = _deprecated_wrapper(*args, **kwargs)

fromInput(self, value)
fromInput - Convert the value from input (like assigning this through constructor or as an item assignment on the object @param value - Value to convert @return - Converted value

fromStorage(self, value)
fromStorage - Convert the value from storage to the value type. @param value - Value to convert @return - The converted value

getDefaultValue(self)
getDefaultValue - Gets the default value associated with this field.   This is the value used when no value has been explicitly set.   @return - The default value

toIndex(self, value)
toIndex - An optional method which will return the value prepped for index. By default, "toStorage" will be called. If you provide "hashIndex=True" on the constructor, the field will be md5summed for indexing purposes. This is useful for large strings, etc.

toStorage(self, value)
toStorage - Convert the value to a string representation for storage.   The default implementation will work here for basic types. @param value - The value of the item to convert @return A string value suitable for storing.

Data descriptors inherited from IndexedRedis.fields.IRField:

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

isIndexHashed

isIndexHashed - Returns if the index value should be hashed @return <bool> - True if this field should be hashed before indexing / filtering

name

name - Property, return this field's name @return <str> - Field name

Data and other attributes inherited from IndexedRedis.fields.IRField:

defaultValue = irNull

hashIndex = False

Methods inherited from builtins.str:

__add__(self, value, /)
Return self+value.

__contains__(self, key, /)
Return key in self.

__eq__(self, value, /)
Return self==value.

__format__(...)
S.__format__(format_spec) -> str Return a formatted version of S as described by format_spec.

__ge__(self, value, /)
Return self>=value.

__getattribute__(self, name, /)
Return getattr(self, name).

__getitem__(self, key, /)
Return self[key].

__getnewargs__(...)

__gt__(self, value, /)
Return self>value.

__hash__(self, /)
Return hash(self).

__iter__(self, /)
Implement iter(self).

__le__(self, value, /)
Return self<=value.

__len__(self, /)
Return len(self).

__lt__(self, value, /)
Return self<value.

__mod__(self, value, /)
Return self%value.

__mul__(self, value, /)
Return self*value.n

__ne__(self, value, /)
Return self!=value.

__rmod__(self, value, /)
Return value%self.

__rmul__(self, value, /)
Return self*value.

__sizeof__(...)
S.__sizeof__() -> size of S in memory, in bytes

__str__(self, /)
Return str(self).

capitalize(...)
S.capitalize() -> str Return a capitalized version of S, i.e. make the first character have upper case and the rest lower case.

casefold(...)
S.casefold() -> str Return a version of S suitable for caseless comparisons.

center(...)
S.center(width[, fillchar]) -> str Return S centered in a string of length width. Padding is done using the specified fill character (default is a space)

count(...)
S.count(sub[, start[, end]]) -> int 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(...)
S.encode(encoding='utf-8', errors='strict') -> bytes Encode S using the codec registered for encoding. Default encoding is 'utf-8'. errors may be given to set a different error handling scheme. 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(...)
S.endswith(suffix[, start[, end]]) -> bool 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(...)
S.expandtabs(tabsize=8) -> str Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find(...)
S.find(sub[, start[, end]]) -> int 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(...)
S.format(*args, **kwargs) -> str Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces ('{' and '}').

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

index(...)
S.index(sub[, start[, end]]) -> int Like S.find() but raise ValueError when the substring is not found.

isalnum(...)
S.isalnum() -> bool Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha(...)
S.isalpha() -> bool Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal(...)
S.isdecimal() -> bool Return True if there are only decimal characters in S, False otherwise.

isdigit(...)
S.isdigit() -> bool Return True if all characters in S are digits and there is at least one character in S, False otherwise.

isidentifier(...)
S.isidentifier() -> bool Return True if S is a valid identifier according to the language definition. Use keyword.iskeyword() to test for reserved identifiers such as "def" and "class".

islower(...)
S.islower() -> bool Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric(...)
S.isnumeric() -> bool Return True if there are only numeric characters in S, False otherwise.

isprintable(...)
S.isprintable() -> bool Return True if all characters in S are considered printable in repr() or S is empty, False otherwise.

isspace(...)
S.isspace() -> bool Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle(...)
S.istitle() -> bool Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper(...)
S.isupper() -> bool Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

join(...)
S.join(iterable) -> str Return a string which is the concatenation of the strings in the iterable.  The separator between elements is S.

ljust(...)
S.ljust(width[, fillchar]) -> str Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower(...)
S.lower() -> str Return a copy of the string S converted to lowercase.

lstrip(...)
S.lstrip([chars]) -> str Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead.

partition(...)
S.partition(sep) -> (head, sep, tail) Search for the separator sep in S, and return the part before it, the separator itself, and the part after it.  If the separator is not found, return S and two empty strings.

replace(...)
S.replace(old, new[, count]) -> str Return a copy of S with all occurrences of substring old replaced by new.  If the optional argument count is given, only the first count occurrences are replaced.

rfind(...)
S.rfind(sub[, start[, end]]) -> int 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(...)
S.rindex(sub[, start[, end]]) -> int Like S.rfind() but raise ValueError when the substring is not found.

rjust(...)
S.rjust(width[, fillchar]) -> str Return S right-justified in a string of length width. Padding is done using the specified fill character (default is a space).

rpartition(...)
S.rpartition(sep) -> (head, sep, tail) Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it.  If the separator is not found, return two empty strings and S.

rsplit(...)
S.rsplit(sep=None, maxsplit=-1) -> list of strings Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front.  If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip(...)
S.rstrip([chars]) -> str Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead.

split(...)
S.split(sep=None, maxsplit=-1) -> list of strings Return a list of the words in S, using sep as the delimiter string.  If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines(...)
S.splitlines([keepends]) -> list of strings Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith(...)
S.startswith(prefix[, start[, end]]) -> bool 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(...)
S.strip([chars]) -> str Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead.

swapcase(...)
S.swapcase() -> str Return a copy of S with uppercase characters converted to lowercase and vice versa.

title(...)
S.title() -> str Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate(...)
S.translate(table) -> str Return a copy of the string S in which each character has been mapped through the given translation table. The table must implement lookup/indexing via __getitem__, for instance a dictionary or list, mapping Unicode ordinals to Unicode ordinals, strings, or None. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.

upper(...)
S.upper() -> str Return a copy of S converted to uppercase.

zfill(...)
S.zfill(width) -> str Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Static methods inherited from builtins.str:

maketrans(x, y=None, z=None, /)
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.

class IRCompressedField(IndexedRedis.fields.IRField)

    IRCompressedField - A field that automatically compresses/decompresses going to/from Redis. Pass this into the FIELDS array of the model to get this functionality, like:         FIELDS  = [ ..., IRCompressedField('my_compressed_field', compressMode=COMPRESS_MODE_ZLIB] By default, after fetch the data will be encoded as "bytes". If you need it to be unicode/string, use an   IRFieldChain with an IRUnicodeField and an IRCompressedField together. An IRCompressedField is indexable, and forces the index to be hashed.

Method resolution order:

IRCompressedField

IndexedRedis.fields.IRField

builtins.str

builtins.object

Methods defined here:

__init__(self, name='', compressMode='zlib', defaultValue=irNull)
__init__ - Create this object @param name <str> - Field name @param compressMode <str>, default "zlib". Determines the compression module to use   for this field. See COMPRESS_MODE_* variables in this module.   Supported values as of 5.0.0 are:      "zlib" / "gz" / "gzip" - zlib compression      "bz2"  / "bzip2"       - bzip2 compression      "lzma" / "xz"          - LZMA compression.        NOTE: This is provided in python3 by default, but in python2 you will need an external module.         IndexedRedis will automatically detect if "backports.lzma" or "lzmaffi" are installed, and use them         if the core "lzma" module is not available. @param defaultValue - The default value for this field An IRCompressedField is indexable, and forces the index to be hashed.

copy(self)
copy - Create a copy of this IRField.   Each subclass should implement this, as you'll need to pass in the args to constructor. @return <IRField (or subclass)> - Another IRField that has all the same values as this one.

getCompressMod(self)
getCompressMod - Return the module used for compression on this field @return <module> - The module for compression

Static methods defined here:

__new__(self, name='', compressMode='zlib', defaultValue=irNull)
Create and return a new object.  See help(type) for accurate signature.

Data and other attributes defined here:

CAN_INDEX = True

hashIndex = True

Methods inherited from IndexedRedis.fields.IRField:

__repr__(self)
__repr__ - Return an object-representation string of this field instance. You should NOT need to extend this on your IRField, instead just implement _getReprProperties   to return your type's specific properties associated with this instance.   @see _getReprProperties

convert = _deprecated_wrapper(*args, **kwargs)

fromInput(self, value)
fromInput - Convert the value from input (like assigning this through constructor or as an item assignment on the object @param value - Value to convert @return - Converted value

fromStorage(self, value)
fromStorage - Convert the value from storage to the value type. @param value - Value to convert @return - The converted value

getDefaultValue(self)
getDefaultValue - Gets the default value associated with this field.   This is the value used when no value has been explicitly set.   @return - The default value

toIndex(self, value)
toIndex - An optional method which will return the value prepped for index. By default, "toStorage" will be called. If you provide "hashIndex=True" on the constructor, the field will be md5summed for indexing purposes. This is useful for large strings, etc.

toStorage(self, value)
toStorage - Convert the value to a string representation for storage.   The default implementation will work here for basic types. @param value - The value of the item to convert @return A string value suitable for storing.

Data descriptors inherited from IndexedRedis.fields.IRField:

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

isIndexHashed

isIndexHashed - Returns if the index value should be hashed @return <bool> - True if this field should be hashed before indexing / filtering

name

name - Property, return this field's name @return <str> - Field name

Data and other attributes inherited from IndexedRedis.fields.IRField:

defaultValue = irNull

Methods inherited from builtins.str:

__add__(self, value, /)
Return self+value.

__contains__(self, key, /)
Return key in self.

__eq__(self, value, /)
Return self==value.

__format__(...)
S.__format__(format_spec) -> str Return a formatted version of S as described by format_spec.

__ge__(self, value, /)
Return self>=value.

__getattribute__(self, name, /)
Return getattr(self, name).

__getitem__(self, key, /)
Return self[key].

__getnewargs__(...)

__gt__(self, value, /)
Return self>value.

__hash__(self, /)
Return hash(self).

__iter__(self, /)
Implement iter(self).

__le__(self, value, /)
Return self<=value.

__len__(self, /)
Return len(self).

__lt__(self, value, /)
Return self<value.

__mod__(self, value, /)
Return self%value.

__mul__(self, value, /)
Return self*value.n

__ne__(self, value, /)
Return self!=value.

__rmod__(self, value, /)
Return value%self.

__rmul__(self, value, /)
Return self*value.

__sizeof__(...)
S.__sizeof__() -> size of S in memory, in bytes

__str__(self, /)
Return str(self).

capitalize(...)
S.capitalize() -> str Return a capitalized version of S, i.e. make the first character have upper case and the rest lower case.

casefold(...)
S.casefold() -> str Return a version of S suitable for caseless comparisons.

center(...)
S.center(width[, fillchar]) -> str Return S centered in a string of length width. Padding is done using the specified fill character (default is a space)

count(...)
S.count(sub[, start[, end]]) -> int 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(...)
S.encode(encoding='utf-8', errors='strict') -> bytes Encode S using the codec registered for encoding. Default encoding is 'utf-8'. errors may be given to set a different error handling scheme. 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(...)
S.endswith(suffix[, start[, end]]) -> bool 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(...)
S.expandtabs(tabsize=8) -> str Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find(...)
S.find(sub[, start[, end]]) -> int 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(...)
S.format(*args, **kwargs) -> str Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces ('{' and '}').

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

index(...)
S.index(sub[, start[, end]]) -> int Like S.find() but raise ValueError when the substring is not found.

isalnum(...)
S.isalnum() -> bool Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha(...)
S.isalpha() -> bool Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal(...)
S.isdecimal() -> bool Return True if there are only decimal characters in S, False otherwise.

isdigit(...)
S.isdigit() -> bool Return True if all characters in S are digits and there is at least one character in S, False otherwise.

isidentifier(...)
S.isidentifier() -> bool Return True if S is a valid identifier according to the language definition. Use keyword.iskeyword() to test for reserved identifiers such as "def" and "class".

islower(...)
S.islower() -> bool Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric(...)
S.isnumeric() -> bool Return True if there are only numeric characters in S, False otherwise.

isprintable(...)
S.isprintable() -> bool Return True if all characters in S are considered printable in repr() or S is empty, False otherwise.

isspace(...)
S.isspace() -> bool Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle(...)
S.istitle() -> bool Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper(...)
S.isupper() -> bool Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

join(...)
S.join(iterable) -> str Return a string which is the concatenation of the strings in the iterable.  The separator between elements is S.

ljust(...)
S.ljust(width[, fillchar]) -> str Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower(...)
S.lower() -> str Return a copy of the string S converted to lowercase.

lstrip(...)
S.lstrip([chars]) -> str Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead.

partition(...)
S.partition(sep) -> (head, sep, tail) Search for the separator sep in S, and return the part before it, the separator itself, and the part after it.  If the separator is not found, return S and two empty strings.

replace(...)
S.replace(old, new[, count]) -> str Return a copy of S with all occurrences of substring old replaced by new.  If the optional argument count is given, only the first count occurrences are replaced.

rfind(...)
S.rfind(sub[, start[, end]]) -> int 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(...)
S.rindex(sub[, start[, end]]) -> int Like S.rfind() but raise ValueError when the substring is not found.

rjust(...)
S.rjust(width[, fillchar]) -> str Return S right-justified in a string of length width. Padding is done using the specified fill character (default is a space).

rpartition(...)
S.rpartition(sep) -> (head, sep, tail) Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it.  If the separator is not found, return two empty strings and S.

rsplit(...)
S.rsplit(sep=None, maxsplit=-1) -> list of strings Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front.  If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip(...)
S.rstrip([chars]) -> str Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead.

split(...)
S.split(sep=None, maxsplit=-1) -> list of strings Return a list of the words in S, using sep as the delimiter string.  If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines(...)
S.splitlines([keepends]) -> list of strings Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith(...)
S.startswith(prefix[, start[, end]]) -> bool 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(...)
S.strip([chars]) -> str Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead.

swapcase(...)
S.swapcase() -> str Return a copy of S with uppercase characters converted to lowercase and vice versa.

title(...)
S.title() -> str Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate(...)
S.translate(table) -> str Return a copy of the string S in which each character has been mapped through the given translation table. The table must implement lookup/indexing via __getitem__, for instance a dictionary or list, mapping Unicode ordinals to Unicode ordinals, strings, or None. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.

upper(...)
S.upper() -> str Return a copy of S converted to uppercase.

zfill(...)
S.zfill(width) -> str Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Static methods inherited from builtins.str:

maketrans(x, y=None, z=None, /)
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.

class IRDatetimeValue(datetime.datetime)

    IRDatetimeValue - A field type that is a datetime. Pass this as "valueType" to an IRField to use a datetime

Method resolution order:

IRDatetimeValue

datetime.datetime

datetime.date

builtins.object

Static methods defined here:

__new__(self, *args, **kwargs)
Create and return a new object.  See help(type) for accurate signature.

Data descriptors defined here:

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

Data and other attributes defined here:

CAN_INDEX = True

Methods inherited from datetime.datetime:

__add__(self, value, /)
Return self+value.

__eq__(self, value, /)
Return self==value.

__ge__(self, value, /)
Return self>=value.

__getattribute__(self, name, /)
Return getattr(self, name).

__gt__(self, value, /)
Return self>value.

__hash__(self, /)
Return hash(self).

__le__(self, value, /)
Return self<=value.

__lt__(self, value, /)
Return self<value.

__ne__(self, value, /)
Return self!=value.

__radd__(self, value, /)
Return value+self.

__reduce__(...)
__reduce__() -> (cls, state)

__reduce_ex__(...)
__reduce_ex__(proto) -> (cls, state)

__repr__(self, /)
Return repr(self).

__rsub__(self, value, /)
Return value-self.

__str__(self, /)
Return str(self).

__sub__(self, value, /)
Return self-value.

astimezone(...)
tz -> convert to local time in new timezone tz

combine(...) from builtins.type
date, time -> datetime with same date and time fields

ctime(...)
Return ctime() style string.

date(...)
Return date object with same year, month and day.

dst(...)
Return self.tzinfo.dst(self).

fromtimestamp(...) from builtins.type
timestamp[, tz] -> tz's local time from POSIX timestamp.

isoformat(...)
[sep] -> string in ISO 8601 format, YYYY-MM-DDT[HH[:MM[:SS[.mmm[uuu]]]]][+HH:MM]. sep is used to separate the year from the time, and defaults to 'T'. timespec specifies what components of the time to include (allowed values are 'auto', 'hours', 'minutes', 'seconds', 'milliseconds', and 'microseconds').

now(tz=None) from builtins.type
Returns new datetime object representing current time local to tz.   tz     Timezone object. If no tz is specified, uses local timezone.

replace(...)
Return datetime with new specified fields.

strptime(...) from builtins.type
string, format -> new datetime parsed from a string (like time.strptime()).

time(...)
Return time object with same time but with tzinfo=None.

timestamp(...)
Return POSIX timestamp as float.

timetuple(...)
Return time tuple, compatible with time.localtime().

timetz(...)
Return time object with same time and tzinfo.

tzname(...)
Return self.tzinfo.tzname(self).

utcfromtimestamp(...) from builtins.type
Construct a naive UTC datetime from a POSIX timestamp.

utcnow(...) from builtins.type
Return a new datetime representing UTC day and time.

utcoffset(...)
Return self.tzinfo.utcoffset(self).

utctimetuple(...)
Return UTC time tuple, compatible with time.localtime().

Data descriptors inherited from datetime.datetime:

fold

hour

microsecond

minute

second

tzinfo

Data and other attributes inherited from datetime.datetime:

max = datetime.datetime(9999, 12, 31, 23, 59, 59, 999999)

min = datetime.datetime(1, 1, 1, 0, 0)

resolution = datetime.timedelta(0, 0, 1)

Methods inherited from datetime.date:

__format__(...)
Formats self with strftime.

fromordinal(...) from builtins.type
int -> date corresponding to a proleptic Gregorian ordinal.

isocalendar(...)
Return a 3-tuple containing ISO year, week number, and weekday.

isoweekday(...)
Return the day of the week represented by the date. Monday == 1 ... Sunday == 7

strftime(...)
format -> strftime() style string.

today(...) from builtins.type
Current date or datetime:  same as self.__class__.fromtimestamp(time.time()).

toordinal(...)
Return proleptic Gregorian ordinal.  January 1 of year 1 is day 1.

weekday(...)
Return the day of the week represented by the date. Monday == 0 ... Sunday == 6

Data descriptors inherited from datetime.date:

day

month

year

class IRField(builtins.str)

    IRField - An advanced field If a type is defined other than default/str/bytes/None , an empty value (empty string in Redis) will be assigned to the IRNullType instance provided in this module, irNull. irNull does not equal anything except irNull (or another IRNullType). Use this to check if a value has been assigned for other types. BE VERY CAREFUL ABOUT USING "float" as a type! It is an inprecise field and can vary from system to system. Instead of using a float, consider using fields.IRFixedPointField, which is indexable. An IRField may be indexable (depending on the type), and has the option to hash the index

Method resolution order:

IRField

builtins.str

builtins.object

Methods defined here:

__init__(self, name='', valueType=<class 'str'>, defaultValue=irNull, hashIndex=False)
__init__ - Create an IRField. Use this directly in the FIELDS array for advanced functionality on a field. @param name <str> - The name of this field @param valueType <type> - The type that will be used for this field. Default str/unicode (and bytes on python2)         act the same as non-IRField FIELDS entries (just plain string), i.e. they are encoded to unicode to and from Redis.         If you pass in None, then no decoding will take place (so whatever you provide goes in, and bytes come out of Redis).         This is similar to IRFieldRaw         On python3, if you pass bytes, than the field will be left as bytes.         To be both python2 and python3 compatible, however, you can use IRBytesField         If bool is used, then "1" and "true" are True, "0" and "false" are False, any other value is an exception.         You can also pass an advanced type (see IndexedRedis.fields.FieldValueTypes) like datetime and json.         All types other than string/unicode/bytes/None will be assigned 'irNull' if they were not provided a value.         @see irNull - Equals only irNull (or other IRNullType instances). You can use this to check if an integer is defined versus 0, for example.         While this class is create for primitive types (like int's and datetimes), more complex types extend IRField (such as pickle, compressed, or unicode with a specific encoding). @param defaultValue <any> (default irNull) - The value assigned to this field as a "default", i.e. when no value has yet been set. Generally, it makes sense to keep this as irNull, but you may want a different default. @param hashIndex <bool> (default False) - If true, the md5 hash of the value will be used for indexing and filtering. This may be useful for very long fields. An IRField may be indexable (depending on the type), and has the option to hash the index NOTE: If you are extending IRField, you should probably not call this __init__ function. So long as you implement your own "convert", any fields used are set on a class-level.

__repr__(self)
__repr__ - Return an object-representation string of this field instance. You should NOT need to extend this on your IRField, instead just implement _getReprProperties   to return your type's specific properties associated with this instance.   @see _getReprProperties

convert = _deprecated_wrapper(*args, **kwargs)

copy(self)
copy - Create a copy of this IRField.   Each subclass should implement this, as you'll need to pass in the args to constructor. @return <IRField (or subclass)> - Another IRField that has all the same values as this one.

fromInput(self, value)
fromInput - Convert the value from input (like assigning this through constructor or as an item assignment on the object @param value - Value to convert @return - Converted value

fromStorage(self, value)
fromStorage - Convert the value from storage to the value type. @param value - Value to convert @return - The converted value

getDefaultValue(self)
getDefaultValue - Gets the default value associated with this field.   This is the value used when no value has been explicitly set.   @return - The default value

toIndex(self, value)
toIndex - An optional method which will return the value prepped for index. By default, "toStorage" will be called. If you provide "hashIndex=True" on the constructor, the field will be md5summed for indexing purposes. This is useful for large strings, etc.

toStorage(self, value)
toStorage - Convert the value to a string representation for storage.   The default implementation will work here for basic types. @param value - The value of the item to convert @return A string value suitable for storing.

Static methods defined here:

__new__(self, name='', valueType=None, defaultValue=irNull, hashIndex=False)
Create and return a new object.  See help(type) for accurate signature.

Data descriptors defined here:

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

isIndexHashed

isIndexHashed - Returns if the index value should be hashed @return <bool> - True if this field should be hashed before indexing / filtering

name

name - Property, return this field's name @return <str> - Field name

Data and other attributes defined here:

CAN_INDEX = False

defaultValue = irNull

hashIndex = False

Methods inherited from builtins.str:

__add__(self, value, /)
Return self+value.

__contains__(self, key, /)
Return key in self.

__eq__(self, value, /)
Return self==value.

__format__(...)
S.__format__(format_spec) -> str Return a formatted version of S as described by format_spec.

__ge__(self, value, /)
Return self>=value.

__getattribute__(self, name, /)
Return getattr(self, name).

__getitem__(self, key, /)
Return self[key].

__getnewargs__(...)

__gt__(self, value, /)
Return self>value.

__hash__(self, /)
Return hash(self).

__iter__(self, /)
Implement iter(self).

__le__(self, value, /)
Return self<=value.

__len__(self, /)
Return len(self).

__lt__(self, value, /)
Return self<value.

__mod__(self, value, /)
Return self%value.

__mul__(self, value, /)
Return self*value.n

__ne__(self, value, /)
Return self!=value.

__rmod__(self, value, /)
Return value%self.

__rmul__(self, value, /)
Return self*value.

__sizeof__(...)
S.__sizeof__() -> size of S in memory, in bytes

__str__(self, /)
Return str(self).

capitalize(...)
S.capitalize() -> str Return a capitalized version of S, i.e. make the first character have upper case and the rest lower case.

casefold(...)
S.casefold() -> str Return a version of S suitable for caseless comparisons.

center(...)
S.center(width[, fillchar]) -> str Return S centered in a string of length width. Padding is done using the specified fill character (default is a space)

count(...)
S.count(sub[, start[, end]]) -> int 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(...)
S.encode(encoding='utf-8', errors='strict') -> bytes Encode S using the codec registered for encoding. Default encoding is 'utf-8'. errors may be given to set a different error handling scheme. 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(...)
S.endswith(suffix[, start[, end]]) -> bool 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(...)
S.expandtabs(tabsize=8) -> str Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find(...)
S.find(sub[, start[, end]]) -> int 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(...)
S.format(*args, **kwargs) -> str Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces ('{' and '}').

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

index(...)
S.index(sub[, start[, end]]) -> int Like S.find() but raise ValueError when the substring is not found.

isalnum(...)
S.isalnum() -> bool Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha(...)
S.isalpha() -> bool Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal(...)
S.isdecimal() -> bool Return True if there are only decimal characters in S, False otherwise.

isdigit(...)
S.isdigit() -> bool Return True if all characters in S are digits and there is at least one character in S, False otherwise.

isidentifier(...)
S.isidentifier() -> bool Return True if S is a valid identifier according to the language definition. Use keyword.iskeyword() to test for reserved identifiers such as "def" and "class".

islower(...)
S.islower() -> bool Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric(...)
S.isnumeric() -> bool Return True if there are only numeric characters in S, False otherwise.

isprintable(...)
S.isprintable() -> bool Return True if all characters in S are considered printable in repr() or S is empty, False otherwise.

isspace(...)
S.isspace() -> bool Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle(...)
S.istitle() -> bool Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper(...)
S.isupper() -> bool Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

join(...)
S.join(iterable) -> str Return a string which is the concatenation of the strings in the iterable.  The separator between elements is S.

ljust(...)
S.ljust(width[, fillchar]) -> str Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower(...)
S.lower() -> str Return a copy of the string S converted to lowercase.

lstrip(...)
S.lstrip([chars]) -> str Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead.

partition(...)
S.partition(sep) -> (head, sep, tail) Search for the separator sep in S, and return the part before it, the separator itself, and the part after it.  If the separator is not found, return S and two empty strings.

replace(...)
S.replace(old, new[, count]) -> str Return a copy of S with all occurrences of substring old replaced by new.  If the optional argument count is given, only the first count occurrences are replaced.

rfind(...)
S.rfind(sub[, start[, end]]) -> int 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(...)
S.rindex(sub[, start[, end]]) -> int Like S.rfind() but raise ValueError when the substring is not found.

rjust(...)
S.rjust(width[, fillchar]) -> str Return S right-justified in a string of length width. Padding is done using the specified fill character (default is a space).

rpartition(...)
S.rpartition(sep) -> (head, sep, tail) Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it.  If the separator is not found, return two empty strings and S.

rsplit(...)
S.rsplit(sep=None, maxsplit=-1) -> list of strings Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front.  If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip(...)
S.rstrip([chars]) -> str Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead.

split(...)
S.split(sep=None, maxsplit=-1) -> list of strings Return a list of the words in S, using sep as the delimiter string.  If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines(...)
S.splitlines([keepends]) -> list of strings Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith(...)
S.startswith(prefix[, start[, end]]) -> bool 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(...)
S.strip([chars]) -> str Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead.

swapcase(...)
S.swapcase() -> str Return a copy of S with uppercase characters converted to lowercase and vice versa.

title(...)
S.title() -> str Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate(...)
S.translate(table) -> str Return a copy of the string S in which each character has been mapped through the given translation table. The table must implement lookup/indexing via __getitem__, for instance a dictionary or list, mapping Unicode ordinals to Unicode ordinals, strings, or None. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.

upper(...)
S.upper() -> str Return a copy of S converted to uppercase.

zfill(...)
S.zfill(width) -> str Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Static methods inherited from builtins.str:

maketrans(x, y=None, z=None, /)
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.

class IRFixedPointField(IndexedRedis.fields.IRField)

    IRFixedPointField - A field which represents a real number (a whole part and a fractional part), such as 3.7 or 3.14159). Use this instead of an IRField(...valueType=float) to get accurate results across platforms, systems, and python versions, and to use for indexing. An IRFixedPointField is indexable, and has no option to hash the index.

Method resolution order:

IRFixedPointField

IndexedRedis.fields.IRField

builtins.str

builtins.object

Methods defined here:

__init__(self, name='', decimalPlaces=5, defaultValue=irNull)
__init__ - Create this object. @param name <str> - Field name (or blank if used in an IRFieldChain) @param decimalPlaces <int> - The number of decimal places to use (precision). Values will be rounded to this many places, and always have   this many digits after the decimal point. @param defaultValue - The default value for this field An IRFixedPointField is indexable, and has no option to hash the index.

copy(self)
copy - Create a copy of this IRField.   Each subclass should implement this, as you'll need to pass in the args to constructor. @return <IRField (or subclass)> - Another IRField that has all the same values as this one.

Static methods defined here:

__new__(self, name='', decimalPlaces=5, defaultValue=irNull)
Create and return a new object.  See help(type) for accurate signature.

Data and other attributes defined here:

CAN_INDEX = True

Methods inherited from IndexedRedis.fields.IRField:

__repr__(self)
__repr__ - Return an object-representation string of this field instance. You should NOT need to extend this on your IRField, instead just implement _getReprProperties   to return your type's specific properties associated with this instance.   @see _getReprProperties

convert = _deprecated_wrapper(*args, **kwargs)

fromInput(self, value)
fromInput - Convert the value from input (like assigning this through constructor or as an item assignment on the object @param value - Value to convert @return - Converted value

fromStorage(self, value)
fromStorage - Convert the value from storage to the value type. @param value - Value to convert @return - The converted value

getDefaultValue(self)
getDefaultValue - Gets the default value associated with this field.   This is the value used when no value has been explicitly set.   @return - The default value

toIndex(self, value)
toIndex - An optional method which will return the value prepped for index. By default, "toStorage" will be called. If you provide "hashIndex=True" on the constructor, the field will be md5summed for indexing purposes. This is useful for large strings, etc.

toStorage(self, value)
toStorage - Convert the value to a string representation for storage.   The default implementation will work here for basic types. @param value - The value of the item to convert @return A string value suitable for storing.

Data descriptors inherited from IndexedRedis.fields.IRField:

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

isIndexHashed

isIndexHashed - Returns if the index value should be hashed @return <bool> - True if this field should be hashed before indexing / filtering

name

name - Property, return this field's name @return <str> - Field name

Data and other attributes inherited from IndexedRedis.fields.IRField:

defaultValue = irNull

hashIndex = False

Methods inherited from builtins.str:

__add__(self, value, /)
Return self+value.

__contains__(self, key, /)
Return key in self.

__eq__(self, value, /)
Return self==value.

__format__(...)
S.__format__(format_spec) -> str Return a formatted version of S as described by format_spec.

__ge__(self, value, /)
Return self>=value.

__getattribute__(self, name, /)
Return getattr(self, name).

__getitem__(self, key, /)
Return self[key].

__getnewargs__(...)

__gt__(self, value, /)
Return self>value.

__hash__(self, /)
Return hash(self).

__iter__(self, /)
Implement iter(self).

__le__(self, value, /)
Return self<=value.

__len__(self, /)
Return len(self).

__lt__(self, value, /)
Return self<value.

__mod__(self, value, /)
Return self%value.

__mul__(self, value, /)
Return self*value.n

__ne__(self, value, /)
Return self!=value.

__rmod__(self, value, /)
Return value%self.

__rmul__(self, value, /)
Return self*value.

__sizeof__(...)
S.__sizeof__() -> size of S in memory, in bytes

__str__(self, /)
Return str(self).

capitalize(...)
S.capitalize() -> str Return a capitalized version of S, i.e. make the first character have upper case and the rest lower case.

casefold(...)
S.casefold() -> str Return a version of S suitable for caseless comparisons.

center(...)
S.center(width[, fillchar]) -> str Return S centered in a string of length width. Padding is done using the specified fill character (default is a space)

count(...)
S.count(sub[, start[, end]]) -> int 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(...)
S.encode(encoding='utf-8', errors='strict') -> bytes Encode S using the codec registered for encoding. Default encoding is 'utf-8'. errors may be given to set a different error handling scheme. 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(...)
S.endswith(suffix[, start[, end]]) -> bool 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(...)
S.expandtabs(tabsize=8) -> str Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find(...)
S.find(sub[, start[, end]]) -> int 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(...)
S.format(*args, **kwargs) -> str Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces ('{' and '}').

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

index(...)
S.index(sub[, start[, end]]) -> int Like S.find() but raise ValueError when the substring is not found.

isalnum(...)
S.isalnum() -> bool Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha(...)
S.isalpha() -> bool Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal(...)
S.isdecimal() -> bool Return True if there are only decimal characters in S, False otherwise.

isdigit(...)
S.isdigit() -> bool Return True if all characters in S are digits and there is at least one character in S, False otherwise.

isidentifier(...)
S.isidentifier() -> bool Return True if S is a valid identifier according to the language definition. Use keyword.iskeyword() to test for reserved identifiers such as "def" and "class".

islower(...)
S.islower() -> bool Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric(...)
S.isnumeric() -> bool Return True if there are only numeric characters in S, False otherwise.

isprintable(...)
S.isprintable() -> bool Return True if all characters in S are considered printable in repr() or S is empty, False otherwise.

isspace(...)
S.isspace() -> bool Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle(...)
S.istitle() -> bool Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper(...)
S.isupper() -> bool Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

join(...)
S.join(iterable) -> str Return a string which is the concatenation of the strings in the iterable.  The separator between elements is S.

ljust(...)
S.ljust(width[, fillchar]) -> str Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower(...)
S.lower() -> str Return a copy of the string S converted to lowercase.

lstrip(...)
S.lstrip([chars]) -> str Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead.

partition(...)
S.partition(sep) -> (head, sep, tail) Search for the separator sep in S, and return the part before it, the separator itself, and the part after it.  If the separator is not found, return S and two empty strings.

replace(...)
S.replace(old, new[, count]) -> str Return a copy of S with all occurrences of substring old replaced by new.  If the optional argument count is given, only the first count occurrences are replaced.

rfind(...)
S.rfind(sub[, start[, end]]) -> int 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(...)
S.rindex(sub[, start[, end]]) -> int Like S.rfind() but raise ValueError when the substring is not found.

rjust(...)
S.rjust(width[, fillchar]) -> str Return S right-justified in a string of length width. Padding is done using the specified fill character (default is a space).

rpartition(...)
S.rpartition(sep) -> (head, sep, tail) Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it.  If the separator is not found, return two empty strings and S.

rsplit(...)
S.rsplit(sep=None, maxsplit=-1) -> list of strings Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front.  If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip(...)
S.rstrip([chars]) -> str Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead.

split(...)
S.split(sep=None, maxsplit=-1) -> list of strings Return a list of the words in S, using sep as the delimiter string.  If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines(...)
S.splitlines([keepends]) -> list of strings Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith(...)
S.startswith(prefix[, start[, end]]) -> bool 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(...)
S.strip([chars]) -> str Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead.

swapcase(...)
S.swapcase() -> str Return a copy of S with uppercase characters converted to lowercase and vice versa.

title(...)
S.title() -> str Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate(...)
S.translate(table) -> str Return a copy of the string S in which each character has been mapped through the given translation table. The table must implement lookup/indexing via __getitem__, for instance a dictionary or list, mapping Unicode ordinals to Unicode ordinals, strings, or None. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.

upper(...)
S.upper() -> str Return a copy of S converted to uppercase.

zfill(...)
S.zfill(width) -> str Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Static methods inherited from builtins.str:

maketrans(x, y=None, z=None, /)
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.

class IRForeignLinkField(IRForeignLinkFieldBase)

    IRForeignLinkField - A field which provides a one-to-one mapping to another IndexedRedisModel object.

Method resolution order:

IRForeignLinkField

IRForeignLinkFieldBase

IndexedRedis.fields.IRField

builtins.str

builtins.object

Methods defined here:

__init__(self, name='', foreignModel=None)
__init__ - Create an IRForeignLinkField. Only takes a name @param name <str> - Field name This field type does not support indexing.

copy(self)
copy - Create a copy of this IRField.   Each subclass should implement this, as you'll need to pass in the args to constructor. @return <IRField (or subclass)> - Another IRField that has all the same values as this one.

isMulti(self)
isMulti - Returns True if this is a MultiLink object (expects lists), otherwise False (expects object) @return <bool>

Static methods defined here:

__new__(self, name='', foreignModel=None)
Create and return a new object.  See help(type) for accurate signature.

Data descriptors defined here:

foreignModel

foreignModel - Resolve and return the weakref to the associated Foreign Model

Data and other attributes defined here:

CAN_INDEX = True

Methods inherited from IndexedRedis.fields.IRField:

__repr__(self)
__repr__ - Return an object-representation string of this field instance. You should NOT need to extend this on your IRField, instead just implement _getReprProperties   to return your type's specific properties associated with this instance.   @see _getReprProperties

convert = _deprecated_wrapper(*args, **kwargs)

fromInput(self, value)
fromInput - Convert the value from input (like assigning this through constructor or as an item assignment on the object @param value - Value to convert @return - Converted value

fromStorage(self, value)
fromStorage - Convert the value from storage to the value type. @param value - Value to convert @return - The converted value

getDefaultValue(self)
getDefaultValue - Gets the default value associated with this field.   This is the value used when no value has been explicitly set.   @return - The default value

toIndex(self, value)
toIndex - An optional method which will return the value prepped for index. By default, "toStorage" will be called. If you provide "hashIndex=True" on the constructor, the field will be md5summed for indexing purposes. This is useful for large strings, etc.

toStorage(self, value)
toStorage - Convert the value to a string representation for storage.   The default implementation will work here for basic types. @param value - The value of the item to convert @return A string value suitable for storing.

Data descriptors inherited from IndexedRedis.fields.IRField:

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

isIndexHashed

isIndexHashed - Returns if the index value should be hashed @return <bool> - True if this field should be hashed before indexing / filtering

name

name - Property, return this field's name @return <str> - Field name

Data and other attributes inherited from IndexedRedis.fields.IRField:

defaultValue = irNull

hashIndex = False

Methods inherited from builtins.str:

__add__(self, value, /)
Return self+value.

__contains__(self, key, /)
Return key in self.

__eq__(self, value, /)
Return self==value.

__format__(...)
S.__format__(format_spec) -> str Return a formatted version of S as described by format_spec.

__ge__(self, value, /)
Return self>=value.

__getattribute__(self, name, /)
Return getattr(self, name).

__getitem__(self, key, /)
Return self[key].

__getnewargs__(...)

__gt__(self, value, /)
Return self>value.

__hash__(self, /)
Return hash(self).

__iter__(self, /)
Implement iter(self).

__le__(self, value, /)
Return self<=value.

__len__(self, /)
Return len(self).

__lt__(self, value, /)
Return self<value.

__mod__(self, value, /)
Return self%value.

__mul__(self, value, /)
Return self*value.n

__ne__(self, value, /)
Return self!=value.

__rmod__(self, value, /)
Return value%self.

__rmul__(self, value, /)
Return self*value.

__sizeof__(...)
S.__sizeof__() -> size of S in memory, in bytes

__str__(self, /)
Return str(self).

capitalize(...)
S.capitalize() -> str Return a capitalized version of S, i.e. make the first character have upper case and the rest lower case.

casefold(...)
S.casefold() -> str Return a version of S suitable for caseless comparisons.

center(...)
S.center(width[, fillchar]) -> str Return S centered in a string of length width. Padding is done using the specified fill character (default is a space)

count(...)
S.count(sub[, start[, end]]) -> int 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(...)
S.encode(encoding='utf-8', errors='strict') -> bytes Encode S using the codec registered for encoding. Default encoding is 'utf-8'. errors may be given to set a different error handling scheme. 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(...)
S.endswith(suffix[, start[, end]]) -> bool 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(...)
S.expandtabs(tabsize=8) -> str Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find(...)
S.find(sub[, start[, end]]) -> int 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(...)
S.format(*args, **kwargs) -> str Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces ('{' and '}').

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

index(...)
S.index(sub[, start[, end]]) -> int Like S.find() but raise ValueError when the substring is not found.

isalnum(...)
S.isalnum() -> bool Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha(...)
S.isalpha() -> bool Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal(...)
S.isdecimal() -> bool Return True if there are only decimal characters in S, False otherwise.

isdigit(...)
S.isdigit() -> bool Return True if all characters in S are digits and there is at least one character in S, False otherwise.

isidentifier(...)
S.isidentifier() -> bool Return True if S is a valid identifier according to the language definition. Use keyword.iskeyword() to test for reserved identifiers such as "def" and "class".

islower(...)
S.islower() -> bool Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric(...)
S.isnumeric() -> bool Return True if there are only numeric characters in S, False otherwise.

isprintable(...)
S.isprintable() -> bool Return True if all characters in S are considered printable in repr() or S is empty, False otherwise.

isspace(...)
S.isspace() -> bool Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle(...)
S.istitle() -> bool Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper(...)
S.isupper() -> bool Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

join(...)
S.join(iterable) -> str Return a string which is the concatenation of the strings in the iterable.  The separator between elements is S.

ljust(...)
S.ljust(width[, fillchar]) -> str Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower(...)
S.lower() -> str Return a copy of the string S converted to lowercase.

lstrip(...)
S.lstrip([chars]) -> str Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead.

partition(...)
S.partition(sep) -> (head, sep, tail) Search for the separator sep in S, and return the part before it, the separator itself, and the part after it.  If the separator is not found, return S and two empty strings.

replace(...)
S.replace(old, new[, count]) -> str Return a copy of S with all occurrences of substring old replaced by new.  If the optional argument count is given, only the first count occurrences are replaced.

rfind(...)
S.rfind(sub[, start[, end]]) -> int 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(...)
S.rindex(sub[, start[, end]]) -> int Like S.rfind() but raise ValueError when the substring is not found.

rjust(...)
S.rjust(width[, fillchar]) -> str Return S right-justified in a string of length width. Padding is done using the specified fill character (default is a space).

rpartition(...)
S.rpartition(sep) -> (head, sep, tail) Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it.  If the separator is not found, return two empty strings and S.

rsplit(...)
S.rsplit(sep=None, maxsplit=-1) -> list of strings Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front.  If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip(...)
S.rstrip([chars]) -> str Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead.

split(...)
S.split(sep=None, maxsplit=-1) -> list of strings Return a list of the words in S, using sep as the delimiter string.  If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines(...)
S.splitlines([keepends]) -> list of strings Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith(...)
S.startswith(prefix[, start[, end]]) -> bool 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(...)
S.strip([chars]) -> str Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead.

swapcase(...)
S.swapcase() -> str Return a copy of S with uppercase characters converted to lowercase and vice versa.

title(...)
S.title() -> str Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate(...)
S.translate(table) -> str Return a copy of the string S in which each character has been mapped through the given translation table. The table must implement lookup/indexing via __getitem__, for instance a dictionary or list, mapping Unicode ordinals to Unicode ordinals, strings, or None. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.

upper(...)
S.upper() -> str Return a copy of S converted to uppercase.

zfill(...)
S.zfill(width) -> str Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Static methods inherited from builtins.str:

maketrans(x, y=None, z=None, /)
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.

class IRForeignLinkFieldBase(IndexedRedis.fields.IRField)

    IRForeignLinkFieldBase - Base class for Foreign Link fields

Method resolution order:

IRForeignLinkFieldBase

IndexedRedis.fields.IRField

builtins.str

builtins.object

Methods inherited from IndexedRedis.fields.IRField:

__init__(self, name='', valueType=<class 'str'>, defaultValue=irNull, hashIndex=False)
__init__ - Create an IRField. Use this directly in the FIELDS array for advanced functionality on a field. @param name <str> - The name of this field @param valueType <type> - The type that will be used for this field. Default str/unicode (and bytes on python2)         act the same as non-IRField FIELDS entries (just plain string), i.e. they are encoded to unicode to and from Redis.         If you pass in None, then no decoding will take place (so whatever you provide goes in, and bytes come out of Redis).         This is similar to IRFieldRaw         On python3, if you pass bytes, than the field will be left as bytes.         To be both python2 and python3 compatible, however, you can use IRBytesField         If bool is used, then "1" and "true" are True, "0" and "false" are False, any other value is an exception.         You can also pass an advanced type (see IndexedRedis.fields.FieldValueTypes) like datetime and json.         All types other than string/unicode/bytes/None will be assigned 'irNull' if they were not provided a value.         @see irNull - Equals only irNull (or other IRNullType instances). You can use this to check if an integer is defined versus 0, for example.         While this class is create for primitive types (like int's and datetimes), more complex types extend IRField (such as pickle, compressed, or unicode with a specific encoding). @param defaultValue <any> (default irNull) - The value assigned to this field as a "default", i.e. when no value has yet been set. Generally, it makes sense to keep this as irNull, but you may want a different default. @param hashIndex <bool> (default False) - If true, the md5 hash of the value will be used for indexing and filtering. This may be useful for very long fields. An IRField may be indexable (depending on the type), and has the option to hash the index NOTE: If you are extending IRField, you should probably not call this __init__ function. So long as you implement your own "convert", any fields used are set on a class-level.

__repr__(self)
__repr__ - Return an object-representation string of this field instance. You should NOT need to extend this on your IRField, instead just implement _getReprProperties   to return your type's specific properties associated with this instance.   @see _getReprProperties

convert = _deprecated_wrapper(*args, **kwargs)

copy(self)
copy - Create a copy of this IRField.   Each subclass should implement this, as you'll need to pass in the args to constructor. @return <IRField (or subclass)> - Another IRField that has all the same values as this one.

fromInput(self, value)
fromInput - Convert the value from input (like assigning this through constructor or as an item assignment on the object @param value - Value to convert @return - Converted value

fromStorage(self, value)
fromStorage - Convert the value from storage to the value type. @param value - Value to convert @return - The converted value

getDefaultValue(self)
getDefaultValue - Gets the default value associated with this field.   This is the value used when no value has been explicitly set.   @return - The default value

toIndex(self, value)
toIndex - An optional method which will return the value prepped for index. By default, "toStorage" will be called. If you provide "hashIndex=True" on the constructor, the field will be md5summed for indexing purposes. This is useful for large strings, etc.

toStorage(self, value)
toStorage - Convert the value to a string representation for storage.   The default implementation will work here for basic types. @param value - The value of the item to convert @return A string value suitable for storing.

Static methods inherited from IndexedRedis.fields.IRField:

__new__(self, name='', valueType=None, defaultValue=irNull, hashIndex=False)
Create and return a new object.  See help(type) for accurate signature.

Data descriptors inherited from IndexedRedis.fields.IRField:

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

isIndexHashed

isIndexHashed - Returns if the index value should be hashed @return <bool> - True if this field should be hashed before indexing / filtering

name

name - Property, return this field's name @return <str> - Field name

Data and other attributes inherited from IndexedRedis.fields.IRField:

CAN_INDEX = False

defaultValue = irNull

hashIndex = False

Methods inherited from builtins.str:

__add__(self, value, /)
Return self+value.

__contains__(self, key, /)
Return key in self.

__eq__(self, value, /)
Return self==value.

__format__(...)
S.__format__(format_spec) -> str Return a formatted version of S as described by format_spec.

__ge__(self, value, /)
Return self>=value.

__getattribute__(self, name, /)
Return getattr(self, name).

__getitem__(self, key, /)
Return self[key].

__getnewargs__(...)

__gt__(self, value, /)
Return self>value.

__hash__(self, /)
Return hash(self).

__iter__(self, /)
Implement iter(self).

__le__(self, value, /)
Return self<=value.

__len__(self, /)
Return len(self).

__lt__(self, value, /)
Return self<value.

__mod__(self, value, /)
Return self%value.

__mul__(self, value, /)
Return self*value.n

__ne__(self, value, /)
Return self!=value.

__rmod__(self, value, /)
Return value%self.

__rmul__(self, value, /)
Return self*value.

__sizeof__(...)
S.__sizeof__() -> size of S in memory, in bytes

__str__(self, /)
Return str(self).

capitalize(...)
S.capitalize() -> str Return a capitalized version of S, i.e. make the first character have upper case and the rest lower case.

casefold(...)
S.casefold() -> str Return a version of S suitable for caseless comparisons.

center(...)
S.center(width[, fillchar]) -> str Return S centered in a string of length width. Padding is done using the specified fill character (default is a space)

count(...)
S.count(sub[, start[, end]]) -> int 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(...)
S.encode(encoding='utf-8', errors='strict') -> bytes Encode S using the codec registered for encoding. Default encoding is 'utf-8'. errors may be given to set a different error handling scheme. 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(...)
S.endswith(suffix[, start[, end]]) -> bool 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(...)
S.expandtabs(tabsize=8) -> str Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find(...)
S.find(sub[, start[, end]]) -> int 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(...)
S.format(*args, **kwargs) -> str Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces ('{' and '}').

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

index(...)
S.index(sub[, start[, end]]) -> int Like S.find() but raise ValueError when the substring is not found.

isalnum(...)
S.isalnum() -> bool Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha(...)
S.isalpha() -> bool Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal(...)
S.isdecimal() -> bool Return True if there are only decimal characters in S, False otherwise.

isdigit(...)
S.isdigit() -> bool Return True if all characters in S are digits and there is at least one character in S, False otherwise.

isidentifier(...)
S.isidentifier() -> bool Return True if S is a valid identifier according to the language definition. Use keyword.iskeyword() to test for reserved identifiers such as "def" and "class".

islower(...)
S.islower() -> bool Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric(...)
S.isnumeric() -> bool Return True if there are only numeric characters in S, False otherwise.

isprintable(...)
S.isprintable() -> bool Return True if all characters in S are considered printable in repr() or S is empty, False otherwise.

isspace(...)
S.isspace() -> bool Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle(...)
S.istitle() -> bool Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper(...)
S.isupper() -> bool Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

join(...)
S.join(iterable) -> str Return a string which is the concatenation of the strings in the iterable.  The separator between elements is S.

ljust(...)
S.ljust(width[, fillchar]) -> str Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower(...)
S.lower() -> str Return a copy of the string S converted to lowercase.

lstrip(...)
S.lstrip([chars]) -> str Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead.

partition(...)
S.partition(sep) -> (head, sep, tail) Search for the separator sep in S, and return the part before it, the separator itself, and the part after it.  If the separator is not found, return S and two empty strings.

replace(...)
S.replace(old, new[, count]) -> str Return a copy of S with all occurrences of substring old replaced by new.  If the optional argument count is given, only the first count occurrences are replaced.

rfind(...)
S.rfind(sub[, start[, end]]) -> int 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(...)
S.rindex(sub[, start[, end]]) -> int Like S.rfind() but raise ValueError when the substring is not found.

rjust(...)
S.rjust(width[, fillchar]) -> str Return S right-justified in a string of length width. Padding is done using the specified fill character (default is a space).

rpartition(...)
S.rpartition(sep) -> (head, sep, tail) Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it.  If the separator is not found, return two empty strings and S.

rsplit(...)
S.rsplit(sep=None, maxsplit=-1) -> list of strings Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front.  If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip(...)
S.rstrip([chars]) -> str Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead.

split(...)
S.split(sep=None, maxsplit=-1) -> list of strings Return a list of the words in S, using sep as the delimiter string.  If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines(...)
S.splitlines([keepends]) -> list of strings Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith(...)
S.startswith(prefix[, start[, end]]) -> bool 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(...)
S.strip([chars]) -> str Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead.

swapcase(...)
S.swapcase() -> str Return a copy of S with uppercase characters converted to lowercase and vice versa.

title(...)
S.title() -> str Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate(...)
S.translate(table) -> str Return a copy of the string S in which each character has been mapped through the given translation table. The table must implement lookup/indexing via __getitem__, for instance a dictionary or list, mapping Unicode ordinals to Unicode ordinals, strings, or None. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.

upper(...)
S.upper() -> str Return a copy of S converted to uppercase.

zfill(...)
S.zfill(width) -> str Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Static methods inherited from builtins.str:

maketrans(x, y=None, z=None, /)
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.

class IRForeignMultiLinkField(IRForeignLinkField)

    IRForeignMultiLinkField - A field which links to a list of foreign objects

Method resolution order:

IRForeignMultiLinkField

IRForeignLinkField

IRForeignLinkFieldBase

IndexedRedis.fields.IRField

builtins.str

builtins.object

Methods defined here:

isMulti(self)
isMulti - Returns True if this is a MultiLink object (expects lists), otherwise False (expects object) @return <bool>

Data and other attributes defined here:

CAN_INDEX = True

Methods inherited from IRForeignLinkField:

__init__(self, name='', foreignModel=None)
__init__ - Create an IRForeignLinkField. Only takes a name @param name <str> - Field name This field type does not support indexing.

copy(self)
copy - Create a copy of this IRField.   Each subclass should implement this, as you'll need to pass in the args to constructor. @return <IRField (or subclass)> - Another IRField that has all the same values as this one.

Static methods inherited from IRForeignLinkField:

__new__(self, name='', foreignModel=None)
Create and return a new object.  See help(type) for accurate signature.

Data descriptors inherited from IRForeignLinkField:

foreignModel

foreignModel - Resolve and return the weakref to the associated Foreign Model

Methods inherited from IndexedRedis.fields.IRField:

__repr__(self)
__repr__ - Return an object-representation string of this field instance. You should NOT need to extend this on your IRField, instead just implement _getReprProperties   to return your type's specific properties associated with this instance.   @see _getReprProperties

convert = _deprecated_wrapper(*args, **kwargs)

fromInput(self, value)
fromInput - Convert the value from input (like assigning this through constructor or as an item assignment on the object @param value - Value to convert @return - Converted value

fromStorage(self, value)
fromStorage - Convert the value from storage to the value type. @param value - Value to convert @return - The converted value

getDefaultValue(self)
getDefaultValue - Gets the default value associated with this field.   This is the value used when no value has been explicitly set.   @return - The default value

toIndex(self, value)
toIndex - An optional method which will return the value prepped for index. By default, "toStorage" will be called. If you provide "hashIndex=True" on the constructor, the field will be md5summed for indexing purposes. This is useful for large strings, etc.

toStorage(self, value)
toStorage - Convert the value to a string representation for storage.   The default implementation will work here for basic types. @param value - The value of the item to convert @return A string value suitable for storing.

Data descriptors inherited from IndexedRedis.fields.IRField:

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

isIndexHashed

isIndexHashed - Returns if the index value should be hashed @return <bool> - True if this field should be hashed before indexing / filtering

name

name - Property, return this field's name @return <str> - Field name

Data and other attributes inherited from IndexedRedis.fields.IRField:

defaultValue = irNull

hashIndex = False

Methods inherited from builtins.str:

__add__(self, value, /)
Return self+value.

__contains__(self, key, /)
Return key in self.

__eq__(self, value, /)
Return self==value.

__format__(...)
S.__format__(format_spec) -> str Return a formatted version of S as described by format_spec.

__ge__(self, value, /)
Return self>=value.

__getattribute__(self, name, /)
Return getattr(self, name).

__getitem__(self, key, /)
Return self[key].

__getnewargs__(...)

__gt__(self, value, /)
Return self>value.

__hash__(self, /)
Return hash(self).

__iter__(self, /)
Implement iter(self).

__le__(self, value, /)
Return self<=value.

__len__(self, /)
Return len(self).

__lt__(self, value, /)
Return self<value.

__mod__(self, value, /)
Return self%value.

__mul__(self, value, /)
Return self*value.n

__ne__(self, value, /)
Return self!=value.

__rmod__(self, value, /)
Return value%self.

__rmul__(self, value, /)
Return self*value.

__sizeof__(...)
S.__sizeof__() -> size of S in memory, in bytes

__str__(self, /)
Return str(self).

capitalize(...)
S.capitalize() -> str Return a capitalized version of S, i.e. make the first character have upper case and the rest lower case.

casefold(...)
S.casefold() -> str Return a version of S suitable for caseless comparisons.

center(...)
S.center(width[, fillchar]) -> str Return S centered in a string of length width. Padding is done using the specified fill character (default is a space)

count(...)
S.count(sub[, start[, end]]) -> int 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(...)
S.encode(encoding='utf-8', errors='strict') -> bytes Encode S using the codec registered for encoding. Default encoding is 'utf-8'. errors may be given to set a different error handling scheme. 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(...)
S.endswith(suffix[, start[, end]]) -> bool 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(...)
S.expandtabs(tabsize=8) -> str Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find(...)
S.find(sub[, start[, end]]) -> int 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(...)
S.format(*args, **kwargs) -> str Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces ('{' and '}').

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

index(...)
S.index(sub[, start[, end]]) -> int Like S.find() but raise ValueError when the substring is not found.

isalnum(...)
S.isalnum() -> bool Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha(...)
S.isalpha() -> bool Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal(...)
S.isdecimal() -> bool Return True if there are only decimal characters in S, False otherwise.

isdigit(...)
S.isdigit() -> bool Return True if all characters in S are digits and there is at least one character in S, False otherwise.

isidentifier(...)
S.isidentifier() -> bool Return True if S is a valid identifier according to the language definition. Use keyword.iskeyword() to test for reserved identifiers such as "def" and "class".

islower(...)
S.islower() -> bool Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric(...)
S.isnumeric() -> bool Return True if there are only numeric characters in S, False otherwise.

isprintable(...)
S.isprintable() -> bool Return True if all characters in S are considered printable in repr() or S is empty, False otherwise.

isspace(...)
S.isspace() -> bool Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle(...)
S.istitle() -> bool Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper(...)
S.isupper() -> bool Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

join(...)
S.join(iterable) -> str Return a string which is the concatenation of the strings in the iterable.  The separator between elements is S.

ljust(...)
S.ljust(width[, fillchar]) -> str Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower(...)
S.lower() -> str Return a copy of the string S converted to lowercase.

lstrip(...)
S.lstrip([chars]) -> str Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead.

partition(...)
S.partition(sep) -> (head, sep, tail) Search for the separator sep in S, and return the part before it, the separator itself, and the part after it.  If the separator is not found, return S and two empty strings.

replace(...)
S.replace(old, new[, count]) -> str Return a copy of S with all occurrences of substring old replaced by new.  If the optional argument count is given, only the first count occurrences are replaced.

rfind(...)
S.rfind(sub[, start[, end]]) -> int 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(...)
S.rindex(sub[, start[, end]]) -> int Like S.rfind() but raise ValueError when the substring is not found.

rjust(...)
S.rjust(width[, fillchar]) -> str Return S right-justified in a string of length width. Padding is done using the specified fill character (default is a space).

rpartition(...)
S.rpartition(sep) -> (head, sep, tail) Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it.  If the separator is not found, return two empty strings and S.

rsplit(...)
S.rsplit(sep=None, maxsplit=-1) -> list of strings Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front.  If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip(...)
S.rstrip([chars]) -> str Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead.

split(...)
S.split(sep=None, maxsplit=-1) -> list of strings Return a list of the words in S, using sep as the delimiter string.  If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines(...)
S.splitlines([keepends]) -> list of strings Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith(...)
S.startswith(prefix[, start[, end]]) -> bool 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(...)
S.strip([chars]) -> str Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead.

swapcase(...)
S.swapcase() -> str Return a copy of S with uppercase characters converted to lowercase and vice versa.

title(...)
S.title() -> str Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate(...)
S.translate(table) -> str Return a copy of the string S in which each character has been mapped through the given translation table. The table must implement lookup/indexing via __getitem__, for instance a dictionary or list, mapping Unicode ordinals to Unicode ordinals, strings, or None. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.

upper(...)
S.upper() -> str Return a copy of S converted to uppercase.

zfill(...)
S.zfill(width) -> str Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Static methods inherited from builtins.str:

maketrans(x, y=None, z=None, /)
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.

class IRJsonValue(builtins.type)

    IRJsonValue - A value which is interpreted as json.     Supports object (dicts), strings, array, number. "null" is supported using IRNullType, because cannot subclass "NoneType". "bool" is supported using a number 0.0 or 1.0 - because cannot subclass "bool"

Method resolution order:

IRJsonValue

builtins.type

builtins.object

Methods defined here:

__init__(self, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.

__str__(self)
Return str(self).

Static methods defined here:

__new__(self, *args, **kwargs)
Create and return a new object.  See help(type) for accurate signature.

Data and other attributes defined here:

CAN_INDEX = False

Methods inherited from builtins.type:

__call__(self, /, *args, **kwargs)
Call self as a function.

__delattr__(self, name, /)
Implement delattr(self, name).

__dir__(...)
__dir__() -> list specialized __dir__ implementation for types

__getattribute__(self, name, /)
Return getattr(self, name).

__instancecheck__(...)
__instancecheck__() -> bool check if an object is an instance

__prepare__(...) from builtins.type
__prepare__() -> dict used to create the namespace for the class statement

__repr__(self, /)
Return repr(self).

__setattr__(self, name, value, /)
Implement setattr(self, name, value).

__sizeof__(...)
__sizeof__() -> int return memory consumption of the type object

__subclasscheck__(...)
__subclasscheck__() -> bool check if a class is a subclass

__subclasses__(...)
__subclasses__() -> list of immediate subclasses

mro(...)
mro() -> list return a type's method resolution order

Data descriptors inherited from builtins.type:

__abstractmethods__

__dict__

__text_signature__

Data and other attributes inherited from builtins.type:

__base__ = <class 'type'>
type(object_or_name, bases, dict) type(object) -> the object's type type(name, bases, dict) -> a new type

__bases__ = (<class 'type'>,)

__basicsize__ = 864

__dictoffset__ = 264

__flags__ = 2148292097

__itemsize__ = 40

__mro__ = (<class 'IndexedRedis.fields.FieldValueTypes.IRJsonValue'>, <class 'type'>, <class 'object'>)

__weakrefoffset__ = 368

class IRNullType(builtins.str)

    The type to represent NULL for anything except string which has no NULL. Values of this type only equal other values of this type (i.e. '' does not equal IRNullType()) Even False does not equal IRNull. You probably shouldn't ever need to use this directly, instead use the static instance, "irNull", defined in this module.

Method resolution order:

IRNullType

builtins.str

builtins.object

Methods defined here:

__bool__(self)

__eq__(self, otherVal)
Return self==value.

__ne__(self, otherVal)
Return self!=value.

__nonzero__(self)

__repr__(self)
Return repr(self).

__str__(self)
Return str(self).

Static methods defined here:

__new__(self, val='')
Don't let this be assigned a value.

Data descriptors defined here:

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

Data and other attributes defined here:

__hash__ = None

Methods inherited from builtins.str:

__add__(self, value, /)
Return self+value.

__contains__(self, key, /)
Return key in self.

__format__(...)
S.__format__(format_spec) -> str Return a formatted version of S as described by format_spec.

__ge__(self, value, /)
Return self>=value.

__getattribute__(self, name, /)
Return getattr(self, name).

__getitem__(self, key, /)
Return self[key].

__getnewargs__(...)

__gt__(self, value, /)
Return self>value.

__iter__(self, /)
Implement iter(self).

__le__(self, value, /)
Return self<=value.

__len__(self, /)
Return len(self).

__lt__(self, value, /)
Return self<value.

__mod__(self, value, /)
Return self%value.

__mul__(self, value, /)
Return self*value.n

__rmod__(self, value, /)
Return value%self.

__rmul__(self, value, /)
Return self*value.

__sizeof__(...)
S.__sizeof__() -> size of S in memory, in bytes

capitalize(...)
S.capitalize() -> str Return a capitalized version of S, i.e. make the first character have upper case and the rest lower case.

casefold(...)
S.casefold() -> str Return a version of S suitable for caseless comparisons.

center(...)
S.center(width[, fillchar]) -> str Return S centered in a string of length width. Padding is done using the specified fill character (default is a space)

count(...)
S.count(sub[, start[, end]]) -> int 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(...)
S.encode(encoding='utf-8', errors='strict') -> bytes Encode S using the codec registered for encoding. Default encoding is 'utf-8'. errors may be given to set a different error handling scheme. 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(...)
S.endswith(suffix[, start[, end]]) -> bool 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(...)
S.expandtabs(tabsize=8) -> str Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find(...)
S.find(sub[, start[, end]]) -> int 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(...)
S.format(*args, **kwargs) -> str Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces ('{' and '}').

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

index(...)
S.index(sub[, start[, end]]) -> int Like S.find() but raise ValueError when the substring is not found.

isalnum(...)
S.isalnum() -> bool Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha(...)
S.isalpha() -> bool Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal(...)
S.isdecimal() -> bool Return True if there are only decimal characters in S, False otherwise.

isdigit(...)
S.isdigit() -> bool Return True if all characters in S are digits and there is at least one character in S, False otherwise.

isidentifier(...)
S.isidentifier() -> bool Return True if S is a valid identifier according to the language definition. Use keyword.iskeyword() to test for reserved identifiers such as "def" and "class".

islower(...)
S.islower() -> bool Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric(...)
S.isnumeric() -> bool Return True if there are only numeric characters in S, False otherwise.

isprintable(...)
S.isprintable() -> bool Return True if all characters in S are considered printable in repr() or S is empty, False otherwise.

isspace(...)
S.isspace() -> bool Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle(...)
S.istitle() -> bool Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper(...)
S.isupper() -> bool Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

join(...)
S.join(iterable) -> str Return a string which is the concatenation of the strings in the iterable.  The separator between elements is S.

ljust(...)
S.ljust(width[, fillchar]) -> str Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower(...)
S.lower() -> str Return a copy of the string S converted to lowercase.

lstrip(...)
S.lstrip([chars]) -> str Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead.

partition(...)
S.partition(sep) -> (head, sep, tail) Search for the separator sep in S, and return the part before it, the separator itself, and the part after it.  If the separator is not found, return S and two empty strings.

replace(...)
S.replace(old, new[, count]) -> str Return a copy of S with all occurrences of substring old replaced by new.  If the optional argument count is given, only the first count occurrences are replaced.

rfind(...)
S.rfind(sub[, start[, end]]) -> int 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(...)
S.rindex(sub[, start[, end]]) -> int Like S.rfind() but raise ValueError when the substring is not found.

rjust(...)
S.rjust(width[, fillchar]) -> str Return S right-justified in a string of length width. Padding is done using the specified fill character (default is a space).

rpartition(...)
S.rpartition(sep) -> (head, sep, tail) Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it.  If the separator is not found, return two empty strings and S.

rsplit(...)
S.rsplit(sep=None, maxsplit=-1) -> list of strings Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front.  If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip(...)
S.rstrip([chars]) -> str Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead.

split(...)
S.split(sep=None, maxsplit=-1) -> list of strings Return a list of the words in S, using sep as the delimiter string.  If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines(...)
S.splitlines([keepends]) -> list of strings Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith(...)
S.startswith(prefix[, start[, end]]) -> bool 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(...)
S.strip([chars]) -> str Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead.

swapcase(...)
S.swapcase() -> str Return a copy of S with uppercase characters converted to lowercase and vice versa.

title(...)
S.title() -> str Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate(...)
S.translate(table) -> str Return a copy of the string S in which each character has been mapped through the given translation table. The table must implement lookup/indexing via __getitem__, for instance a dictionary or list, mapping Unicode ordinals to Unicode ordinals, strings, or None. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.

upper(...)
S.upper() -> str Return a copy of S converted to uppercase.

zfill(...)
S.zfill(width) -> str Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Static methods inherited from builtins.str:

maketrans(x, y=None, z=None, /)
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.

class IRPickleField(IndexedRedis.fields.IRField)

    IRPickleField - A field which pickles its data before storage and loads after retrieval. This uses the python2 format, so is safe to use between python2 and python3. Because even with the same format, python2 and python3 can output different pickle strings for the same object,   as well as different host configurations may lead to different output, this field type is not indexable.

Method resolution order:

IRPickleField

IndexedRedis.fields.IRField

builtins.str

builtins.object

Methods defined here:

__init__(self, name='', defaultValue=irNull)
__init__ - Create an IRPickleField @param name <str> - Field name @param defaultValue - The default value of this field Because even with the same format, python2 and python3 can output different pickle strings for the same object,   as well as different host configurations may lead to different output, this field type is not indexable.

copy(self)
copy - Create a copy of this IRField.   Each subclass should implement this, as you'll need to pass in the args to constructor. @return <IRField (or subclass)> - Another IRField that has all the same values as this one.

Static methods defined here:

__new__(self, name='', defaultValue=irNull)
Create and return a new object.  See help(type) for accurate signature.

Data and other attributes defined here:

CAN_INDEX = False

Methods inherited from IndexedRedis.fields.IRField:

__repr__(self)
__repr__ - Return an object-representation string of this field instance. You should NOT need to extend this on your IRField, instead just implement _getReprProperties   to return your type's specific properties associated with this instance.   @see _getReprProperties

convert = _deprecated_wrapper(*args, **kwargs)

fromInput(self, value)
fromInput - Convert the value from input (like assigning this through constructor or as an item assignment on the object @param value - Value to convert @return - Converted value

fromStorage(self, value)
fromStorage - Convert the value from storage to the value type. @param value - Value to convert @return - The converted value

getDefaultValue(self)
getDefaultValue - Gets the default value associated with this field.   This is the value used when no value has been explicitly set.   @return - The default value

toIndex(self, value)
toIndex - An optional method which will return the value prepped for index. By default, "toStorage" will be called. If you provide "hashIndex=True" on the constructor, the field will be md5summed for indexing purposes. This is useful for large strings, etc.

toStorage(self, value)
toStorage - Convert the value to a string representation for storage.   The default implementation will work here for basic types. @param value - The value of the item to convert @return A string value suitable for storing.

Data descriptors inherited from IndexedRedis.fields.IRField:

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

isIndexHashed

isIndexHashed - Returns if the index value should be hashed @return <bool> - True if this field should be hashed before indexing / filtering

name

name - Property, return this field's name @return <str> - Field name

Data and other attributes inherited from IndexedRedis.fields.IRField:

defaultValue = irNull

hashIndex = False

Methods inherited from builtins.str:

__add__(self, value, /)
Return self+value.

__contains__(self, key, /)
Return key in self.

__eq__(self, value, /)
Return self==value.

__format__(...)
S.__format__(format_spec) -> str Return a formatted version of S as described by format_spec.

__ge__(self, value, /)
Return self>=value.

__getattribute__(self, name, /)
Return getattr(self, name).

__getitem__(self, key, /)
Return self[key].

__getnewargs__(...)

__gt__(self, value, /)
Return self>value.

__hash__(self, /)
Return hash(self).

__iter__(self, /)
Implement iter(self).

__le__(self, value, /)
Return self<=value.

__len__(self, /)
Return len(self).

__lt__(self, value, /)
Return self<value.

__mod__(self, value, /)
Return self%value.

__mul__(self, value, /)
Return self*value.n

__ne__(self, value, /)
Return self!=value.

__rmod__(self, value, /)
Return value%self.

__rmul__(self, value, /)
Return self*value.

__sizeof__(...)
S.__sizeof__() -> size of S in memory, in bytes

__str__(self, /)
Return str(self).

capitalize(...)
S.capitalize() -> str Return a capitalized version of S, i.e. make the first character have upper case and the rest lower case.

casefold(...)
S.casefold() -> str Return a version of S suitable for caseless comparisons.

center(...)
S.center(width[, fillchar]) -> str Return S centered in a string of length width. Padding is done using the specified fill character (default is a space)

count(...)
S.count(sub[, start[, end]]) -> int 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(...)
S.encode(encoding='utf-8', errors='strict') -> bytes Encode S using the codec registered for encoding. Default encoding is 'utf-8'. errors may be given to set a different error handling scheme. 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(...)
S.endswith(suffix[, start[, end]]) -> bool 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(...)
S.expandtabs(tabsize=8) -> str Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find(...)
S.find(sub[, start[, end]]) -> int 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(...)
S.format(*args, **kwargs) -> str Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces ('{' and '}').

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

index(...)
S.index(sub[, start[, end]]) -> int Like S.find() but raise ValueError when the substring is not found.

isalnum(...)
S.isalnum() -> bool Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha(...)
S.isalpha() -> bool Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal(...)
S.isdecimal() -> bool Return True if there are only decimal characters in S, False otherwise.

isdigit(...)
S.isdigit() -> bool Return True if all characters in S are digits and there is at least one character in S, False otherwise.

isidentifier(...)
S.isidentifier() -> bool Return True if S is a valid identifier according to the language definition. Use keyword.iskeyword() to test for reserved identifiers such as "def" and "class".

islower(...)
S.islower() -> bool Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric(...)
S.isnumeric() -> bool Return True if there are only numeric characters in S, False otherwise.

isprintable(...)
S.isprintable() -> bool Return True if all characters in S are considered printable in repr() or S is empty, False otherwise.

isspace(...)
S.isspace() -> bool Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle(...)
S.istitle() -> bool Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper(...)
S.isupper() -> bool Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

join(...)
S.join(iterable) -> str Return a string which is the concatenation of the strings in the iterable.  The separator between elements is S.

ljust(...)
S.ljust(width[, fillchar]) -> str Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower(...)
S.lower() -> str Return a copy of the string S converted to lowercase.

lstrip(...)
S.lstrip([chars]) -> str Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead.

partition(...)
S.partition(sep) -> (head, sep, tail) Search for the separator sep in S, and return the part before it, the separator itself, and the part after it.  If the separator is not found, return S and two empty strings.

replace(...)
S.replace(old, new[, count]) -> str Return a copy of S with all occurrences of substring old replaced by new.  If the optional argument count is given, only the first count occurrences are replaced.

rfind(...)
S.rfind(sub[, start[, end]]) -> int 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(...)
S.rindex(sub[, start[, end]]) -> int Like S.rfind() but raise ValueError when the substring is not found.

rjust(...)
S.rjust(width[, fillchar]) -> str Return S right-justified in a string of length width. Padding is done using the specified fill character (default is a space).

rpartition(...)
S.rpartition(sep) -> (head, sep, tail) Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it.  If the separator is not found, return two empty strings and S.

rsplit(...)
S.rsplit(sep=None, maxsplit=-1) -> list of strings Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front.  If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip(...)
S.rstrip([chars]) -> str Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead.

split(...)
S.split(sep=None, maxsplit=-1) -> list of strings Return a list of the words in S, using sep as the delimiter string.  If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines(...)
S.splitlines([keepends]) -> list of strings Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith(...)
S.startswith(prefix[, start[, end]]) -> bool 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(...)
S.strip([chars]) -> str Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead.

swapcase(...)
S.swapcase() -> str Return a copy of S with uppercase characters converted to lowercase and vice versa.

title(...)
S.title() -> str Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate(...)
S.translate(table) -> str Return a copy of the string S in which each character has been mapped through the given translation table. The table must implement lookup/indexing via __getitem__, for instance a dictionary or list, mapping Unicode ordinals to Unicode ordinals, strings, or None. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.

upper(...)
S.upper() -> str Return a copy of S converted to uppercase.

zfill(...)
S.zfill(width) -> str Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Static methods inherited from builtins.str:

maketrans(x, y=None, z=None, /)
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.

class IRRawField(IndexedRedis.fields.IRField)

    IRRawField - Return the raw data from Redis, without any extra encoding, decoding, or translation. NOTE: This type does NOT support irNull, nor default values (because no encoding/decoding). After fetch, the value will always be bytes (Again, no translation). This field type does not support indexing.

Method resolution order:

IRRawField

IndexedRedis.fields.IRField

builtins.str

builtins.object

Methods defined here:

__init__(self, name='')
__init__ - Create an IRRawField. Only takes a name @param name <str> - Field name This field type does not support indexing.

copy(self)
copy - Create a copy of this IRField.   Each subclass should implement this, as you'll need to pass in the args to constructor. @return <IRField (or subclass)> - Another IRField that has all the same values as this one.

fromInput = _fromInput(self, value)

fromStorage = _fromStorage(self, value)

toStorage = _toStorage(self, value)

Static methods defined here:

__new__(self, name='')
Create and return a new object.  See help(type) for accurate signature.

Data and other attributes defined here:

CAN_INDEX = False

Methods inherited from IndexedRedis.fields.IRField:

__repr__(self)
__repr__ - Return an object-representation string of this field instance. You should NOT need to extend this on your IRField, instead just implement _getReprProperties   to return your type's specific properties associated with this instance.   @see _getReprProperties

convert = _deprecated_wrapper(*args, **kwargs)

getDefaultValue(self)
getDefaultValue - Gets the default value associated with this field.   This is the value used when no value has been explicitly set.   @return - The default value

toIndex(self, value)
toIndex - An optional method which will return the value prepped for index. By default, "toStorage" will be called. If you provide "hashIndex=True" on the constructor, the field will be md5summed for indexing purposes. This is useful for large strings, etc.

Data descriptors inherited from IndexedRedis.fields.IRField:

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

isIndexHashed

isIndexHashed - Returns if the index value should be hashed @return <bool> - True if this field should be hashed before indexing / filtering

name

name - Property, return this field's name @return <str> - Field name

Data and other attributes inherited from IndexedRedis.fields.IRField:

defaultValue = irNull

hashIndex = False

Methods inherited from builtins.str:

__add__(self, value, /)
Return self+value.

__contains__(self, key, /)
Return key in self.

__eq__(self, value, /)
Return self==value.

__format__(...)
S.__format__(format_spec) -> str Return a formatted version of S as described by format_spec.

__ge__(self, value, /)
Return self>=value.

__getattribute__(self, name, /)
Return getattr(self, name).

__getitem__(self, key, /)
Return self[key].

__getnewargs__(...)

__gt__(self, value, /)
Return self>value.

__hash__(self, /)
Return hash(self).

__iter__(self, /)
Implement iter(self).

__le__(self, value, /)
Return self<=value.

__len__(self, /)
Return len(self).

__lt__(self, value, /)
Return self<value.

__mod__(self, value, /)
Return self%value.

__mul__(self, value, /)
Return self*value.n

__ne__(self, value, /)
Return self!=value.

__rmod__(self, value, /)
Return value%self.

__rmul__(self, value, /)
Return self*value.

__sizeof__(...)
S.__sizeof__() -> size of S in memory, in bytes

__str__(self, /)
Return str(self).

capitalize(...)
S.capitalize() -> str Return a capitalized version of S, i.e. make the first character have upper case and the rest lower case.

casefold(...)
S.casefold() -> str Return a version of S suitable for caseless comparisons.

center(...)
S.center(width[, fillchar]) -> str Return S centered in a string of length width. Padding is done using the specified fill character (default is a space)

count(...)
S.count(sub[, start[, end]]) -> int 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(...)
S.encode(encoding='utf-8', errors='strict') -> bytes Encode S using the codec registered for encoding. Default encoding is 'utf-8'. errors may be given to set a different error handling scheme. 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(...)
S.endswith(suffix[, start[, end]]) -> bool 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(...)
S.expandtabs(tabsize=8) -> str Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find(...)
S.find(sub[, start[, end]]) -> int 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(...)
S.format(*args, **kwargs) -> str Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces ('{' and '}').

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

index(...)
S.index(sub[, start[, end]]) -> int Like S.find() but raise ValueError when the substring is not found.

isalnum(...)
S.isalnum() -> bool Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha(...)
S.isalpha() -> bool Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal(...)
S.isdecimal() -> bool Return True if there are only decimal characters in S, False otherwise.

isdigit(...)
S.isdigit() -> bool Return True if all characters in S are digits and there is at least one character in S, False otherwise.

isidentifier(...)
S.isidentifier() -> bool Return True if S is a valid identifier according to the language definition. Use keyword.iskeyword() to test for reserved identifiers such as "def" and "class".

islower(...)
S.islower() -> bool Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric(...)
S.isnumeric() -> bool Return True if there are only numeric characters in S, False otherwise.

isprintable(...)
S.isprintable() -> bool Return True if all characters in S are considered printable in repr() or S is empty, False otherwise.

isspace(...)
S.isspace() -> bool Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle(...)
S.istitle() -> bool Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper(...)
S.isupper() -> bool Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

join(...)
S.join(iterable) -> str Return a string which is the concatenation of the strings in the iterable.  The separator between elements is S.

ljust(...)
S.ljust(width[, fillchar]) -> str Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower(...)
S.lower() -> str Return a copy of the string S converted to lowercase.

lstrip(...)
S.lstrip([chars]) -> str Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead.

partition(...)
S.partition(sep) -> (head, sep, tail) Search for the separator sep in S, and return the part before it, the separator itself, and the part after it.  If the separator is not found, return S and two empty strings.

replace(...)
S.replace(old, new[, count]) -> str Return a copy of S with all occurrences of substring old replaced by new.  If the optional argument count is given, only the first count occurrences are replaced.

rfind(...)
S.rfind(sub[, start[, end]]) -> int 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(...)
S.rindex(sub[, start[, end]]) -> int Like S.rfind() but raise ValueError when the substring is not found.

rjust(...)
S.rjust(width[, fillchar]) -> str Return S right-justified in a string of length width. Padding is done using the specified fill character (default is a space).

rpartition(...)
S.rpartition(sep) -> (head, sep, tail) Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it.  If the separator is not found, return two empty strings and S.

rsplit(...)
S.rsplit(sep=None, maxsplit=-1) -> list of strings Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front.  If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip(...)
S.rstrip([chars]) -> str Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead.

split(...)
S.split(sep=None, maxsplit=-1) -> list of strings Return a list of the words in S, using sep as the delimiter string.  If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines(...)
S.splitlines([keepends]) -> list of strings Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith(...)
S.startswith(prefix[, start[, end]]) -> bool 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(...)
S.strip([chars]) -> str Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead.

swapcase(...)
S.swapcase() -> str Return a copy of S with uppercase characters converted to lowercase and vice versa.

title(...)
S.title() -> str Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate(...)
S.translate(table) -> str Return a copy of the string S in which each character has been mapped through the given translation table. The table must implement lookup/indexing via __getitem__, for instance a dictionary or list, mapping Unicode ordinals to Unicode ordinals, strings, or None. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.

upper(...)
S.upper() -> str Return a copy of S converted to uppercase.

zfill(...)
S.zfill(width) -> str Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Static methods inherited from builtins.str:

maketrans(x, y=None, z=None, /)
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.

class IRUnicodeField(IndexedRedis.fields.IRField)

    IRUnicodeField - A field which supports storing/retrieving data in an arbitrary unicode encoding (may be different than global getDefaultIREncoding/setDefaultIREncoding) If "encoding" is None (default) - each time the value is converted getEncoding() will be called to get the encoding. This makes it roughly the same as a regular IRField. In practice, you may have fields with different encodings (different languages maybe, different platforms, etc), and through this you can support those cases. This field type is indeaxble, and the index is forced to be hashed.

Method resolution order:

IRUnicodeField

IndexedRedis.fields.IRField

builtins.str

builtins.object

Methods defined here:

__init__(self, name='', encoding=None, defaultValue=irNull)
__init__ - Create an IRUnicodeField @param name <str> - The field name @param encoding <None/str> - A specific encoding to use. If None, defaultIREncoding will be used. @param defaultValue - The default value for this field This field type is indeaxble, and the index is forced to be hashed.

copy(self)
copy - Create a copy of this IRField.   Each subclass should implement this, as you'll need to pass in the args to constructor. @return <IRField (or subclass)> - Another IRField that has all the same values as this one.

getEncoding(self)
getEncoding - Get the encoding codec associated with this field.         If you provided None, this will return the defaultIREncoding @return <str> - Encoding

toBytes(self, value)
toBytes - Convert a value to bytes using the encoding specified on this field @param value <str> - The field to convert to bytes @return <bytes> - The object encoded using the codec specified on this field. NOTE: This method may go away.

Static methods defined here:

__new__(self, name='', encoding=None, defaultValue=irNull)
Create and return a new object.  See help(type) for accurate signature.

Data and other attributes defined here:

CAN_INDEX = True

hashIndex = True

Methods inherited from IndexedRedis.fields.IRField:

__repr__(self)
__repr__ - Return an object-representation string of this field instance. You should NOT need to extend this on your IRField, instead just implement _getReprProperties   to return your type's specific properties associated with this instance.   @see _getReprProperties

convert = _deprecated_wrapper(*args, **kwargs)

fromInput(self, value)
fromInput - Convert the value from input (like assigning this through constructor or as an item assignment on the object @param value - Value to convert @return - Converted value

fromStorage(self, value)
fromStorage - Convert the value from storage to the value type. @param value - Value to convert @return - The converted value

getDefaultValue(self)
getDefaultValue - Gets the default value associated with this field.   This is the value used when no value has been explicitly set.   @return - The default value

toIndex(self, value)
toIndex - An optional method which will return the value prepped for index. By default, "toStorage" will be called. If you provide "hashIndex=True" on the constructor, the field will be md5summed for indexing purposes. This is useful for large strings, etc.

toStorage(self, value)
toStorage - Convert the value to a string representation for storage.   The default implementation will work here for basic types. @param value - The value of the item to convert @return A string value suitable for storing.

Data descriptors inherited from IndexedRedis.fields.IRField:

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

isIndexHashed

isIndexHashed - Returns if the index value should be hashed @return <bool> - True if this field should be hashed before indexing / filtering

name

name - Property, return this field's name @return <str> - Field name

Data and other attributes inherited from IndexedRedis.fields.IRField:

defaultValue = irNull

Methods inherited from builtins.str:

__add__(self, value, /)
Return self+value.

__contains__(self, key, /)
Return key in self.

__eq__(self, value, /)
Return self==value.

__format__(...)
S.__format__(format_spec) -> str Return a formatted version of S as described by format_spec.

__ge__(self, value, /)
Return self>=value.

__getattribute__(self, name, /)
Return getattr(self, name).

__getitem__(self, key, /)
Return self[key].

__getnewargs__(...)

__gt__(self, value, /)
Return self>value.

__hash__(self, /)
Return hash(self).

__iter__(self, /)
Implement iter(self).

__le__(self, value, /)
Return self<=value.

__len__(self, /)
Return len(self).

__lt__(self, value, /)
Return self<value.

__mod__(self, value, /)
Return self%value.

__mul__(self, value, /)
Return self*value.n

__ne__(self, value, /)
Return self!=value.

__rmod__(self, value, /)
Return value%self.

__rmul__(self, value, /)
Return self*value.

__sizeof__(...)
S.__sizeof__() -> size of S in memory, in bytes

__str__(self, /)
Return str(self).

capitalize(...)
S.capitalize() -> str Return a capitalized version of S, i.e. make the first character have upper case and the rest lower case.

casefold(...)
S.casefold() -> str Return a version of S suitable for caseless comparisons.

center(...)
S.center(width[, fillchar]) -> str Return S centered in a string of length width. Padding is done using the specified fill character (default is a space)

count(...)
S.count(sub[, start[, end]]) -> int 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(...)
S.encode(encoding='utf-8', errors='strict') -> bytes Encode S using the codec registered for encoding. Default encoding is 'utf-8'. errors may be given to set a different error handling scheme. 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(...)
S.endswith(suffix[, start[, end]]) -> bool 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(...)
S.expandtabs(tabsize=8) -> str Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find(...)
S.find(sub[, start[, end]]) -> int 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(...)
S.format(*args, **kwargs) -> str Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces ('{' and '}').

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

index(...)
S.index(sub[, start[, end]]) -> int Like S.find() but raise ValueError when the substring is not found.

isalnum(...)
S.isalnum() -> bool Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha(...)
S.isalpha() -> bool Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal(...)
S.isdecimal() -> bool Return True if there are only decimal characters in S, False otherwise.

isdigit(...)
S.isdigit() -> bool Return True if all characters in S are digits and there is at least one character in S, False otherwise.

isidentifier(...)
S.isidentifier() -> bool Return True if S is a valid identifier according to the language definition. Use keyword.iskeyword() to test for reserved identifiers such as "def" and "class".

islower(...)
S.islower() -> bool Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric(...)
S.isnumeric() -> bool Return True if there are only numeric characters in S, False otherwise.

isprintable(...)
S.isprintable() -> bool Return True if all characters in S are considered printable in repr() or S is empty, False otherwise.

isspace(...)
S.isspace() -> bool Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle(...)
S.istitle() -> bool Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper(...)
S.isupper() -> bool Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

join(...)
S.join(iterable) -> str Return a string which is the concatenation of the strings in the iterable.  The separator between elements is S.

ljust(...)
S.ljust(width[, fillchar]) -> str Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower(...)
S.lower() -> str Return a copy of the string S converted to lowercase.

lstrip(...)
S.lstrip([chars]) -> str Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead.

partition(...)
S.partition(sep) -> (head, sep, tail) Search for the separator sep in S, and return the part before it, the separator itself, and the part after it.  If the separator is not found, return S and two empty strings.

replace(...)
S.replace(old, new[, count]) -> str Return a copy of S with all occurrences of substring old replaced by new.  If the optional argument count is given, only the first count occurrences are replaced.

rfind(...)
S.rfind(sub[, start[, end]]) -> int 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(...)
S.rindex(sub[, start[, end]]) -> int Like S.rfind() but raise ValueError when the substring is not found.

rjust(...)
S.rjust(width[, fillchar]) -> str Return S right-justified in a string of length width. Padding is done using the specified fill character (default is a space).

rpartition(...)
S.rpartition(sep) -> (head, sep, tail) Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it.  If the separator is not found, return two empty strings and S.

rsplit(...)
S.rsplit(sep=None, maxsplit=-1) -> list of strings Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front.  If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip(...)
S.rstrip([chars]) -> str Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead.

split(...)
S.split(sep=None, maxsplit=-1) -> list of strings Return a list of the words in S, using sep as the delimiter string.  If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines(...)
S.splitlines([keepends]) -> list of strings Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith(...)
S.startswith(prefix[, start[, end]]) -> bool 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(...)
S.strip([chars]) -> str Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead.

swapcase(...)
S.swapcase() -> str Return a copy of S with uppercase characters converted to lowercase and vice versa.

title(...)
S.title() -> str Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate(...)
S.translate(table) -> str Return a copy of the string S in which each character has been mapped through the given translation table. The table must implement lookup/indexing via __getitem__, for instance a dictionary or list, mapping Unicode ordinals to Unicode ordinals, strings, or None. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.

upper(...)
S.upper() -> str Return a copy of S converted to uppercase.

zfill(...)
S.zfill(width) -> str Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Static methods inherited from builtins.str:

maketrans(x, y=None, z=None, /)
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.

Data

IR_NULL_BYTES = b'IRNullType()'
IR_NULL_STR = 'IRNullType()'
IR_NULL_STRINGS = ('IRNullType()', b'IRNullType()')
IR_NULL_UNICODE = 'IRNullType()'
__all__ = ('IRField', 'IRNullType', 'irNull', 'IRPickleField', 'IRCompressedField', 'IRUnicodeField', 'IRRawField', 'IRBase64Field', 'IRFixedPointField', 'IRDatetimeValue', 'IRJsonValue', 'IRBytesField', 'IRClassicField', 'IRForeignLinkFieldBase', 'IRForeignLinkField', 'IRForeignMultiLinkField', 'IR_NULL_STR', 'IR_NULL_BYTES', 'IR_NULL_UNICODE', 'IR_NULL_STRINGS')
irNull = irNull

Data
		IR_NULL_BYTES = b'IRNullType()' IR_NULL_STR = 'IRNullType()' IR_NULL_STRINGS = ('IRNullType()', b'IRNullType()') IR_NULL_UNICODE = 'IRNullType()' __all__ = ('IRField', 'IRNullType', 'irNull', 'IRPickleField', 'IRCompressedField', 'IRUnicodeField', 'IRRawField', 'IRBase64Field', 'IRFixedPointField', 'IRDatetimeValue', 'IRJsonValue', 'IRBytesField', 'IRClassicField', 'IRForeignLinkFieldBase', 'IRForeignLinkField', 'IRForeignMultiLinkField', 'IR_NULL_STR', 'IR_NULL_BYTES', 'IR_NULL_UNICODE', 'IR_NULL_STRINGS') irNull = irNull