Issue 48298: Align API Filter Operators

[RosalineP]

Rationale

In the process of adding lineage filter operators to the APIs, I noticed a handful of inconsistencies I'm resolving across the APIs. See related pull requests.

Related Pull Requests

• Issue 48298: Align API Filter Operators #61
• Issue 48298: Align API Filter Operators labkey-api-js#157
• Issue 48298: Align API Filter Operators labkey-api-r#95
• Issue 48298: Align API Filter Operators labkey-api-java#60

Changes

• Add the following operators:
  • HAS_MISSING_VALUE
  • DOES_NOT_HAVE_MISSING_VALUE
  • Q
  • EXP_CHILD_OF
  • EXP_PARENT_OF
  • EXP_LINEAGE_OF
• Add comments delineating operator types to align with other APIs
• Rearrange ordering of operator types to align with other APIs
• Update Change.txt

[RosalineP]

Manual Test Plan

• HAS_MISSING_VALUE, DOES_NOT_HAVE_MISSING_VALUE

  • Ensure missing value indicators are properly configured. Doc link for convenience: https://www.labkey.org/Documentation/wiki-page.view?name=manageMissing
  • Create a List with a field in which the Advanced Setting 'Track reason for missing data values' is true
  • Populate list with both missing values and populated values
  • Execute and verify results:
    • api.query.select_rows("lists", <List Name>, filter_array=[QueryFilter(<Field Name>, "", QueryFilter.Types. HAS_MISSING_VALUE)])
    • api.query.select_rows("lists", <List Name>, filter_array=[QueryFilter(<Field Name>, "", QueryFilter.Types.DOES_NOT_HAVE_MISSING_VALUE)])

• Q

  • Create a list like the following:
  • Execute:
    • api.query.select_rows("lists", <List Name>, filter_array=[QueryFilter("Field2", "one", QueryFilter.Types.Q)])
  • Verify results against UI results at url ending in /list-grid.view?name=<List Name>&query.Field2~Q=one

• Lineage Filter Operators

  • Go into a SM folder

  • Create a sample type with no manually added fields

  • Create three samples, accepting defaults. Choose one of them (say it's S-3) and click 'Aliquot Selected', choosing two Aliquots per Parent, and accepting defaults for aliquot creation

  • Go to /query-executeQuery.view?schemaName=sampleManagement&query.queryName=SourceSamples and add the LSID column

  • QueryFilter.Types.EXP_LINEAGE_OF:

    • Execute:

    result = api.query.select_rows("sampleManagement", "SourceSamples", filter_array=[QueryFilter("lsid", '{json:[<LSID of     S-3>,10]}', QueryFilter.Types.EXP_LINEAGE_OF)])
    for row in result["rows"]:
        print(str(row['name']))
    

    • Verify results:
      • S-3-1
      • S-3-2

  • QueryFilter.Types.EXP_CHILD_OF:

    • Execute:

    result = api.query.select_rows("samples", <Sample Type Name>, filter_array=[QueryFilter("lsid", <LSID of S-3>, QueryFilter.Types.EXP_CHILD_OF)])
    for row in result["rows"]:
        print(str(row['Name']))
    

    • Verify results:
      • S-3-2
      • S-3-1

  • QueryFilter.Types.EXP_PARENT_OF:

    • Execute:

    result = api.query.select_rows("samples", <Sample Type Name>, filter_array=[QueryFilter("lsid", <LSID of S-3-1>, QueryFilter.Types.EXP_PARENT_OF)])
    for row in result["rows"]:
        print(str(row['Name']))
    

    • Verify results:
      • S-3

[labkey-alan]

Looks good to me. Please update the __init__.py with the correct version, and the CHANGE.txt file with the correct date when merging and ping me so I can issue a release.