{ "content": [ { "type": "text", "text": "# tqdm (pydoc)\n\n## NAME\n\ntqdm\n\n## Sections\n\n- **NAME**\n- **PACKAGE CONTENTS**\n- **CLASSES** (10 subsections)\n- **FUNCTIONS** (6 subsections)\n- **DATA**\n- **VERSION**\n- **FILE**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "tqdm", "section": "", "mode": "pydoc", "summary": "tqdm", "synopsis": null, "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [], "examples": [], "see_also": [], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "PACKAGE CONTENTS", "lines": 23, "subsections": [] }, { "name": "CLASSES", "lines": 17, "subsections": [ { "name": "class TMonitor", "lines": 161 }, { "name": "class TqdmDeprecationWarning", "lines": 74 }, { "name": "class TqdmExperimentalWarning", "lines": 74 }, { "name": "class TqdmKeyError", "lines": 69 }, { "name": "class TqdmMonitorWarning", "lines": 74 }, { "name": "class TqdmSynchronisationWarning", "lines": 72 }, { "name": "class TqdmTypeError", "lines": 68 }, { "name": "class TqdmWarning", "lines": 74 }, { "name": "class tqdm", "lines": 468 }, { "name": "class tqdm_gui", "lines": 357 } ] }, { "name": "FUNCTIONS", "lines": 1, "subsections": [ { "name": "main", "lines": 5 }, { "name": "tgrange", "lines": 2 }, { "name": "tnrange", "lines": 2 }, { "name": "tqdm_notebook", "lines": 2 }, { "name": "tqdm_pandas", "lines": 3 }, { "name": "trange", "lines": 2 } ] }, { "name": "DATA", "lines": 2, "subsections": [] }, { "name": "VERSION", "lines": 2, "subsections": [] }, { "name": "FILE", "lines": 3, "subsections": [] } ], "sections": { "NAME": { "content": "tqdm\n", "subsections": [] }, "PACKAGE CONTENTS": { "content": "main\nmain\nmonitor\ntqdm\ntqdmgui\ntqdmnotebook\ntqdmpandas\nutils\nasyncio\nauto\nautonotebook\ncli\ncontrib (package)\ndask\ngui\nkeras\nnotebook\nrich\nstd\ntk\nutils\nversion\n", "subsections": [] }, "CLASSES": { "content": "builtins.KeyError(builtins.LookupError)\ntqdm.std.TqdmKeyError\nbuiltins.RuntimeWarning(builtins.Warning)\ntqdm.monitor.TqdmSynchronisationWarning\nbuiltins.TypeError(builtins.Exception)\ntqdm.std.TqdmTypeError\nbuiltins.Warning(builtins.Exception)\ntqdm.std.TqdmWarning\ntqdm.std.TqdmDeprecationWarning(tqdm.std.TqdmWarning, builtins.DeprecationWarning)\ntqdm.std.TqdmExperimentalWarning(tqdm.std.TqdmWarning, builtins.FutureWarning)\ntqdm.std.TqdmMonitorWarning(tqdm.std.TqdmWarning, builtins.RuntimeWarning)\nthreading.Thread(builtins.object)\ntqdm.monitor.TMonitor\ntqdm.utils.Comparable(builtins.object)\ntqdm.std.tqdm\ntqdm.gui.tqdmgui\n", "subsections": [ { "name": "class TMonitor", "content": "| TMonitor(tqdmcls, sleepinterval)\n|\n| Monitoring thread for tqdm bars.\n| Monitors if tqdm bars are taking too much time to display\n| and readjusts miniters automatically if necessary.\n|\n| Parameters\n| ----------\n| tqdmcls : class\n| tqdm class to use (can be core tqdm or a submodule).\n| sleepinterval : float\n| Time to sleep between monitoring checks.\n|\n| Method resolution order:\n| TMonitor\n| threading.Thread\n| builtins.object\n|\n| Methods defined here:\n|\n| init(self, tqdmcls, sleepinterval)\n| This constructor should always be called with keyword arguments. Arguments are:\n|\n| *group* should be None; reserved for future extension when a ThreadGroup\n| class is implemented.\n|\n| *target* is the callable object to be invoked by the run()\n| method. Defaults to None, meaning nothing is called.\n|\n| *name* is the thread name. By default, a unique name is constructed of\n| the form \"Thread-N\" where N is a small decimal number.\n|\n| *args* is the argument tuple for the target invocation. Defaults to ().\n|\n| *kwargs* is a dictionary of keyword arguments for the target\n| invocation. Defaults to {}.\n|\n| If a subclass overrides the constructor, it must make sure to invoke\n| the base class constructor (Thread.init()) before doing anything\n| else to the thread.\n|\n| exit(self)\n|\n| getinstances(self)\n|\n| report(self)\n|\n| run(self)\n| Method representing the thread's activity.\n|\n| You may override this method in a subclass. The standard run() method\n| invokes the callable object passed to the object's constructor as the\n| target argument, if any, with sequential and keyword arguments taken\n| from the args and kwargs arguments, respectively.\n|\n| ----------------------------------------------------------------------\n| Methods inherited from threading.Thread:\n|\n| repr(self)\n| Return repr(self).\n|\n| getName(self)\n| Return a string used for identification purposes only.\n|\n| This method is deprecated, use the name attribute instead.\n|\n| isDaemon(self)\n| Return whether this thread is a daemon.\n|\n| This method is deprecated, use the daemon attribute instead.\n|\n| isalive(self)\n| Return whether the thread is alive.\n|\n| This method returns True just before the run() method starts until just\n| after the run() method terminates. See also the module function\n| enumerate().\n|\n| join(self, timeout=None)\n| Wait until the thread terminates.\n|\n| This blocks the calling thread until the thread whose join() method is\n| called terminates -- either normally or through an unhandled exception\n| or until the optional timeout occurs.\n|\n| When the timeout argument is present and not None, it should be a\n| floating point number specifying a timeout for the operation in seconds\n| (or fractions thereof). As join() always returns None, you must call\n| isalive() after join() to decide whether a timeout happened -- if the\n| thread is still alive, the join() call timed out.\n|\n| When the timeout argument is not present or None, the operation will\n| block until the thread terminates.\n|\n| A thread can be join()ed many times.\n|\n| join() raises a RuntimeError if an attempt is made to join the current\n| thread as that would cause a deadlock. It is also an error to join() a\n| thread before it has been started and attempts to do so raises the same\n| exception.\n|\n| setDaemon(self, daemonic)\n| Set whether this thread is a daemon.\n|\n| This method is deprecated, use the .daemon property instead.\n|\n| setName(self, name)\n| Set the name string for this thread.\n|\n| This method is deprecated, use the name attribute instead.\n|\n| start(self)\n| Start the thread's activity.\n|\n| It must be called at most once per thread object. It arranges for the\n| object's run() method to be invoked in a separate thread of control.\n|\n| This method will raise a RuntimeError if called more than once on the\n| same thread object.\n|\n| ----------------------------------------------------------------------\n| Readonly properties inherited from threading.Thread:\n|\n| ident\n| Thread identifier of this thread or None if it has not been started.\n|\n| This is a nonzero integer. See the getident() function. Thread\n| identifiers may be recycled when a thread exits and another thread is\n| created. The identifier is available even after the thread has exited.\n|\n| nativeid\n| Native integral thread ID of this thread, or None if it has not been started.\n|\n| This is a non-negative integer. See the getnativeid() function.\n| This represents the Thread ID as reported by the kernel.\n|\n| ----------------------------------------------------------------------\n| Data descriptors inherited from threading.Thread:\n|\n| dict\n| dictionary for instance variables (if defined)\n|\n| weakref\n| list of weak references to the object (if defined)\n|\n| daemon\n| A boolean value indicating whether this thread is a daemon thread.\n|\n| This must be set before start() is called, otherwise RuntimeError is\n| raised. Its initial value is inherited from the creating thread; the\n| main thread is not a daemon thread and therefore all threads created in\n| the main thread default to daemon = False.\n|\n| The entire Python program exits when only daemon threads are left.\n|\n| name\n| A string used for identification purposes only.\n|\n| It has no semantics. Multiple threads may be given the same name. The\n| initial name is set by the constructor.\n" }, { "name": "class TqdmDeprecationWarning", "content": "| TqdmDeprecationWarning(msg, fpwrite=None)\n|\n| may be removed in a future release\n|\n| Method resolution order:\n| TqdmDeprecationWarning\n| TqdmWarning\n| builtins.DeprecationWarning\n| builtins.Warning\n| builtins.Exception\n| builtins.BaseException\n| builtins.object\n|\n| Methods inherited from TqdmWarning:\n|\n| init(self, msg, fpwrite=None)\n| Initialize self. See help(type(self)) for accurate signature.\n|\n| ----------------------------------------------------------------------\n| Data descriptors inherited from TqdmWarning:\n|\n| weakref\n| list of weak references to the object (if defined)\n|\n| ----------------------------------------------------------------------\n| Static methods inherited from builtins.DeprecationWarning:\n|\n| new(*args, kwargs) from builtins.type\n| Create and return a new object. See help(type) for accurate signature.\n|\n| ----------------------------------------------------------------------\n| Methods inherited from builtins.BaseException:\n|\n| delattr(self, name, /)\n| Implement delattr(self, name).\n|\n| getattribute(self, name, /)\n| Return getattr(self, name).\n|\n| reduce(...)\n| Helper for pickle.\n|\n| repr(self, /)\n| Return repr(self).\n|\n| setattr(self, name, value, /)\n| Implement setattr(self, name, value).\n|\n| setstate(...)\n|\n| str(self, /)\n| Return str(self).\n|\n| withtraceback(...)\n| Exception.withtraceback(tb) --\n| set self.traceback to tb and return self.\n|\n| ----------------------------------------------------------------------\n| Data descriptors inherited from builtins.BaseException:\n|\n| cause\n| exception cause\n|\n| context\n| exception context\n|\n| dict\n|\n| suppresscontext\n|\n| traceback\n|\n| args\n" }, { "name": "class TqdmExperimentalWarning", "content": "| TqdmExperimentalWarning(msg, fpwrite=None)\n|\n| beta feature, unstable API and behaviour\n|\n| Method resolution order:\n| TqdmExperimentalWarning\n| TqdmWarning\n| builtins.FutureWarning\n| builtins.Warning\n| builtins.Exception\n| builtins.BaseException\n| builtins.object\n|\n| Methods inherited from TqdmWarning:\n|\n| init(self, msg, fpwrite=None)\n| Initialize self. See help(type(self)) for accurate signature.\n|\n| ----------------------------------------------------------------------\n| Data descriptors inherited from TqdmWarning:\n|\n| weakref\n| list of weak references to the object (if defined)\n|\n| ----------------------------------------------------------------------\n| Static methods inherited from builtins.FutureWarning:\n|\n| new(*args, kwargs) from builtins.type\n| Create and return a new object. See help(type) for accurate signature.\n|\n| ----------------------------------------------------------------------\n| Methods inherited from builtins.BaseException:\n|\n| delattr(self, name, /)\n| Implement delattr(self, name).\n|\n| getattribute(self, name, /)\n| Return getattr(self, name).\n|\n| reduce(...)\n| Helper for pickle.\n|\n| repr(self, /)\n| Return repr(self).\n|\n| setattr(self, name, value, /)\n| Implement setattr(self, name, value).\n|\n| setstate(...)\n|\n| str(self, /)\n| Return str(self).\n|\n| withtraceback(...)\n| Exception.withtraceback(tb) --\n| set self.traceback to tb and return self.\n|\n| ----------------------------------------------------------------------\n| Data descriptors inherited from builtins.BaseException:\n|\n| cause\n| exception cause\n|\n| context\n| exception context\n|\n| dict\n|\n| suppresscontext\n|\n| traceback\n|\n| args\n" }, { "name": "class TqdmKeyError", "content": "| Method resolution order:\n| TqdmKeyError\n| builtins.KeyError\n| builtins.LookupError\n| builtins.Exception\n| builtins.BaseException\n| builtins.object\n|\n| Data descriptors defined here:\n|\n| weakref\n| list of weak references to the object (if defined)\n|\n| ----------------------------------------------------------------------\n| Methods inherited from builtins.KeyError:\n|\n| init(self, /, *args, kwargs)\n| Initialize self. See help(type(self)) for accurate signature.\n|\n| str(self, /)\n| Return str(self).\n|\n| ----------------------------------------------------------------------\n| Static methods inherited from builtins.LookupError:\n|\n| new(*args, kwargs) from builtins.type\n| Create and return a new object. See help(type) for accurate signature.\n|\n| ----------------------------------------------------------------------\n| Methods inherited from builtins.BaseException:\n|\n| delattr(self, name, /)\n| Implement delattr(self, name).\n|\n| getattribute(self, name, /)\n| Return getattr(self, name).\n|\n| reduce(...)\n| Helper for pickle.\n|\n| repr(self, /)\n| Return repr(self).\n|\n| setattr(self, name, value, /)\n| Implement setattr(self, name, value).\n|\n| setstate(...)\n|\n| withtraceback(...)\n| Exception.withtraceback(tb) --\n| set self.traceback to tb and return self.\n|\n| ----------------------------------------------------------------------\n| Data descriptors inherited from builtins.BaseException:\n|\n| cause\n| exception cause\n|\n| context\n| exception context\n|\n| dict\n|\n| suppresscontext\n|\n| traceback\n|\n| args\n" }, { "name": "class TqdmMonitorWarning", "content": "| TqdmMonitorWarning(msg, fpwrite=None)\n|\n| tqdm monitor errors which do not affect external functionality\n|\n| Method resolution order:\n| TqdmMonitorWarning\n| TqdmWarning\n| builtins.RuntimeWarning\n| builtins.Warning\n| builtins.Exception\n| builtins.BaseException\n| builtins.object\n|\n| Methods inherited from TqdmWarning:\n|\n| init(self, msg, fpwrite=None)\n| Initialize self. See help(type(self)) for accurate signature.\n|\n| ----------------------------------------------------------------------\n| Data descriptors inherited from TqdmWarning:\n|\n| weakref\n| list of weak references to the object (if defined)\n|\n| ----------------------------------------------------------------------\n| Static methods inherited from builtins.RuntimeWarning:\n|\n| new(*args, kwargs) from builtins.type\n| Create and return a new object. See help(type) for accurate signature.\n|\n| ----------------------------------------------------------------------\n| Methods inherited from builtins.BaseException:\n|\n| delattr(self, name, /)\n| Implement delattr(self, name).\n|\n| getattribute(self, name, /)\n| Return getattr(self, name).\n|\n| reduce(...)\n| Helper for pickle.\n|\n| repr(self, /)\n| Return repr(self).\n|\n| setattr(self, name, value, /)\n| Implement setattr(self, name, value).\n|\n| setstate(...)\n|\n| str(self, /)\n| Return str(self).\n|\n| withtraceback(...)\n| Exception.withtraceback(tb) --\n| set self.traceback to tb and return self.\n|\n| ----------------------------------------------------------------------\n| Data descriptors inherited from builtins.BaseException:\n|\n| cause\n| exception cause\n|\n| context\n| exception context\n|\n| dict\n|\n| suppresscontext\n|\n| traceback\n|\n| args\n" }, { "name": "class TqdmSynchronisationWarning", "content": "| tqdm multi-thread/-process errors which may cause incorrect nesting\n| but otherwise no adverse effects\n|\n| Method resolution order:\n| TqdmSynchronisationWarning\n| builtins.RuntimeWarning\n| builtins.Warning\n| builtins.Exception\n| builtins.BaseException\n| builtins.object\n|\n| Data descriptors defined here:\n|\n| weakref\n| list of weak references to the object (if defined)\n|\n| ----------------------------------------------------------------------\n| Methods inherited from builtins.RuntimeWarning:\n|\n| init(self, /, *args, kwargs)\n| Initialize self. See help(type(self)) for accurate signature.\n|\n| ----------------------------------------------------------------------\n| Static methods inherited from builtins.RuntimeWarning:\n|\n| new(*args, kwargs) from builtins.type\n| Create and return a new object. See help(type) for accurate signature.\n|\n| ----------------------------------------------------------------------\n| Methods inherited from builtins.BaseException:\n|\n| delattr(self, name, /)\n| Implement delattr(self, name).\n|\n| getattribute(self, name, /)\n| Return getattr(self, name).\n|\n| reduce(...)\n| Helper for pickle.\n|\n| repr(self, /)\n| Return repr(self).\n|\n| setattr(self, name, value, /)\n| Implement setattr(self, name, value).\n|\n| setstate(...)\n|\n| str(self, /)\n| Return str(self).\n|\n| withtraceback(...)\n| Exception.withtraceback(tb) --\n| set self.traceback to tb and return self.\n|\n| ----------------------------------------------------------------------\n| Data descriptors inherited from builtins.BaseException:\n|\n| cause\n| exception cause\n|\n| context\n| exception context\n|\n| dict\n|\n| suppresscontext\n|\n| traceback\n|\n| args\n" }, { "name": "class TqdmTypeError", "content": "| Method resolution order:\n| TqdmTypeError\n| builtins.TypeError\n| builtins.Exception\n| builtins.BaseException\n| builtins.object\n|\n| Data descriptors defined here:\n|\n| weakref\n| list of weak references to the object (if defined)\n|\n| ----------------------------------------------------------------------\n| Methods inherited from builtins.TypeError:\n|\n| init(self, /, *args, kwargs)\n| Initialize self. See help(type(self)) for accurate signature.\n|\n| ----------------------------------------------------------------------\n| Static methods inherited from builtins.TypeError:\n|\n| new(*args, kwargs) from builtins.type\n| Create and return a new object. See help(type) for accurate signature.\n|\n| ----------------------------------------------------------------------\n| Methods inherited from builtins.BaseException:\n|\n| delattr(self, name, /)\n| Implement delattr(self, name).\n|\n| getattribute(self, name, /)\n| Return getattr(self, name).\n|\n| reduce(...)\n| Helper for pickle.\n|\n| repr(self, /)\n| Return repr(self).\n|\n| setattr(self, name, value, /)\n| Implement setattr(self, name, value).\n|\n| setstate(...)\n|\n| str(self, /)\n| Return str(self).\n|\n| withtraceback(...)\n| Exception.withtraceback(tb) --\n| set self.traceback to tb and return self.\n|\n| ----------------------------------------------------------------------\n| Data descriptors inherited from builtins.BaseException:\n|\n| cause\n| exception cause\n|\n| context\n| exception context\n|\n| dict\n|\n| suppresscontext\n|\n| traceback\n|\n| args\n" }, { "name": "class TqdmWarning", "content": "| TqdmWarning(msg, fpwrite=None)\n|\n| base class for all tqdm warnings.\n|\n| Used for non-external-code-breaking errors, such as garbled printing.\n|\n| Method resolution order:\n| TqdmWarning\n| builtins.Warning\n| builtins.Exception\n| builtins.BaseException\n| builtins.object\n|\n| Methods defined here:\n|\n| init(self, msg, fpwrite=None)\n| Initialize self. See help(type(self)) for accurate signature.\n|\n| ----------------------------------------------------------------------\n| Data descriptors defined here:\n|\n| weakref\n| list of weak references to the object (if defined)\n|\n| ----------------------------------------------------------------------\n| Static methods inherited from builtins.Warning:\n|\n| new(*args, kwargs) from builtins.type\n| Create and return a new object. See help(type) for accurate signature.\n|\n| ----------------------------------------------------------------------\n| Methods inherited from builtins.BaseException:\n|\n| delattr(self, name, /)\n| Implement delattr(self, name).\n|\n| getattribute(self, name, /)\n| Return getattr(self, name).\n|\n| reduce(...)\n| Helper for pickle.\n|\n| repr(self, /)\n| Return repr(self).\n|\n| setattr(self, name, value, /)\n| Implement setattr(self, name, value).\n|\n| setstate(...)\n|\n| str(self, /)\n| Return str(self).\n|\n| withtraceback(...)\n| Exception.withtraceback(tb) --\n| set self.traceback to tb and return self.\n|\n| ----------------------------------------------------------------------\n| Data descriptors inherited from builtins.BaseException:\n|\n| cause\n| exception cause\n|\n| context\n| exception context\n|\n| dict\n|\n| suppresscontext\n|\n| traceback\n|\n| args\n" }, { "name": "class tqdm", "content": "| tqdm(*, )\n|\n| Decorate an iterable object, returning an iterator which acts exactly\n| like the original iterable, but prints a dynamically updating\n| progress bar every time a value is requested.\n|\n| Parameters\n| ----------\n| iterable : iterable, optional\n| Iterable to decorate with a progress bar.\n| Leave blank to manually manage the updates.\n| desc : str, optional\n| Prefix for the progress bar.\n| total : int or float, optional\n| The number of expected iterations. If unspecified,\n| len(iterable) is used if possible. If float(\"inf\") or as a last\n| resort, only basic progress statistics are displayed\n| (no ETA, no progress bar).\n| If `gui` is True and this parameter needs subsequent updating,\n| specify an initial arbitrary large positive number,\n| e.g. 9e9.\n| leave : bool, optional\n| If [default: True], keeps all traces of the progress bar\n| upon termination of iteration.\n| If `None`, will leave only if `position` is `0`.\n| file : `io.TextIOWrapper` or `io.StringIO`, optional\n| Specifies where to output the progress messages\n| (default: sys.stderr). Uses `file.write(str)` and `file.flush()`\n| methods. For encoding, see `writebytes`.\n| ncols : int, optional\n| The width of the entire output message. If specified,\n| dynamically resizes the progress bar to stay within this bound.\n| If unspecified, attempts to use environment width. The\n| fallback is a meter width of 10 and no limit for the counter and\n| statistics. If 0, will not print any meter (only stats).\n| mininterval : float, optional\n| Minimum progress display update interval [default: 0.1] seconds.\n| maxinterval : float, optional\n| Maximum progress display update interval [default: 10] seconds.\n| Automatically adjusts `miniters` to correspond to `mininterval`\n| after long display update lag. Only works if `dynamicminiters`\n| or monitor thread is enabled.\n| miniters : int or float, optional\n| Minimum progress display update interval, in iterations.\n| If 0 and `dynamicminiters`, will automatically adjust to equal\n| `mininterval` (more CPU efficient, good for tight loops).\n| If > 0, will skip display of specified number of iterations.\n| Tweak this and `mininterval` to get very efficient loops.\n| If your progress is erratic with both fast and slow iterations\n| (network, skipping items, etc) you should set miniters=1.\n| ascii : bool or str, optional\n| If unspecified or False, use unicode (smooth blocks) to fill\n| the meter. The fallback is to use ASCII characters \" 123456789#\".\n| disable : bool, optional\n| Whether to disable the entire progress bar wrapper\n| [default: False]. If set to None, disable on non-TTY.\n| unit : str, optional\n| String that will be used to define the unit of each iteration\n| [default: it].\n| unitscale : bool or int or float, optional\n| If 1 or True, the number of iterations will be reduced/scaled\n| automatically and a metric prefix following the\n| International System of Units standard will be added\n| (kilo, mega, etc.) [default: False]. If any other non-zero\n| number, will scale `total` and `n`.\n| dynamicncols : bool, optional\n| If set, constantly alters `ncols` and `nrows` to the\n| environment (allowing for window resizes) [default: False].\n| smoothing : float, optional\n| Exponential moving average smoothing factor for speed estimates\n| (ignored in GUI mode). Ranges from 0 (average speed) to 1\n| (current/instantaneous speed) [default: 0.3].\n| barformat : str, optional\n| Specify a custom bar string formatting. May impact performance.\n| [default: '{lbar}{bar}{rbar}'], where\n| lbar='{desc}: {percentage:3.0f}%|' and\n| rbar='| {nfmt}/{totalfmt} [{elapsed}<{remaining}, '\n| '{ratefmt}{postfix}]'\n| Possible vars: lbar, bar, rbar, n, nfmt, total, totalfmt,\n| percentage, elapsed, elapseds, ncols, nrows, desc, unit,\n| rate, ratefmt, ratenoinv, ratenoinvfmt,\n| rateinv, rateinvfmt, postfix, unitdivisor,\n| remaining, remainings, eta.\n| Note that a trailing \": \" is automatically removed after {desc}\n| if the latter is empty.\n| initial : int or float, optional\n| The initial counter value. Useful when restarting a progress\n| bar [default: 0]. If using float, consider specifying `{n:.3f}`\n| or similar in `barformat`, or specifying `unitscale`.\n| position : int, optional\n| Specify the line offset to print this bar (starting from 0)\n| Automatic if unspecified.\n| Useful to manage multiple bars at once (eg, from threads).\n| postfix : dict or *, optional\n| Specify additional stats to display at the end of the bar.\n| Calls `setpostfix(postfix)` if possible (dict).\n| unitdivisor : float, optional\n| [default: 1000], ignored unless `unitscale` is True.\n| writebytes : bool, optional\n| Whether to write bytes. If (default: False) will write unicode.\n| lockargs : tuple, optional\n| Passed to `refresh` for intermediate output\n| (initialisation, iterating, and updating).\n| nrows : int, optional\n| The screen height. If specified, hides nested bars outside this\n| bound. If unspecified, attempts to use environment height.\n| The fallback is 20.\n| colour : str, optional\n| Bar colour (e.g. 'green', '#00ff00').\n| delay : float, optional\n| Don't display until [default: 0] seconds have elapsed.\n| gui : bool, optional\n| WARNING: internal parameter - do not use.\n| Use tqdm.gui.tqdm(...) instead. If set, will attempt to use\n| matplotlib animations for a graphical output [default: False].\n|\n| Returns\n| -------\n| out : decorated iterator.\n|\n| Method resolution order:\n| tqdm\n| tqdm.utils.Comparable\n| builtins.object\n|\n| Methods defined here:\n|\n| bool(self)\n|\n| contains(self, item)\n|\n| del(self)\n|\n| enter(self)\n|\n| exit(self, exctype, excvalue, traceback)\n|\n| hash(self)\n| Return hash(self).\n|\n| 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', unitscale=False, dynamicncols=False, smoothing=0.3, barformat=None, initial=0, position=None, postfix=None, unitdivisor=1000, writebytes=False, lockargs=None, nrows=None, colour=None, delay=0.0, gui=False, kwargs)\n|\n| iter(self)\n| Backward-compatibility to use: for x in tqdm(iterable)\n|\n| len(self)\n|\n| reversed(self)\n|\n| str(self)\n| Return str(self).\n|\n| clear(self, nolock=False)\n| Clear current bar display.\n|\n| close(self)\n| Cleanup and (if leave=False) close the progress bar.\n|\n| display(self, msg=None, pos=None)\n| Use `self.sp` to display `msg` in the specified `pos`.\n|\n| Consider overloading this function when inheriting to use e.g.:\n| `self.somefrontend(self.formatdict)` instead of `self.sp`.\n|\n| Parameters\n| ----------\n| msg : str, optional. What to display (default: `repr(self)`).\n| pos : int, optional. Position to `moveto`\n| (default: `abs(self.pos)`).\n|\n| moveto(self, n)\n|\n| refresh(self, nolock=False, lockargs=None)\n| Force refresh the display of this bar.\n|\n| Parameters\n| ----------\n| nolock : bool, optional\n| If `True`, does not lock.\n| If [default: `False`]: calls `acquire()` on internal lock.\n| lockargs : tuple, optional\n| Passed to internal lock's `acquire()`.\n| If specified, will only `display()` if `acquire()` returns `True`.\n|\n| reset(self, total=None)\n| Resets to 0 iterations for repeated use.\n|\n| Consider combining with `leave=True`.\n|\n| Parameters\n| ----------\n| total : int or float, optional. Total to use for the new bar.\n|\n| setdescription(self, desc=None, refresh=True)\n| Set/modify description of the progress bar.\n|\n| Parameters\n| ----------\n| desc : str, optional\n| refresh : bool, optional\n| Forces refresh [default: True].\n|\n| setdescriptionstr(self, desc=None, refresh=True)\n| Set/modify description without ': ' appended.\n|\n| setpostfix(self, ordereddict=None, refresh=True, kwargs)\n| Set/modify postfix (additional stats)\n| with automatic formatting based on datatype.\n|\n| Parameters\n| ----------\n| ordereddict : dict or OrderedDict, optional\n| refresh : bool, optional\n| Forces refresh [default: True].\n| kwargs : dict, optional\n|\n| setpostfixstr(self, s='', refresh=True)\n| Postfix without dictionary expansion, similar to prefix handling.\n|\n| unpause(self)\n| Restart tqdm timer from last print time.\n|\n| update(self, n=1)\n| Manually update the progress bar, useful for streams\n| such as reading files.\n| E.g.:\n| >>> t = tqdm(total=filesize) # Initialise\n| >>> for currentbuffer in stream:\n| ... ...\n| ... t.update(len(currentbuffer))\n| >>> t.close()\n| The last line is highly recommended, but possibly not necessary if\n| `t.update()` will be called in such a way that `filesize` will be\n| exactly reached and printed.\n|\n| Parameters\n| ----------\n| n : int or float, optional\n| Increment to add to the internal counter of iterations\n| [default: 1]. If using float, consider specifying `{n:.3f}`\n| or similar in `barformat`, or specifying `unitscale`.\n|\n| Returns\n| -------\n| out : bool or None\n| True if a `display()` was triggered.\n|\n| ----------------------------------------------------------------------\n| Class methods defined here:\n|\n| externalwritemode(file=None, nolock=False) from builtins.type\n| Disable tqdm within context and refresh tqdm when exits.\n| Useful when writing to standard output stream\n|\n| getlock() from builtins.type\n| Get the global lock. Construct it if it does not exist.\n|\n| pandas(tqdmkwargs) from builtins.type\n| Registers the current `tqdm` class with\n| pandas.core.\n| ( frame.DataFrame\n| | series.Series\n| | groupby.(generic.)DataFrameGroupBy\n| | groupby.(generic.)SeriesGroupBy\n| ).progressapply\n|\n| A new instance will be created every time `progressapply` is called,\n| and each instance will automatically `close()` upon completion.\n|\n| Parameters\n| ----------\n| tqdmkwargs : arguments for the tqdm instance\n|\n| Examples\n| --------\n| >>> import pandas as pd\n| >>> import numpy as np\n| >>> from tqdm import tqdm\n| >>> from tqdm.gui import tqdm as tqdmgui\n| >>>\n| >>> df = pd.DataFrame(np.random.randint(0, 100, (100000, 6)))\n| >>> tqdm.pandas(ncols=50) # can use tqdmgui, optional kwargs, etc\n| >>> # Now you can use `progressapply` instead of `apply`\n| >>> df.groupby(0).progressapply(lambda x: x2)\n|\n| References\n| ----------\n| \n|\n| setlock(lock) from builtins.type\n| Set the global lock.\n|\n| wrapattr(stream, method, total=None, bytes=True, tqdmkwargs) from builtins.type\n| stream : file-like object.\n| method : str, \"read\" or \"write\". The result of `read()` and\n| the first argument of `write()` should have a `len()`.\n|\n| >>> with tqdm.wrapattr(fileobj, \"read\", total=fileobj.size) as fobj:\n| ... while True:\n| ... chunk = fobj.read(chunksize)\n| ... if not chunk:\n| ... break\n|\n| write(s, file=None, end='\\n', nolock=False) from builtins.type\n| Print a message via tqdm (without overlap with bars).\n|\n| ----------------------------------------------------------------------\n| Static methods defined here:\n|\n| new(cls, *, )\n| Create and return a new object. See help(type) for accurate signature.\n|\n| formatinterval(t)\n| Formats a number of seconds as a clock time, [H:]MM:SS\n|\n| Parameters\n| ----------\n| t : int\n| Number of seconds.\n|\n| Returns\n| -------\n| out : str\n| [H:]MM:SS\n|\n| formatmeter(n, total, elapsed, ncols=None, prefix='', ascii=False, unit='it', unitscale=False, rate=None, barformat=None, postfix=None, unitdivisor=1000, initial=0, colour=None, extrakwargs)\n| Return a string-based progress bar given some parameters\n|\n| Parameters\n| ----------\n| n : int or float\n| Number of finished iterations.\n| total : int or float\n| The expected total number of iterations. If meaningless (None),\n| only basic progress statistics are displayed (no ETA).\n| elapsed : float\n| Number of seconds passed since start.\n| ncols : int, optional\n| The width of the entire output message. If specified,\n| dynamically resizes `{bar}` to stay within this bound\n| [default: None]. If `0`, will not print any bar (only stats).\n| The fallback is `{bar:10}`.\n| prefix : str, optional\n| Prefix message (included in total width) [default: ''].\n| Use as {desc} in barformat string.\n| ascii : bool, optional or str, optional\n| If not set, use unicode (smooth blocks) to fill the meter\n| [default: False]. The fallback is to use ASCII characters\n| \" 123456789#\".\n| unit : str, optional\n| The iteration unit [default: 'it'].\n| unitscale : bool or int or float, optional\n| If 1 or True, the number of iterations will be printed with an\n| appropriate SI metric prefix (k = 10^3, M = 10^6, etc.)\n| [default: False]. If any other non-zero number, will scale\n| `total` and `n`.\n| rate : float, optional\n| Manual override for iteration rate.\n| If [default: None], uses n/elapsed.\n| barformat : str, optional\n| Specify a custom bar string formatting. May impact performance.\n| [default: '{lbar}{bar}{rbar}'], where\n| lbar='{desc}: {percentage:3.0f}%|' and\n| rbar='| {nfmt}/{totalfmt} [{elapsed}<{remaining}, '\n| '{ratefmt}{postfix}]'\n| Possible vars: lbar, bar, rbar, n, nfmt, total, totalfmt,\n| percentage, elapsed, elapseds, ncols, nrows, desc, unit,\n| rate, ratefmt, ratenoinv, ratenoinvfmt,\n| rateinv, rateinvfmt, postfix, unitdivisor,\n| remaining, remainings, eta.\n| Note that a trailing \": \" is automatically removed after {desc}\n| if the latter is empty.\n| postfix : *, optional\n| Similar to `prefix`, but placed at the end\n| (e.g. for additional stats).\n| Note: postfix is usually a string (not a dict) for this method,\n| and will if possible be set to postfix = ', ' + postfix.\n| However other types are supported (#382).\n| unitdivisor : float, optional\n| [default: 1000], ignored unless `unitscale` is True.\n| initial : int or float, optional\n| The initial counter value [default: 0].\n| colour : str, optional\n| Bar colour (e.g. 'green', '#00ff00').\n|\n| Returns\n| -------\n| out : Formatted meter and stats, ready to display.\n|\n| formatnum(n)\n| Intelligent scientific notation (.3g).\n|\n| Parameters\n| ----------\n| n : int or float or Numeric\n| A Number.\n|\n| Returns\n| -------\n| out : str\n| Formatted number.\n|\n| formatsizeof(num, suffix='', divisor=1000)\n| Formats a number (greater than unity) with SI Order of Magnitude\n| prefixes.\n|\n| Parameters\n| ----------\n| num : float\n| Number ( >= 1) to format.\n| suffix : str, optional\n| Post-postfix [default: ''].\n| divisor : float, optional\n| Divisor between prefixes [default: 1000].\n|\n| Returns\n| -------\n| out : str\n| Number with Order of Magnitude SI unit postfix.\n|\n| statusprinter(file)\n| Manage the printing and in-place updating of a line of characters.\n| Note that if the string is longer than a line, then in-place\n| updating may not work (it will print a new line at each refresh).\n|\n| ----------------------------------------------------------------------\n| Readonly properties defined here:\n|\n| formatdict\n| Public API for read-only member access.\n|\n| ----------------------------------------------------------------------\n| Data and other attributes defined here:\n|\n| monitor = None\n|\n| monitorinterval = 10\n|\n| ----------------------------------------------------------------------\n| Methods inherited from tqdm.utils.Comparable:\n|\n| eq(self, other)\n| Return self==value.\n|\n| ge(self, other)\n| Return self>=value.\n|\n| gt(self, other)\n| Return self>value.\n|\n| le(self, other)\n| Return self<=value.\n|\n| lt(self, other)\n| Return self>> t = tqdm(total=filesize) # Initialise\n| >>> for currentbuffer in stream:\n| ... ...\n| ... t.update(len(currentbuffer))\n| >>> t.close()\n| The last line is highly recommended, but possibly not necessary if\n| `t.update()` will be called in such a way that `filesize` will be\n| exactly reached and printed.\n|\n| Parameters\n| ----------\n| n : int or float, optional\n| Increment to add to the internal counter of iterations\n| [default: 1]. If using float, consider specifying `{n:.3f}`\n| or similar in `barformat`, or specifying `unitscale`.\n|\n| Returns\n| -------\n| out : bool or None\n| True if a `display()` was triggered.\n|\n| ----------------------------------------------------------------------\n| Class methods inherited from tqdm.std.tqdm:\n|\n| externalwritemode(file=None, nolock=False) from builtins.type\n| Disable tqdm within context and refresh tqdm when exits.\n| Useful when writing to standard output stream\n|\n| getlock() from builtins.type\n| Get the global lock. Construct it if it does not exist.\n|\n| pandas(tqdmkwargs) from builtins.type\n| Registers the current `tqdm` class with\n| pandas.core.\n| ( frame.DataFrame\n| | series.Series\n| | groupby.(generic.)DataFrameGroupBy\n| | groupby.(generic.)SeriesGroupBy\n| ).progressapply\n|\n| A new instance will be created every time `progressapply` is called,\n| and each instance will automatically `close()` upon completion.\n|\n| Parameters\n| ----------\n| tqdmkwargs : arguments for the tqdm instance\n|\n| Examples\n| --------\n| >>> import pandas as pd\n| >>> import numpy as np\n| >>> from tqdm import tqdm\n| >>> from tqdm.gui import tqdm as tqdmgui\n| >>>\n| >>> df = pd.DataFrame(np.random.randint(0, 100, (100000, 6)))\n| >>> tqdm.pandas(ncols=50) # can use tqdmgui, optional kwargs, etc\n| >>> # Now you can use `progressapply` instead of `apply`\n| >>> df.groupby(0).progressapply(lambda x: x2)\n|\n| References\n| ----------\n| \n|\n| setlock(lock) from builtins.type\n| Set the global lock.\n|\n| wrapattr(stream, method, total=None, bytes=True, tqdmkwargs) from builtins.type\n| stream : file-like object.\n| method : str, \"read\" or \"write\". The result of `read()` and\n| the first argument of `write()` should have a `len()`.\n|\n| >>> with tqdm.wrapattr(fileobj, \"read\", total=fileobj.size) as fobj:\n| ... while True:\n| ... chunk = fobj.read(chunksize)\n| ... if not chunk:\n| ... break\n|\n| write(s, file=None, end='\\n', nolock=False) from builtins.type\n| Print a message via tqdm (without overlap with bars).\n|\n| ----------------------------------------------------------------------\n| Static methods inherited from tqdm.std.tqdm:\n|\n| new(cls, *, )\n| Create and return a new object. See help(type) for accurate signature.\n|\n| formatinterval(t)\n| Formats a number of seconds as a clock time, [H:]MM:SS\n|\n| Parameters\n| ----------\n| t : int\n| Number of seconds.\n|\n| Returns\n| -------\n| out : str\n| [H:]MM:SS\n|\n| formatmeter(n, total, elapsed, ncols=None, prefix='', ascii=False, unit='it', unitscale=False, rate=None, barformat=None, postfix=None, unitdivisor=1000, initial=0, colour=None, extrakwargs)\n| Return a string-based progress bar given some parameters\n|\n| Parameters\n| ----------\n| n : int or float\n| Number of finished iterations.\n| total : int or float\n| The expected total number of iterations. If meaningless (None),\n| only basic progress statistics are displayed (no ETA).\n| elapsed : float\n| Number of seconds passed since start.\n| ncols : int, optional\n| The width of the entire output message. If specified,\n| dynamically resizes `{bar}` to stay within this bound\n| [default: None]. If `0`, will not print any bar (only stats).\n| The fallback is `{bar:10}`.\n| prefix : str, optional\n| Prefix message (included in total width) [default: ''].\n| Use as {desc} in barformat string.\n| ascii : bool, optional or str, optional\n| If not set, use unicode (smooth blocks) to fill the meter\n| [default: False]. The fallback is to use ASCII characters\n| \" 123456789#\".\n| unit : str, optional\n| The iteration unit [default: 'it'].\n| unitscale : bool or int or float, optional\n| If 1 or True, the number of iterations will be printed with an\n| appropriate SI metric prefix (k = 10^3, M = 10^6, etc.)\n| [default: False]. If any other non-zero number, will scale\n| `total` and `n`.\n| rate : float, optional\n| Manual override for iteration rate.\n| If [default: None], uses n/elapsed.\n| barformat : str, optional\n| Specify a custom bar string formatting. May impact performance.\n| [default: '{lbar}{bar}{rbar}'], where\n| lbar='{desc}: {percentage:3.0f}%|' and\n| rbar='| {nfmt}/{totalfmt} [{elapsed}<{remaining}, '\n| '{ratefmt}{postfix}]'\n| Possible vars: lbar, bar, rbar, n, nfmt, total, totalfmt,\n| percentage, elapsed, elapseds, ncols, nrows, desc, unit,\n| rate, ratefmt, ratenoinv, ratenoinvfmt,\n| rateinv, rateinvfmt, postfix, unitdivisor,\n| remaining, remainings, eta.\n| Note that a trailing \": \" is automatically removed after {desc}\n| if the latter is empty.\n| postfix : *, optional\n| Similar to `prefix`, but placed at the end\n| (e.g. for additional stats).\n| Note: postfix is usually a string (not a dict) for this method,\n| and will if possible be set to postfix = ', ' + postfix.\n| However other types are supported (#382).\n| unitdivisor : float, optional\n| [default: 1000], ignored unless `unitscale` is True.\n| initial : int or float, optional\n| The initial counter value [default: 0].\n| colour : str, optional\n| Bar colour (e.g. 'green', '#00ff00').\n|\n| Returns\n| -------\n| out : Formatted meter and stats, ready to display.\n|\n| formatnum(n)\n| Intelligent scientific notation (.3g).\n|\n| Parameters\n| ----------\n| n : int or float or Numeric\n| A Number.\n|\n| Returns\n| -------\n| out : str\n| Formatted number.\n|\n| formatsizeof(num, suffix='', divisor=1000)\n| Formats a number (greater than unity) with SI Order of Magnitude\n| prefixes.\n|\n| Parameters\n| ----------\n| num : float\n| Number ( >= 1) to format.\n| suffix : str, optional\n| Post-postfix [default: ''].\n| divisor : float, optional\n| Divisor between prefixes [default: 1000].\n|\n| Returns\n| -------\n| out : str\n| Number with Order of Magnitude SI unit postfix.\n|\n| statusprinter(file)\n| Manage the printing and in-place updating of a line of characters.\n| Note that if the string is longer than a line, then in-place\n| updating may not work (it will print a new line at each refresh).\n|\n| ----------------------------------------------------------------------\n| Readonly properties inherited from tqdm.std.tqdm:\n|\n| formatdict\n| Public API for read-only member access.\n|\n| ----------------------------------------------------------------------\n| Data and other attributes inherited from tqdm.std.tqdm:\n|\n| monitor = None\n|\n| monitorinterval = 10\n|\n| ----------------------------------------------------------------------\n| Methods inherited from tqdm.utils.Comparable:\n|\n| eq(self, other)\n| Return self==value.\n|\n| ge(self, other)\n| Return self>=value.\n|\n| gt(self, other)\n| Return self>value.\n|\n| le(self, other)\n| Return self<=value.\n|\n| lt(self, other)\n| Return self