##// END OF EJS Templates
Update messaging protocol docs for new history_request specification.
Thomas Kluyver -
Show More
@@ -596,21 +596,34 Message type: ``history_request``::
596 # If True, return the raw input history, else the transformed input.
596 # If True, return the raw input history, else the transformed input.
597 'raw' : bool,
597 'raw' : bool,
598
598
599 # This parameter can be one of: A number, a pair of numbers, None
599 # So far, this can be 'range', 'tail' or 'search'.
600 # If not given, last 40 are returned.
600 'hist_access_type' : str,
601 # - number n: return the last n entries.
601
602 # - pair n1, n2: return entries in the range(n1, n2).
602 # If hist_access_type is 'range', get a range of input cells. session can
603 # - None: return all history
603 # be a positive session number, or a negative number to count back from
604 'index' : n or (n1, n2) or None,
604 # the current session.
605 'session' : int,
606 # start and stop are line numbers within that session.
607 'start' : int,
608 'stop' : int,
609
610 # If hist_access_type is 'tail', get the last n cells.
611 'n' : int,
612
613 # If hist_access_type is 'search', get cells matching the specified glob
614 # pattern (with * and ? as wildcards).
615 'pattern' : str,
616
605 }
617 }
606
618
607 Message type: ``history_reply``::
619 Message type: ``history_reply``::
608
620
609 content = {
621 content = {
610 # A dict with prompt numbers as keys and either (input, output) or input
622 # A list of 3 tuples, either:
611 # as the value depending on whether output was True or False,
623 # (session, line_number, input) or
612 # respectively.
624 # (session, line_number, (input, output)),
613 'history' : dict,
625 # depending on whether output was False or True, respectively.
626 'history' : list,
614 }
627 }
615
628
616
629
General Comments 0
You need to be logged in to leave comments. Login now