Get data from cache#525

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 2 commits into from
Dec 17, 2024
Merged

Get data from cache #525

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d1e72c4
Get data from cache
jan-janssen Dec 17, 2024
cf7bce5
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 17, 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
34 changes: 25 additions & 9 deletions executorlib/standalone/hdf.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,19 @@
from typing import Optional, Tuple
import os
from typing import List, Optional, Tuple

import cloudpickle
import h5py
import numpy as np

group_dict = {
"fn": "function",
"args": "input_args",
"kwargs": "input_kwargs",
"output": "output",
"runtime": "runtime",
"queue_id": "queue_id",
}


def dump(file_name: str, data_dict: dict) -> None:
"""
Expand All@@ -13,14 +23,6 @@ def dump(file_name: str, data_dict: dict) -> None:
file_name (str): file name of the HDF5 file as absolute path
data_dict (dict): dictionary containing the python function to be executed {"fn": ..., "args": (), "kwargs": {}}
"""
group_dict = {
"fn": "function",
"args": "input_args",
"kwargs": "input_kwargs",
"output": "output",
"runtime": "runtime",
"queue_id": "queue_id",
}
with h5py.File(file_name, "a") as fname:
for data_key, data_value in data_dict.items():
if data_key in group_dict.keys():
Expand DownExpand Up@@ -97,3 +99,17 @@ def get_queue_id(file_name: str) -> Optional[int]:
return cloudpickle.loads(np.void(hdf["/queue_id"]))
else:
return None


def get_cache_data(cache_directory: str) -> List[dict]:
file_lst = []
for file_name in os.listdir(cache_directory):
with h5py.File(os.path.join(cache_directory, file_name), "r") as hdf:
file_content_dict = {
key: cloudpickle.loads(np.void(hdf["/" + key]))
for key in group_dict.values()
if key in hdf
}
file_content_dict["filename"] = file_name
file_lst.append(file_content_dict)
return file_lst
Comment on lines +104 to +115

@coderabbitaicoderabbitaiBotDec 17, 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.

⚠️ Potential issue

Add error handling and improve resource management

The function needs additional safeguards for robustness:

  1. Missing directory existence check
  2. No error handling for invalid HDF5 files
  3. Resource management could be improved using context manager pattern

Consider this improved implementation:

 def get_cache_data(cache_directory: str) -> List[dict]:
+ if not os.path.isdir(cache_directory):+ raise ValueError(f"Cache directory does not exist: {cache_directory}")+
file_lst = []
for file_name in os.listdir(cache_directory):
- with h5py.File(os.path.join(cache_directory, file_name), "r") as hdf:- file_content_dict = {- key: cloudpickle.loads(np.void(hdf["/" + key]))- for key in group_dict.values()- if key in hdf- }- file_content_dict["filename"] = file_name- file_lst.append(file_content_dict)+ file_path = os.path.join(cache_directory, file_name)+ try:+ with h5py.File(file_path, "r") as hdf:+ file_content_dict = {+ key: cloudpickle.loads(np.void(hdf["/" + key]))+ for key in group_dict.values()+ if key in hdf+ }+ file_content_dict["filename"] = file_name+ file_lst.append(file_content_dict)+ except (OSError, KeyError) as e:+ # Log warning but continue processing other files+ import warnings+ warnings.warn(f"Failed to read cache file {file_name}: {str(e)}")
return file_lst
📝 Committable suggestion

‼️IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
defget_cache_data(cache_directory: str) ->List[dict]:
file_lst= []
forfile_nameinos.listdir(cache_directory):
withh5py.File(os.path.join(cache_directory, file_name), "r") ashdf:
file_content_dict= {
key: cloudpickle.loads(np.void(hdf["/"+key]))
forkeyingroup_dict.values()
ifkeyinhdf
}
file_content_dict["filename"] =file_name
file_lst.append(file_content_dict)
returnfile_lst
defget_cache_data(cache_directory: str) ->List[dict]:
ifnotos.path.isdir(cache_directory):
raiseValueError(f"Cache directory does not exist: {cache_directory}")
file_lst= []
forfile_nameinos.listdir(cache_directory):
file_path=os.path.join(cache_directory, file_name)
try:
withh5py.File(file_path, "r") ashdf:
file_content_dict= {
key: cloudpickle.loads(np.void(hdf["/"+key]))
forkeyingroup_dict.values()
ifkeyinhdf
}
file_content_dict["filename"] =file_name
file_lst.append(file_content_dict)
except (OSError, KeyError) ase:
# Log warning but continue processing other files
importwarnings
warnings.warn(f"Failed to read cache file {file_name}: {str(e)}")
returnfile_lst

33 changes: 33 additions & 0 deletions tests/test_cache_executor_interactive.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
import os
import shutil
import unittest

from executorlib import Executor

try:
from executorlib.standalone.hdf import get_cache_data

skip_h5py_test = False
except ImportError:
skip_h5py_test = True


@unittest.skipIf(
skip_h5py_test, "h5py is not installed, so the h5io tests are skipped."
)
class TestCacheFunctions(unittest.TestCase):
def test_cache_data(self):
cache_directory = "./cache"
with Executor(backend="local", cache_directory=cache_directory) as exe:
future_lst = [exe.submit(sum, [i, i]) for i in range(1, 4)]
result_lst = [f.result() for f in future_lst]

cache_lst = get_cache_data(cache_directory=cache_directory)
self.assertEqual(sum([c["output"] for c in cache_lst]), sum(result_lst))
self.assertEqual(
sum([sum(c["input_args"][0]) for c in cache_lst]), sum(result_lst)
)
Comment on lines +19 to +29

@coderabbitaicoderabbitaiBotDec 17, 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

Enhance test coverage and use temporary directory

The test could be improved in several ways:

  1. Use tempfile.mkdtemp() instead of hardcoded "./cache"
  2. Add test cases for error conditions
  3. Validate all cached fields, not just output and input_args

Consider this improved implementation:

+import tempfile+
def test_cache_data(self):
- cache_directory = "./cache"+ cache_directory = tempfile.mkdtemp()
with Executor(backend="local", cache_directory=cache_directory) as exe:
future_lst = [exe.submit(sum, [i, i]) for i in range(1, 4)]
result_lst = [f.result() for f in future_lst]
cache_lst = get_cache_data(cache_directory=cache_directory)
+ # Validate cache size+ self.assertEqual(len(cache_lst), len(future_lst))++ # Validate all cached fields+ for cache_entry in cache_lst:+ self.assertIn('function', cache_entry)+ self.assertIn('input_args', cache_entry)+ self.assertIn('input_kwargs', cache_entry)+ self.assertIn('output', cache_entry)+ self.assertIn('runtime', cache_entry)+
self.assertEqual(sum([c["output"] for c in cache_lst]), sum(result_lst))
self.assertEqual(
sum([sum(c["input_args"][0]) for c in cache_lst]), sum(result_lst)
)
++def test_cache_data_invalid_directory(self):+ with self.assertRaises(ValueError):+ get_cache_data("/nonexistent/path")
📝 Committable suggestion

‼️IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
deftest_cache_data(self):
cache_directory="./cache"
withExecutor(backend="local", cache_directory=cache_directory) asexe:
future_lst= [exe.submit(sum, [i, i]) foriinrange(1, 4)]
result_lst= [f.result() forfinfuture_lst]
cache_lst=get_cache_data(cache_directory=cache_directory)
self.assertEqual(sum([c["output"] forcincache_lst]), sum(result_lst))
self.assertEqual(
sum([sum(c["input_args"][0]) forcincache_lst]), sum(result_lst)
)
deftest_cache_data(self):
cache_directory=tempfile.mkdtemp()
withExecutor(backend="local", cache_directory=cache_directory) asexe:
future_lst= [exe.submit(sum, [i, i]) foriinrange(1, 4)]
result_lst= [f.result() forfinfuture_lst]
cache_lst=get_cache_data(cache_directory=cache_directory)
# Validate cache size
self.assertEqual(len(cache_lst), len(future_lst))
# Validate all cached fields
forcache_entryincache_lst:
self.assertIn('function', cache_entry)
self.assertIn('input_args', cache_entry)
self.assertIn('input_kwargs', cache_entry)
self.assertIn('output', cache_entry)
self.assertIn('runtime', cache_entry)
self.assertEqual(sum([c["output"] forcincache_lst]), sum(result_lst))
self.assertEqual(
sum([sum(c["input_args"][0]) forcincache_lst]), sum(result_lst)
)
deftest_cache_data_invalid_directory(self):
withself.assertRaises(ValueError):
get_cache_data("/nonexistent/path")


def tearDown(self):
if os.path.exists("cache"):
shutil.rmtree("cache")
Comment on lines +31 to +33

@coderabbitaicoderabbitaiBotDec 17, 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

Update cleanup to use test's cache directory

The tearDown method should clean up the temporary directory used in the test, not a hardcoded path.

 def tearDown(self):
- if os.path.exists("cache"):- shutil.rmtree("cache")+ if hasattr(self, '_testMethodName'):+ method = getattr(self, self._testMethodName)+ if hasattr(method, 'cache_directory'):+ shutil.rmtree(method.cache_directory)

Committable suggestion skipped: line range outside the PR's diff.

, '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
Get data from cache#525

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

from

Dec 17, 2024
 Merged


Get data from cache
#525
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d1e72c4

Get data from cache


jan-janssen Dec 17, 2024
cf7bce5

