Implement os.PathLike on Resource#738

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lieryan merged 6 commits into from
Jan 3, 2024
Merged

Implement os.PathLike on Resource #738

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c2c7b26
Simplify code that uses pathlib.Path to use Resource.pathlib property
lieryan Jan 3, 2024
a21d34b
Add type annotations to Resource
lieryan Jan 3, 2024
bafb28e
Make Resouce implement os.PathLike
lieryan Jan 3, 2024
3ffb1c2
Renamed Resource.{is_folder() -> is_dir()}
lieryan Jan 3, 2024
655b567
Update CHANGELOG.md
lieryan Jan 3, 2024
e747c39
Add test for `Resource.__fspath__()`
lieryan Jan 3, 2024
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

- #733 skip directories with perm error when building autoimport index (@MrBago)
- #722, #723 Remove site-packages from packages search tree (@tkrabel)
- #738 Implement os.PathLike on Resource (@lieryan)

# Release 1.11.0

Expand Down
30 changes: 18 additions & 12 deletions rope/base/resources.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@
from rope.base import change, exceptions, fscommands


class Resource:
class Resource(os.PathLike):
"""Represents files and folders in a project"""

def __init__(self, project, path):
Expand All@@ -49,6 +49,10 @@ def __repr__(self):
hex(id(self)),
)

def __fspath__(self) -> str:
"""Return the file system path of this resource"""
return self.project._get_resource_path(self.path)

def move(self, new_location):
"""Move resource to `new_location`"""
self._perform_change(
Expand All@@ -60,22 +64,25 @@ def remove(self):
"""Remove resource from the project"""
self._perform_change(change.RemoveResource(self), "Removing <%s>" % self.path)

def is_dir(self):
"""Alias for `is_folder()`"""

def is_folder(self):
"""Return true if the resource is a folder"""
"""Return True if the resource is a Folder"""

def create(self):
"""Create this resource"""

def exists(self):
return os.path.exists(self.real_path)
return os.path.exists(self)

@property
def parent(self):
parent = "/".join(self.path.split("/")[0:-1])
return self.project.get_folder(parent)

@property
def path(self):
def path(self) -> str:
"""Return the path of this resource relative to the project root

The path is the list of parent directories separated by '/' followed
Expand All@@ -84,19 +91,18 @@ def path(self):
return self._path

@property
def name(self):
def name(self) -> str:
"""Return the name of this resource"""
return self.path.split("/")[-1]

@property
def real_path(self):
"""Return the file system path of this resource"""
return self.project._get_resource_path(self.path)
def real_path(self) -> str:
return os.fspath(self)

@property
def pathlib(self):
def pathlib(self) -> Path:
"""Return the file as a pathlib path."""
return Path(self.real_path)
return Path(self)

def __eq__(self, obj):
return self.__class__ == obj.__class__ and self.path == obj.path
Expand DownExpand Up@@ -135,7 +141,7 @@ def read_bytes(self):
DeprecationWarning,
stacklevel=2,
)
with open(self.real_path, "rb") as handle:
with open(self, "rb") as handle:
return handle.read()
return self.project.fscommands.read(self.real_path)

Expand DownExpand Up@@ -165,7 +171,7 @@ def is_folder(self):
def get_children(self):
"""Return the children of this folder"""
try:
children = os.listdir(self.real_path)
children = os.listdir(self)
except OSError:
return []
result = []
Expand Down
8 changes: 3 additions & 5 deletions rope/contrib/autoimport/sqlite.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -113,7 +113,7 @@ def __init__(
autoimport = AutoImport(..., memory=True)
"""
self.project = project
project_package = get_package_tuple(Path(project.root.real_path), project)
project_package = get_package_tuple(project.root.pathlib, project)
assert project_package is not None
assert project_package.path is not None
self.project_package = project_package
Expand DownExpand Up@@ -175,9 +175,7 @@ def calculate_project_hash(data: str) -> str:
f"file:rope-{project_hash}:?mode=memory&cache=shared", uri=True
)
else:
return sqlite3.connect(
str(Path(project.ropefolder.real_path) / "autoimport.db")
)
return sqlite3.connect(project.ropefolder.pathlib / "autoimport.db")

@property
def connection(self):
Expand DownExpand Up@@ -627,7 +625,7 @@ def _resource_to_module(
) -> ModuleFile:
assert self.project_package.path
underlined = underlined if underlined else self.underlined
resource_path: Path = Path(resource.real_path)
resource_path: Path = resource.pathlib
# The project doesn't need its name added to the path,
# since the standard python file layout accounts for that
# so we set add_package_name to False
Expand Down
13 changes: 13 additions & 0 deletions ropetest/projecttest.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@
from rope.base.libutils import path_to_resource
from rope.base.project import NoProject, Project, _realpath
from rope.base.resourceobserver import FilteredResourceObserver
from rope.base.resources import File, Folder
from ropetest import testutils


Expand DownExpand Up@@ -610,6 +611,18 @@ def test_multi_source_folders2(self):
self.assertEqual(2, len(source_folders))
self.assertTrue(self.project.root in source_folders and src in source_folders)

def test_folder_is_pathlike(self):
resource = self.project.root.create_folder("src")
self.assertIsInstance(resource, Folder)

self.assertIsInstance(os.fspath(resource), str)

def test_file_is_pathlike(self):
resource = self.project.root.create_file("mod.py")
self.assertIsInstance(resource, File)

self.assertIsInstance(os.fspath(resource), str)


class ResourceObserverTest(unittest.TestCase):
def setUp(self):
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Implement os.PathLike on Resource#738

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

lieryan
merged 6 commits into

from

Jan 3, 2024
 Merged


Implement os.PathLike on Resource
#738
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
c2c7b26

Simplify code that uses pathlib.Path to use Resource.pathlib property


