docassemble.AssemblyLine 2.28.1__tar.gz → 3.0.0__tar.gz

{docassemble_assemblyline-2.28.1/docassemble.AssemblyLine.egg-info → docassemble_assemblyline-3.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: docassemble.AssemblyLine
-Version: 2.28.1
+Version: 3.0.0
 Home-page: https://courtformsonline.org
 Author: Suffolk Legal Innovation and Technology Lab
 Author-email: qsteenhuis@suffolk.edu

docassemble_assemblyline-3.0.0/docassemble/AssemblyLine/__init__.py

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

{docassemble_assemblyline-2.28.1 → docassemble_assemblyline-3.0.0}/docassemble/AssemblyLine/al_document.py

@@ -282,8 +282,10 @@ class ALAddendumField(DAObject):
             Any: The portion of the variable exceeding the content safe for display, considered as overflow.
         """
         # Handle a Boolean overflow first
-        if isinstance(self.overflow_trigger, bool) and self.overflow_trigger:
-            return self.value()
+        if isinstance(self.overflow_trigger, bool):
+            if self.overflow_trigger:
+                return self.value()
+            return ""
 
         # 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()
@@ -320,7 +322,11 @@ class ALAddendumField(DAObject):
             return value_to_process[overflow_start:].lstrip()
 
         # Do not subtract length of overflow message if this is a list of objects instead of a string
-        return original_value[self.overflow_trigger :]
+        elif isinstance(safe_text, (list, DAList)):
+            return original_value[self.overflow_trigger :]
+        raise ValueError(
+            f"Attempted ALAddendum overflow for {self.field_name } which is of type {type(safe_text)}. Overflow is for lists and strings only."
+        )
 
     def max_lines(self, input_width: int = 80) -> int:
         """
@@ -524,10 +530,11 @@ class ALAddendumField(DAObject):
                 return value.rstrip()
 
         # If the overflow item is a list or DAList
-        if isinstance(value, list) or isinstance(value, DAList):
+        if isinstance(value, (list, DAList)):
             return value[: self.overflow_trigger]
         else:
             # We can't slice objects that are not lists or strings
+            # TODO: is it correct to return the whole object here?
             return value
 
     def value_if_defined(self) -> Any:
@@ -774,13 +781,13 @@ class ALAddendumFieldDict(DAOrderedDict):
         self[the_key].field_name = the_key
         return newobj
 
-    def from_list(self, data) -> None:
+    def from_list(self, data: List[Dict]) -> None:
         """
         Populate the dictionary using a list of field data.
 
         Args:
-            data (list): List of dictionaries containing field data with keys "field_name"
-                         and "overflow_trigger".
+            data (list): List of dictionaries containing ield data with keys "field_name"
+                and "overflow_trigger".
         """
         for entry in data:
             new_field = self.initializeObject(entry["field_name"], ALAddendumField)
@@ -788,13 +795,13 @@ class ALAddendumFieldDict(DAOrderedDict):
             new_field.overflow_trigger = entry["overflow_trigger"]
         return
 
-    def defined_fields(self, style="overflow_only") -> list:
+    def defined_fields(self, style: str = "overflow_only") -> list:
         """
         Fetch a list of fields that are defined.
 
         Args:
             style (str, optional): If set to "overflow_only", only the fields with overflow values
-                                   will be returned. Defaults to "overflow_only".
+                will be returned. Defaults to "overflow_only".
 
         Returns:
             list: List of defined fields based on the specified style.

{docassemble_assemblyline-2.28.1 → docassemble_assemblyline-3.0.0}/docassemble/AssemblyLine/al_general.py

@@ -115,6 +115,7 @@ class ALAddress(Address):
         show_if: Union[str, Dict[str, str], None] = None,
         allow_no_address: bool = False,
         ask_if_impounded: Optional[bool] = False,
+        maxlengths: Optional[Dict[str, int]] = None,
     ) -> List[Dict[str, Any]]:
         """
         Return a YAML structure representing the list of fields for the object's address.
@@ -134,9 +135,10 @@ class ALAddress(Address):
             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.
+            maxlengths (Optional[Dict[str, int]]): A dictionary of field names and their maximum lengths. Defaults to None.
 
         Returns:
-            list: A list of YAML structure representing address fields.
+            List[Dict[str, Any]]: A list of dictionaries representing address fields.
 
         Notes:
             - The function will set the `country` attribute of the Address to `country_code` under these
@@ -270,6 +272,11 @@ class ALAddress(Address):
                 }
             )
 
