chatterer 0.1.24__py3-none-any.whl → 0.1.26__py3-none-any.whl

chatterer/examples/pw.py

@@ -1,137 +1,143 @@
-import json
-import logging
-import sys
-from pathlib import Path
-
-from spargear import BaseArguments, RunnableArguments, SubcommandSpec
-
-from chatterer import PlayWrightBot
-
-logger = logging.getLogger(__name__)
-
-
-# Define the default path location relative to this script file
-DEFAULT_JSON_PATH = Path(__file__).resolve().parent / "session_state.json"
-
-
-class ReadArgs(RunnableArguments[None]):
-    """Arguments for the 'read' subcommand."""
-
-    URL: str
-    """URL (potentially protected) to navigate to using the saved session."""
-    jsonpath: Path = DEFAULT_JSON_PATH
-    """Path to the session state JSON file to load."""
-
-    def run(self) -> None:
-        """
-        Loads the session state from the specified JSON file, then navigates
-        to a protected_url that normally requires login. If the stored session
-        is valid, it should open without re-entering credentials.
-
-        Correction: Loads the JSON content into a dict first to satisfy type hints.
-        """
-        url = self.URL
-        jsonpath = self.jsonpath
-        logger.info(f"Loading session from {jsonpath} and navigating to {url} ...")
-
-        if not jsonpath.exists():
-            logger.error(f"Session file not found at {jsonpath}")
-            sys.exit(1)
-
-        # Load the storage state from the JSON file into a dictionary
-        logger.info(f"Reading storage state content from {jsonpath} ...")
-        try:
-            with open(jsonpath, "r", encoding="utf-8") as f:
-                # This dictionary should match the 'StorageState' type expected by Playwright/chatterer
-                storage_state_dict = json.load(f)
-        except json.JSONDecodeError:
-            logger.error(f"Failed to decode JSON from {jsonpath}")
-            sys.exit(1)
-        except Exception as e:
-            logger.error(f"Error reading file {jsonpath}: {e}")
-            sys.exit(1)
-
-        logger.info("Launching browser with loaded session state...")
-        with PlayWrightBot(
-            playwright_launch_options={"headless": False},
-            # Pass the loaded dictionary, which should match the expected 'StorageState' type
-            playwright_persistency_options={"storage_state": storage_state_dict},
-        ) as bot:
-            bot.get_page(url)
-
-            logger.info("Press Enter in the console when you're done checking the protected page.")
-            input("    >> Press Enter to exit: ")
-
-        logger.info("Done! Browser is now closed.")
-
-
-class WriteArgs(RunnableArguments[None]):
-    """Arguments for the 'write' subcommand."""
-
-    URL: str
-    """URL to navigate to for manual login."""
-    jsonpath: Path = DEFAULT_JSON_PATH
-    """Path to save the session state JSON file."""
-
-    def run(self) -> None:
-        """
-        Launches a non-headless browser and navigates to the login_url.
-        The user can manually log in, then press Enter in the console
-        to store the current session state into a JSON file.
-        """
-        url = self.URL
-        jsonpath = self.jsonpath
-        logger.info(f"Launching browser and navigating to {url} ... Please log in manually.")
-
-        # Ensure jsonpath directory exists
-        jsonpath.parent.mkdir(parents=True, exist_ok=True)
-
-        with PlayWrightBot(playwright_launch_options={"headless": False}) as bot:
-            bot.get_page(url)
-
-            logger.info("After completing the login in the browser, press Enter here to save the session.")
-            input("    >> Press Enter when ready: ")
-
-            # get_sync_browser() returns the BrowserContext internally
-            context = bot.get_sync_browser()
-
-            # Save the current session (cookies, localStorage) to a JSON file
-            logger.info(f"Saving storage state to {jsonpath} ...")
-            context.storage_state(path=jsonpath)  # Pass Path object directly
-
-        logger.info("Done! Browser is now closed.")
-
-
-class Arguments(BaseArguments):
-    """
-    A simple CLI tool for saving and using Playwright sessions via storage_state.
-    Uses spargear for declarative argument parsing.
-    """
-
-    read: SubcommandSpec[ReadArgs] = SubcommandSpec(
-        name="read",
-        argument_class=ReadArgs,
-        help="Use a saved session to view a protected page.",
-        description="Loads session state from the specified JSON file and navigates to the URL.",
-    )
-    write: SubcommandSpec[WriteArgs] = SubcommandSpec(
-        name="write",
-        argument_class=WriteArgs,
-        help="Save a new session by manually logging in.",
-        description="Launches a browser to the specified URL. Log in manually, then press Enter to save session state.",
-    )
-
-    def run(self) -> None:
-        """Parses arguments using spargear and executes the corresponding command."""
-        if isinstance(last_subcommand := self.last_command, RunnableArguments):
-            last_subcommand.run()
-        else:
-            self.get_parser().print_help()
-
-
-def main() -> None:
-    Arguments().run()
-
-
-if __name__ == "__main__":
-    main()
+import json
+import logging
+import sys
+from pathlib import Path
+
+from spargear import ArgumentSpec, BaseArguments, RunnableArguments, SubcommandSpec
+
+from chatterer import PlayWrightBot
+
+logger = logging.getLogger(__name__)
+
+
+def generate_json_path() -> Path:
+    return Path("session_state.json").resolve()
+
+
+class ReadArgs(RunnableArguments[None]):
+    """Arguments for the 'read' subcommand."""
+
+    URL: str
+    """URL (potentially protected) to navigate to using the saved session."""
+    json: ArgumentSpec[Path] = ArgumentSpec(
+        ["--json", "-j"],
+        default_factory=generate_json_path,
+        help="Path to the session state JSON file to load.",
+    )
+
+    def run(self) -> None:
+        """
+        Loads the session state from the specified JSON file, then navigates
+        to a protected_url that normally requires login. If the stored session
+        is valid, it should open without re-entering credentials.
+
+        Correction: Loads the JSON content into a dict first to satisfy type hints.
+        """
+        url = self.URL
+        jsonpath = self.json.unwrap()
+        logger.info(f"Loading session from {jsonpath} and navigating to {url} ...")
+
+        if not jsonpath.exists():
+            logger.error(f"Session file not found at {jsonpath}")
+            sys.exit(1)
+
+        # Load the storage state from the JSON file into a dictionary
+        logger.info(f"Reading storage state content from {jsonpath} ...")
+        try:
+            with open(jsonpath, "r", encoding="utf-8") as f:
+                # This dictionary should match the 'StorageState' type expected by Playwright/chatterer
+                storage_state_dict = json.load(f)
+        except json.JSONDecodeError:
+            logger.error(f"Failed to decode JSON from {jsonpath}")
+            sys.exit(1)
+        except Exception as e:
+            logger.error(f"Error reading file {jsonpath}: {e}")
+            sys.exit(1)
+
+        logger.info("Launching browser with loaded session state...")
+        with PlayWrightBot(
+            playwright_launch_options={"headless": False},
+            # Pass the loaded dictionary, which should match the expected 'StorageState' type
+            playwright_persistency_options={"storage_state": storage_state_dict},
+        ) as bot:
+            bot.get_page(url)
+
+            logger.info("Press Enter in the console when you're done checking the protected page.")
+            input("    >> Press Enter to exit: ")
+
+        logger.info("Done! Browser is now closed.")
+
+
+class WriteArgs(RunnableArguments[None]):
+    """Arguments for the 'write' subcommand."""
+
+    URL: str
+    """URL to navigate to for manual login."""
+    json: ArgumentSpec[Path] = ArgumentSpec(
+        ["--json", "-j"],
+        default_factory=generate_json_path,
+        help="Path to save the session state JSON file.",
+    )
+
+    def run(self) -> None:
+        """
+        Launches a non-headless browser and navigates to the login_url.
+        The user can manually log in, then press Enter in the console
+        to store the current session state into a JSON file.
+        """
+        url = self.URL
+        jsonpath = self.json.unwrap()
+        logger.info(f"Launching browser and navigating to {url} ... Please log in manually.")
+
+        # Ensure jsonpath directory exists
+        jsonpath.parent.mkdir(parents=True, exist_ok=True)
+
+        with PlayWrightBot(playwright_launch_options={"headless": False}) as bot:
+            bot.get_page(url)
+
+            logger.info("After completing the login in the browser, press Enter here to save the session.")
+            input("    >> Press Enter when ready: ")
+
+            # get_sync_browser() returns the BrowserContext internally
+            context = bot.get_sync_browser()
+
+            # Save the current session (cookies, localStorage) to a JSON file
+            logger.info(f"Saving storage state to {jsonpath} ...")
+            context.storage_state(path=jsonpath)  # Pass Path object directly
+
+        logger.info("Done! Browser is now closed.")
+
+
+class Arguments(BaseArguments):
+    """
+    A simple CLI tool for saving and using Playwright sessions via storage_state.
+    Uses spargear for declarative argument parsing.
+    """
+
+    read: SubcommandSpec[ReadArgs] = SubcommandSpec(
+        name="read",
+        argument_class=ReadArgs,
+        help="Use a saved session to view a protected page.",
+        description="Loads session state from the specified JSON file and navigates to the URL.",
+    )
+    write: SubcommandSpec[WriteArgs] = SubcommandSpec(
+        name="write",
+        argument_class=WriteArgs,
+        help="Save a new session by manually logging in.",
+        description="Launches a browser to the specified URL. Log in manually, then press Enter to save session state.",
+    )
+
+    def run(self) -> None:
+        """Parses arguments using spargear and executes the corresponding command."""
+        if isinstance(last_subcommand := self.last_command, RunnableArguments):
+            last_subcommand.run()
+        else:
+            self.get_parser().print_help()
+
+
+def main() -> None:
+    Arguments().run()
+
+
+if __name__ == "__main__":
+    main()

