pipeline.progress Module

class wpull.pipeline.progress.BarProgress(*args, draw_interval: float=0.5, bar_width: int=25, human_format: bool=True, **kwargs)[source]

Bases: wpull.pipeline.progress.ProgressPrinter

update()[source]
class wpull.pipeline.progress.DotProgress(*args, draw_interval: float=2.0, **kwargs)[source]

Bases: wpull.pipeline.progress.ProgressPrinter

update()[source]
class wpull.pipeline.progress.Measurement[source]

Bases: enum.Enum

class wpull.pipeline.progress.Progress(stream: typing.IO=<_io.TextIOWrapper name='<stderr>' mode='w' encoding='ANSI_X3.4-1968'>)[source]

Bases: wpull.application.hook.HookableMixin

Print file download progress as dots or a bar.

Parameters:
  • bar_style (bool) – If True, print as a progress bar. If False, print dots every few seconds.
  • stream – A file object. Default is usually stderr.
  • human_format (true) – If True, format sizes in units. Otherwise, output bits only.
reset()[source]
update()[source]
class wpull.pipeline.progress.ProgressPrinter(*args, **kwargs)[source]

Bases: wpull.pipeline.progress.ProtocolProgress

update_from_end_response(response: wpull.protocol.abstract.request.BaseResponse)[source]
class wpull.pipeline.progress.ProtocolProgress(*args, **kwargs)[source]

Bases: wpull.pipeline.progress.Progress

class State[source]

Bases: enum.Enum

ProtocolProgress.update_from_begin_request(request: wpull.protocol.abstract.request.BaseRequest)[source]
ProtocolProgress.update_from_begin_response(response: wpull.protocol.abstract.request.BaseResponse)[source]
ProtocolProgress.update_from_end_response(response: wpull.protocol.abstract.request.BaseResponse)[source]
ProtocolProgress.update_with_data(data)[source]