UEPyScripts 1.2.4__tar.gz → 1.2.6__tar.gz

{uepyscripts-1.2.4 → uepyscripts-1.2.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: UEPyScripts
-Version: 1.2.4
+Version: 1.2.6
 Summary: Collection of Python tools and helpers designed to automate common Unreal Engine project tasks (builds, packaging, editor control, CI tasks, etc.).
 Project-URL: Changelog, https://github.com/TheEmidee/UEPyScripts/releases
 Project-URL: Homepage, https://github.com/TheEmidee/UEPyScripts
@@ -248,6 +248,27 @@ How the script works:
   .\setup-venv.ps1
   ```
 
+- In VS Code, you can create a `launch.json` file like this one. It's important to use the `module` setting so that relative imports don't raise exceptions.
+
+```
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Python Debugger: Current File",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "uepyscripts.tools.ue.copy_engine_buildgraph_tasks",
+            "cwd": "ABSOLUTE_PATH_TO_PROJECT",
+            "console": "integratedTerminal",
+            "args": [
+                "--uproject_path=D:\\PATH_TO_UPROJECT.uproject"
+            ]
+        }
+    ]
+}
+```
+
 - Linting & formatting
   - Use `uv run ruff check .` and `uv run ruff format .` Add checks to CI as required.
   - Use `uv run mypy .`
@@ -262,8 +283,11 @@ We welcome contributions — please follow these steps:
 
 1. Fork the repository
 2. Create a feature branch: `git checkout -b feature/your-change`
+3. Add entries in the .changelog folder for towncrier. You can read the [README](.changelog/README.md) file for more information.
 4. Run lint locally
-5. Submit a pull request describing the change
+5. Update documentation
+6. Submit a pull request describing the change
+
 
 ---
 

{uepyscripts-1.2.4 → uepyscripts-1.2.6}/README.md

@@ -168,6 +168,27 @@ How the script works:
   .\setup-venv.ps1
   ```
 
+- In VS Code, you can create a `launch.json` file like this one. It's important to use the `module` setting so that relative imports don't raise exceptions.
+
+```
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Python Debugger: Current File",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "uepyscripts.tools.ue.copy_engine_buildgraph_tasks",
+            "cwd": "ABSOLUTE_PATH_TO_PROJECT",
+            "console": "integratedTerminal",
+            "args": [
+                "--uproject_path=D:\\PATH_TO_UPROJECT.uproject"
+            ]
+        }
+    ]
+}
+```
+
 - Linting & formatting
   - Use `uv run ruff check .` and `uv run ruff format .` Add checks to CI as required.
   - Use `uv run mypy .`
@@ -182,8 +203,11 @@ We welcome contributions — please follow these steps:
 
 1. Fork the repository
 2. Create a feature branch: `git checkout -b feature/your-change`
+3. Add entries in the .changelog folder for towncrier. You can read the [README](.changelog/README.md) file for more information.
 4. Run lint locally
-5. Submit a pull request describing the change
+5. Update documentation
+6. Submit a pull request describing the change
+
 
 ---
 

{uepyscripts-1.2.4 → uepyscripts-1.2.6}/src/uepyscripts/internal/engine.py

@@ -47,12 +47,14 @@ class Engine:
         self.project = project
         self.root_path = root_path
         self.path = self.root_path.joinpath("Engine").resolve()
+        self.build_path = self.path.joinpath("Build").resolve()
+        self.batchfiles_path = self.build_path.joinpath("BatchFiles").resolve()
         self.version = self.get_version_number()
-        self.uat_path = self.Runner(self.path.joinpath("Build/BatchFiles/RunUAT.bat"), True)
+        self.uat_path = self.Runner(self.batchfiles_path.joinpath("RunUAT.bat"), True)
         self.ubt_path = self.Runner(
             self.path.joinpath("Binaries/DotNET/UnrealBuildTool/UnrealBuildTool.exe"), True, True, [str(self.project.uproject_path)]
         )
-        self.build_bat_path = self.Runner(self.path.joinpath("Build/BatchFiles/Build.bat"), True)
+        self.build_bat_path = self.Runner(self.batchfiles_path.joinpath("Build.bat"), True)
         self.editor_exe_path = self.Runner(self.path.joinpath("Binaries/Win64/UnrealEditor.exe"), False, False, [str(self.project.uproject_path)])
 
     def uat(self, args: list[str] = []) -> int:
@@ -70,7 +72,7 @@ class Engine:
     def get_version_number(self) -> Version:
         version = ""
 
-        with open(self.path.joinpath("Build/Build.version")) as build_version_file:
+        with open(self.build_path.joinpath("Build.version")) as build_version_file:
             version_json = json.load(build_version_file)
             major = version_json["MajorVersion"]
             minor = version_json["MinorVersion"]
@@ -80,7 +82,7 @@ class Engine:
         if version == "":
             raise Exception("Impossible to find the version number of the engine")
 
-        jenkins_file = Path(self.path.joinpath("Build/JenkinsBuild.version"))
+        jenkins_file = Path(self.build_path.joinpath("JenkinsBuild.version"))
 
         if jenkins_file.exists():
             with open(jenkins_file) as jenkins_version_file:

{uepyscripts-1.2.4 → uepyscripts-1.2.6}/src/uepyscripts/internal/engine_resolver.py

@@ -5,6 +5,7 @@ from typing import Optional
 
 from pydantic import BaseModel
 
+from .. import logger
 from ..internal.project import Project
 from ..tools.helpers import get_engine_root_folder_from_env_var, is_engine_from_egs
 from ..tools.winreg import get_registry_value
