peeringdb-peeringdb/docs/dev/modules/maintenance.py.md

Generated from maintenance.py on 2023-04-12 10:09:44.563425

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.

---