graphtage.pickle

pickle classes

Pickle

class graphtage.pickle.Pickle

Bases: Filetype

The Python Pickle file type.

__init__()

Initializes the Pickle file type.

By default, Pickle associates itself with the “pickle”, “application/python-pickle”, and “application/x-python-pickle” MIME types.

build_tree(path: str, options: BuildOptions | None = None) → TreeNode

Builds an intermediate representation tree from a file of this Filetype.

Parameters:

• path – Path to the file to parse

• options – An optional set of options for building the tree

Returns:

The root tree node of the provided file

Return type:

TreeNode

build_tree_handling_errors(path: str, options: BuildOptions | None = None) → str | TreeNode

Same as Filetype.build_tree(), but it should return a human-readable error string on failure.

This function should never throw an exception.

Parameters:

• path – Path to the file to parse

• options – An optional set of options for building the tree

Returns:

On success, the root tree node, or a string containing the error message on failure.

Return type:

Union[str, TreeNode]

default_instance: Filetype = <graphtage.pickle.Pickle object>

get_default_formatter() → PyDiffFormatter

Returns the default formatter for printing files of this type.