Support version field in SearchClient.post_search()
#1079
Conversation
m1yag1
requested review from
aaschaer,
ada-globus,
derek-globus,
kurtmckee,
MaxTueckeGlobus and
sirosen
as code owners
* Added ignore for `SearchQuery` in pyproject.toml filterwarnings for pytest * Updated SphinxDocs for `SearchQueryV1` * Added `SearchQueryV1` to the _generate_init.py script * Added `SearchQueryV1` class for new v1 search request version * Added deprecation warning to the `SearchQuery` class during init * Added unit and functional tests for `SearchQueryV1` Co-authored-by: MaxTueckeGlobus <[email protected]>
m1yag1
force-pushed
the
sc-35200-version-field-post-search
branch
from
39acb8f
to
2c9df56
Compare
changelog.d/20241011_113822_8730430+m1yag1_sc_35200_version_field_post_search.rst
Outdated
Show resolved
Hide resolved
changelog.d/20241011_113822_8730430+m1yag1_sc_35200_version_field_post_search.rst
Outdated
Show resolved
Hide resolved
changelog.d/20241011_113822_8730430+m1yag1_sc_35200_version_field_post_search.rst
Outdated
Show resolved
Hide resolved
…eld_post_search.rst Co-authored-by: Stephen Rosen <[email protected]>
…eld_post_search.rst Co-authored-by: Stephen Rosen <[email protected]>
|
@sirosen I believe I've taken care of all the comments except the test updates for |
| :param advanced: Whether to enable (``True``) or not to enable (``False``) advanced | ||
| parsing of query strings. The default of ``False`` is robust and guarantees that | ||
| the query will not error with "bad query string" errors | ||
| :param additional_fields: additional data to include in the query document |
There was a problem hiding this comment.
I'm a little surprised that pylint is passing, given that we have some undocumented parameters. Maybe I need to look at its settings for __init__... Regardless, we need param doc for filters, etc. It should be pretty short and easy to add.
There was a problem hiding this comment.
pylint catches that? PyCharm notifies me about parameter mismatches in docstrings but I haven't spotted that in other linters.
There was a problem hiding this comment.
Well, it's supposed to, under our config:
[tool.pylint]
load-plugins = ["pylint.extensions.docparams"]
accept-no-param-doc = "false"
[tool.pylint."messages control"]
disable = [ # simplified -- we have other disabled rules
"missing-raises-doc",
]But I'm guessing that it doesn't understand that the class docstring applies to the init method. Maybe it's configurable and we can fix it.
|
@sirosen no worries! I've pushed updates for the last review comment on sort. |
https://app.shortcut.com/globus/story/35200/python-sdk-support-version-field-in-searchclient-post-search
Summary of changes
SearchQueryin pyproject.toml filterwarnings for pytestSearchQueryV1SearchQueryV1to the _generate_init.py scriptSearchQueryV1class for new v1 search request versionSearchQueryclass during initSearchQueryV1andSearchQuerydeprecation warnings.📚 Documentation preview 📚: https://globus-sdk-python--1079.org.readthedocs.build/en/1079/