Client¶

Client base¶

class pyskom.client.client_base.ClientBase(host: str, connection_info: str, port: int = 4894, log_calls: bool = False)¶

CALL_NAMES: ClassVar[dict[int, str]] = {}¶

async close()¶

async connect()¶

on_async(f: Callable[[AsyncMessage], Awaitable[None]])¶

on_connected(f: Callable[[], Awaitable[None]])¶

async on_packet(packet: bytes)¶

async send_request(call_nr: int, args: bytearray | None, parse_callable: Callable[[MessageParser], Any] | None) → Any¶

async wait_until_connected(timeout: float | None = None) → None¶

Client class¶

class pyskom.client.Client(host: str, connection_info: str, port: int = 4894, log_calls: bool = False)¶

CALL_NAMES: ClassVar[dict[int, str]] = {1: 'logout', 2: 'change-conference', 3: 'change-name', 4: 'change-what-i-am-doing', 7: 'set-priv-bits', 8: 'set-passwd', 11: 'delete-conf', 15: 'sub-member', 16: 'set-presentation', 17: 'set-etc-motd', 18: 'set-supervisor', 19: 'set-permitted-submitters', 20: 'set-super-conf', 21: 'set-conf-type', 22: 'set-garb-nice', 23: 'get-marks', 25: 'get-text', 27: 'mark-as-read', 29: 'delete-text', 30: 'add-recipient', 31: 'sub-recipient', 32: 'add-comment', 33: 'sub-comment', 35: 'get-time', 37: 'add-footnote', 38: 'sub-footnote', 40: 'set-unread', 41: 'set-motd-of-lyskom', 42: 'enable', 43: 'sync-kom', 44: 'shutdown-kom', 49: 'get-person-stat', 52: 'get-unread-confs', 53: 'send-message', 55: 'disconnect', 56: 'who-am-i', 57: 'set-user-area', 58: 'get-last-text', 60: 'find-next-text-no', 61: 'find-previous-text-no', 62: 'login', 69: 'set-client-version', 70: 'get-client-name', 71: 'get-client-version', 72: 'mark-text', 73: 'unmark-text', 74: 're-z-lookup', 75: 'get-version-info', 76: 'lookup-z-name', 77: 'set-last-read', 78: 'get-uconf-stat', 79: 'set-info', 80: 'accept-async', 81: 'query-async', 82: 'user-active', 83: 'who-is-on-dynamic', 84: 'get-static-session-info', 85: 'get-collate-table', 86: 'create-text', 87: 'create-anonymous-text', 88: 'create-conf', 89: 'create-person', 90: 'get-text-stat', 91: 'get-conf-stat', 92: 'modify-text-info', 93: 'modify-conf-info', 94: 'get-info', 95: 'modify-system-info', 96: 'query-predefined-aux-items', 100: 'add-member', 101: 'get-members', 102: 'set-membership-type', 103: 'local-to-global', 104: 'map-created-texts', 105: 'set-keep-commented', 106: 'set-pers-flags', 107: 'query-read-texts', 108: 'get-membership', 109: 'mark-as-unread', 110: 'set-read-ranges', 111: 'get-stats-description', 112: 'get-stats', 113: 'get-boottime-info', 114: 'first-unused-conf-no', 115: 'first-unused-text-no', 116: 'find-next-conf-no', 117: 'find-previous-conf-no', 120: 'set-connection-time-format', 121: 'local-to-global-reverse', 122: 'map-created-texts-reverse'}¶

async accept_async(request_list: list[KomInt32]) → None¶

async add_comment(text_no: TextNo, comment_to: TextNo) → None¶

async add_footnote(text_no: TextNo, footnote_to: TextNo) → None¶

async add_member(conf_no: ConfNo, pers_no: PersNo, priority: KomInt8, where: KomInt16, type: MembershipType) → None¶

async add_recipient(text_no: TextNo, conf_no: ConfNo, recpt_type: InfoType) → None¶

async change_conference(conference: ConfNo) → None¶

async change_name(conference: ConfNo, new_name: KomStr) → None¶

async change_what_i_am_doing(what_am_i_doing: KomStr) → None¶

async create_anonymous_text(text: KomStr, misc_info: list[MiscInfo], aux_items: list[AuxItemInput]) → TextNo¶

async create_conf(name: KomStr, type: AnyConfType, aux_items: list[AuxItemInput]) → ConfNo¶

async create_person(name: KomStr, passwd: KomStr, flags: PersonalFlags, aux_items: list[AuxItemInput]) → PersNo¶

async create_text(text: KomStr, misc_info: list[MiscInfo], aux_items: list[AuxItemInput]) → TextNo¶

async delete_conf(conf: ConfNo) → None¶

async delete_text(text: TextNo) → None¶

async disconnect(session_no: SessionNo) → None¶

async enable(level: KomInt8) → None¶

async find_next_conf_no(start: ConfNo) → ConfNo¶

async find_next_text_no(start: TextNo) → TextNo¶

async find_previous_conf_no(start: ConfNo) → ConfNo¶

async find_previous_text_no(start: TextNo) → TextNo¶

async first_unused_conf_no() → ConfNo¶

async first_unused_text_no() → TextNo¶

async get_boottime_info() → StaticServerInfo¶

async get_client_name(session: SessionNo) → KomStr¶

async get_client_version(session: SessionNo) → KomStr¶

