Gimp.constants

Constants table

Documentation §

• str(object=’’) -> str
  str(bytes_or_buffer[, encoding[, errors]]) -> str
  
  Create a new string object from the given object. If encoding or
  errors is specified, then the object must expose a data buffer
  that will be decoded using the given encoding and error handler.
  Otherwise, returns the result of object.str() (if defined)
  or repr(object).
  encoding defaults to ‘utf-8’.
  errors defaults to ‘strict’.

Runtime functions

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

Documentation §§

• Convert a string or number to a floating-point number, if possible.

Runtime attributes

• imag
• real

Runtime functions

• as_integer_ratio()
  • Return a pair of integers, whose ratio is exactly equal to the original float.
    
    The ratio is in lowest terms and has a positive denominator. Raise
    OverflowError on infinities and a ValueError on NaNs.
    
    »> (10.0).as_integer_ratio()
    (10, 1)
    »> (0.0).as_integer_ratio()
    (0, 1)
    »> (-.25).as_integer_ratio()
    (-1, 4)
• conjugate()
  • Return self, the complex conjugate of any float.
• fromhex(string, /)
  • Create a floating-point number from a hexadecimal string.
    
    »> float.fromhex(‘0x1.ffffp10’)
    2047.984375
    »> float.fromhex(‘-0x1p-1074’)
    -5e-324
• hex()
  • Return a hexadecimal representation of a floating-point number.
    
    »> (-0.1).hex()
    ‘-0x1.999999999999ap-4’
    »> 3.14159.hex()
    ‘0x1.921f9f01b866ep+1’
• is_integer()
  • Return True if the float is an integer.

Documentation §§§

• int([x]) -> integer
  int(x, base=10) -> integer
  
  Convert a number or string to an integer, or return 0 if no arguments
  are given. If x is a number, return x.int(). For floating-point
  numbers, this truncates towards zero.
  
  If x is not a number or if base is given, then x must be a string,
  bytes, or bytearray instance representing an integer literal in the
  given base. The literal can be preceded by ‘+’ or ‘-‘ and be surrounded
  by whitespace. The base defaults to 10. Valid bases are 0 and 2-36.
  Base 0 means to interpret the base from the string as an integer literal.
  »> int(‘0b100’, base=0)
  4

Runtime attributes

• denominator
• imag
• numerator
• real

Runtime functions

• as_integer_ratio()
  • Return a pair of integers, whose ratio is equal to the original int.
    
    The ratio is in lowest terms and has a positive denominator.
    
    »> (10).as_integer_ratio()
    (10, 1)
    »> (-10).as_integer_ratio()
    (-10, 1)
    »> (0).as_integer_ratio()
    (0, 1)
• bit_count()
  • Number of ones in the binary representation of the absolute value of self.
    
    Also known as the population count.
    
    »> bin(13)
    ‘0b1101’
    »> (13).bit_count()
    3
• bit_length()
  • Number of bits necessary to represent self in binary.
    
    »> bin(37)
    ‘0b100101’
    »> (37).bit_length()
    6
• conjugate()
  • Returns self, the complex conjugate of any int.
• from_bytes(bytes, byteorder='big', *, signed=False)
  • Return the integer represented by the given array of bytes.
    
    bytes
    Holds the array of bytes to convert. The argument must either
    support the buffer protocol or be an iterable object producing bytes.
    Bytes and bytearray are examples of built-in objects that support the
    buffer protocol.
    byteorder
    The byte order used to represent the integer. If byteorder is ‘big’,
    the most significant byte is at the beginning of the byte array. If
    byteorder is ‘little’, the most significant byte is at the end of the
    byte array. To request the native byte order of the host system, use
    sys.byteorder as the byte order value. Default is to use ‘big’.
    signed
    Indicates whether two’s complement is used to represent the integer.
• is_integer()
  • Returns True. Exists for duck type compatibility with float.is_integer.
• to_bytes(length=1, byteorder='big', *, signed=False)
  • Return an array of bytes representing an integer.
    
    length
    Length of bytes object to use. An OverflowError is raised if the
    integer is not representable with the given number of bytes. Default
    is length 1.
    byteorder
    The byte order used to represent the integer. If byteorder is ‘big’,
    the most significant byte is at the beginning of the byte array. If
    byteorder is ‘little’, the most significant byte is at the end of the
    byte array. To request the native byte order of the host system, use
    sys.byteorder as the byte order value. Default is to use ‘big’.
    signed
    Determines whether two’s complement is used to represent the integer.
    If signed is False and a negative integer is given, an OverflowError
    is raised.