ReFreSH.MobileSuit.Core.Services package

Submodules

ReFreSH.MobileSuit.Core.Services.AppInfo module

class ReFreSH.MobileSuit.Core.Services.AppInfo.ISuitAppInfo

Bases: ABC

provides basic info of App.

abstract property AppName: str

Name of application.

abstract property StartArgs: list[str]

Arguments for startup.

class ReFreSH.MobileSuit.Core.Services.AppInfo.SuitAppInfo

Bases: ISuitAppInfo

provides basic info of App.

property AppName: str

Name of application.

property StartArgs: list[str]

Arguments for startup.

ReFreSH.MobileSuit.Core.Services.HistoryService module

class ReFreSH.MobileSuit.Core.Services.HistoryService.HistoryService

Bases: IHistoryService

property Response: str | None

Response of last Request.

property Status: RequestStatus

Status of last Request.

class ReFreSH.MobileSuit.Core.Services.HistoryService.IHistoryService

Bases: ABC

Provides request history.

abstract property Response: str | None

Response of last Request.

abstract property Status: RequestStatus

Status of last Request.

ReFreSH.MobileSuit.Core.Services.IOHub module

class ReFreSH.MobileSuit.Core.Services.IOHub.IOHub(promptFormatter: Callable[[Iterable[PrintUnit]], Iterable[PrintUnit]], configurator: Callable[[IIOHub], None])

Bases: IIOHub, ABC

An entity, which serves the input/output of a mobile suit.

static AppendTimeStamp(sb: List[str]) → None

AppendWriteLinePrefixInternal(prefix: PrintUnit) → None

AppendWriteLinePrefixPrimary(prefix: Iterable) → None

Append a str to Prefix, usually used to increase indentation

ClearWriteLinePrefix() → None

Clear the prefix before writing line.

property ColorSetting: IColorSetting

Color settings for this IOServer. (default DefaultColorSetting)

property ErrorStream: TextIO

Error stream (default stderr)

property FormatPrompt: Callable[[Iterable[PrintUnit]], Iterable[PrintUnit]]

Prompt server for the io server.

GetLinePrefix(otype: OutputType) → List[PrintUnit]

Get the prefix before writing line.

property Input: TextIO

Input stream (default stdin)

property IsErrorRedirected: bool

Check if this IOServer’s error stream is redirected (NOT stderr)

property IsInputRedirected: bool

Checks if this IOServer’s input stream is redirected (NOT stdin)

property IsOutputRedirected: bool

Check if this IOServer’s output stream is redirected (NOT stdout)

property Options: IOOptions

Disable Time marks which shows in Output-Redirected Environment.

property Output: TextIO

Output stream (default stdout)

Peek() → <module 'pyasn1.type.char' from '/opt/hostedtoolcache/Python/3.9.20/x64/lib/python3.9/site-packages/pyasn1/type/char.py'>

Reads the next character from input stream without changing the state of the reader or the character source.

Returns:

The next available character.

Read() → <module 'pyasn1.type.char' from '/opt/hostedtoolcache/Python/3.9.20/x64/lib/python3.9/site-packages/pyasn1/type/char.py'>

Reads the next character from input stream.

Returns:

The next available character.

ReadLinePrimary() → str

Reads a line from input stream, with prompt.

Returns:

Content from input stream, None if EOF

ReadToEnd() → str

Reads all characters from the current position to the end of the input stream and returns them as one string.

Returns:

All characters from the current position to the end.

ResetError() → None

Reset this IOServer’s error stream to stderr

ResetInput() → None

Reset this IOServer’s input stream to stdin

ResetOutput() → None

Reset this IOServer’s output stream to stdout

SubtractWriteLinePrefix() → None

Subtract a str from Prefix, usually used to decrease indentation

WriteInternal(content: PrintUnit) → None

WritePrimary(content: Iterable) → None

Writes some content to output stream, with line break. With certain Input/Output color.

class ReFreSH.MobileSuit.Core.Services.IOHub.IOHub4Bit(promptFormatter: Callable[[Iterable[PrintUnit]], Iterable[PrintUnit]], configurator: Callable[[IIOHub], None])

Bases: IOHub

IO hub using 4-bit color output.

static BackgroundCodeOf(c: Color) → int

static ConsoleColorOf(color: Color) → ConsoleColor

static ForegroundCodeOf(c: Color) → int

WriteInternal(content: PrintUnit) → None

Write content to the output stream.

class ReFreSH.MobileSuit.Core.Services.IOHub.PureTextIOHub(promptFormatter: Callable[[Iterable[PrintUnit]], Iterable[PrintUnit]], configurator: Callable[[IIOHub], None])

Bases: IOHub

IO hub with pure text output.

WritePrimary(content: Iterable) → None

Write content to the output stream.

ReFreSH.MobileSuit.Core.Services.ParsingService module

class ReFreSH.MobileSuit.Core.Services.ParsingService.IParsingService

Bases: ABC

Get parsers for certain type.

abstract Add(_T, converter: Callable[[str], T], name: str = '') → None

Add a parser with certain name to parsing service.

Parameters:

• _T

• converter

• name

abstract AddName(_T: Type, name: str = '') → None

Add a parser.

Parameters:

• _T

• name

abstract AddParser(parser: SuitParser[T]) → None

Add a parser.

Parameters:

parser

abstract Get(type: Type, name: str = '') → Callable[[str], object]

Get a parser for certain type with certain name.

Parameters:

• type – certain type

• name – certain name

Returns:

class ReFreSH.MobileSuit.Core.Services.ParsingService.ParsingService

Bases: IParsingService