[pre-commit.ci] auto fixes from pre-commit.com hooks


pre-commit-ci[bot] Dec 17, 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


34 changes: 25 additions & 9 deletions
executorlib/standalone/hdf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,19 @@
from typing import Optional, Tuple
import os
from typing import List, Optional, Tuple

import cloudpickle
import h5py
import numpy as np

group_dict = {
 "fn": "function",
 "args": "input_args",
 "kwargs": "input_kwargs",
 "output": "output",
 "runtime": "runtime",
 "queue_id": "queue_id",
}


def dump(file_name: str, data_dict: dict) -> None:
 """
Expand All@@ -13,14 +23,6 @@ def dump(file_name: str, data_dict: dict) -> None:
 file_name (str): file name of the HDF5 file as absolute path
 data_dict (dict): dictionary containing the python function to be executed {"fn": ..., "args": (), "kwargs": {}}
 """
 group_dict = {
 "fn": "function",
 "args": "input_args",
 "kwargs": "input_kwargs",
 "output": "output",
 "runtime": "runtime",
 "queue_id": "queue_id",
 }
 with h5py.File(file_name, "a") as fname:
 for data_key, data_value in data_dict.items():
 if data_key in group_dict.keys():
Expand DownExpand Up@@ -97,3 +99,17 @@ def get_queue_id(file_name: str) -> Optional[int]:
 return cloudpickle.loads(np.void(hdf["/queue_id"]))
 else:
 return None


def get_cache_data(cache_directory: str) -> List[dict]:
 file_lst = []
 for file_name in os.listdir(cache_directory):
 with h5py.File(os.path.join(cache_directory, file_name), "r") as hdf:
 file_content_dict = {
 key: cloudpickle.loads(np.void(hdf["/" + key]))
 for key in group_dict.values()
 if key in hdf
 }
 file_content_dict["filename"] = file_name
 file_lst.append(file_content_dict)
 return file_lst

Comment on lines

+104
 to 
+115

@coderabbitaicoderabbitaiBotDec 17, 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.

⚠️ Potential issue
Add error handling and improve resource management
The function needs additional safeguards for robustness:
  1. Missing directory existence check
  2. No error handling for invalid HDF5 files
  3. Resource management could be improved using context manager pattern
Consider this improved implementation:
 def get_cache_data(cache_directory: str) -> List[dict]:
+ if not os.path.isdir(cache_directory):+ raise ValueError(f"Cache directory does not exist: {cache_directory}")+
file_lst = []
for file_name in os.listdir(cache_directory):
- with h5py.File(os.path.join(cache_directory, file_name), "r") as hdf:- file_content_dict = {- key: cloudpickle.loads(np.void(hdf["/" + key]))- for key in group_dict.values()- if key in hdf- }- file_content_dict["filename"] = file_name- file_lst.append(file_content_dict)+ file_path = os.path.join(cache_directory, file_name)+ try:+ with h5py.File(file_path, "r") as hdf:+ file_content_dict = {+ key: cloudpickle.loads(np.void(hdf["/" + key]))+ for key in group_dict.values()+ if key in hdf+ }+ file_content_dict["filename"] = file_name+ file_lst.append(file_content_dict)+ except (OSError, KeyError) as e:+ # Log warning but continue processing other files+ import warnings+ warnings.warn(f"Failed to read cache file {file_name}: {str(e)}")
return file_lst
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

defget_cache_data(cache_directory: str) ->List[dict]:
file_lst= []
forfile_nameinos.listdir(cache_directory):
withh5py.File(os.path.join(cache_directory, file_name), "r") ashdf:
file_content_dict= {
key: cloudpickle.loads(np.void(hdf["/"+key]))
forkeyingroup_dict.values()
ifkeyinhdf
 }
file_content_dict["filename"] =file_name
file_lst.append(file_content_dict)
returnfile_lst
defget_cache_data(cache_directory: str) ->List[dict]:
ifnotos.path.isdir(cache_directory):
raiseValueError(f"Cache directory does not exist: {cache_directory}")
file_lst= []
forfile_nameinos.listdir(cache_directory):
file_path=os.path.join(cache_directory, file_name)
try:
withh5py.File(file_path, "r") ashdf:
file_content_dict= {
key: cloudpickle.loads(np.void(hdf["/"+key]))
forkeyingroup_dict.values()
ifkeyinhdf
 }
file_content_dict["filename"] =file_name
file_lst.append(file_content_dict)
except (OSError, KeyError) ase:
# Log warning but continue processing other files
importwarnings
warnings.warn(f"Failed to read cache file {file_name}: {str(e)}")
returnfile_lst

33 changes: 33 additions & 0 deletions
tests/test_cache_executor_interactive.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
import os
import shutil
import unittest

from executorlib import Executor

try:
 from executorlib.standalone.hdf import get_cache_data

 skip_h5py_test = False
except ImportError:
 skip_h5py_test = True


@unittest.skipIf(
 skip_h5py_test, "h5py is not installed, so the h5io tests are skipped."
)
class TestCacheFunctions(unittest.TestCase):
 def test_cache_data(self):
 cache_directory = "./cache"
 with Executor(backend="local", cache_directory=cache_directory) as exe:
 future_lst = [exe.submit(sum, [i, i]) for i in range(1, 4)]
 result_lst = [f.result() for f in future_lst]

 cache_lst = get_cache_data(cache_directory=cache_directory)
 self.assertEqual(sum([c["output"] for c in cache_lst]), sum(result_lst))
 self.assertEqual(
 sum([sum(c["input_args"][0]) for c in cache_lst]), sum(result_lst)
 )

Comment on lines

+19
 to 
+29

@coderabbitaicoderabbitaiBotDec 17, 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
Enhance test coverage and use temporary directory
The test could be improved in several ways:
  1. Use tempfile.mkdtemp() instead of hardcoded "./cache"
  2. Add test cases for error conditions
  3. Validate all cached fields, not just output and input_args
Consider this improved implementation:
+import tempfile+
def test_cache_data(self):
- cache_directory = "./cache"+ cache_directory = tempfile.mkdtemp()
with Executor(backend="local", cache_directory=cache_directory) as exe:
future_lst = [exe.submit(sum, [i, i]) for i in range(1, 4)]
result_lst = [f.result() for f in future_lst]
cache_lst = get_cache_data(cache_directory=cache_directory)
+ # Validate cache size+ self.assertEqual(len(cache_lst), len(future_lst))++ # Validate all cached fields+ for cache_entry in cache_lst:+ self.assertIn('function', cache_entry)+ self.assertIn('input_args', cache_entry)+ self.assertIn('input_kwargs', cache_entry)+ self.assertIn('output', cache_entry)+ self.assertIn('runtime', cache_entry)+
self.assertEqual(sum([c["output"] for c in cache_lst]), sum(result_lst))
self.assertEqual(
sum([sum(c["input_args"][0]) for c in cache_lst]), sum(result_lst)
)
++def test_cache_data_invalid_directory(self):+ with self.assertRaises(ValueError):+ get_cache_data("/nonexistent/path")
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

deftest_cache_data(self):
cache_directory="./cache"
withExecutor(backend="local", cache_directory=cache_directory) asexe:
future_lst= [exe.submit(sum, [i, i]) foriinrange(1, 4)]
result_lst= [f.result() forfinfuture_lst]
cache_lst=get_cache_data(cache_directory=cache_directory)
self.assertEqual(sum([c["output"] forcincache_lst]), sum(result_lst))
self.assertEqual(
sum([sum(c["input_args"][0]) forcincache_lst]), sum(result_lst)
 )
deftest_cache_data(self):
cache_directory=tempfile.mkdtemp()
withExecutor(backend="local", cache_directory=cache_directory) asexe:
future_lst= [exe.submit(sum, [i, i]) foriinrange(1, 4)]
result_lst= [f.result() forfinfuture_lst]
cache_lst=get_cache_data(cache_directory=cache_directory)
# Validate cache size
self.assertEqual(len(cache_lst), len(future_lst))
# Validate all cached fields
forcache_entryincache_lst:
self.assertIn('function', cache_entry)
self.assertIn('input_args', cache_entry)
self.assertIn('input_kwargs', cache_entry)
self.assertIn('output', cache_entry)
self.assertIn('runtime', cache_entry)
self.assertEqual(sum([c["output"] forcincache_lst]), sum(result_lst))
self.assertEqual(
sum([sum(c["input_args"][0]) forcincache_lst]), sum(result_lst)
 )
deftest_cache_data_invalid_directory(self):
withself.assertRaises(ValueError):
get_cache_data("/nonexistent/path")

 def tearDown(self):
 if os.path.exists("cache"):
 shutil.rmtree("cache")

Comment on lines

+31
 to 
+33

@coderabbitaicoderabbitaiBotDec 17, 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
Update cleanup to use test's cache directory
The tearDown method should clean up the temporary directory used in the test, not a hardcoded path.
 def tearDown(self):
- if os.path.exists("cache"):- shutil.rmtree("cache")+ if hasattr(self, '_testMethodName'):+ method = getattr(self, self._testMethodName)+ if hasattr(method, 'cache_directory'):+ shutil.rmtree(method.cache_directory)
Committable suggestion skipped: line range outside the PR's diff.

, '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
Get data from cache#525

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

from

Dec 17, 2024
 Merged


Get data from cache
#525
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d1e72c4

Get data from cache


