_compression.BaseStream - pydoc - phpman

Help on class BaseStream in _compression:

_compression.BaseStream = class BaseStream(io.BufferedIOBase)
 |  Mode-checking helper functions.
 |
 |  Method resolution order:
 |      BaseStream
 |      io.BufferedIOBase
 |      _io._BufferedIOBase
 |      io.IOBase
 |      _io._IOBase
 |      builtins.object
 |
 |  Data and other attributes defined here:
 |
 |  __abstractmethods__ = frozenset()
 |
 |  ----------------------------------------------------------------------
 |  Methods inherited from _io._BufferedIOBase:
 |
 |  detach(self, /)
 |      Disconnect this buffer from its underlying raw stream and return it.
 |
 |      After the raw stream has been detached, the buffer is in an unusable
 |      state.
 |
 |  read(...)
 |      Read and return up to n bytes.
 |
 |      If the argument is omitted, None, or negative, reads and
 |      returns all data until 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 (as well as sockets and pipes), at most
 |      one raw read will be issued, and a short result does not imply
 |      that EOF is imminent.
 |
 |      Returns an empty bytes object on EOF.
 |
 |      Returns None if the underlying raw stream was open in non-blocking
 |      mode and no data is available at the moment.
 |
 |  read1(...)
 |      Read and return up to n bytes, with at most one read() call
 |      to the underlying raw stream. A short result does not imply
 |      that EOF is imminent.
 |
 |      Returns an empty bytes object on EOF.
 |
 |  readinto(self, buffer, /)
 |
 |  readinto1(self, buffer, /)
 |
 |  write(...)
 |      Write the given buffer to the IO stream.
 |
 |      Returns the number of bytes written, which is always the length of b
 |      in bytes.
 |
 |      Raises BlockingIOError if the buffer is full and the
 |      underlying raw stream cannot accept more data at the moment.
 |
 |  ----------------------------------------------------------------------
 |  Methods inherited from _io._IOBase:
 |
 |  __del__(...)
 |
 |  __enter__(...)
 |
 |  __exit__(...)
 |
 |  __iter__(self, /)
 |      Implement iter(self).
 |
 |  __next__(self, /)
 |      Implement next(self).
 |
 |  close(self, /)
 |      Flush and close the IO object.
 |
 |      This method has no effect if the file is already closed.
 |
 |  fileno(self, /)
 |      Returns underlying file descriptor if one exists.
 |
 |      OSError is raised if the IO object does not use a file descriptor.
 |
 |  flush(self, /)
 |      Flush write buffers, if applicable.
 |
 |      This is not implemented for read-only and non-blocking streams.
 |
 |  isatty(self, /)
 |      Return whether this is an 'interactive' stream.
 |
 |      Return False if it can't be determined.
 |
 |  readable(self, /)
 |      Return whether object was opened for reading.
 |
 |      If False, read() will raise OSError.
 |
 |  readline(self, size=-1, /)
 |      Read and return a 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 newlines argument to open can be used to select the line
 |      terminator(s) recognized.
 |
 |  readlines(self, hint=-1, /)
 |      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.
 |
 |  seek(...)
 |      Change stream position.
 |
 |      Change the stream position to the given byte offset. The offset is
 |      interpreted relative to the position indicated by whence.  Values
 |      for whence are:
 |
 |      * 0 -- start of stream (the default); offset should be zero or positive
 |      * 1 -- current stream position; offset may be negative
 |      * 2 -- end of stream; offset is usually negative
 |
 |      Return the new absolute position.
 |
 |  seekable(self, /)
 |      Return whether object supports random access.
 |
 |      If False, seek(), tell() and truncate() will raise OSError.
 |      This method may need to do a test seek().
 |
 |  tell(self, /)
 |      Return current stream position.
 |
 |  truncate(...)
 |      Truncate file to size bytes.
 |
 |      File pointer is left unchanged.  Size defaults to the current IO
 |      position as reported by tell().  Returns the new size.
 |
 |  writable(self, /)
 |      Return whether object was opened for writing.
 |
 |      If False, write() will raise OSError.
 |
 |  writelines(self, lines, /)
 |      Write a list of lines to stream.
 |
 |      Line separators are not added, so it is usual for each of the
 |      lines provided to have a line separator at the end.
 |
 |  ----------------------------------------------------------------------
 |  Static methods inherited from _io._IOBase:
 |
 |  __new__(*args, **kwargs) from builtins.type
 |      Create and return a new object.  See help(type) for accurate signature.
 |
 |  ----------------------------------------------------------------------
 |  Data descriptors inherited from _io._IOBase:
 |
 |  __dict__
 |
 |  closed