@@ -17,9 +18,7 @@ def resolve_engine_from_env_var(project: Project) -> Optional[Path]:
 def resolve_engine_from_registry(project: Project) -> Optional[Path]:
     path = get_registry_value(winreg.HKEY_CURRENT_USER, r"SOFTWARE\Epic Games\Unreal Engine\Builds", project.engine_association)
     if path:
-        path = Path(path)
-        if path.exists():
-            return path
+        return Path(path)
 
     return None
 
@@ -30,9 +29,7 @@ def resolve_engine_from_egs(project: Project) -> Optional[Path]:
             winreg.HKEY_LOCAL_MACHINE, rf"SOFTWARE\EpicGames\Unreal Engine\{project.engine_association}", "InstalledDirectory"
         )
         if registry_value:
-            path = Path(registry_value)
-            if path.exists():
-                return path
+            return Path(registry_value)
 
     # Some installations are listed in LauncherInstalled.dat
     class EpicInstallation(BaseModel):
@@ -69,13 +66,16 @@ def resolve_engine_from_egs(project: Project) -> Optional[Path]:
                     return Path(item.InstallLocation)
 
     except Exception as e:
-        print(f"Error parsing manifest: {e}")
+        logger.error(f"Error parsing manifest: {e}")
 
     return None
 
 
 def resolve_engine_from_path(project: Project) -> Optional[Path]:
     path = Path(project.engine_association)
+    if not os.path.isabs(path):
+        path = (project.root_folder / path).resolve()
+
     if os.path.isabs(path):
         return path
 
@@ -84,20 +84,25 @@ def resolve_engine_from_path(project: Project) -> Optional[Path]:
 
 def resolve_engine_path(project: Project) -> Path:
     resolvers = [
-        resolve_engine_from_env_var,
         resolve_engine_from_registry,
         resolve_engine_from_egs,
         resolve_engine_from_path,
+        # Resolve last with the environment variable to avoid failing the resolution on a machine
+        # where there's the environment variable but the engine is installed using the launcher
+        resolve_engine_from_env_var,
     ]
 
     for resolver in resolvers:
         path = resolver(project)
         if path:
+            logger.info(f"Engine path resolved via '{resolver.__name__}': {path}")
             break
     else:
         raise FileNotFoundError("Impossible to locate the engine")
 
-    if not (path.exists() and str(path).replace(" ", "") not in ["", ".", "\\"]):
+    path_str = str(path).strip()
+    # Check that the path exists and is not a degenerate path containing only . or \\
+    if not (path.exists() and path_str not in ["", ".", "\\"]):
         raise FileNotFoundError("Impossible to locate the engine")
 
     return path

{uepyscripts-1.2.4 → uepyscripts-1.2.6}/src/uepyscripts/internal/project.py

@@ -68,11 +68,14 @@ def find_parent_with_project_file(starting_path: Path, max_parents: int = 10) ->
     return None
 
 
-def resolve_project() -> Project:
-    dir_path = Path(os.path.dirname(os.path.realpath(__file__)))
-    uproject_path = find_parent_with_project_file(dir_path)
+def resolve_project(uproject_path: Optional[Path] = None) -> Project:
     if not uproject_path:
-        raise Exception(f"Could not find a uproject file from {dir_path}")
+        dir_path = Path(os.path.dirname(os.path.realpath(__file__)))
+        uproject_path = find_parent_with_project_file(dir_path)
+        if not uproject_path:
+            raise Exception(f"Could not find a uproject file from {dir_path}")
+    elif not uproject_path.exists():
+        raise Exception(f"{uproject_path} is not a valid file")
 
     logger.debug(f"Found uproject file at {uproject_path}")
     project = Project(uproject_path)

{uepyscripts-1.2.4 → uepyscripts-1.2.6}/src/uepyscripts/tools/helpers.py

@@ -32,10 +32,7 @@ def get_engine_root_folder_from_env_var(project_engine_association: str) -> Opti
         path = Path(node_ue_root)
         if project_engine_association:
             path = path.joinpath(project_engine_association)
-        if path.exists():
-            return path
-
-        raise FileNotFoundError(f"The environment variable is set to {node_ue_root} but the folder {path} does not exist")
+        return path
 
     return None
 

{uepyscripts-1.2.4 → uepyscripts-1.2.6}/src/uepyscripts/tools/ue/check_engine_installation.py

@@ -16,6 +16,7 @@ which is useful when executed on a build pipeline like Jenkins or Horde.
 """
 
 import argparse
+from pathlib import Path
 
 from ... import logger
 from ...internal.engine import resolve_engine
@@ -26,6 +27,11 @@ from ...tools.ue.engine_installation.engine_installer import EngineInstaller
 def parse_arguments() -> argparse.Namespace:
     """Parse command line arguments."""
     parser = argparse.ArgumentParser(description="Check and install Unreal Engine installation for the given project.")
+    parser.add_argument(
+        "--uproject_path",
+        type=Path,
+        help=("Optional path to a uproject file.If not set, resolve_project will try to find one in its folder hierarchy"),
+    )
     parser.add_argument("--unattended", action="store_true", help="Disable interactive prompts")
 
     return parser.parse_args()
@@ -37,7 +43,7 @@ def main() -> None:
     args = parse_arguments()
 
     try:
-        project = resolve_project()
+        project = resolve_project(args.uproject_path)
     except Exception as e:
         logger.fatal(f"Project resolution failed: {e}")
         exit(1)