builtins

Internal module containing built-in functions and classes.

Classes and functions from the __builtins__ module are generally available from all global namespaces. Built-in names can still be shadowed by module-level globals and function-level locals, so none the names in this module are reserved. When a built-in name has been shadowed, the original can be referenced directly as __builtins__.name instead.

Built-in names may be bound from several sources. Most come from the core interpreter directly, but some may come from loaded C extension modules or the interpreter binary. Kuroko source modules are also free to append new names to the built-in name space by attaching new properties to the __builtins__ instance.

Classes

class Cell(object)

Cell.__new__()

property Cell.cell_contents

class CompilerState(object)

class Helper(object)

Special object that prints a helpeful message.

Object that prints help summary when passed to repr.

Helper(obj=None)

Helper.__call__(obj=None)

Prints help text.

Prints the help documentation attached to obj or starts the interactive help system by importing the mod_help module.

class LicenseReader(object)

Special object that prints Kuroko's copyright information when passed to repr

LicenseReader()

LicenseReader.__call__()

Print the full license statement.

class NoneType(object)

NoneType == other

NoneType.__eq__()

NoneType.__hash__()

NoneType.__new__()

class NotImplementedType(object)

NotImplementedType == other

NotImplementedType.__eq__()

NotImplementedType.__hash__()

NotImplementedType.__new__()

class bool(int)

Returns False if the argument is 'falsey', otherwise True.

bool.__format__()

bool.__new__()

class bytearray(object)

let x = bytearray(bytes=None)

bytearray.__init__(bytes=None)

A mutable array of bytes.

needle in bytearray

bytearray.__contains__()

bytearray == other

bytearray.__eq__()

bytearray[key]

bytearray.__getitem__()

for x in bytearray:

bytearray.__iter__()

len(bytearray)

bytearray.__len__()

bytearray[key] = value

bytearray.__setitem__()

bytearray.decode()

class bytes(object)

bytes + other

bytes.__add__()

needle in bytes

bytes.__contains__()

bytes == other

bytes.__eq__()

bytes[key]

bytes.__getitem__()

bytes.__hash__()

for x in bytes:

bytes.__iter__()

len(bytes)

bytes.__len__()

bytes.__new__(iter=None)

An array of bytes.

Creates a new bytes object. If iter is provided, it should be a tuple or list of integers within the range 0 and 255.

bytes.decode()

bytes.join()

class bytesiterator(object)

let x = bytesiterator()

bytesiterator.__init__()

bytesiterator()

bytesiterator.__call__()

class codeobject(object)

codeobject.__new__()

codeobject._ip_to_line()

property codeobject.__args__

property codeobject.__constants__

property codeobject.__locals__

property codeobject.co_argcount

property codeobject.co_code

property codeobject.co_flags

property codeobject.co_kwonlyargcount

property codeobject.co_posonlyargcount

class dict(object)

Mapping of arbitrary keys to values.

let x = dict()

dict.__init__()

needle in dict

dict.__contains__()

del dict[key]

dict.__delitem__()

dict == other

dict.__eq__()

dict[key]

dict.__getitem__()

dict |= other

dict.__ior__()

for x in dict:

dict.__iter__()

len(dict)

dict.__len__()

dict | other

dict.__or__()

dict[key] = value

dict.__setitem__()

dict.capacity()

dict.clear()

dict.copy()

dict.get()

dict.items()

dict.keys()

dict.setdefault()

dict.update()

dict.values()

class dictitems(object)

let x = dictitems()

dictitems.__init__()

dictitems()

dictitems.__call__()

for x in dictitems:

dictitems.__iter__()

class dictkeys(object)

let x = dictkeys()

dictkeys.__init__()

dictkeys()

dictkeys.__call__()

for x in dictkeys:

dictkeys.__iter__()

class dictvalues(object)

let x = dictvalues()

dictvalues.__init__()

dictvalues()

dictvalues.__call__()

for x in dictvalues:

dictvalues.__iter__()

class ellipsis(object)

ellipsis.__new__()

class enumerate(object)

Return an iterator that produces a tuple with a count the iterated values of the passed iteratable.

let x = enumerate()

enumerate.__init__()

enumerate()

enumerate.__call__()

for x in enumerate:

enumerate.__iter__()

class filter(object)

Return an iterator that returns only the items from an iterable for which the given function returns true.

let x = filter()

filter.__init__()

filter()

filter.__call__()

for x in filter:

filter.__iter__()

class float(object)

Convert a number or string type to a float representation.

float.__abs__()

float + other

float.__add__()

float == other