lieryan Jan 3, 2024
a21d34b

Add type annotations to Resource


lieryan Jan 3, 2024
bafb28e

Make Resouce implement os.PathLike


lieryan Jan 3, 2024
3ffb1c2

Renamed Resource.{is_folder() -> is_dir()}


lieryan Jan 3, 2024
655b567

Update CHANGELOG.md


lieryan Jan 3, 2024
e747c39

Add test for `Resource.__fspath__()`


lieryan Jan 3, 2024

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


1 change: 1 addition & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

- #733 skip directories with perm error when building autoimport index (@MrBago)
- #722, #723 Remove site-packages from packages search tree (@tkrabel)
- #738 Implement os.PathLike on Resource (@lieryan)

# Release 1.11.0

Expand Down

30 changes: 18 additions & 12 deletions
rope/base/resources.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@
from rope.base import change, exceptions, fscommands


class Resource:
class Resource(os.PathLike):
 """Represents files and folders in a project"""

 def __init__(self, project, path):
Expand All@@ -49,6 +49,10 @@ def __repr__(self):
 hex(id(self)),
 )

 def __fspath__(self) -> str:
 """Return the file system path of this resource"""
 return self.project._get_resource_path(self.path)

 def move(self, new_location):
 """Move resource to `new_location`"""
 self._perform_change(
Expand All@@ -60,22 +64,25 @@ def remove(self):
 """Remove resource from the project"""
 self._perform_change(change.RemoveResource(self), "Removing <%s>" % self.path)

 def is_dir(self):
 """Alias for `is_folder()`"""

 def is_folder(self):
 """Return true if the resource is a folder"""
 """Return True if the resource is a Folder"""

 def create(self):
 """Create this resource"""

 def exists(self):
 return os.path.exists(self.real_path)
 return os.path.exists(self)

 @property
 def parent(self):
 parent = "/".join(self.path.split("/")[0:-1])
 return self.project.get_folder(parent)

 @property
 def path(self):
 def path(self) -> str:
 """Return the path of this resource relative to the project root

 The path is the list of parent directories separated by '/' followed
Expand All@@ -84,19 +91,18 @@ def path(self):
 return self._path

 @property
 def name(self):
 def name(self) -> str:
 """Return the name of this resource"""
 return self.path.split("/")[-1]

 @property
 def real_path(self):
 """Return the file system path of this resource"""
 return self.project._get_resource_path(self.path)
 def real_path(self) -> str:
 return os.fspath(self)

 @property
 def pathlib(self):
 def pathlib(self) -> Path:
 """Return the file as a pathlib path."""
 return Path(self.real_path)
 return Path(self)

 def __eq__(self, obj):
 return self.__class__ == obj.__class__ and self.path == obj.path
Expand DownExpand Up@@ -135,7 +141,7 @@ def read_bytes(self):
 DeprecationWarning,
 stacklevel=2,
 )
 with open(self.real_path, "rb") as handle:
 with open(self, "rb") as handle:
 return handle.read()
 return self.project.fscommands.read(self.real_path)

Expand DownExpand Up@@ -165,7 +171,7 @@ def is_folder(self):
 def get_children(self):
 """Return the children of this folder"""
 try:
 children = os.listdir(self.real_path)
 children = os.listdir(self)
 except OSError:
 return []
 result = []
Expand Down

8 changes: 3 additions & 5 deletions
rope/contrib/autoimport/sqlite.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -113,7 +113,7 @@ def __init__(
 autoimport = AutoImport(..., memory=True)
 """
 self.project = project
 project_package = get_package_tuple(Path(project.root.real_path), project)
 project_package = get_package_tuple(project.root.pathlib, project)
 assert project_package is not None
 assert project_package.path is not None
 self.project_package = project_package
Expand DownExpand Up@@ -175,9 +175,7 @@ def calculate_project_hash(data: str) -> str:
 f"file:rope-{project_hash}:?mode=memory&cache=shared", uri=True
 )
 else:
 return sqlite3.connect(
 str(Path(project.ropefolder.real_path) / "autoimport.db")
 )
 return sqlite3.connect(project.ropefolder.pathlib / "autoimport.db")

 @property
 def connection(self):
Expand DownExpand Up@@ -627,7 +625,7 @@ def _resource_to_module(
 ) -> ModuleFile:
 assert self.project_package.path
 underlined = underlined if underlined else self.underlined
 resource_path: Path = Path(resource.real_path)
 resource_path: Path = resource.pathlib
 # The project doesn't need its name added to the path,
 # since the standard python file layout accounts for that
 # so we set add_package_name to False
Expand Down

13 changes: 13 additions & 0 deletions
ropetest/projecttest.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@
from rope.base.libutils import path_to_resource
from rope.base.project import NoProject, Project, _realpath
from rope.base.resourceobserver import FilteredResourceObserver
from rope.base.resources import File, Folder
from ropetest import testutils


Expand DownExpand Up@@ -610,6 +611,18 @@ def test_multi_source_folders2(self):
 self.assertEqual(2, len(source_folders))
 self.assertTrue(self.project.root in source_folders and src in source_folders)

 def test_folder_is_pathlike(self):
 resource = self.project.root.create_folder("src")
 self.assertIsInstance(resource, Folder)

 self.assertIsInstance(os.fspath(resource), str)

 def test_file_is_pathlike(self):
 resource = self.project.root.create_file("mod.py")
 self.assertIsInstance(resource, File)

 self.assertIsInstance(os.fspath(resource), str)


class ResourceObserverTest(unittest.TestCase):
 def setUp(self):
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Implement os.PathLike on Resource#738

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

lieryan
merged 6 commits into

from

Jan 3, 2024
 Merged


Implement os.PathLike on Resource
#738
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
c2c7b26

