[PT-5198] Workspace singleton

[andher1802]

Described Here

Adding workspace mixing to implement active record pattern

Items:

• Implemented (new) unit tests
• Updated documentation

For release:

• Bumped version
• Added changelog

[javidq]

Not needed

[andher1802]

Pylint is triggering an error if we do not add this. Alternative option is to set an ignore. :)

[javidq]

It means something is off, otherwise we would get the warning before as well

[andher1802]

After some research, I finally found what is off here.

We have changed the authenticate variable to store the method of a Class. It seems that before mypy was able to infer that there were Classes, and functions in the comprenhensive list and all of them have the __name__ property. Now, for some reason (perhaps the new typing, or some update of mypy that has changed since the latest commit that touch the init.py file) mypy is not able to do the same type infer than before.

Since the list contains a mix of classes, functions, and now the new authentication variable. mypy infers the most general type that can accommodate all elements, which is likely object. The object type in Python doesn't have a name attribute, leading to the error.

I figure out that splitting the assingment for Classes, and functions makes mypy happy and infers correctly the type.

I also tested this and it works as well:

__all__ = [
    Asset.__name__,
    Auth.__name__,
    Catalog.__name__,
    Order.__name__,
    Storage.__name__,
    Tasking.__name__,
    Webhook.__name__,
    get_example_aoi.__name__,
    read_vector_file.__name__,
    initialize_catalog.__name__,
    initialize_tasking.__name__,
    initialize_storage.__name__,
    initialize_order.__name__,
    initialize_asset.__name__,
    initialize_webhook.__name__,
    authenticate.__name__,
    get_webhooks.__name__,
    create_webhook.__name__,
    get_webhook_events.__name__,
    get_credits_balance.__name__,
] 

We can think of a cleaner solution, perharps assigning authenticate to a better type. I did some tests but I ended up splitting the assignment of the all property into Classes and functions.

[andher1802]

Is this a breaking change?
I ask because I see the version bumped was set to patch version instead of minor.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
95.7% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud