fix: make AccessEntry equality consistent with from_api_repr

[drokeye]

Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

• Ensure the tests and linter pass
• Code coverage does not decrease (if any source code was changed)

Fixes#2217 🦕

🐛 Bug Fix: AccessEntry equality for "view" entity

This PR fixes a bug where two AccessEntry instances representing the same view would not compare as equal:

AccessEntry(entity_type="view", entity_id={"projectId": ..., ...}) !=AccessEntry.from_api_repr({...})

✅ Summary of Changes

• Updated the __eq__ method in AccessEntry to correctly handle entity_type="view" by normalizing the nested dictionary in entity_id.
• Added a new unit test test_access_entry_view_equality in tests/unit/test_dataset.py to assert correctness of equality logic for views.
• Ensured compatibility with existing functionality and from_api_repr consistency.

[google-cla]

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

[Linchin]

The normalization here may not work if there's nested dictionaries, and it might happen, for example here. The most reliable way might be using json.dumps() with sort_keys=True.

[drokeye]

Hey @Linchin — thanks for pointing that out.

You're absolutely right that dict(sorted(...)) won't handle deeply nested dictionaries reliably. In this case though, I tested equality on AccessEntry objects with view, routine, and dataset entity types — including nested structures like the one in dataset. The current approach passed all assertions in the test, and it seems to hold up.

Totally agree that json.dumps(..., sort_keys=True) would be the most robust and reliable method. I will change it right now👍

For reference, here’s the test case I used:

deftest_access_entry_view_equality(self):
fromgoogle.cloudimportbigqueryentry1=bigquery.dataset.AccessEntry(
entity_type="view",
entity_id={
"projectId": "my_project",
"datasetId": "my_dataset",
"tableId": "my_table",
},
)
entry2=bigquery.dataset.AccessEntry.from_api_repr({
"view": {
"projectId": "my_project",
"datasetId": "my_dataset",
"tableId": "my_table",
}
})
entry3=bigquery.dataset.AccessEntry(
entity_type="routine",
entity_id={
"projectId": "my_project",
"datasetId": "my_dataset",
"routineId": "my_routine",
},
)
entry4=bigquery.dataset.AccessEntry.from_api_repr({
"routine": {
"projectId": "my_project",
"datasetId": "my_dataset",
"routineId": "my_routine",
}
})
entry5=bigquery.dataset.AccessEntry(
entity_type="dataset",
entity_id={
"dataset": {
"projectId": "my_project",
"datasetId": "my_dataset",
},
"target_types": "VIEWS",
},
)
entry6=bigquery.dataset.AccessEntry.from_api_repr({
"dataset": {
"dataset": {
"projectId": "my_project",
"datasetId": "my_dataset",
},
"target_types": "VIEWS",
}
})
entry7=bigquery.dataset.AccessEntry(
entity_type="dataset",
entity_id={ "dataset": {
"location": {
"region": {
"zone": "asia-south1-a",
"subzone": "primary"
},
"country": "IN"
},
"datasetId": "my_dataset"
},
"target_types": "VIEWS"
},
)
entry8=bigquery.dataset.AccessEntry.from_api_repr({
"dataset": {
"target_types": "VIEWS",
"dataset": {
"datasetId": "my_dataset",
"location": {
"country": "IN",
"region": {
"subzone": "primary",
"zone": "asia-south1-a"
}
}
}
}
})
assertentry1==entry2assertentry3==entry4assertentry5==entry6assertentry7==entry8

[Linchin]

Thanks for making the change, I guess all test cases passed because we didn't juggle the order of items in the nested dictionary :)

[Linchin]

The lint test is failing, could you run nox -r -s lint in the root folder to fix it? Thanks

[drokeye]

Fixed it, should be fine now!

[Linchin]

I think there's more linting we need to fix

[drokeye]

nox -r -s lint fails locally due to a flake8 error in docs/samples, which contains non-python or partial files.

Not related to the code changes in this PR. I ran a session with commenting the session.run("flake8", os.path.join("docs", "samples")) from noxfile.py and everything seems fine👍🏻