base

Utility functions and types.

The HTTP status codes exported here are spelled out rather than imported from the standard library http client, which is expensive to import under IronPython and is not otherwise needed to describe a request or a response.

Attributes

OK = 200 module-attribute

ACCEPTED = 202 module-attribute

NO_CONTENT = 204 module-attribute

INTERNAL_SERVER_ERROR = 500 module-attribute

DEFAULT_SOURCE = 'pyrevit.routes' module-attribute

Classes

Request(path='/', method='GET', data=None, params=None, query_params=None)

Bases: object

Request wrapper object.

Source code in pyrevitlib/pyrevit/routes/server/base.py

def __init__(
    self, path="/", method="GET", data=None, params=None, query_params=None
):
    self.path = path
    self.method = method
    self.data = data
    self._headers = {}
    self._params = params or []
    self._query_params = query_params or {}

Attributes

path = path instance-attribute

method = method instance-attribute

data = data instance-attribute

headers property

Request headers dict.

params property

Request parameters.

query_params property

Request query string parameters as a dictionary.

callback_url property

Request callback url, if provided in payload.

Methods:

add_header(key, value)

Add new header key:value.

Source code in pyrevitlib/pyrevit/routes/server/base.py

def add_header(self, key, value):
    """Add new header key:value."""
    self._headers[key] = value

Response(status=200, data=None, headers=None)

Bases: object

Response wrapper object.

Source code in pyrevitlib/pyrevit/routes/server/base.py

def __init__(self, status=200, data=None, headers=None):
    self.status = status
    self.data = data
    self._headers = headers or {}

Attributes

status = status instance-attribute

data = data instance-attribute

headers property

Response headers dict.

Methods:

add_header(key, value)

Add new header key:value.

Source code in pyrevitlib/pyrevit/routes/server/base.py

def add_header(self, key, value):
    """Add new header key:value."""
    self._headers[key] = value