Simplify code that uses pathlib.Path to use Resource.pathlib property


lieryan Jan 3, 2024
a21d34b

Add type annotations to Resource


lieryan Jan 3, 2024
bafb28e

Make Resouce implement os.PathLike


lieryan Jan 3, 2024
3ffb1c2

Renamed Resource.{is_folder() -> is_dir()}


lieryan Jan 3, 2024
655b567

Update CHANGELOG.md


lieryan Jan 3, 2024
e747c39

Add test for `Resource.__fspath__()`


lieryan Jan 3, 2024

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


1 change: 1 addition & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

- #733 skip directories with perm error when building autoimport index (@MrBago)
- #722, #723 Remove site-packages from packages search tree (@tkrabel)
- #738 Implement os.PathLike on Resource (@lieryan)

# Release 1.11.0

Expand Down

30 changes: 18 additions & 12 deletions
rope/base/resources.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@
from rope.base import change, exceptions, fscommands


class Resource:
class Resource(os.PathLike):
 """Represents files and folders in a project"""

 def __init__(self, project, path):
Expand All@@ -49,6 +49,10 @@ def __repr__(self):
 hex(id(self)),
 )

 def __fspath__(self) -> str:
 """Return the file system path of this resource"""
 return self.project._get_resource_path(self.path)

 def move(self, new_location):
 """Move resource to `new_location`"""
 self._perform_change(
Expand All@@ -60,22 +64,25 @@ def remove(self):
 """Remove resource from the project"""
 self._perform_change(change.RemoveResource(self), "Removing <%s>" % self.path)

 def is_dir(self):
 """Alias for `is_folder()`"""

 def is_folder(self):
 """Return true if the resource is a folder"""
 """Return True if the resource is a Folder"""

 def create(self):
 """Create this resource"""

 def exists(self):
 return os.path.exists(self.real_path)
 return os.path.exists(self)

 @property
 def parent(self):
 parent = "/".join(self.path.split("/")[0:-1])
 return self.project.get_folder(parent)

 @property
 def path(self):
 def path(self) -> str:
 """Return the path of this resource relative to the project root

 The path is the list of parent directories separated by '/' followed
Expand All@@ -84,19 +91,18 @@ def path(self):
 return self._path

 @property
 def name(self):
 def name(self) -> str:
 """Return the name of this resource"""
 return self.path.split("/")[-1]

 @property
 def real_path(self):
 """Return the file system path of this resource"""
 return self.project._get_resource_path(self.path)
 def real_path(self) -> str:
 return os.fspath(self)

 @property
 def pathlib(self):
 def pathlib(self) -> Path:
 """Return the file as a pathlib path."""
 return Path(self.real_path)
 return Path(self)

 def __eq__(self, obj):
 return self.__class__ == obj.__class__ and self.path == obj.path
Expand DownExpand Up@@ -135,7 +141,7 @@ def read_bytes(self):
 DeprecationWarning,
 stacklevel=2,
 )
 with open(self.real_path, "rb") as handle:
 with open(self, "rb") as handle:
 return handle.read()
 return self.project.fscommands.read(self.real_path)

Expand DownExpand Up@@ -165,7 +171,7 @@ def is_folder(self):
 def get_children(self):
 """Return the children of this folder"""
 try:
 children = os.listdir(self.real_path)
 children = os.listdir(self)
 except OSError:
 return []
 result = []
Expand Down

8 changes: 3 additions & 5 deletions
rope/contrib/autoimport/sqlite.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -113,7 +113,7 @@ def __init__(
 autoimport = AutoImport(..., memory=True)
 """
 self.project = project
 project_package = get_package_tuple(Path(project.root.real_path), project)
 project_package = get_package_tuple(project.root.pathlib, project)
 assert project_package is not None
 assert project_package.path is not None
 self.project_package = project_package
Expand DownExpand Up@@ -175,9 +175,7 @@ def calculate_project_hash(data: str) -> str:
 f"file:rope-{project_hash}:?mode=memory&cache=shared", uri=True
 )
 else:
 return sqlite3.connect(
 str(Path(project.ropefolder.real_path) / "autoimport.db")
 )
 return sqlite3.connect(project.ropefolder.pathlib / "autoimport.db")

 @property
 def connection(self):
Expand DownExpand Up@@ -627,7 +625,7 @@ def _resource_to_module(
 ) -> ModuleFile:
 assert self.project_package.path
 underlined = underlined if underlined else self.underlined
 resource_path: Path = Path(resource.real_path)
 resource_path: Path = resource.pathlib
 # The project doesn't need its name added to the path,
 # since the standard python file layout accounts for that
 # so we set add_package_name to False
Expand Down

13 changes: 13 additions & 0 deletions
ropetest/projecttest.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@
from rope.base.libutils import path_to_resource
from rope.base.project import NoProject, Project, _realpath
from rope.base.resourceobserver import FilteredResourceObserver
from rope.base.resources import File, Folder
from ropetest import testutils


Expand DownExpand Up@@ -610,6 +611,18 @@ def test_multi_source_folders2(self):
 self.assertEqual(2, len(source_folders))
 self.assertTrue(self.project.root in source_folders and src in source_folders)

 def test_folder_is_pathlike(self):
 resource = self.project.root.create_folder("src")
 self.assertIsInstance(resource, Folder)

 self.assertIsInstance(os.fspath(resource), str)

 def test_file_is_pathlike(self):
 resource = self.project.root.create_file("mod.py")
 self.assertIsInstance(resource, File)

 self.assertIsInstance(os.fspath(resource), str)


class ResourceObserverTest(unittest.TestCase):
 def setUp(self):
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Implement os.PathLike on Resource#738

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

lieryan
merged 6 commits into

from

Jan 3, 2024
 Merged


Implement os.PathLike on Resource
#738
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
c2c7b26

