-
Notifications
You must be signed in to change notification settings - Fork 10
Description
Using the adobe fw results in non-standard imports:
Note now our other frameworks are imported like this:
shotgun_settings = sgtk.platform.import_framework("tk-framework-shotgunutils", "settings")
Whereas the adobe fw is imported like this:
adobe_bridge = sgtk.platform.import_framework(
"tk-framework-adobe",
"tk_framework_adobe.adobe_bridge"
)
win_32_api = sgtk.platform.import_framework(
"tk-framework-adobe",
"tk_framework_adobe_utils.win_32_api"
)
We need to get parity with other frameworks and define a strict interface for the adobe framework modules inside __init__.py - for alignment with other patterns in tk, but more importantly to ensure there is a clear public interface which will allow for refactoring in the future.
Framework interfaces should only expose the minimum public interface that we commit to officially support.
Documentation
Note how the docs for the shotgun utils are generated to look like this:
Currently, the docs for the adobe fw look like this:
As part of this work, we want them to align in structure with how the shotgun utils ones above look, e.g it should just say adobe_bridge.AdobeBridge.


