anvil_consortium_manager.auditor.audit.base module

class anvil_consortium_manager.auditor.audit.base.AnVILAudit

Bases: ABC

Abstract base class for AnVIL audit results.

add_result(result)

audit(cache=False)

Run the audit.

This method should not handle caching the results. It may need to know whether caching was requested if it is running sub-audits (e.g., workspace sharing for workspaces).

cache()

Cache the audit results.

cache_key = None

error_table_class

alias of ErrorTable

export(include_verified=True, include_errors=True, include_not_in_app=True, include_ignored=True)

Return a dictionary representation of the audit results.

get_cache_key()

get_error_results()

get_error_table()

get_ignored_results()

get_ignored_table()

get_not_in_app_results()

get_not_in_app_table()

get_result_for_model_instance(model_instance)

get_verified_results()

get_verified_table()

ignored_table_class

alias of IgnoredTable

not_in_app_table_class

alias of NotInAppTable

ok()

run_audit(cache=False)

Run the audit and optionally cache the results.

verified_table_class

alias of VerifiedTable

class anvil_consortium_manager.auditor.audit.base.ErrorTable(data=None, order_by=None, orderable=None, empty_text=None, exclude=None, attrs=None, row_attrs=None, pinned_row_attrs=None, sequence=None, prefix=None, order_by_field=None, page_field=None, per_page_field=None, template_name=None, default=None, request=None, show_header=None, show_footer=True, extra_columns=None)

Bases: Table

Table for results with errors.

base_columns = {'errors': <django_tables2.columns.base.Column object>, 'model_instance': <django_tables2.columns.base.Column object>}

render_errors(record)

class anvil_consortium_manager.auditor.audit.base.IgnoredResult(model_instance, record=None)

Bases: object

Class to hold an audit result for a specific record in an Ignore table.

class anvil_consortium_manager.auditor.audit.base.IgnoredTable(data=None, order_by=None, orderable=None, empty_text=None, exclude=None, attrs=None, row_attrs=None, pinned_row_attrs=None, sequence=None, prefix=None, order_by_field=None, page_field=None, per_page_field=None, template_name=None, default=None, request=None, show_header=None, show_footer=True, extra_columns=None)

Bases: Table

base_columns = {'model_instance': <django_tables2.columns.base.Column object>, 'record': <django_tables2.columns.base.Column object>}

render_model_instance(record)

class anvil_consortium_manager.auditor.audit.base.ModelInstanceResult(model_instance)

Bases: object

Class to hold an audit result for a specific instance of a model.

add_error(error)

Add an error to the audit result for this model instance.

ok()

Check whether an audit result has errors.

class anvil_consortium_manager.auditor.audit.base.NotInAppResult(record)

Bases: object

Class to hold an audit result for a record that is not present in the app.

class anvil_consortium_manager.auditor.audit.base.NotInAppTable(data=None, order_by=None, orderable=None, empty_text=None, exclude=None, attrs=None, row_attrs=None, pinned_row_attrs=None, sequence=None, prefix=None, order_by_field=None, page_field=None, per_page_field=None, template_name=None, default=None, request=None, show_header=None, show_footer=True, extra_columns=None)

Bases: Table

base_columns = {'record': <django_tables2.columns.base.Column object>}

class anvil_consortium_manager.auditor.audit.base.VerifiedTable(data=None, order_by=None, orderable=None, empty_text=None, exclude=None, attrs=None, row_attrs=None, pinned_row_attrs=None, sequence=None, prefix=None, order_by_field=None, page_field=None, per_page_field=None, template_name=None, default=None, request=None, show_header=None, show_footer=True, extra_columns=None)

Bases: Table

Table for verified results.

base_columns = {'model_instance': <django_tables2.columns.base.Column object>}