.. _sec-fs-api:

=====================
hailtop.fs Python API
=====================

This is the API documentation for Hail's cloud-agnostic file system implementation in ``hailtop.fs``.

Use ``import hailtop.fs as hfs`` to access this functionality.


Top-Level Functions
~~~~~~~~~~~~~~~~~~~

.. currentmodule:: hailtop.fs

.. autosummary::

    copy
    exists
    is_dir
    is_file
    ls
    mkdir
    open
    remove
    rmtree
    stat

.. autofunction:: copy
.. autofunction:: exists
.. autofunction:: is_dir
.. autofunction:: is_file
.. autofunction:: ls
.. autofunction:: mkdir
.. autofunction:: open
.. autofunction:: remove
.. autofunction:: rmtree
.. autofunction:: stat