Skip to content

Commit 1ec15f7

Browse files
RRosioRRosio
authored
Merge pull request #122 from ericsnekbytes/signals_refactor
Continue signal refactors.
2 parents 12b4ea5 + 17d58f5 commit 1ec15f7

8 files changed

+319
-103
lines changed

‎jupyter_fsspec/file_manager.py

+38-10
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,21 @@ def _get_protocol_from_path(path):
115115
protocol = storage_options.get("protocol", "file")
116116
return protocol
117117

118+
@staticmethod
119+
def construct_fs(fs_protocol, asynchronous, *args, **kwargs):
120+
return fsspec.filesystem(
121+
fs_protocol, asynchronous=asynchronous, *args, **kwargs
122+
)
123+
124+
def construct_named_fs(self, fs_name, asynchronous=False):
125+
if fs_name in self.filesystems:
126+
fs_info = self.filesystems[fs_name]
127+
fs_protocol = fs_info["protocol"]
128+
return FileSystemManager.construct_fs(
129+
fs_protocol, asynchronous, *fs_info["args"], **fs_info["kwargs"]
130+
)
131+
return None
132+
118133
def initialize_filesystems(self):
119134
new_filesystems = {}
120135

@@ -139,21 +154,34 @@ def initialize_filesystems(self):
139154

140155
key = self._encode_key(fs_config)
141156

157+
# Store the filesystem instance
158+
fs_info = {
159+
"instance": None,
160+
"name": fs_name,
161+
"protocol": fs_protocol,
162+
"path": None,
163+
"canonical_path": None,
164+
"args": args,
165+
"kwargs": kwargs,
166+
}
167+
new_filesystems[key] = fs_info
142168
fs_class = fsspec.get_filesystem_class(fs_protocol)
143169
if fs_class.async_impl:
144-
fs = fsspec.filesystem(fs_protocol, asynchronous=True, *args, **kwargs)
170+
fs = FileSystemManager.construct_fs(fs_protocol, True, *args, **kwargs)
171+
fs_info["instance"] = fs
172+
173+
fs_info["path"] = fs._strip_protocol(fs_path)
174+
fs_info["canonical_path"] = fs.unstrip_protocol(fs_path)
145175
else:
146-
sync_fs = fsspec.filesystem(fs_protocol, *args, **kwargs)
176+
sync_fs = FileSystemManager.construct_fs(
177+
fs_protocol, False, *args, **kwargs
178+
)
147179
fs = AsyncFileSystemWrapper(sync_fs)
180+
fs_info["instance"] = fs
181+
182+
fs_info["path"] = fs._strip_protocol(fs_path)
183+
fs_info["canonical_path"] = fs.unstrip_protocol(fs_path)
148184

149-
# Store the filesystem instance
150-
new_filesystems[key] = {
151-
"instance": fs,
152-
"name": fs_name,
153-
"protocol": fs_protocol,
154-
"path": fs._strip_protocol(fs_path),
155-
"canonical_path": fs.unstrip_protocol(fs_path),
156-
}
157185
logger.debug(
158186
f"Initialized filesystem '{fs_name}' with protocol '{fs_protocol}' at path '{fs_path}'"
159187
)

‎jupyter_fsspec/helper.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -117,9 +117,9 @@ def _get_fs(fs_name):
117117
# Get an fsspec filesystem from the manager
118118
# The fs_name is url encoded, we handle that here...TODO refactor that
119119
mgr = _get_manager()
120-
fs = mgr.get_filesystem(fs_name)
121-
if fs is not None and "instance" in fs:
122-
return fs["instance"] # TODO refactor
120+
fs = mgr.construct_named_fs(fs_name)
121+
if fs is not None:
122+
return fs
123123
else:
124124
raise JupyterFsspecException("Error, could not find specified filesystem")
125125

‎package.json

