docassemble.AssemblyLine 4.2.0__tar.gz → 4.4.0__tar.gz

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

@@ -1,22 +1,19 @@
 Metadata-Version: 2.4
 Name: docassemble.AssemblyLine
-Version: 4.2.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
-Author-email: qsteenhuis@suffolk.edu
-License: The MIT License (MIT)
+Author-email: Suffolk Legal Innovation and Technology Lab <litlab@suffolk.edu>
+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.GithubFeedbackForm>=0.4.1.1
+Requires-Dist: docassemble.ALToolbox>=0.16.0
+Requires-Dist: docassemble.GitHubFeedbackForm>=0.4.1.1
 Dynamic: author
-Dynamic: author-email
-Dynamic: description
-Dynamic: description-content-type
 Dynamic: home-page
-Dynamic: license
 Dynamic: license-file
-Dynamic: requires-dist
 
 # Suffolk LIT Lab Document Assembly Line
 
@@ -55,7 +52,7 @@ https://suffolklitlab.org/docassemble-AssemblyLine-documentation/
 
 ## Menu-driven installation
 
-The recommended installation method is with the [guided installation script](https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/installation).
+The recommended installation method is with the [guided installation script](https://assemblyline.suffolklitlab.org/docs/get_started/installation).
 
 ## Manual installation
 
@@ -155,3 +152,4 @@ code: |
 # Changelog
 
 See [CHANGELOG.MD](https://github.com/SuffolkLITLab/docassemble-AssemblyLine/blob/main/CHANGELOG.md)
+

{docassemble_assemblyline-4.2.0 → docassemble_assemblyline-4.4.0}/README.md

@@ -35,7 +35,7 @@ https://suffolklitlab.org/docassemble-AssemblyLine-documentation/
 
 ## Menu-driven installation
 
-The recommended installation method is with the [guided installation script](https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/installation).
+The recommended installation method is with the [guided installation script](https://assemblyline.suffolklitlab.org/docs/get_started/installation).
 
 ## Manual installation
 
@@ -135,3 +135,4 @@ code: |
 # Changelog
 
 See [CHANGELOG.MD](https://github.com/SuffolkLITLab/docassemble-AssemblyLine/blob/main/CHANGELOG.md)
+

docassemble_assemblyline-4.4.0/docassemble/AssemblyLine/__init__.py

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

{docassemble_assemblyline-4.2.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.2.0 → docassemble_assemblyline-4.4.0}/docassemble/AssemblyLine/al_document.py

@@ -12,6 +12,7 @@ from docassemble.base.util import (
     DAFile,
     DAFileCollection,
     DAFileList,
+    DALazyTemplate,
     defined,
     pdf_concatenate,
     zip_file,
@@ -28,18 +29,17 @@ from docassemble.base.util import (
     DAStaticFile,
     alpha,
     showifdef,
+    word,
 )
 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
 import string
 
-
 __all__ = [
     "ALAddendumField",
     "ALAddendumFieldDict",
@@ -315,6 +315,9 @@ class ALAddendumField(DAObject):
 
         # If trigger is not a boolean value, overflow value is the value that starts at the end of the safe value.
         original_value = self.value_if_defined()
+        # Ensure a DALazyTemplate is rendered to a string for downstream string ops
+        if isinstance(original_value, DALazyTemplate):
+            original_value = str(original_value)
         safe_text = self.safe_value(
             overflow_message=overflow_message,
             input_width=input_width,
@@ -409,6 +412,9 @@ class ALAddendumField(DAObject):
             val = _original_value
         else:
             val = self.value_if_defined()
+        # If this is a template block, render it now so comparisons work correctly
+        if isinstance(val, DALazyTemplate):
+            val = str(val)
 
         return (
             self.safe_value(
@@ -508,6 +514,11 @@ class ALAddendumField(DAObject):
             value = _original_value
         else:
             value = self.value_if_defined()
+
+        # Convert template blocks to strings for purposes of evaluating overflow
+        if isinstance(value, DALazyTemplate):
+            value = str(value)
+
         if (
             isinstance(value, str)
             and len(value) <= self.overflow_trigger
@@ -1996,11 +2007,11 @@ class ALDocumentBundle(DAList):
         refresh: bool = True,
         pdfa: bool = False,
         include_zip: bool = True,
-        view_label="View",
+        view_label: Optional[str] = None,
         view_icon: str = "eye",
-        download_label: str = "Download",
+        download_label: Optional[str] = None,
         download_icon: str = "download",
-        send_label: str = "Send",
+        send_label: Optional[str] = None,
         send_icon: str = "envelope",
         zip_label: Optional[str] = None,
         zip_icon: str = "file-archive",
@@ -2023,11 +2034,11 @@ class ALDocumentBundle(DAList):
             refresh (bool): Flag to reconsider the 'enabled' attribute, default is True.
             pdfa (bool): Flag to return documents in PDF/A format, default is False.
             include_zip (bool): Flag to include a zip option, default is True.
-            view_label (str): Label for the 'view' button, default is "View".
+            view_label (str): Label for the 'view' button, default is self.view_label or "View".
             view_icon (str): Icon for the 'view' button, default is "eye".
-            download_label (str): Label for the 'download' button, default is "Download".
+            download_label (str): Label for the 'download' button, default is self.download_label or "Download".
             download_icon (str): Icon for the 'download' button, default is "download".
-            send_label (str): Label for the 'send' button. Default is "Send".
+            send_label (str): Label for the 'send' button. Default is self.send_label or "Send".
             send_icon (str): Fontawesome icon for the 'send' button. Default is "envelope".
             zip_label (Optional[str]): Label for the zip option. If not provided, uses the generic template for `self.zip_label` ("Download all").
             zip_icon (str): Icon for the zip option, default is "file-archive".
@@ -2044,11 +2055,14 @@ class ALDocumentBundle(DAList):
         Returns:
             str: HTML representation of a table with documents and their associated actions.
         """
-        if not hasattr(self, "_cached_zip_label"):
-            self._cached_zip_label = str(self.zip_label)
+        if not view_label:
+            view_label = str(self.view_label) or word("View")
 
-        if not hasattr(self, "_cached_full_pdf_label"):
-            self._cached_full_pdf_label = str(self.full_pdf_label)
+        if not download_label:
+            download_label = str(self.download_label) or word("Download")
+
+        if not send_label:
+            send_label = str(self.send_label) or word("Send")
 
         if zip_format is None:
             zip_format = format
@@ -2123,7 +2137,7 @@ class ALDocumentBundle(DAList):
         # Add a zip file row if included
         if include_zip and bundled_zip:
             if not zip_label:
-                zip_label = self._cached_zip_label
+                zip_label = str(self.zip_label)
             filename_root = os.path.splitext(str(self.filename))[0]
             zip_button = action_button_html(
                 bundled_zip.url_for(
@@ -2142,7 +2156,7 @@ class ALDocumentBundle(DAList):
 
         if include_full_pdf and bundled_pdf:
             if not full_pdf_label:
-                full_pdf_label = self._cached_full_pdf_label
+                full_pdf_label = str(self.full_pdf_label)
             filename_root = os.path.splitext(str(self.filename))[0]
             full_pdf_button = action_button_html(
                 bundled_pdf.url_for(
@@ -2239,12 +2253,17 @@ class ALDocumentBundle(DAList):
         return html
 
     def send_email_table_row(
-        self, key: str = "final", send_label: str = "Send", send_icon: str = "envelope"
+        self,
+        key: str = "final",
+        send_label: Optional[str] = None,
+        send_icon: str = "envelope",
     ) -> str:
         """
         Generate HTML doc table row for an input box and button that allows
         someone to send the bundle to the specified email address.
 
+        This should normally only be called by download_list_html.
+
         Args:
             key (str): A key used to identify which version of the ALDocument to send. Defaults to "final".
             send_label (str): Label for the 'send' button. Default is "Send".
@@ -2253,14 +2272,12 @@ class ALDocumentBundle(DAList):
         Returns:
             str: The generated HTML string for the table row.
         """
+        if not send_label:
+            send_label = str(self.send_label) or word("Send")
+
         if not self.has_enabled_documents():
             return ""  # Don't let people email an empty set of documents
-        if not hasattr(self, "_cached_get_email_copy"):
-            self._cached_get_email_copy = str(self.get_email_copy)
-        if not hasattr(self, "_cached_include_editable_documents"):
-            self._cached_include_editable_documents = str(
-                self.include_editable_documents
-            )
+
         name = html_safe_str(self.instanceName) + random_suffix()
         al_wants_editable_input_id = "_ignore_al_wants_editable_" + name
         al_email_input_id = "_ignore_al_doc_email_" + name
@@ -2298,7 +2315,7 @@ class ALDocumentBundle(DAList):
         email: str,
         editable: Optional[bool] = None,
         template_name: str = "",
-        label: str = "Send",
+        label: Optional[str] = None,
         icon: str = "envelope",
         color: str = "primary",
         key: str = "final",
@@ -2322,10 +2339,11 @@ class ALDocumentBundle(DAList):
         Returns:
             str: The generated HTML string for the button.
         """
+        if label is None:
+            label = str(self.send_label) or word("Send")
+
         if not self.has_enabled_documents():
             return ""  # Don't let people email an empty set of documents
-        if not hasattr(self, "_cached_get_email_copy"):
-            self._cached_get_email_copy = str(self.get_email_copy)
         name = html_safe_str(self.instanceName) + random_suffix()
         al_send_button_id = "al_send_email_to_button_" + name
 
@@ -2392,12 +2410,6 @@ class ALDocumentBundle(DAList):
         """
         if not self.has_enabled_documents():
             return ""  # Don't let people email an empty set of documents
-        if not hasattr(self, "_cached_get_email_copy"):
-            self._cached_get_email_copy = str(self.get_email_copy)
-        if not hasattr(self, "_cached_include_editable_documents"):
-            self._cached_include_editable_documents = str(
-                self.include_editable_documents
-            )
 
         if isinstance(preferred_formats, str):
             preferred_formats = [preferred_formats]
@@ -2431,7 +2443,7 @@ class ALDocumentBundle(DAList):
         # Container of whole email section with header
         return_str = f"""
   <fieldset class="al_send_bundle al_send_section_alone {html_safe_str(self.instanceName)}" id="al_send_bundle_{name}" name="al_send_bundle_{name}">
-    <legend class="h4 al_doc_email_header">{self._cached_get_email_copy}</legend> 
+    <legend class="h4 al_doc_email_header">{str(self.get_email_copy)}</legend> 
     """
         # "Editable" checkbox
         if (
@@ -2444,7 +2456,7 @@ class ALDocumentBundle(DAList):
     <div class="form-check-container">
       <div class="form-check">
         <input class="form-check-input al_wants_editable" type="checkbox" id="{al_wants_editable_input_id}">
-        <label class="al_wants_editable form-check-label" for="{al_wants_editable_input_id}">{self._cached_include_editable_documents}
+        <label class="al_wants_editable form-check-label" for="{al_wants_editable_input_id}">{str(self.include_editable_documents)}
         </label>
       </div>
     </div>
@@ -2863,10 +2875,11 @@ class ALExhibitList(DAList):
 
     Attributes:
         maximum_size (int): The maximum allowed size in bytes of the entire document.
+        maximum_size_per_doc (int): The maximum allowed size in bytes per document in the list
         auto_label (bool): If True, automatically numbers exhibits for cover page and table of contents. Defaults to True.
         auto_labeler (Callable): An optional function or lambda to transform the exhibit's index to a label.
                                  Uses A..Z labels by default.
-        auto_ocr (bool): If True, automatically starts OCR processing for uploaded exhibits. Defaults to True.
+        auto_ocr (bool): If True, automatically starts OCR processing for uploaded exhibits. Defaults to False.
     """
 
     def init(self, *pargs, **kwargs) -> None:
@@ -3061,6 +3074,7 @@ class ALExhibitDocument(ALDocument):
     auto_ocr: bool
     bates_prefix: str
     maximum_size: int
+    maximum_size_per_doc: int
     suffix_to_append: str
     exhibits: ALExhibitList
     table_of_contents: DAFile
@@ -3085,8 +3099,13 @@ class ALExhibitDocument(ALDocument):
         else:
             self.include_exhibit_cover_pages = True
             self.exhibits.include_exhibit_cover_pages = True
+        if hasattr(self, "maximum_size_per_doc"):
+            self.exhibits.maximum_size_per_doc = self.maximum_size_per_doc
         if hasattr(self, "maximum_size"):
             self.exhibits.maximum_size = self.maximum_size
+            if not hasattr(self, "maximum_size_per_doc"):
+                self.maximum_size_per_doc = self.maximum_size
+                self.exhibits.maximum_size_per_doc = self.maximum_size
         if hasattr(self, "include_table_of_contents"):
             self.exhibits.include_table_of_contents = self.include_table_of_contents
         else:

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

@@ -28,16 +28,14 @@ from docassemble.base.util import (
     states_list,
     subdivision_type,
     their,
-    this_thread,
     url_action,
     validation_error,
-    value,
     word,
     your,
     log,
     value,
 )
-from docassemble.ALToolbox.misc import fa_icon
+import docassemble.base.functions
 import random
 import re
 import pycountry
@@ -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 [
@@ -374,7 +372,7 @@ class ALAddress(Address):
         Returns:
             str: The one-line formatted address.
         """
-        if this_thread.evaluation_context == "docx":
+        if docassemble.base.functions.this_thread.evaluation_context == "docx":
             line_breaker = '</w:t><w:br/><w:t xml:space="preserve">'
         else:
             line_breaker = " [NEWLINE] "
@@ -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:
         """
@@ -1701,7 +1702,7 @@ class ALIndividual(Individual):
         Returns:
             str: The formatted address block.
         """
-        if this_thread.evaluation_context == "docx":
+        if docassemble.base.functions.this_thread.evaluation_context == "docx":
             if isinstance(self.address, ALAddress):
                 return self.address.block(
                     language=language,
@@ -1778,7 +1779,7 @@ class ALIndividual(Individual):
             else:
                 pronouns = self.pronouns
 
-        if self == this_thread.global_vars.user:
+        if self == docassemble.base.functions.this_thread.global_vars.user:
             output = word("you", **kwargs)
         elif hasattr(self, "pronouns") and self.pronouns:
             pronouns_to_use = []
@@ -1876,7 +1877,7 @@ class ALIndividual(Individual):
         else:
             default = self.name_full()
 
-        if self == this_thread.global_vars.user and (
+        if self == docassemble.base.functions.this_thread.global_vars.user and (
             "thirdperson" not in kwargs or not kwargs["thirdperson"]
         ):
             output = your(target, **kwargs)
@@ -1963,7 +1964,7 @@ class ALIndividual(Individual):
             else:
                 pronouns = self.pronouns
 
-        if self == this_thread.global_vars.user:
+        if self == docassemble.base.functions.this_thread.global_vars.user:
             output = word("you", **kwargs)
         elif hasattr(self, "pronouns") and self.pronouns:
             pronouns_to_use = []
@@ -2042,7 +2043,7 @@ class ALIndividual(Individual):
             if person == "2p":
                 return word("yourselves")
 
-        if self == this_thread.global_vars.user:
+        if self == docassemble.base.functions.this_thread.global_vars.user:
             output = word("yourself", **kwargs)
 
         if "default" in kwargs:
@@ -2058,7 +2059,7 @@ class ALIndividual(Individual):
         else:
             pronouns = None
 
-        if self == this_thread.global_vars.user:
+        if self == docassemble.base.functions.this_thread.global_vars.user:
             output = word("yourself", **kwargs)
         elif hasattr(self, "pronouns") and self.pronouns:
             pronouns_to_use = []
@@ -2188,10 +2189,10 @@ class ALIndividual(Individual):
 
         In order, it will try to use:
 
-        * just the first name
-        * the first name and suffix
-        * the first and middle name
-        * the first and last name
+        * just the preferred name (if set) or first name
+        * the preferred/first name and suffix
+        * the preferred/first and middle name
+        * the preferred/first and last name
         * the full name
         * the default value, e.g., "the minor", if provided
         * the full name
@@ -2221,33 +2222,42 @@ class ALIndividual(Individual):
         if unique_names is None:
             unique_names = []
 
+        # Use preferred_name.first if it exists and is non-empty, otherwise use name.first
+        first_name_to_use = self.name.first
+        if (
+            hasattr(self, "preferred_name")
+            and hasattr(self.preferred_name, "first")
+            and self.preferred_name.first
+        ):
+            first_name_to_use = self.preferred_name.first
+
         first_name_candidates = [person.familiar() for person in unique_names]
-        if self.name.first not in first_name_candidates:
-            return self.name.first
+        if first_name_to_use not in first_name_candidates:
+            return first_name_to_use
 
         first_name_and_suffix_candidates = [
             f"{person.familiar()} {person.name.suffix if hasattr(person.name, 'suffix') else ''}"
             for person in unique_names
         ]
         if (
-            f"{self.name.first} {self.name.suffix if hasattr(self.name, 'suffix') else ''}"
+            f"{first_name_to_use} {self.name.suffix if hasattr(self.name, 'suffix') else ''}"
             not in first_name_and_suffix_candidates
         ):
             if hasattr(self.name, "suffix") and self.name.suffix:
-                return f"{self.name.first} {self.name.suffix if hasattr(self.name, 'suffix') else ''}"
-            return self.name.first
+                return f"{first_name_to_use} {self.name.suffix if hasattr(self.name, 'suffix') else ''}"
+            return first_name_to_use
 
         first_and_middle_candidates = [
             f"{person.name.first} {person.name.middle if hasattr(person.name, 'middle') and person.name.middle else ''}"
             for person in unique_names
         ]
         if (
-            f"{self.name.first} {self.name.middle if hasattr(self.name, 'middle') and self.name.middle else ''}"
+            f"{first_name_to_use} {self.name.middle if hasattr(self.name, 'middle') and self.name.middle else ''}"
             not in first_and_middle_candidates
         ):
             if hasattr(self.name, "middle") and self.name.middle:
-                return f"{self.name.first} {self.name.middle}"
-            return self.name.first
+                return f"{first_name_to_use} {self.name.middle}"
+            return first_name_to_use
 
         first_and_last_candidates = [
             (

{docassemble_assemblyline-4.2.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)