Skip to content

module file_export

Functions to export Yaralyzer results to various file formats.

Global Variables

  • INKSCAPE
  • INKSCAPE_URL
  • CAIROSVG_WARNING_MSG

function export_json

export_json(yaralyzer: Yaralyzer, args: Namespace) → Path

Export YARA scan results to JSON.

Args:

  • yaralyzer (Yaralyzer): The Yaralyzer object containing the results to export.
  • export_basepath (Path | None, Optional): Base path to write output to. Should have no file extension.

Returns:

  • Path: File path data was exported to.

function invoke_rich_export

invoke_rich_export(export_method: Callable, args: Namespace) → None

Announce the export, perform the export, and announce completion.

Args:

  • export_method (Callable): Usually a Rich.console.save_whatever() method.
  • args (Namespace, optional): Arguments parsed by ArgumeentParser.

Returns:

  • Path: Path data was exported to.

function render_png

render_png(svg_path: Path, png_path: Path, args: Namespace) → Path | None

Turn the svg output into a png with Inkscape or cairosvg. Returns png path if successful.

This file was automatically generated via lazydocs.