beet-observer 0.7.1__py3-none-any.whl → 0.7.3__py3-none-any.whl

beet_observer/__init__.py

@@ -1,3 +1,3 @@
-__version__ = "0.7.1"
+__version__ = "0.7.3"
 
 from .plugin import *

beet_observer/data_pack.py

@@ -1,3 +1,4 @@
+from pathlib import PosixPath
 from typing import Any
 
 import beet.contrib.worldgen as wg
@@ -6,14 +7,16 @@ from beet import Context, NamespaceProxy, Structure
 
 def gen_dp_overlays(
     ctx: Context, ctx_overlay: Context, overlay_dir: str, ignore: list[str]
-) -> None:
+) -> list[PosixPath]:
     """
-    Generates overlays between two datapacks.
-
-    Keyword arguments:</br>
-    `ctx` -- the build context</br>
-    `ctx_overlay` -- the overlay context</br>
-    `overlay_dir` -- the directory of the overlay</br>
+    Generates overlays between two datapacks. \n
+    Returns a list of deleted files from the source pack.
+
+    Keyword arguments:  \n
+    `ctx` -- the build context  \n
+    `ctx_overlay` -- the overlay context  \n
+    `overlay_dir` -- the directory of the overlay  \n
+    `ignore` -- a list of overlays to ignore (existing overlays that should not be touched)  \n
     """
     # create list of all datapack file types
     file_types: list[tuple[NamespaceProxy[Any], NamespaceProxy[Any]]] = [
@@ -107,8 +110,9 @@ def gen_dp_overlays(
         ),
     ]
     # for each file type, check for required overlays
+    deleted: list[PosixPath] = []
     for registry, registry_overlay in file_types:
-        check_registry(ctx, ctx_overlay, overlay_dir, registry, registry_overlay)
+        deleted.extend(check_registry(ctx, overlay_dir, registry, registry_overlay))
 
     # get pack.mcmeta overlay entries
     mcmeta: dict[str, dict[str, list[dict[str, Any]]]] = ctx.data.mcmeta.data.copy()
@@ -153,24 +157,28 @@ def gen_dp_overlays(
     if len(entries) > 0:
         ctx.data.mcmeta.data.update({"overlays": {"entries": entries}})
 
+    return deleted
+
 
 def check_registry(
     ctx: Context,
-    ctx_overlay: Context,
     overlay_dir: str,
     registry: NamespaceProxy[Any],
     registry_overlay: NamespaceProxy[Any],
-) -> None:
+) -> list[PosixPath]:
     """
-    Generates overlays for each namespace proxy.
-
-    Keyword arguments:</br>
-    `ctx` -- the build context</br>
-    `ctx_overlay` -- the overlay context</br>
-    `overlay_dir` -- the directory of the overlay</br>
-    `registry` -- the namespace proxy from the build context</br>
-    `registry_overlay` -- the namespace proxy from the overlay context</br>
+    Generates overlays for each namespace proxy. \n
+    Returns a list of deleted files from the source pack.
+
+    Keyword arguments:  \n
+    `ctx` -- the build context  \n
+    `overlay_dir` -- the directory of the overlay  \n
+    `registry` -- the namespace proxy from the build context  \n
+    `registry_overlay` -- the namespace proxy from the overlay context  \n
     """
+    # prepare cache deletion list
+    deleted: list[PosixPath] = []
+
     # check each file in the build pack
     for name in list(registry):
         if name in registry_overlay:
