Add type hints to importinfo.py and add repr to ImportInfo#787

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 4 commits into from
Apr 4, 2024
Merged

Add type hints to importinfo.py and add repr to ImportInfo #787

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7e5181a
Add ImportInfo.__repr__()
lieryan Apr 4, 2024
7ac96d2
Add type annotations to importinfo.py
lieryan Apr 4, 2024
1cc05a8
Update CHANGELOG.md
lieryan Apr 4, 2024
3f89161
Add "raise NotImplementedError()" to coverage exclusion
lieryan Apr 4, 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
@@ -1,5 +1,6 @@
# **Upcoming release**

- #787 Add type hints to importinfo.py and add repr to ImportInfo (@lieryan)
- #786 Upgrade Actions used in Github Workflows (@lieryan)
- #785 Refactoring movetest.py (@lieryan)

Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -87,6 +87,7 @@ force-exclude = 'ropetest|rope/base/prefs.py'
[tool.coverage.report]
exclude_also = [
"if TYPE_CHECKING:",
"raise NotImplementedError()",
]

[tool.isort]
Expand Down
48 changes: 34 additions & 14 deletions rope/refactor/importutils/importinfo.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
from typing import List, Tuple
from abc import abstractmethod, ABC
from typing import List, Tuple, Optional, Protocol


class ImportStatement:
Expand DownExpand Up@@ -64,17 +65,22 @@ def accept(self, visitor):
return visitor.dispatch(self)


class ImportInfo:
def get_imported_primaries(self, context):
pass
class ImportInfo(ABC):
names_and_aliases: List[Tuple[str, Optional[str]]]

@abstractmethod
def get_imported_primaries(self, context) -> List[str]: ...

def get_imported_names(self, context):
return [
primary.split(".")[0] for primary in self.get_imported_primaries(context)
]

def get_import_statement(self):
pass
def __repr__(self):
return f'<{self.__class__.__name__} "{self.get_import_statement()}">'

@abstractmethod
def get_import_statement(self) -> str: ...

def is_empty(self):
pass
Expand DownExpand Up@@ -105,10 +111,13 @@ def get_empty_import():


class NormalImport(ImportInfo):
def __init__(self, names_and_aliases):
def __init__(
self,
names_and_aliases: List[Tuple[str, Optional[str]]],
) -> None:
self.names_and_aliases = names_and_aliases

def get_imported_primaries(self, context):
def get_imported_primaries(self, context) -> List[str]:
result = []
for name, alias in self.names_and_aliases:
if alias:
Expand All@@ -117,7 +126,7 @@ def get_imported_primaries(self, context):
result.append(name)
return result

def get_import_statement(self):
def get_import_statement(self) -> str:
result = "import "
for name, alias in self.names_and_aliases:
result += name
Expand All@@ -131,12 +140,20 @@ def is_empty(self):


class FromImport(ImportInfo):
def __init__(self, module_name, level, names_and_aliases):
module_name: str
level: int

def __init__(
self,
module_name: str,
level: int,
names_and_aliases: List[Tuple[str, Optional[str]]],
):
self.module_name = module_name
self.level = level
self.names_and_aliases = names_and_aliases

def get_imported_primaries(self, context):
def get_imported_primaries(self, context) -> List[str]:
if self.names_and_aliases[0][0] == "*":
module = self.get_imported_module(context)
return [name for name in module if not name.startswith("_")]
Expand DownExpand Up@@ -173,7 +190,7 @@ def get_imported_module(self, context):
self.module_name, context.folder, self.level
)

def get_import_statement(self):
def get_import_statement(self) -> str:
result = "from " + "." * self.level + self.module_name + " import "
for name, alias in self.names_and_aliases:
result += name
Expand All@@ -190,14 +207,17 @@ def is_star_import(self):


class EmptyImport(ImportInfo):
names_and_aliases: List[Tuple[str, str]] = []
names_and_aliases = []

def is_empty(self):
return True

def get_imported_primaries(self, context):
def get_imported_primaries(self, context) -> List[str]:
return []

def get_import_statement(self) -> str:
raise NotImplementedError()


class ImportContext:
def __init__(self, project, folder):
Expand Down
22 changes: 22 additions & 0 deletions ropetest/reprtest.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@
from rope.contrib import findit
from rope.contrib.autoimport import models
from rope.refactor import occurrences
from rope.refactor.importutils import importinfo
from ropetest import testutils


Expand DownExpand Up@@ -165,3 +166,24 @@ def test_autoimport_models_finalquery(project, mod1):
obj = models.Package.delete_by_package_name
assert isinstance(obj, models.FinalQuery)
assert repr(obj) == expected_repr


def test_repr_normal_import(project):
obj = importinfo.NormalImport([("abc", None), ("ghi", "jkl")])
expected_repr = '<NormalImport "import abc, ghi as jkl">'
assert isinstance(obj, importinfo.NormalImport)
assert repr(obj) == expected_repr


def test_repr_from_import(project):
obj = importinfo.FromImport("pkg1.pkg2", 0, [("abc", None), ("ghi", "jkl")])
expected_repr = '<FromImport "from pkg1.pkg2 import abc, ghi as jkl">'
assert isinstance(obj, importinfo.FromImport)
assert repr(obj) == expected_repr


def test_repr_from_import_with_level(project):
obj = importinfo.FromImport("pkg1.pkg2", 3, [("abc", None), ("ghi", "jkl")])
expected_repr = '<FromImport "from ...pkg1.pkg2 import abc, ghi as jkl">'
assert isinstance(obj, importinfo.FromImport)
assert repr(obj) == expected_repr
, '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
Add type hints to importinfo.py and add repr to ImportInfo#787

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 4 commits into

from

Apr 4, 2024
 Merged


Add type hints to importinfo.py and add repr to ImportInfo
#787
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
7e5181a

Add ImportInfo.__repr__()


