Welcome to xoutil’s documentation!

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.

What’s new in this release

• Add xoutil.collections.PascalSet and xoutil.collections.BitPascalSet.
• Add xoutil.functools.lwraps().
• Add xoutil.objects.multi_getter(), xoutil.objects.get_branch_subclasses(), xoutil.objects.fix_method_documentation().
• Add xoutil.string.safe_str()
• Remove long deprecated modules: xoutil.aop and xoutil.proxy.
• Deprecate xoutil.html entirely.
• The following modules are included on a provisional basis. Backwards incompatible changes (up to and including removal of the module) may occur if deemed necessary by the core developers:
  • xoutil.connote.
  • xoutil.params.

Fixes in 1.7.1.post1:

• Fix issue with both xoutil.string.safe_decode() and xoutil.string.safe_encode().

  Previously, the parameter encoding could contain an invalid encoding name and the function could fail.

Fixes in 1.7.1.post2:

• Fix xoutil.string.cut_suffix(). The following invariant was being violated:

  >>> cut_suffix(v, '') == v  # for any value of 'v'
  

Warning

Due to lack of time, we have decided to release this version without proper releases of 1.7.0 and 1.6.11. You should also read the 1.7.0 notes in the Changelog.

Contents:

• xoutil – Collection of tools. Top-level imports.
• xoutil.annotate - Py3k compatible annotations for Python 2
• xoutil.bases - Numeric base 32 and base 64 integer representations
• xoutil.bound – Helpers for bounded execution of co-routines.
  • A bounded execution model
  • Included boundary conditions
  • Chaining several boundary conditions
  • Defining boundaries
  • Internal API
  • An example: time bounded batch processing
  • Using the Bounded.generate() method
• xoutil.collections - High-performance container datatypes
• xoutil.connote – Predicates
• xoutil.context - Simple execution contexts
• xoutil.crypto - Other cryptographic services
• xoutil.data - Useful data-structures and data related algorithms
• xoutil.datetime - Basic date and time types
• xoutil.decorator - Several decorators
  • Top-level decorators
  • Sub packages
• xoutil.deprecation - Utils for marking deprecated elements
• xoutil.formatter - Formatting
• xoutil.fs – file system utilities
  • xoutil.fs.path – Path utilities
• xoutil.functools - Higher-order functions and operations on callable objects
• xoutil.html – Helpers for manipulating HTML.
  • Sub-modules on this package
• xoutil.inspect – Inspect live objects
• xoutil.iterators - Functions creating iterators for efficient looping
• xoutil.json - Encode and decode the JSON format
• xoutil.logger - Standard logger helpers
• xoutil.modules – Utilities for working with modules
• xoutil.names – Utilities for handling objects names
  • Use cases for getting the name of an object
• xoutil.objects - Functions for dealing with objects
• xoutil.params – Function signatures
• xoutil.pprint – Extension to the data pretty printer.
• xoutil.progress - Console progress utils
• xoutil.records - Records definitions.
  • Included reader builders
• xoutil.string - Common string operations.
• xoutil.subprocess - Extensions to subprocess stardard module
• xoutil.textwrap – Text wrapping and filling.
• xoutil.threading – Higher-level threading interface
• xoutil.types - Names for built-in types and extensions.
  • Importing Unset and ignored
• xoutil.cli – Command line application facilities
  • Applications
  • Tools
• xoutil.decorator.development - Decorators for development annotations
• xoutil.decorator.meta - Decorator-making facilities
• xoutil.eight – Extensions for writing code that runs on Python 2 and 3
  • Tools
• xoutil.fs.path – Path utilities
• xoutil.html.entities – Definitions of HTML general entities.
• xoutil.html.parser – A simple parser that can handle HTML and XHTML.
• xoutil.validators.identifiers – Simple identifiers validators
• Other utils
• Changelog
  • 1.7 series
  • 1.6 series
  • 1.5 series
  • 1.4 series
  • 1.3 series
  • 1.2 series
  • 1.1 series
  • 1.0 series
• Work plans (backlogs)
  • Python 2 and 3 Compatibility
  • All pending tasks listed
• How to contribute to xoutil
  • Testing
  • Documentation
  • Versioning and deprecation
  • Module layout and rules
• List of contributors
• Copyright and Licence
  • License Terms

Indices and tables

• Index
• Search Page