@@ -178,6 +186,7 @@ def check_registry(
             gen_registry_overlay(ctx, overlay_dir, name, registry, registry_overlay)
         else:
             # exists only in overlay, so create a deletion overlay
+            deleted.append(registry[name].source_path)
             gen_registry_overlay(
                 ctx, overlay_dir, name, registry, registry_overlay, "deletion"
             )
@@ -188,6 +197,8 @@ def check_registry(
             ctx, overlay_dir, name, registry, registry_overlay, "addition"
         )
 
+    return deleted
+
 
 def gen_registry_overlay(
     ctx: Context,
@@ -198,15 +209,15 @@ def gen_registry_overlay(
     type: str = "",
 ) -> None:
     """
-    Checks if two functions have the same contents and generate an overlay if they don't.
-
-    Keyword arguments:</br>
-    `ctx` -- the build context</br>
-    `overlay_dir` -- the directory of the generated overlay</br>
-    `name` -- the name of the file</br>
-    `registry` -- the namespace proxy from the build context</br>
-    `registry_overlay` -- the namespace proxy from the overlay context</br>
-    `type` -- either "deletion" or "addition" (default: `""`)</br>
+    Checks if two files have the same contents and generate an overlay if they don't.
+
+    Keyword arguments:  \n
+    `ctx` -- the build context  \n
+    `overlay_dir` -- the directory of the generated overlay  \n
+    `name` -- the name of the file  \n
+    `registry` -- the namespace proxy from the build context  \n
+    `registry_overlay` -- the namespace proxy from the overlay context  \n
+    `type`(optional) -- either "deletion" or "addition" (default: `""`)  \n
     """
     if type == "deletion":
         # move file from build pack to overlay in build pack

beet_observer/plugin.py

@@ -1,14 +1,16 @@
+from pathlib import PosixPath
+
 from beet import Context, run_beet
 
-from .data_pack import *
-from .resource_pack import *
+from .data_pack import gen_dp_overlays
+from .resource_pack import gen_rp_overlays
 
 
 def beet_default(ctx: Context):
     if "observer" not in ctx.meta:
         return
 
-    # # check cache
+    # check cache
     cache = ctx.cache["observer"]
     cached_dp = False
     cached_rp = False
@@ -17,12 +19,52 @@ def beet_default(ctx: Context):
     if ctx.data:
         dp_path = cache.get_path(f"{ctx.directory} saved_data_pack")
         if dp_path.is_dir():
-            ctx.data.load(f"{dp_path}")
+            # get files that were moved to an overlay
+            with open(f"{dp_path}/deleted.txt", mode="r") as del_list:
+                deleted = del_list.read().splitlines()
+
+            # delete files that were moved to an overlay
+            for target in deleted:
+                # get file location
+                target_path = PosixPath(target)
+                folders = target_path.parts
+                ext = "." + folders[-1].split(".")[-1]
+                loc = f"{folders[1]}:{folders[-1].removesuffix(ext)}"
+                # get resource location
+                for location, resource in ctx.data.all(loc):
+                    p = str(resource.source_path)  # type: ignore
+                    resource_path = PosixPath((p[p.find("/data/") + 1 :]))
+                    # delete resource from pack
+                    if target_path == resource_path:
+                        del ctx.data[type(resource)][location]
+
+            # add overlays to pack
+            ctx.data.load(f"{dp_path}/pack")
             cached_dp = True
     if ctx.assets:
         rp_path = cache.get_path(f"{ctx.directory} saved_resource_pack")
         if rp_path.is_dir():
-            ctx.assets.load(f"{rp_path}")
+            # get files that were moved to an overlay
+            with open(f"{rp_path}/deleted.txt", mode="r") as del_list:
+                deleted = del_list.read().splitlines()
+
+            # delete files that were moved to an overlay
+            for target in deleted:
+                # get file location
+                target_path = PosixPath(target)
+                folders = target_path.parts
+                ext = "." + folders[-1].split(".")[-1]
+                loc = f"{folders[1]}:{folders[-1].removesuffix(ext)}"
+                # get resource location
+                for location, resource in ctx.assets.all(loc):
+                    p = str(resource.source_path)  # type: ignore
+                    resource_path = PosixPath((p[p.find("/assets/") + 1 :]))
+                    # delete resource from pack
+                    if target_path == resource_path:
+                        del ctx.assets[type(resource)][location]
+
+            # add overlays to pack
+            ctx.assets.load(f"{rp_path}/pack")
             cached_rp = True
     if cached_dp and cached_rp:
         return
@@ -45,10 +87,15 @@ def beet_default(ctx: Context):
             "rp"
         ]
     # save current overlays
-    save: list[str] = []
+    save_dp: list[str] = []
+    save_rp: list[str] = []
     for overlay in ctx.data.overlays:
-        save.append(overlay)
+        save_dp.append(overlay)
+    for overlay in ctx.assets.overlays:
+        save_rp.append(overlay)
     # loop through all overlays
+    deleted_dp: list[PosixPath] = []
+    deleted_rp: list[PosixPath] = []
     for overlay in ctx.meta["observer"]["overlays"]:
         # get pack
         if overlay["process"].startswith("https://"):
@@ -67,12 +114,18 @@ def beet_default(ctx: Context):
                 rp_dir = overlay["directory"]
             # compare build pack and overlay pack
             if not cached_dp and ctx.data:
-                gen_dp_overlays(ctx, ctx_overlay, dp_dir, save)
+                deleted_dp = gen_dp_overlays(ctx, ctx_overlay, dp_dir, save_dp)
             if not cached_rp and ctx.assets:
-                gen_rp_overlays(ctx, ctx_overlay, rp_dir, save)
+                deleted_rp = gen_rp_overlays(ctx, ctx_overlay, rp_dir, save_rp)
 
     # save to cache
     if not cached_dp and ctx.data:
-        ctx.data.save(path=dp_path)
+        ctx.data.save(path=f"{dp_path}/pack")
+        with open(f"{dp_path}/deleted.txt", mode="x") as file:
+            for s in deleted_dp:
+                file.write(str(s)[str(s).find("/data/") + 1 :] + "\n")
     if not cached_rp and ctx.assets:
-        ctx.assets.save(path=rp_path)
+        ctx.assets.save(path=f"{rp_path}/pack")
+        with open(f"{rp_path}/deleted.txt", mode="x") as file:
+            for s in deleted_rp:
+                file.write(str(s)[str(s).find("/assets/") + 1 :] + "\n")

beet_observer/resource_pack.py

@@ -1,3 +1,4 @@
+from pathlib import PosixPath
 from typing import Any
 
 from beet import Context, NamespaceProxy
@@ -5,14 +6,15 @@ from beet import Context, NamespaceProxy
 
 def gen_rp_overlays(
     ctx: Context, ctx_overlay: Context, overlay_dir: str, ignore: list[str]
-) -> None:
+) -> list[PosixPath]:
     """
     Generates overlays between two resource packs.
 
-    Keyword arguments:</br>
-    `ctx` -- the build context</br>
-    `ctx_overlay` -- the overlay context</br>
-    `overlay_dir` -- the directory of the overlay</br>
+    Keyword arguments:  \n
+    `ctx` -- the build context  \n
+    `ctx_overlay` -- the overlay context  \n
+    `overlay_dir` -- the directory of the overlay  \n
+    `ignore` -- a list of overlays to ignore (existing overlays that should not be touched)  \n
     """
     # create list of all resource pack file types
     file_types: list[tuple[NamespaceProxy[Any], NamespaceProxy[Any]]] = [
@@ -35,8 +37,9 @@ def gen_rp_overlays(
         (ctx.assets.atlases, ctx_overlay.assets.atlases),
     ]
     # for each file type, check for required overlays
+    deleted: list[PosixPath] = []
     for registry, registry_overlay in file_types:
-        check_registry(ctx, ctx_overlay, overlay_dir, registry, registry_overlay)
+        deleted.extend(check_registry(ctx, overlay_dir, registry, registry_overlay))
 
     # get pack.mcmeta overlay entries
     mcmeta: dict[str, dict[str, list[dict[str, Any]]]] = ctx.assets.mcmeta.data.copy()
@@ -81,24 +84,27 @@ def gen_rp_overlays(
     if len(entries) > 0:
         ctx.assets.mcmeta.data.update({"overlays": {"entries": entries}})
 
+    return deleted
+
 
 def check_registry(
     ctx: Context,
-    ctx_overlay: Context,
     overlay_dir: str,
     registry: NamespaceProxy[Any],
     registry_overlay: NamespaceProxy[Any],
-) -> None:
+) -> list[PosixPath]:
     """
     Generates overlays for each namespace proxy.
 
-    Keyword arguments:</br>
-    `ctx` -- the build context</br>
-    `ctx_overlay` -- the overlay context</br>
-    `overlay_dir` -- the directory of the overlay</br>
-    `registry` -- the namespace proxy from the build context</br>
-    `registry_overlay` -- the namespace proxy from the overlay context</br>
+    Keyword arguments:  \n
+    `ctx` -- the build context  \n
+    `overlay_dir` -- the directory of the overlay  \n
+    `registry` -- the namespace proxy from the build context  \n
+    `registry_overlay` -- the namespace proxy from the overlay context  \n
     """
+    # prepare cache deletion list
+    deleted: list[PosixPath] = []
+
     # check each file in the build pack
     for name in list(registry):
         if name in registry_overlay:
@@ -106,6 +112,7 @@ def check_registry(
             gen_registry_overlay(ctx, overlay_dir, name, registry, registry_overlay)
         else:
             # exists only in overlay, so create a deletion overlay
+            deleted.append(registry[name].source_path)
             gen_registry_overlay(
                 ctx, overlay_dir, name, registry, registry_overlay, "deletion"
             )
@@ -116,6 +123,8 @@ def check_registry(
             ctx, overlay_dir, name, registry, registry_overlay, "addition"
         )
 
+    return deleted
+
 
 def gen_registry_overlay(
     ctx: Context,
@@ -126,15 +135,15 @@ def gen_registry_overlay(
     type: str = "",
 ) -> None:
     """
-    Checks if two functions have the same contents and generate an overlay if they don't.
-
-    Keyword arguments:</br>
-    `ctx` -- the build context</br>
-    `overlay_dir` -- the directory of the generated overlay</br>
-    `name` -- the name of the file</br>
-    `registry` -- the namespace proxy from the build context</br>
-    `registry_overlay` -- the namespace proxy from the overlay context</br>
-    `type` -- either "deletion" or "addition" (default: `""`)</br>
+    Checks if two files have the same contents and generate an overlay if they don't.
+
+    Keyword arguments:  \n
+    `ctx` -- the build context  \n
+    `overlay_dir` -- the directory of the generated overlay  \n
+    `name` -- the name of the file  \n
+    `registry` -- the namespace proxy from the build context  \n
+    `registry_overlay` -- the namespace proxy from the overlay context  \n
+    `type`(optional) -- either "deletion" or "addition" (default: `""`)  \n
     """
     if type == "deletion":
         # move file from build pack to overlay in build pack

{beet_observer-0.7.1.dist-info → beet_observer-0.7.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: beet-observer
-Version: 0.7.1
+Version: 0.7.3
 Summary: A beet plugin to automatically generate overlays from previous datapacks
 License: MIT
 Author: BPR02

beet_observer-0.7.3.dist-info/RECORD

@@ -0,0 +1,8 @@
+beet_observer/__init__.py,sha256=2a7c7z_oeF6m8073Y6AaZlA2Ki1lPLQrXIm7RssesGo,45
+beet_observer/data_pack.py,sha256=6bsBYi7-uvqxEk4ZuYZrS9A68LbTBo1v9M8b9eEzBoo,10361
+beet_observer/plugin.py,sha256=Be1jA_8ScChb0ZtwZ1voQY-sG4YmOaEhiGo41KGF2xk,5412
+beet_observer/resource_pack.py,sha256=2GMUrNv0fF7-a0RWZ46sA7ipDt7s5z4yE3laPv2eXO8,6477
+beet_observer-0.7.3.dist-info/LICENSE,sha256=oBbP6j7sgG9darFSRZxV7iO8yPR1aZiDspSK3mcLpXI,1062
+beet_observer-0.7.3.dist-info/METADATA,sha256=lLvfQOV4UBpOMKqvyV1aOPHdCXyQh6fc7z3_ETYJb9w,674
+beet_observer-0.7.3.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+beet_observer-0.7.3.dist-info/RECORD,,

beet_observer-0.7.1.dist-info/RECORD

@@ -1,8 +0,0 @@
-beet_observer/__init__.py,sha256=1XpNKUm-Hk_yCgkuoqDBACiacdZ1uf9I3C1WAHMucuE,45
-beet_observer/data_pack.py,sha256=YIkMDaR1j6FU-ukC5UibCaweRQ-TEvd_w1sZZTbE5Ww,9972
-beet_observer/plugin.py,sha256=mtGBtJNCiUHkSGiAoRl7li0oIlZBQ-cuDS91bubDaPs,2835
-beet_observer/resource_pack.py,sha256=anQw0EdCF780j9rVMM1ycQAqQzEFpg_8I_h6T5Xoguo,6210
-beet_observer-0.7.1.dist-info/LICENSE,sha256=oBbP6j7sgG9darFSRZxV7iO8yPR1aZiDspSK3mcLpXI,1062
-beet_observer-0.7.1.dist-info/METADATA,sha256=_c2AXX_DL1MmeoqYuYMHpg4xWWTkhKkRuwtlid4-2zc,674
-beet_observer-0.7.1.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-beet_observer-0.7.1.dist-info/RECORD,,