docassemble.AssemblyLine 3.0.1__tar.gz → 3.1.0__tar.gz

{docassemble_assemblyline-3.0.1/docassemble.AssemblyLine.egg-info → docassemble_assemblyline-3.1.0}/PKG-INFO

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

docassemble_assemblyline-3.1.0/docassemble/AssemblyLine/__init__.py

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

{docassemble_assemblyline-3.0.1 → docassemble_assemblyline-3.1.0}/docassemble/AssemblyLine/al_general.py

@@ -804,6 +804,46 @@ class ALPeopleList(DAList):
             and_string=and_string,
         )
 
+    def pronoun_reflexive(self, **kwargs) -> str:
+        """Returns the appropriate reflexive pronoun for the list of people, depending
+        on the `person` keyword argument and the number of items in the list.
+
+        If the list is singular, return the reflexive pronoun for the first item in the list.
+        If it is plural, return the appropriate plural reflexive pronoun (e.g., "themselves")
+
+        Args:
+            **kwargs: Additional keyword arguments that are defined [upstream](https://docassemble.org/docs/objects.html#language%20methods).
+                    - person (Optional[[Union[str,int]]): Whether to use a first, second, or third person pronoun. Can be one of 1/"1p", 2/"2p", or 3/"3p" (default is 3). See [upstream](https://docassemble.org/docs/objects.html#language%20methods) documentation for more information.
+                    - default (Optional[str]): The default word to use if the pronoun is not defined, e.g. "the agent". If not defined, the default term is the user's name.
+
+        Returns:
+            str: The reflexive pronoun for the list.
+        """
+        person = str(kwargs.get("person", self.get_point_of_view()))
+
+        if self.number_gathered() > 1:
+            if person in ("1", "1p", "2", "2p"):
+                if person in ("1", "1p"):
+                    output = word("ourselves")
+                elif person in ("2", "2p"):
+                    output = word("yourselves")
+            else:
+                output = word("themselves")
+
+        elif self.number_gathered() == 1:
+            if isinstance(self[0], ALIndividual) and hasattr(
+                self[0], "pronoun_reflexive"
+            ):
+                output = self[0].pronoun_reflexive(**kwargs)
+            else:
+                output = word("itself")
+        else:
+            output = word("themselves")
+
+        if kwargs.get("capitalize"):
+            return output.capitalize()
+        return output
+
 
 class ALIndividual(Individual):
     """Used to represent an Individual on the assembly line project.
@@ -1562,18 +1602,18 @@ class ALIndividual(Individual):
                 )
 
     def pronoun(self, **kwargs) -> str:
-        """Returns an objective pronoun as appropriate, based on attributes.
+        """Returns an objective pronoun as appropriate, based on the user's `pronouns` attribute or `gender` attribute.
 
-        The pronoun could be "you," "her," "him," "it," or "them". It depends
-        on the `gender` and `person_type` attributes and whether the individual
-        is the current user.
+        The pronoun could be "I", "you," "her," "him," "it," or "them", or a user-provided pronoun.
+        If the user has selected multiple pronouns, each will appear, separated by a "/".
 
-        If the user selected specific pronouns, they take priority over
-        gender (only if they chose a pronoun from the list)
+        This method will not trigger the definition of `gender` or `pronouns`, but it will use them if they are defined,
+        with `pronouns` taking precedence. As a default, it will either use the value of `default` or the individual's full name.
 
         Args:
-            **kwargs: Additional keyword arguments.
-
+            **kwargs: Additional keyword arguments that are defined [upstream](https://docassemble.org/docs/objects.html#language%20methods).
+                    - person (Optional[[Union[str,int]]): Whether to use a first, second, or third person pronoun. Can be one of 1/"1p", 2/"2p", or 3/"3p" (default is 3). See [upstream](https://docassemble.org/docs/objects.html#language%20methods) documentation for more information.
+                    - default (Optional[str]): The default word to use if the pronoun is not defined, e.g. "the agent". If not defined, the default term is the user's name.
         Returns:
             str: The appropriate pronoun.
         """
@@ -1583,49 +1623,64 @@ class ALIndividual(Individual):
             # 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})
+        if "default" in kwargs:
+            default = kwargs.pop("default")
         else:
-            pronouns = self.pronouns
+            default = self.name_full()
+
+        if hasattr(self, "pronouns") and self.pronouns:
+            if isinstance(self.pronouns, str):
+                pronouns = DADict(elements={self.pronouns.lower(): True})
+            else:
+                pronouns = self.pronouns
 
         if self == this_thread.global_vars.user:
             output = word("you", **kwargs)
