neulab/docprompting-conala huggingface dataset:
int.to_bytes(length, byteorder, *, signed=False)  
Return an array of bytes representing an integer. >>> (1024).to_bytes(2, byteorder='big')
b'\x04\x00'
>>> (1024).to_bytes(10, byteorder='big')
b'\x00\x00\x00\x00\x00\x00\x00\x00\x04\x00'
>>> (-1024).to_bytes(10, byteorder='big', signed=True)
b'\xff\xff\xff\xff\xff\xff\xff\xff\xfc\x00'
>>> x = 1000
>>> x.to_bytes((x.bit_length() + 7) // 8, byteorder='little')
b'\xe8\x03'
 The integer is represented using length bytes. An OverflowError is raised if the integer is not representable with the given number of bytes. The byteorder argument determines 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. The signed argument 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. The default value for signed is False.  New in version 3.2.
exception InterruptedError  
Raised when a system call is interrupted by an incoming signal. Corresponds to errno EINTR.  Changed in version 3.5: Python now retries system calls when a syscall is interrupted by a signal, except if the signal handler raises an exception (see PEP 475 for the rationale), instead of raising InterruptedError.
exception io.BlockingIOError  
This is a compatibility alias for the builtin BlockingIOError exception.
detach()  
Separate the underlying raw stream from the buffer and return it. After the raw stream has been detached, the buffer is in an unusable state. Some buffers, like BytesIO, do not have the concept of a single raw stream to return from this method. They raise UnsupportedOperation.  New in version 3.1.
raw  
The underlying raw stream (a RawIOBase instance) that BufferedIOBase deals with. This is not part of the BufferedIOBase API and may not exist on some implementations.
read(size=-1)  
Read and return up to size bytes. If the argument is omitted, None, or negative, data is read and returned until EOF is reached. An empty bytes object is returned if the stream is already at EOF. If the argument is positive, and the underlying raw stream is not interactive, multiple raw reads may be issued to satisfy the byte count (unless EOF is reached first). But for interactive raw streams, at most one raw read will be issued, and a short result does not imply that EOF is imminent. A BlockingIOError is raised if the underlying raw stream is in non blocking-mode, and has no data available at the moment.
read1([size])  
Read and return up to size bytes, with at most one call to the underlying raw stream’s read() (or readinto()) method. This can be useful if you are implementing your own buffering on top of a BufferedIOBase object. If size is -1 (the default), an arbitrary number of bytes are returned (more than zero unless EOF is reached).
readinto(b)  
Read bytes into a pre-allocated, writable bytes-like object b and return the number of bytes read. For example, b might be a bytearray. Like read(), multiple reads may be issued to the underlying raw stream, unless the latter is interactive. A BlockingIOError is raised if the underlying raw stream is in non blocking-mode, and has no data available at the moment.
readinto1(b)  
Read bytes into a pre-allocated, writable bytes-like object b, using at most one call to the underlying raw stream’s read() (or readinto()) method. Return the number of bytes read. A BlockingIOError is raised if the underlying raw stream is in non blocking-mode, and has no data available at the moment.  New in version 3.5.
write(b)  
Write the given bytes-like object, b, and return the number of bytes written (always equal to the length of b in bytes, since if the write fails an OSError will be raised). Depending on the actual implementation, these bytes may be readily written to the underlying stream, or held in a buffer for performance and latency reasons. When in non-blocking mode, a BlockingIOError is raised if the data needed to be written to the raw stream but it couldn’t accept all the data without blocking. The caller may release or mutate b after this method returns, so the implementation should only access b during the method call.
class io.BufferedRandom(raw, buffer_size=DEFAULT_BUFFER_SIZE)  
A buffered binary stream providing higher-level access to a seekable RawIOBase raw binary stream. It inherits BufferedReader and BufferedWriter. The constructor creates a reader and writer for a seekable raw stream, given in the first argument. If the buffer_size is omitted it defaults to DEFAULT_BUFFER_SIZE. BufferedRandom is capable of anything BufferedReader or BufferedWriter can do. In addition, seek() and tell() are guaranteed to be implemented.
class io.BufferedReader(raw, buffer_size=DEFAULT_BUFFER_SIZE)  
A buffered binary stream providing higher-level access to a readable, non seekable RawIOBase raw binary stream. It inherits BufferedIOBase. When reading data from this object, a larger amount of data may be requested from the underlying raw stream, and kept in an internal buffer. The buffered data can then be returned directly on subsequent reads. The constructor creates a BufferedReader for the given readable raw stream and buffer_size. If buffer_size is omitted, DEFAULT_BUFFER_SIZE is used. BufferedReader provides or overrides these methods in addition to those from BufferedIOBase and IOBase:  
peek([size])  
Return bytes from the stream without advancing the position. At most one single read on the raw stream is done to satisfy the call. The number of bytes returned may be less or more than requested. 
  
read([size])  
Read and return size bytes, or if size is not given or negative, until EOF or if the read call would block in non-blocking mode. 
  
read1([size])  
Read and return up to size bytes with only one call on the raw stream. If at least one byte is buffered, only buffered bytes are returned. Otherwise, one raw stream read call is made.  Changed in version 3.7: The size argument is now optional.
peek([size])  
Return bytes from the stream without advancing the position. At most one single read on the raw stream is done to satisfy the call. The number of bytes returned may be less or more than requested.
read([size])  
Read and return size bytes, or if size is not given or negative, until EOF or if the read call would block in non-blocking mode.
read1([size])  
Read and return up to size bytes with only one call on the raw stream. If at least one byte is buffered, only buffered bytes are returned. Otherwise, one raw stream read call is made.  Changed in version 3.7: The size argument is now optional.
class io.BufferedRWPair(reader, writer, buffer_size=DEFAULT_BUFFER_SIZE)  
A buffered binary stream providing higher-level access to two non seekable RawIOBase raw binary streams—one readable, the other writeable. It inherits BufferedIOBase. reader and writer are RawIOBase objects that are readable and writeable respectively. If the buffer_size is omitted it defaults to DEFAULT_BUFFER_SIZE. BufferedRWPair implements all of BufferedIOBase’s methods except for detach(), which raises UnsupportedOperation.  Warning BufferedRWPair does not attempt to synchronize accesses to its underlying raw streams. You should not pass it the same object as reader and writer; use BufferedRandom instead.
class io.BufferedWriter(raw, buffer_size=DEFAULT_BUFFER_SIZE)  
A buffered binary stream providing higher-level access to a writeable, non seekable RawIOBase raw binary stream. It inherits BufferedIOBase. When writing to this object, data is normally placed into an internal buffer. The buffer will be written out to the underlying RawIOBase object under various conditions, including:  when the buffer gets too small for all pending data; when flush() is called; when a seek() is requested (for BufferedRandom objects); when the BufferedWriter object is closed or destroyed.  The constructor creates a BufferedWriter for the given writeable raw stream. If the buffer_size is not given, it defaults to DEFAULT_BUFFER_SIZE. BufferedWriter provides or overrides these methods in addition to those from BufferedIOBase and IOBase:  
flush()  
Force bytes held in the buffer into the raw stream. A BlockingIOError should be raised if the raw stream blocks. 
  
write(b)  
Write the bytes-like object, b, and return the number of bytes written. When in non-blocking mode, a BlockingIOError is raised if the buffer needs to be written out but the raw stream blocks.
flush()  
Force bytes held in the buffer into the raw stream. A BlockingIOError should be raised if the raw stream blocks.
write(b)  
Write the bytes-like object, b, and return the number of bytes written. When in non-blocking mode, a BlockingIOError is raised if the buffer needs to be written out but the raw stream blocks.
class io.BytesIO([initial_bytes])  
A binary stream using an in-memory bytes buffer. It inherits BufferedIOBase. The buffer is discarded when the close() method is called. The optional argument initial_bytes is a bytes-like object that contains initial data. BytesIO provides or overrides these methods in addition to those from BufferedIOBase and IOBase:  
getbuffer()  
Return a readable and writable view over the contents of the buffer without copying them. Also, mutating the view will transparently update the contents of the buffer: >>> b = io.BytesIO(b"abcdef")
>>> view = b.getbuffer()
>>> view[2:4] = b"56"
>>> b.getvalue()
b'ab56ef'
  Note As long as the view exists, the BytesIO object cannot be resized or closed.   New in version 3.2.  
  
getvalue()  
Return bytes containing the entire contents of the buffer. 
  
read1([size])  
In BytesIO, this is the same as read().  Changed in version 3.7: The size argument is now optional.  
  
readinto1(b)  
In BytesIO, this is the same as readinto().  New in version 3.5.
getbuffer()  
Return a readable and writable view over the contents of the buffer without copying them. Also, mutating the view will transparently update the contents of the buffer: >>> b = io.BytesIO(b"abcdef")
>>> view = b.getbuffer()
>>> view[2:4] = b"56"
>>> b.getvalue()
b'ab56ef'
  Note As long as the view exists, the BytesIO object cannot be resized or closed.   New in version 3.2.
read1([size])  
In BytesIO, this is the same as read().  Changed in version 3.7: The size argument is now optional.
readinto1(b)  
In BytesIO, this is the same as readinto().  New in version 3.5.
io.DEFAULT_BUFFER_SIZE  
An int containing the default buffer size used by the module’s buffered I/O classes. open() uses the file’s blksize (as obtained by os.stat()) if possible.
class io.FileIO(name, mode='r', closefd=True, opener=None)  
A raw binary stream representing an OS-level file containing bytes data. It inherits RawIOBase. The name can be one of two things:  a character string or bytes object representing the path to the file which will be opened. In this case closefd must be True (the default) otherwise an error will be raised. an integer representing the number of an existing OS-level file descriptor to which the resulting FileIO object will give access. When the FileIO object is closed this fd will be closed as well, unless closefd is set to False.  The mode can be 'r', 'w', 'x' or 'a' for reading (default), writing, exclusive creation or appending. The file will be created if it doesn’t exist when opened for writing or appending; it will be truncated when opened for writing. FileExistsError will be raised if it already exists when opened for creating. Opening a file for creating implies writing, so this mode behaves in a similar way to 'w'. Add a '+' to the mode to allow simultaneous reading and writing. The read() (when called with a positive argument), readinto() and write() methods on this class will only make one system call. A custom opener can be used by passing a callable as opener. The underlying file descriptor for the file object is then obtained by calling opener with (name, flags). opener must return an open file descriptor (passing os.open as opener results in functionality similar to passing None). The newly created file is non-inheritable. See the open() built-in function for examples on using the opener parameter.  Changed in version 3.3: The opener parameter was added. The 'x' mode was added.   Changed in version 3.4: The file is now non-inheritable.  FileIO provides these data attributes in addition to those from RawIOBase and IOBase:  
mode  
The mode as given in the constructor. 
  
name  
The file name. This is the file descriptor of the file when no name is given in the constructor.
name  
The file name. This is the file descriptor of the file when no name is given in the constructor.
class io.IncrementalNewlineDecoder  
A helper codec that decodes newlines for universal newlines mode. It inherits codecs.IncrementalDecoder.
close()  
Flush and close this stream. This method has no effect if the file is already closed. Once the file is closed, any operation on the file (e.g. reading or writing) will raise a ValueError. As a convenience, it is allowed to call this method more than once; only the first call, however, will have an effect.
fileno()  
Return the underlying file descriptor (an integer) of the stream if it exists. An OSError is raised if the IO object does not use a file descriptor.
flush()  
Flush the write buffers of the stream if applicable. This does nothing for read-only and non-blocking streams.
isatty()  
Return True if the stream is interactive (i.e., connected to a terminal/tty device).
readable()  
Return True if the stream can be read from. If False, read() will raise OSError.
readline(size=-1)  
Read and return one line from the stream. If size is specified, at most size bytes will be read. The line terminator is always b'\n' for binary files; for text files, the newline argument to open() can be used to select the line terminator(s) recognized.
readlines(hint=-1)  
Read and return a list of lines from the stream. hint can be specified to control the number of lines read: no more lines will be read if the total size (in bytes/characters) of all lines so far exceeds hint. Note that it’s already possible to iterate on file objects using for
line in file: ... without calling file.readlines().
seek(offset, whence=SEEK_SET)  
Change the stream position to the given byte offset. offset is interpreted relative to the position indicated by whence. The default value for whence is SEEK_SET. Values for whence are:  
SEEK_SET or 0 – start of the stream (the default); offset should be zero or positive 
SEEK_CUR or 1 – current stream position; offset may be negative 
SEEK_END or 2 – end of the stream; offset is usually negative  Return the new absolute position.  New in version 3.1: The SEEK_* constants.   New in version 3.3: Some operating systems could support additional values, like os.SEEK_HOLE or os.SEEK_DATA. The valid values for a file could depend on it being open in text or binary mode.
seekable()  
Return True if the stream supports random access. If False, seek(), tell() and truncate() will raise OSError.
truncate(size=None)  
Resize the stream to the given size in bytes (or the current position if size is not specified). The current stream position isn’t changed. This resizing can extend or reduce the current file size. In case of extension, the contents of the new file area depend on the platform (on most systems, additional bytes are zero-filled). The new file size is returned.  Changed in version 3.5: Windows will now zero-fill files when extending.
writable()  
Return True if the stream supports writing. If False, write() and truncate() will raise OSError.
writelines(lines)  
Write a list of lines to the stream. Line separators are not added, so it is usual for each of the lines provided to have a line separator at the end.
__del__()  
Prepare for object destruction. IOBase provides a default implementation of this method that calls the instance’s close() method.
io.open(file, mode='r', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None)  
This is an alias for the builtin open() function.
This function raises an auditing event open with arguments path, mode and flags. The mode and flags arguments may have been modified or inferred from the original call.
io.open_code(path)  
Opens the provided file with mode 'rb'. This function should be used when the intent is to treat the contents as executable code. path should be a str and an absolute path. The behavior of this function may be overridden by an earlier call to the PyFile_SetOpenCodeHook(). However, assuming that path is a str and an absolute path, open_code(path) should always behave the same as open(path, 'rb'). Overriding the behavior is intended for additional validation or preprocessing of the file.  New in version 3.8.
class io.RawIOBase  
Base class for raw binary streams. It inherits IOBase. There is no public constructor. Raw binary streams typically provide low-level access to an underlying OS device or API, and do not try to encapsulate it in high-level primitives (this functionality is done at a higher-level in buffered binary streams and text streams, described later in this page). RawIOBase provides these methods in addition to those from IOBase:  
read(size=-1)  
Read up to size bytes from the object and return them. As a convenience, if size is unspecified or -1, all bytes until EOF are returned. Otherwise, only one system call is ever made. Fewer than size bytes may be returned if the operating system call returns fewer than size bytes. If 0 bytes are returned, and size was not 0, this indicates end of file. If the object is in non-blocking mode and no bytes are available, None is returned. The default implementation defers to readall() and readinto(). 
  
readall()  
Read and return all the bytes from the stream until EOF, using multiple calls to the stream if necessary. 
  
readinto(b)  
Read bytes into a pre-allocated, writable bytes-like object b, and return the number of bytes read. For example, b might be a bytearray. If the object is in non-blocking mode and no bytes are available, None is returned. 
  
write(b)  
Write the given bytes-like object, b, to the underlying raw stream, and return the number of bytes written. This can be less than the length of b in bytes, depending on specifics of the underlying raw stream, and especially if it is in non-blocking mode. None is returned if the raw stream is set not to block and no single byte could be readily written to it. The caller may release or mutate b after this method returns, so the implementation should only access b during the method call.
read(size=-1)  
Read up to size bytes from the object and return them. As a convenience, if size is unspecified or -1, all bytes until EOF are returned. Otherwise, only one system call is ever made. Fewer than size bytes may be returned if the operating system call returns fewer than size bytes. If 0 bytes are returned, and size was not 0, this indicates end of file. If the object is in non-blocking mode and no bytes are available, None is returned. The default implementation defers to readall() and readinto().
readall()  
Read and return all the bytes from the stream until EOF, using multiple calls to the stream if necessary.
readinto(b)  
Read bytes into a pre-allocated, writable bytes-like object b, and return the number of bytes read. For example, b might be a bytearray. If the object is in non-blocking mode and no bytes are available, None is returned.
write(b)  
Write the given bytes-like object, b, to the underlying raw stream, and return the number of bytes written. This can be less than the length of b in bytes, depending on specifics of the underlying raw stream, and especially if it is in non-blocking mode. None is returned if the raw stream is set not to block and no single byte could be readily written to it. The caller may release or mutate b after this method returns, so the implementation should only access b during the method call.
class io.StringIO(initial_value='', newline='\n')  
A text stream using an in-memory text buffer. It inherits TextIOBase. The text buffer is discarded when the close() method is called. The initial value of the buffer can be set by providing initial_value. If newline translation is enabled, newlines will be encoded as if by write(). The stream is positioned at the start of the buffer. The newline argument works like that of TextIOWrapper, except that when writing output to the stream, if newline is None, newlines are written as \n on all platforms. StringIO provides this method in addition to those from TextIOBase and IOBase:  
getvalue()  
Return a str containing the entire contents of the buffer. Newlines are decoded as if by read(), although the stream position is not changed. 
 Example usage: import io

output = io.StringIO()
output.write('First line.\n')
print('Second line.', file=output)

# Retrieve file contents -- this will be
# 'First line.\nSecond line.\n'
contents = output.getvalue()

# Close object and discard memory buffer --
# .getvalue() will now raise an exception.
output.close()
getvalue()  
Return a str containing the entire contents of the buffer. Newlines are decoded as if by read(), although the stream position is not changed.
class io.TextIOBase  
Base class for text streams. This class provides a character and line based interface to stream I/O. It inherits IOBase. There is no public constructor. TextIOBase provides or overrides these data attributes and methods in addition to those from IOBase:  
encoding  
The name of the encoding used to decode the stream’s bytes into strings, and to encode strings into bytes. 
  
errors  
The error setting of the decoder or encoder. 
  
newlines  
A string, a tuple of strings, or None, indicating the newlines translated so far. Depending on the implementation and the initial constructor flags, this may not be available. 
  
buffer  
The underlying binary buffer (a BufferedIOBase instance) that TextIOBase deals with. This is not part of the TextIOBase API and may not exist in some implementations. 
  
detach()  
Separate the underlying binary buffer from the TextIOBase and return it. After the underlying buffer has been detached, the TextIOBase is in an unusable state. Some TextIOBase implementations, like StringIO, may not have the concept of an underlying buffer and calling this method will raise UnsupportedOperation.  New in version 3.1.  
  
read(size=-1)  
Read and return at most size characters from the stream as a single str. If size is negative or None, reads until EOF. 
  
readline(size=-1)  
Read until newline or EOF and return a single str. If the stream is already at EOF, an empty string is returned. If size is specified, at most size characters will be read. 
  
seek(offset, whence=SEEK_SET)  
Change the stream position to the given offset. Behaviour depends on the whence parameter. The default value for whence is SEEK_SET.  
SEEK_SET or 0: seek from the start of the stream (the default); offset must either be a number returned by TextIOBase.tell(), or zero. Any other offset value produces undefined behaviour. 
SEEK_CUR or 1: “seek” to the current position; offset must be zero, which is a no-operation (all other values are unsupported). 
SEEK_END or 2: seek to the end of the stream; offset must be zero (all other values are unsupported).  Return the new absolute position as an opaque number.  New in version 3.1: The SEEK_* constants.  
  
tell()  
Return the current stream position as an opaque number. The number does not usually represent a number of bytes in the underlying binary storage. 
  
write(s)  
Write the string s to the stream and return the number of characters written.
buffer  
The underlying binary buffer (a BufferedIOBase instance) that TextIOBase deals with. This is not part of the TextIOBase API and may not exist in some implementations.
detach()  
Separate the underlying binary buffer from the TextIOBase and return it. After the underlying buffer has been detached, the TextIOBase is in an unusable state. Some TextIOBase implementations, like StringIO, may not have the concept of an underlying buffer and calling this method will raise UnsupportedOperation.  New in version 3.1.