beet-observer 0.7.1__tar.gz → 0.7.2__tar.gz

{beet_observer-0.7.1 → beet_observer-0.7.2}/PKG-INFO

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

{beet_observer-0.7.1 → beet_observer-0.7.2}/beet_observer/__init__.py

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

{beet_observer-0.7.1 → beet_observer-0.7.2}/beet_observer/data_pack.py

@@ -10,10 +10,11 @@ def gen_dp_overlays(
     """
     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>
+    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]]] = [
@@ -108,7 +109,7 @@ def gen_dp_overlays(
     ]
     # for each file type, check for required overlays
     for registry, registry_overlay in file_types:
-        check_registry(ctx, ctx_overlay, overlay_dir, registry, registry_overlay)
+        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()
@@ -156,7 +157,6 @@ def gen_dp_overlays(
 
 def check_registry(
     ctx: Context,
-    ctx_overlay: Context,
     overlay_dir: str,
     registry: NamespaceProxy[Any],
     registry_overlay: NamespaceProxy[Any],
@@ -164,12 +164,11 @@ def check_registry(
     """
     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
     """
     # check each file in the build pack
     for name in list(registry):
@@ -198,15 +197,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 → beet_observer-0.7.2}/beet_observer/plugin.py

@@ -1,14 +1,14 @@
 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
@@ -45,9 +45,12 @@ 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
     for overlay in ctx.meta["observer"]["overlays"]:
         # get pack
@@ -67,9 +70,9 @@ 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)
+                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)
+                gen_rp_overlays(ctx, ctx_overlay, rp_dir, save_rp)
 
     # save to cache
     if not cached_dp and ctx.data:

{beet_observer-0.7.1 → beet_observer-0.7.2}/beet_observer/resource_pack.py

@@ -9,10 +9,11 @@ def gen_rp_overlays(
     """
     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]]] = [
@@ -36,7 +37,7 @@ def gen_rp_overlays(
     ]
     # for each file type, check for required overlays
     for registry, registry_overlay in file_types:
-        check_registry(ctx, ctx_overlay, overlay_dir, registry, registry_overlay)
+        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()
@@ -84,7 +85,6 @@ def gen_rp_overlays(
 
 def check_registry(
     ctx: Context,
-    ctx_overlay: Context,
     overlay_dir: str,
     registry: NamespaceProxy[Any],
     registry_overlay: NamespaceProxy[Any],
@@ -92,12 +92,11 @@ def check_registry(
     """
     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
     """
     # check each file in the build pack
     for name in list(registry):
@@ -126,15 +125,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 → beet_observer-0.7.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "beet-observer"
-version = "0.7.1"
+version = "0.7.2"
 description = "A beet plugin to automatically generate overlays from previous datapacks"
 authors = ["BPR02 <dev@bpr02.com>"]
 license = "MIT"
@@ -36,8 +36,8 @@ profile = "black"
 typeCheckingMode = "strict"
 
 [tool.poe.tasks]
-format = {shell = "isort beet_observer & black beet_observer"}
-check = {shell = "isort --check-only beet_observer & black --check beet_observer"}
+format = {shell = "isort beet_observer & black beet_observer & pyright"}
+check = {shell = "isort --check-only beet_observer & black --check beet_observer & pyright"}
 typing = {shell = "pyright"}
 
 [build-system]