pychess.ic.managers package

Submodules

pychess.ic.managers.AdjournManager module

class pychess.ic.managers.AdjournManager.AdjournManager(connection)

Bases: GObject

abort(game)
challenge(playerName)
draw(game)
examine(game)
queryAdjournments(owner=None)
queryHistory(owner=None)
queryJournal(owner=None)
queryMoves(game)
resign(game)

This is (and draw and abort) are possible even when one’s opponent is not logged on

resume(game)

pychess.ic.managers.AutoLogOutManager module

class pychess.ic.managers.AutoLogOutManager.AutoLogOutManager(connection)

Bases: GObject

onLogOut(match)

pychess.ic.managers.BoardManager module

class pychess.ic.managers.BoardManager.BoardManager(connection)

Bases: GObject

accept(offerno)
callflag()
decline(offerno)
follow(player)
classmethod generateCastleSigns(style12, game_type)
isPlaying()
made_examined(match)

Changing from observer to examiner

made_unexamined(match)

You are no longer examine game

matchDeclined(match)
nonoWhileExamine(match)
observe(game, player=None)
onArchiveGameSMovesReceived(matchlist)
onExamineGameCreated(matchlist)
onGameEnd(games, game)
onGameModelStarted(gameno)
onGamePause(match)
onInterceptedChallenge(matchlist)
onMatchingSeekOrGetGame(matchlist)
onObserveGameCreated(matchlist)
onObserveGameMovesReceived(matchlist)
onPlayGameCreated(matchlist)
onStyle12(match)
onUnobserveGame(match)
onWasPrivate(match)
on_game_remove(match)
opp_not_out_of_time(match)
parseGame(matchlist, gameclass, in_progress=False, gameno=None)

Parses the header and movelist for an observed or stored game from its matchlist (an re.match object) into a gameclass (FICSGame or subclass of) object.

in_progress - should be True for an observed game matchlist, and False for stored/adjourned games

classmethod parseStyle12(line, castleSigns=None)
play(seekno)
player_lagged(match)
player_on_censor(match)
player_on_noplay(match)
req_not_fit_formula(matchlist)
resign()
sendMove(move)
start()
tooManySeeks(match)
unexamine()
unobserve(game)
castleSigns = {}
queuedStyle12s = {}
pychess.ic.managers.BoardManager.parse_reason(result, reason, wname=None)

Parse the result value and reason line string for the reason and return the result and reason the game ended.

result – The result of the game, if known. It can be “None”, but if it is “DRAW”, then wname must be supplied

pychess.ic.managers.ChatManager module

class pychess.ic.managers.ChatManager.ChatManager(connection)

Bases: GObject

convTime(h, m, s)
entityDecode(text)
entityEncode(text)
getChannelLog(channel, minutes=30)

Channel can be channel_id, shout or c-shout

getChannelPlayers(matchlist)
getChannels()
getJoinedChannels()
getNoChannelPlayers(match)
getPeopleInChannel(channel)
getPlayersChannels(player)
get_allob_list(match)
Description: Processes the returning pattern matched of the FICS allob command

extracts out the gameno and a list of observers before emmiting them for collection by the observers view

match: (re.reg-ex) is the complied matching pattern for processing

gotPlayerChannels(matchlist)
joinChannel(channel)
mayTellChannel(channel)
onAnnouncement(match)
onArrivalNotification(match)
onChannelList(matchlist)
onChannelLogBreak(match)
onChannelLogLine(match)
onChannelLogStart(match)
onChannelMessage(match)
onDepartedNotification(match)
onKibitzMessage(match)
onPrivateMessage(match)
onShoutMessage(match)
onWhisperMessage(match)
on_allob_no(match)
removeChannel(channel)
tellAll(message)
tellBughousePartner(message)
tellChannel(channel, message)
tellGame(gameno, message)
tellOpponent(message)
tellPlayer(player, message)
tellUser(player, message)
toldChannel(match)
whisper(message)
channelListItem = re.compile('((?:\\d+,?)+)\\s*(.*)')
entityExpr = re.compile('&#x([a-f0-9]+);')

pychess.ic.managers.ConsoleManager module

class pychess.ic.managers.ConsoleManager.ConsoleManager(connection)

Bases: GObject

onConsoleMessage(lines, ini_lines=None)

