Module Hierarchy

• lyntin: Lyntin is an open-source mud client framework written in Python which allows for additional functionality to be written in Python as Lyntin modules.
  • ansi: This holds a series of classes and functions for helping to manipulate ANSI color codes.
  • argparser: This provides the ArgumentParser class which parses command arguments automatically into a dictionary as well as a series of Parser classes which handle single arguments and TypeCheckers which handle validating user input values and converting them into other types (string -> int...).
  • commandmanager: Lyntin comes with a series of commands for manipulating aliases, actions, highlights, and various other things.
  • config: This module holds the configuration manager as well as a series of configuration type classes.
  • constants: Holds constants which will get used through the code-base as well as in various Lyntin modules.
  • engine: This holds the engine which both contains most of the other objects that do work in Lyntin as well as encapsulates the event queue, event handling methods, and some of the other singleton managers such as the HelpManager and the CommandManager.
  • event: Holds the event structures in Lyntin.
  • exported: This is the API for lyntin internals and is guaranteed to change very rarely even though we might change Lyntin's internals.
  • helpmanager: Lyntin has a comprehensive help system that can be accessed in-game through the "#help" command.
  • history: The HistoryManager keeps track of the last 1000 lines of user input history.
  • manager: Managers manage things.
  • net: This holds the SocketCommunicator class which handles socket connections with a mud and polling the connection for data.
  • session: Holds the functionality involved in sessions.
  • ui: This is the ui package.
    • base: Holds the base ui class for Lyntin as well as the get_ui function
    • message: Holds the ui's Message class.
  • utils: This has a series of utility functions that aren't related to classes in the application, but are useful in a variety of places.

Class Hierarchy

• exceptions.Exception: Common base class for all exceptions.
  • lyntin.exported.DoneSpammingException
  • lyntin.argparser.ParserException
  • lyntin.exported.StopSpammingException: This is what you raise when you're implementing a handler hook and you've handled the data.
• lyntin.argparser.ArgumentParser: This is the actual ArgumentParser class.
• lyntin.argparser.Parser: This is the base class for the parsers that argumentparser uses to actually populate the dictionary with each argument.
  • lyntin.argparser.ExtraIndexParser: This class captures the parsing behaviour for an index collector.
  • lyntin.argparser.ExtraNamedParser: This class captures the parsing behaviour for a named value collector.
• lyntin.argparser.TypeChecker: Trivial base class for argument checkers
  • lyntin.argparser.BooleanChecker: Accept only boolean values using the utils.convert_boolean function.
  • lyntin.argparser.BooleanOrNoneChecker: Accept only boolean values or special "not specified" values.
  • lyntin.argparser.ChoiceChecker: Allows for a value to come from a selection of different strings.
  • lyntin.argparser.EvalChecker: Evaluate its input argument as python code and return the resulting object.
  • lyntin.argparser.IntChecker: Accept only integer values and return integer objects.
  • lyntin.argparser.ReChecker: Compiles the incoming argument as a regular expression.
  • lyntin.argparser.StringChecker: Essentiallly the same as the trivial base class, but it's explicit that we just return the string we take in without any transformation.
  • lyntin.argparser.TimeChecker: Accepts a date specification.
  • lyntin.argparser.TimeSpanChecker: Accepts an amount of time and converts it to a number of seconds.
• lyntin.config.ConfigBase: A ConfigDataBase subclass encapsulates a piece of configuration.
  • lyntin.config.BoolConfig: Holds a boolean value.
  • lyntin.config.CharConfig: Holds a single character.
  • lyntin.config.IntConfig: Holds an int.
  • lyntin.config.StringConfig: Holds a string.
• lyntin.engine.Engine: This is the engine class.
• lyntin.event.Event: This is the basic Event class.
  • lyntin.event.InputEvent: A user input event is created whenever the user types something into their ui and it creates a user event from it.
  • lyntin.event.MudEvent: A mud event is when the connected mud sends data to us.
  • lyntin.event.OutputEvent: Sometimes it's necessary to put data that's going to the ui into an event so that it is displayed in the correct order.
  • lyntin.event.ShutdownEvent: This calls sys.exit(0) which will trigger the Python atexit stuff.
  • lyntin.event.SpamEvent: Certain things can kick off a call to spam a hook.
• lyntin.manager.Manager: Base manager class for managing things in Lyntin.
  • lyntin.commandmanager.CommandManager: The CommandManager holds a series of _CommandData objects and methods to manipulate and use them.
  • lyntin.config.ConfigManager: Holds all the configuration pieces for Lyntin.
  • lyntin.helpmanager.HelpManager: The HelpManager exists on the engine scoping--there is only one per Lyntin instance.
  • lyntin.history.HistoryManager: Manages user data history.
• lyntin.net.SocketCommunicator: The SocketCommunicator handles all incoming and outgoing data from and to the mud, telnet control codes, and some data transformations.
• lyntin.session.Session: A session is a nice container of all the stuff that encompasses a user session: aliases, actions, commands...
• lyntin.ui.base.BaseUI: Base ui class.
• lyntin.ui.message.Message: Encapsulates a message to be written to the user.
• lyntin.utils.PriorityQueue: This is a pretty basic priority queue.