From 3cfbe9739599e53f2954af96749bf83ef029b954 Mon Sep 17 00:00:00 2001 From: Niall Byrne Date: Wed, 13 Nov 2019 11:41:48 -0500 Subject: [PATCH 01/64] codebase linting and quality controls --- .coveragerc | 14 + .dockerignore | 5 + .flake8 | 8 + .gitignore | 17 +- Pipfile | 11 + contributing/README.md | 49 ++ contributing/scripts/commander.sh | 65 ++ contributing/scripts/dev | 35 + contributing/scripts/hooks/post-merge | 28 + contributing/scripts/hooks/pre-commit | 46 ++ contributing/scripts/lib/common.sh | 56 ++ contributing/scripts/lib/documentation.sh | 39 + contributing/scripts/lib/lint.sh | 53 ++ contributing/scripts/lib/tests.sh | 34 + contributing/scripts/self-test.sh | 15 + docker/Dockerfile | 25 + docker/requirements-testing.txt | 6 + examples/basic.py | 323 ++++---- examples/blueprints.py | 352 ++++----- examples/inheritance.py | 90 +-- flask_restful_swagger/__init__.py | 6 +- flask_restful_swagger/swagger.py | 850 ++++++++++++---------- setup.py | 41 +- tests/__init__.py | 0 tests/__init__.pyc | Bin 0 -> 152 bytes tests/test_placeholder.py | 3 + tox.ini | 15 + 27 files changed, 1384 insertions(+), 802 deletions(-) create mode 100644 .coveragerc create mode 100644 .dockerignore create mode 100644 .flake8 create mode 100644 Pipfile create mode 100644 contributing/README.md create mode 100755 contributing/scripts/commander.sh create mode 100644 contributing/scripts/dev create mode 100755 contributing/scripts/hooks/post-merge create mode 100755 contributing/scripts/hooks/pre-commit create mode 100644 contributing/scripts/lib/common.sh create mode 100644 contributing/scripts/lib/documentation.sh create mode 100644 contributing/scripts/lib/lint.sh create mode 100644 contributing/scripts/lib/tests.sh create mode 100755 contributing/scripts/self-test.sh create mode 100644 docker/Dockerfile create mode 100644 docker/requirements-testing.txt create mode 100644 tests/__init__.py create mode 100644 tests/__init__.pyc create mode 100644 tests/test_placeholder.py create mode 100644 tox.ini diff --git a/.coveragerc b/.coveragerc new file mode 100644 index 0000000..e354f83 --- /dev/null +++ b/.coveragerc @@ -0,0 +1,14 @@ +[run] +branch = True +omit = */contributing* + */docker/* + tests/* + setup.py +source = . + +[report] +precision = 1 +show_missing = True +ignore_errors = True +exclude_lines = + no cover diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..5ed5d60 --- /dev/null +++ b/.dockerignore @@ -0,0 +1,5 @@ +.tox +.pytest_cache +tests/__pycache__ +__pycache__ +*.pyc diff --git a/.flake8 b/.flake8 new file mode 100644 index 0000000..7920682 --- /dev/null +++ b/.flake8 @@ -0,0 +1,8 @@ +[flake8] + +ignore = E203, W503, W605 +max-line-length = 80 +max-complexity = 12 + +exclude = + .git diff --git a/.gitignore b/.gitignore index 3d51968..6e9d9d6 100644 --- a/.gitignore +++ b/.gitignore @@ -1,22 +1,12 @@ -*.py[cod] - -# C extensions -*.so - # Packages *.egg *.egg-info dist build eggs -parts -bin -var sdist develop-eggs .installed.cfg -lib -lib64 __pycache__ # Installer logs @@ -30,9 +20,4 @@ nosetests.xml # Translations *.mo -# Mr Developer -.mr.developer.cfg -.project -.pydevproject - -*.iml +.tox diff --git a/Pipfile b/Pipfile new file mode 100644 index 0000000..9534830 --- /dev/null +++ b/Pipfile @@ -0,0 +1,11 @@ +[[source]] +name = "pypi" +url = "https://pypi.org/simple" +verify_ssl = true + +[dev-packages] + +[packages] + +[requires] +python_version = "3.6" diff --git a/contributing/README.md b/contributing/README.md new file mode 100644 index 0000000..e90671d --- /dev/null +++ b/contributing/README.md @@ -0,0 +1,49 @@ +# Contribution Guide + +## Development Environment: + +#### You'll need to install the following dependencies: + +1) shellcheck +2) python 3.6 +3) pipenv + + +#### On OSX This looks like: +```bash +$ brew install shellcheck pipenv +``` + +## Recommend Installing ASDF to manage Python Versions + +```bash +$ git clone https://github.com/asdf-vm/asdf.git ~/.asdf --branch v0.7.5 +``` + +## Use ASDF To Install Python 3.6.0 + +```bash +$ git clone https://github.com/asdf-vm/asdf.git ~/.asdf --branch v0.7.5 +$ source contributing/scripts/dev +$ asdf install python 3.6.0 +``` + +## Use the dev scripts to help you work with the code base + +```bash +$ source contributing/scripts/dev +$ dev +Valid Commands: + - lint [time] [v] + - pipeline + - setup + - shell + - test +``` + +## Setup a dev environment + +```bash +$ source contributing/scripts/dev +$ dev setup +``` diff --git a/contributing/scripts/commander.sh b/contributing/scripts/commander.sh new file mode 100755 index 0000000..34d1874 --- /dev/null +++ b/contributing/scripts/commander.sh @@ -0,0 +1,65 @@ +#!/bin/bash + +set -e + +PROJECTHOME="$(git rev-parse --show-toplevel)" +PROJECTNAME="flask_restful_swagger" + +export PROJECTHOME +export PROJECTNAME + +cd "${PROJECTHOME}" + +# shellcheck source=contributing/scripts/lib/common.sh +source "$( dirname "${BASH_SOURCE[0]}" )/lib/common.sh" + +# shellcheck source=contributing/scripts/lib/documentation.sh +source "$( dirname "${BASH_SOURCE[0]}" )/lib/documentation.sh" + +# shellcheck source=contributing/scripts/lib/lint.sh +source "$( dirname "${BASH_SOURCE[0]}" )/lib/lint.sh" + +# shellcheck source=contributing/scripts/lib/tests.sh +source "$( dirname "${BASH_SOURCE[0]}" )/lib/tests.sh" + + +help() { + echo "${PROJECTNAME}" +} + + +case $1 in + 'lint') + shift + lint "$@" + ;; + 'pipeline') + shift + pipline "$@" + ;; + 'setup') + shift + setup_python "$@" + ;; + 'shell') + shift + source_enviroment + pipenv shell + ;; + 'test') + shift + unittests "$@" + ;; + 'shortlist') + echo "lint pipeline setup shell test" + ;; + *) + echo "Valid Commands:" + echo ' - lint [time] [v]' + echo ' - pipeline' + echo ' - setup' + echo ' - shell' + echo ' - test' + ;; + +esac diff --git a/contributing/scripts/dev b/contributing/scripts/dev new file mode 100644 index 0000000..d757893 --- /dev/null +++ b/contributing/scripts/dev @@ -0,0 +1,35 @@ +#!/bin/bash + +# ASDF +if [[ -f "${HOME}/.asdf/asdf.sh" ]]; then + # shellcheck disable=SC1090 + . "${HOME}/.asdf/asdf.sh" +fi + +_script() +{ + + shopt -s expand_aliases + _script_commands=$(dev shortlist) + + local cur + COMPREPLY=() + cur="${COMP_WORDS[COMP_CWORD]}" + + while IFS='' read -r line; do COMPREPLY+=("$line"); done < <(compgen -W "${_script_commands}" -- "${cur}") + return 0 + +} + +complete -o nospace -F _script dev + +dev_identifier() { + Cyan='\033[36m' # Cyan + BRed='\033[31m' # Red + BGreen='\033[32m' # Green + NC="\033[0m" # Color Reset + echo -en "(${BGreen}flask-restful-swagger${NC})" +} + +alias dev='$(git rev-parse --show-toplevel)/contributing/scripts/commander.sh' +PROMPT_COMMAND="dev_identifier; $PROMPT_COMMAND" diff --git a/contributing/scripts/hooks/post-merge b/contributing/scripts/hooks/post-merge new file mode 100755 index 0000000..b709d2b --- /dev/null +++ b/contributing/scripts/hooks/post-merge @@ -0,0 +1,28 @@ +#!/bin/bash + +set -eo pipefail + +# Get the current branch name +BRANCH_NAME="$(git rev-parse --abbrev-ref HEAD)" + +if [[ "$BRANCH_NAME" == "master" || "$BRANCH_NAME" == "develop" ]]; then + + exec < /dev/tty + echo "WARNING: You have just merged code into a protected branch." + read -r -p "Type 'yes' to confirm: " confirm + + if [[ $confirm == "yes" ]]; then + + bash scripts/commander.sh lint + bash scripts/commander.sh test + bash scripts/commander.sh sectest + + else + + git reset --soft 'HEAD@{1}' + echo "Aborted Commit" + exit 127 + + fi + +fi diff --git a/contributing/scripts/hooks/pre-commit b/contributing/scripts/hooks/pre-commit new file mode 100755 index 0000000..a15ee69 --- /dev/null +++ b/contributing/scripts/hooks/pre-commit @@ -0,0 +1,46 @@ +#!/bin/bash + +set -eo pipefail + +clean() { + + bash scripts/commander.sh lint + +} + +main() { + + BRANCH=$(git symbolic-ref --short HEAD) + if [[ "$BRANCH" == "master" || "$BRANCH" == "develop" ]]; then + + exec < /dev/tty + echo "WARNING: You are on a protected branch!" + read -r -p "Type 'yes' to confirm: " confirm + [[ $confirm != "yes" ]] && echo 'ABORTED' && exit 127 + + clean + bash scripts/commander.sh test + bash scripts/commander.sh sectest + + else + + clean + + fi + + if [[ -n "$(git diff)" ]]; then + + git status + + exec < /dev/tty + echo -e "\nWARNING: You have uncommitted changes, that could be a result of yapf formatting." + read -r -p "Type 'yes' to confirm you wish to proceed with this commit: " confirm + [[ $confirm != "yes" ]] && echo 'ABORTED' && exit 127 + + exit 0 + + fi + +} + +main diff --git a/contributing/scripts/lib/common.sh b/contributing/scripts/lib/common.sh new file mode 100644 index 0000000..5387eb8 --- /dev/null +++ b/contributing/scripts/lib/common.sh @@ -0,0 +1,56 @@ +#!/bin/bash + +setup_python() { + + unvirtualize + + pushd "${PROJECTHOME}" > /dev/null + set +e + pipenv --rm + set -e + pipenv --python 3.6 + source_enviroment + pip install -r docker/requirements-testing.txt + unvirtualize + popd > /dev/null + +} + +source_enviroment() { + + set -e + + [[ "$1" == "build" ]] && return + + unvirtualize + + # shellcheck disable=SC1090 + source "$(pipenv --venv)/bin/activate" + + pushd "${PROJECTHOME}" > /dev/null + cd .git/hooks + ln -sf ../../scripts/hooks/pre-commit pre-commit + ln -sf ../../scripts/hooks/post-merge post-merge + popd > /dev/null + + set +e + +} + +unvirtualize() { + + toggle=1 + + if [[ -n "${-//[^e]/}" ]]; then set +e; else toggle=0; fi + if python -c 'import sys; sys.exit(0 if hasattr(sys, "real_prefix") else 1)'; then + deactivate_present=$(LC_ALL=C type deactivate 2>/dev/null) + if [[ -n ${deactivate_present} ]]; then + deactivate + else + echo "Exit your shell before you attempt this action." + exit 127 + fi + fi + if [[ "${toggle}" == "1" ]]; then set -e; fi + +} diff --git a/contributing/scripts/lib/documentation.sh b/contributing/scripts/lib/documentation.sh new file mode 100644 index 0000000..c266191 --- /dev/null +++ b/contributing/scripts/lib/documentation.sh @@ -0,0 +1,39 @@ +#!/bin/bash + +set -e + +build_documentation() { + + echo "Generating Documentation ..." + + source_enviroment + + set -e + + pushd "${PROJECTHOME}/${PROJECTNAME}" > /dev/null + rm -rf documentation-build + make html + popd > /dev/null + +} + +deploy_documentation() { + + echo "Deploying Documentation ..." + + source_enviroment + + set -e + + pushd "${PROJECTHOME}/${PROJECTNAME}" > /dev/null + current_branch="$(git rev-parse --abbrev-ref HEAD)" + git checkout --orphan gh-pages + touch documentation-build/html/.nojekyll + git add -f "documentation-build" + git commit -n -m 'Documentation' + git push -fu origin gh-pages + git checkout "${current_branch}" + git branch -D gh-pages + popd > /dev/null + +} \ No newline at end of file diff --git a/contributing/scripts/lib/lint.sh b/contributing/scripts/lib/lint.sh new file mode 100644 index 0000000..0fcc640 --- /dev/null +++ b/contributing/scripts/lib/lint.sh @@ -0,0 +1,53 @@ +#!/bin/bash + +set -e + +background_pylint() { + bash ./scripts/lib/pylint.sh "${1}" +} + +lint() { + + if [[ "$1" == 'time' ]]; then + shift + TIMINGS="TIMINGS" + fi + + if [[ "$1" == 'v' ]]; then + VERBOSE_ISORT=() + VERBOSE_BLACK=("-v") + else + VERBOSE_ISORT=("-q") + VERBOSE_BLACK=() + fi + + MYPYPATH="${PROJECTNAME}/stubs/" + export MYPYPATH + + source_enviroment + + set -e + + shellcheck -x contributing/scripts/*.sh + shellcheck -x contributing/scripts/lib/*.sh + shellcheck -x contributing/scripts/hooks/* + + # Code Cleaners + echo '- black ...' + black "${VERBOSE_BLACK[@]}" -q -l 80 examples + black "${VERBOSE_BLACK[@]}" -q -l 80 flask_restful_swagger + black "${VERBOSE_BLACK[@]}" -q -l 80 setup.py + + echo '- isort ...' + isort "${VERBOSE_ISORT[@]}" -y + + echo '- flake8 ...' + if [[ -z "${TIMINGS}" ]]; then + flake8 + else + time flake8 + fi + + set +e + +} diff --git a/contributing/scripts/lib/tests.sh b/contributing/scripts/lib/tests.sh new file mode 100644 index 0000000..ec14b1d --- /dev/null +++ b/contributing/scripts/lib/tests.sh @@ -0,0 +1,34 @@ +#!/bin/bash + +set -e + + +coverage_report() { + coverage html --fail-under=100 + [[ -n $1 ]] && coverage report -m | grep "$( echo "$1" | sed 's/\./\//g')" | grep -v "100.0%" +} + +sectests() { + + source_enviroment + + set -e + + bandit -r "${PROJECTNAME}" -c "${PROJECTNAME}"/.bandit.rc + pushd "${PROJECTNAME}" > /dev/null + safety check + popd > /dev/null + + set +e + +} + +unittests() { + + source_enviroment + + pushd "${PROJECTHOME}" > /dev/null + pytest --cov=. . + popd > /dev/null + +} \ No newline at end of file diff --git a/contributing/scripts/self-test.sh b/contributing/scripts/self-test.sh new file mode 100755 index 0000000..c5882ce --- /dev/null +++ b/contributing/scripts/self-test.sh @@ -0,0 +1,15 @@ +#!/bin/bash + +set -exa + +echo '- black ...' +black --check -l 80 examples +black --check -l 80 flask_restful_swagger +black --check -l 80 setup.py + +echo '- isort ...' +isort -c "${VERBOSE_ISORT[@]}" -y + +echo '- flake8 ...' +flake8 flask_restful_swagger +flake8 examples diff --git a/docker/Dockerfile b/docker/Dockerfile new file mode 100644 index 0000000..10b4de5 --- /dev/null +++ b/docker/Dockerfile @@ -0,0 +1,25 @@ +FROM python:3.6.9-alpine3.10 +MAINTAINER Niall Byrne + +ARG RUNTIME_USER=restful +ARG USER_UID=501 + +# Install the build-base system packages +RUN apk add --no-cache \ + bash \ + gcc \ + musl-dev \ + python \ + python-dev + +RUN mkdir -p /home/${RUNTIME_USER}/code +WORKDIR /home/${RUNTIME_USER}/code + +COPY . /home/${RUNTIME_USER}/code + + +RUN pip3 install -r /home/${RUNTIME_USER}/code/docker/requirements-testing.txt +RUN bash /home/${RUNTIME_USER}/code/contributing/scripts/self-test.sh + +RUN pip install tox +RUN tox diff --git a/docker/requirements-testing.txt b/docker/requirements-testing.txt new file mode 100644 index 0000000..6f36383 --- /dev/null +++ b/docker/requirements-testing.txt @@ -0,0 +1,6 @@ +black==19.10b0 +flake8==3.7.9 +isort==4.3.21 +Flask-RESTful>=0.3.6 +pytest-cover==3.0.0 +tox==3.14.1 diff --git a/examples/basic.py b/examples/basic.py index 468c602..1c2b9f2 100644 --- a/examples/basic.py +++ b/examples/basic.py @@ -1,81 +1,89 @@ -''' +""" Running: PYTHONPATH=. python examples/basic.py -''' +""" from flask import Flask, redirect -from flask_restful import reqparse, abort, Api, Resource, fields,\ - marshal_with +from flask_restful import Api, Resource, abort, fields, marshal_with, reqparse + from flask_restful_swagger import swagger -app = Flask(__name__, static_folder='../static') +app = Flask(__name__, static_folder="../static") ################################### # This is important: -api = swagger.docs(Api(app), apiVersion='0.1', - basePath='http://localhost:5000', - resourcePath='/', - produces=["application/json", "text/html"], - api_spec_url='/api/spec', - description='A Basic API') +api = swagger.docs( + Api(app), + apiVersion="0.1", + basePath="http://localhost:5000", + resourcePath="/", + produces=["application/json", "text/html"], + api_spec_url="/api/spec", + description="A Basic API", +) ################################### TODOS = { - 'todo1': {'task': 'build an API'}, - 'todo2': {'task': '?????'}, - 'todo3': {'task': 'profit!'}, + "todo1": {"task": "build an API"}, + "todo2": {"task": "?????"}, + "todo3": {"task": "profit!"}, } def abort_if_todo_doesnt_exist(todo_id): - if todo_id not in TODOS: - abort(404, message="Todo {} doesn't exist".format(todo_id)) + if todo_id not in TODOS: + abort(404, message="Todo {} doesn't exist".format(todo_id)) + parser = reqparse.RequestParser() -parser.add_argument('task', type=str) +parser.add_argument("task", type=str) @swagger.model class TodoItem: - """This is an example of a model class that has parameters in its constructor + """This is an example of a model class that has parameters in its constructor and the fields in the swagger spec are derived from the parameters to __init__. In this case we would have args, arg2 as required parameters and arg3 as optional parameter.""" - def __init__(self, arg1, arg2, arg3='123'): - pass + + def __init__(self, arg1, arg2, arg3="123"): + pass + class Todo(Resource): - "My TODO API" - @swagger.operation( - notes='get a todo item by ID', - nickname='get', - # Parameters can be automatically extracted from URLs (e.g. ) - # but you could also override them here, or add other parameters. - parameters=[ - { - "name": "todo_id_x", - "description": "The ID of the TODO item", - "required": True, - "allowMultiple": False, - "dataType": 'string', - "paramType": "path" - }, - { - "name": "a_bool", - "description": "The ID of the TODO item", - "required": True, - "allowMultiple": False, - "dataType": 'boolean', - "paramType": "path" - } - ]) - def get(self, todo_id): - # This goes into the summary - """Get a todo task + "My TODO API" + + @swagger.operation( + notes="get a todo item by ID", + nickname="get", + # Parameters can be automatically extracted from URLs (e.g. ) + # but you could also override them here, or add other parameters. + parameters=[ + { + "name": "todo_id_x", + "description": "The ID of the TODO item", + "required": True, + "allowMultiple": False, + "dataType": "string", + "paramType": "path", + }, + { + "name": "a_bool", + "description": "The ID of the TODO item", + "required": True, + "allowMultiple": False, + "dataType": "boolean", + "paramType": "path", + }, + ], + ) + def get(self, todo_id): + # This goes into the summary + """Get a todo task This will be added to the Implementation Notes. It lets you put very long text in your api. @@ -88,138 +96,141 @@ def get(self, todo_id): cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. """ - abort_if_todo_doesnt_exist(todo_id) - return TODOS[todo_id], 200, {'Access-Control-Allow-Origin': '*'} - - @swagger.operation( - notes='delete a todo item by ID', - ) - def delete(self, todo_id): - abort_if_todo_doesnt_exist(todo_id) - del TODOS[todo_id] - return '', 204, {'Access-Control-Allow-Origin': '*'} - - @swagger.operation( - notes='edit a todo item by ID', - ) - def put(self, todo_id): - args = parser.parse_args() - task = {'task': args['task']} - TODOS[todo_id] = task - return task, 201, {'Access-Control-Allow-Origin': '*'} - - def options (self, **args): - # since this method is not decorated with @swagger.operation it does not - # get added to the swagger docs - return {'Allow' : 'GET,PUT,POST,DELETE' }, 200, \ - { 'Access-Control-Allow-Origin': '*', \ - 'Access-Control-Allow-Methods': 'GET,PUT,POST,DELETE', \ - 'Access-Control-Allow-Headers': 'Content-Type' } + abort_if_todo_doesnt_exist(todo_id) + return TODOS[todo_id], 200, {"Access-Control-Allow-Origin": "*"} + + @swagger.operation(notes="delete a todo item by ID",) + def delete(self, todo_id): + abort_if_todo_doesnt_exist(todo_id) + del TODOS[todo_id] + return "", 204, {"Access-Control-Allow-Origin": "*"} + + @swagger.operation(notes="edit a todo item by ID",) + def put(self, todo_id): + args = parser.parse_args() + task = {"task": args["task"]} + TODOS[todo_id] = task + return task, 201, {"Access-Control-Allow-Origin": "*"} + + def options(self, **args): + # since this method is not decorated with @swagger.operation it does not + # get added to the swagger docs + return ( + {"Allow": "GET,PUT,POST,DELETE"}, + 200, + { + "Access-Control-Allow-Origin": "*", + "Access-Control-Allow-Methods": "GET,PUT,POST,DELETE", + "Access-Control-Allow-Headers": "Content-Type", + }, + ) + # TodoList # shows a list of all todos, and lets you POST to add new tasks class TodoList(Resource): + def get(self): + return TODOS, 200, {"Access-Control-Allow-Origin": "*"} + + @swagger.operation( + notes="Creates a new TODO item", + responseClass=TodoItem.__name__, + nickname="create", + parameters=[ + { + "name": "body", + "description": "A TODO item", + "required": True, + "allowMultiple": False, + "dataType": TodoItem.__name__, + "paramType": "body", + } + ], + responseMessages=[ + { + "code": 201, + "message": "Created. The URL of the created blueprint should " + + "be in the Location header", + }, + {"code": 405, "message": "Invalid input"}, + ], + ) + def post(self): + args = parser.parse_args() + todo_id = "todo%d" % (len(TODOS) + 1) + TODOS[todo_id] = {"task": args["task"]} + return TODOS[todo_id], 201, {"Access-Control-Allow-Origin": "*"} - def get(self): - return TODOS, 200, {'Access-Control-Allow-Origin': '*'} - - @swagger.operation( - notes='Creates a new TODO item', - responseClass=TodoItem.__name__, - nickname='create', - parameters=[ - { - "name": "body", - "description": "A TODO item", - "required": True, - "allowMultiple": False, - "dataType": TodoItem.__name__, - "paramType": "body" - } - ], - responseMessages=[ - { - "code": 201, - "message": "Created. The URL of the created blueprint should " + - "be in the Location header" - }, - { - "code": 405, - "message": "Invalid input" - } - ]) - def post(self): - args = parser.parse_args() - todo_id = 'todo%d' % (len(TODOS) + 1) - TODOS[todo_id] = {'task': args['task']} - return TODOS[todo_id], 201, {'Access-Control-Allow-Origin': '*'} @swagger.model class ModelWithResourceFields: - resource_fields = { - 'a_string': fields.String() - } + resource_fields = {"a_string": fields.String()} + @swagger.model @swagger.nested( - a_nested_attribute=ModelWithResourceFields.__name__, - a_list_of_nested_types=ModelWithResourceFields.__name__) + a_nested_attribute=ModelWithResourceFields.__name__, + a_list_of_nested_types=ModelWithResourceFields.__name__, +) class TodoItemWithResourceFields: - """This is an example of how Output Fields work + """This is an example of how Output Fields work (http://flask-restful.readthedocs.org/en/latest/fields.html). Output Fields lets you add resource_fields to your model in which you specify the output of the model when it gets sent as an HTTP response. flask-restful-swagger takes advantage of this to specify the fields in the model""" - resource_fields = { - 'a_string': fields.String(attribute='a_string_field_name'), - 'a_formatted_string': fields.FormattedString, - 'an_enum': fields.String, - 'an_int': fields.Integer, - 'a_bool': fields.Boolean, - 'a_url': fields.Url, - 'a_float': fields.Float, - 'an_float_with_arbitrary_precision': fields.Arbitrary, - 'a_fixed_point_decimal': fields.Fixed, - 'a_datetime': fields.DateTime, - 'a_list_of_strings': fields.List(fields.String), - 'a_nested_attribute': fields.Nested(ModelWithResourceFields.resource_fields), - 'a_list_of_nested_types': fields.List(fields.Nested(ModelWithResourceFields.resource_fields)), - } - - # Specify which of the resource fields are required - required = ['a_string'] - - swagger_metadata = { - 'an_enum': { - 'enum': ['one', 'two', 'three'] - } - } + + resource_fields = { + "a_string": fields.String(attribute="a_string_field_name"), + "a_formatted_string": fields.FormattedString, + "an_enum": fields.String, + "an_int": fields.Integer, + "a_bool": fields.Boolean, + "a_url": fields.Url, + "a_float": fields.Float, + "an_float_with_arbitrary_precision": fields.Arbitrary, + "a_fixed_point_decimal": fields.Fixed, + "a_datetime": fields.DateTime, + "a_list_of_strings": fields.List(fields.String), + "a_nested_attribute": fields.Nested( + ModelWithResourceFields.resource_fields + ), + "a_list_of_nested_types": fields.List( + fields.Nested(ModelWithResourceFields.resource_fields) + ), + } + + # Specify which of the resource fields are required + required = ["a_string"] + + swagger_metadata = {"an_enum": {"enum": ["one", "two", "three"]}} + class MarshalWithExample(Resource): - @swagger.operation( - notes='get something', - responseClass=TodoItemWithResourceFields, - nickname='get') - @marshal_with(TodoItemWithResourceFields.resource_fields) - def get(self, **kwargs): - return {}, 200, {'Access-Control-Allow-Origin': '*'} + @swagger.operation( + notes="get something", + responseClass=TodoItemWithResourceFields, + nickname="get", + ) + @marshal_with(TodoItemWithResourceFields.resource_fields) + def get(self, **kwargs): + return {}, 200, {"Access-Control-Allow-Origin": "*"} -## -## Actually setup the Api resource routing here -## -api.add_resource(TodoList, '/todos') -api.add_resource(Todo, '/todos/') -api.add_resource(MarshalWithExample, '/marshal_with') +# +# Actually setup the Api resource routing here +# +api.add_resource(TodoList, "/todos") +api.add_resource(Todo, "/todos/") +api.add_resource(MarshalWithExample, "/marshal_with") -@app.route('/docs') +@app.route("/docs") def docs(): - return redirect('/static/docs.html') + return redirect("/static/docs.html") -if __name__ == '__main__': - TodoItemWithResourceFields() - TodoItem(1, 2, '3') - app.run(debug=True) +if __name__ == "__main__": + TodoItemWithResourceFields() + TodoItem(1, 2, "3") + app.run(debug=True) diff --git a/examples/blueprints.py b/examples/blueprints.py index ce5b85f..1daabe2 100644 --- a/examples/blueprints.py +++ b/examples/blueprints.py @@ -1,91 +1,102 @@ -''' +""" Running: PYTHONPATH=. python examples/basic.py Goto: http://127.0.0.1:5000/api2/api/spec.html -''' +""" -from flask import Flask, redirect, Blueprint -from flask_restful import reqparse, abort, Api, Resource, fields,\ - marshal_with +from flask import Blueprint, Flask, redirect +from flask_restful import Api, Resource, abort, fields, marshal_with, reqparse + from flask_restful_swagger import swagger -app = Flask(__name__, static_folder='../static') -my_blueprint1 = Blueprint('my_blueprint1', __name__) -my_blueprint2 = Blueprint('my_blueprint2', __name__) +app = Flask(__name__, static_folder="../static") +my_blueprint1 = Blueprint("my_blueprint1", __name__) +my_blueprint2 = Blueprint("my_blueprint2", __name__) ################################### # This is important: -api1 = swagger.docs(Api(my_blueprint1), apiVersion='0.1', - basePath='http://localhost:5000', - resourcePath='/', - produces=["application/json", "text/html"], - api_spec_url='/api/spec', - description='Blueprint1 Description') -api2 = swagger.docs(Api(my_blueprint2), apiVersion='0.1', - basePath='http://localhost:5000', - resourcePath='/', - produces=["application/json", "text/html"], - api_spec_url='/api/spec', - description='Blueprint2 Description') +api1 = swagger.docs( + Api(my_blueprint1), + apiVersion="0.1", + basePath="http://localhost:5000", + resourcePath="/", + produces=["application/json", "text/html"], + api_spec_url="/api/spec", + description="Blueprint1 Description", +) +api2 = swagger.docs( + Api(my_blueprint2), + apiVersion="0.1", + basePath="http://localhost:5000", + resourcePath="/", + produces=["application/json", "text/html"], + api_spec_url="/api/spec", + description="Blueprint2 Description", +) ################################### TODOS = { - 'todo1': {'task': 'build an API'}, - 'todo2': {'task': '?????'}, - 'todo3': {'task': 'profit!'}, + "todo1": {"task": "build an API"}, + "todo2": {"task": "?????"}, + "todo3": {"task": "profit!"}, } def abort_if_todo_doesnt_exist(todo_id): - if todo_id not in TODOS: - abort(404, message="Todo {} doesn't exist".format(todo_id)) + if todo_id not in TODOS: + abort(404, message="Todo {} doesn't exist".format(todo_id)) + parser = reqparse.RequestParser() -parser.add_argument('task', type=str) +parser.add_argument("task", type=str) @swagger.model class TodoItem: - """This is an example of a model class that has parameters in its constructor + """This is an example of a model class that has parameters in its constructor and the fields in the swagger spec are derived from the parameters to __init__. In this case we would have args, arg2 as required parameters and arg3 as optional parameter.""" - def __init__(self, arg1, arg2, arg3='123'): - pass + + def __init__(self, arg1, arg2, arg3="123"): + pass + class Todo(Resource): - "My TODO API" - @swagger.operation( - notes='get a todo item by ID', - nickname='get', - # Parameters can be automatically extracted from URLs (e.g. ) - # but you could also override them here, or add other parameters. - parameters=[ - { - "name": "todo_id_x", - "description": "The ID of the TODO item", - "required": True, - "allowMultiple": False, - "dataType": 'string', - "paramType": "path" - }, - { - "name": "a_bool", - "description": "The ID of the TODO item", - "required": True, - "allowMultiple": False, - "dataType": 'boolean', - "paramType": "path" - } - ]) - def get(self, todo_id): - # This goes into the summary - """Get a todo task + "My TODO API" + + @swagger.operation( + notes="get a todo item by ID", + nickname="get", + # Parameters can be automatically extracted from URLs (e.g. ) + # but you could also override them here, or add other parameters. + parameters=[ + { + "name": "todo_id_x", + "description": "The ID of the TODO item", + "required": True, + "allowMultiple": False, + "dataType": "string", + "paramType": "path", + }, + { + "name": "a_bool", + "description": "The ID of the TODO item", + "required": True, + "allowMultiple": False, + "dataType": "boolean", + "paramType": "path", + }, + ], + ) + def get(self, todo_id): + # This goes into the summary + """Get a todo task This will be added to the Implementation Notes. It let's you put very long text in your api. @@ -98,136 +109,143 @@ def get(self, todo_id): cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. """ - abort_if_todo_doesnt_exist(todo_id) - return TODOS[todo_id], 200, {'Access-Control-Allow-Origin': '*'} - - @swagger.operation( - notes='delete a todo item by ID', - ) - def delete(self, todo_id): - abort_if_todo_doesnt_exist(todo_id) - del TODOS[todo_id] - return '', 204, {'Access-Control-Allow-Origin': '*'} - - @swagger.operation( - notes='edit a todo item by ID', - ) - def put(self, todo_id): - args = parser.parse_args() - task = {'task': args['task']} - TODOS[todo_id] = task - return task, 201, {'Access-Control-Allow-Origin': '*'} - - def options (self, **args): - # since this method is not decorated with @swagger.operation it does not - # get added to the swagger docs - return {'Allow' : 'GET,PUT,POST,DELETE' }, 200, \ - { 'Access-Control-Allow-Origin': '*', \ - 'Access-Control-Allow-Methods': 'GET,PUT,POST,DELETE', \ - 'Access-Control-Allow-Headers': 'Content-Type' } + abort_if_todo_doesnt_exist(todo_id) + return TODOS[todo_id], 200, {"Access-Control-Allow-Origin": "*"} + + @swagger.operation(notes="delete a todo item by ID",) + def delete(self, todo_id): + abort_if_todo_doesnt_exist(todo_id) + del TODOS[todo_id] + return "", 204, {"Access-Control-Allow-Origin": "*"} + + @swagger.operation(notes="edit a todo item by ID",) + def put(self, todo_id): + args = parser.parse_args() + task = {"task": args["task"]} + TODOS[todo_id] = task + return task, 201, {"Access-Control-Allow-Origin": "*"} + + def options(self, **args): + # since this method is not decorated with @swagger.operation it does not + # get added to the swagger docs + return ( + {"Allow": "GET,PUT,POST,DELETE"}, + 200, + { + "Access-Control-Allow-Origin": "*", + "Access-Control-Allow-Methods": "GET,PUT,POST,DELETE", + "Access-Control-Allow-Headers": "Content-Type", + }, + ) + # TodoList # shows a list of all todos, and lets you POST to add new tasks class TodoList(Resource): + def get(self): + return TODOS, 200, {"Access-Control-Allow-Origin": "*"} + + @swagger.operation( + notes="Creates a new TODO item", + responseClass=TodoItem.__name__, + nickname="create", + parameters=[ + { + "name": "body", + "description": "A TODO item", + "required": True, + "allowMultiple": False, + "dataType": TodoItem.__name__, + "paramType": "body", + } + ], + responseMessages=[ + { + "code": 201, + "message": "Created. The URL of the created blueprint should " + + "be in the Location header", + }, + {"code": 405, "message": "Invalid input"}, + ], + ) + def post(self): + args = parser.parse_args() + todo_id = "todo%d" % (len(TODOS) + 1) + TODOS[todo_id] = {"task": args["task"]} + return TODOS[todo_id], 201, {"Access-Control-Allow-Origin": "*"} - def get(self): - return TODOS, 200, {'Access-Control-Allow-Origin': '*'} - - @swagger.operation( - notes='Creates a new TODO item', - responseClass=TodoItem.__name__, - nickname='create', - parameters=[ - { - "name": "body", - "description": "A TODO item", - "required": True, - "allowMultiple": False, - "dataType": TodoItem.__name__, - "paramType": "body" - } - ], - responseMessages=[ - { - "code": 201, - "message": "Created. The URL of the created blueprint should " + - "be in the Location header" - }, - { - "code": 405, - "message": "Invalid input" - } - ]) - def post(self): - args = parser.parse_args() - todo_id = 'todo%d' % (len(TODOS) + 1) - TODOS[todo_id] = {'task': args['task']} - return TODOS[todo_id], 201, {'Access-Control-Allow-Origin': '*'} @swagger.model class ModelWithResourceFields: - resource_fields = { - 'a_string': fields.String() - } + resource_fields = {"a_string": fields.String()} + @swagger.model @swagger.nested( - a_nested_attribute=ModelWithResourceFields.__name__, - a_list_of_nested_types=ModelWithResourceFields.__name__) + a_nested_attribute=ModelWithResourceFields.__name__, + a_list_of_nested_types=ModelWithResourceFields.__name__, +) class TodoItemWithResourceFields: - """This is an example of how Output Fields work + """This is an example of how Output Fields work (http://flask-restful.readthedocs.org/en/latest/fields.html). Output Fields lets you add resource_fields to your model in which you specify the output of the model when it gets sent as an HTTP response. flask-restful-swagger takes advantage of this to specify the fields in the model""" - resource_fields = { - 'a_string': fields.String(attribute='a_string_field_name'), - 'a_formatted_string': fields.FormattedString, - 'an_int': fields.Integer, - 'a_bool': fields.Boolean, - 'a_url': fields.Url, - 'a_float': fields.Float, - 'an_float_with_arbitrary_precision': fields.Arbitrary, - 'a_fixed_point_decimal': fields.Fixed, - 'a_datetime': fields.DateTime, - 'a_list_of_strings': fields.List(fields.String), - 'a_nested_attribute': fields.Nested(ModelWithResourceFields.resource_fields), - 'a_list_of_nested_types': fields.List(fields.Nested(ModelWithResourceFields.resource_fields)), - } - - # Specify which of the resource fields are required - required = ['a_string'] + + resource_fields = { + "a_string": fields.String(attribute="a_string_field_name"), + "a_formatted_string": fields.FormattedString, + "an_int": fields.Integer, + "a_bool": fields.Boolean, + "a_url": fields.Url, + "a_float": fields.Float, + "an_float_with_arbitrary_precision": fields.Arbitrary, + "a_fixed_point_decimal": fields.Fixed, + "a_datetime": fields.DateTime, + "a_list_of_strings": fields.List(fields.String), + "a_nested_attribute": fields.Nested( + ModelWithResourceFields.resource_fields + ), + "a_list_of_nested_types": fields.List( + fields.Nested(ModelWithResourceFields.resource_fields) + ), + } + + # Specify which of the resource fields are required + required = ["a_string"] + class MarshalWithExample(Resource): - @swagger.operation( - notes='get something', - responseClass=TodoItemWithResourceFields, - nickname='get') - @marshal_with(TodoItemWithResourceFields.resource_fields) - def get(self, **kwargs): - return {}, 200, {'Access-Control-Allow-Origin': '*'} - - -## -## Actually setup the Api resource routing here -## -api1.add_resource(TodoList, '/todos1') -api1.add_resource(Todo, '/todos1/') -api1.add_resource(MarshalWithExample, '/marshal_with1') -api2.add_resource(TodoList, '/todos2') -api2.add_resource(Todo, '/todos2/') -api2.add_resource(MarshalWithExample, '/marshal_with2') - - -@app.route('/docs') + @swagger.operation( + notes="get something", + responseClass=TodoItemWithResourceFields, + nickname="get", + ) + @marshal_with(TodoItemWithResourceFields.resource_fields) + def get(self, **kwargs): + return {}, 200, {"Access-Control-Allow-Origin": "*"} + + +# +# Actually setup the Api resource routing here +# +api1.add_resource(TodoList, "/todos1") +api1.add_resource(Todo, "/todos1/") +api1.add_resource(MarshalWithExample, "/marshal_with1") +api2.add_resource(TodoList, "/todos2") +api2.add_resource(Todo, "/todos2/") +api2.add_resource(MarshalWithExample, "/marshal_with2") + + +@app.route("/docs") def docs(): - return redirect('/static/docs.html') + return redirect("/static/docs.html") -if __name__ == '__main__': - TodoItemWithResourceFields() - TodoItem(1, 2, '3') - app.register_blueprint(my_blueprint1, url_prefix='/api1') - app.register_blueprint(my_blueprint2, url_prefix='/api2') - app.run(debug=True) +if __name__ == "__main__": + TodoItemWithResourceFields() + TodoItem(1, 2, "3") + app.register_blueprint(my_blueprint1, url_prefix="/api1") + app.register_blueprint(my_blueprint2, url_prefix="/api2") + app.run(debug=True) diff --git a/examples/inheritance.py b/examples/inheritance.py index c6ccaee..4b646ea 100644 --- a/examples/inheritance.py +++ b/examples/inheritance.py @@ -1,62 +1,68 @@ -''' +""" Running: PYTHONPATH=. python examples/inheritance.py -''' +""" from flask import Flask from flask_restful import Api, Resource + from flask_restful_swagger import swagger -app = Flask(__name__, static_folder='../static') +app = Flask(__name__, static_folder="../static") ################################### # This is important: -api = swagger.docs(Api(app), apiVersion='0.1', - basePath='http://localhost:5000', - resourcePath='/', - produces=["application/json", "text/html"], - api_spec_url='/api/spec', - description='Inheritance demonstration') +api = swagger.docs( + Api(app), + apiVersion="0.1", + basePath="http://localhost:5000", + resourcePath="/", + produces=["application/json", "text/html"], + api_spec_url="/api/spec", + description="Inheritance demonstration", +) ################################### class Base(Resource): - def get(self): - pass + def get(self): + pass - def post(self): - pass + def post(self): + pass - def delete(self): - pass + def delete(self): + pass class Inherited(Base): - @swagger.operation( - notes='just testing inheritance', - nickname='get', - parameters=[ - { - "name": "a_bool", - "description": "The ID of the TODO item", - "required": True, - "allowMultiple": False, - "dataType": 'boolean', - "paramType": "path" - } - ]) - def get(self): - return "hello" - - def post(self): - # wont be visible in the swagger docs - return "world" - -## -## Actually setup the Api resource routing here -## -api.add_resource(Inherited, '/inherited') - -if __name__ == '__main__': - app.run(debug=True) + @swagger.operation( + notes="just testing inheritance", + nickname="get", + parameters=[ + { + "name": "a_bool", + "description": "The ID of the TODO item", + "required": True, + "allowMultiple": False, + "dataType": "boolean", + "paramType": "path", + } + ], + ) + def get(self): + return "hello" + + def post(self): + # wont be visible in the swagger docs + return "world" + + +# +# Actually setup the Api resource routing here +# +api.add_resource(Inherited, "/inherited") + +if __name__ == "__main__": + app.run(debug=True) diff --git a/flask_restful_swagger/__init__.py b/flask_restful_swagger/__init__.py index 5a3a67a..9f32af6 100644 --- a/flask_restful_swagger/__init__.py +++ b/flask_restful_swagger/__init__.py @@ -1,5 +1,3 @@ -registry = { - 'models': {} -} +registry = {"models": {}} -api_spec_static = '' +api_spec_static = "" diff --git a/flask_restful_swagger/swagger.py b/flask_restful_swagger/swagger.py index f9ead0f..536d48e 100644 --- a/flask_restful_swagger/swagger.py +++ b/flask_restful_swagger/swagger.py @@ -2,7 +2,13 @@ import inspect import os import re + import six +from flask import Response, abort, request +from flask_restful import Resource, fields +from jinja2 import Template + +from flask_restful_swagger import api_spec_static, registry try: # urlparse is renamed to urllib.parse in python 3 @@ -11,434 +17,481 @@ from urllib import parse as urlparse -from flask import request, abort, Response -from flask_restful import Resource, fields -from flask_restful_swagger import ( - registry, api_spec_static) -from jinja2 import Template - resource_listing_endpoint = None -def docs(api, apiVersion='0.0', swaggerVersion='1.2', - basePath='http://localhost:5000', - resourcePath='/', - produces=["application/json"], - api_spec_url='/api/spec', - description='Auto generated API docs by flask-restful-swagger'): +def docs( + api, + apiVersion="0.0", + swaggerVersion="1.2", + basePath="http://localhost:5000", + resourcePath="/", + produces=["application/json"], + api_spec_url="/api/spec", + description="Auto generated API docs by flask-restful-swagger", +): + + api_add_resource = api.add_resource - api_add_resource = api.add_resource + def add_resource(resource, *urls, **kvargs): + register_once( + api, + api_add_resource, + apiVersion, + swaggerVersion, + basePath, + resourcePath, + produces, + api_spec_url, + description, + ) - def add_resource(resource, *urls, **kvargs): - register_once(api, api_add_resource, apiVersion, swaggerVersion, basePath, - resourcePath, produces, api_spec_url, description) + resource = make_class(resource) + for url in urls: + endpoint = swagger_endpoint(api, resource, url) - resource = make_class(resource) - for url in urls: - endpoint = swagger_endpoint(api, resource, url) + # Add a .help.json help url + swagger_path = extract_swagger_path(url) - # Add a .help.json help url - swagger_path = extract_swagger_path(url) + # Add a .help.html help url + endpoint_html_str = "{0}/help".format(swagger_path) + api_add_resource( + endpoint, + "{0}.help.json".format(swagger_path), + "{0}.help.html".format(swagger_path), + endpoint=endpoint_html_str, + ) - # Add a .help.html help url - endpoint_html_str = '{0}/help'.format(swagger_path) - api_add_resource( - endpoint, - "{0}.help.json".format(swagger_path), - "{0}.help.html".format(swagger_path), - endpoint=endpoint_html_str) + return api_add_resource(resource, *urls, **kvargs) - return api_add_resource(resource, *urls, **kvargs) + api.add_resource = add_resource - api.add_resource = add_resource + return api - return api rootPath = os.path.dirname(__file__) def make_class(class_or_instance): - if inspect.isclass(class_or_instance): - return class_or_instance - return class_or_instance.__class__ - - -def register_once(api, add_resource_func, apiVersion, swaggerVersion, basePath, - resourcePath, produces, endpoint_path, description): - global api_spec_static - global resource_listing_endpoint - - if api.blueprint and not registry.get(api.blueprint.name): - # Most of all this can be taken from the blueprint/app - registry[api.blueprint.name] = { - 'apiVersion': apiVersion, - 'swaggerVersion': swaggerVersion, - 'basePath': basePath, - 'spec_endpoint_path': endpoint_path, - 'resourcePath': resourcePath, - 'produces': produces, - 'x-api-prefix': '', - 'apis': [], - 'description': description - } + if inspect.isclass(class_or_instance): + return class_or_instance + return class_or_instance.__class__ + + +def register_once( + api, + add_resource_func, + apiVersion, + swaggerVersion, + basePath, + resourcePath, + produces, + endpoint_path, + description, +): + global api_spec_static + global resource_listing_endpoint + + if api.blueprint and not registry.get(api.blueprint.name): + # Most of all this can be taken from the blueprint/app + registry[api.blueprint.name] = { + "apiVersion": apiVersion, + "swaggerVersion": swaggerVersion, + "basePath": basePath, + "spec_endpoint_path": endpoint_path, + "resourcePath": resourcePath, + "produces": produces, + "x-api-prefix": "", + "apis": [], + "description": description, + } - def registering_blueprint(setup_state): - reg = registry[setup_state.blueprint.name] - reg['x-api-prefix'] = setup_state.url_prefix - - api.blueprint.record(registering_blueprint) - - add_resource_func( - SwaggerRegistry, - endpoint_path, - endpoint_path + '.json', - endpoint_path + '.html' - ) - - resource_listing_endpoint = endpoint_path + '/_/resource_list.json' - add_resource_func(ResourceLister, resource_listing_endpoint) - - api_spec_static = endpoint_path + '/_/static/' - add_resource_func( - StaticFiles, - api_spec_static + '//', - api_spec_static + '/', - api_spec_static + '') - elif not 'app' in registry: - registry['app'] = { - 'apiVersion': apiVersion, - 'swaggerVersion': swaggerVersion, - 'basePath': basePath, - 'spec_endpoint_path': endpoint_path, - 'resourcePath': resourcePath, - 'produces': produces, - 'description': description - } + def registering_blueprint(setup_state): + reg = registry[setup_state.blueprint.name] + reg["x-api-prefix"] = setup_state.url_prefix + + api.blueprint.record(registering_blueprint) + + add_resource_func( + SwaggerRegistry, + endpoint_path, + endpoint_path + ".json", + endpoint_path + ".html", + ) + + resource_listing_endpoint = endpoint_path + "/_/resource_list.json" + add_resource_func(ResourceLister, resource_listing_endpoint) + + api_spec_static = endpoint_path + "/_/static/" + add_resource_func( + StaticFiles, + api_spec_static + "//", + api_spec_static + "/", + api_spec_static + "", + ) + elif "app" not in registry: + registry["app"] = { + "apiVersion": apiVersion, + "swaggerVersion": swaggerVersion, + "basePath": basePath, + "spec_endpoint_path": endpoint_path, + "resourcePath": resourcePath, + "produces": produces, + "description": description, + } + + add_resource_func( + SwaggerRegistry, + endpoint_path, + endpoint_path + ".json", + endpoint_path + ".html", + endpoint="app/registry", + ) + + resource_listing_endpoint = endpoint_path + "/_/resource_list.json" + add_resource_func( + ResourceLister, + resource_listing_endpoint, + endpoint="app/resourcelister", + ) + + api_spec_static = endpoint_path + "/_/static/" + add_resource_func( + StaticFiles, + api_spec_static + "//", + api_spec_static + "/", + api_spec_static + "", + endpoint="app/staticfiles", + ) - add_resource_func( - SwaggerRegistry, - endpoint_path, - endpoint_path + '.json', - endpoint_path + '.html', - endpoint='app/registry' - ) - - resource_listing_endpoint = endpoint_path + '/_/resource_list.json' - add_resource_func( - ResourceLister, resource_listing_endpoint, - endpoint='app/resourcelister') - - api_spec_static = endpoint_path + '/_/static/' - add_resource_func( - StaticFiles, - api_spec_static + '//', - api_spec_static + '/', - api_spec_static + '', - endpoint='app/staticfiles') templates = {} def render_endpoint(endpoint): - return render_page("endpoint.html", endpoint.__dict__) + return render_page("endpoint.html", endpoint.__dict__) def render_homepage(resource_list_url): - conf = {'resource_list_url': resource_list_url} - return render_page("index.html", conf) + conf = {"resource_list_url": resource_list_url} + return render_page("index.html", conf) def _get_current_registry(api=None): - # import ipdb;ipdb.set_trace() - global registry - app_name = None - overrides = {} - if api: - app_name = api.blueprint.name if api.blueprint else None - else: - app_name = request.blueprint - urlparts = urlparse.urlparse(request.url_root.rstrip('/')) - proto = request.headers.get("x-forwarded-proto") or urlparts[0] - overrides = {'basePath': urlparse.urlunparse([proto] + list(urlparts[1:]))} + # import ipdb;ipdb.set_trace() + global registry + app_name = None + overrides = {} + if api: + app_name = api.blueprint.name if api.blueprint else None + else: + app_name = request.blueprint + urlparts = urlparse.urlparse(request.url_root.rstrip("/")) + proto = request.headers.get("x-forwarded-proto") or urlparts[0] + overrides = { + "basePath": urlparse.urlunparse([proto] + list(urlparts[1:])), + } - if not app_name: - app_name = 'app' + if not app_name: + app_name = "app" - overrides['models'] = registry.get('models', {}) + overrides["models"] = registry.get("models", {}) - reg = registry.setdefault(app_name, {}) - reg.update(overrides) + reg = registry.setdefault(app_name, {}) + reg.update(overrides) - reg['basePath'] = reg['basePath'] + (reg.get('x-api-prefix', '') or '') + reg["basePath"] = reg["basePath"] + (reg.get("x-api-prefix", "") or "") - return reg + return reg def render_page(page, info): - req_registry = _get_current_registry() - url = req_registry['basePath'] - if url.endswith('/'): - url = url.rstrip('/') - conf = { - 'base_url': url + api_spec_static, - 'full_base_url': url + api_spec_static - } - if info is not None: - conf.update(info) - global templates - if page in templates: - template = templates[page] - else: - with open(os.path.join(rootPath, 'static', page), "r") as fs: - template = Template(fs.read()) - templates[page] = template - mime = 'text/html' - if page.endswith('.js'): - mime = 'text/javascript' - return Response(template.render(conf), mimetype=mime) + req_registry = _get_current_registry() + url = req_registry["basePath"] + if url.endswith("/"): + url = url.rstrip("/") + conf = { + "base_url": url + api_spec_static, + "full_base_url": url + api_spec_static, + } + if info is not None: + conf.update(info) + global templates + if page in templates: + template = templates[page] + else: + with open(os.path.join(rootPath, "static", page), "r") as fs: + template = Template(fs.read()) + templates[page] = template + mime = "text/html" + if page.endswith(".js"): + mime = "text/javascript" + return Response(template.render(conf), mimetype=mime) class StaticFiles(Resource): + def get(self, dir1=None, dir2=None, dir3=None): + req_registry = _get_current_registry() - def get(self, dir1=None, dir2=None, dir3=None): - req_registry = _get_current_registry() - - if dir1 is None: - filePath = "index.html" - else: - filePath = dir1 - if dir2 is not None: - filePath = "%s/%s" % (filePath, dir2) - if dir3 is not None: - filePath = "%s/%s" % (filePath, dir3) - if filePath in [ - "index.html", "o2c.html", "swagger-ui.js", - "swagger-ui.min.js", "lib/swagger-oauth.js"]: - conf = {'resource_list_url': req_registry['spec_endpoint_path']} - return render_page(filePath, conf) - mime = 'text/plain' - if filePath.endswith(".gif"): - mime = 'image/gif' - elif filePath.endswith(".png"): - mime = 'image/png' - elif filePath.endswith(".js"): - mime = 'text/javascript' - elif filePath.endswith(".css"): - mime = 'text/css' - filePath = os.path.join(rootPath, 'static', filePath) - if os.path.exists(filePath): - fs = open(filePath, "rb") - return Response(fs, mimetype=mime) - abort(404) + if dir1 is None: + filePath = "index.html" + else: + filePath = dir1 + if dir2 is not None: + filePath = "%s/%s" % (filePath, dir2) + if dir3 is not None: + filePath = "%s/%s" % (filePath, dir3) + if filePath in [ + "index.html", + "o2c.html", + "swagger-ui.js", + "swagger-ui.min.js", + "lib/swagger-oauth.js", + ]: + conf = {"resource_list_url": req_registry["spec_endpoint_path"]} + return render_page(filePath, conf) + mime = "text/plain" + if filePath.endswith(".gif"): + mime = "image/gif" + elif filePath.endswith(".png"): + mime = "image/png" + elif filePath.endswith(".js"): + mime = "text/javascript" + elif filePath.endswith(".css"): + mime = "text/css" + filePath = os.path.join(rootPath, "static", filePath) + if os.path.exists(filePath): + fs = open(filePath, "rb") + return Response(fs, mimetype=mime) + abort(404) class ResourceLister(Resource): - def get(self): - req_registry = _get_current_registry() - return { - "apiVersion": req_registry['apiVersion'], - "swaggerVersion": req_registry['swaggerVersion'], - "apis": [ - { - "path": ( - req_registry['basePath'] + req_registry['spec_endpoint_path']), - "description": req_registry['description'] + def get(self): + req_registry = _get_current_registry() + return { + "apiVersion": req_registry["apiVersion"], + "swaggerVersion": req_registry["swaggerVersion"], + "apis": [ + { + "path": ( + req_registry["basePath"] + + req_registry["spec_endpoint_path"] + ), + "description": req_registry["description"], + } + ], } - ] - } def swagger_endpoint(api, resource, path): - endpoint = SwaggerEndpoint(resource, path) - req_registry = _get_current_registry(api=api) - req_registry.setdefault('apis', []).append(endpoint.__dict__) + endpoint = SwaggerEndpoint(resource, path) + req_registry = _get_current_registry(api=api) + req_registry.setdefault("apis", []).append(endpoint.__dict__) - class SwaggerResource(Resource): - def get(self): - if request.path.endswith('.help.json'): - return endpoint.__dict__ - if request.path.endswith('.help.html'): - return render_endpoint(endpoint) - return SwaggerResource + class SwaggerResource(Resource): + def get(self): + if request.path.endswith(".help.json"): + return endpoint.__dict__ + if request.path.endswith(".help.html"): + return render_endpoint(endpoint) + + return SwaggerResource def _sanitize_doc(comment): - return comment.replace('\n', '
') if comment else comment + return comment.replace("\n", "
") if comment else comment def _parse_doc(obj): - first_line, other_lines = None, None - - full_doc = inspect.getdoc(obj) - if full_doc: - line_feed = full_doc.find('\n') - if line_feed != -1: - first_line = _sanitize_doc(full_doc[:line_feed]) - other_lines = _sanitize_doc(full_doc[line_feed+1:]) - else: - first_line = full_doc + first_line, other_lines = None, None + + full_doc = inspect.getdoc(obj) + if full_doc: + line_feed = full_doc.find("\n") + if line_feed != -1: + first_line = _sanitize_doc(full_doc[:line_feed]) + other_lines = _sanitize_doc(full_doc[line_feed + 1 :]) + else: + first_line = full_doc - return first_line, other_lines + return first_line, other_lines class SwaggerEndpoint(object): - def __init__(self, resource, path): - self.path = extract_swagger_path(path) - path_arguments = extract_path_arguments(path) - self.description, self.notes = _parse_doc(resource) - self.operations = self.extract_operations(resource, path_arguments) - - @staticmethod - def extract_operations(resource, path_arguments=[]): - operations = [] - for method in [m.lower() for m in resource.methods]: - method_impl = resource.__dict__.get(method, None) - if method_impl is None: - for cls in resource.__mro__: - for item_key in cls.__dict__.keys(): - if item_key == method: - method_impl = cls.__dict__[item_key] - op = { - 'method': method, - 'parameters': path_arguments, - 'nickname': 'nickname' - } - op['summary'], op['notes'] = _parse_doc(method_impl) - - if '__swagger_attr' in method_impl.__dict__: - # This method was annotated with @swagger.operation - decorators = method_impl.__dict__['__swagger_attr'] - for att_name, att_value in list(decorators.items()): - if isinstance(att_value, six.string_types + (int, list)): - if att_name == 'parameters': - op['parameters'] = merge_parameter_list( - op['parameters'], att_value) - else: - if op.get(att_name) and att_name is not 'nickname': - att_value = '{0}
{1}'.format(att_value, op[att_name]) - op[att_name] = att_value - elif isinstance(att_value, object): - op[att_name] = att_value.__name__ - operations.append(op) - return operations + def __init__(self, resource, path): + self.path = extract_swagger_path(path) + path_arguments = extract_path_arguments(path) + self.description, self.notes = _parse_doc(resource) + self.operations = self.extract_operations(resource, path_arguments) + + @staticmethod + def extract_operations(resource, path_arguments=[]): + operations = [] + for method in [m.lower() for m in resource.methods]: + method_impl = resource.__dict__.get(method, None) + if method_impl is None: + for cls in resource.__mro__: + for item_key in cls.__dict__.keys(): + if item_key == method: + method_impl = cls.__dict__[item_key] + op = { + "method": method, + "parameters": path_arguments, + "nickname": "nickname", + } + op["summary"], op["notes"] = _parse_doc(method_impl) + + if "__swagger_attr" in method_impl.__dict__: + # This method was annotated with @swagger.operation + decorators = method_impl.__dict__["__swagger_attr"] + for att_name, att_value in list(decorators.items()): + if isinstance(att_value, six.string_types + (int, list)): + if att_name == "parameters": + op["parameters"] = merge_parameter_list( + op["parameters"], att_value + ) + else: + if op.get(att_name) and att_name != "nickname": + att_value = "{0}
{1}".format( + att_value, op[att_name] + ) + op[att_name] = att_value + elif isinstance(att_value, object): + op[att_name] = att_value.__name__ + operations.append(op) + return operations def merge_parameter_list(base, override): - base = list(base) - names = [x['name'] for x in base] - for o in override: - if o['name'] in names: - for n, i in enumerate(base): - if i['name'] == o['name']: - base[n] = o - else: - base.append(o) - return base + base = list(base) + names = [x["name"] for x in base] + for o in override: + if o["name"] in names: + for n, i in enumerate(base): + if i["name"] == o["name"]: + base[n] = o + else: + base.append(o) + return base class SwaggerRegistry(Resource): - def get(self): - req_registry = _get_current_registry() - if request.path.endswith('.html'): - return render_homepage( - req_registry['basePath'] + req_registry['spec_endpoint_path'] + '/_/resource_list.json') - return req_registry + def get(self): + req_registry = _get_current_registry() + if request.path.endswith(".html"): + return render_homepage( + req_registry["basePath"] + + req_registry["spec_endpoint_path"] + + "/_/resource_list.json" + ) + return req_registry def operation(**kwargs): - """ + """ This dedorator marks a function as a swagger operation so that we can easily extract attributes from it. It saves the decorator's key-values at the function level so we can later extract them later when add_resource is invoked. """ - def inner(f): - f.__swagger_attr = kwargs - return f - return inner + + def inner(f): + f.__swagger_attr = kwargs + return f + + return inner def model(c=None, *args, **kwargs): - add_model(c) - return c + add_model(c) + return c class _Nested(object): - def __init__(self, klass, **kwargs): - self._nested = kwargs - self._klass = klass + def __init__(self, klass, **kwargs): + self._nested = kwargs + self._klass = klass - def __call__(self, *args, **kwargs): - return self._klass(*args, **kwargs) + def __call__(self, *args, **kwargs): + return self._klass(*args, **kwargs) - def nested(self): - return self._nested + def nested(self): + return self._nested # wrap _Cache to allow for deferred calling def nested(klass=None, **kwargs): - if klass: - ret = _Nested(klass) - functools.update_wrapper(ret, klass) - else: - def wrapper(klass): - wrapped = _Nested(klass, **kwargs) - functools.update_wrapper(wrapped, klass) - return wrapped - ret = wrapper - return ret + if klass: + ret = _Nested(klass) + functools.update_wrapper(ret, klass) + else: + + def wrapper(klass): + wrapped = _Nested(klass, **kwargs) + functools.update_wrapper(wrapped, klass) + return wrapped + + ret = wrapper + return ret def add_model(model_class): - models = registry['models'] - name = model_class.__name__ - model = models[name] = {'id': name} - model['description'], model['notes'] = _parse_doc(model_class) - if 'resource_fields' in dir(model_class): - # We take special care when the model class has a field resource_fields. - # By convension this field specifies what flask-restful would return when - # this model is used as a return value from an HTTP endpoint. - # We look at the class and search for an attribute named - # resource_fields. - # If that attribute exists then we deduce the swagger model by the content - # of this attribute - - if hasattr(model_class, 'required'): - required = model['required'] = model_class.required - - properties = model['properties'] = {} - nested = model_class.nested() if isinstance(model_class, _Nested) else {} - for field_name, field_type in list(model_class.resource_fields.items()): - nested_type = nested[field_name] if field_name in nested else None - properties[field_name] = deduce_swagger_type(field_type, nested_type) - elif '__init__' in dir(model_class): - # Alternatively, if a resource_fields does not exist, we deduce the model - # fields from the parameters sent to its __init__ method - - # Credits for this snippet go to Robin Walsh - # https://github.com/hobbeswalsh/flask-sillywalk - argspec = inspect.getargspec(model_class.__init__) - argspec.args.remove("self") - defaults = {} - required = model['required'] = [] - if argspec.defaults: - defaults = list( - zip(argspec.args[-len(argspec.defaults):], argspec.defaults)) - properties = model['properties'] = {} - required_args_count = len(argspec.args) - len(defaults) - for arg in argspec.args[:required_args_count]: - required.append(arg) - # type: string for lack of better knowledge, until we add more metadata - properties[arg] = {'type': 'string'} - for k, v in defaults: - properties[k] = {'type': 'string', "default": v} - - if 'swagger_metadata' in dir(model_class): - for field_name, field_metadata in model_class.swagger_metadata.items(): - if field_name in properties: - # does not work for Python 3.x; see: http://stackoverflow.com/questions/38987/how-can-i-merge-two-python-dictionaries-in-a-single-expression - # properties[field_name] = dict(properties[field_name].items() + field_metadata.items()) - properties[field_name].update(field_metadata) + models = registry["models"] + name = model_class.__name__ + model = models[name] = {"id": name} + model["description"], model["notes"] = _parse_doc(model_class) + if "resource_fields" in dir(model_class): + # We take special care when the model class has a field resource_fields. + # By convension this field specifies what flask-restful would return + # when this model is used as a return value from an HTTP endpoint. + # We look at the class and search for an attribute named + # resource_fields. + # If that attribute exists then we deduce the swagger model by the + # content of this attribute + + if hasattr(model_class, "required"): + required = model["required"] = model_class.required + + properties = model["properties"] = {} + nested = ( + model_class.nested() if isinstance(model_class, _Nested) else {} + ) + for field_name, field_type in list(model_class.resource_fields.items()): + nested_type = nested[field_name] if field_name in nested else None + properties[field_name] = deduce_swagger_type( + field_type, nested_type + ) + elif "__init__" in dir(model_class): + # Alternatively, if a resource_fields does not exist, we deduce the + # model fields from the parameters sent to its __init__ method + + # Credits for this snippet go to Robin Walsh + # https://github.com/hobbeswalsh/flask-sillywalk + argspec = inspect.getargspec(model_class.__init__) + argspec.args.remove("self") + defaults = {} + required = model["required"] = [] + if argspec.defaults: + defaults = list( + zip(argspec.args[-len(argspec.defaults) :], argspec.defaults) + ) + properties = model["properties"] = {} + required_args_count = len(argspec.args) - len(defaults) + for arg in argspec.args[:required_args_count]: # type: str + # str for lack of better knowledge, until we add more metadata + required.append(arg) + properties[arg] = {"type": "string"} + for k, v in defaults: + properties[k] = {"type": "string", "default": v} + + if "swagger_metadata" in dir(model_class): + for field_name, field_metadata in model_class.swagger_metadata.items(): + if field_name in properties: + # does not work for Python 3.x; see: http://stackoverflow.com/questions/38987/how-can-i-merge-two-python-dictionaries-in-a-single-expression # noqa + # properties[field_name] = dict(properties[field_name].items() + field_metadata.items()) # noqa + properties[field_name].update(field_metadata) + def deduce_swagger_type(python_type_or_object, nested_type=None): import inspect @@ -447,75 +500,82 @@ def deduce_swagger_type(python_type_or_object, nested_type=None): predicate = issubclass else: predicate = isinstance - if predicate(python_type_or_object, six.string_types + ( - fields.String, - fields.FormattedString, - fields.Url, - int, - fields.Integer, - float, - fields.Float, - fields.Arbitrary, - fields.Fixed, - bool, - fields.Boolean, - fields.DateTime)): - return {'type': deduce_swagger_type_flat(python_type_or_object)} + if predicate( + python_type_or_object, + six.string_types + + ( + fields.String, + fields.FormattedString, + fields.Url, + int, + fields.Integer, + float, + fields.Float, + fields.Arbitrary, + fields.Fixed, + bool, + fields.Boolean, + fields.DateTime, + ), + ): + return {"type": deduce_swagger_type_flat(python_type_or_object)} if predicate(python_type_or_object, (fields.List)): if inspect.isclass(python_type_or_object): - return {'type': 'array'} + return {"type": "array"} else: - return {'type': 'array', - 'items': { - '$ref': deduce_swagger_type_flat( - python_type_or_object.container, nested_type)}} + return { + "type": "array", + "items": { + "$ref": deduce_swagger_type_flat( + python_type_or_object.container, nested_type + ) + }, + } if predicate(python_type_or_object, (fields.Nested)): - return {'type': nested_type} + return {"type": nested_type} - return {'type': 'null'} + return {"type": "null"} def deduce_swagger_type_flat(python_type_or_object, nested_type=None): if nested_type: - return nested_type + return nested_type import inspect if inspect.isclass(python_type_or_object): predicate = issubclass else: predicate = isinstance - if predicate(python_type_or_object, six.string_types + ( - fields.String, - fields.FormattedString, - fields.Url)): - return 'string' - if predicate(python_type_or_object, (int, - fields.Integer)): - return 'integer' - if predicate(python_type_or_object, (float, - fields.Float, - fields.Arbitrary, - fields.Fixed)): - return 'number' - if predicate(python_type_or_object, (bool, - fields.Boolean)): - return 'boolean' + if predicate( + python_type_or_object, + six.string_types + (fields.String, fields.FormattedString, fields.Url), + ): + return "string" + if predicate(python_type_or_object, (int, fields.Integer)): + return "integer" + if predicate( + python_type_or_object, + (float, fields.Float, fields.Arbitrary, fields.Fixed), + ): + return "number" + if predicate(python_type_or_object, (bool, fields.Boolean)): + return "boolean" if predicate(python_type_or_object, (fields.DateTime,)): - return 'date-time' + return "date-time" def extract_swagger_path(path): - """ + """ Extracts a swagger type path from the given flask style path. This /path/ turns into this /path/{parameter} And this /// to this: /{lang_code}/{id}/{probability} """ - return re.sub('<(?:[^:]+:)?([^>]+)>', '{\\1}', path) + return re.sub("<(?:[^:]+:)?([^>]+)>", "{\\1}", path) def extract_path_arguments(path): - """ + """ Extracts a swagger path arguments from the given flask path. This /path/ extracts [{name: 'parameter'}] And this /// @@ -524,19 +584,15 @@ def extract_path_arguments(path): {name: 'id', dataType: 'string'} {name: 'probability', dataType: 'float'}] """ - # Remove all paranteses - path = re.sub('\([^\)]*\)', '', path) - args = re.findall('<([^>]+)>', path) - - def split_arg(arg): - spl = arg.split(':') - if len(spl) == 1: - return {'name': spl[0], - 'dataType': 'string', - 'paramType': 'path'} - else: - return {'name': spl[1], - 'dataType': spl[0], - 'paramType': 'path'} + # Remove all paranteses + path = re.sub("\([^\)]*\)", "", path) + args = re.findall("<([^>]+)>", path) + + def split_arg(arg): + spl = arg.split(":") + if len(spl) == 1: + return {"name": spl[0], "dataType": "string", "paramType": "path"} + else: + return {"name": spl[1], "dataType": spl[0], "paramType": "path"} - return list(map(split_arg, args)) + return list(map(split_arg, args)) diff --git a/setup.py b/setup.py index f95984d..bfcc570 100644 --- a/setup.py +++ b/setup.py @@ -3,26 +3,27 @@ except ImportError: from distutils.core import setup -with open('README') as file: +with open("README") as file: long_description = file.read() -setup(name='flask-restful-swagger', - version='0.20.1', - url='https://github.com/rantav/flask-restful-swagger', - zip_safe=False, - packages=['flask_restful_swagger'], - package_data={ - 'flask_restful_swagger': [ - 'static/*.*', - 'static/css/*.*', - 'static/images/*.*', - 'static/lib/*.*', - 'static/lib/shred/*.*', +setup( + name="flask-restful-swagger", + version="0.20.1", + url="https://github.com/rantav/flask-restful-swagger", + zip_safe=False, + packages=["flask_restful_swagger"], + package_data={ + "flask_restful_swagger": [ + "static/*.*", + "static/css/*.*", + "static/images/*.*", + "static/lib/*.*", + "static/lib/shred/*.*", ] - }, - description='Extract swagger specs from your flast-restful project', - author='Ran Tavory', - license='MIT', - long_description=long_description, - install_requires=['Flask-RESTful>=0.3.6'] - ) + }, + description="Extract swagger specs from your flast-restful project", + author="Ran Tavory", + license="MIT", + long_description=long_description, + install_requires=["Flask-RESTful>=0.3.6"], +) diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tests/__init__.pyc b/tests/__init__.pyc new file mode 100644 index 0000000000000000000000000000000000000000..c54adf53c0023e44e04a5720e72172751ac58cfb GIT binary patch literal 152 zcmZSn%*&OXc_ucQ0SXv_v;z8VBfB|v_$etdjpUS>&ryk0?N W2?x*=o80`A(wtN~kX^+<%m4u0$0JVw literal 0 HcmV?d00001 diff --git a/tests/test_placeholder.py b/tests/test_placeholder.py new file mode 100644 index 0000000..d6f490c --- /dev/null +++ b/tests/test_placeholder.py @@ -0,0 +1,3 @@ + +def test_placeholder(): + assert True is True diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..1db9522 --- /dev/null +++ b/tox.ini @@ -0,0 +1,15 @@ +# content of: tox.ini , put in same dir as setup.py +[tox] +requires = tox-venv + setuptools >= 30.0.0 + black==19.10b0 + flake8==3.7.9 + isort==4.3.21 + Flask-RESTful>=0.3.6 +envlist = py27,py36 + +[testenv] +# install pytest in the virtualenv where commands will be executed +deps = pytest +commands = + pytest From d11b6d5afbdd4aee83e8aa039a817ffa49e1b0b1 Mon Sep 17 00:00:00 2001 From: Niall Byrne Date: Wed, 13 Nov 2019 19:07:09 -0500 Subject: [PATCH 02/64] testing: Update pytest coverage package --- docker/requirements-testing.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docker/requirements-testing.txt b/docker/requirements-testing.txt index 6f36383..8b4dc6d 100644 --- a/docker/requirements-testing.txt +++ b/docker/requirements-testing.txt @@ -2,5 +2,5 @@ black==19.10b0 flake8==3.7.9 isort==4.3.21 Flask-RESTful>=0.3.6 -pytest-cover==3.0.0 +pytest-cov==2.8.1 tox==3.14.1 From 3b9b9f33cadf3c8d8dec75bdae74cf7b92dce172 Mon Sep 17 00:00:00 2001 From: Niall Byrne Date: Wed, 13 Nov 2019 19:08:43 -0500 Subject: [PATCH 03/64] Create pythonpackage.yml --- .github/workflows/pythonpackage.yml | 30 +++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 .github/workflows/pythonpackage.yml diff --git a/.github/workflows/pythonpackage.yml b/.github/workflows/pythonpackage.yml new file mode 100644 index 0000000..2592552 --- /dev/null +++ b/.github/workflows/pythonpackage.yml @@ -0,0 +1,30 @@ +name: Python package + +on: [push] + +jobs: + build: + + runs-on: ubuntu-latest + strategy: + max-parallel: 4 + matrix: + python-version: [2.7, 3.5, 3.6, 3.7] + + steps: + - uses: actions/checkout@v1 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v1 + with: + python-version: ${{ matrix.python-version }} + - name: Install dependencies + run: | + ls + cd flask-restful-swagger + pip3 install -r docker/requirements-testing.txt + - name: Lint + run: | + bash /contributing/scripts/self-test.sh + - name: Test + run: | + pytest --cov=. . From 6845a7436def70605caf72429a90e4f671510eb2 Mon Sep 17 00:00:00 2001 From: Niall Byrne Date: Wed, 13 Nov 2019 19:56:04 -0500 Subject: [PATCH 04/64] Add build pipeline. --- .github/workflows/pythonpackage.yml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/.github/workflows/pythonpackage.yml b/.github/workflows/pythonpackage.yml index 2592552..fe49012 100644 --- a/.github/workflows/pythonpackage.yml +++ b/.github/workflows/pythonpackage.yml @@ -19,9 +19,7 @@ jobs: python-version: ${{ matrix.python-version }} - name: Install dependencies run: | - ls - cd flask-restful-swagger - pip3 install -r docker/requirements-testing.txt + pip3 install -r docker/requirements-testing.txt - name: Lint run: | bash /contributing/scripts/self-test.sh From 6380de9e235f13ebf4ec5bb19c1c2cbdf4aacb53 Mon Sep 17 00:00:00 2001 From: Niall Byrne Date: Mon, 18 Nov 2019 10:54:36 -0500 Subject: [PATCH 05/64] testing: Add unittest for makeclass --- tests/test_make_class.py | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 tests/test_make_class.py diff --git a/tests/test_make_class.py b/tests/test_make_class.py new file mode 100644 index 0000000..a2891bc --- /dev/null +++ b/tests/test_make_class.py @@ -0,0 +1,24 @@ +from flask_restful_swagger import swagger + + +def test_make_class_with_input_class(): + class A: + pass + + assert swagger.make_class(A) == A + + +def test_make_class_with_input_instance(): + class A: + pass + a = A() + + assert swagger.make_class(a) == A + + +def test_make_class_with_None(): + assert isinstance(None, swagger.make_class(None)) + + + + From 662c8e13bd50a9cdde14674b968e7d71580ddd20 Mon Sep 17 00:00:00 2001 From: Seonaid Lee Date: Mon, 18 Nov 2019 12:07:43 -0500 Subject: [PATCH 06/64] add test cases for extract_swagger_path --- tests/test_extract_swagger_path.py | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 tests/test_extract_swagger_path.py diff --git a/tests/test_extract_swagger_path.py b/tests/test_extract_swagger_path.py new file mode 100644 index 0000000..f947df4 --- /dev/null +++ b/tests/test_extract_swagger_path.py @@ -0,0 +1,27 @@ +from flask_restful_swagger import swagger +""" + Docstring from extract_swagger_path: + + Extracts a swagger type path from the given flask style path. + This /path/ turns into this /path/{parameter} + And this /// + to this: /{lang_code}/{id}/{probability} + """ + +def test_extract_swagger_path_empty_string(): + assert swagger.extract_swagger_path('') == '' + +def test_extract_swagger_path_simple(): + assert swagger.extract_swagger_path('/endpoint') == '/endpoint' + +def test_extract_swagger_path_single_parameter_no_type(): + assert swagger.extract_swagger_path('/path/') == '/path/{parameter}' + +def test_extract_swagger_path_single_parameter_string(): + assert swagger.extract_swagger_path('/') == '/{lang_code}' + +def test_extract_swagger_path_multiple_parameters(): + assert swagger.extract_swagger_path('///') == '/{lang_code}/{id}/{probability}' + +def test_extract_swagger_path_long_path_single_parameter(): + assert swagger.extract_swagger_path('path/subpath/other_path/') == 'path/subpath/other_path/{lang_code}' From e8c2ca98eef0ad990dc35b2921f9c3b9f7cd0e04 Mon Sep 17 00:00:00 2001 From: Seonaid Lee Date: Mon, 18 Nov 2019 12:23:57 -0500 Subject: [PATCH 07/64] add test to extract_swagger_path --- tests/test_extract_swagger_path.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/tests/test_extract_swagger_path.py b/tests/test_extract_swagger_path.py index f947df4..5926bdc 100644 --- a/tests/test_extract_swagger_path.py +++ b/tests/test_extract_swagger_path.py @@ -14,6 +14,9 @@ def test_extract_swagger_path_empty_string(): def test_extract_swagger_path_simple(): assert swagger.extract_swagger_path('/endpoint') == '/endpoint' +def test_extract_swagger_path_returns_string(): + assert isinstance(swagger.extract_swagger_path('/endpoint/123'), str) + def test_extract_swagger_path_single_parameter_no_type(): assert swagger.extract_swagger_path('/path/') == '/path/{parameter}' From c7ba089ccd399aa59f619b9ee511304ec68cd9d4 Mon Sep 17 00:00:00 2001 From: Seonaid Lee Date: Mon, 18 Nov 2019 13:25:48 -0500 Subject: [PATCH 08/64] refactor extract_swagger_path tests --- tests/test_extract_swagger_path.py | 26 +++++++++++--------------- 1 file changed, 11 insertions(+), 15 deletions(-) diff --git a/tests/test_extract_swagger_path.py b/tests/test_extract_swagger_path.py index 5926bdc..ed4a920 100644 --- a/tests/test_extract_swagger_path.py +++ b/tests/test_extract_swagger_path.py @@ -1,4 +1,5 @@ from flask_restful_swagger import swagger +import pytest """ Docstring from extract_swagger_path: @@ -8,23 +9,18 @@ to this: /{lang_code}/{id}/{probability} """ -def test_extract_swagger_path_empty_string(): - assert swagger.extract_swagger_path('') == '' +@pytest.mark.parametrize("case_name, test_input, expected", + [('empty_string', '', ''), + ('simple', '/endpoint', '/endpoint'), + ('single_parameter_no_type', '/path/', '/path/{parameter}'), + ('single_parameter_string', '/', '/{lang_code}'), + ('multiple_parameters', '///', '/{lang_code}/{id}/{probability}'), + ('multiple_parameters_varied_length_string', '///', '/{lang_code}/{id}/{probability}'), + ('long_path_single_parameter', 'path/subpath/other_path/', 'path/subpath/other_path/{lang_code}')]) -def test_extract_swagger_path_simple(): - assert swagger.extract_swagger_path('/endpoint') == '/endpoint' +def test_extract_swagger_path(case_name, test_input, expected): + assert swagger.extract_swagger_path(test_input) == expected def test_extract_swagger_path_returns_string(): assert isinstance(swagger.extract_swagger_path('/endpoint/123'), str) -def test_extract_swagger_path_single_parameter_no_type(): - assert swagger.extract_swagger_path('/path/') == '/path/{parameter}' - -def test_extract_swagger_path_single_parameter_string(): - assert swagger.extract_swagger_path('/') == '/{lang_code}' - -def test_extract_swagger_path_multiple_parameters(): - assert swagger.extract_swagger_path('///') == '/{lang_code}/{id}/{probability}' - -def test_extract_swagger_path_long_path_single_parameter(): - assert swagger.extract_swagger_path('path/subpath/other_path/') == 'path/subpath/other_path/{lang_code}' From 9f86b63fa27ff891ebd9188fb720872cbcd3bd31 Mon Sep 17 00:00:00 2001 From: Ashraf Patel <4shr4f@live.co.uk> Date: Mon, 18 Nov 2019 14:16:13 -0500 Subject: [PATCH 09/64] Added sanitize_doc unit test --- tests/test_sanitize_doc.py | 57 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 tests/test_sanitize_doc.py diff --git a/tests/test_sanitize_doc.py b/tests/test_sanitize_doc.py new file mode 100644 index 0000000..47c4b99 --- /dev/null +++ b/tests/test_sanitize_doc.py @@ -0,0 +1,57 @@ +import pytest +from flask_restful_swagger import swagger + +@pytest.mark.parametrize( + "test_input,expected", + [("Hey\n", "Hey
"), + ("\n/n\n/n\n", "
/n
/n
")] +) +def test_string_sanitize_doc(test_input, expected): + """Uses string cases""" + assert swagger._sanitize_doc(test_input) == expected + + +@pytest.mark.parametrize( + "test_input_types, expected_output", + [(str(12345) + "\n", "12345
"), + (str(23+45+31.689923) + "\n", "99.689923
"), + (str((2 / 1)) + str(2 % 1) + "\/\/\n/\\", "2.00\/\/
/\\")] +) +def test_numbers_sanitize_doc(test_input_types, expected_output): + assert swagger._sanitize_doc(test_input_types) == expected_output + + +def test_purenum_sanitize_doc(): + try: + numbers = 6736+32843.73828932+0.138238 + sentence = "I was able to do this a " + ending = " times.\nWhat do you think?" + assert isinstance(swagger._sanitize_doc(sentence + numbers + ending), TypeError) + except TypeError: + assert True + + +def test_zero_errors_sanitize_doc(): + try: + sentence = "I was able to make $" + numbers = 99999999999/0 + ending = "\np/m" + assert isinstance(swagger._sanitize_doc(sentence + numbers + ending), ZeroDivisionError) + except ZeroDivisionError: + assert True + + +def test_none_sanitize_doc(): + try: + none_var = None + assert isinstance(swagger._sanitize_doc(none_var), AssertionError) + except AssertionError: + assert True + + +@pytest.mark.parametrize( + "test_input_types, expected_output", + [("\r\n\'\/\n/'n", "\r
'\\/
/'n")] +) +def test_escape_characters_sanitize_doc(test_input_types, expected_output): + assert swagger._sanitize_doc(test_input_types) == expected_output \ No newline at end of file From 1c60c6b9141b28db86df18963758463f374dc0f4 Mon Sep 17 00:00:00 2001 From: Sabeur Lafi Date: Mon, 18 Nov 2019 15:33:05 -0500 Subject: [PATCH 10/64] Testing: added test for swagger function extract_path_arguments --- tests/test_extract_path_arguments.py | 32 ++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 tests/test_extract_path_arguments.py diff --git a/tests/test_extract_path_arguments.py b/tests/test_extract_path_arguments.py new file mode 100644 index 0000000..2d012b1 --- /dev/null +++ b/tests/test_extract_path_arguments.py @@ -0,0 +1,32 @@ +from flask_restful_swagger import swagger +from unittest.mock import Mock, patch +import types +import pytest + + +def test_documentation_example(): + + path = '///' + expected_result = [{"name": 'lang_code', "dataType": 'string', "paramType": "path"}, + {"name": 'id', "dataType": 'string', "paramType": "path"}, + {"name": 'probability', "dataType": 'float', "paramType": "path"}] + + ret_result = swagger.extract_path_arguments(path) + assert ret_result == expected_result + + +def nested(outer, innerName, **freeVars): + if isinstance(outer, (types.FunctionType, types.MethodType)): + outer = outer.__code__ + for const in outer.co_consts: + if isinstance(const, types.CodeType) and const.co_name == innerName: + return types.FunctionType(const, globals(), None, None, tuple( + freeVar(freeVars[name]) for name in const.co_freevars)) + + +@pytest.mark.parametrize("testcase_string,testcase_expected_result", + [('HelloWorld', {"name": 'HelloWorld', "dataType": 'string', "paramType": "path"}), + ('Hello:World', {"name": 'World', "dataType": 'Hello', "paramType": "path"})]) +def test_split_arg(testcase_string, testcase_expected_result): + temp_split_arg = nested(swagger.extract_path_arguments, 'split_arg') + assert temp_split_arg(testcase_string) == testcase_expected_result From adbe8461308cccc37e00aa8749318969c91b6ae8 Mon Sep 17 00:00:00 2001 From: Seonaid Lee Date: Mon, 18 Nov 2019 15:45:48 -0500 Subject: [PATCH 11/64] mock render_page call to test render_endpoint --- tests/test_render_endpoint.py | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 tests/test_render_endpoint.py diff --git a/tests/test_render_endpoint.py b/tests/test_render_endpoint.py new file mode 100644 index 0000000..de0aef1 --- /dev/null +++ b/tests/test_render_endpoint.py @@ -0,0 +1,15 @@ +from flask_restful_swagger import swagger +import unittest +from unittest.mock import patch + +class Endpoint(): + pass + +class RenderEndpointTestCast(unittest.TestCase): + + def test_render_endpoint(self): + endpoint = Endpoint() + with patch ('flask_restful_swagger.swagger.render_page') as mock_render_page: + swagger.render_endpoint(endpoint) + mock_render_page.assert_called_with("endpoint.html", endpoint.__dict__) + From 7dcc6dbc6d050936e72d32171c43aa9fd43edc76 Mon Sep 17 00:00:00 2001 From: Sabeur Lafi Date: Mon, 18 Nov 2019 16:04:08 -0500 Subject: [PATCH 12/64] Testing: added test for swagger function extract_path_arguments --- tests/test_extract_path_arguments.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/tests/test_extract_path_arguments.py b/tests/test_extract_path_arguments.py index 2d012b1..c9b8b9f 100644 --- a/tests/test_extract_path_arguments.py +++ b/tests/test_extract_path_arguments.py @@ -6,6 +6,9 @@ def test_documentation_example(): + """ This test case tests the outside function extract_path_arguments using + the example given in the documentation + """ path = '///' expected_result = [{"name": 'lang_code', "dataType": 'string', "paramType": "path"}, {"name": 'id', "dataType": 'string', "paramType": "path"}, @@ -16,6 +19,7 @@ def test_documentation_example(): def nested(outer, innerName, **freeVars): + """This helper function extracts the code of a function nested within another one""" if isinstance(outer, (types.FunctionType, types.MethodType)): outer = outer.__code__ for const in outer.co_consts: @@ -28,5 +32,6 @@ def nested(outer, innerName, **freeVars): [('HelloWorld', {"name": 'HelloWorld', "dataType": 'string', "paramType": "path"}), ('Hello:World', {"name": 'World', "dataType": 'Hello', "paramType": "path"})]) def test_split_arg(testcase_string, testcase_expected_result): + """This testcase tests the outside function: extract_path_arguments""" temp_split_arg = nested(swagger.extract_path_arguments, 'split_arg') assert temp_split_arg(testcase_string) == testcase_expected_result From d3730fb7f7df8139a4ed4326f2fd8048968d6f98 Mon Sep 17 00:00:00 2001 From: David Lieu Date: Mon, 18 Nov 2019 16:24:53 -0500 Subject: [PATCH 13/64] testing: added test for model(...) --- tests/test_model.py | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 tests/test_model.py diff --git a/tests/test_model.py b/tests/test_model.py new file mode 100644 index 0000000..051df58 --- /dev/null +++ b/tests/test_model.py @@ -0,0 +1,24 @@ +import datetime +import pytest +from flask_restful_swagger import swagger +from unittest.mock import patch + + +class TestEmptyClass(): + pass + + +@pytest.mark.parametrize("test_input", [ + TestEmptyClass, #Test a class + 'im a str', #Test a str + 123, #Test int + None, #Test None + datetime.datetime.now(), #Test datetime + ]) +def test_model_with_input(test_input): + with patch('flask_restful_swagger.swagger.add_model') as mock_add_model: + assert swagger.model(test_input) == test_input + mock_add_model.assert_called_once_with(test_input) + + + From acab4b8d3baa944532d91f129e1748a36bb471d1 Mon Sep 17 00:00:00 2001 From: Ashraf Patel <4shr4f@live.co.uk> Date: Mon, 18 Nov 2019 16:27:47 -0500 Subject: [PATCH 14/64] Added test_render_homepage.py --- tests/test_render_hompage.py | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 tests/test_render_hompage.py diff --git a/tests/test_render_hompage.py b/tests/test_render_hompage.py new file mode 100644 index 0000000..7f3e87c --- /dev/null +++ b/tests/test_render_hompage.py @@ -0,0 +1,19 @@ +from unittest.mock import patch + +from flask import Response + +from flask_restful_swagger import swagger + +@patch('flask_restful_swagger.swagger.render_page') +@patch('flask.wrappers.Response') +def test_render_hompage_func(response_obj, mock_render_page): + resource_list_url = "resource_list_url" + mock_render_page.return_value = Response() + swagger.render_homepage(resource_list_url) + mock_render_page.assert_called_once_with("index.html", {"resource_list_url": resource_list_url}) + + + +# def render_homepage(resource_list_url): +# conf = {"resource_list_url": resource_list_url} +# # return render_page("index.html", conf) \ No newline at end of file From eca24ded1607ecf04e6ddcbc75cff43a7bb79ce6 Mon Sep 17 00:00:00 2001 From: David Lieu Date: Mon, 18 Nov 2019 16:30:23 -0500 Subject: [PATCH 15/64] testing: Add test for operation(...) --- tests/test_operation.py | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 tests/test_operation.py diff --git a/tests/test_operation.py b/tests/test_operation.py new file mode 100644 index 0000000..dcbb797 --- /dev/null +++ b/tests/test_operation.py @@ -0,0 +1,30 @@ +import datetime +import pytest +from flask_restful_swagger import swagger + + +def empty_func(): + pass + +def func_with_many_args(arg1, arg2, arg3, kwarg1=None, kwarg2=None): + allargs = (arg1, arg2, arg3, kwarg1, kwarg2) + print('func_with_many_args: %s, %s, %s, %s, %s' % allargs) + +class EmptyClass: + pass + + +@pytest.mark.parametrize("plain_input,swagger_kwargs", [ + (empty_func, {'arg1': None, 'arg2': None}), + (func_with_many_args, {'arg1': None, 'arg2': None}), + (EmptyClass, {'arg1': None}), + (EmptyClass(), {'arg1': None}), + ]) +def test_operation(plain_input, swagger_kwargs): + _add_swagger_attr_wrapper = swagger.operation(**swagger_kwargs) + swaggered_input = _add_swagger_attr_wrapper(plain_input) + + + assert hasattr(swaggered_input, '__swagger_attr') + assert swaggered_input.__swagger_attr == swagger_kwargs + From d708ab0f005b78f4761ccd800dcb952199e37cc4 Mon Sep 17 00:00:00 2001 From: Seonaid Lee Date: Mon, 18 Nov 2019 16:39:41 -0500 Subject: [PATCH 16/64] test __parse_docs_ green --- tests/test_parse_docs.py | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 tests/test_parse_docs.py diff --git a/tests/test_parse_docs.py b/tests/test_parse_docs.py new file mode 100644 index 0000000..732373f --- /dev/null +++ b/tests/test_parse_docs.py @@ -0,0 +1,34 @@ +from flask_restful_swagger import swagger + +class MockBasicObject(): + pass + +def test_parse_doc_no_object_is_none(): + assert swagger._parse_doc(None) == (None, None) + +def test_parse_doc_no_docs_is_none(): + assert swagger._parse_doc(MockBasicObject()) == (None, None) + +def test_parse_doc_one_line_doc(): + test_one_line_doc = MockBasicObject() + test_one_line_doc.__doc__ = "Some Text Goes Here" + assert swagger._parse_doc(test_one_line_doc) == ("Some Text Goes Here", None) + +def test_parse_doc_multi_line_doc(): + test_multi_line_doc = MockBasicObject() + test_multi_line_doc.__doc__ = "Some Text Goes Here \n this is the extra text\n and this is the third line." + extracted = swagger._parse_doc(test_multi_line_doc) + assert extracted[0] == "Some Text Goes Here " + assert extracted[1] == "this is the extra text
and this is the third line." + +def test_parse_doc_weird_characters(): + test_weird_characters = MockBasicObject() + test_weird_characters.__doc__ = "Hi, 297agiu(*#&_$ ! \n Oh, the terrible 2908*&%)(#%#" + extracted = swagger._parse_doc(test_weird_characters) + assert extracted[0] == "Hi, 297agiu(*#&_$ ! " + assert extracted[1] == "Oh, the terrible 2908*&%)(#%#" + +def test_parse_doc_ends_with_newline(): + test_ends_newline = MockBasicObject() + test_ends_newline.__doc__ = "Overview \n Some details \n" + assert swagger._parse_doc(test_ends_newline)[1] == "Some details " \ No newline at end of file From cd8b2c3ec2144a2d2ae5fc34c046faa79b88efcb Mon Sep 17 00:00:00 2001 From: Niall Byrne Date: Tue, 19 Nov 2019 09:41:14 -0500 Subject: [PATCH 17/64] linting: Apply linter to pipelines branch --- examples/basic.py | 1 + examples/blueprints.py | 1 + examples/inheritance.py | 1 + flask_restful_swagger/swagger.py | 4 ++-- tests/test_make_class.py | 5 +---- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/examples/basic.py b/examples/basic.py index 30ca79a..1c2b9f2 100644 --- a/examples/basic.py +++ b/examples/basic.py @@ -8,6 +8,7 @@ from flask import Flask, redirect from flask_restful import Api, Resource, abort, fields, marshal_with, reqparse + from flask_restful_swagger import swagger app = Flask(__name__, static_folder="../static") diff --git a/examples/blueprints.py b/examples/blueprints.py index 871f493..1daabe2 100644 --- a/examples/blueprints.py +++ b/examples/blueprints.py @@ -10,6 +10,7 @@ from flask import Blueprint, Flask, redirect from flask_restful import Api, Resource, abort, fields, marshal_with, reqparse + from flask_restful_swagger import swagger app = Flask(__name__, static_folder="../static") diff --git a/examples/inheritance.py b/examples/inheritance.py index f4cefee..4b646ea 100644 --- a/examples/inheritance.py +++ b/examples/inheritance.py @@ -6,6 +6,7 @@ """ from flask import Flask from flask_restful import Api, Resource + from flask_restful_swagger import swagger app = Flask(__name__, static_folder="../static") diff --git a/flask_restful_swagger/swagger.py b/flask_restful_swagger/swagger.py index ea94d08..536d48e 100644 --- a/flask_restful_swagger/swagger.py +++ b/flask_restful_swagger/swagger.py @@ -4,12 +4,12 @@ import re import six - from flask import Response, abort, request from flask_restful import Resource, fields -from flask_restful_swagger import api_spec_static, registry from jinja2 import Template +from flask_restful_swagger import api_spec_static, registry + try: # urlparse is renamed to urllib.parse in python 3 import urlparse diff --git a/tests/test_make_class.py b/tests/test_make_class.py index a2891bc..6e5caba 100644 --- a/tests/test_make_class.py +++ b/tests/test_make_class.py @@ -11,6 +11,7 @@ class A: def test_make_class_with_input_instance(): class A: pass + a = A() assert swagger.make_class(a) == A @@ -18,7 +19,3 @@ class A: def test_make_class_with_None(): assert isinstance(None, swagger.make_class(None)) - - - - From 794c6e09ec92477665b7af87f5e2f49a35abd08f Mon Sep 17 00:00:00 2001 From: David Lieu Date: Tue, 19 Nov 2019 09:49:15 -0500 Subject: [PATCH 18/64] testing: Run linting tools on test_model and test_operation --- tests/test_model.py | 28 +++++++++++++++------------- tests/test_operation.py | 25 +++++++++++++++---------- 2 files changed, 30 insertions(+), 23 deletions(-) diff --git a/tests/test_model.py b/tests/test_model.py index 051df58..6c97961 100644 --- a/tests/test_model.py +++ b/tests/test_model.py @@ -1,24 +1,26 @@ import datetime +from unittest.mock import patch + import pytest + from flask_restful_swagger import swagger -from unittest.mock import patch -class TestEmptyClass(): +class TestEmptyClass: pass -@pytest.mark.parametrize("test_input", [ - TestEmptyClass, #Test a class - 'im a str', #Test a str - 123, #Test int - None, #Test None - datetime.datetime.now(), #Test datetime - ]) +@pytest.mark.parametrize( + "test_input", + [ + TestEmptyClass, # Test a class + "im a str", # Test a str + 123, # Test int + None, # Test None + datetime.datetime.now(), # Test datetime + ], +) def test_model_with_input(test_input): - with patch('flask_restful_swagger.swagger.add_model') as mock_add_model: + with patch("flask_restful_swagger.swagger.add_model") as mock_add_model: assert swagger.model(test_input) == test_input mock_add_model.assert_called_once_with(test_input) - - - diff --git a/tests/test_operation.py b/tests/test_operation.py index dcbb797..b8b123b 100644 --- a/tests/test_operation.py +++ b/tests/test_operation.py @@ -1,30 +1,35 @@ import datetime + import pytest + from flask_restful_swagger import swagger def empty_func(): pass + def func_with_many_args(arg1, arg2, arg3, kwarg1=None, kwarg2=None): allargs = (arg1, arg2, arg3, kwarg1, kwarg2) - print('func_with_many_args: %s, %s, %s, %s, %s' % allargs) + print("func_with_many_args: %s, %s, %s, %s, %s" % allargs) + class EmptyClass: pass -@pytest.mark.parametrize("plain_input,swagger_kwargs", [ - (empty_func, {'arg1': None, 'arg2': None}), - (func_with_many_args, {'arg1': None, 'arg2': None}), - (EmptyClass, {'arg1': None}), - (EmptyClass(), {'arg1': None}), - ]) +@pytest.mark.parametrize( + "plain_input,swagger_kwargs", + [ + (empty_func, {"arg1": None, "arg2": None}), + (func_with_many_args, {"arg1": None, "arg2": None}), + (EmptyClass, {"arg1": None}), + (EmptyClass(), {"arg1": None}), + ], +) def test_operation(plain_input, swagger_kwargs): _add_swagger_attr_wrapper = swagger.operation(**swagger_kwargs) swaggered_input = _add_swagger_attr_wrapper(plain_input) - - assert hasattr(swaggered_input, '__swagger_attr') + assert hasattr(swaggered_input, "__swagger_attr") assert swaggered_input.__swagger_attr == swagger_kwargs - From 40005cb735560fd8cf332c7d3240a5218f9409b9 Mon Sep 17 00:00:00 2001 From: Seonaid Lee Date: Tue, 19 Nov 2019 09:55:10 -0500 Subject: [PATCH 19/64] linting the files --- tests/test_extract_swagger_path.py | 45 ++++++++++++++++++++++-------- tests/test_parse_docs.py | 30 ++++++++++++++++---- tests/test_render_endpoint.py | 17 +++++++---- 3 files changed, 69 insertions(+), 23 deletions(-) diff --git a/tests/test_extract_swagger_path.py b/tests/test_extract_swagger_path.py index ed4a920..f9e7ed3 100644 --- a/tests/test_extract_swagger_path.py +++ b/tests/test_extract_swagger_path.py @@ -1,5 +1,8 @@ -from flask_restful_swagger import swagger import pytest + +from flask_restful_swagger import swagger + + """ Docstring from extract_swagger_path: @@ -9,18 +12,38 @@ to this: /{lang_code}/{id}/{probability} """ -@pytest.mark.parametrize("case_name, test_input, expected", - [('empty_string', '', ''), - ('simple', '/endpoint', '/endpoint'), - ('single_parameter_no_type', '/path/', '/path/{parameter}'), - ('single_parameter_string', '/', '/{lang_code}'), - ('multiple_parameters', '///', '/{lang_code}/{id}/{probability}'), - ('multiple_parameters_varied_length_string', '///', '/{lang_code}/{id}/{probability}'), - ('long_path_single_parameter', 'path/subpath/other_path/', 'path/subpath/other_path/{lang_code}')]) +@pytest.mark.parametrize( + "case_name, test_input, expected", + [ + ("empty_string", "", ""), + ("simple", "/endpoint", "/endpoint"), + ("single_parameter_no_type", "/path/", "/path/{parameter}"), + ( + "single_parameter_string", + "/", + "/{lang_code}", + ), + ( + "multiple_parameters", + "///", + "/{lang_code}/{id}/{probability}", + ), + ( + "multiple_parameters_varied_length_string", + "///", + "/{lang_code}/{id}/{probability}", + ), + ( + "long_path_single_parameter", + "path/subpath/other_path/", + "path/subpath/other_path/{lang_code}", + ), + ], +) def test_extract_swagger_path(case_name, test_input, expected): assert swagger.extract_swagger_path(test_input) == expected -def test_extract_swagger_path_returns_string(): - assert isinstance(swagger.extract_swagger_path('/endpoint/123'), str) +def test_extract_swagger_path_returns_string(): + assert isinstance(swagger.extract_swagger_path("/endpoint/123"), str) diff --git a/tests/test_parse_docs.py b/tests/test_parse_docs.py index 732373f..c92b979 100644 --- a/tests/test_parse_docs.py +++ b/tests/test_parse_docs.py @@ -1,34 +1,52 @@ from flask_restful_swagger import swagger -class MockBasicObject(): + +class MockBasicObject: pass + def test_parse_doc_no_object_is_none(): assert swagger._parse_doc(None) == (None, None) + def test_parse_doc_no_docs_is_none(): assert swagger._parse_doc(MockBasicObject()) == (None, None) + def test_parse_doc_one_line_doc(): test_one_line_doc = MockBasicObject() test_one_line_doc.__doc__ = "Some Text Goes Here" - assert swagger._parse_doc(test_one_line_doc) == ("Some Text Goes Here", None) + assert swagger._parse_doc(test_one_line_doc) == ( + "Some Text Goes Here", + None, + ) + def test_parse_doc_multi_line_doc(): test_multi_line_doc = MockBasicObject() - test_multi_line_doc.__doc__ = "Some Text Goes Here \n this is the extra text\n and this is the third line." + test_multi_line_doc.__doc__ = ( + "Some Text Goes Here \n this is the extra text\n" + "and this is the third line." + ) extracted = swagger._parse_doc(test_multi_line_doc) assert extracted[0] == "Some Text Goes Here " - assert extracted[1] == "this is the extra text
and this is the third line." + assert ( + extracted[1] + == " this is the extra text
and this is the third line." + ) + def test_parse_doc_weird_characters(): test_weird_characters = MockBasicObject() - test_weird_characters.__doc__ = "Hi, 297agiu(*#&_$ ! \n Oh, the terrible 2908*&%)(#%#" + test_weird_characters.__doc__ = ( + "Hi, 297agiu(*#&_$ ! \n Oh, the terrible 2908*&%)(#%#" + ) extracted = swagger._parse_doc(test_weird_characters) assert extracted[0] == "Hi, 297agiu(*#&_$ ! " assert extracted[1] == "Oh, the terrible 2908*&%)(#%#" + def test_parse_doc_ends_with_newline(): test_ends_newline = MockBasicObject() test_ends_newline.__doc__ = "Overview \n Some details \n" - assert swagger._parse_doc(test_ends_newline)[1] == "Some details " \ No newline at end of file + assert swagger._parse_doc(test_ends_newline)[1] == "Some details " diff --git a/tests/test_render_endpoint.py b/tests/test_render_endpoint.py index de0aef1..f00cf9c 100644 --- a/tests/test_render_endpoint.py +++ b/tests/test_render_endpoint.py @@ -1,15 +1,20 @@ -from flask_restful_swagger import swagger import unittest from unittest.mock import patch -class Endpoint(): +from flask_restful_swagger import swagger + + +class Endpoint: pass -class RenderEndpointTestCast(unittest.TestCase): +class RenderEndpointTestCast(unittest.TestCase): def test_render_endpoint(self): endpoint = Endpoint() - with patch ('flask_restful_swagger.swagger.render_page') as mock_render_page: + with patch( + "flask_restful_swagger.swagger.render_page" + ) as mock_render_page: swagger.render_endpoint(endpoint) - mock_render_page.assert_called_with("endpoint.html", endpoint.__dict__) - + mock_render_page.assert_called_with( + "endpoint.html", endpoint.__dict__ + ) From 300040cec30af9804fefa90b2852300573188ecc Mon Sep 17 00:00:00 2001 From: David Lieu Date: Tue, 19 Nov 2019 09:55:47 -0500 Subject: [PATCH 20/64] testing: Fix unused import on test_operation --- tests/test_operation.py | 2 -- 1 file changed, 2 deletions(-) diff --git a/tests/test_operation.py b/tests/test_operation.py index b8b123b..c28b8a5 100644 --- a/tests/test_operation.py +++ b/tests/test_operation.py @@ -1,5 +1,3 @@ -import datetime - import pytest from flask_restful_swagger import swagger From 4c155eb51c898b33fe49fa37c72a6f1d16d16ce1 Mon Sep 17 00:00:00 2001 From: Sabeur Lafi Date: Mon, 18 Nov 2019 16:04:08 -0500 Subject: [PATCH 21/64] Testing: added test for swagger function extract_path_arguments --- tests/test_extract_path_arguments.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/tests/test_extract_path_arguments.py b/tests/test_extract_path_arguments.py index 2d012b1..c9b8b9f 100644 --- a/tests/test_extract_path_arguments.py +++ b/tests/test_extract_path_arguments.py @@ -6,6 +6,9 @@ def test_documentation_example(): + """ This test case tests the outside function extract_path_arguments using + the example given in the documentation + """ path = '///' expected_result = [{"name": 'lang_code', "dataType": 'string', "paramType": "path"}, {"name": 'id', "dataType": 'string', "paramType": "path"}, @@ -16,6 +19,7 @@ def test_documentation_example(): def nested(outer, innerName, **freeVars): + """This helper function extracts the code of a function nested within another one""" if isinstance(outer, (types.FunctionType, types.MethodType)): outer = outer.__code__ for const in outer.co_consts: @@ -28,5 +32,6 @@ def nested(outer, innerName, **freeVars): [('HelloWorld', {"name": 'HelloWorld', "dataType": 'string', "paramType": "path"}), ('Hello:World', {"name": 'World', "dataType": 'Hello', "paramType": "path"})]) def test_split_arg(testcase_string, testcase_expected_result): + """This testcase tests the outside function: extract_path_arguments""" temp_split_arg = nested(swagger.extract_path_arguments, 'split_arg') assert temp_split_arg(testcase_string) == testcase_expected_result From 23a111670a6f49fb202ac1428e00eb7a83d18919 Mon Sep 17 00:00:00 2001 From: Seonaid Lee Date: Tue, 19 Nov 2019 13:20:29 -0500 Subject: [PATCH 22/64] testing for deduce_swagger_type_flat included bug fix discovered in testing --- flask_restful_swagger/swagger.py | 6 +- tests/test_deduce_swagger_type_flat.py | 92 ++++++++++++++++++++++++++ 2 files changed, 95 insertions(+), 3 deletions(-) create mode 100644 tests/test_deduce_swagger_type_flat.py diff --git a/flask_restful_swagger/swagger.py b/flask_restful_swagger/swagger.py index 536d48e..35016fd 100644 --- a/flask_restful_swagger/swagger.py +++ b/flask_restful_swagger/swagger.py @@ -551,6 +551,8 @@ def deduce_swagger_type_flat(python_type_or_object, nested_type=None): six.string_types + (fields.String, fields.FormattedString, fields.Url), ): return "string" + if predicate(python_type_or_object, (bool, fields.Boolean)): + return "boolean" if predicate(python_type_or_object, (int, fields.Integer)): return "integer" if predicate( @@ -558,9 +560,7 @@ def deduce_swagger_type_flat(python_type_or_object, nested_type=None): (float, fields.Float, fields.Arbitrary, fields.Fixed), ): return "number" - if predicate(python_type_or_object, (bool, fields.Boolean)): - return "boolean" - if predicate(python_type_or_object, (fields.DateTime,)): + if predicate(python_type_or_object, (fields.DateTime)): return "date-time" diff --git a/tests/test_deduce_swagger_type_flat.py b/tests/test_deduce_swagger_type_flat.py new file mode 100644 index 0000000..b9807d3 --- /dev/null +++ b/tests/test_deduce_swagger_type_flat.py @@ -0,0 +1,92 @@ +import pytest +import datetime + +from flask_restful_swagger import swagger +from flask_restful import fields + +""" + +the "predicate" in the function determines whether +the argument is a class or an instance chooses whether to apply +"issubclass" or "isinstance" to the remaining conditions + + +Cases + +Argument 1: + String + integer + float + boolean + date-time + child class of each of those + +Argumentßß 2: + blank + None + Something + +""" + +# Instances of types +@pytest.mark.parametrize( + "case_name, test_input, expected", + [ + ("Null", None, None), + ("Simple False", False, "boolean"), + ("Simple True", True, "boolean"), + ("Integer", 1, "integer"), + ("Very large integer", 9223372036854775807, "integer"), + ("Float less than 1", 0.8092, "number"), + ("Float greater than 1", 98763.09, "number"), + ("String", "helloWorld!", "string") + ], +) + +def test_deduce_swagger_type_flat_instances(case_name, test_input, expected): + assert swagger.deduce_swagger_type_flat(test_input) == expected + +#instances of fields from flask + +@pytest.mark.parametrize( + "field_type, expected", + [ + ("Boolean", "boolean"), + ("Integer", "integer"), + ("Arbitrary", "number"), + ("Fixed", "number"), + ("DateTime", "date-time"), + ], +) + +def test_deduce_swagger_type_flat_flask_field(field_type, expected): + new_field = getattr(fields, field_type)() + assert swagger.deduce_swagger_type_flat(new_field) == expected + +# Objects that are subclasses +@pytest.mark.parametrize( + "case_name, object_type, expected", + [ + ("Class derived from string", str, "string"), + ("Class derived from integer", int, "integer"), + ("Class derived from float", float, "number"), + ], +) + +def test_deduce_swagger_type_flat_create_new_class(case_name, object_type, expected): + class NewSubClass(object_type): + pass + + new_instance = NewSubClass() + assert swagger.deduce_swagger_type_flat(new_instance) == expected + + +def test_deduce_swagger_type_flat_with_nested_object(): + #new_object = fields.Nested({}) + assert swagger.deduce_swagger_type_flat("anything", "cookies") == "cookies" + +def test_deduce_swagger_type_flat_with_class(): + class NewSubClass(str): + pass + + assert swagger.deduce_swagger_type_flat(NewSubClass) == "string" \ No newline at end of file From f7969690b5a66bd822c686e72845054c7e47397f Mon Sep 17 00:00:00 2001 From: Niall Byrne Date: Tue, 19 Nov 2019 10:04:33 -0500 Subject: [PATCH 23/64] testing: coverage for staticfiles --- tests/test_staticfiles.py | 139 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 139 insertions(+) create mode 100644 tests/test_staticfiles.py diff --git a/tests/test_staticfiles.py b/tests/test_staticfiles.py new file mode 100644 index 0000000..38b452c --- /dev/null +++ b/tests/test_staticfiles.py @@ -0,0 +1,139 @@ +import os +from unittest.mock import patch + +import pytest + +import flask_restful_swagger +from flask_restful_swagger.swagger import StaticFiles + +test_fixtures_renders = [ + ["index.html", None, None], + ["o2c.html", None, None], + ["swagger-ui.js", None, None], + ["swagger-ui.min.js", None, None], + ["lib/swagger-oauth.js", None, None], +] + + +@patch("flask_restful_swagger.swagger.render_page") +@patch("flask_restful_swagger.swagger._get_current_registry") +@pytest.mark.parametrize("dir1,dir2,dir3", test_fixtures_renders) +def test_get_valid_content_renders(registry, render_page, dir1, dir2, dir3): + + static_files = StaticFiles() + registry.return_value = {"spec_endpoint_path": "dummy"} + + static_files.get(dir1, dir2, dir3) + assert render_page.call_args[0] == (dir1, {"resource_list_url": "dummy"}) + + +test_fixtures_none = [[None, None, None]] + + +@patch("flask_restful_swagger.swagger.render_page") +@patch("flask_restful_swagger.swagger._get_current_registry") +@pytest.mark.parametrize("dir1,dir2,dir3", test_fixtures_none) +def test_get_valid_content_renders_none( + registry, render_page, dir1, dir2, dir3 +): + + static_files = StaticFiles() + registry.return_value = {"spec_endpoint_path": "dummy"} + + static_files.get(dir1, dir2, dir3) + assert render_page.call_args[0] == ( + "index.html", + {"resource_list_url": "dummy"}, + ) + + +test_fixtures_mimes = [ + ["index2.html", "text/plain"], + ["image.gif", "image/gif"], + ["image.png", "image/png"], + ["javascript.js", "text/javascript"], + ["style.css", "text/css"], +] + + +@patch("flask_restful_swagger.swagger.Response", autospec=True) +@patch("flask_restful_swagger.swagger.open") +@patch("flask_restful_swagger.swagger.os.path.exists") +@patch("flask_restful_swagger.swagger._get_current_registry") +@pytest.mark.parametrize("dir1,mime", test_fixtures_mimes) +def test_get_valid_content_mime( + registry, mock_exists, mock_open, response, dir1, mime +): + + mock_open.return_value = "file_handle" + mock_exists.return_value = True + + static_files = StaticFiles() + static_files.get(dir1, None, None) + assert mock_exists.called + assert mock_open.called + + args, kwargs = response.call_args_list[0] + assert args == ("file_handle",) + assert kwargs == {"mimetype": mime} + + +test_fixtures_mimes_does_not_exist = ["index2.html"] + + +@patch("flask_restful_swagger.swagger.os.path.exists") +@patch("flask_restful_swagger.swagger._get_current_registry") +@patch("flask_restful_swagger.swagger.abort") +@pytest.mark.parametrize("dir1", test_fixtures_mimes_does_not_exist) +def test_get_valid_content_mime_file_does_not_exist( + abort, registry, mock_exists, dir1 +): + + mock_exists.return_value = False + static_files = StaticFiles() + static_files.get(dir1, None, None) + assert mock_exists.called + assert abort.called + + +test_fixtures_paths = [ + ["paths", "index2.html", None, "paths/index2.html"], + ["paths", "more_paths", "index2.html", "paths/more_paths/index2.html"], +] + + +@patch("flask_restful_swagger.swagger.Response", autospec=True) +@patch("flask_restful_swagger.swagger.os.path.exists") +@patch("flask_restful_swagger.swagger.open") +@patch("flask_restful_swagger.swagger.render_page") +@patch("flask_restful_swagger.swagger._get_current_registry") +@pytest.mark.parametrize("dir1,dir2,dir3,expected", test_fixtures_paths) +def test_get_valid_content_paths( + registry, + render_page, + mock_open, + mock_exists, + response, + dir1, + dir2, + dir3, + expected, +): + + mock_open.return_value = "file_handle" + mock_exists.return_value = True + + static_files = StaticFiles() + registry.return_value = {"spec_endpoint_path": "dummy"} + + static_files.get(dir1, dir2, dir3) + module_path = os.path.dirname(flask_restful_swagger.__file__) + static_files = "static" + full_path = os.path.join(module_path, static_files, expected) + + assert mock_exists.called + assert mock_open.call_args_list[0][0][0] == full_path + + args, kwargs = response.call_args_list[0] + assert args == ("file_handle",) + assert kwargs == {"mimetype": "text/plain"} From c11bba6cddcd7682aa8e681eb245c574842945c7 Mon Sep 17 00:00:00 2001 From: Seonaid Lee Date: Tue, 19 Nov 2019 14:24:25 -0500 Subject: [PATCH 24/64] test deduce_swaagger_type --- tests/test_deduce_swagger_type.py | 88 ++++++++++++++++++++++++++ tests/test_deduce_swagger_type_flat.py | 26 ++++---- 2 files changed, 103 insertions(+), 11 deletions(-) create mode 100644 tests/test_deduce_swagger_type.py diff --git a/tests/test_deduce_swagger_type.py b/tests/test_deduce_swagger_type.py new file mode 100644 index 0000000..f848991 --- /dev/null +++ b/tests/test_deduce_swagger_type.py @@ -0,0 +1,88 @@ +import pytest +from flask_restful import fields + +from flask_restful_swagger import swagger + + +@pytest.mark.parametrize( + "case_name, test_input, expected", + [ + ("Null", None, {"type": "null"}), + ("Simple False", False, {"type": "boolean"}), + ("Simple True", True, {"type": "boolean"}), + ("Integer", 1, {"type": "integer"}), + ("Very large integer", 9223372036854775807, {"type": "integer"}), + ("Float less than 1", 0.8092, {"type": "number"}), + ("Float greater than 1", 98763.09, {"type": "number"}), + ("String", "helloWorld!", {"type": "string"}), + ], +) +def test_deduce_swagger_type_instances(case_name, test_input, expected): + assert swagger.deduce_swagger_type(test_input) == expected + + +@pytest.mark.parametrize( + "field_type, expected", + [ + ("Boolean", {"type": "boolean"}), + ("Integer", {"type": "integer"}), + ("Arbitrary", {"type": "number"}), + ("Fixed", {"type": "number"}), + ("DateTime", {"type": "date-time"}), + ], +) +def test_deduce_swagger_type_flask_field(field_type, expected): + new_field = getattr(fields, field_type)() + assert swagger.deduce_swagger_type(new_field) == expected + + +# Objects that are subclasses +@pytest.mark.parametrize( + "case_name, object_type, expected", + [ + ("Class derived from string", str, {"type": "string"}), + ("Class derived from integer", int, {"type": "integer"}), + ("Class derived from float", float, {"type": "number"}), + ], +) +def test_deduce_swagger_type_create_new_class(case_name, object_type, expected): + class NewSubClass(object_type): + pass + + new_instance = NewSubClass() + assert swagger.deduce_swagger_type(new_instance) == expected + + +# Objects that are subclasses +@pytest.mark.parametrize( + "case_name, object_type, expected", + [ + ("Class derived from string", str, {"type": "string"}), + ("Class derived from integer", int, {"type": "integer"}), + ("Class derived from float", float, {"type": "number"}), + ("Class derived from fields.List", fields.List, {"type": "array"}), + ], +) +def test_deduce_swagger_type_with_class(case_name, object_type, expected): + class NewSubClass(object_type): + pass + + assert swagger.deduce_swagger_type(NewSubClass) == expected + + +def test_deduce_swagger_type_fields_FormattedString(): + new_instance = fields.FormattedString("Hello {name}") + + assert swagger.deduce_swagger_type(new_instance) == {"type": "string"} + + +def test_deduce_swagger_type_fields_list_instance(): + new_instance = fields.List(fields.String) + + assert "items" in swagger.deduce_swagger_type(new_instance) + + +def test_deduce_swagger_type_fields_nested_instance(): + new_instance = fields.Nested({}) + + assert swagger.deduce_swagger_type(new_instance) == {"type": None} diff --git a/tests/test_deduce_swagger_type_flat.py b/tests/test_deduce_swagger_type_flat.py index b9807d3..cc4ace4 100644 --- a/tests/test_deduce_swagger_type_flat.py +++ b/tests/test_deduce_swagger_type_flat.py @@ -1,8 +1,7 @@ import pytest -import datetime +from flask_restful import fields from flask_restful_swagger import swagger -from flask_restful import fields """ @@ -21,7 +20,7 @@ date-time child class of each of those -Argumentßß 2: +Argument 2: blank None Something @@ -29,6 +28,8 @@ """ # Instances of types + + @pytest.mark.parametrize( "case_name, test_input, expected", [ @@ -39,14 +40,15 @@ ("Very large integer", 9223372036854775807, "integer"), ("Float less than 1", 0.8092, "number"), ("Float greater than 1", 98763.09, "number"), - ("String", "helloWorld!", "string") + ("String", "helloWorld!", "string"), ], ) - def test_deduce_swagger_type_flat_instances(case_name, test_input, expected): assert swagger.deduce_swagger_type_flat(test_input) == expected -#instances of fields from flask + +# instances of fields from flask + @pytest.mark.parametrize( "field_type, expected", @@ -58,11 +60,11 @@ def test_deduce_swagger_type_flat_instances(case_name, test_input, expected): ("DateTime", "date-time"), ], ) - def test_deduce_swagger_type_flat_flask_field(field_type, expected): new_field = getattr(fields, field_type)() assert swagger.deduce_swagger_type_flat(new_field) == expected + # Objects that are subclasses @pytest.mark.parametrize( "case_name, object_type, expected", @@ -72,8 +74,9 @@ def test_deduce_swagger_type_flat_flask_field(field_type, expected): ("Class derived from float", float, "number"), ], ) - -def test_deduce_swagger_type_flat_create_new_class(case_name, object_type, expected): +def test_deduce_swagger_type_flat_create_new_class( + case_name, object_type, expected +): class NewSubClass(object_type): pass @@ -82,11 +85,12 @@ class NewSubClass(object_type): def test_deduce_swagger_type_flat_with_nested_object(): - #new_object = fields.Nested({}) + # new_object = fields.Nested({}) assert swagger.deduce_swagger_type_flat("anything", "cookies") == "cookies" + def test_deduce_swagger_type_flat_with_class(): class NewSubClass(str): pass - assert swagger.deduce_swagger_type_flat(NewSubClass) == "string" \ No newline at end of file + assert swagger.deduce_swagger_type_flat(NewSubClass) == "string" From b57ceafbb91d224ae8ad470c3fdee60357a89b95 Mon Sep 17 00:00:00 2001 From: Niall Byrne Date: Tue, 19 Nov 2019 15:46:16 -0500 Subject: [PATCH 25/64] testing: Add test for ResourceLister --- tests/test_resource_lister.py | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 tests/test_resource_lister.py diff --git a/tests/test_resource_lister.py b/tests/test_resource_lister.py new file mode 100644 index 0000000..001389d --- /dev/null +++ b/tests/test_resource_lister.py @@ -0,0 +1,29 @@ +from unittest.mock import patch + +from flask_restful_swagger.swagger import ResourceLister + + +@patch("flask_restful_swagger.swagger.render_page") +@patch("flask_restful_swagger.swagger._get_current_registry") +def test_get_valid_content_renders(registry, render_page): + + expected_result = { + "apiVersion": "mock_version", + "swaggerVersion": "mock_swagger_version", + "apis": [ + { + "path": "mock_pathmock_spec_endpoint_path", + "description": "mock_description", + } + ], + } + + registry.return_value = { + "apiVersion": "mock_version", + "swaggerVersion": "mock_swagger_version", + "basePath": "mock_path", + "spec_endpoint_path": "mock_spec_endpoint_path", + "description": "mock_description", + } + resource_lister = ResourceLister() + assert resource_lister.get() == expected_result From 4acfa98e011c28e3d627b6909c508831b6affeee Mon Sep 17 00:00:00 2001 From: Seonaid Lee Date: Tue, 19 Nov 2019 16:46:31 -0500 Subject: [PATCH 26/64] test render page --- htmlcov/coverage_html.js | 584 ++++++++ .../flask_restful_swagger___init___py.html | 97 ++ htmlcov/flask_restful_swagger_swagger_py.html | 1287 +++++++++++++++++ htmlcov/index.html | 128 ++ htmlcov/jquery.ba-throttle-debounce.min.js | 9 + htmlcov/jquery.hotkeys.js | 99 ++ htmlcov/jquery.isonscreen.js | 53 + htmlcov/jquery.min.js | 4 + htmlcov/jquery.tablesorter.min.js | 2 + htmlcov/keybd_closed.png | Bin 0 -> 112 bytes htmlcov/keybd_open.png | Bin 0 -> 112 bytes htmlcov/status.json | 1 + htmlcov/style.css | 375 +++++ tests/test_render_endpoint.py | 2 +- tests/test_render_page.py | 48 + 15 files changed, 2688 insertions(+), 1 deletion(-) create mode 100644 htmlcov/coverage_html.js create mode 100644 htmlcov/flask_restful_swagger___init___py.html create mode 100644 htmlcov/flask_restful_swagger_swagger_py.html create mode 100644 htmlcov/index.html create mode 100644 htmlcov/jquery.ba-throttle-debounce.min.js create mode 100644 htmlcov/jquery.hotkeys.js create mode 100644 htmlcov/jquery.isonscreen.js create mode 100644 htmlcov/jquery.min.js create mode 100644 htmlcov/jquery.tablesorter.min.js create mode 100644 htmlcov/keybd_closed.png create mode 100644 htmlcov/keybd_open.png create mode 100644 htmlcov/status.json create mode 100644 htmlcov/style.css create mode 100644 tests/test_render_page.py diff --git a/htmlcov/coverage_html.js b/htmlcov/coverage_html.js new file mode 100644 index 0000000..f6f5de2 --- /dev/null +++ b/htmlcov/coverage_html.js @@ -0,0 +1,584 @@ +// Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0 +// For details: https://bitbucket.org/ned/coveragepy/src/default/NOTICE.txt + +// Coverage.py HTML report browser code. +/*jslint browser: true, sloppy: true, vars: true, plusplus: true, maxerr: 50, indent: 4 */ +/*global coverage: true, document, window, $ */ + +coverage = {}; + +// Find all the elements with shortkey_* class, and use them to assign a shortcut key. +coverage.assign_shortkeys = function () { + $("*[class*='shortkey_']").each(function (i, e) { + $.each($(e).attr("class").split(" "), function (i, c) { + if (/^shortkey_/.test(c)) { + $(document).bind('keydown', c.substr(9), function () { + $(e).click(); + }); + } + }); + }); +}; + +// Create the events for the help panel. +coverage.wire_up_help_panel = function () { + $("#keyboard_icon").click(function () { + // Show the help panel, and position it so the keyboard icon in the + // panel is in the same place as the keyboard icon in the header. + $(".help_panel").show(); + var koff = $("#keyboard_icon").offset(); + var poff = $("#panel_icon").position(); + $(".help_panel").offset({ + top: koff.top-poff.top, + left: koff.left-poff.left + }); + }); + $("#panel_icon").click(function () { + $(".help_panel").hide(); + }); +}; + +// Create the events for the filter box. +coverage.wire_up_filter = function () { + // Cache elements. + var table = $("table.index"); + var table_rows = table.find("tbody tr"); + var table_row_names = table_rows.find("td.name a"); + var no_rows = $("#no_rows"); + + // Create a duplicate table footer that we can modify with dynamic summed values. + var table_footer = $("table.index tfoot tr"); + var table_dynamic_footer = table_footer.clone(); + table_dynamic_footer.attr('class', 'total_dynamic hidden'); + table_footer.after(table_dynamic_footer); + + // Observe filter keyevents. + $("#filter").on("keyup change", $.debounce(150, function (event) { + var filter_value = $(this).val(); + + if (filter_value === "") { + // Filter box is empty, remove all filtering. + table_rows.removeClass("hidden"); + + // Show standard footer, hide dynamic footer. + table_footer.removeClass("hidden"); + table_dynamic_footer.addClass("hidden"); + + // Hide placeholder, show table. + if (no_rows.length > 0) { + no_rows.hide(); + } + table.show(); + + } + else { + // Filter table items by value. + var hidden = 0; + var shown = 0; + + // Hide / show elements. + $.each(table_row_names, function () { + var element = $(this).parents("tr"); + + if ($(this).text().indexOf(filter_value) === -1) { + // hide + element.addClass("hidden"); + hidden++; + } + else { + // show + element.removeClass("hidden"); + shown++; + } + }); + + // Show placeholder if no rows will be displayed. + if (no_rows.length > 0) { + if (shown === 0) { + // Show placeholder, hide table. + no_rows.show(); + table.hide(); + } + else { + // Hide placeholder, show table. + no_rows.hide(); + table.show(); + } + } + + // Manage dynamic header: + if (hidden > 0) { + // Calculate new dynamic sum values based on visible rows. + for (var column = 2; column < 20; column++) { + // Calculate summed value. + var cells = table_rows.find('td:nth-child(' + column + ')'); + if (!cells.length) { + // No more columns...! + break; + } + + var sum = 0, numer = 0, denom = 0; + $.each(cells.filter(':visible'), function () { + var ratio = $(this).data("ratio"); + if (ratio) { + var splitted = ratio.split(" "); + numer += parseInt(splitted[0], 10); + denom += parseInt(splitted[1], 10); + } + else { + sum += parseInt(this.innerHTML, 10); + } + }); + + // Get footer cell element. + var footer_cell = table_dynamic_footer.find('td:nth-child(' + column + ')'); + + // Set value into dynamic footer cell element. + if (cells[0].innerHTML.indexOf('%') > -1) { + // Percentage columns use the numerator and denominator, + // and adapt to the number of decimal places. + var match = /\.([0-9]+)/.exec(cells[0].innerHTML); + var places = 0; + if (match) { + places = match[1].length; + } + var pct = numer * 100 / denom; + footer_cell.text(pct.toFixed(places) + '%'); + } + else { + footer_cell.text(sum); + } + } + + // Hide standard footer, show dynamic footer. + table_footer.addClass("hidden"); + table_dynamic_footer.removeClass("hidden"); + } + else { + // Show standard footer, hide dynamic footer. + table_footer.removeClass("hidden"); + table_dynamic_footer.addClass("hidden"); + } + } + })); + + // Trigger change event on setup, to force filter on page refresh + // (filter value may still be present). + $("#filter").trigger("change"); +}; + +// Loaded on index.html +coverage.index_ready = function ($) { + // Look for a cookie containing previous sort settings: + var sort_list = []; + var cookie_name = "COVERAGE_INDEX_SORT"; + var i; + + // This almost makes it worth installing the jQuery cookie plugin: + if (document.cookie.indexOf(cookie_name) > -1) { + var cookies = document.cookie.split(";"); + for (i = 0; i < cookies.length; i++) { + var parts = cookies[i].split("="); + + if ($.trim(parts[0]) === cookie_name && parts[1]) { + sort_list = eval("[[" + parts[1] + "]]"); + break; + } + } + } + + // Create a new widget which exists only to save and restore + // the sort order: + $.tablesorter.addWidget({ + id: "persistentSort", + + // Format is called by the widget before displaying: + format: function (table) { + if (table.config.sortList.length === 0 && sort_list.length > 0) { + // This table hasn't been sorted before - we'll use + // our stored settings: + $(table).trigger('sorton', [sort_list]); + } + else { + // This is not the first load - something has + // already defined sorting so we'll just update + // our stored value to match: + sort_list = table.config.sortList; + } + } + }); + + // Configure our tablesorter to handle the variable number of + // columns produced depending on report options: + var headers = []; + var col_count = $("table.index > thead > tr > th").length; + + headers[0] = { sorter: 'text' }; + for (i = 1; i < col_count-1; i++) { + headers[i] = { sorter: 'digit' }; + } + headers[col_count-1] = { sorter: 'percent' }; + + // Enable the table sorter: + $("table.index").tablesorter({ + widgets: ['persistentSort'], + headers: headers + }); + + coverage.assign_shortkeys(); + coverage.wire_up_help_panel(); + coverage.wire_up_filter(); + + // Watch for page unload events so we can save the final sort settings: + $(window).unload(function () { + document.cookie = cookie_name + "=" + sort_list.toString() + "; path=/"; + }); +}; + +// -- pyfile stuff -- + +coverage.pyfile_ready = function ($) { + // If we're directed to a particular line number, highlight the line. + var frag = location.hash; + if (frag.length > 2 && frag[1] === 'n') { + $(frag).addClass('highlight'); + coverage.set_sel(parseInt(frag.substr(2), 10)); + } + else { + coverage.set_sel(0); + } + + $(document) + .bind('keydown', 'j', coverage.to_next_chunk_nicely) + .bind('keydown', 'k', coverage.to_prev_chunk_nicely) + .bind('keydown', '0', coverage.to_top) + .bind('keydown', '1', coverage.to_first_chunk) + ; + + $(".button_toggle_run").click(function (evt) {coverage.toggle_lines(evt.target, "run");}); + $(".button_toggle_exc").click(function (evt) {coverage.toggle_lines(evt.target, "exc");}); + $(".button_toggle_mis").click(function (evt) {coverage.toggle_lines(evt.target, "mis");}); + $(".button_toggle_par").click(function (evt) {coverage.toggle_lines(evt.target, "par");}); + + coverage.assign_shortkeys(); + coverage.wire_up_help_panel(); + + coverage.init_scroll_markers(); + + // Rebuild scroll markers after window high changing + $(window).resize(coverage.resize_scroll_markers); +}; + +coverage.toggle_lines = function (btn, cls) { + btn = $(btn); + var hide = "hide_"+cls; + if (btn.hasClass(hide)) { + $("#source ."+cls).removeClass(hide); + btn.removeClass(hide); + } + else { + $("#source ."+cls).addClass(hide); + btn.addClass(hide); + } +}; + +// Return the nth line div. +coverage.line_elt = function (n) { + return $("#t" + n); +}; + +// Return the nth line number div. +coverage.num_elt = function (n) { + return $("#n" + n); +}; + +// Return the container of all the code. +coverage.code_container = function () { + return $(".linenos"); +}; + +// Set the selection. b and e are line numbers. +coverage.set_sel = function (b, e) { + // The first line selected. + coverage.sel_begin = b; + // The next line not selected. + coverage.sel_end = (e === undefined) ? b+1 : e; +}; + +coverage.to_top = function () { + coverage.set_sel(0, 1); + coverage.scroll_window(0); +}; + +coverage.to_first_chunk = function () { + coverage.set_sel(0, 1); + coverage.to_next_chunk(); +}; + +coverage.is_transparent = function (color) { + // Different browsers return different colors for "none". + return color === "transparent" || color === "rgba(0, 0, 0, 0)"; +}; + +coverage.to_next_chunk = function () { + var c = coverage; + + // Find the start of the next colored chunk. + var probe = c.sel_end; + var color, probe_line; + while (true) { + probe_line = c.line_elt(probe); + if (probe_line.length === 0) { + return; + } + color = probe_line.css("background-color"); + if (!c.is_transparent(color)) { + break; + } + probe++; + } + + // There's a next chunk, `probe` points to it. + var begin = probe; + + // Find the end of this chunk. + var next_color = color; + while (next_color === color) { + probe++; + probe_line = c.line_elt(probe); + next_color = probe_line.css("background-color"); + } + c.set_sel(begin, probe); + c.show_selection(); +}; + +coverage.to_prev_chunk = function () { + var c = coverage; + + // Find the end of the prev colored chunk. + var probe = c.sel_begin-1; + var probe_line = c.line_elt(probe); + if (probe_line.length === 0) { + return; + } + var color = probe_line.css("background-color"); + while (probe > 0 && c.is_transparent(color)) { + probe--; + probe_line = c.line_elt(probe); + if (probe_line.length === 0) { + return; + } + color = probe_line.css("background-color"); + } + + // There's a prev chunk, `probe` points to its last line. + var end = probe+1; + + // Find the beginning of this chunk. + var prev_color = color; + while (prev_color === color) { + probe--; + probe_line = c.line_elt(probe); + prev_color = probe_line.css("background-color"); + } + c.set_sel(probe+1, end); + c.show_selection(); +}; + +// Return the line number of the line nearest pixel position pos +coverage.line_at_pos = function (pos) { + var l1 = coverage.line_elt(1), + l2 = coverage.line_elt(2), + result; + if (l1.length && l2.length) { + var l1_top = l1.offset().top, + line_height = l2.offset().top - l1_top, + nlines = (pos - l1_top) / line_height; + if (nlines < 1) { + result = 1; + } + else { + result = Math.ceil(nlines); + } + } + else { + result = 1; + } + return result; +}; + +// Returns 0, 1, or 2: how many of the two ends of the selection are on +// the screen right now? +coverage.selection_ends_on_screen = function () { + if (coverage.sel_begin === 0) { + return 0; + } + + var top = coverage.line_elt(coverage.sel_begin); + var next = coverage.line_elt(coverage.sel_end-1); + + return ( + (top.isOnScreen() ? 1 : 0) + + (next.isOnScreen() ? 1 : 0) + ); +}; + +coverage.to_next_chunk_nicely = function () { + coverage.finish_scrolling(); + if (coverage.selection_ends_on_screen() === 0) { + // The selection is entirely off the screen: select the top line on + // the screen. + var win = $(window); + coverage.select_line_or_chunk(coverage.line_at_pos(win.scrollTop())); + } + coverage.to_next_chunk(); +}; + +coverage.to_prev_chunk_nicely = function () { + coverage.finish_scrolling(); + if (coverage.selection_ends_on_screen() === 0) { + var win = $(window); + coverage.select_line_or_chunk(coverage.line_at_pos(win.scrollTop() + win.height())); + } + coverage.to_prev_chunk(); +}; + +// Select line number lineno, or if it is in a colored chunk, select the +// entire chunk +coverage.select_line_or_chunk = function (lineno) { + var c = coverage; + var probe_line = c.line_elt(lineno); + if (probe_line.length === 0) { + return; + } + var the_color = probe_line.css("background-color"); + if (!c.is_transparent(the_color)) { + // The line is in a highlighted chunk. + // Search backward for the first line. + var probe = lineno; + var color = the_color; + while (probe > 0 && color === the_color) { + probe--; + probe_line = c.line_elt(probe); + if (probe_line.length === 0) { + break; + } + color = probe_line.css("background-color"); + } + var begin = probe + 1; + + // Search forward for the last line. + probe = lineno; + color = the_color; + while (color === the_color) { + probe++; + probe_line = c.line_elt(probe); + color = probe_line.css("background-color"); + } + + coverage.set_sel(begin, probe); + } + else { + coverage.set_sel(lineno); + } +}; + +coverage.show_selection = function () { + var c = coverage; + + // Highlight the lines in the chunk + c.code_container().find(".highlight").removeClass("highlight"); + for (var probe = c.sel_begin; probe > 0 && probe < c.sel_end; probe++) { + c.num_elt(probe).addClass("highlight"); + } + + c.scroll_to_selection(); +}; + +coverage.scroll_to_selection = function () { + // Scroll the page if the chunk isn't fully visible. + if (coverage.selection_ends_on_screen() < 2) { + // Need to move the page. The html,body trick makes it scroll in all + // browsers, got it from http://stackoverflow.com/questions/3042651 + var top = coverage.line_elt(coverage.sel_begin); + var top_pos = parseInt(top.offset().top, 10); + coverage.scroll_window(top_pos - 30); + } +}; + +coverage.scroll_window = function (to_pos) { + $("html,body").animate({scrollTop: to_pos}, 200); +}; + +coverage.finish_scrolling = function () { + $("html,body").stop(true, true); +}; + +coverage.init_scroll_markers = function () { + var c = coverage; + // Init some variables + c.lines_len = $('td.text p').length; + c.body_h = $('body').height(); + c.header_h = $('div#header').height(); + c.missed_lines = $('td.text p.mis, td.text p.par'); + + // Build html + c.resize_scroll_markers(); +}; + +coverage.resize_scroll_markers = function () { + var c = coverage, + min_line_height = 3, + max_line_height = 10, + visible_window_h = $(window).height(); + + $('#scroll_marker').remove(); + // Don't build markers if the window has no scroll bar. + if (c.body_h <= visible_window_h) { + return; + } + + $("body").append("
 
