Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -232,3 +232,7 @@ fabric.properties

# Android studio 3.1+ serialized cache file
.idea/caches/build_file_checksums.ser

# local config files
requirements.txt
plugin_src/PyCharmDebug/Config/tool_config.json
9 changes: 2 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,13 +55,8 @@ Project dependencies are available in the [requirements.in](requirements.in) fil
pip-compile --output-file requirements.txt requirements.in requirements-dev.in requirements-test.in
```
4. Install dependencies:
* Windows:
* ```sh
pip-sync --python-executable %VIRTUAL_ENV%/scripts/python.exe requirements.txt
```
* Linux:
* ```sh
pip-sync --python-executable $VIRTUAL_ENV/bin/python.exe requirements.txt
* ```sh
pip-sync
```
</details>

Expand Down
2 changes: 1 addition & 1 deletion plugin_src/PyCharmDebug/Content/Python/init_unreal.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
""" Plugin initialization script """
"""Plugin initialization script"""

try:
from pycharmdebug.menu import install # type: ignore
Expand Down
57 changes: 46 additions & 11 deletions plugin_src/PyCharmDebug/Content/Python/pycharmdebug/utils.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
from pathlib import Path
import os
import sys
import json
import subprocess
from pathlib import Path
from typing import Optional

from unreal import PluginBlueprintLibrary
from unreal import (
PluginBlueprintLibrary,
log_error,
)

from .exceptions import (
PyCharmDebugRuntimeError,
Expand Down Expand Up @@ -115,23 +121,52 @@ def find_system_dbg_egg() -> str:
PyCharm bin path not found
System debug egg not found
"""
pycharm_bin_dir = os.environ.get("PyCharm")
if pycharm_bin_dir is None:
pycharm_installation_path = resolve_os_specific_pycharm_path()
if not pycharm_installation_path or not pycharm_installation_path.is_dir():
raise PyCharmDebugRuntimeError("PyCharm installation not found")

pycharm_dir_path: Path = Path(pycharm_bin_dir.split(";")[0])

if pycharm_dir_path.is_dir() is False:
raise PyCharmDebugRuntimeError("PyCharm bin path not found")

egg_path: Path = pycharm_dir_path.parent.joinpath("debug-eggs/pydevd-pycharm.egg")
egg_path: Path = pycharm_installation_path.joinpath("debug-eggs/pydevd-pycharm.egg")

if egg_path.is_file() is False:
if not egg_path.is_file():
raise PyCharmDebugRuntimeError("System debug egg not found")

return egg_path.as_posix()


def resolve_os_specific_pycharm_path() -> Optional[Path]:
"""Attempt to resolve the OS specific PyCharm installation path

Returns:
Path: PyCharm installation path or None
"""
if sys.platform.startswith("win"):
pycharm_bin_dir = os.environ.get("PyCharm")
if not pycharm_bin_dir:
return None
return Path(pycharm_bin_dir.split(";")[0]).parent

if sys.platform.startswith("darwin"): # macOS
try:
output = subprocess.check_output(
["mdfind", "kMDItemCFBundleIdentifier == 'com.jetbrains.pycharm'"],
text=True,
).strip()
return (
Path(output.split("\n", maxsplit=1)[0]) / "Contents" if output else None
)

except Exception: # pylint: disable=broad-exception-caught
log_error("Failed to import pydevd_pycharm")

if sys.platform.startswith("linux"):
log_error("Linux")
return None

log_error(f"Unknown: {sys.platform}")

return None


def get_debug_egg() -> str:
"""Get the debug egg location from the config file.

Expand Down
1 change: 0 additions & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1 +0,0 @@

Loading
Loading