docassemble.AssemblyLine 3.2.0__tar.gz → 3.4.1__tar.gz

{docassemble_assemblyline-3.2.0 → docassemble_assemblyline-3.4.1}/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2023 Suffolk Legal Innovation and Technology Lab
+Copyright (c) 2025 Suffolk Legal Innovation and Technology Lab
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

{docassemble_assemblyline-3.2.0/docassemble.AssemblyLine.egg-info → docassemble_assemblyline-3.4.1}/PKG-INFO

@@ -1,14 +1,22 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: docassemble.AssemblyLine
-Version: 3.2.0
+Version: 3.4.1
 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.3
-Requires-Dist: docassemble.GithubFeedbackForm>=0.2.1
+Requires-Dist: docassemble.ALToolbox>=0.11.1
+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
 

docassemble_assemblyline-3.4.1/docassemble/AssemblyLine/__init__.py

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

{docassemble_assemblyline-3.2.0 → docassemble_assemblyline-3.4.1}/docassemble/AssemblyLine/al_courts.py

@@ -24,19 +24,28 @@ __all__ = [
 
 
 class ALCourt(Court):
-    """Object representing a court in Massachusetts.
-    TODO: it could be interesting to store a jurisdiction on a court. But this is non-trivial. Should it be geo boundaries?
+    """Object representing a court in Massachusetts. We use a function on the CourtList object that filters courts by
+    address and can use any of those three features of the court to do the filtering.
+
+    <!-- TODO: it could be interesting to store a jurisdiction on a court. But this is non-trivial. Should it be geo boundaries?
     A list of cities? A list of counties? Instead, we use a function on the CourtList object that filters courts by
-    address and can use any of those three features of the court to do the filtering."""
+    address and can use any of those three features of the court to do the filtering.-->
+    """
 
-    def init(self, *pargs, **kwargs):
+    def init(self, *pargs, **kwargs) -> None:
+        """Create a new court object.
+
+        Args:
+            *pargs: Standard DAObject positional arguments
+            **kwargs: Standard DAObject keyword arguments
+        """
         super().init(*pargs, **kwargs)
         if "address" not in kwargs:
             self.initializeAttribute("address", ALAddress)
         if (
             "jurisdiction" not in kwargs
         ):  # This attribute isn't used. Could be a better way to handle court locating
-            self.jurisdiction = []
+            self.jurisdiction: list = []
         if "location" not in kwargs:
             self.initializeAttribute("location", LatitudeLongitude)
 
@@ -208,7 +217,13 @@ class ALCourtLoader(DAObject):
         converters (Dict[str, Callable]): A dictionary of functions to apply to columns in the dataframe.
     """
 
-    def init(self, *pargs, **kwargs):
+    def init(self, *pargs, **kwargs) -> None:
+        """Create a new courtloader object.
+
+        Args:
+            *pargs: Standard DAObject positional arguments
+            **kwargs: Standard DAObject keyword arguments
+        """
         super().init(*pargs, **kwargs)
         self.package = docassemble.base.functions.this_thread.current_question.package
         if not hasattr(self, "filename"):
@@ -240,8 +255,9 @@ class ALCourtLoader(DAObject):
             column_name (str): The name of the column in the dataframe.
 
         Returns:
-            Set[str]: A set containing unique values from the specified column.
-                      Returns an empty set if an error occurs.
+            Set[str]:
+                - A set containing unique values from the specified column.
+                - Returns an empty set if the column does not exist or an error occurs.
         """
         df = self._load_courts()
         try:

{docassemble_assemblyline-3.2.0 → docassemble_assemblyline-3.4.1}/docassemble/AssemblyLine/al_document.py

@@ -248,7 +248,13 @@ class ALAddendumField(DAObject):
         The attributes `headers` and `field_style` are planned for future releases and are not currently implemented.
     """
 
-    def init(self, *pargs, **kwargs):
+    def init(self, *pargs, **kwargs) -> None:
+        """Standard DAObject init method.
+
+        Args:
+            *pargs: Positional arguments
+            **kwargs: Keyword arguments
+        """
         super().init(*pargs, **kwargs)
 
     def overflow_value(
@@ -752,7 +758,13 @@ class ALAddendumFieldDict(DAOrderedDict):
                      only the overflow text will be displayed.
     """
 
-    def init(self, *pargs, **kwargs):
+    def init(self, *pargs, **kwargs) -> None:
+        """Standard DAObject init method.
+
+        Args:
+            *pargs: Positional arguments
+            **kwargs: Keyword arguments
+        """
         super(ALAddendumFieldDict, self).init(*pargs, **kwargs)
         self.object_type = ALAddendumField
         self.auto_gather = False
@@ -990,7 +1002,13 @@ class ALDocument(DADict):
         ```
     """
 
-    def init(self, *pargs, **kwargs):
+    def init(self, *pargs, **kwargs) -> None:
+        """Standard DAObject init method.
+
+        Args:
+            *pargs: Positional arguments
+            **kwargs: Keyword arguments
+        """
         super(ALDocument, self).init(*pargs, **kwargs)
         self.initializeAttribute("overflow_fields", ALAddendumFieldDict)
         if not hasattr(self, "default_overflow_message"):
@@ -1345,7 +1363,13 @@ class ALStaticDocument(DAStaticFile):
         Consider handling files in `/data/templates` if deemed useful, potentially by copying into a DAFile using `pdf_concatenate()`.
     """
 
-    def init(self, *pargs, **kwargs):
+    def init(self, *pargs, **kwargs) -> None:
+        """Standard DAObject init method.
+
+        Args:
+            *pargs: Positional arguments
+            **kwargs: Keyword arguments
+        """
         super().init(*pargs, **kwargs)
         self.has_addendum = False
         self.auto_gather = False
@@ -1515,7 +1539,13 @@ class ALDocumentBundle(DAList):
         ```
     """
 
-    def init(self, *pargs, **kwargs):
+    def init(self, *pargs, **kwargs) -> None:
+        """Standard DAObject init method.
+
+        Args:
+            *pargs: Positional arguments
+            **kwargs: Keyword arguments
+        """
         super().init(*pargs, **kwargs)
         if "auto_gather" not in kwargs:
             self.auto_gather = False
@@ -1936,8 +1966,11 @@ class ALDocumentBundle(DAList):
         view_icon: str = "eye",
         download_label: str = "Download",
         download_icon: str = "download",
+        send_label: str = "Send",
+        send_icon: str = "envelope",
         zip_label: Optional[str] = None,
         zip_icon: str = "file-archive",
+        zip_row_label: Optional[str] = "",
         append_matching_suffix: bool = True,
         include_email: bool = False,
         use_previously_cached_files: bool = False,
@@ -1958,10 +1991,14 @@ class ALDocumentBundle(DAList):
             view_icon (str): Icon for the 'view' button, default is "eye".
             download_label (str): Label for the 'download' button, default is "Download".
             download_icon (str): Icon for the 'download' button, default is "download".
+            send_label (str): Label for the 'send' button. Default is "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".
+            zip_row_label (str, optional): Text to go in the left-most column
+                of the table's zip row. Will default to the value of `self.title`.
             append_matching_suffix (bool): Flag to determine if matching suffix should be appended to file name, default is True.
-            include_email (bool): Flag to include an email option, default is False.
+            include_email (bool): Flag to include an option, default is False.
             use_previously_cached_files (bool): Flag to use previously cached files (e.g., made in background) if defined. default is False.
             include_full_pdf (bool): Flag to include a full PDF option, default is False.
             full_pdf_label (Optional[str]): Label for the full PDF option. If not provided, uses the generic template for `self.full_pdf_label` ("Download all").
@@ -2052,7 +2089,10 @@ class ALDocumentBundle(DAList):
                 size="md",
                 classname="al_zip al_button",
             )
-            html += table_row(zip_label, zip_button)
+            safe_zip_row_label: str = (
+                zip_row_label or (hasattr(self, "title") and self.title) or zip_label
+            )
+            html += table_row(safe_zip_row_label, zip_button)
 
         if include_full_pdf and bundled_pdf:
             if not full_pdf_label:
@@ -2071,7 +2111,9 @@ class ALDocumentBundle(DAList):
             html += table_row(full_pdf_label, full_pdf_button)
 
         if include_email:
-            html += self.send_email_table_row(key=key)
+            html += self.send_email_table_row(
+                key=key, send_label=send_label, send_icon=send_icon
+            )
 
         html += "\n</div>"
 
@@ -2150,13 +2192,17 @@ class ALDocumentBundle(DAList):
 
         return html
 
-    def send_email_table_row(self, key: str = "final") -> str:
+    def send_email_table_row(
+        self, key: str = "final", send_label: str = "Send", 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.
 
         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".
+            send_icon (str): Icon for the 'send' button. Default is "envelope".
 
         Returns:
             str: The generated HTML string for the table row.
@@ -2189,7 +2235,7 @@ class ALDocumentBundle(DAList):
         """
 
         # "Send" button for the 2nd column of the table row
-        send_button = f'{action_button_html(javascript_string, label="Send", icon="envelope", color="primary", size="md", classname="al_send_email_button al_button", id_tag=al_send_button_id)}'
+        send_button = f'{action_button_html(javascript_string, label=send_label, icon=send_icon, color="primary", size="md", classname="al_send_email_button al_button", id_tag=al_send_button_id)}'
 
         # Whole row put together
         html = f"""
@@ -2261,6 +2307,8 @@ class ALDocumentBundle(DAList):
         key: str = "final",
         show_editable_checkbox: bool = True,
         template_name: str = "",
+        label: str = "Send",
+        icon: str = "envelope",
     ) -> str:
         """
         Generate HTML for an input box and button that allows someone to send the bundle
@@ -2276,6 +2324,9 @@ class ALDocumentBundle(DAList):
                 Defaults to True.
             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.
+            label (str, optional): The label for the button. Defaults to "Send".
+            icon (str, optional): The Fontawesome icon for the button. Defaults
+                to "envelope".
 
         Returns:
             str: The generated HTML string for the input box and button.
@@ -2327,7 +2378,7 @@ class ALDocumentBundle(DAList):
       <input value="{user_info().email if user_logged_in() else ''}" alt="Email address for document" class="form-control" type="email" size="35" name="{al_email_input_id}" id="{al_email_input_id}">
     </span>
     
-    {action_button_html(javascript_string, label="Send", icon="envelope", color="primary", size="md", classname="al_send_email_button", id_tag=al_send_button_id)}
+    {action_button_html(javascript_string, label=label, icon=icon, color="primary", size="md", classname="al_send_email_button", id_tag=al_send_button_id)}
 
   </div>
   """
@@ -2496,7 +2547,13 @@ class ALExhibit(DAObject):
         starting_page (int): first page number to use in table of contents
     """
 
-    def init(self, *pargs, **kwargs):
+    def init(self, *pargs, **kwargs) -> None:
+        """Standard DAObject init method.
+
+        Args:
+            *pargs: Positional arguments
+            **kwargs: Keyword arguments
+        """
         super().init(*pargs, **kwargs)
         self.initializeAttribute("_cache", DALazyAttribute)
         self.object_type = DAFileList
@@ -2716,7 +2773,13 @@ class ALExhibitList(DAList):
         auto_ocr (bool): If True, automatically starts OCR processing for uploaded exhibits. Defaults to True.
     """
 
-    def init(self, *pargs, **kwargs):
+    def init(self, *pargs, **kwargs) -> None:
+        """Standard DAObject init method.
+
+        Args:
+            *pargs: Positional arguments
+            **kwargs: Keyword arguments
+        """
         super().init(*pargs, **kwargs)
         if not hasattr(self, "auto_label"):
             self.auto_label = True
@@ -2894,7 +2957,25 @@ class ALExhibitDocument(ALDocument):
     ```
     """
 
-    def init(self, *pargs, **kwargs):
+    include_exhibit_cover_pages: bool
+    include_table_of_contents: bool
+    add_page_numbers: bool
+    has_addendum: bool
+    auto_labeler: Callable
+    auto_ocr: bool
+    bates_prefix: str
+    maximum_size: int
+    suffix_to_append: str
+    exhibits: ALExhibitList
+    table_of_contents: DAFile
+
+    def init(self, *pargs, **kwargs) -> None:
+        """Standard DAObject init method.
+
+        Args:
+            *pargs: Positional arguments
+            **kwargs: Keyword arguments
+        """
         super().init(*pargs, **kwargs)
         self.initializeAttribute("exhibits", ALExhibitList)
         if hasattr(self, "auto_labeler"):
@@ -3045,7 +3126,13 @@ class ALTableDocument(ALDocument):
         table (???): Represents the actual table data. Type and attributes need more context to document.
     """
 
-    def init(self, *pargs, **kwargs):
+    def init(self, *pargs, **kwargs) -> None:
+        """Standard DAObject init method.
+
+        Args:
+            *pargs: Positional arguments
+            **kwargs: Keyword arguments
+        """
         super().init(*pargs, **kwargs)
         self.has_addendum = False
         if not hasattr(self, "suffix_to_append"):
@@ -3156,7 +3243,13 @@ class ALUntransformedDocument(ALDocument):
         suffix_to_append (str): Suffix that can be appended to file names, defaulting to "preview".
     """
 
-    def init(self, *pargs, **kwargs):
+    def init(self, *pargs, **kwargs) -> None:
+        """Standard DAObject init method.
+
+        Args:
+            *pargs: Positional arguments
+            **kwargs: Keyword arguments
+        """
         super().init(*pargs, **kwargs)
         self.has_addendum = False
         if not hasattr(self, "suffix_to_append"):

{docassemble_assemblyline-3.2.0 → docassemble_assemblyline-3.4.1}/docassemble/AssemblyLine/al_general.py

@@ -293,7 +293,8 @@ class ALAddress(Address):
                                 True, the function will not add 'Unit' regardless of other conditions. Defaults to False.
 
         Returns:
-            str: The formatted unit. If the unit attribute does not exist and require is set to False, this will be an
+            str:
+                The formatted unit. If the unit attribute does not exist and require is set to False, this will be an
                 empty string. If the unit attribute exists and is not None or an empty string, the function will return
                 the unit number, possibly prefixed with 'Unit'. If the unit attribute exists and is None or an empty
                 string, the function will return an empty string.
@@ -627,7 +628,8 @@ class ALAddress(Address):
         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
+            Union[Address, "ALAddress"]:
+                Normalized address if geocoding is successful, otherwise
                 the original address.
         """
         try:
@@ -680,7 +682,13 @@ class ALAddressList(DAList):
     of the list in a formatted manner.
     """
 
-    def init(self, *pargs, **kwargs):
+    def init(self, *pargs, **kwargs) -> None:
+        """Standard DAObject init method.
+
+        Args:
+            *pargs: Positional arguments
+            **kwargs: Keyword arguments
+        """
         super(ALAddressList, self).init(*pargs, **kwargs)
         self.object_type = ALAddress
 
@@ -702,7 +710,13 @@ class ALNameList(DAList):
     Extends the DAList class and is tailored for IndividualName objects.
     """
 
-    def init(self, *pargs, **kwargs):
+    def init(self, *pargs, **kwargs) -> None:
+        """Standard DAObject init method.
+
+        Args:
+            *pargs: Positional arguments
+            **kwargs: Keyword arguments
+        """
         super().init(*pargs, **kwargs)
         self.object_type = IndividualName
 
@@ -720,7 +734,13 @@ class ALPeopleList(DAList):
 
     For example, defendants, plaintiffs, or children."""
 
-    def init(self, *pargs, **kwargs):
+    def init(self, *pargs, **kwargs) -> None:
+        """Standard DAObject init method.
+
+        Args:
+            *pargs: Positional arguments
+            **kwargs: Keyword arguments
+        """
         super(ALPeopleList, self).init(*pargs, **kwargs)
         self.object_type = ALIndividual
 
@@ -799,7 +819,14 @@ class ALPeopleList(DAList):
             str: Formatted string of full names.
         """
         return comma_and_list(
-            [person.name.full(middle="full") for person in self],
+            [
+                (
+                    person.name_full()
+                    if isinstance(person, ALIndividual)
+                    else person.name.full(middle="full")
+                )
+                for person in self
+            ],
             comma_string=comma_string,
             and_string=and_string,
         )
@@ -874,7 +901,13 @@ class ALIndividual(Individual):
     aliases: ALNameList
     preferred_name: IndividualName
 
-    def init(self, *pargs, **kwargs):
+    def init(self, *pargs, **kwargs) -> None:
+        """Standard DAObject init method.
+
+        Args:
+            *pargs: Positional arguments
+            **kwargs: Keyword arguments
+        """
         super(ALIndividual, self).init(*pargs, **kwargs)
         # Initialize the attributes that are themselves objects. Requirement to work with Docassemble
         # See: https://docassemble.org/docs/objects.html#ownclassattributes
@@ -1578,8 +1611,9 @@ class ALIndividual(Individual):
         else:
             if isinstance(self.address, ALAddress):
                 return (
-                    "[FLUSHLEFT] "
-                    + self.name.full()
+                    "[FLUSHLEFT] " + self.name_full()
+                    if isinstance(self, ALIndividual)
+                    else self.name.full(middle="full")
                     + " [NEWLINE] "
                     + self.address.block(
                         language=language,
@@ -1591,8 +1625,9 @@ class ALIndividual(Individual):
                 )
             else:
                 return (
-                    "[FLUSHLEFT] "
-                    + self.name.full()
+                    "[FLUSHLEFT] " + self.name_full()
+                    if isinstance(self, ALIndividual)
+                    else self.name.full(middle="full")
                     + " [NEWLINE] "
                     + self.address.block(
                         language=language,
@@ -1977,9 +2012,18 @@ class ALIndividual(Individual):
     def name_full(self) -> str:
         """Returns the individual's full name.
 
+        If the person has the attribute person_type and it is defined
+        as either `business` or `organization`, it will only return
+        the first name, even if middle, last, or suffix are defined.
+
         Returns:
-            str: The individual's full name.
+            str: The individual or business's full name.
         """
+        if hasattr(self, "person_type") and self.person_type in [
+            "business",
+            "organization",
+        ]:
+            return self.name.first
         return self.name.full(middle="full")
 
     def name_initials(self) -> str:
@@ -1988,9 +2032,18 @@ class ALIndividual(Individual):
         Equivalent to `name.full(middle="initial")`, which is also the default.
         Defined only to make it possible to be explicit about the name form.
 
+        If the person has the attribute person_type and it is defined
+        as either `business` or `organization`, it will only return
+        the "initials" of the first name, even if middle, last, or suffix are defined.
+
         Returns:
             str: The individual's name with the middle name as an initial.
         """
+        if hasattr(self, "person_type") and self.person_type in [
+            "business",
+            "organization",
+        ]:
+            return self.name.first
         return self.name.full(middle="initial")
 
     def name_short(self) -> str:
@@ -1999,9 +2052,18 @@ class ALIndividual(Individual):
 
         Equivalent to self.name.firstlast()
 
+        If the person has the attribute person_type and it is defined
+        as either `business` or `organization`, it will only return
+        the first name, even if middle, last, or suffix are defined.
+
         Returns:
             str: The individual'
         """
+        if hasattr(self, "person_type") and self.person_type in [
+            "business",
+            "organization",
+        ]:
+            return self.name.first
         return self.name.firstlast()
 
     def familiar(
@@ -2025,6 +2087,10 @@ class ALIndividual(Individual):
         * the default value, e.g., "the minor", if provided
         * the full name
 
+        If the person has the attribute `person_type` and it is defined
+        as either `business` or `organization`, it will only return
+        the first name, even if middle, last, or suffix are defined.
+
         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.
@@ -2037,6 +2103,12 @@ class ALIndividual(Individual):
             Who do you want to take care of ${ children.familiar(unique_names=parents + petitioners, default="the minor") }
             ```
         """
+        if hasattr(self, "person_type") and self.person_type in [
+            "business",
+            "organization",
+        ]:
+            return self.name.first
+
         if unique_names is None:
             unique_names = []
 
@@ -2068,7 +2140,14 @@ class ALIndividual(Individual):
                 return f"{self.name.first} {self.name.middle}"
             return self.name.first
 
-        first_and_last_candidates = [person.name.firstlast() for person in unique_names]
+        first_and_last_candidates = [
+            (
+                person.name.firstlast()
+                if hasattr(person.name, "last")
+                else person.name.first
+            )
+            for person in unique_names
+        ]
         if self.name_short() not in first_and_last_candidates:
             return self.name_short()
 
@@ -2080,6 +2159,28 @@ class ALIndividual(Individual):
             return default
         return self.name_full()  # We tried but couldn't disambiguate
 
+    def __str__(self) -> str:
+        """
+        Returns a string representation of the individual, which is their full name with the
+        middle name shortened to one letter.
+
+        If the individual has the attribute `person_type` and it is defined
+        as either `business` or `organization`, it will only return
+        the first name, even if middle, last, or suffix are defined.
+
+        Returns:
+            str: The individual's name.
+        """
+        if hasattr(self, "person_type") and self.person_type in [
+            "business",
+            "organization",
+        ]:
+            return self.name.first
+
+        return (
+            super().__str__()
+        )  # This will call the parent's __str__ method, which returns the full name with middle initial
+
 
 # (DANav isn't in public DA API, but currently in functions.py)
 def section_links(nav) -> List[str]:  # type: ignore
@@ -2425,7 +2526,7 @@ def parse_custom_pronouns(pronouns: str) -> Dict[str, str]:
 
 
 def get_visible_al_nav_items(
-    nav_items: List[Union[str, dict]]
+    nav_items: List[Union[str, dict]],
 ) -> List[Union[str, dict]]:
     """
     Processes a list of nav items and returns only the ones that are not hidden.