aiofiles API Reference

File support for asyncio handling local file I/O asynchronously.

aiofiles.open

Python Library Documentation: function open in module aiofiles.threadpool

open(file, mode='r', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None, *, loop=None, executor=None)

aiofiles.stderr

Python Library Documentation: AsyncTextIndirectIOWrapper in module aiofiles.threadpool.text object

class AsyncTextIndirectIOWrapper(aiofiles.base.AsyncIndirectBase)
 |  AsyncTextIndirectIOWrapper(name, loop, executor, indirect)
 |
 |  The indirect asyncio executor version of io.TextIOWrapper.
 |
 |  Method resolution order:
 |      AsyncTextIndirectIOWrapper
 |      aiofiles.base.AsyncIndirectBase
 |      aiofiles.base.AsyncBase
 |      builtins.object
 |
 |  Methods defined here:
 |
 |  async close = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  detach = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_proxy_method.<locals>
 |
 |  fileno = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_proxy_method.<locals>
 |
 |  async flush = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async isatty = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async read = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async readable = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async readline = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async readlines = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async seek = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async seekable = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async tell = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async truncate = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async writable = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async write = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async writelines = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  ----------------------------------------------------------------------
 |  Readonly properties defined here:
 |
 |  buffer
 |
 |  closed
 |
 |  encoding
 |
 |  errors
 |
 |  line_buffering
 |
 |  mode
 |
 |  name
 |
 |  newlines
 |
 |  ----------------------------------------------------------------------
 |  Methods inherited from aiofiles.base.AsyncIndirectBase:
 |
 |  __init__(self, name, loop, executor, indirect)
 |      Initialize self.  See help(type(self)) for accurate signature.
 |
 |  ----------------------------------------------------------------------
 |  Methods inherited from aiofiles.base.AsyncBase:
 |
 |  __aiter__(self)
 |      We are our own iterator.
 |
 |  async __anext__(self)
 |      Simulate normal file iteration.
 |
 |  __repr__(self)
 |      Return repr(self).
 |
 |  ----------------------------------------------------------------------
 |  Data descriptors inherited from aiofiles.base.AsyncBase:
 |
 |  __dict__
 |      dictionary for instance variables
 |
 |  __weakref__
 |      list of weak references to the object

aiofiles.stderr_bytes

Python Library Documentation: AsyncIndirectBufferedIOBase in module aiofiles.threadpool.binary object

class AsyncIndirectBufferedIOBase(aiofiles.base.AsyncIndirectBase)
 |  AsyncIndirectBufferedIOBase(name, loop, executor, indirect)
 |
 |  The indirect asyncio executor version of io.BufferedWriter and BufferedIOBase.
 |
 |  Method resolution order:
 |      AsyncIndirectBufferedIOBase
 |      aiofiles.base.AsyncIndirectBase
 |      aiofiles.base.AsyncBase
 |      builtins.object
 |
 |  Methods defined here:
 |
 |  async close = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  detach = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_proxy_method.<locals>
 |
 |  fileno = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_proxy_method.<locals>
 |
 |  async flush = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async isatty = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async read = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async read1 = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  readable = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_proxy_method.<locals>
 |
 |  async readinto = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async readline = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async readlines = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async seek = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async seekable = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async tell = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async truncate = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async writable = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async write = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async writelines = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  ----------------------------------------------------------------------
 |  Readonly properties defined here:
 |
 |  closed
 |
 |  mode
 |
 |  name
 |
 |  raw
 |
 |  ----------------------------------------------------------------------
 |  Methods inherited from aiofiles.base.AsyncIndirectBase:
 |
 |  __init__(self, name, loop, executor, indirect)
 |      Initialize self.  See help(type(self)) for accurate signature.
 |
 |  ----------------------------------------------------------------------
 |  Methods inherited from aiofiles.base.AsyncBase:
 |
 |  __aiter__(self)
 |      We are our own iterator.
 |
 |  async __anext__(self)
 |      Simulate normal file iteration.
 |
 |  __repr__(self)
 |      Return repr(self).
 |
 |  ----------------------------------------------------------------------
 |  Data descriptors inherited from aiofiles.base.AsyncBase:
 |
 |  __dict__
 |      dictionary for instance variables
 |
 |  __weakref__
 |      list of weak references to the object