"); + var scroll_marker = $('#scroll_marker'), + marker_scale = scroll_marker.height() / c.body_h, + line_height = scroll_marker.height() / c.lines_len; + + // Line height must be between the extremes. + if (line_height > min_line_height) { + if (line_height > max_line_height) { + line_height = max_line_height; + } + } + else { + line_height = min_line_height; + } + + var previous_line = -99, + last_mark, + last_top; + + c.missed_lines.each(function () { + var line_top = Math.round($(this).offset().top * marker_scale), + id_name = $(this).attr('id'), + line_number = parseInt(id_name.substring(1, id_name.length)); + + if (line_number === previous_line + 1) { + // If this solid missed block just make previous mark higher. + last_mark.css({ + 'height': line_top + line_height - last_top + }); + } + else { + // Add colored line in scroll_marker block. + scroll_marker.append('
'); + last_mark = $('#m' + line_number); + last_mark.css({ + 'height': line_height, + 'top': line_top + }); + last_top = line_top; + } + + previous_line = line_number; + }); +}; diff --git a/htmlcov/flask_restful_swagger___init___py.html b/htmlcov/flask_restful_swagger___init___py.html new file mode 100644 index 0000000..ff6065e --- /dev/null +++ b/htmlcov/flask_restful_swagger___init___py.html @@ -0,0 +1,97 @@ + + + + + + + + + + + Coverage for flask_restful_swagger/__init__.py: 100.0% + + + + + + + + + + + + +
+ Hide keyboard shortcuts +

