docs: 📝 add guide for Sprout checks #1024
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
martonvago
commented
Jan 29, 2025
| licenses=[sp.LicenseProperties(name="odc-pddl")], | ||
| resources=[sp.ResourceProperties()], | ||
| ) | ||
| pprint(sp.check_package_properties(package_properties)) |
There was a problem hiding this comment.
Ideally, I wouldn't even print the output, but then it just prints it unformatted
lwjohnst86
requested changes
Jan 31, 2025
Comment on lines
+156
to
+165
| | raise ExceptionGroup( | ||
| | ExceptionGroup: The following checks failed on the properties: | ||
| | PackageProperties(name='woolly-dormice', id='123-abc-123', title='Hibernation Physiology of the Woolly Dormouse: A Scoping Review.', description=None, homepage=None, version='1.0.0', created='2014-05-14T05:00:01+00:00', contributors=None, keywords=None, image=None, licenses=[LicenseProperties(name='odc-pddl', path=None, title=None)], resources=[ResourceProperties(name='woolly-dormice-2015', path='https://en.wikipedia.org/wiki/Woolly_dormouse', type=None, title='Body fat percentage in the hibernating woolly dormouse', description=None, sources=None, licenses=None, format=None, mediatype=None, encoding=None, bytes=None, hash=None, dialect=None, schema=None)], sources=None) (3 sub-exceptions) | ||
| +-+---------------- 1 ---------------- | ||
| | seedcase_sprout.core.checks.check_error.CheckError: Error at `$.description` caused by `required`: 'description' is a required property | ||
| +---------------- 2 ---------------- | ||
| | seedcase_sprout.core.checks.check_error.CheckError: Error at `$.resources[0].description` caused by `required`: 'description' is a required property | ||
| +---------------- 3 ---------------- | ||
| | seedcase_sprout.core.checks.check_error.CheckError: Error at `$.resources[0].path` caused by `pattern`: 'path' should contain the resource ID | ||
| +------------------------------------ |
There was a problem hiding this comment.
I would love to try to clean this up. I'm not a big fan of Python's error log 😒 Too much text and not that helpful/easy for beginners. We can get into that in the new check-datapackage package though.
There was a problem hiding this comment.
How the errors are printed is pretty easy to configure. I'm not too sure about the stack trace...
Comment on lines
+171
to
+185
| - "seedcase_sprout.core.checks.check_error.CheckError": the class | ||
| representing the error. Check functions will always throw | ||
| `CheckError`s. | ||
| - "Error at `$.resources[0].description`": the location of the error | ||
| in the properties object. `$` corresponds to the topmost layer of | ||
| the object (the root); `.resources` points to the `resources` field | ||
| of this layer; `[0]` indicates that the error is in the 0th (i.e. | ||
| the first, counting from 0) resource properties object; and | ||
| `.description` means that the `description` field of this resource | ||
| properties is at fault. | ||
| - "caused by `required`": the kind of requirement or expectation that | ||
| was violated. Here, the expectation is that the field should be | ||
| present (i.e. it is a required field). | ||
| - "'description' is a required property": a longer, human-readable | ||
| explanation of the error. |
| - "'description' is a required property": a longer, human-readable | ||
| explanation of the error. | ||
|
|
||
| ## Ignoring errors |
There was a problem hiding this comment.
This section could actually be it's own guide page, when we move it over into it's own package.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds a guide for checks in Sprout.
I wasn't sure what level of detail to go for, this is ~~medium.
Closes #859
This PR needs an in-depth review.
Checklist
just run-all