lieryan Apr 4, 2024
7ac96d2

Add type annotations to importinfo.py


lieryan Apr 4, 2024
1cc05a8

Update CHANGELOG.md


lieryan Apr 4, 2024
3f89161

Add "raise NotImplementedError()" to coverage exclusion


lieryan Apr 4, 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
@@ -1,5 +1,6 @@
# **Upcoming release**

- #787 Add type hints to importinfo.py and add repr to ImportInfo (@lieryan)
- #786 Upgrade Actions used in Github Workflows (@lieryan)
- #785 Refactoring movetest.py (@lieryan)

Expand Down

1 change: 1 addition & 0 deletions
pyproject.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,6 +87,7 @@ force-exclude = 'ropetest|rope/base/prefs.py'
[tool.coverage.report]
exclude_also = [
 "if TYPE_CHECKING:",
 "raise NotImplementedError()",
]

[tool.isort]
Expand Down

48 changes: 34 additions & 14 deletions
rope/refactor/importutils/importinfo.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
from typing import List, Tuple
from abc import abstractmethod, ABC
from typing import List, Tuple, Optional, Protocol


class ImportStatement:
Expand DownExpand Up@@ -64,17 +65,22 @@ def accept(self, visitor):
 return visitor.dispatch(self)


class ImportInfo:
 def get_imported_primaries(self, context):
 pass
class ImportInfo(ABC):
 names_and_aliases: List[Tuple[str, Optional[str]]]

 @abstractmethod
 def get_imported_primaries(self, context) -> List[str]: ...

 def get_imported_names(self, context):
 return [
 primary.split(".")[0] for primary in self.get_imported_primaries(context)
 ]

 def get_import_statement(self):
 pass
 def __repr__(self):
 return f'<{self.__class__.__name__} "{self.get_import_statement()}">'

 @abstractmethod
 def get_import_statement(self) -> str: ...

 def is_empty(self):
 pass
Expand DownExpand Up@@ -105,10 +111,13 @@ def get_empty_import():


class NormalImport(ImportInfo):
 def __init__(self, names_and_aliases):
 def __init__(
 self,
 names_and_aliases: List[Tuple[str, Optional[str]]],
 ) -> None:
 self.names_and_aliases = names_and_aliases

 def get_imported_primaries(self, context):
 def get_imported_primaries(self, context) -> List[str]:
 result = []
 for name, alias in self.names_and_aliases:
 if alias:
Expand All@@ -117,7 +126,7 @@ def get_imported_primaries(self, context):
 result.append(name)
 return result

 def get_import_statement(self):
 def get_import_statement(self) -> str:
 result = "import "
 for name, alias in self.names_and_aliases:
 result += name
Expand All@@ -131,12 +140,20 @@ def is_empty(self):


class FromImport(ImportInfo):
 def __init__(self, module_name, level, names_and_aliases):
 module_name: str
 level: int

 def __init__(
 self,
 module_name: str,
 level: int,
 names_and_aliases: List[Tuple[str, Optional[str]]],
 ):
 self.module_name = module_name
 self.level = level
 self.names_and_aliases = names_and_aliases

 def get_imported_primaries(self, context):
 def get_imported_primaries(self, context) -> List[str]:
 if self.names_and_aliases[0][0] == "*":
 module = self.get_imported_module(context)
 return [name for name in module if not name.startswith("_")]
Expand DownExpand Up@@ -173,7 +190,7 @@ def get_imported_module(self, context):
 self.module_name, context.folder, self.level
 )

 def get_import_statement(self):
 def get_import_statement(self) -> str:
 result = "from " + "." * self.level + self.module_name + " import "
 for name, alias in self.names_and_aliases:
 result += name
Expand All@@ -190,14 +207,17 @@ def is_star_import(self):


class EmptyImport(ImportInfo):
 names_and_aliases: List[Tuple[str, str]] = []
 names_and_aliases = []

 def is_empty(self):
 return True

 def get_imported_primaries(self, context):
 def get_imported_primaries(self, context) -> List[str]:
 return []

 def get_import_statement(self) -> str:
 raise NotImplementedError()


class ImportContext:
 def __init__(self, project, folder):
Expand Down

22 changes: 22 additions & 0 deletions
ropetest/reprtest.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@
from rope.contrib import findit
from rope.contrib.autoimport import models
from rope.refactor import occurrences
from rope.refactor.importutils import importinfo
from ropetest import testutils


Expand DownExpand Up@@ -165,3 +166,24 @@ def test_autoimport_models_finalquery(project, mod1):
 obj = models.Package.delete_by_package_name
 assert isinstance(obj, models.FinalQuery)
 assert repr(obj) == expected_repr


def test_repr_normal_import(project):
 obj = importinfo.NormalImport([("abc", None), ("ghi", "jkl")])
 expected_repr = '<NormalImport "import abc, ghi as jkl">'
 assert isinstance(obj, importinfo.NormalImport)
 assert repr(obj) == expected_repr


def test_repr_from_import(project):
 obj = importinfo.FromImport("pkg1.pkg2", 0, [("abc", None), ("ghi", "jkl")])
 expected_repr = '<FromImport "from pkg1.pkg2 import abc, ghi as jkl">'
 assert isinstance(obj, importinfo.FromImport)
 assert repr(obj) == expected_repr


def test_repr_from_import_with_level(project):
 obj = importinfo.FromImport("pkg1.pkg2", 3, [("abc", None), ("ghi", "jkl")])
 expected_repr = '<FromImport "from ...pkg1.pkg2 import abc, ghi as jkl">'
 assert isinstance(obj, importinfo.FromImport)
 assert repr(obj) == expected_repr

, '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
Add type hints to importinfo.py and add repr to ImportInfo#787

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 4 commits into

from

Apr 4, 2024
 Merged


Add type hints to importinfo.py and add repr to ImportInfo
#787
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
7e5181a

