feat: add list-cards command

Author: lervag

src/apyanki/anki.py

@@ -393,6 +393,11 @@ def list_notes(self, query: str) -> None:
         for note in self.find_notes(query):
             cards.print_question(note.n.cards()[0])
 
+    def list_cards(self, query: str, verbose: bool) -> None:
+        """List cards that match a query"""
+        for cid in self.col.find_cards(query):
+            cards.card_pprint(self.col.get_card(cid), verbose)
+
     def list_cards_as_table(self, query: str, opts_display: dict[str, bool]) -> None:
         """List cards that match a query in tabular format"""
         width = console.width - 1

src/apyanki/cards.py

@@ -6,13 +6,51 @@
 
 from rich.text import Text
 
-from apyanki.console import console
+from apyanki.console import console, consolePlain
+from apyanki.fields import check_if_generated_from_markdown, prepare_field_for_cli
 from apyanki.fields import prepare_field_for_cli_oneline
 
 if TYPE_CHECKING:
     from anki.cards import Card
 
 
+def card_pprint(card: Card, verbose: bool = True) -> None:
+    """Pretty print a card."""
+    flag = get_flag(card)
+    consolePlain.print(f"[green]# Card (cid: {card.id})[/green]{flag}\n")
+
+    if verbose:
+        card_type = ["new", "learning", "review", "relearning"][int(card.type)]
+        columned = [
+            f"[yellow]nid:[/yellow] {card.nid}",
+            f"[yellow]model:[/yellow] {card.note_type()['name']}",
+            f"[yellow]type:[/yellow] {card_type}",
+            f"[yellow]due:[/yellow] {card.due} days",
+            f"[yellow]interval:[/yellow] {card.ivl} days",
+            f"[yellow]repetitions:[/yellow] {card.reps}",
+            f"[yellow]lapses:[/yellow] {card.lapses}",
+            f"[yellow]ease:[/yellow] {int(card.factor / 10)} %",
+            "",
+        ]
+        for line in columned:
+            consolePlain.print(line)
+
+    rendered = card.render_output()
+    for title, field in [
+        ["Front", rendered.question_text],
+        ["Back", rendered.answer_text],
+    ]:
+        is_markdown = check_if_generated_from_markdown(field)
+        if is_markdown:
+            title += " [italic](markdown)[/italic]"
+
+        console.print(f"[blue]## {title}[/blue]\n")
+        prepared = prepare_field_for_cli(field)
+        prepared = prepared.replace("\n\n", "\n")
+        console.print(prepared)
+        console.print()
+
+
 def card_field_to_text(field: str, max_width: int = 0) -> Text:
     prepared_field = prepare_field_for_cli_oneline(field)
     if max_width > 0:

src/apyanki/cli.py

@@ -374,6 +374,29 @@ def rename(old_name: str, new_name: str) -> None:
         a.rename_model(old_name, new_name)
 
 
+@main.command("list-cards")
+@click.argument("query", required=False, nargs=-1)
+@click.option("-v", "--verbose", is_flag=True, help="Print details for each card")
+def list_cards(query: str, verbose: bool) -> None:
+    """List cards that match QUERY.
+
+    The default QUERY is "tag:marked OR -flag:0". This default can be
+    customized in the config file `~/.config/apy/apy.json`, e.g. with
+
+    \b
+    {
+      "query": "tag:marked OR tag:leech"
+    }
+    """
+    if query:
+        query = " ".join(query)
+    else:
+        query = cfg["query"]
+
+    with Anki(**cfg) as a:
+        a.list_cards(query, verbose)
+
+
 @main.command("list-cards-table")
 @click.argument("query", required=False, nargs=-1)
 @click.option("-a", "--show-answer", is_flag=True, help="Display answer")

src/apyanki/note.py

@@ -158,7 +158,7 @@ def print_cards(self) -> None:
         table.add_column("Interval", justify="right", header_style="white")
         table.add_column("Reps", justify="right", header_style="white")
         table.add_column("Lapses", justify="right", header_style="white")
-        table.add_column("Factor", justify="right", header_style="white")
+        table.add_column("Ease", justify="right", header_style="white")
         for card in sorted(self.n.cards(), key=lambda x: x.factor):
             table.add_row(
                 "- " + str(card.template()["name"]) + cards.get_flag(card),