B b%@srdZddlmZdZdZdZdZddlZddlZddl m Z dd l m Z dd l m Z eeZGd d d e ZdS) z Validate.py ^^^^^^^^^^ API for wwPDB Validation Web Service :copyright: @wwPDB :license: Apache 2.0, see LICENSE file for more details. Updates: 3-Aug-2016 jdw add Authorization header 20-Sep-2016 jdw refactor for standard packaging )unicode_literalszrestructuredtext enzJohn Westbrookzjwest@rcsb.rutgers.eduz Apache 2.0N) __version__) __apiUrl__)ApiBasecseZdZd*fdd ZddZdd Zd d Zd d ZddZddZ ddZ ddZ ddZ ddZ ddZddZddZd d!Zd"d#Zd$d%Zd&d'Zd(d)ZZS)+ValidateNonedep_error_flagonedep_status_textcs|r|nt}|r|nd}dttjdf}d}tt|j||||dddgdgdgdgd gd gd gd gd gdgd gdgdgdgd}|||j ||ddS)ay OneDep validation webservice client API :param string apiKey: (Optional) security token. :param string apiUrl: (Optional) alternative API server URL. :param string errorFlagKey: (Optional) key for error flag in service return dictionary :param string statusTextKey: (Optional) key for status text in service return dictionary Z anonymouszOneDepClient/%s Python/%s rZvalwsF)apiKey userAgentapiNameapiUrlZverifypdbxanyznmr-starmapZpdfZxmlZtxtZsvg)modelzstructure-factorsznmr-chemical-shiftsznmr-restraintsz nmr-data-nefz nmr-data-strz em-volumezvalidation-report-fullzvalidation-datazvalidation-data-cifzvalidation-report-logzvalidation-report-sliderzvalidation-report-2fo-map-coefzvalidation-report-fo-map-coef) errorFlagKey statusTextKeyN) rrsysversionsplitsuperr__init__ZsetContentTypesZsetApiReturnStatusKeys)selfr r rrr r ZvalContentTypes) __class__2lib/python3.7/site-packages/onedep/api/Validate.pyr+s*    zValidate.__init__cCs|S)zCreate a new OneDep service session. :rtype: json service response converted to dictionary (with mininal keys: api_error_flag, api_status_text, and session_id) )Z createSession)rrrr newSessionSszValidate.newSessioncCs|j|dddS)aInput file containing model coordinates in PDBx/mmCIF format. :param string pdbxFilePath: full path to the input data file :rtype: json service response converted to dictionary (with mininal keys: api_error_flag, api_status_text) rr )filePath contentType fileFormat) inputFile)r pdbxFilePathrrrinputModelXyzFile[szValidate.inputModelXyzFilecCs|j|dddS)a Input file containing structure factor amplitudes in PDBx/mmCIF format. :param string pdbxFilePath: full path to the input data file :rtype: json service response converted to dictionary (with mininal keys: api_error_flag, api_status_text) zstructure-factorsr )rrr)upload)rr!rrrinputStructureFactorFileesz!Validate.inputStructureFactorFilecCs|j|dddS)aInput file containing NMR chemical shift data in PDBx/mmCIF format. :param string pdbxFilePath: full path to the input data file :rtype: json service response converted to dictionary (with mininal keys: api_error_flag, api_status_text) znmr-chemical-shiftsr )rrr)r#)rr!rrrinputNmrChemicalShiftsFilensz#Validate.inputNmrChemicalShiftsFilecCs|j|dddS)zInput file containing NMR restraints data in NEF/STAR format. :param string nefFilePath: full path to the input data file :rtype: json service response converted to dictionary (with mininal keys: api_error_flag, api_status_text) znmr-restraintsZnef)rrr)r#)rZ nefFilePathrrrinputNmrRestraintswszValidate.inputNmrRestraintscCs|j|dddS)aInput file containing NMR Data conforming to NEF dictionary in NMRstar format. :param string nmrDataFilePath: full path to the input data file :rtype: json service response converted to dictionary (with mininal keys: api_error_flag, api_status_text) z nmr-data-nefznmr-star)rrr)r#)rnmrDataFilePathrrrinputNmrDataNefszValidate.inputNmrDataNefcCs|j|dddS)aInput file containing NMR Data conforming to NMRstar dictionary in NMRstar format. :param string nmrDataFilePath: full path to the input data file :rtype: json service response converted to dictionary (with mininal keys: api_error_flag, api_status_text) z nmr-data-strznmr-star)rrr)r#)rr'rrrinputNmrDataStarszValidate.inputNmrDataStarcCs|j|dddS)zInput file containing EM volume data in CCP4 map format. :param string ccp4MapFilePath: full path to the input data file :rtype: json service response converted to dictionary (with mininal keys: api_error_flag, api_status_text) z em-volumer)rrr)r#)rZccp4MapFilePathrrr inputEmVolumeszValidate.inputEmVolumecCs||||S)aAdd the input data file to the current session context. :param string filePath: full path to the input data file :param string contentType: a supported content type (e.g. model, structure factors, ...) :param string fileFormat: a supported format type (e.g. pdbx, map, ...) :rtype: json service response converted to dictionary (with mininal keys: api_error_flag, api_status_text) )r#)rrrrrrrr s zValidate.inputFilecCs |jddS)zReturn the service status for the current session. :rtype: json service response converted to dictionary (with mininal keys: status, api_error_flag, api_status_text) Zsession_status)endPoint)post)rrrr getStatusszValidate.getStatuscCs|j|ddS)a"Store the output validation report from the current session context in the specified output file path. :param string filePath: full path to the output file :rtype: json service response converted to dictionary (with mininal keys: api_error_flag, api_status_text) zvalidation-report-full)dstPathr)downloadByType)rrrrr getReportszValidate.getReportcCs|j|ddS)a%Store the output validation data file from the current session context in the specified output file path. :param string filePath: full path to the output file :rtype: json service response converted to dictionary (with mininal keys: api_error_flag, api_status_text) zvalidation-data)r.r)r/)rrrrr getReportDataszValidate.getReportDatacCs|j|ddS)a+Store the mmCif output validation data file from the current session context in the specified output file path. :param string filePath: full path to the output file :rtype: json service response converted to dictionary (with mininal keys: api_error_flag, api_status_text) zvalidation-data-cif)r.r)r/)rrrrrgetReportDataMmCifszValidate.getReportDataMmCifcCs|j|ddS)a Store the output session log file from the current session context in the specified output file path. :param string filePath: full path to the output file :rtype: json service response converted to dictionary (with mininal keys: api_error_flag, api_status_text) zvalidation-report-log)r.r)r/)rrrrr getReportLogszValidate.getReportLogcCs|j||dS)adStore the output file containing 'contentType' from the current session context in the specified output file path. :param string filePath: full path to the output file :param string contentType: target contentType :rtype: json service response converted to dictionary (with mininal keys: api_error_flag, api_status_text) )r.r)r/)rrrrrrgetOutputByTypeszValidate.getOutputByTypecCs |jddS)zReturn a catalog of the data content of the current session. :rtype: json service response converted to dictionary (catalog plus keys - api_error_flag, api_status_text, index) Z session_index)r+)r,)rrrrgetIndexszValidate.getIndexcCs |jddS)zReturn a summary service activity for the current service user. :rtype: json service response converted to dictionary (catalog plus keys - api_error_flag, api_status_text, activity_summary) Zactivity)r+)r,)rrrr getActivityszValidate.getActivitycKs|jfddi|S)zSubmit request to run the validation suite using the current session data file content. :rtype: json service response converted to dictionary (with mininal keys: api_error_flag, api_status_text) r+Zvalidate_request)r,)rparamsrrrrunsz Validate.run)NNrr)__name__ __module__ __qualname__rrr"r$r%r&r(r)r*r r-r0r1r2r3r4r5r6r8 __classcell__rr)rrr*s&(             r)__doc__Z __future__rZ __docformat__ __author__Z __email__Z __license__ZloggingrZonedeprrZonedep.utils.ApiBaserZ getLoggerr9logrrrrrs