Add ImportInfo.__repr__()


lieryan Apr 4, 2024
7ac96d2

Add type annotations to importinfo.py


lieryan Apr 4, 2024
1cc05a8

Update CHANGELOG.md


lieryan Apr 4, 2024
3f89161

Add "raise NotImplementedError()" to coverage exclusion


lieryan Apr 4, 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
@@ -1,5 +1,6 @@
# **Upcoming release**

- #787 Add type hints to importinfo.py and add repr to ImportInfo (@lieryan)
- #786 Upgrade Actions used in Github Workflows (@lieryan)
- #785 Refactoring movetest.py (@lieryan)

Expand Down

1 change: 1 addition & 0 deletions
pyproject.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,6 +87,7 @@ force-exclude = 'ropetest|rope/base/prefs.py'
[tool.coverage.report]
exclude_also = [
 "if TYPE_CHECKING:",
 "raise NotImplementedError()",
]

[tool.isort]
Expand Down

48 changes: 34 additions & 14 deletions
rope/refactor/importutils/importinfo.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
from typing import List, Tuple
from abc import abstractmethod, ABC
from typing import List, Tuple, Optional, Protocol


class ImportStatement:
Expand DownExpand Up@@ -64,17 +65,22 @@ def accept(self, visitor):
 return visitor.dispatch(self)


class ImportInfo:
 def get_imported_primaries(self, context):
 pass
class ImportInfo(ABC):
 names_and_aliases: List[Tuple[str, Optional[str]]]

 @abstractmethod
 def get_imported_primaries(self, context) -> List[str]: ...

 def get_imported_names(self, context):
 return [
 primary.split(".")[0] for primary in self.get_imported_primaries(context)
 ]

 def get_import_statement(self):
 pass
 def __repr__(self):
 return f'<{self.__class__.__name__} "{self.get_import_statement()}">'

 @abstractmethod
 def get_import_statement(self) -> str: ...

 def is_empty(self):
 pass
Expand DownExpand Up@@ -105,10 +111,13 @@ def get_empty_import():


class NormalImport(ImportInfo):
 def __init__(self, names_and_aliases):
 def __init__(
 self,
 names_and_aliases: List[Tuple[str, Optional[str]]],
 ) -> None:
 self.names_and_aliases = names_and_aliases

 def get_imported_primaries(self, context):
 def get_imported_primaries(self, context) -> List[str]:
 result = []
 for name, alias in self.names_and_aliases:
 if alias:
Expand All@@ -117,7 +126,7 @@ def get_imported_primaries(self, context):
 result.append(name)
 return result

 def get_import_statement(self):
 def get_import_statement(self) -> str:
 result = "import "
 for name, alias in self.names_and_aliases:
 result += name
Expand All@@ -131,12 +140,20 @@ def is_empty(self):


class FromImport(ImportInfo):
 def __init__(self, module_name, level, names_and_aliases):
 module_name: str
 level: int

 def __init__(
 self,
 module_name: str,
 level: int,
 names_and_aliases: List[Tuple[str, Optional[str]]],
 ):
 self.module_name = module_name
 self.level = level
 self.names_and_aliases = names_and_aliases

 def get_imported_primaries(self, context):
 def get_imported_primaries(self, context) -> List[str]:
 if self.names_and_aliases[0][0] == "*":
 module = self.get_imported_module(context)
 return [name for name in module if not name.startswith("_")]
Expand DownExpand Up@@ -173,7 +190,7 @@ def get_imported_module(self, context):
 self.module_name, context.folder, self.level
 )

 def get_import_statement(self):
 def get_import_statement(self) -> str:
 result = "from " + "." * self.level + self.module_name + " import "
 for name, alias in self.names_and_aliases:
 result += name
Expand All@@ -190,14 +207,17 @@ def is_star_import(self):


class EmptyImport(ImportInfo):
 names_and_aliases: List[Tuple[str, str]] = []
 names_and_aliases = []

 def is_empty(self):
 return True

 def get_imported_primaries(self, context):
 def get_imported_primaries(self, context) -> List[str]:
 return []

 def get_import_statement(self) -> str:
 raise NotImplementedError()


class ImportContext:
 def __init__(self, project, folder):
Expand Down

22 changes: 22 additions & 0 deletions
ropetest/reprtest.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@
from rope.contrib import findit
from rope.contrib.autoimport import models
from rope.refactor import occurrences
from rope.refactor.importutils import importinfo
from ropetest import testutils


Expand DownExpand Up@@ -165,3 +166,24 @@ def test_autoimport_models_finalquery(project, mod1):
 obj = models.Package.delete_by_package_name
 assert isinstance(obj, models.FinalQuery)
 assert repr(obj) == expected_repr


def test_repr_normal_import(project):
 obj = importinfo.NormalImport([("abc", None), ("ghi", "jkl")])
 expected_repr = '<NormalImport "import abc, ghi as jkl">'
 assert isinstance(obj, importinfo.NormalImport)
 assert repr(obj) == expected_repr


def test_repr_from_import(project):
 obj = importinfo.FromImport("pkg1.pkg2", 0, [("abc", None), ("ghi", "jkl")])
 expected_repr = '<FromImport "from pkg1.pkg2 import abc, ghi as jkl">'
 assert isinstance(obj, importinfo.FromImport)
 assert repr(obj) == expected_repr


def test_repr_from_import_with_level(project):
 obj = importinfo.FromImport("pkg1.pkg2", 3, [("abc", None), ("ghi", "jkl")])
 expected_repr = '<FromImport "from ...pkg1.pkg2 import abc, ghi as jkl">'
 assert isinstance(obj, importinfo.FromImport)
 assert repr(obj) == expected_repr

, '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
Add type hints to importinfo.py and add repr to ImportInfo#787

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 4 commits into

from

Apr 4, 2024
 Merged


Add type hints to importinfo.py and add repr to ImportInfo
#787
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
7e5181a

Add ImportInfo.__repr__()


lieryan Apr 4, 2024
7ac96d2

Add type annotations to importinfo.py


lieryan Apr 4, 2024
1cc05a8

Update CHANGELOG.md


lieryan Apr 4, 2024
3f89161

Add "raise NotImplementedError()" to coverage exclusion


lieryan Apr 4, 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
@@ -1,5 +1,6 @@
# **Upcoming release**

- #787 Add type hints to importinfo.py and add repr to ImportInfo (@lieryan)
- #786 Upgrade Actions used in Github Workflows (@lieryan)
- #785 Refactoring movetest.py (@lieryan)

Expand Down

1 change: 1 addition & 0 deletions
pyproject.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,6 +87,7 @@ force-exclude = 'ropetest|rope/base/prefs.py'
[tool.coverage.report]
exclude_also = [
 "if TYPE_CHECKING:",
 "raise NotImplementedError()",
]

[tool.isort]
Expand Down

48 changes: 34 additions & 14 deletions
rope/refactor/importutils/importinfo.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
from typing import List, Tuple
from abc import abstractmethod, ABC
from typing import List, Tuple, Optional, Protocol


class ImportStatement:
Expand DownExpand Up@@ -64,17 +65,22 @@ def accept(self, visitor):
 return visitor.dispatch(self)


class ImportInfo:
 def get_imported_primaries(self, context):
 pass
class ImportInfo(ABC):
 names_and_aliases: List[Tuple[str, Optional[str]]]

 @abstractmethod
 def get_imported_primaries(self, context) -> List[str]: ...

 def get_imported_names(self, context):
 return [
 primary.split(".")[0] for primary in self.get_imported_primaries(context)
 ]

 def get_import_statement(self):
 pass
 def __repr__(self):
 return f'<{self.__class__.__name__} "{self.get_import_statement()}">'

 @abstractmethod
 def get_import_statement(self) -> str: ...

 def is_empty(self):
 pass
Expand DownExpand Up@@ -105,10 +111,13 @@ def get_empty_import():


class NormalImport(ImportInfo):
 def __init__(self, names_and_aliases):
 def __init__(
 self,
 names_and_aliases: List[Tuple[str, Optional[str]]],
 ) -> None:
 self.names_and_aliases = names_and_aliases

 def get_imported_primaries(self, context):
 def get_imported_primaries(self, context) -> List[str]:
 result = []
 for name, alias in self.names_and_aliases:
 if alias:
Expand All@@ -117,7 +126,7 @@ def get_imported_primaries(self, context):
 result.append(name)
 return result

 def get_import_statement(self):
 def get_import_statement(self) -> str:
 result = "import "
 for name, alias in self.names_and_aliases:
 result += name
Expand All@@ -131,12 +140,20 @@ def is_empty(self):


class FromImport(ImportInfo):
 def __init__(self, module_name, level, names_and_aliases):
 module_name: str
 level: int

 def __init__(
 self,
 module_name: str,
 level: int,
 names_and_aliases: List[Tuple[str, Optional[str]]],
 ):
 self.module_name = module_name
 self.level = level
 self.names_and_aliases = names_and_aliases

 def get_imported_primaries(self, context):
 def get_imported_primaries(self, context) -> List[str]:
 if self.names_and_aliases[0][0] == "*":
 module = self.get_imported_module(context)
 return [name for name in module if not name.startswith("_")]
Expand DownExpand Up@@ -173,7 +190,7 @@ def get_imported_module(self, context):
 self.module_name, context.folder, self.level
 )

 def get_import_statement(self):
 def get_import_statement(self) -> str:
 result = "from " + "." * self.level + self.module_name + " import "
 for name, alias in self.names_and_aliases:
 result += name
Expand All@@ -190,14 +207,17 @@ def is_star_import(self):


class EmptyImport(ImportInfo):
 names_and_aliases: List[Tuple[str, str]] = []
 names_and_aliases = []

 def is_empty(self):
 return True

 def get_imported_primaries(self, context):
 def get_imported_primaries(self, context) -> List[str]:
 return []

 def get_import_statement(self) -> str:
 raise NotImplementedError()


class ImportContext:
 def __init__(self, project, folder):
Expand Down

22 changes: 22 additions & 0 deletions
ropetest/reprtest.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@
from rope.contrib import findit
from rope.contrib.autoimport import models
from rope.refactor import occurrences
from rope.refactor.importutils import importinfo
from ropetest import testutils


Expand DownExpand Up@@ -165,3 +166,24 @@ def test_autoimport_models_finalquery(project, mod1):
 obj = models.Package.delete_by_package_name
 assert isinstance(obj, models.FinalQuery)
 assert repr(obj) == expected_repr


def test_repr_normal_import(project):
 obj = importinfo.NormalImport([("abc", None), ("ghi", "jkl")])
 expected_repr = '<NormalImport "import abc, ghi as jkl">'
 assert isinstance(obj, importinfo.NormalImport)
 assert repr(obj) == expected_repr


def test_repr_from_import(project):
 obj = importinfo.FromImport("pkg1.pkg2", 0, [("abc", None), ("ghi", "jkl")])
 expected_repr = '<FromImport "from pkg1.pkg2 import abc, ghi as jkl">'
 assert isinstance(obj, importinfo.FromImport)
 assert repr(obj) == expected_repr


def test_repr_from_import_with_level(project):
 obj = importinfo.FromImport("pkg1.pkg2", 3, [("abc", None), ("ghi", "jkl")])
 expected_repr = '<FromImport "from ...pkg1.pkg2 import abc, ghi as jkl">'
 assert isinstance(obj, importinfo.FromImport)
 assert repr(obj) == expected_repr

, '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
Add type hints to importinfo.py and add repr to ImportInfo#787

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 4 commits into

from

Apr 4, 2024
 Merged


