Source code for ReFreSH.MobileSuit.Core.ISuitCommandServer

from abc import ABC, abstractmethod
from typing import Optional

from .SuitContext import SuitContext
from ..RequestStatus import RequestStatus




class ISuitCommandServer(ABC):
    """Built-In-Command Server's Model."""



    @abstractmethod
    async def ListCommands(self, args: list[str]) -> None:
        """Show Members of the Current SuitObject
        
        :param args: command args
        """
        pass




    @abstractmethod
    def ExitSuit(self) -> RequestStatus:
        """Exit MobileSuit"""
        pass




    @abstractmethod
    async def Join(self, index: int, context: SuitContext) -> Optional[str]:
        """Join a Running task
        
        :param index: index of the task to join
        :param context: context of the request
        """
        pass




    @abstractmethod
    async def Tasks(self) -> None:
        """Get All tasks"""
        pass




    @abstractmethod
    async def Stop(self, index: int) -> None:
        """Stop a Running task
        
        :param index: index of the task to stop
        """
        pass




    @abstractmethod
    async def ClearCompleted(self) -> None:
        """Clear all Completed Tasks."""
        pass




    @abstractmethod
    def Dir(self) -> str:
        """Get current directory"""
        pass




    @abstractmethod
    def ChDir(self, path: str) -> str:
        """Set current directory
        
        :param path: path to set as current directory
        """
        pass




    @abstractmethod
    async def SuitHelp(self, args: list[str]) -> None:
        """Show Help of MobileSuit
        
        :param args: command args
        """
        pass