jan-janssen Dec 17, 2024
cf7bce5

[pre-commit.ci] auto fixes from pre-commit.com hooks


pre-commit-ci[bot] Dec 17, 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


34 changes: 25 additions & 9 deletions
executorlib/standalone/hdf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,19 @@
from typing import Optional, Tuple
import os
from typing import List, Optional, Tuple

import cloudpickle
import h5py
import numpy as np

group_dict = {
 "fn": "function",
 "args": "input_args",
 "kwargs": "input_kwargs",
 "output": "output",
 "runtime": "runtime",
 "queue_id": "queue_id",
}


def dump(file_name: str, data_dict: dict) -> None:
 """
Expand All@@ -13,14 +23,6 @@ def dump(file_name: str, data_dict: dict) -> None:
 file_name (str): file name of the HDF5 file as absolute path
 data_dict (dict): dictionary containing the python function to be executed {"fn": ..., "args": (), "kwargs": {}}
 """
 group_dict = {
 "fn": "function",
 "args": "input_args",
 "kwargs": "input_kwargs",
 "output": "output",
 "runtime": "runtime",
 "queue_id": "queue_id",
 }
 with h5py.File(file_name, "a") as fname:
 for data_key, data_value in data_dict.items():
 if data_key in group_dict.keys():
Expand DownExpand Up@@ -97,3 +99,17 @@ def get_queue_id(file_name: str) -> Optional[int]:
 return cloudpickle.loads(np.void(hdf["/queue_id"]))
 else:
 return None


def get_cache_data(cache_directory: str) -> List[dict]:
 file_lst = []
 for file_name in os.listdir(cache_directory):
 with h5py.File(os.path.join(cache_directory, file_name), "r") as hdf:
 file_content_dict = {
 key: cloudpickle.loads(np.void(hdf["/" + key]))
 for key in group_dict.values()
 if key in hdf
 }
 file_content_dict["filename"] = file_name
 file_lst.append(file_content_dict)
 return file_lst

Comment on lines

+104
 to 
+115

@coderabbitaicoderabbitaiBotDec 17, 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.

⚠️ Potential issue
Add error handling and improve resource management
The function needs additional safeguards for robustness:
  1. Missing directory existence check
  2. No error handling for invalid HDF5 files
  3. Resource management could be improved using context manager pattern
Consider this improved implementation:
 def get_cache_data(cache_directory: str) -> List[dict]:
+ if not os.path.isdir(cache_directory):+ raise ValueError(f"Cache directory does not exist: {cache_directory}")+
file_lst = []
for file_name in os.listdir(cache_directory):
- with h5py.File(os.path.join(cache_directory, file_name), "r") as hdf:- file_content_dict = {- key: cloudpickle.loads(np.void(hdf["/" + key]))- for key in group_dict.values()- if key in hdf- }- file_content_dict["filename"] = file_name- file_lst.append(file_content_dict)+ file_path = os.path.join(cache_directory, file_name)+ try:+ with h5py.File(file_path, "r") as hdf:+ file_content_dict = {+ key: cloudpickle.loads(np.void(hdf["/" + key]))+ for key in group_dict.values()+ if key in hdf+ }+ file_content_dict["filename"] = file_name+ file_lst.append(file_content_dict)+ except (OSError, KeyError) as e:+ # Log warning but continue processing other files+ import warnings+ warnings.warn(f"Failed to read cache file {file_name}: {str(e)}")
return file_lst
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

defget_cache_data(cache_directory: str) ->List[dict]:
file_lst= []
forfile_nameinos.listdir(cache_directory):
withh5py.File(os.path.join(cache_directory, file_name), "r") ashdf:
file_content_dict= {
key: cloudpickle.loads(np.void(hdf["/"+key]))
forkeyingroup_dict.values()
ifkeyinhdf
 }
file_content_dict["filename"] =file_name
file_lst.append(file_content_dict)
returnfile_lst
defget_cache_data(cache_directory: str) ->List[dict]:
ifnotos.path.isdir(cache_directory):
raiseValueError(f"Cache directory does not exist: {cache_directory}")
file_lst= []
forfile_nameinos.listdir(cache_directory):
file_path=os.path.join(cache_directory, file_name)
try:
withh5py.File(file_path, "r") ashdf:
file_content_dict= {
key: cloudpickle.loads(np.void(hdf["/"+key]))
forkeyingroup_dict.values()
ifkeyinhdf
 }
file_content_dict["filename"] =file_name
file_lst.append(file_content_dict)
except (OSError, KeyError) ase:
# Log warning but continue processing other files
importwarnings
warnings.warn(f"Failed to read cache file {file_name}: {str(e)}")
returnfile_lst

33 changes: 33 additions & 0 deletions
tests/test_cache_executor_interactive.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
import os
import shutil
import unittest

from executorlib import Executor

try:
 from executorlib.standalone.hdf import get_cache_data

 skip_h5py_test = False
except ImportError:
 skip_h5py_test = True


@unittest.skipIf(
 skip_h5py_test, "h5py is not installed, so the h5io tests are skipped."
)
class TestCacheFunctions(unittest.TestCase):
 def test_cache_data(self):
 cache_directory = "./cache"
 with Executor(backend="local", cache_directory=cache_directory) as exe:
 future_lst = [exe.submit(sum, [i, i]) for i in range(1, 4)]
 result_lst = [f.result() for f in future_lst]

 cache_lst = get_cache_data(cache_directory=cache_directory)
 self.assertEqual(sum([c["output"] for c in cache_lst]), sum(result_lst))
 self.assertEqual(
 sum([sum(c["input_args"][0]) for c in cache_lst]), sum(result_lst)
 )

Comment on lines

+19
 to 
+29

@coderabbitaicoderabbitaiBotDec 17, 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
Enhance test coverage and use temporary directory
The test could be improved in several ways:
  1. Use tempfile.mkdtemp() instead of hardcoded "./cache"
  2. Add test cases for error conditions
  3. Validate all cached fields, not just output and input_args
Consider this improved implementation:
+import tempfile+
def test_cache_data(self):
- cache_directory = "./cache"+ cache_directory = tempfile.mkdtemp()
with Executor(backend="local", cache_directory=cache_directory) as exe:
future_lst = [exe.submit(sum, [i, i]) for i in range(1, 4)]
result_lst = [f.result() for f in future_lst]
cache_lst = get_cache_data(cache_directory=cache_directory)
+ # Validate cache size+ self.assertEqual(len(cache_lst), len(future_lst))++ # Validate all cached fields+ for cache_entry in cache_lst:+ self.assertIn('function', cache_entry)+ self.assertIn('input_args', cache_entry)+ self.assertIn('input_kwargs', cache_entry)+ self.assertIn('output', cache_entry)+ self.assertIn('runtime', cache_entry)+
self.assertEqual(sum([c["output"] for c in cache_lst]), sum(result_lst))
self.assertEqual(
sum([sum(c["input_args"][0]) for c in cache_lst]), sum(result_lst)
)
++def test_cache_data_invalid_directory(self):+ with self.assertRaises(ValueError):+ get_cache_data("/nonexistent/path")
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

deftest_cache_data(self):
cache_directory="./cache"
withExecutor(backend="local", cache_directory=cache_directory) asexe:
future_lst= [exe.submit(sum, [i, i]) foriinrange(1, 4)]
result_lst= [f.result() forfinfuture_lst]
cache_lst=get_cache_data(cache_directory=cache_directory)
self.assertEqual(sum([c["output"] forcincache_lst]), sum(result_lst))
self.assertEqual(
sum([sum(c["input_args"][0]) forcincache_lst]), sum(result_lst)
 )
deftest_cache_data(self):
cache_directory=tempfile.mkdtemp()
withExecutor(backend="local", cache_directory=cache_directory) asexe:
future_lst= [exe.submit(sum, [i, i]) foriinrange(1, 4)]
result_lst= [f.result() forfinfuture_lst]
cache_lst=get_cache_data(cache_directory=cache_directory)
# Validate cache size
self.assertEqual(len(cache_lst), len(future_lst))
# Validate all cached fields
forcache_entryincache_lst:
self.assertIn('function', cache_entry)
self.assertIn('input_args', cache_entry)
self.assertIn('input_kwargs', cache_entry)
self.assertIn('output', cache_entry)
self.assertIn('runtime', cache_entry)
self.assertEqual(sum([c["output"] forcincache_lst]), sum(result_lst))
self.assertEqual(
sum([sum(c["input_args"][0]) forcincache_lst]), sum(result_lst)
 )
deftest_cache_data_invalid_directory(self):
withself.assertRaises(ValueError):
get_cache_data("/nonexistent/path")

 def tearDown(self):
 if os.path.exists("cache"):
 shutil.rmtree("cache")

Comment on lines

+31
 to 
+33

@coderabbitaicoderabbitaiBotDec 17, 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
Update cleanup to use test's cache directory
The tearDown method should clean up the temporary directory used in the test, not a hardcoded path.
 def tearDown(self):
- if os.path.exists("cache"):- shutil.rmtree("cache")+ if hasattr(self, '_testMethodName'):+ method = getattr(self, self._testMethodName)+ if hasattr(method, 'cache_directory'):+ shutil.rmtree(method.cache_directory)
Committable suggestion skipped: line range outside the PR's diff.

, '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
Get data from cache#525

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

from

Dec 17, 2024
 Merged


Get data from cache
#525
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d1e72c4

