j_chess_lib.communication.schema package

This package contains classes created using the j-chess-xsd

Submodules

j_chess_lib.communication.schema.j_chess_message module

class j_chess_lib.communication.schema.j_chess_message.AcceptMessage(accept: Union[bool, NoneType] = None, error_type_code: Union[j_chess_lib.communication.schema.j_chess_message.ErrorType, NoneType] = None)[source]

Bases: object

accept: Optional[bool] = None
error_type_code: Optional[j_chess_lib.communication.schema.j_chess_message.ErrorType] = None
class j_chess_lib.communication.schema.j_chess_message.AwaitMoveMessage(position: Union[str, NoneType] = None, last_move: Union[j_chess_lib.communication.schema.j_chess_message.MoveData, NoneType] = None, time_control: Union[j_chess_lib.communication.schema.j_chess_message.TimeControlData, NoneType] = None)[source]

Bases: object

last_move: Optional[j_chess_lib.communication.schema.j_chess_message.MoveData] = None
position: Optional[str] = None
time_control: Optional[j_chess_lib.communication.schema.j_chess_message.TimeControlData] = None
class j_chess_lib.communication.schema.j_chess_message.DisconnectMessage(error_type_code: Union[j_chess_lib.communication.schema.j_chess_message.ErrorType, NoneType] = None)[source]

Bases: object

error_type_code: Optional[j_chess_lib.communication.schema.j_chess_message.ErrorType] = None
class j_chess_lib.communication.schema.j_chess_message.DrawResponseMessage(accept: Union[bool, NoneType] = None)[source]

Bases: object

accept: Optional[bool] = None
class j_chess_lib.communication.schema.j_chess_message.ErrorType(value)[source]

Bases: enum.Enum

An enumeration.

AWAIT_LOGIN = 'AWAIT_LOGIN'
DUPLICATE_NAME = 'DUPLICATE_NAME'
ERROR = 'ERROR'
NO_ERROR = 'NO_ERROR'
TIMEOUT = 'TIMEOUT'
TOO_MANY_TRIES = 'TOO_MANY_TRIES'
UNSUPPORTED_OPERATION = 'UNSUPPORTED_OPERATION'
VERSION_MISMATCH = 'VERSION_MISMATCH'
class j_chess_lib.communication.schema.j_chess_message.GameOverMessage(winner: Union[str, NoneType] = None, is_draw: Union[bool, NoneType] = None, pgn: Union[str, NoneType] = None)[source]

Bases: object

is_draw: Optional[bool] = None
pgn: Optional[str] = None
winner: Optional[str] = None
class j_chess_lib.communication.schema.j_chess_message.GameStartMessage(name_white: Union[str, NoneType] = None)[source]

Bases: object

name_white: Optional[str] = None
class j_chess_lib.communication.schema.j_chess_message.HeartBeatMessage[source]

Bases: object

class j_chess_lib.communication.schema.j_chess_message.JchessMessage(accept: Union[j_chess_lib.communication.schema.j_chess_message.AcceptMessage, NoneType] = None, login: Union[j_chess_lib.communication.schema.j_chess_message.LoginMessage, NoneType] = None, login_reply: Union[j_chess_lib.communication.schema.j_chess_message.LoginReplyMessage, NoneType] = None, heart_beat: Union[j_chess_lib.communication.schema.j_chess_message.HeartBeatMessage, NoneType] = None, disconnect: Union[j_chess_lib.communication.schema.j_chess_message.DisconnectMessage, NoneType] = None, match_found: Union[j_chess_lib.communication.schema.j_chess_message.MatchFoundMessage, NoneType] = None, match_over: Union[j_chess_lib.communication.schema.j_chess_message.MatchOverMessage, NoneType] = None, match_status: Union[j_chess_lib.communication.schema.j_chess_message.MatchStatusMessage, NoneType] = None, game_start: Union[j_chess_lib.communication.schema.j_chess_message.GameStartMessage, NoneType] = None, game_over: Union[j_chess_lib.communication.schema.j_chess_message.GameOverMessage, NoneType] = None, await_move: Union[j_chess_lib.communication.schema.j_chess_message.AwaitMoveMessage, NoneType] = None, move: Union[j_chess_lib.communication.schema.j_chess_message.MoveMessage, NoneType] = None, request_draw: Union[j_chess_lib.communication.schema.j_chess_message.RequestDrawMessage, NoneType] = None, draw_response: Union[j_chess_lib.communication.schema.j_chess_message.DrawResponseMessage, NoneType] = None, message_type: Union[j_chess_lib.communication.schema.j_chess_message.JchessMessageType, NoneType] = None, player_id: Union[str, NoneType] = None)[source]

Bases: object

class Meta[source]

Bases: object

name = 'JChessMessage'
accept: Optional[j_chess_lib.communication.schema.j_chess_message.AcceptMessage] = None
await_move: Optional[j_chess_lib.communication.schema.j_chess_message.AwaitMoveMessage] = None
disconnect: Optional[j_chess_lib.communication.schema.j_chess_message.DisconnectMessage] = None
draw_response: Optional[j_chess_lib.communication.schema.j_chess_message.DrawResponseMessage] = None
game_over: Optional[j_chess_lib.communication.schema.j_chess_message.GameOverMessage] = None
game_start: Optional[j_chess_lib.communication.schema.j_chess_message.GameStartMessage] = None
heart_beat: Optional[j_chess_lib.communication.schema.j_chess_message.HeartBeatMessage] = None
login: Optional[j_chess_lib.communication.schema.j_chess_message.LoginMessage] = None
login_reply: Optional[j_chess_lib.communication.schema.j_chess_message.LoginReplyMessage] = None
match_found: Optional[j_chess_lib.communication.schema.j_chess_message.MatchFoundMessage] = None
match_over: Optional[j_chess_lib.communication.schema.j_chess_message.MatchOverMessage] = None
match_status: Optional[j_chess_lib.communication.schema.j_chess_message.MatchStatusMessage] = None
message_type: Optional[j_chess_lib.communication.schema.j_chess_message.JchessMessageType] = None
move: Optional[j_chess_lib.communication.schema.j_chess_message.MoveMessage] = None
player_id: Optional[str] = None
request_draw: Optional[j_chess_lib.communication.schema.j_chess_message.RequestDrawMessage] = None
schema_version: str = '0.2.0'
class j_chess_lib.communication.schema.j_chess_message.JchessMessageType(value)[source]

Bases: enum.Enum

An enumeration.

ACCEPT = 'Accept'
AWAIT_MOVE = 'AwaitMove'
DISCONNECT = 'Disconnect'
DRAW_RESPONSE = 'DrawResponse'
GAME_OVER = 'GameOver'
GAME_START = 'GameStart'
HEART_BEAT = 'HeartBeat'
LOGIN = 'Login'
LOGIN_REPLY = 'LoginReply'
MATCH_FOUND = 'MatchFound'
MATCH_OVER = 'MatchOver'
MATCH_STATUS = 'MatchStatus'
MOVE = 'Move'
REQUEST_DRAW = 'RequestDraw'
class j_chess_lib.communication.schema.j_chess_message.LoginMessage(name: Union[str, NoneType] = None, tournament_code: Union[str, NoneType] = None)[source]

Bases: object

name: Optional[str] = None
tournament_code: Optional[str] = None
class j_chess_lib.communication.schema.j_chess_message.LoginReplyMessage(new_id: Union[str, NoneType] = None)[source]

Bases: object

new_id: Optional[str] = None
class j_chess_lib.communication.schema.j_chess_message.MatchFormatData(match_type_value: Union[j_chess_lib.communication.schema.j_chess_message.MatchTypeValue, NoneType] = None, match_type_data: Union[j_chess_lib.communication.schema.j_chess_message.MatchTypeData, NoneType] = None, time_per_side: Union[int, NoneType] = None, time_per_side_increment: Union[int, NoneType] = None, time_per_side_per_move: Union[int, NoneType] = None)[source]

Bases: object

match_type_data: Optional[j_chess_lib.communication.schema.j_chess_message.MatchTypeData] = None
match_type_value: Optional[j_chess_lib.communication.schema.j_chess_message.MatchTypeValue] = None
time_per_side: Optional[int] = None
time_per_side_increment: Optional[int] = None
time_per_side_per_move: Optional[int] = None
class j_chess_lib.communication.schema.j_chess_message.MatchFoundMessage(match_id: Union[str, NoneType] = None, enemy_name: Union[str, NoneType] = None, match_format: Union[j_chess_lib.communication.schema.j_chess_message.MatchFormatData, NoneType] = None)[source]

Bases: object

enemy_name: Optional[str] = None
match_format: Optional[j_chess_lib.communication.schema.j_chess_message.MatchFormatData] = None
match_id: Optional[str] = None
class j_chess_lib.communication.schema.j_chess_message.MatchOverMessage(match_status: Union[j_chess_lib.communication.schema.j_chess_message.MatchStatusData, NoneType] = None, match_format: Union[j_chess_lib.communication.schema.j_chess_message.MatchFormatData, NoneType] = None, statistics: Union[str, NoneType] = None)[source]

Bases: object

match_format: Optional[j_chess_lib.communication.schema.j_chess_message.MatchFormatData] = None
match_status: Optional[j_chess_lib.communication.schema.j_chess_message.MatchStatusData] = None
statistics: Optional[str] = None
class j_chess_lib.communication.schema.j_chess_message.MatchStatusData(name_player1: Union[str, NoneType] = None, name_player2: Union[str, NoneType] = None, score_player1: Union[int, NoneType] = None, score_player2: Union[int, NoneType] = None)[source]

Bases: object

name_player1: Optional[str] = None
name_player2: Optional[str] = None
score_player1: Optional[int] = None
score_player2: Optional[int] = None
class j_chess_lib.communication.schema.j_chess_message.MatchStatusMessage(match_status: Union[j_chess_lib.communication.schema.j_chess_message.MatchStatusData, NoneType] = None)[source]

Bases: object

match_status: Optional[j_chess_lib.communication.schema.j_chess_message.MatchStatusData] = None
class j_chess_lib.communication.schema.j_chess_message.MatchTypeData[source]

Bases: object

class j_chess_lib.communication.schema.j_chess_message.MatchTypeScore(amount_to_play: Union[int, NoneType] = None)[source]

Bases: j_chess_lib.communication.schema.j_chess_message.MatchTypeData

amount_to_play: Optional[int] = None
points_per_draw: int = 1
points_per_win: int = 2
class j_chess_lib.communication.schema.j_chess_message.MatchTypeValue(value)[source]

Bases: enum.Enum

An enumeration.

SCORE = 'SCORE'
WIN_X = 'WIN_X'
class j_chess_lib.communication.schema.j_chess_message.MatchTypeWinX(amount_to_win: Union[int, NoneType] = None)[source]

Bases: j_chess_lib.communication.schema.j_chess_message.MatchTypeData

amount_to_win: Optional[int] = None
class j_chess_lib.communication.schema.j_chess_message.MoveData(from_value: Union[str, NoneType] = None, to: Union[str, NoneType] = None, promotion_unit: Union[str, NoneType] = None)[source]

Bases: object

from_value: Optional[str] = None
promotion_unit: Optional[str] = None
to: Optional[str] = None
class j_chess_lib.communication.schema.j_chess_message.MoveMessage(move: Union[j_chess_lib.communication.schema.j_chess_message.MoveData, NoneType] = None)[source]

Bases: object

move: Optional[j_chess_lib.communication.schema.j_chess_message.MoveData] = None
class j_chess_lib.communication.schema.j_chess_message.RequestDrawMessage(reason: Union[j_chess_lib.communication.schema.j_chess_message.RequestDrawType, NoneType] = None)[source]

Bases: object

reason: Optional[j_chess_lib.communication.schema.j_chess_message.RequestDrawType] = None
class j_chess_lib.communication.schema.j_chess_message.RequestDrawType(value)[source]

Bases: enum.Enum

An enumeration.

