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

Metadata Typing #80

Merged
merged 10 commits into from
Mar 1, 2021
Merged

Metadata Typing #80

merged 10 commits into from
Mar 1, 2021

Conversation

ric-evans
Copy link
Member

  • added schema/types.py containing metadata type hints
    • this can be used by clients (aka the indexer)
    • this could allow validation.py to validate metadata using introspection (future)
  • moved validation.py to schema/validation.py

@ric-evans ric-evans requested a review from dsschult March 1, 2021 18:23
@ric-evans ric-evans self-assigned this Mar 1, 2021
Copy link
Collaborator

@dsschult dsschult left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Type information generally looks good. I guess one question is how to fit the rest of the columns in the metadata doc.

# /data/exp/* i3 File:
software: Optional[List[SoftwareEntry]]
run: Run
offline_processing_metadata: OfflineProcessingMetadata
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we really using such a long name?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup, I think this is the longest name

@ric-evans
Copy link
Member Author

ric-evans commented Mar 1, 2021

Type information generally looks good. I guess one question is how to fit the rest of the columns in the metadata doc.

We can put each description as an inline comment. For whether the key is required, that would need to be an independent dict.

@ric-evans
Copy link
Member Author

Type information generally looks good. I guess one question is how to fit the rest of the columns in the metadata doc.

We can put each description as an inline comment. For whether the key is required, that would need to be an independent dict.

We could really go all out and duplicate/migrate the Google Doc into a dict/yaml. But this is beyond the scope of this PR

@dsschult
Copy link
Collaborator

dsschult commented Mar 1, 2021

Type information generally looks good. I guess one question is how to fit the rest of the columns in the metadata doc.

We can put each description as an inline comment. For whether the key is required, that would need to be an independent dict.

We could really go all out and duplicate/migrate the Google Doc into a dict/yaml. But this is beyond the scope of this PR

Fair enough.

@ric-evans
Copy link
Member Author

Type information generally looks good. I guess one question is how to fit the rest of the columns in the metadata doc.

We can put each description as an inline comment. For whether the key is required, that would need to be an independent dict.

We could really go all out and duplicate/migrate the Google Doc into a dict/yaml. But this is beyond the scope of this PR

Fair enough.

#81

@ric-evans ric-evans merged commit 52e7671 into master Mar 1, 2021
@ric-evans ric-evans deleted the metadata-typing branch March 1, 2021 19:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants