Update Key API to be more user-friendly per design doc discussion

Related ~~to #3 and~~
https://docs.google.com/document/d/1xKw8Tz6lfN5uOcv0my4uUgFSeDoRzwCLho2UGlBpqDU/edit

Plan to make this work:

Remove Key.from_path (since will be new constructor) (Address first part of 451: Remove Key.from_path #456)
Remove all setters (Address second part of 451: Remove all setters and make attrs into @property #458)
Make parent re-use an instance (since immutable) (Address third part of 451: Storing Key.parent on instance for future calls #459)
Make Key constructor act like Key.from_path (Address fourth part of 451: Make Key constructor easier to use by taking positional args. #460)
Make Key.complete_key method (needs better name) to act like Key.id(new_id) (Address fifth part of 451: Implement Key.complete_key for auto_id on partial keys. #461)
Implement Key.compare_to_proto to check a key against a retrieved key (needs better name) (Address sixth part of 451: Implement Key.compare_to_proto to check pb keys against existing. #462)
Require dataset_id on Key (may require removing dataset_id from `Key protos) (Address seventh part of 451: Make dataset_id required on Key. #463)
Add parent to constructor (Address eighth part of 451: Add parent to constructor #476)
~~Update docstrings and other docs to reflect changes (including __repr__, probably shouldn't have path)~~ (Putting off bulk doc fixes until API is stable again)
~~Change Entity constructor to only accept a key. (This can probably move to a new bug, which I have yet to file.)~~ (filed Remove dataset from Entity constructor and allow a key #484)

Remove Key.from_path and derivative uses.

Making all attributes on Key read-only and sorts out use of setters.

Making Key.parent return the same instance on return calls.

Make Key constructor easier to use by taking positional args.

Implement Key.complete_key for auto_id on partial keys.

UPDATE: Not necessary since Key.compare_to_proto was removed.

We should probably also move

        for element in protobuf.path_element:
            key_part = {}
            for descriptor, value in element._fields.items():
                key_part[descriptor.name] = value
            path.append(key_part)

(repeated in Key.compare_to_proto, helpers.key_from_protobuf and test_entity._Key.compare_to_proto) into it's own method.

Implement Key.compare_to_proto to check pb keys against existing.

Make dataset_id required on Key.

Remove Key.from_path and derivative uses.

Making all attributes on Key read-only and sorts out use of setters.

Making Key.parent return the same instance on return calls.

chore: update release_level in repo-metadata.json (#451)

tests: harden instance admin systests vs timeout / 503 (#453)

Release version bump (#451)

feat: Add grpc Compression argument to channels and methods (#451)

chore: store artifacts in placer (#451)

chore: [autoapprove] bump cryptography from 41.0.3 to 41.0.4 (#451)

tests: fix tests on main (#452)

chore(deps): update dependency google-cloud-bigquery to v2.31.0 (#451)

fix: fix `NotImplementedError` for `get_or_insert` inside a transacti…

chore(deps): update dependency google-cloud-bigquery to v2.31.0 (#451)

fix: only add IAM scope to credentials that can change scopes (#451)

chore(deps): update dependency backoff to v1.11.1 (#451)

chore(main): release 2.7.2 (#451)

chore(deps): update dependency pygments to v2.18.0 (#451)

feat: add support for Etag headers on reads (#489)

Navigation Menu

Repository navigation

Update Key API to be more user-friendly per design doc discussion #451

33 remaining items

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Update Key API to be more user-friendly per design doc discussion #451

Description

Activity

dhermes commented on Dec 23, 2014

33 remaining items

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions