fastpix-python 1.1.3__tar.gz → 1.1.4__tar.gz

{fastpix_python-1.1.3 → fastpix_python-1.1.4}/CHANGELOG.md

@@ -3,6 +3,35 @@
 All notable changes to this project will be documented in this file.
 
 
+---
+
+## [1.1.4]
+
+### Changed
+- **SDK version bump: `1.1.3` → `1.1.4`.**
+  A maintenance release that aligns the SDK's internal version identifiers and
+  applies behaviour-preserving code-quality cleanup. It contains no functional,
+  API, or behavioural changes and is fully backward compatible with `1.1.3`.
+
+  Updated identifiers:
+  - `__version__` / package version — now reports `1.1.4` (the internal
+    identifiers were previously lagging at `1.0.1`; they are now aligned with
+    the package version).
+  - `User-Agent` header — outbound requests now identify as
+    `fastpix-sdk/python 1.1.4`.
+
+  Maintainability:
+  - Internal static-analysis (SonarQube) cleanup across the SDK, samples, and
+    test harness — bundled request-builder parameters, shared response-handling
+    helpers, duplicated string literals extracted into constants, and nested
+    conditionals merged. No public-surface impact.
+
+### Compatibility
+- No changes to public types, method signatures, request/response models,
+  default server URLs, hooks, or retry logic.
+- No action required for existing integrations — upgrade the dependency and
+  re-run `pip install --upgrade fastpix_python`.
+
 ---
 
 ## [1.1.3]
@@ -23,7 +52,7 @@ All FastPix-owned hosts, API endpoints, and documentation links are being moved
 What this means for users of `fastpix_python`:
 
 - **If you rely on SDK defaults**, no code change is required. The default `server_url` in this release points at `https://api.fastpix.com/v1/`, so bumping to `1.1.3` and re-running `pip install --upgrade fastpix_python` is enough.
-- **If you have an explicit `server_url` override** (e.g. `Fastpixpython(server_url="https://api.fastpix.io/v1/")`), change it to `https://api.fastpix.com/v1/`.
+- **If you have an explicit `server_url` override** (e.g. `Fastpix(server_url="https://api.fastpix.io/v1/")`), change it to `https://api.fastpix.com/v1/`.
 - **If your application code references FastPix asset URLs directly** — playback URLs (`stream.fastpix.io/...`), image CDN (`images.fastpix.io/...`), dashboard deep links, or doc links in your own README — update them to the `.com` equivalents before the `.io` hosts are decommissioned.
 - We strongly recommend upgrading **every official FastPix SDK** in your stack to its latest release as part of the same change — every SDK is being rolled out with the same migration.
 

