Allow bson objects as job inputs, e.g. datetime.datetimes #375
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.
Summary
Adds the
allow_bson=True
kwarg to thejsanitize
invocation incontains_job_or_flow
utility function, and a corresponding test case. I recently tried to pass an object containing adatetime.datetime
in it as an input to a job (specifically, the object was an emmetTaskDoc
. This object was the output of another job (and I had retrieved it from the jobstore).I noticed that every other invocation of jsanitize in the codebase uses
allow_bson=True
, with the exception of the one inJob::as_dict
, so I concluded that this might be a bug. Please feel free to close if this behavior is intentional! However, I think it's useful to allow things likedatetime
s as inputs (at least to allow the use of TaskDocs as input parameters).Checklist
Work-in-progress pull requests are encouraged, but please put [WIP] in the pull request
title.
Before a pull request can be merged, the following items must be checked:
The easiest way to handle this is to run the following in the correct sequence on
your local machine. Start with running black on your new code. This will
automatically reformat your code to PEP8 conventions and removes most issues. Then run
pycodestyle, followed by flake8.
Run pydocstyle on your code.
type check your code.
Note that the CI system will run all the above checks. But it will be much more
efficient if you already fix most errors prior to submitting the PR. It is highly
recommended that you use the pre-commit hook provided in the repository. Simply
cp pre-commit .git/hooks
and a check will be run prior to allowing commits.