Add type hints to importinfo.py and add repr to ImportInfo
#787
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
7e5181a

Add ImportInfo.__repr__()


lieryan Apr 4, 2024
7ac96d2

Add type annotations to importinfo.py


lieryan Apr 4, 2024
1cc05a8

Update CHANGELOG.md


lieryan Apr 4, 2024
3f89161

Add "raise NotImplementedError()" to coverage exclusion


lieryan Apr 4, 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
@@ -1,5 +1,6 @@
# **Upcoming release**

- #787 Add type hints to importinfo.py and add repr to ImportInfo (@lieryan)
- #786 Upgrade Actions used in Github Workflows (@lieryan)
- #785 Refactoring movetest.py (@lieryan)

Expand Down

1 change: 1 addition & 0 deletions
pyproject.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,6 +87,7 @@ force-exclude = 'ropetest|rope/base/prefs.py'
[tool.coverage.report]
exclude_also = [
 "if TYPE_CHECKING:",
 "raise NotImplementedError()",
]

[tool.isort]
Expand Down

48 changes: 34 additions & 14 deletions
rope/refactor/importutils/importinfo.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
from typing import List, Tuple
from abc import abstractmethod, ABC
from typing import List, Tuple, Optional, Protocol


class ImportStatement:
Expand DownExpand Up@@ -64,17 +65,22 @@ def accept(self, visitor):
 return visitor.dispatch(self)


class ImportInfo:
 def get_imported_primaries(self, context):
 pass
class ImportInfo(ABC):
 names_and_aliases: List[Tuple[str, Optional[str]]]

 @abstractmethod
 def get_imported_primaries(self, context) -> List[str]: ...

 def get_imported_names(self, context):
 return [
 primary.split(".")[0] for primary in self.get_imported_primaries(context)
 ]

 def get_import_statement(self):
 pass
 def __repr__(self):
 return f'<{self.__class__.__name__} "{self.get_import_statement()}">'

 @abstractmethod
 def get_import_statement(self) -> str: ...

 def is_empty(self):
 pass
Expand DownExpand Up@@ -105,10 +111,13 @@ def get_empty_import():


class NormalImport(ImportInfo):
 def __init__(self, names_and_aliases):
 def __init__(
 self,
 names_and_aliases: List[Tuple[str, Optional[str]]],
 ) -> None:
 self.names_and_aliases = names_and_aliases

 def get_imported_primaries(self, context):
 def get_imported_primaries(self, context) -> List[str]:
 result = []
 for name, alias in self.names_and_aliases:
 if alias:
Expand All@@ -117,7 +126,7 @@ def get_imported_primaries(self, context):
 result.append(name)
 return result

 def get_import_statement(self):
 def get_import_statement(self) -> str:
 result = "import "
 for name, alias in self.names_and_aliases:
 result += name
Expand All@@ -131,12 +140,20 @@ def is_empty(self):


class FromImport(ImportInfo):
 def __init__(self, module_name, level, names_and_aliases):
 module_name: str
 level: int

 def __init__(
 self,
 module_name: str,
 level: int,
 names_and_aliases: List[Tuple[str, Optional[str]]],
 ):
 self.module_name = module_name
 self.level = level
 self.names_and_aliases = names_and_aliases

 def get_imported_primaries(self, context):
 def get_imported_primaries(self, context) -> List[str]:
 if self.names_and_aliases[0][0] == "*":
 module = self.get_imported_module(context)
 return [name for name in module if not name.startswith("_")]
Expand DownExpand Up@@ -173,7 +190,7 @@ def get_imported_module(self, context):
 self.module_name, context.folder, self.level
 )

 def get_import_statement(self):
 def get_import_statement(self) -> str:
 result = "from " + "." * self.level + self.module_name + " import "
 for name, alias in self.names_and_aliases:
 result += name
Expand All@@ -190,14 +207,17 @@ def is_star_import(self):


class EmptyImport(ImportInfo):
 names_and_aliases: List[Tuple[str, str]] = []
 names_and_aliases = []

 def is_empty(self):
 return True

 def get_imported_primaries(self, context):
 def get_imported_primaries(self, context) -> List[str]:
 return []

 def get_import_statement(self) -> str:
 raise NotImplementedError()


class ImportContext:
 def __init__(self, project, folder):
Expand Down

22 changes: 22 additions & 0 deletions
ropetest/reprtest.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@
from rope.contrib import findit
from rope.contrib.autoimport import models
from rope.refactor import occurrences
from rope.refactor.importutils import importinfo
from ropetest import testutils


Expand DownExpand Up@@ -165,3 +166,24 @@ def test_autoimport_models_finalquery(project, mod1):
 obj = models.Package.delete_by_package_name
 assert isinstance(obj, models.FinalQuery)
 assert repr(obj) == expected_repr


def test_repr_normal_import(project):
 obj = importinfo.NormalImport([("abc", None), ("ghi", "jkl")])
 expected_repr = '<NormalImport "import abc, ghi as jkl">'
 assert isinstance(obj, importinfo.NormalImport)
 assert repr(obj) == expected_repr


def test_repr_from_import(project):
 obj = importinfo.FromImport("pkg1.pkg2", 0, [("abc", None), ("ghi", "jkl")])
 expected_repr = '<FromImport "from pkg1.pkg2 import abc, ghi as jkl">'
 assert isinstance(obj, importinfo.FromImport)
 assert repr(obj) == expected_repr


def test_repr_from_import_with_level(project):
 obj = importinfo.FromImport("pkg1.pkg2", 3, [("abc", None), ("ghi", "jkl")])
 expected_repr = '<FromImport "from ...pkg1.pkg2 import abc, ghi as jkl">'
 assert isinstance(obj, importinfo.FromImport)
 assert repr(obj) == expected_repr

, '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
Add type hints to importinfo.py and add repr to ImportInfo#787

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 4 commits into

from

Apr 4, 2024
 Merged


Add type hints to importinfo.py and add repr to ImportInfo
#787
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
7e5181a

Add ImportInfo.__repr__()


lieryan Apr 4, 2024
7ac96d2

Add type annotations to importinfo.py


lieryan Apr 4, 2024
1cc05a8

Update CHANGELOG.md


lieryan Apr 4, 2024
3f89161

Add "raise NotImplementedError()" to coverage exclusion


lieryan Apr 4, 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
@@ -1,5 +1,6 @@
# **Upcoming release**

- #787 Add type hints to importinfo.py and add repr to ImportInfo (@lieryan)
- #786 Upgrade Actions used in Github Workflows (@lieryan)
- #785 Refactoring movetest.py (@lieryan)

Expand Down

1 change: 1 addition & 0 deletions
pyproject.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,6 +87,7 @@ force-exclude = 'ropetest|rope/base/prefs.py'
[tool.coverage.report]
exclude_also = [
 "if TYPE_CHECKING:",
 "raise NotImplementedError()",
]

[tool.isort]
Expand Down

48 changes: 34 additions & 14 deletions
rope/refactor/importutils/importinfo.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
from typing import List, Tuple
from abc import abstractmethod, ABC
from typing import List, Tuple, Optional, Protocol


class ImportStatement:
Expand DownExpand Up@@ -64,17 +65,22 @@ def accept(self, visitor):
 return visitor.dispatch(self)


class ImportInfo:
 def get_imported_primaries(self, context):
 pass
class ImportInfo(ABC):
 names_and_aliases: List[Tuple[str, Optional[str]]]

 @abstractmethod
 def get_imported_primaries(self, context) -> List[str]: ...

 def get_imported_names(self, context):
 return [
 primary.split(".")[0] for primary in self.get_imported_primaries(context)
 ]

 def get_import_statement(self):
 pass
 def __repr__(self):
 return f'<{self.__class__.__name__} "{self.get_import_statement()}">'

 @abstractmethod
 def get_import_statement(self) -> str: ...

 def is_empty(self):
 pass
Expand DownExpand Up@@ -105,10 +111,13 @@ def get_empty_import():


class NormalImport(ImportInfo):
 def __init__(self, names_and_aliases):
 def __init__(
 self,
 names_and_aliases: List[Tuple[str, Optional[str]]],
 ) -> None:
 self.names_and_aliases = names_and_aliases

 def get_imported_primaries(self, context):
 def get_imported_primaries(self, context) -> List[str]:
 result = []
 for name, alias in self.names_and_aliases:
 if alias:
Expand All@@ -117,7 +126,7 @@ def get_imported_primaries(self, context):
 result.append(name)
 return result

 def get_import_statement(self):
 def get_import_statement(self) -> str:
 result = "import "
 for name, alias in self.names_and_aliases:
 result += name
Expand All@@ -131,12 +140,20 @@ def is_empty(self):


class FromImport(ImportInfo):
 def __init__(self, module_name, level, names_and_aliases):
 module_name: str
 level: int

 def __init__(
 self,
 module_name: str,
 level: int,
 names_and_aliases: List[Tuple[str, Optional[str]]],
 ):
 self.module_name = module_name
 self.level = level
 self.names_and_aliases = names_and_aliases

 def get_imported_primaries(self, context):
 def get_imported_primaries(self, context) -> List[str]:
 if self.names_and_aliases[0][0] == "*":
 module = self.get_imported_module(context)
 return [name for name in module if not name.startswith("_")]
Expand DownExpand Up@@ -173,7 +190,7 @@ def get_imported_module(self, context):
 self.module_name, context.folder, self.level
 )

 def get_import_statement(self):
 def get_import_statement(self) -> str:
 result = "from " + "." * self.level + self.module_name + " import "
 for name, alias in self.names_and_aliases:
 result += name
Expand All@@ -190,14 +207,17 @@ def is_star_import(self):


class EmptyImport(ImportInfo):
 names_and_aliases: List[Tuple[str, str]] = []
 names_and_aliases = []

 def is_empty(self):
 return True

 def get_imported_primaries(self, context):
 def get_imported_primaries(self, context) -> List[str]:
 return []

 def get_import_statement(self) -> str:
 raise NotImplementedError()


class ImportContext:
 def __init__(self, project, folder):
Expand Down

22 changes: 22 additions & 0 deletions
ropetest/reprtest.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@
from rope.contrib import findit
from rope.contrib.autoimport import models
from rope.refactor import occurrences
from rope.refactor.importutils import importinfo
from ropetest import testutils


Expand DownExpand Up@@ -165,3 +166,24 @@ def test_autoimport_models_finalquery(project, mod1):
 obj = models.Package.delete_by_package_name
 assert isinstance(obj, models.FinalQuery)
 assert repr(obj) == expected_repr


def test_repr_normal_import(project):
 obj = importinfo.NormalImport([("abc", None), ("ghi", "jkl")])
 expected_repr = '<NormalImport "import abc, ghi as jkl">'
 assert isinstance(obj, importinfo.NormalImport)
 assert repr(obj) == expected_repr


def test_repr_from_import(project):
 obj = importinfo.FromImport("pkg1.pkg2", 0, [("abc", None), ("ghi", "jkl")])
 expected_repr = '<FromImport "from pkg1.pkg2 import abc, ghi as jkl">'
 assert isinstance(obj, importinfo.FromImport)
 assert repr(obj) == expected_repr


def test_repr_from_import_with_level(project):
 obj = importinfo.FromImport("pkg1.pkg2", 3, [("abc", None), ("ghi", "jkl")])
 expected_repr = '<FromImport "from ...pkg1.pkg2 import abc, ghi as jkl">'
 assert isinstance(obj, importinfo.FromImport)
 assert repr(obj) == expected_repr

, '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
Add type hints to importinfo.py and add repr to ImportInfo#787

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 4 commits into

