sg-python-api 0.1.0__tar.gz → 0.1.2__tar.gz

{sg_python_api-0.1.0 → sg_python_api-0.1.2}/COMPATIBILITY.md

@@ -24,7 +24,7 @@ the *readiness check*.
 ## Supported scope
 
 The package provides the `shotgun_api3` import name and targets the documented synchronous API of
-Autodesk's Python client `3.10.2`, including its method signatures, return shapes, errors, filters,
+Autodesk's Python client `3.10.3`, including its method signatures, return shapes, errors, filters,
 paging, schema, file, activity, navigation, and scheduling operations. It also provides the
 `shotgun_api3.lib.mockgun` and `shotgun_api3.lib.sgtimezone` modules and native async extensions.
 
@@ -112,7 +112,7 @@ operation repeats the check; the client never pages with an invalid size.
 | ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | Download setup errors          | Setup RPC faults keep their specific types. Setup or transfer HTTP failures and invalid download URLs raise `ShotgunFileDownloadError` with a generic message and no underlying exception details. Configuration and security failures keep their existing types. |
 | Multi-target thumbnail sharing | The client waits for source readiness before sharing and does not upload the source again.                                                                                                                                                                        |
-| Legacy form uploads            | A successful response from the legacy form-upload route is unsupported. Hosted direct and multipart routes are supported.                                                                                                                                         |
+| Legacy form uploads            | Servers requiring legacy form uploads are unsupported. The client raises `ShotgunError` before any upload request; capability reads may occur. Hosted direct and multipart routes are supported.                                                                  |
 | Datetime-shaped strings        | Invalid values remain unchanged strings. On platforms without pre-1970 time conversion, valid pre-epoch values use the process standard offset without historical daylight-saving accuracy.                                                                       |
 | Request diagnostics            | Structured observers omit credentials and bodies. Application `httpx2` INFO logging can include signed URLs; set that logger to WARNING.                                                                                                                          |
 | User agent                     | The default includes an `sg-python-api` marker. `add_user_agent()` preserves it, `reset_user_agent()` restores the default, and assigning `sg.config.user_agents` replaces every entry.                                                                           |
@@ -168,13 +168,8 @@ import logging
 logging.getLogger('httpx2').setLevel(logging.WARNING)
 ```
 
-Compatibility warnings use stable codes and fixed messages:
-
-| Code                            | Emitted when                                                                            |
-| ------------------------------- | --------------------------------------------------------------------------------------- |
-| `deprecated-entity-types-alias` | The application calls `entity_types()`, the deprecated alias of `schema_entity_read()`. |
-| `deprecated-schema-alias`       | The application calls `schema()`, the deprecated alias of `schema_field_read()`.        |
-| `legacy-infinite-timeout`       | An operation runs with `sg.config.timeout_secs` set to `None`.                          |
+Compatibility warnings use stable codes and fixed messages. The client emits one code,
+`legacy-infinite-timeout`, when an operation runs with `sg.config.timeout_secs` set to `None`.
 
 ### Callback threads and failures
 

{sg_python_api-0.1.0 → sg_python_api-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: sg-python-api
-Version: 0.1.0
+Version: 0.1.2
 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
@@ -44,9 +44,9 @@ This documentation uses SG for Flow Production Tracking, formerly named Shotgun
   for application tests.
 
 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.
+`3.10.3`. 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.2/docs/migration-guide.md) walks
+through the switch, and the [compatibility reference](https://github.com/dactylo/sg-python-api/blob/v0.1.2/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.2/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.2/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.2/docs/migration-guide.md)                                         |
+| Check what behaves differently from Autodesk's client | [Compatibility](https://github.com/dactylo/sg-python-api/blob/v0.1.2/COMPATIBILITY.md)                                                  |
+| Tune pooling and page prefetch, or observe requests   | [Configuration extensions](https://github.com/dactylo/sg-python-api/blob/v0.1.2/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.2/docs/testing.md)                                         |
+| Compare measured latency and transfer memory          | [Benchmarks](https://github.com/dactylo/sg-python-api/blob/v0.1.2/docs/benchmarks.md)                                                   |
+| See changes by version                                | [Changelog](https://github.com/dactylo/sg-python-api/blob/v0.1.2/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.2/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.2/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 → sg_python_api-0.1.2}/README.md

@@ -20,7 +20,7 @@ This documentation uses SG for Flow Production Tracking, formerly named Shotgun
   for application tests.
 
 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
+`3.10.3`. Some behavior differs on purpose, so validate your application's workflows against a test
 site before replacing its production client. The [migration guide](docs/migration-guide.md) walks
 through the switch, and the [compatibility reference](COMPATIBILITY.md) lists the differences.
 
@@ -33,14 +33,7 @@ requests to a remote site require HTTPS.
 exactly one of them in a Python environment. If the official client is already installed, follow
 the [migration steps](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 .
@@ -50,12 +43,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]'
 ```

