mapfile-parser 2.3.0__tar.gz → 2.3.1__tar.gz

{mapfile_parser-2.3.0 → mapfile_parser-2.3.1}/CHANGELOG.md

@@ -7,6 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.3.1] - 2023-12-23
+
+### Added
+
+- Add a few utility methods to `ProgressStats`.
+
+### Changed
+
+- `pyo3` is no longer needed to use this crate as Rust-only library.
+- Updated Rust dependencies.
+
 ## [2.3.0] - 2023-11-05
 
 ### Added
@@ -277,6 +288,7 @@ Full changes: <https://github.com/Decompollaborate/mapfile_parser/compare/702a73
 - Initial release
 
 [unreleased]: https://github.com/Decompollaborate/mapfile_parser/compare/master...develop
+[2.3.1]: https://github.com/Decompollaborate/mapfile_parser/compare/2.3.0...2.3.1
 [2.3.0]: https://github.com/Decompollaborate/mapfile_parser/compare/2.2.1...2.3.0
 [2.2.1]: https://github.com/Decompollaborate/mapfile_parser/compare/2.2.0...2.2.1
 [2.2.0]: https://github.com/Decompollaborate/mapfile_parser/compare/2.1.5...2.2.0

{mapfile_parser-2.3.0 → mapfile_parser-2.3.1}/Cargo.lock

@@ -29,11 +29,17 @@ version = "1.0.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd"
 
+[[package]]
+name = "heck"
+version = "0.4.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "95505c38b4572b2d910cecb0281560f54b440a19336cbbcb27bf6ce6adc6f5a8"
+
 [[package]]
 name = "indoc"
-version = "1.0.9"
+version = "2.0.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "bfa799dd5ed20a7e349f3b4639aa80d74549c81716d9ec4f994c9b5815598306"
+checksum = "1e186cfbae8084e513daff4240b4797e342f988cecda4fb6c939150f96315fd8"
 
 [[package]]
 name = "lazy_static"
@@ -43,9 +49,9 @@ checksum = "e2abad23fbc42b3700f2f279844dc832adb2b2eb069b2df918f455c4e18cc646"
 
 [[package]]
 name = "libc"
-version = "0.2.150"
+version = "0.2.151"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "89d92a4743f9a61002fae18374ed11e7973f530cb3a3255fb354818118b2203c"
+checksum = "302d7ab3130588088d277783b1e2d2e10c9e9e4a16dd9050e6ec93fb3e7048f4"
 
 [[package]]
 name = "lock_api"
