Cache: Implement resource dict for submit()#451

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
jan-janssen merged 3 commits into from
Oct 27, 2024
Merged

Cache: Implement resource dict for submit() #451

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4f91a27
Cache: Implement resource dict for submit()
jan-janssen Oct 27, 2024
91d2e68
Reduce inputs
jan-janssen Oct 27, 2024
a813845
bug fixes
jan-janssen Oct 27, 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
4 changes: 2 additions & 2 deletions executorlib/cache/executor.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,9 +14,9 @@ class FileExecutor(ExecutorBase):
def __init__(
self,
cache_directory: str = "cache",
execute_function: callable = execute_in_subprocess,
cores_per_worker: int = 1,
cwd: Optional[str] = None,
execute_function: callable = execute_in_subprocess,
terminate_function: Optional[callable] = None,
):
"""
Expand All@@ -26,8 +26,8 @@ def __init__(
cache_directory (str, optional): The directory to store cache files. Defaults to "cache".
execute_function (callable, optional): The function to execute tasks. Defaults to execute_in_subprocess.
cores_per_worker (int, optional): The number of CPU cores per worker. Defaults to 1.
cwd (str/None): current working directory where the parallel python task is executed
terminate_function (callable, optional): The function to terminate the tasks.
cwd (str/None): current working directory where the parallel python task is executed
"""
super().__init__()
if execute_function == execute_in_subprocess and terminate_function is None:
Expand Down
13 changes: 9 additions & 4 deletions executorlib/cache/shared.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,9 +49,9 @@ def done(self) -> bool:
def execute_tasks_h5(
future_queue: queue.Queue,
cache_directory: str,
cores_per_worker: int,
execute_function: callable,
cwd: Optional[str],
cores_per_worker: int = 1,
cwd: Optional[str] = None,
terminate_function: Optional[callable] = None,
) -> None:
"""
Expand DownExpand Up@@ -93,11 +93,16 @@ def execute_tasks_h5(
memory_dict=memory_dict,
file_name_dict=file_name_dict,
)
resource_dict = task_dict["resource_dict"].copy()
if "cores" not in resource_dict:
resource_dict["cores"] = cores_per_worker
if "cwd" not in resource_dict:
resource_dict["cwd"] = cwd
task_key, data_dict = serialize_funct_h5(
fn=task_dict["fn"],
fn_args=task_args,
fn_kwargs=task_kwargs,
resource_dict=task_dict["resource_dict"],
resource_dict=resource_dict,
)
if task_key not in memory_dict.keys():
if task_key + ".h5out" not in os.listdir(cache_directory):
Expand All@@ -111,7 +116,7 @@ def execute_tasks_h5(
task_dependent_lst=[
process_dict[k] for k in future_wait_key_lst
],
cwd=cwd,
resource_dict=resource_dict,
)
file_name_dict[task_key] = os.path.join(
cache_directory, task_key + ".h5out"
Expand Down
13 changes: 10 additions & 3 deletions executorlib/standalone/cache/spawner.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,15 +6,18 @@
def execute_in_subprocess(
command: list,
task_dependent_lst: list = [],
cwd: Optional[str] = None,
resource_dict: Optional[dict] = None,
) -> subprocess.Popen:
"""
Execute a command in a subprocess.

Args:
command (list): The command to be executed.
task_dependent_lst (list): A list of subprocesses that the current subprocess depends on. Defaults to [].
cwd (str/None): current working directory where the parallel python task is executed
resource_dict (dict): resource dictionary, which defines the resources used for the execution of the function.
Example resource dictionary: {
cwd: None,
}

Returns:
subprocess.Popen: The subprocess object.
Expand All@@ -24,7 +27,11 @@ def execute_in_subprocess(
task_dependent_lst = [
task for task in task_dependent_lst if task.poll() is None
]
return subprocess.Popen(command, universal_newlines=True, cwd=cwd)
if resource_dict is None:
resource_dict = {"cwd": None}
elif len(resource_dict) == 0:
resource_dict = {"cwd": None}
return subprocess.Popen(command, universal_newlines=True, cwd=resource_dict["cwd"])
Comment on lines +30 to +34

@coderabbitaicoderabbitaiBotOct 27, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Simplify conditions and future-proof resource handling.

The current implementation can be simplified and made more robust.

Consider these improvements:

- if resource_dict is None:- resource_dict = {"cwd": None}- elif len(resource_dict) == 0:- resource_dict = {"cwd": None}+ if resource_dict is None or len(resource_dict) == 0:+ resource_dict = {"cwd": None}+ # Create a copy to avoid modifying the input dictionary+ resource_dict = resource_dict.copy()

Additionally, consider defining a set of supported resource keys as constants to make the code more maintainable as new resource types are added in the future:

SUPPORTED_RESOURCES= {"cwd"}
🧰 Tools
🪛 Ruff

30-33: Combine if branches using logical or operator

Combine if branches

(SIM114)



def terminate_subprocess(task):
Expand Down
3 changes: 0 additions & 3 deletions tests/test_cache_executor_serial.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,7 +73,6 @@ def test_executor_function(self):
"cache_directory": cache_dir,
"execute_function": execute_in_subprocess,
"cores_per_worker": 1,
"cwd": None,
"terminate_function": terminate_subprocess,
},
)
Expand DownExpand Up@@ -115,7 +114,6 @@ def test_executor_function_dependence_kwargs(self):
"cache_directory": cache_dir,
"execute_function": execute_in_subprocess,
"cores_per_worker": 1,
"cwd": None,
"terminate_function": terminate_subprocess,
},
)
Expand DownExpand Up@@ -157,7 +155,6 @@ def test_executor_function_dependence_args(self):
"cache_directory": cache_dir,
"execute_function": execute_in_subprocess,
"cores_per_worker": 1,
"cwd": None,
"terminate_function": terminate_subprocess,
},
)
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all \u003cpre\u003e\u003ccode\u003e 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