Get data from cache


jan-janssen Dec 17, 2024
cf7bce5

[pre-commit.ci] auto fixes from pre-commit.com hooks


pre-commit-ci[bot] Dec 17, 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


34 changes: 25 additions & 9 deletions
executorlib/standalone/hdf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,19 @@
from typing import Optional, Tuple
import os
from typing import List, Optional, Tuple

import cloudpickle
import h5py
import numpy as np

group_dict = {
 "fn": "function",
 "args": "input_args",
 "kwargs": "input_kwargs",
 "output": "output",
 "runtime": "runtime",
 "queue_id": "queue_id",
}


def dump(file_name: str, data_dict: dict) -> None:
 """
Expand All@@ -13,14 +23,6 @@ def dump(file_name: str, data_dict: dict) -> None:
 file_name (str): file name of the HDF5 file as absolute path
 data_dict (dict): dictionary containing the python function to be executed {"fn": ..., "args": (), "kwargs": {}}
 """
 group_dict = {
 "fn": "function",
 "args": "input_args",
 "kwargs": "input_kwargs",
 "output": "output",
 "runtime": "runtime",
 "queue_id": "queue_id",
 }
 with h5py.File(file_name, "a") as fname:
 for data_key, data_value in data_dict.items():
 if data_key in group_dict.keys():
Expand DownExpand Up@@ -97,3 +99,17 @@ def get_queue_id(file_name: str) -> Optional[int]:
 return cloudpickle.loads(np.void(hdf["/queue_id"]))
 else:
 return None


def get_cache_data(cache_directory: str) -> List[dict]:
 file_lst = []
 for file_name in os.listdir(cache_directory):
 with h5py.File(os.path.join(cache_directory, file_name), "r") as hdf:
 file_content_dict = {
 key: cloudpickle.loads(np.void(hdf["/" + key]))
 for key in group_dict.values()
 if key in hdf
 }
 file_content_dict["filename"] = file_name
 file_lst.append(file_content_dict)
 return file_lst

Comment on lines

+104
 to 
+115

@coderabbitaicoderabbitaiBotDec 17, 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.

⚠️ Potential issue
Add error handling and improve resource management
The function needs additional safeguards for robustness:
  1. Missing directory existence check
  2. No error handling for invalid HDF5 files
  3. Resource management could be improved using context manager pattern
Consider this improved implementation:
 def get_cache_data(cache_directory: str) -> List[dict]:
+ if not os.path.isdir(cache_directory):+ raise ValueError(f"Cache directory does not exist: {cache_directory}")+
file_lst = []
for file_name in os.listdir(cache_directory):
- with h5py.File(os.path.join(cache_directory, file_name), "r") as hdf:- file_content_dict = {- key: cloudpickle.loads(np.void(hdf["/" + key]))- for key in group_dict.values()- if key in hdf- }- file_content_dict["filename"] = file_name- file_lst.append(file_content_dict)+ file_path = os.path.join(cache_directory, file_name)+ try:+ with h5py.File(file_path, "r") as hdf:+ file_content_dict = {+ key: cloudpickle.loads(np.void(hdf["/" + key]))+ for key in group_dict.values()+ if key in hdf+ }+ file_content_dict["filename"] = file_name+ file_lst.append(file_content_dict)+ except (OSError, KeyError) as e:+ # Log warning but continue processing other files+ import warnings+ warnings.warn(f"Failed to read cache file {file_name}: {str(e)}")
return file_lst
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

defget_cache_data(cache_directory: str) ->List[dict]:
file_lst= []
forfile_nameinos.listdir(cache_directory):
withh5py.File(os.path.join(cache_directory, file_name), "r") ashdf:
file_content_dict= {
key: cloudpickle.loads(np.void(hdf["/"+key]))
forkeyingroup_dict.values()
ifkeyinhdf
 }
file_content_dict["filename"] =file_name
file_lst.append(file_content_dict)
returnfile_lst
defget_cache_data(cache_directory: str) ->List[dict]:
ifnotos.path.isdir(cache_directory):
raiseValueError(f"Cache directory does not exist: {cache_directory}")
file_lst= []
forfile_nameinos.listdir(cache_directory):
file_path=os.path.join(cache_directory, file_name)
try:
withh5py.File(file_path, "r") ashdf:
file_content_dict= {
key: cloudpickle.loads(np.void(hdf["/"+key]))
forkeyingroup_dict.values()
ifkeyinhdf
 }
file_content_dict["filename"] =file_name
file_lst.append(file_content_dict)
except (OSError, KeyError) ase:
# Log warning but continue processing other files
importwarnings
warnings.warn(f"Failed to read cache file {file_name}: {str(e)}")
returnfile_lst

33 changes: 33 additions & 0 deletions
tests/test_cache_executor_interactive.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
import os
import shutil
import unittest

from executorlib import Executor

try:
 from executorlib.standalone.hdf import get_cache_data

 skip_h5py_test = False
except ImportError:
 skip_h5py_test = True


@unittest.skipIf(
 skip_h5py_test, "h5py is not installed, so the h5io tests are skipped."
)
class TestCacheFunctions(unittest.TestCase):
 def test_cache_data(self):
 cache_directory = "./cache"
 with Executor(backend="local", cache_directory=cache_directory) as exe:
 future_lst = [exe.submit(sum, [i, i]) for i in range(1, 4)]
 result_lst = [f.result() for f in future_lst]

 cache_lst = get_cache_data(cache_directory=cache_directory)
 self.assertEqual(sum([c["output"] for c in cache_lst]), sum(result_lst))
 self.assertEqual(
 sum([sum(c["input_args"][0]) for c in cache_lst]), sum(result_lst)
 )

Comment on lines

+19
 to 
+29

@coderabbitaicoderabbitaiBotDec 17, 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
Enhance test coverage and use temporary directory
The test could be improved in several ways:
  1. Use tempfile.mkdtemp() instead of hardcoded "./cache"
  2. Add test cases for error conditions
  3. Validate all cached fields, not just output and input_args
Consider this improved implementation:
+import tempfile+
def test_cache_data(self):
- cache_directory = "./cache"+ cache_directory = tempfile.mkdtemp()
with Executor(backend="local", cache_directory=cache_directory) as exe:
future_lst = [exe.submit(sum, [i, i]) for i in range(1, 4)]
result_lst = [f.result() for f in future_lst]
cache_lst = get_cache_data(cache_directory=cache_directory)
+ # Validate cache size+ self.assertEqual(len(cache_lst), len(future_lst))++ # Validate all cached fields+ for cache_entry in cache_lst:+ self.assertIn('function', cache_entry)+ self.assertIn('input_args', cache_entry)+ self.assertIn('input_kwargs', cache_entry)+ self.assertIn('output', cache_entry)+ self.assertIn('runtime', cache_entry)+
self.assertEqual(sum([c["output"] for c in cache_lst]), sum(result_lst))
self.assertEqual(
sum([sum(c["input_args"][0]) for c in cache_lst]), sum(result_lst)
)
++def test_cache_data_invalid_directory(self):+ with self.assertRaises(ValueError):+ get_cache_data("/nonexistent/path")
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

deftest_cache_data(self):
cache_directory="./cache"
withExecutor(backend="local", cache_directory=cache_directory) asexe:
future_lst= [exe.submit(sum, [i, i]) foriinrange(1, 4)]
result_lst= [f.result() forfinfuture_lst]
cache_lst=get_cache_data(cache_directory=cache_directory)
self.assertEqual(sum([c["output"] forcincache_lst]), sum(result_lst))
self.assertEqual(
sum([sum(c["input_args"][0]) forcincache_lst]), sum(result_lst)
 )
deftest_cache_data(self):
cache_directory=tempfile.mkdtemp()
withExecutor(backend="local", cache_directory=cache_directory) asexe:
future_lst= [exe.submit(sum, [i, i]) foriinrange(1, 4)]
result_lst= [f.result() forfinfuture_lst]
cache_lst=get_cache_data(cache_directory=cache_directory)
# Validate cache size
self.assertEqual(len(cache_lst), len(future_lst))
# Validate all cached fields
forcache_entryincache_lst:
self.assertIn('function', cache_entry)
self.assertIn('input_args', cache_entry)
self.assertIn('input_kwargs', cache_entry)
self.assertIn('output', cache_entry)
self.assertIn('runtime', cache_entry)
self.assertEqual(sum([c["output"] forcincache_lst]), sum(result_lst))
self.assertEqual(
sum([sum(c["input_args"][0]) forcincache_lst]), sum(result_lst)
 )
deftest_cache_data_invalid_directory(self):
withself.assertRaises(ValueError):
get_cache_data("/nonexistent/path")

 def tearDown(self):
 if os.path.exists("cache"):
 shutil.rmtree("cache")

Comment on lines

+31
 to 
+33

@coderabbitaicoderabbitaiBotDec 17, 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
Update cleanup to use test's cache directory
The tearDown method should clean up the temporary directory used in the test, not a hardcoded path.
 def tearDown(self):
- if os.path.exists("cache"):- shutil.rmtree("cache")+ if hasattr(self, '_testMethodName'):+ method = getattr(self, self._testMethodName)+ if hasattr(method, 'cache_directory'):+ shutil.rmtree(method.cache_directory)
Committable suggestion skipped: line range outside the PR's diff.

, '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
Get data from cache#525

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

from

Dec 17, 2024
 Merged


