refactor: pass variables to designated dict instead of using c-object

Author: stefina

ckanext/harvester_dashboard/blueprints/dashboard.py

@@ -1,8 +1,10 @@
 import logging
+from typing import Any
 
 import ckan.plugins.toolkit as tk
-from ckan.common import _, c, request
+from ckan.common import _, current_user, request
 from ckan.lib.base import render
+from ckan.types import Context
 from flask import Blueprint
 
 from ckanext.harvester_dashboard.helpers import harvester_dashboard_organization_title
@@ -29,48 +31,59 @@
 
 
 def dashboard():
-    c.q = request.params.get("q", "")
-    c.source_type = request.params.get("source_type", RESULT_ALL)
-    c.job_result = request.params.get("job_result", RESULT_ALL)
-    c.job_run = request.params.get("job_run", RESULT_ALL)
-    context = {"user": c.user, "auth_user_obj": c.userobj}
+    context: Context = {
+        "user": current_user.name,
+        "auth_user_obj": current_user,
+    }
     harvest_source_list = tk.get_action("get_harvest_source_infos_for_user")(
         context, {}
-    )  # noqa
-    c.source_type_options = _get_source_type_options(harvest_source_list)
-    c.job_result_options = RESULT_OPTIONS
-    c.job_run_options = RUN_OPTIONS
+    )
+    extra_vars: dict[str, Any] = {
+        "q": request.params.get("q", ""),
+        "source_type": request.params.get("source_type", RESULT_ALL),
+        "job_result": request.params.get("job_result", RESULT_ALL),
+        "job_run": request.params.get("job_run", RESULT_ALL),
+        "source_type_options": _get_source_type_options(harvest_source_list),
+        "job_result_options": RESULT_OPTIONS,
+        "job_run_options": RUN_OPTIONS,
+        "harvest_source_infos": harvest_source_list,
+    }
     harvest_source_list = list(
         filter(
             lambda harvest_source_info: _source_type_test(
-                harvest_source_info, c.source_type
+                harvest_source_info, extra_vars["source_type"]
             ),
             harvest_source_list,
         )
     )
     harvest_source_list = list(
         filter(
             lambda harvest_source_info: _job_result_test(
-                harvest_source_info, c.job_result
+                harvest_source_info, extra_vars["job_result"]
             ),
             harvest_source_list,
         )
     )
     harvest_source_list = list(
         filter(
-            lambda harvest_source_info: _job_run_test(harvest_source_info, c.job_run),
+            lambda harvest_source_info: _job_run_test(
+                harvest_source_info, extra_vars["job_run"]
+            ),
             harvest_source_list,
         )
     )
-    if c.q:
+    if extra_vars.get("q"):
         harvest_source_list = list(
             filter(
-                lambda harvest_source_info: _source_name_test(harvest_source_info, c.q),
+                lambda harvest_source_info: _source_name_test(
+                    harvest_source_info, extra_vars["q"]
+                ),
                 harvest_source_list,
             )
         )
-    c.harvest_source_infos = harvest_source_list
-    return render("harvester_dashboard/list.html")
+    extra_vars["harvest_source_infos"] = harvest_source_list
+
+    return render("harvester_dashboard/list.html", extra_vars)
 
 
 def _source_type_test(harvest_source_info, source_type):

ckanext/harvester_dashboard/templates/harvester_dashboard/list.html

@@ -14,11 +14,11 @@
     <h1>{{ _('Harvester Dashboard') }}</h1>
     <p>Last Harvest Jobs filtered by:</p>
     <ul>
-      <li>Source type: {{ c.source_type }}</li>
-      <li>Job result: {{ c.job_result }}</li>
-      <li>Job run status: {{ c.job_run }}</li>
+      <li>Source type: {{ source_type }}</li>
+      <li>Job result: {{ job_result }}</li>
+      <li>Job run status: {{ job_run }}</li>
     </ul>
-    {% for harvest_source_info in c.harvest_source_infos %}
+    {% for harvest_source_info in harvest_source_infos %}
       {% set job = harvest_source_info.job.last_job %}
       {% set organization = harvest_source_info.organization %}
       {% set source = harvest_source_info.source %}
@@ -52,5 +52,5 @@ <h3><a href="{{ source_url }}">Harvester Name: {{ source.title }}</a></h3>
 
 {% block secondary_content %}
   {% snippet 'harvester_dashboard/snippets/helper.html' %}
-  {% snippet 'harvester_dashboard/snippets/search.html' %}
+  {% snippet 'harvester_dashboard/snippets/search.html', source_type_options=source_type_options, job_result_options=job_result_options, job_run_options=job_run_options %}
 {% endblock %}

ckanext/harvester_dashboard/templates/harvester_dashboard/snippets/search.html

@@ -1,7 +1,7 @@
 {% import 'macros/form.html' as form %}
 
 <section class="module module-narrow module-shallow simple-input">
-  {{ c.user_roles }}
+  {{ user_roles }}
   <h2 class="module-heading">{{ _('Harvesters') }}</h2>
   <form id="user-search-form"
         class="module-content field-bordered"
@@ -10,7 +10,7 @@ <h2 class="module-heading">{{ _('Harvesters') }}</h2>
     <div class="field">
       <label for="field-harvester-search">{{ _('Search Harvesters') }}</label>
       <input id="ogdch_user_search"
-             value="{{ c.q }}"
+             value="{{ q }}"
              class="field form-control"
              name="q"
              autocomplete="off"
@@ -24,19 +24,19 @@ <h2 class="module-heading">{{ _('Harvesters') }}</h2>
     <div class="field">
       {% set format_attrs = {'data-module': 'autocomplete'} %}
       {{ form.select('source_type', label=_('Harvest Source Type'),
-         options=c.source_type_options, selected=c.source_type, error='',
+         options=source_type_options, selected=source_type, error='',
          attrs=format_attrs, is_required=false) }}
     </div>
     <div class="field">
       {% set format_attrs = {'data-module': 'autocomplete'} %}
       {{ form.select('job_result', label=_('Job Result'),
-         options=c.job_result_options, selected=c.job_result, error='',
+         options=job_result_options, selected=job_result, error='',
          attrs=format_attrs, is_required=false) }}
     </div>
     <div class="field">
       {% set format_attrs = {'data-module': 'autocomplete'} %}
       {{ form.select('job_run', label=_('Job Run'),
-         options=c.job_run_options, selected=c.job_run, error='',
+         options=job_run_options, selected=job_run, error='',
          attrs=format_attrs, is_required=false) }}
     </div>
     <div class="reset-search">

setup.py

@@ -1,6 +1,7 @@
-from setuptools import setup, find_packages  # Always prefer setuptools over distutils
 from os import path
 
+from setuptools import find_packages, setup  # Always prefer setuptools over distutils
+
 here = path.abspath(path.dirname(__file__))