+        if maxlengths:
+            for field in fields:
+                if field["field"] in maxlengths:
+                    field["maxlength"] = maxlengths[field["field"]]
+
         return fields
 
     def formatted_unit(
@@ -743,22 +750,27 @@ class ALPeopleList(DAList):
             comma_string=comma_string,
         )
 
-    def familiar(self) -> str:
+    def familiar(self, **kwargs) -> str:
         """Provide a list of familiar forms of names of individuals.
 
+        Args:
+            **kwargs: Keyword arguments to pass to the familiar method.
         Returns:
             str: Formatted string of familiar names.
         """
-        return comma_and_list([person.name.familiar() for person in self])
+        return comma_and_list([person.familiar(**kwargs) for person in self])
 
-    def familiar_or(self) -> str:
+    def familiar_or(self, **kwargs) -> str:
         """Provide a list of familiar forms of names of individuals separated by 'or'.
 
+        Args:
+            **kwargs: Keyword arguments to pass to the familiar method.
+
         Returns:
             str: Formatted string of familiar names separated by 'or'.
         """
         return comma_and_list(
-            [person.name.familiar() for person in self], and_string=word("or")
+            [person.familiar(**kwargs) for person in self], and_string=word("or")
         )
 
     def short_list(self, limit: int, truncate_string: str = ", et. al.") -> str:
@@ -978,6 +990,7 @@ class ALIndividual(Individual):
         show_title: bool = False,
         title_options: Optional[List[str]] = None,
         show_if: Union[str, Dict[str, str], None] = None,
+        maxlengths: Optional[Dict[str, int]] = None,
     ) -> List[Dict[str, str]]:
         """
         Generates suitable field prompts for a name based on the type of entity (person or business)
@@ -994,6 +1007,7 @@ class ALIndividual(Individual):
                 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.
+            maxlengths (Dict[str, int], optional): A dictionary of field names and their maximum lengths. Default is None.
 
         Returns:
             List[Dict[str, str]]: A list of dictionaries where each dictionary contains field prompt details.
@@ -1137,6 +1151,11 @@ class ALIndividual(Individual):
                     "show if": show_if_business,
                 }
             )
+
+            if maxlengths:
+                for field in fields:
+                    if field["field"] in maxlengths:
+                        field["maxlength"] = maxlengths[field["field"]]
             return fields
 
     def address_fields(
@@ -1148,6 +1167,7 @@ class ALIndividual(Individual):
         show_if: Union[str, Dict[str, str], None] = None,
         allow_no_address: bool = False,
         ask_if_impounded: bool = False,
+        maxlengths: Optional[Dict[str, int]] = None,
     ) -> List[Dict[str, str]]:
         """
         Generate field prompts for capturing an address.
@@ -1160,6 +1180,7 @@ class ALIndividual(Individual):
             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.
+            maxlengths (Dict[str, int], optional): A dictionary of field names and their maximum lengths. Default is None.
 
         Returns:
             List[Dict[str, str]]: A list of dictionaries with field prompts for addresses.
@@ -1174,10 +1195,14 @@ class ALIndividual(Individual):
             show_if=show_if,
             allow_no_address=allow_no_address,
             ask_if_impounded=ask_if_impounded,
+            maxlengths=maxlengths,
         )
 
     def gender_fields(
-        self, show_help=False, show_if: Union[str, Dict[str, str], None] = None
+        self,
+        show_help=False,
+        show_if: Union[str, Dict[str, str], None] = None,
+        maxlengths: Optional[Dict[str, int]] = None,
     ) -> List[Dict[str, str]]:
         """
         Generate fields for capturing gender information, including a
@@ -1186,6 +1211,7 @@ class ALIndividual(Individual):
         Args:
             show_help (bool): Whether to show additional help text. Defaults to False.
             show_if (Union[str, Dict[str, str], None]): Condition to determine if the field should be shown. Defaults to None.
+            maxlengths (Dict[str, int], optional): A dictionary of field names and their maximum lengths. Default is None.
 
         Returns:
             List[Dict[str, str]]: A list of dictionaries with field prompts for gender.
@@ -1217,6 +1243,11 @@ class ALIndividual(Individual):
         if show_if:
             fields[0]["show if"] = show_if
 
+        if maxlengths:
+            for field in fields:
+                if field["field"] in maxlengths:
+                    field["maxlength"] = maxlengths[field["field"]]
+
         return fields
 
     def pronoun_fields(
@@ -1226,6 +1257,7 @@ class ALIndividual(Individual):
         required: bool = False,
         shuffle: bool = False,
         show_unknown: Optional[Union[Literal["guess"], bool]] = "guess",
+        maxlengths: Optional[Dict[str, int]] = None,
     ) -> List[Dict[str, str]]:
         """
         Generate fields for capturing pronoun information.
