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

Updating the python import paths for the o3de scripts to use the new package o3de package location

Browse Source
This commit is contained in:
lumberyard-employee-dm
2021-05-19 00:52:28 -05:00
parent 703c268e40
commit c6b0e3562e
7 changed files with 63 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Code/Tools/ProjectManager/Source/PythonBindings.cpp
+35 -35
View File
@@ -53,7 +53,7 @@ namespace Platform
#define Py_To_String(obj) obj.cast<std::string>().c_str()
#define Py_To_String_Optional(dict, key, default_string) dict.contains(key) ? Py_To_String(dict[key]) : default_string
namespace O3DE::ProjectManager
namespace O3DE::ProjectManager
{
PythonBindings::PythonBindings(const AZ::IO::PathView& enginePath)
: m_enginePath(enginePath)
@@ -112,7 +112,7 @@ namespace O3DE::ProjectManager
AZ_Warning("ProjectManagerWindow", result != -1, "Append to sys path failed");
// import required modules
m_registration = pybind11::module::import("cmake.Tools.registration");
m_registration = pybind11::module::import("o3de.registration");
return result == 0 && !PyErr_Occurred();
} catch ([[maybe_unused]] const std::exception& e)
@@ -153,22 +153,22 @@ namespace O3DE::ProjectManager
}
}
AZ::Outcome<EngineInfo> PythonBindings::GetEngineInfo()
AZ::Outcome<EngineInfo> PythonBindings::GetEngineInfo()
{
return AZ::Failure();
}
bool PythonBindings::SetEngineInfo([[maybe_unused]] const EngineInfo& engineInfo)
bool PythonBindings::SetEngineInfo([[maybe_unused]] const EngineInfo& engineInfo)
{
return false;
}
AZ::Outcome<GemInfo> PythonBindings::GetGem(const QString& path)
AZ::Outcome<GemInfo> PythonBindings::GetGem(const QString& path)
{
GemInfo gemInfo = GemInfoFromPath(pybind11::str(path.toStdString()));
if (gemInfo.IsValid())
{
return AZ::Success(AZStd::move(gemInfo));
return AZ::Success(AZStd::move(gemInfo));
}
else
{
@@ -176,18 +176,18 @@ namespace O3DE::ProjectManager
}
}
AZ::Outcome<QVector<GemInfo>> PythonBindings::GetGems()
AZ::Outcome<QVector<GemInfo>> PythonBindings::GetGems()
{
QVector<GemInfo> gems;
bool result = ExecuteWithLock([&] {
// external gems
// external gems
for (auto path : m_registration.attr("get_gems")())
{
gems.push_back(GemInfoFromPath(path));
}
// gems from the engine
// gems from the engine
for (auto path : m_registration.attr("get_engine_gems")())
{
gems.push_back(GemInfoFromPath(path));
@@ -200,21 +200,21 @@ namespace O3DE::ProjectManager
}
else
{
return AZ::Success(AZStd::move(gems));
return AZ::Success(AZStd::move(gems));
}
}
AZ::Outcome<ProjectInfo> PythonBindings::CreateProject([[maybe_unused]] const ProjectTemplateInfo& projectTemplate,[[maybe_unused]] const ProjectInfo& projectInfo)
AZ::Outcome<ProjectInfo> PythonBindings::CreateProject([[maybe_unused]] const ProjectTemplateInfo& projectTemplate,[[maybe_unused]] const ProjectInfo& projectInfo)
{
return AZ::Failure();
}
AZ::Outcome<ProjectInfo> PythonBindings::GetProject(const QString& path)
AZ::Outcome<ProjectInfo> PythonBindings::GetProject(const QString& path)
{
ProjectInfo projectInfo = ProjectInfoFromPath(pybind11::str(path.toStdString()));
if (projectInfo.IsValid())
{
return AZ::Success(AZStd::move(projectInfo));
return AZ::Success(AZStd::move(projectInfo));
}
else
{
@@ -225,7 +225,7 @@ namespace O3DE::ProjectManager
GemInfo PythonBindings::GemInfoFromPath(pybind11::handle path)
{
GemInfo gemInfo;
gemInfo.m_path = Py_To_String(path);
gemInfo.m_path = Py_To_String(path);
auto data = m_registration.attr("get_gem_data")(pybind11::none(), path);
if (pybind11::isinstance<pybind11::dict>(data))
@@ -233,13 +233,13 @@ namespace O3DE::ProjectManager
try
{
// required
gemInfo.m_name = Py_To_String(data["Name"]);
gemInfo.m_uuid = AZ::Uuid(Py_To_String(data["Uuid"]));
gemInfo.m_name = Py_To_String(data["Name"]);
gemInfo.m_uuid = AZ::Uuid(Py_To_String(data["Uuid"]));
// optional
gemInfo.m_displayName = Py_To_String_Optional(data, "DisplayName", gemInfo.m_name);
gemInfo.m_summary = Py_To_String_Optional(data, "Summary", "");
gemInfo.m_version = Py_To_String_Optional(data, "Version", "");
gemInfo.m_displayName = Py_To_String_Optional(data, "DisplayName", gemInfo.m_name);
gemInfo.m_summary = Py_To_String_Optional(data, "Summary", "");
gemInfo.m_version = Py_To_String_Optional(data, "Version", "");
if (data.contains("Dependencies"))
{
@@ -268,7 +268,7 @@ namespace O3DE::ProjectManager
ProjectInfo PythonBindings::ProjectInfoFromPath(pybind11::handle path)
{
ProjectInfo projectInfo;
projectInfo.m_path = Py_To_String(path);
projectInfo.m_path = Py_To_String(path);
auto projectData = m_registration.attr("get_project_data")(pybind11::none(), path);
if (pybind11::isinstance<pybind11::dict>(projectData))
@@ -276,9 +276,9 @@ namespace O3DE::ProjectManager
try
{
// required fields
projectInfo.m_productName = Py_To_String(projectData["product_name"]);
projectInfo.m_projectName = Py_To_String(projectData["project_name"]);
projectInfo.m_projectId = AZ::Uuid(Py_To_String(projectData["project_id"]));
projectInfo.m_productName = Py_To_String(projectData["product_name"]);
projectInfo.m_projectName = Py_To_String(projectData["project_name"]);
projectInfo.m_projectId = AZ::Uuid(Py_To_String(projectData["project_id"]));
}
catch ([[maybe_unused]] const std::exception& e)
{
@@ -289,18 +289,18 @@ namespace O3DE::ProjectManager
return projectInfo;
}
AZ::Outcome<QVector<ProjectInfo>> PythonBindings::GetProjects()
AZ::Outcome<QVector<ProjectInfo>> PythonBindings::GetProjects()
{
QVector<ProjectInfo> projects;
bool result = ExecuteWithLock([&] {
// external projects
// external projects
for (auto path : m_registration.attr("get_projects")())
{
projects.push_back(ProjectInfoFromPath(path));
}
// projects from the engine
// projects from the engine
for (auto path : m_registration.attr("get_engine_projects")())
{
projects.push_back(ProjectInfoFromPath(path));
@@ -313,11 +313,11 @@ namespace O3DE::ProjectManager
}
else
{
return AZ::Success(AZStd::move(projects));
return AZ::Success(AZStd::move(projects));
}
}
bool PythonBindings::UpdateProject([[maybe_unused]] const ProjectInfo& projectInfo)
bool PythonBindings::UpdateProject([[maybe_unused]] const ProjectInfo& projectInfo)
{
return false;
}
@@ -325,7 +325,7 @@ namespace O3DE::ProjectManager
ProjectTemplateInfo PythonBindings::ProjectTemplateInfoFromPath(pybind11::handle path)
{
ProjectTemplateInfo templateInfo;
templateInfo.m_path = Py_To_String(path);
templateInfo.m_path = Py_To_String(path);
auto data = m_registration.attr("get_template_data")(pybind11::none(), path);
if (pybind11::isinstance<pybind11::dict>(data))
@@ -333,10 +333,10 @@ namespace O3DE::ProjectManager
try
{
// required
templateInfo.m_displayName = Py_To_String(data["display_name"]);
templateInfo.m_name = Py_To_String(data["template_name"]);
templateInfo.m_summary = Py_To_String(data["summary"]);
templateInfo.m_displayName = Py_To_String(data["display_name"]);
templateInfo.m_name = Py_To_String(data["template_name"]);
templateInfo.m_summary = Py_To_String(data["summary"]);
// optional
if (data.contains("canonical_tags"))
{
@@ -362,7 +362,7 @@ namespace O3DE::ProjectManager
return templateInfo;
}
AZ::Outcome<QVector<ProjectTemplateInfo>> PythonBindings::GetProjectTemplates()
AZ::Outcome<QVector<ProjectTemplateInfo>> PythonBindings::GetProjectTemplates()
{
QVector<ProjectTemplateInfo> templates;
@@ -379,7 +379,7 @@ namespace O3DE::ProjectManager
}
else
{
return AZ::Success(AZStd::move(templates));
return AZ::Success(AZStd::move(templates));
}
}
}
scripts/o3de.py
+15 -8
View File
@@ -10,17 +10,24 @@
#
import argparse
import pathlib
import sys
import os
# Resolve the common python module
ROOT_DEV_PATH = os.path.realpath(os.path.join(os.path.dirname(__file__), '..'))
if ROOT_DEV_PATH not in sys.path:
sys.path.append(ROOT_DEV_PATH)
# As o3de.py shares the same name as the o3de package attempting to use a regular
# from o3de import <module> line tries to import from the current o3de.py script and not the package
# So the current script directory is removed from the sys.path temporary
SCRIPT_DIR_REMOVED = False
SCRIPT_DIR = pathlib.Path(__file__).parent.resolve()
if str(SCRIPT_DIR) in sys.path:
SCRIPT_DIR_REMOVED = True
sys.path.remove(str(SCRIPT_DIR))
from cmake.Tools import engine_template
from cmake.Tools import global_project
from cmake.Tools import registration
from o3de import engine_template
from o3de import global_project
from o3de import registration
if SCRIPT_DIR_REMOVED:
sys.path.insert(0, str(SCRIPT_DIR))
def add_args(parser, subparsers) -> None:
scripts/o3de/CMakeLists.txt
+1 -1
View File
@@ -9,4 +9,4 @@
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#
add_subdirectory(test)
add_subdirectory(tests)
scripts/o3de/o3de/engine_template.py
+5 -4
View File
@@ -20,8 +20,8 @@ import json
import uuid
import re
from cmake.Tools import utils
import cmake.Tools.registration as registration
from o3de import utils, registration
logger = logging.getLogger()
logging.basicConfig()
@@ -2423,7 +2423,7 @@ if __name__ == "__main__":
the_parser = argparse.ArgumentParser()
# add subparsers
the_subparsers = the_parser.add_subparsers(help='sub-command help')
the_subparsers = the_parser.add_subparsers(help='sub-command help', dest='command', required=True)
# add args to the parser
add_args(the_parser, the_subparsers)
@@ -2432,7 +2432,8 @@ if __name__ == "__main__":
the_args = the_parser.parse_args()
# run
ret = the_args.func(the_args)
ret = the_args.func(the_args) if hasattr(the_args, 'func') else 1
# return
sys.exit(ret)
scripts/o3de/o3de/global_project.py
+3 -3
View File
@@ -16,7 +16,7 @@ import sys
import re
import pathlib
import json
import cmake.Tools.registration as registration
from o3de import registration
logger = logging.getLogger()
logging.basicConfig()
@@ -153,7 +153,7 @@ if __name__ == "__main__":
the_parser = argparse.ArgumentParser()
# add subparsers
the_subparsers = the_parser.add_subparsers(help='sub-command help')
the_subparsers = the_parser.add_subparsers(help='sub-command help', dest='command', required=True)
# add args to the parser
add_args(the_parser, the_subparsers)
@@ -162,7 +162,7 @@ if __name__ == "__main__":
the_args = the_parser.parse_args()
# run
ret = the_args.func(the_args)
ret = the_args.func(the_args) if hasattr(the_args, 'func') else 1
# return
sys.exit(ret)
scripts/o3de/o3de/registration.py
+2 -2
View File
@@ -4416,7 +4416,7 @@ if __name__ == "__main__":
the_parser = argparse.ArgumentParser()
# add subparsers
the_subparsers = the_parser.add_subparsers(help='sub-command help')
the_subparsers = the_parser.add_subparsers(help='sub-command help', dest='command', required=True)
# add args to the parser
add_args(the_parser, the_subparsers)
@@ -4425,7 +4425,7 @@ if __name__ == "__main__":
the_args = the_parser.parse_args()
# run
ret = the_args.func(the_args)
ret = the_args.func(the_args) if hasattr(the_args, 'func') else 1
# return
sys.exit(ret)
scripts/project_manager/projects.py
+2 -3
View File
@@ -29,12 +29,11 @@ executable_path = ''
logger = logging.getLogger()
logger.setLevel(logging.INFO)
from cmake.Tools import engine_template
from cmake.Tools import registration
from o3de import engine_template, registration
o3de_folder = registration.get_o3de_folder()
o3de_logs_folder = registration.get_o3de_logs_folder()
project_manager_log_file_path = o3de_log_folder / "project_manager.log"
project_manager_log_file_path = o3de_logs_folder / "project_manager.log"
log_file_handler = RotatingFileHandler(filename=project_manager_log_file_path, maxBytes=1024 * 1024, backupCount=1)
formatter = logging.Formatter('%(asctime)s | %(levelname)s : %(message)s')
log_file_handler.setFormatter(formatter)