119 lines
3.3 KiB
Python
119 lines
3.3 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright 2013 Mirantis, Inc.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
import inspect
|
|
|
|
from oslo_serialization import jsonutils
|
|
|
|
from nailgun.api.v1.handlers.base import BaseHandler
|
|
from nailgun.api.v1.urls import urls
|
|
from nailgun import objects
|
|
from nailgun.utils import reverse
|
|
|
|
|
|
class SampleGenerator(object):
|
|
|
|
http_methods = ["GET", "POST", "PUT", "DELETE"]
|
|
|
|
@classmethod
|
|
def gen_sample_data(cls):
|
|
def process(app, what, name, obj, options, lines):
|
|
if cls._ishandler(obj):
|
|
lines.insert(0, cls.generate_handler_url_doc(obj))
|
|
lines.insert(1, "")
|
|
|
|
if lines and lines[-1]:
|
|
lines.append("")
|
|
return process
|
|
|
|
@classmethod
|
|
def skip_member(cls):
|
|
def process(app, what, name, obj, skip, options):
|
|
if skip:
|
|
return skip
|
|
|
|
if any([
|
|
cls._ishandler(obj),
|
|
cls._ishandlermethod(obj),
|
|
cls._isrestobject(obj),
|
|
cls._isrestobjectmethod(obj)
|
|
]):
|
|
return False
|
|
|
|
return skip
|
|
|
|
return process
|
|
|
|
@classmethod
|
|
def _ishandler(cls, obj):
|
|
return inspect.isclass(obj) and issubclass(obj, BaseHandler) and \
|
|
obj.__name__ in urls[1::2]
|
|
|
|
@classmethod
|
|
def _ishandlermethod(cls, obj):
|
|
return inspect.ismethod(obj) and cls._ishandler(obj.im_class)\
|
|
and obj.__name__ in cls.http_methods
|
|
|
|
@classmethod
|
|
def _isrestobject(cls, obj):
|
|
return inspect.isclass(obj) and issubclass(
|
|
obj,
|
|
(objects.NailgunObject, objects.NailgunCollection)
|
|
)
|
|
|
|
@classmethod
|
|
def _isrestobjectmethod(cls, obj):
|
|
return inspect.ismethod(obj) and cls._isrestobject(obj.im_class)
|
|
|
|
@classmethod
|
|
def generate_handler_url_doc(cls, handler):
|
|
sample_method = None
|
|
for field in cls.http_methods:
|
|
if hasattr(handler, field):
|
|
sample_method = getattr(handler, field)
|
|
break
|
|
|
|
if not sample_method:
|
|
return "URL: **Not exposed**"
|
|
|
|
args = inspect.getargspec(sample_method).args[1:]
|
|
test_url_data = dict([
|
|
(arg, "%{0}%".format(arg)) for arg in args
|
|
])
|
|
return "URL: **{0}**".format(
|
|
reverse(handler.__name__, test_url_data)
|
|
)
|
|
|
|
@classmethod
|
|
def gen_json_block(cls, data):
|
|
return "\n.. code-block:: javascript\n\n{0}\n\n".format(
|
|
"\n".join([
|
|
" " + s
|
|
for s in jsonutils.dumps(data, indent=4).split("\n")
|
|
])
|
|
)
|
|
|
|
|
|
def setup(app):
|
|
app.connect(
|
|
'autodoc-process-docstring',
|
|
SampleGenerator.gen_sample_data()
|
|
)
|
|
app.connect(
|
|
'autodoc-skip-member',
|
|
SampleGenerator.skip_member()
|
|
)
|