pychess.ic.managers.ErrorManager module

class pychess.ic.managers.ErrorManager.ErrorManager(connection)

Bases: GObject

onAmbiguousMove(match)
onError(match)
onIllegalMove(match)

pychess.ic.managers.FingerManager module

class pychess.ic.managers.FingerManager.FingerManager(connection)

Bases: GObject

finger(user)
onFinger(matchlist)
onRatingAdjust(match)
parseDate(date)
parseShortDate(date)
parseTime(time)
setBusyMessage(message)

Like set busy is really busy right now.

setFingerNote(note, message)
class pychess.ic.managers.FingerManager.FingerObject(name='')

Bases: object

getAdminLevel()

Returns the admin level as a string Only set for admins.

getBusyMessage()

Returns the userset idle message This is set when status == STATUS_BUSY or sometimes when status == STATUS_PLAYING

getColor()

If status == STATUS_PLAYING getColor returns the color witch the player has got in the game. Otherwise always WHITE is returned

getCreated()

Returns when the account was created

getEmail()

Returns the email adress of the user. This will probably only be set for the logged in user

getGameno()

Returns the gameno of the game in which user is currently playing This is only set when status == STATUS_PLAYING

getIdleTime()

Returns the when the last time the user did something active Not set when status == STATUS_OFFLINE

getLastSeen()

Returns when the user logged off This is only set when status == STATUS_OFFLINE This is not set, if the user has never logged on

getName()

Returns the name of the user, without any title sufixes

getNotes()

Returns a list of the ten finger notes

getOpponent()

Returns the opponent of the user in his current game This is only set when status == STATUS_PLAYING

getRating(type=None)
getRatings()
getRatingsLen()
getSanctions()

Returns any sanctions the user has against them. This is usually an empty string

getSilence()

Return True if the user is playing in silence This is only set when status == STATUS_PLAYING

getStatus()

Returns the current user-status as a STATUS constant

getTimeseal()

Returns True if the user is using timeseal for fics connection

getTitles()
getTotalTimeOnline()

Returns how many seconds the user has been on FICS since the account was created. This is not set, if the user has never logged on

getUpTime()

Returns the when the user logged on Not set when status == STATUS_OFFLINE

setAdminLevel(value)
setBusyMessage(value)

Use relative seconds

setColor(value)
setCreated(value)

Use relative seconds

setEmail(value)
setGameno(value)
setIdleTime(value)

Use relative seconds

setLastSeen(value)

Use relative seconds

setName(value)
setNote(index, note)
setOpponent(value)
setRating(rating_type, rating_line)
setSanctions(value)
setSilence(value)
setStatus(value)
setTimeseal(value)
setTitles(titles)
setTotalTimeOnline(value)

Use relative seconds

setUpTime(value)

Use relative seconds

pychess.ic.managers.HelperManager module

class pychess.ic.managers.HelperManager.HelperManager(helperconn, connection)

Bases: GObject

on_game_add(match)
on_game_list(matchlist)
on_game_remove(match)
on_player_available(matches)
on_player_connect(match)
on_player_connectI(match, set_online=True)
on_player_disconnect(match)
on_player_disconnectI(match)
on_player_unavailable(match)
on_player_who(match)
on_player_whoI(matchlist)
static parseTitles(titles)

pychess.ic.managers.ListAndVarManager module

class pychess.ic.managers.ListAndVarManager.ListAndVarManager(connection)

Bases: object

addToList(list_name, value)
autoFlagNotify(*args)
getList(list_name)
onUpdateEmptyListitems(match)
onUpdateList(match)
onUpdateListitems(matchlist)
onUpdateLists(matchlist)
removeFromList(list_name, value)

pychess.ic.managers.NewsManager module

class pychess.ic.managers.NewsManager.NewsManager(connection)

Bases: GObject

onNewsItem(match)

pychess.ic.managers.OfferManager module

class pychess.ic.managers.OfferManager.OfferManager(connection)

Bases: GObject

accept(offer)
acceptIndex(index)
challenge(player_name, game_type, startmin, incsec, rated, color=None)
decline(offer)
declineIndex(index)
noOffersToAccept(match)
notEnoughMovesToUndo(match)
offer(offer)
onOfferAdd(match)
onOfferDeclined(match)
onOfferRemove(match)
playIndex(index)
withdraw(offer)

