feat: Improve ScoreAnalysis debug information

[zepfred]

This pull request adds a summary logic to the ScoreAnalysis and ConstraintAnalysis classes. Additionally, it synchronizes the API of the Python _score_analysis.py with the Java classes.

[zepfred]

@triceo I created a new pull request because the branch was renamed to run the tests correctly. Your comments from #102 have been addressed.

[Christopher-Chianelli]

• Do not use method names as attribute names
• Do not add additional dependencies

[Christopher-Chianelli]

I opt for removing indicted_object_list, since it just a rename of indicted_objects.

[zepfred]

@Christopher-Chianelli @triceo, do we all agree to use the summarize as a method?

def assert_score_analysis_summary(score_analysis: ScoreAnalysis):
    summary = score_analysis.summarize()
    ...
    match = score_analysis.constraint_analyses[0]
    match_summary = match.summarize()
    ...

[Christopher-Chianelli]

@triceo summary property or summarize method?

• match.summary is more pythonic than match.summarize(), but slightly deviates from the Java name.

I vote for summary.

[triceo]

@Christopher-Chianelli My rationale for summarize is that this isn't actually an accessor for a property, it is not a constant - in that case, arguably summary would be correct. But summarize is a method that computes a result when it is called, which I think warrants the different name. IMO it has nothing to do with Python or Java.

Are you telling me that in Python, they don't actually make a distinction between methods and properties, even though they clearly have those constructs?

[triceo]

I give up. This is not worth the time we already spent on it.

@zepfred, please, change it back to summary and make it a property. I'm sorry for this.

[triceo]

I was deleting one of my comments and accidentally deleted yours, @Christopher-Chianelli. My apologies, was not intentional.

[Christopher-Chianelli]

No worries @triceo

[Christopher-Chianelli]

API looks good, I would change the IndexError to a ValueError; IndexError are typically used for invalid indexes, whereas ValueError are used for invalid values.

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarCloud

[Christopher-Chianelli]

@zepfred Please state clearly when a PR depends on another PR; in particular, this PR shouldn't have been merged before TimefoldAI/timefold-solver#923

[zepfred]

@zepfred Please state clearly when a PR depends on another PR; in particular, this PR shouldn't have been merged before TimefoldAI/timefold-solver#923

Understood!