Simplify code that uses pathlib.Path to use Resource.pathlib property


lieryan Jan 3, 2024
a21d34b

Add type annotations to Resource


lieryan Jan 3, 2024
bafb28e

Make Resouce implement os.PathLike


lieryan Jan 3, 2024
3ffb1c2

Renamed Resource.{is_folder() -> is_dir()}


lieryan Jan 3, 2024
655b567

Update CHANGELOG.md


lieryan Jan 3, 2024
e747c39

Add test for `Resource.__fspath__()`


lieryan Jan 3, 2024

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


1 change: 1 addition & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

- #733 skip directories with perm error when building autoimport index (@MrBago)
- #722, #723 Remove site-packages from packages search tree (@tkrabel)
- #738 Implement os.PathLike on Resource (@lieryan)

# Release 1.11.0

Expand Down

30 changes: 18 additions & 12 deletions
rope/base/resources.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@
from rope.base import change, exceptions, fscommands


class Resource:
class Resource(os.PathLike):
 """Represents files and folders in a project"""

 def __init__(self, project, path):
Expand All@@ -49,6 +49,10 @@ def __repr__(self):
 hex(id(self)),
 )

 def __fspath__(self) -> str:
 """Return the file system path of this resource"""
 return self.project._get_resource_path(self.path)

 def move(self, new_location):
 """Move resource to `new_location`"""
 self._perform_change(
Expand All@@ -60,22 +64,25 @@ def remove(self):
 """Remove resource from the project"""
 self._perform_change(change.RemoveResource(self), "Removing <%s>" % self.path)

 def is_dir(self):
 """Alias for `is_folder()`"""

 def is_folder(self):
 """Return true if the resource is a folder"""
 """Return True if the resource is a Folder"""

 def create(self):
 """Create this resource"""

 def exists(self):
 return os.path.exists(self.real_path)
 return os.path.exists(self)

 @property
 def parent(self):
 parent = "/".join(self.path.split("/")[0:-1])
 return self.project.get_folder(parent)

 @property
 def path(self):
 def path(self) -> str:
 """Return the path of this resource relative to the project root

 The path is the list of parent directories separated by '/' followed
Expand All@@ -84,19 +91,18 @@ def path(self):
 return self._path

 @property
 def name(self):
 def name(self) -> str:
 """Return the name of this resource"""
 return self.path.split("/")[-1]

 @property
 def real_path(self):
 """Return the file system path of this resource"""
 return self.project._get_resource_path(self.path)
 def real_path(self) -> str:
 return os.fspath(self)

 @property
 def pathlib(self):
 def pathlib(self) -> Path:
 """Return the file as a pathlib path."""
 return Path(self.real_path)
 return Path(self)

 def __eq__(self, obj):
 return self.__class__ == obj.__class__ and self.path == obj.path
Expand DownExpand Up@@ -135,7 +141,7 @@ def read_bytes(self):
 DeprecationWarning,
 stacklevel=2,
 )
 with open(self.real_path, "rb") as handle:
 with open(self, "rb") as handle:
 return handle.read()
 return self.project.fscommands.read(self.real_path)

Expand DownExpand Up@@ -165,7 +171,7 @@ def is_folder(self):
 def get_children(self):
 """Return the children of this folder"""
 try:
 children = os.listdir(self.real_path)
 children = os.listdir(self)
 except OSError:
 return []
 result = []
Expand Down

8 changes: 3 additions & 5 deletions
rope/contrib/autoimport/sqlite.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -113,7 +113,7 @@ def __init__(
 autoimport = AutoImport(..., memory=True)
 """
 self.project = project
 project_package = get_package_tuple(Path(project.root.real_path), project)
 project_package = get_package_tuple(project.root.pathlib, project)
 assert project_package is not None
 assert project_package.path is not None
 self.project_package = project_package
Expand DownExpand Up@@ -175,9 +175,7 @@ def calculate_project_hash(data: str) -> str:
 f"file:rope-{project_hash}:?mode=memory&cache=shared", uri=True
 )
 else:
 return sqlite3.connect(
 str(Path(project.ropefolder.real_path) / "autoimport.db")
 )
 return sqlite3.connect(project.ropefolder.pathlib / "autoimport.db")

 @property
 def connection(self):
Expand DownExpand Up@@ -627,7 +625,7 @@ def _resource_to_module(
 ) -> ModuleFile:
 assert self.project_package.path
 underlined = underlined if underlined else self.underlined
 resource_path: Path = Path(resource.real_path)
 resource_path: Path = resource.pathlib
 # The project doesn't need its name added to the path,
 # since the standard python file layout accounts for that
 # so we set add_package_name to False
Expand Down

13 changes: 13 additions & 0 deletions
ropetest/projecttest.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@
from rope.base.libutils import path_to_resource
from rope.base.project import NoProject, Project, _realpath
from rope.base.resourceobserver import FilteredResourceObserver
from rope.base.resources import File, Folder
from ropetest import testutils


Expand DownExpand Up@@ -610,6 +611,18 @@ def test_multi_source_folders2(self):
 self.assertEqual(2, len(source_folders))
 self.assertTrue(self.project.root in source_folders and src in source_folders)

 def test_folder_is_pathlike(self):
 resource = self.project.root.create_folder("src")
 self.assertIsInstance(resource, Folder)

 self.assertIsInstance(os.fspath(resource), str)

 def test_file_is_pathlike(self):
 resource = self.project.root.create_file("mod.py")
 self.assertIsInstance(resource, File)

 self.assertIsInstance(os.fspath(resource), str)


class ResourceObserverTest(unittest.TestCase):
 def setUp(self):
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Implement os.PathLike on Resource#738

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

lieryan
merged 6 commits into

from

Jan 3, 2024
 Merged