chatterer/examples/snippet.py

@@ -1,55 +1,56 @@
-import logging
-from pathlib import Path
-from typing import Optional
-
-from spargear import RunnableArguments
-
-from chatterer import CodeSnippets
-
-logger = logging.getLogger(__name__)
-
-
-class Arguments(RunnableArguments[CodeSnippets]):
-    PATH_OR_PACKAGE_NAME: str
-    """Path to the package or file from which to extract code snippets."""
-    output: Optional[str] = None
-    """Output path for the extracted code snippets. If not provided, defaults to a file with the same name as the input."""
-    ban_file_patterns: list[str] = [".venv/*", Path(__file__).relative_to(Path.cwd()).as_posix()]
-    """List of file patterns to ignore."""
-    glob_patterns: list[str] = ["*.py"]
-    """List of glob patterns to include."""
-    case_sensitive: bool = False
-    """Enable case-sensitive matching for glob patterns."""
-    prevent_save_file: bool = False
-    """Prevent saving the extracted code snippets to a file."""
-
-    def run(self) -> CodeSnippets:
-        if not self.prevent_save_file:
-            if not self.output:
-                output = Path(__file__).with_suffix(".txt")
-            else:
-                output = Path(self.output)
-        else:
-            output = None
-
-        cs = CodeSnippets.from_path_or_pkgname(
-            path_or_pkgname=self.PATH_OR_PACKAGE_NAME,
-            ban_file_patterns=self.ban_file_patterns,
-            glob_patterns=self.glob_patterns,
-            case_sensitive=self.case_sensitive,
-        )
-        if output is not None:
-            output.parent.mkdir(parents=True, exist_ok=True)
-            output.write_text(cs.snippets_text, encoding="utf-8")
-            logger.info(f"Extracted code snippets from `{self.PATH_OR_PACKAGE_NAME}` and saved to `{output}`.")
-        else:
-            logger.info(f"Extracted code snippets from `{self.PATH_OR_PACKAGE_NAME}`.")
-        return cs
-
-
-def main() -> None:
-    Arguments().run()
-
-
-if __name__ == "__main__":
-    main()
+import logging
+from datetime import datetime
+from pathlib import Path
+from typing import Optional
+
+from spargear import RunnableArguments
+
+from chatterer import CodeSnippets
+
+logger = logging.getLogger(__name__)
+
+
+class Arguments(RunnableArguments[CodeSnippets]):
+    PATH_OR_PACKAGE_NAME: str
+    """Path to the package or file from which to extract code snippets."""
+    output: Optional[str] = None
+    """Output path for the extracted code snippets. If not provided, defaults to a file with the current timestamp."""
+    ban_file_patterns: list[str] = [".venv/*", Path(__file__).relative_to(Path.cwd()).as_posix()]
+    """List of file patterns to ignore."""
+    glob_patterns: list[str] = ["*.py"]
+    """List of glob patterns to include."""
+    case_sensitive: bool = False
+    """Enable case-sensitive matching for glob patterns."""
+    prevent_save_file: bool = False
+    """Prevent saving the extracted code snippets to a file."""
+
+    def run(self) -> CodeSnippets:
+        if not self.prevent_save_file:
+            if not self.output:
+                output = Path(datetime.now().strftime("%Y%m%d_%H%M%S") + "_snippets.txt")
+            else:
+                output = Path(self.output)
+        else:
+            output = None
+
+        cs = CodeSnippets.from_path_or_pkgname(
+            path_or_pkgname=self.PATH_OR_PACKAGE_NAME,
+            ban_file_patterns=self.ban_file_patterns,
+            glob_patterns=self.glob_patterns,
+            case_sensitive=self.case_sensitive,
+        )
+        if output is not None:
+            output.parent.mkdir(parents=True, exist_ok=True)
+            output.write_text(cs.snippets_text, encoding="utf-8")
+            logger.info(f"Extracted code snippets from `{self.PATH_OR_PACKAGE_NAME}` and saved to `{output}`.")
+        else:
+            logger.info(f"Extracted code snippets from `{self.PATH_OR_PACKAGE_NAME}`.")
+        return cs
+
+
+def main() -> None:
+    Arguments().run()
+
+
+if __name__ == "__main__":
+    main()