unitytk 0.0.3__tar.gz → 0.0.4__tar.gz

{unitytk-0.0.3/unitytk.egg-info → unitytk-0.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: unitytk
-Version: 0.0.3
+Version: 0.0.4
 Summary: A modular Python toolkit for Unity interaction.
 Author-email: Ryan Simpson <m3trik@outlook.com>
 License: MIT
@@ -15,7 +15,7 @@ License-File: LICENSE
 Requires-Dist: pythontk>=0.7.71
 Dynamic: license-file
 
-[![Tests](https://img.shields.io/badge/Tests-113%20passed-brightgreen.svg)](../test/)
+[![Tests](https://img.shields.io/badge/Tests-116%20passed-brightgreen.svg)](../test/)
 
 # unitytk
 

{unitytk-0.0.3 → unitytk-0.0.4}/docs/README.md

@@ -1,4 +1,4 @@
-[![Tests](https://img.shields.io/badge/Tests-113%20passed-brightgreen.svg)](../test/)
+[![Tests](https://img.shields.io/badge/Tests-116%20passed-brightgreen.svg)](../test/)
 
 # unitytk
 

{unitytk-0.0.3 → unitytk-0.0.4}/test/test_c130_fcr_integration.py

@@ -641,7 +641,7 @@ class TestC130FcrIntegration(unittest.TestCase):
 
     @classmethod
     def setUpClass(cls):
-        # Repo-local temp_tests (already on O:); temp dir — C: drive is often full
+        # Repo-local temp_tests (already on the O: drive; C: is often full).
         _temp_base = os.path.join(os.path.dirname(__file__), "temp_tests")
         os.makedirs(_temp_base, exist_ok=True)
         cls.temp_dir = tempfile.mkdtemp(prefix="c130_fcr_integ_", dir=_temp_base)

{unitytk-0.0.3 → unitytk-0.0.4}/test/test_deploy_templates.py

@@ -92,6 +92,47 @@ class DeployTemplateTest(unittest.TestCase):
         with open(shader, encoding="utf-8") as fh:
             self.assertIn('#include "EmissiveGroups.hlsl"', fh.read())
 
+    def test_status_reports_not_installed_then_up_to_date(self):
+        """The panels' Status action: absent → installed=False with the full
+        bundle missing; after deploy → current version, nothing missing."""
+        before = TemplateDeployer.status(self.project)
+        self.assertFalse(before["installed"])
+        self.assertFalse(before["up_to_date"])
+        self.assertIn("UnitytkSettings.cs", before["missing"])
+
+        TemplateDeployer.deploy_package(self.project)
+        after = TemplateDeployer.status(self.project)
+        self.assertTrue(after["installed"])
+        self.assertEqual(after["version"], unitytk.__version__)
+        self.assertEqual(after["missing"], [])
+        self.assertTrue(after["up_to_date"])
+
+    def test_status_flags_a_partial_deploy(self):
+        """A deleted file shows in ``missing`` and clears ``up_to_date`` — the
+        compile-coupled set is only valid whole."""
+        TemplateDeployer.deploy_package(self.project)
+        os.remove(os.path.join(self.package, "UnitytkSettings.cs"))
+        info = TemplateDeployer.status(self.project)
+        self.assertEqual(info["missing"], ["UnitytkSettings.cs"])
+        self.assertFalse(info["up_to_date"])
+
+    def test_uninstall_removes_only_our_package(self):
+        """Uninstall deletes the deployed folder (True), no-ops when absent
+        (False), and REFUSES a folder whose package.json is not ours — never
+        delete a directory we merely expected to own."""
+        self.assertFalse(TemplateDeployer.uninstall_package(self.project))
+
+        TemplateDeployer.deploy_package(self.project)
+        self.assertTrue(TemplateDeployer.uninstall_package(self.project))
+        self.assertFalse(os.path.isdir(self.package))
+
+        os.makedirs(self.package)
+        with open(os.path.join(self.package, "package.json"), "w") as fh:
+            json.dump({"name": "com.example.other"}, fh)
+        with self.assertRaises(ValueError):
+            TemplateDeployer.uninstall_package(self.project)
+        self.assertTrue(os.path.isdir(self.package), "foreign folder untouched")
+
     def test_deploy_package_never_writes_project_config(self):
         """Per-project settings live in ProjectSettings/UnitytkSettings.json,
         owned by the project — deploying must not create or clobber them."""

{unitytk-0.0.3 → unitytk-0.0.4}/test/test_fade_window_preservation.py

@@ -209,7 +209,9 @@ class TestFadeWindowPreservation(unittest.TestCase):
 
     @classmethod
     def setUpClass(cls):
-        base = os.path.join(repo_root, "test", "temp_tests")
+        # Repo-local temp_tests (repo_root is the WORKSPACE root, for sys.path
+        # only -- joining it here scattered Unity projects outside the repo).
+        base = os.path.join(os.path.dirname(__file__), "temp_tests")
         os.makedirs(base, exist_ok=True)
         cls.temp_dir = tempfile.mkdtemp(prefix="fade_window_", dir=base)
         cls.fbx_path = None

{unitytk-0.0.3 → unitytk-0.0.4}/unitytk/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.0.3"
+__version__ = "0.0.4"
 
 from .launcher import UnityLauncher, UnityFinder
 from .scene_builder import SceneBuilder

{unitytk-0.0.3 → unitytk-0.0.4}/unitytk/template_deployer.py

@@ -22,6 +22,7 @@ from __future__ import annotations
 
 import json
 import os
+import shutil
 from importlib import resources
 from typing import List
 
@@ -106,15 +107,10 @@ class TemplateDeployer:
                 f"Not a Unity project (no Assets/ folder): {project_root!r}"
             )
 
-        package_dir = os.path.join(project_root, "Packages", UPM_PACKAGE_NAME)
-        root = resources.files(TEMPLATE_PACKAGE)
-        names = sorted(
-            entry.name
-            for entry in root.iterdir()
-            if entry.name.endswith(CODE_SUFFIXES) or entry.name == "README.md"
-        )
+        package_dir = cls.package_dir(project_root)
         written = [
-            cls.deploy(name, os.path.join(package_dir, name)) for name in names
+            cls.deploy(name, os.path.join(package_dir, name))
+            for name in cls._bundle_names()
         ]
 
         manifest_path = os.path.join(package_dir, "package.json")
@@ -125,6 +121,100 @@ class TemplateDeployer:
 
         return sorted(written)
 
+    @classmethod
+    def package_dir(cls, project_root: str) -> str:
+        """The embedded package's folder inside *project_root* (may not exist)."""
+        return os.path.join(project_root, "Packages", UPM_PACKAGE_NAME)
+
+    @classmethod
+    def status(cls, project_root: str) -> dict:
+        """Report the deployed state of the embedded package in *project_root*.
+
+        Never raises for an absent/partial deployment -- "not installed" is a
+        reportable state, not an error (the DCC panels' *Status* action renders
+        this dict into their log).
+
+        Returns:
+            dict: ``installed`` (bool), ``package_dir`` (str),
+            ``version`` (str or None -- the deployed ``package.json`` version),
+            ``bundled_version`` (str -- this unitytk release),
+            ``missing`` (list[str] -- bundled files absent from the deploy),
+            ``up_to_date`` (bool -- current version and nothing missing).
+        """
+        import unitytk
+
+        package_dir = cls.package_dir(project_root)
+        bundled = cls._bundle_names()
+        result = {
+            "installed": False,
+            "package_dir": package_dir,
+            "version": None,
+            "bundled_version": unitytk.__version__,
+            "missing": list(bundled),
+            "up_to_date": False,
+        }
+        manifest_path = os.path.join(package_dir, "package.json")
+        if not os.path.isfile(manifest_path):
+            return result
+
+        result["installed"] = True
+        try:
+            with open(manifest_path, encoding="utf-8") as fh:
+                result["version"] = json.load(fh).get("version")
+        except (OSError, ValueError):
+            pass  # corrupt manifest: installed but version unknown
+
+        present = set(os.listdir(package_dir))
+        result["missing"] = [n for n in bundled if n not in present]
+        result["up_to_date"] = (
+            result["version"] == unitytk.__version__ and not result["missing"]
+        )
+        return result
+
+    @classmethod
+    def uninstall_package(cls, project_root: str) -> bool:
+        """Remove the embedded package from *project_root*.
+
+        Returns:
+            bool: True when the package folder was removed; False when there
+            was nothing deployed.
+
+        Raises:
+            ValueError: the folder at the package path is NOT ours -- its
+                ``package.json`` is absent or names a different package.
+                Refusing beats deleting a directory we merely expected to own.
+        """
+        package_dir = cls.package_dir(project_root)
+        if not os.path.isdir(package_dir):
+            return False
+
+        name = None
+        try:
+            with open(
+                os.path.join(package_dir, "package.json"), encoding="utf-8"
+            ) as fh:
+                name = json.load(fh).get("name")
+        except (OSError, ValueError):
+            pass
+        if name != UPM_PACKAGE_NAME:
+            raise ValueError(
+                f"Refusing to delete {package_dir!r}: its package.json does "
+                f"not identify it as {UPM_PACKAGE_NAME!r}."
+            )
+
+        shutil.rmtree(package_dir)
+        return True
+
+    @staticmethod
+    def _bundle_names() -> "List[str]":
+        """The bundled deployables, sorted: code set + the catalog README."""
+        root = resources.files(TEMPLATE_PACKAGE)
+        return sorted(
+            entry.name
+            for entry in root.iterdir()
+            if entry.name.endswith(CODE_SUFFIXES) or entry.name == "README.md"
+        )
+
     @staticmethod
     def _package_manifest() -> dict:
         """The generated ``package.json`` -- version mirrors this release."""

{unitytk-0.0.3 → unitytk-0.0.4}/unitytk/templates/AudioEventController.cs

@@ -230,9 +230,8 @@ public class AudioEventImporter : AssetPostprocessor
         // so the next import of this asset would inject every event twice.
         _pendingManifests.Remove(assetPath);
 
-        if (!ShouldProcess()) return;
-
-        CarrierImport.EnableUserProps(assetImporter);
+        // String channel: user properties arrive with Unity's default
+        // importer settings (probe-verified) — nothing to configure here.
     }
 
     // Why we attach the controller to the prefab ROOT, not the

{unitytk-0.0.3 → unitytk-0.0.4}/unitytk/templates/EmissiveGroupController.cs

@@ -215,18 +215,35 @@ public class EmissiveGroupImporter : AssetPostprocessor
     {
         // Fresh-import reset: JSON stranded by an import that aborted between
         // the callbacks must not resurrect on a re-export without the carrier.
+        // Touches NO importer settings — the manifest is a string channel that
+        // arrives with Unity's defaults; only Maya keyed weights need a flag,
+        // requested per-asset on detection below.
         _pending.Remove(assetPath);
-
-        if (!ShouldProcess()) return;
-        CarrierImport.EnableUserProps(assetImporter);
     }
 
     void OnPostprocessGameObjectWithUserProperties(
         GameObject go, string[] propNames, object[] values)
     {
         if (!ShouldProcess()) return;
-        if (CarrierImport.TryGetProp(propNames, values, ATTR_MANIFEST, out var json))
-            _pending[assetPath] = json;
+        if (!CarrierImport.TryGetProp(propNames, values, ATTR_MANIFEST, out var json))
+            return;
+        _pending[assetPath] = json;
+
+        // Maya keyed weights ride animated custom properties (per-group
+        // `attr` records). Only such assets need the importer flag — request
+        // it here so unrelated FBX keep the user's own settings.
+        var payload = ParsePayload(json, assetPath);
+        if (payload != null)
+        {
+            foreach (var rec in payload.groups)
+            {
+                if (rec != null && !string.IsNullOrEmpty(rec.attr))
+                {
+                    CarrierImport.RequestAnimatedCustomProperties(assetPath);
+                    break;
+                }
+            }
+        }
     }
 
     // --- Keyed weights: rebind DCC weight curves to the controller --------

{unitytk-0.0.3 → unitytk-0.0.4}/unitytk/templates/LightmapMetadataController.cs

@@ -134,8 +134,8 @@ public class LightmapMetadataImporter : AssetPostprocessor
         // the callbacks must not resurrect on a re-export without the carrier.
         _pending.Remove(assetPath);
 
-        if (!ShouldProcess()) return;
-        CarrierImport.EnableUserProps(assetImporter);
+        // String channel: user properties arrive with Unity's default
+        // importer settings (probe-verified) — nothing to configure here.
         // NOTE: deliberately does NOT touch generateSecondaryUV here — at
         // preprocess we don't yet know if this FBX carries Maya lightmaps, and
         // with no allowlist config every FBX is "allowed", so blindly flipping

{unitytk-0.0.3 → unitytk-0.0.4}/unitytk/templates/README.md

@@ -82,6 +82,18 @@ Settings are stored as JSON in `ProjectSettings/UnitytkSettings.json` (missing
 file/keys = everything on, all FBX). External tools can write it directly;
 changes are picked up automatically (no restart needed).
 
+### Safety: unrelated assets are never modified
+
+The importers **never touch a model's import settings up front**. Channel
+detection works with Unity's default settings, so an FBX that carries no
+unitytk metadata comes through the pipeline byte-identical to a project
+without unitytk installed. Only when an asset is detected to carry *animated*
+channel data (opacity fades, Maya keyed emissive weights) are the two settings
+that data needs — *Animated Custom Properties* on, *Resample Curves* off —
+enabled **on that one asset**, with a single automatic reimport (logged).
+Nothing is ever switched off, and no other asset's settings are read or
+written.
+
 ---
 
 ## Importing an FBX

{unitytk-0.0.3 → unitytk-0.0.4}/unitytk/templates/RenderOpacityController.cs

@@ -209,15 +209,11 @@ public class RenderOpacityImporter : AssetPostprocessor
         // an import that aborts between the callbacks (another postprocessor
         // throwing) strands destroyed Transform refs here — EnsureControllers
         // would trip over them on the NEXT import of this asset.
+        //
+        // Deliberately touches NO importer settings: the settings this channel
+        // needs are requested per-asset on detection (see Step 1) and applied
+        // by UnitytkImportConfigurator — unrelated FBX are never modified.
         _opacityTransforms.Remove(assetPath);
-
-        if (!ShouldProcess()) return;
-
-        CarrierImport.EnableUserProps(assetImporter);
-
-        var importer = assetImporter as ModelImporter;
-        if (importer != null && importer.resampleCurves)
-            importer.resampleCurves = false;
     }
 
     // --- Step 1: Record opacity transforms ------------------------------------
@@ -232,6 +228,13 @@ public class RenderOpacityImporter : AssetPostprocessor
         if (!ShouldProcess()) return;
         if (!CarrierImport.HasProp(propNames, ATTR_NAME)) return;
 
+        // This asset carries opacity data: it needs the custom-property curve
+        // (flattened 'opacity') and SPARSE visibility keys — the fade windows
+        // live in the gaps, which resampling destroys. Requested here, applied
+        // (with a one-time reimport of this asset only) after the batch.
+        CarrierImport.RequestAnimatedCustomProperties(assetPath);
+        CarrierImport.RequestSparseCurves(assetPath);
+
         if (!_opacityTransforms.ContainsKey(assetPath))
             _opacityTransforms[assetPath] = new HashSet<Transform>();
         _opacityTransforms[assetPath].Add(go.transform);
@@ -253,6 +256,12 @@ public class RenderOpacityImporter : AssetPostprocessor
     {
         if (!ShouldProcess()) return;
 
+        // Detection pass: the importer settings this conversion depends on
+        // (custom-prop curves present, resampling off) aren't in effect yet —
+        // converting RESAMPLED visibility would fabricate wrong fades. The
+        // configured reimport that follows runs the real conversion.
+        if (CarrierImport.IsDetectionPass(assetPath, assetImporter)) return;
+
         var opaPaths = EnsureControllers(assetPath, root.transform);
         if (opaPaths.Count == 0) return;
 

{unitytk-0.0.3 → unitytk-0.0.4}/unitytk/templates/ShadowPlaneController.cs

@@ -116,8 +116,8 @@ public class ShadowPlaneImporter : AssetPostprocessor
         // the callbacks must not resurrect on a re-export without the carrier.
         _pending.Remove(assetPath);
 
-        if (!ShouldProcess()) return;
-        CarrierImport.EnableUserProps(assetImporter);
+        // String channel: user properties arrive with Unity's default
+        // importer settings (probe-verified) — nothing to configure here.
     }
 
     // ---- silhouette texture: pin import settings by naming convention ----

{unitytk-0.0.3 → unitytk-0.0.4}/unitytk/templates/ShotMetadataController.cs

@@ -105,8 +105,8 @@ public class ShotMetadataImporter : AssetPostprocessor
         // the callbacks must not resurrect on a re-export without the carrier.
         _pending.Remove(assetPath);
 
-        if (!ShouldProcess()) return;
-        CarrierImport.EnableUserProps(assetImporter);
+        // String channel: user properties arrive with Unity's default
+        // importer settings (probe-verified) — nothing to configure here.
     }
 
     void OnPostprocessGameObjectWithUserProperties(

{unitytk-0.0.3 → unitytk-0.0.4}/unitytk/templates/UnitytkSettings.cs

@@ -212,12 +212,83 @@ public static class CarrierImport
         return false;
     }
 
-    /// <summary>Enable animated custom-property import — carrier channels ride on it.</summary>
-    public static void EnableUserProps(AssetImporter importer)
+    // ---- Per-asset import-settings scoping -------------------------------
+    //
+    // Channel DETECTION needs no importer settings: FBX user properties reach
+    // OnPostprocessGameObjectWithUserProperties even with Unity's defaults
+    // (verified against a live batch 6000.3: string channels AND the animated
+    // 'opacity' attr arrive with importAnimatedCustomProperties=false — only
+    // the flattened curve needs the flag). So unitytk never touches a model
+    // importer up front; a channel importer that discovers it needs a setting
+    // REQUESTS it here for that one asset, and the pending set is applied
+    // (with a single reimport of just that asset) after the import batch.
+    // Unrelated FBX are never modified, and nothing is ever switched OFF —
+    // the user's own import settings are left exactly as they had them.
+
+    static readonly HashSet<string> _needCustomProps = new HashSet<string>();
+    static readonly HashSet<string> _needSparseCurves = new HashSet<string>();
+
+    /// <summary>This asset needs animated custom-property curves
+    /// (opacity / Maya keyed emissive weights).</summary>
+    public static void RequestAnimatedCustomProperties(string assetPath)
+        => _needCustomProps.Add(assetPath);
+
+    /// <summary>This asset needs sparse (unresampled) curves — the opacity
+    /// fade windows live in the gaps between keys.</summary>
+    public static void RequestSparseCurves(string assetPath)
+        => _needSparseCurves.Add(assetPath);
+
+    /// <summary>True while *importer*'s current settings can't yet satisfy the
+    /// asset's requested channels — i.e. this pass is detection-only and a
+    /// configured reimport is coming. Curve-rewriting importers skip their
+    /// work on such a pass rather than transform resampled data.</summary>
+    public static bool IsDetectionPass(string assetPath, AssetImporter importer)
     {
         var mi = importer as ModelImporter;
-        if (mi != null && !mi.importAnimatedCustomProperties)
-            mi.importAnimatedCustomProperties = true;
+        if (mi == null) return false;
+        if (_needCustomProps.Contains(assetPath) && !mi.importAnimatedCustomProperties)
+            return true;
+        if (_needSparseCurves.Contains(assetPath) && mi.resampleCurves)
+            return true;
+        return false;
+    }
+
+    /// <summary>Apply every pending request; called from
+    /// <c>UnitytkImportConfigurator.OnPostprocessAllAssets</c> (after the
+    /// import batch, when reimporting is legal). Reimports only assets whose
+    /// settings actually changed, so a configured asset never loops.</summary>
+    public static void ApplyPendingImportSettings()
+    {
+        if (_needCustomProps.Count == 0 && _needSparseCurves.Count == 0)
+            return;
+
+        var paths = new HashSet<string>(_needCustomProps);
+        paths.UnionWith(_needSparseCurves);
+        foreach (var assetPath in paths)
+        {
+            bool wantProps = _needCustomProps.Remove(assetPath);
+            bool wantSparse = _needSparseCurves.Remove(assetPath);
+            var mi = AssetImporter.GetAtPath(assetPath) as ModelImporter;
+            if (mi == null) continue;
+
+            var enabled = new List<string>();
+            if (wantProps && !mi.importAnimatedCustomProperties)
+            {
+                mi.importAnimatedCustomProperties = true;
+                enabled.Add("Animated Custom Properties");
+            }
+            if (wantSparse && mi.resampleCurves)
+            {
+                mi.resampleCurves = false;
+                enabled.Add("unresampled curves (Resample Curves off)");
+            }
+            if (enabled.Count == 0) continue;
+
+            Debug.Log($"[unitytk] '{assetPath}' carries animated channel data — "
+                      + string.Join(" + ", enabled)
+                      + " set on this asset only; reimporting it once.");
+            mi.SaveAndReimport();
+        }
     }
 
     /// <summary>Warn when a payload comes from a newer producer schema than this importer.</summary>
@@ -231,6 +302,21 @@ public static class CarrierImport
     }
 }
 
+/// <summary>
+/// Applies the per-asset import-settings requests collected during the batch
+/// (see the scoping notes on <see cref="CarrierImport"/>). Lives in its own
+/// postprocessor because reimporting from OnPostprocessAllAssets is the
+/// supported pattern; doing it mid-import is not.
+/// </summary>
+public class UnitytkImportConfigurator : AssetPostprocessor
+{
+    static void OnPostprocessAllAssets(
+        string[] imported, string[] deleted, string[] moved, string[] movedFrom)
+    {
+        CarrierImport.ApplyPendingImportSettings();
+    }
+}
+
 /// <summary>
 /// Edit ▸ Project Settings ▸ unitytk — the native home for "what is this
 /// package doing to my imports": one toggle per channel plus the FBX

{unitytk-0.0.3 → unitytk-0.0.4/unitytk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: unitytk
-Version: 0.0.3
+Version: 0.0.4
 Summary: A modular Python toolkit for Unity interaction.
 Author-email: Ryan Simpson <m3trik@outlook.com>
 License: MIT
@@ -15,7 +15,7 @@ License-File: LICENSE
 Requires-Dist: pythontk>=0.7.71
 Dynamic: license-file
 
-[![Tests](https://img.shields.io/badge/Tests-113%20passed-brightgreen.svg)](../test/)
+[![Tests](https://img.shields.io/badge/Tests-116%20passed-brightgreen.svg)](../test/)
 
 # unitytk