quick-ini 4.0__tar.gz → 4.1__tar.gz

{quick_ini-4.0/quick_ini.egg-info → quick_ini-4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: quick_ini
-Version: 4.0
+Version: 4.1
 Summary: A library for reading from and writing to .ini formatted files
 Author-email: OllieZ-Mods <socksinthewash@gmail.com>
 License-Expression: MIT
@@ -38,7 +38,7 @@ pip install quick_ini
 ```python
 from quick_ini import QuickIni
 
-# Load from file
+# Load from file, before any get_value() or get_all() (those raise RuntimeError otherwise)
 QuickIni.load_file("config.ini")
 
 # Load from URL

{quick_ini-4.0 → quick_ini-4.1}/README.md

@@ -13,7 +13,7 @@ pip install quick_ini
 ```python
 from quick_ini import QuickIni
 
-# Load from file
+# Load from file, before any get_value() or get_all() (those raise RuntimeError otherwise)
 QuickIni.load_file("config.ini")
 
 # Load from URL

{quick_ini-4.0 → quick_ini-4.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "quick_ini"
-version = "4.0"
+version = "4.1"
 description = "A library for reading from and writing to .ini formatted files"
 readme = "README.md"
 license = "MIT"

{quick_ini-4.0 → quick_ini-4.1}/quick_ini/quick_ini.py

@@ -17,6 +17,7 @@ class QuickIni:
     error_message: str = ""
     web_file: str | None = None
     sync_report: dict[str, Any] | None = None
+    load_called: bool = False
 
     @staticmethod
     def grab_from_url(url:str, timeout:float = 10) -> bool:
@@ -323,6 +324,8 @@ class QuickIni:
         """
         QuickIni.parsed_ini = {}
         QuickIni.auto_type_convert_g = auto_type_convert
+        # Set even if loading fails, the caller gets False and reading falls back to defaults
+        QuickIni.load_called = True
 
         if(not QuickIni.sync_template(file_location, template)):
             # sync_template sets the error message
@@ -411,6 +414,15 @@ class QuickIni:
         QuickIni.loaded_file_path=file_location
         return True
 
+    @staticmethod
+    def check_loaded(call:str) -> None:
+        """
+        Raises a RuntimeError if load_file() was never called, so settings aren't silently read as defaults.
+        """
+        if(not QuickIni.load_called):
+            QuickIni.error_message = f"QuickIni.{call} was called before QuickIni.load_file()"
+            raise(RuntimeError(QuickIni.error_message))
+
     @staticmethod
     def get_value(name:str, default:Any = None, expected_type:type | None = None, section:str | None = None) -> Any:
         """
@@ -423,6 +435,8 @@ class QuickIni:
             section (str): The [section] the setting is in, None for keys above any section
         Return:
             Any: The value associated with the name
+        Raises:
+            RuntimeError: If load_file() was never called
         Example:
             >>> get_value("do_debug_logs", False)
             True
@@ -431,6 +445,7 @@ class QuickIni:
         """
         if(section):
             name = f"{section}.{name}"
+        QuickIni.check_loaded(f"get_value({name!r})")
         value:Any = QuickIni.parsed_ini.get(name, default)
         if(expected_type != None):
             if(not isinstance(value, expected_type)):
@@ -446,10 +461,13 @@ class QuickIni:
             section (str): Only return the settings in this [section], with the section prefix removed
         Return:
             dict[str, Any]: The settings, keys in a section are given as "section.key" when no section is passed
+        Raises:
+            RuntimeError: If load_file() was never called
         Example:
             >>> get_all("database")
             {'host': 'localhost', 'port': 5432}
         """
+        QuickIni.check_loaded(f"get_all({section!r})" if section else "get_all()")
         if(not section):
             return dict(QuickIni.parsed_ini)
         prefix = f"{section}."

{quick_ini-4.0 → quick_ini-4.1/quick_ini.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: quick_ini
-Version: 4.0
+Version: 4.1
 Summary: A library for reading from and writing to .ini formatted files
 Author-email: OllieZ-Mods <socksinthewash@gmail.com>
 License-Expression: MIT
@@ -38,7 +38,7 @@ pip install quick_ini
 ```python
 from quick_ini import QuickIni
 
-# Load from file
+# Load from file, before any get_value() or get_all() (those raise RuntimeError otherwise)
 QuickIni.load_file("config.ini")
 
 # Load from URL

{quick_ini-4.0 → quick_ini-4.1}/tests/test_quickini.py

@@ -16,6 +16,7 @@ class TestQuickIni(unittest.TestCase):
         """Set up test fixtures before each test method."""
         # Clear any previous state
         QuickIni.parsed_ini = {}
+        QuickIni.load_called = False
         QuickIni.loaded_file_path = None
         QuickIni.auto_type_convert_g = True
         QuickIni.error_message = ""
@@ -473,6 +474,7 @@ class TestQuickIniFormats(unittest.TestCase):
 
     def setUp(self):
         QuickIni.parsed_ini = {}
+        QuickIni.load_called = False
         QuickIni.loaded_file_path = None
         QuickIni.auto_type_convert_g = True
         QuickIni.error_message = ""
@@ -496,6 +498,30 @@ class TestQuickIniFormats(unittest.TestCase):
         with open(path, encoding='utf-8') as f:
             return f.read()
 
+    # ===== LOADING FIRST =====
+
+    def test_get_value_before_load_raises(self):
+        with self.assertRaises(RuntimeError):
+            QuickIni.get_value("port", 8080)
+        self.assertEqual(QuickIni.get_last_error(), "QuickIni.get_value('port') was called before QuickIni.load_file()")
+
+    def test_get_value_section_before_load_names_key(self):
+        with self.assertRaises(RuntimeError):
+            QuickIni.get_value("port", section="database")
+        self.assertIn("'database.port'", QuickIni.get_last_error())
+
+    def test_get_all_before_load_raises(self):
+        with self.assertRaises(RuntimeError):
+            QuickIni.get_all()
+        with self.assertRaises(RuntimeError):
+            QuickIni.get_all("database")
+        self.assertIn("get_all('database')", QuickIni.get_last_error())
+
+    def test_failed_load_falls_back_to_defaults(self):
+        self.assertFalse(QuickIni.load_file("/no/such/config.ini"))
+        self.assertEqual(QuickIni.get_value("port", 8080), 8080)
+        self.assertEqual(QuickIni.get_all(), {})
+
     # ===== PARSING =====
 
     def test_spaces_around_equals(self):
@@ -667,6 +693,7 @@ port = 5432
 
     def setUp(self):
         QuickIni.parsed_ini = {}
+        QuickIni.load_called = False
         QuickIni.loaded_file_path = None
         QuickIni.auto_type_convert_g = True
         QuickIni.error_message = ""