feat: add list-notes

This also adjusts the note review and adds the new "Show details" menu
item to toggle verbose mode on and off. This has a corresponding config
option "review_verbose".

Author: lervag

README.md

@@ -135,6 +135,8 @@ currently recognized:
 - `query`: Specify default query for `apy list`, `apy review` and `apy tag`.
 - `review_show_cards`: Whether to show list of cards by default during note
   review
+- `review_verbose`: Whether to show note details by default during note
+  review
 
 An example configuration:
 

src/apyanki/anki.py

@@ -388,11 +388,20 @@ def edit_model_css(self, model_name: str) -> None:
             self.col.models.save(model, templates=True)
             self.modified = True
 
-    def list_notes(self, query: str) -> None:
-        """List notes that match a query"""
+    def list_note_questions(self, query: str) -> None:
+        """List first card questions for notes that match a query"""
         for note in self.find_notes(query):
             cards.print_question(note.n.cards()[0])
 
+    def list_notes(
+        self, query: str, show_cards: bool, show_raw_fields: bool, verbose: bool
+    ) -> None:
+        """List notes that match a query"""
+        for note in self.find_notes(query):
+            note.pprint(
+                print_raw=show_raw_fields, list_cards=show_cards, verbose=verbose
+            )
+
     def list_cards(self, query: str, verbose: bool) -> None:
         """List cards that match a query"""
         for cid in self.col.find_cards(query):

src/apyanki/cards.py

@@ -4,6 +4,7 @@
 
 from typing import TYPE_CHECKING
 
+from rich.markdown import Markdown
 from rich.text import Text
 
 from apyanki.console import console, consolePlain
@@ -21,7 +22,7 @@ def card_pprint(card: Card, verbose: bool = True) -> None:
 
     if verbose:
         card_type = ["new", "learning", "review", "relearning"][int(card.type)]
