The instrospection module

A tool for parsing instrument modules.

Classes

Module

class src.tools.instrospection.Module(filename)

The class containing the entire contents of the module.

Docstring

class src.tools.instrospection.Docstring(text)

A class to contain docstrings.

Parameters :

text : str

The text for the docstring.

Methods

toCode()

Return the text of the docstring.

Returns :

str :

The new docstring.

Imports

class src.tools.instrospection.Imports(text)

The collection of imports.

Methods

Import

class src.tools.instrospection.Import(information)

A single import command.

Methods

Constants

class src.tools.instrospection.Constants

The constants defined in the module.

Instrument

class src.tools.instrospection.Instrument

An instrument class

Function

class src.tools.instrospection.Function

A module-level function.

Functions

src.tools.instrospection.compare(stringA, stringB)

Compare two import strings for sorting.

Parameters :

stringA : str

The first import string.

stringB : str

The import string to compare with the first.

Returns :

int :

An integer representing how the first import string compares to the second. If the first is smaller, the returned value is -1. If the two are the same, 0 is returned. Otherwise, +1 is returned.