unitytk 0.0.15__tar.gz → 0.1.0__tar.gz

{unitytk-0.0.15 → unitytk-0.1.0}/MANIFEST.in

@@ -1,4 +1,4 @@
 include LICENSE
 include docs/README.md
 include pyproject.toml
-recursive-include unitytk *.ui *.gif *.png *.json *.txt *.cs *.hlsl *.shader *.asmdef
+recursive-include unitytk *.ui *.gif *.png *.json *.txt *.cs *.hlsl *.shader *.asmdef *.meta

{unitytk-0.0.15/unitytk.egg-info → unitytk-0.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: unitytk
-Version: 0.0.15
+Version: 0.1.0
 Summary: A modular Python toolkit for Unity interaction.
 Author-email: Ryan Simpson <m3trik@outlook.com>
 License: MIT
@@ -13,7 +13,7 @@ Classifier: Operating System :: POSIX :: Linux
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: pythontk>=0.12.0
+Requires-Dist: pythontk>=0.13.0
 Dynamic: license-file
 
 [![Tests](https://img.shields.io/badge/Tests-146%20passed-brightgreen.svg)](../test/)

{unitytk-0.0.15 → unitytk-0.1.0}/pyproject.toml

@@ -17,12 +17,15 @@ classifiers = [
 ]
 # The floor is HAND-RATCHETED: unitytk is off-chain from m3trik/push.ps1, so no
 # release cascade bumps it.
-# pythontk 0.12.0, the release this one ships and was tested with. The hard
-# minimum is 0.8.84: UnityFinder.find_editors scans through
-# `AppLauncher.scan_install_dirs` (new in 0.8.72) and needs its pattern order to
-# be a priority (0.8.84), so the Hub's chosen install location wins over the
-# default. Below 0.8.72 the scan fails, is logged, and no editor is found.
-dependencies = ["pythontk>=0.12.0"]
+# pythontk 0.13.0, the release this one ships and was tested with: the suite
+# holds the templates to its `Conformance` cases and its articulation solve's
+# halving step (both new in 0.13.0). The hard minimum is 0.11.3:
+# TemplateDeployer builds its deprecation notices at import through
+# `Deprecation.values(..., since=)` (new in 0.11.3). UnityFinder.find_editors
+# needs 0.8.84: it scans through `AppLauncher.scan_install_dirs` (new in
+# 0.8.72) and needs its pattern order to be a priority (0.8.84), so the Hub's
+# chosen install location wins over the default.
+dependencies = ["pythontk>=0.13.0"]
 
 [project.urls]
 Homepage = "https://github.com/m3trik/unitytk"
@@ -37,7 +40,7 @@ where = ["."]
 include = ["unitytk*"]
 
 [tool.setuptools.package-data]
-"*" = ["*.ui", "*.json", "*.txt", "*.md", "*.cs", "*.hlsl", "*.shader", "*.asmdef"]
+"*" = ["*.ui", "*.json", "*.txt", "*.md", "*.cs", "*.hlsl", "*.shader", "*.asmdef", "*.meta"]
 
 [tool.pytest.ini_options]
 testpaths = ["test"]

{unitytk-0.0.15 → unitytk-0.1.0}/test/test_articulated_rig_runtime.py

@@ -69,6 +69,7 @@ from base_test import EnvSkip, TempProjects, UnityEnv
 
 import pythontk as ptk
 from unitytk import UnityLauncher, UnityFinder, TemplateDeployer
+from unitytk.template_deployer import UPM_PACKAGE_NAME
 
 
 def _unity_available() -> bool:
@@ -433,9 +434,17 @@ class ControllerScenario:
                 }
             )
         s_end = self.path_states()[-1]
+
+        def cut_short(**field):
+            """The record with one joint's ``t`` or ``q`` cut short."""
+            rig = json.loads(json.dumps(self.rig))
+            rig["joints"][1].update(field)
+            return json.dumps(dict(self.payload, rigs=[rig]))
+
         return {
             "record": json.dumps(self.payload),
             "record_newer": json.dumps(dict(self.payload, version=2)),
+            "records_short": [cut_short(t=[1.0]), cut_short(q=[0.0, 0.0])],
             "root": {
                 "p": list(self.ROOT["p"]),
                 "q": list(self.ROOT["q"]),
@@ -784,6 +793,7 @@ public class ArticulatedRigVerifier
         catch (Exception e) { Put("inputs_error", S(e.ToString())); }
         if (inputs != null)
         {
+            Run("guids", () => Guids(L(inputs["guids"])));
             Run("conformance", () => Conformance(O(inputs["doc"])));
             Run("invalid", () => Invalid(L(inputs["invalid"])));
             Run("boundary", () => Boundary(O(inputs["boundary"])));
@@ -806,6 +816,15 @@ public class ArticulatedRigVerifier
         catch (Exception e) { Put(section + "_error", S(e.ToString())); }
     }
 
+    // ---- 0. fixed GUIDs ---------------------------------------------------
+    // The editor's own answer, per deployed asset path (files and folders):
+    // the GUID committed in the bundle's .meta, unless Unity re-minted it.
+    static void Guids(IList<object> paths)
+    {
+        var rows = paths.Select(p => S((string)p) + ": " + S(AssetDatabase.AssetPathToGUID((string)p)));
+        Put("guids", "{" + string.Join(", ", rows) + "}");
+    }
+
     // ---- 1. conformance ---------------------------------------------------
     static void Conformance(IDictionary<string, object> doc)
     {
@@ -1113,6 +1132,20 @@ public class ArticulatedRigVerifier
         var futureCtrl = future.AddComponent<ArticulatedRigController>();
         futureCtrl.record = (string)c["record_newer"];
         Put("ctrl_newer", "{\"resolved\": " + B(futureCtrl.Resolve()) + ", \"rigs\": " + futureCtrl.RigCount + "}");
+
+        // A joint whose t or q is cut short is refused with a warning, never
+        // thrown out of Resolve (the importer calls it: the import would fail).
+        var cutRows = new List<string>();
+        foreach (var raw in L(c["records_short"]))
+        {
+            var cut = new GameObject("CutShortModel");
+            cut.transform.SetParent(root, false);
+            var cutCtrl = cut.AddComponent<ArticulatedRigController>();
+            cutCtrl.record = (string)raw;
+            try { cutRows.Add("{\"resolved\": " + B(cutCtrl.Resolve()) + ", \"rigs\": " + cutCtrl.RigCount + "}"); }
+            catch (Exception thrown) { cutRows.Add("{\"threw\": " + S(thrown.GetType().Name) + "}"); }
+        }
+        Put("ctrl_short", "[" + string.Join(",", cutRows) + "]");
         UnityEngine.Object.DestroyImmediate(root.gameObject);
     }
 
@@ -1407,6 +1440,22 @@ def _compile_errors(log_path: str) -> str:
     return "\n".join(errors[:20])
 
 
+#: The embedded package's root as an AssetDatabase path.
+_PACKAGE_ASSET_ROOT = f"Packages/{UPM_PACKAGE_NAME}"
+
+
+def _bundle_assets():
+    """Every deployed bundle file and folder, as "/"-joined package paths."""
+    names = TemplateDeployer._bundle_names()
+    return list(names) + TemplateDeployer._folders(names)
+
+
+def _committed_meta(name):
+    """Bundle asset *name*'s committed .meta, LF (as the deployer writes it)."""
+    ref = TemplateDeployer._bundle_ref(name + ".meta")
+    return ref.read_bytes().replace(b"\r\n", b"\n")
+
+
 def _run_unity(test, temp_dir, execute_method, prepare, timeout=600):
     """Create a project, let *prepare(project_path)* stage it, run the
     verifier; returns the parsed results (or skips on the license wall)."""
@@ -1552,6 +1601,7 @@ class TestArticulatedRigRuntime(unittest.TestCase):
                 variants[key] = os.path.join(cls.temp_dir, f"fixture_{key}.fbx.txt")
                 cls.fixture.fbx(**kwargs).write(variants[key])
             inputs = {
+                "guids": [f"{_PACKAGE_ASSET_ROOT}/{n}" for n in _bundle_assets()],
                 "doc": cls.doc,
                 "invalid": _invalid_rigs(),
                 "boundary": cls.boundary,
@@ -1586,6 +1636,34 @@ class TestArticulatedRigRuntime(unittest.TestCase):
         cls.unity = unity
         logger.info("Unity %s", unity.get("unity_version"))
 
+    @EnvSkip.unless(_unity_available(), "no Unity editor found")
+    def test_01b_the_editor_reads_the_committed_guids(self):
+        """Fixed GUIDs, proven by the editor rather than by reading files:
+        AssetDatabase names every deployed script, shader, asmdef, the README
+        and every component folder (the XR sub-assembly's included) by the
+        GUID committed in the bundle's .meta -- and the import left those
+        .meta files byte-identical, so a project never churns them."""
+        got = self._section("guids")
+        expected = {
+            f"{_PACKAGE_ASSET_ROOT}/{name}": re.search(
+                rb"^guid: ([0-9a-f]{32})$", _committed_meta(name), re.M
+            )
+            .group(1)
+            .decode()
+            for name in _bundle_assets()
+        }
+        self.assertEqual(got, expected, "Unity named a deployed asset differently")
+        package = TemplateDeployer.package_dir(
+            os.path.join(self.temp_dir, "UnityProject")
+        )
+        rewritten = []
+        for name in _bundle_assets():
+            path = os.path.join(package, *name.split("/")) + ".meta"
+            with open(path, "rb") as fh:
+                if fh.read() != _committed_meta(name):
+                    rewritten.append(name)
+        self.assertEqual(rewritten, [], "Unity rewrote these .meta files on import")
+
     # ---- Step 2: conformance -------------------------------------------------
 
     def _conformance(self):
@@ -2082,6 +2160,17 @@ class TestArticulatedRigRuntime(unittest.TestCase):
         in): nothing binds."""
         self.assertEqual(self._section("ctrl_newer"), {"resolved": False, "rigs": 0})
 
+    @EnvSkip.unless(_unity_available(), "no Unity editor found")
+    def test_16c_controller_refuses_a_joint_cut_short(self):
+        """A joint whose ``t`` holds fewer than 3 values, or ``q`` fewer than
+        4, is a rig the runtime refuses with a warning: nothing binds, and
+        nothing is thrown out of ``Resolve``, which the importer calls. The
+        reference has no such check (a short ``q`` is an IndexError there), so
+        this is the port's own contract, not a ``_invalid_rigs`` case."""
+        self.assertEqual(
+            self._section("ctrl_short"), [{"resolved": False, "rigs": 0}] * 2
+        )
+
     @EnvSkip.unless(_unity_available(), "no Unity editor found")
     def test_17_xr_adapter_inert_without_xri(self):
         """Without the XR Interaction Toolkit the XR assembly is excluded by

{unitytk-0.0.15 → unitytk-0.1.0}/test/test_audio_events_integration.py

@@ -66,8 +66,8 @@ maya.standalone.initialize(name="python")
 import maya.cmds as cmds
 import maya.mel as mel
 
-from mayatk.audio_utils._audio_utils import AudioUtils
-from mayatk.audio_utils.audio_clips._audio_clips import AudioClips
+from mayatk import AudioUtils
+from mayatk import AudioClips
 
 output_dir = sys.argv[1]
 fbx_path = os.path.join(output_dir, "audio_events_test.fbx")
@@ -113,7 +113,10 @@ if not cmds.pluginInfo("fbxmaya", query=True, loaded=True):
     cmds.loadPlugin("fbxmaya")
 
 mel.eval("FBXResetExport")
-mel.eval("FBXExportInAscii -v true")
+# Binary, as every production writer ships: Unity's ASCII FBX reader
+# drops the whole scene (or truncates the string) once a carrier channel
+# passes ~6 KB, and the handoff record alone is past that.
+mel.eval("FBXExportInAscii -v false")
 mel.eval(f'FBXExport -f "{fbx_path.replace(os.sep, "/")}"')
 
 assert os.path.exists(fbx_path), f"FBX was not created at {fbx_path}"
@@ -133,7 +136,10 @@ with open(os.path.join(output_dir, "maya_results.json"), "w") as f:
 print("\n" + "=" * 60)
 print("MAYA EXPORT COMPLETE")
 print("=" * 60)
-maya.standalone.uninitialize()
+# Not maya.standalone.uninitialize(): Maya's static destructors fault at DLL
+# detach, filing a crash dump and an untitled[Recovered].ma per run.
+import pythontk as ptk
+ptk.ProcessExit.hard_exit(0)
 '''
 
 
@@ -561,18 +567,7 @@ class TestAudioEventsIntegration(unittest.TestCase):
             else:
                 logger.info("Unity log: no AudioEvent/Warning/Error lines.")
 
-        if not os.path.exists(results_path):
-            # A batch-licensing failure is environmental (not a code bug) — skip.
-            if UnityLauncher.is_license_failure(returncode, full_log):
-                logger.info(
-                    "Unity batch license failure (rc=%s) — see %s",
-                    returncode, log_path,
-                )
-                self.skipTest(UnityEnv.license_reason())
-            self.fail(
-                f"unity_results.json not created (Unity rc={returncode}) — "
-                f"check {log_path}"
-            )
+        UnityEnv.require_results(self, results_path, returncode, log_path)
         with open(results_path) as f:
             self.__class__.unity_results = json.load(f)
 

{unitytk-0.0.15 → unitytk-0.1.0}/test/test_base_test.py

@@ -20,6 +20,9 @@ green without having verified anything:
 * :class:`base_test.UserPropsProbe` -- one C# user-properties postprocessor
   shared by the five FBX-import suites, with ONE carrier-matching rule for its
   C# and Python halves (they had drifted to ``==`` vs ``startswith``).
+* :class:`base_test.TemplateSources` -- the suites that stage templates by hand
+  resolve them by bundle path in one place, so a moved template fails loudly
+  instead of one suite silently copying nothing.
 
 :class:`PublicHygieneTest` is the permanent guard for the 2026-08-17 rename:
 client program identifiers must not come back into tracked Python/C# source.
@@ -37,6 +40,7 @@ from base_test import (
     EnvSkip,
     MayaEnv,
     SuiteOptions,
+    TemplateSources,
     TestAssets,
     UnityEnv,
     UserPropsProbe,
@@ -334,6 +338,45 @@ class UnityEnvTest(unittest.TestCase):
             f"{offenders}",
         )
 
+    def test_require_results_skips_unlicensed_and_fails_a_clean_run(self):
+        """The check every batch verifier makes: results there, nothing to do;
+        none from an unlicensed editor, an environmental skip; none from a
+        clean run, a failure. Asserting the file alone failed every such suite
+        on a machine signed out of the Hub."""
+        import pythontk as ptk
+
+        store = ptk.TempArtifacts("unitytk_require_results", policy="scoped")
+        self.addCleanup(store.cleanup)
+        root = store.dir_path()
+        present = os.path.join(root, "results.json")
+        with open(present, "w", encoding="utf-8") as fh:
+            fh.write("{}")
+        missing = os.path.join(root, "missing.json")
+        log = os.path.join(root, "unity_log.txt")
+        with open(log, "w", encoding="utf-8") as fh:
+            fh.write("Batchmode quit successfully invoked\n")
+
+        class Case(unittest.TestCase):
+            def test_present(self):
+                UnityEnv.require_results(self, present, 0, log)
+
+            def test_unlicensed(self):
+                UnityEnv.require_results(self, missing, 198, log)
+
+            def test_clean_run_wrote_nothing(self):
+                UnityEnv.require_results(self, missing, 0, log)
+
+        result = _run_case(Case)
+        self.assertEqual(
+            [reason for _t, reason in result.skipped], [UnityEnv.license_reason()]
+        )
+        self.assertEqual(
+            [t.id().rsplit(".", 1)[-1] for t, _tb in result.failures],
+            ["test_clean_run_wrote_nothing"],
+        )
+        self.assertEqual(result.errors, [])
+        self.assertEqual(result.testsRun, 3)
+
 
 class SuiteOptionsTest(unittest.TestCase):
     """The opt-in switches are named once, neutrally."""
@@ -395,6 +438,48 @@ class TestAssetsTest(unittest.TestCase):
         )
 
 
+class TemplateSourcesTest(unittest.TestCase):
+    """Hand-staged templates resolve by bundle path, in one place."""
+
+    def test_every_bundle_path_resolves_in_the_checkout(self):
+        from unitytk import TemplateDeployer
+
+        names = TemplateDeployer._bundle_names()
+        self.assertTrue(TemplateSources.available(names))
+        for name in names:
+            self.assertTrue(os.path.isfile(TemplateSources.path(name)), name)
+
+    def test_copy_flat_copies_side_by_side_and_never_skips(self):
+        import pythontk as ptk
+
+        store = ptk.TempArtifacts("unitytk_template_sources", policy="scoped")
+        self.addCleanup(store.cleanup)
+        dest = os.path.join(store.dir_path(), "Scripts")
+        copied = TemplateSources.copy_flat(
+            ["UnitytkSettings.cs", "RenderEffects/RenderEffectsController.cs"], dest
+        )
+        self.assertEqual(
+            copied,
+            [
+                os.path.join(dest, "UnitytkSettings.cs"),
+                os.path.join(dest, "RenderEffectsController.cs"),
+            ],
+        )
+        self.assertTrue(all(os.path.isfile(p) for p in copied))
+        with self.assertRaises(FileNotFoundError):  # a bare, pre-move name
+            TemplateSources.copy_flat(["RenderEffectsController.cs"], dest)
+
+    def test_no_suite_joins_the_templates_dir_itself(self):
+        """Five suites joined their own templates dir with a bare file name;
+        one of them silently skipped a copy that no longer resolved."""
+        offenders = []
+        for path in _source_files(".py", exclude=("base_test.py",)):
+            with open(path, encoding="utf-8", errors="replace") as fh:
+                if re.search(r"""["']unitytk["'],\s*["']templates["']""", fh.read()):
+                    offenders.append(os.path.relpath(path, REPO_ROOT))
+        self.assertEqual(offenders, [], f"templates dir joined by hand in: {offenders}")
+
+
 class UserPropsProbeTest(unittest.TestCase):
     """One postprocessor template, one carrier-matching rule on both sides."""
 

{unitytk-0.0.15 → unitytk-0.1.0}/test/test_clip_name_contract_integration.py

@@ -65,7 +65,7 @@ import maya.cmds as cmds
 import maya.mel as mel
 
 import pythontk as ptk
-from mayatk.anim_utils.shots._shots import ShotStore
+from mayatk import ShotStore
 from mayatk.env_utils.fbx_utils import FbxUtils
 from mayatk.node_utils.data_nodes import DataNodes
 
@@ -104,7 +104,10 @@ takes = ptk.SceneRecords.declared_takes(
 
 if not cmds.pluginInfo("fbxmaya", query=True, loaded=True):
     cmds.loadPlugin("fbxmaya")
-mel.eval("FBXExportInAscii -v true")
+# Binary, as every production writer ships: Unity's ASCII FBX reader
+# drops the whole scene (or truncates the string) once a carrier channel
+# passes ~6 KB, and the handoff record alone is past that.
+mel.eval("FBXExportInAscii -v false")
 mel.eval('FBXExport -f "%s"' % fbx_path)
 assert os.path.exists(fbx_path), "FBX not created: %s" % fbx_path
 
@@ -119,7 +122,10 @@ results = {
 with open(os.path.join(output_dir, "maya_results.json"), "w") as f:
     json.dump(results, f, indent=2)
 print("MAYA CLIP-NAME CONTRACT EXPORT COMPLETE — keys:", results["clip_keys"])
-maya.standalone.uninitialize()
+# Not maya.standalone.uninitialize(): Maya's static destructors fault at DLL
+# detach, filing a crash dump and an untitled[Recovered].ma per run.
+import pythontk as ptk
+ptk.ProcessExit.hard_exit(0)
 '''
 
 
@@ -297,18 +303,7 @@ class TestClipNameContract(unittest.TestCase):
                 proc.kill()
                 raise TimeoutError("Unity timed out")
 
-        if not os.path.exists(results_path):
-            log_text = ""
-            if os.path.exists(log_path):
-                with open(log_path, encoding="utf-8", errors="ignore") as fh:
-                    log_text = fh.read()
-            if UnityLauncher.is_license_failure(returncode, log_text):
-                logger.info(
-                    "Unity batch license failure (rc=%s) — see %s",
-                    returncode, log_path,
-                )
-                self.skipTest(UnityEnv.license_reason())
-            self.fail(f"unity_results.json not created (rc={returncode}) — {log_path}")
+        UnityEnv.require_results(self, results_path, returncode, log_path)
         with open(results_path) as f:
             self.__class__.unity_results = json.load(f)
         logger.info(f"Unity results:\n{json.dumps(self.__class__.unity_results, indent=2)}")

{unitytk-0.0.15 → unitytk-0.1.0}/test/test_controller_runtime_integration.py

@@ -215,22 +215,7 @@ class TestControllerRuntimeIntegration(unittest.TestCase):
                 proc.kill()
                 raise TimeoutError("Unity timed out")
 
-        if not os.path.exists(results_path):
-            log_text = ""
-            if os.path.exists(log_path):
-                with open(log_path, encoding="utf-8", errors="ignore") as fh:
-                    log_text = fh.read()
-            if UnityLauncher.is_license_failure(returncode, log_text):
-                logger.info(
-                    "Unity batch license failure (rc=%s) — see %s",
-                    returncode,
-                    log_path,
-                )
-                self.skipTest(UnityEnv.license_reason())
-            self.fail(
-                f"unity_results.json not created (Unity rc={returncode}) — "
-                f"check {log_path}"
-            )
+        UnityEnv.require_results(self, results_path, returncode, log_path)
         with open(results_path) as f:
             self.__class__.unity_results = json.load(f)
         logger.info(