pysabelle package

Subpackages

• pysabelle.client package
  • Submodules
  • pysabelle.client.client module
    • IsabelleClient
      • IsabelleClient.connect()
      • IsabelleClient.start()
      • IsabelleClient.stop_server()
      • IsabelleClient.aclose()
  • Module contents
• pysabelle.raw package
  • Submodules
  • pysabelle.raw.commands module
    • RawCommands
      • RawCommands.help()
      • RawCommands.echo()
      • RawCommands.shutdown()
      • RawCommands.cancel()
      • RawCommands.session_build()
      • RawCommands.session_start()
      • RawCommands.session_stop()
      • RawCommands.use_theories()
      • RawCommands.purge_theories()
  • pysabelle.raw.dispatcher module
    • TaskDispatcher
      • TaskDispatcher.start()
      • TaskDispatcher.stop()
      • TaskDispatcher.run_sync()
      • TaskDispatcher.run_async()
  • pysabelle.raw.exceptions module
    • IsabelleError
    • IsabelleConnectionError
    • IsabelleProtocolError
    • IsabelleCommandError
    • IsabelleTimeoutError
    • IsabelleTaskCancelled
  • pysabelle.raw.protocol module
    • ReplyKind
      • ReplyKind.OK
      • ReplyKind.ERROR
      • ReplyKind.FINISHED
      • ReplyKind.FAILED
      • ReplyKind.NOTE
    • RawReply
      • RawReply.kind
      • RawReply.argument_raw
      • RawReply.parse()
      • RawReply.json()
      • RawReply.get()
      • RawReply.task_id
      • RawReply.is_ok
      • RawReply.is_error
      • RawReply.is_finished
      • RawReply.is_failed
      • RawReply.is_note
      • RawReply.is_terminal
      • RawReply.is_async
    • encode_long_message()
    • encode_short_message()
  • pysabelle.raw.transport module
    • Transport
      • Transport.open()
      • Transport.send()
      • Transport.receive()
      • Transport.close()
      • Transport.is_closing
  • pysabelle.raw.types module
    • UUID
    • TaskId
      • TaskId.task
    • SessionId
      • SessionId.session_id
    • NoteCallback
    • Position
      • Position.line
      • Position.offset
      • Position.end_offset
      • Position.file
      • Position.id
      • Position.from_dict()
      • Position.to_dict()
    • MessageKind
      • MessageKind.WRITELN
      • MessageKind.WARNING
      • MessageKind.ERROR
    • Message
      • Message.kind
      • Message.message
      • Message.pos
      • Message.from_dict()
      • Message.is_error
    • ErrorMessage
      • ErrorMessage.message
      • ErrorMessage.kind
      • ErrorMessage.from_dict()
    • TheoryProgress
      • TheoryProgress.message
      • TheoryProgress.theory
      • TheoryProgress.session
      • TheoryProgress.kind
      • TheoryProgress.percentage
      • TheoryProgress.from_dict()
      • TheoryProgress.is_theory_progress()
    • Timing
      • Timing.elapsed
      • Timing.cpu
      • Timing.gc
      • Timing.from_dict()
    • NodeStatus
      • NodeStatus.ok
      • NodeStatus.total
      • NodeStatus.unprocessed
      • NodeStatus.running
      • NodeStatus.warned
      • NodeStatus.failed
      • NodeStatus.finished
      • NodeStatus.canceled
      • NodeStatus.consolidated
      • NodeStatus.percentage
      • NodeStatus.from_dict()
    • Node
      • Node.node_name
      • Node.theory_name
      • Node.from_dict()
    • NodeWithStatus
      • NodeWithStatus.node
      • NodeWithStatus.status
      • NodeWithStatus.from_dict()
    • SessionBuildArgs
      • SessionBuildArgs.session
      • SessionBuildArgs.preferences
      • SessionBuildArgs.options
      • SessionBuildArgs.dirs
      • SessionBuildArgs.include_sessions
      • SessionBuildArgs.verbose
      • SessionBuildArgs.print_mode
      • SessionBuildArgs.to_dict()
    • SessionBuildResult
      • SessionBuildResult.session
      • SessionBuildResult.ok
      • SessionBuildResult.return_code
      • SessionBuildResult.timeout
      • SessionBuildResult.timing
      • SessionBuildResult.from_dict()
    • SessionBuildResults
      • SessionBuildResults.ok
      • SessionBuildResults.return_code
      • SessionBuildResults.sessions
      • SessionBuildResults.from_dict()
    • SessionStartResult
      • SessionStartResult.session_id
      • SessionStartResult.tmp_dir
      • SessionStartResult.from_dict()
    • SessionStopResult
      • SessionStopResult.ok
      • SessionStopResult.return_code
      • SessionStopResult.from_dict()
    • UseTheoriesArgs
      • UseTheoriesArgs.session_id
      • UseTheoriesArgs.theories
      • UseTheoriesArgs.options
      • UseTheoriesArgs.master_dir
      • UseTheoriesArgs.pretty_margin
      • UseTheoriesArgs.unicode_symbols
      • UseTheoriesArgs.export_pattern
      • UseTheoriesArgs.check_delay
      • UseTheoriesArgs.check_limit
      • UseTheoriesArgs.watchdog_timeout
      • UseTheoriesArgs.nodes_status_delay
      • UseTheoriesArgs.to_dict()
    • Export
      • Export.name
      • Export.base64
      • Export.body
      • Export.from_dict()
    • NodeResults
      • NodeResults.status
      • NodeResults.messages
      • NodeResults.exports
      • NodeResults.from_dict()
    • NodeResultEntry
      • NodeResultEntry.node
      • NodeResultEntry.results
      • NodeResultEntry.from_dict()
    • UseTheoriesResults
      • UseTheoriesResults.ok
      • UseTheoriesResults.errors
      • UseTheoriesResults.nodes
      • UseTheoriesResults.from_dict()
    • PurgeTheoriesArgs
      • PurgeTheoriesArgs.session_id
      • PurgeTheoriesArgs.theories
      • PurgeTheoriesArgs.master_dir
      • PurgeTheoriesArgs.all
      • PurgeTheoriesArgs.to_dict()
    • PurgeTheoriesResults
      • PurgeTheoriesResults.purged
      • PurgeTheoriesResults.retained
      • PurgeTheoriesResults.from_dict()
  • Module contents
