ReFreSH.MobileSuit.Core package

Subpackages

• ReFreSH.MobileSuit.Core.Middlewares package
  • Submodules
  • ReFreSH.MobileSuit.Core.Middlewares.AppShellMiddleware module
    • AppShellMiddleware
      • AppShellMiddleware.InvokeAsync()
  • ReFreSH.MobileSuit.Core.Middlewares.FinalizeMiddleware module
    • FinalizeMiddleware
      • FinalizeMiddleware.InvokeAsync()
  • ReFreSH.MobileSuit.Core.Middlewares.HostShellMiddleware module
    • HostShellMiddleware
      • HostShellMiddleware.InvokeAsync()
  • ReFreSH.MobileSuit.Core.Middlewares.PromptMiddleware module
    • PromptMiddleware
      • PromptMiddleware.InvokeAsync()
  • ReFreSH.MobileSuit.Core.Middlewares.UserInputMiddleware module
    • Operation
    • SplitCommandLine()
    • StackOp
      • StackOp.None_
      • StackOp.Pop
      • StackOp.Push1
      • StackOp.Push1Then2
      • StackOp.Push2
      • StackOp.Push3
    • UserInputMiddleware
      • UserInputMiddleware.InvokeAsync()
  • Module contents
• ReFreSH.MobileSuit.Core.Services package
  • Submodules
  • ReFreSH.MobileSuit.Core.Services.AppInfo module
    • ISuitAppInfo
      • ISuitAppInfo.AppName
      • ISuitAppInfo.StartArgs
    • SuitAppInfo
      • SuitAppInfo.AppName
      • SuitAppInfo.StartArgs
  • ReFreSH.MobileSuit.Core.Services.HistoryService module
    • HistoryService
      • HistoryService.Response
      • HistoryService.Status
    • IHistoryService
      • IHistoryService.Response
      • IHistoryService.Status
  • ReFreSH.MobileSuit.Core.Services.IOHub module
    • IOHub
      • IOHub.AppendTimeStamp()
      • IOHub.AppendWriteLinePrefixInternal()
      • IOHub.AppendWriteLinePrefixPrimary()
      • IOHub.ClearWriteLinePrefix()
      • IOHub.ColorSetting
      • IOHub.ErrorStream
      • IOHub.FormatPrompt
      • IOHub.GetLinePrefix()
      • IOHub.Input
      • IOHub.IsErrorRedirected
      • IOHub.IsInputRedirected
      • IOHub.IsOutputRedirected
      • IOHub.Options
      • IOHub.Output
      • IOHub.Peek()
      • IOHub.Read()
      • IOHub.ReadLinePrimary()
      • IOHub.ReadToEnd()
      • IOHub.ResetError()
      • IOHub.ResetInput()
      • IOHub.ResetOutput()
      • IOHub.SubtractWriteLinePrefix()
      • IOHub.WriteInternal()
      • IOHub.WritePrimary()
    • IOHub4Bit
      • IOHub4Bit.BackgroundCodeOf()
      • IOHub4Bit.ConsoleColorOf()
      • IOHub4Bit.ForegroundCodeOf()
      • IOHub4Bit.WriteInternal()
    • PureTextIOHub
      • PureTextIOHub.WritePrimary()
  • ReFreSH.MobileSuit.Core.Services.ParsingService module
    • IParsingService
      • IParsingService.Add()
      • IParsingService.AddName()
      • IParsingService.AddParser()
      • IParsingService.Get()
    • ParsingService
      • ParsingService.Add()
      • ParsingService.AddName()
      • ParsingService.AddParser()
      • ParsingService.Get()
  • ReFreSH.MobileSuit.Core.Services.PromptFormatter module
    • PromptFormatter
    • PromptFormatters
      • PromptFormatters.BasicPromptFormatter()
      • PromptFormatters.Cross
      • PromptFormatters.Lightning
      • PromptFormatters.PowerLineFormatter()
      • PromptFormatters.RightArrow
      • PromptFormatters.RightTriangle
  • ReFreSH.MobileSuit.Core.Services.SuitAppShell module
    • SuitAppShell
      • SuitAppShell.Execute()
      • SuitAppShell.FromClients()
      • SuitAppShell.MayExecute()
      • SuitAppShell.MemberCount
      • SuitAppShell.Members()
  • ReFreSH.MobileSuit.Core.Services.SuitCommandServer module
    • SuitCommandServer
      • SuitCommandServer.ChDir()
      • SuitCommandServer.ClearCompleted()
      • SuitCommandServer.Dir()
      • SuitCommandServer.ExitSuit()
      • SuitCommandServer.Join()
      • SuitCommandServer.ListCommands()
      • SuitCommandServer.ListMembersAsync()
      • SuitCommandServer.Stop()
      • SuitCommandServer.SuitHelp()
      • SuitCommandServer.Tasks()
  • ReFreSH.MobileSuit.Core.Services.SuitExceptionHandler module
    • ISuitExceptionHandler
      • ISuitExceptionHandler.InvokeAsync()
    • SuitExceptionHandler
      • SuitExceptionHandler.InvokeAsync()
  • ReFreSH.MobileSuit.Core.Services.SuitHostShell module
    • SuitHostShell
      • SuitHostShell.FromCommandServer()
  • ReFreSH.MobileSuit.Core.Services.TaskService module
    • ITaskService
      • ITaskService.AddTask()
      • ITaskService.ClearCompleted()
      • ITaskService.GetTasks()
      • ITaskService.HasTask()
      • ITaskService.Join()
      • ITaskService.RunTaskImmediately()
      • ITaskService.RunningCount
      • ITaskService.Stop()
    • TaskInfo
    • TaskRecorder
      • TaskRecorder.Add()
      • TaskRecorder.Remove()
    • TaskService
      • TaskService.AddTask()
      • TaskService.ClearCompleted()
      • TaskService.GetTasks()
      • TaskService.HasTask()
      • TaskService.Join()
      • TaskService.RunTaskImmediately()
      • TaskService.RunningCount
      • TaskService.Stop()
  • Module contents