-        elif (
-            hasattr(self, "pronouns")
-            and isinstance(pronouns, DADict)
-            and len(pronouns.true_values()) == 1
-            and (
-                (
-                    pronouns.true_values()[0]
-                    in ["she/her/hers", "he/him/his", "they/them/theirs", "ze/zir/zirs"]
-                )
-                or (
-                    pronouns.get("self-described")
-                    and has_parsable_pronouns(self.pronouns_self_described)
-                )
-            )
-        ):
-            if pronouns.get("she/her/hers"):
-                output = word("her", **kwargs)
-            elif pronouns.get("he/him/his"):
-                output = word("him", **kwargs)
-            elif pronouns.get("they/them/theirs"):
-                output = word("them", **kwargs)
-            elif pronouns.get("ze/zir/zirs"):
-                output = word("zir", **kwargs)
-            elif pronouns.get("self-described"):
-                output = parse_custom_pronouns(self.pronouns_self_described)["o"]
+        elif hasattr(self, "pronouns") and self.pronouns:
+            pronouns_to_use = []
+            if isinstance(pronouns, DADict):
+                for pronoun in pronouns.true_values():
+                    if pronoun in [
+                        "she/her/hers",
+                        "he/him/his",
+                        "they/them/theirs",
+                        "ze/zir/zirs",
+                    ]:
+                        if pronoun == "she/her/hers":
+                            pronouns_to_use.append(word("her", **kwargs))
+                        elif pronoun == "he/him/his":
+                            pronouns_to_use.append(word("him", **kwargs))
+                        elif pronoun == "they/them/theirs":
+                            pronouns_to_use.append(word("them", **kwargs))
+                        elif pronoun == "ze/zir/zirs":
+                            pronouns_to_use.append(word("zir", **kwargs))
+                    elif pronoun == "self-described" and has_parsable_pronouns(
+                        self.pronouns_self_described
+                    ):
+                        pronouns_to_use.append(
+                            parse_custom_pronouns(self.pronouns_self_described)["o"]
+                        )
+                    elif has_parsable_pronouns(pronoun):
+                        pronouns_to_use.append(parse_custom_pronouns(pronoun)["o"])
+            if len(pronouns_to_use) > 0:
+                output = "/".join(pronouns_to_use)
+            else:
+                output = default
         elif hasattr(self, "person_type") and self.person_type in [
             "business",
             "organization",
         ]:
             output = word("it", **kwargs)
-        elif self.gender.lower() == "female":
-            output = word("her", **kwargs)
-        elif self.gender.lower() == "male":
-            output = word("him", **kwargs)
+        elif hasattr(self, "gender"):
+            if self.gender.lower() == "female":
+                output = word("her", **kwargs)
+            elif self.gender.lower() == "male":
+                output = word("him", **kwargs)
+            else:
+                output = word("them", **kwargs)
         else:
-            output = word("them", **kwargs)
+            output = default
+
         if "capitalize" in kwargs and kwargs["capitalize"]:
             return capitalize(output)
         return output
@@ -1642,18 +1697,24 @@ class ALIndividual(Individual):
         return self.pronoun(**kwargs)
 
     def pronoun_possessive(self, target, **kwargs) -> str:
-        """Returns a possessive pronoun and a target word, based on attributes.
+        """
+        Returns a possessive pronoun and a target word, based on attributes.
+
+        This method will not trigger the definition of `gender` or `pronouns`, but it will use them if they are defined,
+        with `pronouns` taking precedence. As a default, it will either use the value of `default` or the individual's full name.
 
         Given a target word, the function returns "{pronoun} {target}". The pronoun could be
-        "her," "his," "its," or "their". It depends on the `gender` and `person_type` attributes
+        "my", "her," "his," "its," or "their". It depends on the `gender` and `person_type` attributes
         and whether the individual is the current user.
 
         Args:
             target (str): The target word to follow the pronoun.