from

Apr 4, 2024
 Merged


Add type hints to importinfo.py and add repr to ImportInfo
#787
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
7e5181a

Add ImportInfo.__repr__()


lieryan Apr 4, 2024
7ac96d2

Add type annotations to importinfo.py


lieryan Apr 4, 2024
1cc05a8

Update CHANGELOG.md


lieryan Apr 4, 2024
3f89161

Add "raise NotImplementedError()" to coverage exclusion


lieryan Apr 4, 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
@@ -1,5 +1,6 @@
# **Upcoming release**

- #787 Add type hints to importinfo.py and add repr to ImportInfo (@lieryan)
- #786 Upgrade Actions used in Github Workflows (@lieryan)
- #785 Refactoring movetest.py (@lieryan)

Expand Down

1 change: 1 addition & 0 deletions
pyproject.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,6 +87,7 @@ force-exclude = 'ropetest|rope/base/prefs.py'
[tool.coverage.report]
exclude_also = [
 "if TYPE_CHECKING:",
 "raise NotImplementedError()",
]

[tool.isort]
Expand Down

48 changes: 34 additions & 14 deletions
rope/refactor/importutils/importinfo.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
from typing import List, Tuple
from abc import abstractmethod, ABC
from typing import List, Tuple, Optional, Protocol


class ImportStatement:
Expand DownExpand Up@@ -64,17 +65,22 @@ def accept(self, visitor):
 return visitor.dispatch(self)


class ImportInfo:
 def get_imported_primaries(self, context):
 pass
class ImportInfo(ABC):
 names_and_aliases: List[Tuple[str, Optional[str]]]

 @abstractmethod
 def get_imported_primaries(self, context) -> List[str]: ...

 def get_imported_names(self, context):
 return [
 primary.split(".")[0] for primary in self.get_imported_primaries(context)
 ]

 def get_import_statement(self):
 pass
 def __repr__(self):
 return f'<{self.__class__.__name__} "{self.get_import_statement()}">'

 @abstractmethod
 def get_import_statement(self) -> str: ...

 def is_empty(self):
 pass
Expand DownExpand Up@@ -105,10 +111,13 @@ def get_empty_import():


class NormalImport(ImportInfo):
 def __init__(self, names_and_aliases):
 def __init__(
 self,
 names_and_aliases: List[Tuple[str, Optional[str]]],
 ) -> None:
 self.names_and_aliases = names_and_aliases

 def get_imported_primaries(self, context):
 def get_imported_primaries(self, context) -> List[str]:
 result = []
 for name, alias in self.names_and_aliases:
 if alias:
Expand All@@ -117,7 +126,7 @@ def get_imported_primaries(self, context):
 result.append(name)
 return result

 def get_import_statement(self):
 def get_import_statement(self) -> str:
 result = "import "
 for name, alias in self.names_and_aliases:
 result += name
Expand All@@ -131,12 +140,20 @@ def is_empty(self):


class FromImport(ImportInfo):
 def __init__(self, module_name, level, names_and_aliases):
 module_name: str
 level: int

 def __init__(
 self,
 module_name: str,
 level: int,
 names_and_aliases: List[Tuple[str, Optional[str]]],
 ):
 self.module_name = module_name
 self.level = level
 self.names_and_aliases = names_and_aliases

 def get_imported_primaries(self, context):
 def get_imported_primaries(self, context) -> List[str]:
 if self.names_and_aliases[0][0] == "*":
 module = self.get_imported_module(context)
 return [name for name in module if not name.startswith("_")]
Expand DownExpand Up@@ -173,7 +190,7 @@ def get_imported_module(self, context):
 self.module_name, context.folder, self.level
 )

 def get_import_statement(self):
 def get_import_statement(self) -> str:
 result = "from " + "." * self.level + self.module_name + " import "
 for name, alias in self.names_and_aliases:
 result += name
Expand All@@ -190,14 +207,17 @@ def is_star_import(self):


class EmptyImport(ImportInfo):
 names_and_aliases: List[Tuple[str, str]] = []
 names_and_aliases = []

 def is_empty(self):
 return True

 def get_imported_primaries(self, context):
 def get_imported_primaries(self, context) -> List[str]:
 return []

 def get_import_statement(self) -> str:
 raise NotImplementedError()


class ImportContext:
 def __init__(self, project, folder):
Expand Down

22 changes: 22 additions & 0 deletions
ropetest/reprtest.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@
from rope.contrib import findit
from rope.contrib.autoimport import models
from rope.refactor import occurrences
from rope.refactor.importutils import importinfo
from ropetest import testutils


Expand DownExpand Up@@ -165,3 +166,24 @@ def test_autoimport_models_finalquery(project, mod1):
 obj = models.Package.delete_by_package_name
 assert isinstance(obj, models.FinalQuery)
 assert repr(obj) == expected_repr


def test_repr_normal_import(project):
 obj = importinfo.NormalImport([("abc", None), ("ghi", "jkl")])
 expected_repr = '<NormalImport "import abc, ghi as jkl">'
 assert isinstance(obj, importinfo.NormalImport)
 assert repr(obj) == expected_repr


def test_repr_from_import(project):
 obj = importinfo.FromImport("pkg1.pkg2", 0, [("abc", None), ("ghi", "jkl")])
 expected_repr = '<FromImport "from pkg1.pkg2 import abc, ghi as jkl">'
 assert isinstance(obj, importinfo.FromImport)
 assert repr(obj) == expected_repr


def test_repr_from_import_with_level(project):
 obj = importinfo.FromImport("pkg1.pkg2", 3, [("abc", None), ("ghi", "jkl")])
 expected_repr = '<FromImport "from ...pkg1.pkg2 import abc, ghi as jkl">'
 assert isinstance(obj, importinfo.FromImport)
 assert repr(obj) == expected_repr

