docassemble.AssemblyLine 4.3.0__tar.gz → 4.4.0__tar.gz

{docassemble_assemblyline-4.3.0/docassemble.AssemblyLine.egg-info → docassemble_assemblyline-4.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: docassemble.AssemblyLine
-Version: 4.3.0
+Version: 4.4.0
 Summary: Quickly go from a paper court form to a runnable, guided, step-by-step web application powered by Docassemble. Swap out branding and pre-built questions to meet your needs.
 Home-page: https://courtformsonline.org
 Author: Suffolk Legal Innovation and Technology Lab
@@ -9,7 +9,7 @@ License-Expression: MIT
 Project-URL: Homepage, https://courtformsonline.org
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: docassemble.ALToolbox>=0.12.0
+Requires-Dist: docassemble.ALToolbox>=0.16.0
 Requires-Dist: docassemble.GitHubFeedbackForm>=0.4.1.1
 Dynamic: author
 Dynamic: home-page

docassemble_assemblyline-4.4.0/docassemble/AssemblyLine/__init__.py

@@ -0,0 +1 @@
+__version__ = '4.4.0'

{docassemble_assemblyline-4.3.0 → docassemble_assemblyline-4.4.0}/docassemble/AssemblyLine/al_courts.py

@@ -2,13 +2,11 @@
 Package for a very simple / MVP list of courts that is mostly signature compatible w/ MACourts for now
 """
 
-import os
-from typing import Any, Callable, Dict, List, Mapping, Optional, Union, Set, Tuple
+from typing import Any, Callable, Dict, List, Optional, Union, Set, Tuple
 import pandas as pd
 import docassemble.base.functions
 from docassemble.base.util import (
     path_and_mimetype,
-    Address,
     LatitudeLongitude,
     DAObject,
     log,

{docassemble_assemblyline-4.3.0 → docassemble_assemblyline-4.4.0}/docassemble/AssemblyLine/al_document.py

@@ -35,7 +35,6 @@ from docassemble.base.pdfa import pdf_to_pdfa
 from textwrap import wrap
 from math import floor
 import subprocess
-from collections import ChainMap
 import pikepdf
 from typing import Tuple
 import secrets

{docassemble_assemblyline-4.3.0 → docassemble_assemblyline-4.4.0}/docassemble/AssemblyLine/al_general.py

@@ -30,13 +30,11 @@ from docassemble.base.util import (
     their,
     url_action,
     validation_error,
-    value,
     word,
     your,
     log,
     value,
 )
-from docassemble.ALToolbox.misc import fa_icon
 import docassemble.base.functions
 import random
 import re
@@ -325,7 +323,7 @@ class ALAddress(Address):
             if not bare and (
                 unit_lower.isnumeric()
                 or (
-                    not " " in self.unit
+                    " " not in self.unit
                     and not any(
                         x in unit_lower
                         for x in [
@@ -1660,10 +1658,13 @@ class ALIndividual(Individual):
         Used to assist with checkbox filling in PDFs with "skip undefined"
         turned on.
         """
-        return not (
-            self.gender
-            in ["prefer-not-to-say", "male", "female", "unknown", "nonbinary"]
-        )
+        return self.gender not in [
+            "prefer-not-to-say",
+            "male",
+            "female",
+            "unknown",
+            "nonbinary",
+        ]
 
     def contact_fields(self) -> None:
         """

{docassemble_assemblyline-4.3.0 → docassemble_assemblyline-4.4.0}/docassemble/AssemblyLine/custom_jinja_filters.py

@@ -5,9 +5,8 @@
 
 # See: https://docassemble.org/docs/documents.html#register_jinja_filter
 
-import re
 from typing import Any, Dict, List, Optional, Union
-from docassemble.base.util import register_jinja_filter, DACatchAll, word
+from docassemble.base.util import register_jinja_filter, DACatchAll
 from jinja2 import Undefined, pass_context
 from jinja2.runtime import Context as Jinja2Context
 
@@ -18,6 +17,7 @@ __all__ = [
     "catchall_question",
     "catchall_subquestion",
     "catchall_fields_code",
+    "catchall_complete",
 ]
 
 
@@ -29,6 +29,7 @@ def catchall_options(value: Any, *raw_items: Any) -> DACatchAll:
 
     The items can be in various formats:
 
+    - String: `"code_is_the_label"`
     - String: `"code: label"`
     - Dictionary: `{"code": "label"}`
     - Tuple: `("code", "label")`
@@ -66,14 +67,14 @@ def catchall_options(value: Any, *raw_items: Any) -> DACatchAll:
         DACatchAll: The modified DACatchAll object with the assigned options.
     """
     if isinstance(value, DACatchAll):
-        pairs = []
+        pairs: list[str | tuple[str, str]] = []
         for item in raw_items:
             if isinstance(item, str):
                 if ":" in item:
                     code, label = item.split(":", 1)
+                    pairs.append((code.strip(), label.strip()))
                 else:
-                    code = label = item
-                pairs.append((code.strip(), label.strip()))
+                    pairs.append(item.strip())
             elif isinstance(item, dict):
                 for code, label in item.items():
                     pairs.append((code.strip(), label.strip()))
@@ -203,6 +204,49 @@ def catchall_subquestion(value: Any, subquestion: str) -> DACatchAll:
     return value
 
 
+def catchall_complete(
+    value: DACatchAll,
+    question: str = "",
+    subquestion: str = "",
+    label: str = "",
+    datatype: str = "",
+    options: Any = "",
+) -> DACatchAll:
+    """
+    Jinja2 filter to allow you to define multiple attributes of a DACatchAll field inside a DOCX template.
+
+    Each argument after `value` corresponds to the similarly named `catchall_` function.
+
+    Example usage in a DOCX template:
+    ```
+    {{ my_catchall_field | catchall_complete(question="What additional information do you need?", subquestion="Be specific", label="no label") }}
+    ```
+
+    Args:
+        value (DACatchAll): The DACatchAll object to which the attributes will be assigned.
+        question (str, optional): The question text to set on the DACatchAll object.
+        subquestion (str, optional): The subquestion text to set on the DACatchAll object.
+        label (str, optional): The label to set on the DACatchAll object.
+        datatype (str, optional): The datatype to set on the DACatchAll object.
+        options (Any, optional): The options to set on the DACatchAll object.
+
+    Returns:
+        DACatchAll: The modified DACatchAll object with the assigned attributes.
+    """
+    if isinstance(value, DACatchAll):
+        if question:
+            catchall_question(value, question)
+        if subquestion:
+            catchall_subquestion(value, subquestion)
+        if label:
+            catchall_label(value, label)
+        if datatype:
+            catchall_datatype(value, datatype)
+        if options:
+            catchall_options(value, options)
+    return value
+
+
 def _undefined_label(ud: Undefined) -> Union[str, None]:
     """
     Extract the variable name from a Jinja2 Undefined object for use as a placeholder label.
@@ -314,6 +358,7 @@ register_jinja_filter("catchall_label", catchall_label)
 register_jinja_filter("catchall_datatype", catchall_datatype)
 register_jinja_filter("catchall_question", catchall_question)
 register_jinja_filter("catchall_subquestion", catchall_subquestion)
+register_jinja_filter("catchall_complete", catchall_complete)
 register_jinja_filter("if_final", if_final)
 
 

{docassemble_assemblyline-4.3.0 → docassemble_assemblyline-4.4.0}/docassemble/AssemblyLine/data/questions/al_code.yml

@@ -22,14 +22,14 @@ code: |
   form_delivery_complete = True
 ---
 code: |
-  court_email = court_emails.get(trial_court.name,None)
+  court_email = court_emails.get(trial_court.name, None)
   if not court_email:
     found_email = False
   else:
     found_email = True
 ---
 code: |
-  bcc_failsafe = court_emails.get('Failsafe Address',None)
+  bcc_failsafe = court_emails.get("Failsafe Address", None)
 ---
 comment: |
   You are encouraged to overwrite these emails during testing!
@@ -51,22 +51,50 @@ code: |
   else:
     email_to_use = dev_email_to_use
     bcc_email = dev_bcc_email
-  
+
   # temporary for testing
   # email_to_use = "massaccess@suffolk.edu"
 
-  if task_not_yet_performed('send email'):
+  if task_not_yet_performed("send email"):
     log(f"Court email is {court_email}, sending email to {email_to_use}")
     email_success = False
     if should_cc_user:
-      log('Sending email to ' + email_to_use + ' and ccing ' + cc_email + ' for ' + str(users) + ' bcc to ' + bcc_email)
-      email_success = send_email(to=email_to_use, template=email_to_court_template, task='send email', 
-                                 cc=cc_email, bcc=bcc_email, attachments=al_final_form_to_file.as_pdf_list(key='final'))
+      log(
+        "Sending email to "
+        + email_to_use
+        + " and ccing "
+        + cc_email
+        + " for "
+        + str(users)
+        + " bcc to "
+        + bcc_email
+      )
+      email_success = send_email(
+        to=email_to_use,
+        template=email_to_court_template,
+        task="send email",
+        cc=cc_email,
+        bcc=bcc_email,
+        attachments=al_final_form_to_file.as_pdf_list(key="final"),
+      )
     else:
-      log('Sending email to ' + email_to_use + ' and no cc ' + ' for ' + str(users) + ' bcc to ' + bcc_email)
-      email_success = send_email(to=email_to_use, template=email_to_court_template, task='send email', 
-                                 attachments=al_final_form_to_file.as_pdf_list(key='final'), bcc=bcc_email)
-    mark_task_as_performed('send email')
+      log(
+        "Sending email to "
+        + email_to_use
+        + " and no cc "
+        + " for "
+        + str(users)
+        + " bcc to "
+        + bcc_email
+      )
+      email_success = send_email(
+        to=email_to_use,
+        template=email_to_court_template,
+        task="send email",
+        attachments=al_final_form_to_file.as_pdf_list(key="final"),
+        bcc=bcc_email,
+      )
+    mark_task_as_performed("send email")
   sent_email_to_court = True
 ---
 ##############################################################
@@ -90,7 +118,7 @@ code: |
   # Gets the number of pages, plus the first cover page
   # TODO(brycew): figure out a better way to estimate the number of pages,
   # including addendum, without generating a full file
-  al_num_package_pages = al_court_bundle.as_pdf(key='preview').num_pages() + 1
+  al_num_package_pages = al_court_bundle.as_pdf(key="preview").num_pages() + 1
 ---
 code: |
   # You can define this in the interview's code block.
@@ -101,7 +129,7 @@ code: |
   # This is a fallback package title to avoid errors on new forms
   # It defines package_title as the metadata title.
   # You may want a better form title for most interviews
-  package_title = all_variables(special='metadata').get('title','').rstrip()
+  package_title = all_variables(special="metadata").get("title", "").rstrip()
 ---
 attachment:
   variable name: al_cover_page[i]
@@ -126,27 +154,36 @@ code: |
   elif signature_choice == "typed_signature":
     for signature in signature_fields:
       # Signature fields are strings like "users[0].signature". If the string ends in .signature, remove that and replace with .typed_signature, only at the end of the string
-      if signature.endswith('signature'):
-        typed_signature = signature[:-9] + 'typed_signature'
+      if signature.endswith("signature"):
+        typed_signature = signature[:-9] + "typed_signature"
         define(signature, DAFile(signature, filename="signature.png"))
         value(signature).initialize()
-        create_signature(value(typed_signature), value(signature).path(), signature_prefix = al_typed_signature_prefix, font_name = al_typed_signature_font)
+        create_signature(
+          value(typed_signature),
+          value(signature).path(),
+          signature_prefix=al_typed_signature_prefix,
+          font_name=al_typed_signature_font,
+        )
       else:
-        log("Signature field " + signature + " does not end with .signature, not creating typed signature")
-  elif signature_choice in ['this device', 'this_device']:
+        log(
+          "Signature field "
+          + signature
+          + " does not end with .signature, not creating typed signature"
+        )
+  elif signature_choice in ["this device", "this_device"]:
     for signature in signature_fields:
-      value(signature)    
+      value(signature)
   # Check for Branch 2 or 3
-  elif signature_choice == 'phone':
+  elif signature_choice == "phone":
     saw_signature_qrcode
     # User will click next. link_cell will only be defined if they chose the texting option
-    if showifdef("link_cell") and task_not_yet_performed('send signature link'): 
+    if showifdef("link_cell") and task_not_yet_performed("send signature link"):
       # They used the text option
-      send_sms(task='send signature link', to=link_cell,template=interview_link)
+      send_sms(task="send signature link", to=link_cell, template=interview_link)
       signature_wait_screen
       for signature in signature_fields:
         value(signature)
-    else: # Branch 3: They used the QR Code. No special screen, just continue
+    else:  # Branch 3: They used the QR Code. No special screen, just continue
       for signature in signature_fields:
         value(signature)
     # Show the follow-up if they sent the link to their phone by QR or by SMS
@@ -157,14 +194,14 @@ code: |
 code: |
   # Sometimes we have values that can be set from interview_metadata.
   # They don't always work, but interview author can override.
-  
+
   # Some interviews have multiple interview_metadata keys. Look in the 1st one
-  first_form_key = next(iter(interview_metadata),'')
-  if isinstance(interview_metadata.get(first_form_key,{}), dict):
-    first_form = interview_metadata.get(first_form_key,{})
+  first_form_key = next(iter(interview_metadata), "")
+  if isinstance(interview_metadata.get(first_form_key, {}), dict):
+    first_form = interview_metadata.get(first_form_key, {})
   else:
     first_form = {}
-  del(first_form_key)
+  del first_form_key
 ---
 depends on:
   - user_ask_role
@@ -175,12 +212,12 @@ code: |
   # define user_role to be either "defendant" or "plaintiff",
   # either by checking interview_metadata or asking the user.
   # The only valid values for user_role are "plaintiff" and "defendant".
-  
+
   # We will check for the "typical_role" key.
   # Some older wizarded code doesn't define `typical_role`, so fall back
   # to "unknown" if the key is not present.
   # first_form is the first entry in interview_metadata
-  if not first_form.get("typical_role", 'unknown') == 'unknown':
+  if not first_form.get("typical_role", "unknown") == "unknown":
     user_role = first_form.get("typical_role")
   else:
     # If the user role was set to "unknown" at the time wizard run

{docassemble_assemblyline-4.3.0 → docassemble_assemblyline-4.4.0}/docassemble/AssemblyLine/data/questions/al_document.yml

@@ -25,21 +25,26 @@ code: |
       preferred_formats = ["pdf"]
 
   email_success = x.send_email(
-      to=action_argument('email'),
-      template=(
-        value(action_argument('template_name'))
-        if action_argument('template_name')
-        else None
-      ),
-      key=action_argument('key'),
-      preferred_formats=preferred_formats,
+    to=action_argument("email"),
+    template=(
+      value(action_argument("template_name"))
+      if action_argument("template_name")
+      else None
+    ),
+    key=action_argument("key"),
+    preferred_formats=preferred_formats,
   )
+  email_arg = action_argument('email')
+  if isinstance(email_arg, list):
+    email_str = ', '.join(email_arg)
+  else:
+    email_str = str(email_arg)
   if email_success:
     # Exact phrase below is in Docassemble's words dictionary
-    log(word('E-mail was sent to') + ' ' + action_argument('email') ,'success')
+    log(f" {word('E-mail was sent to')} {email_str}", "success")
   else:
     # E-mail failed is not in the default Docassemble words dictionary
-    log(word('E-mail failed'), 'error')
+    log(f" {word('E-mail failed')} to {email_str}", "error")
 ---
 generic object: ALDocumentBundle
 event: x.send_email_to_action_event
@@ -58,33 +63,39 @@ code: |
       preferred_formats = ["pdf"]
 
   email_success = x.send_email(
-      to=action_argument('email'),
-      template=(
-        value(action_argument('template_name'))
-        if action_argument('template_name')
-        else None
-      ),
-      key=action_argument('key'),
-      preferred_formats=preferred_formats,
+    to=action_argument("email"),
+    template=(
+      value(action_argument("template_name"))
+      if action_argument("template_name")
+      else None
+    ),
+    key=action_argument("key"),
+    preferred_formats=preferred_formats,
   )
+  email_arg = action_argument('email')
+  if isinstance(email_arg, list):
+    email_str = ', '.join(email_arg)
+  else:
+    email_str = str(email_arg)
   if email_success:
-    log("Email sent to " + action_argument('email')) # to log file
+    log(f"Email sent to {email_str}")  # to log file
   else:
-    log(word('E-mail failed to ') + action_argument('email'))
-
-  json_response({'success': email_success})
-  
-
+    log(f" {word('E-mail failed to ')} {email_str}")
 
+  json_response({"success": email_success})
 ---
 generic object: ALDocumentBundle
 code: |
   # Used in the email subject line when email is triggered on download screen.
-  # This defaults to the interview title. For example, if the 
+  # This defaults to the interview title. For example, if the
   # interview title is "Guardianship Helper", the email
   # subject would be "Your Guardianship Helper document from CourtFormsOnline is ready".
   # Customize this if you prefer something like "Your guardianship document is ready"
-  x.document_label = str(all_variables(special='titles').get('title', all_variables(special='metadata').get('title', 'assembled'))).strip()
+  x.document_label = str(
+    all_variables(special="titles").get(
+      "title", all_variables(special="metadata").get("title", "assembled")
+    )
+  ).strip()
 ---
 generic object: ALDocumentBundle
 template: x.send_email_template
@@ -122,36 +133,46 @@ content: |
 id: al exhibit ocr pages bg
 event: al_exhibit_ocr_pages
 code: |
-  to_pdf = action_argument('to_pdf')
-  from_file = action_argument('from_file')
+  to_pdf = action_argument("to_pdf")
+  from_file = action_argument("from_file")
   background_response(ocrmypdf_task(from_file, to_pdf))
 ---
 ############## Background document assembly #################
 ---
 generic object: ALDocumentBundle
 code: |
-  x.generate_downloads_task = background_action(x.attr_name('create_downloads'))
+  x.generate_downloads_task = background_action(x.attr_name("create_downloads"))
 ---
 generic object: ALDocumentBundle
 event: x.create_downloads
 code: |
-  download_response = x.get_cacheable_documents(key="final", pdf=True, include_full_pdf=True)
-  background_response_action(x.attr_name('save_downloads'), download_response=download_response)
+  download_response = x.get_cacheable_documents(
+    key="final", pdf=True, include_full_pdf=True
+  )
+  background_response_action(
+    x.attr_name("save_downloads"), download_response=download_response
+  )
 ---
 generic object: ALDocumentBundle
 code: |
-  x.generate_downloads_with_docx_task = background_action(x.attr_name('create_downloads_with_docx'))
+  x.generate_downloads_with_docx_task = background_action(
+    x.attr_name("create_downloads_with_docx")
+  )
 ---
 generic object: ALDocumentBundle
 event: x.create_downloads_with_docx
 code: |
-  download_response = x.get_cacheable_documents(key="final", pdf=True, docx=True, include_full_pdf=True)
-  background_response_action(x.attr_name('save_downloads'), download_response=download_response)
+  download_response = x.get_cacheable_documents(
+    key="final", pdf=True, docx=True, include_full_pdf=True
+  )
+  background_response_action(
+    x.attr_name("save_downloads"), download_response=download_response
+  )
 ---
 generic object: ALDocumentBundle
 event: x.save_downloads
 code: |
-  x._downloadable_files = action_argument('download_response')
+  x._downloadable_files = action_argument("download_response")
 
   background_response()
 ---
@@ -171,18 +192,20 @@ reload: True
 ---
 generic object: ALDocumentBundle
 code: |
-  x.generate_preview_task = background_action(x.attr_name('generate_preview_event'))
+  x.generate_preview_task = background_action(x.attr_name("generate_preview_event"))
 ---
 generic object: ALDocumentBundle
 event: x.generate_preview_event
 code: |
   preview_response = x.as_pdf(key="preview")
-  background_response_action(x.attr_name('save_preview'), preview_response=preview_response)
+  background_response_action(
+    x.attr_name("save_preview"), preview_response=preview_response
+  )
 ---
 generic object: ALDocumentBundle
 event: x.save_preview
 code: |
-  x._preview_file = action_argument('preview_response')
+  x._preview_file = action_argument("preview_response")
   background_response()
 ---
 id: preview waiting screen
@@ -195,4 +218,4 @@ subquestion: |
       <span class="sr-only visually-hidden">Generating preview...</span>
   </div>
 event: al_preview_waiting_screen
-reload: True
+reload: True

{docassemble_assemblyline-4.3.0 → docassemble_assemblyline-4.4.0}/docassemble/AssemblyLine/data/questions/al_language.yml

@@ -30,13 +30,13 @@ code: |
 ---
 code: |
   if enable_al_language:
-    if url_args.get('lang'):
-      al_user_language = url_args.get('lang')
+    if url_args.get("lang"):
+      al_user_language = url_args.get("lang")
     else:
       al_user_language = al_user_default_language
 ---
 event: al_change_language
 code: |
-  if 'lang' in action_arguments():
-    al_user_language = action_argument('lang')
+  if "lang" in action_arguments():
+    al_user_language = action_argument("lang")
     set_language(al_user_language)

{docassemble_assemblyline-4.3.0 → docassemble_assemblyline-4.4.0}/docassemble/AssemblyLine/data/questions/al_question_test.yml

@@ -47,12 +47,12 @@ code: |
   chiropractors.gather()
   other_parties.gather()
   users.gather()
-  users[0].gender  
+  users[0].gender
   users[0].address.address
   users[0].mailing_address.address
   users[0].phone_number
   trial_court
-  big_text_field  
+  big_text_field
   children.gather()
   preview_screen
   basic_questions_signature_flow
@@ -73,7 +73,7 @@ continue button field: test_label_functions
 code: |
   children[i].name.first
   children[i].birthdate
-  children[i].complete=True
+  children[i].complete = True
 ---
 # Page to test certain features
 # Reduced text for ease of testing custom audio element
@@ -125,9 +125,9 @@ question: |
 yesno: mako_template_enabled
 ---
 code: |
-  # You must use an intermediate value to set the enabled status, because it is not 
+  # You must use an intermediate value to set the enabled status, because it is not
   # cached longer than one page load. You do not need to explicitly reconsider it.
-  mako_template.enabled = mako_template_enabled 
+  mako_template.enabled = mako_template_enabled
 ---
 objects:
   - al_user_bundle: ALDocumentBundle.using(elements=[mako_template, word_template, static_template, exhibit_attachment], filename="user_bundle.pdf", title="All forms to download for your records")
@@ -140,8 +140,8 @@ code: |
   metadata_title = "AssemblyLine Question Test"
 ---
 code: |
-  mako_template.overflow_fields['big_text_field'].overflow_trigger = 200
-  mako_template.overflow_fields['children'].overflow_trigger = 2
+  mako_template.overflow_fields["big_text_field"].overflow_trigger = 200
+  mako_template.overflow_fields["children"].overflow_trigger = 2
   mako_template.overflow_fields.gathered = True
 ---
 attachment: