MapleX 2.2.0b1__tar.gz → 2.2.0.dev2__tar.gz

{maplex-2.2.0b1 → maplex-2.2.0.dev2}/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.0b1/src/MapleX.egg-info → maplex-2.2.0.dev2}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: MapleX
-Version: 2.2.0b1
-Summary: A Python library for Maple file format operations, with logging and console color utilities
-Author: RyujiHazama
+Version: 2.2.0.dev2
+Summary: MapleX: A Python library for Maple file format operations, with logging and console color utilities
+Author: Ryuji Hazama
 Project-URL: PyPI, https://pypi.org/project/MapleX/
 Project-URL: Homepage, https://github.com/Ryuji-Hazama
 Project-URL: Repository, https://github.com/Ryuji-Hazama/MapleTree
@@ -26,18 +26,9 @@ Dynamic: license-file
     ***You can install the package from pip with the following command.***
 
 ```bash
-pip install MapleX
+pip install maplex
 ```
 
-## Table of Contents
-
-> - [Maple File](#maple-file)
-> - [MapleTree Class](#mapletree-class)
-> - [Logger Class](#logger-class)
-> - [Exceptions](#exceptions)
-> - [Console Colors](#console-colors)
-> - [Install MapleX](#install-maplex)
-
 ## Maple File
 
     Maple is a file system that I created when I was a child. It's like a combination of the INI file and the Jason file. I made this format that is easy to read and write for both humans and machines.
@@ -82,12 +73,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.
@@ -157,30 +147,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
 
@@ -323,8 +292,6 @@ EOF
     If `encrypt=True`, the instance decrypts data when it is read, and encrypts data when it is saved.  
     You need to specify the byte key when you use encryption, and the file must be encrypted.
 
-:warning: **The key must be 32 url-safe base64-encoded bytes**
-
 ```python
 mapleFile = MapleTree("FileName.mpl", encrypt=True, key=key)
 ```
@@ -396,32 +363,7 @@ def saveTagLine(
 |**`willSave`**|\*|Save to file flag|
 |**`headers`**||Target headers|
 
-    Outdated from `v2.2.0`
-
-### `saveValue()`
-
-    `v2.2.0` or newer
-
-```python
-def saveValue(
-    tag: str,
-    valueString: any,
-    *headers: str,
-    **kwargs
-) -> bool
-```
-
-|Property|Required|Value|
-|--------|--------|-----|
-|**`tag`**|\*|Target tag|
-|**`value`**|\*|Value to save|
-|**`headers`**||Target headers|
-|**`kwargs`**||Keyword arguments|
-
-    `saveValue` saves a value with a tag in a header block specified by the parameter.
-
-- Set `save=True` to save changes to the file.
-  - Default: `save=False`
+    `saveTagLine` saves a value with a tag in a header block specified by the parameter.
 
 E.g.:
 
@@ -429,7 +371,7 @@ E.g.:
 from maplex import MapleTree
 
 mapleFile = MapleTree("SampleData.mpl", createBaseFile=True)
-mapleFile.saveTagLine("TAG", "VALUE", "FOO", save=True)
+mapleFile.saveTagLine("TAG", "VALUE", True, "FOO")
 
 ```
 
@@ -445,12 +387,12 @@ EOF
 
 #### Update a Buffer Content
 
-    If `save=False` (or not specified), the buffer content will be updated, but no update on physical file content.
+    If `willSave=False`, the buffer content will be updated, but no update on physical file content.
 
 E.g.:
 
 ```python
-mapleFile.saveTagLine("TAG", "NEW VALUE", "FOO")
+mapleFile.saveTagLine("TAG", "NEW VALUE", False, "FOO")
 ```
 
     This code changes the contents on buffer like:
@@ -475,10 +417,10 @@ EOF
 
 #### Update and Save Changes
 
-    If `save=True`, all the changes to the buffer will be saved.
+    If `willSave=True`, all the changes to the buffer will be saved.
 
 ```python
-mapleFile.saveTagLine("BAR", "ANOTHER VALUE", "FOO", save=True)
+mapleFile.saveTagLine("BAR", "ANOTHER VALUE", True, "FOO")
 ```
 
     This code changes the contents in the file like:
@@ -497,10 +439,10 @@ EOF
     If the block and/or the header(s) specified with the parameters do not exist in the data, the function creates the new header block(s) and the tag and saves the value.
 
 ```python
-mapleFile.saveTagLine("TAZ", "NEW HEADER AND TAG", "NEW_HEADER")
+mapleFile.saveTagLine("TAZ", "NEW HEADER AND TAG", False, "NEW_HEADER")
 ```
 
-    This code will change the buffer data like:
+    This code will change the data like:
 
 ```text
 MAPLE
@@ -530,31 +472,8 @@ def deleteTag(
 |**`willSave`**||Save to file flag|
 |**`headers`**||Target headers|
 
-    Outdated from `v2.2.0`
-
-### `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|
-
     Delete a tag and its value.
 
-- Set `save=True` to save changes to the file.
-  - Default: `save=False`
-
 Sample data: `SampleData.mpl`
 
 ```text
@@ -574,7 +493,7 @@ E.g.:
 from maplex import MapleTree
 
 mapleFile = MapleTree("SampleData.mpl")
-mapleFile.deleteTag("BAR", "FOO", save=True)
+mapleFile.deleteTag("BAR", True, "FOO")
 ```
 
     The file data will be changed like:
@@ -681,33 +600,10 @@ def deleteHeader(
 |--------|--------|-----|
 |**`delHead`**|\*|Deleting header|
 |**`willSave`**||Save to file flag|
-|**`Headers`**||Target headers|
-
-    Outdated from `v2.2.0`
-
-### `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|
 
     This deletes an entire header block and its associated data, including child blocks.
 
-- Set `save=True` for save data to the file.
-  - Default: `save=False`
-
 Sample data: `SampleData.mpl`
 
 ```text
@@ -732,7 +628,7 @@ E.g.:
 from maplex import MapleTree
 
 mapleTree = MapleTree("SampleData.mpl")
-mapleTree.deleteHeader("FOO", save=True)
+mapleTree.deleteHeader("FOO", True)
 ```
 
     This code changes the data like:
@@ -791,255 +687,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
-```
-
-### `changeEncryptionKey()`
-
-    `v2.2.0` or newer
-
-```python
-def changeEncryptionKey(
-    newKey: bytes,
-    save: bool = False
-    ) -> None
-```
-
-|Property|Required|Value|
-|--------|--------|-----|
-|**`newKey`**|\*|New encryption key|
-|**`save`**||Save to file flag|
-
-    Changing file encryption key. If `save=True`, encrypt the buffer data with new key and save to the file.
-
-:warning: **The key must be 32 url-safe base64-encoded bytes**
-
 ## Logger Class
 
     Logger is a logging object for Python applications. It outputs application logs to log files and to standard output.
@@ -1122,9 +769,8 @@ def ShowError(
 
 - You can configure log settings with `config.mpl`.
 - If `config.mpl` does not exist, the instance auto-generates the file.
-- Instance uses the parameter values to auto-generate configuration file, or using default value if it was not specified.
 
-Auto-generated `config.mpl` (parameters not specified):
+Auto-generated `config.mpl`:
 
 ```text
 MAPLE
@@ -1171,10 +817,6 @@ EOF
 
     This occurs when the data is not found in the file.
 
-### `MapleEncryptionNotEnabledException(MapleException)`
-
-    This occurs when try to encrypt maple data, but the encryption flag is `False`.
-
 ### `class MapleHeaderNotFoundException(MapleDataNotFoundException)`
 
     This occurs when the header (specified by the user) is not found in the data.
@@ -1257,12 +899,12 @@ EOF
 |`Reversed`|\\033\[7m|Reversed colors|
 |`Reset`|\\033\[0m|Reset formatting|
 
-## Install MapleX
+## Install maplex :inbox_tray:
 
 ### From PyPI
 
 ```bash
-[python[3] -m] pip install MapleX [--break-system-packages]
+[python[3] -m] pip install maplex [--break-system-packages]
 ```
 
 ### Manual Installation