trackteroid

Rasteroide

---

Envoltura declarativa, orientada a objetos para consultas FTRack. Poderosas interacciones de estilo funcional con colecciones resultantes.

El rasteroid depende de FTRack y su API de Python, un software de gestión de proyectos y seguimiento de producción diseñado específicamente para la industria de los medios y el entretenimiento. Se usa comúnmente en los campos de cine, televisión, animación, efectos visuales y juegos.

Instalación

Instalar y actualizar con PIP:

pip install trackteroid

Motivación

Hemos decidido construir una API de envoltura alrededor de la API Ftrack Python para abordar varias limitaciones y desafíos que surgen cuando interactúan directamente con la API de Python. Si bien la API FTRack Python ofrece mucha flexibilidad, hay ciertos aspectos que pueden hacer que el desarrollo y el mantenimiento sean más engorrosos y menos intuitivos. Al crear una API de envoltura, nuestro objetivo es superar estos desafíos y proporcionar una experiencia más simplificada y amigable para los desarrolladores. Estas son las razones clave para esta decisión:

• Simplificando consultas

  • Uno de los principales desafíos con la API FTRack Python es el requisito de escribir consultas como cadenas similares a SQL utilizando un lenguaje de consulta personalizado. Este enfoque a menudo conduce a un formato de cadena complejo y puede ser difícil de leer, comprender y depurar. Este proyecto tiene como objetivo simplificar la lógica de consulta y proporciona una interfaz de consulta más expresiva e intuitiva. Esto permite a los desarrolladores construir consultas utilizando una sintaxis más natural y legible, lo que resulta en una mejor productividad y errores reducidos.

• Optimización del rendimiento de la consulta

  • Cuando trabajan con la API FTRack Python, los desarrolladores deben asegurarse de que escriban consultas eficientes para minimizar las llamadas de base de datos innecesarias y optimizar el rendimiento. Esto requiere una consideración cuidadosa de la lógica de recuperación de datos y la comprensión de las implicaciones de rendimiento de las diferentes construcciones de consultas. En contraste, nuestra API hace un esfuerzo adicional al intentar optimizar las consultas para el rendimiento automáticamente. Al aprovechar varias técnicas de optimización, nuestro objetivo es reducir el número de consultas de bases de datos, optimizar la recuperación de datos y mejorar el rendimiento general del sistema. Esto alivia la carga de los desarrolladores para optimizar manualmente sus consultas, lo que les permite centrarse más en las características y la funcionalidad de la construcción.

• Abrazos de complejidad del esquema de la base de datos

  • La construcción de consultas con la API FTRack Python requiere una buena comprensión del esquema y las relaciones de la base de datos subyacente. Esto puede ser una barrera para los desarrolladores que no están familiarizados con las complejidades del modelo de datos FTRack. Nuestro objetivo es abstraer las complejidades del esquema de la base de datos y proporcionar una interfaz de nivel superior que proteja a los desarrolladores de los detalles. Esto simplifica el proceso de desarrollo y permite a los desarrolladores centrarse en la funcionalidad que desean construir, en lugar de perderse en las complejidades de la estructura de la base de datos.

• Mejora de las colecciones resultantes

  • Las colecciones devueltas por la API Ftrack Python después de ejecutar consultas pueden no ser siempre lo suficientemente convenientes como para interactuar directamente. Pueden carecer de ciertos métodos o propiedades que harían que la manipulación de datos y el procesamiento sean más eficientes. Podemos enriquecer las colecciones resultantes con funcionalidades adicionales y métodos de utilidad adaptados a las necesidades específicas de nuestra aplicación. Esto mejora la experiencia del desarrollador al proporcionar formas más convenientes e intuitivas de trabajar con los datos recuperados, mejorando en última instancia la productividad y la mantenimiento del código.

• Accesibilidad a campo mejorada

  • La API FTRack Python no siempre presenta los campos disponibles en las entidades directamente, lo que requiere que los desarrolladores se refieran a la documentación o inspeccionan el esquema para determinar las propiedades disponibles. Tomamos medidas para mejorar la accesibilidad de campo hasta cierto punto. Nuestro objetivo es proporcionar una forma más intuitiva y descubierta para que los desarrolladores accedan a los campos de entidad al exponerlos directamente a través de la API. Esto ahorra tiempo y esfuerzo a los desarrolladores al eliminar la necesidad de una referencia constante de la documentación o la inspección del esquema subyacente. Mejora la productividad y la capacidad de mantenimiento del código al hacer que los campos de entidad sean más accesibles y descubiertos dentro del flujo de trabajo de desarrollo.

