werkzeug.debug.DebuggedApplication

class documentation

class DebuggedApplication:

Enables debugging support for a given application:

from werkzeug.debug import DebuggedApplication
from myapp import app
app = DebuggedApplication(app, evalex=True)

The evalex keyword argument allows evaluating expressions in a traceback's frame context.

Parameters
app	the WSGI application to run debugged.
evalex	enable exception evaluation feature (interactive debugging). This requires a non-forking server.
request_key	The key that points to the request object in ths environment. This parameter is ignored in current versions.
console_path	the URL for a general purpose console.
console_init_func	the function that is executed before starting the general purpose console. The return value is used as initial namespace.
show_hidden_frames	by default hidden traceback frames are skipped. You can show them by setting this parameter to `True`.
pin_security	can be used to disable the pin based security system.
pin_logging	enables the logging of the pin system.

Method	`__call__`	Dispatch the requests.
Method	`__init__`	Undocumented
Method	`check_pin_trust`	No summary
Method	`debug_application`	Run the application and conserve the traceback frames.
Method	`display_console`	Display a standalone shell.
Method	`execute_command`	Execute a command in a console.
Method	`get_resource`	Return a static resource from the shared folder.
Method	`log_pin_request`	Log the pin if needed.
Method	`pin.setter`	Undocumented
Method	`pin_auth`	Authenticates with the pin.
Instance Variable	`app`	Undocumented
Instance Variable	`console_init_func`	Undocumented
Instance Variable	`console_path`	Undocumented
Instance Variable	`evalex`	Undocumented
Instance Variable	`frames`	Undocumented
Instance Variable	`pin_logging`	Undocumented
Instance Variable	`request_key`	Undocumented
Instance Variable	`secret`	Undocumented
Instance Variable	`show_hidden_frames`	Undocumented
Instance Variable	`tracebacks`	Undocumented
Property	`pin`	Undocumented
Property	`pin_cookie_name`	The name of the pin cookie.
Method	`_fail_pin_auth`	Undocumented
Class Variable	`_pin_cookie`	Undocumented
Instance Variable	`_failed_pin_auth`	Undocumented
Instance Variable	`_pin`	Undocumented

def __call__(self, environ, start_response):

Dispatch the requests.

Parameters
environ:`WSGIEnvironment`	Undocumented
start_response:`StartResponse`	Undocumented
Returns
`t.Iterable[bytes]`	Undocumented

def __init__(self, app, evalex=False, request_key='werkzeug.request', console_path='/console', console_init_func=None, show_hidden_frames=False, pin_security=True, pin_logging=True):

Undocumented

Parameters
app:`WSGIApplication`	Undocumented
evalex:`bool`	Undocumented
request_key:`str`	Undocumented
console_path:`str`	Undocumented
console_init_func:`t.Optional[t.Callable[[], t.Dict[str, t.Any]]]`	Undocumented
show_hidden_frames:`bool`	Undocumented
pin_security:`bool`	Undocumented
pin_logging:`bool`	Undocumented

def check_pin_trust(self, environ):

Checks if the request passed the pin test. This returns True if the request is trusted on a pin/cookie basis and returns False if not. Additionally if the cookie's stored pin hash is wrong it will return None so that appropriate action can be taken.

Parameters
environ:`WSGIEnvironment`	Undocumented
Returns
`t.Optional[bool]`	Undocumented

def debug_application(self, environ, start_response):

Run the application and conserve the traceback frames.

Parameters
environ:`WSGIEnvironment`	Undocumented
start_response:`StartResponse`	Undocumented
Returns
`t.Iterator[bytes]`	Undocumented

def display_console(self, request):

Display a standalone shell.

Parameters
request:`Request`	Undocumented
Returns
`Response`	Undocumented

def execute_command(self, request, command, frame):

Execute a command in a console.

Parameters
request:`Request`	Undocumented
command:`str`	Undocumented
frame:`t.Union[Frame, _ConsoleFrame]`	Undocumented
Returns
`Response`	Undocumented

def get_resource(self, request, filename):

Return a static resource from the shared folder.

Parameters
request:`Request`	Undocumented
filename:`str`	Undocumented
Returns
`Response`	Undocumented

def log_pin_request(self):

Log the pin if needed.

Returns
`Response`	Undocumented

@pin.setter
def pin(self, value):

Undocumented

Parameters
value:`str`	Undocumented

def pin_auth(self, request):

Authenticates with the pin.

Parameters
request:`Request`	Undocumented
Returns
`Response`	Undocumented

app =

Undocumented

console_init_func =

Undocumented

console_path =

Undocumented

evalex =

Undocumented

frames: t.Dict[int, t.Union[Frame, _ConsoleFrame]] =

Undocumented

pin_logging =

Undocumented

request_key =

Undocumented

secret =

Undocumented

show_hidden_frames =

Undocumented

tracebacks: t.Dict[int, Traceback] =

Undocumented

@property
pin: t.Optional[str] =

Undocumented

@property
pin_cookie_name: str =

The name of the pin cookie.

def _fail_pin_auth(self):

Undocumented

_pin_cookie: str =

Undocumented

_failed_pin_auth: int =

Undocumented

_pin =

Undocumented