2026-07-18 11:07 @216.73.216.114
CrawledBy Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; ClaudeBot/1.0; +claudebot@anthropic.com)
Help on package tqdm: NAME tqdm PACKAGE CONTENTS __main__ _main _monitor _tqdm _tqdm_gui _tqdm_notebook _tqdm_pandas _utils asyncio auto autonotebook cli contrib (package) dask gui keras notebook rich std tk utils version CLASSES builtins.KeyError(builtins.LookupError) tqdm.std.TqdmKeyError builtins.RuntimeWarning(builtins.Warning) tqdm._monitor.TqdmSynchronisationWarning builtins.TypeError(builtins.Exception) tqdm.std.TqdmTypeError builtins.Warning(builtins.Exception) tqdm.std.TqdmWarning tqdm.std.TqdmDeprecationWarning(tqdm.std.TqdmWarning, builtins.DeprecationWarning) tqdm.std.TqdmExperimentalWarning(tqdm.std.TqdmWarning, builtins.FutureWarning) tqdm.std.TqdmMonitorWarning(tqdm.std.TqdmWarning, builtins.RuntimeWarning) threading.Thread(builtins.object) tqdm._monitor.TMonitor tqdm.utils.Comparable(builtins.object) tqdm.std.tqdm tqdm.gui.tqdm_gui class TMonitor(threading.Thread) | TMonitor(tqdm_cls, sleep_interval) | | Monitoring thread for tqdm bars. | Monitors if tqdm bars are taking too much time to display | and readjusts miniters automatically if necessary. | | Parameters | ---------- | tqdm_cls : class | tqdm class to use (can be core tqdm or a submodule). | sleep_interval : float | Time to sleep between monitoring checks. | | Method resolution order: | TMonitor | threading.Thread | builtins.object | | Methods defined here: | | __init__(self, tqdm_cls, sleep_interval) | This constructor should always be called with keyword arguments. Arguments are: | | *group* should be None; reserved for future extension when a ThreadGroup | class is implemented. | | *target* is the callable object to be invoked by the run() | method. Defaults to None, meaning nothing is called. | | *name* is the thread name. By default, a unique name is constructed of | the form "Thread-N" where N is a small decimal number. | | *args* is the argument tuple for the target invocation. Defaults to (). | | *kwargs* is a dictionary of keyword arguments for the target | invocation. Defaults to {}. | | If a subclass overrides the constructor, it must make sure to invoke | the base class constructor (Thread.__init__()) before doing anything | else to the thread. | | exit(self) | | get_instances(self) | | report(self) | | run(self) | Method representing the thread's activity. | | You may override this method in a subclass. The standard run() method | invokes the callable object passed to the object's constructor as the | target argument, if any, with sequential and keyword arguments taken | from the args and kwargs arguments, respectively. | | ---------------------------------------------------------------------- | Methods inherited from threading.Thread: | | __repr__(self) | Return repr(self). | | getName(self) | Return a string used for identification purposes only. | | This method is deprecated, use the name attribute instead. | | isDaemon(self) | Return whether this thread is a daemon. | | This method is deprecated, use the daemon attribute instead. | | is_alive(self) | Return whether the thread is alive. | | This method returns True just before the run() method starts until just | after the run() method terminates. See also the module function | enumerate(). | | join(self, timeout=None) | Wait until the thread terminates. | | This blocks the calling thread until the thread whose join() method is | called terminates -- either normally or through an unhandled exception | or until the optional timeout occurs. | | When the timeout argument is present and not None, it should be a | floating point number specifying a timeout for the operation in seconds | (or fractions thereof). As join() always returns None, you must call | is_alive() after join() to decide whether a timeout happened -- if the | thread is still alive, the join() call timed out. | | When the timeout argument is not present or None, the operation will | block until the thread terminates. | | A thread can be join()ed many times. | | join() raises a RuntimeError if an attempt is made to join the current | thread as that would cause a deadlock. It is also an error to join() a | thread before it has been started and attempts to do so raises the same | exception. | | setDaemon(self, daemonic) | Set whether this thread is a daemon. | | This method is deprecated, use the .daemon property instead. | | setName(self, name) | Set the name string for this thread. | | This method is deprecated, use the name attribute instead. | | start(self) | Start the thread's activity. | | It must be called at most once per thread object. It arranges for the | object's run() method to be invoked in a separate thread of control. | | This method will raise a RuntimeError if called more than once on the | same thread object. | | ---------------------------------------------------------------------- | Readonly properties inherited from threading.Thread: | | ident | Thread identifier of this thread or None if it has not been started. | | This is a nonzero integer. See the get_ident() function. Thread | identifiers may be recycled when a thread exits and another thread is | created. The identifier is available even after the thread has exited. | | native_id | Native integral thread ID of this thread, or None if it has not been started. | | This is a non-negative integer. See the get_native_id() function. | This represents the Thread ID as reported by the kernel. | | ---------------------------------------------------------------------- | Data descriptors inherited from threading.Thread: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) | | daemon | A boolean value indicating whether this thread is a daemon thread. | | This must be set before start() is called, otherwise RuntimeError is | raised. Its initial value is inherited from the creating thread; the | main thread is not a daemon thread and therefore all threads created in | the main thread default to daemon = False. | | The entire Python program exits when only daemon threads are left. | | name | A string used for identification purposes only. | | It has no semantics. Multiple threads may be given the same name. The | initial name is set by the constructor. class TqdmDeprecationWarning(TqdmWarning, builtins.DeprecationWarning) | TqdmDeprecationWarning(msg, fp_write=None) | | may be removed in a future release | | Method resolution order: | TqdmDeprecationWarning | TqdmWarning | builtins.DeprecationWarning | builtins.Warning | builtins.Exception | builtins.BaseException | builtins.object | | Methods inherited from TqdmWarning: | | __init__(self, msg, fp_write=None) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Data descriptors inherited from TqdmWarning: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Static methods inherited from builtins.DeprecationWarning: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args class TqdmExperimentalWarning(TqdmWarning, builtins.FutureWarning) | TqdmExperimentalWarning(msg, fp_write=None) | | beta feature, unstable API and behaviour | | Method resolution order: | TqdmExperimentalWarning | TqdmWarning | builtins.FutureWarning | builtins.Warning | builtins.Exception | builtins.BaseException | builtins.object | | Methods inherited from TqdmWarning: | | __init__(self, msg, fp_write=None) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Data descriptors inherited from TqdmWarning: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Static methods inherited from builtins.FutureWarning: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args class TqdmKeyError(builtins.KeyError) | Method resolution order: | TqdmKeyError | builtins.KeyError | builtins.LookupError | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors defined here: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Methods inherited from builtins.KeyError: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | __str__(self, /) | Return str(self). | | ---------------------------------------------------------------------- | Static methods inherited from builtins.LookupError: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args class TqdmMonitorWarning(TqdmWarning, builtins.RuntimeWarning) | TqdmMonitorWarning(msg, fp_write=None) | | tqdm monitor errors which do not affect external functionality | | Method resolution order: | TqdmMonitorWarning | TqdmWarning | builtins.RuntimeWarning | builtins.Warning | builtins.Exception | builtins.BaseException | builtins.object | | Methods inherited from TqdmWarning: | | __init__(self, msg, fp_write=None) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Data descriptors inherited from TqdmWarning: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Static methods inherited from builtins.RuntimeWarning: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args class TqdmSynchronisationWarning(builtins.RuntimeWarning) | tqdm multi-thread/-process errors which may cause incorrect nesting | but otherwise no adverse effects | | Method resolution order: | TqdmSynchronisationWarning | builtins.RuntimeWarning | builtins.Warning | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors defined here: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Methods inherited from builtins.RuntimeWarning: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.RuntimeWarning: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args class TqdmTypeError(builtins.TypeError) | Method resolution order: | TqdmTypeError | builtins.TypeError | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors defined here: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Methods inherited from builtins.TypeError: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.TypeError: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args class TqdmWarning(builtins.Warning) | TqdmWarning(msg, fp_write=None) | | base class for all tqdm warnings. | | Used for non-external-code-breaking errors, such as garbled printing. | | Method resolution order: | TqdmWarning | builtins.Warning | builtins.Exception | builtins.BaseException | builtins.object | | Methods defined here: | | __init__(self, msg, fp_write=None) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Warning: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args class tqdm(tqdm.utils.Comparable) | tqdm(*_, **__) | | Decorate an iterable object, returning an iterator which acts exactly | like the original iterable, but prints a dynamically updating | progress bar every time a value is requested. | | Parameters | ---------- | iterable : iterable, optional | Iterable to decorate with a progress bar. | Leave blank to manually manage the updates. | desc : str, optional | Prefix for the progress bar. | total : int or float, optional | The number of expected iterations. If unspecified, | len(iterable) is used if possible. If float("inf") or as a last | resort, only basic progress statistics are displayed | (no ETA, no progress bar). | If `gui` is True and this parameter needs subsequent updating, | specify an initial arbitrary large positive number, | e.g. 9e9. | leave : bool, optional | If [default: True], keeps all traces of the progress bar | upon termination of iteration. | If `None`, will leave only if `position` is `0`. | file : `io.TextIOWrapper` or `io.StringIO`, optional | Specifies where to output the progress messages | (default: sys.stderr). Uses `file.write(str)` and `file.flush()` | methods. For encoding, see `write_bytes`. | ncols : int, optional | The width of the entire output message. If specified, | dynamically resizes the progress bar to stay within this bound. | If unspecified, attempts to use environment width. The | fallback is a meter width of 10 and no limit for the counter and | statistics. If 0, will not print any meter (only stats). | mininterval : float, optional | Minimum progress display update interval [default: 0.1] seconds. | maxinterval : float, optional | Maximum progress display update interval [default: 10] seconds. | Automatically adjusts `miniters` to correspond to `mininterval` | after long display update lag. Only works if `dynamic_miniters` | or monitor thread is enabled. | miniters : int or float, optional | Minimum progress display update interval, in iterations. | If 0 and `dynamic_miniters`, will automatically adjust to equal | `mininterval` (more CPU efficient, good for tight loops). | If > 0, will skip display of specified number of iterations. | Tweak this and `mininterval` to get very efficient loops. | If your progress is erratic with both fast and slow iterations | (network, skipping items, etc) you should set miniters=1. | ascii : bool or str, optional | If unspecified or False, use unicode (smooth blocks) to fill | the meter. The fallback is to use ASCII characters " 123456789#". | disable : bool, optional | Whether to disable the entire progress bar wrapper | [default: False]. If set to None, disable on non-TTY. | unit : str, optional | String that will be used to define the unit of each iteration | [default: it]. | unit_scale : bool or int or float, optional | If 1 or True, the number of iterations will be reduced/scaled | automatically and a metric prefix following the | International System of Units standard will be added | (kilo, mega, etc.) [default: False]. If any other non-zero | number, will scale `total` and `n`. | dynamic_ncols : bool, optional | If set, constantly alters `ncols` and `nrows` to the | environment (allowing for window resizes) [default: False]. | smoothing : float, optional | Exponential moving average smoothing factor for speed estimates | (ignored in GUI mode). Ranges from 0 (average speed) to 1 | (current/instantaneous speed) [default: 0.3]. | bar_format : str, optional | Specify a custom bar string formatting. May impact performance. | [default: '{l_bar}{bar}{r_bar}'], where | l_bar='{desc}: {percentage:3.0f}%|' and | r_bar='| {n_fmt}/{total_fmt} [{elapsed}<{remaining}, ' | '{rate_fmt}{postfix}]' | Possible vars: l_bar, bar, r_bar, n, n_fmt, total, total_fmt, | percentage, elapsed, elapsed_s, ncols, nrows, desc, unit, | rate, rate_fmt, rate_noinv, rate_noinv_fmt, | rate_inv, rate_inv_fmt, postfix, unit_divisor, | remaining, remaining_s, eta. | Note that a trailing ": " is automatically removed after {desc} | if the latter is empty. | initial : int or float, optional | The initial counter value. Useful when restarting a progress | bar [default: 0]. If using float, consider specifying `{n:.3f}` | or similar in `bar_format`, or specifying `unit_scale`. | position : int, optional | Specify the line offset to print this bar (starting from 0) | Automatic if unspecified. | Useful to manage multiple bars at once (eg, from threads). | postfix : dict or *, optional | Specify additional stats to display at the end of the bar. | Calls `set_postfix(**postfix)` if possible (dict). | unit_divisor : float, optional | [default: 1000], ignored unless `unit_scale` is True. | write_bytes : bool, optional | Whether to write bytes. If (default: False) will write unicode. | lock_args : tuple, optional | Passed to `refresh` for intermediate output | (initialisation, iterating, and updating). | nrows : int, optional | The screen height. If specified, hides nested bars outside this | bound. If unspecified, attempts to use environment height. | The fallback is 20. | colour : str, optional | Bar colour (e.g. 'green', '#00ff00'). | delay : float, optional | Don't display until [default: 0] seconds have elapsed. | gui : bool, optional | WARNING: internal parameter - do not use. | Use tqdm.gui.tqdm(...) instead. If set, will attempt to use | matplotlib animations for a graphical output [default: False]. | | Returns | ------- | out : decorated iterator. | | Method resolution order: | tqdm | tqdm.utils.Comparable | builtins.object | | Methods defined here: | | __bool__(self) | | __contains__(self, item) | | __del__(self) | | __enter__(self) | | __exit__(self, exc_type, exc_value, traceback) | | __hash__(self) | Return hash(self). | | __init__ = _method(self, iterable=None, desc=None, total=None, leave=True, file=None, ncols=None, mininterval=0.1, maxinterval=10.0, miniters=None, ascii=None, disable=False, unit='it', unit_scale=False, dynamic_ncols=False, smoothing=0.3, bar_format=None, initial=0, position=None, postfix=None, unit_divisor=1000, write_bytes=False, lock_args=None, nrows=None, colour=None, delay=0.0, gui=False, **kwargs) | | __iter__(self) | Backward-compatibility to use: for x in tqdm(iterable) | | __len__(self) | | __reversed__(self) | | __str__(self) | Return str(self). | | clear(self, nolock=False) | Clear current bar display. | | close(self) | Cleanup and (if leave=False) close the progress bar. | | display(self, msg=None, pos=None) | Use `self.sp` to display `msg` in the specified `pos`. | | Consider overloading this function when inheriting to use e.g.: | `self.some_frontend(**self.format_dict)` instead of `self.sp`. | | Parameters | ---------- | msg : str, optional. What to display (default: `repr(self)`). | pos : int, optional. Position to `moveto` | (default: `abs(self.pos)`). | | moveto(self, n) | | refresh(self, nolock=False, lock_args=None) | Force refresh the display of this bar. | | Parameters | ---------- | nolock : bool, optional | If `True`, does not lock. | If [default: `False`]: calls `acquire()` on internal lock. | lock_args : tuple, optional | Passed to internal lock's `acquire()`. | If specified, will only `display()` if `acquire()` returns `True`. | | reset(self, total=None) | Resets to 0 iterations for repeated use. | | Consider combining with `leave=True`. | | Parameters | ---------- | total : int or float, optional. Total to use for the new bar. | | set_description(self, desc=None, refresh=True) | Set/modify description of the progress bar. | | Parameters | ---------- | desc : str, optional | refresh : bool, optional | Forces refresh [default: True]. | | set_description_str(self, desc=None, refresh=True) | Set/modify description without ': ' appended. | | set_postfix(self, ordered_dict=None, refresh=True, **kwargs) | Set/modify postfix (additional stats) | with automatic formatting based on datatype. | | Parameters | ---------- | ordered_dict : dict or OrderedDict, optional | refresh : bool, optional | Forces refresh [default: True]. | kwargs : dict, optional | | set_postfix_str(self, s='', refresh=True) | Postfix without dictionary expansion, similar to prefix handling. | | unpause(self) | Restart tqdm timer from last print time. | | update(self, n=1) | Manually update the progress bar, useful for streams | such as reading files. | E.g.: | >>> t = tqdm(total=filesize) # Initialise | >>> for current_buffer in stream: | ... ... | ... t.update(len(current_buffer)) | >>> t.close() | The last line is highly recommended, but possibly not necessary if | `t.update()` will be called in such a way that `filesize` will be | exactly reached and printed. | | Parameters | ---------- | n : int or float, optional | Increment to add to the internal counter of iterations | [default: 1]. If using float, consider specifying `{n:.3f}` | or similar in `bar_format`, or specifying `unit_scale`. | | Returns | ------- | out : bool or None | True if a `display()` was triggered. | | ---------------------------------------------------------------------- | Class methods defined here: | | external_write_mode(file=None, nolock=False) from builtins.type | Disable tqdm within context and refresh tqdm when exits. | Useful when writing to standard output stream | | get_lock() from builtins.type | Get the global lock. Construct it if it does not exist. | | pandas(**tqdm_kwargs) from builtins.type | Registers the current `tqdm` class with | pandas.core. | ( frame.DataFrame | | series.Series | | groupby.(generic.)DataFrameGroupBy | | groupby.(generic.)SeriesGroupBy | ).progress_apply | | A new instance will be created every time `progress_apply` is called, | and each instance will automatically `close()` upon completion. | | Parameters | ---------- | tqdm_kwargs : arguments for the tqdm instance | | Examples | -------- | >>> import pandas as pd | >>> import numpy as np | >>> from tqdm import tqdm | >>> from tqdm.gui import tqdm as tqdm_gui | >>> | >>> df = pd.DataFrame(np.random.randint(0, 100, (100000, 6))) | >>> tqdm.pandas(ncols=50) # can use tqdm_gui, optional kwargs, etc | >>> # Now you can use `progress_apply` instead of `apply` | >>> df.groupby(0).progress_apply(lambda x: x**2) | | References | ---------- | <https://stackoverflow.com/questions/18603270/ progress-indicator-during-pandas-operations-python> | | set_lock(lock) from builtins.type | Set the global lock. | | wrapattr(stream, method, total=None, bytes=True, **tqdm_kwargs) from builtins.type | stream : file-like object. | method : str, "read" or "write". The result of `read()` and | the first argument of `write()` should have a `len()`. | | >>> with tqdm.wrapattr(file_obj, "read", total=file_obj.size) as fobj: | ... while True: | ... chunk = fobj.read(chunk_size) | ... if not chunk: | ... break | | write(s, file=None, end='\n', nolock=False) from builtins.type | Print a message via tqdm (without overlap with bars). | | ---------------------------------------------------------------------- | Static methods defined here: | | __new__(cls, *_, **__) | Create and return a new object. See help(type) for accurate signature. | | format_interval(t) | Formats a number of seconds as a clock time, [H:]MM:SS | | Parameters | ---------- | t : int | Number of seconds. | | Returns | ------- | out : str | [H:]MM:SS | | format_meter(n, total, elapsed, ncols=None, prefix='', ascii=False, unit='it', unit_scale=False, rate=None, bar_format=None, postfix=None, unit_divisor=1000, initial=0, colour=None, **extra_kwargs) | Return a string-based progress bar given some parameters | | Parameters | ---------- | n : int or float | Number of finished iterations. | total : int or float | The expected total number of iterations. If meaningless (None), | only basic progress statistics are displayed (no ETA). | elapsed : float | Number of seconds passed since start. | ncols : int, optional | The width of the entire output message. If specified, | dynamically resizes `{bar}` to stay within this bound | [default: None]. If `0`, will not print any bar (only stats). | The fallback is `{bar:10}`. | prefix : str, optional | Prefix message (included in total width) [default: '']. | Use as {desc} in bar_format string. | ascii : bool, optional or str, optional | If not set, use unicode (smooth blocks) to fill the meter | [default: False]. The fallback is to use ASCII characters | " 123456789#". | unit : str, optional | The iteration unit [default: 'it']. | unit_scale : bool or int or float, optional | If 1 or True, the number of iterations will be printed with an | appropriate SI metric prefix (k = 10^3, M = 10^6, etc.) | [default: False]. If any other non-zero number, will scale | `total` and `n`. | rate : float, optional | Manual override for iteration rate. | If [default: None], uses n/elapsed. | bar_format : str, optional | Specify a custom bar string formatting. May impact performance. | [default: '{l_bar}{bar}{r_bar}'], where | l_bar='{desc}: {percentage:3.0f}%|' and | r_bar='| {n_fmt}/{total_fmt} [{elapsed}<{remaining}, ' | '{rate_fmt}{postfix}]' | Possible vars: l_bar, bar, r_bar, n, n_fmt, total, total_fmt, | percentage, elapsed, elapsed_s, ncols, nrows, desc, unit, | rate, rate_fmt, rate_noinv, rate_noinv_fmt, | rate_inv, rate_inv_fmt, postfix, unit_divisor, | remaining, remaining_s, eta. | Note that a trailing ": " is automatically removed after {desc} | if the latter is empty. | postfix : *, optional | Similar to `prefix`, but placed at the end | (e.g. for additional stats). | Note: postfix is usually a string (not a dict) for this method, | and will if possible be set to postfix = ', ' + postfix. | However other types are supported (#382). | unit_divisor : float, optional | [default: 1000], ignored unless `unit_scale` is True. | initial : int or float, optional | The initial counter value [default: 0]. | colour : str, optional | Bar colour (e.g. 'green', '#00ff00'). | | Returns | ------- | out : Formatted meter and stats, ready to display. | | format_num(n) | Intelligent scientific notation (.3g). | | Parameters | ---------- | n : int or float or Numeric | A Number. | | Returns | ------- | out : str | Formatted number. | | format_sizeof(num, suffix='', divisor=1000) | Formats a number (greater than unity) with SI Order of Magnitude | prefixes. | | Parameters | ---------- | num : float | Number ( >= 1) to format. | suffix : str, optional | Post-postfix [default: '']. | divisor : float, optional | Divisor between prefixes [default: 1000]. | | Returns | ------- | out : str | Number with Order of Magnitude SI unit postfix. | | status_printer(file) | Manage the printing and in-place updating of a line of characters. | Note that if the string is longer than a line, then in-place | updating may not work (it will print a new line at each refresh). | | ---------------------------------------------------------------------- | Readonly properties defined here: | | format_dict | Public API for read-only member access. | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | monitor = None | | monitor_interval = 10 | | ---------------------------------------------------------------------- | Methods inherited from tqdm.utils.Comparable: | | __eq__(self, other) | Return self==value. | | __ge__(self, other) | Return self>=value. | | __gt__(self, other) | Return self>value. | | __le__(self, other) | Return self<=value. | | __lt__(self, other) | Return self<value. | | __ne__(self, other) | Return self!=value. | | ---------------------------------------------------------------------- | Data descriptors inherited from tqdm.utils.Comparable: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) class tqdm_gui(tqdm.std.tqdm) | tqdm_gui(*args, **kwargs) | | Experimental Matplotlib GUI version of tqdm! | | Method resolution order: | tqdm_gui | tqdm.std.tqdm | tqdm.utils.Comparable | builtins.object | | Methods defined here: | | __init__(self, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | clear(self, *_, **__) | Clear current bar display. | | close(self) | Cleanup and (if leave=False) close the progress bar. | | display(self, *_, **__) | Use `self.sp` to display `msg` in the specified `pos`. | | Consider overloading this function when inheriting to use e.g.: | `self.some_frontend(**self.format_dict)` instead of `self.sp`. | | Parameters | ---------- | msg : str, optional. What to display (default: `repr(self)`). | pos : int, optional. Position to `moveto` | (default: `abs(self.pos)`). | | ---------------------------------------------------------------------- | Methods inherited from tqdm.std.tqdm: | | __bool__(self) | | __contains__(self, item) | | __del__(self) | | __enter__(self) | | __exit__(self, exc_type, exc_value, traceback) | | __hash__(self) | Return hash(self). | | __iter__(self) | Backward-compatibility to use: for x in tqdm(iterable) | | __len__(self) | | __reversed__(self) | | __str__(self) | Return str(self). | | moveto(self, n) | | refresh(self, nolock=False, lock_args=None) | Force refresh the display of this bar. | | Parameters | ---------- | nolock : bool, optional | If `True`, does not lock. | If [default: `False`]: calls `acquire()` on internal lock. | lock_args : tuple, optional | Passed to internal lock's `acquire()`. | If specified, will only `display()` if `acquire()` returns `True`. | | reset(self, total=None) | Resets to 0 iterations for repeated use. | | Consider combining with `leave=True`. | | Parameters | ---------- | total : int or float, optional. Total to use for the new bar. | | set_description(self, desc=None, refresh=True) | Set/modify description of the progress bar. | | Parameters | ---------- | desc : str, optional | refresh : bool, optional | Forces refresh [default: True]. | | set_description_str(self, desc=None, refresh=True) | Set/modify description without ': ' appended. | | set_postfix(self, ordered_dict=None, refresh=True, **kwargs) | Set/modify postfix (additional stats) | with automatic formatting based on datatype. | | Parameters | ---------- | ordered_dict : dict or OrderedDict, optional | refresh : bool, optional | Forces refresh [default: True]. | kwargs : dict, optional | | set_postfix_str(self, s='', refresh=True) | Postfix without dictionary expansion, similar to prefix handling. | | unpause(self) | Restart tqdm timer from last print time. | | update(self, n=1) | Manually update the progress bar, useful for streams | such as reading files. | E.g.: | >>> t = tqdm(total=filesize) # Initialise | >>> for current_buffer in stream: | ... ... | ... t.update(len(current_buffer)) | >>> t.close() | The last line is highly recommended, but possibly not necessary if | `t.update()` will be called in such a way that `filesize` will be | exactly reached and printed. | | Parameters | ---------- | n : int or float, optional | Increment to add to the internal counter of iterations | [default: 1]. If using float, consider specifying `{n:.3f}` | or similar in `bar_format`, or specifying `unit_scale`. | | Returns | ------- | out : bool or None | True if a `display()` was triggered. | | ---------------------------------------------------------------------- | Class methods inherited from tqdm.std.tqdm: | | external_write_mode(file=None, nolock=False) from builtins.type | Disable tqdm within context and refresh tqdm when exits. | Useful when writing to standard output stream | | get_lock() from builtins.type | Get the global lock. Construct it if it does not exist. | | pandas(**tqdm_kwargs) from builtins.type | Registers the current `tqdm` class with | pandas.core. | ( frame.DataFrame | | series.Series | | groupby.(generic.)DataFrameGroupBy | | groupby.(generic.)SeriesGroupBy | ).progress_apply | | A new instance will be created every time `progress_apply` is called, | and each instance will automatically `close()` upon completion. | | Parameters | ---------- | tqdm_kwargs : arguments for the tqdm instance | | Examples | -------- | >>> import pandas as pd | >>> import numpy as np | >>> from tqdm import tqdm | >>> from tqdm.gui import tqdm as tqdm_gui | >>> | >>> df = pd.DataFrame(np.random.randint(0, 100, (100000, 6))) | >>> tqdm.pandas(ncols=50) # can use tqdm_gui, optional kwargs, etc | >>> # Now you can use `progress_apply` instead of `apply` | >>> df.groupby(0).progress_apply(lambda x: x**2) | | References | ---------- | <https://stackoverflow.com/questions/18603270/ progress-indicator-during-pandas-operations-python> | | set_lock(lock) from builtins.type | Set the global lock. | | wrapattr(stream, method, total=None, bytes=True, **tqdm_kwargs) from builtins.type | stream : file-like object. | method : str, "read" or "write". The result of `read()` and | the first argument of `write()` should have a `len()`. | | >>> with tqdm.wrapattr(file_obj, "read", total=file_obj.size) as fobj: | ... while True: | ... chunk = fobj.read(chunk_size) | ... if not chunk: | ... break | | write(s, file=None, end='\n', nolock=False) from builtins.type | Print a message via tqdm (without overlap with bars). | | ---------------------------------------------------------------------- | Static methods inherited from tqdm.std.tqdm: | | __new__(cls, *_, **__) | Create and return a new object. See help(type) for accurate signature. | | format_interval(t) | Formats a number of seconds as a clock time, [H:]MM:SS | | Parameters | ---------- | t : int | Number of seconds. | | Returns | ------- | out : str | [H:]MM:SS | | format_meter(n, total, elapsed, ncols=None, prefix='', ascii=False, unit='it', unit_scale=False, rate=None, bar_format=None, postfix=None, unit_divisor=1000, initial=0, colour=None, **extra_kwargs) | Return a string-based progress bar given some parameters | | Parameters | ---------- | n : int or float | Number of finished iterations. | total : int or float | The expected total number of iterations. If meaningless (None), | only basic progress statistics are displayed (no ETA). | elapsed : float | Number of seconds passed since start. | ncols : int, optional | The width of the entire output message. If specified, | dynamically resizes `{bar}` to stay within this bound | [default: None]. If `0`, will not print any bar (only stats). | The fallback is `{bar:10}`. | prefix : str, optional | Prefix message (included in total width) [default: '']. | Use as {desc} in bar_format string. | ascii : bool, optional or str, optional | If not set, use unicode (smooth blocks) to fill the meter | [default: False]. The fallback is to use ASCII characters | " 123456789#". | unit : str, optional | The iteration unit [default: 'it']. | unit_scale : bool or int or float, optional | If 1 or True, the number of iterations will be printed with an | appropriate SI metric prefix (k = 10^3, M = 10^6, etc.) | [default: False]. If any other non-zero number, will scale | `total` and `n`. | rate : float, optional | Manual override for iteration rate. | If [default: None], uses n/elapsed. | bar_format : str, optional | Specify a custom bar string formatting. May impact performance. | [default: '{l_bar}{bar}{r_bar}'], where | l_bar='{desc}: {percentage:3.0f}%|' and | r_bar='| {n_fmt}/{total_fmt} [{elapsed}<{remaining}, ' | '{rate_fmt}{postfix}]' | Possible vars: l_bar, bar, r_bar, n, n_fmt, total, total_fmt, | percentage, elapsed, elapsed_s, ncols, nrows, desc, unit, | rate, rate_fmt, rate_noinv, rate_noinv_fmt, | rate_inv, rate_inv_fmt, postfix, unit_divisor, | remaining, remaining_s, eta. | Note that a trailing ": " is automatically removed after {desc} | if the latter is empty. | postfix : *, optional | Similar to `prefix`, but placed at the end | (e.g. for additional stats). | Note: postfix is usually a string (not a dict) for this method, | and will if possible be set to postfix = ', ' + postfix. | However other types are supported (#382). | unit_divisor : float, optional | [default: 1000], ignored unless `unit_scale` is True. | initial : int or float, optional | The initial counter value [default: 0]. | colour : str, optional | Bar colour (e.g. 'green', '#00ff00'). | | Returns | ------- | out : Formatted meter and stats, ready to display. | | format_num(n) | Intelligent scientific notation (.3g). | | Parameters | ---------- | n : int or float or Numeric | A Number. | | Returns | ------- | out : str | Formatted number. | | format_sizeof(num, suffix='', divisor=1000) | Formats a number (greater than unity) with SI Order of Magnitude | prefixes. | | Parameters | ---------- | num : float | Number ( >= 1) to format. | suffix : str, optional | Post-postfix [default: '']. | divisor : float, optional | Divisor between prefixes [default: 1000]. | | Returns | ------- | out : str | Number with Order of Magnitude SI unit postfix. | | status_printer(file) | Manage the printing and in-place updating of a line of characters. | Note that if the string is longer than a line, then in-place | updating may not work (it will print a new line at each refresh). | | ---------------------------------------------------------------------- | Readonly properties inherited from tqdm.std.tqdm: | | format_dict | Public API for read-only member access. | | ---------------------------------------------------------------------- | Data and other attributes inherited from tqdm.std.tqdm: | | monitor = None | | monitor_interval = 10 | | ---------------------------------------------------------------------- | Methods inherited from tqdm.utils.Comparable: | | __eq__(self, other) | Return self==value. | | __ge__(self, other) | Return self>=value. | | __gt__(self, other) | Return self>value. | | __le__(self, other) | Return self<=value. | | __lt__(self, other) | Return self<value. | | __ne__(self, other) | Return self!=value. | | ---------------------------------------------------------------------- | Data descriptors inherited from tqdm.utils.Comparable: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) FUNCTIONS main(fp=<_io.TextIOWrapper name='<stderr>' mode='w' encoding='utf-8'>, argv=None) Parameters (internal use only) --------- fp : file-like object for tqdm argv : list (default: sys.argv[1:]) tgrange(*args, **kwargs) Shortcut for `tqdm.gui.tqdm(range(*args), **kwargs)`. tnrange(*args, **kwargs) Shortcut for `tqdm.notebook.tqdm(range(*args), **kwargs)`. tqdm_notebook(*args, **kwargs) See tqdm.notebook.tqdm for full documentation tqdm_pandas(tclass, **tqdm_kwargs) Registers the given `tqdm` instance with `pandas.core.groupby.DataFrameGroupBy.progress_apply`. trange(*args, **kwargs) Shortcut for tqdm(range(*args), **kwargs). DATA __all__ = ['tqdm', 'tqdm_gui', 'trange', 'tgrange', 'tqdm_pandas', 'tq... VERSION 4.68.3 FILE /home/chedong/.local/lib/python3.10/site-packages/tqdm/__init__.py
Generated by phpman v4.9.27 · Markdown · JSON · MCP Author: Che Dong Under GNU General Public License
2026-07-18 11:07 @216.73.216.114
CrawledBy Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; ClaudeBot/1.0; +claudebot@anthropic.com)