Flask Restful add resource parameters

Question

I am looking to pass an object instance as a parameter into a Flask-RESTfull Resource.

Here is my setup:

# in main.py
from flask import Flask
from flask.ext.restful import Api
from bar import Bar
from foo import views

app = Flask(__name__)
api = Api(app)

my_bar = Bar()

api.add_resource(views.ApiPage, "/api/my/end/point/")

Then in views.py I have the resource set up as follows:

# In views.py
from flask.ext.restful import Resource

class ApiPage(Resource):
    def get(self):
        serialized = str(my_bar)
        return serialized

So the issue that I am having is that I need to pass my instance of Bar() into the api resource. Is there any way to pass it in through the add_resource method like api.add_resource(views.ApiPage, "/api/my/end/point/", instance=bar)?

I don't believe that overriding ApiPage would work since add_resource takes a class reference, rather than a class instance. — Gunther
– Gunther, Commented Aug 2, 2014 at 21:13

José Fernández Ramos · Accepted Answer · 2015-11-16 17:09:32Z

51

Since version 0.3.3 (released May 22, 2015), add_resource() is able to pass parameters to your Resource constructor.

Following the original example, here is the views.py:

from flask.ext.restful import Resource

class ApiPage(Resource):
    def __init__(self, bar):
        self.bar = bar

    def get(self):
        serialized = str(my_bar)
        return serialized

And the relevant code for main.py:

# ...
my_bar = Bar()
api.add_resource(views.ApiPage, '/api/my/end/point/',
                 resource_class_kwargs={'bar': my_bar})

answered Nov 16, 2015 at 17:09

José Fernández Ramos

5,4203 gold badges33 silver badges28 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

ron · Accepted Answer · 2018-09-23 05:40:46Z

7

In version 0.3.5 documentation you can do it this way

# in main.py
...
my_bar = Bar()
api.add_resource(views.ApiPage, '/api/my/end/point/',
             resource_class_kwargs={'my_bar': my_bar})

pass your object in the add_resource method and use it in the resource init method

and in your class init

class ApiPage(Resource):
    def __init__(self, **kwargs):
       self.my_bar= kwargs['my_bar']

edited Sep 23, 2018 at 5:40

answered Sep 22, 2018 at 17:39

ron

83612 silver badges19 bronze badges

1 Comment

Frank Wang Over a year ago

you saved me, a green hand 4 python.

Leon · Accepted Answer · 2014-10-23 10:56:47Z

3

After struggling with the same problem I found you can use add_url_rule coupled with as_view

So in your case I guess the code would be something like

class ApiPage(Resource):
    def __init__(self, bar=None)
        self.__my_bar=bar

    def get(self):
        serialized = str(self.__my_bar)
        return serialized

my_bar = Bar()

app = Flask(__name__)
app.add_url_rule('/api/my/end/point/', bar=my_bar)

api = Api(app)

answered Oct 23, 2014 at 10:56

Leon

12.5k5 gold badges40 silver badges60 bronze badges

Comments

Ketouem · Accepted Answer · 2014-08-02 20:11:03Z

0

Given the documentation such thing can not be done at this level. One way to circumvent this issue would be to put the initialisation of Bar inside another module, then fetch the instance through an import in your views module.

answered Aug 2, 2014 at 20:11

Ketouem

3,8571 gold badge21 silver badges29 bronze badges

Collectives™ on Stack Overflow

Flask Restful add resource parameters

4 Answers 4

Comments

1 Comment

Comments

Comments

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

Comments

1 Comment

Comments

Comments

Linked

Related