clearpath::__main__ Namespace Reference

Module. More...

Functions
def	__main
	List Installed Modules.
def	list_modules
	Module Listing.
Variables
string	__revision__ = "$Revision: 634 $"
	SVN Code Revision.
string	__version__ = "1.0"
	Module Version.

---

Detailed Description

Module.

Clearpath Robotics Modules Listing

Python Script for listing installed Clearpath python modules.

Author:

Malcolm Robert

Date:

24/03/10

Version:

1.0

USE

This module, the main script for the clearpath package, provides the user with a list of installed Clearpath Robotics, Inc. modules, their versions, and whether the module can run as a script (x) or just a module (m). Because this script imports modules as it searches, only modules compatible with the version of Python you are running will be listed.

This script is executed by running 'python -m clearpath' for Python 2.7+ and Python 3.1+ or 'python -m clearpath.__main__' for Python 2.6- and Python 3.0.

HISTORY

Version 1.0

• Initial Creation
• Python 2.5+ & 3.x compatible

License

---

Function Documentation

def clearpath.__main__.__main

(

)

[private]

List Installed Modules.

Main Program for Clearpath Robotics, Inc. package

• Gets a tree list of installed clearpath modules and their versions
• Prints the list to stdout

List Installed Modules.

Definition at line 220 of file __main__.py.

def clearpath.__main__.list_modules	(		package,
			prefix = '',
			pos = 0
	)

Module Listing.

List Installed Modules

Lists installed modules within the given package. List format is similar to the Unix program tree.

Parameters:

package	The name of the package to list
prefix	The string to put at the start of each line
pos	The location of the package: 0 - head, 1 - middle, 2 - tail

Returns:

list of tuple(line,version,is_script) in the display order

List Installed Modules.

Definition at line 141 of file __main__.py.

---

Variable Documentation

string clearpath::__main__::__revision__ = "$Revision: 634 $"

SVN Code Revision.

Definition at line 119 of file __main__.py.

string clearpath::__main__::__version__ = "1.0"

Module Version.

Definition at line 116 of file __main__.py.