Cache: Implement resource dict for submit()#451

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
jan-janssen merged 3 commits into from
Oct 27, 2024
Merged

Cache: Implement resource dict for submit() #451

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4f91a27
Cache: Implement resource dict for submit()
jan-janssen Oct 27, 2024
91d2e68
Reduce inputs
jan-janssen Oct 27, 2024
a813845
bug fixes
jan-janssen Oct 27, 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
4 changes: 2 additions & 2 deletions executorlib/cache/executor.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,9 +14,9 @@ class FileExecutor(ExecutorBase):
def __init__(
self,
cache_directory: str = "cache",
execute_function: callable = execute_in_subprocess,
cores_per_worker: int = 1,
cwd: Optional[str] = None,
execute_function: callable = execute_in_subprocess,
terminate_function: Optional[callable] = None,
):
"""
Expand All@@ -26,8 +26,8 @@ def __init__(
cache_directory (str, optional): The directory to store cache files. Defaults to "cache".
execute_function (callable, optional): The function to execute tasks. Defaults to execute_in_subprocess.
cores_per_worker (int, optional): The number of CPU cores per worker. Defaults to 1.
cwd (str/None): current working directory where the parallel python task is executed
terminate_function (callable, optional): The function to terminate the tasks.
cwd (str/None): current working directory where the parallel python task is executed
"""
super().__init__()
if execute_function == execute_in_subprocess and terminate_function is None:
Expand Down
13 changes: 9 additions & 4 deletions executorlib/cache/shared.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,9 +49,9 @@ def done(self) -> bool:
def execute_tasks_h5(
future_queue: queue.Queue,
cache_directory: str,
cores_per_worker: int,
execute_function: callable,
cwd: Optional[str],
cores_per_worker: int = 1,
cwd: Optional[str] = None,
terminate_function: Optional[callable] = None,
) -> None:
"""
Expand DownExpand Up@@ -93,11 +93,16 @@ def execute_tasks_h5(
memory_dict=memory_dict,
file_name_dict=file_name_dict,
)
resource_dict = task_dict["resource_dict"].copy()
if "cores" not in resource_dict:
resource_dict["cores"] = cores_per_worker
if "cwd" not in resource_dict:
resource_dict["cwd"] = cwd
task_key, data_dict = serialize_funct_h5(
fn=task_dict["fn"],
fn_args=task_args,
fn_kwargs=task_kwargs,
resource_dict=task_dict["resource_dict"],
resource_dict=resource_dict,
)
if task_key not in memory_dict.keys():
if task_key + ".h5out" not in os.listdir(cache_directory):
Expand All@@ -111,7 +116,7 @@ def execute_tasks_h5(
task_dependent_lst=[
process_dict[k] for k in future_wait_key_lst
],
cwd=cwd,
resource_dict=resource_dict,
)
file_name_dict[task_key] = os.path.join(
cache_directory, task_key + ".h5out"
Expand Down
13 changes: 10 additions & 3 deletions executorlib/standalone/cache/spawner.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,15 +6,18 @@
def execute_in_subprocess(
command: list,
task_dependent_lst: list = [],
cwd: Optional[str] = None,
resource_dict: Optional[dict] = None,
) -> subprocess.Popen:
"""
Execute a command in a subprocess.

Args:
command (list): The command to be executed.
task_dependent_lst (list): A list of subprocesses that the current subprocess depends on. Defaults to [].
cwd (str/None): current working directory where the parallel python task is executed
resource_dict (dict): resource dictionary, which defines the resources used for the execution of the function.
Example resource dictionary: {
cwd: None,
}

Returns:
subprocess.Popen: The subprocess object.
Expand All@@ -24,7 +27,11 @@ def execute_in_subprocess(
task_dependent_lst = [
task for task in task_dependent_lst if task.poll() is None
]
return subprocess.Popen(command, universal_newlines=True, cwd=cwd)
if resource_dict is None:
resource_dict = {"cwd": None}
elif len(resource_dict) == 0:
resource_dict = {"cwd": None}
return subprocess.Popen(command, universal_newlines=True, cwd=resource_dict["cwd"])
Comment on lines +30 to +34

@coderabbitaicoderabbitaiBotOct 27, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Simplify conditions and future-proof resource handling.

The current implementation can be simplified and made more robust.

Consider these improvements:

- if resource_dict is None:- resource_dict = {"cwd": None}- elif len(resource_dict) == 0:- resource_dict = {"cwd": None}+ if resource_dict is None or len(resource_dict) == 0:+ resource_dict = {"cwd": None}+ # Create a copy to avoid modifying the input dictionary+ resource_dict = resource_dict.copy()

Additionally, consider defining a set of supported resource keys as constants to make the code more maintainable as new resource types are added in the future:

SUPPORTED_RESOURCES= {"cwd"}
🧰 Tools
🪛 Ruff

30-33: Combine if branches using logical or operator

Combine if branches

(SIM114)



def terminate_subprocess(task):
Expand Down
3 changes: 0 additions & 3 deletions tests/test_cache_executor_serial.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,7 +73,6 @@ def test_executor_function(self):
"cache_directory": cache_dir,
"execute_function": execute_in_subprocess,
"cores_per_worker": 1,
"cwd": None,
"terminate_function": terminate_subprocess,
},
)
Expand DownExpand Up@@ -115,7 +114,6 @@ def test_executor_function_dependence_kwargs(self):
"cache_directory": cache_dir,
"execute_function": execute_in_subprocess,
"cores_per_worker": 1,
"cwd": None,
"terminate_function": terminate_subprocess,
},
)
Expand DownExpand Up@@ -157,7 +155,6 @@ def test_executor_function_dependence_args(self):
"cache_directory": cache_dir,
"execute_function": execute_in_subprocess,
"cores_per_worker": 1,
"cwd": None,
"terminate_function": terminate_subprocess,
},
)
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

