fabiangeisler / pyshotgrid

A pythonic and object oriented way to talk to Autodesk Flow Production Tracking (formally known as ShotGrid).
https://fabiangeisler.github.io/pyshotgrid/
MIT License
47 stars 0 forks source link

Add hints for DB calls to docstrings #125

Open fabiangeisler opened 3 months ago

fabiangeisler commented 3 months ago

Each Shotgrid Database call slows down code execution, which means that some pysg functions are more efficient than others. For example sg_project["code"].get() and sg_project.all_field_values() each do only one call to the Shotgrid Database, but the second call returns vastly more information and might be more desirable to use in your code. It would be great for the user to see how many calls are made in the docstring of each function, so they can decide what to use and optimise easier.