-            **kwargs: Additional keyword arguments.
+            **kwargs: Additional keyword arguments that can be passed to modify the behavior. These might include:
+                - `default` (Optional[str]): The default word to use if the pronoun is not defined, e.g., "the agent". If not defined, the default term is the user's name.
+                - `person` (Optional[Union[str, int]]): Whether to use a first, second, or third person pronoun. Can be one of 1/"1p", 2/"2p", or 3/"3p" (default is 3). See [upstream documentation](https://docassemble.org/docs/objects.html#language%20methods) for more information.
 
         Returns:
-            str: The appropriate possessive phrase.
+            str: The appropriate possessive phrase, e.g., "her book", "their document".
         """
         person = str(kwargs.get("person", self.get_point_of_view()))
 
@@ -1666,50 +1727,64 @@ class ALIndividual(Individual):
         else:
             pronouns = self.pronouns
 
+        if "default" in kwargs:
+            default = kwargs.pop("default")
+        else:
+            default = self.name_full()
+
         if self == this_thread.global_vars.user and (
             "thirdperson" not in kwargs or not kwargs["thirdperson"]
         ):
             output = your(target, **kwargs)
-        elif (
-            hasattr(self, "pronouns")
-            and isinstance(pronouns, DADict)
-            and len(pronouns.true_values()) == 1
-            and (
-                (
-                    pronouns.true_values()[0]
-                    in ["she/her/hers", "he/him/his", "they/them/theirs", "ze/zir/zirs"]
-                )
-                or (
-                    pronouns.get("self-described")
-                    and has_parsable_pronouns(self.pronouns_self_described)
-                )
-            )
-        ):
-            if pronouns.get("she/her/hers"):
-                output = her(target, **kwargs)
-            elif pronouns.get("he/him/his"):
-                output = his(target, **kwargs)
-            elif pronouns.get("they/them/theirs"):
-                output = their(target, **kwargs)
-            elif pronouns.get("ze/zir/zirs"):
-                output = word("zir", **kwargs) + " " + target
-            elif pronouns.get("self-described"):
-                output = (
-                    parse_custom_pronouns(self.pronouns_self_described)["p"]
-                    + " "
-                    + target
-                )
+        elif hasattr(self, "pronouns") and self.pronouns:
+            pronouns_to_use = []
+            if isinstance(pronouns, DADict):
+                for pronoun in pronouns.true_values():
+                    if pronoun in [
+                        "she/her/hers",
+                        "he/him/his",
+                        "they/them/theirs",
+                        "ze/zir/zirs",
+                    ]:
+                        if pronoun == "she/her/hers":
+                            pronouns_to_use.append(her(target, **kwargs))
+                        elif pronoun == "he/him/his":
+                            pronouns_to_use.append(his(target, **kwargs))
+                        elif pronoun == "they/them/theirs":
+                            pronouns_to_use.append(their(target, **kwargs))
+                        elif pronoun == "ze/zir/zirs":
+                            pronouns_to_use.append(word("zir", **kwargs) + " " + target)
+                    elif pronoun == "self-described" and has_parsable_pronouns(
+                        self.pronouns_self_described
+                    ):
+                        pronouns_to_use.append(
+                            parse_custom_pronouns(self.pronouns_self_described)["p"]
+                            + " "
+                            + target
+                        )
+                    elif has_parsable_pronouns(pronoun):
+                        pronouns_to_use.append(
+                            parse_custom_pronouns(pronoun)["p"] + " " + target
+                        )
+            if len(pronouns_to_use) > 0:
+                output = "/".join(pronouns_to_use)
+            else:
+                output = default
         elif hasattr(self, "person_type") and self.person_type in [
             "business",
             "organization",
         ]:
             output = its(target, **kwargs)
-        elif self.gender.lower() == "female":
-            output = her(target, **kwargs)
-        elif self.gender.lower() == "male":
-            output = his(target, **kwargs)
+        elif hasattr(self, "gender"):
+            if self.gender.lower() == "female":
+                output = her(target, **kwargs)
+            elif self.gender.lower() == "male":
+                output = his(target, **kwargs)
+            else:
+                output = their(target, **kwargs)
         else:
-            output = their(target, **kwargs)
+            output = default
+
         if "capitalize" in kwargs and kwargs["capitalize"]:
             return capitalize(output)
         return output
@@ -1717,13 +1792,14 @@ class ALIndividual(Individual):
     def pronoun_subjective(self, **kwargs) -> str:
         """Returns a subjective pronoun, based on attributes.
 
-        The pronoun could be "you," "she," "he," "it," or "they". It depends
+        The pronoun could be "you," "we", "she," "he," "it," or "they". It depends
         on the `gender` and `person_type` attributes and whether the individual
         is the current user.
 
         Args:
-            **kwargs: Additional keyword arguments.
-
+            **kwargs: Additional keyword arguments that are defined [upstream](https://docassemble.org/docs/objects.html#language%20methods).
+                    - person (Optional[[Union[str,int]]): Whether to use a first, second, or third person pronoun. Can be one of 1/"1p", 2/"2p", or 3/"3p" (default is 3). See [upstream](https://docassemble.org/docs/objects.html#language%20methods) documentation for more information.
+                    - default (Optional[str]): The default word to use if the pronoun is not defined, e.g. "the agent". If not defined, the default term is the user's name.
         Returns:
             str: The appropriate subjective pronoun.
         """
@@ -1732,53 +1808,169 @@ class ALIndividual(Individual):
         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})
+        if "default" in kwargs:
+            default = kwargs.pop("default")
         else:
-            pronouns = self.pronouns
+            default = self.name_full()
 
-        if self == this_thread.global_vars.user and (
-            "thirdperson" not in kwargs or not kwargs["thirdperson"]
-        ):
+        if hasattr(self, "pronouns") and self.pronouns:
+            if isinstance(self.pronouns, str):
+                pronouns = DADict(elements={self.pronouns.lower(): True})
+            else:
+                pronouns = self.pronouns
+
+        if self == this_thread.global_vars.user:
             output = word("you", **kwargs)
-        elif (
-            hasattr(self, "pronouns")
-            and isinstance(pronouns, DADict)
-            and len(pronouns.true_values()) == 1
-            and (
-                (
-                    pronouns.true_values()[0]
-                    in ["she/her/hers", "he/him/his", "they/them/theirs", "ze/zir/zirs"]
-                )
-                or (
-                    pronouns.get("self-described")
-                    and has_parsable_pronouns(self.pronouns_self_described)
-                )
-            )
-        ):
-            if pronouns.get("she/her/hers"):
+        elif hasattr(self, "pronouns") and self.pronouns:
+            pronouns_to_use = []
+            if isinstance(pronouns, DADict):
+                for pronoun in pronouns.true_values():
+                    if pronoun in [
+                        "she/her/hers",
+                        "he/him/his",
+                        "they/them/theirs",
+                        "ze/zir/zirs",
+                    ]:
+                        if pronoun == "she/her/hers":
+                            pronouns_to_use.append(word("she", **kwargs))
+                        elif pronoun == "he/him/his":
+                            pronouns_to_use.append(word("he", **kwargs))
+                        elif pronoun == "they/them/theirs":
+                            pronouns_to_use.append(word("they", **kwargs))
+                        elif pronoun == "ze/zir/zirs":
+                            pronouns_to_use.append(word("ze", **kwargs))
+                    elif pronoun == "self-described" and has_parsable_pronouns(
+                        self.pronouns_self_described
+                    ):
+                        pronouns_to_use.append(
+                            parse_custom_pronouns(self.pronouns_self_described)["s"]
+                        )
+                    elif has_parsable_pronouns(pronoun):
+                        pronouns_to_use.append(parse_custom_pronouns(pronoun)["s"])
+            if len(pronouns_to_use) > 0:
+                output = "/".join(pronouns_to_use)
+            else:
+                output = default
+        elif hasattr(self, "person_type") and self.person_type in [
+            "business",
+            "organization",
+        ]:
+            output = word("it", **kwargs)
+        elif hasattr(self, "gender"):
+            if self.gender.lower() == "female":
                 output = word("she", **kwargs)
-            elif pronouns.get("he/him/his"):
+            elif self.gender.lower() == "male":
                 output = word("he", **kwargs)
-            elif pronouns.get("they/them/theirs"):
+            else:
                 output = word("they", **kwargs)
-            elif pronouns.get("ze/zir/zirs"):
-                output = word("ze", **kwargs)
-            elif pronouns.get("self-described"):
-                output = parse_custom_pronouns(self.pronouns_self_described)["s"]
+        else:
+            output = default
+
+        if "capitalize" in kwargs and kwargs["capitalize"]:
+            return capitalize(output)
+        return output
+
+    def pronoun_reflexive(self, **kwargs) -> str:
+        """Returns the appropriate reflexive pronoun ("herself", "themself", "myself"), based on the user's pronouns or gender and whether we are asked
+        to return a 1st, 2nd, or 3rd person pronoun.
+
+        Note that if the person has pronouns of they/them/theirs or a nonbinary gender, we return "themself" as the singular non-gendered
+        reflexive pronoun and not "themselves". This has growing acceptance although some consider it nonstandard.
+        See: https://www.merriam-webster.com/wordplay/themself
+
+        Args:
+            **kwargs: Additional keyword arguments that are defined [upstream](https://docassemble.org/docs/objects.html#language%20methods).
+                    - person (Optional[[Union[str,int]]): Whether to use a first, second, or third person pronoun. Can be one of 1/"1p", 2/"2p", or 3/"3p" (default is 3). See [upstream](https://docassemble.org/docs/objects.html#language%20methods) documentation for more information.
+                    - default (Optional[str]): The default word to use if the pronoun is not defined, e.g. "the agent". If not defined, the default term is the user's name.
+
+        Returns:
+            str: The appropriate reflexive pronoun.
+        """
+        person = str(kwargs.get("person", self.get_point_of_view()))
+
+        if person in ("1", "1p", "2", "2p"):
+            if person == "1":
+                return word("myself")
+            if person == "1p":
+                return word("ourselves")
+            if person == "2":
+                return word("yourself")
+            if person == "2p":
+                return word("yourselves")
+
+        if self == this_thread.global_vars.user:
+            output = word("yourself", **kwargs)
+
+        if "default" in kwargs:
+            default = kwargs.pop("default")
+        else:
+            default = None
+
+        if hasattr(self, "pronouns") and self.pronouns:
+            if isinstance(self.pronouns, str):
+                pronouns = DADict(elements={self.pronouns.lower(): True})
+            else:
+                pronouns = self.pronouns
+        else:
+            pronouns = None
+
+        if self == this_thread.global_vars.user:
+            output = word("yourself", **kwargs)
+        elif hasattr(self, "pronouns") and self.pronouns:
+            pronouns_to_use = []
+
+            if isinstance(pronouns, DADict):
+                for pronoun in pronouns.true_values():
+                    if pronoun in [
+                        "she/her/hers",
+                        "he/him/his",
+                        "they/them/theirs",
+                        "ze/zir/zirs",
+                    ]:
+                        if pronoun == "she/her/hers":
+                            pronouns_to_use.append(word("herself", **kwargs))
+                        elif pronoun == "he/him/his":
+                            pronouns_to_use.append(word("himself", **kwargs))
+                        elif pronoun == "they/them/theirs":
+                            pronouns_to_use.append(word("themself", **kwargs))
+                        elif pronoun == "ze/zir/zirs":
+                            pronouns_to_use.append(word("zirself", **kwargs))
+                    elif pronoun == "self-described" and has_parsable_pronouns(
+                        self.pronouns_self_described
+                    ):
+                        pronouns_to_use.append(
+                            parse_custom_pronouns(self.pronouns_self_described)["o"]
+                            + word("self")
+                        )
+                    elif has_parsable_pronouns(pronoun):
+                        pronouns_to_use.append(
+                            parse_custom_pronouns(pronoun)["o"] + word("self")
+                        )
+                if len(pronouns_to_use) > 0:
+                    output = "/".join(pronouns_to_use)
+                else:
+                    output = default
         elif hasattr(self, "person_type") and self.person_type in [
             "business",
             "organization",
         ]:
-            output = word("it", **kwargs)
-        elif self.gender.lower() == "female":
-            output = word("she", **kwargs)
-        elif self.gender.lower() == "male":
-            output = word("he", **kwargs)
+            output = word("itself", **kwargs)
+        elif hasattr(self, "gender"):
+            if self.gender.lower() == "female":
+                output = word("herself", **kwargs)
+            elif self.gender.lower() == "male":
+                output = word("himself", **kwargs)
+            else:
+                output = word("themself", **kwargs)
         else:
-            output = word("they", **kwargs)
-        if "capitalize" in kwargs and kwargs["capitalize"]:
+            if default:
+                output = default
+            else:
+                output = word(
+                    "themself"
+                )  # reflexive pronoun shouldn't be the person's name
+
+        if kwargs.get("capitalize"):
             return capitalize(output)
         return output
 

{docassemble_assemblyline-3.0.1 → docassemble_assemblyline-3.1.0}/docassemble/AssemblyLine/data/questions/interview_list.yml

@@ -425,4 +425,19 @@ code: |
 code: |
   LOGO_TITLE_ROW_2 = config_with_language_fallback("logo title row 2")
 ---
-code: al_sessions_to_exclude_from_interview_list = get_config("assembly line",{}).get("interview list",{}).get("exclude from interview list", get_config("assembly line",{}).get("exclude from interview list"))
+code: |
+  al_sessions_to_exclude_from_interview_list = (
+      get_config("assembly line", {})
+      .get("interview list", {})
+      .get(
+          "exclude from interview list",
+          get_config("assembly line", {}).get(
+              "exclude from interview list",
+              [
+                  "docassemble.ALDashboard",
+                  "docassemble.AssemblyLine:data/questions/al_saved_sessions_store.yml",
+                  "docassemble.AssemblyLine:data/questions/interview_list.yml",
+              ],
+          ),
+      )
+  )

{docassemble_assemblyline-3.0.1 → docassemble_assemblyline-3.1.0}/docassemble/AssemblyLine/sessions.py

@@ -334,54 +334,12 @@ def get_saved_interview_list(
         offset (int, optional): The offset to start returning results from. Defaults to 0.
         filename_to_exclude (str, optional): The filename to exclude from the results. Defaults to "".
         exclude_current_filename (bool, optional): Whether to exclude the current filename from the results. Defaults to True.
-        exclude_filenames (Optional[List[str]], optional): A list of filenames to exclude from the results. Defaults to None.
+        exclude_filenames (Optional[List[str]], optional): List of filenames to exclude. Defaults to None. If the `filename` does not contain a `:` it will be treated as a prefix, allowing you to filter out whole packages (e.g., any path starting with docassemble.ALDashboard or docassemble.playground)
         exclude_newly_started_sessions (bool, optional): Whether to exclude sessions that are still on "step 1". Defaults to False.
 
     Returns:
         List[Dict[str, Any]]: A list of saved sessions for the specified filename.
     """
-    # We use an `offset` instead of a cursor because it is simpler and clearer
-    # while it appears to be performant enough for real-world usage.
-    # Up to ~ 1,000 sessions performs well and is higher than expected for an end-user
-    get_sessions_query = text(
-        """
-    SELECT userdict.indexno
-        ,userdict.filename as filename
-        ,num_keys
-        ,userdictkeys.user_id as user_id
-        ,userdict.modtime as modtime
-        ,userdict.key as key
-        ,jsonstorage.data->'auto_title' as auto_title
-        ,jsonstorage.data->'title' as title
-        ,jsonstorage.data->'description' as description
-        ,jsonstorage.data->'steps' as steps
-        ,jsonstorage.data->'progress' as progress
-        ,jsonstorage.data->'original_interview_filename' as original_interview_filename
-        ,jsonstorage.data->'answer_count' as answer_count
-        ,jsonstorage.data as data
-    FROM userdict 
-    NATURAL JOIN 
-    (
-      SELECT  key
-             ,MAX(modtime) AS modtime
-             ,COUNT(key)   AS num_keys
-      FROM userdict
-      GROUP BY  key
-    ) mostrecent
-    LEFT JOIN userdictkeys
-    ON userdictkeys.key = userdict.key
-    LEFT JOIN jsonstorage
-    ON userdict.key = jsonstorage.key AND (jsonstorage.tags = :metadata)
-    WHERE (userdictkeys.user_id = :user_id or :user_id is null)
-    AND (userdict.filename = :filename OR :filename is null)
-    AND (userdict.filename NOT IN :filenames_to_exclude)
-    AND (NOT :exclude_newly_started_sessions OR num_keys > 1)
-    ORDER BY modtime desc 
-    LIMIT :limit
-    OFFSET :offset;
-    """
-    )
-
     if offset < 0:
         offset = 0
 
@@ -393,10 +351,69 @@ def get_saved_interview_list(
         current_filename = ""
     if not filename_to_exclude:
         filename_to_exclude = ""
-    filenames_to_exclude = []
+    filenames_to_exclude: List[str] = []
+    packages_to_exclude: List[str] = []
     if exclude_filenames:
-        filenames_to_exclude.extend(exclude_filenames)
+        for f in filenames_to_exclude:
+            if f and (":" not in f):
+                packages_to_exclude.append(f)
+            else:
+                filenames_to_exclude.append(f)
     filenames_to_exclude.extend([current_filename, filename_to_exclude])
+
+    query_draft = """
+        SELECT userdict.indexno
+            ,userdict.filename as filename
+            ,num_keys
+            ,userdictkeys.user_id as user_id
+            ,userdict.modtime as modtime
+            ,userdict.key as key
+            ,jsonstorage.data->'auto_title' as auto_title
+            ,jsonstorage.data->'title' as title
+            ,jsonstorage.data->'description' as description
+            ,jsonstorage.data->'steps' as steps
+            ,jsonstorage.data->'progress' as progress
+            ,jsonstorage.data->'original_interview_filename' as original_interview_filename
+            ,jsonstorage.data->'answer_count' as answer_count
+            ,jsonstorage.data as data
+        FROM userdict 
+        NATURAL JOIN 
+        (
+        SELECT  key
+                ,MAX(modtime) AS modtime
+                ,COUNT(key)   AS num_keys
+        FROM userdict
+        GROUP BY  key
+        ) mostrecent
+        LEFT JOIN userdictkeys
+        ON userdictkeys.key = userdict.key
+        LEFT JOIN jsonstorage
+        ON userdict.key = jsonstorage.key AND (jsonstorage.tags = :metadata)
+        WHERE (userdictkeys.user_id = :user_id or :user_id is null)
+        AND (userdict.filename = :filename OR :filename is null)
+        AND (userdict.filename NOT IN :filenames_to_exclude)
+        AND (NOT :exclude_newly_started_sessions OR num_keys > 1)
+        """
+    if packages_to_exclude:
+        query_draft += (
+            """
+            AND (:packages_to_exclude IS NULL OR NOT (
+            """
+            + " OR ".join(
+                [f"userdict.filename LIKE '{name}%'" for name in packages_to_exclude]
+            )
+            + """
+            ))
+        """
+        )
+    query_draft += """
+        ORDER BY modtime desc 
+        LIMIT :limit
+        OFFSET :offset;
+    """
+
+    get_sessions_query = text(query_draft)
+
     if user_id is None:
         if user_logged_in():
             user_id = user_info().id
@@ -427,6 +444,9 @@ def get_saved_interview_list(
                 "offset": offset,
                 "filenames_to_exclude": tuple(filenames_to_exclude),
                 "exclude_newly_started_sessions": exclude_newly_started_sessions,
+                "packages_to_exclude": (
+                    None if not packages_to_exclude else "present"
+                ),  # We need to pass a value to the query, but it's treated as a flag
             },
         )
     sessions = []
@@ -486,10 +506,13 @@ def find_matching_sessions(
     )
 
     # Construct the dynamic part of the SQL query for metadata column selection and keyword search
-    metadata_search_conditions = " OR ".join(
-        f"COALESCE(jsonstorage.data->>{repr(column)}, '') ILIKE '%' || :keyword || '%'"
-        for column in metadata_column_names
-    )
+    if keyword:
+        metadata_search_conditions = " OR ".join(
+            f"COALESCE(jsonstorage.data->>{repr(column)}, '') ILIKE '%' || :keyword || '%'"
+            for column in metadata_column_names
+        )
+    else:
+        metadata_search_conditions = "TRUE"
 
     # we retrieve the default metadata columns even if we don't search them
     metadata_column_names = set(metadata_column_names).union(
@@ -565,19 +588,23 @@ def find_matching_sessions(
             log("Asked to get interview list for user that is not logged in")
             return []
 
+    parameters = {
+        "metadata": metadata_key_name,
+        "keyword": keyword,
+        "user_id": user_id,
+        "limit": limit,
+        "offset": offset,
+        "filenames_to_exclude": tuple(filenames_to_exclude),
+        "exclude_newly_started_sessions": exclude_newly_started_sessions,
+    }
+
+    # Add filename parameters
+    if filenames:
+        for i, filename in enumerate(filenames):
+            parameters[f"filename{i}"] = filename
+
     with db.connect() as con:
-        rs = con.execute(
-            get_sessions_query,
-            {
-                "metadata": metadata_key_name,
-                "keyword": keyword,
-                "user_id": user_id,
-                "limit": limit,
-                "offset": offset,
-                "filenames_to_exclude": tuple(filenames_to_exclude),
-                "exclude_newly_started_sessions": exclude_newly_started_sessions,
-            },
-        )
+        rs = con.execute(get_sessions_query, parameters)
 
     sessions = []
     for session in rs:
@@ -921,7 +948,7 @@ def session_list_html(
         metadata_key_name (str, optional): Name of the metadata key. Defaults to "metadata".
         filename_to_exclude (str, optional): Name of the file to exclude. Defaults to `al_session_store_default_filename`.
         exclude_current_filename (bool, optional): If True, excludes the current filename. Defaults to True.
-        exclude_filenames (Optional[List[str]], optional): List of filenames to exclude. Defaults to None.
+        exclude_filenames (Optional[List[str]], optional): List of filenames to exclude. Defaults to None. If the `filename` does not contain a `:` it will be treated as a prefix, allowing you to filter out whole packages (e.g., any path starting with docassemble.ALDashboard or docassemble.playground)
         exclude_newly_started_sessions (bool, optional): If True, excludes newly started sessions. Defaults to False.
         name_label (str, optional): Label for the session name/title. Defaults to translated word "Title".
         date_label (str, optional): Label for the date column. Defaults to translated word "Date modified".
@@ -938,6 +965,7 @@ def session_list_html(
         limit (int, optional): Limit for the number of sessions returned. Defaults to 50.
         offset (int, optional): Offset for the session list. Defaults to 0.
 
+
     Returns:
         str: HTML-formatted table containing the list of user sessions.
     """

{docassemble_assemblyline-3.0.1 → docassemble_assemblyline-3.1.0}/docassemble/AssemblyLine/test_al_general.py

@@ -61,6 +61,8 @@ class TestALIndividual(unittest.TestCase):
         # Assigning this_thread to self.individual
         self.individual.this_thread = self.this_thread
 
+        self.individual.name.first = "John"
+
     def test_phone_numbers(self):
         self.assertEqual(self.individual.phone_numbers(), "")
         self.individual.phone_number = ""
@@ -423,9 +425,7 @@ class TestALIndividual(unittest.TestCase):
         self.assertEqual(self.individual.pronoun_possessive("fish"), "xem fish")
 
         self.individual.pronouns_self_described = "Xe/Xir/Xirs/xem/xirself"
-        # Should raise an exception
-        with self.assertRaises(DAAttributeError):
-            self.individual.pronoun_objective()
+        self.assertEqual(self.individual.pronoun_objective(), "John")
 
     def test_name_methods(self):
         self.individual.name.first = "John"

{docassemble_assemblyline-3.0.1 → docassemble_assemblyline-3.1.0/docassemble.AssemblyLine.egg-info}/PKG-INFO

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

{docassemble_assemblyline-3.0.1 → docassemble_assemblyline-3.1.0}/setup.py

@@ -44,7 +44,7 @@ def find_package_data(where='.', package='', exclude=standard_exclude, exclude_d
     return out
 
 setup(name='docassemble.AssemblyLine',
-      version='3.0.1',
+      version='3.1.0',
       description=(''),
       long_description='# Suffolk LIT Lab Document Assembly Line\r\n\r\n[![PyPI version](https://badge.fury.io/py/docassemble-AssemblyLine.svg)](https://badge.fury.io/py/docassemble-AssemblyLine)\r\n\r\n<img src="https://user-images.githubusercontent.com/7645641/142245862-c2eb02ab-3090-4e97-9653-bb700bf4c54d.png" alt="drawing" width="300" alt="work together" style="align: center;"/>\r\n\r\nThe Assembly Line Project is a collection of volunteers, students, and institutions who joined together\r\nduring the COVID-19 pandemic to help increase access to the court system. Our vision is mobile-friendly,\r\neasy to use **guided** online forms that help empower litigants to access the court remotely.\r\n\r\nOur signature project is [CourtFormsOnline.org](https://courtformsonline.org).\r\n\r\nWe designed a step-by-step, assembly line style process for automating court forms on top of Docassemble\r\nand built several tools along the way that **you** can use in your home jurisdiction.\r\n\r\nThis package contains **runtime code** and **pre-written questions** to support authoring robust, \r\nconsistent, and attractive Docassemble interviews that help complete court forms.\r\n\r\nRead more on our [documentation page](https://suffolklitlab.org/docassemble-AssemblyLine-documentation/).\r\n\r\n\r\n# Related repositories\r\n\r\n* https://github.com/SuffolkLitLab/docassemble-ALWeaver\r\n* https://github.com/SuffolkLitLab/docassemble-ALMassachusetts\r\n* https://github.com/SuffolkLitLab/docassemble-MassAccess\r\n* https://github.com/SuffolkLitLab/docassemble-ALThemeTemplate\r\n* https://github.com/SuffolkLitLab/EfileProxyServer\r\n\r\n# Documentation\r\n\r\nhttps://suffolklitlab.org/docassemble-AssemblyLine-documentation/\r\n\r\n# Installation\r\n\r\n## Menu-driven installation\r\n\r\nThe recommended installation method is with the [guided installation script](https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/installation).\r\n\r\n## Manual installation\r\n\r\nNormally you do not need to manually install the Assembly Line. Use the [installation script](https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/installation)\r\nif you can. The instructions below are for your optional reference.\r\n\r\nThis package depends on the following configuration changes on your Docassemble server:\r\n\r\n* Ensure that [font-awesome](https://docassemble.org/docs/config.html#default%20icons) is enabled (this may be on by default:\r\n```yaml\r\ndefault icons: font awesome\r\n```\r\n* Add a [Google API key](https://docassemble.org/docs/config.html#google) that has access to:\r\n    * Google Places API\r\n    * Google Geocoding API\r\n* Add a [VoiceRSS API key](https://docassemble.org/docs/config.html#voicerss)\r\n* Add a [Twilio API key](https://docassemble.org/docs/config.html#twilio) for SMS support\r\n* Add an email account: [Mailgun](https://docassemble.org/docs/config.html#mailgun%20api) or [SendGrid](https://docassemble.org/docs/config.html#sendgrid%20api) recommended for email support\r\n* To show package update time and to enable the feedback form, add a GitHub Private Access token to your config.yml file, like this:\r\n```yaml\r\n# Needs access to create new issues on repositories\r\ngithub issues:\r\n  username: "suffolklitlab-issues"\r\n  token: "12345"\r\n# Does not need any special access to public repositories  \r\ngithub readonly:\r\n  username: "suffolklitlab-issues"\r\n  password: "45678"\r\n  type: "basic"\r\n```\r\n* If you are also using the [Assembly Line Weaver](https://github.com/SuffolkLITLab/docassemble-assemblylinewizard), you may want to set up a [Docassemble API key](https://docassemble.org/docs/api.html#manage_api) in your config.yml file to allow you to install packages automatically, like this:\r\n```yaml\r\ninstall packages api key: 12345\r\n```\r\n\r\n# Migration\r\n\r\nSee [discussion here](https://github.com/SuffolkLITLab/docassemble-AssemblyLine/issues/69)\r\n\r\n\r\n# ALDocument class\r\n\r\n## Purpose\r\n\r\nThe ALDocument class is a small utility library that makes it simpler to use the following features in an interview:\r\n\r\n* Conditional assembly of multiple, optional documents that are triggered in different ways in your interview\r\n* An addendum for PDF files that makes it simple to deal with overflow text\r\n* A customizable download screen that lists the documents in a neat table\r\n* A customizable "send" button that allows the user to email the final forms to a location of their choice\r\n\r\nHere is a small snippet that you can copy and modify that shows how to use the most important features of the ALDocument class.\r\n\r\n```\r\n---\r\nobjects:\r\n  - CRA_Motion_to_Dismiss_attachment: ALDocument.using(filename="CRA_Motion_to_Dismiss", title="Motion to Dismiss CRA", enabled=True, has_addendum=True, default_overflow_message="[See addendum]")  \r\n---\r\nobjects:\r\n  - al_user_bundle: ALDocumentBundle.using(elements=[CRA_Motion_to_Dismiss_attachment], title="Forms to download and deliver to court", filename="motion_to_dismiss_CRA.pdf")\r\n  - al_court_bundle: ALDocumentBundle.using(elements=[CRA_Motion_to_Dismiss_attachment], title="Forms to download and deliver to court", filename="motion_to_dismiss_CRA.pdf")\r\n---\r\ngeneric object: ALDocument\r\nattachment:\r\n  variable name: x.addendum\r\n  docx template file: docx_addendum.docx\r\n---\r\ncode: |\r\n  CRA_Motion_to_Dismiss_attachment.overflow_fields[\'reasons_for_request\'].overflow_trigger = 640\r\n  CRA_Motion_to_Dismiss_attachment.overflow_fields[\'reasons_for_request\'].label = "Reasons for request"\r\n  CRA_Motion_to_Dismiss_attachment.overflow_fields.gathered = True\r\n  \r\n---\r\nattachment:\r\n    variable name: CRA_Motion_to_Dismiss_attachment[i]\r\n    name: CRA Motion to Dismiss\r\n    filename: CRA_Motion_to_Dismiss\r\n    skip undefined: True\r\n    pdf template file: CRA_Motion_to_Dismiss.pdf\r\n    fields: \r\n      - "court_county": ${ trial_court.address.county }\r\n      - "docket_number": ${ docket_number }\r\n      - "user_signature": ${ users[0].signature_if_final(i) }\r\n      - "signature_date": ${ signature_date }\r\n```\r\n\r\nIt is very common to have a *contingent* document in ALDocument. If your document is contingent, remove the `enabled=True` from the object declaration, and use\r\nsome other method to "turn on" the attachment.\r\n\r\nE.g.,\r\n\r\n```\r\ncode: |\r\n  CRA_Motion_to_Dismiss_attachment.enabled = condition1 and condition2\r\n```\r\n\r\n# Changelog\r\n\r\nSee [CHANGELOG.MD](https://github.com/SuffolkLITLab/docassemble-AssemblyLine/blob/main/CHANGELOG.md)\r\n',
       long_description_content_type='text/markdown',

docassemble_assemblyline-3.0.1/docassemble/AssemblyLine/__init__.py

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