sg-python-api 0.1.0__py3-none-any.whl → 0.1.1__py3-none-any.whl

{sg_python_api-0.1.0.dist-info → sg_python_api-0.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: sg-python-api
-Version: 0.1.0
+Version: 0.1.1
 Summary: Python client for Autodesk Flow Production Tracking
 Project-URL: Documentation, https://github.com/dactylo/sg-python-api/tree/main/docs
 Project-URL: Homepage, https://github.com/dactylo/sg-python-api
@@ -45,8 +45,8 @@ This documentation uses SG for Flow Production Tracking, formerly named Shotgun
 
 sg-python-api is an independent implementation of the documented API of Autodesk's Python client
 `3.10.2`. Some behavior differs on purpose, so validate your application's workflows against a test
-site before replacing its production client. The [migration guide](https://github.com/dactylo/sg-python-api/blob/v0.1.0/docs/migration-guide.md) walks
-through the switch, and the [compatibility reference](https://github.com/dactylo/sg-python-api/blob/v0.1.0/COMPATIBILITY.md) lists the differences.
+site before replacing its production client. The [migration guide](https://github.com/dactylo/sg-python-api/blob/v0.1.1/docs/migration-guide.md) walks
+through the switch, and the [compatibility reference](https://github.com/dactylo/sg-python-api/blob/v0.1.1/COMPATIBILITY.md) lists the differences.
 
 ## Installation
 
@@ -55,16 +55,9 @@ requests to a remote site require HTTPS.
 
 `sg-python-api` and Autodesk's `shotgun-api3` both install the `shotgun_api3` package, so install
 exactly one of them in a Python environment. If the official client is already installed, follow
-the [migration steps](https://github.com/dactylo/sg-python-api/blob/v0.1.0/docs/migration-guide.md#install-the-replacement) to replace it.
+the [migration steps](https://github.com/dactylo/sg-python-api/blob/v0.1.1/docs/migration-guide.md#install-the-replacement) to replace it.
 
-When a release is available on your package index, install into the Python environment that runs
-your application:
-
-```sh
-python -m pip install sg-python-api
-```
-
-To install from a checkout instead, run:
+From a checkout, install into the Python environment that runs your application:
 
 ```sh
 python -m pip install .
@@ -74,12 +67,6 @@ The base installation provides the synchronous `Shotgun` client and both `mockgu
 use the native asynchronous client, `AsyncShotgun`, install the `async` extra, which adds the
 `httpx2` HTTP library:
 
-```sh
-python -m pip install 'sg-python-api[async]'
-```
-
-From a checkout, use:
-
 ```sh
 python -m pip install '.[async]'
 ```
@@ -143,23 +130,23 @@ operation fails. Without the `async` extra, importing `AsyncShotgun` raises `Imp
 
 Share an `AsyncShotgun` only among tasks on one event loop, and cancel its work by cancelling the
 task. A cancelled write may already have reached the server, so check its outcome before repeating
-it. The [async reference](https://github.com/dactylo/sg-python-api/blob/v0.1.0/COMPATIBILITY.md#async-extension-surfaces) covers shutdown and
+it. The [async reference](https://github.com/dactylo/sg-python-api/blob/v0.1.1/COMPATIBILITY.md#async-extension-surfaces) covers shutdown and
 cancellation in detail.
 
 ## Documentation
 
 | If you want to...                                     | Read                                                                               |
 | ----------------------------------------------------- | ---------------------------------------------------------------------------------- |
-| Replace Autodesk's client in an existing application  | [Migration guide](https://github.com/dactylo/sg-python-api/blob/v0.1.0/docs/migration-guide.md)                                         |
-| Check what behaves differently from Autodesk's client | [Compatibility](https://github.com/dactylo/sg-python-api/blob/v0.1.0/COMPATIBILITY.md)                                                  |
-| Tune pooling and page prefetch, or observe requests   | [Configuration extensions](https://github.com/dactylo/sg-python-api/blob/v0.1.0/COMPATIBILITY.md#configuration-and-observer-extensions) |
-| Confirm which client loads and run a smoke test       | [Testing an installation](https://github.com/dactylo/sg-python-api/blob/v0.1.0/docs/testing.md)                                         |
-| Compare measured latency and transfer memory          | [Benchmarks](https://github.com/dactylo/sg-python-api/blob/v0.1.0/docs/benchmarks.md)                                                   |
-| See changes by version                                | [Changelog](https://github.com/dactylo/sg-python-api/blob/v0.1.0/CHANGELOG.md)                                                          |
+| Replace Autodesk's client in an existing application  | [Migration guide](https://github.com/dactylo/sg-python-api/blob/v0.1.1/docs/migration-guide.md)                                         |
+| Check what behaves differently from Autodesk's client | [Compatibility](https://github.com/dactylo/sg-python-api/blob/v0.1.1/COMPATIBILITY.md)                                                  |
+| Tune pooling and page prefetch, or observe requests   | [Configuration extensions](https://github.com/dactylo/sg-python-api/blob/v0.1.1/COMPATIBILITY.md#configuration-and-observer-extensions) |
+| Confirm which client loads and run a smoke test       | [Testing an installation](https://github.com/dactylo/sg-python-api/blob/v0.1.1/docs/testing.md)                                         |
+| Compare measured latency and transfer memory          | [Benchmarks](https://github.com/dactylo/sg-python-api/blob/v0.1.1/docs/benchmarks.md)                                                   |
+| See changes by version                                | [Changelog](https://github.com/dactylo/sg-python-api/blob/v0.1.1/CHANGELOG.md)                                                          |
 
 ## Development
 
-See the [development guide](https://github.com/dactylo/sg-python-api/blob/v0.1.0/docs/development.md) for the required tools, CI, and dependency locks.
+See the [development guide](https://github.com/dactylo/sg-python-api/blob/v0.1.1/docs/development.md) for the required tools, CI, and dependency locks.
 With those tools installed, run:
 
 ```sh
@@ -172,6 +159,6 @@ make check
 
 ## License
 
-sg-python-api is available under the [MIT License](https://github.com/dactylo/sg-python-api/blob/v0.1.0/LICENSE). It is an independent project and is
+sg-python-api is available under the [MIT License](https://github.com/dactylo/sg-python-api/blob/v0.1.1/LICENSE). It is an independent project and is
 not affiliated with or endorsed by Autodesk. Flow Production Tracking is a product of Autodesk,
 Inc.

{sg_python_api-0.1.0.dist-info → sg_python_api-0.1.1.dist-info}/RECORD

@@ -1,23 +1,23 @@
 shotgun_api3/__init__.py,sha256=fviJGOi_Gb9jHi5Q9ty5tIbeIvxMtLNrKx_4HJVgemI,2011
-shotgun_api3/_async_client.py,sha256=or11Le6Y2WB3TVTVj_7QiLfOLpDbwjs1p3VVAQhFHLQ,111070
-shotgun_api3/_async_driver.py,sha256=ldrETCNgihOcuoGYVqt8M4u2R1euNkvp3TRXLYQbzJ0,32838
+shotgun_api3/_async_client.py,sha256=I5_4t_WwJNc-3hkDrAVnbofqw4Nil07Jcxfr2CSb18A,112160
+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=n4lbXG9UxQhrv1IhwsJd8dD41JIq_Xh-_zqDueSguW8,100184
-shotgun_api3/_config.py,sha256=hCKJtaO06wZFJEz-yIw2SagDeWqZMHpuqSmS33qG2Q4,55264
+shotgun_api3/_client.py,sha256=7ICzGJGKKI-OzuKoCTfqhumrvRaNybN98-br7CJnB9Y,101143
+shotgun_api3/_config.py,sha256=fALxy5xGI3A0nECsRDyls_9A8tvjB0DNSpTu1agNEHw,54931
 shotgun_api3/_crud.py,sha256=Ax36jA2E-lauRf2D-2rmRDj61SilOygtkjKgs5XDCUs,30319
-shotgun_api3/_driver.py,sha256=sPkiseKisJTMSNAxkCvdGXc_H1kKS6sg-rJQLKXSVgU,30139
+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=a1PfHKV4OMi6j7BQG2rkMPCcaNTB5uAWNiqCh64AEXg,35223
-shotgun_api3/_methods.py,sha256=8dD5BUN_5hnGAYomUEAX1dHZnI4Cliid6PrrP8AhhPI,36132
+shotgun_api3/_files.py,sha256=7onuC_ODjGtgysIy3YUpeHKtmUpBHQpYln6XtNe3NK4,36770
+shotgun_api3/_methods.py,sha256=yGyQv7tKpHX3e3nGIVHEbuTNzjsAxQdJVXpmlXXStsw,34184
 shotgun_api3/_protocol.py,sha256=dKr1XqB6Xo56QloZ2MAyN4ulqYkTjw8VYeJRd5QHufQ,45286
 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=yK498PuHvOUCFnIC1QKSqvFXzUBBuOMHBsVo5gSpFCE,102
+shotgun_api3/_version.py,sha256=LnmGg2me6J0MbE65mSg2nIknHNNg0Etx_3Jkh_k9BWc,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
@@ -25,7 +25,7 @@ shotgun_api3/lib/sgtimezone.py,sha256=nYSaCsIeq_SJh7YgL4yWN7dTVVz9lAfx-G3mzsHb8i
 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.0.dist-info/METADATA,sha256=7Wzieh6ix8BwZJ_oD-B4_G-bO6m5pPDr1wzC5EFYhUQ,7789
-sg_python_api-0.1.0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
-sg_python_api-0.1.0.dist-info/licenses/LICENSE,sha256=V3moMsQxKDchTd3mtXl5J-ODaNBDvFrapOf1DK7Nx_U,1082
-sg_python_api-0.1.0.dist-info/RECORD,,
+sg_python_api-0.1.1.dist-info/METADATA,sha256=bwDwuEXYzQ-8J-igveXXMna_Ulemsdz9xwNLVhdW3mI,7587
+sg_python_api-0.1.1.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+sg_python_api-0.1.1.dist-info/licenses/LICENSE,sha256=V3moMsQxKDchTd3mtXl5J-ODaNBDvFrapOf1DK7Nx_U,1082
+sg_python_api-0.1.1.dist-info/RECORD,,

shotgun_api3/_async_client.py

@@ -51,7 +51,6 @@ from ._client import (
     expose_constructor_signature,
 )
 from ._config import (
-    CompatibilityWarningCode,
     Config,
     RequestContext,
     advance_transport_generation,
@@ -288,7 +287,6 @@ class _InvocationOptions:
     """Collect non-payload controls for one client invocation."""
 
     auth_spec: _protocol.AuthSpec | None = None
-    compatibility_warning_codes: tuple[CompatibilityWarningCode, ...] = ()
     include_auth: bool = True
     logical_method_name: str | None = None
 
@@ -523,7 +521,6 @@ class AsyncShotgun:
             outbound,
             context,
             include_auth=invocation.options.include_auth,
-            compatibility_warning_codes=invocation.options.compatibility_warning_codes,
             _logical_method_name=invocation.options.logical_method_name,
         )
         return _protocol.transform_inbound(result, context.convert_datetimes_to_utc)
@@ -1220,6 +1217,28 @@ class AsyncShotgun:
         await self._upload_direct(driver, context, prepared, upload_info)
         return await self._upload_link(driver, context, prepared, upload_info)
 
+    async def _upload_thumbnails_after_write(
+        self,
+        entity_type: str,
+        entity_id: int,
+        thumbnails: dict[str, object],
+        result: dict[str, object],
+    ) -> dict[str, object]:
+        """Upload separated thumbnail paths and merge their current field values."""
+        if not thumbnails:
+            return result
+        for field_name, path in thumbnails.items():
+            upload = (
+                self.upload_filmstrip_thumbnail
+                if field_name == 'filmstrip_image'
+                else self.upload_thumbnail
+            )
+            await upload(entity_type, entity_id, cast('str', path))
+        current = await self.find_one(entity_type, [['id', 'is', entity_id]], list(thumbnails))
+        if current is not None:
+            result.update({field_name: current.get(field_name) for field_name in thumbnails})
+        return result
+
     @overload
     async def activity_stream_read(self, entity_type: Never) -> dict[str, object]: ...
 
@@ -1520,6 +1539,10 @@ class AsyncShotgun:
     ) -> dict[str, object]:
         """Create an entity with the supplied field values.
 
+        Non-empty `image` and `filmstrip_image` values are file paths. They are
+        uploaded as thumbnails after the entity is created, and the result
+        includes their current field values.
+
         Args:
             entity_type: Entity type to create.
             data: Field values for the new entity.
@@ -1530,14 +1553,22 @@ class AsyncShotgun:
 
         Raises:
             ShotgunError: If an RPC fault or terminal transport failure occurs,
-                or if `data`, its field names, `return_fields`, or the server
-                result is invalid.
+                if `data`, its field names, `return_fields`, or the server
+                result is invalid, or if a thumbnail path is not a nonempty
+                file. A thumbnail failure occurs after the entity is created.
             ProtocolError: If a server request returns an HTTP error.
             ValueError: If authenticated HTTP violates the configured origin
                 policy.
         """
-        params = _crud.build_create_params(entity_type, data, return_fields)
-        return _crud.require_dictionary_result(await self._call('create', params), 'create')
+        field_data, thumbnails = _files.split_thumbnail_uploads(data, keep_image_none=False)
+        params = _crud.build_create_params(entity_type, field_data, return_fields)
+        result = _crud.require_dictionary_result(await self._call('create', params), 'create')
+        if not thumbnails:
+            return result
+        entity_id = _crud.require_entity_id(result.get('id'), 'create did not return an entity id')
+        return await self._upload_thumbnails_after_write(
+            entity_type, entity_id, thumbnails, result
+        )
 
     async def delete(self, entity_type: str, entity_id: int) -> bool:
         """Retire an entity.
@@ -1642,6 +1673,15 @@ class AsyncShotgun:
         except (TransportError, _errors.ProtocolError, OSError):
             raise _errors.ShotgunFileDownloadError('attachment download failed') from None
 
+    async def entity_types(self) -> Never:
+        """Reject the deprecated alias of `schema_entity_read()` without I/O.
+
+        Raises:
+            ShotgunError: Always, naming `schema_entity_read()` as the
+                replacement.
+        """
+        raise _methods.entity_types_alias_error()
+
     @overload
     async def export_page(
         self,
@@ -2085,6 +2125,18 @@ class AsyncShotgun:
         params = _crud.build_entity_action_params(entity_type, entity_id)
         return _crud.require_boolean_result(await self._call('revive', params), 'revive')
 
+    async def schema(self, entity_type: str) -> Never:
+        """Reject the deprecated alias of `schema_field_read()` without I/O.
+
+        Args:
+            entity_type: Entity type named in the replacement suggestion.
+
+        Raises:
+            ShotgunError: Always, naming the equivalent `schema_field_read()`
+                call.
+        """
+        raise _methods.schema_alias_error(entity_type)
+
     async def schema_entity_read(
         self,
         project_entity: dict[str, Any] | None = None,
@@ -2104,34 +2156,12 @@ class AsyncShotgun:
             ValueError: If authenticated HTTP violates the configured origin
                 policy.
         """
-        warnings_codes = _methods.consume_compatibility_warnings(
-            _methods.SCHEMA_ENTITY_READ_WARNINGS,
-            self,
-        )
         result = await self._call(
             'schema_entity_read',
             _methods.build_schema_entity_read_params(project_entity),
-            _InvocationOptions(compatibility_warning_codes=warnings_codes),
         )
         return _crud.require_dictionary_result(result, 'schema_entity_read')
 
-    async def entity_types(self) -> dict[str, object]:
-        """Return entity schema through the deprecated alias.
-
-        Returns:
-            Entity-type schema data returned by the server.
-
-        Raises:
-            ShotgunError: If an RPC fault or terminal transport failure occurs,
-                or if the server result is not a dictionary.
-            ProtocolError: If a server request returns an HTTP error.
-            ValueError: If authenticated HTTP violates the configured origin
-                policy.
-        """
-        _methods.warn_entity_types_alias()
-        with _methods.entity_types_alias(self):
-            return await self.schema_entity_read()
-
     async def schema_field_create(
         self,
         entity_type: str,
@@ -2210,10 +2240,6 @@ class AsyncShotgun:
             ValueError: If authenticated HTTP violates the configured origin
                 policy.
         """
-        warning_codes = _methods.consume_compatibility_warnings(
-            _methods.SCHEMA_FIELD_READ_WARNINGS,
-            self,
-        )
         result = await self._call(
             'schema_field_read',
             _methods.build_schema_field_read_params(
@@ -2221,30 +2247,9 @@ class AsyncShotgun:
                 field_name,
                 project_entity,
             ),
-            _InvocationOptions(compatibility_warning_codes=warning_codes),
         )
         return _crud.require_dictionary_result(result, 'schema_field_read')
 
-    async def schema(self, entity_type: str) -> dict[str, object]:
-        """Return field schema through the deprecated alias.
-
-        Args:
-            entity_type: Entity type whose fields to return.
-
-        Returns:
-            Field schema data returned by the server.
-
-        Raises:
-            ShotgunError: If an RPC fault or terminal transport failure occurs,
-                or if the server result is invalid.
-            ProtocolError: If a server request returns an HTTP error.
-            ValueError: If authenticated HTTP violates the configured origin
-                policy.
-        """
-        _methods.warn_schema_alias()
-        with _methods.schema_alias(self):
-            return await self.schema_field_read(entity_type)
-
     async def schema_field_update(
         self,
         entity_type: str,
@@ -2559,6 +2564,12 @@ class AsyncShotgun:
     ) -> dict[str, object]:
         """Update fields on an existing entity.
 
+        Non-empty `image` and `filmstrip_image` values are file paths. They are
+        uploaded as thumbnails after the other fields are updated, and the
+        result includes their current field values. An `image` of `None` clears
+        both thumbnails. When no other fields remain, no update request is sent
+        and the result contains only `id` and `type`.
+
         Args:
             entity_type: Entity type to update.
             entity_id: Numeric entity identifier.
@@ -2570,19 +2581,29 @@ class AsyncShotgun:
 
         Raises:
             ShotgunError: If an RPC fault or terminal transport failure occurs,
-                or if `data`, its field names, `multi_entity_update_modes`, or
-                the server result is invalid.
+                if `data`, its field names, `multi_entity_update_modes`, or the
+                server result is invalid, or if a thumbnail path is not a
+                nonempty file. A thumbnail failure occurs after the update.
             ProtocolError: If a server request returns an HTTP error.
             ValueError: If authenticated HTTP violates the configured origin
                 policy.
         """
+        field_data, thumbnails = _files.split_thumbnail_uploads(data, keep_image_none=True)
         params = _crud.build_update_params(
             entity_type,
             entity_id,
-            data,
+            field_data,
             multi_entity_update_modes,
         )
-        return _crud.require_dictionary_result(await self._call('update', params), 'update')
+        result: dict[str, object] = {'id': entity_id, 'type': entity_type}
+        if params['fields']:
+            result = _crud.require_dictionary_result(
+                await self._call('update', params),
+                'update',
+            )
+        return await self._upload_thumbnails_after_write(
+            entity_type, entity_id, thumbnails, result
+        )
 
     async def update_project_last_accessed(
         self,

shotgun_api3/_async_driver.py

@@ -15,7 +15,6 @@ from typing import Protocol, TypeVar, cast
 from . import _protocol, _transport
 from ._async_transport import AsyncTransport
 from ._config import (
-    CompatibilityWarningCode,
     EventRoute,
     ObserverCallback,
     Outcome,
@@ -200,14 +199,11 @@ class AsyncExecutionOptions:
     """Control async executor transport choreography.
 
     Attributes:
-        compatibility_warning_codes: Compatibility warnings emitted before
-            attempts.
         logical_method_name: Optional observer-facing operation name.
         redirect_factory: Optional request factory for redirect responses.
         streaming: Whether the response body is consumed as a stream.
     """
 
-    compatibility_warning_codes: tuple[CompatibilityWarningCode, ...] = ()
     logical_method_name: str | None = None
     redirect_factory: Callable[['AsyncLiveResponse'], TransportRequest] | None = None
     streaming: bool = False
@@ -486,10 +482,7 @@ class AsyncDriver:
                 consumption, or cleanup fails.
         """
         execution_options = options or AsyncExecutionOptions()
-        for event in compatibility_warning_events(
-            execution_options.compatibility_warning_codes,
-            context.timeout,
-        ):
+        for event in compatibility_warning_events(context.timeout):
             notify_observer(context.on_compatibility_warning, event)
         route = event_route(operation)
         self._transport.checkout()
@@ -590,7 +583,6 @@ class AsyncDriver:
         params: object,
         context: RequestContext,
         include_auth: bool = True,
-        compatibility_warning_codes: tuple[CompatibilityWarningCode, ...] = (),
         *,
         _logical_method_name: str | None = None,
     ) -> object:
@@ -601,7 +593,6 @@ class AsyncDriver:
             params: Normalized method parameters.
             context: Immutable operation configuration.
             include_auth: Whether to include captured authentication.
-            compatibility_warning_codes: Sanitized compatibility notices.
             _logical_method_name: Optional logical operation name when it
                 differs from the wire method.
 
@@ -615,10 +606,7 @@ class AsyncDriver:
                 consumption, or cleanup fails.
         """
         normalized_params = copy.deepcopy(params)
-        options = AsyncExecutionOptions(
-            compatibility_warning_codes=compatibility_warning_codes,
-            logical_method_name=_logical_method_name,
-        )
+        options = AsyncExecutionOptions(logical_method_name=_logical_method_name)
         return await self._execute_rpc(
             method_name,
             normalized_params,

shotgun_api3/_client.py

@@ -26,7 +26,6 @@ from . import _config as config_module
 from . import _crud, _errors, _files, _methods, _protocol, _transport
 from ._capabilities import ClientCapabilities, ServerCapabilities
 from ._config import (
-    CompatibilityWarningCode,
     Config,
     RequestContext,
     advance_transport_generation,
@@ -348,7 +347,6 @@ class _InvocationOptions:
     """Collect non-payload controls for one client invocation."""
 
     include_auth: bool = True
-    compatibility_warning_codes: tuple[CompatibilityWarningCode, ...] = ()
     logical_method_name: str | None = None
     auth_spec: _protocol.AuthSpec | None = None
 
@@ -570,7 +568,6 @@ class Shotgun:
             outbound,
             context,
             include_auth=options.include_auth,
-            compatibility_warning_codes=options.compatibility_warning_codes,
             _logical_method_name=options.logical_method_name,
         )
         return _protocol.transform_inbound(result, context.convert_datetimes_to_utc)
@@ -1038,6 +1035,28 @@ class Shotgun:
         self._upload_direct(driver, context, prepared, upload_info)
         return self._upload_link(driver, context, prepared, upload_info)
 
+    def _upload_thumbnails_after_write(
+        self,
+        entity_type: str,
+        entity_id: int,
+        thumbnails: dict[str, object],
+        result: dict[str, object],
+    ) -> dict[str, object]:
+        """Upload separated thumbnail paths and merge their current field values."""
+        if not thumbnails:
+            return result
+        for field_name, path in thumbnails.items():
+            upload = (
+                self.upload_filmstrip_thumbnail
+                if field_name == 'filmstrip_image'
+                else self.upload_thumbnail
+            )
+            upload(entity_type, entity_id, cast('str', path))
+        current = self.find_one(entity_type, [['id', 'is', entity_id]], list(thumbnails))
+        if current is not None:
+            result.update({field_name: current.get(field_name) for field_name in thumbnails})
+        return result
+
     @overload
     def activity_stream_read(self, entity_type: Never) -> dict[str, object]: ...
 
@@ -1298,6 +1317,10 @@ class Shotgun:
     ) -> dict[str, object]:
         """Create an entity with the supplied field values.
 
+        Non-empty `image` and `filmstrip_image` values are file paths. They are
+        uploaded as thumbnails after the entity is created, and the result
+        includes their current field values.
+
         Args:
             entity_type: Entity type to create.
             data: Field values for the new entity.
@@ -1308,14 +1331,20 @@ class Shotgun:
 
         Raises:
             ShotgunError: If an RPC fault or terminal transport failure occurs,
-                or if `data`, its field names, `return_fields`, or the server
-                result is invalid.
+                if `data`, its field names, `return_fields`, or the server
+                result is invalid, or if a thumbnail path is not a nonempty
+                file. A thumbnail failure occurs after the entity is created.
             ProtocolError: If a server request returns an HTTP error.
             ValueError: If authenticated HTTP violates the configured origin
                 policy.
         """
-        params = _crud.build_create_params(entity_type, data, return_fields)
-        return _crud.require_dictionary_result(self._call('create', params), 'create')
+        field_data, thumbnails = _files.split_thumbnail_uploads(data, keep_image_none=False)
+        params = _crud.build_create_params(entity_type, field_data, return_fields)
+        result = _crud.require_dictionary_result(self._call('create', params), 'create')
+        if not thumbnails:
+            return result
+        entity_id = _crud.require_entity_id(result.get('id'), 'create did not return an entity id')
+        return self._upload_thumbnails_after_write(entity_type, entity_id, thumbnails, result)
 
     def delete(self, entity_type: str, entity_id: int) -> bool:
         """Retire an entity.
@@ -1422,6 +1451,15 @@ class Shotgun:
         except (TransportError, _errors.ProtocolError, OSError):
             raise _errors.ShotgunFileDownloadError('attachment download failed') from None
 
+    def entity_types(self) -> Never:
+        """Reject the deprecated alias of `schema_entity_read()` without I/O.
+
+        Raises:
+            ShotgunError: Always, naming `schema_entity_read()` as the
+                replacement.
+        """
+        raise _methods.entity_types_alias_error()
+
     @overload
     def export_page(
         self,
@@ -1900,6 +1938,18 @@ class Shotgun:
             'revive',
         )
 
+    def schema(self, entity_type: str) -> Never:
+        """Reject the deprecated alias of `schema_field_read()` without I/O.
+
+        Args:
+            entity_type: Entity type named in the replacement suggestion.
+
+        Raises:
+            ShotgunError: Always, naming the equivalent `schema_field_read()`
+                call.
+        """
+        raise _methods.schema_alias_error(entity_type)
+
     def schema_entity_read(
         self,
         project_entity: dict[str, Any] | None = None,
@@ -1923,33 +1973,10 @@ class Shotgun:
             self._call(
                 'schema_entity_read',
                 _methods.build_schema_entity_read_params(project_entity),
-                _InvocationOptions(
-                    compatibility_warning_codes=_methods.consume_compatibility_warnings(
-                        _methods.SCHEMA_ENTITY_READ_WARNINGS,
-                        self,
-                    ),
-                ),
             ),
             'schema_entity_read',
         )
 
-    def entity_types(self) -> dict[str, object]:
-        """Return entity schema through the deprecated alias.
-
-        Returns:
-            Entity-type schema data returned by the server.
-
-        Raises:
-            ShotgunError: If an RPC fault or terminal transport failure occurs,
-                or if the server result is not a dictionary.
-            ProtocolError: If a server request returns an HTTP error.
-            ValueError: If authenticated HTTP violates the configured origin
-                policy.
-        """
-        _methods.warn_entity_types_alias()
-        with _methods.entity_types_alias(self):
-            return self.schema_entity_read()
-
     def schema_field_create(
         self,
         entity_type: str,
@@ -2042,36 +2069,10 @@ class Shotgun:
                     field_name,
                     project_entity,
                 ),
-                _InvocationOptions(
-                    compatibility_warning_codes=_methods.consume_compatibility_warnings(
-                        _methods.SCHEMA_FIELD_READ_WARNINGS,
-                        self,
-                    ),
-                ),
             ),
             'schema_field_read',
         )
 
-    def schema(self, entity_type: str) -> dict[str, object]:
-        """Return field schema through the deprecated alias.
-
-        Args:
-            entity_type: Entity type whose fields to return.
-
-        Returns:
-            Field schema data returned by the server.
-
-        Raises:
-            ShotgunError: If an RPC fault or terminal transport failure occurs,
-                or if the server result is invalid.
-            ProtocolError: If a server request returns an HTTP error.
-            ValueError: If authenticated HTTP violates the configured origin
-                policy.
-        """
-        _methods.warn_schema_alias()
-        with _methods.schema_alias(self):
-            return self.schema_field_read(entity_type)
-
     def schema_field_update(
         self,
         entity_type: str,
@@ -2384,6 +2385,12 @@ class Shotgun:
     ) -> dict[str, object]:
         """Update fields on an existing entity.
 
+        Non-empty `image` and `filmstrip_image` values are file paths. They are
+        uploaded as thumbnails after the other fields are updated, and the
+        result includes their current field values. An `image` of `None` clears
+        both thumbnails. When no other fields remain, no update request is sent
+        and the result contains only `id` and `type`.
+
         Args:
             entity_type: Entity type to update.
             entity_id: Numeric entity identifier.
@@ -2395,19 +2402,27 @@ class Shotgun:
 
         Raises:
             ShotgunError: If an RPC fault or terminal transport failure occurs,
-                or if `data`, its field names, `multi_entity_update_modes`, or
-                the server result is invalid.
+                if `data`, its field names, `multi_entity_update_modes`, or the
+                server result is invalid, or if a thumbnail path is not a
+                nonempty file. A thumbnail failure occurs after the update.
             ProtocolError: If a server request returns an HTTP error.
             ValueError: If authenticated HTTP violates the configured origin
                 policy.
         """
+        field_data, thumbnails = _files.split_thumbnail_uploads(data, keep_image_none=True)
         params = _crud.build_update_params(
             entity_type,
             entity_id,
-            data,
+            field_data,
             multi_entity_update_modes,
         )
-        return _crud.require_dictionary_result(self._call('update', params), 'update')
+        result: dict[str, object] = {'id': entity_id, 'type': entity_type}
+        if params['fields']:
+            result = _crud.require_dictionary_result(
+                self._call('update', params),
+                'update',
+            )
+        return self._upload_thumbnails_after_write(entity_type, entity_id, thumbnails, result)
 
     def update_project_last_accessed(
         self,

shotgun_api3/_config.py

@@ -21,11 +21,7 @@ from ._sentinel import Unset as _Unset
 from ._transport import TimeoutConfig
 from ._version import PACKAGE_VERSION
 
-CompatibilityWarningCode: TypeAlias = Literal[
-    'deprecated-entity-types-alias',
-    'deprecated-schema-alias',
-    'legacy-infinite-timeout',
-]
+CompatibilityWarningCode: TypeAlias = Literal['legacy-infinite-timeout']
 EventRoute: TypeAlias = Literal[
     'allocation',
     'download',
@@ -85,8 +81,6 @@ _ORIGIN_FIELDS = frozenset({'api_path', 'scheme', 'server'})
 _ORIGIN_STRING_FIELDS = frozenset({'scheme', 'server'})
 _UNSET: Final = _Unset()
 _WARNING_MESSAGES: Mapping[CompatibilityWarningCode, str] = {
-    'deprecated-entity-types-alias': 'The entity_types alias is deprecated.',
-    'deprecated-schema-alias': 'The schema alias is deprecated.',
     'legacy-infinite-timeout': 'Explicit None timeout enables legacy infinite waits.',
 }
 _PUBLIC_FIELDS = frozenset(
@@ -1021,19 +1015,17 @@ def auth_spec(config: Config) -> _protocol.AuthSpec:
 
 
 def compatibility_warning_events(
-    warning_codes: tuple[CompatibilityWarningCode, ...],
     timeout: TimeoutConfig,
 ) -> tuple[CompatibilityWarningEvent, ...]:
     """Build fixed-message compatibility warnings for one operation.
 
     Args:
-        warning_codes: Sanitized compatibility notices from the client.
         timeout: Captured operation timeout semantics.
 
     Returns:
         Immutable compatibility-warning events in publication order.
     """
-    codes = list(warning_codes)
+    codes: list[CompatibilityWarningCode] = []
     if timeout.connect is None and timeout.read is None:
         codes.append('legacy-infinite-timeout')
     return tuple(

shotgun_api3/_driver.py

@@ -12,7 +12,6 @@ from typing import Literal, Protocol, TypeVar, cast, runtime_checkable
 
 from . import _protocol, _transport
 from ._config import (
-    CompatibilityWarningCode,
     EventRoute,
     ObserverCallback,
     Outcome,
@@ -181,14 +180,11 @@ class ExecutionOptions:
     """Control executor behavior that is not part of retry classification.
 
     Attributes:
-        compatibility_warning_codes: Compatibility warnings emitted before
-            attempts.
         logical_method_name: Optional observer-facing operation name.
         redirect_factory: Optional request factory for redirect responses.
         streaming: Whether the response body is consumed as a stream.
     """
 
-    compatibility_warning_codes: tuple[CompatibilityWarningCode, ...] = ()
     logical_method_name: str | None = None
     redirect_factory: 'Callable[[LiveResponse], TransportRequest] | None' = None
     streaming: bool = False
@@ -443,13 +439,9 @@ class Driver:
             raise AssertionError('response consumption ended without an outcome')
         return attempt_result
 
-    def _emit_warnings(
-        self,
-        context: RequestContext,
-        warning_codes: tuple[CompatibilityWarningCode, ...],
-    ) -> None:
+    def _emit_warnings(self, context: RequestContext) -> None:
         """Publish fixed-message compatibility warnings."""
-        for event in compatibility_warning_events(warning_codes, context.timeout):
+        for event in compatibility_warning_events(context.timeout):
             notify_observer(context.on_compatibility_warning, event)
 
     def _execute_rpc(
@@ -623,7 +615,6 @@ class Driver:
         params: object,
         context: RequestContext,
         include_auth: bool = True,
-        compatibility_warning_codes: tuple[CompatibilityWarningCode, ...] = (),
         *,
         _logical_method_name: str | None = None,
     ) -> object:
@@ -635,8 +626,6 @@ class Driver:
             context: Immutable operation configuration.
             include_auth: Whether to include the captured authentication
                 payload.
-            compatibility_warning_codes: Sanitized compatibility notices
-                attached by the client surface.
             _logical_method_name: Optional logical operation name when it
                 differs from the wire method.
 
@@ -648,10 +637,7 @@ class Driver:
                 response contract (`reason` and `content`).
         """
         normalized_params = copy.deepcopy(params)
-        options = ExecutionOptions(
-            compatibility_warning_codes=compatibility_warning_codes,
-            logical_method_name=_logical_method_name,
-        )
+        options = ExecutionOptions(logical_method_name=_logical_method_name)
         return self._execute_rpc(
             method_name,
             normalized_params,
@@ -745,7 +731,7 @@ class Driver:
             Exception: If status validation or response consumption fails.
         """
         execution_options = options or ExecutionOptions()
-        self._emit_warnings(context, execution_options.compatibility_warning_codes)
+        self._emit_warnings(context)
         route = event_route(operation)
         for attempt in range(1, context.max_rpc_attempts + 1):
             state = self._attempt_state(operation, context, route, attempt)

shotgun_api3/_files.py

@@ -34,6 +34,7 @@ _FILE_SERVE_ATTACHMENT = '/file_serve/attachment/'
 _MULTIPART_CHUNK_SIZE = 20_000_000
 _Origin: TypeAlias = tuple[str, str, int]
 _PART_LINK_FIELD_COUNT = 2
+_THUMBNAIL_UPLOAD_FIELDS = ('image', 'filmstrip_image')
 _UPLOAD_FILE = '/upload/upload_file'
 
 
@@ -992,8 +993,8 @@ def prepare_upload(options: UploadOptions) -> PreparedUpload:
         Captured filename, size, and options for one upload.
 
     Raises:
-        ShotgunError: If the path does not name a nonempty file or `created_at`
-            is not a datetime.
+        ShotgunError: If the path does not name a file, the file is empty, or
+            `created_at` is not a datetime.
     """
     created_at = cast('object', options.arguments.created_at)
     if created_at is not None and not isinstance(created_at, datetime.datetime):
@@ -1006,11 +1007,14 @@ def prepare_upload(options: UploadOptions) -> PreparedUpload:
         )
     path = Path(options.arguments.path)
     try:
-        file_size = path.stat().st_size if path.is_file() else 0
+        is_file = path.is_file()
+        file_size = path.stat().st_size if is_file else 0
     except OSError:
-        file_size = 0
+        is_file, file_size = False, 0
+    if not is_file:
+        raise ShotgunError(f"Path must be a valid file, got '{options.arguments.path}'")
     if file_size <= 0:
-        raise ShotgunError('File must exist and be non-empty')
+        raise ShotgunError(f"Path cannot be an empty file: '{options.arguments.path}'")
     return PreparedUpload(filename=path.name, file_size=file_size, options=options)
 
 
@@ -1049,6 +1053,41 @@ def resolve_attachment_url(attachment: object, base_url: str) -> str | None:
     raise ShotgunError('attachment must be an id or dictionary')
 
 
+def split_thumbnail_uploads(
+    data: object,
+    *,
+    keep_image_none: bool,
+) -> tuple[object, dict[str, object]]:
+    """Separate `image` and `filmstrip_image` paths from entity field data.
+
+    Autodesk's client uploads these paths after the entity write instead of
+    sending them as field values.
+
+    Args:
+        data: Public field mapping. A non-dictionary is returned unchanged so
+            that the caller's own validation reports it.
+        keep_image_none: Whether an `image` value of `None` stays in the field
+            data, which lets an update clear both thumbnails.
+
+    Returns:
+        A copy of the field data without the separated fields, and the
+        non-empty paths to upload, with `image` before `filmstrip_image`.
+    """
+    if not isinstance(data, dict):
+        return data, {}
+    mapping = cast('dict[object, object]', data)
+    fields: dict[object, object] = {}
+    paths: dict[str, object] = {}
+    for name, value in mapping.items():
+        if name not in _THUMBNAIL_UPLOAD_FIELDS or (
+            keep_image_none and name == 'image' and value is None
+        ):
+            fields[name] = value
+        elif value:
+            paths[cast('str', name)] = value
+    return fields, {name: paths[name] for name in _THUMBNAIL_UPLOAD_FIELDS if name in paths}
+
+
 def thumbnail_source_ready(
     result: object,
     field_name: Literal['filmstrip_image', 'image'],

shotgun_api3/_methods.py

@@ -1,16 +1,12 @@
 """Shared pure plans for synchronous and asynchronous client methods."""
 
-import contextvars
 import dataclasses
 import datetime
 import inspect
-import warnings
-from collections.abc import Callable, Generator
-from contextlib import contextmanager
+from collections.abc import Callable
 from typing import Any, NotRequired, TypedDict, cast
 
 from . import _crud, _protocol
-from ._config import CompatibilityWarningCode
 from ._errors import ShotgunError
 from ._signatures import bind_arguments, expose_signature
 
@@ -111,10 +107,6 @@ _METHOD_EXPORT_PAGE_SIGNATURE = inspect.Signature(
     ),
     return_annotation=str,
 )
-_PENDING_COMPATIBILITY_WARNINGS = tuple[
-    object,
-    tuple[CompatibilityWarningCode, ...],
-]
 _SCHEDULE_DATE_LENGTH = 10
 _SUMMARIZE_DOCSTRING = """Summarize field data returned by a query.
 
@@ -241,12 +233,6 @@ _WORK_SCHEDULE_UPDATE_SIGNATURE = inspect.Signature(
     _WORK_SCHEDULE_UPDATE_PARAMETERS,
     return_annotation=dict[str, object],
 )
-SCHEMA_ENTITY_READ_WARNINGS: contextvars.ContextVar[_PENDING_COMPATIBILITY_WARNINGS | None] = (
-    contextvars.ContextVar('SCHEMA_ENTITY_READ_WARNINGS', default=None)
-)
-SCHEMA_FIELD_READ_WARNINGS: contextvars.ContextVar[_PENDING_COMPATIBILITY_WARNINGS | None] = (
-    contextvars.ContextVar('SCHEMA_FIELD_READ_WARNINGS', default=None)
-)
 
 
 @dataclasses.dataclass(frozen=True)
@@ -1007,43 +993,13 @@ def build_work_schedule_update_params(
     return params
 
 
-def consume_compatibility_warnings(
-    warning_context: contextvars.ContextVar[_PENDING_COMPATIBILITY_WARNINGS | None],
-    owner: object,
-) -> tuple[CompatibilityWarningCode, ...]:
-    """Consume operation-local compatibility warnings exactly once.
-
-    Args:
-        warning_context: Context-local warning state.
-        owner: Client instance expected to own the warning.
+def entity_types_alias_error() -> ShotgunError:
+    """Build the error raised by the deprecated `entity_types` alias.
 
     Returns:
-        Compatibility warning codes for the target call.
+        A `ShotgunError` naming `schema_entity_read()` as the replacement.
     """
-    pending = warning_context.get()
-    if pending is None or pending[0] is not owner:
-        return ()
-    warning_context.set(None)
-    return pending[1]
-
-
-@contextmanager
-def entity_types_alias(owner: object) -> Generator[None, None, None]:
-    """Scope the deprecated `entity_types` compatibility notice.
-
-    Args:
-        owner: Client instance invoking the alias.
-
-    Yields:
-        Control while the public target method consumes the warning.
-    """
-    token = SCHEMA_ENTITY_READ_WARNINGS.set(
-        (owner, ('deprecated-entity-types-alias',)),
-    )
-    try:
-        yield
-    finally:
-        SCHEMA_ENTITY_READ_WARNINGS.reset(token)
+    return ShotgunError('Deprecated: use schema_entity_read() instead')
 
 
 def expose_activity_stream_read_signature(
@@ -1168,38 +1124,13 @@ def require_string_result(value: object, method_name: str) -> str:
     return value
 
 
-@contextmanager
-def schema_alias(owner: object) -> Generator[None, None, None]:
-    """Scope the deprecated `schema` compatibility notice.
+def schema_alias_error(entity_type: object) -> ShotgunError:
+    """Build the error raised by the deprecated `schema` alias.
 
     Args:
-        owner: Client instance invoking the alias.
+        entity_type: Caller-supplied entity type, rendered with `str()`.
 
-    Yields:
-        Control while the public target method consumes the warning.
+    Returns:
+        A `ShotgunError` naming the equivalent `schema_field_read()` call.
     """
-    token = SCHEMA_FIELD_READ_WARNINGS.set(
-        (owner, ('deprecated-schema-alias',)),
-    )
-    try:
-        yield
-    finally:
-        SCHEMA_FIELD_READ_WARNINGS.reset(token)
-
-
-def warn_entity_types_alias() -> None:
-    """Warn at the caller of the deprecated `entity_types` method."""
-    warnings.warn(
-        'entity_types() is deprecated; use schema_entity_read()',
-        DeprecationWarning,
-        stacklevel=3,
-    )
-
-
-def warn_schema_alias() -> None:
-    """Warn at the caller of the deprecated `schema` method."""
-    warnings.warn(
-        'schema() is deprecated; use schema_field_read()',
-        DeprecationWarning,
-        stacklevel=3,
-    )
+    return ShotgunError(f"Deprecated: use schema_field_read('{entity_type}') instead")

shotgun_api3/_version.py

@@ -1,3 +1,3 @@
 """Package version shared by public exports and compatibility metadata."""
 
-PACKAGE_VERSION = '0.1.0'
+PACKAGE_VERSION = '0.1.1'