roboto.domain.files.progress#

Module Contents#

class roboto.domain.files.progress.NoopProgressMonitor#

Bases: ProgressMonitor

A Noop Progress Monitor

close()#
is_closed()#
Return type:

bool

update(uploaded_bytes)#
Parameters:

uploaded_bytes (int)

class roboto.domain.files.progress.NoopProgressMonitorFactory(ctx=None)#

Bases: ProgressMonitorFactory

A Noop Progress Monitor Factory

Parameters:

ctx (Optional[dict[str, Any]])

download_monitor(source, size, kwargs=None)#
Parameters:

  • source (str)

  • size (int)

  • kwargs (Optional[dict[str, Any]])

Return type:

ProgressMonitor

upload_monitor(source, size, kwargs=None)#
Parameters:

  • source (str)

  • size (int)

  • kwargs (Optional[dict[str, Any]])

Return type:

ProgressMonitor

class roboto.domain.files.progress.ProgressMonitor#

Bases: abc.ABC

Progress Monitor for file upload

abstract close()#
abstract is_closed()#
Return type:

bool

abstract update(delta)#
Parameters:

delta (int)

class roboto.domain.files.progress.ProgressMonitorFactory(ctx=None)#

Bases: abc.ABC

Progress Monitor Factory for file upload

Parameters:

ctx (Optional[dict[str, Any]])

abstract download_monitor(source, size, kwargs=None)#
Parameters:

  • source (str)

  • size (int)

  • kwargs (Optional[dict[str, Any]])

Return type:

ProgressMonitor

get_context()#
Return type:

dict[str, Any]

abstract upload_monitor(source, size, kwargs=None)#
Parameters:

  • source (str)

  • size (int)

  • kwargs (Optional[dict[str, Any]])

Return type:

ProgressMonitor

class roboto.domain.files.progress.TqdmProgressMonitor(total, desc, position=0, leave=True, unit='B')#

Bases: ProgressMonitor

A Tqdm Progress Monitor

Parameters:

  • total (int)

  • desc (str)

  • position (int)

  • leave (bool)

  • unit (Optional[str])

close()#
is_closed()#
Return type:

bool

update(uploaded_bytes)#
Parameters:

uploaded_bytes (int)

class roboto.domain.files.progress.TqdmProgressMonitorFactory(concurrency=1, ctx=None, unit='B')#

Bases: ProgressMonitorFactory

A Tqdm Progress Monitor Factory

Parameters:

  • concurrency (int)

  • ctx (Optional[dict[str, Any]])

  • unit (Optional[str])

download_monitor(source, size, kwargs=None)#
Parameters:

  • source (str)

  • size (int)

  • kwargs (Optional[dict[str, Any]])

Return type:

ProgressMonitor

upload_monitor(source, size, kwargs=None)#
Parameters:

  • source (str)

  • size (int)

  • kwargs (Optional[dict[str, Any]])

Return type:

ProgressMonitor

On this page