docassemble.AssemblyLine 2.25.0__tar.gz → 2.27.0__tar.gz

{docassemble.AssemblyLine-2.25.0/docassemble.AssemblyLine.egg-info → docassemble.AssemblyLine-2.27.0}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.1
 Name: docassemble.AssemblyLine
-Version: 2.25.0
+Version: 2.27.0
 Home-page: https://courtformsonline.org
 Author: Suffolk Legal Innovation and Technology Lab
 Author-email: qsteenhuis@suffolk.edu
 License: The MIT License (MIT)
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: docassemble.ALToolbox>=0.8.1
+Requires-Dist: docassemble.ALToolbox>=0.8.3
 Requires-Dist: docassemble.GithubFeedbackForm>=0.2.1
 
 # Suffolk LIT Lab Document Assembly Line

docassemble.AssemblyLine-2.27.0/docassemble/AssemblyLine/__init__.py

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

{docassemble.AssemblyLine-2.25.0 → docassemble.AssemblyLine-2.27.0}/docassemble/AssemblyLine/al_courts.py

@@ -4,6 +4,7 @@ Package for a very simple / MVP list of courts that is mostly signature compatib
 import os
 from typing import Any, Dict, List, Optional, Union, Set
 import pandas as pd
+import docassemble.base.functions
 from docassemble.base.util import (
     path_and_mimetype,
     Address,
@@ -205,6 +206,7 @@ class ALCourtLoader(DAObject):
 
     def init(self, *pargs, **kwargs):
         super().init(*pargs, **kwargs)
+        self.package = docassemble.base.functions.this_thread.current_question.package
         if not hasattr(self, "filename"):
             self.filename = (
                 self.file_name
@@ -416,11 +418,15 @@ class ALCourtLoader(DAObject):
         """
         if not hasattr(self, "filename") and hasattr(self, "file_name"):
             self.filename = self.file_name
-        if "/" in self.filename:
-            to_load = path_and_mimetype(self.filename)[0]
+        if ":" not in self.filename and hasattr(self, "package"):
+            load_path = self.package + ":"
+            if "/" not in str(self.filename):
+                load_path += "data/sources/"
+            load_path += str(self.filename)
         else:
-            to_load = path_and_mimetype(os.path.join("data/sources", self.filename))[0]
+            load_path = str(self.filename)
 
+        to_load = path_and_mimetype(load_path)[0]
         if self.filename.lower().endswith(".xlsx"):
             df = pd.read_excel(to_load)
         elif self.filename.lower().endswith(".csv"):

{docassemble.AssemblyLine-2.25.0 → docassemble.AssemblyLine-2.27.0}/docassemble/AssemblyLine/al_document.py

@@ -3,6 +3,8 @@ import os
 import mimetypes
 from typing import Any, Dict, List, Union, Callable, Optional
 from docassemble.base.util import (
+    Address,
+    LatitudeLongitude,
     log,
     DADict,
     DAList,
@@ -116,14 +118,22 @@ def safeattr(object: Any, key: str) -> str:
 
     Returns:
         str: The retrieved value or an empty string if not found or if an error occurred.
+
+    Note:
+        The `location` attribute of an Address object or any LatitudeLongitude attribute of a DAObject is always skipped.
     """
     try:
         if isinstance(object, dict) or isinstance(object, DADict):
             return str(object.get(key, ""))
         elif isinstance(object, DAObject):
             # `location` is not an attribute people usually want shown in the table of people's attributes
-            if key == "location":
+            if key == "location" and isinstance(object, Address):
                 return ""
+            elif key == "location" and isinstance(object, DAObject):
+                if hasattr(object, "location") and isinstance(
+                    object.location, LatitudeLongitude
+                ):
+                    return ""
             return str(getattr(object, key))
         else:
             return ""
@@ -512,6 +522,9 @@ class ALAddendumField(DAObject):
 
         Returns:
             Optional[list]: A list of columns or None if no meaningful columns can be determined.
+
+        Note:
+            The "location" attribute of an Address object is always skipped in the column list.
         """
         if not skip_attributes:
             skip_attributes = {"complete"}
@@ -2078,7 +2091,8 @@ class ALDocumentBundle(DAList):
             show_editable_checkbox (bool, optional): Flag indicating if the checkbox
                 for deciding the inclusion of an editable (Word) copy should be displayed.
                 Defaults to True.
-            template_name (str, optional): The name of the template to be used. Defaults to an empty string.
+            template_name (str, optional): Name of the template variable that is used to fill
+                the email contents. By default, the `x.send_email_template` template will be used.
 
         Returns:
             str: The generated HTML string for the input box and button.

{docassemble.AssemblyLine-2.25.0 → docassemble.AssemblyLine-2.27.0}/docassemble/AssemblyLine/al_general.py

@@ -24,6 +24,7 @@ from docassemble.base.util import (
     name_suffix,
     phone_number_formatted,
     phone_number_is_valid,
+    showifdef,
     state_name,
     states_list,
     subdivision_type,
@@ -101,6 +102,7 @@ class ALAddress(Address):
         state (str): The state where the person lives.
         zip (str): The zip code where the person lives.
         country (str): The country where the person lives.
+        impounded (Optional[bool]): Whether the address is impounded.
     """
 
     def address_fields(
@@ -111,6 +113,7 @@ class ALAddress(Address):
         show_county: bool = False,
         show_if: Union[str, Dict[str, str], None] = None,
         allow_no_address: bool = False,
+        ask_if_impounded: Optional[bool] = False,
     ) -> List[Dict[str, Any]]:
         """
         Return a YAML structure representing the list of fields for the object's address.
@@ -129,6 +132,7 @@ class ALAddress(Address):
             show_county (bool): Whether to display the county field. Defaults to False.
             show_if (Union[str, Dict[str, str], None]): Condition to display each field. Defaults to None.
             allow_no_address (bool): Allow users to specify they don't have an address. Defaults to False.
+            ask_if_impounded (Optional[bool]): Whether to ask if the address is impounded. Defaults to False.
 
         Returns:
             list: A list of YAML structure representing address fields.
@@ -147,6 +151,10 @@ class ALAddress(Address):
         # differs from the server's country.
         if country_code and country_code != get_country() and not show_country:
             self.country = country_code
+        # Priority order for country: already answered country, passed in country_code, then get_country
+        prev_selected_country = showifdef(self.attr_name("country"), None, prior=True)
+        if prev_selected_country:
+            country_code = prev_selected_country
         if not country_code:
             country_code = get_country()
         if allow_no_address:
@@ -190,7 +198,7 @@ class ALAddress(Address):
 
         fields.append({"label": str(self.city_label), "field": self.attr_name("city")})
 
-        if country_code:
+        if country_code and not show_country:
             fields.append(
                 {
                     "label": str(self.state_label),
@@ -199,15 +207,15 @@ class ALAddress(Address):
                     "default": default_state if default_state else "",
                 }
             )
-        else:  # not showing country and not showing country code
+        else:  # when you are allowed to change country
             fields.append(
                 {
-                    "label": str(self.state_label),
+                    "label": str(self.state_or_province_label),
                     "field": self.attr_name("state"),
                     "default": default_state if default_state else "",
                 }
             )
-        if country_code == "US":
+        if country_code == "US" and not show_country:
             fields.append(
                 {
                     "label": str(self.zip_label),
@@ -252,6 +260,15 @@ class ALAddress(Address):
                 for field in fields:
                     field["show if"] = show_if
 
+        if ask_if_impounded:
+            fields.append(
+                {
+                    "label": str(self.impounded_label),
+                    "field": self.attr_name("impounded"),
+                    "datatype": "yesno",
+                }
+            )
+
         return fields
 
     def formatted_unit(
@@ -322,6 +339,7 @@ class ALAddress(Address):
         show_country: Optional[bool] = None,
         bare: bool = False,
         long_state: bool = False,
+        show_impounded: bool = False,
     ) -> str:
         """Returns a one-line formatted address, primarily for geocoding.
 
@@ -332,6 +350,7 @@ class ALAddress(Address):
                 If None, decides based on the country attribute.
             bare (bool): If True, excludes certain formatting elements. Defaults to False.
             long_state (bool): If True, uses the full state name. Defaults to False.
+            show_impounded (bool): If True, shows the address even if impounded. Defaults to False.
 
         Returns:
             str: The one-line formatted address.
@@ -341,6 +360,8 @@ class ALAddress(Address):
         else:
             line_breaker = " [NEWLINE] "
 
+        if not show_impounded and (hasattr(self, "impounded") and self.impounded):
+            return str(self.impounded_output_label)
         if (
             hasattr(self, "has_no_address")
             and self.has_no_address
@@ -417,16 +438,24 @@ class ALAddress(Address):
             output += line_breaker + country_name(self._get_country())
         return output
 
-    def line_one(self, language: Optional[str] = None, bare: bool = False) -> str:
+    def line_one(
+        self,
+        language: Optional[str] = None,
+        bare: bool = False,
+        show_impounded: bool = False,
+    ) -> str:
         """Returns the first line of the address, including the unit number if it exists.
 
         Args:
             language (str, optional): Language for the address format.
             bare (bool): If True, excludes certain formatting elements. Defaults to False.
+            show_impounded (bool): If True, shows the address even if impounded. Defaults to False.
 
         Returns:
             str: The first line of the address.
         """
+        if not show_impounded and (hasattr(self, "impounded") and self.impounded):
+            return str(self.impounded_output_label)
         if (
             hasattr(self, "has_no_address")
             and self.has_no_address
@@ -448,16 +477,24 @@ class ALAddress(Address):
             output += ", " + the_unit
         return output
 
-    def line_two(self, language: Optional[str] = None, long_state: bool = False) -> str:
+    def line_two(
+        self,
+        language: Optional[str] = None,
+        long_state: bool = False,
+        show_impounded: bool = False,
+    ) -> str:
         """Returns the second line of the address, including city, state, and postal code.
 
         Args:
             language (str, optional): Language for the address format.
             long_state (bool): If True, uses the full state name. Defaults to False.
+            show_impounded (bool): If True, shows the address even if impounded. Defaults to False.
 
         Returns:
             str: The second line of the address.
         """
+        if not show_impounded and (hasattr(self, "impounded") and self.impounded):
+            return str(self.impounded_output_label)
         output = ""
         # if hasattr(self, 'sublocality') and self.sublocality:
         #    output += str(self.sublocality) + ", "
@@ -483,21 +520,25 @@ class ALAddress(Address):
         show_country: Optional[bool] = None,
         bare: bool = False,
         long_state: bool = False,
+        show_impounded: bool = False,
     ) -> str:
         """Returns a one-line formatted address.
 
         Args:
             include_unit (bool): If True, includes the unit in the formatted address. Defaults to True.
-            omit_default_country (bool): If True, omits the default country from the formatted address. Defaults to True.
+            omit_default_country (bool): If True, doesn't show the Docassemble default country in the formatted address. Defaults to True.
             language (str, optional): Language for the address format.
             show_country (bool, optional): If True, includes the country in the formatted address.
                 If None, decides based on the country attribute.
             bare (bool): If True, excludes certain formatting elements. Defaults to False.
             long_state (bool): If True, uses the full state name. Defaults to False.
+            show_impounded (bool): If True, shows the address even if impounded. Defaults to False.
 
         Returns:
             str: The one-line formatted address.
         """
+        if not show_impounded and (hasattr(self, "impounded") and self.impounded):
+            return str(self.impounded_output_label)
         if (
             hasattr(self, "has_no_address")
             and self.has_no_address
@@ -557,9 +598,11 @@ class ALAddress(Address):
         be a standard Address object, not an ALAddress object. If geocoding fails, it returns
         the version of the address as entered by the user.
 
+        Warning: currently the normalized address will not be redacted if the address is impounded.
+
         Returns:
             Union[Address, "ALAddress"]: Normalized address if geocoding is successful, otherwise
-            the original address.
+                the original address.
         """
         try:
             self.geocode()
@@ -791,49 +834,54 @@ class ALIndividual(Individual):
         else:
             return ""
 
-    def phone_numbers(self, country: Optional[str] = None) -> str:
+    def phone_numbers(
+        self, country: Optional[str] = None, show_impounded: bool = False
+    ) -> str:
         """Fetches and formats the phone numbers of the individual.
 
         Args:
             country (str, optional): The country for phone number formatting. Defaults to the country of the docassemble server.
+            show_impounded (bool): If True, shows the phone numbers even if impounded. Defaults to False.
 
         Returns:
             str: Formatted string of phone numbers.
         """
         nums = []
         if hasattr(self, "mobile_number") and self.mobile_number:
+            fmt_number = None
             try:
-                nums.append(
-                    {
-                        phone_number_formatted(
-                            self.mobile_number, country=country
-                        ): "cell"
-                    }
-                )
+                fmt_number = phone_number_formatted(self.mobile_number, country=country)
             except:
+                fmt_number = None
+            if fmt_number:
+                nums.append({fmt_number: "cell"})
+            else:
                 nums.append({self.mobile_number: "cell"})
         if hasattr(self, "phone_number") and self.phone_number:
+            fmt_number = None
             try:
-                nums.append(
-                    {
-                        phone_number_formatted(
-                            self.phone_number, country=country
-                        ): "other"
-                    }
-                )
+                fmt_number = phone_number_formatted(self.phone_number, country=country)
             except:
+                fmt_number = None
+            if fmt_number:
+                nums.append({fmt_number: "other"})
+            else:
                 nums.append({self.phone_number: "other"})
-        if len(nums) > 1:
+        if len(nums) < 1:
+            return ""
+        # Check for impounded phone number
+        elif not show_impounded and (
+            hasattr(self, "phone_impounded") and self.phone_impounded
+        ):
+            return str(self.impounded_phone_output_label)
+        elif len(nums) > 1:
             return comma_list(
-                [
-                    list(num.keys())[0] + " (" + list(num.values())[0] + ")"
-                    for num in nums
-                ]
+                [f"{list(num.keys())[0]} ({list(num.values())[0]})" for num in nums]
             )
         elif len(nums):
             return list(nums[0].keys())[0]
-        else:
-            return ""
+
+        assert False  # We should never get here, no default return is necessary
 
     def contact_methods(self) -> str:
         """Generates a formatted string of all provided contact methods.
@@ -843,15 +891,17 @@ class ALIndividual(Individual):
         """
         methods = []
         if self.phone_numbers():
-            methods.append({self.phone_numbers(): word("by phone at ")})
+            methods.append({self.phone_numbers(): str(self.phone_number_contact_label)})
         if hasattr(self, "email") and self.email:
-            methods.append({self.email: word("by email at ")})
+            methods.append({self.email: str(self.email_contact_label)})
         if hasattr(self, "other_contact_method") and self.other_contact_method:
-            methods.append({self.other_contact_method: "by "})
+            methods.append(
+                {self.other_contact_method: str(self.other_contact_method_label)}
+            )
 
         return comma_and_list(
             [
-                list(method.values())[0] + list(method.keys())[0]
+                list(method.values())[0] + " " + list(method.keys())[0]
                 for method in methods
                 if len(method)
             ],
@@ -900,6 +950,8 @@ class ALIndividual(Individual):
         self,
         person_or_business: str = "person",
         show_suffix: bool = True,
+        show_title: bool = False,
+        title_options: Optional[List[str]] = None,
         show_if: Union[str, Dict[str, str], None] = None,
     ) -> List[Dict[str, str]]:
         """
@@ -911,6 +963,10 @@ class ALIndividual(Individual):
                 Default is "person".
             show_suffix (bool, optional): Determines if the name's suffix (e.g., Jr., Sr.) should be included in the prompts.
                 Default is True.
+            show_title: (bool, optional): Determines if the name's title (e.g., Mr., Ms.) should be included in the prompts.
+                Default is False.
+            title_options (List[str], optional): A list of title options to use in the prompts. Default is defined as a list
+                of common titles in English-speaking countries.
             show_if (Union[str, Dict[str, str], None], optional): Condition to determine which fields to show.
                 It can be a string, a dictionary with conditions, or None. Default is None.
 
@@ -921,6 +977,29 @@ class ALIndividual(Individual):
             If `person_or_business` is set to None, the method will offer the end user a choice
             and will set appropriate "show ifs" conditions for each type.
         """
+        if not title_options:
+            title_options = [
+                "Mr.",
+                "Mrs.",
+                "Miss",
+                "Ms.",
+                "Mx.",
+                "Dr.",
+                "Prof.",
+                "Hon.",
+                "Rev.",
+                "Sir",
+                "Lord",
+                "Lady",
+                "Dame",
+                "Maj.",
+                "Gen.",
+                "Capt.",
+                "Lt.",
+                "Sgt.",
+                "Fr.",
+                "Sr.",
+            ]
         if person_or_business == "person":
             fields = [
                 {
@@ -946,6 +1025,16 @@ class ALIndividual(Individual):
                         "required": False,
                     }
                 )
+            if show_title:
+                fields.insert(
+                    0,
+                    {
+                        "label": str(self.name_title_label),
+                        "field": self.attr_name("name.title"),
+                        "choices": title_options,
+                        "required": False,
+                    },
+                )
             if show_if:
                 for field in fields:
                     field["show if"] = show_if
@@ -1033,6 +1122,7 @@ class ALIndividual(Individual):
         show_county: bool = False,
         show_if: Union[str, Dict[str, str], None] = None,
         allow_no_address: bool = False,
+        ask_if_impounded: bool = False,
     ) -> List[Dict[str, str]]:
         """
         Generate field prompts for capturing an address.
@@ -1044,6 +1134,7 @@ class ALIndividual(Individual):
             show_county (bool): Whether to display the county field. Defaults to False.
             show_if (Union[str, Dict[str, str], None]): Condition to determine if the field should be shown. Defaults to None.
             allow_no_address (bool): Whether to permit entries with no address. Defaults to False.
+            ask_if_impounded (bool): Whether to ask if the address is impounded. Defaults to False.
 
         Returns:
             List[Dict[str, str]]: A list of dictionaries with field prompts for addresses.
@@ -1057,6 +1148,7 @@ class ALIndividual(Individual):
             show_county=show_county,
             show_if=show_if,
             allow_no_address=allow_no_address,
+            ask_if_impounded=ask_if_impounded,
         )
 
     def gender_fields(
@@ -1323,7 +1415,12 @@ class ALIndividual(Individual):
         return f"{self.name.first[:1]}{self.name.middle[:1] if hasattr(self.name,'middle') else ''}{self.name.last[:1] if hasattr(self.name, 'last') else ''}"
 
     def address_block(
-        self, language=None, international=False, show_country=False, bare=False
+        self,
+        language=None,
+        international=False,
+        show_country=False,
+        bare=False,
+        show_impounded=False,
     ) -> str:
         """
         Generate a formatted address block for mailings.
@@ -1333,6 +1430,7 @@ class ALIndividual(Individual):
             international (bool): If True, format for international mailing. Defaults to False.
             show_country (bool): If True, include the country in the address. Defaults to False.
             bare (bool): If True, produce the address without additional formatting. Defaults to False.
+            show_impounded (bool): If True, show the address even if it is impounded. Defaults to False.
 
         Returns:
             str: The formatted address block.
@@ -1345,6 +1443,8 @@ class ALIndividual(Individual):
                     language=language,
                     international=international,
                     show_country=show_country,
+                    bare=bare,
+                    show_impounded=show_impounded,
                 )
             )
         return (
@@ -1356,6 +1456,7 @@ class ALIndividual(Individual):
                 international=international,
                 show_country=show_country,
                 bare=bare,
+                show_impounded=show_impounded,
             )
         )
 

{docassemble.AssemblyLine-2.25.0 → docassemble.AssemblyLine-2.27.0}/docassemble/AssemblyLine/data/questions/al_code.yml

@@ -53,7 +53,7 @@ code: |
   # email_to_use = "massaccess@suffolk.edu"
 
   if task_not_yet_performed('send email'):
-    log("Court email is ".format(court_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)

{docassemble.AssemblyLine-2.25.0 → docassemble.AssemblyLine-2.27.0}/docassemble/AssemblyLine/data/questions/al_visual.yml

@@ -366,10 +366,18 @@ content: |
       MAIN_METADATA = next(iter(interview_metadata.values())) 
     %>
   % else:
-    <% MAIN_METADATA = {} %>
+    <% MAIN_METADATA = all_variables(special='metadata') %>
   % endif
-  % if MAIN_METADATA.get("original_form") and not MAIN_METADATA.get("original_form", "").strip() == "None" and MAIN_METADATA.get("original_form").startswith("http"):
-  [View the original version of this form](${ MAIN_METADATA.get("original_form") }).
+  <% ORIGINAL_FORMS = MAIN_METADATA.get("original_form", []) if isinstance(MAIN_METADATA.get("original_form"), list) else ([MAIN_METADATA.get("original_form", "")] if MAIN_METADATA.get("original_form") else []) %>
+
+  % if len(ORIGINAL_FORMS) > 1:
+  View the original version of this form at the links below:
+
+  % for url in [url for url in ORIGINAL_FORMS if url.strip() != "None" and url.startswith("http")]:
+  * [${ url }](${ url })
+  % endfor
+  % elif len(ORIGINAL_FORMS) == 1:
+  [View the original version of this form](${ ORIGINAL_FORMS[0] }).
   % endif
   
   % if package_updated_on:
@@ -426,8 +434,10 @@ continue button field: al_exit_logout_confirmation
 metadata:
   error action: al_custom_error_action
 ---
+# Only necessary to ignore playground "undefined names" warning
 objects:
   - MAIN_METADATA: DAEmpty()
+  - ORIGINAL_FORMS: DAEmpty()
 ---
 id: custom error action
 event: al_custom_error_action
@@ -445,8 +455,9 @@ subquestion: |
       MAIN_METADATA = next(iter(interview_metadata.values())) 
     %>
   % else:
-    <% MAIN_METADATA = {} %>
+    <% MAIN_METADATA = all_variables(special='metadata') %>
   % endif
+  <% ORIGINAL_FORMS = MAIN_METADATA.get("original_form", []) if isinstance(MAIN_METADATA.get("original_form"), list) else ([MAIN_METADATA.get("original_form", "")] if MAIN_METADATA.get("original_form") else []) %>
 
   We ran into an error when we tried to load this screen.
 
@@ -459,8 +470,13 @@ subquestion: |
   % if al_enable_incomplete_downloads:
   * Try to [download your work in progress](${ url_action("al_error_action_download_screen") })
   % endif
-  % if MAIN_METADATA.get("original_form") and not MAIN_METADATA.get("original_form", "").strip() == "None":
-  * [Download a blank "${ all_variables(special='metadata').get("title", "").strip() }"](${ MAIN_METADATA.get("original_form") } )
+  % if len(ORIGINAL_FORMS) > 1:
+  * Download a blank "${ all_variables(special='metadata').get("title", "").strip() }":
+  % for url in ORIGINAL_FORMS:
+      * [${ url }](${ url } )
+  % endfor
+  % elif len(ORIGINAL_FORMS) == 1:
+  * [Download a blank "${ all_variables(special='metadata').get("title", "").strip() }"]( ${ ORIGINAL_FORMS[0] })
   % endif
   * Visit the [${ AL_ORGANIZATION_TITLE } home page](${ AL_ORGANIZATION_HOMEPAGE }) and try another interview
   % if al_show_email_to_user_on_errors and get_config("error notification email"):