modules

Package modules

[show private | hide private]

Package modules

The modules package holds all of the dynamically loaded Lyntin modules. Modules get loaded when Lyntin starts up unless:

the module throws an exception when getting imported
the module's name starts with an _

On multi-user systems, you'll want to dump modules that everyone will want to use here. Otherwise, users can put modules that they want to use in their moduledir and specify the moduledir at the command line using the -m flag.

Modules

modutils: This module holds helper functions for building other Lyntin modules.

Function Summary
string	`get_module_name(filename)` Takes in a fully qualified filename and returns the module name portion.
	`load_modules()` Magically dynamically loads all the modules in the modules package.
	`test_for_conflicts(name, module)` Tests a module we just imported with the name the path the module should have.

Function Details

get_module_name(filename)

Takes in a fully qualified filename and returns the module name portion.

example:

 /home/willg/lyntinng/modules/alias.py -> alias

Parameters:: filename - the fully qualified filename
(type=string)

Returns:: the module name
(type=string)

load_modules()

Magically dynamically loads all the modules in the modules package. This is truly a semi-magic function.

test_for_conflicts(name, module)

Tests a module we just imported with the name the path the module should have. This allows us to test Lyntin modules we just dynamically loaded to verify it's the one we intended to load.

Right now we don't really do anything except kick up an error to the user. Let them deal with the issue.

Parameters:: name - the full name of the module we wanted to load
(type=string); module - the actual module we loaded
(type=module instance)

Generated by Epydoc 1.1 on Mon Apr 28 21:11:25 2003

http://epydoc.sf.net