Rename methods to upload files

It was agreed to use `upload_from_path(path)` and
`upload_from_bytes(content, name)`.

Also update protocols which raised, it seems a valid error.

Author: gmazoyer

changelog/ihs193.added.md

@@ -0,0 +1 @@
+Added support for FileObject nodes with file upload and download capabilities. New methods `upload_from_path(path)` and `upload_from_bytes(content, name)` allow setting file content before saving, while `download_file(dest)` enables downloading files to memory or streaming to disk for large files.

infrahub_sdk/ctl/branch.py

@@ -119,8 +119,8 @@ def generate_proposed_change_tables(proposed_changes: list[CoreProposedChange])
         proposed_change_table.add_row("Name", pc.name.value)
         proposed_change_table.add_row("State", str(pc.state.value))
         proposed_change_table.add_row("Is draft", "Yes" if pc.is_draft.value else "No")
-        proposed_change_table.add_row("Created by", pc.created_by.peer.name.value)  # type: ignore[union-attr]
-        proposed_change_table.add_row("Created at", format_timestamp(str(pc.created_by.updated_at)))
+        proposed_change_table.add_row("Created by", pc.created_by.peer.name.value)  # type: ignore[attr-defined]
+        proposed_change_table.add_row("Created at", format_timestamp(str(pc.created_by.updated_at)))  # type: ignore[attr-defined]
         proposed_change_table.add_row("Approvals", str(len(pc.approved_by.peers)))
         proposed_change_table.add_row("Rejections", str(len(pc.rejected_by.peers)))
 

infrahub_sdk/node/node.py

@@ -225,8 +225,8 @@ def is_file_object(self) -> bool:
         """Check if this node inherits from CoreFileObject and supports file uploads."""
         return self._file_object_support
 
-    def select_file_for_upload(self, path: Path) -> None:
-        """Select a file from disk to be uploaded when saving this FileObject node.
+    def upload_from_path(self, path: Path) -> None:
+        """Set a file from disk to be uploaded when saving this FileObject node.
 
         The file will be streamed during upload, avoiding loading the entire file into memory.
 
@@ -237,7 +237,7 @@ def select_file_for_upload(self, path: Path) -> None:
             FeatureNotSupportedError: If this node doesn't inherit from CoreFileObject.
 
         Example:
-            node.select_file_for_upload(path=Path("/path/to/large_file.pdf"))
+            node.upload_from_path(path=Path("/path/to/large_file.pdf"))
         """
         if not self._file_object_support:
             raise FeatureNotSupportedError(
@@ -246,8 +246,8 @@ def select_file_for_upload(self, path: Path) -> None:
         self._file_content = path
         self._file_name = path.name
 
-    def select_content_for_upload(self, content: bytes | BinaryIO, name: str) -> None:
-        """Select content to be uploaded when saving this FileObject node.
+    def upload_from_bytes(self, content: bytes | BinaryIO, name: str) -> None:
+        """Set content to be uploaded when saving this FileObject node.
 
         The content can be provided as bytes or a file-like object.
         Using BinaryIO is recommended for large content to stream during upload.
@@ -261,11 +261,11 @@ def select_content_for_upload(self, content: bytes | BinaryIO, name: str) -> Non
 
         Examples:
             # Using bytes (for small files)
-            node.select_content_for_upload(content=b"file content", name="example.txt")
+            node.upload_from_bytes(content=b"file content", name="example.txt")
 
             # Using file-like object (for large files)
             with open("/path/to/file.bin", "rb") as f:
-                node.select_content_for_upload(content=f, name="file.bin")
+                node.upload_from_bytes(content=f, name="file.bin")
         """
         if not self._file_object_support:
             raise FeatureNotSupportedError(
@@ -1159,7 +1159,7 @@ async def create(
     ) -> None:
         if self._file_object_support and self._file_content is None:
             raise ValueError(
-                f"Cannot create {self._schema.kind} without file content. Use select_file_for_upload() or select_content_for_upload() to provide "
+                f"Cannot create {self._schema.kind} without file content. Use upload_from_path() or upload_from_bytes() to provide "
                 "file content before saving."
             )
 
@@ -2049,7 +2049,7 @@ def create(
     ) -> None:
         if self._file_object_support and self._file_content is None:
             raise ValueError(
-                f"Cannot create {self._schema.kind} without file content. Use select_file_for_upload() or select_content_for_upload() to provide "
+                f"Cannot create {self._schema.kind} without file content. Use upload_from_path() or upload_from_bytes() to provide "
                 "file content before saving."
             )
 

infrahub_sdk/protocols.py

@@ -29,7 +29,6 @@
         StringOptional,
     )
 
-# pylint: disable=too-many-ancestors
 
 # ---------------------------------------------
 # ASYNC
@@ -108,6 +107,14 @@ class CoreCredential(CoreNode):
     description: StringOptional
 
 
+class CoreFileObject(CoreNode):
+    file_name: String
+    checksum: String
+    file_size: Integer
+    file_type: String
+    storage_id: String
+
+
 class CoreGenericAccount(CoreNode):
     name: String
     password: HashedPassword
@@ -227,6 +234,7 @@ class CoreValidator(CoreNode):
 class CoreWebhook(CoreNode):
     name: String
     event_type: Enum
+    active: Boolean
     branch_scope: Dropdown
     node_kind: StringOptional
     description: StringOptional
@@ -499,7 +507,6 @@ class CoreProposedChange(CoreTaskTarget):
     approved_by: RelationshipManager
     rejected_by: RelationshipManager
     reviewers: RelationshipManager
-    created_by: RelatedNode
     comments: RelationshipManager
     threads: RelationshipManager
     validations: RelationshipManager
@@ -665,6 +672,14 @@ class CoreCredentialSync(CoreNodeSync):
     description: StringOptional
 
 
+class CoreFileObjectSync(CoreNodeSync):
+    file_name: String
+    checksum: String
+    file_size: Integer
+    file_type: String
+    storage_id: String
+
+
 class CoreGenericAccountSync(CoreNodeSync):
     name: String
     password: HashedPassword
@@ -784,6 +799,7 @@ class CoreValidatorSync(CoreNodeSync):
 class CoreWebhookSync(CoreNodeSync):
     name: String
     event_type: Enum
+    active: Boolean
     branch_scope: Dropdown
     node_kind: StringOptional
     description: StringOptional
@@ -1056,7 +1072,6 @@ class CoreProposedChangeSync(CoreTaskTargetSync):
     approved_by: RelationshipManagerSync
     rejected_by: RelationshipManagerSync
     reviewers: RelationshipManagerSync
-    created_by: RelatedNodeSync
     comments: RelationshipManagerSync
     threads: RelationshipManagerSync
     validations: RelationshipManagerSync

tests/unit/sdk/test_file_object.py

@@ -89,7 +89,7 @@ async def test_node_create_with_file_uses_multipart(
 
     node.contract_start.value = "2024-01-01T00:00:00Z"  # type: ignore[union-attr]
     node.contract_end.value = "2024-12-31T23:59:59Z"  # type: ignore[union-attr]
-    node.select_content_for_upload(content=FILE_CONTENT, name=FILE_NAME)
+    node.upload_from_bytes(content=FILE_CONTENT, name=FILE_NAME)
 
     if isinstance(node, InfrahubNode):
         await node.save()
@@ -121,7 +121,7 @@ async def test_node_update_with_file_uses_multipart(
     node._existing = True
     node.contract_start.value = "2024-01-01T00:00:00Z"  # type: ignore[union-attr]
     node.contract_end.value = "2024-12-31T23:59:59Z"  # type: ignore[union-attr]
-    node.select_content_for_upload(content=FILE_CONTENT, name=FILE_NAME)
+    node.upload_from_bytes(content=FILE_CONTENT, name=FILE_NAME)
 
     if isinstance(node, InfrahubNode):
         await node.save()
@@ -173,7 +173,7 @@ async def test_node_save_clears_file_after_upload(
     node.contract_start.value = "2024-01-01T00:00:00Z"  # type: ignore[union-attr]
     node.contract_end.value = "2024-12-31T23:59:59Z"  # type: ignore[union-attr]
 
-    node.select_content_for_upload(content=FILE_CONTENT, name=FILE_NAME)
+    node.upload_from_bytes(content=FILE_CONTENT, name=FILE_NAME)
     assert node._file_content is not None
     assert node._file_name is not None
 

tests/unit/sdk/test_node.py

@@ -3303,27 +3303,25 @@ async def test_node_is_file_object_false(
 
 
 @pytest.mark.parametrize("client_type", client_types)
-async def test_node_select_content_for_upload_with_bytes(
+async def test_node_upload_from_bytes_with_bytes(
     client_type: str, clients: BothClients, file_object_schema: NodeSchemaAPI
 ) -> None:
-    """Test that select_content_for_upload works with bytes on FileObject nodes."""
+    """Test that upload_from_bytes works with bytes on FileObject nodes."""
     if client_type == "standard":
         node = InfrahubNode(client=clients.standard, schema=file_object_schema, branch="main")
     else:
         node = InfrahubNodeSync(client=clients.sync, schema=file_object_schema, branch="main")
 
     file_content = b"PDF content here"
-    node.select_content_for_upload(content=file_content, name="contract.pdf")
+    node.upload_from_bytes(content=file_content, name="contract.pdf")
 
     assert node._file_content == file_content
     assert node._file_name == "contract.pdf"
 
 
 @pytest.mark.parametrize("client_type", client_types)
-async def test_node_select_file_for_upload(
-    client_type: str, clients: BothClients, file_object_schema: NodeSchemaAPI
-) -> None:
-    """Test that select_file_for_upload works with a Path object."""
+async def test_node_upload_from_path(client_type: str, clients: BothClients, file_object_schema: NodeSchemaAPI) -> None:
+    """Test that upload_from_path works with a Path object."""
     if client_type == "standard":
         node = InfrahubNode(client=clients.standard, schema=file_object_schema, branch="main")
     else:
@@ -3335,16 +3333,16 @@ async def test_node_select_file_for_upload(
         tmp.flush()
         tmp_path = Path(tmp.name)
 
-        node.select_file_for_upload(path=tmp_path)
+        node.upload_from_path(path=tmp_path)
         assert node._file_content == tmp_path
         assert node._file_name == tmp_path.name
 
 
 @pytest.mark.parametrize("client_type", client_types)
-async def test_node_select_content_for_upload_with_binary_io(
+async def test_node_upload_from_bytes_with_binary_io(
     client_type: str, clients: BothClients, file_object_schema: NodeSchemaAPI
 ) -> None:
-    """Test that select_content_for_upload works with a BinaryIO object."""
+    """Test that upload_from_bytes works with a BinaryIO object."""
     if client_type == "standard":
         node = InfrahubNode(client=clients.standard, schema=file_object_schema, branch="main")
     else:
@@ -3353,38 +3351,38 @@ async def test_node_select_content_for_upload_with_binary_io(
     file_content = b"Content from BinaryIO"
     file_obj = BytesIO(file_content)
 
-    node.select_content_for_upload(content=file_obj, name="uploaded.pdf")
+    node.upload_from_bytes(content=file_obj, name="uploaded.pdf")
 
     assert node._file_content == file_obj
     assert node._file_name == "uploaded.pdf"
 
 
 @pytest.mark.parametrize("client_type", client_types)
-async def test_node_select_content_for_upload_on_non_file_object_raises(
+async def test_node_upload_from_bytes_on_non_file_object_raises(
     client_type: str, clients: BothClients, non_file_object_schema: NodeSchemaAPI
 ) -> None:
-    """Test that select_content_for_upload raises FeatureNotSupportedError on non-FileObject nodes."""
+    """Test that upload_from_bytes raises FeatureNotSupportedError on non-FileObject nodes."""
     if client_type == "standard":
         node = InfrahubNode(client=clients.standard, schema=non_file_object_schema, branch="main")
     else:
         node = InfrahubNodeSync(client=clients.sync, schema=non_file_object_schema, branch="main")
 
     with pytest.raises(FeatureNotSupportedError, match=r"File upload is not supported"):
-        node.select_content_for_upload(content=b"some content", name="file.txt")
+        node.upload_from_bytes(content=b"some content", name="file.txt")
 
 
 @pytest.mark.parametrize("client_type", client_types)
-async def test_node_select_file_for_upload_on_non_file_object_raises(
+async def test_node_upload_from_path_on_non_file_object_raises(
     client_type: str, clients: BothClients, non_file_object_schema: NodeSchemaAPI
 ) -> None:
-    """Test that select_file_for_upload raises FeatureNotSupportedError on non-FileObject nodes."""
+    """Test that upload_from_path raises FeatureNotSupportedError on non-FileObject nodes."""
     if client_type == "standard":
         node = InfrahubNode(client=clients.standard, schema=non_file_object_schema, branch="main")
     else:
         node = InfrahubNodeSync(client=clients.sync, schema=non_file_object_schema, branch="main")
 
     with pytest.raises(FeatureNotSupportedError, match=r"File upload is not supported"):
-        node.select_file_for_upload(path=Path("/some/file.txt"))
+        node.upload_from_path(path=Path("/some/file.txt"))
 
 
 @pytest.mark.parametrize("client_type", client_types)
@@ -3398,7 +3396,7 @@ async def test_node_clear_file(client_type: str, clients: BothClients, file_obje
     file_content = b"Test content"
     file_name = "file.txt"
 
-    node.select_content_for_upload(content=file_content, name=file_name)
+    node.upload_from_bytes(content=file_content, name=file_name)
     assert node._file_content == file_content
     assert node._file_name == file_name
 
@@ -3419,7 +3417,7 @@ async def test_node_get_file_for_upload_bytes(
 
     file_content = b"Test content"
     file_name = "test.txt"
-    node.select_content_for_upload(content=file_content, name=file_name)
+    node.upload_from_bytes(content=file_content, name=file_name)
 
     if isinstance(node, InfrahubNode):
         prepared = await node._get_file_for_upload()
@@ -3448,7 +3446,7 @@ async def test_node_get_file_for_upload_path(
         tmp.flush()
         tmp_path = Path(tmp.name)
 
-        node.select_file_for_upload(path=tmp_path)
+        node.upload_from_path(path=tmp_path)
 
         if isinstance(node, InfrahubNode):
             prepared = await node._get_file_for_upload()
@@ -3475,7 +3473,7 @@ async def test_node_get_file_for_upload_binary_io(
     file_content = b"Content from BinaryIO"
     file_name = "test.bin"
     file_obj_input = BytesIO(file_content)
-    node.select_content_for_upload(content=file_obj_input, name=file_name)
+    node.upload_from_bytes(content=file_obj_input, name=file_name)
 
     if isinstance(node, InfrahubNode):
         prepared = await node._get_file_for_upload()
@@ -3517,7 +3515,7 @@ async def test_node_generate_input_data_with_file(
     else:
         node = InfrahubNodeSync(client=clients.sync, schema=file_object_schema, branch="main")
 
-    node.select_content_for_upload(content=b"test content", name="test.txt")
+    node.upload_from_bytes(content=b"test content", name="test.txt")
 
     input_data = node._generate_input_data()