En resumen, Trackeroid intenta capacitar a los desarrolladores al proporcionar una forma más intuitiva y eficiente de interactuar con la plataforma FTRack, acelerando en última instancia el desarrollo, mejorar la calidad del código y mejorar la experiencia general del usuario.

Comparación

Con rasteroid ...

 # Calculate and display the total time duration logged for 
# AssetBuild types within specified Shots and Folders.
#
# output:
# Found 9 assetbuilds.
# Found 1 assetbuilds with timelogs.
# {16.0: ['Drone Craft'],
#  'No time tracked yet.': ['Drawer Cabinet 01',
#                           'Gothic Commode 01',
#                           'Shelf 01',
#                           'Side Table 01',
#                           'Small Wooden Table 01',
#                           'Vintage Wooden Drawer 01',
#                           'Wooden Table 01',
#                           'Wooden Table 02']}
  
from pprint import pprint

from trackteroid import (
    Query ,
    AssetBuild ,
    Folder ,
    Task ,
    Project
)

assetbuild_collection = Query ( AssetBuild ).
    by_name ( Project , "sync" , "showroom" ).
    by_name ( Folder , "Asset%" , "Delivery 3" ).
    get_all (
        projections = [
            Task . Timelog ,
            Task . Timelog . duration
        ]
    )

print (
    f"Found { len ( assetbuild_collection ) } assets. n "
    f"Found { assetbuild_collection . count ( lambda ac : ac . Task . Timelog ) } assetbuilds with timelogs."
)

pprint (
    assetbuild_collection . group_and_map (
        lambda abc : abc . Task . Timelog . fold (
            0 ,
            lambda current , tc : current + tc . duration [ 0 ] / 3600
        ) or "No time tracked yet." ,
        lambda abc : abc . sort (
            lambda abc : abc . name
        ). name
    )
)

... En contraste con la API Ftrack Python .

 # Calculate and display the total time duration logged for 
# AssetBuild types within specified Shots and Folders.
#
# output:
# Found 9 assetbuilds.
# Found 1 assetbuilds with timelogs.
# {16.0: ['Drone Craft'],
#  'No time tracked yet.': ['Drawer Cabinet 01',
#                           'Gothic Commode 01',
#                           'Shelf 01',
#                           'Side Table 01',
#                           'Small Wooden Table 01',
#                           'Vintage Wooden Drawer 01',
#                           'Wooden Table 01',
#                           'Wooden Table 02']}

from pprint import pprint

import ftrack_api

session = ftrack_api . Session ( auto_connect_event_hub = False , auto_populate = False )
project_names = ( "sync" , "showroom" )
folder_specific = "Delivery 3"
folder_unspecific = "Asset%"

query = (
    f"select id, name, assets.name, parent.name, project.name, "
    f"assets.versions.task.timelogs, assets.versions.task.timelogs.duration "
    f"from AssetBuild where project has (name in { project_names } ) "
    f"and parent[Folder] has (name is ' { folder_specific } ' or name like ' { folder_unspecific } ')"
)

assetbuilds_no_duration = [ "No time tracked yet." , []]
assetbuilds_timelog_duration = [ 0 , []]

assetbuilds = session . query ( query ). all ()

for assetbuild in assetbuilds :
    has_duration = False
    for asset in assetbuild [ "assets" ]:
        for version in asset [ "versions" ]:
            durations = [ _ [ "duration" ] for _ in version [ "task" ][ "timelogs" ]]
            if any ( durations ):
                for duration in durations :
                    assetbuilds_timelog_duration [ 0 ] += duration / 3600
                if not has_duration :
                    has_duration = True

    if has_duration :
        assetbuilds_timelog_duration [ 1 ]. append ( assetbuild [ "name" ])
    else :
        assetbuilds_no_duration [ 1 ]. append ( assetbuild [ "name" ])

print (
    f"Found { len ( assetbuilds ) } assetbuilds. n "
    f"Found { len ( assetbuilds_timelog_duration [ 1 ]) } assetbuilds with timelogs."
)

assetbuilds_no_duration [ 1 ]. sort ()
assetbuilds_timelog_duration [ 1 ]. sort ()

pprint (
    dict (
        [ assetbuilds_no_duration , assetbuilds_timelog_duration ]
    )
)

Uso

Vea la última documentación para los detalles de uso.