docassemble.AssemblyLine 2.28.0__tar.gz → 3.0.0__tar.gz

{docassemble_assemblyline-2.28.0/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.0
+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.0 → docassemble_assemblyline-3.0.0}/docassemble/AssemblyLine/al_courts.py

@@ -3,7 +3,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
+from typing import Any, Callable, Dict, List, Mapping, Optional, Union, Set
 import pandas as pd
 import docassemble.base.functions
 from docassemble.base.util import (
@@ -205,6 +205,7 @@ class ALCourtLoader(DAObject):
 
     Attributes:
         filename (str): Path to the file containing court information.
+        converters (Dict[str, Callable]): A dictionary of functions to apply to columns in the dataframe.
     """
 
     def init(self, *pargs, **kwargs):
@@ -413,6 +414,8 @@ class ALCourtLoader(DAObject):
 
         The method determines the file type (.csv, .xlsx, or .json) based on its extension and reads it accordingly.
 
+        If the "callable" attribute is defined on the instance, it will be used to convert the data in the dataframe.
+
         Returns:
             pd.DataFrame: A dataframe containing the list of courts.
 
@@ -429,11 +432,20 @@ class ALCourtLoader(DAObject):
         else:
             load_path = str(self.filename)
 
+        def convert_zip(z: Any) -> str:
+            return str(z).zfill(5)
+
+        merged_converters: Dict[str, Callable[[object], object]] = {
+            "address_zip": convert_zip
+        }
+        if hasattr(self, "converters") and self.converters:
+            assert isinstance(self.converters, dict)
+            merged_converters.update(self.converters)
         to_load = path_and_mimetype(load_path)[0]
         if self.filename.lower().endswith(".xlsx"):
-            df = pd.read_excel(to_load)
+            df = pd.read_excel(to_load, converters=merged_converters)  # type: ignore
         elif self.filename.lower().endswith(".csv"):
-            df = pd.read_csv(to_load)
+            df = pd.read_csv(to_load, converters=merged_converters)  # type: ignore
         elif self.filename.lower().endswith(".json"):
             # TODO: we may need to normalize a JSON file
             df = pd.read_json(to_load)

{docassemble_assemblyline-2.28.0 → 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.
@@ -2244,8 +2251,12 @@ class ALDocumentBundle(DAList):
             return send_email(
                 to=to,
                 template=template,
-                attachments=set(
-                    self.as_editable_list(key=key) + self.as_pdf_list(key=key)
+                # Add both DOCX and PDF versions, but if it's not possible to be a DOCX don't add the PDF
+                # twice
+                attachments=list(
+                    dict.fromkeys(
+                        self.as_editable_list(key=key) + self.as_pdf_list(key=key)
+                    )
                 ),
                 **kwargs,
             )