API Reference for Enthought Tool Suite 3.2.0

Function summary

• create_unique_name(prefix, names, separator = '_')
• find_resource(project, resource_path, alt_path = None, return_path = False)
• get_path(path)
• store_resource(project, resource_path, filename)

Functions

• create_unique_name(prefix, names, separator = '_')

  Creates a name starting with 'prefix' that is not in 'names'.

• find_resource(project, resource_path, alt_path = None, return_path = False)

  Returns a file object or file path pointing to the desired resource.

  Parameters

  project : string

  The name of the project to look for the resource in. Can be the name or a requirement string. Ex: 'MyProject', 'MyProject>1.0', 'MyProject==1.1'

  resource_path : string

  The path to the file from inside the package. If the file desired is MyProject/data/image.jpg, resource_path would be 'data/image.jpg'.

  alt_path : string

  The path to the resource relative to the location of the application's top-level script (the one with __main__). If this function is called in code/scripts/myscript.py and the resource is code/data/image.jpg, the alt_path would be '../data/image.jpg'. This path is only used if the resource cannot be found using setuptools.

  return_path : bool

  Determines whether the function should return a file object or a full path to the resource.

  Returns

  file : file object or file path

  A file object containing the resource. If return_path is True, 'file' will be the full path to the resource. If the file is not found or cannot be opened, None is returned.

  Description

  This function will find a desired resource file and return an opened file object. The main method of finding the resource uses the pkg_resources resource_stream method, which searches your working set for the installed project specified and appends the resource_path given to the project path, leading it to the file. If setuptools is not installed or it cannot find/open the resource, find_resource will use the sys.path[0] to find the resource if alt_path is defined.

• get_path(path)

  Returns an absolute path for the specified path.

  'path' can be a string, class or instance.

• store_resource(project, resource_path, filename)

  Store the content of a resource, given by the name of the projet and the path (relative to the root of the project), into a newly created file.

  The first two arguments (project and resource_path) are the same as for the function find_resource in this module. The third argument (filename) is the name of the file which will be created, or overwritten if it already exists. The return value in always None.

Imported Names

© Copyright 2002-2009 Enthought, Inc.