15.2.96. camcops_server.cc_modules.cc_dataclasses

camcops_server/cc_modules/cc_dataclasses.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/>.


Dataclasses.

class camcops_server.cc_modules.cc_dataclasses.SummarySchemaInfo(table_name: str, source: str, column_name: str, data_type: str, comment: str)[source]

Information to be given to the user about the schema for spreadsheet-style downloads, including database and summary columns.

__init__(table_name: str, source: str, column_name: str, data_type: str, comment: str) None
property as_dict: Dict[str, str]

Used to create spreadsheet rows. Maps spreadsheet headings to values.

classmethod from_column(column: Column, table_name: str = '', source: str = '', column_name_prefix: str = '') SummarySchemaInfo[source]

Create from an SQLAlchemy column.

classmethod from_summary_element(table_name: str, element: SummaryElement, source: str = '', column_name_prefix: str = '') SummarySchemaInfo[source]

Create from a camcops_server.cc_modules.cc_summaryelement.SummarySchemaInfo.