Submodules

ReFreSH.MobileSuit.Core.ColorSetting module

class ReFreSH.MobileSuit.Core.ColorSetting.ColorSetting(BackgroundColor: Color, DefaultColor: Color, PromptColor: Color, ErrorColor: Color, OkColor: Color, TitleColor: Color, InformationColor: Color, SystemColor: Color, WarningColor: Color)

Bases: IColorSetting

Color settings of a Mobile Suit.

property BackgroundColor: Color

property DefaultColor: Color

Default color. For OutputType.Default

Equals(other: IColorSetting | None) → bool

Indicates whether this instance and a specified object are equal.

Parameters:

other – The object to compare with the current instance.

property ErrorColor: Color

Prompt Color. For OutputType.Error

property InformationColor: Color

Prompt Color. For OutputType.CustomInformation

property OkColor: Color

Prompt Color. For OutputType.AllOK

property PromptColor: Color

Prompt Color. For OutputType.Prompt

property SystemColor: Color

Prompt Color. For OutputType.Information

property TitleColor: Color

Prompt Color. For OutputType.ListTitle

property WarningColor: Color

Warning color. For OutputType.Warning

class ReFreSH.MobileSuit.Core.ColorSetting.IColorSetting

Bases: ABC

Color settings of a Mobile Suit.

abstract property BackgroundColor: Color

abstract property DefaultColor: Color

Default color. For OutputType.Default

static DefaultColorSetting()

Default color settings for IOServer.

abstract property ErrorColor: Color

Prompt Color. For OutputType.Error

abstract property InformationColor: Color

Prompt Color. For OutputType.Info

abstract property OkColor: Color

Prompt Color. For OutputType.OK

abstract property PromptColor: Color

Prompt Color. For OutputType.Prompt

static SelectColor(colorSetting, otype: OutputType = OutputType.Default, customColor: Color | None = None) → Color

select color for the output type from color setting

Parameters:

• colorSetting – color setting

• otype – output type

• customColor – customized color

abstract property SystemColor: Color

Prompt Color. For OutputType.System

abstract property TitleColor: Color

Prompt Color. For OutputType.Title

abstract property WarningColor: Color

Prompt Color. For OutputType.System

ReFreSH.MobileSuit.Core.ISuitCommandServer module

class ReFreSH.MobileSuit.Core.ISuitCommandServer.ISuitCommandServer

Bases: ABC

Built-In-Command Server’s Model.

abstract ChDir(path: str) → str

Set current directory

Parameters:

path – path to set as current directory

abstract async ClearCompleted() → None

Clear all Completed Tasks.

abstract Dir() → str

Get current directory

abstract ExitSuit() → RequestStatus

Exit MobileSuit

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

Join a Running task

Parameters:

• index – index of the task to join

• context – context of the request

abstract async ListCommands(args: list[str]) → None

Show Members of the Current SuitObject

Parameters:

args – command args

abstract async Stop(index: int) → None

Stop a Running task

Parameters:

index – index of the task to stop

abstract async SuitHelp(args: list[str]) → None

Show Help of MobileSuit

Parameters:

args – command args

abstract async Tasks() → None

Get All tasks

ReFreSH.MobileSuit.Core.ISuitMiddleware module

class ReFreSH.MobileSuit.Core.ISuitMiddleware.ISuitMiddleware

Bases: ABC

A middleware of Mobile Suit.

abstract async InvokeAsync(context: SuitContext, nextStep: Callable[[SuitContext], Awaitable])

To invoke the middleware

ReFreSH.MobileSuit.Core.SuitBuildUtils module

ReFreSH.MobileSuit.Core.SuitBuildUtils.CreateConverterFactory(T, parserInfo: SuitArgParserInfo) → Callable[[SuitContext], Callable[[str], object | None]]

ReFreSH.MobileSuit.Core.SuitBuildUtils.CreateInstance(otype, s: SuitContext) → Any | None

ReFreSH.MobileSuit.Core.SuitBuildUtils.CreateInstanceWithProvider(otype, s: ServiceProvider) → Any | None

ReFreSH.MobileSuit.Core.SuitBuildUtils.GetArg(parameter: Parameter, function: Callable, arg: str | None, context: SuitContext) → tuple[object, int]

ReFreSH.MobileSuit.Core.SuitBuildUtils.GetArgs(func: Callable, args: List[str], context: SuitContext) → List[Any | None] | None

ReFreSH.MobileSuit.Core.SuitBuildUtils.GetArgsInternal(func: Callable, parameterInfo: SuitMethodParameterInfo, args: List[str], context: SuitContext) → List[Any | None] | None

ReFreSH.MobileSuit.Core.SuitBuildUtils.GetArrayArg(parameter: Parameter, function: Callable, argArray: list[str], context: SuitContext) → object

ReFreSH.MobileSuit.Core.SuitBuildUtils.GetMethodParameterInfo(func: Callable) → SuitMethodParameterInfo

ReFreSH.MobileSuit.Core.SuitContext module

class ReFreSH.MobileSuit.Core.SuitContext.SuitContext(sp: ServiceProvider)

Bases: object

Context through the lifetime of a SuitRequest(A Command)

Dispose()

Exception: Exception | None

The exception caught in the execution.

GetRequiredService(T) → Any

GetService(T) → Any | None

Properties: dict[str, object]

Properties of current request.

Request: list[str]

A command from input stream

RequestStatus: RequestStatus

The execution status of current request.

Response: str | None

Output to the output stream

ServiceProvider

The ServiceProvider who provides services through whole request.

ReFreSH.MobileSuit.Core.SuitMethodParameterInfo module

class ReFreSH.MobileSuit.Core.SuitMethodParameterInfo.SuitMethodParameterInfo

Bases: object

Parameter information of a method in MobileSuit

MaxParameterCount: int

Number of the parameters which can be passed at least.

MinParameterCount: int

Number of the parameters which can be passed at most.

NonArrayParameterCount: int

Number of the parameters which are neither array nor DynamicParameter

TailParameterType: TailParameterType

Type of the last parameter

class ReFreSH.MobileSuit.Core.SuitMethodParameterInfo.TailParameterType(value)

Bases: IntEnum

Represents type of the last parameter of a method

Array = 1

Last parameter is an array.

NoParameter = -1

Last parameter does not exist.

Normal = 0

