1
0
mirror of https://github.com/peeringdb/peeringdb.git synced 2024-05-11 05:55:09 +00:00
Files
peeringdb-peeringdb/docs/dev/modules/maintenance.py.md
Matt Griswold c21130eed9 Docs 202109 (#1067)
* module docstrings

* db schema graph

* dev docs first pass

* dev docs pass 2

* add generated notification to top of generated docs files

* linting

* regen docs

Co-authored-by: Stefan Pratter <stefan@20c.com>
Co-authored-by: Sunshine Buchholz <sunshine@20c.com>
2021-10-15 03:25:38 -05:00

1.2 KiB

Generated from maintenance.py on 2021-10-15 07:56:57.376975

peeringdb_server.maintenance

Django middleware to handle maintenance mode.

Functions


active

def active()

Return True if maintenance mode is currently active.


off

def off()

Turn maintenance mode off.


on

def on(timeout=None)

Turn maintenance mode on.

Keyword Arguments:

- timeout<int=None>: if specified will automatically
    end maintenance mode after n seconds

raise_if_active

def raise_if_active()

Raise ActionBlocked exception if maintenance mode is active.


Classes


ActionBlocked

ActionBlocked(builtins.Exception)

Common base class for all non-exit exceptions.

Methods

_init_

def __init__(self)

Initialize self. See help(type(self)) for accurate signature.


Middleware

Middleware(builtins.object)

Middleware will return 503 json responses for all write ops (POST PUT PATCH DELETE).

Methods

_call_

def __call__(self, request)

Call self as a function.


_init_

def __init__(self, get_response=None)

Initialize self. See help(type(self)) for accurate signature.