Get data from cache
#525
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d1e72c4

Get data from cache


jan-janssen Dec 17, 2024
cf7bce5

[pre-commit.ci] auto fixes from pre-commit.com hooks


pre-commit-ci[bot] Dec 17, 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


34 changes: 25 additions & 9 deletions
executorlib/standalone/hdf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,19 @@
from typing import Optional, Tuple
import os
from typing import List, Optional, Tuple

import cloudpickle
import h5py
import numpy as np

group_dict = {
 "fn": "function",
 "args": "input_args",
 "kwargs": "input_kwargs",
 "output": "output",
 "runtime": "runtime",
 "queue_id": "queue_id",
}


def dump(file_name: str, data_dict: dict) -> None:
 """
Expand All@@ -13,14 +23,6 @@ def dump(file_name: str, data_dict: dict) -> None:
 file_name (str): file name of the HDF5 file as absolute path
 data_dict (dict): dictionary containing the python function to be executed {"fn": ..., "args": (), "kwargs": {}}
 """
 group_dict = {
 "fn": "function",
 "args": "input_args",
 "kwargs": "input_kwargs",
 "output": "output",
 "runtime": "runtime",
 "queue_id": "queue_id",
 }
 with h5py.File(file_name, "a") as fname:
 for data_key, data_value in data_dict.items():
 if data_key in group_dict.keys():
Expand DownExpand Up@@ -97,3 +99,17 @@ def get_queue_id(file_name: str) -> Optional[int]:
 return cloudpickle.loads(np.void(hdf["/queue_id"]))
 else:
 return None


def get_cache_data(cache_directory: str) -> List[dict]:
 file_lst = []
 for file_name in os.listdir(cache_directory):
 with h5py.File(os.path.join(cache_directory, file_name), "r") as hdf:
 file_content_dict = {
 key: cloudpickle.loads(np.void(hdf["/" + key]))
 for key in group_dict.values()
 if key in hdf
 }
 file_content_dict["filename"] = file_name
 file_lst.append(file_content_dict)
 return file_lst

Comment on lines

+104
 to 
+115

@coderabbitaicoderabbitaiBotDec 17, 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.

⚠️ Potential issue
Add error handling and improve resource management
The function needs additional safeguards for robustness:
  1. Missing directory existence check
  2. No error handling for invalid HDF5 files
  3. Resource management could be improved using context manager pattern
Consider this improved implementation:
 def get_cache_data(cache_directory: str) -> List[dict]:
+ if not os.path.isdir(cache_directory):+ raise ValueError(f"Cache directory does not exist: {cache_directory}")+
file_lst = []
for file_name in os.listdir(cache_directory):
- with h5py.File(os.path.join(cache_directory, file_name), "r") as hdf:- file_content_dict = {- key: cloudpickle.loads(np.void(hdf["/" + key]))- for key in group_dict.values()- if key in hdf- }- file_content_dict["filename"] = file_name- file_lst.append(file_content_dict)+ file_path = os.path.join(cache_directory, file_name)+ try:+ with h5py.File(file_path, "r") as hdf:+ file_content_dict = {+ key: cloudpickle.loads(np.void(hdf["/" + key]))+ for key in group_dict.values()+ if key in hdf+ }+ file_content_dict["filename"] = file_name+ file_lst.append(file_content_dict)+ except (OSError, KeyError) as e:+ # Log warning but continue processing other files+ import warnings+ warnings.warn(f"Failed to read cache file {file_name}: {str(e)}")
return file_lst
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

defget_cache_data(cache_directory: str) ->List[dict]:
file_lst= []
forfile_nameinos.listdir(cache_directory):
withh5py.File(os.path.join(cache_directory, file_name), "r") ashdf:
file_content_dict= {
key: cloudpickle.loads(np.void(hdf["/"+key]))
forkeyingroup_dict.values()
ifkeyinhdf
 }
file_content_dict["filename"] =file_name
file_lst.append(file_content_dict)
returnfile_lst
defget_cache_data(cache_directory: str) ->List[dict]:
ifnotos.path.isdir(cache_directory):
raiseValueError(f"Cache directory does not exist: {cache_directory}")
file_lst= []
forfile_nameinos.listdir(cache_directory):
file_path=os.path.join(cache_directory, file_name)
try:
withh5py.File(file_path, "r") ashdf:
file_content_dict= {
key: cloudpickle.loads(np.void(hdf["/"+key]))
forkeyingroup_dict.values()
ifkeyinhdf
 }
file_content_dict["filename"] =file_name
file_lst.append(file_content_dict)
except (OSError, KeyError) ase:
# Log warning but continue processing other files
importwarnings
warnings.warn(f"Failed to read cache file {file_name}: {str(e)}")
returnfile_lst

33 changes: 33 additions & 0 deletions
tests/test_cache_executor_interactive.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
import os
import shutil
import unittest

from executorlib import Executor

try:
 from executorlib.standalone.hdf import get_cache_data

 skip_h5py_test = False
except ImportError:
 skip_h5py_test = True


@unittest.skipIf(
 skip_h5py_test, "h5py is not installed, so the h5io tests are skipped."
)
class TestCacheFunctions(unittest.TestCase):
 def test_cache_data(self):
 cache_directory = "./cache"
 with Executor(backend="local", cache_directory=cache_directory) as exe:
 future_lst = [exe.submit(sum, [i, i]) for i in range(1, 4)]
 result_lst = [f.result() for f in future_lst]

 cache_lst = get_cache_data(cache_directory=cache_directory)
 self.assertEqual(sum([c["output"] for c in cache_lst]), sum(result_lst))
 self.assertEqual(
 sum([sum(c["input_args"][0]) for c in cache_lst]), sum(result_lst)
 )

Comment on lines

+19
 to 
+29

@coderabbitaicoderabbitaiBotDec 17, 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
Enhance test coverage and use temporary directory
The test could be improved in several ways:
  1. Use tempfile.mkdtemp() instead of hardcoded "./cache"
  2. Add test cases for error conditions
  3. Validate all cached fields, not just output and input_args
Consider this improved implementation:
+import tempfile+
def test_cache_data(self):
- cache_directory = "./cache"+ cache_directory = tempfile.mkdtemp()
with Executor(backend="local", cache_directory=cache_directory) as exe:
future_lst = [exe.submit(sum, [i, i]) for i in range(1, 4)]
result_lst = [f.result() for f in future_lst]
cache_lst = get_cache_data(cache_directory=cache_directory)
+ # Validate cache size+ self.assertEqual(len(cache_lst), len(future_lst))++ # Validate all cached fields+ for cache_entry in cache_lst:+ self.assertIn('function', cache_entry)+ self.assertIn('input_args', cache_entry)+ self.assertIn('input_kwargs', cache_entry)+ self.assertIn('output', cache_entry)+ self.assertIn('runtime', cache_entry)+
self.assertEqual(sum([c["output"] for c in cache_lst]), sum(result_lst))
self.assertEqual(
sum([sum(c["input_args"][0]) for c in cache_lst]), sum(result_lst)
)
++def test_cache_data_invalid_directory(self):+ with self.assertRaises(ValueError):+ get_cache_data("/nonexistent/path")
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

deftest_cache_data(self):
cache_directory="./cache"
withExecutor(backend="local", cache_directory=cache_directory) asexe:
future_lst= [exe.submit(sum, [i, i]) foriinrange(1, 4)]
result_lst= [f.result() forfinfuture_lst]
cache_lst=get_cache_data(cache_directory=cache_directory)
self.assertEqual(sum([c["output"] forcincache_lst]), sum(result_lst))
self.assertEqual(
sum([sum(c["input_args"][0]) forcincache_lst]), sum(result_lst)
 )
deftest_cache_data(self):
cache_directory=tempfile.mkdtemp()
withExecutor(backend="local", cache_directory=cache_directory) asexe:
future_lst= [exe.submit(sum, [i, i]) foriinrange(1, 4)]
result_lst= [f.result() forfinfuture_lst]
cache_lst=get_cache_data(cache_directory=cache_directory)
# Validate cache size
self.assertEqual(len(cache_lst), len(future_lst))
# Validate all cached fields
forcache_entryincache_lst:
self.assertIn('function', cache_entry)
self.assertIn('input_args', cache_entry)
self.assertIn('input_kwargs', cache_entry)
self.assertIn('output', cache_entry)
self.assertIn('runtime', cache_entry)
self.assertEqual(sum([c["output"] forcincache_lst]), sum(result_lst))
self.assertEqual(
sum([sum(c["input_args"][0]) forcincache_lst]), sum(result_lst)
 )
deftest_cache_data_invalid_directory(self):
withself.assertRaises(ValueError):
get_cache_data("/nonexistent/path")

 def tearDown(self):
 if os.path.exists("cache"):
 shutil.rmtree("cache")

Comment on lines

+31
 to 
+33

@coderabbitaicoderabbitaiBotDec 17, 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
Update cleanup to use test's cache directory
The tearDown method should clean up the temporary directory used in the test, not a hardcoded path.
 def tearDown(self):
- if os.path.exists("cache"):- shutil.rmtree("cache")+ if hasattr(self, '_testMethodName'):+ method = getattr(self, self._testMethodName)+ if hasattr(method, 'cache_directory'):+ shutil.rmtree(method.cache_directory)
Committable suggestion skipped: line range outside the PR's diff.

, '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
Get data from cache#525

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

from

Dec 17, 2024
 Merged


