API Reference for Enthought Tool Suite 3.0.1

Classes

• Bunch - Often we want to just collect a bunch of stuff together, naming each item of the bunch; a dictionary's OK for that, but a small do- nothing class is even handier, and prettier to use
• Null - Null objects always and reliably "do nothing."
• RingBuffer - class that implements a not-yet-full buffer
• silent_list - override repr when returning a list of matplotlib artists to prevent long, meaningless output
• Sorter - Sort by attribute or item

  Example usage: sort = Sorter()

  list = [(1, 2), (4, 8), (0, 3)] dict = [{'a': 3, 'b': 4}, {'a': 5, 'b': 2}, {'a': 0, 'b': 0}, {'a': 9, 'b': 9}]

  sort(list) # default sort sort(list, 1) # sort by index 1 sort(dict, 'a') # sort a list of dicts by key 'a'

• Stack - Implement a stack where elements can be pushed on and you can move back and forth
• Xlator - All-in-one multiple-string-substitution class

  Example usage:

  text = "Larry Wall is the creator of Perl" adict = { "Larry Wall" : "Guido van Rossum", "creator" : "Benevolent Dictator for Life", "Perl" : "Python", }

  print multiple_replace(adict, text)

  xlat = Xlator(adict) print xlat.xlat(text)

Function summary

• allequal(seq)
• allpairs(x)
• alltrue(seq)
• dict_delall(d, keys)
• exception_to_str(s = None)
• finddir(o, match, case = False)
• flatten(seq, scalarp = is_scalar)
• get_recursive_filelist(args)
• get_split_ind(seq, N)
• is_file_like(obj)
• is_scalar(obj)
• is_string_like(obj)
• iterable(obj)
• listFiles(root, patterns = '*', recurse = 1, return_folders = 0)
• mkdirs(newdir, mode = 511)
• onetrue(seq)
• pieces(seq, num = 2)
• popall(seq)
• popd(d, *args)
• reverse_dict(d)
• soundex(name, len = 4)
• strip_math(s)
• unique(x)
• wrap(prefix, text, cols)

Functions

• allequal(seq)

  return true if all elements of seq compare equal. If seq is 0 or 1 length, return True

• allpairs(x)

  Return all possible pairs in sequence x

  Condensed by Alex Martelli from this thread on comp.lang.python:

  http://groups.google.com/groups?q=all+pairs+group:*python*&hl=en&lr=&ie=UTF-8&selm=mailman.4028.1096403649.5135.python-list%40python.org&rnum=1
  

• alltrue(seq)
• dict_delall(d, keys)

  delete all of the keys from the dict d

• exception_to_str(s = None)
• finddir(o, match, case = False)

  return all attributes of o which match string in match. if case is True require an exact case match.

• flatten(seq, scalarp = is_scalar)

  this generator flattens nested containers such as

  >>> l=( ('John', 'Hunter'), (1,23), [[[[42,(5,23)]]]])
  

  so that

  >>> for i in flatten(l): print i,
  John Hunter 1 23 42 5 23
  

  By: Composite of Holger Krekel and Luther Blissett From: http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/121294 and Recipe 1.12 in cookbook

• get_recursive_filelist(args)

  Recurs all the files and dirs in args ignoring symbolic links and return the files as a list of strings

• get_split_ind(seq, N)

  seq is a list of words. Return the index into seq such that len(' '.join(seq[:ind])<=N

• is_file_like(obj)
• is_scalar(obj)
• is_string_like(obj)
• iterable(obj)
• listFiles(root, patterns = '*', recurse = 1, return_folders = 0)

  Recursively list files from Parmar and Martelli in the Python Cookbook

• mkdirs(newdir, mode = 511)
• onetrue(seq)
• pieces(seq, num = 2)

  Break up the seq into num tuples

• popall(seq)

  empty a list

• popd(d, *args)

  Should behave like python2.3 pop method; d is a dict

  # returns value for key and deletes item; raises a KeyError if key # is not in dict val = popd(d, key)

  # returns value for key if key exists, else default. Delete key, # val item if it exists. Will not raise a KeyError val = popd(d, key, default)

• reverse_dict(d)

  reverse the dictionary -- may lose data if values are not uniq!

• soundex(name, len = 4)

  soundex module conforming to Odell-Russell algorithm

• strip_math(s)

  remove latex formatting from mathtext

• unique(x)

  Return a list of unique elements of x

• wrap(prefix, text, cols)

  wrap text with prefix at length cols

Imported Names

© Copyright 2002-2008 Enthought, Inc.