Add Better Handling for Generated Descriptions

[johnwalz97]

Internal Notes for Reviewers

External Release Notes

[juanmleng]

Awesome :)

[cachafla]

@juanmleng is this PR ready to merge?

[juanmleng]

@juanmleng is this PR ready to merge?

Yes :)

[github-actions]

PR Summary

This pull request introduces several enhancements and refactorings to the TestResult class and related components:

1. Lazy Loading of Descriptions: The __getattribute__ method has been overridden to lazily load the description attribute if it is a DescriptionFuture. This ensures that the description is only generated when accessed, improving performance by deferring computation until necessary.

2. Refactoring of __post_init__: The __post_init__ method has been moved to ensure that ref_id is initialized correctly if it is None.

3. Reintroduction of test_name Property: The test_name property has been reintroduced to provide a test name using a custom title if available, or defaulting to a name derived from result_id.

4. Removal of Redundant Code: Redundant code related to the handling of DescriptionFuture in to_widget and log_async methods has been removed, as this logic is now handled by the lazy loading mechanism.

5. Code Cleanup: Unused imports and commented-out code have been removed to improve code readability and maintainability.

Test Suggestions

• Test lazy loading of the description to ensure it is only generated when accessed.
• Verify that ref_id is correctly initialized in __post_init__ when it is None.
• Test the test_name property to ensure it returns the correct name based on the presence of a custom title.
• Ensure that the removal of redundant code does not affect the functionality of to_widget and log_async methods.
• Check for any performance improvements due to lazy loading of descriptions.