Hot-keys on this page

+
+

+ r + m + x + p   toggle line displays +

+

+ j + k   next/prev highlighted chunk +

+

+ 0   (zero) top of page +

+

+ 1   (one) first highlighted chunk +

+
+
+ +
+ + + + + +
+

1

+

2

+

3

+ + 		+

registry = {"models": {}} 

+

 

+

api_spec_static = "" 

+ +
+
+ + + + + diff --git a/htmlcov/flask_restful_swagger_swagger_py.html b/htmlcov/flask_restful_swagger_swagger_py.html new file mode 100644 index 0000000..b130298 --- /dev/null +++ b/htmlcov/flask_restful_swagger_swagger_py.html @@ -0,0 +1,1287 @@ + + + + + + + + + + + Coverage for flask_restful_swagger/swagger.py: 36.5% + + + + + + + + + + + + +
+ Hide keyboard shortcuts +

Hot-keys on this page

+
+

+ r + m + x + p   toggle line displays +

+

+ j + k   next/prev highlighted chunk +

+

+ 0   (zero) top of page +

+

+ 1   (one) first highlighted chunk +

+
+
+ +
+ + + + + +
+

1

+

2

+

3

+

4

+

5

+

6

+

7

+

8

+

9

+

10

+

11

+

12

+

13