float.__eq__()

float.__float__()

float // other

float.__floordiv__()

float.__format__()

float >= other

float.__ge__()

float > other

float.__gt__()

float.__hash__()

float += other

float.__iadd__()

float //= other

float.__ifloordiv__()

float *= other

float.__imul__()

float.__int__()

float -= other

float.__isub__()

float /= other

float.__itruediv__()

float <= other

float.__le__()

float < other

float.__lt__()

float * other

float.__mul__()

-float

float.__neg__()

float.__new__()

float.__pos__()

other + float

float.__radd__()

other // float

float.__rfloordiv__()

other * float

float.__rmul__()

other - float

float.__rsub__()

other / float

float.__rtruediv__()

float - other

float.__sub__()

float / other

float.__truediv__()

float.as_integer_ratio()

class function(object)

function.__new__()

function._ip_to_line()

property function.__annotations__

property function.__args__

property function.__closure__

property function.__code__

property function.__doc__

property function.__globals__

property function.__qualname__

class generator(object)

let x = generator()

generator.__init__()

generator()

generator.__call__()

generator.__finish__()

for x in generator:

generator.__iter__()

generator.send()

property generator.gi_running

class int(object)

Convert a number or string type to an integer representation.

int.__abs__()

int + other

int.__add__()

int & other

int.__and__()

int.__bin__()

int.__chr__()

int == other

int.__eq__()

int.__float__()

int // other

int.__floordiv__()

int.__format__()

int >= other

int.__ge__()

int > other

int.__gt__()

int.__hash__()

int.__hex__()

int += other

int.__iadd__()

int &= other

int.__iand__()

int //= other

int.__ifloordiv__()

int <<= other

int.__ilshift__()

int %= other

int.__imod__()

int *= other

int.__imul__()

int.__int__()

~int

int.__invert__()

int |= other

int.__ior__()

int **= other

int.__ipow__()

int >>= other

int.__irshift__()

int -= other

int.__isub__()

int /= other

int.__itruediv__()

int ^= other

int.__ixor__()

int <= other

int.__le__()

int << other

int.__lshift__()

int < other

int.__lt__()

int % other

int.__mod__()

int * other

int.__mul__()

-int

int.__neg__()

int.__new__()

int.__oct__()

int | other

int.__or__()

int.__pos__()

int ** other

int.__pow__()

other + int

int.__radd__()

other & int

int.__rand__()

other // int

int.__rfloordiv__()

other << int

int.__rlshift__()

other % int

int.__rmod__()

other * int

int.__rmul__()

other | int

int.__ror__()

other ** int

int.__rpow__()

other >> int

int.__rrshift__()

int >> other

int.__rshift__()

other - int

int.__rsub__()

other / int

int.__rtruediv__()

other ^ int

int.__rxor__()

int - other

int.__sub__()

int / other

int.__truediv__()

int ^ other

int.__xor__()

int.bit_count()

int.bit_length()

int.to_bytes()

class list(object)

Mutable sequence of arbitrary values.

let x = list()

list.__init__()

list + other

list.__add__()

needle in list

list.__contains__()

del list[key]

list.__delitem__()

list == other

list.__eq__()

list >= other

list.__ge__()

list[key]

list.__getitem__()

list > other

list.__gt__()

for x in list:

list.__iter__()

list <= other

list.__le__()

len(list)

list.__len__()

list < other

list.__lt__()

list * other

list.__mul__()

list[key] = value

list.__setitem__()

list.append(item)

Add an item to the end of the list.

Adds an item to the end of a list. Appending items to a list is an amortized constant-time operation, but may result in the reallocation of the list if not enough additional space is available to store to the new element in the current allocation.

list.clear()

Empty a list.

Removes all entries from the list.

list.copy()

Clone a list.

Equivalent to list[:], creates a new list with the same items as this list.

list.count(val)

Count instances of a value in the list.

Scans the list for values equal to val and returns the count of matching entries.

list.extend()

Add the contents of an iterable to the end of a list. @argument iterable

Adds all of the elements of iterable to the end of the list, as if each were added individually with _list_append.

list.index(val,[min,[max]])

Locate an item in the list by value.

Searches for val in the list and returns its index if found. If min is provided, the search will begin at index min. If max is also provided, the search will end at index max. Raises ValueError if the item is not found.

list.insert(index, val)

Add an entry to the list at a given offset.

Adds val to the list at offset index, moving all following items back. Inserting near the beginning of a list can be costly.

list.pop([index])

Remove and return an element from the list.

