ckparser 0.3.1__tar.gz → 0.3.3__tar.gz

{ckparser-0.3.1/ckparser.egg-info → ckparser-0.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ckparser
-Version: 0.3.1
+Version: 0.3.3
 Summary: Parse Paradox Jomini data files to Python/JSON and revert them back experimentally.
 Author: Marc Debureaux (debnet)
 License-Expression: MIT
@@ -284,6 +284,29 @@ from ckparser import walk
 for value, path in walk(data):
     print(path, value)
 ```
+
+### `objectify`
+
+Transform a dictionary datastructure into an object-like dictionary which allows a better inspection.
+
+```python
+from ckparser import objectify
+
+data = {
+    "name": "Louis",
+    "traits": [
+        "brave",
+        "diligent"
+    ],
+    "father": {
+        "name": "Charles"
+    }
+}
+
+obj = objectify(data)
+print(obj.traits[1])
+print(obj.father.name)
+```
 	
 ### `parse_all_locales`
 
@@ -518,9 +541,9 @@ Paradox scripting languages include many practical exceptions, formatting varian
 
 ### Parsing
 
-* `parse_text(text, return_text_on_error=False, comments=False, dates=False, filename=None, is_global=False)`
-* `parse_file(path, output_dir=None, encoding="utf_8_sig", base_dir=None, save=False, comments=False, dates=False, is_global=False, patch=None)`
-* `parse_all_files(path, output_dir=None, encoding="utf_8_sig", keep_data=False, save=False, comments=False, dates=False, variables_first=True)`
+* `parse_text(text, return_text_on_error=False, comments=False, dates=False, as_object=False, filename=None, is_global=False)`
+* `parse_file(path, output_dir=None, encoding="utf_8_sig", base_dir=None, save=False, comments=False, dates=False, as_object=False, is_global=False, patch=None)`
+* `parse_all_files(path, output_dir=None, encoding="utf_8_sig", keep_data=False, save=False, comments=False, dates=False, as_object=False, variables_first=True)`
 
 ### Reversion
 
@@ -533,6 +556,7 @@ Paradox scripting languages include many practical exceptions, formatting varian
 * `convert_date(date, key=None)`
 * `read_file(path, encoding="utf_8_sig")`
 * `walk(obj, *from_keys)`
+* `objectify(item, name="Object", default=None)`
 * `parse_all_locales(path, encoding="utf_8_sig", language="english", save=False)`
 * `load_variables(filepath="_variables.json")`
 * `save_variables(filepath="_variables.json")`

{ckparser-0.3.1 → ckparser-0.3.3}/README.md

@@ -253,6 +253,29 @@ from ckparser import walk
 for value, path in walk(data):
     print(path, value)
 ```
+
+### `objectify`
+
+Transform a dictionary datastructure into an object-like dictionary which allows a better inspection.
+
+```python
+from ckparser import objectify
+
+data = {
+    "name": "Louis",
+    "traits": [
+        "brave",
+        "diligent"
+    ],
+    "father": {
+        "name": "Charles"
+    }
+}
+
+obj = objectify(data)
+print(obj.traits[1])
+print(obj.father.name)
+```
 	
 ### `parse_all_locales`
 
@@ -487,9 +510,9 @@ Paradox scripting languages include many practical exceptions, formatting varian
 
 ### Parsing
 
-* `parse_text(text, return_text_on_error=False, comments=False, dates=False, filename=None, is_global=False)`
-* `parse_file(path, output_dir=None, encoding="utf_8_sig", base_dir=None, save=False, comments=False, dates=False, is_global=False, patch=None)`
-* `parse_all_files(path, output_dir=None, encoding="utf_8_sig", keep_data=False, save=False, comments=False, dates=False, variables_first=True)`
+* `parse_text(text, return_text_on_error=False, comments=False, dates=False, as_object=False, filename=None, is_global=False)`
+* `parse_file(path, output_dir=None, encoding="utf_8_sig", base_dir=None, save=False, comments=False, dates=False, as_object=False, is_global=False, patch=None)`
+* `parse_all_files(path, output_dir=None, encoding="utf_8_sig", keep_data=False, save=False, comments=False, dates=False, as_object=False, variables_first=True)`
 
 ### Reversion
 
@@ -502,6 +525,7 @@ Paradox scripting languages include many practical exceptions, formatting varian
 * `convert_date(date, key=None)`
 * `read_file(path, encoding="utf_8_sig")`
 * `walk(obj, *from_keys)`
+* `objectify(item, name="Object", default=None)`
 * `parse_all_locales(path, encoding="utf_8_sig", language="english", save=False)`
 * `load_variables(filepath="_variables.json")`
 * `save_variables(filepath="_variables.json")`

{ckparser-0.3.1 → ckparser-0.3.3/ckparser.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ckparser
-Version: 0.3.1
+Version: 0.3.3
 Summary: Parse Paradox Jomini data files to Python/JSON and revert them back experimentally.
 Author: Marc Debureaux (debnet)
 License-Expression: MIT
@@ -284,6 +284,29 @@ from ckparser import walk
 for value, path in walk(data):
     print(path, value)
 ```
+
+### `objectify`
+
+Transform a dictionary datastructure into an object-like dictionary which allows a better inspection.
+
+```python
+from ckparser import objectify
+
+data = {
+    "name": "Louis",
+    "traits": [
+        "brave",
+        "diligent"
+    ],
+    "father": {
+        "name": "Charles"
+    }
+}
+
+obj = objectify(data)
+print(obj.traits[1])
+print(obj.father.name)
+```
 	
 ### `parse_all_locales`
 
@@ -518,9 +541,9 @@ Paradox scripting languages include many practical exceptions, formatting varian
 
 ### Parsing
 
-* `parse_text(text, return_text_on_error=False, comments=False, dates=False, filename=None, is_global=False)`
-* `parse_file(path, output_dir=None, encoding="utf_8_sig", base_dir=None, save=False, comments=False, dates=False, is_global=False, patch=None)`
-* `parse_all_files(path, output_dir=None, encoding="utf_8_sig", keep_data=False, save=False, comments=False, dates=False, variables_first=True)`
+* `parse_text(text, return_text_on_error=False, comments=False, dates=False, as_object=False, filename=None, is_global=False)`
+* `parse_file(path, output_dir=None, encoding="utf_8_sig", base_dir=None, save=False, comments=False, dates=False, as_object=False, is_global=False, patch=None)`
+* `parse_all_files(path, output_dir=None, encoding="utf_8_sig", keep_data=False, save=False, comments=False, dates=False, as_object=False, variables_first=True)`
 
 ### Reversion
 
@@ -533,6 +556,7 @@ Paradox scripting languages include many practical exceptions, formatting varian
 * `convert_date(date, key=None)`
 * `read_file(path, encoding="utf_8_sig")`
 * `walk(obj, *from_keys)`
+* `objectify(item, name="Object", default=None)`
 * `parse_all_locales(path, encoding="utf_8_sig", language="english", save=False)`
 * `load_variables(filepath="_variables.json")`
 * `save_variables(filepath="_variables.json")`

{ckparser-0.3.1 → ckparser-0.3.3}/ckparser.py

@@ -41,7 +41,7 @@ import re
 import time
 
 # Script version
-__version__ = "0.3.1"
+__version__ = "0.3.3"
 
 # Logger (because logging is awesome)
 logger = logging.getLogger(__name__)
@@ -104,9 +104,11 @@ regex_inner_string = re.compile(r"\|(?P<index>\d+)\|")
 # Regex to remove comments in files
 regex_comment = re.compile(r"(?P<space>\s*)(?P<comment>#.*)", re.MULTILINE)
 # Regex to fix blocks with no equal sign
-regex_missing = re.compile(r"^\s*([\w\.]+)\s+([{])", re.MULTILINE)
+regex_missing = re.compile(r"^(\s*)([\w\.]+)\s+([{])", re.MULTILINE)
 # Regex to remove "list" prefix
 regex_list = re.compile(r"\s*=\s*list\s+([\{\"\|])", re.MULTILINE)
+# Regex to split brackets on new lines
+regex_jump = re.compile(r"(\s*)([{}])")
 # Regex for color blocks (color = [rgb|hsv] { x y z })
 regex_color = re.compile(r"=\s*(?P<type>\w+)\s*{", re.MULTILINE)
 # Regex to parse items with format key=value
@@ -118,7 +120,7 @@ regex_line = re.compile(r"\"?(?P<key>[^\s\"]+)\"?\s*(?P<operator>[?!<=>]+)\s*(li
 # Regex to parse independent items in a list
 regex_item = re.compile(r"(\"[^\"]+\"|[\d\.]+|[^\s]+)")
 # Regex to parse dates
-regex_date = re.compile(r"^(?:\d{1,4})\.(?:[1-9]|1[0-2])\.(?:[1-9]|[12]\d|3[01])$")
+regex_date = re.compile(r"^(?P<year>\d{1,4})\.(?P<month>[1-9]|1[0-2])\.(?P<day>[1-9]|[12]\d|3[01])$")
 # Regex to remove empty lines
 regex_empty = re.compile(r"(\n\s*\n)+", re.MULTILINE)
 # Regex to parse locale files
@@ -129,6 +131,8 @@ regex_keyword = re.compile(r"(" + "|".join(map(re.escape, sorted(keywords, key=l
 regex_count = re.compile(r"([?!<=>]+)\s*([§\n]+)\s*\{")
 # Regex for string indexes
 regex_index = re.compile(r"\|(\d+)\|")
+# Regex to clean line numbers
+regex_clean = re.compile(r"^§+\n", re.MULTILINE)
 # Regex for variables
 regex_variables = re.compile(r"\b([\w]+)\b")
 
@@ -188,14 +192,23 @@ def read_file(path, encoding="utf_8_sig"):
         return file.read()
 
 
-def parse_text(text, return_text_on_error=False, comments=False, dates=False, filename=None, is_global=False):
+def parse_text(
+    text,
+    return_text_on_error=False,
+    comments=False,
+    dates=False,
+    as_object=False,
+    filename=None,
+    is_global=False,
+):
     """
     Parse raw text
     :param text: Text to parse
     :param return_text_on_error: (default false) Return working text document if parsing fails
     :param comments: (default false) Include comments?
     :param dates: (default false) Include dates?
-    :param filename: (default none) Filename (only for debugging)
+    :param as_object: (default false) Return data as an object-like instead of dict
+    :param filename: (default none) file which is parsed (only for debugging)
     :param is_global: (default false) Are variables global?
     :return: Parsed data as dictionary
     """
@@ -238,12 +251,12 @@ def parse_text(text, return_text_on_error=False, comments=False, dates=False, fi
     if missings := regex_missing.findall(text):
         if filename:
             logger.warning(f"Filename: {filename}")
-        for key, val in missings:
+        for _, key, val in missings:
             logger.warning(f"Potential missing `=` operator between `{key}` and `{val}` needs to be fixed.")
-        text = regex_missing.sub(r"\g<1>=\g<2>", text)
+        text = regex_missing.sub(r"\g<1>\g<2>=\g<3>", text)
     text = regex_color.sub(r"={\n\g<1>", text)
     text = regex_list.sub(r"|list=\g<1>", text)
-    text = text.replace("{", "\n{\n").replace("}", "\n}\n")
+    text = regex_jump.sub(r"\n\g<1>\g<2>\n", text)
     text = regex_inline.sub(r"\g<1>\n", text)
     text = regex_block.sub(r"\g<2>\g<4>{", text)
     text = regex_empty.sub(r"\n", text)
@@ -418,10 +431,14 @@ def parse_text(text, return_text_on_error=False, comments=False, dates=False, fi
                 nodes.pop()
             # If line is a list or list item
             else:
+                # Assuming the parsed file is just an array
+                if len(nodes) == 1 and not node:
+                    root = node = []
+                    nodes = [("", root)]
                 # Ensure previous data are treated as list
                 if not isinstance(node, list):
                     if len(nodes) < 2:
-                        raise SyntaxError("Incorrect file format or syntax!")
+                        raise SyntaxError("Incorrect file format or unknown syntax error!")
                     _, prev = nodes[-2]
                     if node_name:
                         if node and isinstance(node, dict):
@@ -472,12 +489,12 @@ def parse_text(text, return_text_on_error=False, comments=False, dates=False, fi
                                 result = None
                             if isinstance(result, float):
                                 result = round(result, 5)
-                            node.append({"@type": "formula", "@value": value, "@result": result})
+                            node.append({"@type": "formula", "@value": item, "@result": result})
                         elif item.startswith("@"):
                             if (result := variables.get(item)) is None:
                                 if filename:
                                     logger.warning(f"Filename: {filename}")
-                                logger.warning(f'Value for "{value}" cannot be found (line: {line_number})')
+                                logger.warning(f'Value for "{item}" cannot be found (line: {line_number})')
                             node.append({"@type": "variable", "@value": item, "@result": result})
                         elif dates and regex_date.fullmatch(item):
                             item = convert_date(item) or item
@@ -494,8 +511,8 @@ def parse_text(text, return_text_on_error=False, comments=False, dates=False, fi
             logger.error(f"Line {line_number}: {line_text}")
             logger.error(f"Parse error: {error}")
             logger.debug("Exception:", exc_info=True)
-            return text if return_text_on_error else None
-    return root
+            return regex_clean.sub("", text) if return_text_on_error else None
+    return objectify(root) if as_object else root
 
 
 def parse_file(
@@ -506,6 +523,7 @@ def parse_file(
     save=False,
     comments=False,
     dates=False,
+    as_object=False,
     is_global=False,
     patch=None,
 ):
@@ -516,12 +534,16 @@ def parse_file(
     :param encoding: Encoding used to read file
     :param base_dir: Base directory (for debug)
     :param save: (default false) Save parsed file in output directory
-    :param comments: Include comments?
-    :param dates: Include dates?
+    :param comments: (default false) Include comments?
+    :param dates: (default false) Include dates?
+    :param as_object: (default false) Return data as an object-like instead of dict
     :param is_global: (default false) Are file's variables global?
     :param patch: String replacement patterns
     :return: Parsed data as dictionary or text if parsing fails
     """
+    if save and as_object:
+        logger.warning("`as_object` disabled bacause only dicts can be converted to JSON.")
+        as_object = False
     start_time = time.monotonic()
     if base_dir:
         base_dir = os.sep.join(str(base_dir).rstrip(os.sep).split(os.sep)[:-1]) + os.sep
@@ -535,7 +557,13 @@ def parse_file(
     filename = os.path.join(base_dir, os.path.basename(path))
     logger.debug(f"Parsing {filename}")
     data = parse_text(
-        text, return_text_on_error=True, comments=comments, dates=dates, filename=filename, is_global=is_global
+        text,
+        return_text_on_error=True,
+        comments=comments,
+        dates=dates,
+        as_object=as_object,
+        filename=filename,
+        is_global=is_global,
     )
     if save:
         filename, _ = os.path.splitext(os.path.basename(path))
@@ -565,6 +593,7 @@ def parse_all_files(
     save=False,
     comments=False,
     dates=False,
+    as_object=False,
     variables_first=True,
     _variables_only=False,
 ):
@@ -575,8 +604,9 @@ def parse_all_files(
     :param encoding: Encoding used to read files
     :param keep_data: (default false) Return parsed data of all files in a dictionary
     :param save: (default false) Save every parsed data in output directory
-    :param comments: Include comments?
-    :param dates: Include dates?
+    :param comments: (default false) Include comments?
+    :param dates: (default false) Include dates?
+    :param as_object: (default false) Return data as an object-like instead of dict
     :param variables_first: Try to parse variables first
     :return: Dictionary (key: file, value: parsed data if keep_data=True)
     """
@@ -592,6 +622,7 @@ def parse_all_files(
                 save=save,
                 comments=comments,
                 dates=dates,
+                as_object=as_object,
                 variables_first=False,
                 _variables_only=True,
             )
@@ -612,6 +643,7 @@ def parse_all_files(
                 save=save,
                 comments=comments,
                 dates=dates,
+                as_object=as_object,
                 is_global=_variables_only,
             )
             if isinstance(data, str):
@@ -683,6 +715,48 @@ def walk(obj, *from_keys):
         yield obj, from_keys
 
 
+def objectify(data, name="Object", default=None):
+    """
+    Convert a dictionary to an object-like dictionary
+    :param data: dictionary
+    :param name: name of the object
+    :param default: default value for unknown attributes
+    :return: object-like dictionary
+    """
+
+    def _getattr(s, k):
+        try:
+            object.__getattribute__(s, k)
+        except AttributeError:
+            return s.get(k, default)
+
+    if isinstance(data, list):
+        return [
+            objectify(item)
+            for item in data
+            if not (isinstance(item, str) and item.startswith("@") and item.endswith("@"))
+        ]
+    elif isinstance(data, dict):
+        name = (data.get("@type") or name).title()
+        slots = set()
+        attrs = dict(__getattr__=lambda s, k: _getattr(s, k), __slots__=slots)
+        subdata = {}
+        for key, value in data.items():
+            if key.startswith("#"):
+                continue
+            skey = key.replace("@", "_").replace(":", "_")
+            if match := regex_date.match(skey):
+                skey = "_".join(match.groups())
+            skey = f"_{skey}" if key != skey or key[0].isdigit() else skey
+            slots.add(skey)
+            if isinstance(value, (list, dict)):
+                subdata[key] = subdata[skey] = objectify(value)
+                continue
+            subdata[key] = subdata[skey] = value
+        return type(name, (dict,), attrs)(subdata)
+    return data
+
+
 # Tags which are always a list when reverting
 list_keys_rules = [
     # Colors
@@ -729,6 +803,8 @@ def revert(obj, from_key=None, prev_key=None, depth=-1, sep="\t", sort=False):
             elif depth > 0:
                 lines.append(f"{tabs}{{")
             for key, value in sorted(obj.items()) if sort else obj.items():
+                if key.startswith("_"):
+                    continue
                 lines.extend(revert(value, from_key=key, prev_key=from_key, depth=depth + 1, sep=sep, sort=sort))
             if from_key or depth > 0:
                 lines.append(f"{tabs}}}")
@@ -736,11 +812,13 @@ def revert(obj, from_key=None, prev_key=None, depth=-1, sep="\t", sort=False):
         if from_key and (from_key.lower() == "this" or not any(regex.match(from_key) for regex in list_keys_rules)):
             for value in sorted(obj) if sort else obj:
                 lines.extend(revert(value, from_key=from_key, prev_key=prev_key, depth=depth, sep=sep, sort=sort))
-        elif not any(isinstance(o, (dict, list)) for o in obj):
+        elif not any(isinstance(o, (dict, list)) for o in obj) and not any(
+            o.startswith("#") and o.endswith("#") for o in obj if isinstance(o, str)
+        ):
             prefix = f"{tabs}{from_key} = {{"
             # Only for color modes
             if from_key == "color" and len(obj) == 4 and isinstance(obj[0], str):
-                prefix = f"{tabs}{from_key} {obj[0]} = {{"
+                prefix = f"{tabs}{from_key} = {obj[0]} {{"
                 obj = obj[1:]
             func = functools.partial(revert_value, from_key=from_key, prev_key=prev_key, sep=sep, sort=sort)
             values = " ".join(map(str, map(func, obj)))
@@ -783,7 +861,7 @@ def revert_value(value, from_key=None, prev_key=None, **kwargs):
         return "yes" if value else "no"
     elif isinstance(value, str):
         if value.startswith("#") and value.endswith("#"):
-            return f"#{value}"
+            return f"#{value.strip("#")}"
         elif (
             " " in value
             or (value.startswith("$") and value.endswith("$"))
@@ -874,6 +952,22 @@ def save_variables(filepath="_variables.json"):
         json_dump(global_variables, file, sort_keys=True)
 
 
+def enable_logging(debug=False, file=False):
+    logger.setLevel(logging.DEBUG)
+    formatter = logging.Formatter("[%(asctime)s] %(levelname)s: %(message)s")
+    console_handler = logging.StreamHandler()
+    console_handler.setLevel(logging.INFO)
+    console_handler.setFormatter(formatter)
+    logger.addHandler(console_handler)
+    if debug:
+        console_handler.setLevel(logging.DEBUG)
+    if file:
+        file_handler = logging.FileHandler("ckparser.log")
+        file_handler.setLevel(logging.INFO)
+        file_handler.setFormatter(formatter)
+        logger.addHandler(file_handler)
+
+
 def main():
     """
     Command-line main entrypoint
@@ -890,18 +984,7 @@ def main():
     parser.add_argument("--debug", action="store_true", help="debug mode?")
     args = parser.parse_args()
 
-    logger.setLevel(logging.DEBUG)
-    formatter = logging.Formatter("[%(asctime)s] %(levelname)s: %(message)s")
-    console_handler = logging.StreamHandler()
-    console_handler.setLevel(logging.INFO)
-    console_handler.setFormatter(formatter)
-    logger.addHandler(console_handler)
-    if args.debug:
-        console_handler.setLevel(logging.DEBUG)
-    file_handler = logging.FileHandler("ckparser.log")
-    file_handler.setLevel(logging.INFO)
-    file_handler.setFormatter(formatter)
-    logger.addHandler(file_handler)
+    enable_logging(debug=args.debug, file=True)
 
     if args.revert:
         if os.path.isdir(args.path):

{ckparser-0.3.1 → ckparser-0.3.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ckparser"
-version = "0.3.1"
+version = "0.3.3"
 description = "Parse Paradox Jomini data files to Python/JSON and revert them back experimentally."
 readme = "README.md"
 requires-python = ">=3.9"