Cache: Implement resource dict for submit()#451

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
jan-janssen merged 3 commits into from
Oct 27, 2024
Merged

Cache: Implement resource dict for submit() #451

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4f91a27
Cache: Implement resource dict for submit()
jan-janssen Oct 27, 2024
91d2e68
Reduce inputs
jan-janssen Oct 27, 2024
a813845
bug fixes
jan-janssen Oct 27, 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
4 changes: 2 additions & 2 deletions executorlib/cache/executor.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,9 +14,9 @@ class FileExecutor(ExecutorBase):
def __init__(
self,
cache_directory: str = "cache",
execute_function: callable = execute_in_subprocess,
cores_per_worker: int = 1,
cwd: Optional[str] = None,
execute_function: callable = execute_in_subprocess,
terminate_function: Optional[callable] = None,
):
"""
Expand All@@ -26,8 +26,8 @@ def __init__(
cache_directory (str, optional): The directory to store cache files. Defaults to "cache".
execute_function (callable, optional): The function to execute tasks. Defaults to execute_in_subprocess.
cores_per_worker (int, optional): The number of CPU cores per worker. Defaults to 1.
cwd (str/None): current working directory where the parallel python task is executed
terminate_function (callable, optional): The function to terminate the tasks.
cwd (str/None): current working directory where the parallel python task is executed
"""
super().__init__()
if execute_function == execute_in_subprocess and terminate_function is None:
Expand Down
13 changes: 9 additions & 4 deletions executorlib/cache/shared.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,9 +49,9 @@ def done(self) -> bool:
def execute_tasks_h5(
future_queue: queue.Queue,
cache_directory: str,
cores_per_worker: int,
execute_function: callable,
cwd: Optional[str],
cores_per_worker: int = 1,
cwd: Optional[str] = None,
terminate_function: Optional[callable] = None,
) -> None:
"""
Expand DownExpand Up@@ -93,11 +93,16 @@ def execute_tasks_h5(
memory_dict=memory_dict,
file_name_dict=file_name_dict,
)
resource_dict = task_dict["resource_dict"].copy()
if "cores" not in resource_dict:
resource_dict["cores"] = cores_per_worker
if "cwd" not in resource_dict:
resource_dict["cwd"] = cwd
task_key, data_dict = serialize_funct_h5(
fn=task_dict["fn"],
fn_args=task_args,
fn_kwargs=task_kwargs,
resource_dict=task_dict["resource_dict"],
resource_dict=resource_dict,
)
if task_key not in memory_dict.keys():
if task_key + ".h5out" not in os.listdir(cache_directory):
Expand All@@ -111,7 +116,7 @@ def execute_tasks_h5(
task_dependent_lst=[
process_dict[k] for k in future_wait_key_lst
],
cwd=cwd,
resource_dict=resource_dict,
)
file_name_dict[task_key] = os.path.join(
cache_directory, task_key + ".h5out"
Expand Down
13 changes: 10 additions & 3 deletions executorlib/standalone/cache/spawner.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,15 +6,18 @@
def execute_in_subprocess(
command: list,
task_dependent_lst: list = [],
cwd: Optional[str] = None,
resource_dict: Optional[dict] = None,
) -> subprocess.Popen:
"""
Execute a command in a subprocess.

Args:
command (list): The command to be executed.
task_dependent_lst (list): A list of subprocesses that the current subprocess depends on. Defaults to [].
cwd (str/None): current working directory where the parallel python task is executed
resource_dict (dict): resource dictionary, which defines the resources used for the execution of the function.
Example resource dictionary: {
cwd: None,
}

Returns:
subprocess.Popen: The subprocess object.
Expand All@@ -24,7 +27,11 @@ def execute_in_subprocess(
task_dependent_lst = [
task for task in task_dependent_lst if task.poll() is None
]
return subprocess.Popen(command, universal_newlines=True, cwd=cwd)
if resource_dict is None:
resource_dict = {"cwd": None}
elif len(resource_dict) == 0:
resource_dict = {"cwd": None}
return subprocess.Popen(command, universal_newlines=True, cwd=resource_dict["cwd"])
Comment on lines +30 to +34

@coderabbitaicoderabbitaiBotOct 27, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Simplify conditions and future-proof resource handling.

The current implementation can be simplified and made more robust.

Consider these improvements:

- if resource_dict is None:- resource_dict = {"cwd": None}- elif len(resource_dict) == 0:- resource_dict = {"cwd": None}+ if resource_dict is None or len(resource_dict) == 0:+ resource_dict = {"cwd": None}+ # Create a copy to avoid modifying the input dictionary+ resource_dict = resource_dict.copy()

Additionally, consider defining a set of supported resource keys as constants to make the code more maintainable as new resource types are added in the future:

SUPPORTED_RESOURCES= {"cwd"}
🧰 Tools
🪛 Ruff

30-33: Combine if branches using logical or operator

Combine if branches

(SIM114)



def terminate_subprocess(task):
Expand Down
3 changes: 0 additions & 3 deletions tests/test_cache_executor_serial.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,7 +73,6 @@ def test_executor_function(self):
"cache_directory": cache_dir,
"execute_function": execute_in_subprocess,
"cores_per_worker": 1,
"cwd": None,
"terminate_function": terminate_subprocess,
},
)
Expand DownExpand Up@@ -115,7 +114,6 @@ def test_executor_function_dependence_kwargs(self):
"cache_directory": cache_dir,
"execute_function": execute_in_subprocess,
"cores_per_worker": 1,
"cwd": None,
"terminate_function": terminate_subprocess,
},
)
Expand DownExpand Up@@ -157,7 +155,6 @@ def test_executor_function_dependence_args(self):
"cache_directory": cache_dir,
"execute_function": execute_in_subprocess,
"cores_per_worker": 1,
"cwd": None,
"terminate_function": terminate_subprocess,
},
)
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 \u003e 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