{sg_python_api-0.1.0 → sg_python_api-0.1.2}/docs/benchmarks.md

@@ -7,9 +7,10 @@ on your site. If you have not tried the client yet, start with the
 
 ## What the results show
 
-- **Latency was mixed.** In these samples, downloads and all three upload routes had lower medians
-  with sg-python-api. Most queries, writes, and schema reads had similar or higher medians,
-  including the four-concurrent-read comparison.
+- **Latency was mixed.** In these samples, all three upload routes had lower medians with
+  sg-python-api, cold and warm, and so did warm downloads. Cold medians were higher for writes,
+  schema reads, summaries, and the four-concurrent-read comparison. Warm medians were similar or
+  lower except for the encode-heavy batch.
 - **Transfer memory was lower in the measured workloads.** sg-python-api's peak process memory grew
   less during the measured upload and download. That observation also depends on payload shape and
   runtime.
@@ -39,7 +40,7 @@ In the tables below, "replacement" means sg-python-api and "official" means Auto
 
 | Setting                     | Value                                                                   |
 | --------------------------- | ----------------------------------------------------------------------- |
-| Replacement package version | `0.0.1`                                                                 |
+| Replacement package version | `0.1.1`                                                                 |
 | Autodesk client version     | `3.10.2`                                                                |
 | Python                      | `3.14.6`                                                                |
 | Platform                    | macOS, arm64                                                            |
@@ -55,26 +56,26 @@ estimate a reliable tail-latency distribution.
 
 | Operation                           | Replacement cold | Official cold | Replacement warm | Official warm |
 | ----------------------------------- | ---------------: | ------------: | ---------------: | ------------: |
