Create load_data and load_schema APIs [RHELDST-4862] #19
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
crungehottman
force-pushed
the
RHELDST-4863
branch
from
f9972d4
to
b112aeb
Compare
rohanpm
requested changes
Feb 2, 2021
crungehottman
force-pushed
the
RHELDST-4863
branch
from
b112aeb
to
51507d3
Compare
crungehottman
changed the title
crungehottman
force-pushed
the
RHELDST-4863
branch
2 times, most recently
from
b3cd75e
to
90df90a
Compare
crungehottman
commented
Feb 3, 2021
rohanpm
requested changes
Feb 3, 2021
crungehottman
force-pushed
the
RHELDST-4863
branch
from
90df90a
to
4d85878
Compare
rohanpm
previously approved these changes
Feb 4, 2021
crungehottman
force-pushed
the
RHELDST-4863
branch
2 times, most recently
from
fc33bef
to
29e374d
Compare
rohanpm
requested changes
Feb 7, 2021
Well, progress on release-engineering/exodus-lambda#116 and merging of https://gitlab.cee.redhat.com/cdn/cdn-definitions-private/-/merge_requests/6 will be blocked until a new release of cdn-definitions lands in PyPI. I still need to add the schemas (etc) though, and I don't want to burden you (? I don't think I can release this) with several releases, so I will add the schemas first--I think the release can wait until the schemas have been merged. |
crungehottman
force-pushed
the
RHELDST-4863
branch
from
d3e99c2
to
a9239a0
Compare
rohanpm
reviewed
Feb 8, 2021
rohanpm
previously approved these changes
Feb 8, 2021
crungehottman
force-pushed
the
RHELDST-4863
branch
from
a9239a0
to
a21c4d8
Compare
|
Sorry, @nathanegillett @lipoja - I neglected to CC you here earlier. Again, I cannot add either of you as a reviewer. |
negillett
previously approved these changes
Feb 12, 2021
The load_schema API allows clients to more easily consume the schema.json file that is included in the cdn-definitions package. The load_data API will return a raw dictionary of the chosen data file. This will allow users to access various types of data in a uniform way. In order to encourage a single, consistent method of access to the cdn-definitions data, the legacy access methods and related classes (i.e., PathAlias, rhui_alias, and origin_alias) will be deprecated. A dedicated Python object will no longer need to be created for each new addition to the schema. The load_data API also includes an optional "source" argument to the load_data method. The source parameter allows the user to specify the source of the cdn_definitions JSON or YAML data file. The source could be a URL or a local path in a directory tree. If a source is not specified, the location may be overriden via the CDN_DEFINITIONS_PATH environment variable, which also may either be in the form of a URL or a local path. If neither a source is specified, nor a CDN_DEFINITIONS_PATH environment variable is set, the data.yaml file included in the cdn-definitions package will be used as a source. If that file is unavailable, load_data will attempt to load data from /usr/share/cdn-definitions/data.yaml. If all of the sources are invalid, a RuntimeError will be thrown.
crungehottman
force-pushed
the
RHELDST-4863
branch
from
a21c4d8
to
ea404ab
Compare
rohanpm
approved these changes
Feb 15, 2021
negillett
approved these changes
Feb 15, 2021
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.
The load_schema API allows clients to more easily consume the
schema.json file that is included in the cdn-definitions package.
The load_data API will return a raw dictionary of the chosen data
file. This will allow users to access various types of data in a
uniform way.
In order to encourage a single, consistent method of access to
the cdn-definitions data, the legacy access methods and related
classes (i.e., PathAlias, rhui_alias, and origin_alias) will be
deprecated. A dedicated Python object will no longer need to be
created for each new addition to the schema.
The load_data API also includes an optional "source" argument to
the load_data method. The source parameter allows the user to
specify the source of the cdn_definitions JSON or YAML data file.
The source could be a URL or a local path in a directory tree.
If a source is not specified, the location may be overriden via the
CDN_DEFINITIONS_PATH environment variable, which also may either
be in the form of a URL or a local path.
If neither a source is specified, nor a CDN_DEFINITIONS_PATH
environment variable is set, the data.yaml file included in the
cdn-definitions package will be used as a source. If that file is
unavailable, load_data will attempt to load data from
/usr/share/cdn-definitions/data.yaml. If all of the sources are
invalid, a RuntimeError will be thrown.