sg-python-api 0.1.2__py3-none-any.whl → 0.2.0__py3-none-any.whl

shotgun_api3/lib/mockgun/mockgun.py

@@ -0,0 +1,14 @@
+"""Provide mockgun's clients under the module path Autodesk's package uses.
+
+Code written for Autodesk's mockgun can import `Shotgun` from this module. The
+names here are the same objects that `shotgun_api3.lib.mockgun` exports; see
+that package for their behavior.
+"""
+
+from ._async_client import AsyncShotgun
+from ._errors import MockgunError
+from ._schema import generate_schema
+from ._site import Site
+from ._sync_client import Shotgun
+
+__all__ = ['AsyncShotgun', 'MockgunError', 'Shotgun', 'Site', 'generate_schema']

shotgun_api3/lib/sgtimezone.py

@@ -3,6 +3,8 @@
 import datetime
 import time
 
+__all__ = ['UTC', 'LocalTimezone', 'SgTimezone']
+
 _EPOCH = datetime.datetime(1970, 1, 1, tzinfo=datetime.UTC)
 _NAIVE_EPOCH = _EPOCH.replace(tzinfo=None)
 _ZERO = datetime.timedelta(0)
@@ -69,6 +71,11 @@ class LocalTimezone(datetime.tzinfo):
 
         Returns:
             The daylight-saving adjustment, or zero when DST is not active.
+
+        Raises:
+            OSError: If the platform cannot resolve a non-pre-epoch local time.
+            OverflowError: If that local time exceeds the platform's range.
+            ValueError: If the platform rejects that local time.
         """
         standard, daylight = self._offsets()
         return daylight - standard if self._isdst(dt) else _ZERO
@@ -85,7 +92,11 @@ class LocalTimezone(datetime.tzinfo):
             time.
 
         Raises:
-            ValueError: If `dt.tzinfo` is not this instance.
+            ValueError: If the platform rejects the conversion.
+            OSError: If platform conversion fails without an applicable
+                pre-epoch fallback.
+            OverflowError: If platform conversion or local datetime arithmetic
+                exceeds its supported range.
         """
         if dt.tzinfo is not self:
             raise ValueError('fromutc() requires dt.tzinfo to be self')
@@ -130,6 +141,11 @@ class LocalTimezone(datetime.tzinfo):
 
         Returns:
             The platform's standard or daylight timezone name.
+
+        Raises:
+            OSError: If the platform cannot resolve a non-pre-epoch local time.
+            OverflowError: If that local time exceeds the platform's range.
+            ValueError: If the platform rejects that local time.
         """
         return time.tzname[int(self._isdst(dt))]
 
@@ -142,6 +158,11 @@ class LocalTimezone(datetime.tzinfo):
 
         Returns:
             The current standard or daylight offset from UTC.
+
+        Raises:
+            OSError: If the platform cannot resolve a non-pre-epoch local time.
+            OverflowError: If that local time exceeds the platform's range.
+            ValueError: If the platform rejects that local time.
         """
         standard, daylight = self._offsets()
         return daylight if self._isdst(dt) else standard
@@ -193,6 +214,8 @@ class SgTimezone:
     Attributes:
         utc: UTC timezone instance.
         local: System-local timezone instance.
