sdkagent

tqdm API reference

49 public APIs from tqdm (tqdm/tqdm) — 24 classes, 8 functions, 17 methods. Signatures extracted by static analysis of the actual source.

Repository: tqdm/tqdm

KindCount
Classes24
Functions8
Methods17

API list

classtqdm._monitor.TMonitor
Monitoring thread for tqdm bars.
classtqdm.asyncio.tqdm_asyncio
Asynchronous-friendly version of tqdm.
functqdm.cli.cp(name, dst)
copy resource `name` to `dst`
classtqdm.contrib.DummyTqdmFile
Dummy file-like that will write to tqdm
functqdm.contrib.builtin_iterable(func)
Returns `func`
classtqdm.contrib.discord.DiscordIO
Non-blocking file-like IO using a Discord Bot.
methodtqdm.contrib.discord.DiscordIO.delete()
Deletes internal `message_id`.
functqdm.contrib.itertools.chain(*total=None, *tqdm_class=tqdm_auto, *iterables, **kwargs)
Equivalent of `itertools.chain`.
classtqdm.contrib.slack.SlackIO
Non-blocking file-like IO using a Slack app.
classtqdm.contrib.slack.tqdm_slack
Standard `tqdm.auto.tqdm` but also sends updates to a Slack app.
classtqdm.contrib.telegram.TelegramIO
Non-blocking file-like IO using a Telegram Bot.
methodtqdm.contrib.telegram.TelegramIO.delete()
Deletes internal `message_id`.
functqdm.contrib.tmap(function, *sequences, **tqdm_kwargs)
Equivalent of builtin `map`.
functqdm.contrib.tzip(iter1, *iter2plus, **tqdm_kwargs)
Equivalent of builtin `zip`.
classtqdm.contrib.utils_worker.MonoWorker
Supports one running task and one waiting task.
classtqdm.dask.TqdmCallback
Dask callback for task progress.
methodtqdm.dask.TqdmCallback.display()
Displays in the current cell in Notebooks.
classtqdm.gui.tqdm_gui
Experimental Matplotlib GUI version of tqdm!
classtqdm.keras.TqdmCallback
Keras callback for epoch and batch progress.
methodtqdm.keras.TqdmCallback.display()
Displays in the current cell in Notebooks.
classtqdm.notebook.TqdmHBox
`ipywidgets.HBox` with a pretty representation
classtqdm.notebook.tqdm_notebook
Experimental IPython/Jupyter Notebook widget using tqdm!
methodtqdm.notebook.tqdm_notebook.reset(total=None)
Resets to 0 iterations for repeated use.
classtqdm.rich.FractionColumn
Renders completed/total, e.g.
classtqdm.rich.RateColumn
Renders human readable transfer speed.
methodtqdm.rich.RateColumn.render(task)
Show data transfer speed.
classtqdm.rich.tqdm_rich
Experimental rich.progress GUI version of tqdm!
methodtqdm.rich.tqdm_rich.reset(total=None)
Resets to 0 iterations for repeated use.
functqdm.std.TRLock(*args, **kwargs)
threading RLock
classtqdm.std.TqdmDefaultWriteLock
Provide a default write lock for thread and multiprocessing safety.
classtqdm.std.TqdmDeprecationWarning
may be removed in a future release
classtqdm.std.TqdmExperimentalWarning
beta feature, unstable API and behaviour
classtqdm.std.TqdmMonitorWarning
tqdm monitor errors which do not affect external functionality
classtqdm.std.TqdmWarning
base class for all tqdm warnings.
methodtqdm.std.tqdm.clear(nolock=False)
Clear current bar display.
methodtqdm.std.tqdm.format_dict()
Public API for read-only member access.
methodtqdm.std.tqdm.format_num(n)
Intelligent scientific notation (.3g).
methodtqdm.std.tqdm.get_lock()
Get the global lock.
methodtqdm.std.tqdm.refresh(nolock=False, lock_args=None)
Force refresh the display of this bar.
methodtqdm.std.tqdm.reset(total=None)
Resets to 0 iterations for repeated use.
methodtqdm.std.tqdm.set_lock(lock)
Set the global lock.
methodtqdm.std.tqdm.unpause()
Restart tqdm timer from last print time.
methodtqdm.std.tqdm.wrapattr(stream, method, total=None, bytes=True, **tqdm_kwargs)
stream : file-like object.
functqdm.std.trange(*args, **kwargs)
Shortcut for tqdm(range(*args), **kwargs).
classtqdm.tk.tqdm_tk
Experimental Tkinter GUI version of tqdm!
methodtqdm.tk.tqdm_tk.reset(total=None)
Resets to 0 iterations for repeated use.
functqdm.tqdm_notebook(*args, **kwargs)
See tqdm.notebook.tqdm for full documentation
classtqdm.utils.Comparable
Assumes child has self._comparable attr/@property
classtqdm.utils.FormatReplace
>>> a = FormatReplace('something') >>> f"{a:5d}" 'something'

About this data

These signatures were extracted from the public source of tqdm/tqdm using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries