inihelper 0.1.0__tar.gz

inihelper-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Arjuna S. Erat
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

inihelper-0.1.0/PKG-INFO

@@ -0,0 +1,99 @@
+Metadata-Version: 2.4
+Name: inihelper
+Version: 0.1.0
+Summary: An INI parser that preserves comments, supports custom 'separator' (=) 'rules' and comment styles, incl (wip) multiline.
+Author-email: "Simon Arjuna Erat (sri-arjuna)" <erat.simon@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/sri-arjuna/python-ini
+Project-URL: Bug Reports, https://github.com/sri-arjuna/python-ini/issues
+Project-URL: Source, https://github.com/sri-arjuna/python-ini
+Keywords: ini,config,parser,comments
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Topic :: Utilities
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# INI Comments
+This is a ini-file handler that preserves comments.
+
+For various projects of mine, I prefer to provide comments within an ini file for others to know their meanings, or other options.
+
+While configParser is nice, it always removed any/all comments from the file, so this project solves that issue.
+
+
+### Features:
+- Supports: "#", ";" and "//" as line comments
+- Preserve comments
+- Handles "line comment" and "comments behind values"
+- Custom "separator" (default: "=")
+- Allows toggle between: "instant save" or "on purpose"
+- May handle "lazy" (bStrict=False) ini files, that do not have any "[Section]"s (this is required for the saving, wether manual or automatic)
+- Allows for fallback/non-existing config 
+
+
+# Usage:
+How to handle this class:
+
+## Available commands:
+- my_ini.export(args)
+- my_ini.get(args)
+- my_ini.get_simple(args)
+- my_ini.list_sections()
+- my_ini.list_variables(args)
+- my_ini.load_data()
+- my_ini.load_file()
+- my_ini.save()
+- my_ini.set(args)
+- my_ini.set_simple(args)
+
+
+### Import:
+```python
+import inicomments
+```
+
+### Initialize:
+```python
+my_ini = inicomments.handler("/path/to/file")
+```
+
+### Working with values:
+```python
+# Get value:
+current_value = my_ini.get("SectionName", "VariableName")
+print(current_value)
+
+# Set Value:
+my_ini.set("SectionName", "VariableName", "NewValue")
+```
+
+### Special Handling:
+If you have ``bInstantSave=False`` you simply call: ``my_ini.save()`` at whatever point you want/need to save the file.
+
+
+
+# Example File:
+Here is an example of a - *very chaotic, but still work-able* - ini file:
+
+```
+# Most used comment
+; But you can apply any comment style
+// that fits your project
+
+[section]
+variable = some value
+someting = with a comment // like this
+ofCourse = this would ; work as well
+sooooo = "would this ; if you" ; apply quotes
+
+```

inihelper-0.1.0/README.md

@@ -0,0 +1,74 @@
+# INI Comments
+This is a ini-file handler that preserves comments.
+
+For various projects of mine, I prefer to provide comments within an ini file for others to know their meanings, or other options.
+
+While configParser is nice, it always removed any/all comments from the file, so this project solves that issue.
+
+
+### Features:
+- Supports: "#", ";" and "//" as line comments
+- Preserve comments
+- Handles "line comment" and "comments behind values"
+- Custom "separator" (default: "=")
+- Allows toggle between: "instant save" or "on purpose"
+- May handle "lazy" (bStrict=False) ini files, that do not have any "[Section]"s (this is required for the saving, wether manual or automatic)
+- Allows for fallback/non-existing config 
+
+
+# Usage:
+How to handle this class:
+
+## Available commands:
+- my_ini.export(args)
+- my_ini.get(args)
+- my_ini.get_simple(args)
+- my_ini.list_sections()
+- my_ini.list_variables(args)
+- my_ini.load_data()
+- my_ini.load_file()
+- my_ini.save()
+- my_ini.set(args)
+- my_ini.set_simple(args)
+
+
+### Import:
+```python
+import inicomments
+```
+
+### Initialize:
+```python
+my_ini = inicomments.handler("/path/to/file")
+```
+
+### Working with values:
+```python
+# Get value:
+current_value = my_ini.get("SectionName", "VariableName")
+print(current_value)
+
+# Set Value:
+my_ini.set("SectionName", "VariableName", "NewValue")
+```
+
+### Special Handling:
+If you have ``bInstantSave=False`` you simply call: ``my_ini.save()`` at whatever point you want/need to save the file.
+
+
+
+# Example File:
+Here is an example of a - *very chaotic, but still work-able* - ini file:
+
+```
+# Most used comment
+; But you can apply any comment style
+// that fits your project
+
+[section]
+variable = some value
+someting = with a comment // like this
+ofCourse = this would ; work as well
+sooooo = "would this ; if you" ; apply quotes
+
+```

inihelper-0.1.0/inihandler/__init__.py

@@ -0,0 +1,38 @@
+from .ini import INIhandler as _INIhandler
+
+#
+#   Imports - Official
+#
+import os as _os
+import sys as _sys
+import shutil as _shutil
+
+#
+#   Imports - Internals
+#
+from .tools import vars
+from .tools import LoadFile
+
+
+def handler(file_path="", bInstantSave=True, bStrict=True, bForcedCommentStyle: vars.NoneOrString=None, bVerbose=False, sVerbosePrefix="", SEP="=", sEncoding="utf-8", sDefaultBackupConfig="", lang: str="english"):
+    """
+    Initialize the ini-handler, the one that preserves file comments on normal saves!
+
+    Errors will always be printed to "stderr".
+
+    Supported comment-single/on-line styles are: "#", ";", "//", "|"
+
+    Supported comment-MULTI-line styles are: "*/", "-->", '\"\"\"'
+
+
+    :param file_path: Path to the .ini **file**, or a **nested dict**: {"Section 1": {"var1": "value1"}, "Section 2": {"variable_name": "its value"}}
+    :param bInstantSave: If True, saves to file on every 'set()'.
+    :param bStrict: True/Default expects '[Section]', where as 'False' will expect ONLY 'variable = value'
+    :param bForcedCommentStyle: If set to a non-None string (e.g., "#"), it enforces that only that specific comment style is accepted for all parsing. Set to None for flexible, multi-style comment handling, incl multi-line comments.
+    :param bVerbose: If True, prints basic status messages.
+    :param sVerbosePrefix: This will print '[sVerbosePrefix] message' instead of just 'message'
+    :param SEP: The separator for key-value pairs (default "=" for cross-platform compatability).
+    :param sEncoding: On rare occasions your files might not be "utf-8", here you can handle such cases.
+    :param sDefaultBackupConfig: Expects "path/to/file", this will be used if required "file_path" doesnt exist) and/or if/when its config became invalid.
+    """
+    return _INIhandler(file_path, bInstantSave=bInstantSave, bStrict=bStrict, bForcedCommentStyle=bForcedCommentStyle, bVerbose=bVerbose, sVerbosePrefix=sVerbosePrefix, SEP=SEP, sEncoding=sEncoding, sDefaultBackupConfig=sDefaultBackupConfig, lang=lang)