Add(_T: Type, converter: Callable[[str], T], name: str = '') → None

Add a parser with certain name to parsing service.

Parameters:

• _T

• converter

• name

AddName(_T: Type, name: str = '') → None

Add a parser.

Parameters:

• _T

• name

AddParser(parser: SuitParser[T]) → None

Add a parser.

Parameters:

parser

Get(type: Type, name: str = '') → Callable[[str], object]

Get a parser for certain type with certain name.

Parameters:

• type – certain type

• name – certain name

Returns:

ReFreSH.MobileSuit.Core.Services.PromptFormatter module

ReFreSH.MobileSuit.Core.Services.PromptFormatter.PromptFormatter

represents a generator provides prompt output.

alias of Callable[[Iterable[PrintUnit]], Iterable[PrintUnit]]

class ReFreSH.MobileSuit.Core.Services.PromptFormatter.PromptFormatters

Bases: object

Default prompt formatters.

static BasicPromptFormatter(origin: Iterable[PrintUnit]) → Iterable[PrintUnit]

A basic prompt formatter for Mobile Suit.

Cross = '⨯'

a cross ⨯ char

Lightning = '⚡'

a lightning ⚡ char

static PowerLineFormatter(origin: Iterable[PrintUnit]) → Iterable[PrintUnit]

A PowerLine themed prompt generator

RightArrow = '\ue0b1'

a right arrow  char

RightTriangle = '\ue0b0'

a right triangle  char

ReFreSH.MobileSuit.Core.Services.SuitAppShell module

class ReFreSH.MobileSuit.Core.Services.SuitAppShell.SuitAppShell

Bases: SuitShell, ISuitShellCollection

SuitShell for Client App.

async Execute(context: SuitContext) → None

Inherited from base class.

classmethod FromClients(clients: Iterable[SuitShell]) → SuitAppShell

MayExecute(request: List[str]) → bool

Inherited from base class.

property MemberCount: int

Inherited from base class.

Members() → Iterable[SuitShell]

Ordered members of this

ReFreSH.MobileSuit.Core.Services.SuitCommandServer module

class ReFreSH.MobileSuit.Core.Services.SuitCommandServer.SuitCommandServer(io: IIOHub, app: SuitAppShell, host: SuitHostShell, taskService: ITaskService)

Bases: ISuitCommandServer

Built-In-Command Server. May be Override if necessary.

ChDir(path: str) → str

Inherited from base class.

async ClearCompleted() → None

Inherited from base class.

Dir() → str

Inherited from base class.

ExitSuit() → RequestStatus

Inherited from base class.

async Join(index: int, context: SuitContext) → str | None

Inherited from base class.

async ListCommands(args: List[str]) → None

Inherited from base class.

async ListMembersAsync(suitObject: ISuitShellCollection) → None

List members of a SuitObject

async Stop(index: int) → None

Inherited from base class.

async SuitHelp() → None

Inherited from base class.

async Tasks() → None

Inherited from base class.

ReFreSH.MobileSuit.Core.Services.SuitExceptionHandler module

class ReFreSH.MobileSuit.Core.Services.SuitExceptionHandler.ISuitExceptionHandler

Bases: ABC

The handler

abstract async InvokeAsync(context: SuitContext)

To invoke the middleware

Args:

context: Context of the request.

class ReFreSH.MobileSuit.Core.Services.SuitExceptionHandler.SuitExceptionHandler(history: IHistoryService, io: IIOHub)

Bases: ISuitExceptionHandler

async InvokeAsync(context: SuitContext)

To invoke the middleware

Args:

context: Context of the request.

ReFreSH.MobileSuit.Core.Services.SuitHostShell module

class ReFreSH.MobileSuit.Core.Services.SuitHostShell.SuitHostShell(otype: Type, factory: Callable[[SuitContext], Any], info: str)

Bases: SuitObjectShell

A SuitShell over SuitServer

classmethod FromCommandServer(serverType: Type) → SuitHostShell

Create a Host shell from command server.

ReFreSH.MobileSuit.Core.Services.TaskService module

class ReFreSH.MobileSuit.Core.Services.TaskService.ITaskService

Bases: ABC

Provides task system.

AddTask(task: Task, context: SuitContext) → None

Add a task to Task Collection

ClearCompleted() → None

Remove the completed tasks.

GetTasks() → Iterable[TaskInfo]

Get All tasks in Collection.

HasTask(index: int) → bool

Has a task with given index

async Join(index: int, newContext: SuitContext) → None

Join the task with certain index.

async RunTaskImmediately(task: Task) → None

Run some task immediately

property RunningCount: int

Number of Tasks that are running.

Stop(index: int) → None

Stop the task with certain index.

class ReFreSH.MobileSuit.Core.Services.TaskService.TaskInfo

Bases: object

Information of Suit Task

class ReFreSH.MobileSuit.Core.Services.TaskService.TaskRecorder

Bases: Iterable

Add(task: Task) → bool

Remove(task: Task) → bool

class ReFreSH.MobileSuit.Core.Services.TaskService.TaskService(cancelTasks: TaskRecorder)

Bases: ITaskService

AddTask(task: Task, context: SuitContext) → None

Add a task to Task Collection

ClearCompleted() → None

Remove the completed tasks.

GetTasks() → Iterable[TaskInfo]

Get All tasks in Collection.

HasTask(index: int) → bool

Has a task with given index

async Join(index: int, newContext: SuitContext) → None

Join the task with certain index.

async RunTaskImmediately(task: Task) → None

Run some task immediately

property RunningCount: int

Number of Tasks that are running.

Stop(index: int) → None

Stop the task with certain index.

Module contents