1.19.0

Author: matthewdeanmartin

dedlin/__main__.py

@@ -127,7 +127,7 @@ def document_inputter(prompt: str, text: str = "") -> Generator[str, None, None]
             if not vim_mode:
                 break
         except Exception as the_exception:
-            dedlin.save_on_crash(the_exception, None, None)
+            dedlin.save_on_crash(type(the_exception), the_exception, None)
             print(traceback.format_exc())
             break
     dedlin.final_report()

dedlin/ai_interface.py

@@ -1,6 +1,9 @@
 """
 Code for AI
 """
+import asyncio
+
+import dotenv
 from openai import AsyncOpenAI
 from openai.types.chat import ChatCompletionMessageParam
 
@@ -19,33 +22,39 @@
 
 
 class AiClient:
+    """Client for AI"""
+
     def __init__(self):
+        """Initialize the client"""
         self.client = AsyncOpenAI()
         self.model = "gpt-3.5-turbo"
 
-    async def completion(self, messages: list[ChatCompletionMessageParam]):
+    async def completion(self, messages: list[ChatCompletionMessageParam]) -> str:
+        """Get a completion from the AI"""
         # [{"role": "user", "content": "Hello world"}]
 
         completion = await self.client.chat.completions.create(model=self.model, messages=messages)
         # print(completion.model_dump_json(indent=2))
         # print(dict(completion).get('usage'))
         choice = completion.choices[0]
         print(choice.message.content)
-        return completion
+        return choice.message.content
 
 
 if __name__ == "__main__":
-    import asyncio
 
-    import dotenv
+    def run() -> None:
+        """Example"""
+
+        dotenv.load_dotenv()
 
-    dotenv.load_dotenv()
+        async def main():
+            client = AiClient()
+            content = PROLOGUE + "Tell me about edlin."
+            ask = ChatCompletionMessageParam(content=content, role="user")
+            await client.completion([ask])
 
-    async def main():
-        client = AiClient()
-        content = PROLOGUE + "Tell me about edlin."
-        ask = ChatCompletionMessageParam(content=content, role="user")
-        await client.completion([ask])
+        # Python 3.7+
+        asyncio.run(main())
 
-    # Python 3.7+
-    asyncio.run(main())
+    run()

dedlin/basic_types.py

@@ -296,13 +296,19 @@ class Printable(Protocol):
     """Something that acts like print()"""
 
     def __call__(self, text: Optional[str], end: str = "\n") -> None:
-        ...
+        """Signature of a printable"""
 
 
-def null_printer(text: str, end: str = "") -> None:
-    """
-    Do nothing implementation of Printable
-    """
+class NullPrinter:
+    """Something that acts like print()"""
+
+    def __call__(self, text: Optional[str], end: str = "\n") -> None:
+        """
+        Do nothing implementation of Printable
+        """
+
+
+# def null_printer(text: str, end: str = "") -> None:
 
 
 @runtime_checkable
@@ -317,7 +323,6 @@ def generate(
         self,
     ) -> Generator[Command, None, None]:
         """Generate commands"""
-        ...
 
 
 @runtime_checkable
@@ -327,6 +332,8 @@ class StringGeneratorProtocol(Protocol):
     prompt: str
     default: str
 
+    # current_line:int # will we need this?
+
     def generate(
         self,
     ) -> Generator[str, None, None]:

dedlin/command_sources.py

@@ -83,6 +83,20 @@ def questionary_command_handler(prompt: str = "*") -> Generator[str, None, None]
         yield answer
 
 
+class CommandGeneratorProtocol:
+    def __init__(self, path: Path):
+        """Initialize the generator"""
+        self.current_line: int = 0
+        self.document_length: int = 0
+        self.macro_path: Path = path
+        self.prompt: str = "> "
+
+    def generate(
+        self,
+    ) -> Generator[Command, None, None]:
+        """Turn a file into a bunch of commands"""
+
+
 class CommandGenerator:
     """Get a typed command from a file"""
 

dedlin/document.py

@@ -263,7 +263,8 @@ def edit(self, line_number: int) -> EditStatus:
         # end up with a reference to a static, past state of the prompt and line number
         input_generator = self.edit_inputter.generate()
         try:
-            self.edit_inputter.current_line = f"   {line_number} : "
+            # does this next line have any impact? If so, all inputters need this property.
+            # self.edit_inputter.current_line = f"   {line_number} : "
             self.edit_inputter.default = line_text
             new_line = next(input_generator)
         except StopIteration:
@@ -339,7 +340,7 @@ def insert(
                 self.current_line = line_number
                 line_number += 1
         logger.debug(f"Inserted at {line_number}")
-        return Phrases(accumulated_lines)
+        return Phrases(tuple(accumulated_lines))
 
     def lorem(self, line_range: Optional[LineRange]) -> None:
         """Add lorem ipsum to lines"""
@@ -400,3 +401,13 @@ def backup(self) -> None:
         # TODO: call a mutator method instead of assigning to self.previous_lines
         self.previous_lines = self.lines.copy()
         self.previous_current_line = self.current_line
+
+    def print(self, line_range: Optional[LineRange]) -> Generator[tuple[str, str], None, None]:
+        """For handing lines off to a print() function"""
+        for line in self.lines[line_range.start - 1 : line_range.end]:
+            if line.endswith("\n"):
+                line = line[:-1]
+                end = "\n"
+            else:
+                end = ""
+            yield line, end

dedlin/document_sources.py

@@ -19,11 +19,11 @@
     import win32console
 
     PROBABLY_WINDOWS = True
-    STANDARD_IN = win32console.GetStdHandle(win32console.STD_INPUT_HANDLE)
 
 
 # alternate windows: https://stackoverflow.com/a/11616477
 if PROBABLY_WINDOWS:
+    STANDARD_IN_WINDOWS = win32console.GetStdHandle(win32console.STD_INPUT_HANDLE)
 
     def input_with_prefill(prompt: str, default: str = "") -> str:
         """Show prompt and prefill input text with default value.
@@ -39,20 +39,20 @@ def input_with_prefill(prompt: str, default: str = "") -> str:
             evt.KeyDown = True
             keys.append(evt)
 
-        STANDARD_IN.WriteConsoleInput(keys)
+        STANDARD_IN_WINDOWS.WriteConsoleInput(keys)
         return input(prompt)
 
 else:
 
-    def input_with_prefill(prompt: str, text: str = "") -> str:
+    def input_with_prefill(prompt: str, default: str = "") -> str:
         """Show prompt and prefill input text with default value.
 
         Linux/Mac Version
         """
 
         # ref https://stackoverflow.com/a/8505387
         def hook() -> None:
-            readline.insert_text(text)
+            readline.insert_text(default)
             readline.redisplay()
 
         readline.set_pre_input_hook(hook)

dedlin/file_converters.py

@@ -20,7 +20,7 @@ def write_to_markdown(filename: str, lines: list[str]) -> str:
     path = Path(filename)
     if path.suffix == ".md":
         path.rename(path.with_suffix(".html"))
-        path.write_text(html_text)
+        path.write_text(html_text, encoding="utf-8")
     else:
         print("Not markdown!")
     return html_text

dedlin/file_system.py

@@ -9,7 +9,7 @@
 from dedlin.tools.export import export_markdown
 
 
-def read_or_create_file(path: Path) -> list[str]:
+def read_or_create_file(path: Optional[Path]) -> list[str]:
     """Attempt to read file, create if it doesn't exist"""
 
     if path:
@@ -26,7 +26,7 @@ def read_file(path: Optional[Path]) -> list[str]:
     """Read a file and return a list_doc of lines"""
     lines: list[str] = []
 
-    with open(path, encoding="utf-8") as file:
+    with open(str(path), encoding="utf-8") as file:
         for line in file:
             if line.endswith("\n"):
                 lines.append(line[:-1])

dedlin/history_feature.py

@@ -2,6 +2,7 @@
 Manage history on file system
 """
 from pathlib import Path
+from typing import Optional
 
 from dedlin.utils.file_utils import locate_file
 
@@ -20,9 +21,11 @@ def __init__(self, persist: bool = True) -> None:
         """Initialize the history log"""
         self.persist = persist
         if self.persist:
-            self.history_file = self.initialize_history_folder() / self.make_sequential_history_file_name()
+            self.history_file: Optional[Path] = (
+                self.initialize_history_folder() / self.make_sequential_history_file_name()
+            )
         else:
-            self.history_file = None
+            self.history_file: Optional[Path] = None
 
     def initialize_history_folder(self) -> Path:
         """