15.2.99. camcops_server.cc_modules.cc_client_api_helpers

camcops_server/cc_modules/cc_client_api_helpers.py

Copyright (C) 2012, University of Cambridge, Department of Psychiatry. Created by Rudolf Cardinal (rnc1001@cam.ac.uk).

This file is part of CamCOPS.

CamCOPS is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

CamCOPS is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with CamCOPS. If not, see <https://www.gnu.org/licenses/>.

Additional helper functions used by the client (tablet device) API and the webview for special features.

camcops_server.cc_modules.cc_client_api_helpers.upload_commit_order_sorter(x: sqlalchemy.sql.schema.Table) → Tuple[bool, bool, bool, str][source]

Function to sort tables for the commit phase of the upload.

  • “patient” must come before “patient_idnum”, since ID number indexing looks at the associated Patient.

  • All of “patient”, “blobs”, and all ancillary tables must come before task tables, because task indexes depend on tasks correctly retrieving their subsidiary information to determine their camcops_server.cc_modules.cc_task.Task.is_complete() status. (However, even though ancillary tables can refer to BLOBs, as long as both are complete before the task tables are examined, their relative order doesn’t matter.)

  • Task tables come last.

Parameters

x – an SQLAlchemy Table

Returns

a tuple suitable for use as the key to a sort() or sorted() operation

Note that False sorts before True, and see https://stackoverflow.com/questions/23090664/sorting-a-list-of-string-in-python-such-that-a-specific-string-if-present-appea.