deprecate getname and debugging

Decompollaborate · Oct 2, 2023 · 8aea14f · 8aea14f
1 parent 4e3f9cb
commit 8aea14f
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -16,6 +16,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Cleanup the `README.md` a bit
 
+### Deprecated
+
+- Deprecate `File.getName`
+  - The method itself doesn't make sense, instead operate on `File.filepath` directly
+- Deprecate `MapFile.debugging`
+- Deprecate `progress` frontend's `--debugging` flag
+
 ## [2.1.4] - 2023-09-11
 
 ### Fixed

diff --git a/src/mapfile_parser/mapfile.py b/src/mapfile_parser/mapfile.py
@@ -165,6 +165,7 @@ def serializeVrom(self, humanReadable: bool=True) -> str|int|None:
         return self.vrom
 
 
+    #! @deprecated
     def getName(self) -> Path:
         return Path(*self.filepath.with_suffix("").parts[2:])
 
@@ -445,6 +446,8 @@ def __hash__(self):
 class MapFile:
     def __init__(self):
         self._segmentsList: list[Segment] = list()
+
+        #! @deprecated
         self.debugging: bool = False
 
     def readMapFile(self, mapPath: Path):