Implement os.PathLike on Resource
#738
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
c2c7b26

Simplify code that uses pathlib.Path to use Resource.pathlib property


lieryan Jan 3, 2024
a21d34b

Add type annotations to Resource


lieryan Jan 3, 2024
bafb28e

Make Resouce implement os.PathLike


lieryan Jan 3, 2024
3ffb1c2

Renamed Resource.{is_folder() -> is_dir()}


lieryan Jan 3, 2024
655b567

Update CHANGELOG.md


lieryan Jan 3, 2024
e747c39

Add test for `Resource.__fspath__()`


lieryan Jan 3, 2024

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


1 change: 1 addition & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

- #733 skip directories with perm error when building autoimport index (@MrBago)
- #722, #723 Remove site-packages from packages search tree (@tkrabel)
- #738 Implement os.PathLike on Resource (@lieryan)

# Release 1.11.0

Expand Down

30 changes: 18 additions & 12 deletions
rope/base/resources.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@
from rope.base import change, exceptions, fscommands


class Resource:
class Resource(os.PathLike):
 """Represents files and folders in a project"""

 def __init__(self, project, path):
Expand All@@ -49,6 +49,10 @@ def __repr__(self):
 hex(id(self)),
 )

 def __fspath__(self) -> str:
 """Return the file system path of this resource"""
 return self.project._get_resource_path(self.path)

 def move(self, new_location):
 """Move resource to `new_location`"""
 self._perform_change(
Expand All@@ -60,22 +64,25 @@ def remove(self):
 """Remove resource from the project"""
 self._perform_change(change.RemoveResource(self), "Removing <%s>" % self.path)

 def is_dir(self):
 """Alias for `is_folder()`"""

 def is_folder(self):
 """Return true if the resource is a folder"""
 """Return True if the resource is a Folder"""

 def create(self):
 """Create this resource"""

 def exists(self):
 return os.path.exists(self.real_path)
 return os.path.exists(self)

 @property
 def parent(self):
 parent = "/".join(self.path.split("/")[0:-1])
 return self.project.get_folder(parent)

 @property
 def path(self):
 def path(self) -> str:
 """Return the path of this resource relative to the project root

 The path is the list of parent directories separated by '/' followed
Expand All@@ -84,19 +91,18 @@ def path(self):
 return self._path

 @property
 def name(self):
 def name(self) -> str:
 """Return the name of this resource"""
 return self.path.split("/")[-1]

 @property
 def real_path(self):
 """Return the file system path of this resource"""
 return self.project._get_resource_path(self.path)
 def real_path(self) -> str:
 return os.fspath(self)

 @property
 def pathlib(self):
 def pathlib(self) -> Path:
 """Return the file as a pathlib path."""
 return Path(self.real_path)
 return Path(self)

 def __eq__(self, obj):
 return self.__class__ == obj.__class__ and self.path == obj.path
Expand DownExpand Up@@ -135,7 +141,7 @@ def read_bytes(self):
 DeprecationWarning,
 stacklevel=2,
 )
 with open(self.real_path, "rb") as handle:
 with open(self, "rb") as handle:
 return handle.read()
 return self.project.fscommands.read(self.real_path)

Expand DownExpand Up@@ -165,7 +171,7 @@ def is_folder(self):
 def get_children(self):
 """Return the children of this folder"""
 try:
 children = os.listdir(self.real_path)
 children = os.listdir(self)
 except OSError:
 return []
 result = []
Expand Down

8 changes: 3 additions & 5 deletions
rope/contrib/autoimport/sqlite.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -113,7 +113,7 @@ def __init__(
 autoimport = AutoImport(..., memory=True)
 """
 self.project = project
 project_package = get_package_tuple(Path(project.root.real_path), project)
 project_package = get_package_tuple(project.root.pathlib, project)
 assert project_package is not None
 assert project_package.path is not None
 self.project_package = project_package
Expand DownExpand Up@@ -175,9 +175,7 @@ def calculate_project_hash(data: str) -> str:
 f"file:rope-{project_hash}:?mode=memory&cache=shared", uri=True
 )
 else:
 return sqlite3.connect(
 str(Path(project.ropefolder.real_path) / "autoimport.db")
 )
 return sqlite3.connect(project.ropefolder.pathlib / "autoimport.db")

 @property
 def connection(self):
Expand DownExpand Up@@ -627,7 +625,7 @@ def _resource_to_module(
 ) -> ModuleFile:
 assert self.project_package.path
 underlined = underlined if underlined else self.underlined
 resource_path: Path = Path(resource.real_path)
 resource_path: Path = resource.pathlib
 # The project doesn't need its name added to the path,
 # since the standard python file layout accounts for that
 # so we set add_package_name to False
Expand Down

13 changes: 13 additions & 0 deletions
ropetest/projecttest.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@
from rope.base.libutils import path_to_resource
from rope.base.project import NoProject, Project, _realpath
from rope.base.resourceobserver import FilteredResourceObserver
from rope.base.resources import File, Folder
from ropetest import testutils


Expand DownExpand Up@@ -610,6 +611,18 @@ def test_multi_source_folders2(self):
 self.assertEqual(2, len(source_folders))
 self.assertTrue(self.project.root in source_folders and src in source_folders)

 def test_folder_is_pathlike(self):
 resource = self.project.root.create_folder("src")
 self.assertIsInstance(resource, Folder)

 self.assertIsInstance(os.fspath(resource), str)

 def test_file_is_pathlike(self):
 resource = self.project.root.create_file("mod.py")
 self.assertIsInstance(resource, File)

 self.assertIsInstance(os.fspath(resource), str)


class ResourceObserverTest(unittest.TestCase):
 def setUp(self):
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Implement os.PathLike on Resource#738

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

lieryan
merged 6 commits into

from

Jan 3, 2024
 Merged


