Input / Output¶
papermill.iorw¶
-
class
papermill.iorw.
ABSHandler
¶ Bases:
object
-
listdir
(path)¶
-
pretty_path
(path)¶
-
read
(path)¶
-
write
(buf, path)¶
-
-
class
papermill.iorw.
ADLHandler
¶ Bases:
object
-
listdir
(path)¶
-
pretty_path
(path)¶
-
read
(path)¶
-
write
(buf, path)¶
-
-
class
papermill.iorw.
GCSHandler
¶ Bases:
object
-
RATE_LIMIT_RETRIES
= 3¶
-
RETRY_DELAY
= 1¶
-
RETRY_MAX_DELAY
= 4¶
-
RETRY_MULTIPLIER
= 1¶
-
listdir
(path)¶
-
pretty_path
(path)¶
-
read
(path)¶
-
write
(buf, path)¶
-
-
class
papermill.iorw.
HttpHandler
¶ Bases:
object
-
classmethod
listdir
(path)¶
-
classmethod
pretty_path
(path)¶
-
classmethod
read
(path)¶
-
classmethod
write
(buf, path)¶
-
classmethod
-
class
papermill.iorw.
LocalHandler
¶ Bases:
object
-
cwd
(new_path)¶ Sets the cwd during reads and writes
-
listdir
(path)¶
-
pretty_path
(path)¶
-
read
(path)¶
-
write
(buf, path)¶
-
-
class
papermill.iorw.
PapermillIO
¶ Bases:
object
The holder which houses any io system registered with the system. This object is used in a singleton manner to save and load particular named Handler objects for reference externally.
-
get_handler
(path)¶
-
listdir
(path)¶
-
pretty_path
(path)¶
-
read
(path, extensions=['.ipynb', '.json'])¶
-
register
(scheme, handler)¶
-
register_entry_points
()¶
-
reset
()¶
-
write
(buf, path, extensions=['.ipynb', '.json'])¶
-
-
class
papermill.iorw.
S3Handler
¶ Bases:
object
-
classmethod
listdir
(path)¶
-
classmethod
pretty_path
(path)¶
-
classmethod
read
(path)¶
-
classmethod
write
(buf, path)¶
-
classmethod
-
papermill.iorw.
get_pretty_path
(path)¶
-
papermill.iorw.
list_notebook_files
(path)¶ Returns a list of all the notebook files in a directory.
-
papermill.iorw.
load_notebook_node
(notebook_path)¶ Returns a notebook object with papermill metadata loaded from the specified path.
Parameters: notebook_path (str) – Path to the notebook file. Returns: nbformat.NotebookNode
-
papermill.iorw.
local_file_io_cwd
(path=None)¶
-
papermill.iorw.
read_yaml_file
(path)¶ Reads a YAML file from the location specified at ‘path’.
-
papermill.iorw.
write_ipynb
(nb, path)¶ Saves a notebook object to the specified path. :param nb_node: Notebook object to save. :type nb_node: nbformat.NotebookNode :param notebook_path: Path to save the notebook object to. :type notebook_path: str