+        UTC: Constructor alias for the UTC timezone class.
+        LocalTimezone: Constructor alias for the system-local timezone class.
     """
 
     LocalTimezone = LocalTimezone

sg_python_api-0.1.2.dist-info/RECORD

@@ -1,31 +0,0 @@
-shotgun_api3/__init__.py,sha256=fviJGOi_Gb9jHi5Q9ty5tIbeIvxMtLNrKx_4HJVgemI,2011
-shotgun_api3/_async_client.py,sha256=UYVk_IGzMcUguJ4oCV-Nof4mL2kvzYYGuiYvW4gHeMs,113167
-shotgun_api3/_async_driver.py,sha256=NnuMmQP5KrAoANBvWIhcIUe_ljD62pK_7xSIoEIltXw,32308
-shotgun_api3/_async_httpx2.py,sha256=3pjeFsb5racGArvlR50c3w0XtrttXuRU_6E9Y-cBU3c,24387
-shotgun_api3/_async_transport.py,sha256=8iAcoFafEHKRBirBkqdIqMFgqLs1YTgtzgACudD0kM4,4928
-shotgun_api3/_capabilities.py,sha256=RrStvExVC3TAADhfbY2JpYZUXmvE63vXIJy1R-nkEII,5527
-shotgun_api3/_client.py,sha256=jtemxhdhFr1gwE7qB6K-62Sohb2C_S4dEO7uKpVh2Uo,102109
-shotgun_api3/_config.py,sha256=fALxy5xGI3A0nECsRDyls_9A8tvjB0DNSpTu1agNEHw,54931
-shotgun_api3/_crud.py,sha256=Ax36jA2E-lauRf2D-2rmRDj61SilOygtkjKgs5XDCUs,30319
-shotgun_api3/_driver.py,sha256=DAtnZW044TWiqscs0G1uwTiluAFtCoR2wKTbJYJHT2g,29498
-shotgun_api3/_errors.py,sha256=fk7v3XbmZK63M272r5wDwF_GgI-4RynPfAWv1P-J-GI,1480
-shotgun_api3/_execution.py,sha256=Kn2Yd9sXIA975stnof7MeuA8bT3dyOuWDIqQnP65LO0,8235
-shotgun_api3/_files.py,sha256=-eXHyG0U9mEAdYTthgVEhlzBKYUOt4g-3k9D522L3zM,33900
-shotgun_api3/_methods.py,sha256=pYzx2pN0nus6vPWf-Gl8Zz4MgRf8R4b7kvxN8lhoXgc,37685
-shotgun_api3/_protocol.py,sha256=0ccL65aIm3v2w6dOtNnZuFrKQncA8WO4yadtxRP55-w,42194
-shotgun_api3/_sentinel.py,sha256=KAQzQjJVhTTZPLFY1f88-_vP7U06i2g6ZS7KJcn4vIA,116
-shotgun_api3/_sg_timezone.py,sha256=yr7Wdln9fwfTVGMQSFsgO-eduuTHQ5EbSY5xEVQ2tYw,115
-shotgun_api3/_signatures.py,sha256=_yhNnbkVF-0opaBfg9H6SauBN2RT4hJsHGa3ZO3Ug4s,1622
-shotgun_api3/_transport.py,sha256=LmQ0e2VvAKwFdNy4SyfRHwgKC6GWnwkIN5Wa2fin3AM,30047
-shotgun_api3/_version.py,sha256=0NYED9oy2nGCvTERMwWJvajshS5qzH_v4w7QUAGAivY,102
-shotgun_api3/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-shotgun_api3/shotgun.py,sha256=X7PLlCC-gR8dJgY_uLYXw_LWN8mz5MsQsSYJldtavTk,1706
-shotgun_api3/lib/__init__.py,sha256=4WGYod6xHcj23rapx5bTDGdjT52H1CAQNMz4BmzNmn0,55
-shotgun_api3/lib/sgtimezone.py,sha256=nYSaCsIeq_SJh7YgL4yWN7dTVVz9lAfx-G3mzsHb8iM,7027
-shotgun_api3/lib/mockgun/__init__.py,sha256=2mHjMJAV4mZ8JvnP8WHn6tkdMJoB7UQtNSs99YzNW30,703
-shotgun_api3/lib/mockgun/_async.py,sha256=7bTZFdlSzeoGq9fRbPBAf-X08qDmrkzV9rxskx5AGX8,10812
-shotgun_api3/lib/mockgun/_mockgun.py,sha256=k2cqLMCKpU5oIbUGiYulf1aIU0HLrMB6DQQ3KrCy7WQ,65093
-sg_python_api-0.1.2.dist-info/METADATA,sha256=2Zv6g9pJZ28QttHMO6Q1yYWvyczPypCHc-QCAYbjIaQ,7587
-sg_python_api-0.1.2.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
-sg_python_api-0.1.2.dist-info/licenses/LICENSE,sha256=V3moMsQxKDchTd3mtXl5J-ODaNBDvFrapOf1DK7Nx_U,1082
-sg_python_api-0.1.2.dist-info/RECORD,,

shotgun_api3/_signatures.py

@@ -1,53 +0,0 @@
-"""Shared argument binding and callable reflection metadata."""
-
-import inspect
-from collections.abc import Callable, Mapping
-
-
-def bind_arguments(
-    signature: inspect.Signature,
-    args: tuple[object, ...],
-    kwargs: Mapping[str, object],
-    label: str,
-) -> inspect.BoundArguments:
-    """Bind arguments and defaults with a caller-specific error prefix.
-
-    Args:
-        signature: Public call signature to enforce.
-        args: Supplied positional arguments.
-        kwargs: Supplied keyword arguments.
-        label: Public callable label, including parentheses, for errors.
-
-    Returns:
-        Bound arguments retaining the supplied values without copying them.
-
-    Raises:
-        TypeError: If binding fails, prefixed with the callable label.
-    """
-    try:
-        bound = signature.bind(*args, **kwargs)
-    except TypeError as exc:
-        raise TypeError(f'{label} {exc}') from None
-    bound.apply_defaults()
-    return bound
-
-
-def expose_signature(
-    function: Callable[..., object],
-    signature: inspect.Signature,
-    doc: str | None,
-) -> Callable[..., object]:
-    """Attach a signature and optional documentation to the same callable.
-
-    Args:
-        function: Implementation receiving public reflection metadata.
-        signature: Public signature to expose.
-        doc: Replacement documentation, or `None` to preserve the docstring.
-
-    Returns:
-        The same callable with its reflection metadata updated.
-    """
-    if doc is not None:
-        object.__setattr__(function, '__doc__', doc)
-    object.__setattr__(function, '__signature__', signature)
-    return function

shotgun_api3/lib/mockgun/_async.py

@@ -1,315 +0,0 @@
-"""Awaitable delegation twin of the in-memory mockgun client."""
-
-from typing import Any, ClassVar
-
-from ._mockgun import Shotgun, expose_find_documentation, expose_find_one_documentation
-
-
-class AsyncShotgun:
-    """Provide the mockgun surface through awaitable methods.
-
-    Each instance owns a synchronous in-memory delegate; awaitable operations
-    execute against that delegate without network I/O. Each subclass receives
-    its own delegate class, so changing its schema paths does not change those
-    of sibling subclasses.
-
-    Attributes:
-        base_url: Constructor-supplied site URL, preserved unchanged.
-        config: Mutable mock configuration.
-        finds: Number of find operations performed.
-    """
-
-    _sync_type: ClassVar[type[Shotgun]] = Shotgun
-    finds: int
-
-    def __init__(  # noqa: PLR0913, PLR0917 - compatibility requires the exact sync signature.
-        self,
-        base_url: str,
-        script_name: str | None = None,
-        api_key: str | None = None,
-        convert_datetimes_to_utc: bool = True,
-        http_proxy: str | None = None,
-        connect: bool = True,
-        ca_certs: str | None = None,
-        login: str | None = None,
-        password: str | None = None,
-        sudo_as_login: str | None = None,
-        session_token: str | None = None,
-        auth_token: str | None = None,
-    ) -> None:
-        """Initialize an asynchronous wrapper around one mock client.
-
-        Args:
-            base_url: Site URL used to initialize mock configuration.
-            script_name: Accepted compatibility script name.
-            api_key: Accepted compatibility API key.
-            convert_datetimes_to_utc: Accepted datetime-conversion setting.
-            http_proxy: Accepted compatibility proxy setting.
-            connect: Accepted compatibility connection setting.
-            ca_certs: Accepted compatibility certificate path.
-            login: Accepted compatibility user login.
-            password: Accepted compatibility user password.
-            sudo_as_login: Accepted compatibility sudo login.
-            session_token: Accepted compatibility session token.
-            auth_token: Accepted compatibility two-factor token.
-
-        Raises:
-            MockgunError: If schema paths are unset or files are missing.
-            TypeError: If arguments do not match the compatibility signature.
-            ValueError: If `base_url` has an unsupported or invalid origin.
-        """
-        self._sync = self._sync_type(
-            base_url,
-            script_name,
-            api_key,
-            convert_datetimes_to_utc,
-            http_proxy,
-            connect,
-            ca_certs,
-            login,
-            password,
-            sudo_as_login,
-            session_token,
-            auth_token,
-        )
-        self.config = self._sync.config
-        self.base_url = self._sync.base_url
-
-    def __getattr__(self, name: str) -> object:
-        """Return the sync twin's live find counter."""
-        if name == 'finds':
-            return self._sync.finds
-        raise AttributeError(f'{type(self).__name__!s} has no attribute {name!r}')
-
-    def __init_subclass__(cls) -> None:
-        """Give each async mock subclass its own synchronous delegate class."""
-        super().__init_subclass__()
-        cls._sync_type = type(
-            f'_{cls.__name__}SyncDelegate',
-            (cls._sync_type,),
-            {'__module__': __name__},
-        )
-
-    async def batch(self, requests: list[dict[str, Any]]) -> list[object]:
-        """Execute supported requests in order and return their result values.
-
-        Requests apply sequentially. If a later request fails, earlier
-        mutations remain applied.
-
-        Args:
-            requests: Create, update, and delete request dictionaries.
-
-        Returns:
-            Per-request results in input order.
-
-        Raises:
-            ShotgunError: If a request or delegated operation is invalid.
-        """
-        return self._sync.batch(requests)
-
-    async def create(
-        self,
-        entity_type: str,
-        data: dict[str, Any],
-        return_fields: list[str] | None = None,
-    ) -> dict[str, object]:
-        """Create and return an entity in the in-memory database.
-
-        Args:
-            entity_type: Schema entity type to create.
-            data: Field values for the new entity.
-            return_fields: Fields to return instead of the fields in `data`.
-
-        Returns:
-            Created entity identity and the selected field values.
-
-        Raises:
-            ShotgunError: If the entity, fields, or values are invalid.
-        """
-        return self._sync.create(entity_type, data, return_fields)
-
-    async def delete(self, entity_type: str, entity_id: int) -> bool:
-        """Retire an active entity.
-
-        Args:
-            entity_type: Schema entity type to retire.
-            entity_id: ID of the existing entity.
-
-        Returns:
-            `True` when the entity changed state, otherwise `False`.
-
-        Raises:
-            ShotgunError: If the entity type or ID is unknown.
-        """
-        return self._sync.delete(entity_type, entity_id)
-
-    @expose_find_documentation
-    async def find(  # noqa: PLR0913, PLR0917 - compatibility requires the exact sync signature.
-        self,
-        entity_type: str,
-        filters: list[Any] | tuple[Any, ...] | dict[str, Any],
-        fields: list[str] | None = None,
-        order: list[dict[str, str]] | None = None,
-        filter_operator: str | None = None,
-        limit: int = 0,
-        retired_only: bool = False,
-        page: int = 0,
-        include_archived_projects: bool = True,
-        additional_filter_presets: object = None,
-    ) -> list[dict[str, object]]:
-        return self._sync.find(
-            entity_type,
-            filters,
-            fields,
-            order,
-            filter_operator,
-            limit,
-            retired_only,
-            page,
-            include_archived_projects,
-            additional_filter_presets,
-        )
-
-    @expose_find_one_documentation
-    async def find_one(  # noqa: PLR0913, PLR0917 - compatibility requires the exact sync signature.
-        self,
-        entity_type: str,
-        filters: list[Any] | tuple[Any, ...] | dict[str, Any],
-        fields: list[str] | None = None,
-        order: list[dict[str, str]] | None = None,
-        filter_operator: str | None = None,
-        retired_only: bool = False,
-        include_archived_projects: bool = True,
-        additional_filter_presets: object = None,
-    ) -> dict[str, object] | None:
-        return self._sync.find_one(
-            entity_type,
-            filters,
-            fields,
-            order,
-            filter_operator,
-            retired_only,
-            include_archived_projects,
-            additional_filter_presets,
-        )
-
-    @classmethod
-    async def get_schema_paths(cls) -> tuple[str | None, str | None]:
-        """Return the schema paths configured for mockgun clients.
-
-        Returns:
-            Field-schema and entity-schema paths, in that order.
-        """
-        return cls._sync_type.get_schema_paths()
-
-    async def revive(self, entity_type: str, entity_id: int) -> bool:
-        """Restore a retired entity to active state.
-
-        Args:
-            entity_type: Schema entity type to restore.
-            entity_id: ID of the existing entity.
-
-        Returns:
-            `True` when the entity changed state, otherwise `False`.
-
-        Raises:
-            ShotgunError: If the entity type or ID is unknown.
-        """
-        return self._sync.revive(entity_type, entity_id)
-
-    async def schema_entity_read(
-        self,
-        project_entity: dict[str, Any] | None = None,
-    ) -> dict[str, object]:
-        """Return the loaded entity schema.
-
-        Args:
-            project_entity: Accepted for public-client compatibility and
-                ignored.
-
-        Returns:
-            The live entity-schema dictionary. Mutations affect this client.
-        """
-        return self._sync.schema_entity_read(project_entity)
-
-    async def schema_field_read(
-        self,
-        entity_type: str,
-        field_name: str | None = None,
-        project_entity: dict[str, Any] | None = None,
-    ) -> dict[str, object]:
-        """Return the loaded field schema for an entity or one field.
-
-        Args:
-            entity_type: Entity type whose fields to return.
-            field_name: Optional field name to select.
-            project_entity: Accepted for public-client compatibility and
-                ignored.
-
-        Returns:
-            The live entity field-schema dictionary when no field is selected.
-            Otherwise, a new dictionary containing the selected field and its
-            shared schema value, or an empty dictionary for an unknown field.
-            Mutating shared schema values affects this client.
-
-        Raises:
-            KeyError: If `entity_type` is absent from the loaded schema.
-        """
-        return self._sync.schema_field_read(entity_type, field_name, project_entity)
-
-    async def schema_read(
-        self,
-        project_entity: dict[str, Any] | None = None,
-    ) -> dict[str, object]:
-        """Return the loaded field schema.
-
-        Args:
-            project_entity: Accepted for public-client compatibility and
-                ignored.
-
-        Returns:
-            The live field-schema dictionary. Mutations affect this client.
-        """
-        return self._sync.schema_read(project_entity)
-
-    @classmethod
-    async def set_schema_paths(
-        cls,
-        schema_path: str,
-        schema_entity_path: str,
-    ) -> None:
-        """Configure the schema files loaded by future mockgun clients.
-
-        Args:
-            schema_path: Path to the field-schema pickle.
-            schema_entity_path: Path to the entity-schema pickle.
-        """
-        cls._sync_type.set_schema_paths(schema_path, schema_entity_path)
-
-    async def update(
-        self,
-        entity_type: str,
-        entity_id: int,
-        data: dict[str, Any],
-        multi_entity_update_modes: dict[str, str] | None = None,
-    ) -> list[dict[str, object]]:
-        """Update an entity and return the official one-item result list.
-
-        Args:
-            entity_type: Schema entity type to update.
-            entity_id: ID of the existing entity.
-            data: Replacement field values.
-            multi_entity_update_modes: Per-field replacement modes.
-
-        Returns:
-            One updated entity containing identity and submitted fields.
-
-        Raises:
-            ShotgunError: If the entity, fields, or values are invalid.
-        """
-        return self._sync.update(
-            entity_type,
-            entity_id,
-            data,
-            multi_entity_update_modes,
-        )