pychess.ic.managers.SeekManager module

class pychess.ic.managers.SeekManager.SeekManager(connection)

Bases: GObject

assess(player1, player2, type)
on_assess(matchlist)
on_our_seeks_removed(matchlist)
on_seek_add(match)
on_seek_clear(*args)
on_seek_remove(match)
on_seek_updated(matchlist)
refresh_seeks()
seek(startmin, incsec, game_type, rated, ratings=(0, 9999), color=None, manual=False)

pychess.ic.managers.ICCAdjournManager module

class pychess.ic.managers.ICCAdjournManager.ICCAdjournManager(connection)

Bases: pychess.ic.managers.AdjournManager.AdjournManager

on_icc_gamelist_begin(data)
on_icc_gamelist_item(data)
on_icc_rating_type_key(data)
queryJournal(owner=None)
queryMoves(game)

pychess.ic.managers.ICCAutoLogOutManager module

class pychess.ic.managers.ICCAutoLogOutManager.ICCAutoLogOutManager(connection)

Bases: pychess.ic.managers.AutoLogOutManager.AutoLogOutManager

pychess.ic.managers.ICCBoardManager module

class pychess.ic.managers.ICCBoardManager.ICCBoardManager(connection)

Bases: pychess.ic.managers.BoardManager.BoardManager

on_icc_back(data)
on_icc_game_message(data)
on_icc_isolated_board(data)
on_icc_knows_fischer_random(data)
on_icc_move_lag(data)
on_icc_my_game_ended(data)
on_icc_my_game_result(data)
on_icc_my_game_started(data)
on_icc_position_begin(data)
on_icc_send_moves(data)
on_icc_set_board(data)
on_icc_spgn(data)
on_icc_started_observing(data)
on_icc_stop_observing(data)
queued_send_moves = {}

pychess.ic.managers.ICCChatManager module

class pychess.ic.managers.ICCChatManager.ICCChatManager(connection)

Bases: pychess.ic.managers.ChatManager.ChatManager

on_icc_channel_tell(data)
on_icc_channels_shared(data)
on_icc_kibitz(data)
on_icc_people_in_my_channel(data)
on_icc_personal_tell(data)
on_icc_players_in_my_game(data)
on_icc_shout(data)

pychess.ic.managers.ICCErrorManager module

class pychess.ic.managers.ICCErrorManager.ICCErrorManager(connection)

Bases: pychess.ic.managers.ErrorManager.ErrorManager

on_icc_illegal_move(data)

pychess.ic.managers.ICCFingerManager module

class pychess.ic.managers.ICCFingerManager.ICCFingerManager(connection)

Bases: pychess.ic.managers.FingerManager.FingerManager

finger(user)
on_icc_who_am_i(data)
on_icc_yfinger(data)

pychess.ic.managers.ICCHelperManager module

class pychess.ic.managers.ICCHelperManager.ICCHelperManager(helperconn, connection)

Bases: pychess.ic.managers.HelperManager.HelperManager

on_icc_games(data)
on_icc_player_arrived_simple(data)
on_icc_player_left(data)
on_icc_tourney(data)
on_icc_wild_key(data)

pychess.ic.managers.ICCListAndVarManager module

class pychess.ic.managers.ICCListAndVarManager.ICCListAndVarManager(connection)

Bases: pychess.ic.managers.ListAndVarManager.ListAndVarManager

autoFlagNotify(*args)

pychess.ic.managers.ICCNewsManager module

class pychess.ic.managers.ICCNewsManager.ICCNewsManager(connection)

Bases: pychess.ic.managers.NewsManager.NewsManager

pychess.ic.managers.ICCOfferManager module

class pychess.ic.managers.ICCOfferManager.ICCOfferManager(connection)

Bases: pychess.ic.managers.OfferManager.OfferManager

accept(offer)
decline(offer)
on_icc_match(data)
on_icc_match_removed(data)
on_icc_offers_in_my_game(data)

pychess.ic.managers.ICCSeekManager module

class pychess.ic.managers.ICCSeekManager.ICCSeekManager(connection)

Bases: pychess.ic.managers.SeekManager.SeekManager

on_icc_seek_add(data)
on_icc_seek_removed(data)

Module contents