aiofiles.stdin

Python Library Documentation: AsyncTextIndirectIOWrapper in module aiofiles.threadpool.text object

class AsyncTextIndirectIOWrapper(aiofiles.base.AsyncIndirectBase)
 |  AsyncTextIndirectIOWrapper(name, loop, executor, indirect)
 |
 |  The indirect asyncio executor version of io.TextIOWrapper.
 |
 |  Method resolution order:
 |      AsyncTextIndirectIOWrapper
 |      aiofiles.base.AsyncIndirectBase
 |      aiofiles.base.AsyncBase
 |      builtins.object
 |
 |  Methods defined here:
 |
 |  async close = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  detach = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_proxy_method.<locals>
 |
 |  fileno = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_proxy_method.<locals>
 |
 |  async flush = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async isatty = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async read = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async readable = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async readline = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async readlines = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async seek = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async seekable = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async tell = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async truncate = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async writable = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async write = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async writelines = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  ----------------------------------------------------------------------
 |  Readonly properties defined here:
 |
 |  buffer
 |
 |  closed
 |
 |  encoding
 |
 |  errors
 |
 |  line_buffering
 |
 |  mode
 |
 |  name
 |
 |  newlines
 |
 |  ----------------------------------------------------------------------
 |  Methods inherited from aiofiles.base.AsyncIndirectBase:
 |
 |  __init__(self, name, loop, executor, indirect)
 |      Initialize self.  See help(type(self)) for accurate signature.
 |
 |  ----------------------------------------------------------------------
 |  Methods inherited from aiofiles.base.AsyncBase:
 |
 |  __aiter__(self)
 |      We are our own iterator.
 |
 |  async __anext__(self)
 |      Simulate normal file iteration.
 |
 |  __repr__(self)
 |      Return repr(self).
 |
 |  ----------------------------------------------------------------------
 |  Data descriptors inherited from aiofiles.base.AsyncBase:
 |
 |  __dict__
 |      dictionary for instance variables
 |
 |  __weakref__
 |      list of weak references to the object

aiofiles.stdin_bytes

Python Library Documentation: AsyncIndirectBufferedIOBase in module aiofiles.threadpool.binary object

class AsyncIndirectBufferedIOBase(aiofiles.base.AsyncIndirectBase)
 |  AsyncIndirectBufferedIOBase(name, loop, executor, indirect)
 |
 |  The indirect asyncio executor version of io.BufferedWriter and BufferedIOBase.
 |
 |  Method resolution order:
 |      AsyncIndirectBufferedIOBase
 |      aiofiles.base.AsyncIndirectBase
 |      aiofiles.base.AsyncBase
 |      builtins.object
 |
 |  Methods defined here:
 |
 |  async close = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  detach = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_proxy_method.<locals>
 |
 |  fileno = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_proxy_method.<locals>
 |
 |  async flush = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async isatty = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async read = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async read1 = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  readable = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_proxy_method.<locals>
 |
 |  async readinto = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async readline = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async readlines = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async seek = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async seekable = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async tell = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async truncate = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async writable = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async write = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async writelines = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  ----------------------------------------------------------------------
 |  Readonly properties defined here:
 |
 |  closed
 |
 |  mode
 |
 |  name
 |
 |  raw
 |
 |  ----------------------------------------------------------------------
 |  Methods inherited from aiofiles.base.AsyncIndirectBase:
 |
 |  __init__(self, name, loop, executor, indirect)
 |      Initialize self.  See help(type(self)) for accurate signature.
 |
 |  ----------------------------------------------------------------------
 |  Methods inherited from aiofiles.base.AsyncBase:
 |
 |  __aiter__(self)
 |      We are our own iterator.
 |
 |  async __anext__(self)
 |      Simulate normal file iteration.
 |
 |  __repr__(self)
 |      Return repr(self).
 |
 |  ----------------------------------------------------------------------
 |  Data descriptors inherited from aiofiles.base.AsyncBase:
 |
 |  __dict__
 |      dictionary for instance variables
 |
 |  __weakref__
 |      list of weak references to the object

aiofiles.stdout