{fastpix_python-1.1.3 → fastpix_python-1.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastpix_python
-Version: 1.1.3
+Version: 1.1.4
 Summary: Python Client SDK Generated by fastpix.
 Home-page: https://github.com/FastPix/fastpix-python
 Author: FastPix
@@ -209,7 +209,7 @@ Comprehensive Python SDK for FastPix platform integration with full API coverage
 
 Upload, manage, and transform video content with comprehensive media management capabilities.
 
-For detailed documentation, see [FastPix Video on Demand Overview](https://fastpix.com/docs/get-started/overview).
+For detailed documentation, see [FastPix Video on Demand Overview](https://fastpix.com/docs/video-on-demand-api/overview).
 
 #### Input Video
 - [Create from URL](https://github.com/FastPix/fastpix-python/blob/feature/fixed-missing-parameters/docs/sdks/inputvideo/README.md#create_from_url) - Upload video content from external URL
@@ -257,7 +257,7 @@ For detailed documentation, see [FastPix Video on Demand Overview](https://fastp
 
 Stream, manage, and transform live video content with real-time broadcasting capabilities.
 
-For detailed documentation, see [FastPix Live Stream Overview](https://fastpix.com/docs/get-started/live-overview).
+For detailed documentation, see [FastPix Live Stream Overview](https://fastpix.com/docs/live-stream-api/overview).
 
 #### Start Live Stream
 - [Create Stream](https://github.com/FastPix/fastpix-python/blob/feature/fixed-missing-parameters/docs/sdks/startlivestream/README.md#create_stream) - Initialize new live streaming session with DVR mode support
@@ -288,7 +288,7 @@ For detailed documentation, see [FastPix Live Stream Overview](https://fastpix.c
 
 Monitor video performance and quality with comprehensive analytics and real-time metrics.
 
-For detailed documentation, see [FastPix Video Data Overview](https://fastpix.com/docs/concepts/what-video-data-do-we-capture).
+For detailed documentation, see [FastPix Video Data Overview](https://fastpix.com/docs/video-data-api/overview).
 
 #### Metrics
 - [List Breakdown Values](https://github.com/FastPix/fastpix-python/blob/feature/fixed-missing-parameters/docs/sdks/metrics/README.md#list_breakdown_values) - Get detailed breakdown of metrics by dimension
@@ -666,6 +666,6 @@ We value community contributions and feedback. Feel free to submit pull requests
 
 ## Detailed Usage
 
-For comprehensive understanding of each API's functionality, including detailed request and response specifications, parameter descriptions, and additional examples, please refer to the [FastPix API Reference](https://fastpix.com/docs/video-security/secure-media-access-with-jwts).
+For comprehensive understanding of each API's functionality, including detailed request and response specifications, parameter descriptions, and additional examples, please refer to the [FastPix API Reference](https://fastpix.com/docs/product-os-api/overview).
 
 The API reference offers complete documentation for all available endpoints and features, enabling developers to integrate and leverage FastPix APIs effectively.

{fastpix_python-1.1.3 → fastpix_python-1.1.4}/README.md

@@ -190,7 +190,7 @@ Comprehensive Python SDK for FastPix platform integration with full API coverage
 
 Upload, manage, and transform video content with comprehensive media management capabilities.
 
-For detailed documentation, see [FastPix Video on Demand Overview](https://fastpix.com/docs/get-started/overview).
+For detailed documentation, see [FastPix Video on Demand Overview](https://fastpix.com/docs/video-on-demand-api/overview).
 
 #### Input Video
 - [Create from URL](https://github.com/FastPix/fastpix-python/blob/feature/fixed-missing-parameters/docs/sdks/inputvideo/README.md#create_from_url) - Upload video content from external URL
@@ -238,7 +238,7 @@ For detailed documentation, see [FastPix Video on Demand Overview](https://fastp
 
 Stream, manage, and transform live video content with real-time broadcasting capabilities.
 
-For detailed documentation, see [FastPix Live Stream Overview](https://fastpix.com/docs/get-started/live-overview).
+For detailed documentation, see [FastPix Live Stream Overview](https://fastpix.com/docs/live-stream-api/overview).
 
 #### Start Live Stream
 - [Create Stream](https://github.com/FastPix/fastpix-python/blob/feature/fixed-missing-parameters/docs/sdks/startlivestream/README.md#create_stream) - Initialize new live streaming session with DVR mode support
@@ -269,7 +269,7 @@ For detailed documentation, see [FastPix Live Stream Overview](https://fastpix.c
 
 Monitor video performance and quality with comprehensive analytics and real-time metrics.
 
-For detailed documentation, see [FastPix Video Data Overview](https://fastpix.com/docs/concepts/what-video-data-do-we-capture).
+For detailed documentation, see [FastPix Video Data Overview](https://fastpix.com/docs/video-data-api/overview).
 
 #### Metrics
 - [List Breakdown Values](https://github.com/FastPix/fastpix-python/blob/feature/fixed-missing-parameters/docs/sdks/metrics/README.md#list_breakdown_values) - Get detailed breakdown of metrics by dimension
@@ -647,6 +647,6 @@ We value community contributions and feedback. Feel free to submit pull requests
 
 ## Detailed Usage
 
-For comprehensive understanding of each API's functionality, including detailed request and response specifications, parameter descriptions, and additional examples, please refer to the [FastPix API Reference](https://fastpix.com/docs/video-security/secure-media-access-with-jwts).
+For comprehensive understanding of each API's functionality, including detailed request and response specifications, parameter descriptions, and additional examples, please refer to the [FastPix API Reference](https://fastpix.com/docs/product-os-api/overview).
 
 The API reference offers complete documentation for all available endpoints and features, enabling developers to integrate and leverage FastPix APIs effectively.

{fastpix_python-1.1.3 → fastpix_python-1.1.4}/fastpix_python/_version.py

@@ -3,10 +3,10 @@
 import importlib.metadata
 
 __title__: str = "fastpix_python"
-__version__: str = "1.0.1"
+__version__: str = "1.1.4"
 __openapi_doc_version__: str = "1.0.0"
 __gen_version__: str = "2.723.4"
-__user_agent__: str = "fastpix-sdk/python 1.0.1 2.723.4 1.0.1 fastpix_python"
+__user_agent__: str = "fastpix-sdk/python 1.1.4 2.723.4 1.1.4 fastpix_python"
 
 try:
     if __package__ is not None:

fastpix_python-1.1.4/fastpix_python/basesdk.py

@@ -0,0 +1,314 @@
+"""Code generated by fastpix (https://fastpix.com). DO NOT EDIT."""
+
+from .sdkconfiguration import SDKConfiguration
+from . import errors, models, utils
+from ._hooks import (
+    AfterErrorContext,
+    AfterSuccessContext,
+    BeforeRequestContext,
+)
+from .utils import RetryConfig, SerializedRequestBody, get_body_content
+from dataclasses import dataclass
+import httpx
+from typing import Any, Callable, List, Mapping, Optional, Tuple
+from urllib.parse import parse_qs, urlparse
+
+
+_LOG_REQUEST_EXCEPTION = "Request Exception"
+
+
+@dataclass
+class BuildRequestData:
+    """Bundles the inputs used to build an HTTP request.
+
+    Grouping these into a single object keeps the request-builder method
+    signatures compact while preserving the exact same set of inputs.
+    """
+
+    method: str
+    path: str
+    base_url: Optional[str]
+    url_variables: Any
+    request: Any
+    request_body_required: bool
+    request_has_path_params: bool
+    request_has_query_params: bool
+    user_agent_header: str
+    accept_header_value: str
+    _globals: Any = None
+    security: Any = None
+    timeout_ms: Optional[int] = None
+    get_serialized_body: Optional[
+        Callable[[], Optional[SerializedRequestBody]]
+    ] = None
+    url_override: Optional[str] = None
+    http_headers: Optional[Mapping[str, str]] = None
+
+
+class BaseSDK:
+    sdk_configuration: SDKConfiguration
+    parent_ref: Optional[object] = None
+    """
+    Reference to the root SDK instance, if any. This will prevent it from
+    being garbage collected while there are active streams.
+    """
+
+    def __init__(
+        self,
+        sdk_config: SDKConfiguration,
+        parent_ref: Optional[object] = None,
+    ) -> None:
+        self.sdk_configuration = sdk_config
+        self.parent_ref = parent_ref
+
+    def _get_url(self, base_url, url_variables):
+        sdk_url, sdk_variables = self.sdk_configuration.get_server_details()
+
+        if base_url is None:
+            base_url = sdk_url
+
+        if url_variables is None:
+            url_variables = sdk_variables
+
+        return utils.template_url(base_url, url_variables)
+
+    def _build_request_async(self, data: BuildRequestData) -> httpx.Request:
+        client = self.sdk_configuration.async_client
+        return self._build_request_with_client(client, data)
+
+    def _build_request(self, data: BuildRequestData) -> httpx.Request:
+        client = self.sdk_configuration.client
+        return self._build_request_with_client(client, data)
+
+    def _build_url_and_query(
+        self,
+        url_override,
+        base_url,
+        url_variables,
+        path,
+        request,
+        _globals,
+        request_has_path_params,
+        request_has_query_params,
+    ):
+        if url_override is not None:
+            # Pick up the query parameter from the override so they can be
+            # preserved when building the request later on (necessary as of
+            # httpx 0.28).
+            parsed_override = urlparse(str(url_override))
+            return url_override, parse_qs(
+                parsed_override.query, keep_blank_values=True
+            )
+
+        url = utils.generate_url(
+            self._get_url(base_url, url_variables),
+            path,
+            request if request_has_path_params else None,
+            _globals if request_has_path_params else None,
+        )
+        query_params = utils.get_query_params(
+            request if request_has_query_params else None,
+            _globals if request_has_query_params else None,
+        )
+        return url, query_params
+
+    def _apply_security(self, headers, query_params, security):
+        if security is not None and callable(security):
+            security = security()
+        security = utils.get_security_from_env(security, models.Security)
+        if security is not None:
+            security_headers, security_query_params = utils.get_security(security)
+            headers = {**headers, **security_headers}
+            query_params = {**query_params, **security_query_params}
+        return headers, query_params
+
+    def _serialize_request_body(self, get_serialized_body, request_body_required):
+        serialized_request_body = SerializedRequestBody()
+        if get_serialized_body is None:
+            return serialized_request_body
+
+        rb = get_serialized_body()
+        if request_body_required and rb is None:
+            raise ValueError("request body is required")
+        if rb is not None:
+            serialized_request_body = rb
+        return serialized_request_body
+
+    def _build_request_with_client(
+        self, client, data: BuildRequestData
+    ) -> httpx.Request:
+        url, query_params = self._build_url_and_query(
+            data.url_override,
+            data.base_url,
+            data.url_variables,
+            data.path,
+            data.request,
+            data._globals,
+            data.request_has_path_params,
+            data.request_has_query_params,
+        )
+
+        headers = utils.get_headers(data.request, data._globals)
+        headers["Accept"] = data.accept_header_value
+        headers[data.user_agent_header] = self.sdk_configuration.user_agent
+
+        headers, query_params = self._apply_security(
+            headers, query_params, data.security
+        )
+
+        serialized_request_body = self._serialize_request_body(
+            data.get_serialized_body, data.request_body_required
+        )
+
+        if (
+            serialized_request_body.media_type is not None
+            and serialized_request_body.media_type
+            not in (
+                "multipart/form-data",
+                "multipart/mixed",
+            )
+        ):
+            headers["content-type"] = serialized_request_body.media_type
+
+        if data.http_headers is not None:
+            for header, value in data.http_headers.items():
+                headers[header] = value
+
+        timeout = data.timeout_ms / 1000 if data.timeout_ms is not None else None
+
+        return client.build_request(
+            data.method,
+            url,
+            params=query_params,
+            content=serialized_request_body.content,
+            data=serialized_request_body.data,
+            files=serialized_request_body.files,
+            headers=headers,
+            timeout=timeout,
+        )
+
+    @staticmethod
+    def _log_request(logger, req):
+        logger.debug(
+            "Request:\nMethod: %s\nURL: %s\nHeaders: %s\nBody: %s",
+            req.method,
+            req.url,
+            req.headers,
+            get_body_content(req),
+        )
+
+    def _handle_response(
+        self, http_res, hook_ctx, error_status_codes, stream, hooks, logger
+    ):
+        if http_res is None:
+            logger.debug("Raising no response SDK error")
+            raise errors.NoResponseError("No response received")
+
+        logger.debug(
+            "Response:\nStatus Code: %s\nURL: %s\nHeaders: %s\nBody: %s",
+            http_res.status_code,
+            http_res.url,
+            http_res.headers,
+            "<streaming response>" if stream else http_res.text,
+        )
+
+        if not utils.match_status_codes(error_status_codes, http_res.status_code):
+            return http_res
+
+        result, err = hooks.after_error(AfterErrorContext(hook_ctx), http_res, None)
+        if err is not None:
+            logger.debug(_LOG_REQUEST_EXCEPTION, exc_info=True)
+            raise err
+        if result is not None:
+            return result
+
+        logger.debug("Raising unexpected SDK error")
+        raise errors.FastpixDefaultError("Unexpected error occurred", http_res)
+
+    def do_request(
+        self,
+        hook_ctx,
+        request,
+        error_status_codes,
+        stream=False,
+        retry_config: Optional[Tuple[RetryConfig, List[str]]] = None,
+    ) -> httpx.Response:
+        client = self.sdk_configuration.client
+        logger = self.sdk_configuration.debug_logger
+
+        hooks = self.sdk_configuration.__dict__["_hooks"]
+
+        def do():
+            http_res = None
+            try:
+                req = hooks.before_request(BeforeRequestContext(hook_ctx), request)
+                self._log_request(logger, req)
+
+                if client is None:
+                    raise ValueError("client is required")
+
+                http_res = client.send(req, stream=stream)
+            except Exception as e:
+                _, e = hooks.after_error(AfterErrorContext(hook_ctx), None, e)
+                if e is not None:
+                    logger.debug(_LOG_REQUEST_EXCEPTION, exc_info=True)
+                    raise e
+
+            return self._handle_response(
+                http_res, hook_ctx, error_status_codes, stream, hooks, logger
+            )
+
+        if retry_config is not None:
+            http_res = utils.retry(do, utils.Retries(retry_config[0], retry_config[1]))
+        else:
+            http_res = do()
+
+        if not utils.match_status_codes(error_status_codes, http_res.status_code):
+            http_res = hooks.after_success(AfterSuccessContext(hook_ctx), http_res)
+
+        return http_res
+
+    async def do_request_async(
+        self,
+        hook_ctx,
+        request,
+        error_status_codes,
+        stream=False,
+        retry_config: Optional[Tuple[RetryConfig, List[str]]] = None,
+    ) -> httpx.Response:
+        client = self.sdk_configuration.async_client
+        logger = self.sdk_configuration.debug_logger
+
+        hooks = self.sdk_configuration.__dict__["_hooks"]
+
+        async def do():
+            http_res = None
+            try:
+                req = hooks.before_request(BeforeRequestContext(hook_ctx), request)
+                self._log_request(logger, req)
+
+                if client is None:
+                    raise ValueError("client is required")
+
+                http_res = await client.send(req, stream=stream)
+            except Exception as e:
+                _, e = hooks.after_error(AfterErrorContext(hook_ctx), None, e)
+                if e is not None:
+                    logger.debug(_LOG_REQUEST_EXCEPTION, exc_info=True)
+                    raise e
+
+            return self._handle_response(
+                http_res, hook_ctx, error_status_codes, stream, hooks, logger
+            )
+
+        if retry_config is not None:
+            http_res = await utils.retry_async(
+                do, utils.Retries(retry_config[0], retry_config[1])
+            )
+        else:
+            http_res = await do()
+
+        if not utils.match_status_codes(error_status_codes, http_res.status_code):
+            http_res = hooks.after_success(AfterSuccessContext(hook_ctx), http_res)
+
+        return http_res