Add __dir__ whitelist to SyftboxManager for cleaner Colab autocomplete

syft_client/sync/syftbox_manager.py

@@ -373,6 +373,36 @@ class SyftboxManager(BaseModel):
         default_factory=lambda: ThreadPoolExecutor(max_workers=10)
     )
 
+    _PUBLIC_API = (
+        "email",
+        "syftbox_folder",
+        "dev_mode",
+        "config",
+        "dataset_manager",
+        "version_manager",
+        "peers",
+        "jobs",
+        "datasets",
+        "add_peer",
+        "load_peers",
+        "approve_peer_request",
+        "reject_peer_request",
+        "sync",
+        "create_dataset",
+        "delete_dataset",
+        "share_dataset",
+        "submit_bash_job",
+        "submit_python_job",
+        "process_approved_jobs",
+        "create_checkpoint",
+        "should_create_checkpoint",
+        "try_create_checkpoint",
+        "delete_syftbox",
+    )
+
+    def __dir__(self):
+        return list(self._PUBLIC_API)
+
     @property
     def peers(self) -> PeerList:
         """

tests/unit/test_dir_autocomplete.py

@@ -0,0 +1,33 @@
+from syft_client.sync.syftbox_manager import SyftboxManager
+
+
+def test_dir_returns_only_public_api():
+    ds_manager, do_manager = SyftboxManager.pair_with_mock_drive_service_connection()
+
+    public_names = dir(ds_manager)
+
+    # Contains public API
+    assert "email" in public_names
+    assert "sync" in public_names
+    assert "peers" in public_names
+    assert "jobs" in public_names
+    assert "datasets" in public_names
+    assert "add_peer" in public_names
+    assert "create_dataset" in public_names
+    assert "submit_python_job" in public_names
+
+    # Hides Pydantic internals
+    assert "model_dump" not in public_names
+    assert "model_fields" not in public_names
+    assert "model_validate" not in public_names
+
+    # Hides internal fields
+    assert "datasite_owner_syncer" not in public_names
+    assert "datasite_watcher_syncer" not in public_names
+    assert "file_writer" not in public_names
+    assert "job_file_change_handler" not in public_names
+
+    # Hidden attributes are still accessible
+    assert ds_manager.email is not None
+    assert ds_manager.file_writer is not None
+    assert callable(ds_manager.model_dump)