Implement os.PathLike on Resource
#738
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
c2c7b26

Simplify code that uses pathlib.Path to use Resource.pathlib property


lieryan Jan 3, 2024
a21d34b

Add type annotations to Resource


lieryan Jan 3, 2024
bafb28e

Make Resouce implement os.PathLike


lieryan Jan 3, 2024
3ffb1c2

Renamed Resource.{is_folder() -> is_dir()}


lieryan Jan 3, 2024
655b567

Update CHANGELOG.md


lieryan Jan 3, 2024
e747c39

Add test for `Resource.__fspath__()`


lieryan Jan 3, 2024

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


1 change: 1 addition & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

- #733 skip directories with perm error when building autoimport index (@MrBago)
- #722, #723 Remove site-packages from packages search tree (@tkrabel)
- #738 Implement os.PathLike on Resource (@lieryan)

# Release 1.11.0

Expand Down

30 changes: 18 additions & 12 deletions
rope/base/resources.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@
from rope.base import change, exceptions, fscommands


class Resource:
class Resource(os.PathLike):
 """Represents files and folders in a project"""

 def __init__(self, project, path):
Expand All@@ -49,6 +49,10 @@ def __repr__(self):
 hex(id(self)),
 )

 def __fspath__(self) -> str:
 """Return the file system path of this resource"""
 return self.project._get_resource_path(self.path)

 def move(self, new_location):
 """Move resource to `new_location`"""
 self._perform_change(
Expand All@@ -60,22 +64,25 @@ def remove(self):
 """Remove resource from the project"""
 self._perform_change(change.RemoveResource(self), "Removing <%s>" % self.path)

 def is_dir(self):
 """Alias for `is_folder()`"""

 def is_folder(self):
 """Return true if the resource is a folder"""
 """Return True if the resource is a Folder"""

 def create(self):
 """Create this resource"""

 def exists(self):
 return os.path.exists(self.real_path)
 return os.path.exists(self)

 @property
 def parent(self):
 parent = "/".join(self.path.split("/")[0:-1])
 return self.project.get_folder(parent)

 @property
 def path(self):
 def path(self) -> str:
 """Return the path of this resource relative to the project root

 The path is the list of parent directories separated by '/' followed
Expand All@@ -84,19 +91,18 @@ def path(self):
 return self._path

 @property
 def name(self):
 def name(self) -> str:
 """Return the name of this resource"""
 return self.path.split("/")[-1]

 @property
 def real_path(self):
 """Return the file system path of this resource"""
 return self.project._get_resource_path(self.path)
 def real_path(self) -> str:
 return os.fspath(self)

 @property
 def pathlib(self):
 def pathlib(self) -> Path:
 """Return the file as a pathlib path."""
 return Path(self.real_path)
 return Path(self)

 def __eq__(self, obj):
 return self.__class__ == obj.__class__ and self.path == obj.path
Expand DownExpand Up@@ -135,7 +141,7 @@ def read_bytes(self):
 DeprecationWarning,
 stacklevel=2,
 )
 with open(self.real_path, "rb") as handle:
 with open(self, "rb") as handle:
 return handle.read()
 return self.project.fscommands.read(self.real_path)

Expand DownExpand Up@@ -165,7 +171,7 @@ def is_folder(self):
 def get_children(self):
 """Return the children of this folder"""
 try:
 children = os.listdir(self.real_path)
 children = os.listdir(self)
 except OSError:
 return []
 result = []
Expand Down

8 changes: 3 additions & 5 deletions
rope/contrib/autoimport/sqlite.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -113,7 +113,7 @@ def __init__(
 autoimport = AutoImport(..., memory=True)
 """
 self.project = project
 project_package = get_package_tuple(Path(project.root.real_path), project)
 project_package = get_package_tuple(project.root.pathlib, project)
 assert project_package is not None
 assert project_package.path is not None
 self.project_package = project_package
Expand DownExpand Up@@ -175,9 +175,7 @@ def calculate_project_hash(data: str) -> str:
 f"file:rope-{project_hash}:?mode=memory&cache=shared", uri=True
 )
 else:
 return sqlite3.connect(
 str(Path(project.ropefolder.real_path) / "autoimport.db")
 )
 return sqlite3.connect(project.ropefolder.pathlib / "autoimport.db")

 @property
 def connection(self):
Expand DownExpand Up@@ -627,7 +625,7 @@ def _resource_to_module(
 ) -> ModuleFile:
 assert self.project_package.path
 underlined = underlined if underlined else self.underlined
 resource_path: Path = Path(resource.real_path)
 resource_path: Path = resource.pathlib
 # The project doesn't need its name added to the path,
 # since the standard python file layout accounts for that
 # so we set add_package_name to False
Expand Down

13 changes: 13 additions & 0 deletions
ropetest/projecttest.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@
from rope.base.libutils import path_to_resource
from rope.base.project import NoProject, Project, _realpath
from rope.base.resourceobserver import FilteredResourceObserver
from rope.base.resources import File, Folder
from ropetest import testutils


Expand DownExpand Up@@ -610,6 +611,18 @@ def test_multi_source_folders2(self):
 self.assertEqual(2, len(source_folders))
 self.assertTrue(self.project.root in source_folders and src in source_folders)

 def test_folder_is_pathlike(self):
 resource = self.project.root.create_folder("src")
 self.assertIsInstance(resource, Folder)

 self.assertIsInstance(os.fspath(resource), str)

 def test_file_is_pathlike(self):
 resource = self.project.root.create_file("mod.py")
 self.assertIsInstance(resource, File)

 self.assertIsInstance(os.fspath(resource), str)


class ResourceObserverTest(unittest.TestCase):
 def setUp(self):
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Implement os.PathLike on Resource#738

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

lieryan
merged 6 commits into