Cache: Implement resource dict for submit()#451

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
jan-janssen merged 3 commits into from
Oct 27, 2024
Merged

Cache: Implement resource dict for submit() #451

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4f91a27
Cache: Implement resource dict for submit()
jan-janssen Oct 27, 2024
91d2e68
Reduce inputs
jan-janssen Oct 27, 2024
a813845
bug fixes
jan-janssen Oct 27, 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
4 changes: 2 additions & 2 deletions executorlib/cache/executor.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,9 +14,9 @@ class FileExecutor(ExecutorBase):
def __init__(
self,
cache_directory: str = "cache",
execute_function: callable = execute_in_subprocess,
cores_per_worker: int = 1,
cwd: Optional[str] = None,
execute_function: callable = execute_in_subprocess,
terminate_function: Optional[callable] = None,
):
"""
Expand All@@ -26,8 +26,8 @@ def __init__(
cache_directory (str, optional): The directory to store cache files. Defaults to "cache".
execute_function (callable, optional): The function to execute tasks. Defaults to execute_in_subprocess.
cores_per_worker (int, optional): The number of CPU cores per worker. Defaults to 1.
cwd (str/None): current working directory where the parallel python task is executed
terminate_function (callable, optional): The function to terminate the tasks.
cwd (str/None): current working directory where the parallel python task is executed
"""
super().__init__()
if execute_function == execute_in_subprocess and terminate_function is None:
Expand Down
13 changes: 9 additions & 4 deletions executorlib/cache/shared.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,9 +49,9 @@ def done(self) -> bool:
def execute_tasks_h5(
future_queue: queue.Queue,
cache_directory: str,
cores_per_worker: int,
execute_function: callable,
cwd: Optional[str],
cores_per_worker: int = 1,
cwd: Optional[str] = None,
terminate_function: Optional[callable] = None,
) -> None:
"""
Expand DownExpand Up@@ -93,11 +93,16 @@ def execute_tasks_h5(
memory_dict=memory_dict,
file_name_dict=file_name_dict,
)
resource_dict = task_dict["resource_dict"].copy()
if "cores" not in resource_dict:
resource_dict["cores"] = cores_per_worker
if "cwd" not in resource_dict:
resource_dict["cwd"] = cwd
task_key, data_dict = serialize_funct_h5(
fn=task_dict["fn"],
fn_args=task_args,
fn_kwargs=task_kwargs,
resource_dict=task_dict["resource_dict"],
resource_dict=resource_dict,
)
if task_key not in memory_dict.keys():
if task_key + ".h5out" not in os.listdir(cache_directory):
Expand All@@ -111,7 +116,7 @@ def execute_tasks_h5(
task_dependent_lst=[
process_dict[k] for k in future_wait_key_lst
],
cwd=cwd,
resource_dict=resource_dict,
)
file_name_dict[task_key] = os.path.join(
cache_directory, task_key + ".h5out"
Expand Down
13 changes: 10 additions & 3 deletions executorlib/standalone/cache/spawner.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,15 +6,18 @@
def execute_in_subprocess(
command: list,
task_dependent_lst: list = [],
cwd: Optional[str] = None,
resource_dict: Optional[dict] = None,
) -> subprocess.Popen:
"""
Execute a command in a subprocess.

Args:
command (list): The command to be executed.
task_dependent_lst (list): A list of subprocesses that the current subprocess depends on. Defaults to [].
cwd (str/None): current working directory where the parallel python task is executed
resource_dict (dict): resource dictionary, which defines the resources used for the execution of the function.
Example resource dictionary: {
cwd: None,
}

Returns:
subprocess.Popen: The subprocess object.
Expand All@@ -24,7 +27,11 @@ def execute_in_subprocess(
task_dependent_lst = [
task for task in task_dependent_lst if task.poll() is None
]
return subprocess.Popen(command, universal_newlines=True, cwd=cwd)
if resource_dict is None:
resource_dict = {"cwd": None}
elif len(resource_dict) == 0:
resource_dict = {"cwd": None}
return subprocess.Popen(command, universal_newlines=True, cwd=resource_dict["cwd"])
Comment on lines +30 to +34

@coderabbitaicoderabbitaiBotOct 27, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Simplify conditions and future-proof resource handling.

The current implementation can be simplified and made more robust.

Consider these improvements:

- if resource_dict is None:- resource_dict = {"cwd": None}- elif len(resource_dict) == 0:- resource_dict = {"cwd": None}+ if resource_dict is None or len(resource_dict) == 0:+ resource_dict = {"cwd": None}+ # Create a copy to avoid modifying the input dictionary+ resource_dict = resource_dict.copy()

Additionally, consider defining a set of supported resource keys as constants to make the code more maintainable as new resource types are added in the future:

SUPPORTED_RESOURCES= {"cwd"}
🧰 Tools
🪛 Ruff

30-33: Combine if branches using logical or operator

Combine if branches

(SIM114)



def terminate_subprocess(task):
Expand Down
3 changes: 0 additions & 3 deletions tests/test_cache_executor_serial.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,7 +73,6 @@ def test_executor_function(self):
"cache_directory": cache_dir,
"execute_function": execute_in_subprocess,
"cores_per_worker": 1,
"cwd": None,
"terminate_function": terminate_subprocess,
},
)
Expand DownExpand Up@@ -115,7 +114,6 @@ def test_executor_function_dependence_kwargs(self):
"cache_directory": cache_dir,
"execute_function": execute_in_subprocess,
"cores_per_worker": 1,
"cwd": None,
"terminate_function": terminate_subprocess,
},
)
Expand DownExpand Up@@ -157,7 +155,6 @@ def test_executor_function_dependence_args(self):
"cache_directory": cache_dir,
"execute_function": execute_in_subprocess,
"cores_per_worker": 1,
"cwd": None,
"terminate_function": terminate_subprocess,
},
)
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