Python Library Documentation: AsyncTextIndirectIOWrapper in module aiofiles.threadpool.text object

class AsyncTextIndirectIOWrapper(aiofiles.base.AsyncIndirectBase)
 |  AsyncTextIndirectIOWrapper(name, loop, executor, indirect)
 |
 |  The indirect asyncio executor version of io.TextIOWrapper.
 |
 |  Method resolution order:
 |      AsyncTextIndirectIOWrapper
 |      aiofiles.base.AsyncIndirectBase
 |      aiofiles.base.AsyncBase
 |      builtins.object
 |
 |  Methods defined here:
 |
 |  async close = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  detach = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_proxy_method.<locals>
 |
 |  fileno = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_proxy_method.<locals>
 |
 |  async flush = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async isatty = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async read = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async readable = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async readline = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async readlines = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async seek = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async seekable = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async tell = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async truncate = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async writable = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async write = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async writelines = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  ----------------------------------------------------------------------
 |  Readonly properties defined here:
 |
 |  buffer
 |
 |  closed
 |
 |  encoding
 |
 |  errors
 |
 |  line_buffering
 |
 |  mode
 |
 |  name
 |
 |  newlines
 |
 |  ----------------------------------------------------------------------
 |  Methods inherited from aiofiles.base.AsyncIndirectBase:
 |
 |  __init__(self, name, loop, executor, indirect)
 |      Initialize self.  See help(type(self)) for accurate signature.
 |
 |  ----------------------------------------------------------------------
 |  Methods inherited from aiofiles.base.AsyncBase:
 |
 |  __aiter__(self)
 |      We are our own iterator.
 |
 |  async __anext__(self)
 |      Simulate normal file iteration.
 |
 |  __repr__(self)
 |      Return repr(self).
 |
 |  ----------------------------------------------------------------------
 |  Data descriptors inherited from aiofiles.base.AsyncBase:
 |
 |  __dict__
 |      dictionary for instance variables
 |
 |  __weakref__
 |      list of weak references to the object

aiofiles.stdout_bytes

Python Library Documentation: AsyncIndirectBufferedIOBase in module aiofiles.threadpool.binary object

class AsyncIndirectBufferedIOBase(aiofiles.base.AsyncIndirectBase)
 |  AsyncIndirectBufferedIOBase(name, loop, executor, indirect)
 |
 |  The indirect asyncio executor version of io.BufferedWriter and BufferedIOBase.
 |
 |  Method resolution order:
 |      AsyncIndirectBufferedIOBase
 |      aiofiles.base.AsyncIndirectBase
 |      aiofiles.base.AsyncBase
 |      builtins.object
 |
 |  Methods defined here:
 |
 |  async close = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  detach = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_proxy_method.<locals>
 |
 |  fileno = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_proxy_method.<locals>
 |
 |  async flush = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async isatty = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async read = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async read1 = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  readable = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_proxy_method.<locals>
 |
 |  async readinto = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async readline = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async readlines = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async seek = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async seekable = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async tell = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async truncate = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async writable = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async write = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  async writelines = method(self, *args, **kwargs) from aiofiles.threadpool.utils._make_delegate_method.<locals>
 |
 |  ----------------------------------------------------------------------
 |  Readonly properties defined here:
 |
 |  closed
 |
 |  mode
 |
 |  name
 |
 |  raw
 |
 |  ----------------------------------------------------------------------
 |  Methods inherited from aiofiles.base.AsyncIndirectBase:
 |
 |  __init__(self, name, loop, executor, indirect)
 |      Initialize self.  See help(type(self)) for accurate signature.
 |
 |  ----------------------------------------------------------------------
 |  Methods inherited from aiofiles.base.AsyncBase:
 |
 |  __aiter__(self)
 |      We are our own iterator.
 |
 |  async __anext__(self)
 |      Simulate normal file iteration.
 |
 |  __repr__(self)
 |      Return repr(self).
 |
 |  ----------------------------------------------------------------------
 |  Data descriptors inherited from aiofiles.base.AsyncBase:
 |
 |  __dict__
 |      dictionary for instance variables
 |
 |  __weakref__
 |      list of weak references to the object

⚡ aiofiles Docs

aiofiles API Reference