class documentation

class ACMEViewRequests(Vertical):

Constructor: ACMEViewRequests(id)

View In Hierarchy

View to show the requests in the ACME text UI.

Method __init__ Initialize the view.
Method action_delete_requests Delete the requests.
Method action_disable_requests Disable request recording.
Method action_enable_requests Enable request recording.
Method action_refresh_requests Refresh the requests.
Method action_toggle_comment_style Toggle the comment style.
Method action_toggle_list_details Toggle the list details.
Method compose Compose the view.
Method currentRI.setter Set the current resource ID.
Method deleteRequests Delete the requests from the storage.
Method on_click Handle Click events. Copy the request or response to the clipboard.
Async Method on_list_view_highlighted Handle the highlighting of a request in the list.
Async Method on_list_view_selected Handle the selection of a request in the list.
Method onShow Called when the view is shown.
Method updateBindings Update the bindings.
Method updateRequests Update the requests.
Constant BINDINGS The key bindings for the view.
Class Variable requestManager Injected RequestManager instance.
Class Variable storage Injected Storage instance.
Class Variable validator Injected Validator instance.
Instance Variable commentsOneLine Show comments in requests and responses in one line.
Instance Variable currentRequest The current request.
Instance Variable currentResponse The current response.
Instance Variable listDetails Show list details.
Property currentRI The current resource ID.
Property requestList The view for the list of requests.
Property requestListRequest The view for the list of requests.
Property requestListResponse The view for the list of responses.
Method _showRequests Show the request and response of a request.
Instance Variable _app The application.
Instance Variable _currentRequests The current requests.
Instance Variable _currentRI The current resource ID.
Instance Variable _requestListList The list of requests view.
Instance Variable _requestListRequest The request view.
Instance Variable _requestListResponse The response view.
def __init__(self, id: str):

Initialize the view.

Parameters
id:strThe ID of the view.
def action_delete_requests(self):

Delete the requests.

def action_disable_requests(self):

Disable request recording.

def action_enable_requests(self):

Enable request recording.

def action_refresh_requests(self):

Refresh the requests.

def action_toggle_comment_style(self):

Toggle the comment style.

def action_toggle_list_details(self):

Toggle the list details.

def compose(self) -> ComposeResult:

Compose the view.

Yields
The widgets of the view.
def currentRI(self, ri: str):

Set the current resource ID.

Parameters
ri:strThe resource ID.
def deleteRequests(self):

Delete the requests from the storage.

def on_click(self, event: events.Click):

Handle Click events. Copy the request or response to the clipboard.

Parameters
event:events.ClickThe Click event.
async def on_list_view_highlighted(self, selected: ListView.Highlighted):

Handle the highlighting of a request in the list.

Parameters
selected:ListView.HighlightedThe highlighted request.
async def on_list_view_selected(self, selected: ListView.Selected):

Handle the selection of a request in the list.

Parameters
selected:ListView.SelectedThe selected request.
def onShow(self):

Called when the view is shown.

def updateBindings(self):

Update the bindings.

def updateRequests(self):

Update the requests.

BINDINGS =

The key bindings for the view.

Value
[Binding('r', 'refresh_requests', 'Refresh'),
 Binding('D', 'delete_requests', 'Delete ALL Requests',
         key_display='SHIFT+D'),
 Binding('e', 'enable_requests', ''),
 Binding('t', 'toggle_list_details', 'List Details'),
 Binding('ctrl+t', 'toggle_comment_style', 'Comments Style')]
requestManager: RequestManager =

Injected RequestManager instance.

storage: Storage =

Injected Storage instance.

validator: Validator =

Injected Validator instance.

commentsOneLine =

Show comments in requests and responses in one line.

currentRequest: JSON =

The current request.

currentResponse: JSON =

The current response.

listDetails =

Show list details.

@property
currentRI: str | None =

The current resource ID.

Returns
The current resource ID.
@property
requestList: ListView =

The view for the list of requests.

Returns
The list of requests.
@property
requestListRequest: Static =

The view for the list of requests.

Returns
The view for the list of requests.
@property
requestListResponse: Static =

The view for the list of responses.

Returns
The view for the list of responses.
def _showRequests(self, item: ACMEListItem):

Show the request and response of a request.

Parameters
item:ACMEListItemThe selected request item.
_app =

The application.

_currentRequests: list[JSON] =

The current requests.

_currentRI: str =

The current resource ID.

_requestListList =

The list of requests view.

_requestListRequest =

The request view.

_requestListResponse =

The response view.