-        columned = [
+        details = [
             f"[yellow]nid:[/yellow] {card.nid}",
             f"[yellow]model:[/yellow] {card.note_type()['name']}",
             f"[yellow]type:[/yellow] {card_type}",
@@ -32,8 +33,8 @@ def card_pprint(card: Card, verbose: bool = True) -> None:
             f"[yellow]ease:[/yellow] {int(card.factor / 10)} %",
             "",
         ]
-        for line in columned:
-            consolePlain.print(line)
+        for detail in details:
+            consolePlain.print(detail)
 
     rendered = card.render_output()
     for title, field in [
@@ -47,7 +48,10 @@ def card_pprint(card: Card, verbose: bool = True) -> None:
         console.print(f"[blue]## {title}[/blue]\n")
         prepared = prepare_field_for_cli(field)
         prepared = prepared.replace("\n\n", "\n")
-        console.print(prepared)
+        if is_markdown:
+            console.print(Markdown(prepared))
+        else:
+            console.print(prepared)
         console.print()
 
 

src/apyanki/cli.py

@@ -397,6 +397,33 @@ def list_cards(query: str, verbose: bool) -> None:
         a.list_cards(query, verbose)
 
 
+@main.command("list-notes")
+@click.argument("query", required=False, nargs=-1)
+@click.option("-c", "--show-cards", is_flag=True, help="Print card specs")
+@click.option("-r", "--show-raw-fields", is_flag=True, help="Print raw field data")
+@click.option("-v", "--verbose", is_flag=True, help="Print note details")
+def list_notes(
+    query: str, show_cards: bool, show_raw_fields: bool, verbose: bool
+) -> None:
+    """List notes 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_notes(query, show_cards, show_raw_fields, verbose)
+
+
 @main.command("list-cards-table")
 @click.argument("query", required=False, nargs=-1)
 @click.option("-a", "--show-answer", is_flag=True, help="Display answer")
@@ -679,7 +706,7 @@ def tag(
             raise click.Abort()
 
         console.print(f"The operation will be applied to {n_notes} matched notes:")
-        a.list_notes(query)
+        a.list_note_questions(query)
         console.print("")
 
         if add_tags is not None:

src/apyanki/config.py

@@ -54,6 +54,7 @@ def get_base_path() -> str | None:
     "profile_name": None,
     "query": "tag:marked OR -flag:0",
     "review_show_cards": False,
+    "review_verbose": False,
 }
 
 # Ensure that cfg has required keys

src/apyanki/note.py

@@ -80,41 +80,47 @@ def __repr__(self) -> str:
 
         return "\n".join(lines)
 
-    def pprint(self, print_raw: bool = False, list_cards: bool = False) -> None:
+    def pprint(
+        self, print_raw: bool = False, list_cards: bool = False, verbose: bool = False
+    ) -> None:
         """Print to screen"""
         from anki import latex
 
         header = f"[green]# Note (nid: {self.n.id})[/green]"
         if self.suspended:
             header += " [red](suspended)[/red]"
-
-        created = strftime("%F %H:%M", localtime(self.n.id / 1000))
-        modified = strftime("%F %H:%M", localtime(self.n.mod))
-        columned = [
-            f"[yellow]model:[/yellow] {self.model_name} ({len(self.n.cards())} cards)",
-            f"[yellow]tags:[/yellow] {self.get_tag_string()}",
-            f"[yellow]created:[/yellow] {created}",
-            f"[yellow]modified:[/yellow] {modified}",
-        ]
-        if self.a.n_decks > 1:
-            columned += ["[yellow]deck:[/yellow] " + self.get_deck()]
-
-        if not list_cards:
-            flagged = [
-                cards.get_flag(c, str(c.template()["name"]))
-                for c in self.n.cards()
-                if c.flags > 0
+        consolePlain.print(header + "\n")
+
+        if verbose:
+            created = strftime("%F %H:%M", localtime(self.n.id / 1000))
+            modified = strftime("%F %H:%M", localtime(self.n.mod))
+            details = [
+                f"[yellow]model:[/yellow] {self.model_name} ({len(self.n.cards())} cards)",
+                f"[yellow]tags:[/yellow] {self.get_tag_string()}",
+                f"[yellow]created:[/yellow] {created}",
+                f"[yellow]modified:[/yellow] {modified}",
             ]
-            if flagged:
-                columned += [f"[yellow]flagged:[/yellow] {', '.join(flagged)}"]
+            if self.a.n_decks > 1:
+                details += ["[yellow]deck:[/yellow] " + self.get_deck()]
+
+            if not list_cards:
+                flagged = [
+                    cards.get_flag(c, str(c.template()["name"]))
+                    for c in self.n.cards()
+                    if c.flags > 0
+                ]
+                if flagged:
+                    details += [f"[yellow]flagged:[/yellow] {', '.join(flagged)}"]
 
-        consolePlain.print(header)
-        consolePlain.print(Columns(columned, width=37))
+            for detail in details:
+                consolePlain.print(detail)
 
         if list_cards:
             self.print_cards()
 
-        console.print()
+        if verbose or list_cards:
+            console.print()
+
         imgs: list[Path] = []
         for name, field in self.n.items():
             is_markdown = check_if_generated_from_markdown(field)
@@ -441,6 +447,7 @@ def review(
             "N": "Change model",
             "s": "Save and stop",
             "v": "Show cards",
+            "V": "Show details",
             "x": "Save and stop",
         }
 
@@ -471,14 +478,15 @@ def review(
         )
 
         print_raw_fields = False
-        refresh = True
+        verbose = cfg["review_verbose"]
         show_cards = cfg["review_show_cards"]
+        refresh = True
         while True:
             if refresh:
                 console.clear()
                 console.print(menu)
                 console.print("")
-                self.pprint(print_raw_fields, list_cards=show_cards)
+                self.pprint(print_raw_fields, list_cards=show_cards, verbose=verbose)
 
             refresh = True
             choice = readchar.readchar()
@@ -560,6 +568,12 @@ def review(
 
             if action == "Show cards":
                 show_cards = not show_cards
+                cfg["review_show_cards"] = show_cards
+                continue
+
+            if action == "Show details":
+                verbose = not verbose
+                cfg["review_verbose"] = verbose
                 continue