Improve upload source detection in Conn.upload() and coll.upload()

Author: 0xrohitgarg

README.md

@@ -74,14 +74,15 @@ conn = videodb.connect(api_key="YOUR_API_KEY")
 Now that you have established a connection to VideoDB, you can upload your videos using `conn.upload()`.
 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.
+`upload` method returns a `Video` object. You can simply pass a single string
+representing either a local file path or a URL.
 
 ```python
 # Upload a video by url
-video = conn.upload(url="https://www.youtube.com/watch?v=WDv4AWk0J3U")
+video = conn.upload("https://www.youtube.com/watch?v=WDv4AWk0J3U")
 
 # Upload a video from file system
-video_f = conn.upload(file_path="./my_video.mp4")
+video_f = conn.upload("./my_video.mp4")
 
 ```
 
@@ -147,9 +148,9 @@ In the future you'll be able to index videos using:
 coll = conn.get_collection()
 
 # Upload Videos to a collection
-coll.upload(url="https://www.youtube.com/watch?v=lsODSDmY4CY")
-coll.upload(url="https://www.youtube.com/watch?v=vZ4kOr38JhY")
-coll.upload(url="https://www.youtube.com/watch?v=uak_dXHh6s4")
+coll.upload("https://www.youtube.com/watch?v=lsODSDmY4CY")
+coll.upload("https://www.youtube.com/watch?v=vZ4kOr38JhY")
+coll.upload("https://www.youtube.com/watch?v=uak_dXHh6s4")
 ```
 
 - `conn.get_collection()` : Returns a Collection object; the default collection.

videodb/__about__.py

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

videodb/_upload.py

@@ -1,7 +1,9 @@
 import requests
 
 from typing import Optional
+from urllib.parse import urlparse
 from requests import HTTPError
+import os
 
 
 from videodb._constants import (
@@ -13,15 +15,42 @@
 )
 
 
+def _is_url(path: str) -> bool:
+    parsed = urlparse(path)
+    return all([parsed.scheme in ("http", "https"), parsed.netloc])
+
+
 def upload(
     _connection,
-    file_path: str = None,
-    url: str = None,
+    source: Optional[str] = None,
     media_type: Optional[str] = None,
     name: Optional[str] = None,
     description: Optional[str] = None,
     callback_url: Optional[str] = None,
+    file_path: Optional[str] = None,
+    url: Optional[str] = None,
 ) -> dict:
+    """Upload a file or URL.
+
+    ``source`` can be used as a generic argument which accepts either a local
+    file path or a URL.
+    """
+    if source and (file_path or url):
+        raise VideodbError("source cannot be used with file_path or url")
+
+    if source and not file_path and not url:
+        if _is_url(source):
+            url = source
+        else:
+            file_path = source
+    if file_path and not url and _is_url(file_path):
+        url = file_path
+        file_path = None
+
+    if not file_path and url and not _is_url(url) and os.path.exists(url):
+        file_path = url
+        url = None
+
     if not file_path and not url:
         raise VideodbError("Either file_path or url is required")
     if file_path and url:

videodb/client.py

@@ -256,32 +256,35 @@ def get_transcode_details(self, job_id: str) -> dict:
 
     def upload(
         self,
-        file_path: str = None,
-        url: str = None,
+        source: Optional[str] = None,
         media_type: Optional[str] = None,
         name: Optional[str] = None,
         description: Optional[str] = None,
         callback_url: Optional[str] = None,
+        file_path: Optional[str] = None,
+        url: Optional[str] = None,
     ) -> Union[Video, Audio, Image, None]:
         """Upload a file.
 
-        :param str file_path: Path to the file to upload (optional)
-        :param str url: URL of the file to upload (optional)
+        :param str source: Local path or 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,
-            file_path,
-            url,
-            media_type,
-            name,
-            description,
-            callback_url,
+            source,
+            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

@@ -428,32 +428,35 @@ def search_title(self, query) -> List[Video]:
 
     def upload(
         self,
-        file_path: str = None,
-        url: Optional[str] = None,
+        source: Optional[str] = None,
         media_type: Optional[str] = None,
         name: Optional[str] = None,
         description: Optional[str] = None,
         callback_url: Optional[str] = None,
+        file_path: Optional[str] = None,
+        url: Optional[str] = None,
     ) -> Union[Video, Audio, Image, None]:
         """Upload a file to the collection.
 
-        :param str file_path: Path to the file to be uploaded
-        :param str url: URL of the file to be uploaded
+        :param str source: Local path or 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,
-            file_path,
-            url,
-            media_type,
-            name,
-            description,
-            callback_url,
+            source,
+            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-"):