[SYNPY-1575] Introduce EntityView model

[BryanFauble]

Problem:

1. The FileView aka EntityView was not created in an OOP fashion.
2. There are a number of small bugs that I found while implementing this feature related to the work done in [SYNPY-1571] Adds Dataset Model & Introduces Composition Model for Table/View-like Classes #1175 and more generally the Table refactor: [SYNPY-1551] Tables refactor #1151

Solution:

1. Creating a EntityView model based on this Synapse object: https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/table/EntityView.html
2. Support the functionality for Views to be able to interact with the EntityViews
3. Creating a tutorial and doc pages for the EntityView
4. Patching an issue with re-ordering of Columns that I had found in testing. Essentially the problem is what when an existing View was stored the default columns were being ordered to the front of the table. To patch this issue I moved where default columns are being added to the .columns attribute to be after we get the existing object state from Synapse.
5. Moving the async job to use the TQDM progress bar to prevent it from being printed out the console.
6. Creating method wrappers in the EntityView class to allow for specific examples for that class type to be shown.

Testing:

1. I wrote a number of integration tests to verify the async and non-async functionality.
2. I wrote a tutorial that showcases how to use this EntityView model
3. I ran through a significant amount of testing during development to verify functionality to creating, updating, adding, removing, data and columns

[BryanFauble]

@BWMac This could use a final review when you get a chance this week. Thanks in advance!

[thomasyu888]

Interesting, how have these been resolved?

[BryanFauble]

It has not been explicitly fixed, but a global retry mechanism was put in place after this was written.

[thomasyu888]

I may have missed this, but what happens when an entity view is created with the default columns specified?

[BryanFauble]

If you are specifying a column with the same name a warning is emitted and it is overwritten with the default column:

synapsePythonClient/synapseclient/models/mixins/table_components.py

Lines 517 to 541 in 181a364

	if self.include_default_columns:
	view_type_mask = None
	if self.view_type_mask:
	if isinstance(self.view_type_mask, ViewTypeMask):
	view_type_mask = self.view_type_mask.value
	else:
	view_type_mask = self.view_type_mask
	default_columns = await get_default_columns(
	view_entity_type=(
	self.view_entity_type if self.view_entity_type else None
	),
	view_type_mask=view_type_mask,
	synapse_client=synapse_client,
	)
	for default_column in default_columns:
	if (
	default_column.name in self.columns
	and default_column != self.columns[default_column.name]
	):
	client.logger.warning(
	f"Column '{default_column.name}' already exists in dataset. "
	"Overwriting with default column."
	)
	self.columns[default_column.name] = default_column

[thomasyu888]

🔥 LGTM! Awesome to see this work, I'll defer to brad for final review once he's back from vacay.

[BWMac]

LGTM! 🚀