-| First script-authenticated request  |            359.4 |         364.1 |            124.2 |         128.9 |
-| Batch                               |            419.7 |         339.2 |            202.3 |         199.9 |
-| Create                              |            431.2 |         380.3 |            228.3 |         185.2 |
-| Delete                              |            431.9 |         346.0 |            183.6 |         173.3 |
-| Download                            |            603.2 |         767.6 |            340.1 |         450.4 |
-| Medium query                        |            384.2 |         366.1 |            199.0 |         135.8 |
-| Find one                            |            401.2 |         360.3 |            134.3 |         119.1 |
-| Paged query                         |            551.0 |         499.9 |            263.8 |         256.5 |
-| Small query                         |            362.4 |         360.6 |            138.6 |         129.5 |
-| Four concurrent reads               |            551.5 |         387.7 |            191.1 |         130.4 |
-| Decode-heavy read                   |            395.4 |         371.3 |            134.9 |         130.4 |
-| Encode-heavy batch                  |            924.8 |         809.8 |            739.7 |         628.8 |
-| Entity schema                       |            360.6 |         341.5 |            140.4 |         189.8 |
-| Field schema                        |            401.6 |         304.8 |            148.8 |         143.8 |
-| First session-authenticated request |            486.5 |         462.2 |            119.7 |         120.5 |
-| Summarize                           |            374.6 |         310.1 |            132.4 |         132.8 |
-| Update                              |            384.3 |         349.2 |            147.9 |         156.7 |
-| Direct upload                       |           1026.3 |        1242.3 |            655.8 |        1006.6 |
-| Generic upload                      |            782.4 |        1169.4 |            577.0 |         743.4 |
-| Multipart upload                    |           3016.3 |        3423.4 |           2037.6 |        2906.0 |
+| First script-authenticated request  |            366.6 |         358.9 |            119.7 |         124.7 |
+| Batch                               |            410.7 |         309.8 |            160.5 |         178.6 |
+| Create                              |            407.0 |         328.3 |            175.0 |         172.1 |
+| Delete                              |            456.8 |         362.4 |            193.0 |         233.5 |
+| Download                            |            602.2 |         605.4 |            336.3 |         377.0 |
+| Medium query                        |            362.6 |         371.6 |            120.7 |         126.1 |
+| Find one                            |            354.3 |         371.3 |            128.6 |         133.4 |
+| Paged query                         |            490.2 |         484.0 |            263.8 |         254.0 |
+| Small query                         |            354.1 |         380.7 |            125.6 |         133.8 |
+| Four concurrent reads               |            520.6 |         377.5 |            129.6 |         131.1 |
+| Decode-heavy read                   |            361.0 |         365.9 |            129.9 |         138.9 |
+| Encode-heavy batch                  |            993.3 |         790.8 |            665.0 |         565.4 |
+| Entity schema                       |            346.5 |         276.7 |            117.7 |         113.9 |
+| Field schema                        |            371.4 |         303.3 |            141.2 |         146.3 |
+| First session-authenticated request |            489.3 |         477.0 |            116.3 |         127.6 |
+| Summarize                           |            370.7 |         282.8 |            122.2 |         133.5 |
+| Update                              |            394.6 |         298.1 |            163.5 |         157.2 |
+| Direct upload                       |            982.0 |        1183.9 |            652.6 |         950.1 |
+| Generic upload                      |            797.1 |        1128.5 |            596.2 |         814.0 |
+| Multipart upload                    |           2389.0 |        3118.5 |           2163.7 |        2745.0 |
 
 ## Transfer memory
 
@@ -84,8 +85,8 @@ memory use or individual Python allocations.
 
 | Workload | Replacement peak increase | Official peak increase |
 | -------- | ------------------------: | ---------------------: |
-| Download |                  3.69 MiB |               6.63 MiB |
-| Upload   |                  0.94 MiB |              24.50 MiB |
+| Download |                  3.34 MiB |               7.31 MiB |
+| Upload   |                  1.95 MiB |              24.70 MiB |
 
 The upload measurement used the multipart route. Download memory uses a fresh download-only process
 after setup so earlier work does not dominate the process's high-water mark.

{sg_python_api-0.1.0 → sg_python_api-0.1.2}/docs/development.md

@@ -119,7 +119,7 @@ invalidate the evidence. Both scripts need network access and a
 
 Run `scripts/run_conformance.sh` with the same `PATH` and with `SG_TEST_SITE`, `SG_TEST_SCRIPT`,
 `SG_TEST_KEY`, `SG_TEST_HUMAN_LOGIN`, and `SG_TEST_HUMAN_PASSWORD` set. It clones Autodesk's suite
-at `v3.10.2`, runs it against the validated wheel, and appends a tally to
+at `v3.10.3`, runs it against the validated wheel, and appends a tally to
 `dist/conformance-results.md`.
 
 The configured human user must already exist and authenticate with a legacy login passphrase and
@@ -137,9 +137,8 @@ API tests without the official client's legacy transport. Individual tests tied
 private methods, bundled `httplib2`, or unsupported server versions are explicitly skipped. Their
 exact names and reasons are recorded in `scripts/_conformance_setup.py`; unexpected imports still
 fail. Four tests use a reduced setup because their assertions do not require the legacy transport
-mocks. Three test methods have explicit expectation adaptations: deprecated aliases must return the
-documented schema and emit a warning, and invalid export arguments must raise `ShotgunError`
-without requiring Autodesk's exact message text.
+mocks. Two test methods have explicit expectation adaptations: invalid export arguments must raise
+`ShotgunError` without requiring Autodesk's exact message text.
 
 The runtime fixtures snapshot and restore the existing user fields, custom schema and visibility,
 and schedule exceptions changed by the tests. The two schema tests use unique field names on each

{sg_python_api-0.1.0 → sg_python_api-0.1.2}/docs/migration-guide.md

