Rassembler tous les commentaires d'un Projet

Vue d’ensemble

L’extracteur de commentaires récupère tous les Assets d’un Projet, extrait les commentaires et les exporte dans un fichier .csv. Cette procédure utilise les ressources suivantes :

• SDK Python - Le SDK gère la pagination pour vous et configure un client que vous pouvez utiliser avec les jetons de développeur (authentification bearer).
• Extracteur de commentaires en Python - L’exemple de code que nous utilisons se trouve ici.

Testez-le sur Glitch

Glitch est un outil simple qui vous permet de configurer vos propres Application et de les tester et les exécuter en utilisant leurs serveurs. Si vous ne connaissez pas Glitch, consultez notre Guide sur l’utilisation de Glitch. Si vous voulez voir l’extracteur de commentaires fonctionner sur un serveur, nous avons configuré une appli Flask sur Glitch : Extracteur de commentaires Frame.io en Python.

Portées requises

Avant de commencer ce Guide, vous devez vous assurer d’avoir un jeton qui inclut au moins les portées suivantes :

1. Préparez votre appli

Ce Guide suivra un Motif similaire à Lecture de l’arborescence de fichiers — par conséquent, pour Commencer, vous aurez besoin de :

• Le root_asset_id du Projet que vous explorez

Vous devrez également importer FrameioClient dans votre application Python, ainsi que quelques bibliothèques assistant supplémentaires :

1
from frameioclient import FrameioClient
2
import requests, json, csv, itertools
3
4
ROOT_ASSET_ID = "<ROOT_ASSET_ID>"
5
TOKEN = "<DEV_TOKEN>"

2. Parcourir le Projet

Maintenant, vous devez récupérer de manière récursive tous les asset, vérifier s’ils contiennent des commentaires et stocker tous les asset commentés dans une liste à partir de laquelle vous pourrez construire votre fichier CSV.

Lorsque vous parcourez votre Projet, vous devez effectuer les vérifications suivantes sur chaque asset :

• L’asset est-il un fichier ?(\"_type\": \"file\").

• S’il s’agit d’un fichier, contient-il des commentaires ?* Si c’est le cas, récupérez-les et ajoutez-les à votre liste.

• L’asset est-il un dossier ?(\"_type\": \"folder\")

• S’il s’agit d’un dossier, effectuez alors une récursion sur ses enfants.

• L’asset est-il une pile de versions ?(\"_type\": \"version_stack\")

• S’il s’agit d’une pile de versions, récupérez alors tous les enfants et vérifiez la présence de commentaires.

1
def all_comments(client, asset_id, comment_list):
2
    files = client.get_asset_children(asset_id)
3
4
    for asset in files:
5
        if asset['type'] == "file":
6
            if asset['comment_count'] > 0:
7
                asset_parent_id = asset['parent_id']
8
                asset_name = asset['name']
9
                comments = client.get_comments(asset['id'])
10
                my_comment_list = [comment for comment in comments.results]
11
                for object in my_comment_list:
12
                    object.update({'parent_id':asset_parent_id})
13
                    object.update({'name':asset_name})
14
                comment_list.append(my_comment_list)
15
16
        if asset['type'] == "folder":
17
            if asset['item_count'] > 0:
18
                all_comments(client, asset['id'], comment_list)
19
20
        if asset['type'] == "version_stack":
21
            asset_name = asset['name']
22
            parent_id = asset['parent_id']
23
            vfiles = client.get_asset_children(asset['id'])
24
25
            for asset in vfiles.results:
26
                asset_name = asset['name']
27
                parent_id = asset['parent_id']
28
                if asset['type'] == "file":
29
                    if asset['comment_count'] > 0:
30
                        comments = client.get_comments(asset['id'])
31
                        my_comment_list = [comment for comment in comments.results]
32
                        for object in my_comment_list:
33
                            object.update({'parent_id':parent_id})
34
                            object.update({'name':asset_name})
35
                        comment_list.append(my_comment_list)
36
37
def get_all_project_comments(root_asset_id, token):
38
    comment_list = []
39
    client = FrameioClient(token)
40
41
    all_comments(client, root_asset_id, comment_list)
42
43
    return comment_list

3. Aplatir votre liste de commentaires

À moins que vous ne l’ayez géré pendant votre parcours, vous voudrez aplatir votre liste pour faciliter le traitement.

1
# The response list comes back as a list of lists.
2
# Flatten out responses to a single list so you can build your .csv file.
3
4
flat_response_list = list(itertools.chain.from_iterable(responses))

4. Épurer la liste et créer votre CSV

Lorsque votre liste est aplatie, vous pouvez utiliser la compréhension de liste pour récupérer les éléments de chaque commentaire que vous jugez utiles, puis les exporter dans un fichier CSV. ” ] } ```Nous recommandons d’avoir au moins :

• Commentaire - texte
• ID gabarit - parent_id
• ID asset - asset_id
• Nom asset nom
• ID propriétaire - owner_id
• E-mail propriétaire - owner.email
• Date et heure - timestamp
• Mis à jour le - updated_at

Lorsque vous avez créé une nouvelle liste contenant la sortie souhaitée par asset pour votre sortie finale, il est temps d’écrire dans votre fichier CSV (valeurs séparées par des virgules).

1
list_for_csv = [[o['text'], o['parent_id'], o['asset_id'], o['name'], o['owner_id'], o['owner']['email'], o['timestamp'], o['updated_at']] for o in flat_response_list]
2
3
# Let's write our new list out to a .csv file. We'll add a heading.
4
with open("output.csv", 'w') as myfile:
5
     wr = csv.writer(myfile, dialect='excel')
6
     wr.writerow(['Comment', 'Parent ID', 'Asset ID', 'Asset Name', 'Owner ID', 'Email', 'Timestamp', 'Updated At'])
7
     wr.writerows(list_for_csv)

Et voilà ! Vous avez maintenant un fichier CSV (valeurs séparées par des virgules) avec les commentaires aplatis d’un Projet Frame.io entier.