birkeh/o3de
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

{LYN-2336} Fix: Python Console script help opens empty (#3060)

Browse Source 
* {LYN-2336} Fix: Python Console script help opens empty

Fixes: Python Console: Script Help opens empty in AutomatedTesting project
This fixes the missing Python symbols in the Editor
This also fixes the PYI files to write out for the AutomatedTesting project

Signed-off-by: Jackson <23512001+jackalbe@users.noreply.github.com>

* Fixing proper symbol log execution times


Signed-off-by: Jackson <23512001+jackalbe@users.noreply.github.com>

* annotating input values with const

Signed-off-by: Jackson <23512001+jackalbe@users.noreply.github.com>
This commit is contained in:
jackalbe
2021-08-12 11:19:15 -05:00
committed by GitHub
parent 288d366c2a
commit 117bd0e680
8 changed files with 113 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Gems/EditorPythonBindings/Code/Source/PythonSystemComponent.cpp
+39 -3
View File
@@ -10,6 +10,7 @@
#include <EditorPythonBindings/EditorPythonBindingsBus.h>
#include <Source/PythonCommon.h>
#include <Source/PythonSymbolsBus.h>
#include <pybind11/pybind11.h>
#include <pybind11/embed.h>
#include <pybind11/eval.h>
@@ -25,6 +26,7 @@
#include <AzCore/Serialization/SerializeContext.h>
#include <AzCore/Settings/SettingsRegistryMergeUtils.h>
#include <AzCore/std/string/conversions.h>
#include <AzCore/std/smart_ptr/make_shared.h>
#include <AzCore/StringFunc/StringFunc.h>
#include <AzCore/Utils/Utils.h>
@@ -39,7 +41,7 @@
namespace Platform
{
// Implemented in each different platform's implentation files, as it differs per platform.
// Implemented in each different platform's implementation files, as it differs per platform.
bool InsertPythonBinaryLibraryPaths(AZStd::unordered_set<AZStd::string>& paths, const char* pythonPackage, const char* engineRoot);
AZStd::string GetPythonHomePath(const char* pythonPackage, const char* engineRoot);
}
@@ -225,6 +227,37 @@ namespace RedirectOutput
namespace EditorPythonBindings
{
// A stand in bus to capture the log symbol queue events
// so that when/if the PythonLogSymbolsComponent becomes
// active it can write out the python symbols to disk
class PythonSystemComponent::SymbolLogHelper final
: public PythonSymbolEventBus::Handler
{
public:
SymbolLogHelper()
{
PythonSymbolEventBus::Handler::BusConnect();
}
~SymbolLogHelper()
{
PythonSymbolEventBus::ExecuteQueuedEvents();
PythonSymbolEventBus::Handler::BusDisconnect();
}
void LogClass(const AZStd::string, const AZ::BehaviorClass*) override {}
void LogClassWithName(const AZStd::string, const AZ::BehaviorClass*, const AZStd::string) override {}
void LogClassMethod(
const AZStd::string,
const AZStd::string,
const AZ::BehaviorClass*,
const AZ::BehaviorMethod*) override {}
void LogBus(const AZStd::string, const AZStd::string, const AZ::BehaviorEBus*) override {}
void LogGlobalMethod(const AZStd::string, const AZStd::string, const AZ::BehaviorMethod*) override {}
void LogGlobalProperty(const AZStd::string, const AZStd::string, const AZ::BehaviorProperty*) override {}
void Finalize() override {}
};
void PythonSystemComponent::Reflect(AZ::ReflectContext* context)
{
if (AZ::SerializeContext* serialize = azrtti_cast<AZ::SerializeContext*>(context))
@@ -471,8 +504,6 @@ namespace EditorPythonBindings
}
}
bool PythonSystemComponent::StartPythonInterpreter(const PythonPathStack& pythonPathStack)
{
AZStd::unordered_set<AZStd::string> pyPackageSites(pythonPathStack.begin(), pythonPathStack.end());
@@ -520,6 +551,11 @@ namespace EditorPythonBindings
AZStd::lock_guard<decltype(m_lock)> lock(m_lock);
pybind11::gil_scoped_acquire acquire;
if (EditorPythonBindings::PythonSymbolEventBus::GetTotalNumOfEventHandlers() == 0)
{
m_symbolLogHelper = AZStd::make_shared<PythonSystemComponent::SymbolLogHelper>();
}
// print Python version using AZ logging
const int verRet = PyRun_SimpleStringFlags("import sys \nprint (sys.version) \n", nullptr);
AZ_Error("python", verRet == 0, "Error trying to fetch the version number in Python!");