upgrade Python and JavaScript dependencies; allow multi-threaded code to run in Celery tasks; avoid potential error with undefined gathering mode; prevent translation of field modifiers that are Mako but are not user-visible text; fix issue with gathering dictionaries; change the way Azure mail is sent so that bcc recipients are correctly handled; added _edit_button() and _delete_button() methods to DADict; rename class method of DAGlobal from delete, which is already used, to remove; change the way that the restart process works after changing the configuration or synchronizing the Playground so that Ajax requests are sent from the browser to poll the server to check that it has restarted

Author: jhpyle

CHANGELOG.md

@@ -1,5 +1,44 @@
 # Change Log
 
+## [1.9.0] - 2025-12-31
+
+### Added
+
+- The `.cancel_add_or_edit()` method of `DADict`.
+- The methods `_edit_button()`, `_delete_button()`, and
+  `_add_action_button()` of the `DADict` class, so that `DADict` can
+  be subclassed for customizing the appearance of these buttons.
+- The `remove()` class method of `DAGlobal` that can be used to delete
+  any key from the data store, for any given base.
+
+### Changed
+
+- Upgraded Python dependencies. Note that if you are using third-party
+  Python packages, you may encounter dependency conflicts. It is
+  possible that your interviews will need to be updated.
+- Upgraded Font Awesome, Bootstrap, and CodeMirror.
+- Use process-local rather than thread-local variables to store global
+  information in the context of the Celery background task system.
+- The `plain()`, `bold()`, and `italic()` functions will return the
+  empty string if given blank space.
+- Added additional information to Mako error messages.
+- The `.complete_elements()` method of `DAList` and `DADict` now
+  returns an object of the same class, rather than a pure Python data
+  structure.
+- The Google Drive sync and OneDrive sync result page now wait for
+  the server to finish restarting.
+
+### Fixed
+- Avoided `KeyError` error messages related to `gathering_mode` and
+  `save_status`.
+- Avoided translation of non-user-facing Mako template text in field
+  modifiers.
+- Fix to dictionary gathering.
+- The restart process from the Configuration page could show a 502
+  error to the user when the Python app is behind a reverse proxy.
+- The Microsoft Azure mail sending feature did not support sending to
+  bcc recipients.
+
 ## [1.8.18] - 2025-11-01
 
 ### Fixed

Dockerfile

@@ -52,39 +52,39 @@ bash -c \
 && cp /usr/local/bin/unoconv /usr/bin/unoconv \
 && python3 -m venv --copies /usr/share/docassemble/local3.12 \
 && source /usr/share/docassemble/local3.12/bin/activate \
-&& pip install --upgrade pip==25.2 \
+&& pip install --upgrade pip==25.3 \
 && pip install --upgrade wheel==0.45.1 \
 && pip install --upgrade mod_wsgi==5.0.2 \
 && pip install --upgrade \
-   acme==4.1.1 \
-   certbot==4.1.1 \
-   certbot-apache==4.1.1 \
-   certbot-nginx==4.1.1 \
-   certifi==2025.8.3 \
-   cffi==1.17.1 \
-   charset-normalizer==3.4.2 \
-   click==8.2.1 \
+   acme==5.2.2 \
+   certbot==5.2.2 \
+   certbot-apache==5.2.2 \
+   certbot-nginx==5.2.2 \
+   certifi==2025.11.12 \
+   cffi==2.0.0 \
+   charset-normalizer==3.4.4 \
+   click==8.3.1 \
    ConfigArgParse==1.7.1 \
    configobj==5.0.9 \
-   cryptography==45.0.7 \
+   cryptography==46.0.3 \
    distro==1.9.0 \
-   idna==3.10 \
-   joblib==1.5.1 \
-   josepy==2.1.0 \
-   nltk==3.9.1 \
+   idna==3.11 \
+   joblib==1.5.3 \
+   josepy==2.2.0 \
+   nltk==3.9.2 \
    parsedatetime==2.6 \
-   pycparser==2.22 \
-   pyOpenSSL==25.1.0 \
-   pyparsing==3.2.3 \
-   pyRFC3339==2.0.1 \
+   pycparser==2.23 \
+   pyOpenSSL==25.3.0 \
+   pyparsing==3.3.1 \
+   pyRFC3339==2.1.0 \
    python-augeas==1.2.0 \
    pytz==2025.2 \
-   regex==2025.7.34 \
-   requests==2.32.4 \
+   regex==2025.11.3 \
+   requests==2.32.5 \
    six==1.17.0 \
    tqdm==4.67.1 \
