refactor upload params

Author: ashish-spext

README.md

@@ -75,8 +75,9 @@ Now that you have established a connection to VideoDB, you can upload your video
 You can directly upload from `youtube`, `any public url`, `S3 bucket` or a `local file path`. A default collection is created when you create your first connection.
 
 `upload` method returns a `Video` object. You can simply pass a single string
-representing either a local file path or a URL. For explicit calls, use the
-``source`` parameter.
+representing either a local file path or a URL. The optional second positional
+argument is `media_type`, keeping backwards compatibility. For explicit calls,
+use the ``source`` parameter.
 
 ```python
 # Upload a video by url

tests/test_upload.py

@@ -1,4 +1,5 @@
 from videodb._upload import upload, VideodbError
+from videodb._constants import MediaType
 
 
 class DummyConn:
@@ -30,3 +31,10 @@ def test_upload_source_conflict():
         assert True
     else:
         assert False, "Expected VideodbError"
+
+
+def test_upload_media_type_positional():
+    conn = DummyConn()
+    upload(conn, "https://example.com/video.mp4", MediaType.video)
+    assert conn.data["url"] == "https://example.com/video.mp4"
+    assert conn.data["media_type"] == MediaType.video

videodb/__about__.py

@@ -1,6 +1,6 @@
 """About information for videodb sdk"""
 
-__version__ = "0.2.17"
+__version__ = "0.2.18"
 __title__ = "videodb"
 __author__ = "videodb"
 __email__ = "[email protected]"

videodb/_upload.py

@@ -23,12 +23,12 @@ def _is_url(path: str) -> bool:
 def upload(
     _connection,
     source: str | None = None,
-    file_path: str | None = None,
-    url: str | None = None,
     media_type: Optional[str] = None,
     name: Optional[str] = None,
     description: Optional[str] = None,
     callback_url: Optional[str] = None,
+    file_path: str | None = None,
+    url: str | None = None,
 ) -> dict:
     """Upload a file or URL.
 

videodb/client.py

@@ -257,37 +257,37 @@ def get_transcode_details(self, job_id: str) -> dict:
     def upload(
         self,
         source: str | None = None,
-        file_path: str | None = None,
-        url: str | None = None,
         media_type: Optional[str] = None,
         name: Optional[str] = None,
         description: Optional[str] = None,
         callback_url: Optional[str] = None,
+        file_path: str | None = None,
+        url: str | None = None,
     ) -> Union[Video, Audio, Image, None]:
         """Upload a file.
 
         The method automatically detects if ``source``/``file_path`` is a URL
         or a local path when only one of ``file_path`` or ``url`` is provided.
 
         :param str source: Local path or URL of the file to upload (optional)
-        :param str file_path: Path to the file to upload (optional)
-        :param str url: URL of the file to upload (optional)
         :param MediaType media_type: MediaType object (optional)
         :param str name: Name of the file (optional)
         :param str description: Description of the file (optional)
         :param str callback_url: URL to receive the callback (optional)
+        :param str file_path: Path to the file to upload (optional)
+        :param str url: URL of the file to upload (optional)
         :return: :class:`Video <Video>`, or :class:`Audio <Audio>`, or :class:`Image <Image>` object
         :rtype: Union[ :class:`videodb.video.Video`, :class:`videodb.audio.Audio`, :class:`videodb.image.Image`]
         """
         upload_data = upload(
             self,
             source,
-            file_path=file_path,
-            url=url,
             media_type=media_type,
             name=name,
             description=description,
             callback_url=callback_url,
+            file_path=file_path,
+            url=url,
         )
         media_id = upload_data.get("id", "")
         if media_id.startswith("m-"):

videodb/collection.py

@@ -429,37 +429,37 @@ def search_title(self, query) -> List[Video]:
     def upload(
         self,
         source: str | None = None,
-        file_path: str = None,
-        url: Optional[str] = None,
         media_type: Optional[str] = None,
         name: Optional[str] = None,
         description: Optional[str] = None,
         callback_url: Optional[str] = None,
+        file_path: str = None,
+        url: Optional[str] = None,
     ) -> Union[Video, Audio, Image, None]:
         """Upload a file to the collection.
 
         The method automatically detects if ``source``/``file_path`` is a URL
         or a local path when only one of ``file_path`` or ``url`` is provided.
 
         :param str source: Local path or URL of the file to be uploaded
-        :param str file_path: Path to the file to be uploaded
-        :param str url: URL of the file to be uploaded
         :param MediaType media_type: MediaType object (optional)
         :param str name: Name of the file (optional)
         :param str description: Description of the file (optional)
         :param str callback_url: URL to receive the callback (optional)
+        :param str file_path: Path to the file to be uploaded
+        :param str url: URL of the file to be uploaded
         :return: :class:`Video <Video>`, or :class:`Audio <Audio>`, or :class:`Image <Image>` object
         :rtype: Union[ :class:`videodb.video.Video`, :class:`videodb.audio.Audio`, :class:`videodb.image.Image`]
         """
         upload_data = upload(
             self._connection,
             source,
-            file_path=file_path,
-            url=url,
             media_type=media_type,
             name=name,
             description=description,
             callback_url=callback_url,
+            file_path=file_path,
+            url=url,
         )
         media_id = upload_data.get("id", "")
         if media_id.startswith("m-"):