+

14

+

15

+

16

+

17

+

18

+

19

+

20

+

21

+

22

+

23

+

24

+

25

+

26

+

27

+

28

+

29

+

30

+

31

+

32

+

33

+

34

+

35

+

36

+

37

+

38

+

39

+

40

+

41

+

42

+

43

+

44

+

45

+

46

+

47

+

48

+

49

+

50

+

51

+

52

+

53

+

54

+

55

+

56

+

57

+

58

+

59

+

60

+

61

+

62

+

63

+

64

+

65

+

66

+

67

+

68

+

69

+

70

+

71

+

72

+

73

+

74

+

75

+

76

+

77

+

78

+

79

+

80

+

81

+

82

+

83

+

84

+

85

+

86

+

87

+

88

+

89

+

90

+

91

+

92

+

93

+

94

+

95

+

96

+

97

+

98

+

99

+

100

+

101

+

102

+

103

+

104

+

105

+

106

+

107

+

108

+

109

+

110

+

111

+

112

+

113

+

114

+

115

+

116

+

117

+

118

+

119

+

120

+

121

+

122

+

123

+

124

+

125

+

126

+

127

+

128

+

129

+

130

+

131

+

132

+

133

+

134

+

135

+

136

+

137

+

138

+

139

+

140

+

141

