Thanks to Ryan DowlingSoka for this contribution.
#rb Jamie.Dale
#jira None
#preflight 63110a8e043c42d592cc82b6
[CL 21746103 by Patrick Laflamme in ue5-main branch]
Custom excepthooks can be installed in Python to be invoked when an exception is
raised:
https://docs.python.org/3/library/sys.html#sys.excepthook
The excepthook is expected to take three arguments: the exception class, an
exception instance, and a traceback object.
The PythonScriptPlugin has some handling to detect when a custom excepthook is
installed and make sure that it gets called, which it does from C++ using
PyObject_CallFunctionObjArgs(). Depending on the exception though, it's possible
that the FPyObjectPtrs that hold the exception instance and/or the traceback object
could be invalid. When passed to PyObject_CallFunctionObjArgs(), their value then
becomes nullptr, which is used to signal the end of the arguments list to the function
and would therefore cause too few arguments to be passed to the excepthook.
This would put the interpreter into a bad state where it would continue to attempt to
call the excepthook with too few arguments, and no future commands would work.
The easiest way to get into this bad state was to install a custom excepthook and
then issue a Python command with invalid syntax. Doing so raises a SyntaxError with
no traceback object, since the code could not actually be executed.
To address this, we explicitly pass None for the exception instance and/or the traceback
object when they are invalid to ensure that the excepthook always receives three
arguments.
#rb jamie.dale
#preflight 62c5ba982a05d4f55b097757
[CL 20985039 by matt johnson in ue5-main branch]
This change consists of multiple changes:
Core:
- Deprecation of ANY_PACKAGE macro. Added ANY_PACKAGE_DEPRECATED macro which can still be used for backwards compatibility purposes (only used in CoreUObject)
- Deprecation of StaticFindObjectFast* functions that take bAnyPackage parameter
- Added UStruct::GetStructPathName function that returns FTopLevelAssetPath representing the path name (package + object FName, super quick compared to UObject::GetPathName) + wrapper UClass::GetClassPathName to make it look better when used with UClasses
- Added (Static)FindFirstObject* functions that find a first object given its Name (no Outer). These functions are used in places I consider valid to do global UObject (UClass) lookups like parsing command line parameters / checking for unique object names
- Added static UClass::TryFindType function which serves a similar purpose as FindFirstObject however it's going to throw a warning (with a callstack / maybe ensure in the future?) if short class name is provided. This function is used in places that used to use short class names but now should have been converted to use path names to catch any potential regressions and or edge cases I missed.
- Added static UClass::TryConvertShortNameToPathName utility function
- Added static UClass::TryFixShortClassNameExportPath utility function
- Object text export paths will now also include class path (Texture2D'/Game/Textures/Grass.Grass' -> /Script/Engine.Texture2D'/Game/Textures/Grass.Grass')
- All places that manually generated object export paths for objects will now use FObjectPropertyBase::GetExportPath
- Added a new startup test that checks for short type names in UClass/FProperty MetaData values
AssetRegistry:
- Deprecated any member variables (FAssetData / FARFilter) or functions that use FNames to represent class names and replaced them with FTopLevelAssetPath
- Added new member variables and new function overloads that use FTopLevelAssetPath to represent class names
- This also applies to a few other modules' APIs to match AssetRegistry changes
Everything else:
- Updated code that used ANY_PACKAGE (depending on the use case) to use FindObject(nullptr, PathToObject), UClass::TryFindType (used when path name is expected, warns if it's a short name) or FindFirstObject (usually for finding types based on user input but there's been a few legitimate use cases not related to user input)
- Updated code that used AssetRegistry API to use FTopLevelAssetPaths and USomeClass::StaticClass()->GetClassPathName() instead of GetFName()
- Updated meta data and hardcoded FindObject(ANY_PACKAGE, "EEnumNameOrClassName") calls to use path names
#jira UE-99463
#rb many.people
[FYI] Marcus.Wassmer
#preflight 629248ec2256738f75de9b32
#codereviewnumbers 20320742, 20320791, 20320799, 20320756, 20320809, 20320830, 20320840, 20320846, 20320851, 20320863, 20320780, 20320765, 20320876, 20320786
#ROBOMERGE-OWNER: robert.manuszewski
#ROBOMERGE-AUTHOR: robert.manuszewski
#ROBOMERGE-SOURCE: CL 20430220 via CL 20433854 via CL 20435474 via CL 20435484
#ROBOMERGE-BOT: UE5 (Release-Engine-Staging -> Main) (v949-20362246)
[CL 20448496 by robert manuszewski in ue5-main branch]
#jira UE-154049 - //UE5/Main - Static Analysis Win64 (MSVC) - PyGenUtil.cpp warning: (<non-zero constant> && <expression>) always evaluates to the result of <expression>
#rb Trivial
#preflight 628e7c2ec826bd5a7f02e5e8
[CL 20370010 by Patrick Laflamme in ue5-main branch]
- The 'Off' mode turns type hinting off and produce the Python stub as before.
- The 'Auto-Completion' mode aims to provide types in Python IDE auto-completion while leaving out some information/complexity that clutter the function definition.
- The 'Type Checker' mode aims to provide the closest to the truth (with some limitations) of the supported API types. Type coercion makes it harder to see the exact types.
Known limitations:
- We don't know when a reflected UObject can legally be None. In 'Type Checker' mode, the UObject are always marked as typing.Optional[] everywhere to denotate that they can be None. Obviously, some methods never returns None and some method will fails if an Object is None. It might be annoying to users in some case.
#jira UE-119557 - Consider adding type hinting support to the unreal.py stub file
#rb Jamie.Dale
#preflight 628cf27f7778f10598b1e56d
[CL 20349869 by Patrick Laflamme in ue5-main branch]
Added a test in test_wrapper_types.py to validate before and after the fix.
#jira UE-148631 - GitHub 9069 : Python Type Registry Name Collision Fix
#9069
#rb Jamie.Dale
#preflight 628253a5c57a894cf67eab9d
[CL 20223162 by Patrick Laflamme in ue5-main branch]
It seems those change generates failures in some automation tasks checking asset references.
#rb None
#preflight None
[CL 20191520 by Patrick Laflamme in ue5-main branch]
Added a test in test_wrapper_types.py to validate before and after the fix.
#jira UE-148631 - GitHub 9069 : Python Type Registry Name Collision Fix
#9069
#rb Jamie.Dale
#preflight 627ebc38631ab4370513e79d
[CL 20188886 by Patrick Laflamme in ue5-main branch]
#fyi Patrick.Laflamme
Original CL Desc
-----------------------------------------------------------------
Fixed Python calling the wrong delegate if the same delegate name/type was declared in two different UObject.
Added a test in test_wrapper_types.py to validate before and after the fix.
#jira UE-148631 - GitHub 9069 : Python Type Registry Name Collision Fix
#9069
#rb Jamie.Dale
#preflight 627d5e294a05ef0394d5ac65
[CL 20173858 by bob tellez in ue5-main branch]
Added a test in test_wrapper_types.py to validate before and after the fix.
#jira UE-148631 - GitHub 9069 : Python Type Registry Name Collision Fix
#rb Jamie.Dale
#preflight 627d5e294a05ef0394d5ac65
[CL 20169181 by Patrick Laflamme in ue5-main branch]
#jira UE-150446 - //UE5/Main - UE.EditorAutomation(RunTest=Editor) Win64 - test_wrapper_types test fails due to ensure condition failing referencing PyConversion.h
#rb Trivial
#preflight 626ffdf6645c64f3a249bd21
[CL 20009793 by Patrick Laflamme in ue5-main branch]
#jira UE-149733 - //UE5/Main - Static Analysis Win64 (PVS-Studio) - PyWrapperTypeRegistry.cpp warning: The 'InTypeMethod.MethodFunc.Func' pointer was utilized before it was verified against nullptr
#rb Trivial
#preflight 626058cbdd47b4ad217f80c8
[CL 19836351 by Patrick Laflamme in ue5-main branch]
#rb Jamie.Dale
#jira UE-149707 - Change Python glue generation error into a warning when a make or a break function signature doesn't comply with Python requirements.
#preflight 62601f824617dd44291097f0
[CL 19830811 by Patrick Laflamme in ue5-main branch]
- Fixed the Python method declaration by adding "=..." when a default value was missing. This is legal in a Python stub to not specify the default value.
#rb Jamie.Dale
#preflight 625f25e3db15ac92dba883ee
[CL 19818316 by Patrick Laflamme in ue5-main branch]