Removes and returns the entry at the end of the list, or at index if provided. Popping from the end of the list is constant-time. Popping from the head of the list is always O(n) as the contents of the list must be shifted.

list.remove(val)

Remove an item from the list.

Scans the list for an entry equivalent to val and removes it from the list. Raises ValueError if no matching entry is found.

list.reverse()

Reverse the contents of a list.

Reverses the elements of the list in-place.

list.sort()

Sort the contents of a list.

Performs an in-place sort of the elements in the list, returning None as a gentle reminder that the sort is in-place. If a sorted copy is desired, use sorted instead.

class listiterator(object)

let x = listiterator()

listiterator.__init__()

listiterator()

listiterator.__call__()

class long(int)

long.__abs__()

long + other

long.__add__()

long & other

long.__and__()

long.__bin__()

long == other

long.__eq__()

long.__float__()

long // other

long.__floordiv__()

long.__format__()

long >= other

long.__ge__()

long > other

long.__gt__()

long.__hash__()

long.__hex__()

long += other

long.__iadd__()

long &= other

long.__iand__()

long //= other

long.__ifloordiv__()

long <<= other

long.__ilshift__()

long %= other

long.__imod__()

long *= other

long.__imul__()

long.__int__()

~long

long.__invert__()

long |= other

long.__ior__()

long **= other

long.__ipow__()

long >>= other

long.__irshift__()

long -= other

long.__isub__()

long /= other

long.__itruediv__()

long ^= other

long.__ixor__()

long <= other

long.__le__()

len(long)

long.__len__()

long << other

long.__lshift__()

long < other

long.__lt__()

long % other

long.__mod__()

long * other

long.__mul__()

-long

long.__neg__()

long.__new__()

long.__oct__()

long | other

long.__or__()

long.__pos__()

long ** other

long.__pow__()

other + long

long.__radd__()

other & long

long.__rand__()

other // long

long.__rfloordiv__()

other << long

long.__rlshift__()

other % long

long.__rmod__()

other * long

long.__rmul__()

other | long

long.__ror__()

other ** long

long.__rpow__()

other >> long

long.__rrshift__()

long >> other

long.__rshift__()

other - long

long.__rsub__()

other / long

long.__rtruediv__()

other ^ long

long.__rxor__()

long - other

long.__sub__()

long / other

long.__truediv__()

long ^ other

long.__xor__()

long._digit_count()

long._get_digit()

long.bit_count()

long.bit_length()

long.to_bytes()

class map(object)

Return an iterator that applies a function to a series of iterables

let x = map()

map.__init__()

map()

map.__call__()

for x in map:

map.__iter__()

class method(object)

method.__new__()

method._ip_to_line()

property method.__annotations__

property method.__args__

property method.__code__

property method.__doc__

property method.__qualname__

property method.__self__

class object()

Base class for all types.

The object base class provides the fallback implementations of methods like __dir__. All object and primitive types eventually inherit from object.

let x = object()

object.__init__()

object.__dir__()

object == other

object.__eq__()

object.__format__()

object.__hash__()

object.__new__()

object.__setattr__()

class property(object)

let x = property(fget,[fset])

property.__init__(fget,[fset])

Create a property object.

When a property object is obtained from an instance of the class in which it is defined, the function or method assigned to fget is called with the instance as an argument. If fset is provided, it will be called with the instance and a value when the property object is assigned to through an instance. For legacy compatibility reasons, a property object's fget method may also accept an additional argument to act as a setter if fset is not provided, but this functionality may be removed in the future.

The typical use for property is as a decorator on methods in a class. See also property.setter for the newer Python-style approach to decorating a companion setter method.

property.__get__()

property.__set__()

property.setter(fset)

Assign the setter method of a property object.

This should be used as a decorator from an existing property object as follows:

class Foo():
    @property
    def bar(self):
        return 42
    @bar.setter
    def bar(self, val):
        print('setting bar to',val)

Be sure to apply the decorator to a function or method with the same name, as this name will be used to assign the property to the class's attribute table; using a different name will create a duplicate alias.

class range(object)

Iterable object that produces sequential numeric values.

let x = range([min,] max, [step])

range.__init__([min,] max, [step])

Create an iterable that produces sequential numeric values.

With one argument, iteration will start at 0 and continue to max, exclusive. With two arguments, iteration starts at min and continues to max, exclusive. With three arguments, a step may also be included.

needle in range

range.__contains__()

for x in range:

range.__iter__()

class rangeiterator(object)

let x = rangeiterator()

rangeiterator.__init__()

rangeiterator()

rangeiterator.__call__()

class set(object)