from

Jan 3, 2024
 Merged


Implement os.PathLike on Resource
#738
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
c2c7b26

Simplify code that uses pathlib.Path to use Resource.pathlib property


lieryan Jan 3, 2024
a21d34b

Add type annotations to Resource


lieryan Jan 3, 2024
bafb28e

Make Resouce implement os.PathLike


lieryan Jan 3, 2024
3ffb1c2

Renamed Resource.{is_folder() -> is_dir()}


lieryan Jan 3, 2024
655b567

Update CHANGELOG.md


lieryan Jan 3, 2024
e747c39

Add test for `Resource.__fspath__()`


lieryan Jan 3, 2024

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


1 change: 1 addition & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

- #733 skip directories with perm error when building autoimport index (@MrBago)
- #722, #723 Remove site-packages from packages search tree (@tkrabel)
- #738 Implement os.PathLike on Resource (@lieryan)

# Release 1.11.0

Expand Down

30 changes: 18 additions & 12 deletions
rope/base/resources.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@
from rope.base import change, exceptions, fscommands


class Resource:
class Resource(os.PathLike):
 """Represents files and folders in a project"""

 def __init__(self, project, path):
Expand All@@ -49,6 +49,10 @@ def __repr__(self):
 hex(id(self)),
 )

 def __fspath__(self) -> str:
 """Return the file system path of this resource"""
 return self.project._get_resource_path(self.path)

 def move(self, new_location):
 """Move resource to `new_location`"""
 self._perform_change(
Expand All@@ -60,22 +64,25 @@ def remove(self):
 """Remove resource from the project"""
 self._perform_change(change.RemoveResource(self), "Removing <%s>" % self.path)

 def is_dir(self):
 """Alias for `is_folder()`"""

 def is_folder(self):
 """Return true if the resource is a folder"""
 """Return True if the resource is a Folder"""

 def create(self):
 """Create this resource"""

 def exists(self):
 return os.path.exists(self.real_path)
 return os.path.exists(self)

 @property
 def parent(self):
 parent = "/".join(self.path.split("/")[0:-1])
 return self.project.get_folder(parent)

 @property
 def path(self):
 def path(self) -> str:
 """Return the path of this resource relative to the project root

 The path is the list of parent directories separated by '/' followed
Expand All@@ -84,19 +91,18 @@ def path(self):
 return self._path

 @property
 def name(self):
 def name(self) -> str:
 """Return the name of this resource"""
 return self.path.split("/")[-1]

 @property
 def real_path(self):
 """Return the file system path of this resource"""
 return self.project._get_resource_path(self.path)
 def real_path(self) -> str:
 return os.fspath(self)

 @property
 def pathlib(self):
 def pathlib(self) -> Path:
 """Return the file as a pathlib path."""
 return Path(self.real_path)
 return Path(self)

 def __eq__(self, obj):
 return self.__class__ == obj.__class__ and self.path == obj.path
Expand DownExpand Up@@ -135,7 +141,7 @@ def read_bytes(self):
 DeprecationWarning,
 stacklevel=2,
 )
 with open(self.real_path, "rb") as handle:
 with open(self, "rb") as handle:
 return handle.read()
 return self.project.fscommands.read(self.real_path)

Expand DownExpand Up@@ -165,7 +171,7 @@ def is_folder(self):
 def get_children(self):
 """Return the children of this folder"""
 try:
 children = os.listdir(self.real_path)
 children = os.listdir(self)
 except OSError:
 return []
 result = []
Expand Down

8 changes: 3 additions & 5 deletions
rope/contrib/autoimport/sqlite.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -113,7 +113,7 @@ def __init__(
 autoimport = AutoImport(..., memory=True)
 """
 self.project = project
 project_package = get_package_tuple(Path(project.root.real_path), project)
 project_package = get_package_tuple(project.root.pathlib, project)
 assert project_package is not None
 assert project_package.path is not None
 self.project_package = project_package
Expand DownExpand Up@@ -175,9 +175,7 @@ def calculate_project_hash(data: str) -> str:
 f"file:rope-{project_hash}:?mode=memory&cache=shared", uri=True
 )
 else:
 return sqlite3.connect(
 str(Path(project.ropefolder.real_path) / "autoimport.db")
 )
 return sqlite3.connect(project.ropefolder.pathlib / "autoimport.db")

 @property
 def connection(self):
Expand DownExpand Up@@ -627,7 +625,7 @@ def _resource_to_module(
 ) -> ModuleFile:
 assert self.project_package.path
 underlined = underlined if underlined else self.underlined
 resource_path: Path = Path(resource.real_path)
 resource_path: Path = resource.pathlib
 # The project doesn't need its name added to the path,
 # since the standard python file layout accounts for that
 # so we set add_package_name to False
Expand Down

13 changes: 13 additions & 0 deletions
ropetest/projecttest.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@
from rope.base.libutils import path_to_resource
from rope.base.project import NoProject, Project, _realpath
from rope.base.resourceobserver import FilteredResourceObserver
from rope.base.resources import File, Folder
from ropetest import testutils


Expand DownExpand Up@@ -610,6 +611,18 @@ def test_multi_source_folders2(self):
 self.assertEqual(2, len(source_folders))
 self.assertTrue(self.project.root in source_folders and src in source_folders)

 def test_folder_is_pathlike(self):
 resource = self.project.root.create_folder("src")
 self.assertIsInstance(resource, Folder)

 self.assertIsInstance(os.fspath(resource), str)

 def test_file_is_pathlike(self):
 resource = self.project.root.create_file("mod.py")
 self.assertIsInstance(resource, File)

 self.assertIsInstance(os.fspath(resource), str)


class ResourceObserverTest(unittest.TestCase):
 def setUp(self):
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Implement os.PathLike on Resource#738

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

