protocolbuffers/protobuf

Pass key-value pairs into Struct constructor in python

Open

#12,809 opened on May 15, 2023

View on GitHub
 (5 comments) (0 reactions) (0 assignees)C++ (16,128 forks)batch import
help wanted

Repository metrics

Stars
 (71,223 stars)
PR merge metrics
 (Avg merge 2d 11h) (185 merged PRs in 30d)

Description

What language does this apply to? python

Describe the problem you are trying to solve. When we initialise a Struct and want to set key-value pair on the struct, there are two steps:

struct = Struct()
struct.update(key1='value-1', key2=2)

Alternatively, we can also use json_format.ParseDict.

Describe the solution you'd like Hopefully, we can do the following:

struct = Struct(fields={'key1': 'value-1, 'key2: 2})
# or 
struct = Struct({'key1': 'value-1, 'key2: 2})

Describe alternatives you've considered

Additional context Add any other context or screenshots about the feature request here.

Contributor guide

Research direction
Modify the Struct class in python/google/protobuf/internal/well known types.py to accept a fields dictionary in init and call self.update(fields). Ensure consistency with json format.ParseDict.
Tech stack
python
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Pythonprotobuf
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75