let x = set()

set.__init__()

set & other

set.__and__()

needle in set

set.__contains__()

set == other

set.__eq__()

set >= other

set.__ge__()

set > other

set.__gt__()

for x in set:

set.__iter__()

set <= other

set.__le__()

len(set)

set.__len__()

set < other

set.__lt__()

set | other

set.__or__()

set ^ other

set.__xor__()

set.add(value)

Add an element to the set.

Adds the given value to the set. value must be hashable.

set.clear()

Empty the set.

Removes all elements from the set, in-place.

set.discard(value)

Remove an element from the set, quietly.

Removes value from the set, without raising an exception if it is not a member.

set.remove(value)

Remove an element from the set.

Removes value from the set, raising KeyError if it is not a member of the set.

set.update()

class setiterator(object)

let x = setiterator()

setiterator.__init__()

setiterator()

setiterator.__call__()

class slice(object)

let x = slice()

slice.__init__()

property slice.end

property slice.start

property slice.step

class str(object)

Obtain a string representation of an object.

str + other

str.__add__()

needle in str

str.__contains__()

del str[key]

str.__delitem__()

str.__float__()

str.__format__()

str >= other

str.__ge__()

str[key]

str.__getitem__()

str > other

str.__gt__()

str.__hash__()

str.__int__()

for x in str:

str.__iter__()

str <= other

str.__le__()

len(str)

str.__len__()

str < other

str.__lt__()

str % other

str.__mod__()

str * other

str.__mul__()

str.__new__()

str.__ord__()

other * str

str.__rmul__()

str[key] = value

str.__setitem__()

str.encode()

str.endswith()

str.find()

str.format()

str.index()

str.isalnum()

str.isalpha()

str.isdigit()

str.islower()

str.isspace()

str.isupper()

str.isxdigit()

str.join()

str.lower()

str.lstrip()

str.replace()

str.rstrip()

str.split()

str.startswith()

str.strip()

str.title()

str.upper()

class striterator(object)

let x = striterator()

striterator.__init__()

striterator()

striterator.__call__()

class tuple(object)

tuple + other

tuple.__add__()

needle in tuple

tuple.__contains__()

tuple == other

tuple.__eq__()

tuple >= other

tuple.__ge__()

tuple[key]

tuple.__getitem__()

tuple > other

tuple.__gt__()

tuple.__hash__()

for x in tuple:

tuple.__iter__()

tuple <= other

tuple.__le__()

len(tuple)

tuple.__len__()

tuple < other

tuple.__lt__()

tuple * other

tuple.__mul__()

tuple.__new__()

class tupleiterator(object)

let x = tupleiterator()

tupleiterator.__init__()

tupleiterator()

tupleiterator.__call__()

class type(object)

Obtain the object representation of the class of an object.

type()

type.__call__()

type[key]

type.__getitem__()

type.__new__()

type.__subclasses__()

class zip(object)

Returns an iterator that produces tuples of the nth element of each passed iterable. @arguments *iterables

Creates an iterator that returns a tuple of elements from each of iterables, until one of iterables is exhuasted.

let x = zip()

zip.__init__()

zip()

zip.__call__()

for x in zip:

zip.__iter__()

Functions

abs(iterable)

Obtain the absolute value of a numeric.

all(iterable)

Returns True if every element in the given iterable is truthy, False otherwise.

any(iterable)

Returns True if at least one element in the given iterable is truthy, False otherwise.

bin(i)

Convert an integer value to a binary string.

Produces a string representation of i in binary, with a leading 0b.

chr(codepoint)

Convert an integer codepoint to its string representation.

Creates a single-codepoint string with the character represented by the integer codepoint codepoint.

classmethod()

A class method takes an implicit cls argument, instead of self.

delattr(obj,attribute)

Delete an attribute by name.

Deletes the attribute attribute from obj.

dir([obj])

Return a list of known property names for a given object.

Uses various internal methods to collect a list of property names of obj, returning that list sorted lexicographically. If no argument is given, the returned list will be the valid global names in the calling scope.

format(value[,format_spec])

Format a value for string printing.

getattr(obj,attribute,[default])

Perform attribute lookup on an object using a string.

Obtains the attributed named attribute from the object obj, if such an attribute exists. Attribute lookup ordering is complex and includes direct attribute tables of instances, dynamic attributes from classes, and so on. The use of getattr is equivalent to a dotted access. If attribute refers to a method of obj's class, a bound method will be obtained. If default is provided then the value supplied will be returned in the case where obj does not have an attribute named attribute, otherwise an AttributeError will be raised.