@@ -1236,6 +1268,7 @@ class ALIndividual(Individual):
             required (bool): Whether the field is required. Defaults to False.
             shuffle (bool): Whether to shuffle the order of pronouns. Defaults to False.
             show_unknown (Union[Literal["guess"], bool]): Whether to show an "unknown" option. Can be "guess", True, or False. Defaults to "guess".
+            maxlengths (Dict[str, int], optional): A dictionary of field names and their maximum lengths. Default is None.
 
         Returns:
             List[Dict[str, str]]: A list of dictionaries with field prompts for pronouns.
@@ -1277,6 +1310,11 @@ class ALIndividual(Individual):
         if show_if:
             fields[0]["show if"] = show_if
 
+        if maxlengths:
+            for field in fields:
+                if field["field"] in maxlengths:
+                    field["maxlength"] = maxlengths[field["field"]]
+
         return fields
 
     def get_pronouns(self) -> set:
@@ -1314,6 +1352,7 @@ class ALIndividual(Individual):
         choices: Optional[List[Dict[str, str]]] = None,
         style: str = "radio",
         show_if: Union[str, Dict[str, str], None] = None,
+        maxlengths: Optional[Dict[str, int]] = None,
     ) -> List[Dict[str, str]]:
         """
         Generate fields for capturing language preferences.
@@ -1322,6 +1361,7 @@ class ALIndividual(Individual):
             choices (Optional[List[Dict[str, str]]]): A list of language choices. Defaults to None.
             style (str): The display style of choices. Defaults to "radio".
             show_if (Union[str, Dict[str, str], None]): Condition to determine if the field should be shown. Defaults to None.
+            maxlengths (Dict[str, int], optional): A dictionary of field names and their maximum lengths. Default is None.
 
         Returns:
             List[Dict[str, str]]: A list of dictionaries with field prompts for language preferences.
@@ -1349,6 +1389,11 @@ class ALIndividual(Individual):
             fields[0]["input type"] = "radio"
         if show_if:
             fields[0]["show if"] = show_if
+
+        if maxlengths:
+            for field in fields:
+                if field["field"] in maxlengths:
+                    field["maxlength"] = maxlengths[field["field"]]
         return fields
 
     def language_name(self) -> str:
@@ -1532,7 +1577,12 @@ class ALIndividual(Individual):
         Returns:
             str: The appropriate pronoun.
         """
-        # Developers can do funky things; be a little flexible
+        person = str(kwargs.get("person", self.get_point_of_view()))
+
+        if person in ("1", "1p", "2", "2p"):
+            # Use the parent version of pronoun
+            return super().pronoun(**kwargs)
+
         if hasattr(self, "pronouns") and isinstance(self.pronouns, str):
             pronouns = DADict(elements={self.pronouns.lower(): True})
         else:
@@ -1605,6 +1655,12 @@ class ALIndividual(Individual):
         Returns:
             str: The appropriate possessive phrase.
         """
+        person = str(kwargs.get("person", self.get_point_of_view()))
+
+        if person in ("1", "1p", "2", "2p"):
+            # Use the parent version of pronoun
+            return super().pronoun_possessive(target, **kwargs)
+
         if hasattr(self, "pronouns") and isinstance(self.pronouns, str):
             pronouns = DADict(elements={self.pronouns.lower(): True})
         else:
@@ -1671,6 +1727,12 @@ class ALIndividual(Individual):
         Returns:
             str: The appropriate subjective pronoun.
         """
+        person = str(kwargs.get("person", self.get_point_of_view()))
+
+        if person in ("1", "1p", "2", "2p"):
+            # Use the parent version of pronoun
+            return super().pronoun_subjective(**kwargs)
+
         if hasattr(self, "pronouns") and isinstance(self.pronouns, str):
             pronouns = DADict(elements={self.pronouns.lower(): True})
         else:
