From 69ce1d4ee337497757b108b40233c3077173609f Mon Sep 17 00:00:00 2001
From: MMA <58857539+TheGeeKing@users.noreply.github.com>
Date: Tue, 15 Aug 2023 17:39:35 +0200
Subject: [PATCH] Add verbose parameter to functions

Changed:
- `sey_key` and `get_key` have now verbose parameter. Default verbose was True for `get_key`, so `sey_key` and `get_key` have True by default.
- `sey_key` use `with_warn_for_invalid_lines` so I added a verbose parameter to it which is by default True.
- `parse` was also using `with_warn_for_invalid_lines`, it will by default be using `self.verbose`

Resolve https://github.com/theskumar/python-dotenv/issues/467
---
 src/dotenv/main.py | 26 ++++++++++++++++++++------
 1 file changed, 20 insertions(+), 6 deletions(-)

diff --git a/src/dotenv/main.py b/src/dotenv/main.py
index 383b79f4..5b408a9f 100644
--- a/src/dotenv/main.py
+++ b/src/dotenv/main.py
@@ -21,9 +21,20 @@
 logger = logging.getLogger(__name__)
 
 
-def with_warn_for_invalid_lines(mappings: Iterator[Binding]) -> Iterator[Binding]:
+def with_warn_for_invalid_lines(mappings: Iterator[Binding], verbose: bool = True) -> Iterator[Binding]:
+    """
+    The function `with_warn_for_invalid_lines` iterates over a collection of `Binding` objects and
+    yields each object, while also logging a warning message if the object has an error and the
+    `verbose` flag is set to `True`.
+
+    Parameters:
+        mappings: An iterator of `Binding` objects. Each `Binding` object represents a line in a file being parsed. It contains information about the line number, the original line content, and any parsing errors encountered
+        verbose: Whether or not to display warnings for invalid lines. If set to True, warnings will be displayed. If set to False, warnings will be suppressed, defaults to True
+    Returns:
+        Iterator[Binding]: An iterator of `Binding` objects, each representing a line in a file being parsed
+    """
     for mapping in mappings:
-        if mapping.error:
+        if mapping.error and verbose:
             logger.warning(
                 "Python-dotenv could not parse statement starting at line %s",
                 mapping.original.line,
@@ -80,7 +91,7 @@ def dict(self) -> Dict[str, Optional[str]]:
 
     def parse(self) -> Iterator[Tuple[str, Optional[str]]]:
         with self._get_stream() as stream:
-            for mapping in with_warn_for_invalid_lines(parse_stream(stream)):
+            for mapping in with_warn_for_invalid_lines(parse_stream(stream), verbose=self.verbose):
                 if mapping.key is not None:
                     yield mapping.key, mapping.value
 
@@ -116,6 +127,7 @@ def get(self, key: str) -> Optional[str]:
 def get_key(
     dotenv_path: StrPath,
     key_to_get: str,
+    verbose: bool = True,
     encoding: Optional[str] = "utf-8",
 ) -> Optional[str]:
     """
@@ -123,7 +135,7 @@ def get_key(
 
     Returns `None` if the key isn't found or doesn't have a value.
     """
-    return DotEnv(dotenv_path, verbose=True, encoding=encoding).get(key_to_get)
+    return DotEnv(dotenv_path, verbose=verbose, encoding=encoding).get(key_to_get)
 
 
 @contextmanager
@@ -150,6 +162,7 @@ def set_key(
     value_to_set: str,
     quote_mode: str = "always",
     export: bool = False,
+    verbose: bool = True,
     encoding: Optional[str] = "utf-8",
 ) -> Tuple[Optional[bool], str, str]:
     """
@@ -178,7 +191,7 @@ def set_key(
     with rewrite(dotenv_path, encoding=encoding) as (source, dest):
         replaced = False
         missing_newline = False
-        for mapping in with_warn_for_invalid_lines(parse_stream(source)):
+        for mapping in with_warn_for_invalid_lines(parse_stream(source), verbose=verbose):
             if mapping.key == key_to_set:
                 dest.write(line_out)
                 replaced = True
@@ -197,6 +210,7 @@ def unset_key(
     dotenv_path: StrPath,
     key_to_unset: str,
     quote_mode: str = "always",
+    verbose: bool = True,
     encoding: Optional[str] = "utf-8",
 ) -> Tuple[Optional[bool], str]:
     """
@@ -211,7 +225,7 @@ def unset_key(
 
     removed = False
     with rewrite(dotenv_path, encoding=encoding) as (source, dest):
-        for mapping in with_warn_for_invalid_lines(parse_stream(source)):
+        for mapping in with_warn_for_invalid_lines(parse_stream(source), verbose=verbose):
             if mapping.key == key_to_unset:
                 removed = True
             else: