2015-03-22 00:12:50 +00:00
|
|
|
.. boltons documentation master file, created on Sat Mar 21 00:34:18 2015.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
boltons
|
|
|
|
|
=======
|
|
|
|
|
|
|
|
|
|
*boltons should be builtins.*
|
|
|
|
|
|
2015-03-22 09:56:24 +00:00
|
|
|
**Boltons** is a set of pure-Python utilities in the same spirit as
|
|
|
|
|
the Python builtins, and yet somehow not present in the standard
|
|
|
|
|
library. A few examples include:
|
2015-03-22 00:12:50 +00:00
|
|
|
|
|
|
|
|
* Atomic file saving, bolted on with fileutils
|
|
|
|
|
* A highly-optimized ``OrderedMultiDict``, in dictutils
|
|
|
|
|
* Two types of ``PriorityQueue``, in queueutils
|
|
|
|
|
* "Chunked" and "windowed" iteration, among many others, in iterutils
|
|
|
|
|
* A full-featured ``TracebackInfo`` type, for representing stack traces, in tbutils
|
|
|
|
|
|
2015-03-22 09:56:24 +00:00
|
|
|
Usage
|
|
|
|
|
-----
|
|
|
|
|
|
|
|
|
|
Boltons can be used in a couple ways.
|
|
|
|
|
|
2015-03-22 18:47:38 +00:00
|
|
|
1. Install the boltons package using ``pip`` or ``easy_install``.
|
|
|
|
|
2. Copy the whole boltons package into your project.
|
|
|
|
|
3. Copy just the ``utils.py`` module that your package needs.
|
2015-03-22 09:56:24 +00:00
|
|
|
|
|
|
|
|
The boltons package depends on no packages, making it easy for
|
|
|
|
|
inclusion into a project. Furthermore, most individual modules have
|
|
|
|
|
been written to be as self-contained as possible, allowing
|
2015-03-23 09:54:48 +00:00
|
|
|
cherrypicking of functionality into projects. Utility libraries are
|
|
|
|
|
often used extensively within a project, and because they are not
|
|
|
|
|
often fundamental to the architecture of the application, stability
|
|
|
|
|
may take precedence over version recency.
|
2015-03-22 09:56:24 +00:00
|
|
|
|
2015-03-22 00:12:50 +00:00
|
|
|
|
|
|
|
|
Third-party packages
|
|
|
|
|
--------------------
|
|
|
|
|
|
|
|
|
|
The majority of boltons strive to be "good enough" for a wide range of
|
|
|
|
|
basic uses, leaving advanced use cases to specialized 3rd party
|
|
|
|
|
libraries. For example, no radical recommendations of NumPy inclusion
|
|
|
|
|
in the standard lib; the builtin number types and operations are
|
|
|
|
|
great! Built-in support for imaginary numbers for goodness sake!
|
|
|
|
|
|
|
|
|
|
Gaps
|
|
|
|
|
----
|
|
|
|
|
|
|
|
|
|
Found something missing in boltons? If you are very motivated, submit
|
|
|
|
|
a Pull Request. Otherwise, submit a feature request on the Issues
|
|
|
|
|
page, and we will figure something out.
|
|
|
|
|
|
|
|
|
|
Contents:
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
|
|
|
|
|
cacheutils
|
|
|
|
|
debugutils
|
|
|
|
|
dictutils
|
|
|
|
|
fileutils
|
|
|
|
|
formatutils
|
|
|
|
|
funcutils
|
|
|
|
|
gcutils
|
|
|
|
|
iterutils
|
|
|
|
|
jsonutils
|
|
|
|
|
listutils
|
|
|
|
|
mboxutils
|
|
|
|
|
namedutils
|
|
|
|
|
queueutils
|
|
|
|
|
setutils
|
|
|
|
|
statsutils
|
2015-03-22 06:18:45 +00:00
|
|
|
strutils
|
2015-03-22 00:12:50 +00:00
|
|
|
tableutils
|
|
|
|
|
tbutils
|
|
|
|
|
timeutils
|
|
|
|
|
tzutils
|
