Skip to content

Commit ce6e29a

Browse files
authored
fix: File paramter: Improve user-friendliness of File class
Improve user-friendliness of File class
2 parents 60a1e3d + 2667b1c commit ce6e29a

File tree

3 files changed

+10
-5
lines changed

3 files changed

+10
-5
lines changed

openhexa/sdk/files/file.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,16 @@ class File:
1212

1313
def __init__(
1414
self,
15-
key: str,
1615
name: str,
1716
path: str,
1817
size: int,
1918
type: str,
2019
):
21-
self.key = key
2220
self.name = name
2321
self.path = path
2422
self.size = size
2523
self.type = type
2624

2725
def __repr__(self) -> str:
2826
"""Safe representation of a file instance."""
29-
return f"<File key={self.key} name={self.name} path={self.path}>"
27+
return f"<File name={self.name} path={self.path}>"

openhexa/sdk/workspaces/current_workspace.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -634,4 +634,11 @@ def get_file(self, path: str) -> File:
634634
ValueError
635635
If the file does not exist
636636
"""
637-
return OpenHexaClient().get_file_by_path(path=path, workspace_slug=self.slug)
637+
result = OpenHexaClient().get_file_by_path(path=path, workspace_slug=self.slug)
638+
639+
return File(
640+
name=result.name,
641+
path=f"{self.files_path}/{result.key}",
642+
size=result.size,
643+
type=result.type,
644+
)

tests/test_parameter.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ def test_validate_dataset_parameter(mock_get_dataset):
217217
@mock.patch("openhexa.sdk.workspace.get_file")
218218
def test_validate_file_parameter(mock_get_file):
219219
"""Check File parameter validation."""
220-
file = File(key="test.csv", name="test.csv", path="my_folder/test.csv", size=1024, type="file")
220+
file = File(name="test.csv", path="my_folder/test.csv", size=1024, type="file")
221221
mock_get_file.return_value = file
222222

223223
file_type = FileType()

0 commit comments

Comments
 (0)