Fix to new version of docsig; add missing docstrings and reformat some return statements

Author: nonprofittechy

docassemble/AssemblyLine/al_courts.py

@@ -29,7 +29,13 @@ class ALCourt(Court):
     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."""
 
-    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)
@@ -208,7 +214,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 +252,9 @@ def unique_column_values(self, column_name: str) -> Set[str]:
             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/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
@@ -2511,7 +2541,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
@@ -2731,7 +2767,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
@@ -2909,7 +2951,13 @@ class ALExhibitDocument(ALDocument):
     ```
     """
 
-    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("exhibits", ALExhibitList)
         if hasattr(self, "auto_labeler"):
@@ -3060,7 +3108,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"):
@@ -3171,7 +3225,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/al_general.py

@@ -293,7 +293,8 @@ def formatted_unit(
                                 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 @@ def normalized_address(self) -> Union[Address, "ALAddress"]:
         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
 
@@ -874,7 +894,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

docassemble/AssemblyLine/language.py

@@ -14,8 +14,15 @@
 ]
 
 
-def _package_name(package_name: Optional[str] = None):
-    """Get package name without the name of the given module. By default this is `docassemble.AssemblyLine.language`"""
+def _package_name(package_name: Optional[str] = None) -> str:
+    """Get package name without the name of the given module. By default this is `docassemble.AssemblyLine.language`
+    
+    Args:
+        package_name: the name of the package to get the package name from (defaults to `docassemble.AssemblyLine.language`)
+
+    Returns:
+        str: the package name without the name of the given module
+    """
     if not package_name:
         package_name = __name__
     try:
@@ -24,7 +31,13 @@ def _package_name(package_name: Optional[str] = None):
         return package_name
 
 
-def get_local_languages_yaml():
+def get_local_languages_yaml() -> str:
+    """
+    Get the path to the local languages.yml file. If it does not exist, it will return the path to the languages.yml
+
+    Returns:
+        str: the path to the local languages.yml file if it exists, otherwise the path to the languages.yml file
+    """
     try:
         local_yaml = path_and_mimetype("data/sources/languages.yml")[0]
     except:

docassemble/AssemblyLine/project_maintenance.py

@@ -338,7 +338,10 @@ def link_issue_title_to_project(
         print(f"Project '{project_name}' not found.")
 
 
-def main():
+def main() -> None:
+    """
+    Main function to run the specified project maintenance command.
+    """
     parser = argparse.ArgumentParser(
         description="Run specified function with arguments."
     )