FIFTY_MOVE_RULE = 'FIFTY_MOVE_RULE'
OFFER = 'OFFER'
class j_chess_lib.communication.schema.j_chess_message.TimeControlData(your_time_in_ms: Union[int, NoneType] = None, enemy_time_in_ms: Union[int, NoneType] = None)[source]

Bases: object

enemy_time_in_ms: Optional[int] = None
your_time_in_ms: Optional[int] = None

Module contents

class j_chess_lib.communication.schema.AcceptMessage(accept: Union[bool, NoneType] = None, error_type_code: Union[j_chess_lib.communication.schema.j_chess_message.ErrorType, NoneType] = None)[source]

Bases: object

accept: Optional[bool] = None
error_type_code: Optional[j_chess_lib.communication.schema.j_chess_message.ErrorType] = None
class j_chess_lib.communication.schema.AwaitMoveMessage(position: Union[str, NoneType] = None, last_move: Union[j_chess_lib.communication.schema.j_chess_message.MoveData, NoneType] = None, time_control: Union[j_chess_lib.communication.schema.j_chess_message.TimeControlData, NoneType] = None)[source]

Bases: object

last_move: Optional[j_chess_lib.communication.schema.j_chess_message.MoveData] = None
position: Optional[str] = None
time_control: Optional[j_chess_lib.communication.schema.j_chess_message.TimeControlData] = None
class j_chess_lib.communication.schema.DisconnectMessage(error_type_code: Union[j_chess_lib.communication.schema.j_chess_message.ErrorType, NoneType] = None)[source]

Bases: object

error_type_code: Optional[j_chess_lib.communication.schema.j_chess_message.ErrorType] = None
class j_chess_lib.communication.schema.DrawResponseMessage(accept: Union[bool, NoneType] = None)[source]

Bases: object

accept: Optional[bool] = None
class j_chess_lib.communication.schema.ErrorType(value)[source]

Bases: enum.Enum

An enumeration.

AWAIT_LOGIN = 'AWAIT_LOGIN'
DUPLICATE_NAME = 'DUPLICATE_NAME'
ERROR = 'ERROR'
NO_ERROR = 'NO_ERROR'
TIMEOUT = 'TIMEOUT'
TOO_MANY_TRIES = 'TOO_MANY_TRIES'
UNSUPPORTED_OPERATION = 'UNSUPPORTED_OPERATION'
VERSION_MISMATCH = 'VERSION_MISMATCH'
class j_chess_lib.communication.schema.GameOverMessage(winner: Union[str, NoneType] = None, is_draw: Union[bool, NoneType] = None, pgn: Union[str, NoneType] = None)[source]

Bases: object

is_draw: Optional[bool] = None
pgn: Optional[str] = None
winner: Optional[str] = None
class j_chess_lib.communication.schema.GameStartMessage(name_white: Union[str, NoneType] = None)[source]

Bases: object

name_white: Optional[str] = None
class j_chess_lib.communication.schema.HeartBeatMessage[source]

Bases: object

class j_chess_lib.communication.schema.JchessMessage(accept: Union[j_chess_lib.communication.schema.j_chess_message.AcceptMessage, NoneType] = None, login: Union[j_chess_lib.communication.schema.j_chess_message.LoginMessage, NoneType] = None, login_reply: Union[j_chess_lib.communication.schema.j_chess_message.LoginReplyMessage, NoneType] = None, heart_beat: Union[j_chess_lib.communication.schema.j_chess_message.HeartBeatMessage, NoneType] = None, disconnect: Union[j_chess_lib.communication.schema.j_chess_message.DisconnectMessage, NoneType] = None, match_found: Union[j_chess_lib.communication.schema.j_chess_message.MatchFoundMessage, NoneType] = None, match_over: Union[j_chess_lib.communication.schema.j_chess_message.MatchOverMessage, NoneType] = None, match_status: Union[j_chess_lib.communication.schema.j_chess_message.MatchStatusMessage, NoneType] = None, game_start: Union[j_chess_lib.communication.schema.j_chess_message.GameStartMessage, NoneType] = None, game_over: Union[j_chess_lib.communication.schema.j_chess_message.GameOverMessage, NoneType] = None, await_move: Union[j_chess_lib.communication.schema.j_chess_message.AwaitMoveMessage, NoneType] = None, move: Union[j_chess_lib.communication.schema.j_chess_message.MoveMessage, NoneType] = None, request_draw: Union[j_chess_lib.communication.schema.j_chess_message.RequestDrawMessage, NoneType] = None, draw_response: Union[j_chess_lib.communication.schema.j_chess_message.DrawResponseMessage, NoneType] = None, message_type: Union[j_chess_lib.communication.schema.j_chess_message.JchessMessageType, NoneType] = None, player_id: Union[str, NoneType] = None)[source]

