From 3b1e9e56a7f9be4ed0e37da9af00fffd3768564c Mon Sep 17 00:00:00 2001 From: Roman Trapeznikov Date: Fri, 26 Jan 2024 15:12:53 +0300 Subject: [PATCH 1/7] Update bug_report.md --- .github/ISSUE_TEMPLATE/bug_report.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 2df5214d..73c93e37 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -4,12 +4,17 @@ about: Create a report to help us improve title: Bug labels: bug assignees: '' +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug! If you need real-time help, join us on Discord. --- ### Description Describe the bug. Do not forget to fill the title. -Make sure you're running game without any modifications (unless you want to report an api bug). +Make sure you're running game without any modifications. ### Steps to reproduce 1. Launch BombSquad @@ -18,16 +23,17 @@ Make sure you're running game without any modifications (unless you want to repo 4. Bug! ### Expected behavior -Describe what you think should happen. +Describe what you think should happen if it's not obvious. ### Machine -**Platform**: Windows 10 / Ubuntu 20.04 LTS / AOSP 8.1 / etc. -**BombSquad version**: [1.5.27](https://github.com/efroemling/ballistica/releases/tag/v1.5.27) -**Commit**: [2642488](https://github.com/efroemling/ballistica/commit/2642488a51b250752169738f5aeeccaafa2bc8de) -Select what do you want to use: release version or commit. Please use a hyperlink. +**Platform**: Windows 11 / Ubuntu 22.04 LTS / Android 12 / MyToasterOS 7.3 / ... \ +**BombSquad version**: [1.7.33](https://github.com/efroemling/ballistica/tree/v1.7.32) \ +**Commit**: https://github.com/efroemling/ballistica/tree/978f32f9f098bd0ff1dc64b496ec31cf493ded09 + +You may specify BombSquad version you're running or refer to the latest commit. ### Screenshots Put some screenshots here if needed. ### Extra -Put some extra information here. For example, describe your assumptions about the cause of the bug. +You may put some extra information here. For example, describe your assumptions about the cause of the bug. From c01cb78e0654e74e0e4fbaebb018866351362f73 Mon Sep 17 00:00:00 2001 From: Roman Trapeznikov Date: Fri, 26 Jan 2024 15:14:25 +0300 Subject: [PATCH 2/7] Update bug_report.md fix yaml :( --- .github/ISSUE_TEMPLATE/bug_report.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 73c93e37..eb0b9a5d 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -5,10 +5,10 @@ title: Bug labels: bug assignees: '' body: - - type: markdown - attributes: - value: | - Thanks for taking the time to fill out this bug! If you need real-time help, join us on Discord. +- type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug! If you need real-time help, join us on Discord. --- From c3f49de1a2c90be86c2effba5a04e90b0314a2b8 Mon Sep 17 00:00:00 2001 From: Roman Trapeznikov Date: Fri, 26 Jan 2024 18:54:09 +0300 Subject: [PATCH 3/7] Update bug_report.md --- .github/ISSUE_TEMPLATE/bug_report.md | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index eb0b9a5d..32b08077 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -4,11 +4,6 @@ about: Create a report to help us improve title: Bug labels: bug assignees: '' -body: -- type: markdown - attributes: - value: | - Thanks for taking the time to fill out this bug! If you need real-time help, join us on Discord. --- @@ -27,7 +22,7 @@ Describe what you think should happen if it's not obvious. ### Machine **Platform**: Windows 11 / Ubuntu 22.04 LTS / Android 12 / MyToasterOS 7.3 / ... \ -**BombSquad version**: [1.7.33](https://github.com/efroemling/ballistica/tree/v1.7.32) \ +**BombSquad version**: [1.7.32](https://github.com/efroemling/ballistica/tree/v1.7.32) \ **Commit**: https://github.com/efroemling/ballistica/tree/978f32f9f098bd0ff1dc64b496ec31cf493ded09 You may specify BombSquad version you're running or refer to the latest commit. From e9d31b012c3e0d028e78f0d2857b7845cf7349c8 Mon Sep 17 00:00:00 2001 From: Eric Date: Wed, 31 Jan 2024 13:58:45 -0800 Subject: [PATCH 4/7] Latest public/internal sync. --- .efrocachemap | 56 ++++---- CHANGELOG.md | 4 +- src/assets/ba_data/python/baenv.py | 8 +- src/ballistica/shared/ballistica.cc | 2 +- tests/test_efro/test_dataclassio.py | 189 ++++++++++++++++++++++++++- tools/bacommon/transfer.py | 8 +- tools/efro/dataclassio/__init__.py | 3 +- tools/efro/dataclassio/_api.py | 32 ++++- tools/efro/dataclassio/_base.py | 148 ++++++++++++++------- tools/efro/dataclassio/_inputter.py | 94 +++++++++---- tools/efro/dataclassio/_outputter.py | 61 ++++++++- tools/efro/dataclassio/_prep.py | 14 +- 12 files changed, 504 insertions(+), 115 deletions(-) diff --git a/.efrocachemap b/.efrocachemap index 398381a0..873034ca 100644 --- a/.efrocachemap +++ b/.efrocachemap @@ -4060,26 +4060,26 @@ "build/assets/windows/Win32/ucrtbased.dll": "2def5335207d41b21b9823f6805997f1", "build/assets/windows/Win32/vc_redist.x86.exe": "b08a55e2e77623fe657bea24f223a3ae", "build/assets/windows/Win32/vcruntime140d.dll": "865b2af4d1e26a1a8073c89acb06e599", - "build/prefab/full/linux_arm64_gui/debug/ballisticakit": "26eea64d4509875c9a88da74f49e675c", - "build/prefab/full/linux_arm64_gui/release/ballisticakit": "0a39319a89364641f3bb0598821b4288", - "build/prefab/full/linux_arm64_server/debug/dist/ballisticakit_headless": "84567063607be0227ef779027e12d19d", - "build/prefab/full/linux_arm64_server/release/dist/ballisticakit_headless": "f4458855192dedd13a28d36dc3962890", - "build/prefab/full/linux_x86_64_gui/debug/ballisticakit": "4c0679b0157c2dd63519e5225d99359d", - "build/prefab/full/linux_x86_64_gui/release/ballisticakit": "335a3f06dc6dd361d6122fd9143124ae", - "build/prefab/full/linux_x86_64_server/debug/dist/ballisticakit_headless": "041a300c9fa99c82395e1ebc66e81fe3", - "build/prefab/full/linux_x86_64_server/release/dist/ballisticakit_headless": "181145bf30e752991860acd0e44f972c", - "build/prefab/full/mac_arm64_gui/debug/ballisticakit": "8531542c35242bcbffc0309cef10b2b8", - "build/prefab/full/mac_arm64_gui/release/ballisticakit": "48cdebbdea839f6b8fc8f5cb69d7f961", - "build/prefab/full/mac_arm64_server/debug/dist/ballisticakit_headless": "159003daac99048702c74120be565bad", - "build/prefab/full/mac_arm64_server/release/dist/ballisticakit_headless": "51c9582a1efaae50e1c435c13c390855", - "build/prefab/full/mac_x86_64_gui/debug/ballisticakit": "d66c11ebe6d9035ea7e86b362f8505a1", - "build/prefab/full/mac_x86_64_gui/release/ballisticakit": "1f8113ffba1d000120bf83ac268c603b", - "build/prefab/full/mac_x86_64_server/debug/dist/ballisticakit_headless": "6f2a68c0370061a2913278d97b039ecc", - "build/prefab/full/mac_x86_64_server/release/dist/ballisticakit_headless": "471e7f81fac96b4db752c5cdaeed7168", - "build/prefab/full/windows_x86_gui/debug/BallisticaKit.exe": "94916e80a9d7bc7801db666beceea026", - "build/prefab/full/windows_x86_gui/release/BallisticaKit.exe": "1bc098ae93dd18143fb64ae5cbc33c19", - "build/prefab/full/windows_x86_server/debug/dist/BallisticaKitHeadless.exe": "da99cef03f12a6ff2c0065f4616262f2", - "build/prefab/full/windows_x86_server/release/dist/BallisticaKitHeadless.exe": "14b67157a3bf57b9de067089476f79d5", + "build/prefab/full/linux_arm64_gui/debug/ballisticakit": "d1d989de9e44829ce7adc6348cad34f1", + "build/prefab/full/linux_arm64_gui/release/ballisticakit": "d27e236d62e3db407c61902f0768b209", + "build/prefab/full/linux_arm64_server/debug/dist/ballisticakit_headless": "148a0c692fd30c3027158866a1c6c157", + "build/prefab/full/linux_arm64_server/release/dist/ballisticakit_headless": "0836f235c538b20dd2187071dc82a9c0", + "build/prefab/full/linux_x86_64_gui/debug/ballisticakit": "c928cdc074b9cb8f752ca049fb30fcf9", + "build/prefab/full/linux_x86_64_gui/release/ballisticakit": "b66bd051975628898fb66d291188824f", + "build/prefab/full/linux_x86_64_server/debug/dist/ballisticakit_headless": "7b3579d629ad99f032c4b2d821f7e348", + "build/prefab/full/linux_x86_64_server/release/dist/ballisticakit_headless": "08d11c347fed9b4d2b6f582c92321ed0", + "build/prefab/full/mac_arm64_gui/debug/ballisticakit": "f51e6dbccdeb8b64163029d58168d6d3", + "build/prefab/full/mac_arm64_gui/release/ballisticakit": "5c250868de853f0bcdbfd671e5863e0b", + "build/prefab/full/mac_arm64_server/debug/dist/ballisticakit_headless": "bc49209413eacf23bd6aa8cae47f7324", + "build/prefab/full/mac_arm64_server/release/dist/ballisticakit_headless": "40f7edd3b8e2d5cf2869cdaf12459fbe", + "build/prefab/full/mac_x86_64_gui/debug/ballisticakit": "9530446001824359b438d64054a4fa39", + "build/prefab/full/mac_x86_64_gui/release/ballisticakit": "5db3cac8a2cfdb5d56cb7579d32f17c6", + "build/prefab/full/mac_x86_64_server/debug/dist/ballisticakit_headless": "db8d6083d7bbdf78855c70affc3792df", + "build/prefab/full/mac_x86_64_server/release/dist/ballisticakit_headless": "c4d5c5387cc15f9c83dd41ce75e5cba5", + "build/prefab/full/windows_x86_gui/debug/BallisticaKit.exe": "2accd53f262abd82afcc9f9b73f26f2e", + "build/prefab/full/windows_x86_gui/release/BallisticaKit.exe": "3e2d7f9d4c7c350af1e21a8acbb3dec6", + "build/prefab/full/windows_x86_server/debug/dist/BallisticaKitHeadless.exe": "4d629a6f6029e191dd341e0a2a21d50b", + "build/prefab/full/windows_x86_server/release/dist/BallisticaKitHeadless.exe": "feeeb28a230759fb5283474f82fc2451", "build/prefab/lib/linux_arm64_gui/debug/libballisticaplus.a": "8709ad96140d71760c2f493ee8bd7c43", "build/prefab/lib/linux_arm64_gui/release/libballisticaplus.a": "ee829cd5488e9750570dc6f602d65589", "build/prefab/lib/linux_arm64_server/debug/libballisticaplus.a": "8709ad96140d71760c2f493ee8bd7c43", @@ -4096,14 +4096,14 @@ "build/prefab/lib/mac_x86_64_gui/release/libballisticaplus.a": "79117cbfdf695298e1d9ae997d990c4d", "build/prefab/lib/mac_x86_64_server/debug/libballisticaplus.a": "984f0990a8e4cca29a382d70e51cc051", "build/prefab/lib/mac_x86_64_server/release/libballisticaplus.a": "79117cbfdf695298e1d9ae997d990c4d", - "build/prefab/lib/windows/Debug_Win32/BallisticaKitGenericPlus.lib": "97a0aee0716397c0394c620b0cdc8cfa", - "build/prefab/lib/windows/Debug_Win32/BallisticaKitGenericPlus.pdb": "5edf5fd129429079b24368da6c792c44", - "build/prefab/lib/windows/Debug_Win32/BallisticaKitHeadlessPlus.lib": "e453446a36102733a1f0db636fafb704", - "build/prefab/lib/windows/Debug_Win32/BallisticaKitHeadlessPlus.pdb": "dfb843bbc924daf7a2e2a2eb6b4811df", - "build/prefab/lib/windows/Release_Win32/BallisticaKitGenericPlus.lib": "09bb45bcbfad7c0f63b9494ceca669cc", - "build/prefab/lib/windows/Release_Win32/BallisticaKitGenericPlus.pdb": "c8d10517d61dc5c4d7c94a5eccecab4a", - "build/prefab/lib/windows/Release_Win32/BallisticaKitHeadlessPlus.lib": "4944d18bb54894b0488cbdaa7b2ef06f", - "build/prefab/lib/windows/Release_Win32/BallisticaKitHeadlessPlus.pdb": "d17c4758367051e734601018b081f786", + "build/prefab/lib/windows/Debug_Win32/BallisticaKitGenericPlus.lib": "810dd57e398827fb3abc488a4185a0b3", + "build/prefab/lib/windows/Debug_Win32/BallisticaKitGenericPlus.pdb": "c10f8fb6e748f6244753adef81ef5ed4", + "build/prefab/lib/windows/Debug_Win32/BallisticaKitHeadlessPlus.lib": "d30f36c9c925e52e94ef39afc8b0a35e", + "build/prefab/lib/windows/Debug_Win32/BallisticaKitHeadlessPlus.pdb": "88431c1a6372b951ce85c2c73bc7f8c5", + "build/prefab/lib/windows/Release_Win32/BallisticaKitGenericPlus.lib": "928e9fd64e81de0d43e433a4474826cb", + "build/prefab/lib/windows/Release_Win32/BallisticaKitGenericPlus.pdb": "ae0ce0dd3541770cb7bd93997aca3e04", + "build/prefab/lib/windows/Release_Win32/BallisticaKitHeadlessPlus.lib": "0de083bc720affcbab4fbf0c121a84fe", + "build/prefab/lib/windows/Release_Win32/BallisticaKitHeadlessPlus.pdb": "299be2aa45e5d943b56828f065911172", "src/assets/ba_data/python/babase/_mgen/__init__.py": "f885fed7f2ed98ff2ba271f9dbe3391c", "src/assets/ba_data/python/babase/_mgen/enums.py": "b611c090513a21e2fe90e56582724e9d", "src/ballistica/base/mgen/pyembed/binding_base.inc": "72bfed2cce8ff19741989dec28302f3f", diff --git a/CHANGELOG.md b/CHANGELOG.md index 00f77a1e..7be40ad5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,4 @@ -### 1.7.33 (build 21762, api 8, 2024-01-24) +### 1.7.33 (build 21763, api 8, 2024-01-31) - Stress test input-devices are now a bit smarter; they won't press any buttons while UIs are up (this could cause lots of chaos if it happened). - Added a 'Show Demos When Idle' option in advanced settings. If enabled, the @@ -20,6 +20,8 @@ languages; I feel it helps keep logic more understandable and should help us catch problems where a base class changes or removes a method and child classes forget to adapt to the change. +- Implemented `efro.dataclassio.IOMultiType` which will make my life a lot + easier. ### 1.7.32 (build 21741, api 8, 2023-12-20) - Fixed a screen message that no one will ever see (Thanks vishal332008?...) diff --git a/src/assets/ba_data/python/baenv.py b/src/assets/ba_data/python/baenv.py index 01c47c91..8a4b85c3 100644 --- a/src/assets/ba_data/python/baenv.py +++ b/src/assets/ba_data/python/baenv.py @@ -52,7 +52,7 @@ if TYPE_CHECKING: # Build number and version of the ballistica binary we expect to be # using. -TARGET_BALLISTICA_BUILD = 21762 +TARGET_BALLISTICA_BUILD = 21763 TARGET_BALLISTICA_VERSION = '1.7.33' @@ -287,9 +287,9 @@ def _setup_certs(contains_python_dist: bool) -> None: import certifi # Let both OpenSSL and requests (if present) know to use this. - os.environ['SSL_CERT_FILE'] = os.environ[ - 'REQUESTS_CA_BUNDLE' - ] = certifi.where() + os.environ['SSL_CERT_FILE'] = os.environ['REQUESTS_CA_BUNDLE'] = ( + certifi.where() + ) def _setup_paths( diff --git a/src/ballistica/shared/ballistica.cc b/src/ballistica/shared/ballistica.cc index 75f4b12f..f88717ed 100644 --- a/src/ballistica/shared/ballistica.cc +++ b/src/ballistica/shared/ballistica.cc @@ -39,7 +39,7 @@ auto main(int argc, char** argv) -> int { namespace ballistica { // These are set automatically via script; don't modify them here. -const int kEngineBuildNumber = 21762; +const int kEngineBuildNumber = 21763; const char* kEngineVersion = "1.7.33"; const int kEngineApiVersion = 8; diff --git a/tests/test_efro/test_dataclassio.py b/tests/test_efro/test_dataclassio.py index 1c91d47d..427ffff3 100644 --- a/tests/test_efro/test_dataclassio.py +++ b/tests/test_efro/test_dataclassio.py @@ -5,10 +5,17 @@ from __future__ import annotations -from enum import Enum import datetime +from enum import Enum from dataclasses import field, dataclass -from typing import TYPE_CHECKING, Any, Sequence, Annotated +from typing import ( + TYPE_CHECKING, + Any, + Sequence, + Annotated, + assert_type, + assert_never, +) from typing_extensions import override import pytest @@ -24,10 +31,11 @@ from efro.dataclassio import ( Codec, DataclassFieldLookup, IOExtendedData, + IOMultiType, ) if TYPE_CHECKING: - pass + from typing import Self class _EnumTest(Enum): @@ -1069,3 +1077,178 @@ def test_soft_default() -> None: todict = dataclass_to_dict(orig) assert todict == {'ival': 2} assert dataclass_from_dict(_TestClassE8, todict) == orig + + +class MTTestTypeID(Enum): + """IDs for our multi-type class.""" + + CLASS_1 = 'm1' + CLASS_2 = 'm2' + + +class MTTestBase(IOMultiType[MTTestTypeID]): + """Our multi-type class. + + These top level multi-type classes are special parent classes + that know about all of their child classes and how to serialize + & deserialize them using explicit type ids. We can then use the + parent class in annotations and dataclassio will do the right thing. + Useful for stuff like Message classes. + """ + + @override + @classmethod + def get_type(cls, type_id: MTTestTypeID) -> type[MTTestBase]: + """Return the subclass for each of our type-ids.""" + + # This uses assert_never() to ensure we cover all cases in the + # enum. Though this is less efficient than looking up by dict + # would be. If we had lots of values we could also support lazy + # loading by importing classes only when their value is being + # requested. + val: type[MTTestBase] + if type_id is MTTestTypeID.CLASS_1: + val = MTTestClass1 + elif type_id is MTTestTypeID.CLASS_2: + val = MTTestClass2 + else: + assert_never(type_id) + return val + + @override + @classmethod + def get_type_id(cls) -> MTTestTypeID: + """Provide the type-id for this subclass.""" + # If we wanted, we could just maintain a static mapping + # of types-to-ids here, but there are benefits to letting + # each child class speak for itself. Namely that we can + # do lazy-loading and don't need to have all types present + # here. + + # So we'll let all our child classes override this. + raise NotImplementedError() + + +@ioprepped +@dataclass(frozen=True) # Frozen so we can test in set() +class MTTestClass1(MTTestBase): + """A test child-class for use with our multi-type class.""" + + ival: int + + @override + @classmethod + def get_type_id(cls) -> MTTestTypeID: + return MTTestTypeID.CLASS_1 + + +@ioprepped +@dataclass(frozen=True) # Frozen so we can test in set() +class MTTestClass2(MTTestBase): + """Another test child-class for use with our multi-type class.""" + + sval: str + + @override + @classmethod + def get_type_id(cls) -> MTTestTypeID: + return MTTestTypeID.CLASS_2 + + +def test_multi_type() -> None: + """Test IOMultiType stuff.""" + # pylint: disable=too-many-locals + + # Test converting single instances back and forth. + val1: MTTestBase = MTTestClass1(ival=123) + tpname = MTTestBase.ID_STORAGE_NAME + outdict = dataclass_to_dict(val1) + assert outdict == {'ival': 123, tpname: 'm1'} + val2: MTTestBase = MTTestClass2(sval='whee') + outdict2 = dataclass_to_dict(val2) + assert outdict2 == {'sval': 'whee', tpname: 'm2'} + + # Make sure types and values work for both concrete types and the + # multi-type. + assert_type(dataclass_from_dict(MTTestClass1, outdict), MTTestClass1) + assert_type(dataclass_from_dict(MTTestBase, outdict), MTTestBase) + + assert dataclass_from_dict(MTTestClass1, outdict) == val1 + assert dataclass_from_dict(MTTestClass2, outdict2) == val2 + assert dataclass_from_dict(MTTestBase, outdict) == val1 + assert dataclass_from_dict(MTTestBase, outdict2) == val2 + + # Now test our multi-type embedded in other classes. We should be + # able to throw a mix of things in there and have them deserialize + # back the types we started with. + + # Individual values: + + @ioprepped + @dataclass + class _TestContainerClass1: + obj_a: MTTestBase + obj_b: MTTestBase + + container1 = _TestContainerClass1( + obj_a=MTTestClass1(234), obj_b=MTTestClass2('987') + ) + outdict = dataclass_to_dict(container1) + container1b = dataclass_from_dict(_TestContainerClass1, outdict) + assert container1 == container1b + + # Lists: + + @ioprepped + @dataclass + class _TestContainerClass2: + objs: list[MTTestBase] + + container2 = _TestContainerClass2( + objs=[MTTestClass1(111), MTTestClass2('bbb')] + ) + outdict = dataclass_to_dict(container2) + container2b = dataclass_from_dict(_TestContainerClass2, outdict) + assert container2 == container2b + + # Dict values: + + @ioprepped + @dataclass + class _TestContainerClass3: + objs: dict[int, MTTestBase] + + container3 = _TestContainerClass3( + objs={1: MTTestClass1(456), 2: MTTestClass2('gronk')} + ) + outdict = dataclass_to_dict(container3) + container3b = dataclass_from_dict(_TestContainerClass3, outdict) + assert container3 == container3b + + # Tuples: + + @ioprepped + @dataclass + class _TestContainerClass4: + objs: tuple[MTTestBase, MTTestBase] + + container4 = _TestContainerClass4( + objs=(MTTestClass1(932), MTTestClass2('potato')) + ) + outdict = dataclass_to_dict(container4) + container4b = dataclass_from_dict(_TestContainerClass4, outdict) + assert container4 == container4b + + # Sets (note: dataclasses must be frozen for this to work): + + @ioprepped + @dataclass + class _TestContainerClass5: + objs: set[MTTestBase] + + container5 = _TestContainerClass5( + objs={MTTestClass1(424), MTTestClass2('goo')} + ) + outdict = dataclass_to_dict(container5) + container5b = dataclass_from_dict(_TestContainerClass5, outdict) + assert container5 == container5b diff --git a/tools/bacommon/transfer.py b/tools/bacommon/transfer.py index a53c6153..65221cbd 100644 --- a/tools/bacommon/transfer.py +++ b/tools/bacommon/transfer.py @@ -18,10 +18,10 @@ if TYPE_CHECKING: @ioprepped @dataclass class DirectoryManifestFile: - """Describes metadata and hashes for a file in a manifest.""" + """Describes a file in a manifest.""" - filehash: Annotated[str, IOAttrs('h')] - filesize: Annotated[int, IOAttrs('s')] + hash_sha256: Annotated[str, IOAttrs('h')] + size: Annotated[int, IOAttrs('s')] @ioprepped @@ -67,7 +67,7 @@ class DirectoryManifest: return ( filepath, DirectoryManifestFile( - filehash=sha.hexdigest(), filesize=filesize + hash_sha256=sha.hexdigest(), size=filesize ), ) diff --git a/tools/efro/dataclassio/__init__.py b/tools/efro/dataclassio/__init__.py index 56c87b10..9c6ae98a 100644 --- a/tools/efro/dataclassio/__init__.py +++ b/tools/efro/dataclassio/__init__.py @@ -11,7 +11,7 @@ data formats in a nondestructive manner. from __future__ import annotations from efro.util import set_canonical_module_names -from efro.dataclassio._base import Codec, IOAttrs, IOExtendedData +from efro.dataclassio._base import Codec, IOAttrs, IOExtendedData, IOMultiType from efro.dataclassio._prep import ( ioprep, ioprepped, @@ -33,6 +33,7 @@ __all__ = [ 'Codec', 'IOAttrs', 'IOExtendedData', + 'IOMultiType', 'ioprep', 'ioprepped', 'will_ioprep', diff --git a/tools/efro/dataclassio/_api.py b/tools/efro/dataclassio/_api.py index ddadd4d8..2fa308fa 100644 --- a/tools/efro/dataclassio/_api.py +++ b/tools/efro/dataclassio/_api.py @@ -27,7 +27,7 @@ class JsonStyle(Enum): """Different style types for json.""" # Single line, no spaces, no sorting. Not deterministic. - # Use this for most storage purposes. + # Use this where speed is more important than determinism. FAST = 'fast' # Single line, no spaces, sorted keys. Deterministic. @@ -40,7 +40,9 @@ class JsonStyle(Enum): def dataclass_to_dict( - obj: Any, codec: Codec = Codec.JSON, coerce_to_float: bool = True + obj: Any, + codec: Codec = Codec.JSON, + coerce_to_float: bool = True, ) -> dict: """Given a dataclass object, return a json-friendly dict. @@ -89,6 +91,28 @@ def dataclass_to_json( return json.dumps(jdict, separators=(',', ':'), sort_keys=sort_keys) +# @overload +# def dataclass_from_dict( +# cls: type[T], +# values: dict, +# codec: Codec = Codec.JSON, +# coerce_to_float: bool = True, +# allow_unknown_attrs: bool = True, +# discard_unknown_attrs: bool = False, +# ) -> T: ... + + +# @overload +# def dataclass_from_dict( +# cls: IOTypeMap, +# values: dict, +# codec: Codec = Codec.JSON, +# coerce_to_float: bool = True, +# allow_unknown_attrs: bool = True, +# discard_unknown_attrs: bool = False, +# ) -> Any: ... + + def dataclass_from_dict( cls: type[T], values: dict, @@ -120,13 +144,15 @@ def dataclass_from_dict( exported back to a dict, unless discard_unknown_attrs is True, in which case they will simply be discarded. """ - return _Inputter( + val = _Inputter( cls, codec=codec, coerce_to_float=coerce_to_float, allow_unknown_attrs=allow_unknown_attrs, discard_unknown_attrs=discard_unknown_attrs, ).run(values) + assert isinstance(val, cls) + return val def dataclass_from_json( diff --git a/tools/efro/dataclassio/_base.py b/tools/efro/dataclassio/_base.py index afe19deb..abcb24a7 100644 --- a/tools/efro/dataclassio/_base.py +++ b/tools/efro/dataclassio/_base.py @@ -8,13 +8,13 @@ import dataclasses import typing import datetime from enum import Enum -from typing import TYPE_CHECKING, get_args +from typing import TYPE_CHECKING, get_args, TypeVar, Generic # noinspection PyProtectedMember from typing import _AnnotatedAlias # type: ignore if TYPE_CHECKING: - from typing import Any, Callable + from typing import Any, Callable, Literal, ClassVar, Self # Types which we can pass through as-is. SIMPLE_TYPES = {int, bool, str, float, type(None)} @@ -24,23 +24,6 @@ SIMPLE_TYPES = {int, bool, str, float, type(None)} EXTRA_ATTRS_ATTR = '_DCIOEXATTRS' -def _raise_type_error( - fieldpath: str, valuetype: type, expected: tuple[type, ...] -) -> None: - """Raise an error when a field value's type does not match expected.""" - assert isinstance(expected, tuple) - assert all(isinstance(e, type) for e in expected) - if len(expected) == 1: - expected_str = expected[0].__name__ - else: - expected_str = ' | '.join(t.__name__ for t in expected) - raise TypeError( - f'Invalid value type for "{fieldpath}";' - f' expected "{expected_str}", got' - f' "{valuetype.__name__}".' - ) - - class Codec(Enum): """Specifies expected data format exported to or imported from.""" @@ -78,32 +61,41 @@ class IOExtendedData: """ -def _is_valid_for_codec(obj: Any, codec: Codec) -> bool: - """Return whether a value consists solely of json-supported types. +KeyT = TypeVar('KeyT', bound=Enum) - Note that this does not include things like tuples which are - implicitly translated to lists by python's json module. + +class IOMultiType(Generic[KeyT]): + """A base class for types that can map to multiple dataclass types. + + This allows construction of high level base classes (for example + a 'Message' type). These types can then be used as annotations in + dataclasses, and dataclassio will serialize/deserialize instances + based on their subtype plus simple embedded type-id values. + + See tests/test_efro/test_dataclassio.py for an example of this. """ - if obj is None: - return True - objtype = type(obj) - if objtype in (int, float, str, bool): - return True - if objtype is dict: - # JSON 'objects' supports only string dict keys, but all value types. - return all( - isinstance(k, str) and _is_valid_for_codec(v, codec) - for k, v in obj.items() - ) - if objtype is list: - return all(_is_valid_for_codec(elem, codec) for elem in obj) + # Serialized data will store individual object ids to this key. If + # this value is ever problematic, it should be possible to override + # it in a subclass. + ID_STORAGE_NAME = '_iotype' - # A few things are valid in firestore but not json. - if issubclass(objtype, datetime.datetime) or objtype is bytes: - return codec is Codec.FIRESTORE + @classmethod + def get_key_type(cls) -> type[Enum]: + """Return the enum type we use as a key.""" + out: type[Enum] = cls.__orig_bases__[0].__args__[0] # type: ignore + assert issubclass(out, Enum) + return out - return False + @classmethod + def get_type_id(cls) -> KeyT: + """Return the type id for this subclass.""" + raise NotImplementedError() + + @classmethod + def get_type(cls, type_id: KeyT) -> type[Self]: + """Return a specific subclass given an id.""" + raise NotImplementedError() class IOAttrs: @@ -192,7 +184,7 @@ class IOAttrs: """Ensure the IOAttrs instance is ok to use with the provided field.""" # Turning off store_default requires the field to have either - # a default or a a default_factory or for us to have soft equivalents. + # a default or a default_factory or for us to have soft equivalents. if not self.store_default: field_default_factory: Any = field.default_factory @@ -241,6 +233,52 @@ class IOAttrs: ) +def _raise_type_error( + fieldpath: str, valuetype: type, expected: tuple[type, ...] +) -> None: + """Raise an error when a field value's type does not match expected.""" + assert isinstance(expected, tuple) + assert all(isinstance(e, type) for e in expected) + if len(expected) == 1: + expected_str = expected[0].__name__ + else: + expected_str = ' | '.join(t.__name__ for t in expected) + raise TypeError( + f'Invalid value type for "{fieldpath}";' + f' expected "{expected_str}", got' + f' "{valuetype.__name__}".' + ) + + +def _is_valid_for_codec(obj: Any, codec: Codec) -> bool: + """Return whether a value consists solely of json-supported types. + + Note that this does not include things like tuples which are + implicitly translated to lists by python's json module. + """ + if obj is None: + return True + + objtype = type(obj) + if objtype in (int, float, str, bool): + return True + if objtype is dict: + # JSON 'objects' supports only string dict keys, but all value + # types. + return all( + isinstance(k, str) and _is_valid_for_codec(v, codec) + for k, v in obj.items() + ) + if objtype is list: + return all(_is_valid_for_codec(elem, codec) for elem in obj) + + # A few things are valid in firestore but not json. + if issubclass(objtype, datetime.datetime) or objtype is bytes: + return codec is Codec.FIRESTORE + + return False + + def _get_origin(anntype: Any) -> Any: """Given a type annotation, return its origin or itself if there is none. @@ -255,9 +293,9 @@ def _get_origin(anntype: Any) -> Any: def _parse_annotated(anntype: Any) -> tuple[Any, IOAttrs | None]: """Parse Annotated() constructs, returning annotated type & IOAttrs.""" - # If we get an Annotated[foo, bar, eep] we take - # foo as the actual type, and we look for IOAttrs instances in - # bar/eep to affect our behavior. + # If we get an Annotated[foo, bar, eep] we take foo as the actual + # type, and we look for IOAttrs instances in bar/eep to affect our + # behavior. ioattrs: IOAttrs | None = None if isinstance(anntype, _AnnotatedAlias): annargs = get_args(anntype) @@ -270,8 +308,8 @@ def _parse_annotated(anntype: Any) -> tuple[Any, IOAttrs | None]: ) ioattrs = annarg - # I occasionally just throw a 'x' down when I mean IOAttrs('x'); - # catch these mistakes. + # I occasionally just throw a 'x' down when I mean + # IOAttrs('x'); catch these mistakes. elif isinstance(annarg, (str, int, float, bool)): raise RuntimeError( f'Raw {type(annarg)} found in Annotated[] entry:' @@ -279,3 +317,21 @@ def _parse_annotated(anntype: Any) -> tuple[Any, IOAttrs | None]: ) anntype = annargs[0] return anntype, ioattrs + + +def _get_multitype_type( + cls: type[IOMultiType], fieldpath: str, val: Any +) -> type[Any]: + if not isinstance(val, dict): + raise ValueError( + f"Found a {type(val)} at '{fieldpath}'; expected a dict." + ) + storename = cls.ID_STORAGE_NAME + id_val = val.get(storename) + if id_val is None: + raise ValueError( + f"Expected a '{storename}'" f" value for object at '{fieldpath}'." + ) + id_enum_type = cls.get_key_type() + id_enum = id_enum_type(id_val) + return cls.get_type(id_enum) diff --git a/tools/efro/dataclassio/_inputter.py b/tools/efro/dataclassio/_inputter.py index 97075528..4c41582f 100644 --- a/tools/efro/dataclassio/_inputter.py +++ b/tools/efro/dataclassio/_inputter.py @@ -13,7 +13,7 @@ import dataclasses import typing import types import datetime -from typing import TYPE_CHECKING, Generic, TypeVar +from typing import TYPE_CHECKING from efro.util import enum_by_value, check_utc from efro.dataclassio._base import ( @@ -25,6 +25,8 @@ from efro.dataclassio._base import ( SIMPLE_TYPES, _raise_type_error, IOExtendedData, + _get_multitype_type, + IOMultiType, ) from efro.dataclassio._prep import PrepSession @@ -34,13 +36,11 @@ if TYPE_CHECKING: from efro.dataclassio._base import IOAttrs from efro.dataclassio._outputter import _Outputter -T = TypeVar('T') - -class _Inputter(Generic[T]): +class _Inputter: def __init__( self, - cls: type[T], + cls: type[Any], codec: Codec, coerce_to_float: bool, allow_unknown_attrs: bool = True, @@ -59,27 +59,39 @@ class _Inputter(Generic[T]): ' when allow_unknown_attrs is False.' ) - def run(self, values: dict) -> T: + def run(self, values: dict) -> Any: """Do the thing.""" - # For special extended data types, call their 'will_output' callback. - tcls = self._cls + outcls: type[Any] - if issubclass(tcls, IOExtendedData): + # If we're dealing with a multi-type class, figure out the + # top level type we're going to. + if issubclass(self._cls, IOMultiType): + type_id_val = values.get(self._cls.ID_STORAGE_NAME) + if type_id_val is None: + raise ValueError( + f'No type id value present for multi-type object:' + f' {values}.' + ) + type_id_enum = self._cls.get_key_type() + enum_val = type_id_enum(type_id_val) + outcls = self._cls.get_type(enum_val) + else: + outcls = self._cls + + # FIXME - should probably move this into _dataclass_from_input + # so it can work on nested values. + if issubclass(outcls, IOExtendedData): is_ext = True - tcls.will_input(values) + outcls.will_input(values) else: is_ext = False - out = self._dataclass_from_input(self._cls, '', values) - assert isinstance(out, self._cls) + out = self._dataclass_from_input(outcls, '', values) + assert isinstance(out, outcls) if is_ext: - # mypy complains that we're no longer returning a T - # if we operate on out directly. - out2 = out - assert isinstance(out2, IOExtendedData) - out2.did_input() + out.did_input() return out @@ -111,8 +123,8 @@ class _Inputter(Generic[T]): # noinspection PyPep8 if origin is typing.Union or origin is types.UnionType: # Currently, the only unions we support are None/Value - # (translated from Optional), which we verified on prep. - # So let's treat this as a simple optional case. + # (translated from Optional), which we verified on prep. So + # let's treat this as a simple optional case. if value is None: return None childanntypes_l = [ @@ -123,13 +135,15 @@ class _Inputter(Generic[T]): cls, fieldpath, childanntypes_l[0], value, ioattrs ) - # Everything below this point assumes the annotation type resolves - # to a concrete type. (This should have been verified at prep time). + # Everything below this point assumes the annotation type + # resolves to a concrete type. (This should have been verified + # at prep time). assert isinstance(origin, type) if origin in SIMPLE_TYPES: if type(value) is not origin: - # Special case: if they want to coerce ints to floats, do so. + # Special case: if they want to coerce ints to floats, + # do so. if ( self._coerce_to_float and origin is float @@ -157,6 +171,16 @@ class _Inputter(Generic[T]): if dataclasses.is_dataclass(origin): return self._dataclass_from_input(origin, fieldpath, value) + # ONLY consider something as a multi-type when it's not a + # dataclass (all dataclasses inheriting from the multi-type + # should just be processed as dataclasses). + if issubclass(origin, IOMultiType): + return self._dataclass_from_input( + _get_multitype_type(anntype, fieldpath, value), + fieldpath, + value, + ) + if issubclass(origin, Enum): return enum_by_value(origin, value) @@ -228,10 +252,23 @@ class _Inputter(Generic[T]): f.name: _parse_annotated(prep.annotations[f.name]) for f in fields } + # Special case: if this is a multi-type class it probably has a + # type attr. Ignore that while parsing since we already have a + # definite type and it will just pollute extra-attrs otherwise. + if issubclass(cls, IOMultiType): + type_id_store_name = cls.ID_STORAGE_NAME + else: + type_id_store_name = None + # Go through all data in the input, converting it to either dataclass # args or extra data. args: dict[str, Any] = {} for rawkey, value in values.items(): + + # Ignore _iotype or whatnot. + if type_id_store_name is not None and rawkey == type_id_store_name: + continue + key = prep.storage_names_to_attr_names.get(rawkey, rawkey) field = fields_by_name.get(key) @@ -473,6 +510,19 @@ class _Inputter(Generic[T]): # We contain elements of some specified type. assert len(childanntypes) == 1 childanntype = childanntypes[0] + + # If our annotation type inherits from IOMultiType, use type-id + # values to determine which type to load for each element. + if issubclass(childanntype, IOMultiType): + return seqtype( + self._dataclass_from_input( + _get_multitype_type(childanntype, fieldpath, i), + fieldpath, + i, + ) + for i in value + ) + return seqtype( self._value_from_input(cls, fieldpath, childanntype, i, ioattrs) for i in value diff --git a/tools/efro/dataclassio/_outputter.py b/tools/efro/dataclassio/_outputter.py index 03e1d20f..198ad93e 100644 --- a/tools/efro/dataclassio/_outputter.py +++ b/tools/efro/dataclassio/_outputter.py @@ -25,6 +25,7 @@ from efro.dataclassio._base import ( SIMPLE_TYPES, _raise_type_error, IOExtendedData, + IOMultiType, ) from efro.dataclassio._prep import PrepSession @@ -49,6 +50,8 @@ class _Outputter: assert dataclasses.is_dataclass(self._obj) # For special extended data types, call their 'will_output' callback. + # FIXME - should probably move this into _process_dataclass so it + # can work on nested values. if isinstance(self._obj, IOExtendedData): self._obj.will_output() @@ -139,6 +142,17 @@ class _Outputter: if self._create: assert out is not None out.update(extra_attrs) + + # If this obj inherits from multi-type, store its type id. + if isinstance(obj, IOMultiType): + type_id = obj.get_type_id() + # Sanity checks; make sure looking up this id gets us this type. + assert isinstance(type_id.value, str) + assert obj.get_type(type_id) is type(obj) + if self._create: + assert out is not None + out[obj.ID_STORAGE_NAME] = type_id.value + return out def _process_value( @@ -231,6 +245,7 @@ class _Outputter: f'Expected a list for {fieldpath};' f' found a {type(value)}' ) + childanntypes = typing.get_args(anntype) # 'Any' type children; make sure they are valid values for @@ -246,8 +261,37 @@ class _Outputter: # Hmm; should we do a copy here? return value if self._create else None - # We contain elements of some specified type. + # We contain elements of some single specified type. assert len(childanntypes) == 1 + childanntype = childanntypes[0] + + # If that type is a multi-type, we determine our type per-object. + if issubclass(childanntype, IOMultiType): + # In the multi-type case, we use each object's own type + # to do its conversion, but lets at least make sure each + # of those types inherits from the annotated multi-type + # class. + for x in value: + if not isinstance(x, childanntype): + raise ValueError( + f"Found a {type(x)} value under '{fieldpath}'." + f' Everything must inherit from' + f' {childanntype}.' + ) + + if self._create: + out: list[Any] = [] + for x in value: + # We know these are dataclasses so no need to do + # the generic _process_value. + out.append(self._process_dataclass(cls, x, fieldpath)) + return out + for x in value: + # We know these are dataclasses so no need to do + # the generic _process_value. + self._process_dataclass(cls, x, fieldpath) + + # Normal non-multitype case; everything's got the same type. if self._create: return [ self._process_value( @@ -307,6 +351,21 @@ class _Outputter: ) return self._process_dataclass(cls, value, fieldpath) + # ONLY consider something as a multi-type when it's not a + # dataclass (all dataclasses inheriting from the multi-type should + # just be processed as dataclasses). + if issubclass(origin, IOMultiType): + # In the multi-type case, we use each object's own type to + # do its conversion, but lets at least make sure each of + # those types inherits from the annotated multi-type class. + if not isinstance(value, origin): + raise ValueError( + f"Found a {type(value)} value at '{fieldpath}'." + f' It is expected to inherit from {origin}.' + ) + + return self._process_dataclass(cls, value, fieldpath) + if issubclass(origin, Enum): if not isinstance(value, origin): raise TypeError( diff --git a/tools/efro/dataclassio/_prep.py b/tools/efro/dataclassio/_prep.py index 0800b559..d7f8e828 100644 --- a/tools/efro/dataclassio/_prep.py +++ b/tools/efro/dataclassio/_prep.py @@ -17,7 +17,12 @@ import datetime from typing import TYPE_CHECKING, TypeVar, get_type_hints # noinspection PyProtectedMember -from efro.dataclassio._base import _parse_annotated, _get_origin, SIMPLE_TYPES +from efro.dataclassio._base import ( + _parse_annotated, + _get_origin, + SIMPLE_TYPES, + IOMultiType, +) if TYPE_CHECKING: from typing import Any @@ -260,6 +265,13 @@ class PrepSession: origin = _get_origin(anntype) + # If we inherit from IOMultiType, we use its type map to + # determine which type we're going to instead of the annotation. + # And we can't really check those types because they are + # lazy-loaded. So I guess we're done here. + if issubclass(origin, IOMultiType): + return + # noinspection PyPep8 if origin is typing.Union or origin is types.UnionType: self.prep_union( From 3186ff6b503202d1acbe83b429376a7f52c0e4fc Mon Sep 17 00:00:00 2001 From: Eric Date: Wed, 31 Jan 2024 14:25:19 -0800 Subject: [PATCH 5/7] tidying --- .efrocachemap | 40 ++++++++++++------------- CHANGELOG.md | 2 +- src/assets/ba_data/python/baenv.py | 2 +- src/ballistica/shared/ballistica.cc | 2 +- tests/test_efro/test_dataclassio.py | 3 +- tools/efro/dataclassio/_base.py | 46 ++++++++++++++--------------- tools/efro/dataclassio/_inputter.py | 2 +- 7 files changed, 49 insertions(+), 48 deletions(-) diff --git a/.efrocachemap b/.efrocachemap index 873034ca..bee3b976 100644 --- a/.efrocachemap +++ b/.efrocachemap @@ -4060,26 +4060,26 @@ "build/assets/windows/Win32/ucrtbased.dll": "2def5335207d41b21b9823f6805997f1", "build/assets/windows/Win32/vc_redist.x86.exe": "b08a55e2e77623fe657bea24f223a3ae", "build/assets/windows/Win32/vcruntime140d.dll": "865b2af4d1e26a1a8073c89acb06e599", - "build/prefab/full/linux_arm64_gui/debug/ballisticakit": "d1d989de9e44829ce7adc6348cad34f1", - "build/prefab/full/linux_arm64_gui/release/ballisticakit": "d27e236d62e3db407c61902f0768b209", - "build/prefab/full/linux_arm64_server/debug/dist/ballisticakit_headless": "148a0c692fd30c3027158866a1c6c157", - "build/prefab/full/linux_arm64_server/release/dist/ballisticakit_headless": "0836f235c538b20dd2187071dc82a9c0", - "build/prefab/full/linux_x86_64_gui/debug/ballisticakit": "c928cdc074b9cb8f752ca049fb30fcf9", - "build/prefab/full/linux_x86_64_gui/release/ballisticakit": "b66bd051975628898fb66d291188824f", - "build/prefab/full/linux_x86_64_server/debug/dist/ballisticakit_headless": "7b3579d629ad99f032c4b2d821f7e348", - "build/prefab/full/linux_x86_64_server/release/dist/ballisticakit_headless": "08d11c347fed9b4d2b6f582c92321ed0", - "build/prefab/full/mac_arm64_gui/debug/ballisticakit": "f51e6dbccdeb8b64163029d58168d6d3", - "build/prefab/full/mac_arm64_gui/release/ballisticakit": "5c250868de853f0bcdbfd671e5863e0b", - "build/prefab/full/mac_arm64_server/debug/dist/ballisticakit_headless": "bc49209413eacf23bd6aa8cae47f7324", - "build/prefab/full/mac_arm64_server/release/dist/ballisticakit_headless": "40f7edd3b8e2d5cf2869cdaf12459fbe", - "build/prefab/full/mac_x86_64_gui/debug/ballisticakit": "9530446001824359b438d64054a4fa39", - "build/prefab/full/mac_x86_64_gui/release/ballisticakit": "5db3cac8a2cfdb5d56cb7579d32f17c6", - "build/prefab/full/mac_x86_64_server/debug/dist/ballisticakit_headless": "db8d6083d7bbdf78855c70affc3792df", - "build/prefab/full/mac_x86_64_server/release/dist/ballisticakit_headless": "c4d5c5387cc15f9c83dd41ce75e5cba5", - "build/prefab/full/windows_x86_gui/debug/BallisticaKit.exe": "2accd53f262abd82afcc9f9b73f26f2e", - "build/prefab/full/windows_x86_gui/release/BallisticaKit.exe": "3e2d7f9d4c7c350af1e21a8acbb3dec6", - "build/prefab/full/windows_x86_server/debug/dist/BallisticaKitHeadless.exe": "4d629a6f6029e191dd341e0a2a21d50b", - "build/prefab/full/windows_x86_server/release/dist/BallisticaKitHeadless.exe": "feeeb28a230759fb5283474f82fc2451", + "build/prefab/full/linux_arm64_gui/debug/ballisticakit": "4061f6114403c60ce1553d2b95c6fd7f", + "build/prefab/full/linux_arm64_gui/release/ballisticakit": "c73d4beea86082419fa0dee9cf8e93be", + "build/prefab/full/linux_arm64_server/debug/dist/ballisticakit_headless": "928c17c937e26d2fdc9edc8bc1e07659", + "build/prefab/full/linux_arm64_server/release/dist/ballisticakit_headless": "07a90a9ee49ccfcf4cb0fcbccd0e1a04", + "build/prefab/full/linux_x86_64_gui/debug/ballisticakit": "aa4929306878a5e757be36bbd80cb3b3", + "build/prefab/full/linux_x86_64_gui/release/ballisticakit": "6579bfe457770767a35ce69513433273", + "build/prefab/full/linux_x86_64_server/debug/dist/ballisticakit_headless": "0eb96f2dfd3798621dd35d3693e596f7", + "build/prefab/full/linux_x86_64_server/release/dist/ballisticakit_headless": "21ff8796c4e459d4087a68d02b998576", + "build/prefab/full/mac_arm64_gui/debug/ballisticakit": "a69ade336e8d9574919debda154ca2ec", + "build/prefab/full/mac_arm64_gui/release/ballisticakit": "ce625368b6392bc3d9c6f033b1255c6f", + "build/prefab/full/mac_arm64_server/debug/dist/ballisticakit_headless": "0b606c6c6f4774dc9cfebfab347d6271", + "build/prefab/full/mac_arm64_server/release/dist/ballisticakit_headless": "56878ae9435c3b99a62319e016418dff", + "build/prefab/full/mac_x86_64_gui/debug/ballisticakit": "461c5e567f8bf9726a1b7f5ced7e7418", + "build/prefab/full/mac_x86_64_gui/release/ballisticakit": "c6a85daf172fee978c7deafb3b50fc21", + "build/prefab/full/mac_x86_64_server/debug/dist/ballisticakit_headless": "42121063ca6dc6a446a331b2ea4dc707", + "build/prefab/full/mac_x86_64_server/release/dist/ballisticakit_headless": "94a0a0bec30f85b0397fb1925ef54e33", + "build/prefab/full/windows_x86_gui/debug/BallisticaKit.exe": "f9f983439f6b2a5cc92e2c8c575b66bb", + "build/prefab/full/windows_x86_gui/release/BallisticaKit.exe": "ec5f0294584602e88e071eb336b671fd", + "build/prefab/full/windows_x86_server/debug/dist/BallisticaKitHeadless.exe": "6c49a9829024ff91e2d07dbaf2c75184", + "build/prefab/full/windows_x86_server/release/dist/BallisticaKitHeadless.exe": "f82d8ed05ca2fa9a3bef869e3ce6ac4b", "build/prefab/lib/linux_arm64_gui/debug/libballisticaplus.a": "8709ad96140d71760c2f493ee8bd7c43", "build/prefab/lib/linux_arm64_gui/release/libballisticaplus.a": "ee829cd5488e9750570dc6f602d65589", "build/prefab/lib/linux_arm64_server/debug/libballisticaplus.a": "8709ad96140d71760c2f493ee8bd7c43", diff --git a/CHANGELOG.md b/CHANGELOG.md index 7be40ad5..151e25aa 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,4 @@ -### 1.7.33 (build 21763, api 8, 2024-01-31) +### 1.7.33 (build 21764, api 8, 2024-01-31) - Stress test input-devices are now a bit smarter; they won't press any buttons while UIs are up (this could cause lots of chaos if it happened). - Added a 'Show Demos When Idle' option in advanced settings. If enabled, the diff --git a/src/assets/ba_data/python/baenv.py b/src/assets/ba_data/python/baenv.py index 8a4b85c3..b61f151a 100644 --- a/src/assets/ba_data/python/baenv.py +++ b/src/assets/ba_data/python/baenv.py @@ -52,7 +52,7 @@ if TYPE_CHECKING: # Build number and version of the ballistica binary we expect to be # using. -TARGET_BALLISTICA_BUILD = 21763 +TARGET_BALLISTICA_BUILD = 21764 TARGET_BALLISTICA_VERSION = '1.7.33' diff --git a/src/ballistica/shared/ballistica.cc b/src/ballistica/shared/ballistica.cc index f88717ed..b1201f9b 100644 --- a/src/ballistica/shared/ballistica.cc +++ b/src/ballistica/shared/ballistica.cc @@ -39,7 +39,7 @@ auto main(int argc, char** argv) -> int { namespace ballistica { // These are set automatically via script; don't modify them here. -const int kEngineBuildNumber = 21763; +const int kEngineBuildNumber = 21764; const char* kEngineVersion = "1.7.33"; const int kEngineApiVersion = 8; diff --git a/tests/test_efro/test_dataclassio.py b/tests/test_efro/test_dataclassio.py index 427ffff3..20e603cd 100644 --- a/tests/test_efro/test_dataclassio.py +++ b/tests/test_efro/test_dataclassio.py @@ -1093,7 +1093,8 @@ class MTTestBase(IOMultiType[MTTestTypeID]): that know about all of their child classes and how to serialize & deserialize them using explicit type ids. We can then use the parent class in annotations and dataclassio will do the right thing. - Useful for stuff like Message classes. + Useful for stuff like Message classes where we may want to store a + bunch of different types of them into one place. """ @override diff --git a/tools/efro/dataclassio/_base.py b/tools/efro/dataclassio/_base.py index abcb24a7..c1ba8841 100644 --- a/tools/efro/dataclassio/_base.py +++ b/tools/efro/dataclassio/_base.py @@ -61,42 +61,42 @@ class IOExtendedData: """ -KeyT = TypeVar('KeyT', bound=Enum) +EnumT = TypeVar('EnumT', bound=Enum) -class IOMultiType(Generic[KeyT]): +class IOMultiType(Generic[EnumT]): """A base class for types that can map to multiple dataclass types. - This allows construction of high level base classes (for example - a 'Message' type). These types can then be used as annotations in - dataclasses, and dataclassio will serialize/deserialize instances - based on their subtype plus simple embedded type-id values. + This enables usage of high level base classes (for example + a 'Message' type) in dataclasses, with dataclassio automatically + serializing/deserializing subclass instances using provided + per-class type-ids. See tests/test_efro/test_dataclassio.py for an example of this. """ - # Serialized data will store individual object ids to this key. If - # this value is ever problematic, it should be possible to override - # it in a subclass. + # Dataclasses inheriting from an IOMultiType will store a type-id + # with this key in their serialized data. This value can be + # overridden in IOMultiType subclasses in case of conflicts. ID_STORAGE_NAME = '_iotype' @classmethod - def get_key_type(cls) -> type[Enum]: - """Return the enum type we use as a key.""" - out: type[Enum] = cls.__orig_bases__[0].__args__[0] # type: ignore + def get_type(cls, type_id: EnumT) -> type[Self]: + """Return a specific subclass given a type-id.""" + raise NotImplementedError() + + @classmethod + def get_type_id(cls) -> EnumT: + """Return the type-id for this subclass.""" + raise NotImplementedError() + + @classmethod + def get_type_id_type(cls) -> type[EnumT]: + """Return the Enum type this class uses as its type-id.""" + out: type[EnumT] = cls.__orig_bases__[0].__args__[0] # type: ignore assert issubclass(out, Enum) return out - @classmethod - def get_type_id(cls) -> KeyT: - """Return the type id for this subclass.""" - raise NotImplementedError() - - @classmethod - def get_type(cls, type_id: KeyT) -> type[Self]: - """Return a specific subclass given an id.""" - raise NotImplementedError() - class IOAttrs: """For specifying io behavior in annotations. @@ -332,6 +332,6 @@ def _get_multitype_type( raise ValueError( f"Expected a '{storename}'" f" value for object at '{fieldpath}'." ) - id_enum_type = cls.get_key_type() + id_enum_type = cls.get_type_id_type() id_enum = id_enum_type(id_val) return cls.get_type(id_enum) diff --git a/tools/efro/dataclassio/_inputter.py b/tools/efro/dataclassio/_inputter.py index 4c41582f..d6627b25 100644 --- a/tools/efro/dataclassio/_inputter.py +++ b/tools/efro/dataclassio/_inputter.py @@ -73,7 +73,7 @@ class _Inputter: f'No type id value present for multi-type object:' f' {values}.' ) - type_id_enum = self._cls.get_key_type() + type_id_enum = self._cls.get_type_id_type() enum_val = type_id_enum(type_id_val) outcls = self._cls.get_type(enum_val) else: From dc6d29de22a19bfe02388e3c555ad12a9125b2b6 Mon Sep 17 00:00:00 2001 From: Eric Date: Thu, 1 Feb 2024 12:35:00 -0800 Subject: [PATCH 6/7] dataclassio multitype fixes/tidying --- .efrocachemap | 40 +++++++++++++------------- CHANGELOG.md | 2 +- src/assets/ba_data/python/baenv.py | 2 +- src/assets/server_package/README.txt | 2 +- src/ballistica/shared/ballistica.cc | 2 +- tests/test_efro/test_dataclassio.py | 43 ++++++++++++++++++++++++++++ tools/efro/dataclassio/_base.py | 13 ++++++--- tools/efro/dataclassio/_inputter.py | 14 ++++++--- 8 files changed, 86 insertions(+), 32 deletions(-) diff --git a/.efrocachemap b/.efrocachemap index bee3b976..f8c75782 100644 --- a/.efrocachemap +++ b/.efrocachemap @@ -4060,26 +4060,26 @@ "build/assets/windows/Win32/ucrtbased.dll": "2def5335207d41b21b9823f6805997f1", "build/assets/windows/Win32/vc_redist.x86.exe": "b08a55e2e77623fe657bea24f223a3ae", "build/assets/windows/Win32/vcruntime140d.dll": "865b2af4d1e26a1a8073c89acb06e599", - "build/prefab/full/linux_arm64_gui/debug/ballisticakit": "4061f6114403c60ce1553d2b95c6fd7f", - "build/prefab/full/linux_arm64_gui/release/ballisticakit": "c73d4beea86082419fa0dee9cf8e93be", - "build/prefab/full/linux_arm64_server/debug/dist/ballisticakit_headless": "928c17c937e26d2fdc9edc8bc1e07659", - "build/prefab/full/linux_arm64_server/release/dist/ballisticakit_headless": "07a90a9ee49ccfcf4cb0fcbccd0e1a04", - "build/prefab/full/linux_x86_64_gui/debug/ballisticakit": "aa4929306878a5e757be36bbd80cb3b3", - "build/prefab/full/linux_x86_64_gui/release/ballisticakit": "6579bfe457770767a35ce69513433273", - "build/prefab/full/linux_x86_64_server/debug/dist/ballisticakit_headless": "0eb96f2dfd3798621dd35d3693e596f7", - "build/prefab/full/linux_x86_64_server/release/dist/ballisticakit_headless": "21ff8796c4e459d4087a68d02b998576", - "build/prefab/full/mac_arm64_gui/debug/ballisticakit": "a69ade336e8d9574919debda154ca2ec", - "build/prefab/full/mac_arm64_gui/release/ballisticakit": "ce625368b6392bc3d9c6f033b1255c6f", - "build/prefab/full/mac_arm64_server/debug/dist/ballisticakit_headless": "0b606c6c6f4774dc9cfebfab347d6271", - "build/prefab/full/mac_arm64_server/release/dist/ballisticakit_headless": "56878ae9435c3b99a62319e016418dff", - "build/prefab/full/mac_x86_64_gui/debug/ballisticakit": "461c5e567f8bf9726a1b7f5ced7e7418", - "build/prefab/full/mac_x86_64_gui/release/ballisticakit": "c6a85daf172fee978c7deafb3b50fc21", - "build/prefab/full/mac_x86_64_server/debug/dist/ballisticakit_headless": "42121063ca6dc6a446a331b2ea4dc707", - "build/prefab/full/mac_x86_64_server/release/dist/ballisticakit_headless": "94a0a0bec30f85b0397fb1925ef54e33", - "build/prefab/full/windows_x86_gui/debug/BallisticaKit.exe": "f9f983439f6b2a5cc92e2c8c575b66bb", - "build/prefab/full/windows_x86_gui/release/BallisticaKit.exe": "ec5f0294584602e88e071eb336b671fd", - "build/prefab/full/windows_x86_server/debug/dist/BallisticaKitHeadless.exe": "6c49a9829024ff91e2d07dbaf2c75184", - "build/prefab/full/windows_x86_server/release/dist/BallisticaKitHeadless.exe": "f82d8ed05ca2fa9a3bef869e3ce6ac4b", + "build/prefab/full/linux_arm64_gui/debug/ballisticakit": "7169141b846e3c15160f3405bd1ed2ce", + "build/prefab/full/linux_arm64_gui/release/ballisticakit": "04869210f06ff8c00fb6d68a69f6b335", + "build/prefab/full/linux_arm64_server/debug/dist/ballisticakit_headless": "e28eac17f30edddc35c483fbc4e69fc5", + "build/prefab/full/linux_arm64_server/release/dist/ballisticakit_headless": "342aee2d1f2965caed811a72888cc7f1", + "build/prefab/full/linux_x86_64_gui/debug/ballisticakit": "c091240edeeeac378ffe86ce1421decc", + "build/prefab/full/linux_x86_64_gui/release/ballisticakit": "c959d3661ea83a2f9920da6d6d355fd9", + "build/prefab/full/linux_x86_64_server/debug/dist/ballisticakit_headless": "9015fb2718d6fc5a9a9bd95b0086bde6", + "build/prefab/full/linux_x86_64_server/release/dist/ballisticakit_headless": "dfcd11db04c0071b7e5032673c2dad43", + "build/prefab/full/mac_arm64_gui/debug/ballisticakit": "8a0ad295f62fc9cfa4a71d30038b0c20", + "build/prefab/full/mac_arm64_gui/release/ballisticakit": "21f2f9aecbd0c60b8e125f206ebd44c2", + "build/prefab/full/mac_arm64_server/debug/dist/ballisticakit_headless": "df5d59cf4b6da427b3e2bb4d1136cf32", + "build/prefab/full/mac_arm64_server/release/dist/ballisticakit_headless": "72f5ab8cd24ce31b8bbfe08ce691bf7b", + "build/prefab/full/mac_x86_64_gui/debug/ballisticakit": "11280b6cbec7a21574f0e8e29c379bea", + "build/prefab/full/mac_x86_64_gui/release/ballisticakit": "766b8ad86046a92fa5fa25a0a7ad88ae", + "build/prefab/full/mac_x86_64_server/debug/dist/ballisticakit_headless": "10ac2e99587552edfc3eb089ea69ede4", + "build/prefab/full/mac_x86_64_server/release/dist/ballisticakit_headless": "8cd63147b79d8866af817d01dcc8f5eb", + "build/prefab/full/windows_x86_gui/debug/BallisticaKit.exe": "061de20725a847ac6ed327d8c2e5b905", + "build/prefab/full/windows_x86_gui/release/BallisticaKit.exe": "6556a6e96f2a360a4006f2c2b7a5a1f1", + "build/prefab/full/windows_x86_server/debug/dist/BallisticaKitHeadless.exe": "1324063eeaeda2c72f7e133984fa838b", + "build/prefab/full/windows_x86_server/release/dist/BallisticaKitHeadless.exe": "3c6b96c3a63fc53819425f8872264aa8", "build/prefab/lib/linux_arm64_gui/debug/libballisticaplus.a": "8709ad96140d71760c2f493ee8bd7c43", "build/prefab/lib/linux_arm64_gui/release/libballisticaplus.a": "ee829cd5488e9750570dc6f602d65589", "build/prefab/lib/linux_arm64_server/debug/libballisticaplus.a": "8709ad96140d71760c2f493ee8bd7c43", diff --git a/CHANGELOG.md b/CHANGELOG.md index 151e25aa..471b12c4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,4 @@ -### 1.7.33 (build 21764, api 8, 2024-01-31) +### 1.7.33 (build 21766, api 8, 2024-02-01) - Stress test input-devices are now a bit smarter; they won't press any buttons while UIs are up (this could cause lots of chaos if it happened). - Added a 'Show Demos When Idle' option in advanced settings. If enabled, the diff --git a/src/assets/ba_data/python/baenv.py b/src/assets/ba_data/python/baenv.py index b61f151a..cdcf043b 100644 --- a/src/assets/ba_data/python/baenv.py +++ b/src/assets/ba_data/python/baenv.py @@ -52,7 +52,7 @@ if TYPE_CHECKING: # Build number and version of the ballistica binary we expect to be # using. -TARGET_BALLISTICA_BUILD = 21764 +TARGET_BALLISTICA_BUILD = 21766 TARGET_BALLISTICA_VERSION = '1.7.33' diff --git a/src/assets/server_package/README.txt b/src/assets/server_package/README.txt index 407c003c..fe0c8d35 100644 --- a/src/assets/server_package/README.txt +++ b/src/assets/server_package/README.txt @@ -14,7 +14,7 @@ Mac: (brew install python3). Linux (x86_64): -- Server binaries are currently compiled against Ubuntu 20 LTS. +- Server binaries are currently compiled against Ubuntu 22 LTS. Raspberry Pi: - The server binary was compiled on a Raspberry Pi 4 running Raspbian Buster. diff --git a/src/ballistica/shared/ballistica.cc b/src/ballistica/shared/ballistica.cc index b1201f9b..4e3a9e8d 100644 --- a/src/ballistica/shared/ballistica.cc +++ b/src/ballistica/shared/ballistica.cc @@ -39,7 +39,7 @@ auto main(int argc, char** argv) -> int { namespace ballistica { // These are set automatically via script; don't modify them here. -const int kEngineBuildNumber = 21764; +const int kEngineBuildNumber = 21766; const char* kEngineVersion = "1.7.33"; const int kEngineApiVersion = 8; diff --git a/tests/test_efro/test_dataclassio.py b/tests/test_efro/test_dataclassio.py index 20e603cd..125613e3 100644 --- a/tests/test_efro/test_dataclassio.py +++ b/tests/test_efro/test_dataclassio.py @@ -5,6 +5,7 @@ from __future__ import annotations +import copy import datetime from enum import Enum from dataclasses import field, dataclass @@ -1159,6 +1160,7 @@ class MTTestClass2(MTTestBase): def test_multi_type() -> None: """Test IOMultiType stuff.""" # pylint: disable=too-many-locals + # pylint: disable=too-many-statements # Test converting single instances back and forth. val1: MTTestBase = MTTestClass1(ival=123) @@ -1179,6 +1181,17 @@ def test_multi_type() -> None: assert dataclass_from_dict(MTTestBase, outdict) == val1 assert dataclass_from_dict(MTTestBase, outdict2) == val2 + # Trying to load as a multi-type should fail if there is no type + # value present. + outdictmod = copy.deepcopy(outdict) + del outdictmod[tpname] + with pytest.raises(ValueError): + dataclass_from_dict(MTTestBase, outdictmod) + + # However it should work when loading an exact type. This can be + # necessary to gracefully upgrade old data to multi-type form. + dataclass_from_dict(MTTestClass1, outdictmod) + # Now test our multi-type embedded in other classes. We should be # able to throw a mix of things in there and have them deserialize # back the types we started with. @@ -1253,3 +1266,33 @@ def test_multi_type() -> None: outdict = dataclass_to_dict(container5) container5b = dataclass_from_dict(_TestContainerClass5, outdict) assert container5 == container5b + + # Optionals. + + @ioprepped + @dataclass + class _TestContainerClass6: + obj: MTTestBase | None + + container6 = _TestContainerClass6(obj=None) + outdict = dataclass_to_dict(container6) + container6b = dataclass_from_dict(_TestContainerClass6, outdict) + assert container6 == container6b + + container6 = _TestContainerClass6(obj=MTTestClass2('fwr')) + outdict = dataclass_to_dict(container6) + container6b = dataclass_from_dict(_TestContainerClass6, outdict) + assert container6 == container6b + + @ioprepped + @dataclass + class _TestContainerClass7: + obj: Annotated[ + MTTestBase | None, + IOAttrs('o', soft_default=None), + ] + + container7 = _TestContainerClass7(obj=None) + outdict = dataclass_to_dict(container7) + container7b = dataclass_from_dict(_TestContainerClass7, {}) + assert container7 == container7b diff --git a/tools/efro/dataclassio/_base.py b/tools/efro/dataclassio/_base.py index c1ba8841..eda3243e 100644 --- a/tools/efro/dataclassio/_base.py +++ b/tools/efro/dataclassio/_base.py @@ -69,16 +69,21 @@ class IOMultiType(Generic[EnumT]): This enables usage of high level base classes (for example a 'Message' type) in dataclasses, with dataclassio automatically - serializing/deserializing subclass instances using provided - per-class type-ids. + serializing & deserializing subclass instances based on their + type. - See tests/test_efro/test_dataclassio.py for an example of this. + Standard usage involves creating a class which inherits from this + one that acts as a 'registry', and then creating dataclass classes + inheriting from that registry class. Dataclassio will then do the + right thing when that registry class is used in type annotations. + + See tests/test_efro/test_dataclassio.py for examples. """ # Dataclasses inheriting from an IOMultiType will store a type-id # with this key in their serialized data. This value can be # overridden in IOMultiType subclasses in case of conflicts. - ID_STORAGE_NAME = '_iotype' + ID_STORAGE_NAME = '_dciotype' @classmethod def get_type(cls, type_id: EnumT) -> type[Self]: diff --git a/tools/efro/dataclassio/_inputter.py b/tools/efro/dataclassio/_inputter.py index d6627b25..0e19cba3 100644 --- a/tools/efro/dataclassio/_inputter.py +++ b/tools/efro/dataclassio/_inputter.py @@ -64,9 +64,15 @@ class _Inputter: outcls: type[Any] - # If we're dealing with a multi-type class, figure out the - # top level type we're going to. - if issubclass(self._cls, IOMultiType): + # If we're dealing with a multi-type subclass which is NOT a + # dataclass, we must rely on its stored type to figure out + # what type of dataclass we're going to. If we are a dataclass + # then we already know what type we're going to so we can + # survive without this, which is often necessary when reading + # old data that doesn't have a type id attr yet. + if issubclass(self._cls, IOMultiType) and not dataclasses.is_dataclass( + self._cls + ): type_id_val = values.get(self._cls.ID_STORAGE_NAME) if type_id_val is None: raise ValueError( @@ -265,7 +271,7 @@ class _Inputter: args: dict[str, Any] = {} for rawkey, value in values.items(): - # Ignore _iotype or whatnot. + # Ignore _dciotype or whatnot. if type_id_store_name is not None and rawkey == type_id_store_name: continue From 37588433bc6e15595bc167a46407bbc0d27611dc Mon Sep 17 00:00:00 2001 From: Eric Date: Tue, 6 Feb 2024 11:01:57 -0800 Subject: [PATCH 7/7] langs and misc library work --- .efrocachemap | 92 +++++++++---------- Makefile | 5 +- src/assets/ba_data/python/babase/_meta.py | 6 +- tests/test_efro/test_message.py | 60 +++++-------- tools/bacommon/bacloud.py | 12 +-- tools/bacommon/net.py | 6 +- tools/bacommon/servermanager.py | 6 +- tools/batools/build.py | 6 +- tools/efro/call.py | 105 ++++++++-------------- tools/efro/dataclassio/__init__.py | 25 ++++-- tools/efro/dataclassio/_api.py | 40 +++------ tools/efro/dataclassio/_base.py | 15 ++-- tools/efro/dataclassio/_outputter.py | 11 ++- tools/efro/debug.py | 8 +- tools/efro/log.py | 16 ++-- tools/efro/message/_protocol.py | 6 +- tools/efro/message/_receiver.py | 13 +-- tools/efro/message/_sender.py | 24 ++--- tools/efro/terminal.py | 4 +- tools/efro/util.py | 3 +- tools/efrotools/__init__.py | 6 +- tools/efrotools/pcommand.py | 8 +- tools/efrotools/sync.py | 1 - tools/efrotools/toolconfig.py | 1 - 24 files changed, 203 insertions(+), 276 deletions(-) diff --git a/.efrocachemap b/.efrocachemap index f8c75782..9f55a5f5 100644 --- a/.efrocachemap +++ b/.efrocachemap @@ -421,7 +421,7 @@ "build/assets/ba_data/audio/zoeOw.ogg": "74befe45a8417e95b6a2233c51992a26", "build/assets/ba_data/audio/zoePickup01.ogg": "48ab8cddfcde36a750856f3f81dd20c8", "build/assets/ba_data/audio/zoeScream01.ogg": "2b468aedfa8741090247f04eb9e6df55", - "build/assets/ba_data/data/langdata.json": "750e45f2f19a94a44703e3d31b9a8e96", + "build/assets/ba_data/data/langdata.json": "831b83240126d0a851104f4148712ed1", "build/assets/ba_data/data/languages/arabic.json": "0db32e21b6d5337ccca478381744aa88", "build/assets/ba_data/data/languages/belarussian.json": "a112dfca3e188387516788bd8229c5b0", "build/assets/ba_data/data/languages/chinese.json": "1360ffde06828b63ce4fe956c3c3cd1d", @@ -456,7 +456,7 @@ "build/assets/ba_data/data/languages/thai.json": "9c425b420f0488a7f883da98947657ad", "build/assets/ba_data/data/languages/turkish.json": "2be25c89ca754341f27750e0d595f31e", "build/assets/ba_data/data/languages/ukrainian.json": "b54a38e93deebafa5706ba2d1f626892", - "build/assets/ba_data/data/languages/venetian.json": "8e9714d98a85e428ce3543fc49188a46", + "build/assets/ba_data/data/languages/venetian.json": "f896fc3df13a42f1bef8813ca80b1a09", "build/assets/ba_data/data/languages/vietnamese.json": "921cd1e50f60fe3e101f246e172750ba", "build/assets/ba_data/data/maps/big_g.json": "1dd301d490643088a435ce75df971054", "build/assets/ba_data/data/maps/bridgit.json": "6aea74805f4880cc11237c5734a24422", @@ -4060,50 +4060,50 @@ "build/assets/windows/Win32/ucrtbased.dll": "2def5335207d41b21b9823f6805997f1", "build/assets/windows/Win32/vc_redist.x86.exe": "b08a55e2e77623fe657bea24f223a3ae", "build/assets/windows/Win32/vcruntime140d.dll": "865b2af4d1e26a1a8073c89acb06e599", - "build/prefab/full/linux_arm64_gui/debug/ballisticakit": "7169141b846e3c15160f3405bd1ed2ce", - "build/prefab/full/linux_arm64_gui/release/ballisticakit": "04869210f06ff8c00fb6d68a69f6b335", - "build/prefab/full/linux_arm64_server/debug/dist/ballisticakit_headless": "e28eac17f30edddc35c483fbc4e69fc5", - "build/prefab/full/linux_arm64_server/release/dist/ballisticakit_headless": "342aee2d1f2965caed811a72888cc7f1", - "build/prefab/full/linux_x86_64_gui/debug/ballisticakit": "c091240edeeeac378ffe86ce1421decc", - "build/prefab/full/linux_x86_64_gui/release/ballisticakit": "c959d3661ea83a2f9920da6d6d355fd9", - "build/prefab/full/linux_x86_64_server/debug/dist/ballisticakit_headless": "9015fb2718d6fc5a9a9bd95b0086bde6", - "build/prefab/full/linux_x86_64_server/release/dist/ballisticakit_headless": "dfcd11db04c0071b7e5032673c2dad43", - "build/prefab/full/mac_arm64_gui/debug/ballisticakit": "8a0ad295f62fc9cfa4a71d30038b0c20", - "build/prefab/full/mac_arm64_gui/release/ballisticakit": "21f2f9aecbd0c60b8e125f206ebd44c2", - "build/prefab/full/mac_arm64_server/debug/dist/ballisticakit_headless": "df5d59cf4b6da427b3e2bb4d1136cf32", - "build/prefab/full/mac_arm64_server/release/dist/ballisticakit_headless": "72f5ab8cd24ce31b8bbfe08ce691bf7b", - "build/prefab/full/mac_x86_64_gui/debug/ballisticakit": "11280b6cbec7a21574f0e8e29c379bea", - "build/prefab/full/mac_x86_64_gui/release/ballisticakit": "766b8ad86046a92fa5fa25a0a7ad88ae", - "build/prefab/full/mac_x86_64_server/debug/dist/ballisticakit_headless": "10ac2e99587552edfc3eb089ea69ede4", - "build/prefab/full/mac_x86_64_server/release/dist/ballisticakit_headless": "8cd63147b79d8866af817d01dcc8f5eb", - "build/prefab/full/windows_x86_gui/debug/BallisticaKit.exe": "061de20725a847ac6ed327d8c2e5b905", - "build/prefab/full/windows_x86_gui/release/BallisticaKit.exe": "6556a6e96f2a360a4006f2c2b7a5a1f1", - "build/prefab/full/windows_x86_server/debug/dist/BallisticaKitHeadless.exe": "1324063eeaeda2c72f7e133984fa838b", - "build/prefab/full/windows_x86_server/release/dist/BallisticaKitHeadless.exe": "3c6b96c3a63fc53819425f8872264aa8", - "build/prefab/lib/linux_arm64_gui/debug/libballisticaplus.a": "8709ad96140d71760c2f493ee8bd7c43", - "build/prefab/lib/linux_arm64_gui/release/libballisticaplus.a": "ee829cd5488e9750570dc6f602d65589", - "build/prefab/lib/linux_arm64_server/debug/libballisticaplus.a": "8709ad96140d71760c2f493ee8bd7c43", - "build/prefab/lib/linux_arm64_server/release/libballisticaplus.a": "ee829cd5488e9750570dc6f602d65589", - "build/prefab/lib/linux_x86_64_gui/debug/libballisticaplus.a": "35fe69d96c154b97b534711dae9d8d3a", - "build/prefab/lib/linux_x86_64_gui/release/libballisticaplus.a": "2db876e543b3e93128ec421ea5cbb011", - "build/prefab/lib/linux_x86_64_server/debug/libballisticaplus.a": "35fe69d96c154b97b534711dae9d8d3a", - "build/prefab/lib/linux_x86_64_server/release/libballisticaplus.a": "2db876e543b3e93128ec421ea5cbb011", - "build/prefab/lib/mac_arm64_gui/debug/libballisticaplus.a": "417ea0f30d203d5de0e235550fcd7ab8", - "build/prefab/lib/mac_arm64_gui/release/libballisticaplus.a": "72d071e977c88454d0623c4a9fb34361", - "build/prefab/lib/mac_arm64_server/debug/libballisticaplus.a": "417ea0f30d203d5de0e235550fcd7ab8", - "build/prefab/lib/mac_arm64_server/release/libballisticaplus.a": "72d071e977c88454d0623c4a9fb34361", - "build/prefab/lib/mac_x86_64_gui/debug/libballisticaplus.a": "de1b228d95c47a7c296a853778715326", - "build/prefab/lib/mac_x86_64_gui/release/libballisticaplus.a": "79117cbfdf695298e1d9ae997d990c4d", - "build/prefab/lib/mac_x86_64_server/debug/libballisticaplus.a": "984f0990a8e4cca29a382d70e51cc051", - "build/prefab/lib/mac_x86_64_server/release/libballisticaplus.a": "79117cbfdf695298e1d9ae997d990c4d", - "build/prefab/lib/windows/Debug_Win32/BallisticaKitGenericPlus.lib": "810dd57e398827fb3abc488a4185a0b3", - "build/prefab/lib/windows/Debug_Win32/BallisticaKitGenericPlus.pdb": "c10f8fb6e748f6244753adef81ef5ed4", - "build/prefab/lib/windows/Debug_Win32/BallisticaKitHeadlessPlus.lib": "d30f36c9c925e52e94ef39afc8b0a35e", - "build/prefab/lib/windows/Debug_Win32/BallisticaKitHeadlessPlus.pdb": "88431c1a6372b951ce85c2c73bc7f8c5", - "build/prefab/lib/windows/Release_Win32/BallisticaKitGenericPlus.lib": "928e9fd64e81de0d43e433a4474826cb", - "build/prefab/lib/windows/Release_Win32/BallisticaKitGenericPlus.pdb": "ae0ce0dd3541770cb7bd93997aca3e04", - "build/prefab/lib/windows/Release_Win32/BallisticaKitHeadlessPlus.lib": "0de083bc720affcbab4fbf0c121a84fe", - "build/prefab/lib/windows/Release_Win32/BallisticaKitHeadlessPlus.pdb": "299be2aa45e5d943b56828f065911172", + "build/prefab/full/linux_arm64_gui/debug/ballisticakit": "d5a8312cd9cf65f32ca2a7c4a2063c03", + "build/prefab/full/linux_arm64_gui/release/ballisticakit": "aecb00e9044fa677583e1036fa7875d8", + "build/prefab/full/linux_arm64_server/debug/dist/ballisticakit_headless": "eca7f9ab892edfa7423a9d4a6f89e571", + "build/prefab/full/linux_arm64_server/release/dist/ballisticakit_headless": "99647f48362f84112d23a9bc89eaa983", + "build/prefab/full/linux_x86_64_gui/debug/ballisticakit": "31e21a64d77fc0834832b633a26d986b", + "build/prefab/full/linux_x86_64_gui/release/ballisticakit": "7c12b4078c3af6e627a4051b1c1d8370", + "build/prefab/full/linux_x86_64_server/debug/dist/ballisticakit_headless": "f7a66c48321efa4462e8eae6b72db2b2", + "build/prefab/full/linux_x86_64_server/release/dist/ballisticakit_headless": "08cdbeb2ca4fa8c996f3369680c4e5cd", + "build/prefab/full/mac_arm64_gui/debug/ballisticakit": "f92679bab5a0d057427962869e19f057", + "build/prefab/full/mac_arm64_gui/release/ballisticakit": "d5bcd695f84dab1ab32655989d399c9e", + "build/prefab/full/mac_arm64_server/debug/dist/ballisticakit_headless": "c766f437ece15dae0ee971e4c2e10a2d", + "build/prefab/full/mac_arm64_server/release/dist/ballisticakit_headless": "cbecc4c11b9aa4621abfdc996fecfd74", + "build/prefab/full/mac_x86_64_gui/debug/ballisticakit": "7af782c9d9bcf1396a15dea6f2493d70", + "build/prefab/full/mac_x86_64_gui/release/ballisticakit": "2c04f3f68db3e73e4aad4c656d956c00", + "build/prefab/full/mac_x86_64_server/debug/dist/ballisticakit_headless": "132c83ee8811828739601ac3d0599fe9", + "build/prefab/full/mac_x86_64_server/release/dist/ballisticakit_headless": "8de942a2e1ff96c147a9500a56ca4f64", + "build/prefab/full/windows_x86_gui/debug/BallisticaKit.exe": "6bf51ccbd01937bf1b28cfffe029d857", + "build/prefab/full/windows_x86_gui/release/BallisticaKit.exe": "c5f0d834a47852f1c240e17a6c933e0a", + "build/prefab/full/windows_x86_server/debug/dist/BallisticaKitHeadless.exe": "4f74b71dabd207bee732dc91c9a28dc4", + "build/prefab/full/windows_x86_server/release/dist/BallisticaKitHeadless.exe": "f48ab8e4c4d05f4b2231bebf33c965f1", + "build/prefab/lib/linux_arm64_gui/debug/libballisticaplus.a": "ee36a39fd0f524989cb68930c89c8868", + "build/prefab/lib/linux_arm64_gui/release/libballisticaplus.a": "dbed9145e5db116d92aa47cb9e98da39", + "build/prefab/lib/linux_arm64_server/debug/libballisticaplus.a": "ee36a39fd0f524989cb68930c89c8868", + "build/prefab/lib/linux_arm64_server/release/libballisticaplus.a": "dbed9145e5db116d92aa47cb9e98da39", + "build/prefab/lib/linux_x86_64_gui/debug/libballisticaplus.a": "dc078f11a4e93062adc7d210fd4f08fb", + "build/prefab/lib/linux_x86_64_gui/release/libballisticaplus.a": "a74bea3380d0fb39f78ac7b7598c1a72", + "build/prefab/lib/linux_x86_64_server/debug/libballisticaplus.a": "dc078f11a4e93062adc7d210fd4f08fb", + "build/prefab/lib/linux_x86_64_server/release/libballisticaplus.a": "a74bea3380d0fb39f78ac7b7598c1a72", + "build/prefab/lib/mac_arm64_gui/debug/libballisticaplus.a": "b397e020f33132c4dd2280cb1222cd14", + "build/prefab/lib/mac_arm64_gui/release/libballisticaplus.a": "ff0cb4db976707d25bd401bce80a4882", + "build/prefab/lib/mac_arm64_server/debug/libballisticaplus.a": "b397e020f33132c4dd2280cb1222cd14", + "build/prefab/lib/mac_arm64_server/release/libballisticaplus.a": "ff0cb4db976707d25bd401bce80a4882", + "build/prefab/lib/mac_x86_64_gui/debug/libballisticaplus.a": "c464accef921df1325459bdd10c59b84", + "build/prefab/lib/mac_x86_64_gui/release/libballisticaplus.a": "0896e849885cef50bcf33ce863efa7d2", + "build/prefab/lib/mac_x86_64_server/debug/libballisticaplus.a": "e53c808357cc0a2f0da7b870be147083", + "build/prefab/lib/mac_x86_64_server/release/libballisticaplus.a": "0896e849885cef50bcf33ce863efa7d2", + "build/prefab/lib/windows/Debug_Win32/BallisticaKitGenericPlus.lib": "e34cc55fd284e31d9ed1151c5a51bf34", + "build/prefab/lib/windows/Debug_Win32/BallisticaKitGenericPlus.pdb": "36cb65be158a0103d81c82d8a51dc8b6", + "build/prefab/lib/windows/Debug_Win32/BallisticaKitHeadlessPlus.lib": "21f8a61745c2fec88749299f5aeeeaf9", + "build/prefab/lib/windows/Debug_Win32/BallisticaKitHeadlessPlus.pdb": "d61272f101f87b140b84895e482b07f4", + "build/prefab/lib/windows/Release_Win32/BallisticaKitGenericPlus.lib": "36c30bcd93d38569b9515ed17896d8de", + "build/prefab/lib/windows/Release_Win32/BallisticaKitGenericPlus.pdb": "841c7cd3cc96c91ecd11335a91c0c465", + "build/prefab/lib/windows/Release_Win32/BallisticaKitHeadlessPlus.lib": "305aab4423bf510f6bf95fe0c996128f", + "build/prefab/lib/windows/Release_Win32/BallisticaKitHeadlessPlus.pdb": "f1066b8591d7859df76c8e976ceee2d5", "src/assets/ba_data/python/babase/_mgen/__init__.py": "f885fed7f2ed98ff2ba271f9dbe3391c", "src/assets/ba_data/python/babase/_mgen/enums.py": "b611c090513a21e2fe90e56582724e9d", "src/ballistica/base/mgen/pyembed/binding_base.inc": "72bfed2cce8ff19741989dec28302f3f", diff --git a/Makefile b/Makefile index d21ab3e5..ddd594fc 100644 --- a/Makefile +++ b/Makefile @@ -49,7 +49,7 @@ endif # Prereq targets that should be safe to run anytime; even if project-files # are out of date. PREREQS_SAFE = .cache/checkenv $(PCOMMANDBATCHBIN) .dir-locals.el .mypy.ini \ - .pyrightconfig.json .pycheckers .pylintrc .style.yapf .clang-format \ + .pyrightconfig.json .pylintrc .style.yapf .clang-format \ ballisticakit-cmake/.clang-format .editorconfig # Prereq targets that may break if the project needs updating should go here. @@ -1216,9 +1216,6 @@ ENV_SRC = $(PCOMMAND) tools/batools/build.py .pyrightconfig.json: config/toolconfigsrc/pyrightconfig.yaml $(TOOL_CFG_SRC) @$(TOOL_CFG_INST) $< $@ -.pycheckers: config/toolconfigsrc/pycheckers $(TOOL_CFG_SRC) - @$(TOOL_CFG_INST) $< $@ - # Set this to 1 to skip environment checks. SKIP_ENV_CHECKS ?= 0 diff --git a/src/assets/ba_data/python/babase/_meta.py b/src/assets/ba_data/python/babase/_meta.py index 904e354f..6e1224d8 100644 --- a/src/assets/ba_data/python/babase/_meta.py +++ b/src/assets/ba_data/python/babase/_meta.py @@ -288,14 +288,12 @@ class DirectoryScan: ) -> None: """Scan provided path and add module entries to provided list.""" try: - # Special case: let's save some time and skip the whole 'babase' - # package since we know it doesn't contain any meta tags. fullpath = Path(path, subpath) + # Note: skipping hidden dirs (starting with '.'). entries = [ (path, Path(subpath, name)) for name in os.listdir(fullpath) - # Actually scratch that for now; trying to avoid special cases. - # if name != 'babase' + if not name.startswith('.') ] except PermissionError: # Expected sometimes. diff --git a/tests/test_efro/test_message.py b/tests/test_efro/test_message.py index 7027dfe6..be5cf589 100644 --- a/tests/test_efro/test_message.py +++ b/tests/test_efro/test_message.py @@ -149,16 +149,13 @@ class _BoundTestMessageSenderSync(BoundMessageSender): """Protocol-specific bound sender.""" @overload - def send(self, message: _TMsg1) -> _TResp1: - ... + def send(self, message: _TMsg1) -> _TResp1: ... @overload - def send(self, message: _TMsg2) -> _TResp1 | _TResp2: - ... + def send(self, message: _TMsg2) -> _TResp1 | _TResp2: ... @overload - def send(self, message: _TMsg3) -> None: - ... + def send(self, message: _TMsg3) -> None: ... def send(self, message: Message) -> Response | None: """Send a message synchronously.""" @@ -188,16 +185,13 @@ class _BoundTestMessageSenderAsync(BoundMessageSender): """Protocol-specific bound sender.""" @overload - async def send_async(self, message: _TMsg1) -> _TResp1: - ... + async def send_async(self, message: _TMsg1) -> _TResp1: ... @overload - async def send_async(self, message: _TMsg2) -> _TResp1 | _TResp2: - ... + async def send_async(self, message: _TMsg2) -> _TResp1 | _TResp2: ... @overload - async def send_async(self, message: _TMsg3) -> None: - ... + async def send_async(self, message: _TMsg3) -> None: ... def send_async(self, message: Message) -> Awaitable[Response | None]: """Send a message asynchronously.""" @@ -227,40 +221,32 @@ class _BoundTestMessageSenderBBoth(BoundMessageSender): """Protocol-specific bound sender.""" @overload - def send(self, message: _TMsg1) -> _TResp1: - ... + def send(self, message: _TMsg1) -> _TResp1: ... @overload - def send(self, message: _TMsg2) -> _TResp1 | _TResp2: - ... + def send(self, message: _TMsg2) -> _TResp1 | _TResp2: ... @overload - def send(self, message: _TMsg3) -> None: - ... + def send(self, message: _TMsg3) -> None: ... @overload - def send(self, message: _TMsg4) -> None: - ... + def send(self, message: _TMsg4) -> None: ... def send(self, message: Message) -> Response | None: """Send a message synchronously.""" return self._sender.send(self._obj, message) @overload - async def send_async(self, message: _TMsg1) -> _TResp1: - ... + async def send_async(self, message: _TMsg1) -> _TResp1: ... @overload - async def send_async(self, message: _TMsg2) -> _TResp1 | _TResp2: - ... + async def send_async(self, message: _TMsg2) -> _TResp1 | _TResp2: ... @overload - async def send_async(self, message: _TMsg3) -> None: - ... + async def send_async(self, message: _TMsg3) -> None: ... @overload - async def send_async(self, message: _TMsg4) -> None: - ... + async def send_async(self, message: _TMsg4) -> None: ... def send_async(self, message: Message) -> Awaitable[Response | None]: """Send a message asynchronously.""" @@ -338,22 +324,19 @@ class _TestSyncMessageReceiver(MessageReceiver): def handler( self, call: Callable[[Any, _TMsg1], _TResp1], - ) -> Callable[[Any, _TMsg1], _TResp1]: - ... + ) -> Callable[[Any, _TMsg1], _TResp1]: ... @overload def handler( self, call: Callable[[Any, _TMsg2], _TResp1 | _TResp2], - ) -> Callable[[Any, _TMsg2], _TResp1 | _TResp2]: - ... + ) -> Callable[[Any, _TMsg2], _TResp1 | _TResp2]: ... @overload def handler( self, call: Callable[[Any, _TMsg3], None], - ) -> Callable[[Any, _TMsg3], None]: - ... + ) -> Callable[[Any, _TMsg3], None]: ... def handler(self, call: Callable) -> Callable: """Decorator to register message handlers.""" @@ -399,22 +382,19 @@ class _TestAsyncMessageReceiver(MessageReceiver): def handler( self, call: Callable[[Any, _TMsg1], Awaitable[_TResp1]], - ) -> Callable[[Any, _TMsg1], Awaitable[_TResp1]]: - ... + ) -> Callable[[Any, _TMsg1], Awaitable[_TResp1]]: ... @overload def handler( self, call: Callable[[Any, _TMsg2], Awaitable[_TResp1 | _TResp2]], - ) -> Callable[[Any, _TMsg2], Awaitable[_TResp1 | _TResp2]]: - ... + ) -> Callable[[Any, _TMsg2], Awaitable[_TResp1 | _TResp2]]: ... @overload def handler( self, call: Callable[[Any, _TMsg3], Awaitable[None]], - ) -> Callable[[Any, _TMsg3], Awaitable[None]]: - ... + ) -> Callable[[Any, _TMsg3], Awaitable[None]]: ... def handler(self, call: Callable) -> Callable: """Decorator to register message handlers.""" diff --git a/tools/bacommon/bacloud.py b/tools/bacommon/bacloud.py index 2f41f622..15f85ee5 100644 --- a/tools/bacommon/bacloud.py +++ b/tools/bacommon/bacloud.py @@ -75,9 +75,9 @@ class ResponseData: delay_seconds: Annotated[float, IOAttrs('d', store_default=False)] = 0.0 login: Annotated[str | None, IOAttrs('l', store_default=False)] = None logout: Annotated[bool, IOAttrs('lo', store_default=False)] = False - dir_manifest: Annotated[ - str | None, IOAttrs('man', store_default=False) - ] = None + dir_manifest: Annotated[str | None, IOAttrs('man', store_default=False)] = ( + None + ) uploads: Annotated[ tuple[list[str], str, dict] | None, IOAttrs('u', store_default=False) ] = None @@ -97,9 +97,9 @@ class ResponseData: input_prompt: Annotated[ tuple[str, bool] | None, IOAttrs('inp', store_default=False) ] = None - end_message: Annotated[ - str | None, IOAttrs('em', store_default=False) - ] = None + end_message: Annotated[str | None, IOAttrs('em', store_default=False)] = ( + None + ) end_message_end: Annotated[str, IOAttrs('eme', store_default=False)] = '\n' end_command: Annotated[ tuple[str, dict] | None, IOAttrs('ec', store_default=False) diff --git a/tools/bacommon/net.py b/tools/bacommon/net.py index 2cc97df1..d07f774a 100644 --- a/tools/bacommon/net.py +++ b/tools/bacommon/net.py @@ -63,9 +63,9 @@ class PrivateHostingConfig: randomize: bool = False tutorial: bool = False custom_team_names: tuple[str, str] | None = None - custom_team_colors: tuple[ - tuple[float, float, float], tuple[float, float, float] - ] | None = None + custom_team_colors: ( + tuple[tuple[float, float, float], tuple[float, float, float]] | None + ) = None playlist: list[dict[str, Any]] | None = None exit_minutes: float = 120.0 exit_minutes_unclean: float = 180.0 diff --git a/tools/bacommon/servermanager.py b/tools/bacommon/servermanager.py index 28ca0db5..0fe8e7d8 100644 --- a/tools/bacommon/servermanager.py +++ b/tools/bacommon/servermanager.py @@ -134,9 +134,9 @@ class ServerConfig: team_names: tuple[str, str] | None = None # Team colors (teams mode only). - team_colors: tuple[ - tuple[float, float, float], tuple[float, float, float] - ] | None = None + team_colors: ( + tuple[tuple[float, float, float], tuple[float, float, float]] | None + ) = None # Whether to enable the queue where players can line up before entering # your server. Disabling this can be used as a workaround to deal with diff --git a/tools/batools/build.py b/tools/batools/build.py index 1bc59689..72caf9e6 100644 --- a/tools/batools/build.py +++ b/tools/batools/build.py @@ -52,7 +52,7 @@ PY_REQUIREMENTS = [ PyRequirement(pipname='requests', minversion=[2, 31, 0]), PyRequirement(pipname='pdoc', minversion=[14, 4, 0]), PyRequirement(pipname='PyYAML', minversion=[6, 0, 1]), - PyRequirement(pipname='black', minversion=[23, 12, 1]), + PyRequirement(pipname='black', minversion=[24, 1, 1]), PyRequirement(pipname='typing_extensions', minversion=[4, 9, 0]), PyRequirement(pipname='types-filelock', minversion=[3, 2, 7]), PyRequirement(pipname='types-requests', minversion=[2, 31, 0, 20240106]), @@ -614,7 +614,7 @@ def _get_server_config_template_yaml(projroot: str) -> str: # Ignore indented lines (our few multi-line special cases). continue - if line.startswith(']'): + if line.startswith(']') or line.startswith(')'): # Ignore closing lines (our few multi-line special cases). continue @@ -643,7 +643,7 @@ def _get_server_config_template_yaml(projroot: str) -> str: before_equal_sign = before_equal_sign.strip() vval_raw = vval_raw.strip() vname = before_equal_sign.split()[0] - assert vname.endswith(':') + assert vname.endswith(':'), f"'{vname}' does not end with ':'" vname = vname[:-1] vval: Any if vval_raw == 'field(default_factory=list)': diff --git a/tools/efro/call.py b/tools/efro/call.py index 8e811e50..933f3f0b 100644 --- a/tools/efro/call.py +++ b/tools/efro/call.py @@ -83,57 +83,46 @@ if TYPE_CHECKING: class _CallNoArgs(Generic[OutT]): """Single argument variant of call wrapper.""" - def __init__(self, _call: Callable[[], OutT]): - ... + def __init__(self, _call: Callable[[], OutT]): ... - def __call__(self) -> OutT: - ... + def __call__(self) -> OutT: ... class _Call1Arg(Generic[In1T, OutT]): """Single argument variant of call wrapper.""" - def __init__(self, _call: Callable[[In1T], OutT]): - ... + def __init__(self, _call: Callable[[In1T], OutT]): ... - def __call__(self, _arg1: In1T) -> OutT: - ... + def __call__(self, _arg1: In1T) -> OutT: ... class _Call2Args(Generic[In1T, In2T, OutT]): """Two argument variant of call wrapper""" - def __init__(self, _call: Callable[[In1T, In2T], OutT]): - ... + def __init__(self, _call: Callable[[In1T, In2T], OutT]): ... - def __call__(self, _arg1: In1T, _arg2: In2T) -> OutT: - ... + def __call__(self, _arg1: In1T, _arg2: In2T) -> OutT: ... class _Call3Args(Generic[In1T, In2T, In3T, OutT]): """Three argument variant of call wrapper""" - def __init__(self, _call: Callable[[In1T, In2T, In3T], OutT]): - ... + def __init__(self, _call: Callable[[In1T, In2T, In3T], OutT]): ... - def __call__(self, _arg1: In1T, _arg2: In2T, _arg3: In3T) -> OutT: - ... + def __call__(self, _arg1: In1T, _arg2: In2T, _arg3: In3T) -> OutT: ... class _Call4Args(Generic[In1T, In2T, In3T, In4T, OutT]): """Four argument variant of call wrapper""" - def __init__(self, _call: Callable[[In1T, In2T, In3T, In4T], OutT]): - ... + def __init__(self, _call: Callable[[In1T, In2T, In3T, In4T], OutT]): ... def __call__( self, _arg1: In1T, _arg2: In2T, _arg3: In3T, _arg4: In4T - ) -> OutT: - ... + ) -> OutT: ... class _Call5Args(Generic[In1T, In2T, In3T, In4T, In5T, OutT]): """Five argument variant of call wrapper""" def __init__( self, _call: Callable[[In1T, In2T, In3T, In4T, In5T], OutT] - ): - ... + ): ... def __call__( self, @@ -142,16 +131,14 @@ if TYPE_CHECKING: _arg3: In3T, _arg4: In4T, _arg5: In5T, - ) -> OutT: - ... + ) -> OutT: ... class _Call6Args(Generic[In1T, In2T, In3T, In4T, In5T, In6T, OutT]): """Six argument variant of call wrapper""" def __init__( self, _call: Callable[[In1T, In2T, In3T, In4T, In5T, In6T], OutT] - ): - ... + ): ... def __call__( self, @@ -161,8 +148,7 @@ if TYPE_CHECKING: _arg4: In4T, _arg5: In5T, _arg6: In6T, - ) -> OutT: - ... + ) -> OutT: ... class _Call7Args(Generic[In1T, In2T, In3T, In4T, In5T, In6T, In7T, OutT]): """Seven argument variant of call wrapper""" @@ -170,8 +156,7 @@ if TYPE_CHECKING: def __init__( self, _call: Callable[[In1T, In2T, In3T, In4T, In5T, In6T, In7T], OutT], - ): - ... + ): ... def __call__( self, @@ -182,50 +167,43 @@ if TYPE_CHECKING: _arg5: In5T, _arg6: In6T, _arg7: In7T, - ) -> OutT: - ... + ) -> OutT: ... # No arg call; no args bundled. # noinspection PyPep8Naming @overload - def Call(call: Callable[[], OutT]) -> _CallNoArgs[OutT]: - ... + def Call(call: Callable[[], OutT]) -> _CallNoArgs[OutT]: ... # 1 arg call; 1 arg bundled. # noinspection PyPep8Naming @overload - def Call(call: Callable[[In1T], OutT], arg1: In1T) -> _CallNoArgs[OutT]: - ... + def Call(call: Callable[[In1T], OutT], arg1: In1T) -> _CallNoArgs[OutT]: ... # 1 arg call; no args bundled. # noinspection PyPep8Naming @overload - def Call(call: Callable[[In1T], OutT]) -> _Call1Arg[In1T, OutT]: - ... + def Call(call: Callable[[In1T], OutT]) -> _Call1Arg[In1T, OutT]: ... # 2 arg call; 2 args bundled. # noinspection PyPep8Naming @overload def Call( call: Callable[[In1T, In2T], OutT], arg1: In1T, arg2: In2T - ) -> _CallNoArgs[OutT]: - ... + ) -> _CallNoArgs[OutT]: ... # 2 arg call; 1 arg bundled. # noinspection PyPep8Naming @overload def Call( call: Callable[[In1T, In2T], OutT], arg1: In1T - ) -> _Call1Arg[In2T, OutT]: - ... + ) -> _Call1Arg[In2T, OutT]: ... # 2 arg call; no args bundled. # noinspection PyPep8Naming @overload def Call( call: Callable[[In1T, In2T], OutT] - ) -> _Call2Args[In1T, In2T, OutT]: - ... + ) -> _Call2Args[In1T, In2T, OutT]: ... # 3 arg call; 3 args bundled. # noinspection PyPep8Naming @@ -235,32 +213,28 @@ if TYPE_CHECKING: arg1: In1T, arg2: In2T, arg3: In3T, - ) -> _CallNoArgs[OutT]: - ... + ) -> _CallNoArgs[OutT]: ... # 3 arg call; 2 args bundled. # noinspection PyPep8Naming @overload def Call( call: Callable[[In1T, In2T, In3T], OutT], arg1: In1T, arg2: In2T - ) -> _Call1Arg[In3T, OutT]: - ... + ) -> _Call1Arg[In3T, OutT]: ... # 3 arg call; 1 arg bundled. # noinspection PyPep8Naming @overload def Call( call: Callable[[In1T, In2T, In3T], OutT], arg1: In1T - ) -> _Call2Args[In2T, In3T, OutT]: - ... + ) -> _Call2Args[In2T, In3T, OutT]: ... # 3 arg call; no args bundled. # noinspection PyPep8Naming @overload def Call( call: Callable[[In1T, In2T, In3T], OutT] - ) -> _Call3Args[In1T, In2T, In3T, OutT]: - ... + ) -> _Call3Args[In1T, In2T, In3T, OutT]: ... # 4 arg call; 4 args bundled. # noinspection PyPep8Naming @@ -271,8 +245,7 @@ if TYPE_CHECKING: arg2: In2T, arg3: In3T, arg4: In4T, - ) -> _CallNoArgs[OutT]: - ... + ) -> _CallNoArgs[OutT]: ... # 4 arg call; 3 args bundled. # noinspection PyPep8Naming @@ -282,8 +255,7 @@ if TYPE_CHECKING: arg1: In1T, arg2: In2T, arg3: In3T, - ) -> _Call1Arg[In4T, OutT]: - ... + ) -> _Call1Arg[In4T, OutT]: ... # 4 arg call; 2 args bundled. # noinspection PyPep8Naming @@ -292,8 +264,7 @@ if TYPE_CHECKING: call: Callable[[In1T, In2T, In3T, In4T], OutT], arg1: In1T, arg2: In2T, - ) -> _Call2Args[In3T, In4T, OutT]: - ... + ) -> _Call2Args[In3T, In4T, OutT]: ... # 4 arg call; 1 arg bundled. # noinspection PyPep8Naming @@ -301,16 +272,14 @@ if TYPE_CHECKING: def Call( call: Callable[[In1T, In2T, In3T, In4T], OutT], arg1: In1T, - ) -> _Call3Args[In2T, In3T, In4T, OutT]: - ... + ) -> _Call3Args[In2T, In3T, In4T, OutT]: ... # 4 arg call; no args bundled. # noinspection PyPep8Naming @overload def Call( call: Callable[[In1T, In2T, In3T, In4T], OutT], - ) -> _Call4Args[In1T, In2T, In3T, In4T, OutT]: - ... + ) -> _Call4Args[In1T, In2T, In3T, In4T, OutT]: ... # 5 arg call; 5 args bundled. # noinspection PyPep8Naming @@ -322,8 +291,7 @@ if TYPE_CHECKING: arg3: In3T, arg4: In4T, arg5: In5T, - ) -> _CallNoArgs[OutT]: - ... + ) -> _CallNoArgs[OutT]: ... # 6 arg call; 6 args bundled. # noinspection PyPep8Naming @@ -336,8 +304,7 @@ if TYPE_CHECKING: arg4: In4T, arg5: In5T, arg6: In6T, - ) -> _CallNoArgs[OutT]: - ... + ) -> _CallNoArgs[OutT]: ... # 7 arg call; 7 args bundled. # noinspection PyPep8Naming @@ -351,12 +318,10 @@ if TYPE_CHECKING: arg5: In5T, arg6: In6T, arg7: In7T, - ) -> _CallNoArgs[OutT]: - ... + ) -> _CallNoArgs[OutT]: ... # noinspection PyPep8Naming - def Call(*_args: Any, **_keywds: Any) -> Any: - ... + def Call(*_args: Any, **_keywds: Any) -> Any: ... # (Type-safe Partial) # A convenient wrapper around functools.partial which adds type-safety diff --git a/tools/efro/dataclassio/__init__.py b/tools/efro/dataclassio/__init__.py index 9c6ae98a..eae9c820 100644 --- a/tools/efro/dataclassio/__init__.py +++ b/tools/efro/dataclassio/__init__.py @@ -11,7 +11,13 @@ data formats in a nondestructive manner. from __future__ import annotations from efro.util import set_canonical_module_names -from efro.dataclassio._base import Codec, IOAttrs, IOExtendedData, IOMultiType +from efro.dataclassio._base import ( + Codec, + IOAttrs, + IOExtendedData, + IOMultiType, + EXTRA_ATTRS_ATTR, +) from efro.dataclassio._prep import ( ioprep, ioprepped, @@ -29,21 +35,22 @@ from efro.dataclassio._api import ( ) __all__ = [ - 'JsonStyle', 'Codec', + 'DataclassFieldLookup', + 'EXTRA_ATTRS_ATTR', 'IOAttrs', 'IOExtendedData', 'IOMultiType', - 'ioprep', - 'ioprepped', - 'will_ioprep', - 'is_ioprepped_dataclass', - 'DataclassFieldLookup', - 'dataclass_to_dict', - 'dataclass_to_json', + 'JsonStyle', 'dataclass_from_dict', 'dataclass_from_json', + 'dataclass_to_dict', + 'dataclass_to_json', 'dataclass_validate', + 'ioprep', + 'ioprepped', + 'is_ioprepped_dataclass', + 'will_ioprep', ] # Have these things present themselves cleanly as 'thismodule.SomeClass' diff --git a/tools/efro/dataclassio/_api.py b/tools/efro/dataclassio/_api.py index 2fa308fa..0bd5f895 100644 --- a/tools/efro/dataclassio/_api.py +++ b/tools/efro/dataclassio/_api.py @@ -91,28 +91,6 @@ def dataclass_to_json( return json.dumps(jdict, separators=(',', ':'), sort_keys=sort_keys) -# @overload -# def dataclass_from_dict( -# cls: type[T], -# values: dict, -# codec: Codec = Codec.JSON, -# coerce_to_float: bool = True, -# allow_unknown_attrs: bool = True, -# discard_unknown_attrs: bool = False, -# ) -> T: ... - - -# @overload -# def dataclass_from_dict( -# cls: IOTypeMap, -# values: dict, -# codec: Codec = Codec.JSON, -# coerce_to_float: bool = True, -# allow_unknown_attrs: bool = True, -# discard_unknown_attrs: bool = False, -# ) -> Any: ... - - def dataclass_from_dict( cls: type[T], values: dict, @@ -125,24 +103,26 @@ def dataclass_from_dict( The dict must be formatted to match the specified codec (generally json-friendly object types). This means that sequence values such as - tuples or sets should be passed as lists, enums should be passed as their - associated values, nested dataclasses should be passed as dicts, etc. + tuples or sets should be passed as lists, enums should be passed as + their associated values, nested dataclasses should be passed as dicts, + etc. All values are checked to ensure their types/values are valid. Data for attributes of type Any will be checked to ensure they match types supported directly by json. This does not include types such as tuples which are implicitly translated by Python's json module - (as this would break the ability to do a lossless round-trip with data). + (as this would break the ability to do a lossless round-trip with + data). If coerce_to_float is True, int values passed for float typed fields will be converted to float values. Otherwise, a TypeError is raised. - If allow_unknown_attrs is False, AttributeErrors will be raised for - attributes present in the dict but not on the data class. Otherwise, they - will be preserved as part of the instance and included if it is - exported back to a dict, unless discard_unknown_attrs is True, in which - case they will simply be discarded. + If `allow_unknown_attrs` is False, AttributeErrors will be raised for + attributes present in the dict but not on the data class. Otherwise, + they will be preserved as part of the instance and included if it is + exported back to a dict, unless `discard_unknown_attrs` is True, in + which case they will simply be discarded. """ val = _Inputter( cls, diff --git a/tools/efro/dataclassio/_base.py b/tools/efro/dataclassio/_base.py index eda3243e..d2edc2f8 100644 --- a/tools/efro/dataclassio/_base.py +++ b/tools/efro/dataclassio/_base.py @@ -19,8 +19,9 @@ if TYPE_CHECKING: # Types which we can pass through as-is. SIMPLE_TYPES = {int, bool, str, float, type(None)} -# Attr name for dict of extra attributes included on dataclass instances. -# Note that this is only added if extra attributes are present. +# Attr name for dict of extra attributes included on dataclass +# instances. Note that this is only added if extra attributes are +# present. EXTRA_ATTRS_ATTR = '_DCIOEXATTRS' @@ -68,12 +69,12 @@ class IOMultiType(Generic[EnumT]): """A base class for types that can map to multiple dataclass types. This enables usage of high level base classes (for example - a 'Message' type) in dataclasses, with dataclassio automatically - serializing & deserializing subclass instances based on their - type. + a 'Message' type) in annotations, with dataclassio automatically + serializing & deserializing dataclass subclasses based on their + type ('MessagePing', 'MessageChat', etc.) Standard usage involves creating a class which inherits from this - one that acts as a 'registry', and then creating dataclass classes + one which acts as a 'registry', and then creating dataclass classes inheriting from that registry class. Dataclassio will then do the right thing when that registry class is used in type annotations. @@ -82,7 +83,7 @@ class IOMultiType(Generic[EnumT]): # Dataclasses inheriting from an IOMultiType will store a type-id # with this key in their serialized data. This value can be - # overridden in IOMultiType subclasses in case of conflicts. + # overridden in IOMultiType subclasses as desired. ID_STORAGE_NAME = '_dciotype' @classmethod diff --git a/tools/efro/dataclassio/_outputter.py b/tools/efro/dataclassio/_outputter.py index 198ad93e..216b11d9 100644 --- a/tools/efro/dataclassio/_outputter.py +++ b/tools/efro/dataclassio/_outputter.py @@ -72,6 +72,7 @@ class _Outputter: def _process_dataclass(self, cls: type, obj: Any, fieldpath: str) -> Any: # pylint: disable=too-many-locals # pylint: disable=too-many-branches + # pylint: disable=too-many-statements prep = PrepSession(explicit=False).prep_dataclass( type(obj), recursion_level=0 ) @@ -146,8 +147,16 @@ class _Outputter: # If this obj inherits from multi-type, store its type id. if isinstance(obj, IOMultiType): type_id = obj.get_type_id() - # Sanity checks; make sure looking up this id gets us this type. + + # Sanity checks; make sure looking up this id gets us this + # type. assert isinstance(type_id.value, str) + if obj.get_type(type_id) is not type(obj): + raise RuntimeError( + f'dataclassio: object of type {type(obj)}' + f' gives type-id {type_id} but that id gives type' + f' {obj.get_type(type_id)}. Something is out of sync.' + ) assert obj.get_type(type_id) is type(obj) if self._create: assert out is not None diff --git a/tools/efro/debug.py b/tools/efro/debug.py index 438a84e6..1f9b8b90 100644 --- a/tools/efro/debug.py +++ b/tools/efro/debug.py @@ -278,9 +278,7 @@ def _desc(obj: Any) -> str: tpss = ( f', contains [{tpsj}, ...]' if len(obj) > 3 - else f', contains [{tpsj}]' - if tps - else '' + else f', contains [{tpsj}]' if tps else '' ) extra = f' (len {len(obj)}{tpss})' elif isinstance(obj, dict): @@ -299,9 +297,7 @@ def _desc(obj: Any) -> str: pairss = ( f', contains {{{pairsj}, ...}}' if len(obj) > 3 - else f', contains {{{pairsj}}}' - if pairs - else '' + else f', contains {{{pairsj}}}' if pairs else '' ) extra = f' (len {len(obj)}{pairss})' if extra is None: diff --git a/tools/efro/log.py b/tools/efro/log.py index 680d94e8..e33e10a1 100644 --- a/tools/efro/log.py +++ b/tools/efro/log.py @@ -92,9 +92,9 @@ class LogEntry: # incorporated into custom log processing. To populate this, our # LogHandler class looks for a 'labels' dict passed in the optional # 'extra' dict arg to standard Python log calls. - labels: Annotated[ - dict[str, str], IOAttrs('la', store_default=False) - ] = field(default_factory=dict) + labels: Annotated[dict[str, str], IOAttrs('la', store_default=False)] = ( + field(default_factory=dict) + ) @ioprepped @@ -483,11 +483,11 @@ class LogHandler(logging.Handler): # after a short bit if we never get a newline. ship_task = self._file_chunk_ship_task[name] if ship_task is None: - self._file_chunk_ship_task[ - name - ] = self._event_loop.create_task( - self._ship_chunks_task(name), - name='log ship file chunks', + self._file_chunk_ship_task[name] = ( + self._event_loop.create_task( + self._ship_chunks_task(name), + name='log ship file chunks', + ) ) except Exception: diff --git a/tools/efro/message/_protocol.py b/tools/efro/message/_protocol.py index 8daa8d88..57dd80a2 100644 --- a/tools/efro/message/_protocol.py +++ b/tools/efro/message/_protocol.py @@ -499,8 +499,7 @@ class MessageProtocol: f' @overload\n' f' {pfx}def send{sfx}(self,' f' message: {msgtypevar})' - f' -> {rtypevar}:\n' - f' ...\n' + f' -> {rtypevar}: ...\n' ) rtypevar = 'Response | None' if async_pass: @@ -607,8 +606,7 @@ class MessageProtocol: f' call: Callable[[Any, {msgtypevar}], ' f'{rtypevar}],\n' f' )' - f' -> Callable[[Any, {msgtypevar}], {rtypevar}]:\n' - f' ...\n' + f' -> Callable[[Any, {msgtypevar}], {rtypevar}]: ...\n' ) out += ( '\n' diff --git a/tools/efro/message/_receiver.py b/tools/efro/message/_receiver.py index f8c38783..8ef6e8b0 100644 --- a/tools/efro/message/_receiver.py +++ b/tools/efro/message/_receiver.py @@ -55,12 +55,13 @@ class MessageReceiver: def __init__(self, protocol: MessageProtocol) -> None: self.protocol = protocol self._handlers: dict[type[Message], Callable] = {} - self._decode_filter_call: Callable[ - [Any, dict, Message], None - ] | None = None - self._encode_filter_call: Callable[ - [Any, Message | None, Response | SysResponse, dict], None - ] | None = None + self._decode_filter_call: ( + Callable[[Any, dict, Message], None] | None + ) = None + self._encode_filter_call: ( + Callable[[Any, Message | None, Response | SysResponse, dict], None] + | None + ) = None # noinspection PyProtectedMember def register_handler( diff --git a/tools/efro/message/_sender.py b/tools/efro/message/_sender.py index c1f9d00c..b7e18755 100644 --- a/tools/efro/message/_sender.py +++ b/tools/efro/message/_sender.py @@ -41,18 +41,18 @@ class MessageSender: def __init__(self, protocol: MessageProtocol) -> None: self.protocol = protocol self._send_raw_message_call: Callable[[Any, str], str] | None = None - self._send_async_raw_message_call: Callable[ - [Any, str], Awaitable[str] - ] | None = None - self._send_async_raw_message_ex_call: Callable[ - [Any, str, Message], Awaitable[str] - ] | None = None - self._encode_filter_call: Callable[ - [Any, Message, dict], None - ] | None = None - self._decode_filter_call: Callable[ - [Any, Message, dict, Response | SysResponse], None - ] | None = None + self._send_async_raw_message_call: ( + Callable[[Any, str], Awaitable[str]] | None + ) = None + self._send_async_raw_message_ex_call: ( + Callable[[Any, str, Message], Awaitable[str]] | None + ) = None + self._encode_filter_call: ( + Callable[[Any, Message, dict], None] | None + ) = None + self._decode_filter_call: ( + Callable[[Any, Message, dict, Response | SysResponse], None] | None + ) = None self._peer_desc_call: Callable[[Any], str] | None = None def send_method( diff --git a/tools/efro/terminal.py b/tools/efro/terminal.py index 7b84c658..6d8cd745 100644 --- a/tools/efro/terminal.py +++ b/tools/efro/terminal.py @@ -317,8 +317,6 @@ _envval = os.environ.get('EFRO_TERMCOLORS') color_enabled: bool = ( True if _envval == '1' - else False - if _envval == '0' - else _default_color_enabled() + else False if _envval == '0' else _default_color_enabled() ) Clr: type[ClrBase] = ClrAlways if color_enabled else ClrNever diff --git a/tools/efro/util.py b/tools/efro/util.py index f5815429..5fc5b3ec 100644 --- a/tools/efro/util.py +++ b/tools/efro/util.py @@ -459,8 +459,7 @@ if TYPE_CHECKING: class ValueDispatcherMethod(Generic[ValT, RetT]): """Used by the valuedispatchmethod decorator.""" - def __call__(self, value: ValT) -> RetT: - ... + def __call__(self, value: ValT) -> RetT: ... def register( self, value: ValT diff --git a/tools/efrotools/__init__.py b/tools/efrotools/__init__.py index 1c3bbd45..33cc1aa5 100644 --- a/tools/efrotools/__init__.py +++ b/tools/efrotools/__init__.py @@ -105,13 +105,11 @@ def extract_flag(args: list[str], name: str) -> bool: @overload def extract_arg( args: list[str], name: str, required: Literal[False] = False -) -> str | None: - ... +) -> str | None: ... @overload -def extract_arg(args: list[str], name: str, required: Literal[True]) -> str: - ... +def extract_arg(args: list[str], name: str, required: Literal[True]) -> str: ... def extract_arg( diff --git a/tools/efrotools/pcommand.py b/tools/efrotools/pcommand.py index 43fb1be8..ace1aab8 100644 --- a/tools/efrotools/pcommand.py +++ b/tools/efrotools/pcommand.py @@ -120,9 +120,11 @@ def clientprint( assert _g_thread_local_storage is not None print( *args, - file=_g_thread_local_storage.stderr - if stderr - else _g_thread_local_storage.stdout, + file=( + _g_thread_local_storage.stderr + if stderr + else _g_thread_local_storage.stdout + ), end=end, ) else: diff --git a/tools/efrotools/sync.py b/tools/efrotools/sync.py index 28e2ecc6..71cf7ddd 100644 --- a/tools/efrotools/sync.py +++ b/tools/efrotools/sync.py @@ -39,7 +39,6 @@ def _valid_filename(fname: str) -> bool: 'requirements.txt', 'pylintrc', 'clang-format', - 'pycheckers', 'style.yapf', 'test_task_bin', '.editorconfig', diff --git a/tools/efrotools/toolconfig.py b/tools/efrotools/toolconfig.py index 82690847..bb993a5c 100644 --- a/tools/efrotools/toolconfig.py +++ b/tools/efrotools/toolconfig.py @@ -47,7 +47,6 @@ def install_tool_config(projroot: Path, src: Path, dst: Path) -> None: comment = ';;' elif dst.name in [ '.mypy.ini', - '.pycheckers', '.pylintrc', '.style.yapf', '.clang-format',