+

142

+

143

+

144

+

145

+

146

+

147

+

148

+

149

+

150

+

151

+

152

+

153

+

154

+

155

+

156

+

157

+

158

+

159

+

160

+

161

+

162

+

163

+

164

+

165

+

166

+

167

+

168

+

169

+

170

+

171

+

172

+

173

+

174

+

175

+

176

+

177

+

178

+

179

+

180

+

181

+

182

+

183

+

184

+

185

+

186

+

187

+

188

+

189

+

190

+

191

+

192

+

193

+

194

+

195

+

196

+

197

+

198

+

199

+

200

+

201

+

202

+

203

+

204

+

205

+

206

+

207

+

208

+

209

+

210

+

211

+

212

+

213

+

214

+

215

+

216

+

217

+

218

+

219

+

220

+

221

+

222

+

223

+

224

+

225

+

226

+

227

+

228

+

229

+

230

+

231

+

232

+

233

+

234

+

235

+

236

+

237

+

238

+

239

+

240

+

241

+

242

+

243

+

244

+

245

+

246

+

247

+

248

+

249

+

250

+

251

+

252

+

253

+

254

+

255

+

256

+

257

+

258

+

259

+

260

+

261

+

262

+

263

+

264

+

265

+

266

+

267

+

268

+

269

+

270

+

271

+

272

+

273

+

274

+

275

+

276

+

277

+

278

+

279

+

280

+

281

+

282

+

283

+

284

+

285

+

286

+

287

+

288

+

289

+

290

+

291

+

292

+

293

+

294

+

295

+

296

+

297

+

298

+

299

+

300

+

301

+

302

+

303

+

304

+

305

+

306

+

307

+

308

+

309

+

310

+

311

+

312

+

313

+

314

+

315

+

316

+

317

+

318

+

319

+

320

+

321

+

322

+

323

+

324

+

325

+

326

+

327

+

328

+

329

+

330

+

331

+

332

+

333

+

334

+

335

+

336

+

337

+

338

+

339

+

340

+

341

+

342

+

343

+

344

+

345

+

346

+

347

+

348

+

349

+

350

+

351

+

352

+

353

+

354

+

355

+

356

+

357

+

358

+

359

+

360

+

361

+

362

+

363

+

364

+

365

+

366

+

367

+

368

+

369

+

370

+

371

+

372

+

373

+

374

+

375

+

376

+

377

+

378

+

379

+

380

+

381

+

382

+

383

+

384

+

385

+

386

+

387

+

388

+

389

+

390

+

391

+

392

+

393

+

394

+

395

+

396

+

397

+

398

+

399

+

400

+

401

+

402

+

403

+

404

+

405

+

406

+

407

+

408

+

409

+

410

+

411

+

412

+

413

+

414

+

415

+

416

+

417

+

418

+

419

+

420

+

421

+

422

+

423

+

424

+

425

+

426

+

427

+

428

+

429

+

430

+

431

+

432

+

433

+

434

+

435

+

436

+

437

+

438

+

439

+

440

+

441

+

442

+

443

+

444

+

445

+

446

+

447

+

448

+

449

+

450

+

451

+

452

+

453

+

454

+

455

+

456

+

457

+

458

+

459

+

460

+

461

+

462

+

463

+

464

+

465

+

466

+

467

+

468

+

469

+

470

+

471

+

472

+

473

+

474

+

475

+

476

+

477

+

478

+

479

+

480

+

481

+

482

+

483

+

484

+

485

+

486

+

487

+

488

+

489

+

490

+

491

+

492

+

493

+

494

+

495

+

496

+

497

+

498

+

499

+

500

+

501

+

502

+

503

+

504

+

505

+

506

+

507

+

508

+

509

+

510

+

511

+

512

+

513

+

514

+

515

+

516

+

517

+

518

+

519

+

520

+

521

+

522

+

523

+

524

+

525

+

526

+

527

+

528

+

529

+

530

+

531

+

532

+

533

+

534

+

535

+

536

+

537

+

538

+

539

+

540

+

541

+

542

+

543

+

544

+

545

+

546

+

547

+

548

+

549

+

550

+

551

+

552

+

553

+

554

+

555

+

556

+

557

+

558

+

559

+

560

+

561

+

562

+

563

+

564

+

565

+

566

+

567

+

568

+

569

+

570

+

571

+

572

+

573

+

574

+

575

+

576

+

577

+

578

+

579

+

580

+

581

+

582

+

583

+

584

+

585

+

586

+

587

+

588

+

589

+

590

+

591

+

592

+

593

+

594

+

595

+

596

+

597

+

598

+ + 		+

import functools 

+

import inspect 

+

import os 

+

import re 

+

 

+

import six 

+

from flask import Response, abort, request 

+

from flask_restful import Resource, fields 

+

from jinja2 import Template 

+

 

+

from flask_restful_swagger import api_spec_static, registry 

+

 

+

try: 

+

# urlparse is renamed to urllib.parse in python 3 

+

import urlparse 

+

except ImportError: 

+

from urllib import parse as urlparse 

+

 

+

 

+

resource_listing_endpoint = None 

+

 

+

 

+

def docs( 

+

api, 

+

apiVersion="0.0", 

+

swaggerVersion="1.2", 

+

basePath="http://localhost:5000", 

+

resourcePath="/", 

+

produces=["application/json"], 

+

api_spec_url="/api/spec", 

+

description="Auto generated API docs by flask-restful-swagger", 

+

): 