Cache: Implement resource dict for submit()#451

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
jan-janssen merged 3 commits into from
Oct 27, 2024
Merged

Cache: Implement resource dict for submit() #451

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4f91a27
Cache: Implement resource dict for submit()
jan-janssen Oct 27, 2024
91d2e68
Reduce inputs
jan-janssen Oct 27, 2024
a813845
bug fixes
jan-janssen Oct 27, 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
4 changes: 2 additions & 2 deletions executorlib/cache/executor.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,9 +14,9 @@ class FileExecutor(ExecutorBase):
def __init__(
self,
cache_directory: str = "cache",
execute_function: callable = execute_in_subprocess,
cores_per_worker: int = 1,
cwd: Optional[str] = None,
execute_function: callable = execute_in_subprocess,
terminate_function: Optional[callable] = None,
):
"""
Expand All@@ -26,8 +26,8 @@ def __init__(
cache_directory (str, optional): The directory to store cache files. Defaults to "cache".
execute_function (callable, optional): The function to execute tasks. Defaults to execute_in_subprocess.
cores_per_worker (int, optional): The number of CPU cores per worker. Defaults to 1.
cwd (str/None): current working directory where the parallel python task is executed
terminate_function (callable, optional): The function to terminate the tasks.
cwd (str/None): current working directory where the parallel python task is executed
"""
super().__init__()
if execute_function == execute_in_subprocess and terminate_function is None:
Expand Down
13 changes: 9 additions & 4 deletions executorlib/cache/shared.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,9 +49,9 @@ def done(self) -> bool:
def execute_tasks_h5(
future_queue: queue.Queue,
cache_directory: str,
cores_per_worker: int,
execute_function: callable,
cwd: Optional[str],
cores_per_worker: int = 1,
cwd: Optional[str] = None,
terminate_function: Optional[callable] = None,
) -> None:
"""
Expand DownExpand Up@@ -93,11 +93,16 @@ def execute_tasks_h5(
memory_dict=memory_dict,
file_name_dict=file_name_dict,
)
resource_dict = task_dict["resource_dict"].copy()
if "cores" not in resource_dict:
resource_dict["cores"] = cores_per_worker
if "cwd" not in resource_dict:
resource_dict["cwd"] = cwd
task_key, data_dict = serialize_funct_h5(
fn=task_dict["fn"],
fn_args=task_args,
fn_kwargs=task_kwargs,
resource_dict=task_dict["resource_dict"],
resource_dict=resource_dict,
)
if task_key not in memory_dict.keys():
if task_key + ".h5out" not in os.listdir(cache_directory):
Expand All@@ -111,7 +116,7 @@ def execute_tasks_h5(
task_dependent_lst=[
process_dict[k] for k in future_wait_key_lst
],
cwd=cwd,
resource_dict=resource_dict,
)
file_name_dict[task_key] = os.path.join(
cache_directory, task_key + ".h5out"
Expand Down
13 changes: 10 additions & 3 deletions executorlib/standalone/cache/spawner.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,15 +6,18 @@
def execute_in_subprocess(
command: list,
task_dependent_lst: list = [],
cwd: Optional[str] = None,
resource_dict: Optional[dict] = None,
) -> subprocess.Popen:
"""
Execute a command in a subprocess.

Args:
command (list): The command to be executed.
task_dependent_lst (list): A list of subprocesses that the current subprocess depends on. Defaults to [].
cwd (str/None): current working directory where the parallel python task is executed
resource_dict (dict): resource dictionary, which defines the resources used for the execution of the function.
Example resource dictionary: {
cwd: None,
}

Returns:
subprocess.Popen: The subprocess object.
Expand All@@ -24,7 +27,11 @@ def execute_in_subprocess(
task_dependent_lst = [
task for task in task_dependent_lst if task.poll() is None
]
return subprocess.Popen(command, universal_newlines=True, cwd=cwd)
if resource_dict is None:
resource_dict = {"cwd": None}
elif len(resource_dict) == 0:
resource_dict = {"cwd": None}
return subprocess.Popen(command, universal_newlines=True, cwd=resource_dict["cwd"])
Comment on lines +30 to +34

@coderabbitaicoderabbitaiBotOct 27, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Simplify conditions and future-proof resource handling.

The current implementation can be simplified and made more robust.

Consider these improvements:

- if resource_dict is None:- resource_dict = {"cwd": None}- elif len(resource_dict) == 0:- resource_dict = {"cwd": None}+ if resource_dict is None or len(resource_dict) == 0:+ resource_dict = {"cwd": None}+ # Create a copy to avoid modifying the input dictionary+ resource_dict = resource_dict.copy()

Additionally, consider defining a set of supported resource keys as constants to make the code more maintainable as new resource types are added in the future:

SUPPORTED_RESOURCES= {"cwd"}
🧰 Tools
🪛 Ruff

30-33: Combine if branches using logical or operator

Combine if branches

(SIM114)



def terminate_subprocess(task):
Expand Down
3 changes: 0 additions & 3 deletions tests/test_cache_executor_serial.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,7 +73,6 @@ def test_executor_function(self):
"cache_directory": cache_dir,
"execute_function": execute_in_subprocess,
"cores_per_worker": 1,
"cwd": None,
"terminate_function": terminate_subprocess,
},
)
Expand DownExpand Up@@ -115,7 +114,6 @@ def test_executor_function_dependence_kwargs(self):
"cache_directory": cache_dir,
"execute_function": execute_in_subprocess,
"cores_per_worker": 1,
"cwd": None,
"terminate_function": terminate_subprocess,
},
)
Expand DownExpand Up@@ -157,7 +155,6 @@ def test_executor_function_dependence_args(self):
"cache_directory": cache_dir,
"execute_function": execute_in_subprocess,
"cores_per_worker": 1,
"cwd": None,
"terminate_function": terminate_subprocess,
},
)
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

