MapleX 2.2.0a2__tar.gz → 2.2.0.dev1__tar.gz

{maplex-2.2.0a2 → maplex-2.2.0.dev1}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2026 Ryuji Hazama
+Copyright (c) 2025 Ryuji Hazama
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

{maplex-2.2.0a2/src/MapleX.egg-info → maplex-2.2.0.dev1}/PKG-INFO

@@ -1,10 +1,31 @@
 Metadata-Version: 2.4
 Name: MapleX
-Version: 2.2.0a2
-Summary: # MapleX
+Version: 2.2.0.dev1
+Summary: MapleX: A Python library for Maple file format operations, with logging and console color utilities
 Author: Ryuji Hazama
+License: MIT License
+        
+        Copyright (c) 2025 Ryuji Hazama
+        
+        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.
 Project-URL: PyPI, https://pypi.org/project/MapleX/
-Project-URL: Homepage, https://github.com/Ryuji-Hazama
+Project-URL: GitHub, https://github.com/Ryuji-Hazama
 Project-URL: Repository, https://github.com/Ryuji-Hazama/MapleTree
 Project-URL: Issues, https://github.com/Ryuji-Hazama/MapleTree/issues
 Project-URL: YouTube, https://www.youtube.com/@ryujihazama
@@ -73,12 +94,11 @@ H Data Headers
             # which is already used in the parent's header
         E
     E
-    H *NOTES NOTES_HEADER
+    H *NOTES
         # Note's header
         NTE {strimg}
         NTE ...
         # Note's main strings for the multi-line data
-        # COMMENTS IN THE "*NOTES" BLOCK WILL BE DELETED WHEN SAVE VALUE!
     E
     H #*
         This is a comment block.
@@ -148,30 +168,9 @@ E
 EOF
 ```
 
-### Notes (Multi-lined Data)
-
-`v2.2.0` or newer
-
-- You can save multi-lined data inside `H *NOTES` block.
-- You must specify the header when you save notes value.
-
-E.g.:
-
-```text
-MAPLE
-
-H *NOTES NOTES_HEADER
-    NTE YOU CAN SAVE
-    NTE MULTI-LINED DATA
-    NTE INSIDE THIS BLOCK
-E
-
-EOF
-```
-
 ### Comments
 
-`v2.1.0` or newer
+`v2.1.0 or newer`
 
 #### Comment Line
 
@@ -478,30 +477,6 @@ E
 EOF
 ```
 
-### `saveValue()`
-
-    `v2.2.0` or newer
-
-```python
-def saveValue(
-    tag: str,
-    valueString: any,
-    *headers: str,
-    **kwargs
-) -> bool
-```
-
-|Property|Required|Value|
-|--------|--------|-----|
-|**`tag`**|\*|Tag to delete|
-|**`value`**|\*|Value to save|
-|**`headers`**||Target headers|
-|**`kwargs`**||Keyword arguments|
-
-- Same as `saveTagLine()`
-- Set `save=True` to save changes to the file.
-  - Default: `save=False`
-
 ### `deleteTag()`
 
 ```python
@@ -554,28 +529,6 @@ E
 EOF
 ```
 
-### `deleteValue()`
-
-    `v2.2.0` or newer
-
-```python
-def deleteValue(
-    delTag: str,
-    *headers: str,
-    **kwargs
-) -> bool
-```
-
-|Property|Required|Value|
-|--------|--------|-----|
-|**`delTag`**|\*|Tag to delete|
-|**`headers`**||Target headers|
-|**`kwargs`**||Keyword arguments|
-
-- Same as `deleteTag()`
-- Set `save=True` to save changes to the file.
-  - Default: `save=False`
-
 ### `getTagValueDict()`
 
 ```python
@@ -668,7 +621,7 @@ def deleteHeader(
 |--------|--------|-----|
 |**`delHead`**|\*|Deleting header|
 |**`willSave`**||Save to file flag|
-|**`Headers`**||Target headers|
+|**`headers`**||Target headers|
 
     This deletes an entire header block and its associated data, including child blocks.
 
@@ -711,28 +664,6 @@ E
 EOF
 ```
 
-### `removeHeader()`
-
-    `v2.2.0` or newer
-
-```python
-def removeHeader(
-    delHead: str,
-    *headers: str,
-    **kwargs
-) -> bool
-```
-
-|Property|Required|Value|
-|--------|--------|-----|
-|**`delHead`**|\*|Deleting header|
-|**`headers`**||Target headers|
-|**`kwargs`**||Keyword arguments|
-
-- Same as `deleteHeader()`
-- Set `save=True` for save data to the file.
-  - Default: `save=False`
-
 ### `getHeaders()`
 
 ```python
@@ -777,235 +708,6 @@ print(headerList)
 # Outputs "['FOO', 'QUUX']"
 ```
 