Get data from cache
#525
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d1e72c4

Get data from cache


jan-janssen Dec 17, 2024
cf7bce5

[pre-commit.ci] auto fixes from pre-commit.com hooks


pre-commit-ci[bot] Dec 17, 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


34 changes: 25 additions & 9 deletions
executorlib/standalone/hdf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,19 @@
from typing import Optional, Tuple
import os
from typing import List, Optional, Tuple

import cloudpickle
import h5py
import numpy as np

group_dict = {
 "fn": "function",
 "args": "input_args",
 "kwargs": "input_kwargs",
 "output": "output",
 "runtime": "runtime",
 "queue_id": "queue_id",
}


def dump(file_name: str, data_dict: dict) -> None:
 """
Expand All@@ -13,14 +23,6 @@ def dump(file_name: str, data_dict: dict) -> None:
 file_name (str): file name of the HDF5 file as absolute path
 data_dict (dict): dictionary containing the python function to be executed {"fn": ..., "args": (), "kwargs": {}}
 """
 group_dict = {
 "fn": "function",
 "args": "input_args",
 "kwargs": "input_kwargs",
 "output": "output",
 "runtime": "runtime",
 "queue_id": "queue_id",
 }
 with h5py.File(file_name, "a") as fname:
 for data_key, data_value in data_dict.items():
 if data_key in group_dict.keys():
Expand DownExpand Up@@ -97,3 +99,17 @@ def get_queue_id(file_name: str) -> Optional[int]:
 return cloudpickle.loads(np.void(hdf["/queue_id"]))
 else:
 return None


def get_cache_data(cache_directory: str) -> List[dict]:
 file_lst = []
 for file_name in os.listdir(cache_directory):
 with h5py.File(os.path.join(cache_directory, file_name), "r") as hdf:
 file_content_dict = {
 key: cloudpickle.loads(np.void(hdf["/" + key]))
 for key in group_dict.values()
 if key in hdf
 }
 file_content_dict["filename"] = file_name
 file_lst.append(file_content_dict)
 return file_lst

Comment on lines

+104
 to 
+115

@coderabbitaicoderabbitaiBotDec 17, 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.

⚠️ Potential issue
Add error handling and improve resource management
The function needs additional safeguards for robustness:
  1. Missing directory existence check
  2. No error handling for invalid HDF5 files
  3. Resource management could be improved using context manager pattern
Consider this improved implementation:
 def get_cache_data(cache_directory: str) -> List[dict]:
+ if not os.path.isdir(cache_directory):+ raise ValueError(f"Cache directory does not exist: {cache_directory}")+
file_lst = []
for file_name in os.listdir(cache_directory):
- with h5py.File(os.path.join(cache_directory, file_name), "r") as hdf:- file_content_dict = {- key: cloudpickle.loads(np.void(hdf["/" + key]))- for key in group_dict.values()- if key in hdf- }- file_content_dict["filename"] = file_name- file_lst.append(file_content_dict)+ file_path = os.path.join(cache_directory, file_name)+ try:+ with h5py.File(file_path, "r") as hdf:+ file_content_dict = {+ key: cloudpickle.loads(np.void(hdf["/" + key]))+ for key in group_dict.values()+ if key in hdf+ }+ file_content_dict["filename"] = file_name+ file_lst.append(file_content_dict)+ except (OSError, KeyError) as e:+ # Log warning but continue processing other files+ import warnings+ warnings.warn(f"Failed to read cache file {file_name}: {str(e)}")
return file_lst
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

defget_cache_data(cache_directory: str) ->List[dict]:
file_lst= []
forfile_nameinos.listdir(cache_directory):
withh5py.File(os.path.join(cache_directory, file_name), "r") ashdf:
file_content_dict= {
key: cloudpickle.loads(np.void(hdf["/"+key]))
forkeyingroup_dict.values()
ifkeyinhdf
 }
file_content_dict["filename"] =file_name
file_lst.append(file_content_dict)
returnfile_lst
defget_cache_data(cache_directory: str) ->List[dict]:
ifnotos.path.isdir(cache_directory):
raiseValueError(f"Cache directory does not exist: {cache_directory}")
file_lst= []
forfile_nameinos.listdir(cache_directory):
file_path=os.path.join(cache_directory, file_name)
try:
withh5py.File(file_path, "r") ashdf:
file_content_dict= {
key: cloudpickle.loads(np.void(hdf["/"+key]))
forkeyingroup_dict.values()
ifkeyinhdf
 }
file_content_dict["filename"] =file_name
file_lst.append(file_content_dict)
except (OSError, KeyError) ase:
# Log warning but continue processing other files
importwarnings
warnings.warn(f"Failed to read cache file {file_name}: {str(e)}")
returnfile_lst

33 changes: 33 additions & 0 deletions
tests/test_cache_executor_interactive.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
import os
import shutil
import unittest

from executorlib import Executor

try:
 from executorlib.standalone.hdf import get_cache_data

 skip_h5py_test = False
except ImportError:
 skip_h5py_test = True


@unittest.skipIf(
 skip_h5py_test, "h5py is not installed, so the h5io tests are skipped."
)
class TestCacheFunctions(unittest.TestCase):
 def test_cache_data(self):
 cache_directory = "./cache"
 with Executor(backend="local", cache_directory=cache_directory) as exe:
 future_lst = [exe.submit(sum, [i, i]) for i in range(1, 4)]
 result_lst = [f.result() for f in future_lst]

 cache_lst = get_cache_data(cache_directory=cache_directory)
 self.assertEqual(sum([c["output"] for c in cache_lst]), sum(result_lst))
 self.assertEqual(
 sum([sum(c["input_args"][0]) for c in cache_lst]), sum(result_lst)
 )

Comment on lines

+19
 to 
+29

@coderabbitaicoderabbitaiBotDec 17, 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
Enhance test coverage and use temporary directory
The test could be improved in several ways:
  1. Use tempfile.mkdtemp() instead of hardcoded "./cache"
  2. Add test cases for error conditions
  3. Validate all cached fields, not just output and input_args
Consider this improved implementation:
+import tempfile+
def test_cache_data(self):
- cache_directory = "./cache"+ cache_directory = tempfile.mkdtemp()
with Executor(backend="local", cache_directory=cache_directory) as exe:
future_lst = [exe.submit(sum, [i, i]) for i in range(1, 4)]
result_lst = [f.result() for f in future_lst]
cache_lst = get_cache_data(cache_directory=cache_directory)
+ # Validate cache size+ self.assertEqual(len(cache_lst), len(future_lst))++ # Validate all cached fields+ for cache_entry in cache_lst:+ self.assertIn('function', cache_entry)+ self.assertIn('input_args', cache_entry)+ self.assertIn('input_kwargs', cache_entry)+ self.assertIn('output', cache_entry)+ self.assertIn('runtime', cache_entry)+
self.assertEqual(sum([c["output"] for c in cache_lst]), sum(result_lst))
self.assertEqual(
sum([sum(c["input_args"][0]) for c in cache_lst]), sum(result_lst)
)
++def test_cache_data_invalid_directory(self):+ with self.assertRaises(ValueError):+ get_cache_data("/nonexistent/path")
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

deftest_cache_data(self):
cache_directory="./cache"
withExecutor(backend="local", cache_directory=cache_directory) asexe:
future_lst= [exe.submit(sum, [i, i]) foriinrange(1, 4)]
result_lst= [f.result() forfinfuture_lst]
cache_lst=get_cache_data(cache_directory=cache_directory)
self.assertEqual(sum([c["output"] forcincache_lst]), sum(result_lst))
self.assertEqual(
sum([sum(c["input_args"][0]) forcincache_lst]), sum(result_lst)
 )
deftest_cache_data(self):
cache_directory=tempfile.mkdtemp()
withExecutor(backend="local", cache_directory=cache_directory) asexe:
future_lst= [exe.submit(sum, [i, i]) foriinrange(1, 4)]
result_lst= [f.result() forfinfuture_lst]
cache_lst=get_cache_data(cache_directory=cache_directory)
# Validate cache size
self.assertEqual(len(cache_lst), len(future_lst))
# Validate all cached fields
forcache_entryincache_lst:
self.assertIn('function', cache_entry)
self.assertIn('input_args', cache_entry)
self.assertIn('input_kwargs', cache_entry)
self.assertIn('output', cache_entry)
self.assertIn('runtime', cache_entry)
self.assertEqual(sum([c["output"] forcincache_lst]), sum(result_lst))
self.assertEqual(
sum([sum(c["input_args"][0]) forcincache_lst]), sum(result_lst)
 )
deftest_cache_data_invalid_directory(self):
withself.assertRaises(ValueError):
get_cache_data("/nonexistent/path")

 def tearDown(self):
 if os.path.exists("cache"):
 shutil.rmtree("cache")

Comment on lines

+31
 to 
+33

@coderabbitaicoderabbitaiBotDec 17, 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
Update cleanup to use test's cache directory
The tearDown method should clean up the temporary directory used in the test, not a hardcoded path.
 def tearDown(self):
- if os.path.exists("cache"):- shutil.rmtree("cache")+ if hasattr(self, '_testMethodName'):+ method = getattr(self, self._testMethodName)+ if hasattr(method, 'cache_directory'):+ shutil.rmtree(method.cache_directory)
Committable suggestion skipped: line range outside the PR's diff.

, '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
Get data from cache#525

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

from