async get_collate_table() → KomStr¶

async get_conf_stat(conf_no: ConfNo) → Conference¶

async get_info() → Info¶

async get_last_text(before: Time) → TextNo¶

async get_marks() → list[Mark]¶

async get_members(conf: ConfNo, first: KomInt16, no_of_members: KomInt16) → list[Member]¶

async get_membership(person: PersNo, first: KomInt16, no_of_confs: KomInt16, want_read_ranges: KomBool, max_ranges: KomInt32) → list[Membership]¶

async get_person_stat(pers_no: PersNo) → Person¶

async get_static_session_info(session_no: SessionNo) → StaticSessionInfo¶

async get_stats(what: KomStr) → list[Stats]¶

async get_stats_description() → StatsDescription¶

async get_text(text: TextNo, start_char: KomInt32, end_char: KomInt32) → KomBytes¶

async get_text_stat(text_no: TextNo) → TextStat¶

async get_time() → Time¶

async get_uconf_stat(conference: ConfNo) → Uconference¶

async get_unread_confs(pers_no: PersNo) → list[ConfNo]¶

async get_version_info() → VersionInfo¶

async local_to_global(conf_no: ConfNo, first_local_no: LocalTextNo, no_of_existing_texts: KomInt32) → TextMapping¶

async local_to_global_reverse(conf_no: ConfNo, local_no_ceiling: LocalTextNo, no_of_existing_texts: KomInt32) → TextMapping¶

async login(person: PersNo, passwd: KomStr, invisible: KomBool) → None¶

async logout() → None¶

async lookup_z_name(name: KomStr, want_pers: KomBool, want_confs: KomBool) → list[ConfZInfo]¶

async map_created_texts(author: PersNo, first_local_no: LocalTextNo, no_of_existing_texts: KomInt32) → TextMapping¶

async map_created_texts_reverse(author: PersNo, local_no_ceiling: LocalTextNo, no_of_existing_texts: KomInt32) → TextMapping¶

async mark_as_read(conference: ConfNo, text: list[LocalTextNo]) → None¶

async mark_as_unread(conference: ConfNo, text: LocalTextNo) → None¶

async mark_text(text: TextNo, mark_type: KomInt8) → None¶

async modify_conf_info(conf: ConfNo, delete: list[AuxNo], add: list[AuxItemInput]) → None¶

async modify_system_info(items_to_delete: list[AuxNo], items_to_add: list[AuxItemInput]) → None¶

async modify_text_info(text: TextNo, delete: list[AuxNo], add: list[AuxItemInput]) → None¶

async query_async() → list[KomInt32]¶

async query_predefined_aux_items() → list[KomInt32]¶

async query_read_texts(person: PersNo, conference: ConfNo, want_read_ranges: KomBool, max_ranges: KomInt32) → Membership¶

async re_z_lookup(regexp: KomStr, want_persons: KomBool, want_confs: KomBool) → list[ConfZInfo]¶

async send_message(recipient: ConfNo, message: KomStr) → None¶

async set_client_version(client_name: KomStr, client_version: KomStr) → None¶

async set_conf_type(conf_no: ConfNo, type: AnyConfType) → None¶

async set_connection_time_format(use_utc: KomBool) → None¶

async set_etc_motd(conf_no: ConfNo, text_no: TextNo) → None¶

async set_garb_nice(conf_no: ConfNo, nice: GarbNice) → None¶

async set_info(info: InfoOld) → None¶

async set_keep_commented(conf_no: ConfNo, keep_commented: GarbNice) → None¶

async set_last_read(conference: ConfNo, last_read: LocalTextNo) → None¶

async set_membership_type(pers: PersNo, conf: ConfNo, type: MembershipType) → None¶

async set_motd_of_lyskom(text_no: TextNo) → None¶

async set_passwd(person: PersNo, old_pwd: KomStr, new_pwd: KomStr) → None¶

async set_permitted_submitters(conf_no: ConfNo, perm_sub: ConfNo) → None¶

async set_pers_flags(pers_no: PersNo, flags: PersonalFlags) → None¶

async set_presentation(conf_no: ConfNo, text_no: TextNo) → None¶

async set_priv_bits(person: PersNo, privileges: PrivBits) → None¶

async set_read_ranges(conference: ConfNo, read_ranges: list[ReadRange]) → None¶

async set_super_conf(conf_no: ConfNo, super_conf: ConfNo) → None¶

async set_supervisor(conf_no: ConfNo, admin: ConfNo) → None¶

async set_unread(conf_no: ConfNo, no_of_unread: KomInt32) → None¶

async set_user_area(pers_no: PersNo, user_area: TextNo) → None¶

async shutdown_kom(exit_val: KomInt8) → None¶

async sub_comment(text_no: TextNo, comment_to: TextNo) → None¶

async sub_footnote(text_no: TextNo, footnote_to: TextNo) → None¶

async sub_member(conf_no: ConfNo, pers_no: PersNo) → None¶

async sub_recipient(text_no: TextNo, conf_no: ConfNo) → None¶

async sync_kom() → None¶

async unmark_text(text_no: TextNo) → None¶

async user_active() → None¶

async who_am_i() → SessionNo¶

async who_is_on_dynamic(want_visible: KomBool, want_invisible: KomBool, active_last: KomInt32) → list[DynamicSessionInfo]¶