Cache: Implement resource dict for submit()#451

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
jan-janssen merged 3 commits into from
Oct 27, 2024
Merged

Cache: Implement resource dict for submit() #451

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4f91a27
Cache: Implement resource dict for submit()
jan-janssen Oct 27, 2024
91d2e68
Reduce inputs
jan-janssen Oct 27, 2024
a813845
bug fixes
jan-janssen Oct 27, 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
4 changes: 2 additions & 2 deletions executorlib/cache/executor.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,9 +14,9 @@ class FileExecutor(ExecutorBase):
def __init__(
self,
cache_directory: str = "cache",
execute_function: callable = execute_in_subprocess,
cores_per_worker: int = 1,
cwd: Optional[str] = None,
execute_function: callable = execute_in_subprocess,
terminate_function: Optional[callable] = None,
):
"""
Expand All@@ -26,8 +26,8 @@ def __init__(
cache_directory (str, optional): The directory to store cache files. Defaults to "cache".
execute_function (callable, optional): The function to execute tasks. Defaults to execute_in_subprocess.
cores_per_worker (int, optional): The number of CPU cores per worker. Defaults to 1.
cwd (str/None): current working directory where the parallel python task is executed
terminate_function (callable, optional): The function to terminate the tasks.
cwd (str/None): current working directory where the parallel python task is executed
"""
super().__init__()
if execute_function == execute_in_subprocess and terminate_function is None:
Expand Down
13 changes: 9 additions & 4 deletions executorlib/cache/shared.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,9 +49,9 @@ def done(self) -> bool:
def execute_tasks_h5(
future_queue: queue.Queue,
cache_directory: str,
cores_per_worker: int,
execute_function: callable,
cwd: Optional[str],
cores_per_worker: int = 1,
cwd: Optional[str] = None,
terminate_function: Optional[callable] = None,
) -> None:
"""
Expand DownExpand Up@@ -93,11 +93,16 @@ def execute_tasks_h5(
memory_dict=memory_dict,
file_name_dict=file_name_dict,
)
resource_dict = task_dict["resource_dict"].copy()
if "cores" not in resource_dict:
resource_dict["cores"] = cores_per_worker
if "cwd" not in resource_dict:
resource_dict["cwd"] = cwd
task_key, data_dict = serialize_funct_h5(
fn=task_dict["fn"],
fn_args=task_args,
fn_kwargs=task_kwargs,
resource_dict=task_dict["resource_dict"],
resource_dict=resource_dict,
)
if task_key not in memory_dict.keys():
if task_key + ".h5out" not in os.listdir(cache_directory):
Expand All@@ -111,7 +116,7 @@ def execute_tasks_h5(
task_dependent_lst=[
process_dict[k] for k in future_wait_key_lst
],
cwd=cwd,
resource_dict=resource_dict,
)
file_name_dict[task_key] = os.path.join(
cache_directory, task_key + ".h5out"
Expand Down
13 changes: 10 additions & 3 deletions executorlib/standalone/cache/spawner.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,15 +6,18 @@
def execute_in_subprocess(
command: list,
task_dependent_lst: list = [],
cwd: Optional[str] = None,
resource_dict: Optional[dict] = None,
) -> subprocess.Popen:
"""
Execute a command in a subprocess.

Args:
command (list): The command to be executed.
task_dependent_lst (list): A list of subprocesses that the current subprocess depends on. Defaults to [].
cwd (str/None): current working directory where the parallel python task is executed
resource_dict (dict): resource dictionary, which defines the resources used for the execution of the function.
Example resource dictionary: {
cwd: None,
}

Returns:
subprocess.Popen: The subprocess object.
Expand All@@ -24,7 +27,11 @@ def execute_in_subprocess(
task_dependent_lst = [
task for task in task_dependent_lst if task.poll() is None
]
return subprocess.Popen(command, universal_newlines=True, cwd=cwd)
if resource_dict is None:
resource_dict = {"cwd": None}
elif len(resource_dict) == 0:
resource_dict = {"cwd": None}
return subprocess.Popen(command, universal_newlines=True, cwd=resource_dict["cwd"])
Comment on lines +30 to +34

@coderabbitaicoderabbitaiBotOct 27, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Simplify conditions and future-proof resource handling.

The current implementation can be simplified and made more robust.

Consider these improvements:

- if resource_dict is None:- resource_dict = {"cwd": None}- elif len(resource_dict) == 0:- resource_dict = {"cwd": None}+ if resource_dict is None or len(resource_dict) == 0:+ resource_dict = {"cwd": None}+ # Create a copy to avoid modifying the input dictionary+ resource_dict = resource_dict.copy()

Additionally, consider defining a set of supported resource keys as constants to make the code more maintainable as new resource types are added in the future:

SUPPORTED_RESOURCES= {"cwd"}
🧰 Tools
🪛 Ruff

30-33: Combine if branches using logical or operator

Combine if branches

(SIM114)



def terminate_subprocess(task):
Expand Down
3 changes: 0 additions & 3 deletions tests/test_cache_executor_serial.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,7 +73,6 @@ def test_executor_function(self):
"cache_directory": cache_dir,
"execute_function": execute_in_subprocess,
"cores_per_worker": 1,
"cwd": None,
"terminate_function": terminate_subprocess,
},
)
Expand DownExpand Up@@ -115,7 +114,6 @@ def test_executor_function_dependence_kwargs(self):
"cache_directory": cache_dir,
"execute_function": execute_in_subprocess,
"cores_per_worker": 1,
"cwd": None,
"terminate_function": terminate_subprocess,
},
)
Expand DownExpand Up@@ -157,7 +155,6 @@ def test_executor_function_dependence_args(self):
"cache_directory": cache_dir,
"execute_function": execute_in_subprocess,
"cores_per_worker": 1,
"cwd": None,
"terminate_function": terminate_subprocess,
},
)
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

