Update the FileIO Aliases (#4186)
* Update the FileIOAlias naming to make the cache, project root and engine root paths more clear The alias of `@root@`, `@assets@`, and `@projectplatformcache@` has been collapsed to `@projectproductassets@` The alias of `@devroot@` and `@engroot@` has been collapsed to `@engroot@` The alias of `@devassets@` and `@projectroot@` has been collapsed to `@projectroot@` Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Updated use of devassets and devroot properties in python Those properties now use projectroot and engroot Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Updating the alias @engroot@ alias path comment in each platform specific LocalFileIO_*.cpp file Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Removed hardcoded size of 9 for the product asset alias. The ResolvePath function now just appends the @projectproductassets@ alias with the input path Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Remove duplicate @projectproductassets@ check in ProcessFileTreeRequest Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Fix for typos in Hydra python test Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Updated LocalFileIO::Copy call on Windows to use the Unicode aware CopyFileW API Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Updated the AWSMetreicsGemAllocatorFixture to properly suppress asset cache write errors for Test file creation. Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Removed unneeded call to set the @projectproductasstes@ alias at the bottom of the AssetSeedManagerTest SetUp Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Added a deprecated alias map to the FileIO System When a deprecated alias is accessed, the FileIO System logs an AZ_Error and indicates the alias that should be used Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Updated python test scripts to use the projectroot binding Retrieving the AutomatedTesting project path based on "<devroot>/AutomatedTesting" has been removed. Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Updated references to devroot and devgame within the codebase The GetAbsoluteDevGameFolderPath functions has been replaced with direct call to AZ::Utils::GetProjectPath The GetAbsoluteDevRootFolderPath functions has been replaced with direct calls to AZ::Utils::GetEnginePath Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Updated <engroot>/AutomatedTesting references to projectroot Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Replaced references that assumes the project path is <engroot>/AutomatedTesting with <projectroot> in the AutomatedTesting python test Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Correct casing in emfxworkspace file Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Removed newly added AppendPathParts function Removed the Path constructors which accepts a PathIterable instance The PathIterable isn't safe to return to a user of the Path class as it might be referencing temporary paths supplied via PathView arguments Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Fixed unused parameter warning Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Undid change to the LexicallyProximate function to set the path result to the base path. It needs to return the *this path if the pathResult is empty Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Moved the LocalFileIO ConvertToAbsolutePath implementations to AZ::Utils Fixed the ConvertToAbsolutePath implementation for Unix platforms to use a buffer that is size PATH_MAX(4096 on all our supported Unix platforms). Because the buffer before was AZ::IO::MaxPathLength which as a size of 1024, this was resulting in the Unix `realpath` function smashing the stack when it converts a path to an absolute path that is longer than 1024 characters Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Updated the EditorCore.Tests to attach the AZ Environment to the EditorCore shared library that is statically loaded on launch. Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Fixed for DeprecatedAlaisesKeyVisitor Visit function causing the non string_view overloads being hidden causing a hidden base class function warning Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Changed the AWSMetricsGemMock to use a temporary for writing test assets Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Updated the LocalFileIO::ResolvePath function to use HasRootPath to determine if a path starts with a root path such as "D:", "D:/" or "/" IsAbsolute was not the corect check as the path of "D:" is a relative path. To be absolute according to the Windows the path must have a root directory. i.e "D:/" or "D:\" Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Removed absolute path comment from LocalFile_UnixLike.cpp and LocalFile_Android.cpp FindFiles implementations Updated the ConvertToAlias to supply an AZ::IO::FixedMaxPath Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Replaced usage of the @projectproductassets@ alias with @engroot@ when referring to the LmbrCentral source folder in the CopyDependencyBuilderTest and the SeedBuilderTests Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Updated the ScriptCanvas Upgrade Tool to output backed up files to the Project User Path instead of the engine root Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Fixed whitespacing issues in Application.cpp Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Remove unnecessary creation of a FixedMaxPath in the UpgradeTool.cpp Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Modified testSeedFolder variable in the SeedBuilderTests to use the @engroot@ alias instead of @projectproductassets@/.. alias when referring to the LmbrCentral Gem source path Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Updated references to the Project Asset Cache in the PythonTests. Those tests no longer use the logic `azlmbr.paths.projectroot / "Cache" / "pc"` to retrieve a path to the cache root but instead the `azlmbr.paths.projectproductassets` constant Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Fixed the FileIO Deprecated Alias test on Windows Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Removing @projectsourceassets@ alias, as it is only used once. Updated the PhysX EditorSystemComponent.cpp to query the ProjectPath form the SettingsRegistry. Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Replaced @projectproductassets@ alias with @products@ Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Rollback changes to the PhysX EditorSystemComponent.cpp The changes to use the ProjectPath from the SettingsRegistry has been implemented in PR #4497 Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com>
This commit is contained in:
lumberyard-employee-dm
committed by
GitHub
GitHub
parent
643bd84739
commit
f648cb1fd8
@@ -59,7 +59,7 @@ The API:
|
||||
- ExecuteByString(string) – runs a string buffer in the Python VM; it returns no value
|
||||
- ExecuteByFilename(string) – loads a file off of the disk to execute in the
|
||||
Python VM; the call returns no value. The filename can contain an alias such as
|
||||
‘\@devroot\@’ to execute a project relative file inside the Editor
|
||||
‘\@projectroot\@’ to execute a project relative file inside the Editor
|
||||
|
||||
#### New Console Commands
|
||||
|
||||
|
||||
@@ -38,7 +38,7 @@ namespace EditorPythonBindings
|
||||
static constexpr const char* s_default = "default";
|
||||
static constexpr const char* s_globals = "globals";
|
||||
|
||||
// a structure for pybind11 to bind to hold constants, properties, and enums from the Behavior Context
|
||||
// a structure for pybind11 to bind to hold constants, properties, and enums from the Behavior Context
|
||||
struct StaticPropertyHolder final
|
||||
{
|
||||
AZ_CLASS_ALLOCATOR(StaticPropertyHolder, AZ::SystemAllocator, 0);
|
||||
@@ -54,7 +54,7 @@ namespace EditorPythonBindings
|
||||
if (m_behaviorContext == nullptr)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
m_fullName = PyModule_GetName(scope.ptr());
|
||||
|
||||
@@ -199,12 +199,10 @@ namespace EditorPythonBindings
|
||||
}
|
||||
});
|
||||
|
||||
RegisterAliasIfExists(pathsModule, "@devroot@", "devroot");
|
||||
RegisterAliasIfExists(pathsModule, "@engroot@", "engroot");
|
||||
RegisterAliasIfExists(pathsModule, "@assets@", "assets");
|
||||
RegisterAliasIfExists(pathsModule, "@devassets@", "devassets");
|
||||
RegisterAliasIfExists(pathsModule, "@products@", "products");
|
||||
RegisterAliasIfExists(pathsModule, "@projectroot@", "projectroot");
|
||||
RegisterAliasIfExists(pathsModule, "@log@", "log");
|
||||
RegisterAliasIfExists(pathsModule, "@root@", "root");
|
||||
|
||||
const char* executableFolder = nullptr;
|
||||
AZ::ComponentApplicationBus::BroadcastResult(executableFolder, &AZ::ComponentApplicationBus::Events::GetExecutableFolder);
|
||||
@@ -363,7 +361,7 @@ namespace EditorPythonBindings
|
||||
m_staticPropertyHolderMap.reset();
|
||||
EditorPythonBindings::EditorPythonBindingsNotificationBus::Handler::BusDisconnect();
|
||||
}
|
||||
|
||||
|
||||
void PythonReflectionComponent::OnImportModule(PyObject* module)
|
||||
{
|
||||
pybind11::module parentModule = pybind11::cast<pybind11::module>(module);
|
||||
|
||||
@@ -524,7 +524,7 @@ namespace EditorPythonBindings
|
||||
{
|
||||
AZ::IO::Path newSourcePath = jsonSourcePathPointer;
|
||||
// Resolve any file aliases first - Do not use ResolvePath() as that assumes
|
||||
// any relative path is underneath the @assets@ alias
|
||||
// any relative path is underneath the @products@ alias
|
||||
if (auto fileIoBase = AZ::IO::FileIOBase::GetInstance(); fileIoBase != nullptr)
|
||||
{
|
||||
AZ::IO::FixedMaxPath replacedAliasPath;
|
||||
@@ -803,7 +803,7 @@ namespace EditorPythonBindings
|
||||
return Result::Error_InvalidFilename;
|
||||
}
|
||||
|
||||
// support the alias version of a script such as @devroot@/Editor/Scripts/select_story_anim_objects.py
|
||||
// support the alias version of a script such as @engroot@/Editor/Scripts/select_story_anim_objects.py
|
||||
AZStd::string theFilename(filename);
|
||||
{
|
||||
char resolvedPath[AZ_MAX_PATH_LEN] = { 0 };
|
||||
|
||||
@@ -268,7 +268,7 @@ print ('entityId invalid is ' + str(entityId.id))
|
||||
{
|
||||
Skip = 0,
|
||||
ImportModule,
|
||||
TestCallHit,
|
||||
TestCallHit,
|
||||
TestTypeDoCall1
|
||||
};
|
||||
|
||||
@@ -302,7 +302,7 @@ print ('entityId invalid is ' + str(entityId.id))
|
||||
pybind11::exec(R"(
|
||||
import sys, os
|
||||
import azlmbr.paths
|
||||
sys.path.append(os.path.join(azlmbr.paths.devroot,'Gems','EditorPythonBindings','Code','Tests'))
|
||||
sys.path.append(os.path.join(azlmbr.paths.engroot,'Gems','EditorPythonBindings','Code','Tests'))
|
||||
from test_package import import_test as itest
|
||||
print('ImportModule')
|
||||
itest.test_call()
|
||||
@@ -401,8 +401,8 @@ print ('entityId invalid is ' + str(entityId.id))
|
||||
pybind11::exec(R"(
|
||||
import sys, os
|
||||
import azlmbr.paths
|
||||
sys.path.append(os.path.join(azlmbr.paths.devroot,'Gems','EditorPythonBindings','Code','Tests'))
|
||||
sys.path.append(os.path.join(azlmbr.paths.devroot,'Gems','EditorPythonBindings','Code','Tests','test_package'))
|
||||
sys.path.append(os.path.join(azlmbr.paths.engroot,'Gems','EditorPythonBindings','Code','Tests'))
|
||||
sys.path.append(os.path.join(azlmbr.paths.engroot,'Gems','EditorPythonBindings','Code','Tests','test_package'))
|
||||
|
||||
from test_package import import_many
|
||||
import_many.test_many_entity_id()
|
||||
|
||||
@@ -161,7 +161,7 @@ namespace UnitTest
|
||||
->Method("accept_vector_of_floats", &PythonReflectionContainerSimpleTypes::AcceptVectorOfFloats, nullptr, "")
|
||||
->Method("return_vector_of_doubles", &PythonReflectionContainerSimpleTypes::ReturnVectorOfDoubles, nullptr, "")
|
||||
->Method("accept_vector_of_doubles", &PythonReflectionContainerSimpleTypes::AcceptVectorOfDoubles, nullptr, "")
|
||||
->Property("vector_of_s8",
|
||||
->Property("vector_of_s8",
|
||||
[](PythonReflectionContainerSimpleTypes* self) { return self->m_s8ValueValues.ReturnValues(); },
|
||||
[](PythonReflectionContainerSimpleTypes* self, const AZStd::vector<AZ::s8>& values) { return self->m_s8ValueValues.AcceptValues(values); })
|
||||
->Property("vector_of_u8",
|
||||
@@ -792,7 +792,7 @@ namespace UnitTest
|
||||
theAsset = reflectAny.access_any_ref()
|
||||
if( reflectAny.compare_asset_ids(theAsset,testObject.theAsset) ):
|
||||
print ('MutateAssetId')
|
||||
|
||||
|
||||
)");
|
||||
}
|
||||
catch ([[maybe_unused]] const std::exception& e)
|
||||
@@ -1429,7 +1429,6 @@ namespace UnitTest
|
||||
{
|
||||
Skip = 0,
|
||||
EngrootIs,
|
||||
DevrootIs,
|
||||
pathResolvedTo,
|
||||
};
|
||||
|
||||
@@ -1442,10 +1441,6 @@ namespace UnitTest
|
||||
{
|
||||
return static_cast<int>(LogTypes::EngrootIs);
|
||||
}
|
||||
else if (AzFramework::StringFunc::StartsWith(message, "devroot is "))
|
||||
{
|
||||
return static_cast<int>(LogTypes::DevrootIs);
|
||||
}
|
||||
else if (AzFramework::StringFunc::StartsWith(message, "path resolved to "))
|
||||
{
|
||||
return static_cast<int>(LogTypes::pathResolvedTo);
|
||||
@@ -1470,9 +1465,6 @@ namespace UnitTest
|
||||
if (len(azlmbr.paths.engroot) != 0):
|
||||
print ('engroot is {}'.format(azlmbr.paths.engroot))
|
||||
|
||||
if (len(azlmbr.paths.devroot) != 0):
|
||||
print ('devroot is {}'.format(azlmbr.paths.devroot))
|
||||
|
||||
path = azlmbr.paths.resolve_path('@engroot@/engineassets/texturemsg/defaultsolids.mtl')
|
||||
if (path.find('@engroot@') == -1):
|
||||
print ('path resolved to {}'.format(path))
|
||||
@@ -1487,7 +1479,6 @@ namespace UnitTest
|
||||
e.Deactivate();
|
||||
|
||||
EXPECT_EQ(m_testSink.m_evaluationMap[(int)LogTypes::EngrootIs], 1);
|
||||
EXPECT_EQ(m_testSink.m_evaluationMap[(int)LogTypes::DevrootIs], 1);
|
||||
EXPECT_EQ(m_testSink.m_evaluationMap[(int)LogTypes::pathResolvedTo], 1);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -81,7 +81,6 @@ namespace UnitTest
|
||||
}
|
||||
|
||||
m_fileIOHelper = AZStd::make_unique<FileIOHelper>();
|
||||
m_fileIOHelper->m_fileIO.SetAlias("@devroot@", m_engineRoot.c_str());
|
||||
m_fileIOHelper->m_fileIO.SetAlias("@engroot@", m_engineRoot.c_str());
|
||||
|
||||
AzFramework::Application::Descriptor appDesc;
|
||||
|
||||
Reference in New Issue
Block a user