@@ -1750,6 +1812,82 @@ class ALIndividual(Individual):
         """
         return self.name.firstlast()
 
+    def familiar(
+        self, unique_names: Optional[List[Any]] = None, default: Optional[str] = None
+    ) -> str:
+        """
+        Returns the individual's name in the most familiar form possible.
+
+        The purpose is to allow using a short version of the individual's name in an unambiguous
+        way in the interview. For example: referring to the child in a guardianship petition
+        by first name instead of "the minor". But there may be a problem if context doesn't make
+        it clear if you are talking about the child or their parent when they share a name.
+
+        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
+        * the full name
+        * the default value, e.g., "the minor", if provided
+        * the full name
+
+        Args:
+            unique_names (Optional[List[Any]]): A list of unique names to compare against. Defaults to None.
+            default (Optional[str]): The default name to return if no unique name is found. Defaults to None.
+
+        Returns:
+            str: The individual's name in the most familiar form possible.
+
+        Example:
+            ```mako
+            Who do you want to take care of ${ children.familiar(unique_names=parents + petitioners, default="the minor") }
+            ```
+        """
+        if unique_names is None:
+            unique_names = []
+
+        first_name_candidates = [person.familiar() for person in unique_names]
+        if self.name.first not in first_name_candidates:
+            return self.name.first
+
+        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 ''}"
+            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
+
+        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 ''}"
+            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
+
+        first_and_last_candidates = [person.name.firstlast() for person in unique_names]
+        if self.name_short() not in first_and_last_candidates:
+            return self.name_short()
+
+        full_name_candidates = [person.name.full() for person in unique_names]
+        if self.name_full() not in full_name_candidates:
+            return self.name_full()
+
+        if default:
+            return default
+        return self.name_full()  # We tried but couldn't disambiguate
+
 
 # (DANav isn't in public DA API, but currently in functions.py)
 def section_links(nav) -> List[str]:  # type: ignore

{docassemble_assemblyline-2.28.1 → docassemble_assemblyline-3.0.0}/docassemble/AssemblyLine/data/questions/al_settings.yml

@@ -103,4 +103,7 @@ code: |
   AL_DEFAULT_OVERFLOW_MESSAGE = "..."
 ---
 code: |
-  al_form_requires_digital_signature = True
+  al_form_requires_digital_signature = True
+---
+code: |
+  al_person_answering = "user"

docassemble_assemblyline-3.0.0/docassemble/AssemblyLine/data/questions/demo_search_sessions.yml

@@ -0,0 +1,67 @@
+---
+include:
+  - assembly_line.yml
+---
+metadata:
+  title: |
+    Search sessions demo
+  required privileges:
+    - admin
+    - developer
+    - advocate
+---
+mandatory: True
+code: |
+  search_keyword
+  if not matching_results:
+    no_matches
+  show_results
+  show_selected_interview
+---
+id: search_keyword
+question: |
+  What would you like to search for?
+subquestion: |
+  Searching is not case sensitive.
+fields:
+  - Keyword: search_keyword
+---
+code: |
+  matching_results = find_matching_sessions(search_keyword, user_id="all")
+---
+event: no_matches
+question: |
+  We didn't find any matches
+subquestion: |
+  Check your spelling and try again.
+---
+continue button field: show_results
+question: |
+  We found ${ len(matching_results) } results that match your keyword
+subquestion: |
+  % for result in matching_results:
+  * ${ nice_interview_subtitle(result, exclude_identical=False)}
+  ${ result["modtime"]}
+  % endfor
+
+  Raw results:
+  <div class="overflow-scroll" style="height: 200px;">
+  ${ matching_results }
+  </div>
+fields:
+  - Which session do you want to load: interview_to_load
+    datatype: integer
+    code: |
+      [{idx: f"<b>{nice_interview_subtitle(answer, exclude_identical=False)}</b>" + f' ({answer.get("modtime", DAEmpty()).strftime("%B %d, %Y")})'} for idx, answer in enumerate(matching_results)]
+---
+event: show_selected_interview
+id: show the selected interview
+question: |
+  Here is some information from the session you chose
+subquestion: |
+  Filename: ${ matching_results[interview_to_load]["filename"] } [BR]
+  Session ID: ${ matching_results[interview_to_load]["key"] }
+
+  <div class="overflow-scroll" style="height: 200px;">
+  <pre>${ get_filtered_session_variables_string(filename=matching_results[interview_to_load]["filename"], session_id=matching_results[interview_to_load]["key"]) }</pre>
+  </div