Merge pull request #113 from jverswijver/update_dynamic_api

Update dynamic api generation to make it more performant

Author: guzman-raphael

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 Observes [Semantic Versioning](https://semver.org/spec/v2.0.0.html) standard and [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) convention.
 
+## [0.2.2] - 2021-11-10
+### Fixed
+- Optimize dynamic api virtual modules.
+
 ## [0.2.1] - 2021-11-08
 ### Fixed
 - Error with retrieving the module's installation root path.
@@ -80,6 +84,7 @@ Observes [Semantic Versioning](https://semver.org/spec/v2.0.0.html) standard and
 - Support for DataJoint attribute types: `varchar`, `int`, `float`, `datetime`, `date`, `time`, `decimal`, `uuid`.
 - Check dependency utility to determine child table references.
 
+[0.2.2]: https://github.com/datajoint/pharus/compare/0.2.1...0.2.2
 [0.2.1]: https://github.com/datajoint/pharus/compare/0.2.0...0.2.1
 [0.2.0]: https://github.com/datajoint/pharus/compare/0.1.0...0.2.0
 [0.1.0]: https://github.com/datajoint/pharus/compare/0.1.0b2...0.1.0

pharus/dynamic_api_gen.py

@@ -12,6 +12,7 @@ def populate_api():
 from flask import request
 from json import loads
 from base64 import b64decode
+import inspect
 """
     route_template = """
 
@@ -24,9 +25,9 @@ def {method_name}(jwt_payload: dict) -> dict:
     if request.method in {{'GET'}}:
         try:
             djconn = _DJConnector._set_datajoint_config(jwt_payload)
-            vm_dict = {{s: dj.VirtualModule(s, s, connection=djconn)
-                       for s in dj.list_schemas()}}
-            query, fetch_args = dj_query(vm_dict)
+            vm_list = [dj.VirtualModule(s, s, connection=djconn)
+                       for s in inspect.getfullargspec(dj_query).args]
+            query, fetch_args = dj_query(*vm_list)
             query = query & restriction()
             record_header, table_tuples, total_count = _DJConnector._fetch_records(
                 query=query,
@@ -49,9 +50,9 @@ def {method_name}_attributes(jwt_payload: dict) -> dict:
     if request.method in {{'GET'}}:
         try:
             djconn = _DJConnector._set_datajoint_config(jwt_payload)
-            vm_dict = {{s: dj.VirtualModule(s, s, connection=djconn)
-                       for s in dj.list_schemas()}}
-            query, fetch_args = dj_query(vm_dict)
+            vm_list = [dj.VirtualModule(s, s, connection=djconn)
+                       for s in inspect.getfullargspec(dj_query).args]
+            query, fetch_args = dj_query(*vm_list)
             attributes_meta = _DJConnector._get_attributes(query)
 
             return dict(attributeHeaders=attributes_meta['attribute_headers'],

pharus/version.py

@@ -1,2 +1,2 @@
 """Package metadata."""
-__version__ = '0.2.1'
+__version__ = '0.2.2'

tests/init/test_dynamic_api_spec.yaml

@@ -23,8 +23,8 @@ SciViz: # top level tab
                 def restriction(**kwargs):
                     return dict(**kwargs)
               dj_query: >
-                def dj_query(vms):
-                    TableA, TableB = (vms['test_group1_simple'].TableA, vms['test_group1_simple'].TableB)
+                def dj_query(test_group1_simple):
+                    TableA, TableB = (test_group1_simple.TableA, test_group1_simple.TableB)
                     return TableA * TableB, dict(order_by='b_number')
         grid2:
           components:
@@ -37,8 +37,8 @@ SciViz: # top level tab
                 def restriction(**kwargs):
                     return dict(**kwargs)
               dj_query: >
-                def dj_query(vms):
-                    TableA, TableB = (vms['test_group1_simple'].TableA, vms['test_group1_simple'].TableB)
+                def dj_query(test_group1_simple):
+                    TableA, TableB = (test_group1_simple.TableA, test_group1_simple.TableB)
                     return TableA * TableB, dict(order_by='b_number')
           
     page1:
@@ -63,8 +63,8 @@ SciViz: # top level tab
                 def restriction(**kwargs):
                     return dict(**kwargs)
               dj_query: >
-                def dj_query(vms):
-                    TableA, TableB = (vms['test_group1_simple'].TableA, vms['test_group1_simple'].TableB)
+                def dj_query(test_group1_simple):
+                    TableA, TableB = (test_group1_simple.TableA, test_group1_simple.TableB)
                     return TableA * TableB, dict(order_by='b_number')
             component2:
               route: /query4
@@ -75,8 +75,8 @@ SciViz: # top level tab
                 def restriction(**kwargs):
                     return dict(**kwargs)
               dj_query: >
-                def dj_query(vms):
-                    TableA, TableB = (vms['test_group1_simple'].TableA, vms['test_group1_simple'].TableB)
+                def dj_query(test_group1_simple):
+                    TableA, TableB = (test_group1_simple.TableA, test_group1_simple.TableB)
                     return TableA * TableB, dict(order_by='b_number')
               diff_checker: >
                 def diff_checker(**args):
@@ -90,8 +90,8 @@ SciViz: # top level tab
                 def restriction(**kwargs):
                     return dict(a_id=0, **kwargs)
               dj_query: >
-                def dj_query(vms):
-                    TableA, TableB = (vms['test_group1_simple'].TableA, vms['test_group1_simple'].TableB)
+                def dj_query(test_group1_simple):
+                    TableA, TableB = (test_group1_simple.TableA, test_group1_simple.TableB)
                     return TableA * TableB, dict(order_by='b_number')
               diff_checker: >
                 def diff_checker(**args):