AcademySoftwareFoundation / AcademySoftwareFoundation/OpenCue

PyCue should not pass any protobuf objects

Closed
#338 1 comment 0 reactions 0 assignees View on GitHub
enhancement triaged
Dominant language
Python
Stars
957
Forks
259
Avg merge
3d 6h
Merged PRs (30d)
16

Description

**Describe the enhancement**
Right now PyCue uses and expects a mix of protobuf objects and wrapper objects. This is confusing to use as an api since it's not clear when to use the protobuf object vs the wrapper. Once #337 is in place we should standardize on only passing and returning the wrapper objects.

**Screenshots**
None

**Version Number**
0.2.31

**Additional context**
Dependent on #337

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the PyCue API and the dependent #337 change to understand the wrapper objects and protobuf objects currently exposed. Trace the public paths that pass or return each kind of object, then verify that the completed work consistently uses wrapper objects only and no longer exposes protobuf objects.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.