Last parameter exists, and is quite normal.

ReFreSH.MobileSuit.Core.SuitMethodShell module

class ReFreSH.MobileSuit.Core.SuitMethodShell.SuitMethodShell(method: Callable, factory: Callable[[SuitContext], Any], absoluteName=None)

Bases: SuitShell

Object’s Member which may be a method.

CanFitTo(argumentCount: int) → bool

async Execute(context: SuitContext)

Execute this object.

Parameters:

context – The arguments for execution.

Returns:

The result of executing this object

classmethod FromDelegate(methodName, delegate: Callable)

classmethod FromInstance(method: Callable, factory: Callable[[SuitContext], Any])

MayExecute(request: List[str]) → bool

Detect whether this IExecutable may execute the command.

property MemberCount

ReFreSH.MobileSuit.Core.SuitObjectShell module

class ReFreSH.MobileSuit.Core.SuitObjectShell.ISuitShellCollection

Bases: ABC

A collection contains ordered suit shell members.

abstract Members() → Iterable[SuitShell]

Ordered members of this

class ReFreSH.MobileSuit.Core.SuitObjectShell.SuitObjectShell(typedef, factory: Callable[[SuitContext], Any], info, name)

Bases: SuitShell, ISuitShellCollection

Represents an object in Mobile Suit.

AddMethod(method)

AddProperty(name: str, prop: property)

async Execute(context: SuitContext)

Execute this object.

Parameters:

context – The arguments for execution.

Returns:

The result of executing this object

classmethod FromInstance(typedef, instanceFactory, name='')

classmethod FromInstanceProperty(name, prop, instanceFactory) → Optional

classmethod FromType(typedef, name='')

static GetMemberInfo(sh) → str

MayExecute(request: List[str]) → bool

Detect whether this IExecutable may execute the command.

property MemberCount

Members()

Ordered members of this

ReFreSH.MobileSuit.Core.SuitParser module

class ReFreSH.MobileSuit.Core.SuitParser.SuitParser(name: str, parser: Callable[[str], T | None])

Bases: Generic[T]

A data parser of MobileSuit

classmethod FromConverter(_T, converter: Callable[[str], T | None], name='')

Create a mobile suit parser from a converter

Parameters:

• _T

• converter – The converter method

• name – Name of the parser, if set empty, the parser will be default.

classmethod FromName(_T, name)

Create a mobile suit parser from a func and given type

Parameters:

name – Name of the parser, if set empty, the parser will be default.

Name

Name of the Parser

Parser

The parser which convert string argument to certain type.

property TargetType: Type

ReFreSH.MobileSuit.Core.SuitShell module

class ReFreSH.MobileSuit.Core.SuitShell.MemberType(value)

Bases: IntEnum

Type of member

FieldWithInfo = 1

A Field/Property with customized information

FieldWithoutInfo = -2

A Field/Property without customized information

MethodWithInfo = 0

A Method with customized information

MethodWithoutInfo = -1

A Method without customized information

class ReFreSH.MobileSuit.Core.SuitShell.SuitShell(member, instance_factory: Callable[[SuitContext], Any], absoluteName=None)

Bases: ABC

A SuitObject’s member.

AbsoluteName

Absolute name of this member.

Aliases

Aliases of this member.

abstract async Execute(context: SuitContext)

Execute this object.

Parameters:

context – The arguments for execution.

Returns:

The result of executing this object

FriendlyNames

Absolute name, and aliases.

GetInstance(context: SuitContext) → Any

Instance which contains this member.

property Information: str

Information of this member, customized or generated by Mobile Suit.

abstract MayExecute(request: List[str]) → bool

Detect whether this IExecutable may execute the command.

Type: MemberType

Type of the member

ReFreSH.MobileSuit.Core.TestSuitMethodShell2 module

class ReFreSH.MobileSuit.Core.TestSuitMethodShell2.TestSuitMethodShell(methodName='runTest')

Bases: TestCase

async execute_method_async()

setUp()

Hook method for setting up the test fixture before exercising it.

test_execute_method()

test_may_execute()

test_member_count()

Module contents

class ReFreSH.MobileSuit.Core.RequestStatus

Bases: object