shotgun-api3 3.8.5__tar.gz → 3.9.1__tar.gz

{shotgun_api3-3.8.5/shotgun_api3.egg-info → shotgun_api3-3.9.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: shotgun_api3
-Version: 3.8.5
+Version: 3.9.1
 Summary: Flow Production Tracking Python API
 Home-page: https://github.com/shotgunsoftware/python-api
 Author: Autodesk
@@ -61,12 +61,12 @@ License: Copyright (c) 2009-2011, Shotgun Software Inc
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.7.0
+Requires-Python: >=3.9.0
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Dynamic: author
@@ -79,15 +79,16 @@ Dynamic: license-file
 Dynamic: requires-python
 Dynamic: summary
 
-[![VFX Platform](https://img.shields.io/badge/vfxplatform-2025%20%7C%202024%20%7C%202023%20%7C%202022-blue.svg)](http://www.vfxplatform.com/)
-[![Python](https://img.shields.io/badge/python-3.11%20%7C%203.10%20%7C%203.9-blue.svg)](https://www.python.org/)/)
-[![Reference Documentation](http://img.shields.io/badge/doc-reference-blue.svg)](http://developer.shotgridsoftware.com/python-api)
+[![Supported VFX Platform: 2022 - 2025](https://img.shields.io/badge/VFX_Platform-2022_|_2023_|_2024_|_2025-blue)](http://www.vfxplatform.com/ "Supported VFX Platform")
+[![Supported Python versions: 3.9 - 3.11](https://img.shields.io/badge/Python-3.9_|_3.10_|_3.11-blue?logo=python&logoColor=f5f5f5)](https://www.python.org/ "Supported Python versions")
+[![Reference Documentation](http://img.shields.io/badge/Reference-documentation-blue.svg?logo=wikibooks&logoColor=f5f5f5)](http://developer.shotgridsoftware.com/python-api)
+
 [![Build Status](https://dev.azure.com/shotgun-ecosystem/Python%20API/_apis/build/status/shotgunsoftware.python-api?branchName=master)](https://dev.azure.com/shotgun-ecosystem/Python%20API/_build/latest?definitionId=108&branchName=master)
 [![Coverage Status](https://coveralls.io/repos/github/shotgunsoftware/python-api/badge.svg?branch=master)](https://coveralls.io/github/shotgunsoftware/python-api?branch=master)
 
 # Flow Production Tracking Python API
 
-Autodesk provides a simple Python-based API for accessing Flow Production Tracking and integrating with other tools. This is the official API that is maintained by Autodesk (https://knowledge.autodesk.com/contact-support)
+Autodesk provides a simple Python-based API for accessing Flow Production Tracking and integrating with other tools. This is the official API that is maintained by Autodesk (https://www.autodesk.com/support)
 
 The latest version can always be found at http://github.com/shotgunsoftware/python-api
 
@@ -106,13 +107,6 @@ Some useful direct links:
 
 You can see the [full history of the Python API on the documentation site](http://developer.shotgridsoftware.com/python-api/changelog.html).
 
-## Updating HTTPLib2
-
-The API comes with a copy of the `httplib2` inside the `shotgun_api3/lib` folder. To update the copy to a more recent version of the API, you can run the `update_httplib2.py` script at the root of this repository like this:
-
-    python update_httplib2.py vX.Y.Z
-
-where `vX.Y.Z` is a release found on `httplib2`'s [release page](https://github.com/httplib2/httplib2/releases).
 
 ## Tests
 
@@ -124,42 +118,7 @@ Integration and unit tests are provided.
     - (Note: Running `pip install -r tests/ci_requirements.txt` will install this package)
 - A `tests/config` file (you can copy an example from `tests/example_config`).
 - Tests can be run individually like this: `nosetests --config="nose.cfg" tests/test_client.py`
-    - Make sure to not forget the `--config="nose.cfg"` option. This option tells nose to use our config file.  This will exclude python 2- and 3-specific files in the `/lib` directory, preventing a failure from being reported by nose for compilation due to incompatible syntax in those files.
+    - Make sure to not forget the `--config="nose.cfg"` option. This option tells nose to use our config file.
 - `test_client` and `tests_unit` use mock server interaction and do not require a Flow Production Tracking instance to be available (no modifications to `tests/config` are necessary).
 - `test_api` and `test_api_long` *do* require a Flow Production Tracking instance, with a script key available for the tests. The server and script user values must be supplied in the `tests/config` file. The tests will add test data to your server based on information in your config. This data will be manipulated by the tests, and should not be used for other purposes.
 - To run all of the tests, use the shell script `run-tests`.
-
-## Release process
-
-### Packaging up new release
-
-1) Update the Changelog in the `HISTORY.rst` file
-    - Add bullet points for any changes that have happened since the previous release. This may include changes you did not make so look at the commit history and make sure we don't miss anything. If you notice something was done that wasn't added to the changelog, hunt down that engineer and make them feel guilty for not doing so. This is a required step in making changes to the API.
-    - Try and match the language of previous change log messages. We want to keep a consistent voice.
-    - Make sure the date of the release matches today. We try and keep this TBD until we're ready to do a release so it's easy to catch that it needs to be updated.
-    - Make sure the version number is filled out and correct. We follow semantic versioning.
-2) Ensure any changes or additions to public methods are documented
-    - Ensure that doc strings are updated in the code itself to work with Sphinx and are correctly formatted.
-    - Examples are always good especially if this a new feature or method.
-    - Think about a new user to the API trying to figure out how to use the features you're documenting.
-3) Update the version value in `python-api/setup.py`  to match the version you are packaging. This controls what version users will get when installing via pip.
-4) Update the `__version__` value in `shotgun_api3/shotgun.py` to the version you're releasing. This identified the current version within the API itself.
-5) Commit these changes in master with a commit message like `packaging for the vx.x.x release`.
-6) Create a tag based off of the master branch called `vx.x.x` to match the version number you're releasing.
-7) Push master and your tag to Github.
-8) Update the Releases page with your new release.
-    - The release should already be there from your tag but if not, create a new one.
-    - Add more detailed information regarding the changes in this release. This is a great place to add examples, and reasons for the change!
-
-### Letting the world know
-Post a message in the [Pipeline Community channel](https://community.shotgridsoftware.com/c/pipeline).
-
-### Prepare for the Next Dev Cycle
-1) Update the `__version__` value in `shotgun_api3/shotgun.py` to the next version number with `.dev` appended to it. For example, `v3.0.24.dev`
-2) Add a new section to the Changelog in the `HISTORY.rst` file with the next version number and a TBD date
-```
-    **v3.0.24 - TBD**
-       + TBD
-```
-3) Commit the changes to master with a commit message like `Bump version to v3.0.24.dev`
-4) Push master to Github

shotgun_api3-3.9.1/README.md

@@ -0,0 +1,43 @@
+[![Supported VFX Platform: 2022 - 2025](https://img.shields.io/badge/VFX_Platform-2022_|_2023_|_2024_|_2025-blue)](http://www.vfxplatform.com/ "Supported VFX Platform")
+[![Supported Python versions: 3.9 - 3.11](https://img.shields.io/badge/Python-3.9_|_3.10_|_3.11-blue?logo=python&logoColor=f5f5f5)](https://www.python.org/ "Supported Python versions")
+[![Reference Documentation](http://img.shields.io/badge/Reference-documentation-blue.svg?logo=wikibooks&logoColor=f5f5f5)](http://developer.shotgridsoftware.com/python-api)
+
+[![Build Status](https://dev.azure.com/shotgun-ecosystem/Python%20API/_apis/build/status/shotgunsoftware.python-api?branchName=master)](https://dev.azure.com/shotgun-ecosystem/Python%20API/_build/latest?definitionId=108&branchName=master)
+[![Coverage Status](https://coveralls.io/repos/github/shotgunsoftware/python-api/badge.svg?branch=master)](https://coveralls.io/github/shotgunsoftware/python-api?branch=master)
+
+# Flow Production Tracking Python API
+
+Autodesk provides a simple Python-based API for accessing Flow Production Tracking and integrating with other tools. This is the official API that is maintained by Autodesk (https://www.autodesk.com/support)
+
+The latest version can always be found at http://github.com/shotgunsoftware/python-api
+
+## Documentation
+Tutorials and detailed documentation about the Python API are available at http://developer.shotgridsoftware.com/python-api).
+
+Some useful direct links:
+
+* [Installing](http://developer.shotgridsoftware.com/python-api/installation.html)
+* [Tutorials](http://developer.shotgridsoftware.com/python-api/cookbook/tutorials.html)
+* [API Reference](http://developer.shotgridsoftware.com/python-api/reference.html)
+* [Data Types](http://developer.shotgridsoftware.com/python-api/reference.html#data-types)
+* [Filter Syntax](http://developer.shotgridsoftware.com/python-api/reference.html#filter-syntax)
+
+## Changelog
+
+You can see the [full history of the Python API on the documentation site](http://developer.shotgridsoftware.com/python-api/changelog.html).
+
+
+## Tests
+
+Integration and unit tests are provided.
+
+- All tests require:
+    - The [nose unit testing tools](http://nose.readthedocs.org),
+    - The [nose-exclude nose plugin](https://pypi.org/project/nose-exclude/)
+    - (Note: Running `pip install -r tests/ci_requirements.txt` will install this package)
+- A `tests/config` file (you can copy an example from `tests/example_config`).
+- Tests can be run individually like this: `nosetests --config="nose.cfg" tests/test_client.py`
+    - Make sure to not forget the `--config="nose.cfg"` option. This option tells nose to use our config file.
+- `test_client` and `tests_unit` use mock server interaction and do not require a Flow Production Tracking instance to be available (no modifications to `tests/config` are necessary).
+- `test_api` and `test_api_long` *do* require a Flow Production Tracking instance, with a script key available for the tests. The server and script user values must be supplied in the `tests/config` file. The tests will add test data to your server based on information in your config. This data will be manipulated by the tests, and should not be used for other purposes.
+- To run all of the tests, use the shell script `run-tests`.

{shotgun_api3-3.8.5 → shotgun_api3-3.9.1}/setup.py

@@ -20,7 +20,7 @@ license = f.read().strip()
 
 setup(
     name="shotgun_api3",
-    version="3.8.5",
+    version="3.9.1",
     description="Flow Production Tracking Python API",
     long_description=readme,
     long_description_content_type="text/markdown",
@@ -30,17 +30,17 @@ setup(
     packages=find_packages(exclude=("tests",)),
     script_args=sys.argv[1:],
     include_package_data=True,
-    package_data={"": ["cacerts.txt", "cacert.pem"]},
+    package_data={"": ["cacerts.txt", "cacert.pem", "py.typed"]},
     zip_safe=False,
-    python_requires=">=3.7.0",
+    python_requires=">=3.9.0",
     classifiers=[
         "Development Status :: 5 - Production/Stable",
         "Intended Audience :: Developers",
         "Programming Language :: Python",
-        "Programming Language :: Python :: 3.7",
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
         "Operating System :: OS Independent",
     ],
 )

shotgun_api3-3.9.1/shotgun_api3/__init__.py

@@ -0,0 +1,59 @@
+# Copyright (c) 2019 Shotgun Software Inc.
+#
+# CONFIDENTIAL AND PROPRIETARY
+#
+# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
+# Source Code License included in this distribution package. See LICENSE.
+# By accessing, using, copying or modifying this work you indicate your
+# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights
+# not expressly granted therein are reserved by Shotgun Software Inc.
+
+import os
+import sys
+import warnings
+
+if sys.version_info < (3, 7):
+    if os.environ.get("SHOTGUN_ALLOW_OLD_PYTHON", "0") != "1":
+        # This is our preferred default behavior when using an old
+        # unsupported Python version.
+        # This way, we can control where the exception is raised, and it provides a
+        # comprehensive error message rather than having users facing a random
+        # Python traceback and trying to understand this is due to using an
+        # unsupported Python version.
+
+        raise RuntimeError("This module requires Python version 3.7 or higher.")
+
+    warnings.warn(
+        "Python versions older than 3.7 are no longer supported as of January "
+        "2023. Since the SHOTGUN_ALLOW_OLD_PYTHON variable is enabled, this "
+        "module is raising a warning instead of an exception. "
+        "However, it is very likely that this module will not be able to work "
+        "on this Python version.",
+        RuntimeWarning,
+        stacklevel=2,
+    )
+elif sys.version_info < (3, 9):
+    warnings.warn(
+        "Python versions older than 3.9 are no longer supported as of March "
+        "2025 and compatibility will be discontinued after March 2026. "
+        "Please update to Python 3.11 or any other supported version.",
+        DeprecationWarning,
+        stacklevel=2,
+    )
+
+
+from .shotgun import (
+    Shotgun,
+    ShotgunError,
+    ShotgunFileDownloadError,  # noqa unused imports
+    ShotgunThumbnailNotReady,
+    Fault,
+    AuthenticationFault,
+    MissingTwoFactorAuthenticationFault,
+    UserCredentialsNotAllowedForSSOAuthenticationFault,
+    ProtocolError,
+    ResponseError,
+    Error,
+    __version__,
+)
+from .shotgun import SG_TIMEZONE as sg_timezone  # noqa unused imports

{shotgun_api3-3.8.5/shotgun_api3/lib/httplib2/python3 → shotgun_api3-3.9.1/shotgun_api3/lib/httplib2}/auth.py

@@ -1,7 +1,7 @@
 import base64
 import re
 
-from ... import pyparsing as pp
+from .. import pyparsing as pp
 
 from .error import *
 

{shotgun_api3-3.8.5 → shotgun_api3-3.9.1}/shotgun_api3/lib/mockgun/mockgun.py

@@ -115,6 +115,7 @@ Below is a non-exhaustive list of things that we still need to implement:
 """
 
 import datetime
+from typing import Any
 
 from ... import ShotgunError
 from ...shotgun import _Config
@@ -177,7 +178,6 @@ class Shotgun(object):
                  api_key=None,
                  convert_datetimes_to_utc=True,
                  http_proxy=None,
-                 ensure_ascii=True,
                  connect=True,
                  ca_certs=None,
                  login=None,
@@ -581,7 +581,7 @@ class Shotgun(object):
             row[field] = default_value
         return row
 
-    def _compare(self, field_type, lval, operator, rval):
+    def _compare(self, field_type: str, lval: Any, operator: str, rval: Any) -> bool:
         """
         Compares a field using the operator and value provide by the filter.
 
@@ -798,7 +798,7 @@ class Shotgun(object):
 
             return self._compare(field_type, lval, operator, rval)
 
-    def _rearrange_filters(self, filters):
+    def _rearrange_filters(self, filters: list) -> None:
         """
         Modifies the filter syntax to turn it into a list of three items regardless
         of the actual filter. Most of the filters are list of three elements, so this doesn't change much.

{shotgun_api3-3.8.5 → shotgun_api3-3.9.1}/shotgun_api3/lib/mockgun/schema.py

@@ -30,8 +30,8 @@
 -----------------------------------------------------------------------------
 """
 
-from ..six.moves import cPickle as pickle
 import os
+import pickle
 
 from .errors import MockgunError
 
@@ -47,7 +47,7 @@ class SchemaFactory(object):
     _schema_cache_path = None
 
     @classmethod
-    def get_schemas(cls, schema_path, schema_entity_path):
+    def get_schemas(cls, schema_path: str, schema_entity_path: str) -> tuple:
         """
         Retrieves the schemas from disk.