+

 

+

api_add_resource = api.add_resource 

+

 

+

def add_resource(resource, *urls, **kvargs): 

+

register_once( 

+

api, 

+

api_add_resource, 

+

apiVersion, 

+

swaggerVersion, 

+

basePath, 

+

resourcePath, 

+

produces, 

+

api_spec_url, 

+

description, 

+

) 

+

 

+

resource = make_class(resource) 

+

for url in urls: 

+

endpoint = swagger_endpoint(api, resource, url) 

+

 

+

# Add a .help.json help url 

+

swagger_path = extract_swagger_path(url) 

+

 

+

# Add a .help.html help url 

+

endpoint_html_str = "{0}/help".format(swagger_path) 

+

api_add_resource( 

+

endpoint, 

+

"{0}.help.json".format(swagger_path), 

+

"{0}.help.html".format(swagger_path), 

+

endpoint=endpoint_html_str, 

+

) 

+

 

+

return api_add_resource(resource, *urls, **kvargs) 

+

 

+

api.add_resource = add_resource 

+

 

+

return api 

+

 

+

 

+

rootPath = os.path.dirname(__file__) 

+

 

+

 

+

def make_class(class_or_instance): 

+

if inspect.isclass(class_or_instance): 

+

return class_or_instance 

+

return class_or_instance.__class__ 

+

 

+

 

+

def register_once( 

+

api, 

+

add_resource_func, 

+

apiVersion, 

+

swaggerVersion, 

+

basePath, 

+

resourcePath, 

+

produces, 

+

endpoint_path, 

+

description, 

+

): 

+

global api_spec_static 

+

global resource_listing_endpoint 

+

 

+

if api.blueprint and not registry.get(api.blueprint.name): 

+

# Most of all this can be taken from the blueprint/app 

+

registry[api.blueprint.name] = { 

+

"apiVersion": apiVersion, 

+

"swaggerVersion": swaggerVersion, 

+

"basePath": basePath, 

+

"spec_endpoint_path": endpoint_path, 

+

"resourcePath": resourcePath, 

+

"produces": produces, 

+

"x-api-prefix": "", 

+

"apis": [], 

+

"description": description, 

+

} 

+

 

+

def registering_blueprint(setup_state): 

+

reg = registry[setup_state.blueprint.name] 

+

reg["x-api-prefix"] = setup_state.url_prefix 

+

 

+

api.blueprint.record(registering_blueprint) 

+

 

+

add_resource_func( 

+

SwaggerRegistry, 

+

endpoint_path, 

+

endpoint_path + ".json", 

+

endpoint_path + ".html", 

+

) 

+

 

+

resource_listing_endpoint = endpoint_path + "/_/resource_list.json" 

+

add_resource_func(ResourceLister, resource_listing_endpoint) 

+

 

+

api_spec_static = endpoint_path + "/_/static/" 

+

add_resource_func( 

+

StaticFiles, 

+

api_spec_static + "<string:dir1>/<string:dir2>/<string:dir3>", 

+

api_spec_static + "<string:dir1>/<string:dir2>", 

+

api_spec_static + "<string:dir1>", 

+

) 

+

elif "app" not in registry: 

+

registry["app"] = { 

+

"apiVersion": apiVersion, 

+

"swaggerVersion": swaggerVersion, 

+

"basePath": basePath, 

+

"spec_endpoint_path": endpoint_path, 

+

"resourcePath": resourcePath, 

+

"produces": produces, 

+

"description": description, 

+

} 

+

 

+

add_resource_func( 

+

SwaggerRegistry, 

+

endpoint_path, 

+

endpoint_path + ".json", 

+

endpoint_path + ".html", 

+

endpoint="app/registry", 

+

) 

+

 

+

resource_listing_endpoint = endpoint_path + "/_/resource_list.json" 

+

add_resource_func( 

+

ResourceLister, 

+

resource_listing_endpoint, 

+

endpoint="app/resourcelister", 

+

) 

+

 

+

api_spec_static = endpoint_path + "/_/static/" 

+

add_resource_func( 

+

StaticFiles, 

+

api_spec_static + "<string:dir1>/<string:dir2>/<string:dir3>", 

+

api_spec_static + "<string:dir1>/<string:dir2>", 

+

api_spec_static + "<string:dir1>", 

+

endpoint="app/staticfiles", 

+

) 

+

 

+

 

+

templates = {} 

+

 

+

 

+

def render_endpoint(endpoint): 

+

return render_page("endpoint.html", endpoint.__dict__) 

+

 

+

 

+

def render_homepage(resource_list_url): 

+

conf = {"resource_list_url": resource_list_url} 

+

return render_page("index.html", conf) 

+

 

+

 

+

def _get_current_registry(api=None): 

+

# import ipdb;ipdb.set_trace() 

+

global registry 

+

app_name = None 

+

overrides = {} 

+

if api: 

+

app_name = api.blueprint.name if api.blueprint else None 

+

else: 

+

app_name = request.blueprint 

+

urlparts = urlparse.urlparse(request.url_root.rstrip("/")) 

+

proto = request.headers.get("x-forwarded-proto") or urlparts[0] 

+

overrides = { 

+

"basePath": urlparse.urlunparse([proto] + list(urlparts[1:])), 

+

} 

+

 

+

if not app_name: 

+

app_name = "app" 

+

 

+

overrides["models"] = registry.get("models", {}) 

+

 

+

reg = registry.setdefault(app_name, {}) 

+

reg.update(overrides) 

+

 

+

reg["basePath"] = reg["basePath"] + (reg.get("x-api-prefix", "") or "") 

+

 

+

return reg 

+

 

+

 

+

def render_page(page, info): 

+

req_registry = _get_current_registry() 

+

url = req_registry["basePath"] 

+

if url.endswith("/"): 

+

url = url.rstrip("/") 

+

conf = { 

+

"base_url": url + api_spec_static, 

+

"full_base_url": url + api_spec_static, 

+

} 

+

if info is not None: 

+

conf.update(info) 

+

global templates 

+

if page in templates: 

+

template = templates[page] 

+

else: 

+

with open(os.path.join(rootPath, "static", page), "r") as fs: 

+

template = Template(fs.read()) 

+

templates[page] = template 

+

mime = "text/html" 

+

if page.endswith(".js"): 

+

mime = "text/javascript" 

+

return Response(template.render(conf), mimetype=mime) 

+

 

+

 

+

class StaticFiles(Resource): 

+

def get(self, dir1=None, dir2=None, dir3=None): 

+

req_registry = _get_current_registry() 

+

 

+

if dir1 is None: 

+

filePath = "index.html" 

+

else: 

+

filePath = dir1 

+

if dir2 is not None: 

+

filePath = "%s/%s" % (filePath, dir2) 

+

if dir3 is not None: 

+

filePath = "%s/%s" % (filePath, dir3) 

+

if filePath in [ 

+

"index.html", 

+

"o2c.html", 

+

"swagger-ui.js", 

+

"swagger-ui.min.js", 

+

"lib/swagger-oauth.js", 

+

]: 

+

conf = {"resource_list_url": req_registry["spec_endpoint_path"]} 

+

return render_page(filePath, conf) 

+

mime = "text/plain" 

+

if filePath.endswith(".gif"): 

+

mime = "image/gif" 

+

elif filePath.endswith(".png"): 

+

mime = "image/png" 

+

elif filePath.endswith(".js"): 

+

mime = "text/javascript" 

+

elif filePath.endswith(".css"): 

+

mime = "text/css" 

+

filePath = os.path.join(rootPath, "static", filePath) 

+

if os.path.exists(filePath): 

+

fs = open(filePath, "rb") 

+

return Response(fs, mimetype=mime) 

+

abort(404) 

+

 

+

 

+

class ResourceLister(Resource): 

+

def get(self): 

+

req_registry = _get_current_registry() 

+

return { 

+

"apiVersion": req_registry["apiVersion"], 

+

"swaggerVersion": req_registry["swaggerVersion"], 

+

"apis": [ 

+

{ 

+

"path": ( 

+

req_registry["basePath"] 

+

+ req_registry["spec_endpoint_path"] 

+

), 

+

"description": req_registry["description"], 

+

} 

+

], 

+

} 

+

 

+

 

+

def swagger_endpoint(api, resource, path): 

+

endpoint = SwaggerEndpoint(resource, path) 

+

req_registry = _get_current_registry(api=api) 

+

req_registry.setdefault("apis", []).append(endpoint.__dict__) 

+

 

+

class SwaggerResource(Resource): 

+

def get(self): 

+

if request.path.endswith(".help.json"): 

+

return endpoint.__dict__ 

+

if request.path.endswith(".help.html"): 

+

return render_endpoint(endpoint) 

+

 

+

return SwaggerResource 

+

 

+

 

+

def _sanitize_doc(comment): 

+

return comment.replace("\n", "<br/>") if comment else comment 

+

 

+

 

+

def _parse_doc(obj): 

+

first_line, other_lines = None, None 

+

 

+

full_doc = inspect.getdoc(obj) 

+

if full_doc: 

+

line_feed = full_doc.find("\n") 

+

if line_feed != -1: 

+

first_line = _sanitize_doc(full_doc[:line_feed]) 

+

other_lines = _sanitize_doc(full_doc[line_feed + 1 :]) 

+

else: 

+

first_line = full_doc 

+

 

+

return first_line, other_lines 

+

 

+

 

+

class SwaggerEndpoint(object): 

+

def __init__(self, resource, path): 

+

self.path = extract_swagger_path(path) 

+

path_arguments = extract_path_arguments(path) 

+

self.description, self.notes = _parse_doc(resource) 

+

self.operations = self.extract_operations(resource, path_arguments) 

+

 

+

@staticmethod 

+

def extract_operations(resource, path_arguments=[]): 

+

operations = [] 

+

for method in [m.lower() for m in resource.methods]: 

+

method_impl = resource.__dict__.get(method, None) 

+

if method_impl is None: 

+

for cls in resource.__mro__: 

+

for item_key in cls.__dict__.keys(): 

+

if item_key == method: 

+

method_impl = cls.__dict__[item_key] 

+

op = { 

+

"method": method, 

+

"parameters": path_arguments, 

+

"nickname": "nickname", 

+

} 

+

op["summary"], op["notes"] = _parse_doc(method_impl) 

+

 

+

if "__swagger_attr" in method_impl.__dict__: 

+

# This method was annotated with @swagger.operation 

+

decorators = method_impl.__dict__["__swagger_attr"] 

+

for att_name, att_value in list(decorators.items()): 

+

if isinstance(att_value, six.string_types + (int, list)): 

+

if att_name == "parameters": 

+

op["parameters"] = merge_parameter_list( 

+

op["parameters"], att_value 

+

) 

+

else: 

+

if op.get(att_name) and att_name != "nickname": 

+

att_value = "{0}<br/>{1}".format( 

+

att_value, op[att_name] 

+

) 

+

op[att_name] = att_value 

+

elif isinstance(att_value, object): 

+

op[att_name] = att_value.__name__ 

+

operations.append(op) 

+

return operations 

+

 

+

 

+

def merge_parameter_list(base, override): 

+

base = list(base) 

+

names = [x["name"] for x in base] 

+

for o in override: 

+

if o["name"] in names: 

+

for n, i in enumerate(base): 

+

if i["name"] == o["name"]: 

+

base[n] = o 

+

else: 

+

base.append(o) 

+

return base 

+

 

+

 

+

class SwaggerRegistry(Resource): 

+

def get(self): 

+

req_registry = _get_current_registry() 

+

if request.path.endswith(".html"): 

+

return render_homepage( 

+

req_registry["basePath"] 

+

+ req_registry["spec_endpoint_path"] 

+

+ "/_/resource_list.json" 

+

) 

+

return req_registry 

+

 

+

 

+

def operation(**kwargs): 

+

""" 

+

This dedorator marks a function as a swagger operation so that we can easily 

+

extract attributes from it. 

+

It saves the decorator's key-values at the function level so we can later 

+

extract them later when add_resource is invoked. 

+

""" 

+

 

+

def inner(f): 

+

f.__swagger_attr = kwargs 

+

return f 

+

 

+

return inner 

+

 

+

 

+

def model(c=None, *args, **kwargs): 

+

add_model(c) 

+

return c 

+

 

+

 

+

class _Nested(object): 

+

def __init__(self, klass, **kwargs): 

+

self._nested = kwargs 

+

self._klass = klass 

+

 

+

def __call__(self, *args, **kwargs): 

+

return self._klass(*args, **kwargs) 

+

 

+

def nested(self): 

+

return self._nested 

+

 

+

 

+

# wrap _Cache to allow for deferred calling 

+

def nested(klass=None, **kwargs): 

+

if klass: 

+

ret = _Nested(klass) 

+

functools.update_wrapper(ret, klass) 

+

else: 

+

 

+

def wrapper(klass): 

+

wrapped = _Nested(klass, **kwargs) 

+

functools.update_wrapper(wrapped, klass) 

+

return wrapped 

+

 

+

ret = wrapper 

+

return ret 

+

 

+

 

+

def add_model(model_class): 

+

models = registry["models"] 

+

name = model_class.__name__ 

+

model = models[name] = {"id": name} 

+

model["description"], model["notes"] = _parse_doc(model_class) 

+

if "resource_fields" in dir(model_class): 

+

# We take special care when the model class has a field resource_fields. 

+

# By convension this field specifies what flask-restful would return 

+

# when this model is used as a return value from an HTTP endpoint. 

+

# We look at the class and search for an attribute named 

+

# resource_fields. 

+

# If that attribute exists then we deduce the swagger model by the 

+

# content of this attribute 

+

 

+

if hasattr(model_class, "required"): 

+

required = model["required"] = model_class.required 

+

 

+

properties = model["properties"] = {} 

+

nested = ( 

+

model_class.nested() if isinstance(model_class, _Nested) else {} 

+

) 

+

for field_name, field_type in list(model_class.resource_fields.items()): 

+

nested_type = nested[field_name] if field_name in nested else None 

+

properties[field_name] = deduce_swagger_type( 

+

field_type, nested_type 

+

) 

+

elif "__init__" in dir(model_class): 

+

# Alternatively, if a resource_fields does not exist, we deduce the 

+

# model fields from the parameters sent to its __init__ method 

+

 

+

# Credits for this snippet go to Robin Walsh 

+

# https://github.com/hobbeswalsh/flask-sillywalk 

+

argspec = inspect.getargspec(model_class.__init__) 

+

argspec.args.remove("self") 

+

defaults = {} 

+

required = model["required"] = [] 

+

if argspec.defaults: 

+

defaults = list( 

+

zip(argspec.args[-len(argspec.defaults) :], argspec.defaults) 

+

) 

+

properties = model["properties"] = {} 

+

required_args_count = len(argspec.args) - len(defaults) 

+

for arg in argspec.args[:required_args_count]: # type: str 

+

# str for lack of better knowledge, until we add more metadata 

+

required.append(arg) 

+

properties[arg] = {"type": "string"} 

+

for k, v in defaults: 

+

properties[k] = {"type": "string", "default": v} 

+

 

+

if "swagger_metadata" in dir(model_class): 

+

for field_name, field_metadata in model_class.swagger_metadata.items(): 

+

if field_name in properties: 

+

# does not work for Python 3.x; see: http://stackoverflow.com/questions/38987/how-can-i-merge-two-python-dictionaries-in-a-single-expression # noqa 

+

# properties[field_name] = dict(properties[field_name].items() + field_metadata.items()) # noqa 

+

properties[field_name].update(field_metadata) 

+

 

+

 

+

def deduce_swagger_type(python_type_or_object, nested_type=None): 

+

import inspect 

+

 

+

if inspect.isclass(python_type_or_object): 

+

predicate = issubclass 

+

else: 

+

predicate = isinstance 

+

if predicate( 

+

python_type_or_object, 

+

six.string_types 

+

+ ( 

+

fields.String, 

+

fields.FormattedString, 

+

fields.Url, 

+

int, 

+

fields.Integer, 

+

float, 

+

fields.Float, 

+

fields.Arbitrary, 

+

fields.Fixed, 

+

bool, 

+

fields.Boolean, 

+

fields.DateTime, 

+

), 

+

): 

+

return {"type": deduce_swagger_type_flat(python_type_or_object)} 

+

if predicate(python_type_or_object, (fields.List)): 

+

if inspect.isclass(python_type_or_object): 

+

return {"type": "array"} 

+

else: 

+

return { 

+

"type": "array", 

+

"items": { 

+

"$ref": deduce_swagger_type_flat( 

+

python_type_or_object.container, nested_type 

+

) 

+

}, 

+

} 

+

if predicate(python_type_or_object, (fields.Nested)): 

+

return {"type": nested_type} 

+

 

+

return {"type": "null"} 

+

 

+

 

+

def deduce_swagger_type_flat(python_type_or_object, nested_type=None): 

+

if nested_type: 

+

return nested_type 

+

import inspect 

+

 

+

if inspect.isclass(python_type_or_object): 

+

predicate = issubclass 

+

else: 

+

predicate = isinstance 

+

if predicate( 

+

python_type_or_object, 

+

six.string_types + (fields.String, fields.FormattedString, fields.Url), 

+

): 

+

return "string" 

+

if predicate(python_type_or_object, (bool, fields.Boolean)): 

+

return "boolean" 

+

if predicate(python_type_or_object, (int, fields.Integer)): 

+

return "integer" 

+

if predicate( 

+

python_type_or_object, 

+

(float, fields.Float, fields.Arbitrary, fields.Fixed), 

+

): 

+

return "number" 

+

if predicate(python_type_or_object, (fields.DateTime)): 

+

return "date-time" 

+

 

+

 

+

def extract_swagger_path(path): 

+

""" 

+

Extracts a swagger type path from the given flask style path. 

+

This /path/<parameter> turns into this /path/{parameter} 

+

And this /<string(length=2):lang_code>/<string:id>/<float:probability> 

+

to this: /{lang_code}/{id}/{probability} 

+

""" 

+

return re.sub("<(?:[^:]+:)?([^>]+)>", "{\\1}", path) 

+

 

+

 

+

def extract_path_arguments(path): 

+

""" 

+

Extracts a swagger path arguments from the given flask path. 

+

This /path/<parameter> extracts [{name: 'parameter'}] 

+

And this /<string(length=2):lang_code>/<string:id>/<float:probability> 

+

extracts: [ 

+

{name: 'lang_code', dataType: 'string'}, 

+

{name: 'id', dataType: 'string'} 

+

{name: 'probability', dataType: 'float'}] 

+

""" 

+

# Remove all paranteses 

+

path = re.sub("\([^\)]*\)", "", path) 

+

args = re.findall("<([^>]+)>", path) 

+

 

+

def split_arg(arg): 

+

spl = arg.split(":") 

+

if len(spl) == 1: 

+

return {"name": spl[0], "dataType": "string", "paramType": "path"} 

+

else: 

+

return {"name": spl[1], "dataType": spl[0], "paramType": "path"} 

+

 

+

return list(map(split_arg, args)) 

+ +
+
+ + + + + diff --git a/htmlcov/index.html b/htmlcov/index.html new file mode 100644 index 0000000..4de70c4 --- /dev/null +++ b/htmlcov/index.html @@ -0,0 +1,128 @@ + + + + + + + + Coverage report + + + + + + + + + + + + + +
+ Hide keyboard shortcuts +

Hot-keys on this page

+
+

+ n + s + m + x + + b + p + + c   change column sorting +

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Modulestatementsmissingexcludedbranchespartialcoverage
Total2921750129036.8%
flask_restful_swagger/__init__.py20000100.0%
flask_restful_swagger/swagger.py2901750129036.5%
+ +

+ No items found using the specified filter. +

