total_fields_count property

FieldUpdatingProgressArgs.total_fields_count property

Gets the total fields count to be updated.

@property
def total_fields_count(self) -> int:
    ...

Remarks

The value is not constant and may be increased during updating process.

Examples

Shows how to use callback methods during a field update (FieldUpdatingCallback).

class FieldUpdatingCallback(aw.fields.IFieldUpdatingCallback, aw.fields.IFieldUpdatingProgressCallback):

    @property
    def field_updated_calls(self):
        pass

    def __init__(self):
        field_updated_calls = []

    def field_updating(self, field):
        if field.type == aw.fields.FieldType.FIELD_AUTHOR:
            field_author = field.as_field_author()
            field_author.author_name = 'Updating John Doe'

    def field_updated(self, field):
        field_updated_calls.append(field.result)

    def notify(self, args):
        print(f'{args.update_completed}/{args.total_fields_count}')
        print(f'{args.updated_fields_count}')

See Also