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
|
#!/usr/bin/env python
# Copyright 2013 by Rackspace Hosting, Inc.
#
# Licensed under the Apache License, Version 2.0 (the 'License');
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an 'AS IS' BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Script that prints out the routes of an App instance."""
import argparse
import importlib
import os
import sys
import falcon
from falcon.inspect import inspect_app
from falcon.inspect import inspect_routes
from falcon.inspect import StringVisitor
sys.path.append(os.getcwd())
def make_parser():
"""Create the parser or the application."""
parser = argparse.ArgumentParser(
description='Example: falcon-inspect-app myprogram:app'
)
parser.add_argument(
'-r',
'--route_only',
action='store_true',
help='Prints only the information regarding the routes',
)
parser.add_argument(
'-v',
'--verbose',
action='store_true',
help='More verbose output',
)
parser.add_argument(
'-i',
'--internal',
action='store_true',
help='Print also internal falcon route methods and error handlers',
)
parser.add_argument(
'app_module',
help='The module and app to inspect. Example: myapp.somemodule:api',
)
return parser
def load_app(parser, args):
try:
module, instance = args.app_module.split(':', 1)
except ValueError:
parser.error(
'The app_module must include a colon between the module and instance'
)
try:
app = getattr(importlib.import_module(module), instance)
except AttributeError:
parser.error('{!r} not found in module {!r}'.format(instance, module))
if not isinstance(app, falcon.App):
if callable(app):
app = app()
if not isinstance(app, falcon.App):
parser.error(
'{} did not return a falcon.App instance'.format(args.app_module)
)
else:
parser.error(
'The instance must be of falcon.App or be '
'a callable without args that returns falcon.App'
)
return app
# TODO(vytas): Remove this placeholder altogether in Falcon 5.0.
def route_main():
sys.stderr.write(
'The "falcon-print-routes" command is no longer supported. \n\n'
'Please use "falcon-inspect-app" instead.\n\n'
)
sys.exit(2)
def main():
parser = make_parser()
args = parser.parse_args()
app = load_app(parser, args)
if args.route_only:
routes = inspect_routes(app)
visitor = StringVisitor(args.verbose, args.internal)
for route in routes:
print(visitor.process(route))
else:
print(inspect_app(app).to_string(args.verbose, args.internal))
if __name__ == '__main__': # pragma: no cover
main()
|