• pysabelle.server package
  • Submodules
  • pysabelle.server.exceptions module
    • IsabelleServerError
    • ServerStartupTimeout
    • ServerAlreadyRunning
    • ServerNotRunning
  • pysabelle.server.models module
    • ServerInfo
      • ServerInfo.name
      • ServerInfo.host
      • ServerInfo.port
      • ServerInfo.password
  • pysabelle.server.server_process module
    • list_servers()
    • is_server_running()
    • BaseIsabelleServer
      • BaseIsabelleServer.is_running
      • BaseIsabelleServer.info
      • BaseIsabelleServer.start()
      • BaseIsabelleServer.stop()
    • IsabelleServerProcess
      • IsabelleServerProcess.is_running
      • IsabelleServerProcess.info
      • IsabelleServerProcess.start()
      • IsabelleServerProcess.stop()
  • Module contents
• pysabelle.session package
  • Submodules
  • pysabelle.session.callbacks module
    • ProgressCallback
    • NodesStatusCallback
    • build_note_handler()
    • use_theories_note_handler()
  • pysabelle.session.exceptions module
    • IsabelleSessionError
    • SessionAlreadyClosed
    • TheoryLoadError
  • pysabelle.session.session module
    • IsabelleSession
      • IsabelleSession.session_id
      • IsabelleSession.tmp_dir
      • IsabelleSession.start()
      • IsabelleSession.connect()
      • IsabelleSession.build()
      • IsabelleSession.use_theories()
      • IsabelleSession.purge_theories()
      • IsabelleSession.check_theories()
      • IsabelleSession.load_and_purge()
      • IsabelleSession.close()
  • Module contents

Module contents

pYsabelle: Modern async Python client for the Isabelle Server protocol.

This package provides a layered API to interact with Isabelle’s TCP server. It includes raw transport, command dispatcher, typed commands, and a high-level session facade.

The public interface is exposed through the subpackages: - pysabelle.raw: Low-level protocol handling. - pysabelle.client: Mid-level client with raw commands. - pysabelle.server: Management of Isabelle server processes. - pysabelle.session: High-level session API with convenience methods.