-   typing_extensions==4.14.1 \
-   urllib3==2.5.0 \
+   typing_extensions==4.15.0 \
+   urllib3==2.6.2 \
 && pip install \
    /tmp/docassemble/docassemble_base \
    /tmp/docassemble/docassemble_demo \

docassemble_base/docassemble/base/data/sources/base-words.yml

@@ -596,6 +596,7 @@
 "Montserrat": Null
 "Morocco": Null
 "Move down": Null
+"Move up": Null
 "Mozambique": Null
 "Multiselect box": Null
 "Must be a two-letter code": Null

docassemble_base/docassemble/base/functions.py

@@ -25,6 +25,7 @@
 import markdown
 import nltk
 import ruamel.yaml
+from types import SimpleNamespace
 from docassemble.base.save_status import SS_NEW, SS_OVERWRITE, SS_IGNORE
 
 try:
@@ -205,7 +206,10 @@ def set_gathering_mode(mode, instanceName):
             # logmessage("set_gathering_mode: using " + str(get_current_variable()))
             this_thread.gathering_mode[instanceName] = get_current_variable()
     else:
-        del this_thread.gathering_mode[instanceName]
+        try:
+            del this_thread.gathering_mode[instanceName]
+        except KeyError:
+            pass
 
 
 def get_gathering_mode(instanceName):
@@ -229,7 +233,10 @@ def reset_gathering_mode(*pargs):
             todel.append(instanceName)
     # logmessage("reset_gathering_mode: deleting " + repr([y for y in todel]))
     for item in todel:
-        del this_thread.gathering_mode[item]
+        try:
+            del this_thread.gathering_mode[item]
+        except KeyError:
+            pass
 
 
 def set_uid(uid):
@@ -2176,31 +2183,41 @@ def __init__(self):
 #         self.__dict__.update(kw)
 
 this_thread = threading.local()
-this_thread.language = server.default_language
-this_thread.dialect = server.default_dialect
-this_thread.voice = server.default_voice
-this_thread.country = server.default_country
-this_thread.locale = server.default_locale
-this_thread.current_info = {}
-this_thread.internal = {}
-this_thread.initialized = False
-this_thread.session_id = None
-this_thread.current_package = None
-this_thread.interview = None
-this_thread.interview_status = None
-this_thread.evaluation_context = None
-this_thread.gathering_mode = {}
-this_thread.global_vars = GenericObject()
-this_thread.current_variable = []
-this_thread.open_files = set()
-this_thread.markdown = markdown.Markdown(extensions=['smarty', 'markdown.extensions.sane_lists', 'markdown.extensions.tables', 'markdown.extensions.attr_list', 'markdown.extensions.md_in_html', 'footnotes'], output_format='html5')
-this_thread.saved_files = {}
-this_thread.message_log = []
-this_thread.misc = {}
-this_thread.probing = False
-this_thread.prevent_going_back = False
-this_thread.current_question = None
-this_thread.current_section = None
+
+def populate_this_thread_defaults():
+    this_thread.language = server.default_language
+    this_thread.dialect = server.default_dialect
+    this_thread.voice = server.default_voice
+    this_thread.country = server.default_country
+    this_thread.locale = server.default_locale
+    this_thread.current_info = {}
+    this_thread.internal = {}
+    this_thread.initialized = False
+    this_thread.session_id = None
+    this_thread.current_package = None
+    this_thread.interview = None
+    this_thread.interview_status = None
+    this_thread.evaluation_context = None
+    this_thread.gathering_mode = {}
+    this_thread.global_vars = GenericObject()
+    this_thread.current_variable = []
+    this_thread.open_files = set()
+    this_thread.markdown = markdown.Markdown(extensions=['smarty', 'markdown.extensions.sane_lists', 'markdown.extensions.tables', 'markdown.extensions.attr_list', 'markdown.extensions.md_in_html', 'footnotes'], output_format='html5')
+    this_thread.saved_files = {}
+    this_thread.message_log = []
+    this_thread.misc = {}
+    this_thread.probing = False
+    this_thread.prevent_going_back = False
+    this_thread.current_question = None
+    this_thread.current_section = None
+
+populate_this_thread_defaults()
+
+
+def enable_threading():
+    global this_thread
+    this_thread = SimpleNamespace()
+    populate_this_thread_defaults()
 
 
 def backup_thread_variables():
@@ -5470,7 +5487,7 @@ def class_name(the_object):
 def plain(text, default=None):
     """Substitutes empty string or the value of the default parameter if the text is empty."""
     ensure_definition(text, default)
-    if text is None or not str(text).strip():
+    if text is None or str(text).strip() == '':
         if default is None:
             return ''
         return default