@@ -59,7 +65,7 @@ dependencies = [
 
 [[package]]
 name = "mapfile_parser"
-version = "2.3.0"
+version = "2.3.1"
 dependencies = [
  "lazy_static",
  "pyo3",
@@ -83,9 +89,9 @@ dependencies = [
 
 [[package]]
 name = "once_cell"
-version = "1.18.0"
+version = "1.19.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "dd8b5dd2ae5ed71462c540258bedcb51965123ad7e7ccf4b9a8cafaa4a63576d"
+checksum = "3fdb12b2476b595f9358c5161aa467c2438859caa136dec86c26fdd2efe17b92"
 
 [[package]]
 name = "parking_lot"
@@ -112,18 +118,18 @@ dependencies = [
 
 [[package]]
 name = "proc-macro2"
-version = "1.0.69"
+version = "1.0.71"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "134c189feb4956b20f6f547d2cf727d4c0fe06722b20a0eec87ed445a97f92da"
+checksum = "75cb1540fadbd5b8fbccc4dddad2734eba435053f725621c070711a14bb5f4b8"
 dependencies = [
  "unicode-ident",
 ]
 
 [[package]]
 name = "pyo3"
-version = "0.19.2"
+version = "0.20.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e681a6cfdc4adcc93b4d3cf993749a4552018ee0a9b65fc0ccfad74352c72a38"
+checksum = "04e8453b658fe480c3e70c8ed4e3d3ec33eb74988bd186561b0cc66b85c3bc4b"
 dependencies = [
  "cfg-if",
  "indoc",
@@ -138,9 +144,9 @@ dependencies = [
 
 [[package]]
 name = "pyo3-build-config"
-version = "0.19.2"
+version = "0.20.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "076c73d0bc438f7a4ef6fdd0c3bb4732149136abd952b110ac93e4edb13a6ba5"
+checksum = "a96fe70b176a89cff78f2fa7b3c930081e163d5379b4dcdf993e3ae29ca662e5"
 dependencies = [
  "once_cell",
  "target-lexicon",
@@ -148,9 +154,9 @@ dependencies = [
 
 [[package]]
 name = "pyo3-ffi"
-version = "0.19.2"
+version = "0.20.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e53cee42e77ebe256066ba8aa77eff722b3bb91f3419177cf4cd0f304d3284d9"
+checksum = "214929900fd25e6604661ed9cf349727c8920d47deff196c4e28165a6ef2a96b"
 dependencies = [
  "libc",
  "pyo3-build-config",
@@ -158,9 +164,9 @@ dependencies = [
 
 [[package]]
 name = "pyo3-macros"
-version = "0.19.2"
+version = "0.20.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "dfeb4c99597e136528c6dd7d5e3de5434d1ceaf487436a3f03b2d56b6fc9efd1"
+checksum = "dac53072f717aa1bfa4db832b39de8c875b7c7af4f4a6fe93cdbf9264cf8383b"
 dependencies = [
  "proc-macro2",
  "pyo3-macros-backend",
@@ -170,10 +176,11 @@ dependencies = [
 
 [[package]]
 name = "pyo3-macros-backend"
-version = "0.19.2"
+version = "0.20.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "947dc12175c254889edc0c02e399476c2f652b4b9ebd123aa655c224de259536"
+checksum = "7774b5a8282bd4f25f803b1f0d945120be959a36c72e08e7cd031c792fdfd424"
 dependencies = [
+ "heck",
  "proc-macro2",
  "quote",
  "syn",
@@ -234,15 +241,15 @@ checksum = "94143f37725109f92c262ed2cf5e59bce7498c01bcc1502d7b9afe439a4e9f49"
 
 [[package]]
 name = "smallvec"
-version = "1.11.1"
+version = "1.11.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "942b4a808e05215192e39f4ab80813e599068285906cc91aa64f923db842bd5a"
+checksum = "4dccd0940a2dcdf68d092b8cbab7dc0ad8fa938bf95787e1b916b0e3d0e8e970"
 
 [[package]]
 name = "syn"
-version = "1.0.109"
+version = "2.0.42"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "72b64191b275b66ffe2469e8af2c1cfe3bafa67b529ead792a6d0160888b4237"
+checksum = "5b7d0a2c048d661a1a59fcd7355baa232f7ed34e0ee4df2eef3c1c1c0d3852d8"
 dependencies = [
  "proc-macro2",
  "quote",
@@ -263,9 +270,9 @@ checksum = "3354b9ac3fae1ff6755cb6db53683adb661634f67557942dea4facebec0fee4b"
 
 [[package]]
 name = "unindent"
-version = "0.1.11"
+version = "0.2.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e1766d682d402817b5ac4490b3c3002d91dfa0d22812f341609f97b08757359c"
+checksum = "c7de7d73e1754487cb58364ee906a499937a0dfabd86bcb980fa99ec8c8fa2ce"
 
 [[package]]
 name = "windows-targets"

{mapfile_parser-2.3.0 → mapfile_parser-2.3.1}/Cargo.toml

@@ -3,7 +3,7 @@
 
 [package]
 name = "mapfile_parser"
-version = "2.3.0"
+version = "2.3.1"
 edition = "2021"
 authors = ["Anghelo Carvajal <angheloalf95@gmail.com>"]
 description = "Map file parser library focusing decompilation projects"
@@ -22,11 +22,9 @@ path = "src/rs/lib.rs"
 crate-type = ["cdylib", "staticlib", "rlib"]
 
 [dependencies]
-regex = "1.9.5"
-# pyo3 = { version = "0.19.0", optional = true }
-pyo3 = { version = "0.19.0", optional = false }
+regex = "1.10.2"
+pyo3 = { version = "0.20.0", optional = true }
 lazy_static = "1.4.0"
 
 [features]
-python_bindings = []
-# python_bindings = ["dep:pyo3"]
+python_bindings = ["dep:pyo3"]

{mapfile_parser-2.3.0 → mapfile_parser-2.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mapfile_parser
-Version: 2.3.0
+Version: 2.3.1
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
@@ -54,7 +54,7 @@ If you use a `requirements.txt` file in your repository, then you can add
 this library with the following line:
 
 ```txt
-mapfile_parser>=2.3.0,<3.0.0
+mapfile_parser>=2.3.1,<3.0.0
 ```
 
 #### Development version
@@ -93,19 +93,7 @@ cargo add mapfile_parser
 Or add the following line manually to your `Cargo.toml` file:
 
 ```toml
-mapfile_parser = "2.3.0"
-```
-
-#### System-wide dependencies
-
-Due to how intrusive `pyo3` is (and even impossible to disable via Cargo
-features), Python development files are required to build and use the Rust
-version of this library
-
-To install those dependencies on a Debian/Ubuntu Linux distro:
-
-```bash
-sudo apt install libpython3-dev
+mapfile_parser = "2.3.1"
 ```
 
 ## Versioning and changelog

{mapfile_parser-2.3.0 → mapfile_parser-2.3.1}/README.md

@@ -35,7 +35,7 @@ If you use a `requirements.txt` file in your repository, then you can add
 this library with the following line:
 
 ```txt
-mapfile_parser>=2.3.0,<3.0.0
+mapfile_parser>=2.3.1,<3.0.0
 ```
 
 #### Development version
@@ -74,19 +74,7 @@ cargo add mapfile_parser
 Or add the following line manually to your `Cargo.toml` file:
 
 ```toml
-mapfile_parser = "2.3.0"
-```
-
-#### System-wide dependencies
-
-Due to how intrusive `pyo3` is (and even impossible to disable via Cargo
-features), Python development files are required to build and use the Rust
-version of this library
-
-To install those dependencies on a Debian/Ubuntu Linux distro:
-
-```bash
-sudo apt install libpython3-dev
+mapfile_parser = "2.3.1"
 ```
 
 ## Versioning and changelog

{mapfile_parser-2.3.0 → mapfile_parser-2.3.1}/pyproject.toml

@@ -3,7 +3,7 @@
 
 [project]
 name = "mapfile_parser"
-version = "2.3.0"
+version = "2.3.1"
 description = "Map file parser library focusing decompilation projects"
 readme = "README.md"
 requires-python = ">=3.7"

{mapfile_parser-2.3.0 → mapfile_parser-2.3.1}/src/mapfile_parser/__init__.py

@@ -5,7 +5,7 @@
 
 from __future__ import annotations
 
-__version_info__ = (2, 3, 0)
+__version_info__ = (2, 3, 1)
 __version__ = ".".join(map(str, __version_info__))
 __author__ = "Decompollaborate"
 

{mapfile_parser-2.3.0 → mapfile_parser-2.3.1}/src/mapfile_parser/frontends/progress.py

@@ -32,7 +32,7 @@ def processArguments(args: argparse.Namespace):
     asmPath: Path = args.asmpath
     nonmatchingsPath: Path = args.nonmatchingspath
     pathIndex: int = args.path_index
-    debugging: bool = args.debugging
+    debugging: bool = args.debugging #! @deprecated
 
     exit(doProgress(mapPath, asmPath, nonmatchingsPath, pathIndex=pathIndex, debugging=debugging))
 
@@ -43,6 +43,6 @@ def addSubparser(subparser: argparse._SubParsersAction[argparse.ArgumentParser])
     parser.add_argument("asmpath", help="Path to asm folder", type=Path)
     parser.add_argument("nonmatchingspath", help="Path to nonmatchings folder", type=Path)
     parser.add_argument("-i", "--path-index", help="Specify the index to start reading the file paths. Defaults to 2", type=int, default=2)
-    parser.add_argument("-d", "--debugging", help="Enable debugging prints", action="store_true")
+    parser.add_argument("-d", "--debugging", help="Enable debugging prints. This option is deprecated", action="store_true")
 
     parser.set_defaults(func=processArguments)

{mapfile_parser-2.3.0 → mapfile_parser-2.3.1}/src/mapfile_parser/mapfile_parser.pyi

@@ -47,11 +47,30 @@ class ProgressStats:
     @property
     def total(self) -> int: ...
 
+    def undecompedPercentage(self) -> float:
+        ...
+
+    def decompedPercentage(self) -> float:
+        ...
+
+    def undecompedPercentageTotal(self, totalStats: ProgressStats) -> float:
+        ...
+
+    def decompedPercentageTotal(self, totalStats: ProgressStats) -> float:
+        ...
+
     def getAsFrogressEntry(self, name: str) -> dict[str, int]: ...
 
+    @staticmethod
+    def getHeaderAsStr() -> str:
+        ...
+
     @staticmethod
     def printHeader() -> None: ...
 
+    def getEntryAsStr(self, category: str, totalStats: ProgressStats) -> str:
+        ...
+
     def print(self, category: str, totalStats: ProgressStats) -> None: ...
 
 
@@ -67,7 +86,9 @@ class Symbol:
     def getVramStr(self) -> str: ...
     def getSizeStr(self) -> str: ...
     def getVromStr(self) -> str: ...
+    def getAlignStr(self) -> str: ...
 
+    def serializeName(self, humanReadable: bool=True) -> str|int|None: ...
     def serializeVram(self, humanReadable: bool=True) -> str|int|None: ...
     def serializeSize(self, humanReadable: bool=True) -> str|int|None: ...
     def serializeVrom(self, humanReadable: bool=True) -> str|int|None: ...
@@ -84,6 +105,7 @@ class Symbol:
 
     def __eq__(self, other) -> bool: ...
     def __hash__(self): ...
+    def __repr__(self): ...
 
 
 class File:

{mapfile_parser-2.3.0 → mapfile_parser-2.3.1}/src/mapfile_parser/mapfile_rs.py

@@ -18,40 +18,6 @@ from .mapfile_parser import Segment as Segment
 from .mapfile_parser import MapFile as MapFile
 
 
-def __symbolrs_serializeVram(self: Symbol, humanReadable: bool=True) -> str|int|None:
-    if humanReadable:
-        return f"0x{self.vram:08X}"
-    return self.vram
-
-def __symbolrs_serializeSize(self: Symbol, humanReadable: bool=True) -> str|int|None:
-    if self.size is None:
-        return None
-    if humanReadable:
-        return f"0x{self.size:X}"
-    return self.size
-
-def __symbolrs_serializeVrom(self: Symbol, humanReadable: bool=True) -> str|int|None:
-    if self.vrom is None:
-        return None
-    if humanReadable:
-        return f"0x{self.vrom:06X}"
-    return self.vrom
-
-def __symbolrs_toJson(self: Symbol, humanReadable: bool=True) -> dict[str, Any]:
-    result: dict[str, Any] = {
-        "name": self.name,
-        "vram": self.serializeVram(humanReadable=humanReadable),
-        "size": self.serializeSize(humanReadable=humanReadable),
-        "vrom": self.serializeVrom(humanReadable=humanReadable),
-    }
-    return result
-
-Symbol.serializeVram = __symbolrs_serializeVram # type: ignore
-Symbol.serializeSize = __symbolrs_serializeSize # type: ignore
-Symbol.serializeVrom = __symbolrs_serializeVrom # type: ignore
-Symbol.toJson = __symbolrs_toJson # type: ignore
-
-
 @property # type: ignore
 def __filers_filepath(self: File) -> Path:
     return Path(self._filepath_internal)

mapfile_parser-2.3.1/src/mapfile_parser/progress_stats.py

@@ -0,0 +1,60 @@
+#!/usr/bin/env python3
+
+# SPDX-FileCopyrightText: © 2022-2023 Decompollaborate
+# SPDX-License-Identifier: MIT
+
+from __future__ import annotations
+
+import dataclasses
+
+
+@dataclasses.dataclass
+class ProgressStats:
+    undecompedSize: int = 0
+    decompedSize: int = 0
+
+    @property
+    def total(self) -> int:
+        return self.undecompedSize + self.decompedSize
+
+    def undecompedPercentage(self) -> float:
+        return self.undecompedSize / self.total * 100
+
+    def decompedPercentage(self) -> float:
+        return self.decompedSize / self.total * 100
+
+    def undecompedPercentageTotal(self, totalStats: ProgressStats) -> float:
+        return self.undecompedSize / totalStats.total * 100
+
+    def decompedPercentageTotal(self, totalStats: ProgressStats) -> float:
+        return self.decompedSize / totalStats.total * 100
+
+    def getAsFrogressEntry(self, name: str) -> dict[str, int]:
+        categories: dict[str, int] = {}
+        categories[name] = self.decompedSize
+        categories[f"{name}/total"] = self.total
+        return categories
+
+    @staticmethod
+    def getHeaderAsStr() -> str:
+        return f"{'Category':<28}: {'DecompedSize':>12} / {'Total':>8} {'OfFolder':>10}%  ({'OfTotal':>20}%)"
+
+    @staticmethod
+    def printHeader():
+        print(ProgressStats.getHeaderAsStr())
+
+    def getEntryAsStr(self, category: str, totalStats: ProgressStats) -> str:
+        return f"{category:<28}: {self.decompedSize:>12} / {self.total:>8} {self.decompedPercentage():>10.4f}%  ({self.decompedPercentageTotal(totalStats):>8.4f}% / {self.total / totalStats.total * 100:>8.4f}%)"
+
+    def print(self, category: str, totalStats: ProgressStats):
+        print(self.getEntryAsStr(category, totalStats))
+
+
+def printStats(totalStats: ProgressStats, progressPerFolder: dict[str, ProgressStats]):
+    ProgressStats.printHeader()
+    totalStats.print("all", totalStats)
+    print()
+
+    for folder, statsEntry in progressPerFolder.items():
+        statsEntry.print(folder, totalStats)
+