Xoutil Documentation

xoutil Documentation

Release 1.7.11 Merchise

Oct 31, 2017

Contents

1 What's new in 1.7.11

3

2 Contents:

5

2.1 xoutil ? Collection of tools. Top-level imports. . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

2.2 xoutil.annotate - Py3k compatible annotations for Python 2 . . . . . . . . . . . . . . . . . . 6

2.3 xoutil.bases - Numeric base 32 and base 64 integer representations . . . . . . . . . . . . . . . 7

2.4 xoutil.bound ? Helpers for bounded execution of co-routines. . . . . . . . . . . . . . . . . . . . 9

2.5 xoutil.cli ? Command line application facilities . . . . . . . . . . . . . . . . . . . . . . . . . . 16

2.6 xoutil.collections - High-performance container datatypes . . . . . . . . . . . . . . . . . . 18

2.7 xoutil.connote ? Predicates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

2.8 xoutil.context - Simple execution contexts . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

2.9 xoutil.crypto - Other cryptographic services . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

2.10 xoutil.data - Useful data-structures and data related algorithms . . . . . . . . . . . . . . . . . . 27

2.11 xoutil.datetime - Basic date and time types . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

2.12 xoutil.decorator - Several decorators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

2.13 xoutil.deprecation - Utils for marking deprecated elements . . . . . . . . . . . . . . . . . . 34

2.14 xoutil.dim - Facilities to work with concrete numbers . . . . . . . . . . . . . . . . . . . . . . . 35

2.15 xoutil.eight ? Extensions for writing code that runs on Python 2 and 3 . . . . . . . . . . . . . 44

2.16 xoutil.formatter - Formatting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

2.17 xoutil.fs ? file system utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

2.18 xoutil.functools - Higher-order functions and operations on callable objects . . . . . . . . . 52

2.19 xoutil.html ? Helpers for manipulating HTML. . . . . . . . . . . . . . . . . . . . . . . . . . . 55

2.20 xoutil.infinity - An infinite value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

2.21 xoutil.inspect ? Inspect live objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

2.22 xoutil.iterators - Functions creating iterators for efficient looping . . . . . . . . . . . . . . . 57

2.23 xoutil.json - Encode and decode the JSON format . . . . . . . . . . . . . . . . . . . . . . . . 61

2.24 xoutil.logger - Standard logger helpers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

2.25 xoutil.modules ? Utilities for working with modules . . . . . . . . . . . . . . . . . . . . . . . 64

2.26 xoutil.names ? Utilities for handling objects names . . . . . . . . . . . . . . . . . . . . . . . . 66

2.27 xoutil.objects - Functions for dealing with objects . . . . . . . . . . . . . . . . . . . . . . . . 68

2.28 xoutil.params ? Function signatures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

2.29 xoutil.pprint ? Extension to the data pretty printer. . . . . . . . . . . . . . . . . . . . . . . . 75

2.30 xoutil.progress - Console progress utils . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

2.31 xoutil.records - Records definitions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

2.32 xoutil.string - Common string operations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

2.33 xoutil.subprocess - Extensions to subprocess stardard module . . . . . . . . . . . . . . . . . 82

i

2.34 xoutil.textwrap ? Text wrapping and filling. . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 2.35 xoutil.threading ? Higher-level threading interface . . . . . . . . . . . . . . . . . . . . . . . 83 2.36 xoutil.types - Names for built-in types and extensions. . . . . . . . . . . . . . . . . . . . . . . 84 2.37 Other utils . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 2.38 Changelog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 2.39 Work plans (backlogs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 2.40 How to contribute to xoutil . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 2.41 List of contributors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 2.42 Copyright and Licence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

3 Indices and tables

107

Python Module Index

109

ii

xoutil Documentation, Release 1.7.11

xoutil is a collection of disparate utilities that does not conform a framework for anything. xoutil is essentially an extension to the Python's standard library.

Contents

1

................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download