@@ -5480,7 +5497,7 @@ def plain(text, default=None):
 def bold(text, default=None):
     """Adds Markdown tags to make the text bold if it is not blank."""
     ensure_definition(text, default)
-    if text is None or not str(text).strip():
+    if text is None or str(text).strip() == '':
         if default is None:
             return ''
         return '**' + str(default) + '**'
@@ -5490,7 +5507,7 @@ def bold(text, default=None):
 def italic(text, default=None):
     """Adds Markdown tags to make the text italic if it is not blank."""
     ensure_definition(text, default)
-    if text is None or not str(text).strip():
+    if text is None or str(text).strip() == '':
         if default is None:
             return ''
         return '_' + str(default) + '_'

docassemble_base/docassemble/base/parse.py

@@ -3212,22 +3212,22 @@ def __init__(self, orig_data, caller, **kwargs):
                         raise DASourceError("The css classifier specifier in an action buttons item must refer to plain text." + self.idebug(data))
                     if not isinstance(forget_prior, bool):
                         raise DASourceError("The forget prior specifier in an action buttons item must refer to true or false." + self.idebug(data))
-                    button = {'action': TextObject(definitions + action, question=self), 'label': TextObject(definitions + label, question=self), 'color': TextObject(definitions + color, question=self)}
+                    button = {'action': TextObject(definitions + action, question=self), 'label': TextObject(definitions + label, question=self), 'color': TextObject(definitions + color, question=self, translate=False)}
                     button['show if'] = showif
                     if target is not None:
-                        button['target'] = TextObject(definitions + target, question=self)
+                        button['target'] = TextObject(definitions + target, question=self, translate=False)
                     else:
                         button['target'] = None
                     if icon is not None:
-                        button['icon'] = TextObject(definitions + icon, question=self)
+                        button['icon'] = TextObject(definitions + icon, question=self, translate=False)
                     else:
                         button['icon'] = None
                     if placement is not None:
-                        button['placement'] = TextObject(definitions + placement, question=self)
+                        button['placement'] = TextObject(definitions + placement, question=self, translate=False)
                     else:
                         button['placement'] = None
                     if css_class is not None:
-                        button['css_class'] = TextObject(definitions + css_class, question=self)
+                        button['css_class'] = TextObject(definitions + css_class, question=self, translate=False)
                     else:
                         button['css_class'] = None
                     if forget_prior:

docassemble_base/docassemble/base/util.py

