feat: infer upload source

Author: ashish-spext

README.md

@@ -78,10 +78,10 @@ You can directly upload from `youtube`, `any public url`, `S3 bucket` or a `loca
 
 ```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 +147,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.

tests/test_upload.py

@@ -0,0 +1,22 @@
+from videodb._upload import upload
+
+
+class DummyConn:
+    def __init__(self):
+        self.collection_id = "default"
+        self.data = None
+
+    def get(self, path, params=None, show_progress=False):
+        # return fake upload url
+        return {"upload_url": "http://upload"}
+
+    def post(self, path, data=None, show_progress=False):
+        self.data = data
+        # mimic api returning id and url
+        return {"id": "m-1", **(data or {})}
+
+
+def test_upload_infers_url():
+    conn = DummyConn()
+    upload(conn, file_path="https://example.com/video.mp4")
+    assert conn.data["url"] == "https://example.com/video.mp4"

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,6 +15,11 @@
 )
 
 
+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,
@@ -22,6 +29,14 @@ def upload(
     description: Optional[str] = None,
     callback_url: Optional[str] = None,
 ) -> dict:
+    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

@@ -265,6 +265,9 @@ def upload(
     ) -> Union[Video, Audio, Image, None]:
         """Upload a file.
 
+        The method automatically detects if ``file_path`` is a URL or a local
+        path when only one of ``file_path`` or ``url`` is provided.
+
         :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)

videodb/collection.py

@@ -437,6 +437,9 @@ def upload(
     ) -> Union[Video, Audio, Image, None]:
         """Upload a file to the collection.
 
+        The method automatically detects if ``file_path`` is a URL or a local
+        path when only one of ``file_path`` or ``url`` is provided.
+
         :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)