Source code for axonius_api_client.api.asset_callbacks.base_xlsx

# -*- coding: utf-8 -*-
"""Excel export callbacks class."""
from typing import List

import xlsxwriter

from ...exceptions import ApiError
from ...tools import listify
from .base import ExportMixins


[docs]class Xlsx(ExportMixins): """Callbacks for formatting asset data and exporting it in Excel format. Examples: Create a ``client`` using :obj:`axonius_api_client.connect.Connect` and assume ``apiobj`` is either ``client.devices`` or ``client.users`` >>> apiobj = client.devices # or client.users * :meth:`args_map` for callback generic arguments to format assets. * :meth:`args_map_custom` for callback specific arguments to format and export data. """
[docs] @classmethod def args_map_custom(cls) -> dict: """Get the custom argument names and their defaults for this callbacks object. Examples: Export the output to STDOUT. If ``export_file`` is not supplied, the default is to print the output to STDOUT. >>> assets = apiobj.get(export="xlsx") Export the output to a file in the default path :attr:`axonius_api_client.setup_env.DEFAULT_PATH`. >>> assets = apiobj.get(export="xlsx", export_file="test.xlsx") Export the output to an absolute path file (ignoring ``export_path``) and overwrite the file if it exists. >>> assets = apiobj.get( ... export="xlsx", ... export_file="/tmp/output.xlsx", ... export_overwrite=True, ... ) Export the output to a file in a specific dir. >>> assets = apiobj.get(export="xlsx", export_file="output.xlsx", export_path="/tmp") Change the length of columns in the output. >>> assets = apiobj.get( ... export="xlsx", ... export_file="test.xlsx", ... xlsx_column_length=100, ... ) Provide custom formatting for each cell. See https://xlsxwriter.readthedocs.io/format.html#format-methods-and-format-properties for format properties that can be supplied. >>> fmt = {"text_wrap": True, "bold": True, "font_color": "red"} >>> assets = apiobj.get( ... export="xlsx", ... export_file="test.xlsx", ... xlsx_cell_format=fmt, ... ) See Also: * :meth:`args_map` for callback generic arguments to format assets. Notes: If ``export_file`` does not end with ``.xlsx``, it will be appended to the filename. This callbacks object forces the following arguments to True in order to make the output usable in the exported format: ``field_null``, ``field_flatten``, and ``field_join`` These arguments can be supplied as extra kwargs passed to :meth:`axonius_api_client.api.assets.users.Users.get` or :meth:`axonius_api_client.api.assets.devices.Devices.get` """ args = {} args.update(cls.args_map_export()) args.update( { "field_titles": True, "field_flatten": True, "field_join": True, "field_null": True, "xlsx_column_length": 50, "xlsx_cell_format": {"text_wrap": True}, } ) return args
[docs] def _init(self, **kwargs): """Override defaults to make export readable.""" self.set_arg_value("field_null", True) self.set_arg_value("field_flatten", True) self.set_arg_value("field_join", True)
[docs] def start(self, **kwargs): """Start this callbacks object.""" super(Xlsx, self).start(**kwargs) self.do_start(**kwargs)
[docs] def do_start(self, **kwargs): """Start this callbacks object.""" export_file = self.get_arg_value("export_file") cell_format = self.get_arg_value("xlsx_cell_format") column_length = self.get_arg_value("xlsx_column_length") if export_file: if not str(export_file).endswith(".xlsx"): self.set_arg_value("export_file", f"{export_file}.xlsx") self.open_fd_path() self._fd.close() else: msg = "Must supply export_file for this export method" self.echo(msg=msg, error=ApiError, level="error") self._workbook = xlsxwriter.Workbook(str(self._file_path), {"constant_memory": True}) self._cell_format = self._workbook.add_format(cell_format) worksheet = f"{self.APIOBJ.__class__.__name__}" self._worksheet = self._workbook.add_worksheet(worksheet) for idx, column_name in enumerate(self.final_columns): self._worksheet.write(0, idx, column_name, self._cell_format) self._worksheet.set_column(idx, idx, column_length) self._rowtracker = 1
[docs] def stop(self, **kwargs): """Stop this callbacks object.""" super(Xlsx, self).stop(**kwargs) self.do_stop(**kwargs)
[docs] def do_stop(self, **kwargs): """Stop this callbacks object.""" self._workbook.close()
[docs] def process_row(self, row: dict) -> List[dict]: """Write row to dictwriter and delete it.""" rows = listify(row) rows = self.do_pre_row(rows=rows) row_return = [{"internal_axon_id": row["internal_axon_id"]} for row in rows] rows = self.do_row(rows=rows) for row in listify(rows): for idx, column_name in enumerate(self.final_columns): self._worksheet.write( self._rowtracker, idx, row.get(column_name), self._cell_format ) self._rowtracker += 1 del row del rows return row_return
CB_NAME: str = "xlsx" """name for this callback"""