Bases: object

class Meta[source]

Bases: object

name = 'JChessMessage'
accept: Optional[j_chess_lib.communication.schema.j_chess_message.AcceptMessage] = None
await_move: Optional[j_chess_lib.communication.schema.j_chess_message.AwaitMoveMessage] = None
disconnect: Optional[j_chess_lib.communication.schema.j_chess_message.DisconnectMessage] = None
draw_response: Optional[j_chess_lib.communication.schema.j_chess_message.DrawResponseMessage] = None
game_over: Optional[j_chess_lib.communication.schema.j_chess_message.GameOverMessage] = None
game_start: Optional[j_chess_lib.communication.schema.j_chess_message.GameStartMessage] = None
heart_beat: Optional[j_chess_lib.communication.schema.j_chess_message.HeartBeatMessage] = None
login: Optional[j_chess_lib.communication.schema.j_chess_message.LoginMessage] = None
login_reply: Optional[j_chess_lib.communication.schema.j_chess_message.LoginReplyMessage] = None
match_found: Optional[j_chess_lib.communication.schema.j_chess_message.MatchFoundMessage] = None
match_over: Optional[j_chess_lib.communication.schema.j_chess_message.MatchOverMessage] = None
match_status: Optional[j_chess_lib.communication.schema.j_chess_message.MatchStatusMessage] = None
message_type: Optional[j_chess_lib.communication.schema.j_chess_message.JchessMessageType] = None
move: Optional[j_chess_lib.communication.schema.j_chess_message.MoveMessage] = None
player_id: Optional[str] = None
request_draw: Optional[j_chess_lib.communication.schema.j_chess_message.RequestDrawMessage] = None
schema_version: str = '0.2.0'
class j_chess_lib.communication.schema.JchessMessageType(value)[source]

Bases: enum.Enum

An enumeration.

ACCEPT = 'Accept'
AWAIT_MOVE = 'AwaitMove'
DISCONNECT = 'Disconnect'
DRAW_RESPONSE = 'DrawResponse'
GAME_OVER = 'GameOver'
GAME_START = 'GameStart'
HEART_BEAT = 'HeartBeat'
LOGIN = 'Login'
LOGIN_REPLY = 'LoginReply'
MATCH_FOUND = 'MatchFound'
MATCH_OVER = 'MatchOver'
MATCH_STATUS = 'MatchStatus'
MOVE = 'Move'
REQUEST_DRAW = 'RequestDraw'
class j_chess_lib.communication.schema.LoginMessage(name: Union[str, NoneType] = None, tournament_code: Union[str, NoneType] = None)[source]

Bases: object

name: Optional[str] = None
tournament_code: Optional[str] = None
class j_chess_lib.communication.schema.LoginReplyMessage(new_id: Union[str, NoneType] = None)[source]

Bases: object

new_id: Optional[str] = None
class j_chess_lib.communication.schema.MatchFormatData(match_type_value: Union[j_chess_lib.communication.schema.j_chess_message.MatchTypeValue, NoneType] = None, match_type_data: Union[j_chess_lib.communication.schema.j_chess_message.MatchTypeData, NoneType] = None, time_per_side: Union[int, NoneType] = None, time_per_side_increment: Union[int, NoneType] = None, time_per_side_per_move: Union[int, NoneType] = None)[source]

Bases: object

