Skip to main content

Invenio digital library framework.

Project description


image image image image


    pip install oarepo-actions


The library provides functionality for adding functions into your data models with supported REST methods, which are GET, POST, PUT and DELETE. It will create URL rule for your method, and use default or defined serializers, permissions and url path.

Decorate your method with @action() decorator and add optional parameters. You must have **kwargs as your function parameter.

List of optional parameters

  • for specifing url_path, which will be added after list-route or item-route from your configuration
  • by default allow all
  • accepts permission factory
  • for REST method
  • by default get
  • you can use get, put, delete or post written with lowercase letters
  • by default application/json serializer.
  • accepts dictionary where key is MIME type and value your own serializer
  • serializers takes arguments from function as *args.Therefore if you want to return array, you must wrap it with another array ( return [["a", "b", "c"]] )
  • by default True. Change to False if method is class method
  • determines which route will be used (list route if detail is False)


class SampleRecord(Record):

    def test_a(self, **kwargs):
        return {"title": self["title"]}

    @action(detail=False, url_path="send_email")
    def test_b(cls, **kwargs):
        return {"title": self["title"]}

    @action(detail=False, permissions=permission_factory)
    def test_c(cls, **kwargs):
        return {"title": self["title"]}

    @action(detail=False, url_path="test/<int:param>",  permissions=permission_factory)
    def test_d(cls, param = None, **kwargs):
        return Response(status=200)

    @action(detail=False, permissions = permission_factory, serializers = {'text/html': make_response})
    def test_e(cls, **kwargs):
        return '<h1>xx</h1>'

    @action(detail=False, url_path='test',permissions=allow_all, method='post')
    def test_f(cls, param=None, **kwargs):
        return {param: "yy"}
  • url_a = server/records/1/test_a
  • url_b = server/records/send_email
  • url_c = server/records/test_c
  • url_d = server/records/test/42
  • url_e = server/records/test_e
  • url_f = server/records/test
    • post method

Record class

If you put record_class parameter in your decorated function, it will be filled with record class obtained from


    @action(detail=False, url_path="jej")
    def test(cls,record_class, **kwargs):
        record_uuid = uuid.uuid4()
        data = {"title": "The title of the record", "contributors": [{"name": "something"}]}
        pid, data = record_minter(record_uuid, data)
        record = record_class.create(data=data, id_=record_uuid)
        indexer = RecordIndexer()
        res = indexer.index(record)
        return record


Version 1.0.0 (released 2020-09-15)

  • Initial public release.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

oarepo-actions-1.0.7.tar.gz (15.0 kB view hashes)

Uploaded Source

Built Distribution

oarepo_actions-1.0.7-py3-none-any.whl (8.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page