# botlib/bot.py
#
#

""" bot classes. """

from .error import ENOTIMPLEMENTED
from .launcher import Launcher
from .handler import Handler
from .engine import Engine
from .utils import sname

import queue

[docs]class Bot(Engine):

    """
        main bot class.

        >>> from botlib.bot import Bot
        >>> bot = Bot()
        >>> bot.connect()

    """

    cc = ""

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self._type = str(type(self))
        self._outqueue = queue.Queue()
        self.channels = [] 
        self.cfg.fromdisk(self.type)

[docs]    def announce(self, txt):
        """ print text on joined channels. """
        if self.cfg.silent:
            return
        if not self.channels:
            self.raw(txt)
        for channel in self.channels:
            self.say(channel, txt)

[docs]    def connect(self, *args, **kwargs):
        """ connect to server. """
        self._connected.ready()

[docs]    def event(self, *args, **kwargs):
        """ virtual method returning a event from the bot. """
        raise ENOTIMPLEMENTED

[docs]    def exit(self):
        self.put(None)

[docs]    def id(self, *args, **kwargs):
        return sname(self).lower() + "." + (self.cfg.server or "localhost")

[docs]    def join(self, channel):
        """ join a channel. """
        pass

[docs]    def joinall(self):
        """ join all channels. """
        for channel in self.channels:
            self.join(channel)

[docs]    def out(self, channel, txt):
        self.say(channel, txt)

[docs]    def raw(self, txt):
        """ send txt to server. """
        self._counter.raw += 1

[docs]    def prompt(self):
        """ echo prompt to sys.stdout. """
        pass

[docs]    def say(self, channel, txt):
        """ say something on a channel. """
        self.raw(str(txt).strip())

[docs]    def start(self, *args, **kwargs):
        from .space import fleet
        super().start(*args, **kwargs)
        fleet.add(self)