@@ -2,7 +2,7 @@
 
 This guide is for applications that use Autodesk's `shotgun_api3` client and want to switch to
 sg-python-api. sg-python-api keeps the `shotgun_api3` import name and targets the documented API of
-Autodesk's client `3.10.2`, so migration mainly concerns installation, network policy, and failure
+Autodesk's client `3.10.3`, so migration mainly concerns installation, network policy, and failure
 handling. Work in your application's test environment first, so you can validate its actual queries
 and writes before changing a production deployment. For a new integration, start with the
 [README quick start](../README.md#quick-start) instead.
@@ -26,21 +26,15 @@ these:
 
 Use your application's package manager to remove `shotgun-api3` and install `sg-python-api`. Both
 provide `shotgun_api3`, so they cannot coexist in one environment. In a pip-managed environment,
-use these commands when a release is available on your package index:
+run these commands from a checkout of `sg-python-api`:
 
 ```sh
 python -m pip uninstall shotgun-api3
-python -m pip install sg-python-api
-```
-
-To install from a checkout instead, run the second command there as:
-
-```sh
 python -m pip install .
 ```
 
-When the application needs native async support, install `sg-python-api[async]` from the index or
-`'.[async]'` from a checkout. Existing `import shotgun_api3` statements stay as they are.
+When the application needs native async support, run `python -m pip install '.[async]'` instead of
+the second command. Existing `import shotgun_api3` statements stay as they are.
 
 Next, [confirm which client loads](testing.md#verify-the-import-target) and run the
 [read-only smoke test](testing.md#run-a-read-only-smoke-test) with a test-site credential. A

{sg_python_api-0.1.0 → sg_python_api-0.1.2}/pyproject.toml

@@ -10,7 +10,7 @@ requires = [ "editables~=0.3", "hatch-fancy-pypi-readme>=25.1", "hatchling>=1.27
 # ==========================================================
 [project]
 name = "sg-python-api"
-version = "0.1.0"
+version = "0.1.2"
 description = "Python client for Autodesk Flow Production Tracking"
 keywords = [ "api", "flow-production-tracking", "shotgrid", "shotgun", "shotgun-api3" ]
 license = "MIT"
@@ -138,6 +138,7 @@ max_supported_python = "3.15"
 [tool.pyright]
 pythonVersion = "3.11"  # Keep in sync with tool.ruff.target-version
 typeCheckingMode = "strict"
+exclude = [ "dist" ]
 extraPaths = [ ".", "src" ]
 executionEnvironments = [
   { root = "tests", reportPrivateUsage = "none" },

{sg_python_api-0.1.0 → sg_python_api-0.1.2}/scripts/_conformance_setup.py

@@ -197,14 +197,6 @@ _EXPECTATIONS = {
         "self.assertRaises(shotgun_api3.ShotgunError, self.sg.export_page, None, 'csv', "
         "layout_name='Conformance')\n"
     ),
-    'TestShotgunApi.test_deprecated_functions': (
-        'with self.assertWarns(DeprecationWarning):\n'
-        '    entity_schema = self.sg.entity_types()\n'
-        'self.assertEqual(entity_schema, self.sg.schema_entity_read())\n'
-        'with self.assertWarns(DeprecationWarning):\n'
-        "    field_schema = self.sg.schema('Asset')\n"
-        "self.assertEqual(field_schema, self.sg.schema_field_read('Asset'))\n"
-    ),
 }
 _SCHEMA_INPUTS = {
     'TestFind.test_zero_is_not_none': (

{sg_python_api-0.1.0 → sg_python_api-0.1.2}/scripts/_sdist_contract.py

@@ -22,7 +22,7 @@ if TYPE_CHECKING:
 _ARTIFACT_ARGUMENT_COUNT = 6
 _COMMAND_ARGUMENT_COUNT = 3
 _DIRECT_DOC_PART_COUNT = 2
-_EXPECTED_VERSION = '0.1.0'
+_EXPECTED_VERSION = '0.1.2'
 _REGULAR_MEMBER_TYPES = frozenset({tarfile.AREGTYPE, tarfile.REGTYPE})
 _ROOT_SOURCE_FILES = frozenset(
     {