Prefer get_cli_parser() over get_cli_args()

Because get_cli_parser() is more flexible and allow for specifying
additional arguments within an analyzer context, it is now recommended
instead of get_cli_args(). With that, get_cli_args() is now deprecated
and will be removed in ICA v3.

Author: caleb531

README.md

@@ -127,7 +127,7 @@ def main() -> None:
     # Allow your program to accept all the same CLI arguments as the `ica`
     # command; you can skip calling this if have other means of specifying the
     # contact name and output format
-    cli_args = ica.get_cli_args()
+    cli_args = ica.get_cli_parser().parse_args()
     # Retrieve the dataframes corresponding to the massaged contents of the
     # database; dataframes include `message` and `attachment`
     dfs = ica.get_dataframes(

ica/analyzers/attachment_totals.py

@@ -11,7 +11,7 @@ def main() -> None:
     Generate count data by attachment type, including number of Spotify links
     shared, YouTube videos, Apple Music, etc.
     """
-    cli_args = ica.get_cli_args()
+    cli_args = ica.get_cli_parser().parse_args()
     dfs = ica.get_dataframes(
         contact_name=cli_args.contact_name, timezone=cli_args.timezone
     )

ica/analyzers/message_totals.py

@@ -78,7 +78,7 @@ def main() -> None:
     Generate a summary of message and reaction counts, by person and in total,
     as well as other insightful metrics
     """
-    cli_args = ica.get_cli_args()
+    cli_args = ica.get_cli_parser().parse_args()
     dfs = ica.get_dataframes(
         contact_name=cli_args.contact_name, timezone=cli_args.timezone
     )

ica/analyzers/most_frequent_emojis.py

@@ -28,7 +28,7 @@ def main() -> None:
     Generates count data for the top 10 most frequently used emojis across the
     entire conversation
     """
-    cli_args = ica.get_cli_args()
+    cli_args = ica.get_cli_parser().parse_args()
     dfs = ica.get_dataframes(
         contact_name=cli_args.contact_name, timezone=cli_args.timezone
     )

ica/analyzers/totals_by_day.py

@@ -13,7 +13,7 @@ def main() -> None:
     Generates a comprehensive breakdown of message totals for every day you and
     the other person have been messaging in the conversation
     """
-    cli_args = ica.get_cli_args()
+    cli_args = ica.get_cli_parser().parse_args()
     dfs = ica.get_dataframes(
         contact_name=cli_args.contact_name, timezone=cli_args.timezone
     )

ica/analyzers/transcript.py

@@ -17,7 +17,7 @@ def main() -> None:
     Generates a full, unedited transcript of every message, including
     reactions, between you and the other person (attachment files not included)
     """
-    cli_args = ica.get_cli_args()
+    cli_args = ica.get_cli_parser().parse_args()
     dfs = ica.get_dataframes(
         contact_name=cli_args.contact_name, timezone=cli_args.timezone
     )

ica/cli.py

@@ -71,12 +71,9 @@ def get_cli_parser() -> argparse.ArgumentParser:
 
 def get_cli_args() -> argparse.Namespace:
     """
-    Parse user arguments from the command line
+    [DEPRECATED]: Parse user arguments from the command line
     """
-    # parse_known_args() is slightly different from parse_args() in that the
-    # former returns a two-item tuple where the first item is the Namespace of
-    # known arguments, and the second item is a list of any unknown arguments
-    return get_cli_parser().parse_known_args()[0]
+    return get_cli_parser().parse_args()
 
 
 def run_analyzer(analyzer: str) -> None:
@@ -111,7 +108,10 @@ def main() -> None:
     global did_user_invoke_cli_directly
     did_user_invoke_cli_directly = True
 
-    cli_args = get_cli_args()
+    # parse_known_args() is slightly different from parse_args() in that the
+    # former returns a two-item tuple where the first item is the Namespace of
+    # known arguments, and the second item is a list of any unknown arguments
+    cli_args = get_cli_parser().parse_known_args()[0]
 
     try:
         run_analyzer(cli_args.analyzer)