ayon-python-api 1.2.16.dev0__py3-none-any.whl → 1.2.17__py3-none-any.whl

ayon_api/utils.py

@@ -12,9 +12,9 @@ import platform
 import traceback
 import collections
 import itertools
-from urllib.parse import urlparse, urlencode
+from urllib.parse import urlparse, urlencode, ParseResult
 import typing
-from typing import Optional, Any, Iterable, Union
+from typing import Any, Iterable
 from enum import IntEnum
 
 import requests
@@ -27,6 +27,7 @@ from .constants import (
 )
 from .exceptions import (
     UrlError,
+    UrlNotReached,
     ServerError,
     UnauthorizedError,
     HTTPRequestError,
@@ -148,7 +149,7 @@ class RestApiResponse:
         return self._response.content
 
     @property
-    def content_type(self) -> Optional[str]:
+    def content_type(self) -> str | None:
         return self.headers.get("Content-Type")
 
     @property
@@ -256,7 +257,7 @@ def fill_own_attribs(entity: AnyEntityDict) -> None:
             own_attrib[key] = copy.deepcopy(value)
 
 
-def _convert_list_filter_value(value: Any) -> Optional[list[Any]]:
+def _convert_filter_value(value: Any) -> list[Any] | None:
     if value is None:
         return None
 
@@ -272,7 +273,7 @@ def prepare_list_filters(
     output: dict[str, Any], *args: tuple[str, Any], **kwargs: Any
 ) -> bool:
     for key, value in itertools.chain(args, kwargs.items()):
-        value = _convert_list_filter_value(value)
+        value = _convert_filter_value(value)
         if value is None:
             continue
         if not value:
@@ -318,11 +319,11 @@ def get_machine_name() -> str:
     return unidecode.unidecode(platform.node())
 
 
-def get_default_site_id() -> Optional[str]:
+def get_default_site_id() -> str | None:
     """Site id used for server connection.
 
     Returns:
-        Optional[str]: Site id from environment variable or None.
+        str | None: Site id from environment variable or None.
 
     """
     return os.environ.get(SITE_ID_ENV_KEY)
@@ -333,25 +334,25 @@ class ThumbnailContent:
 
     Args:
         project_name (str): Project name.
-        thumbnail_id (Optional[str]): Thumbnail id.
-        content (Optional[bytes]): Thumbnail content.
-        content_type (Optional[str]): Content type e.g. 'image/png'.
+        thumbnail_id (str | None): Thumbnail id.
+        content (bytes | None): Thumbnail content.
+        content_type (str | None): Content type e.g. 'image/png'.
 
     """
     def __init__(
         self,
         project_name: str,
-        thumbnail_id: Optional[str],
-        content: Optional[bytes],
-        content_type: Optional[str],
+        thumbnail_id: str | None,
+        content: bytes | None,
+        content_type: str | None,
     ):
         self.project_name: str = project_name
-        self.thumbnail_id: Optional[str] = thumbnail_id
-        self.content_type: Optional[str] = content_type
+        self.thumbnail_id: str | None = thumbnail_id
+        self.content_type: str | None = content_type
         self.content: bytes = content or b""
 
     @property
-    def id(self) -> str:
+    def id(self) -> str | None:
         """Wrapper for thumbnail id."""
         return self.thumbnail_id
 
@@ -394,14 +395,14 @@ def prepare_query_string(
 
     if not key_values:
         return ""
-    return "?{}".format(urlencode(key_values))
+    return f"?{urlencode(key_values)}"
 
 
 def create_entity_id() -> str:
     return uuid.uuid1().hex
 
 
-def convert_entity_id(entity_id) -> Optional[str]:
+def convert_entity_id(entity_id) -> str | None:
     if not entity_id:
         return None
 
@@ -416,7 +417,7 @@ def convert_entity_id(entity_id) -> Optional[str]:
     return None
 
 
-def convert_or_create_entity_id(entity_id: Optional[str] = None) -> str:
+def convert_or_create_entity_id(entity_id: str | None = None) -> str:
     output = convert_entity_id(entity_id)
     if output is None:
         output = create_entity_id()
@@ -428,7 +429,7 @@ def entity_data_json_default(value: Any) -> Any:
         return int(value.timestamp())
 
     raise TypeError(
-        "Object of type {} is not JSON serializable".format(str(type(value)))
+        f"Object of type {type(value)} is not JSON serializable"
     )
 
 
@@ -440,7 +441,7 @@ def slugify_string(
     min_length: int = 1,
     lower: bool = False,
     make_set: bool = False,
-) -> Union[str, set[str]]:
+) -> str | set[str]:
     """Slugify a text string.
 
     This function removes transliterates input string to ASCII, removes
@@ -460,8 +461,7 @@ def slugify_string(
         min_length (int): Minimal length of an element (word).
 
     Returns:
-        Union[str, set[str]]: Based on 'make_set' value returns slugified
-            string.
+        str | set[str]: Based on 'make_set' value returns slugified string.
 
     """
     tmp_string = unidecode.unidecode(input_string)
@@ -486,14 +486,14 @@ def slugify_string(
 
 
 def failed_json_default(value: Any) -> str:
-    return "< Failed value {} > {}".format(type(value), str(value))
+    return f"< Failed value {type(value)} > {value}"
 
 
 def prepare_attribute_changes(
     old_entity: AnyEntityDict,
     new_entity: AnyEntityDict,
     replace: int = False,
-):
+) -> dict[str, Any]:
     attrib_changes = {}
     new_attrib = new_entity.get("attrib")
     old_attrib = old_entity.get("attrib")
@@ -544,7 +544,7 @@ def prepare_entity_changes(
     return changes
 
 
-def _try_parse_url(url: str) -> Optional[str]:
+def _try_parse_url(url: str) -> ParseResult | None:
     try:
         return urlparse(url)
     except BaseException:
@@ -553,10 +553,10 @@ def _try_parse_url(url: str) -> Optional[str]:
 
 def _try_connect_to_server(
     url: str,
-    timeout: Optional[float],
-    verify: Optional[Union[str, bool]],
-    cert: Optional[str],
-) -> Optional[str]:
+    timeout: float | None,
+    verify: str | bool | None,
+    cert: str | None,
+) -> str | None:
     if timeout is None:
         timeout = get_default_timeout()
 
@@ -570,11 +570,12 @@ def _try_connect_to_server(
         # TODO add validation if the url lead to AYON server
         #   - this won't validate if the url lead to 'google.com'
         response = requests.get(
-            url,
+            f"{url}/api/info",
             timeout=timeout,
             verify=verify,
             cert=cert,
         )
+        _ = response.json()
         if response.history:
             return response.history[-1].headers["location"].rstrip("/")
         return url
@@ -590,19 +591,19 @@ def login_to_server(
     url: str,
     username: str,
     password: str,
-    timeout: Optional[float] = None,
-) -> Optional[str]:
+    timeout: float | None = None,
+) -> str | None:
     """Use login to the server to receive token.
 
     Args:
         url (str): Server url.
         username (str): User's username.
         password (str): User's password.
-        timeout (Optional[float]): Timeout for request. Value from
+        timeout (float | None): Timeout for request. Value from
             'get_default_timeout' is used if not specified.
 
     Returns:
-        Optional[str]: User's token if login was successfull.
+        str | None: User's token if login was successfull.
             Otherwise 'None'.
 
     """
@@ -610,7 +611,7 @@ def login_to_server(
         timeout = get_default_timeout()
     headers = {"Content-Type": "application/json"}
     response = requests.post(
-        "{}/api/auth/login".format(url),
+        f"{url}/api/auth/login",
         headers=headers,
         json={
             "name": username,
@@ -627,13 +628,17 @@ def login_to_server(
     return token
 
 
-def logout_from_server(url: str, token: str, timeout: Optional[float] = None):
+def logout_from_server(
+    url: str,
+    token: str,
+    timeout: float | None = None,
+) -> None:
     """Logout from server and throw token away.
 
     Args:
         url (str): Url from which should be logged out.
         token (str): Token which should be used to log out.
-        timeout (Optional[float]): Timeout for request. Value from
+        timeout (float | None): Timeout for request. Value from
             'get_default_timeout' is used if not specified.
 
     """
@@ -641,10 +646,10 @@ def logout_from_server(url: str, token: str, timeout: Optional[float] = None):
         timeout = get_default_timeout()
     headers = {
         "Content-Type": "application/json",
-        "Authorization": "Bearer {}".format(token)
+        "Authorization": f"Bearer {token}",
     }
     requests.post(
-        url + "/api/auth/logout",
+        f"{url}/api/auth/logout",
         headers=headers,
         timeout=timeout,
     )
@@ -653,18 +658,18 @@ def logout_from_server(url: str, token: str, timeout: Optional[float] = None):
 def get_user_by_token(
     url: str,
     token: str,
-    timeout: Optional[float] = None,
-) -> Optional[dict[str, Any]]:
+    timeout: float | None = None,
+) -> dict[str, Any] | None:
     """Get user information by url and token.
 
     Args:
         url (str): Server url.
         token (str): User's token.
-        timeout (Optional[float]): Timeout for request. Value from
+        timeout (float | None): Timeout for request. Value from
             'get_default_timeout' is used if not specified.
 
     Returns:
-        Optional[dict[str, Any]]: User information if url and token are valid.
+        dict[str, Any] | None: User information if url and token are valid.
 
     """
     if timeout is None:
@@ -674,13 +679,13 @@ def get_user_by_token(
         "Content-Type": "application/json",
     }
     for header_value in (
-        {"Authorization": "Bearer {}".format(token)},
+        {"Authorization": f"Bearer {token}"},
         {"X-Api-Key": token},
     ):
         headers = base_headers.copy()
         headers.update(header_value)
         response = requests.get(
-            "{}/api/users/me".format(url),
+            f"{url}/api/users/me",
             headers=headers,
             timeout=timeout,
         )
@@ -692,7 +697,7 @@ def get_user_by_token(
 def is_token_valid(
     url: str,
     token: str,
-    timeout: Optional[float] = None,
+    timeout: float | None = None,
 ) -> bool:
     """Check if token is valid.
 
@@ -701,7 +706,7 @@ def is_token_valid(
     Args:
         url (str): Server url.
         token (str): User's token.
-        timeout (Optional[float]): Timeout for request. Value from
+        timeout (float | None): Timeout for request. Value from
             'get_default_timeout' is used if not specified.
 
     Returns:
@@ -715,9 +720,9 @@ def is_token_valid(
 
 def validate_url(
     url: str,
-    timeout: Optional[int] = None,
-    verify: Optional[Union[str, bool]] = None,
-    cert: Optional[str] = None,
+    timeout: int | None = None,
+    verify: str | bool | None = None,
+    cert: str | None = None,
 ) -> str:
     """Validate url if is valid and server is available.
 
@@ -740,7 +745,7 @@ def validate_url(
 
     Args:
         url (str): Server url.
-        timeout (Optional[int]): Timeout in seconds for connection to server.
+        timeout (int | None): Timeout in seconds for connection to server.
 
     Returns:
         Url which was used to connect to server.
@@ -749,8 +754,8 @@ def validate_url(
         UrlError: Error with short description and hints for user.
 
     """
-    stripperd_url = url.strip()
-    if not stripperd_url:
+    stripped_url = url.strip()
+    if not stripped_url:
         raise UrlError(
             "Invalid url format. Url is empty.",
             title="Invalid url format",
@@ -758,25 +763,30 @@ def validate_url(
         )
 
     # Not sure if this is good idea?
-    modified_url = stripperd_url.rstrip("/")
+    modified_url = stripped_url.rstrip("/")
+
+    # Make sure url has http scheme
+    if not modified_url.lower().startswith("http"):
+        modified_url = f"http://{modified_url}"
+
     parsed_url = _try_parse_url(modified_url)
     universal_hints = [
         "does the url work in browser?"
     ]
     if parsed_url is None:
         raise UrlError(
-            "Invalid url format. Url cannot be parsed as url \"{}\".".format(
-                modified_url
+            (
+                "Invalid url format. Url cannot be parsed"
+                f" as url \"{modified_url}\"."
             ),
             title="Invalid url format",
             hints=universal_hints
         )
 
-    # Try add 'https://' scheme if is missing
-    # - this will trigger UrlError if both will crash
-    if not parsed_url.scheme:
+    pathless_url = f"{parsed_url.scheme}://{parsed_url.netloc}"
+    if parsed_url.path:
         new_url = _try_connect_to_server(
-            "http://" + modified_url,
+            pathless_url,
             timeout=timeout,
             verify=verify,
             cert=cert,
@@ -794,17 +804,11 @@ def validate_url(
         return new_url
 
     hints = []
-    if "/" in parsed_url.path or not parsed_url.scheme:
-        new_path = parsed_url.path.split("/")[0]
-        if not parsed_url.scheme:
-            new_path = "https://" + new_path
-
-        hints.append(
-            "did you mean \"{}\"?".format(parsed_url.scheme + new_path)
-        )
+    if parsed_url.path:
+        hints.append(f"did you mean \"{pathless_url}\"?")
 
-    raise UrlError(
-        "Couldn't connect to server on \"{}\"".format(url),
+    raise UrlNotReached(
+        f"Couldn't connect to server on \"{url}\"",
         title="Couldn't connect to server",
         hints=hints + universal_hints
     )
@@ -818,25 +822,25 @@ class TransferProgress:
         self._started: bool = False
         self._transfer_done: bool = False
         self._transferred: int = 0
-        self._content_size: Optional[int] = None
+        self._content_size: int | None = None
 
         self._failed: bool = False
-        self._fail_reason: Optional[str] = None
+        self._fail_reason: str | None = None
 
         self._source_url: str = "N/A"
         self._destination_url: str = "N/A"
 
-    def get_content_size(self):
+    def get_content_size(self) -> int | None:
         """Content size in bytes.
 
         Returns:
-            Union[int, None]: Content size in bytes or None
+            int | None: Content size in bytes or None
                 if is unknown.
 
         """
         return self._content_size
 
-    def set_content_size(self, content_size: int):
+    def set_content_size(self, content_size: int) -> None:
         """Set content size in bytes.
 
         Args:
@@ -859,7 +863,7 @@ class TransferProgress:
         """
         return self._started
 
-    def set_started(self):
+    def set_started(self) -> None:
         """Mark that transfer started.
 
         Raises:
@@ -890,7 +894,7 @@ class TransferProgress:
         """
         return self._transfer_done
 
-    def set_transfer_done(self):
+    def set_transfer_done(self) -> None:
         """Mark progress as transfer finished.
 
         Raises:
@@ -913,17 +917,17 @@ class TransferProgress:
         """
         return self._failed
 
-    def get_fail_reason(self) -> Optional[str]:
+    def get_fail_reason(self) -> str | None:
         """Get reason why transfer failed.
 
         Returns:
-            Optional[str]: Reason why transfer
+            str | None: Reason why transfer
                 failed or None.
 
         """
         return self._fail_reason
 
-    def set_failed(self, reason: str):
+    def set_failed(self, reason: str) -> None:
         """Mark progress as failed.
 
         Args:
@@ -942,7 +946,7 @@ class TransferProgress:
         """
         return self._transferred
 
-    def set_transferred_size(self, transferred: int):
+    def set_transferred_size(self, transferred: int) -> None:
         """Set already transferred size in bytes.
 
         Args:
@@ -955,7 +959,7 @@ class TransferProgress:
         """Reset transferred size to initial value."""
         self._transferred = 0
 
-    def add_transferred_chunk(self, chunk_size: int):
+    def add_transferred_chunk(self, chunk_size: int) -> None:
         """Add transferred chunk size in bytes.
 
         Args:
@@ -978,7 +982,7 @@ class TransferProgress:
         """
         return self._source_url
 
-    def set_source_url(self, url: str):
+    def set_source_url(self, url: str) -> None:
         """Set source url from where transfer happens.
 
         Args:
@@ -1000,7 +1004,7 @@ class TransferProgress:
         """
         return self._destination_url
 
-    def set_destination_url(self, url: str):
+    def set_destination_url(self, url: str) -> None:
         """Set destination url where transfer happens.
 
         Args:
@@ -1026,11 +1030,11 @@ class TransferProgress:
         return True
 
     @property
-    def transfer_progress(self) -> Optional[float]:
+    def transfer_progress(self) -> float | None:
         """Get transfer progress in percents.
 
         Returns:
-            Optional[float]: Transfer progress in percents or 'None'
+            float | None: Transfer progress in percents or 'None'
                 if content size is unknown.
 
         """
@@ -1049,12 +1053,12 @@ class TransferProgress:
 
 
 def create_dependency_package_basename(
-    platform_name: Optional[str] = None
+    platform_name: str | None = None
 ) -> str:
     """Create basename for dependency package file.
 
     Args:
-        platform_name (Optional[str]): Name of platform for which the
+        platform_name (str | None): Name of platform for which the
             bundle is targeted. Default value is current platform.
 
     Returns:
@@ -1066,11 +1070,11 @@ def create_dependency_package_basename(
 
     now_date = datetime.datetime.now()
     time_stamp = now_date.strftime("%y%m%d%H%M")
-    return "ayon_{}_{}".format(time_stamp, platform_name)
+    return f"ayon_{time_stamp}_{platform_name}"
 
 
 
-def _get_media_mime_type_from_ftyp(content: bytes) -> Optional[str]:
+def _get_media_mime_type_from_ftyp(content: bytes) -> str | None:
     if content[8:10] == b"qt" or content[8:12] == b"MSNV":
         return "video/quicktime"
 
@@ -1110,7 +1114,7 @@ def _get_media_mime_type_from_ftyp(content: bytes) -> Optional[str]:
     return None
 
 
-def _get_media_mime_type_for_content_base(content: bytes) -> Optional[str]:
+def _get_media_mime_type_for_content_base(content: bytes) -> str | None:
     """Determine Mime-Type of a file.
 
     Use header of the file to determine mime type (needs 12 bytes).
@@ -1173,14 +1177,14 @@ def _get_media_mime_type_for_content_base(content: bytes) -> Optional[str]:
     return None
 
 
-def _get_svg_mime_type(content: bytes) -> Optional[str]:
+def _get_svg_mime_type(content: bytes) -> str | None:
     # SVG
     if b'xmlns="http://www.w3.org/2000/svg"' in content:
         return "image/svg+xml"
     return None
 
 
-def _get_json_mime_type(content: bytes) -> Optional[str]:
+def _get_json_mime_type(content: bytes) -> str | None:
     # json
     try:
         json.loads(content.decode("utf-8"))
@@ -1190,14 +1194,14 @@ def _get_json_mime_type(content: bytes) -> Optional[str]:
     return None
 
 
-def get_media_mime_type_for_content(content: bytes) -> Optional[str]:
+def get_media_mime_type_for_content(content: bytes) -> str | None:
     mime_type = _get_media_mime_type_for_content_base(content)
     if mime_type is not None:
         return mime_type
     return _get_svg_mime_type(content) or _get_json_mime_type(content)
 
 
-def get_media_mime_type_for_stream(stream: StreamType) -> Optional[str]:
+def get_media_mime_type_for_stream(stream: StreamType) -> str | None:
     # Read only 12 bytes to determine mime type
     content = stream.read(12)
     mime_type = _get_media_mime_type_for_content_base(content)
@@ -1208,14 +1212,14 @@ def get_media_mime_type_for_stream(stream: StreamType) -> Optional[str]:
     return _get_svg_mime_type(content) or _get_json_mime_type(content)
 
 
-def get_media_mime_type(filepath: str) -> Optional[str]:
+def get_media_mime_type(filepath: str) -> str | None:
     """Determine Mime-Type of a file.
 
     Args:
         filepath (str): Path to file.
 
     Returns:
-        Optional[str]: Mime type or None if is unknown mime type.
+        str | None: Mime type or None if is unknown mime type.
 
     """
     if not filepath or not os.path.exists(filepath):

ayon_api/version.py

@@ -1,2 +1,2 @@
 """Package declaring Python API for AYON server."""
-__version__ = "1.2.16-dev"
+__version__ = "1.2.17"

{ayon_python_api-1.2.16.dev0.dist-info → ayon_python_api-1.2.17.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ayon_python_api
-Version: 1.2.16.dev0
+Version: 1.2.17
 Summary: AYON Python API
 Home-page: https://github.com/ynput/ayon-python-api
 Author: ynput.io