1
0
mirror of https://github.com/peeringdb/peeringdb.git synced 2024-05-11 05:55:09 +00:00

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>
This commit is contained in:
Matt Griswold
2021-10-15 03:25:38 -05:00
committed by GitHub
parent 48a3a899f6
commit c21130eed9
133 changed files with 9962 additions and 986 deletions

View File

@@ -1,3 +1,6 @@
"""
Django middleware to handle maintenance mode.
"""
import os
from django.http import JsonResponse
@@ -9,7 +12,7 @@ from peeringdb_server import settings
def on(timeout=None):
"""
turns maintenance mode on
Turn maintenance mode on.
Keyword Arguments:
@@ -20,18 +23,18 @@ def on(timeout=None):
def off():
"""turn maintenance mode off"""
"""Turn maintenance mode off."""
if active():
os.remove(settings.MAINTENANCE_MODE_LOCKFILE)
def active():
"""return True if maintenance mode is currently active"""
"""Return True if maintenance mode is currently active."""
return os.path.isfile(settings.MAINTENANCE_MODE_LOCKFILE)
def raise_if_active():
"""raise ActionBlocked exception if maintenance mode is active"""
"""Raise ActionBlocked exception if maintenance mode is active."""
if active():
raise ActionBlocked()
@@ -40,7 +43,7 @@ class Middleware:
"""
Middleware will return 503 json responses for all write
ops (POST PUT PATCH DELETE)
ops (POST PUT PATCH DELETE).
"""
def __init__(self, get_response=None):