Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates to StacIO #471

Merged
merged 6 commits into from
Jun 24, 2021
Merged

Conversation

duckontheweb
Copy link
Contributor

@duckontheweb duckontheweb commented Jun 23, 2021

Related Issue(s):

Description:

  • Makes "private" StacIO._json_dumps method into a "public" StacIO.json_dumps and updates the signature to accept arbitrary keyword arguments instead of specifically accepting a source argument (see StacIO._json_dumps requires unused argument #467).
  • Refactors error reporting logic for DuplicateKeyReportingMixin.read_json and DuplicateKeyReportingMixin.json_loads so that we do not need to pass the source into json_loads. Also adds test coverage for this class.
  • Adds all exception classes to API docs
  • Moves DuplicateObjectKeyError into pystac.errors
  • Updates the API docs for the stac_io classes as well as the "Using STAC_IO" section in the "Concepts" docs

PR Checklist:

  • Code is formatted (run pre-commit run --all-files)
  • 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.

@duckontheweb duckontheweb changed the title Fix/gh 467 json dumps Updates to StacIO Jun 23, 2021
@duckontheweb duckontheweb force-pushed the fix/gh-467-json-dumps branch from de3e392 to 2519e03 Compare June 24, 2021 02:48
@codecov-commenter
Copy link

Codecov Report

Merging #471 (2519e03) into main (13a9fad) will increase coverage by 0.17%.
The diff coverage is 96.55%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #471      +/-   ##
==========================================
+ Coverage   91.48%   91.66%   +0.17%     
==========================================
  Files          40       40              
  Lines        5240     5245       +5     
==========================================
+ Hits         4794     4808      +14     
+ Misses        446      437       -9     
Impacted Files Coverage Δ
pystac/__init__.py 100.00% <ø> (ø)
pystac/stac_io.py 82.75% <96.29%> (+5.56%) ⬆️
pystac/errors.py 90.00% <100.00%> (+1.11%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 13a9fad...2519e03. Read the comment docs.

@lossyrob lossyrob merged commit 3f82170 into stac-utils:main Jun 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

StacIO._json_dumps requires unused argument Update I/O documentation
4 participants