Cache: Implement resource dict for submit()#451

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
jan-janssen merged 3 commits into from
Oct 27, 2024
Merged

Cache: Implement resource dict for submit() #451

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4f91a27
Cache: Implement resource dict for submit()
jan-janssen Oct 27, 2024
91d2e68
Reduce inputs
jan-janssen Oct 27, 2024
a813845
bug fixes
jan-janssen Oct 27, 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
4 changes: 2 additions & 2 deletions executorlib/cache/executor.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,9 +14,9 @@ class FileExecutor(ExecutorBase):
def __init__(
self,
cache_directory: str = "cache",
execute_function: callable = execute_in_subprocess,
cores_per_worker: int = 1,
cwd: Optional[str] = None,
execute_function: callable = execute_in_subprocess,
terminate_function: Optional[callable] = None,
):
"""
Expand All@@ -26,8 +26,8 @@ def __init__(
cache_directory (str, optional): The directory to store cache files. Defaults to "cache".
execute_function (callable, optional): The function to execute tasks. Defaults to execute_in_subprocess.
cores_per_worker (int, optional): The number of CPU cores per worker. Defaults to 1.
cwd (str/None): current working directory where the parallel python task is executed
terminate_function (callable, optional): The function to terminate the tasks.
cwd (str/None): current working directory where the parallel python task is executed
"""
super().__init__()
if execute_function == execute_in_subprocess and terminate_function is None:
Expand Down
13 changes: 9 additions & 4 deletions executorlib/cache/shared.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,9 +49,9 @@ def done(self) -> bool:
def execute_tasks_h5(
future_queue: queue.Queue,
cache_directory: str,
cores_per_worker: int,
execute_function: callable,
cwd: Optional[str],
cores_per_worker: int = 1,
cwd: Optional[str] = None,
terminate_function: Optional[callable] = None,
) -> None:
"""
Expand DownExpand Up@@ -93,11 +93,16 @@ def execute_tasks_h5(
memory_dict=memory_dict,
file_name_dict=file_name_dict,
)
resource_dict = task_dict["resource_dict"].copy()
if "cores" not in resource_dict:
resource_dict["cores"] = cores_per_worker
if "cwd" not in resource_dict:
resource_dict["cwd"] = cwd
task_key, data_dict = serialize_funct_h5(
fn=task_dict["fn"],
fn_args=task_args,
fn_kwargs=task_kwargs,
resource_dict=task_dict["resource_dict"],
resource_dict=resource_dict,
)
if task_key not in memory_dict.keys():
if task_key + ".h5out" not in os.listdir(cache_directory):
Expand All@@ -111,7 +116,7 @@ def execute_tasks_h5(
task_dependent_lst=[
process_dict[k] for k in future_wait_key_lst
],
cwd=cwd,
resource_dict=resource_dict,
)
file_name_dict[task_key] = os.path.join(
cache_directory, task_key + ".h5out"
Expand Down
13 changes: 10 additions & 3 deletions executorlib/standalone/cache/spawner.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,15 +6,18 @@
def execute_in_subprocess(
command: list,
task_dependent_lst: list = [],
cwd: Optional[str] = None,
resource_dict: Optional[dict] = None,
) -> subprocess.Popen:
"""
Execute a command in a subprocess.

Args:
command (list): The command to be executed.
task_dependent_lst (list): A list of subprocesses that the current subprocess depends on. Defaults to [].
cwd (str/None): current working directory where the parallel python task is executed
resource_dict (dict): resource dictionary, which defines the resources used for the execution of the function.
Example resource dictionary: {
cwd: None,
}

Returns:
subprocess.Popen: The subprocess object.
Expand All@@ -24,7 +27,11 @@ def execute_in_subprocess(
task_dependent_lst = [
task for task in task_dependent_lst if task.poll() is None
]
return subprocess.Popen(command, universal_newlines=True, cwd=cwd)
if resource_dict is None:
resource_dict = {"cwd": None}
elif len(resource_dict) == 0:
resource_dict = {"cwd": None}
return subprocess.Popen(command, universal_newlines=True, cwd=resource_dict["cwd"])
Comment on lines +30 to +34

@coderabbitaicoderabbitaiBotOct 27, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Simplify conditions and future-proof resource handling.

The current implementation can be simplified and made more robust.

Consider these improvements:

- if resource_dict is None:- resource_dict = {"cwd": None}- elif len(resource_dict) == 0:- resource_dict = {"cwd": None}+ if resource_dict is None or len(resource_dict) == 0:+ resource_dict = {"cwd": None}+ # Create a copy to avoid modifying the input dictionary+ resource_dict = resource_dict.copy()

Additionally, consider defining a set of supported resource keys as constants to make the code more maintainable as new resource types are added in the future:

SUPPORTED_RESOURCES= {"cwd"}
🧰 Tools
🪛 Ruff

30-33: Combine if branches using logical or operator

Combine if branches

(SIM114)



def terminate_subprocess(task):
Expand Down
3 changes: 0 additions & 3 deletions tests/test_cache_executor_serial.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,7 +73,6 @@ def test_executor_function(self):
"cache_directory": cache_dir,
"execute_function": execute_in_subprocess,
"cores_per_worker": 1,
"cwd": None,
"terminate_function": terminate_subprocess,
},
)
Expand DownExpand Up@@ -115,7 +114,6 @@ def test_executor_function_dependence_kwargs(self):
"cache_directory": cache_dir,
"execute_function": execute_in_subprocess,
"cores_per_worker": 1,
"cwd": None,
"terminate_function": terminate_subprocess,
},
)
Expand DownExpand Up@@ -157,7 +155,6 @@ def test_executor_function_dependence_args(self):
"cache_directory": cache_dir,
"execute_function": execute_in_subprocess,
"cores_per_worker": 1,
"cwd": None,
"terminate_function": terminate_subprocess,
},
)
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