, '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
Add type hints to importinfo.py and add repr to ImportInfo#787

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 4 commits into

from

Apr 4, 2024
 Merged


Add type hints to importinfo.py and add repr to ImportInfo
#787
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
7e5181a

Add ImportInfo.__repr__()


lieryan Apr 4, 2024
7ac96d2

Add type annotations to importinfo.py


lieryan Apr 4, 2024
1cc05a8

Update CHANGELOG.md


lieryan Apr 4, 2024
3f89161

Add "raise NotImplementedError()" to coverage exclusion


lieryan Apr 4, 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
@@ -1,5 +1,6 @@
# **Upcoming release**

- #787 Add type hints to importinfo.py and add repr to ImportInfo (@lieryan)
- #786 Upgrade Actions used in Github Workflows (@lieryan)
- #785 Refactoring movetest.py (@lieryan)

Expand Down

1 change: 1 addition & 0 deletions
pyproject.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,6 +87,7 @@ force-exclude = 'ropetest|rope/base/prefs.py'
[tool.coverage.report]
exclude_also = [
 "if TYPE_CHECKING:",
 "raise NotImplementedError()",
]

[tool.isort]
Expand Down

48 changes: 34 additions & 14 deletions
rope/refactor/importutils/importinfo.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
from typing import List, Tuple
from abc import abstractmethod, ABC
from typing import List, Tuple, Optional, Protocol


class ImportStatement:
Expand DownExpand Up@@ -64,17 +65,22 @@ def accept(self, visitor):
 return visitor.dispatch(self)


class ImportInfo:
 def get_imported_primaries(self, context):
 pass
class ImportInfo(ABC):
 names_and_aliases: List[Tuple[str, Optional[str]]]

 @abstractmethod
 def get_imported_primaries(self, context) -> List[str]: ...

 def get_imported_names(self, context):
 return [
 primary.split(".")[0] for primary in self.get_imported_primaries(context)
 ]

 def get_import_statement(self):
 pass
 def __repr__(self):
 return f'<{self.__class__.__name__} "{self.get_import_statement()}">'

 @abstractmethod
 def get_import_statement(self) -> str: ...

 def is_empty(self):
 pass
Expand DownExpand Up@@ -105,10 +111,13 @@ def get_empty_import():


class NormalImport(ImportInfo):
 def __init__(self, names_and_aliases):
 def __init__(
 self,
 names_and_aliases: List[Tuple[str, Optional[str]]],
 ) -> None:
 self.names_and_aliases = names_and_aliases

 def get_imported_primaries(self, context):
 def get_imported_primaries(self, context) -> List[str]:
 result = []
 for name, alias in self.names_and_aliases:
 if alias:
Expand All@@ -117,7 +126,7 @@ def get_imported_primaries(self, context):
 result.append(name)
 return result

 def get_import_statement(self):
 def get_import_statement(self) -> str:
 result = "import "
 for name, alias in self.names_and_aliases:
 result += name
Expand All@@ -131,12 +140,20 @@ def is_empty(self):


class FromImport(ImportInfo):
 def __init__(self, module_name, level, names_and_aliases):
 module_name: str
 level: int

 def __init__(
 self,
 module_name: str,
 level: int,
 names_and_aliases: List[Tuple[str, Optional[str]]],
 ):
 self.module_name = module_name
 self.level = level
 self.names_and_aliases = names_and_aliases

 def get_imported_primaries(self, context):
 def get_imported_primaries(self, context) -> List[str]:
 if self.names_and_aliases[0][0] == "*":
 module = self.get_imported_module(context)
 return [name for name in module if not name.startswith("_")]
Expand DownExpand Up@@ -173,7 +190,7 @@ def get_imported_module(self, context):
 self.module_name, context.folder, self.level
 )

 def get_import_statement(self):
 def get_import_statement(self) -> str:
 result = "from " + "." * self.level + self.module_name + " import "
 for name, alias in self.names_and_aliases:
 result += name
Expand All@@ -190,14 +207,17 @@ def is_star_import(self):


class EmptyImport(ImportInfo):
 names_and_aliases: List[Tuple[str, str]] = []
 names_and_aliases = []

 def is_empty(self):
 return True

 def get_imported_primaries(self, context):
 def get_imported_primaries(self, context) -> List[str]:
 return []

 def get_import_statement(self) -> str:
 raise NotImplementedError()


class ImportContext:
 def __init__(self, project, folder):
Expand Down

22 changes: 22 additions & 0 deletions
ropetest/reprtest.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@
from rope.contrib import findit
from rope.contrib.autoimport import models
from rope.refactor import occurrences
from rope.refactor.importutils import importinfo
from ropetest import testutils


Expand DownExpand Up@@ -165,3 +166,24 @@ def test_autoimport_models_finalquery(project, mod1):
 obj = models.Package.delete_by_package_name
 assert isinstance(obj, models.FinalQuery)
 assert repr(obj) == expected_repr


def test_repr_normal_import(project):
 obj = importinfo.NormalImport([("abc", None), ("ghi", "jkl")])
 expected_repr = '<NormalImport "import abc, ghi as jkl">'
 assert isinstance(obj, importinfo.NormalImport)
 assert repr(obj) == expected_repr


def test_repr_from_import(project):
 obj = importinfo.FromImport("pkg1.pkg2", 0, [("abc", None), ("ghi", "jkl")])
 expected_repr = '<FromImport "from pkg1.pkg2 import abc, ghi as jkl">'
 assert isinstance(obj, importinfo.FromImport)
 assert repr(obj) == expected_repr


def test_repr_from_import_with_level(project):
 obj = importinfo.FromImport("pkg1.pkg2", 3, [("abc", None), ("ghi", "jkl")])
 expected_repr = '<FromImport "from ...pkg1.pkg2 import abc, ghi as jkl">'
 assert isinstance(obj, importinfo.FromImport)
 assert repr(obj) == expected_repr