+3
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,8 @@
6565
"@jupyterlab/filebrowser": "^4.0.0",
6666
"@jupyterlab/settingregistry": "^4.0.0",
6767
"@jupyterlab/ui-components": "^4.0.0",
68+
"@lumino/signaling": "^2.0.0",
69+
"@lumino/widgets": "^2.5.0",
6870
"buffer": "^6.0.3",
6971
"path": "^0.12.7",
7072
"react": "^18.3.1",
@@ -95,6 +97,7 @@
9597
"stylelint-csstree-validator": "^3.0.0",
9698
"stylelint-prettier": "^4.0.0",
9799
"typescript": "~5.0.2",
100+
"util": "^0.12.5",
98101
"yjs": "^13.5.0"
99102
},
100103
"resolutions": {

‎src/FssTreeItem.ts

+19-51
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ import {
55
jpTreeItem
66
} from '@jupyter/web-components';
77

8+
import { Signal } from '@lumino/signaling';
9+
810
import { INotebookTracker } from '@jupyterlab/notebook';
911

1012
import { fileIcon, folderIcon } from '@jupyterlab/ui-components';
@@ -20,27 +22,18 @@ export class FssTreeItem {
2022
sizeLbl: HTMLElement;
2123
dirSymbol: HTMLElement;
2224
container: HTMLElement;
23-
clickSlots: any;
24-
getBytesSlots: any;
25-
uploadUserDataSlots: any;
26-
uploadFromBrowserPickerSlots: any;
27-
uploadFromJupyterBrowserSlots: any;
2825
isDir = false;
2926
treeItemObserver: MutationObserver;
3027
pendingExpandAction = false;
3128
lazyLoadAutoExpand = true;
3229
clickAnywhereDoesAutoExpand = true;
3330
notebookTracker: INotebookTracker;
31+
treeItemClicked: Signal<any, string>;
32+
getBytesRequested: Signal<any, string>;
33+
uploadRequested: Signal<any, any>; // All upload requests go here (kernel user_data, browser picker etc.)
3434

3535
constructor(
3636
model: any,
37-
clickSlots: any,
38-
userGetBytesSlots: any,
39-
uploadUserDataSlots: any,
40-
41-
uploadFromBrowserPickerSlots: any,
42-
uploadFromJupyterBrowserSlots: any,
43-
4437
autoExpand: boolean,
4538
expandOnClickAnywhere: boolean,
4639
notebookTracker: INotebookTracker
@@ -56,14 +49,12 @@ export class FssTreeItem {
5649
root.setAttribute('name', 'jfss-treeitem-root');
5750
this.root = root;
5851
this.model = model;
59-
this.clickSlots = clickSlots;
60-
this.getBytesSlots = userGetBytesSlots; // TODO fix its horrible
61-
this.uploadUserDataSlots = uploadUserDataSlots;
62-
this.uploadFromBrowserPickerSlots = uploadFromBrowserPickerSlots;
63-
this.uploadFromJupyterBrowserSlots = uploadFromJupyterBrowserSlots;
6452
this.lazyLoadAutoExpand = autoExpand;
6553
this.clickAnywhereDoesAutoExpand = expandOnClickAnywhere;
6654
this.notebookTracker = notebookTracker;
55+
this.treeItemClicked = new Signal<this, string>(this);
56+
this.getBytesRequested = new Signal<this, string>(this);
57+
this.uploadRequested = new Signal<this, any>(this);
6758

6859
// Use a MutationObserver on the root TreeItem's shadow DOM,
6960
// where the TreeItem's expand/collapse control will live once
@@ -119,30 +110,12 @@ export class FssTreeItem {
119110

120111
handleRequestBytes() {
121112
Logger.debug('Treeitem get bytes');
122-
for (const slot of this.getBytesSlots) {
123-
Logger.debug(slot);
124-
slot(this.root.dataset.fss);
125-
}
126-
}
127-
128-
async handleUploadFromBrowserPicker(options: any) {
129-
this.model.queuedPickerUploadInfo = {}; // Context click always resets this data
130-
Logger.debug('Treeitem upload user data');
131-
for (const slot of this.uploadFromBrowserPickerSlots) {
132-
Logger.debug(slot);
133-
await slot(this.root.dataset.fss, this.isDir);
134-
}
113+
this.getBytesRequested.emit(this.root.dataset.fss);
135114
}
136115

137-
async handleUploadFromJupyterBrowser(options: any) {
138-
Logger.debug('Treeitem upload user data');
139-
for (const slot of this.uploadFromJupyterBrowserSlots) {
140-
Logger.debug(slot);
141-
await slot(this.root.dataset.fss, this.isDir);
142-
}
143-
}
144-
145-
async handleUploadUserData(options: any) {
116+
async handleUploadRequest(options: any) {
117+
// Uploads can come from different places, gather info and emit it here
118+
// (so that connected slots can route the request to the right place)
146119
let is_browser_file_picker = false;
147120
let is_jup_browser_file = false;
148121
if (options) {
@@ -151,15 +124,12 @@ export class FssTreeItem {
151124
this.model.queuedPickerUploadInfo = {}; // Context click always resets this data
152125
}
153126
Logger.debug('Treeitem upload user data');
154-
for (const slot of this.uploadUserDataSlots) {
155-
Logger.debug(slot);
156-
await slot(
157-
this.root.dataset.fss,
158-
this.isDir,
159-
is_browser_file_picker,
160-
is_jup_browser_file
161-
);
162-
}
127+
this.uploadRequested.emit({
128+
user_path: this.root.dataset.fss,
129+
is_dir: this.isDir,
130+
is_browser_file_picker: is_browser_file_picker,
131+
is_jup_browser_file: is_jup_browser_file
132+
});
163133
}
164134

165135
setMetadata(user_path: string, size: string) {
@@ -250,9 +220,7 @@ export class FssTreeItem {
250220
}
251221
// Fire connected slots that were supplied to this item on init
252222
if (this.isDir) {
253-
for (const slot of this.clickSlots) {
254-
slot(this.root.dataset.fss);
255-
}
223+
this.treeItemClicked.emit(this.root.dataset.fss);
256224
} else {
257225
this.root.click();
258226
}

‎src/FssTreeItemContext.ts

+8-4
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,7 @@ export class FssTreeItemContext {
104104
}
105105
}
106106
}
107+
107108
copyOpenCodeBlock() {
108109
const path = this.copyPath();
109110

@@ -129,7 +130,7 @@ export class FssTreeItemContext {
129130
}
130131

131132
handleItemClick(event: any) {
132-
// TODO multiple menu it
133+
console.log('sig1');
133134
if (event.target.dataset.fssContextType === 'copyPath') {
134135
this.copyPathToClipboard();
135136
} else if (event.target.dataset.fssContextType === 'copyOpenCodeBlock') {
@@ -143,12 +144,13 @@ export class FssTreeItemContext {
143144
} else if (event.target.dataset.fssContextType === 'uploadUserData') {
144145
Logger.debug('XX1');
145146
if (this.parentControl) {
146-
this.parentControl.handleUploadUserData();
147+
this.parentControl.handleUploadRequest();
147148
}
148149
} else if (event.target.dataset.fssContextType === 'uploadBrowserFile') {
149150
Logger.debug('XX2');
151+
console.log('sig2');
150152
if (this.parentControl) {
151-
this.parentControl.handleUploadFromBrowserPicker({
153+
this.parentControl.handleUploadRequest({
152154
is_browser_file_picker: true
153155
});
154156
}
@@ -157,13 +159,15 @@ export class FssTreeItemContext {
157159
) {
158160
Logger.debug('XX3');
159161
if (this.parentControl) {
160-
this.parentControl.handleUploadFromJupyterBrowser({
162+
this.parentControl.handleUploadRequest({
161163
is_jup_browser_file: true
162164
});
163165
}
164166
}
165167

168+
console.log('sig3');
166169
this.root.remove();
170+
console.log('sig4');
167171
}
168172

169173
handleItemHover(event: any) {

0 commit comments

Comments
 (0)