Dec 17, 2024
 Merged


Get data from cache
#525
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d1e72c4

Get data from cache


jan-janssen Dec 17, 2024
cf7bce5

[pre-commit.ci] auto fixes from pre-commit.com hooks


pre-commit-ci[bot] Dec 17, 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


34 changes: 25 additions & 9 deletions
executorlib/standalone/hdf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,19 @@
from typing import Optional, Tuple
import os
from typing import List, Optional, Tuple

import cloudpickle
import h5py
import numpy as np

group_dict = {
 "fn": "function",
 "args": "input_args",
 "kwargs": "input_kwargs",
 "output": "output",
 "runtime": "runtime",
 "queue_id": "queue_id",
}


def dump(file_name: str, data_dict: dict) -> None:
 """
Expand All@@ -13,14 +23,6 @@ def dump(file_name: str, data_dict: dict) -> None:
 file_name (str): file name of the HDF5 file as absolute path
 data_dict (dict): dictionary containing the python function to be executed {"fn": ..., "args": (), "kwargs": {}}
 """
 group_dict = {
 "fn": "function",
 "args": "input_args",
 "kwargs": "input_kwargs",
 "output": "output",
 "runtime": "runtime",
 "queue_id": "queue_id",
 }
 with h5py.File(file_name, "a") as fname:
 for data_key, data_value in data_dict.items():
 if data_key in group_dict.keys():
Expand DownExpand Up@@ -97,3 +99,17 @@ def get_queue_id(file_name: str) -> Optional[int]:
 return cloudpickle.loads(np.void(hdf["/queue_id"]))
 else:
 return None


def get_cache_data(cache_directory: str) -> List[dict]:
 file_lst = []
 for file_name in os.listdir(cache_directory):
 with h5py.File(os.path.join(cache_directory, file_name), "r") as hdf:
 file_content_dict = {
 key: cloudpickle.loads(np.void(hdf["/" + key]))
 for key in group_dict.values()
 if key in hdf
 }
 file_content_dict["filename"] = file_name
 file_lst.append(file_content_dict)
 return file_lst

Comment on lines

+104
 to 
+115

@coderabbitaicoderabbitaiBotDec 17, 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.

⚠️ Potential issue
Add error handling and improve resource management
The function needs additional safeguards for robustness:
  1. Missing directory existence check
  2. No error handling for invalid HDF5 files
  3. Resource management could be improved using context manager pattern
Consider this improved implementation:
 def get_cache_data(cache_directory: str) -> List[dict]:
+ if not os.path.isdir(cache_directory):+ raise ValueError(f"Cache directory does not exist: {cache_directory}")+
file_lst = []
for file_name in os.listdir(cache_directory):
- with h5py.File(os.path.join(cache_directory, file_name), "r") as hdf:- file_content_dict = {- key: cloudpickle.loads(np.void(hdf["/" + key]))- for key in group_dict.values()- if key in hdf- }- file_content_dict["filename"] = file_name- file_lst.append(file_content_dict)+ file_path = os.path.join(cache_directory, file_name)+ try:+ with h5py.File(file_path, "r") as hdf:+ file_content_dict = {+ key: cloudpickle.loads(np.void(hdf["/" + key]))+ for key in group_dict.values()+ if key in hdf+ }+ file_content_dict["filename"] = file_name+ file_lst.append(file_content_dict)+ except (OSError, KeyError) as e:+ # Log warning but continue processing other files+ import warnings+ warnings.warn(f"Failed to read cache file {file_name}: {str(e)}")
return file_lst
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

defget_cache_data(cache_directory: str) ->List[dict]:
file_lst= []
forfile_nameinos.listdir(cache_directory):
withh5py.File(os.path.join(cache_directory, file_name), "r") ashdf:
file_content_dict= {
key: cloudpickle.loads(np.void(hdf["/"+key]))
forkeyingroup_dict.values()
ifkeyinhdf
 }
file_content_dict["filename"] =file_name
file_lst.append(file_content_dict)
returnfile_lst
defget_cache_data(cache_directory: str) ->List[dict]:
ifnotos.path.isdir(cache_directory):
raiseValueError(f"Cache directory does not exist: {cache_directory}")
file_lst= []
forfile_nameinos.listdir(cache_directory):
file_path=os.path.join(cache_directory, file_name)
try:
withh5py.File(file_path, "r") ashdf:
file_content_dict= {
key: cloudpickle.loads(np.void(hdf["/"+key]))
forkeyingroup_dict.values()
ifkeyinhdf
 }
file_content_dict["filename"] =file_name
file_lst.append(file_content_dict)
except (OSError, KeyError) ase:
# Log warning but continue processing other files
importwarnings
warnings.warn(f"Failed to read cache file {file_name}: {str(e)}")
returnfile_lst

33 changes: 33 additions & 0 deletions
tests/test_cache_executor_interactive.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
import os
import shutil
import unittest

from executorlib import Executor

try:
 from executorlib.standalone.hdf import get_cache_data

 skip_h5py_test = False
except ImportError:
 skip_h5py_test = True


@unittest.skipIf(
 skip_h5py_test, "h5py is not installed, so the h5io tests are skipped."
)
class TestCacheFunctions(unittest.TestCase):
 def test_cache_data(self):
 cache_directory = "./cache"
 with Executor(backend="local", cache_directory=cache_directory) as exe:
 future_lst = [exe.submit(sum, [i, i]) for i in range(1, 4)]
 result_lst = [f.result() for f in future_lst]

 cache_lst = get_cache_data(cache_directory=cache_directory)
 self.assertEqual(sum([c["output"] for c in cache_lst]), sum(result_lst))
 self.assertEqual(
 sum([sum(c["input_args"][0]) for c in cache_lst]), sum(result_lst)
 )

Comment on lines

+19
 to 
+29

@coderabbitaicoderabbitaiBotDec 17, 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
Enhance test coverage and use temporary directory
The test could be improved in several ways:
  1. Use tempfile.mkdtemp() instead of hardcoded "./cache"
  2. Add test cases for error conditions
  3. Validate all cached fields, not just output and input_args
Consider this improved implementation:
+import tempfile+
def test_cache_data(self):
- cache_directory = "./cache"+ cache_directory = tempfile.mkdtemp()
with Executor(backend="local", cache_directory=cache_directory) as exe:
future_lst = [exe.submit(sum, [i, i]) for i in range(1, 4)]
result_lst = [f.result() for f in future_lst]
cache_lst = get_cache_data(cache_directory=cache_directory)
+ # Validate cache size+ self.assertEqual(len(cache_lst), len(future_lst))++ # Validate all cached fields+ for cache_entry in cache_lst:+ self.assertIn('function', cache_entry)+ self.assertIn('input_args', cache_entry)+ self.assertIn('input_kwargs', cache_entry)+ self.assertIn('output', cache_entry)+ self.assertIn('runtime', cache_entry)+
self.assertEqual(sum([c["output"] for c in cache_lst]), sum(result_lst))
self.assertEqual(
sum([sum(c["input_args"][0]) for c in cache_lst]), sum(result_lst)
)
++def test_cache_data_invalid_directory(self):+ with self.assertRaises(ValueError):+ get_cache_data("/nonexistent/path")
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

deftest_cache_data(self):
cache_directory="./cache"
withExecutor(backend="local", cache_directory=cache_directory) asexe:
future_lst= [exe.submit(sum, [i, i]) foriinrange(1, 4)]
result_lst= [f.result() forfinfuture_lst]
cache_lst=get_cache_data(cache_directory=cache_directory)
self.assertEqual(sum([c["output"] forcincache_lst]), sum(result_lst))
self.assertEqual(
sum([sum(c["input_args"][0]) forcincache_lst]), sum(result_lst)
 )
deftest_cache_data(self):
cache_directory=tempfile.mkdtemp()
withExecutor(backend="local", cache_directory=cache_directory) asexe:
future_lst= [exe.submit(sum, [i, i]) foriinrange(1, 4)]
result_lst= [f.result() forfinfuture_lst]
cache_lst=get_cache_data(cache_directory=cache_directory)
# Validate cache size
self.assertEqual(len(cache_lst), len(future_lst))
# Validate all cached fields
forcache_entryincache_lst:
self.assertIn('function', cache_entry)
self.assertIn('input_args', cache_entry)
self.assertIn('input_kwargs', cache_entry)
self.assertIn('output', cache_entry)
self.assertIn('runtime', cache_entry)
self.assertEqual(sum([c["output"] forcincache_lst]), sum(result_lst))
self.assertEqual(
sum([sum(c["input_args"][0]) forcincache_lst]), sum(result_lst)
 )
deftest_cache_data_invalid_directory(self):
withself.assertRaises(ValueError):
get_cache_data("/nonexistent/path")

 def tearDown(self):
 if os.path.exists("cache"):
 shutil.rmtree("cache")

Comment on lines

+31
 to 
+33

@coderabbitaicoderabbitaiBotDec 17, 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
Update cleanup to use test's cache directory
The tearDown method should clean up the temporary directory used in the test, not a hardcoded path.
 def tearDown(self):
- if os.path.exists("cache"):- shutil.rmtree("cache")+ if hasattr(self, '_testMethodName'):+ method = getattr(self, self._testMethodName)+ if hasattr(method, 'cache_directory'):+ shutil.rmtree(method.cache_directory)
Committable suggestion skipped: line range outside the PR's diff.

, '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
Get data from cache#525

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

from

Dec 17, 2024
 Merged


Get data from cache
#525
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d1e72c4

Get data from cache


jan-janssen Dec 17, 2024
cf7bce5

[pre-commit.ci] auto fixes from pre-commit.com hooks


pre-commit-ci[bot] Dec 17, 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


34 changes: 25 additions & 9 deletions
executorlib/standalone/hdf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,19 @@
from typing import Optional, Tuple
import os
from typing import List, Optional, Tuple

import cloudpickle
import h5py
import numpy as np

group_dict = {
 "fn": "function",
 "args": "input_args",
 "kwargs": "input_kwargs",
 "output": "output",
 "runtime": "runtime",
 "queue_id": "queue_id",
}


def dump(file_name: str, data_dict: dict) -> None:
 """
Expand All@@ -13,14 +23,6 @@ def dump(file_name: str, data_dict: dict) -> None:
 file_name (str): file name of the HDF5 file as absolute path
 data_dict (dict): dictionary containing the python function to be executed {"fn": ..., "args": (), "kwargs": {}}
 """
 group_dict = {
 "fn": "function",
 "args": "input_args",
 "kwargs": "input_kwargs",
 "output": "output",
 "runtime": "runtime",
 "queue_id": "queue_id",
 }
 with h5py.File(file_name, "a") as fname:
 for data_key, data_value in data_dict.items():
 if data_key in group_dict.keys():
Expand DownExpand Up@@ -97,3 +99,17 @@ def get_queue_id(file_name: str) -> Optional[int]:
 return cloudpickle.loads(np.void(hdf["/queue_id"]))
 else:
 return None


def get_cache_data(cache_directory: str) -> List[dict]:
 file_lst = []
 for file_name in os.listdir(cache_directory):
 with h5py.File(os.path.join(cache_directory, file_name), "r") as hdf:
 file_content_dict = {
 key: cloudpickle.loads(np.void(hdf["/" + key]))
 for key in group_dict.values()
 if key in hdf
 }
 file_content_dict["filename"] = file_name
 file_lst.append(file_content_dict)
 return file_lst

Comment on lines

+104
 to 
+115

@coderabbitaicoderabbitaiBotDec 17, 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.

⚠️ Potential issue
Add error handling and improve resource management
The function needs additional safeguards for robustness:
  1. Missing directory existence check
  2. No error handling for invalid HDF5 files
  3. Resource management could be improved using context manager pattern
Consider this improved implementation:
 def get_cache_data(cache_directory: str) -> List[dict]:
+ if not os.path.isdir(cache_directory):+ raise ValueError(f"Cache directory does not exist: {cache_directory}")+
file_lst = []
for file_name in os.listdir(cache_directory):
- with h5py.File(os.path.join(cache_directory, file_name), "r") as hdf:- file_content_dict = {- key: cloudpickle.loads(np.void(hdf["/" + key]))- for key in group_dict.values()- if key in hdf- }- file_content_dict["filename"] = file_name- file_lst.append(file_content_dict)+ file_path = os.path.join(cache_directory, file_name)+ try:+ with h5py.File(file_path, "r") as hdf:+ file_content_dict = {+ key: cloudpickle.loads(np.void(hdf["/" + key]))+ for key in group_dict.values()+ if key in hdf+ }+ file_content_dict["filename"] = file_name+ file_lst.append(file_content_dict)+ except (OSError, KeyError) as e:+ # Log warning but continue processing other files+ import warnings+ warnings.warn(f"Failed to read cache file {file_name}: {str(e)}")
return file_lst
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

defget_cache_data(cache_directory: str) ->List[dict]:
file_lst= []
forfile_nameinos.listdir(cache_directory):
withh5py.File(os.path.join(cache_directory, file_name), "r") ashdf:
file_content_dict= {
key: cloudpickle.loads(np.void(hdf["/"+key]))
forkeyingroup_dict.values()
ifkeyinhdf
 }
file_content_dict["filename"] =file_name
file_lst.append(file_content_dict)
returnfile_lst
defget_cache_data(cache_directory: str) ->List[dict]:
ifnotos.path.isdir(cache_directory):
raiseValueError(f"Cache directory does not exist: {cache_directory}")
file_lst= []
forfile_nameinos.listdir(cache_directory):
file_path=os.path.join(cache_directory, file_name)
try:
withh5py.File(file_path, "r") ashdf:
file_content_dict= {
key: cloudpickle.loads(np.void(hdf["/"+key]))
forkeyingroup_dict.values()
ifkeyinhdf
 }
file_content_dict["filename"] =file_name
file_lst.append(file_content_dict)
except (OSError, KeyError) ase:
# Log warning but continue processing other files
importwarnings
warnings.warn(f"Failed to read cache file {file_name}: {str(e)}")
returnfile_lst

33 changes: 33 additions & 0 deletions
tests/test_cache_executor_interactive.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
import os
import shutil
import unittest

from executorlib import Executor

try:
 from executorlib.standalone.hdf import get_cache_data

 skip_h5py_test = False
except ImportError:
 skip_h5py_test = True


@unittest.skipIf(
 skip_h5py_test, "h5py is not installed, so the h5io tests are skipped."
)
class TestCacheFunctions(unittest.TestCase):
 def test_cache_data(self):
 cache_directory = "./cache"
 with Executor(backend="local", cache_directory=cache_directory) as exe:
 future_lst = [exe.submit(sum, [i, i]) for i in range(1, 4)]
 result_lst = [f.result() for f in future_lst]

 cache_lst = get_cache_data(cache_directory=cache_directory)
 self.assertEqual(sum([c["output"] for c in cache_lst]), sum(result_lst))
 self.assertEqual(
 sum([sum(c["input_args"][0]) for c in cache_lst]), sum(result_lst)
 )

Comment on lines

+19
 to 
+29

@coderabbitaicoderabbitaiBotDec 17, 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
Enhance test coverage and use temporary directory
The test could be improved in several ways:
  1. Use tempfile.mkdtemp() instead of hardcoded "./cache"
  2. Add test cases for error conditions
  3. Validate all cached fields, not just output and input_args
Consider this improved implementation:
+import tempfile+
def test_cache_data(self):
- cache_directory = "./cache"+ cache_directory = tempfile.mkdtemp()
with Executor(backend="local", cache_directory=cache_directory) as exe:
future_lst = [exe.submit(sum, [i, i]) for i in range(1, 4)]
result_lst = [f.result() for f in future_lst]
cache_lst = get_cache_data(cache_directory=cache_directory)
+ # Validate cache size+ self.assertEqual(len(cache_lst), len(future_lst))++ # Validate all cached fields+ for cache_entry in cache_lst:+ self.assertIn('function', cache_entry)+ self.assertIn('input_args', cache_entry)+ self.assertIn('input_kwargs', cache_entry)+ self.assertIn('output', cache_entry)+ self.assertIn('runtime', cache_entry)+
self.assertEqual(sum([c["output"] for c in cache_lst]), sum(result_lst))
self.assertEqual(
sum([sum(c["input_args"][0]) for c in cache_lst]), sum(result_lst)
)
++def test_cache_data_invalid_directory(self):+ with self.assertRaises(ValueError):+ get_cache_data("/nonexistent/path")
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

deftest_cache_data(self):
cache_directory="./cache"
withExecutor(backend="local", cache_directory=cache_directory) asexe:
future_lst= [exe.submit(sum, [i, i]) foriinrange(1, 4)]
result_lst= [f.result() forfinfuture_lst]
cache_lst=get_cache_data(cache_directory=cache_directory)
self.assertEqual(sum([c["output"] forcincache_lst]), sum(result_lst))
self.assertEqual(
sum([sum(c["input_args"][0]) forcincache_lst]), sum(result_lst)
 )
deftest_cache_data(self):
cache_directory=tempfile.mkdtemp()
withExecutor(backend="local", cache_directory=cache_directory) asexe:
future_lst= [exe.submit(sum, [i, i]) foriinrange(1, 4)]
result_lst= [f.result() forfinfuture_lst]
cache_lst=get_cache_data(cache_directory=cache_directory)
# Validate cache size
self.assertEqual(len(cache_lst), len(future_lst))
# Validate all cached fields
forcache_entryincache_lst:
self.assertIn('function', cache_entry)
self.assertIn('input_args', cache_entry)
self.assertIn('input_kwargs', cache_entry)
self.assertIn('output', cache_entry)
self.assertIn('runtime', cache_entry)
self.assertEqual(sum([c["output"] forcincache_lst]), sum(result_lst))
self.assertEqual(
sum([sum(c["input_args"][0]) forcincache_lst]), sum(result_lst)
 )
deftest_cache_data_invalid_directory(self):
withself.assertRaises(ValueError):
get_cache_data("/nonexistent/path")

 def tearDown(self):
 if os.path.exists("cache"):
 shutil.rmtree("cache")

Comment on lines

+31
 to 
+33

@coderabbitaicoderabbitaiBotDec 17, 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
Update cleanup to use test's cache directory
The tearDown method should clean up the temporary directory used in the test, not a hardcoded path.
 def tearDown(self):
- if os.path.exists("cache"):- shutil.rmtree("cache")+ if hasattr(self, '_testMethodName'):+ method = getattr(self, self._testMethodName)+ if hasattr(method, 'cache_directory'):+ shutil.rmtree(method.cache_directory)
Committable suggestion skipped: line range outside the PR's diff.