Cache: Implement resource dict for submit()#451

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
jan-janssen merged 3 commits into from
Oct 27, 2024
Merged

Cache: Implement resource dict for submit() #451

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4f91a27
Cache: Implement resource dict for submit()
jan-janssen Oct 27, 2024
91d2e68
Reduce inputs
jan-janssen Oct 27, 2024
a813845
bug fixes
jan-janssen Oct 27, 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
4 changes: 2 additions & 2 deletions executorlib/cache/executor.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,9 +14,9 @@ class FileExecutor(ExecutorBase):
def __init__(
self,
cache_directory: str = "cache",
execute_function: callable = execute_in_subprocess,
cores_per_worker: int = 1,
cwd: Optional[str] = None,
execute_function: callable = execute_in_subprocess,
terminate_function: Optional[callable] = None,
):
"""
Expand All@@ -26,8 +26,8 @@ def __init__(
cache_directory (str, optional): The directory to store cache files. Defaults to "cache".
execute_function (callable, optional): The function to execute tasks. Defaults to execute_in_subprocess.
cores_per_worker (int, optional): The number of CPU cores per worker. Defaults to 1.
cwd (str/None): current working directory where the parallel python task is executed
terminate_function (callable, optional): The function to terminate the tasks.
cwd (str/None): current working directory where the parallel python task is executed
"""
super().__init__()
if execute_function == execute_in_subprocess and terminate_function is None:
Expand Down
13 changes: 9 additions & 4 deletions executorlib/cache/shared.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,9 +49,9 @@ def done(self) -> bool:
def execute_tasks_h5(
future_queue: queue.Queue,
cache_directory: str,
cores_per_worker: int,
execute_function: callable,
cwd: Optional[str],
cores_per_worker: int = 1,
cwd: Optional[str] = None,
terminate_function: Optional[callable] = None,
) -> None:
"""
Expand DownExpand Up@@ -93,11 +93,16 @@ def execute_tasks_h5(
memory_dict=memory_dict,
file_name_dict=file_name_dict,
)
resource_dict = task_dict["resource_dict"].copy()
if "cores" not in resource_dict:
resource_dict["cores"] = cores_per_worker
if "cwd" not in resource_dict:
resource_dict["cwd"] = cwd
task_key, data_dict = serialize_funct_h5(
fn=task_dict["fn"],
fn_args=task_args,
fn_kwargs=task_kwargs,
resource_dict=task_dict["resource_dict"],
resource_dict=resource_dict,
)
if task_key not in memory_dict.keys():
if task_key + ".h5out" not in os.listdir(cache_directory):
Expand All@@ -111,7 +116,7 @@ def execute_tasks_h5(
task_dependent_lst=[
process_dict[k] for k in future_wait_key_lst
],
cwd=cwd,
resource_dict=resource_dict,
)
file_name_dict[task_key] = os.path.join(
cache_directory, task_key + ".h5out"
Expand Down
13 changes: 10 additions & 3 deletions executorlib/standalone/cache/spawner.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,15 +6,18 @@
def execute_in_subprocess(
command: list,
task_dependent_lst: list = [],
cwd: Optional[str] = None,
resource_dict: Optional[dict] = None,
) -> subprocess.Popen:
"""
Execute a command in a subprocess.

Args:
command (list): The command to be executed.
task_dependent_lst (list): A list of subprocesses that the current subprocess depends on. Defaults to [].
cwd (str/None): current working directory where the parallel python task is executed
resource_dict (dict): resource dictionary, which defines the resources used for the execution of the function.
Example resource dictionary: {
cwd: None,
}

Returns:
subprocess.Popen: The subprocess object.
Expand All@@ -24,7 +27,11 @@ def execute_in_subprocess(
task_dependent_lst = [
task for task in task_dependent_lst if task.poll() is None
]
return subprocess.Popen(command, universal_newlines=True, cwd=cwd)
if resource_dict is None:
resource_dict = {"cwd": None}
elif len(resource_dict) == 0:
resource_dict = {"cwd": None}
return subprocess.Popen(command, universal_newlines=True, cwd=resource_dict["cwd"])
Comment on lines +30 to +34

@coderabbitaicoderabbitaiBotOct 27, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Simplify conditions and future-proof resource handling.

The current implementation can be simplified and made more robust.

Consider these improvements:

- if resource_dict is None:- resource_dict = {"cwd": None}- elif len(resource_dict) == 0:- resource_dict = {"cwd": None}+ if resource_dict is None or len(resource_dict) == 0:+ resource_dict = {"cwd": None}+ # Create a copy to avoid modifying the input dictionary+ resource_dict = resource_dict.copy()

Additionally, consider defining a set of supported resource keys as constants to make the code more maintainable as new resource types are added in the future:

SUPPORTED_RESOURCES= {"cwd"}
🧰 Tools
🪛 Ruff

30-33: Combine if branches using logical or operator

Combine if branches

(SIM114)



def terminate_subprocess(task):
Expand Down
3 changes: 0 additions & 3 deletions tests/test_cache_executor_serial.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,7 +73,6 @@ def test_executor_function(self):
"cache_directory": cache_dir,
"execute_function": execute_in_subprocess,
"cores_per_worker": 1,
"cwd": None,
"terminate_function": terminate_subprocess,
},
)
Expand DownExpand Up@@ -115,7 +114,6 @@ def test_executor_function_dependence_kwargs(self):
"cache_directory": cache_dir,
"execute_function": execute_in_subprocess,
"cores_per_worker": 1,
"cwd": None,
"terminate_function": terminate_subprocess,
},
)
Expand DownExpand Up@@ -157,7 +155,6 @@ def test_executor_function_dependence_args(self):
"cache_directory": cache_dir,
"execute_function": execute_in_subprocess,
"cores_per_worker": 1,
"cwd": None,
"terminate_function": terminate_subprocess,
},
)
Expand Down