change STACTypeError to create short informative message

[ircwaves]

Related Issue(s):

• pystac-client#130

Description:

This creates a standardized message (which doesn't blow out the console) for STACTypeErrors.

PR Checklist:

• pre-commit hooks pass locally
• Tests pass (run scripts/test)
• Documentation has been updated to reflect changes, if applicable
• This PR maintains or improves overall codebase code coverage.
• Changes are added to the CHANGELOG. See the docs for information about adding to the changelog.

[codecov]

Codecov Report

Patch coverage: 100.00% and project coverage change: +0.03 🎉

Comparison is base (e196e50) 90.38% compared to head (b9b6346) 90.42%.

❗ Current head b9b6346 differs from pull request most recent head e988e24. Consider uploading reports for the commit e988e24 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1126      +/-   ##
==========================================
+ Coverage   90.38%   90.42%   +0.03%     
==========================================
  Files          48       48              
  Lines        6367     6330      -37     
  Branches      947      941       -6     
==========================================
- Hits         5755     5724      -31     
+ Misses        431      428       -3     
+ Partials      181      178       -3     

Impacted Files	Coverage Δ
pystac/catalog.py	93.33% <100.00%> (+0.42%)	⬆️
pystac/collection.py	95.40% <100.00%> (+0.64%)	⬆️
pystac/errors.py	100.00% <100.00%> (ø)
pystac/item.py	93.59% <100.00%> (+0.77%)	⬆️
pystac/item_collection.py	91.54% <100.00%> (ø)
pystac/serialization/identify.py	90.90% <100.00%> (ø)

... and 2 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[ircwaves]

Adjustments made.

[gadomski]

So this is a little annoying, but the Catalog.from_file error message isn't quite what I'd expect. Code (run from root):

from pathlib import Path

from pystac import Catalog

path = (
    Path(__file__).parent
    / "tests"
    / "data-files"
    / "catalogs"
    / "invalid-catalog"
    / "catalog.json"
)
Catalog.from_file(str(path))

results in

pystac.errors.STACTypeError: JSON (id = broken_cat) does not represent a STACObject instance.

It's way better than it was, but the best text would end with "...a Catalog instance". Is there any way to get the "final" class type into the message in those STACObject alternate-constructor methods?

[ircwaves]

It's way better than it was, but the best text would end with "...a Catalog instance". Is there any way to get the "final" class type into the message in those STACObject alternate-constructor methods?

I thought that there was only one case where that should happen, and not that one. Let me take a look.