globals()

Update and a return a mapping of names in the global namespace.

Produces a dict mapping all of the names of the current globals namespace to their values. Updating this dict has no meaning, but modifying mutable values within it can affect the global namespace.

hasattr(obj,attribute)

Determines if an object has an attribute.

Uses getattr to determine if obj has an attribute named attribute.

hash(val)

Returns the hash of a value, used for table indexing.

If val is hashable, its hash value will be calculated if necessary and returned. If val is not hashable, TypeError will be raised.

hex(i)

Convert an integer value to a hexadecimal string.

Returns a string representation of i in hexadecimal, with a leading 0x.

id(val)

Returns the identity of an object.

Returns the internal identity for val. Note that not all objects have identities; primitive values such as int or float do not have identities. Internally, this is the pointer value for a heap object, but this is an implementation detail.

input(prompt='',promptwidth=0,syntax=None)

Read a line of input.

Read a line of input from stdin. If the rline library is available, it will be used to gather input. Input reading stops on end-of file or when a read ends with a line feed, which will be removed from the returned string. If a prompt is provided, it will be printed without a line feed before requesting input. If rline is available, the prompt will be passed to the library as the left-hand prompt string. If not provided, promptwidth will default to the width of prompt in codepoints; if you are providing a prompt with escape characters or characters with multi-column East-Asian Character Width be sure to pass a value for promptwidth that reflects the display width of your prompt. If provided, syntax specifies the name of an rline syntax module to provide color highlighting of the input line.

isinstance(inst, cls)

Check if an object is an instance of a type.

Determine if an object inst is an instance of the given class cls or one if its subclasses. cls may be a single class or a tuple of classes.

issubclass(cls, clsinfo)

Check if a class is a subclass of a type.

Determine if the class cls is a subclass of the class clsinfo. clsinfo may be a single class or a tuple of classes.

len(seq)

Return the length of a given sequence object.

Returns the length of the sequence object seq, which must implement len.

locals(callDepth=1)

Update and return a mapping of names in the current local scope.

Produces a dict mapping the names of the requested locals scope to their current stack values. If callDepth is provided, the locals of an outer call frame will be returned. If the requested call depth is out of range, an exception will be raised.

max(iterable)

Return the highest value in an iterable or the passed arguments.

min(iterable)

Return the lowest value in an iterable or the passed arguments.

next(iterable)

Compatibility function. Calls an iterable.

oct(i)

Convert an integer value to an octal string.

Returns a string representation of i in octal, with a leading 0o.

ord(char)

Obtain the ordinal integer value of a codepoint or byte.

Returns the integer codepoint value of a single-character string char.

print(*args,sep=' ',end='\n',file=None,flush=False)

Print text to the standard output.

Prints the string representation of each argument to the standard output. The keyword argument sep specifies the string to print between values. The keyword argument end specifies the string to print after all of the values have been printed.

repr(val)

Produce a string representation of the given object.

Return a string representation of the given object through its repr method. repr strings should convey all information needed to recreate the object, if this is possible.

reversed(iterable)

Return a reversed representation of an iterable.

Creates a new, reversed list from the elements of iterable.

setattr(obj,attribute,value)

Set an attribute of an object using a string name.

Sets the attribute named by attribute of the object obj to value. If attribute refers to a property object or other descriptor, the descriptor's __set__ method will be called. If obj is a class, instance, or other type with its own attribute table, then the field will be updated. If obj is a type without an attribute table and no class property provides an overriding setter for attribute, an AttributeError will be raised.

sorted(iterable)

Return a sorted representation of an iterable.

Creates a new, sorted list from the elements of iterable.

staticmethod()

A static method does not take an implicit self or cls argument.

sum(iterable,start=0)

add the elements of an iterable.

Continuously adds all of the elements from iterable to start and returns the result when iterable has been exhausted.

Exceptions

class ArgumentError(TypeError)

class AssertionError(Exception)

class AttributeError(Exception)

class BaseException(object)

let x = BaseException()

BaseException.__init__()

class Exception(BaseException)

class IOError(Exception)

class ImportError(Exception)

class IndexError(Exception)

class KeyError(Exception)

class KeyboardInterrupt(BaseException)

class NameError(Exception)

class NotImplementedError(Exception)

class OSError(Exception)

class SyntaxError(Exception)

class SystemError(Exception)

class TypeError(Exception)

class ValueError(Exception)

class ZeroDivisionError(Exception)

Other Members

let Ellipsis = ellipsis

let NotImplemented = NotImplementedType

let help = Helper

let license = LicenseReader