lieryan
merged 6 commits into

from

Jan 3, 2024
 Merged


Implement os.PathLike on Resource
#738
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
c2c7b26

Simplify code that uses pathlib.Path to use Resource.pathlib property


lieryan Jan 3, 2024
a21d34b

Add type annotations to Resource


lieryan Jan 3, 2024
bafb28e

Make Resouce implement os.PathLike


lieryan Jan 3, 2024
3ffb1c2

Renamed Resource.{is_folder() -> is_dir()}


lieryan Jan 3, 2024
655b567

Update CHANGELOG.md


lieryan Jan 3, 2024
e747c39

Add test for `Resource.__fspath__()`


lieryan Jan 3, 2024

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


1 change: 1 addition & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

- #733 skip directories with perm error when building autoimport index (@MrBago)
- #722, #723 Remove site-packages from packages search tree (@tkrabel)
- #738 Implement os.PathLike on Resource (@lieryan)

# Release 1.11.0

Expand Down

30 changes: 18 additions & 12 deletions
rope/base/resources.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@
from rope.base import change, exceptions, fscommands


class Resource:
class Resource(os.PathLike):
 """Represents files and folders in a project"""

 def __init__(self, project, path):
Expand All@@ -49,6 +49,10 @@ def __repr__(self):
 hex(id(self)),
 )

 def __fspath__(self) -> str:
 """Return the file system path of this resource"""
 return self.project._get_resource_path(self.path)

 def move(self, new_location):
 """Move resource to `new_location`"""
 self._perform_change(
Expand All@@ -60,22 +64,25 @@ def remove(self):
 """Remove resource from the project"""
 self._perform_change(change.RemoveResource(self), "Removing <%s>" % self.path)

 def is_dir(self):
 """Alias for `is_folder()`"""

 def is_folder(self):
 """Return true if the resource is a folder"""
 """Return True if the resource is a Folder"""

 def create(self):
 """Create this resource"""

 def exists(self):
 return os.path.exists(self.real_path)
 return os.path.exists(self)

 @property
 def parent(self):
 parent = "/".join(self.path.split("/")[0:-1])
 return self.project.get_folder(parent)

 @property
 def path(self):
 def path(self) -> str:
 """Return the path of this resource relative to the project root

 The path is the list of parent directories separated by '/' followed
Expand All@@ -84,19 +91,18 @@ def path(self):
 return self._path

 @property
 def name(self):
 def name(self) -> str:
 """Return the name of this resource"""
 return self.path.split("/")[-1]

 @property
 def real_path(self):
 """Return the file system path of this resource"""
 return self.project._get_resource_path(self.path)
 def real_path(self) -> str:
 return os.fspath(self)

 @property
 def pathlib(self):
 def pathlib(self) -> Path:
 """Return the file as a pathlib path."""
 return Path(self.real_path)
 return Path(self)

 def __eq__(self, obj):
 return self.__class__ == obj.__class__ and self.path == obj.path
Expand DownExpand Up@@ -135,7 +141,7 @@ def read_bytes(self):
 DeprecationWarning,
 stacklevel=2,
 )
 with open(self.real_path, "rb") as handle:
 with open(self, "rb") as handle:
 return handle.read()
 return self.project.fscommands.read(self.real_path)

Expand DownExpand Up@@ -165,7 +171,7 @@ def is_folder(self):
 def get_children(self):
 """Return the children of this folder"""
 try:
 children = os.listdir(self.real_path)
 children = os.listdir(self)
 except OSError:
 return []
 result = []
Expand Down

8 changes: 3 additions & 5 deletions
rope/contrib/autoimport/sqlite.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -113,7 +113,7 @@ def __init__(
 autoimport = AutoImport(..., memory=True)
 """
 self.project = project
 project_package = get_package_tuple(Path(project.root.real_path), project)
 project_package = get_package_tuple(project.root.pathlib, project)
 assert project_package is not None
 assert project_package.path is not None
 self.project_package = project_package
Expand DownExpand Up@@ -175,9 +175,7 @@ def calculate_project_hash(data: str) -> str:
 f"file:rope-{project_hash}:?mode=memory&cache=shared", uri=True
 )
 else:
 return sqlite3.connect(
 str(Path(project.ropefolder.real_path) / "autoimport.db")
 )
 return sqlite3.connect(project.ropefolder.pathlib / "autoimport.db")

 @property
 def connection(self):
Expand DownExpand Up@@ -627,7 +625,7 @@ def _resource_to_module(
 ) -> ModuleFile:
 assert self.project_package.path
 underlined = underlined if underlined else self.underlined
 resource_path: Path = Path(resource.real_path)
 resource_path: Path = resource.pathlib
 # The project doesn't need its name added to the path,
 # since the standard python file layout accounts for that
 # so we set add_package_name to False
Expand Down

13 changes: 13 additions & 0 deletions
ropetest/projecttest.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@
from rope.base.libutils import path_to_resource
from rope.base.project import NoProject, Project, _realpath
from rope.base.resourceobserver import FilteredResourceObserver
from rope.base.resources import File, Folder
from ropetest import testutils


Expand DownExpand Up@@ -610,6 +611,18 @@ def test_multi_source_folders2(self):
 self.assertEqual(2, len(source_folders))
 self.assertTrue(self.project.root in source_folders and src in source_folders)

 def test_folder_is_pathlike(self):
 resource = self.project.root.create_folder("src")
 self.assertIsInstance(resource, Folder)

 self.assertIsInstance(os.fspath(resource), str)

 def test_file_is_pathlike(self):
 resource = self.project.root.create_file("mod.py")
 self.assertIsInstance(resource, File)

 self.assertIsInstance(os.fspath(resource), str)


class ResourceObserverTest(unittest.TestCase):
 def setUp(self):
Expand Down