+
+ + + + + diff --git a/htmlcov/jquery.ba-throttle-debounce.min.js b/htmlcov/jquery.ba-throttle-debounce.min.js new file mode 100644 index 0000000..648fe5d --- /dev/null +++ b/htmlcov/jquery.ba-throttle-debounce.min.js @@ -0,0 +1,9 @@ +/* + * jQuery throttle / debounce - v1.1 - 3/7/2010 + * http://benalman.com/projects/jquery-throttle-debounce-plugin/ + * + * Copyright (c) 2010 "Cowboy" Ben Alman + * Dual licensed under the MIT and GPL licenses. + * http://benalman.com/about/license/ + */ +(function(b,c){var $=b.jQuery||b.Cowboy||(b.Cowboy={}),a;$.throttle=a=function(e,f,j,i){var h,d=0;if(typeof f!=="boolean"){i=j;j=f;f=c}function g(){var o=this,m=+new Date()-d,n=arguments;function l(){d=+new Date();j.apply(o,n)}function k(){h=c}if(i&&!h){l()}h&&clearTimeout(h);if(i===c&&m>e){l()}else{if(f!==true){h=setTimeout(i?k:l,i===c?e-m:e)}}}if($.guid){g.guid=j.guid=j.guid||$.guid++}return g};$.debounce=function(d,e,f){return f===c?a(d,e,false):a(d,f,e!==false)}})(this); diff --git a/htmlcov/jquery.hotkeys.js b/htmlcov/jquery.hotkeys.js new file mode 100644 index 0000000..09b21e0 --- /dev/null +++ b/htmlcov/jquery.hotkeys.js @@ -0,0 +1,99 @@ +/* + * jQuery Hotkeys Plugin + * Copyright 2010, John Resig + * Dual licensed under the MIT or GPL Version 2 licenses. + * + * Based upon the plugin by Tzury Bar Yochay: + * http://github.com/tzuryby/hotkeys + * + * Original idea by: + * Binny V A, http://www.openjs.com/scripts/events/keyboard_shortcuts/ +*/ + +(function(jQuery){ + + jQuery.hotkeys = { + version: "0.8", + + specialKeys: { + 8: "backspace", 9: "tab", 13: "return", 16: "shift", 17: "ctrl", 18: "alt", 19: "pause", + 20: "capslock", 27: "esc", 32: "space", 33: "pageup", 34: "pagedown", 35: "end", 36: "home", + 37: "left", 38: "up", 39: "right", 40: "down", 45: "insert", 46: "del", + 96: "0", 97: "1", 98: "2", 99: "3", 100: "4", 101: "5", 102: "6", 103: "7", + 104: "8", 105: "9", 106: "*", 107: "+", 109: "-", 110: ".", 111 : "/", + 112: "f1", 113: "f2", 114: "f3", 115: "f4", 116: "f5", 117: "f6", 118: "f7", 119: "f8", + 120: "f9", 121: "f10", 122: "f11", 123: "f12", 144: "numlock", 145: "scroll", 191: "/", 224: "meta" + }, + + shiftNums: { + "`": "~", "1": "!", "2": "@", "3": "#", "4": "$", "5": "%", "6": "^", "7": "&", + "8": "*", "9": "(", "0": ")", "-": "_", "=": "+", ";": ": ", "'": "\"", ",": "<", + ".": ">", "/": "?", "\\": "|" + } + }; + + function keyHandler( handleObj ) { + // Only care when a possible input has been specified + if ( typeof handleObj.data !== "string" ) { + return; + } + + var origHandler = handleObj.handler, + keys = handleObj.data.toLowerCase().split(" "); + + handleObj.handler = function( event ) { + // Don't fire in text-accepting inputs that we didn't directly bind to + if ( this !== event.target && (/textarea|select/i.test( event.target.nodeName ) || + event.target.type === "text") ) { + return; + } + + // Keypress represents characters, not special keys + var special = event.type !== "keypress" && jQuery.hotkeys.specialKeys[ event.which ], + character = String.fromCharCode( event.which ).toLowerCase(), + key, modif = "", possible = {}; + + // check combinations (alt|ctrl|shift+anything) + if ( event.altKey && special !== "alt" ) { + modif += "alt+"; + } + + if ( event.ctrlKey && special !== "ctrl" ) { + modif += "ctrl+"; + } + + // TODO: Need to make sure this works consistently across platforms + if ( event.metaKey && !event.ctrlKey && special !== "meta" ) { + modif += "meta+"; + } + + if ( event.shiftKey && special !== "shift" ) { + modif += "shift+"; + } + + if ( special ) { + possible[ modif + special ] = true; + + } else { + possible[ modif + character ] = true; + possible[ modif + jQuery.hotkeys.shiftNums[ character ] ] = true; + + // "$" can be triggered as "Shift+4" or "Shift+$" or just "$" + if ( modif === "shift+" ) { + possible[ jQuery.hotkeys.shiftNums[ character ] ] = true; + } + } + + for ( var i = 0, l = keys.length; i < l; i++ ) { + if ( possible[ keys[i] ] ) { + return origHandler.apply( this, arguments ); + } + } + }; + } + + jQuery.each([ "keydown", "keyup", "keypress" ], function() { + jQuery.event.special[ this ] = { add: keyHandler }; + }); + +})( jQuery ); diff --git a/htmlcov/jquery.isonscreen.js b/htmlcov/jquery.isonscreen.js new file mode 100644 index 0000000..0182ebd --- /dev/null +++ b/htmlcov/jquery.isonscreen.js @@ -0,0 +1,53 @@ +/* Copyright (c) 2010 + * @author Laurence Wheway + * Dual licensed under the MIT (http://www.opensource.org/licenses/mit-license.php) + * and GPL (http://www.opensource.org/licenses/gpl-license.php) licenses. + * + * @version 1.2.0 + */ +(function($) { + jQuery.extend({ + isOnScreen: function(box, container) { + //ensure numbers come in as intgers (not strings) and remove 'px' is it's there + for(var i in box){box[i] = parseFloat(box[i])}; + for(var i in container){container[i] = parseFloat(container[i])}; + + if(!container){ + container = { + left: $(window).scrollLeft(), + top: $(window).scrollTop(), + width: $(window).width(), + height: $(window).height() + } + } + + if( box.left+box.width-container.left > 0 && + box.left < container.width+container.left && + box.top+box.height-container.top > 0 && + box.top < container.height+container.top + ) return true; + return false; + } + }) + + + jQuery.fn.isOnScreen = function (container) { + for(var i in container){container[i] = parseFloat(container[i])}; + + if(!container){ + container = { + left: $(window).scrollLeft(), + top: $(window).scrollTop(), + width: $(window).width(), + height: $(window).height() + } + } + + if( $(this).offset().left+$(this).width()-container.left > 0 && + $(this).offset().left < container.width+container.left && + $(this).offset().top+$(this).height()-container.top > 0 && + $(this).offset().top < container.height+container.top + ) return true; + return false; + } +})(jQuery); diff --git a/htmlcov/jquery.min.js b/htmlcov/jquery.min.js new file mode 100644 index 0000000..d1608e3 --- /dev/null +++ b/htmlcov/jquery.min.js @@ -0,0 +1,4 @@ +/*! jQuery v1.11.1 | (c) 2005, 2014 jQuery Foundation, Inc. | jquery.org/license */ +!function(a,b){"object"==typeof module&&"object"==typeof module.exports?module.exports=a.document?b(a,!0):function(a){if(!a.document)throw new Error("jQuery requires a window with a document");return b(a)}:b(a)}("undefined"!=typeof window?window:this,function(a,b){var c=[],d=c.slice,e=c.concat,f=c.push,g=c.indexOf,h={},i=h.toString,j=h.hasOwnProperty,k={},l="1.11.1",m=function(a,b){return new m.fn.init(a,b)},n=/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g,o=/^-ms-/,p=/-([\da-z])/gi,q=function(a,b){return b.toUpperCase()};m.fn=m.prototype={jquery:l,constructor:m,selector:"",length:0,toArray:function(){return d.call(this)},get:function(a){return null!=a?0>a?this[a+this.length]:this[a]:d.call(this)},pushStack:function(a){var b=m.merge(this.constructor(),a);return b.prevObject=this,b.context=this.context,b},each:function(a,b){return m.each(this,a,b)},map:function(a){return this.pushStack(m.map(this,function(b,c){return a.call(b,c,b)}))},slice:function(){return this.pushStack(d.apply(this,arguments))},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},eq:function(a){var b=this.length,c=+a+(0>a?b:0);return this.pushStack(c>=0&&b>c?[this[c]]:[])},end:function(){return this.prevObject||this.constructor(null)},push:f,sort:c.sort,splice:c.splice},m.extend=m.fn.extend=function(){var a,b,c,d,e,f,g=arguments[0]||{},h=1,i=arguments.length,j=!1;for("boolean"==typeof g&&(j=g,g=arguments[h]||{},h++),"object"==typeof g||m.isFunction(g)||(g={}),h===i&&(g=this,h--);i>h;h++)if(null!=(e=arguments[h]))for(d in e)a=g[d],c=e[d],g!==c&&(j&&c&&(m.isPlainObject(c)||(b=m.isArray(c)))?(b?(b=!1,f=a&&m.isArray(a)?a:[]):f=a&&m.isPlainObject(a)?a:{},g[d]=m.extend(j,f,c)):void 0!==c&&(g[d]=c));return g},m.extend({expando:"jQuery"+(l+Math.random()).replace(/\D/g,""),isReady:!0,error:function(a){throw new Error(a)},noop:function(){},isFunction:function(a){return"function"===m.type(a)},isArray:Array.isArray||function(a){return"array"===m.type(a)},isWindow:function(a){return null!=a&&a==a.window},isNumeric:function(a){return!m.isArray(a)&&a-parseFloat(a)>=0},isEmptyObject:function(a){var b;for(b in a)return!1;return!0},isPlainObject:function(a){var b;if(!a||"object"!==m.type(a)||a.nodeType||m.isWindow(a))return!1;try{if(a.constructor&&!j.call(a,"constructor")&&!j.call(a.constructor.prototype,"isPrototypeOf"))return!1}catch(c){return!1}if(k.ownLast)for(b in a)return j.call(a,b);for(b in a);return void 0===b||j.call(a,b)},type:function(a){return null==a?a+"":"object"==typeof a||"function"==typeof a?h[i.call(a)]||"object":typeof a},globalEval:function(b){b&&m.trim(b)&&(a.execScript||function(b){a.eval.call(a,b)})(b)},camelCase:function(a){return a.replace(o,"ms-").replace(p,q)},nodeName:function(a,b){return a.nodeName&&a.nodeName.toLowerCase()===b.toLowerCase()},each:function(a,b,c){var d,e=0,f=a.length,g=r(a);if(c){if(g){for(;f>e;e++)if(d=b.apply(a[e],c),d===!1)break}else for(e in a)if(d=b.apply(a[e],c),d===!1)break}else if(g){for(;f>e;e++)if(d=b.call(a[e],e,a[e]),d===!1)break}else for(e in a)if(d=b.call(a[e],e,a[e]),d===!1)break;return a},trim:function(a){return null==a?"":(a+"").replace(n,"")},makeArray:function(a,b){var c=b||[];return null!=a&&(r(Object(a))?m.merge(c,"string"==typeof a?[a]:a):f.call(c,a)),c},inArray:function(a,b,c){var d;if(b){if(g)return g.call(b,a,c);for(d=b.length,c=c?0>c?Math.max(0,d+c):c:0;d>c;c++)if(c in b&&b[c]===a)return c}return-1},merge:function(a,b){var c=+b.length,d=0,e=a.length;while(c>d)a[e++]=b[d++];if(c!==c)while(void 0!==b[d])a[e++]=b[d++];return a.length=e,a},grep:function(a,b,c){for(var d,e=[],f=0,g=a.length,h=!c;g>f;f++)d=!b(a[f],f),d!==h&&e.push(a[f]);return e},map:function(a,b,c){var d,f=0,g=a.length,h=r(a),i=[];if(h)for(;g>f;f++)d=b(a[f],f,c),null!=d&&i.push(d);else for(f in a)d=b(a[f],f,c),null!=d&&i.push(d);return e.apply([],i)},guid:1,proxy:function(a,b){var c,e,f;return"string"==typeof b&&(f=a[b],b=a,a=f),m.isFunction(a)?(c=d.call(arguments,2),e=function(){return a.apply(b||this,c.concat(d.call(arguments)))},e.guid=a.guid=a.guid||m.guid++,e):void 0},now:function(){return+new Date},support:k}),m.each("Boolean Number String Function Array Date RegExp Object Error".split(" "),function(a,b){h["[object "+b+"]"]=b.toLowerCase()});function r(a){var b=a.length,c=m.type(a);return"function"===c||m.isWindow(a)?!1:1===a.nodeType&&b?!0:"array"===c||0===b||"number"==typeof b&&b>0&&b-1 in a}var s=function(a){var b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u="sizzle"+-new Date,v=a.document,w=0,x=0,y=gb(),z=gb(),A=gb(),B=function(a,b){return a===b&&(l=!0),0},C="undefined",D=1<<31,E={}.hasOwnProperty,F=[],G=F.pop,H=F.push,I=F.push,J=F.slice,K=F.indexOf||function(a){for(var b=0,c=this.length;c>b;b++)if(this[b]===a)return b;return-1},L="checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped",M="[\\x20\\t\\r\\n\\f]",N="(?:\\\\.|[\\w-]|[^\\x00-\\xa0])+",O=N.replace("w","w#"),P="\\["+M+"*("+N+")(?:"+M+"*([*^$|!~]?=)"+M+"*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|("+O+"))|)"+M+"*\\]",Q=":("+N+")(?:\\((('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|((?:\\\\.|[^\\\\()[\\]]|"+P+")*)|.*)\\)|)",R=new RegExp("^"+M+"+|((?:^|[^\\\\])(?:\\\\.)*)"+M+"+$","g"),S=new RegExp("^"+M+"*,"+M+"*"),T=new RegExp("^"+M+"*([>+~]|"+M+")"+M+"*"),U=new RegExp("="+M+"*([^\\]'\"]*?)"+M+"*\\]","g"),V=new RegExp(Q),W=new RegExp("^"+O+"$"),X={ID:new RegExp("^#("+N+")"),CLASS:new RegExp("^\\.("+N+")"),TAG:new RegExp("^("+N.replace("w","w*")+")"),ATTR:new RegExp("^"+P),PSEUDO:new RegExp("^"+Q),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+L+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/^(?:input|select|textarea|button)$/i,Z=/^h\d$/i,$=/^[^{]+\{\s*\[native \w/,_=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ab=/[+~]/,bb=/'|\\/g,cb=new RegExp("\\\\([\\da-f]{1,6}"+M+"?|("+M+")|.)","ig"),db=function(a,b,c){var d="0x"+b-65536;return d!==d||c?b:0>d?String.fromCharCode(d+65536):String.fromCharCode(d>>10|55296,1023&d|56320)};try{I.apply(F=J.call(v.childNodes),v.childNodes),F[v.childNodes.length].nodeType}catch(eb){I={apply:F.length?function(a,b){H.apply(a,J.call(b))}:function(a,b){var c=a.length,d=0;while(a[c++]=b[d++]);a.length=c-1}}}function fb(a,b,d,e){var f,h,j,k,l,o,r,s,w,x;if((b?b.ownerDocument||b:v)!==n&&m(b),b=b||n,d=d||[],!a||"string"!=typeof a)return d;if(1!==(k=b.nodeType)&&9!==k)return[];if(p&&!e){if(f=_.exec(a))if(j=f[1]){if(9===k){if(h=b.getElementById(j),!h||!h.parentNode)return d;if(h.id===j)return d.push(h),d}else if(b.ownerDocument&&(h=b.ownerDocument.getElementById(j))&&t(b,h)&&h.id===j)return d.push(h),d}else{if(f[2])return I.apply(d,b.getElementsByTagName(a)),d;if((j=f[3])&&c.getElementsByClassName&&b.getElementsByClassName)return I.apply(d,b.getElementsByClassName(j)),d}if(c.qsa&&(!q||!q.test(a))){if(s=r=u,w=b,x=9===k&&a,1===k&&"object"!==b.nodeName.toLowerCase()){o=g(a),(r=b.getAttribute("id"))?s=r.replace(bb,"\\$&"):b.setAttribute("id",s),s="[id='"+s+"'] ",l=o.length;while(l--)o[l]=s+qb(o[l]);w=ab.test(a)&&ob(b.parentNode)||b,x=o.join(",")}if(x)try{return I.apply(d,w.querySelectorAll(x)),d}catch(y){}finally{r||b.removeAttribute("id")}}}return i(a.replace(R,"$1"),b,d,e)}function gb(){var a=[];function b(c,e){return a.push(c+" ")>d.cacheLength&&delete b[a.shift()],b[c+" "]=e}return b}function hb(a){return a[u]=!0,a}function ib(a){var b=n.createElement("div");try{return!!a(b)}catch(c){return!1}finally{b.parentNode&&b.parentNode.removeChild(b),b=null}}function jb(a,b){var c=a.split("|"),e=a.length;while(e--)d.attrHandle[c[e]]=b}function kb(a,b){var c=b&&a,d=c&&1===a.nodeType&&1===b.nodeType&&(~b.sourceIndex||D)-(~a.sourceIndex||D);if(d)return d;if(c)while(c=c.nextSibling)if(c===b)return-1;return a?1:-1}function lb(a){return function(b){var c=b.nodeName.toLowerCase();return"input"===c&&b.type===a}}function mb(a){return function(b){var c=b.nodeName.toLowerCase();return("input"===c||"button"===c)&&b.type===a}}function nb(a){return hb(function(b){return b=+b,hb(function(c,d){var e,f=a([],c.length,b),g=f.length;while(g--)c[e=f[g]]&&(c[e]=!(d[e]=c[e]))})})}function ob(a){return a&&typeof a.getElementsByTagName!==C&&a}c=fb.support={},f=fb.isXML=function(a){var b=a&&(a.ownerDocument||a).documentElement;return b?"HTML"!==b.nodeName:!1},m=fb.setDocument=function(a){var b,e=a?a.ownerDocument||a:v,g=e.defaultView;return e!==n&&9===e.nodeType&&e.documentElement?(n=e,o=e.documentElement,p=!f(e),g&&g!==g.top&&(g.addEventListener?g.addEventListener("unload",function(){m()},!1):g.attachEvent&&g.attachEvent("onunload",function(){m()})),c.attributes=ib(function(a){return a.className="i",!a.getAttribute("className")}),c.getElementsByTagName=ib(function(a){return a.appendChild(e.createComment("")),!a.getElementsByTagName("*").length}),c.getElementsByClassName=$.test(e.getElementsByClassName)&&ib(function(a){return a.innerHTML="
",a.firstChild.className="i",2===a.getElementsByClassName("i").length}),c.getById=ib(function(a){return o.appendChild(a).id=u,!e.getElementsByName||!e.getElementsByName(u).length}),c.getById?(d.find.ID=function(a,b){if(typeof b.getElementById!==C&&p){var c=b.getElementById(a);return c&&c.parentNode?[c]:[]}},d.filter.ID=function(a){var b=a.replace(cb,db);return function(a){return a.getAttribute("id")===b}}):(delete d.find.ID,d.filter.ID=function(a){var b=a.replace(cb,db);return function(a){var c=typeof a.getAttributeNode!==C&&a.getAttributeNode("id");return c&&c.value===b}}),d.find.TAG=c.getElementsByTagName?function(a,b){return typeof b.getElementsByTagName!==C?b.getElementsByTagName(a):void 0}:function(a,b){var c,d=[],e=0,f=b.getElementsByTagName(a);if("*"===a){while(c=f[e++])1===c.nodeType&&d.push(c);return d}return f},d.find.CLASS=c.getElementsByClassName&&function(a,b){return typeof b.getElementsByClassName!==C&&p?b.getElementsByClassName(a):void 0},r=[],q=[],(c.qsa=$.test(e.querySelectorAll))&&(ib(function(a){a.innerHTML="",a.querySelectorAll("[msallowclip^='']").length&&q.push("[*^$]="+M+"*(?:''|\"\")"),a.querySelectorAll("[selected]").length||q.push("\\["+M+"*(?:value|"+L+")"),a.querySelectorAll(":checked").length||q.push(":checked")}),ib(function(a){var b=e.createElement("input");b.setAttribute("type","hidden"),a.appendChild(b).setAttribute("name","D"),a.querySelectorAll("[name=d]").length&&q.push("name"+M+"*[*^$|!~]?="),a.querySelectorAll(":enabled").length||q.push(":enabled",":disabled"),a.querySelectorAll("*,:x"),q.push(",.*:")})),(c.matchesSelector=$.test(s=o.matches||o.webkitMatchesSelector||o.mozMatchesSelector||o.oMatchesSelector||o.msMatchesSelector))&&ib(function(a){c.disconnectedMatch=s.call(a,"div"),s.call(a,"[s!='']:x"),r.push("!=",Q)}),q=q.length&&new RegExp(q.join("|")),r=r.length&&new RegExp(r.join("|")),b=$.test(o.compareDocumentPosition),t=b||$.test(o.contains)?function(a,b){var c=9===a.nodeType?a.documentElement:a,d=b&&b.parentNode;return a===d||!(!d||1!==d.nodeType||!(c.contains?c.contains(d):a.compareDocumentPosition&&16&a.compareDocumentPosition(d)))}:function(a,b){if(b)while(b=b.parentNode)if(b===a)return!0;return!1},B=b?function(a,b){if(a===b)return l=!0,0;var d=!a.compareDocumentPosition-!b.compareDocumentPosition;return d?d:(d=(a.ownerDocument||a)===(b.ownerDocument||b)?a.compareDocumentPosition(b):1,1&d||!c.sortDetached&&b.compareDocumentPosition(a)===d?a===e||a.ownerDocument===v&&t(v,a)?-1:b===e||b.ownerDocument===v&&t(v,b)?1:k?K.call(k,a)-K.call(k,b):0:4&d?-1:1)}:function(a,b){if(a===b)return l=!0,0;var c,d=0,f=a.parentNode,g=b.parentNode,h=[a],i=[b];if(!f||!g)return a===e?-1:b===e?1:f?-1:g?1:k?K.call(k,a)-K.call(k,b):0;if(f===g)return kb(a,b);c=a;while(c=c.parentNode)h.unshift(c);c=b;while(c=c.parentNode)i.unshift(c);while(h[d]===i[d])d++;return d?kb(h[d],i[d]):h[d]===v?-1:i[d]===v?1:0},e):n},fb.matches=function(a,b){return fb(a,null,null,b)},fb.matchesSelector=function(a,b){if((a.ownerDocument||a)!==n&&m(a),b=b.replace(U,"='$1']"),!(!c.matchesSelector||!p||r&&r.test(b)||q&&q.test(b)))try{var d=s.call(a,b);if(d||c.disconnectedMatch||a.document&&11!==a.document.nodeType)return d}catch(e){}return fb(b,n,null,[a]).length>0},fb.contains=function(a,b){return(a.ownerDocument||a)!==n&&m(a),t(a,b)},fb.attr=function(a,b){(a.ownerDocument||a)!==n&&m(a);var e=d.attrHandle[b.toLowerCase()],f=e&&E.call(d.attrHandle,b.toLowerCase())?e(a,b,!p):void 0;return void 0!==f?f:c.attributes||!p?a.getAttribute(b):(f=a.getAttributeNode(b))&&f.specified?f.value:null},fb.error=function(a){throw new Error("Syntax error, unrecognized expression: "+a)},fb.uniqueSort=function(a){var b,d=[],e=0,f=0;if(l=!c.detectDuplicates,k=!c.sortStable&&a.slice(0),a.sort(B),l){while(b=a[f++])b===a[f]&&(e=d.push(f));while(e--)a.splice(d[e],1)}return k=null,a},e=fb.getText=function(a){var b,c="",d=0,f=a.nodeType;if(f){if(1===f||9===f||11===f){if("string"==typeof a.textContent)return a.textContent;for(a=a.firstChild;a;a=a.nextSibling)c+=e(a)}else if(3===f||4===f)return a.nodeValue}else while(b=a[d++])c+=e(b);return c},d=fb.selectors={cacheLength:50,createPseudo:hb,match:X,attrHandle:{},find:{},relative:{">":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(a){return a[1]=a[1].replace(cb,db),a[3]=(a[3]||a[4]||a[5]||"").replace(cb,db),"~="===a[2]&&(a[3]=" "+a[3]+" "),a.slice(0,4)},CHILD:function(a){return a[1]=a[1].toLowerCase(),"nth"===a[1].slice(0,3)?(a[3]||fb.error(a[0]),a[4]=+(a[4]?a[5]+(a[6]||1):2*("even"===a[3]||"odd"===a[3])),a[5]=+(a[7]+a[8]||"odd"===a[3])):a[3]&&fb.error(a[0]),a},PSEUDO:function(a){var b,c=!a[6]&&a[2];return X.CHILD.test(a[0])?null:(a[3]?a[2]=a[4]||a[5]||"":c&&V.test(c)&&(b=g(c,!0))&&(b=c.indexOf(")",c.length-b)-c.length)&&(a[0]=a[0].slice(0,b),a[2]=c.slice(0,b)),a.slice(0,3))}},filter:{TAG:function(a){var b=a.replace(cb,db).toLowerCase();return"*"===a?function(){return!0}:function(a){return a.nodeName&&a.nodeName.toLowerCase()===b}},CLASS:function(a){var b=y[a+" "];return b||(b=new RegExp("(^|"+M+")"+a+"("+M+"|$)"))&&y(a,function(a){return b.test("string"==typeof a.className&&a.className||typeof a.getAttribute!==C&&a.getAttribute("class")||"")})},ATTR:function(a,b,c){return function(d){var e=fb.attr(d,a);return null==e?"!="===b:b?(e+="","="===b?e===c:"!="===b?e!==c:"^="===b?c&&0===e.indexOf(c):"*="===b?c&&e.indexOf(c)>-1:"$="===b?c&&e.slice(-c.length)===c:"~="===b?(" "+e+" ").indexOf(c)>-1:"|="===b?e===c||e.slice(0,c.length+1)===c+"-":!1):!0}},CHILD:function(a,b,c,d,e){var f="nth"!==a.slice(0,3),g="last"!==a.slice(-4),h="of-type"===b;return 1===d&&0===e?function(a){return!!a.parentNode}:function(b,c,i){var j,k,l,m,n,o,p=f!==g?"nextSibling":"previousSibling",q=b.parentNode,r=h&&b.nodeName.toLowerCase(),s=!i&&!h;if(q){if(f){while(p){l=b;while(l=l[p])if(h?l.nodeName.toLowerCase()===r:1===l.nodeType)return!1;o=p="only"===a&&!o&&"nextSibling"}return!0}if(o=[g?q.firstChild:q.lastChild],g&&s){k=q[u]||(q[u]={}),j=k[a]||[],n=j[0]===w&&j[1],m=j[0]===w&&j[2],l=n&&q.childNodes[n];while(l=++n&&l&&l[p]||(m=n=0)||o.pop())if(1===l.nodeType&&++m&&l===b){k[a]=[w,n,m];break}}else if(s&&(j=(b[u]||(b[u]={}))[a])&&j[0]===w)m=j[1];else while(l=++n&&l&&l[p]||(m=n=0)||o.pop())if((h?l.nodeName.toLowerCase()===r:1===l.nodeType)&&++m&&(s&&((l[u]||(l[u]={}))[a]=[w,m]),l===b))break;return m-=e,m===d||m%d===0&&m/d>=0}}},PSEUDO:function(a,b){var c,e=d.pseudos[a]||d.setFilters[a.toLowerCase()]||fb.error("unsupported pseudo: "+a);return e[u]?e(b):e.length>1?(c=[a,a,"",b],d.setFilters.hasOwnProperty(a.toLowerCase())?hb(function(a,c){var d,f=e(a,b),g=f.length;while(g--)d=K.call(a,f[g]),a[d]=!(c[d]=f[g])}):function(a){return e(a,0,c)}):e}},pseudos:{not:hb(function(a){var b=[],c=[],d=h(a.replace(R,"$1"));return d[u]?hb(function(a,b,c,e){var f,g=d(a,null,e,[]),h=a.length;while(h--)(f=g[h])&&(a[h]=!(b[h]=f))}):function(a,e,f){return b[0]=a,d(b,null,f,c),!c.pop()}}),has:hb(function(a){return function(b){return fb(a,b).length>0}}),contains:hb(function(a){return function(b){return(b.textContent||b.innerText||e(b)).indexOf(a)>-1}}),lang:hb(function(a){return W.test(a||"")||fb.error("unsupported lang: "+a),a=a.replace(cb,db).toLowerCase(),function(b){var c;do if(c=p?b.lang:b.getAttribute("xml:lang")||b.getAttribute("lang"))return c=c.toLowerCase(),c===a||0===c.indexOf(a+"-");while((b=b.parentNode)&&1===b.nodeType);return!1}}),target:function(b){var c=a.location&&a.location.hash;return c&&c.slice(1)===b.id},root:function(a){return a===o},focus:function(a){return a===n.activeElement&&(!n.hasFocus||n.hasFocus())&&!!(a.type||a.href||~a.tabIndex)},enabled:function(a){return a.disabled===!1},disabled:function(a){return a.disabled===!0},checked:function(a){var b=a.nodeName.toLowerCase();return"input"===b&&!!a.checked||"option"===b&&!!a.selected},selected:function(a){return a.parentNode&&a.parentNode.selectedIndex,a.selected===!0},empty:function(a){for(a=a.firstChild;a;a=a.nextSibling)if(a.nodeType<6)return!1;return!0},parent:function(a){return!d.pseudos.empty(a)},header:function(a){return Z.test(a.nodeName)},input:function(a){return Y.test(a.nodeName)},button:function(a){var b=a.nodeName.toLowerCase();return"input"===b&&"button"===a.type||"button"===b},text:function(a){var b;return"input"===a.nodeName.toLowerCase()&&"text"===a.type&&(null==(b=a.getAttribute("type"))||"text"===b.toLowerCase())},first:nb(function(){return[0]}),last:nb(function(a,b){return[b-1]}),eq:nb(function(a,b,c){return[0>c?c+b:c]}),even:nb(function(a,b){for(var c=0;b>c;c+=2)a.push(c);return a}),odd:nb(function(a,b){for(var c=1;b>c;c+=2)a.push(c);return a}),lt:nb(function(a,b,c){for(var d=0>c?c+b:c;--d>=0;)a.push(d);return a}),gt:nb(function(a,b,c){for(var d=0>c?c+b:c;++db;b++)d+=a[b].value;return d}function rb(a,b,c){var d=b.dir,e=c&&"parentNode"===d,f=x++;return b.first?function(b,c,f){while(b=b[d])if(1===b.nodeType||e)return a(b,c,f)}:function(b,c,g){var h,i,j=[w,f];if(g){while(b=b[d])if((1===b.nodeType||e)&&a(b,c,g))return!0}else while(b=b[d])if(1===b.nodeType||e){if(i=b[u]||(b[u]={}),(h=i[d])&&h[0]===w&&h[1]===f)return j[2]=h[2];if(i[d]=j,j[2]=a(b,c,g))return!0}}}function sb(a){return a.length>1?function(b,c,d){var e=a.length;while(e--)if(!a[e](b,c,d))return!1;return!0}:a[0]}function tb(a,b,c){for(var d=0,e=b.length;e>d;d++)fb(a,b[d],c);return c}function ub(a,b,c,d,e){for(var f,g=[],h=0,i=a.length,j=null!=b;i>h;h++)(f=a[h])&&(!c||c(f,d,e))&&(g.push(f),j&&b.push(h));return g}function vb(a,b,c,d,e,f){return d&&!d[u]&&(d=vb(d)),e&&!e[u]&&(e=vb(e,f)),hb(function(f,g,h,i){var j,k,l,m=[],n=[],o=g.length,p=f||tb(b||"*",h.nodeType?[h]:h,[]),q=!a||!f&&b?p:ub(p,m,a,h,i),r=c?e||(f?a:o||d)?[]:g:q;if(c&&c(q,r,h,i),d){j=ub(r,n),d(j,[],h,i),k=j.length;while(k--)(l=j[k])&&(r[n[k]]=!(q[n[k]]=l))}if(f){if(e||a){if(e){j=[],k=r.length;while(k--)(l=r[k])&&j.push(q[k]=l);e(null,r=[],j,i)}k=r.length;while(k--)(l=r[k])&&(j=e?K.call(f,l):m[k])>-1&&(f[j]=!(g[j]=l))}}else r=ub(r===g?r.splice(o,r.length):r),e?e(null,g,r,i):I.apply(g,r)})}function wb(a){for(var b,c,e,f=a.length,g=d.relative[a[0].type],h=g||d.relative[" "],i=g?1:0,k=rb(function(a){return a===b},h,!0),l=rb(function(a){return K.call(b,a)>-1},h,!0),m=[function(a,c,d){return!g&&(d||c!==j)||((b=c).nodeType?k(a,c,d):l(a,c,d))}];f>i;i++)if(c=d.relative[a[i].type])m=[rb(sb(m),c)];else{if(c=d.filter[a[i].type].apply(null,a[i].matches),c[u]){for(e=++i;f>e;e++)if(d.relative[a[e].type])break;return vb(i>1&&sb(m),i>1&&qb(a.slice(0,i-1).concat({value:" "===a[i-2].type?"*":""})).replace(R,"$1"),c,e>i&&wb(a.slice(i,e)),f>e&&wb(a=a.slice(e)),f>e&&qb(a))}m.push(c)}return sb(m)}function xb(a,b){var c=b.length>0,e=a.length>0,f=function(f,g,h,i,k){var l,m,o,p=0,q="0",r=f&&[],s=[],t=j,u=f||e&&d.find.TAG("*",k),v=w+=null==t?1:Math.random()||.1,x=u.length;for(k&&(j=g!==n&&g);q!==x&&null!=(l=u[q]);q++){if(e&&l){m=0;while(o=a[m++])if(o(l,g,h)){i.push(l);break}k&&(w=v)}c&&((l=!o&&l)&&p--,f&&r.push(l))}if(p+=q,c&&q!==p){m=0;while(o=b[m++])o(r,s,g,h);if(f){if(p>0)while(q--)r[q]||s[q]||(s[q]=G.call(i));s=ub(s)}I.apply(i,s),k&&!f&&s.length>0&&p+b.length>1&&fb.uniqueSort(i)}return k&&(w=v,j=t),r};return c?hb(f):f}return h=fb.compile=function(a,b){var c,d=[],e=[],f=A[a+" "];if(!f){b||(b=g(a)),c=b.length;while(c--)f=wb(b[c]),f[u]?d.push(f):e.push(f);f=A(a,xb(e,d)),f.selector=a}return f},i=fb.select=function(a,b,e,f){var i,j,k,l,m,n="function"==typeof a&&a,o=!f&&g(a=n.selector||a);if(e=e||[],1===o.length){if(j=o[0]=o[0].slice(0),j.length>2&&"ID"===(k=j[0]).type&&c.getById&&9===b.nodeType&&p&&d.relative[j[1].type]){if(b=(d.find.ID(k.matches[0].replace(cb,db),b)||[])[0],!b)return e;n&&(b=b.parentNode),a=a.slice(j.shift().value.length)}i=X.needsContext.test(a)?0:j.length;while(i--){if(k=j[i],d.relative[l=k.type])break;if((m=d.find[l])&&(f=m(k.matches[0].replace(cb,db),ab.test(j[0].type)&&ob(b.parentNode)||b))){if(j.splice(i,1),a=f.length&&qb(j),!a)return I.apply(e,f),e;break}}}return(n||h(a,o))(f,b,!p,e,ab.test(a)&&ob(b.parentNode)||b),e},c.sortStable=u.split("").sort(B).join("")===u,c.detectDuplicates=!!l,m(),c.sortDetached=ib(function(a){return 1&a.compareDocumentPosition(n.createElement("div"))}),ib(function(a){return a.innerHTML="","#"===a.firstChild.getAttribute("href")})||jb("type|href|height|width",function(a,b,c){return c?void 0:a.getAttribute(b,"type"===b.toLowerCase()?1:2)}),c.attributes&&ib(function(a){return a.innerHTML="",a.firstChild.setAttribute("value",""),""===a.firstChild.getAttribute("value")})||jb("value",function(a,b,c){return c||"input"!==a.nodeName.toLowerCase()?void 0:a.defaultValue}),ib(function(a){return null==a.getAttribute("disabled")})||jb(L,function(a,b,c){var d;return c?void 0:a[b]===!0?b.toLowerCase():(d=a.getAttributeNode(b))&&d.specified?d.value:null}),fb}(a);m.find=s,m.expr=s.selectors,m.expr[":"]=m.expr.pseudos,m.unique=s.uniqueSort,m.text=s.getText,m.isXMLDoc=s.isXML,m.contains=s.contains;var t=m.expr.match.needsContext,u=/^<(\w+)\s*\/?>(?:<\/\1>|)$/,v=/^.[^:#\[\.,]*$/;function w(a,b,c){if(m.isFunction(b))return m.grep(a,function(a,d){return!!b.call(a,d,a)!==c});if(b.nodeType)return m.grep(a,function(a){return a===b!==c});if("string"==typeof b){if(v.test(b))return m.filter(b,a,c);b=m.filter(b,a)}return m.grep(a,function(a){return m.inArray(a,b)>=0!==c})}m.filter=function(a,b,c){var d=b[0];return c&&(a=":not("+a+")"),1===b.length&&1===d.nodeType?m.find.matchesSelector(d,a)?[d]:[]:m.find.matches(a,m.grep(b,function(a){return 1===a.nodeType}))},m.fn.extend({find:function(a){var b,c=[],d=this,e=d.length;if("string"!=typeof a)return this.pushStack(m(a).filter(function(){for(b=0;e>b;b++)if(m.contains(d[b],this))return!0}));for(b=0;e>b;b++)m.find(a,d[b],c);return c=this.pushStack(e>1?m.unique(c):c),c.selector=this.selector?this.selector+" "+a:a,c},filter:function(a){return this.pushStack(w(this,a||[],!1))},not:function(a){return this.pushStack(w(this,a||[],!0))},is:function(a){return!!w(this,"string"==typeof a&&t.test(a)?m(a):a||[],!1).length}});var x,y=a.document,z=/^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]*))$/,A=m.fn.init=function(a,b){var c,d;if(!a)return this;if("string"==typeof a){if(c="<"===a.charAt(0)&&">"===a.charAt(a.length-1)&&a.length>=3?[null,a,null]:z.exec(a),!c||!c[1]&&b)return!b||b.jquery?(b||x).find(a):this.constructor(b).find(a);if(c[1]){if(b=b instanceof m?b[0]:b,m.merge(this,m.parseHTML(c[1],b&&b.nodeType?b.ownerDocument||b:y,!0)),u.test(c[1])&&m.isPlainObject(b))for(c in b)m.isFunction(this[c])?this[c](b[c]):this.attr(c,b[c]);return this}if(d=y.getElementById(c[2]),d&&d.parentNode){if(d.id!==c[2])return x.find(a);this.length=1,this[0]=d}return this.context=y,this.selector=a,this}return a.nodeType?(this.context=this[0]=a,this.length=1,this):m.isFunction(a)?"undefined"!=typeof x.ready?x.ready(a):a(m):(void 0!==a.selector&&(this.selector=a.selector,this.context=a.context),m.makeArray(a,this))};A.prototype=m.fn,x=m(y);var B=/^(?:parents|prev(?:Until|All))/,C={children:!0,contents:!0,next:!0,prev:!0};m.extend({dir:function(a,b,c){var d=[],e=a[b];while(e&&9!==e.nodeType&&(void 0===c||1!==e.nodeType||!m(e).is(c)))1===e.nodeType&&d.push(e),e=e[b];return d},sibling:function(a,b){for(var c=[];a;a=a.nextSibling)1===a.nodeType&&a!==b&&c.push(a);return c}}),m.fn.extend({has:function(a){var b,c=m(a,this),d=c.length;return this.filter(function(){for(b=0;d>b;b++)if(m.contains(this,c[b]))return!0})},closest:function(a,b){for(var c,d=0,e=this.length,f=[],g=t.test(a)||"string"!=typeof a?m(a,b||this.context):0;e>d;d++)for(c=this[d];c&&c!==b;c=c.parentNode)if(c.nodeType<11&&(g?g.index(c)>-1:1===c.nodeType&&m.find.matchesSelector(c,a))){f.push(c);break}return this.pushStack(f.length>1?m.unique(f):f)},index:function(a){return a?"string"==typeof a?m.inArray(this[0],m(a)):m.inArray(a.jquery?a[0]:a,this):this[0]&&this[0].parentNode?this.first().prevAll().length:-1},add:function(a,b){return this.pushStack(m.unique(m.merge(this.get(),m(a,b))))},addBack:function(a){return this.add(null==a?this.prevObject:this.prevObject.filter(a))}});function D(a,b){do a=a[b];while(a&&1!==a.nodeType);return a}m.each({parent:function(a){var b=a.parentNode;return b&&11!==b.nodeType?b:null},parents:function(a){return m.dir(a,"parentNode")},parentsUntil:function(a,b,c){return m.dir(a,"parentNode",c)},next:function(a){return D(a,"nextSibling")},prev:function(a){return D(a,"previousSibling")},nextAll:function(a){return m.dir(a,"nextSibling")},prevAll:function(a){return m.dir(a,"previousSibling")},nextUntil:function(a,b,c){return m.dir(a,"nextSibling",c)},prevUntil:function(a,b,c){return m.dir(a,"previousSibling",c)},siblings:function(a){return m.sibling((a.parentNode||{}).firstChild,a)},children:function(a){return m.sibling(a.firstChild)},contents:function(a){return m.nodeName(a,"iframe")?a.contentDocument||a.contentWindow.document:m.merge([],a.childNodes)}},function(a,b){m.fn[a]=function(c,d){var e=m.map(this,b,c);return"Until"!==a.slice(-5)&&(d=c),d&&"string"==typeof d&&(e=m.filter(d,e)),this.length>1&&(C[a]||(e=m.unique(e)),B.test(a)&&(e=e.reverse())),this.pushStack(e)}});var E=/\S+/g,F={};function G(a){var b=F[a]={};return m.each(a.match(E)||[],function(a,c){b[c]=!0}),b}m.Callbacks=function(a){a="string"==typeof a?F[a]||G(a):m.extend({},a);var b,c,d,e,f,g,h=[],i=!a.once&&[],j=function(l){for(c=a.memory&&l,d=!0,f=g||0,g=0,e=h.length,b=!0;h&&e>f;f++)if(h[f].apply(l[0],l[1])===!1&&a.stopOnFalse){c=!1;break}b=!1,h&&(i?i.length&&j(i.shift()):c?h=[]:k.disable())},k={add:function(){if(h){var d=h.length;!function f(b){m.each(b,function(b,c){var d=m.type(c);"function"===d?a.unique&&k.has(c)||h.push(c):c&&c.length&&"string"!==d&&f(c)})}(arguments),b?e=h.length:c&&(g=d,j(c))}return this},remove:function(){return h&&m.each(arguments,function(a,c){var d;while((d=m.inArray(c,h,d))>-1)h.splice(d,1),b&&(e>=d&&e--,f>=d&&f--)}),this},has:function(a){return a?m.inArray(a,h)>-1:!(!h||!h.length)},empty:function(){return h=[],e=0,this},disable:function(){return h=i=c=void 0,this},disabled:function(){return!h},lock:function(){return i=void 0,c||k.disable(),this},locked:function(){return!i},fireWith:function(a,c){return!h||d&&!i||(c=c||[],c=[a,c.slice?c.slice():c],b?i.push(c):j(c)),this},fire:function(){return k.fireWith(this,arguments),this},fired:function(){return!!d}};return k},m.extend({Deferred:function(a){var b=[["resolve","done",m.Callbacks("once memory"),"resolved"],["reject","fail",m.Callbacks("once memory"),"rejected"],["notify","progress",m.Callbacks("memory")]],c="pending",d={state:function(){return c},always:function(){return e.done(arguments).fail(arguments),this},then:function(){var a=arguments;return m.Deferred(function(c){m.each(b,function(b,f){var g=m.isFunction(a[b])&&a[b];e[f[1]](function(){var a=g&&g.apply(this,arguments);a&&m.isFunction(a.promise)?a.promise().done(c.resolve).fail(c.reject).progress(c.notify):c[f[0]+"With"](this===d?c.promise():this,g?[a]:arguments)})}),a=null}).promise()},promise:function(a){return null!=a?m.extend(a,d):d}},e={};return d.pipe=d.then,m.each(b,function(a,f){var g=f[2],h=f[3];d[f[1]]=g.add,h&&g.add(function(){c=h},b[1^a][2].disable,b[2][2].lock),e[f[0]]=function(){return e[f[0]+"With"](this===e?d:this,arguments),this},e[f[0]+"With"]=g.fireWith}),d.promise(e),a&&a.call(e,e),e},when:function(a){var b=0,c=d.call(arguments),e=c.length,f=1!==e||a&&m.isFunction(a.promise)?e:0,g=1===f?a:m.Deferred(),h=function(a,b,c){return function(e){b[a]=this,c[a]=arguments.length>1?d.call(arguments):e,c===i?g.notifyWith(b,c):--f||g.resolveWith(b,c)}},i,j,k;if(e>1)for(i=new Array(e),j=new Array(e),k=new Array(e);e>b;b++)c[b]&&m.isFunction(c[b].promise)?c[b].promise().done(h(b,k,c)).fail(g.reject).progress(h(b,j,i)):--f;return f||g.resolveWith(k,c),g.promise()}});var H;m.fn.ready=function(a){return m.ready.promise().done(a),this},m.extend({isReady:!1,readyWait:1,holdReady:function(a){a?m.readyWait++:m.ready(!0)},ready:function(a){if(a===!0?!--m.readyWait:!m.isReady){if(!y.body)return setTimeout(m.ready);m.isReady=!0,a!==!0&&--m.readyWait>0||(H.resolveWith(y,[m]),m.fn.triggerHandler&&(m(y).triggerHandler("ready"),m(y).off("ready")))}}});function I(){y.addEventListener?(y.removeEventListener("DOMContentLoaded",J,!1),a.removeEventListener("load",J,!1)):(y.detachEvent("onreadystatechange",J),a.detachEvent("onload",J))}function J(){(y.addEventListener||"load"===event.type||"complete"===y.readyState)&&(I(),m.ready())}m.ready.promise=function(b){if(!H)if(H=m.Deferred(),"complete"===y.readyState)setTimeout(m.ready);else if(y.addEventListener)y.addEventListener("DOMContentLoaded",J,!1),a.addEventListener("load",J,!1);else{y.attachEvent("onreadystatechange",J),a.attachEvent("onload",J);var c=!1;try{c=null==a.frameElement&&y.documentElement}catch(d){}c&&c.doScroll&&!function e(){if(!m.isReady){try{c.doScroll("left")}catch(a){return setTimeout(e,50)}I(),m.ready()}}()}return H.promise(b)};var K="undefined",L;for(L in m(k))break;k.ownLast="0"!==L,k.inlineBlockNeedsLayout=!1,m(function(){var a,b,c,d;c=y.getElementsByTagName("body")[0],c&&c.style&&(b=y.createElement("div"),d=y.createElement("div"),d.style.cssText="position:absolute;border:0;width:0;height:0;top:0;left:-9999px",c.appendChild(d).appendChild(b),typeof b.style.zoom!==K&&(b.style.cssText="display:inline;margin:0;border:0;padding:1px;width:1px;zoom:1",k.inlineBlockNeedsLayout=a=3===b.offsetWidth,a&&(c.style.zoom=1)),c.removeChild(d))}),function(){var a=y.createElement("div");if(null==k.deleteExpando){k.deleteExpando=!0;try{delete a.test}catch(b){k.deleteExpando=!1}}a=null}(),m.acceptData=function(a){var b=m.noData[(a.nodeName+" ").toLowerCase()],c=+a.nodeType||1;return 1!==c&&9!==c?!1:!b||b!==!0&&a.getAttribute("classid")===b};var M=/^(?:\{[\w\W]*\}|\[[\w\W]*\])$/,N=/([A-Z])/g;function O(a,b,c){if(void 0===c&&1===a.nodeType){var d="data-"+b.replace(N,"-$1").toLowerCase();if(c=a.getAttribute(d),"string"==typeof c){try{c="true"===c?!0:"false"===c?!1:"null"===c?null:+c+""===c?+c:M.test(c)?m.parseJSON(c):c}catch(e){}m.data(a,b,c)}else c=void 0}return c}function P(a){var b;for(b in a)if(("data"!==b||!m.isEmptyObject(a[b]))&&"toJSON"!==b)return!1;return!0}function Q(a,b,d,e){if(m.acceptData(a)){var f,g,h=m.expando,i=a.nodeType,j=i?m.cache:a,k=i?a[h]:a[h]&&h; +if(k&&j[k]&&(e||j[k].data)||void 0!==d||"string"!=typeof b)return k||(k=i?a[h]=c.pop()||m.guid++:h),j[k]||(j[k]=i?{}:{toJSON:m.noop}),("object"==typeof b||"function"==typeof b)&&(e?j[k]=m.extend(j[k],b):j[k].data=m.extend(j[k].data,b)),g=j[k],e||(g.data||(g.data={}),g=g.data),void 0!==d&&(g[m.camelCase(b)]=d),"string"==typeof b?(f=g[b],null==f&&(f=g[m.camelCase(b)])):f=g,f}}function R(a,b,c){if(m.acceptData(a)){var d,e,f=a.nodeType,g=f?m.cache:a,h=f?a[m.expando]:m.expando;if(g[h]){if(b&&(d=c?g[h]:g[h].data)){m.isArray(b)?b=b.concat(m.map(b,m.camelCase)):b in d?b=[b]:(b=m.camelCase(b),b=b in d?[b]:b.split(" ")),e=b.length;while(e--)delete d[b[e]];if(c?!P(d):!m.isEmptyObject(d))return}(c||(delete g[h].data,P(g[h])))&&(f?m.cleanData([a],!0):k.deleteExpando||g!=g.window?delete g[h]:g[h]=null)}}}m.extend({cache:{},noData:{"applet ":!0,"embed ":!0,"object ":"clsid:D27CDB6E-AE6D-11cf-96B8-444553540000"},hasData:function(a){return a=a.nodeType?m.cache[a[m.expando]]:a[m.expando],!!a&&!P(a)},data:function(a,b,c){return Q(a,b,c)},removeData:function(a,b){return R(a,b)},_data:function(a,b,c){return Q(a,b,c,!0)},_removeData:function(a,b){return R(a,b,!0)}}),m.fn.extend({data:function(a,b){var c,d,e,f=this[0],g=f&&f.attributes;if(void 0===a){if(this.length&&(e=m.data(f),1===f.nodeType&&!m._data(f,"parsedAttrs"))){c=g.length;while(c--)g[c]&&(d=g[c].name,0===d.indexOf("data-")&&(d=m.camelCase(d.slice(5)),O(f,d,e[d])));m._data(f,"parsedAttrs",!0)}return e}return"object"==typeof a?this.each(function(){m.data(this,a)}):arguments.length>1?this.each(function(){m.data(this,a,b)}):f?O(f,a,m.data(f,a)):void 0},removeData:function(a){return this.each(function(){m.removeData(this,a)})}}),m.extend({queue:function(a,b,c){var d;return a?(b=(b||"fx")+"queue",d=m._data(a,b),c&&(!d||m.isArray(c)?d=m._data(a,b,m.makeArray(c)):d.push(c)),d||[]):void 0},dequeue:function(a,b){b=b||"fx";var c=m.queue(a,b),d=c.length,e=c.shift(),f=m._queueHooks(a,b),g=function(){m.dequeue(a,b)};"inprogress"===e&&(e=c.shift(),d--),e&&("fx"===b&&c.unshift("inprogress"),delete f.stop,e.call(a,g,f)),!d&&f&&f.empty.fire()},_queueHooks:function(a,b){var c=b+"queueHooks";return m._data(a,c)||m._data(a,c,{empty:m.Callbacks("once memory").add(function(){m._removeData(a,b+"queue"),m._removeData(a,c)})})}}),m.fn.extend({queue:function(a,b){var c=2;return"string"!=typeof a&&(b=a,a="fx",c--),arguments.lengthh;h++)b(a[h],c,g?d:d.call(a[h],h,b(a[h],c)));return e?a:j?b.call(a):i?b(a[0],c):f},W=/^(?:checkbox|radio)$/i;!function(){var a=y.createElement("input"),b=y.createElement("div"),c=y.createDocumentFragment();if(b.innerHTML="
a",k.leadingWhitespace=3===b.firstChild.nodeType,k.tbody=!b.getElementsByTagName("tbody").length,k.htmlSerialize=!!b.getElementsByTagName("link").length,k.html5Clone="<:nav>"!==y.createElement("nav").cloneNode(!0).outerHTML,a.type="checkbox",a.checked=!0,c.appendChild(a),k.appendChecked=a.checked,b.innerHTML="",k.noCloneChecked=!!b.cloneNode(!0).lastChild.defaultValue,c.appendChild(b),b.innerHTML="",k.checkClone=b.cloneNode(!0).cloneNode(!0).lastChild.checked,k.noCloneEvent=!0,b.attachEvent&&(b.attachEvent("onclick",function(){k.noCloneEvent=!1}),b.cloneNode(!0).click()),null==k.deleteExpando){k.deleteExpando=!0;try{delete b.test}catch(d){k.deleteExpando=!1}}}(),function(){var b,c,d=y.createElement("div");for(b in{submit:!0,change:!0,focusin:!0})c="on"+b,(k[b+"Bubbles"]=c in a)||(d.setAttribute(c,"t"),k[b+"Bubbles"]=d.attributes[c].expando===!1);d=null}();var X=/^(?:input|select|textarea)$/i,Y=/^key/,Z=/^(?:mouse|pointer|contextmenu)|click/,$=/^(?:focusinfocus|focusoutblur)$/,_=/^([^.]*)(?:\.(.+)|)$/;function ab(){return!0}function bb(){return!1}function cb(){try{return y.activeElement}catch(a){}}m.event={global:{},add:function(a,b,c,d,e){var f,g,h,i,j,k,l,n,o,p,q,r=m._data(a);if(r){c.handler&&(i=c,c=i.handler,e=i.selector),c.guid||(c.guid=m.guid++),(g=r.events)||(g=r.events={}),(k=r.handle)||(k=r.handle=function(a){return typeof m===K||a&&m.event.triggered===a.type?void 0:m.event.dispatch.apply(k.elem,arguments)},k.elem=a),b=(b||"").match(E)||[""],h=b.length;while(h--)f=_.exec(b[h])||[],o=q=f[1],p=(f[2]||"").split(".").sort(),o&&(j=m.event.special[o]||{},o=(e?j.delegateType:j.bindType)||o,j=m.event.special[o]||{},l=m.extend({type:o,origType:q,data:d,handler:c,guid:c.guid,selector:e,needsContext:e&&m.expr.match.needsContext.test(e),namespace:p.join(".")},i),(n=g[o])||(n=g[o]=[],n.delegateCount=0,j.setup&&j.setup.call(a,d,p,k)!==!1||(a.addEventListener?a.addEventListener(o,k,!1):a.attachEvent&&a.attachEvent("on"+o,k))),j.add&&(j.add.call(a,l),l.handler.guid||(l.handler.guid=c.guid)),e?n.splice(n.delegateCount++,0,l):n.push(l),m.event.global[o]=!0);a=null}},remove:function(a,b,c,d,e){var f,g,h,i,j,k,l,n,o,p,q,r=m.hasData(a)&&m._data(a);if(r&&(k=r.events)){b=(b||"").match(E)||[""],j=b.length;while(j--)if(h=_.exec(b[j])||[],o=q=h[1],p=(h[2]||"").split(".").sort(),o){l=m.event.special[o]||{},o=(d?l.delegateType:l.bindType)||o,n=k[o]||[],h=h[2]&&new RegExp("(^|\\.)"+p.join("\\.(?:.*\\.|)")+"(\\.|$)"),i=f=n.length;while(f--)g=n[f],!e&&q!==g.origType||c&&c.guid!==g.guid||h&&!h.test(g.namespace)||d&&d!==g.selector&&("**"!==d||!g.selector)||(n.splice(f,1),g.selector&&n.delegateCount--,l.remove&&l.remove.call(a,g));i&&!n.length&&(l.teardown&&l.teardown.call(a,p,r.handle)!==!1||m.removeEvent(a,o,r.handle),delete k[o])}else for(o in k)m.event.remove(a,o+b[j],c,d,!0);m.isEmptyObject(k)&&(delete r.handle,m._removeData(a,"events"))}},trigger:function(b,c,d,e){var f,g,h,i,k,l,n,o=[d||y],p=j.call(b,"type")?b.type:b,q=j.call(b,"namespace")?b.namespace.split("."):[];if(h=l=d=d||y,3!==d.nodeType&&8!==d.nodeType&&!$.test(p+m.event.triggered)&&(p.indexOf(".")>=0&&(q=p.split("."),p=q.shift(),q.sort()),g=p.indexOf(":")<0&&"on"+p,b=b[m.expando]?b:new m.Event(p,"object"==typeof b&&b),b.isTrigger=e?2:3,b.namespace=q.join("."),b.namespace_re=b.namespace?new RegExp("(^|\\.)"+q.join("\\.(?:.*\\.|)")+"(\\.|$)"):null,b.result=void 0,b.target||(b.target=d),c=null==c?[b]:m.makeArray(c,[b]),k=m.event.special[p]||{},e||!k.trigger||k.trigger.apply(d,c)!==!1)){if(!e&&!k.noBubble&&!m.isWindow(d)){for(i=k.delegateType||p,$.test(i+p)||(h=h.parentNode);h;h=h.parentNode)o.push(h),l=h;l===(d.ownerDocument||y)&&o.push(l.defaultView||l.parentWindow||a)}n=0;while((h=o[n++])&&!b.isPropagationStopped())b.type=n>1?i:k.bindType||p,f=(m._data(h,"events")||{})[b.type]&&m._data(h,"handle"),f&&f.apply(h,c),f=g&&h[g],f&&f.apply&&m.acceptData(h)&&(b.result=f.apply(h,c),b.result===!1&&b.preventDefault());if(b.type=p,!e&&!b.isDefaultPrevented()&&(!k._default||k._default.apply(o.pop(),c)===!1)&&m.acceptData(d)&&g&&d[p]&&!m.isWindow(d)){l=d[g],l&&(d[g]=null),m.event.triggered=p;try{d[p]()}catch(r){}m.event.triggered=void 0,l&&(d[g]=l)}return b.result}},dispatch:function(a){a=m.event.fix(a);var b,c,e,f,g,h=[],i=d.call(arguments),j=(m._data(this,"events")||{})[a.type]||[],k=m.event.special[a.type]||{};if(i[0]=a,a.delegateTarget=this,!k.preDispatch||k.preDispatch.call(this,a)!==!1){h=m.event.handlers.call(this,a,j),b=0;while((f=h[b++])&&!a.isPropagationStopped()){a.currentTarget=f.elem,g=0;while((e=f.handlers[g++])&&!a.isImmediatePropagationStopped())(!a.namespace_re||a.namespace_re.test(e.namespace))&&(a.handleObj=e,a.data=e.data,c=((m.event.special[e.origType]||{}).handle||e.handler).apply(f.elem,i),void 0!==c&&(a.result=c)===!1&&(a.preventDefault(),a.stopPropagation()))}return k.postDispatch&&k.postDispatch.call(this,a),a.result}},handlers:function(a,b){var c,d,e,f,g=[],h=b.delegateCount,i=a.target;if(h&&i.nodeType&&(!a.button||"click"!==a.type))for(;i!=this;i=i.parentNode||this)if(1===i.nodeType&&(i.disabled!==!0||"click"!==a.type)){for(e=[],f=0;h>f;f++)d=b[f],c=d.selector+" ",void 0===e[c]&&(e[c]=d.needsContext?m(c,this).index(i)>=0:m.find(c,this,null,[i]).length),e[c]&&e.push(d);e.length&&g.push({elem:i,handlers:e})}return h]","i"),hb=/^\s+/,ib=/<(?!area|br|col|embed|hr|img|input|link|meta|param)(([\w:]+)[^>]*)\/>/gi,jb=/<([\w:]+)/,kb=/\s*$/g,rb={option:[1,""],legend:[1,"
","
"],area:[1,"",""],param:[1,"",""],thead:[1,"","
"],tr:[2,"","
"],col:[2,"","
"],td:[3,"","
"],_default:k.htmlSerialize?[0,"",""]:[1,"X
","
"]},sb=db(y),tb=sb.appendChild(y.createElement("div"));rb.optgroup=rb.option,rb.tbody=rb.tfoot=rb.colgroup=rb.caption=rb.thead,rb.th=rb.td;function ub(a,b){var c,d,e=0,f=typeof a.getElementsByTagName!==K?a.getElementsByTagName(b||"*"):typeof a.querySelectorAll!==K?a.querySelectorAll(b||"*"):void 0;if(!f)for(f=[],c=a.childNodes||a;null!=(d=c[e]);e++)!b||m.nodeName(d,b)?f.push(d):m.merge(f,ub(d,b));return void 0===b||b&&m.nodeName(a,b)?m.merge([a],f):f}function vb(a){W.test(a.type)&&(a.defaultChecked=a.checked)}function wb(a,b){return m.nodeName(a,"table")&&m.nodeName(11!==b.nodeType?b:b.firstChild,"tr")?a.getElementsByTagName("tbody")[0]||a.appendChild(a.ownerDocument.createElement("tbody")):a}function xb(a){return a.type=(null!==m.find.attr(a,"type"))+"/"+a.type,a}function yb(a){var b=pb.exec(a.type);return b?a.type=b[1]:a.removeAttribute("type"),a}function zb(a,b){for(var c,d=0;null!=(c=a[d]);d++)m._data(c,"globalEval",!b||m._data(b[d],"globalEval"))}function Ab(a,b){if(1===b.nodeType&&m.hasData(a)){var c,d,e,f=m._data(a),g=m._data(b,f),h=f.events;if(h){delete g.handle,g.events={};for(c in h)for(d=0,e=h[c].length;e>d;d++)m.event.add(b,c,h[c][d])}g.data&&(g.data=m.extend({},g.data))}}function Bb(a,b){var c,d,e;if(1===b.nodeType){if(c=b.nodeName.toLowerCase(),!k.noCloneEvent&&b[m.expando]){e=m._data(b);for(d in e.events)m.removeEvent(b,d,e.handle);b.removeAttribute(m.expando)}"script"===c&&b.text!==a.text?(xb(b).text=a.text,yb(b)):"object"===c?(b.parentNode&&(b.outerHTML=a.outerHTML),k.html5Clone&&a.innerHTML&&!m.trim(b.innerHTML)&&(b.innerHTML=a.innerHTML)):"input"===c&&W.test(a.type)?(b.defaultChecked=b.checked=a.checked,b.value!==a.value&&(b.value=a.value)):"option"===c?b.defaultSelected=b.selected=a.defaultSelected:("input"===c||"textarea"===c)&&(b.defaultValue=a.defaultValue)}}m.extend({clone:function(a,b,c){var d,e,f,g,h,i=m.contains(a.ownerDocument,a);if(k.html5Clone||m.isXMLDoc(a)||!gb.test("<"+a.nodeName+">")?f=a.cloneNode(!0):(tb.innerHTML=a.outerHTML,tb.removeChild(f=tb.firstChild)),!(k.noCloneEvent&&k.noCloneChecked||1!==a.nodeType&&11!==a.nodeType||m.isXMLDoc(a)))for(d=ub(f),h=ub(a),g=0;null!=(e=h[g]);++g)d[g]&&Bb(e,d[g]);if(b)if(c)for(h=h||ub(a),d=d||ub(f),g=0;null!=(e=h[g]);g++)Ab(e,d[g]);else Ab(a,f);return d=ub(f,"script"),d.length>0&&zb(d,!i&&ub(a,"script")),d=h=e=null,f},buildFragment:function(a,b,c,d){for(var e,f,g,h,i,j,l,n=a.length,o=db(b),p=[],q=0;n>q;q++)if(f=a[q],f||0===f)if("object"===m.type(f))m.merge(p,f.nodeType?[f]:f);else if(lb.test(f)){h=h||o.appendChild(b.createElement("div")),i=(jb.exec(f)||["",""])[1].toLowerCase(),l=rb[i]||rb._default,h.innerHTML=l[1]+f.replace(ib,"<$1>")+l[2],e=l[0];while(e--)h=h.lastChild;if(!k.leadingWhitespace&&hb.test(f)&&p.push(b.createTextNode(hb.exec(f)[0])),!k.tbody){f="table"!==i||kb.test(f)?""!==l[1]||kb.test(f)?0:h:h.firstChild,e=f&&f.childNodes.length;while(e--)m.nodeName(j=f.childNodes[e],"tbody")&&!j.childNodes.length&&f.removeChild(j)}m.merge(p,h.childNodes),h.textContent="";while(h.firstChild)h.removeChild(h.firstChild);h=o.lastChild}else p.push(b.createTextNode(f));h&&o.removeChild(h),k.appendChecked||m.grep(ub(p,"input"),vb),q=0;while(f=p[q++])if((!d||-1===m.inArray(f,d))&&(g=m.contains(f.ownerDocument,f),h=ub(o.appendChild(f),"script"),g&&zb(h),c)){e=0;while(f=h[e++])ob.test(f.type||"")&&c.push(f)}return h=null,o},cleanData:function(a,b){for(var d,e,f,g,h=0,i=m.expando,j=m.cache,l=k.deleteExpando,n=m.event.special;null!=(d=a[h]);h++)if((b||m.acceptData(d))&&(f=d[i],g=f&&j[f])){if(g.events)for(e in g.events)n[e]?m.event.remove(d,e):m.removeEvent(d,e,g.handle);j[f]&&(delete j[f],l?delete d[i]:typeof d.removeAttribute!==K?d.removeAttribute(i):d[i]=null,c.push(f))}}}),m.fn.extend({text:function(a){return V(this,function(a){return void 0===a?m.text(this):this.empty().append((this[0]&&this[0].ownerDocument||y).createTextNode(a))},null,a,arguments.length)},append:function(){return this.domManip(arguments,function(a){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var b=wb(this,a);b.appendChild(a)}})},prepend:function(){return this.domManip(arguments,function(a){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var b=wb(this,a);b.insertBefore(a,b.firstChild)}})},before:function(){return this.domManip(arguments,function(a){this.parentNode&&this.parentNode.insertBefore(a,this)})},after:function(){return this.domManip(arguments,function(a){this.parentNode&&this.parentNode.insertBefore(a,this.nextSibling)})},remove:function(a,b){for(var c,d=a?m.filter(a,this):this,e=0;null!=(c=d[e]);e++)b||1!==c.nodeType||m.cleanData(ub(c)),c.parentNode&&(b&&m.contains(c.ownerDocument,c)&&zb(ub(c,"script")),c.parentNode.removeChild(c));return this},empty:function(){for(var a,b=0;null!=(a=this[b]);b++){1===a.nodeType&&m.cleanData(ub(a,!1));while(a.firstChild)a.removeChild(a.firstChild);a.options&&m.nodeName(a,"select")&&(a.options.length=0)}return this},clone:function(a,b){return a=null==a?!1:a,b=null==b?a:b,this.map(function(){return m.clone(this,a,b)})},html:function(a){return V(this,function(a){var b=this[0]||{},c=0,d=this.length;if(void 0===a)return 1===b.nodeType?b.innerHTML.replace(fb,""):void 0;if(!("string"!=typeof a||mb.test(a)||!k.htmlSerialize&&gb.test(a)||!k.leadingWhitespace&&hb.test(a)||rb[(jb.exec(a)||["",""])[1].toLowerCase()])){a=a.replace(ib,"<$1>");try{for(;d>c;c++)b=this[c]||{},1===b.nodeType&&(m.cleanData(ub(b,!1)),b.innerHTML=a);b=0}catch(e){}}b&&this.empty().append(a)},null,a,arguments.length)},replaceWith:function(){var a=arguments[0];return this.domManip(arguments,function(b){a=this.parentNode,m.cleanData(ub(this)),a&&a.replaceChild(b,this)}),a&&(a.length||a.nodeType)?this:this.remove()},detach:function(a){return this.remove(a,!0)},domManip:function(a,b){a=e.apply([],a);var c,d,f,g,h,i,j=0,l=this.length,n=this,o=l-1,p=a[0],q=m.isFunction(p);if(q||l>1&&"string"==typeof p&&!k.checkClone&&nb.test(p))return this.each(function(c){var d=n.eq(c);q&&(a[0]=p.call(this,c,d.html())),d.domManip(a,b)});if(l&&(i=m.buildFragment(a,this[0].ownerDocument,!1,this),c=i.firstChild,1===i.childNodes.length&&(i=c),c)){for(g=m.map(ub(i,"script"),xb),f=g.length;l>j;j++)d=i,j!==o&&(d=m.clone(d,!0,!0),f&&m.merge(g,ub(d,"script"))),b.call(this[j],d,j);if(f)for(h=g[g.length-1].ownerDocument,m.map(g,yb),j=0;f>j;j++)d=g[j],ob.test(d.type||"")&&!m._data(d,"globalEval")&&m.contains(h,d)&&(d.src?m._evalUrl&&m._evalUrl(d.src):m.globalEval((d.text||d.textContent||d.innerHTML||"").replace(qb,"")));i=c=null}return this}}),m.each({appendTo:"append",prependTo:"prepend",insertBefore:"before",insertAfter:"after",replaceAll:"replaceWith"},function(a,b){m.fn[a]=function(a){for(var c,d=0,e=[],g=m(a),h=g.length-1;h>=d;d++)c=d===h?this:this.clone(!0),m(g[d])[b](c),f.apply(e,c.get());return this.pushStack(e)}});var Cb,Db={};function Eb(b,c){var d,e=m(c.createElement(b)).appendTo(c.body),f=a.getDefaultComputedStyle&&(d=a.getDefaultComputedStyle(e[0]))?d.display:m.css(e[0],"display");return e.detach(),f}function Fb(a){var b=y,c=Db[a];return c||(c=Eb(a,b),"none"!==c&&c||(Cb=(Cb||m("