match_type_data: Optional[j_chess_lib.communication.schema.j_chess_message.MatchTypeData] = None
match_type_value: Optional[j_chess_lib.communication.schema.j_chess_message.MatchTypeValue] = None
time_per_side: Optional[int] = None
time_per_side_increment: Optional[int] = None
time_per_side_per_move: Optional[int] = None
class j_chess_lib.communication.schema.MatchFoundMessage(match_id: Union[str, NoneType] = None, enemy_name: Union[str, NoneType] = None, match_format: Union[j_chess_lib.communication.schema.j_chess_message.MatchFormatData, NoneType] = None)[source]

Bases: object

enemy_name: Optional[str] = None
match_format: Optional[j_chess_lib.communication.schema.j_chess_message.MatchFormatData] = None
match_id: Optional[str] = None
class j_chess_lib.communication.schema.MatchOverMessage(match_status: Union[j_chess_lib.communication.schema.j_chess_message.MatchStatusData, NoneType] = None, match_format: Union[j_chess_lib.communication.schema.j_chess_message.MatchFormatData, NoneType] = None, statistics: Union[str, NoneType] = None)[source]

Bases: object

match_format: Optional[j_chess_lib.communication.schema.j_chess_message.MatchFormatData] = None
match_status: Optional[j_chess_lib.communication.schema.j_chess_message.MatchStatusData] = None
statistics: Optional[str] = None
class j_chess_lib.communication.schema.MatchStatusData(name_player1: Union[str, NoneType] = None, name_player2: Union[str, NoneType] = None, score_player1: Union[int, NoneType] = None, score_player2: Union[int, NoneType] = None)[source]

Bases: object

name_player1: Optional[str] = None
name_player2: Optional[str] = None
score_player1: Optional[int] = None
score_player2: Optional[int] = None
class j_chess_lib.communication.schema.MatchStatusMessage(match_status: Union[j_chess_lib.communication.schema.j_chess_message.MatchStatusData, NoneType] = None)[source]

Bases: object

match_status: Optional[j_chess_lib.communication.schema.j_chess_message.MatchStatusData] = None
class j_chess_lib.communication.schema.MatchTypeData[source]

Bases: object

class j_chess_lib.communication.schema.MatchTypeScore(amount_to_play: Union[int, NoneType] = None)[source]

Bases: j_chess_lib.communication.schema.j_chess_message.MatchTypeData

amount_to_play: Optional[int] = None
points_per_draw: int = 1
points_per_win: int = 2
class j_chess_lib.communication.schema.MatchTypeValue(value)[source]

Bases: enum.Enum

An enumeration.

SCORE = 'SCORE'
WIN_X = 'WIN_X'
class j_chess_lib.communication.schema.MatchTypeWinX(amount_to_win: Union[int, NoneType] = None)[source]

Bases: j_chess_lib.communication.schema.j_chess_message.MatchTypeData

amount_to_win: Optional[int] = None
class j_chess_lib.communication.schema.MoveData(from_value: Union[str, NoneType] = None, to: Union[str, NoneType] = None, promotion_unit: Union[str, NoneType] = None)[source]

Bases: object

from_value: Optional[str] = None
promotion_unit: Optional[str] = None
to: Optional[str] = None
class j_chess_lib.communication.schema.MoveMessage(move: Union[j_chess_lib.communication.schema.j_chess_message.MoveData, NoneType] = None)[source]

Bases: object

move: Optional[j_chess_lib.communication.schema.j_chess_message.MoveData] = None
class j_chess_lib.communication.schema.RequestDrawMessage(reason: Union[j_chess_lib.communication.schema.j_chess_message.RequestDrawType, NoneType] = None)[source]

Bases: object

reason: Optional[j_chess_lib.communication.schema.j_chess_message.RequestDrawType] = None
class j_chess_lib.communication.schema.RequestDrawType(value)[source]

Bases: enum.Enum

An enumeration.

FIFTY_MOVE_RULE = 'FIFTY_MOVE_RULE'
OFFER = 'OFFER'
class j_chess_lib.communication.schema.TimeControlData(your_time_in_ms: Union[int, NoneType] = None, enemy_time_in_ms: Union[int, NoneType] = None)[source]

Bases: object

enemy_time_in_ms: Optional[int] = None
your_time_in_ms: Optional[int] = None