-### `saveNotes()`
-
-    `v2.2.0` or newer
-
-```python
-def saveNotes(
-    noteValues: list[str],
-    *headers: str,
-    **kwargs
-    ) -> None
-```
-
-|Property|Required|Value|
-|--------|--------|-----|
-|**`noteValues`**|\*|Data to save|
-|**`headers`**|\*|Target headers|
-|**`kwargs`**||Keyword arguments|
-
-    The function saves string list as a special notes block value. Set `save=True` to save the changes (Default: `save=False`)
-
-E.g.:
-
-```python
-from maplex import MapleTree
-
-mapleTree = MapleTree("SampleData.mpl", createBasaFile=True)
-stringList = ["Hello", "there!"]
-mapleTree.saveNotes(stringList, "FOO", "BAR", save=True)
-```
-
-    This code creates a new file contains the following contents:
-
-```text
-MAPLE
-
-H FOO
-    H *NOTES BAR
-        NTE Hello
-        NTE there!
-    E
-E
-
-EOF
-```
-
-### `saveNote()`
-
-    `v2.2.0` or newer
-
-```python
-def saveNote(
-    noteValues: str,
-    *headers: str,
-    **kwargs
-    ) -> None
-```
-
-|Property|Required|Value|
-|--------|--------|-----|
-|**`noteValues`**|\*|Data to save|
-|**`headers`**|\*|Target headers|
-|**`kwargs`**||Keyword arguments|
-
-    The function saves multi-lined string as a special notes block value. Set `save=True` to save the changes (Default: `save=False`)
-
-E.g.:
-
-```python
-from maplex import MapleTree
-
-mapleTree = MapleTree("SampleData.mpl", createBasaFile=True)
-dataString = "This is a\nmulti-lined data."
-mapleTree.saveNotes(dataString, "FOO", "BAR", save=True)
-```
-
-    This code creates a new file contains the following contents:
-
-```text
-MAPLE
-
-H FOO
-    H *NOTES BAR
-        NTE This is a
-        NTE multi-lined data.
-    E
-E
-
-EOF
-```
-
-### `readNotes()`
-
-    `v2.2.0` or newer
-
-```python
-def readNotes(
-    *headers: str
-    ) -> list[str]
-```
-
-|Property|Required|Value|
-|--------|--------|-----|
-|**`headers`**|\*|Target headers|
-
-    Read note block value which specified by the `headers` and return as a string list.
-
-Sample data: `SampleData.mpl`
-
-```text
-MAPLE
-
-H FOO
-    H *NOTES BAR
-        NTE This is a
-        NTE multi-lined data.
-    E
-E
-
-EOF
-```
-
-E.g.:
-
-```python
-from maplex import MapleTree
-
-mapleFile = MapleTree("SampleData.mpl")
-stringList = mapleFile.readNotes("FOO", "BAR")
-
-print(stringList)
-# Outputs "['This is a', 'multi-lined data.']"
-```
-
-### `readNote()`
-
-    `v2.2.0` or newer
-
-```python
-def readNote(
-    *headers: str
-    ) -> str
-```
-
-|Property|Required|Value|
-|--------|--------|-----|
-|**`headers`**|\*|Target headers|
-
-    Read note block value which specified by the `headers` and return as a string.
-
-Sample data: `SampleData.mpl`
-
-```text
-MAPLE
-
-H FOO
-    H *NOTES BAR
-        NTE This is a
-        NTE multi-lined data.
-    E
-E
-
-EOF
-```
-
-E.g.:
-
-```python
-from maplex import MapleTree
-
-mapleFile = MapleTree("SampleData.mpl")
-dataString = mapleFile.readNote("FOO", "BAR")
-
-print(dataString)
-# Outputs "This is a
-# multi-lined data"
-```
-
-### `deleteNotes()`
-
-    `v2.2.0` or newer
-
-```python
-def deleteNotes(
-    *headers: str
-    ) -> bool
-```
-
-|Property|Required|Value|
-|--------|--------|-----|
-|**`headers`**|\*|Target headers|
-|**`kwargs`**||Keyword args|
-
-    Delete note block which specified by the `headers` and return `True` if it success. Set `save=True` to save the changes (Default: `save=False`)
-
-Sample data: `SampleData.mpl`
-
-```text
-MAPLE
-
-H FOO
-    H *NOTES BAR
-        NTE This is a
-        NTE multi-lined data.
-    E
-E
-
-EOF
-```
-
-E.g.:
-
-```python
-from maplex import MapleTree
-
-mapleFile = MapleTree("SampleData.mpl")
-stringList = mapleFile.deleteNotes("FOO", "BAR", save=True)
-```
-
-    This code changes the file data like:
-
-```text
-MAPLE
-
-H FOO
-E
-
-EOF
-```
-
 ## Logger Class
 
     Logger is a logging object for Python applications. It outputs application logs to log files and to standard output.