@@ -3783,7 +3783,8 @@ def gather(self, item_object_type=None, number=None, minimum=None, complete_attr
             elif hasattr(self, 'there_is_another'):
                 # logmessage("0gather " + self.instanceName + ": del on there_is_another")
                 delattr(self, 'there_is_another')
-        while (number is not None and len(self.elements) < int(number)) or (minimum is not None and len(self.elements) < int(minimum)) or (self.ask_number is False and minimum != 0 and (self.there_is_another or (hasattr(self, 'there_is_one_other') and self.there_is_one_other))):
+        should_break_out = False
+        while not should_break_out and ((number is not None and len(self.elements) < int(number)) or (minimum is not None and len(self.elements) < int(minimum)) or (self.ask_number is False and minimum != 0 and (self.there_is_another or (hasattr(self, 'there_is_one_other') and self.there_is_one_other)))):
             if item_object_type is not None:
                 self.initializeObject(self.new_item_name, item_object_type, **new_item_parameters)
                 if hasattr(self, 'there_is_one_other'):
@@ -3808,6 +3809,7 @@ def gather(self, item_object_type=None, number=None, minimum=None, complete_attr
                 else:
                     the_name = self.new_item_name
                     self.__getitem__(the_name)  # pylint: disable=unnecessary-dunder-call
+                    should_break_out = True
                     if hasattr(self, 'new_item_name'):
                         delattr(self, 'new_item_name')
                     if hasattr(self, 'there_is_one_other'):
@@ -4105,6 +4107,12 @@ def pronoun_subjective(self, **kwargs):
             return capitalize_func(output)
         return output
 
+    def _edit_button(self, url, classes):
+        return f'<a href="{url}" role="button" class="{classes}"><span class="text-nowrap"><i class="fa-solid fa-pencil-alt"></i> {word("Edit")}</span></a> '
+
+    def _delete_button(self, url, classes):
+        return f'<a href="{url}" role="button" class="{classes}"><span class="text-nowrap"><i class="fa-solid fa-trash"></i> {word("Delete")}</span></a>'
+
     def item_actions(self, *pargs, **kwargs):
         """Returns HTML for editing the items in a dictionary"""
         the_args = list(pargs)
@@ -4139,13 +4147,13 @@ def item_actions(self, *pargs, **kwargs):
                 items += [{'action': '_da_define', 'arguments': {'variables': [item.instanceName + '.' + attrib for attrib in self._complete_attributes()]}}]
             if ensure_complete:
                 items += [{'action': '_da_dict_ensure_complete', 'arguments': {'group': self.instanceName}}]
-            output += '<a href="' + docassemble.base.functions.url_action('_da_dict_edit', items=items) + '" role="button" class="btn btn-sm ' + server.button_class_prefix + server.daconfig['button colors'].get('edit', 'secondary') + ' btn-darevisit"><i class="fa-solid fa-pencil-alt"></i> ' + word('Edit') + '</a> '
+            output += self._edit_button(docassemble.base.functions.url_action('_da_dict_edit', items=items), 'btn btn-sm ' + server.button_class_prefix + server.daconfig['button colors'].get('edit', 'secondary') + ' btn-darevisit')
         if use_delete and can_delete:
             if kwargs.get('confirm', False):
                 areyousure = ' daremovebutton'
             else:
                 areyousure = ''
-            output += '<a href="' + docassemble.base.functions.url_action('_da_dict_remove', dict=self.instanceName, item=repr(index)) + '" role="button" class="btn btn-sm ' + server.button_class_prefix + server.daconfig['button colors'].get('delete', 'danger') + ' btn-darevisit' + areyousure + '"><i class="fa-solid fa-trash"></i> ' + word('Delete') + '</a>'
+            output += self._delete_button(docassemble.base.functions.url_action('_da_dict_remove', dict=self.instanceName, item=repr(index)), 'btn btn-sm ' + server.button_class_prefix + server.daconfig['button colors'].get('delete', 'danger') + ' btn-darevisit' + areyousure)
         if kwargs.get('edit_url_only', False):
             return docassemble.base.functions.url_action('_da_dict_edit', items=items)
         if kwargs.get('delete_url_only', False):
@@ -7083,8 +7091,8 @@ def defined(cls, base, key):
         return server.server_sql_defined(globalkey)
 
     @classmethod
-    def delete(cls, base, key):
-        """Deletes the key from the base in the global storage area."""
+    def remove(cls, base, key):
+        """Deletes the key from the data store."""
         if base == 'interview':
             globalkey = 'da:daglobal:i:' + str(this_thread.current_info.get('yaml_filename', '')) + ':' + str(key)
         elif base == 'global':
@@ -9968,7 +9976,7 @@ def ocr_file(image_file, language=None, psm=6, f=None, l=None, x=None, y=None, W
             except subprocess.CalledProcessError as err:
                 raise DAError("ocr_file: failed to OCR file: " + str(err) + " " + str(err.output.decode()))
         elif TESSERACT_MODE == REMOTE:
-            result = run_tesseract.delay(['stdin', 'stdout', '-l', str(lang), '--psm', str(psm)], mode=0, file_path=file_to_read.name).get(disable_sync_subtasks=False)
+            result = run_tesseract.delay(['stdin', 'stdout', '-l', str(lang), '--psm', str(psm)], mode=0, file_path=file_to_read.name).get(disable_sync_subtasks=False)  # pylint: disable=possibly-used-before-assignment
             if not result.ok:
                 raise DAError("ocr_file: failed to OCR file")
             text = result.content
@@ -11304,7 +11312,7 @@ def ocr_pdf(*pargs, target=None, filename=None, lang=None, psm=6, dafilelist=Non
                     result = 1
                     logmessage("ocr_pdf: call to gs took too long")
             elif TESSERACT_MODE == REMOTE:
-                result = run_gs.delay(params[1:]).get(disable_sync_subtasks=False)
+                result = run_gs.delay(params[1:]).get(disable_sync_subtasks=False)  # pylint: disable=possibly-used-before-assignment
                 if result is None:
                     result = 1
                     logmessage("ocr_pdf: call to gs took too long")
@@ -11372,6 +11380,7 @@ def ocr_pdf(*pargs, target=None, filename=None, lang=None, psm=6, dafilelist=Non
 
 def ocr_page(indexno, doc=None, lang=None, pdf_to_ppm='pdf_to_ppm', ocr_resolution=300, psm=6, page=None, x=None, y=None, W=None, H=None, user_code=None, user=None, pdf=False, preserve_color=False):  # pylint: disable=unused-argument
     """Runs optical character recognition on an image or a page of a PDF file and returns the recognized text."""
+    text = ''
     if page is None:
         page = 1
     if psm is None: