Datasets:

---

jqop

/

python-code-dataset

like 0

[ "def", "_check_filter_specific_tag", "(", "self", ",", "specific_tag", ":", "list", ")", ":", "if", "isinstance", "(", "specific_tag", ",", "list", ")", ":", "if", "len", "(", "specific_tag", ")", ">", "0", ":", "specific_tag", "=", "\",\"", ".", "join", "(", "specific_tag", ")", "else", ":", "specific_tag", "=", "\"\"", "else", ":", "raise", "TypeError", "(", "\"'specific_tag' expects a list\"", ")", "return", "specific_tag" ]

[ "Check", "if", "specific_tag", "parameter", "is", "valid", "." ]

[ "def", "_check_filter_includes", "(", "self", ",", "includes", ":", "list", ",", "resource", ":", "str", "=", "\"metadata\"", ")", ":", "# check resource parameter", "if", "resource", "==", "\"metadata\"", ":", "ref_subresources", "=", "_SUBRESOURCES_MD", "elif", "resource", "==", "\"keyword\"", ":", "ref_subresources", "=", "_SUBRESOURCES_KW", "else", ":", "raise", "ValueError", "(", "\"Must be one of: metadata | keyword.\"", ")", "# sub resources manager", "if", "isinstance", "(", "includes", ",", "str", ")", "and", "includes", ".", "lower", "(", ")", "==", "\"all\"", ":", "includes", "=", "\",\"", ".", "join", "(", "ref_subresources", ")", "elif", "isinstance", "(", "includes", ",", "list", ")", ":", "if", "len", "(", "includes", ")", ">", "0", ":", "includes", "=", "\",\"", ".", "join", "(", "includes", ")", "else", ":", "includes", "=", "\"\"", "else", ":", "raise", "TypeError", "(", "\"'includes' expect a list or a str='all'\"", ")", "return", "includes" ]

[ "Check", "if", "specific_resources", "parameter", "is", "valid", "." ]

[ "def", "_check_subresource", "(", "self", ",", "subresource", ":", "str", ")", ":", "warnings", ".", "warn", "(", "\"subresource in URL is deprecated.\"", "\" Use _include mecanism instead.\"", ",", "DeprecationWarning", ",", ")", "l_subresources", "=", "(", "\"conditions\"", ",", "\"contacts\"", ",", "\"coordinate-system\"", ",", "\"events\"", ",", "\"feature-attributes\"", ",", "\"keywords\"", ",", "\"layers\"", ",", "\"limitations\"", ",", "\"links\"", ",", "\"operations\"", ",", "\"specifications\"", ",", ")", "if", "isinstance", "(", "subresource", ",", "str", ")", ":", "if", "subresource", "in", "l_subresources", ":", "subresource", "=", "subresource", "elif", "subresource", "==", "\"tags\"", ":", "subresource", "=", "\"keywords\"", "logging", ".", "debug", "(", "\"'tags' is an include not a subresource.\"", "\" Don't worry, it has be automatically renamed \"", "\"into 'keywords' which is the correct subresource.\"", ")", "elif", "subresource", "==", "\"serviceLayers\"", ":", "subresource", "=", "\"layers\"", "logging", ".", "debug", "(", "\"'serviceLayers' is an include not a subresource.\"", "\" Don't worry, it has be automatically renamed \"", "\"into 'layers' which is the correct subresource.\"", ")", "else", ":", "raise", "ValueError", "(", "\"Invalid subresource. Must be one of: {}\"", ".", "format", "(", "\"|\"", ".", "join", "(", "l_subresources", ")", ")", ")", "else", ":", "raise", "TypeError", "(", "\"'subresource' expects a str\"", ")", "return", "subresource" ]

[ "Check", "if", "specific_resources", "parameter", "is", "valid", "." ]

[ "def", "_convert_md_type", "(", "self", ",", "type_to_convert", ":", "str", ")", ":", "if", "type_to_convert", "in", "FILTER_TYPES", ":", "return", "FILTER_TYPES", ".", "get", "(", "type_to_convert", ")", "elif", "type_to_convert", "in", "FILTER_TYPES", ".", "values", "(", ")", ":", "return", "[", "k", "for", "k", ",", "v", "in", "FILTER_TYPES", ".", "items", "(", ")", "if", "v", "==", "type_to_convert", "]", "[", "0", "]", "else", ":", "raise", "ValueError", "(", "\"Incorrect metadata type to convert: {}\"", ".", "format", "(", "type_to_convert", ")", ")" ]

[ "Metadata", "types", "are", "not", "consistent", "in", "Isogeo", "API", ".", "A", "vector", "dataset", "is", "defined", "as", "vector", "-", "dataset", "in", "query", "filter", "but", "as", "vectorDataset", "in", "resource", "(", "metadata", ")", "details", "." ]

[ "def", "version_cli", "(", "ctx", ",", "porcelain", ")", ":", "# type: (click.Context, bool) -> None", "if", "ctx", ".", "invoked_subcommand", ":", "return", "from", "peltak", ".", "core", "import", "log", "from", "peltak", ".", "core", "import", "versioning", "current", "=", "versioning", ".", "current", "(", ")", "if", "porcelain", ":", "print", "(", "current", ")", "else", ":", "log", ".", "info", "(", "\"Version: <35>{}\"", ".", "format", "(", "current", ")", ")" ]

[ "Show", "project", "version", ".", "Has", "sub", "commands", "." ]

[ "def", "bump_version", "(", "component", "=", "'patch'", ",", "exact", "=", "None", ")", ":", "# type: (str, str) -> None", "from", "peltak", ".", "core", "import", "log", "from", "peltak", ".", "core", "import", "versioning", "old_ver", ",", "new_ver", "=", "versioning", ".", "bump", "(", "component", ",", "exact", ")", "log", ".", "info", "(", "\"Project version bumped\"", ")", "log", ".", "info", "(", "\" old version: <35>{}\"", ".", "format", "(", "old_ver", ")", ")", "log", ".", "info", "(", "\" new version: <35>{}\"", ".", "format", "(", "new_ver", ")", ")" ]

[ "Bump", "current", "project", "version", "without", "committing", "anything", "." ]

[ "def", "get_logfile_name", "(", "tag", ")", ":", "if", "not", "os", ".", "path", ".", "exists", "(", "p", ".", "LOG_DIR", ")", ":", "os", ".", "mkdir", "(", "p", ".", "LOG_DIR", ")", "filename", "=", "\"log_\"", "+", "p", ".", "HOST", "+", "\"_\"", "+", "tag", "+", "\".txt\"", "filename", "=", "os", ".", "path", ".", "join", "(", "p", ".", "LOG_DIR", ",", "filename", ")", "return", "filename" ]

[ "Creates", "a", "name", "for", "a", "log", "file", "that", "is", "meant", "to", "be", "used", "in", "a", "call", "to", "logging", ".", "FileHandler", ".", "The", "log", "file", "name", "will", "incldue", "the", "path", "to", "the", "log", "directory", "given", "by", "the", "p", ".", "LOG_DIR", "constant", ".", "The", "format", "of", "the", "file", "name", "is", ":", "log_$HOST_$TAG", ".", "txt", "where" ]

[ "def", "_get", "(", "self", ",", "rec_id", "=", "None", ",", "upstream", "=", "None", ")", ":", "if", "rec_id", ":", "self", ".", "record_url", "=", "self", ".", "__class__", ".", "get_record_url", "(", "rec_id", ")", "self", ".", "debug_logger", ".", "debug", "(", "\"GET {} record with ID {}: {}\"", ".", "format", "(", "self", ".", "__class__", ".", "__name__", ",", "rec_id", ",", "self", ".", "record_url", ")", ")", "response", "=", "requests", ".", "get", "(", "url", "=", "self", ".", "record_url", ",", "headers", "=", "HEADERS", ",", "verify", "=", "False", ")", "if", "not", "response", ".", "ok", "and", "response", ".", "status_code", "==", "requests", ".", "codes", ".", "NOT_FOUND", ":", "raise", "RecordNotFound", "(", "\"Search for {} record with ID '{}' returned no results.\"", ".", "format", "(", "self", ".", "__class__", ".", "__name__", ",", "rec_id", ")", ")", "self", ".", "write_response_html_to_file", "(", "response", ",", "\"get_bob.html\"", ")", "response", ".", "raise_for_status", "(", ")", "return", "response", ".", "json", "(", ")", "elif", "upstream", ":", "rec_json", "=", "self", ".", "__class__", ".", "find_by", "(", "{", "\"upstream_identifier\"", ":", "upstream", "}", ",", "require", "=", "True", ")", "self", ".", "record_url", "=", "self", ".", "__class__", ".", "get_record_url", "(", "rec_json", "[", "\"id\"", "]", ")", "return", "rec_json" ]

[ "Fetches", "a", "record", "by", "the", "record", "s", "ID", "or", "upstream_identifier", "." ]

[ "def", "replace_name_with_id", "(", "cls", ",", "name", ")", ":", "try", ":", "int", "(", "name", ")", "return", "name", "#Already a presumed ID.", "except", "ValueError", ":", "pass", "#Not an int, so maybe a combination of MODEL_ABBR and Primary Key, i.e. B-8.", "if", "name", ".", "split", "(", "\"-\"", ")", "[", "0", "]", "in", "Meta", ".", "_MODEL_ABBREVS", ":", "return", "int", "(", "name", ".", "split", "(", "\"-\"", ",", "1", ")", "[", "1", "]", ")", "try", ":", "result", "=", "cls", ".", "ES", ".", "get_record_by_name", "(", "cls", ".", "ES_INDEX_NAME", ",", "name", ")", "if", "result", ":", "return", "result", "[", "\"id\"", "]", "except", "pulsarpy", ".", "elasticsearch_utils", ".", "MultipleHitsException", "as", "e", ":", "raise", "raise", "RecordNotFound", "(", "\"Name '{}' for model '{}' not found.\"", ".", "format", "(", "name", ",", "cls", ".", "__name__", ")", ")" ]

[ "Used", "to", "replace", "a", "foreign", "key", "reference", "using", "a", "name", "with", "an", "ID", ".", "Works", "by", "searching", "the", "record", "in", "Pulsar", "and", "expects", "to", "find", "exactly", "one", "hit", ".", "First", "will", "check", "if", "the", "foreign", "key", "reference", "is", "an", "integer", "value", "and", "if", "so", "returns", "that", "as", "it", "is", "presumed", "to", "be", "the", "foreign", "key", "." ]

[ "def", "add_model_name_to_payload", "(", "cls", ",", "payload", ")", ":", "if", "not", "cls", ".", "MODEL_NAME", "in", "payload", ":", "payload", "=", "{", "cls", ".", "MODEL_NAME", ":", "payload", "}", "return", "payload" ]

[ "Checks", "whether", "the", "model", "name", "in", "question", "is", "in", "the", "payload", ".", "If", "not", "the", "entire", "payload", "is", "set", "as", "a", "value", "of", "a", "key", "by", "the", "name", "of", "the", "model", ".", "This", "method", "is", "useful", "when", "some", "server", "-", "side", "Rails", "API", "calls", "expect", "the", "parameters", "to", "include", "the", "parameterized", "model", "name", ".", "For", "example", "server", "-", "side", "endpoints", "that", "handle", "the", "updating", "of", "a", "biosample", "record", "or", "the", "creation", "of", "a", "new", "biosmample", "record", "will", "expect", "the", "payload", "to", "be", "of", "the", "form", "::" ]

[ "def", "delete", "(", "self", ")", ":", "res", "=", "requests", ".", "delete", "(", "url", "=", "self", ".", "record_url", ",", "headers", "=", "HEADERS", ",", "verify", "=", "False", ")", "#self.write_response_html_to_file(res,\"bob_delete.html\")", "if", "res", ".", "status_code", "==", "204", ":", "#No content. Can't render json:", "return", "{", "}", "return", "res", ".", "json", "(", ")" ]

[ "Deletes", "the", "record", "." ]

[ "def", "find_by", "(", "cls", ",", "payload", ",", "require", "=", "False", ")", ":", "if", "not", "isinstance", "(", "payload", ",", "dict", ")", ":", "raise", "ValueError", "(", "\"The 'payload' parameter must be provided a dictionary object.\"", ")", "url", "=", "os", ".", "path", ".", "join", "(", "cls", ".", "URL", ",", "\"find_by\"", ")", "payload", "=", "{", "\"find_by\"", ":", "payload", "}", "cls", ".", "debug_logger", ".", "debug", "(", "\"Searching Pulsar {} for {}\"", ".", "format", "(", "cls", ".", "__name__", ",", "json", ".", "dumps", "(", "payload", ",", "indent", "=", "4", ")", ")", ")", "res", "=", "requests", ".", "post", "(", "url", "=", "url", ",", "json", "=", "payload", ",", "headers", "=", "HEADERS", ",", "verify", "=", "False", ")", "#cls.write_response_html_to_file(res,\"bob.html\")", "res", ".", "raise_for_status", "(", ")", "res_json", "=", "res", ".", "json", "(", ")", "if", "res_json", ":", "try", ":", "res_json", "=", "res_json", "[", "cls", ".", "MODEL_NAME", "]", "except", "KeyError", ":", "# Key won't be present if there isn't a serializer for it on the server.", "pass", "else", ":", "if", "require", ":", "raise", "RecordNotFound", "(", "\"Can't find any {} records with search criteria: '{}'.\"", ".", "format", "(", "cls", ".", "__name__", ",", "payload", ")", ")", "return", "res_json" ]

[ "Searches", "the", "model", "in", "question", "by", "AND", "joining", "the", "query", "parameters", "." ]

[ "def", "find_by_or", "(", "cls", ",", "payload", ")", ":", "if", "not", "isinstance", "(", "payload", ",", "dict", ")", ":", "raise", "ValueError", "(", "\"The 'payload' parameter must be provided a dictionary object.\"", ")", "url", "=", "os", ".", "path", ".", "join", "(", "cls", ".", "URL", ",", "\"find_by_or\"", ")", "payload", "=", "{", "\"find_by_or\"", ":", "payload", "}", "cls", ".", "debug_logger", ".", "debug", "(", "\"Searching Pulsar {} for {}\"", ".", "format", "(", "cls", ".", "__name__", ",", "json", ".", "dumps", "(", "payload", ",", "indent", "=", "4", ")", ")", ")", "res", "=", "requests", ".", "post", "(", "url", "=", "url", ",", "json", "=", "payload", ",", "headers", "=", "HEADERS", ",", "verify", "=", "False", ")", "cls", ".", "write_response_html_to_file", "(", "res", ",", "\"bob.html\"", ")", "if", "res", ":", "try", ":", "res", "=", "res", "[", "cls", ".", "MODEL_NAME", "]", "except", "KeyError", ":", "# Key won't be present if there isn't a serializer for it on the server.", "pass", "return", "res" ]

[ "Searches", "the", "model", "in", "question", "by", "OR", "joining", "the", "query", "parameters", "." ]

[ "def", "index", "(", "cls", ")", ":", "res", "=", "requests", ".", "get", "(", "cls", ".", "URL", ",", "headers", "=", "HEADERS", ",", "verify", "=", "False", ")", "res", ".", "raise_for_status", "(", ")", "return", "res", ".", "json", "(", ")" ]

[ "Fetches", "all", "records", "." ]

[ "def", "patch", "(", "self", ",", "payload", ",", "append_to_arrays", "=", "True", ")", ":", "if", "not", "isinstance", "(", "payload", ",", "dict", ")", ":", "raise", "ValueError", "(", "\"The 'payload' parameter must be provided a dictionary object.\"", ")", "payload", "=", "self", ".", "__class__", ".", "set_id_in_fkeys", "(", "payload", ")", "if", "append_to_arrays", ":", "for", "key", "in", "payload", ":", "val", "=", "payload", "[", "key", "]", "if", "type", "(", "val", ")", "==", "list", ":", "val", ".", "extend", "(", "getattr", "(", "self", ",", "key", ")", ")", "payload", "[", "key", "]", "=", "list", "(", "set", "(", "val", ")", ")", "payload", "=", "self", ".", "check_boolean_fields", "(", "payload", ")", "payload", "=", "self", ".", "__class__", ".", "add_model_name_to_payload", "(", "payload", ")", "self", ".", "debug_logger", ".", "debug", "(", "\"PATCHING payload {}\"", ".", "format", "(", "json", ".", "dumps", "(", "payload", ",", "indent", "=", "4", ")", ")", ")", "res", "=", "requests", ".", "patch", "(", "url", "=", "self", ".", "record_url", ",", "json", "=", "payload", ",", "headers", "=", "HEADERS", ",", "verify", "=", "False", ")", "self", ".", "write_response_html_to_file", "(", "res", ",", "\"bob.html\"", ")", "res", ".", "raise_for_status", "(", ")", "json_res", "=", "res", ".", "json", "(", ")", "self", ".", "debug_logger", ".", "debug", "(", "\"Success\"", ")", "self", ".", "attrs", "=", "json_res", "return", "json_res" ]

[ "Patches", "current", "record", "and", "udpates", "the", "current", "instance", "s", "attrs", "attribute", "to", "reflect", "the", "new", "changes", "." ]

[ "def", "set_id_in_fkeys", "(", "cls", ",", "payload", ")", ":", "for", "key", "in", "payload", ":", "val", "=", "payload", "[", "key", "]", "if", "not", "val", ":", "continue", "if", "key", ".", "endswith", "(", "\"_id\"", ")", ":", "model", "=", "getattr", "(", "THIS_MODULE", ",", "cls", ".", "FKEY_MAP", "[", "key", "]", ")", "rec_id", "=", "model", ".", "replace_name_with_id", "(", "name", "=", "val", ")", "payload", "[", "key", "]", "=", "rec_id", "elif", "key", ".", "endswith", "(", "\"_ids\"", ")", ":", "model", "=", "getattr", "(", "THIS_MODULE", ",", "cls", ".", "FKEY_MAP", "[", "key", "]", ")", "rec_ids", "=", "[", "]", "for", "v", "in", "val", ":", "rec_id", "=", "model", ".", "replace_name_with_id", "(", "name", "=", "v", ")", "rec_ids", ".", "append", "(", "rec_id", ")", "payload", "[", "key", "]", "=", "rec_ids", "return", "payload" ]

[ "Looks", "for", "any", "keys", "in", "the", "payload", "that", "end", "with", "either", "_id", "or", "_ids", "signaling", "a", "foreign", "key", "field", ".", "For", "each", "foreign", "key", "field", "checks", "whether", "the", "value", "is", "using", "the", "name", "of", "the", "record", "or", "the", "actual", "primary", "ID", "of", "the", "record", "(", "which", "may", "include", "the", "model", "abbreviation", "i", ".", "e", ".", "B", "-", "1", ")", ".", "If", "the", "former", "case", "the", "name", "is", "replaced", "with", "the", "record", "s", "primary", "ID", "." ]

[ "def", "post", "(", "cls", ",", "payload", ")", ":", "if", "not", "isinstance", "(", "payload", ",", "dict", ")", ":", "raise", "ValueError", "(", "\"The 'payload' parameter must be provided a dictionary object.\"", ")", "payload", "=", "cls", ".", "set_id_in_fkeys", "(", "payload", ")", "payload", "=", "cls", ".", "check_boolean_fields", "(", "payload", ")", "payload", "=", "cls", ".", "add_model_name_to_payload", "(", "payload", ")", "# Run any pre-post hooks:", "payload", "=", "cls", ".", "prepost_hooks", "(", "payload", ")", "cls", ".", "debug_logger", ".", "debug", "(", "\"POSTING payload {}\"", ".", "format", "(", "json", ".", "dumps", "(", "payload", ",", "indent", "=", "4", ")", ")", ")", "res", "=", "requests", ".", "post", "(", "url", "=", "cls", ".", "URL", ",", "json", "=", "(", "payload", ")", ",", "headers", "=", "HEADERS", ",", "verify", "=", "False", ")", "cls", ".", "write_response_html_to_file", "(", "res", ",", "\"bob.html\"", ")", "if", "not", "res", ".", "ok", ":", "cls", ".", "log_error", "(", "res", ".", "text", ")", "res_json", "=", "res", ".", "json", "(", ")", "if", "\"exception\"", "in", "res_json", ":", "exc_type", "=", "res_json", "[", "\"exception\"", "]", "if", "exc_type", "==", "\"ActiveRecord::RecordNotUnique\"", ":", "raise", "RecordNotUnique", "(", ")", "res", ".", "raise_for_status", "(", ")", "res", "=", "res", ".", "json", "(", ")", "cls", ".", "log_post", "(", "res", ")", "cls", ".", "debug_logger", ".", "debug", "(", "\"Success\"", ")", "return", "res" ]

[ "Posts", "the", "data", "to", "the", "specified", "record", "." ]

[ "def", "log_error", "(", "cls", ",", "msg", ")", ":", "cls", ".", "error_logger", ".", "error", "(", "msg", ")", "cls", ".", "debug_logger", ".", "debug", "(", "msg", ")" ]

[ "Logs", "the", "provided", "error", "message", "to", "both", "the", "error", "logger", "and", "the", "debug", "logger", "logging", "instances", "." ]

[ "def", "write_response_html_to_file", "(", "response", ",", "filename", ")", ":", "fout", "=", "open", "(", "filename", ",", "'w'", ")", "if", "not", "str", "(", "response", ".", "status_code", ")", ".", "startswith", "(", "\"2\"", ")", ":", "Model", ".", "debug_logger", ".", "debug", "(", "response", ".", "text", ")", "fout", ".", "write", "(", "response", ".", "text", ")", "fout", ".", "close", "(", ")" ]

[ "An", "aid", "in", "troubleshooting", "internal", "application", "errors", "i", ".", "e", ".", "<Response", "[", "500", "]", ">", "to", "be", "mainly", "beneficial", "when", "developing", "the", "server", "-", "side", "API", ".", "This", "method", "will", "write", "the", "response", "HTML", "for", "viewing", "the", "error", "details", "in", "the", "browesr", "." ]

[ "def", "parent_ids", "(", "self", ")", ":", "action", "=", "os", ".", "path", ".", "join", "(", "self", ".", "record_url", ",", "\"parent_ids\"", ")", "res", "=", "requests", ".", "get", "(", "url", "=", "action", ",", "headers", "=", "HEADERS", ",", "verify", "=", "False", ")", "res", ".", "raise_for_status", "(", ")", "return", "res", ".", "json", "(", ")", "[", "\"biosamples\"", "]" ]

[ "Returns", "an", "array", "of", "parent", "Biosample", "IDs", ".", "If", "the", "current", "Biosample", "has", "a", "part_of", "relationship", "the", "Biosampled", "referenced", "there", "will", "be", "returned", ".", "Otherwise", "if", "the", "current", "Biosample", "was", "generated", "from", "a", "pool", "of", "Biosamples", "(", "pooled_from_biosample_ids", ")", "then", "those", "will", "be", "returned", ".", "Otherwise", "the", "result", "will", "be", "an", "empty", "array", "." ]

[ "def", "find_first_wt_parent", "(", "self", ",", "with_ip", "=", "False", ")", ":", "parent_id", "=", "self", ".", "part_of_id", "if", "not", "parent_id", ":", "return", "False", "parent", "=", "Biosample", "(", "parent_id", ")", "if", "parent", ".", "wild_type", ":", "if", "with_ip", "and", "parent", ".", "immunoblot_ids", ":", "return", "parent", ".", "id", "elif", "not", "with_ip", ":", "return", "parent", ".", "id", "return", "parent", ".", "find_first_wt_parent", "(", "with_ip", "=", "with_ip", ")" ]

[ "Recursively", "looks", "at", "the", "part_of", "parent", "ancestry", "line", "(", "ignoring", "pooled_from", "parents", ")", "and", "returns", "a", "parent", "Biosample", "ID", "if", "its", "wild_type", "attribute", "is", "True", "." ]

[ "def", "upload", "(", "cls", ",", "path", ",", "document_type", ",", "is_protocol", ",", "description", "=", "\"\"", ")", ":", "file_name", "=", "os", ".", "path", ".", "basename", "(", "path", ")", "mime_type", "=", "mimetypes", ".", "guess_type", "(", "file_name", ")", "[", "0", "]", "data", "=", "base64", ".", "b64encode", "(", "open", "(", "path", ",", "'rb'", ")", ".", "read", "(", ")", ")", "temp_uri", "=", "str", "(", "data", ",", "\"utf-8\"", ")", "#href = \"data:{mime_type};base64,{temp_uri}\".format(mime_type=mime_type, temp_uri=temp_uri) ", "payload", "=", "{", "}", "payload", "[", "\"content_type\"", "]", "=", "mime_type", "payload", "[", "\"data\"", "]", "=", "temp_uri", "payload", "[", "\"description\"", "]", "=", "description", "payload", "[", "\"document_type_id\"", "]", "=", "DocumentType", "(", "document_type", ")", ".", "id", "payload", "[", "\"name\"", "]", "=", "file_name", "payload", "[", "\"is_protocol\"", "]", "=", "is_protocol", "cls", ".", "post", "(", "payload", ")" ]

[ "Args", ":", "path", ":", "str", ".", "The", "path", "to", "the", "document", "to", "upload", ".", "document_type", ":", "str", ".", "DocumentType", "identified", "by", "the", "value", "of", "its", "name", "attribute", ".", "is_protocol", ":", "bool", ".", "description", ":", "str", "." ]

[ "def", "post", "(", "cls", ",", "payload", ")", ":", "slpk_attr_name", "=", "\"sequencing_library_prep_kit_id\"", "paired_bc_id_attr_name", "=", "\"paired_barcode_id\"", "seq_reg", "=", "re", ".", "compile", "(", "\"^[ACGTN]+$\"", ")", "if", "paired_bc_id_attr_name", "in", "payload", ":", "try", ":", "index1", ",", "index2", "=", "payload", "[", "paired_bc_id_attr_name", "]", ".", "upper", "(", ")", ".", "split", "(", "\"-\"", ")", "except", "ValueError", ":", "# Not in GATTTCCA-GGCGTCGA format so let it be. ", "return", "Model", ".", "post", "(", "cls", "=", "cls", ",", "payload", "=", "payload", ")", "if", "not", "seq_reg", ".", "match", "(", "index1", ")", "or", "not", "seq_reg", ".", "match", "(", "index2", ")", ":", "# Not in GATTTCCA-GGCGTCGA format so let it be. ", "return", "Model", ".", "post", "(", "cls", "=", "cls", ",", "payload", "=", "payload", ")", "if", "not", "slpk_attr_name", "in", "payload", ":", "raise", "Exception", "(", "\"You need to include the \"", "+", "slpk", "+", "\" attribute name.\"", ")", "slpk_id", "=", "SequencingLibraryPrepKit", ".", "replace_name_with_id", "(", "payload", "[", "slpk_attr_name", "]", ")", "payload", "[", "slpk_attr_name", "]", "=", "slpk_id", "index1_id", "=", "Barcode", ".", "find_by", "(", "payload", "=", "{", "slpk_attr_name", ":", "slpk_id", ",", "\"index_number\"", ":", "1", ",", "\"sequence\"", ":", "index1", "}", ",", "require", "=", "True", ")", "[", "\"id\"", "]", "index2_id", "=", "Barcode", ".", "find_by", "(", "payload", "=", "{", "slpk_attr_name", ":", "slpk_id", ",", "\"index_number\"", ":", "2", ",", "\"sequence\"", ":", "index2", "}", ",", "require", "=", "True", ")", "[", "\"id\"", "]", "# Ensure that PairedBarcode for this index combo already exists:", "pbc_payload", "=", "{", "\"index1_id\"", ":", "index1_id", ",", "\"index2_id\"", ":", "index2_id", ",", "slpk_attr_name", ":", "slpk_id", "}", "pbc_exists", "=", "PairedBarcode", ".", "find_by", "(", "payload", "=", "pbc_payload", ")", "if", "not", "pbc_exists", ":", "pbc_exists", "=", "PairedBarcode", ".", "post", "(", "payload", "=", "pbc_payload", ")", "pbc_id", "=", "pbc_exists", "[", "\"id\"", "]", "payload", "[", "paired_bc_id_attr_name", "]", "=", "pbc_id", "return", "super", "(", ")", ".", "post", "(", "payload", "=", "payload", ")" ]

[ "A", "wrapper", "over", "Model", ".", "post", "()", "that", "handles", "the", "case", "where", "a", "Library", "has", "a", "PairedBarcode", "and", "the", "user", "may", "have", "supplied", "the", "PairedBarcode", "in", "the", "form", "of", "index1", "-", "index2", "i", ".", "e", ".", "GATTTCCA", "-", "GGCGTCGA", ".", "This", "isn", "t", "the", "PairedBarcode", "s", "record", "name", "or", "a", "record", "ID", "thus", "Model", ".", "post", "()", "won", "t", "be", "able", "to", "figure", "out", "the", "PairedBarcode", "s", "ID", "to", "substitute", "in", "the", "payload", "(", "via", "a", "call", "to", "cls", ".", "replace_name_with_id", "()", ")", ".", "Thus", "this", "wrapper", "will", "attempt", "to", "replace", "a", "PairedBarcode", "sequence", "in", "the", "payload", "with", "a", "PairedBarcode", "ID", "then", "pass", "the", "payload", "off", "to", "Model", ".", "post", "()", "." ]

[ "def", "get_library_barcode_sequence_hash", "(", "self", ",", "inverse", "=", "False", ")", ":", "action", "=", "os", ".", "path", ".", "join", "(", "self", ".", "record_url", ",", "\"get_library_barcode_sequence_hash\"", ")", "res", "=", "requests", ".", "get", "(", "url", "=", "action", ",", "headers", "=", "HEADERS", ",", "verify", "=", "False", ")", "res", ".", "raise_for_status", "(", ")", "res_json", "=", "res", ".", "json", "(", ")", "# Convert library ID from string to int", "new_res", "=", "{", "}", "for", "lib_id", "in", "res_json", ":", "new_res", "[", "int", "(", "lib_id", ")", "]", "=", "res_json", "[", "lib_id", "]", "res_json", "=", "new_res", "if", "inverse", ":", "rev", "=", "{", "}", "for", "lib_id", "in", "res_json", ":", "rev", "[", "res_json", "[", "lib_id", "]", "]", "=", "lib_id", "res_json", "=", "rev", "return", "res_json" ]

[ "Calls", "the", "SequencingRequest", "s", "get_library_barcode_sequence_hash", "server", "-", "side", "endpoint", "to", "create", "a", "hash", "of", "the", "form", "{", "LibraryID", "-", ">", "barcode_sequence", "}", "for", "all", "Libraries", "on", "the", "SequencingRequest", "." ]

[ "def", "library_sequencing_results", "(", "self", ")", ":", "sres_ids", "=", "self", ".", "sequencing_result_ids", "res", "=", "{", "}", "for", "i", "in", "sres_ids", ":", "sres", "=", "SequencingResult", "(", "i", ")", "res", "[", "sres", ".", "library_id", "]", "=", "sres", "return", "res" ]

[ "Generates", "a", "dict", ".", "where", "each", "key", "is", "a", "Library", "ID", "on", "the", "SequencingRequest", "and", "each", "value", "is", "the", "associated", "SequencingResult", ".", "Libraries", "that", "aren", "t", "yet", "with", "a", "SequencingResult", "are", "not", "inlcuded", "in", "the", "dict", "." ]

[ "def", "unarchive_user", "(", "self", ",", "user_id", ")", ":", "url", "=", "self", ".", "record_url", "+", "\"/unarchive\"", "res", "=", "requests", ".", "patch", "(", "url", "=", "url", ",", "json", "=", "{", "\"user_id\"", ":", "user_id", "}", ",", "headers", "=", "HEADERS", ",", "verify", "=", "False", ")", "self", ".", "write_response_html_to_file", "(", "res", ",", "\"bob.html\"", ")", "res", ".", "raise_for_status", "(", ")" ]

[ "Unarchives", "the", "user", "with", "the", "specified", "user", "ID", "." ]

[ "def", "remove_api_key", "(", "self", ")", ":", "url", "=", "self", ".", "record_url", "+", "\"/remove_api_key\"", "res", "=", "requests", ".", "patch", "(", "url", "=", "url", ",", "headers", "=", "HEADERS", ",", "verify", "=", "False", ")", "res", ".", "raise_for_status", "(", ")", "self", ".", "api_key", "=", "\"\"" ]

[ "Removes", "the", "user", "s", "existing", "API", "key", "if", "present", "and", "sets", "the", "current", "instance", "s", "api_key", "attribute", "to", "the", "empty", "string", "." ]

[ "def", "generate_synthObs", "(", "self", ",", "bases_wave", ",", "bases_flux", ",", "basesCoeff", ",", "Av_star", ",", "z_star", ",", "sigma_star", ",", "resample_range", "=", "None", ",", "resample_int", "=", "1", ")", ":", "nbases", "=", "basesCoeff", ".", "shape", "[", "0", "]", "bases_wave_resam", "=", "arange", "(", "int", "(", "resample_range", "[", "0", "]", ")", ",", "int", "(", "resample_range", "[", "-", "1", "]", ")", ",", "resample_int", ",", "dtype", "=", "float", ")", "npix_resample", "=", "len", "(", "bases_wave_resam", ")", "#Resampling the range", "bases_flux_resam", "=", "empty", "(", "(", "nbases", ",", "npix_resample", ")", ")", "for", "i", "in", "range", "(", "nbases", ")", ":", "# print bases_wave[i][0], bases_wave[i][-1]", "# print bases_wave_resam[0], bases_wave_resam[-1]", "bases_flux_resam", "[", "i", ",", ":", "]", "=", "interp1d", "(", "bases_wave", "[", "i", "]", ",", "bases_flux", "[", "i", "]", ",", "bounds_error", "=", "True", ")", "(", "bases_wave_resam", ")", "#Display physical parameters", "synth_wave", "=", "bases_wave_resam", "*", "(", "1", "+", "z_star", ")", "Av_vector", "=", "Av_star", "*", "ones", "(", "nbases", ")", "Xx_redd", "=", "CCM89_Bal07", "(", "3.4", ",", "bases_wave_resam", ")", "r_sigma", "=", "sigma_star", "/", "(", "synth_wave", "[", "1", "]", "-", "synth_wave", "[", "0", "]", ")", "#Defining empty kernel", "box", "=", "int", "(", "3", "*", "r_sigma", ")", "if", "int", "(", "3", "*", "r_sigma", ")", "<", "3", "else", "3", "kernel_len", "=", "2", "*", "box", "+", "1", "kernel", "=", "zeros", "(", "(", "1", ",", "kernel_len", ")", ")", "kernel_range", "=", "arange", "(", "0", ",", "2", "*", "box", "+", "1", ")", "#Generating the kernel with sigma (the norm factor is the sum of the gaussian)", "kernel", "[", "0", ",", ":", "]", "=", "exp", "(", "-", "0.5", "*", "(", "(", "square", "(", "kernel_range", "-", "box", ")", "/", "r_sigma", ")", ")", ")", "norm", "=", "np_sum", "(", "kernel", "[", "0", ",", ":", "]", ")", "kernel", "=", "kernel", "/", "norm", "#Convove bases with respect to kernel for dispersion velocity calculation", "bases_grid_convolve", "=", "convolve2d", "(", "bases_flux_resam", ",", "kernel", ",", "mode", "=", "'same'", ",", "boundary", "=", "'symm'", ")", "#Interpolate bases to wavelength range", "interBases_matrix", "=", "(", "interp1d", "(", "bases_wave_resam", ",", "bases_grid_convolve", ",", "axis", "=", "1", ",", "bounds_error", "=", "True", ")", "(", "bases_wave_resam", ")", ")", ".", "T", "#Generate final flux model including dust ", "dust_attenuation", "=", "power", "(", "10", ",", "-", "0.4", "*", "outer", "(", "Xx_redd", ",", "Av_vector", ")", ")", "bases_grid_model", "=", "interBases_matrix", "*", "dust_attenuation", "#Generate combined flux", "synth_flux", "=", "np_sum", "(", "basesCoeff", ".", "T", "*", "bases_grid_model", ",", "axis", "=", "1", ")", "return", "synth_wave", ",", "synth_flux" ]

[ "basesWave", ":", "Bases", "wavelength", "must", "be", "at", "rest" ]

[ "def", "_process", "(", "self", ",", "resource", "=", "None", ",", "data", "=", "{", "}", ")", ":", "# use object's data if no data is passed", "_data", "=", "data", "or", "self", ".", "_data", "rsc_url", "=", "self", ".", "get_rsc_endpoint", "(", "resource", ")", "if", "_data", ":", "req", "=", "requests", ".", "post", "(", "rsc_url", ",", "data", "=", "json", ".", "dumps", "(", "_data", ")", ",", "headers", "=", "self", ".", "headers", ")", "else", ":", "req", "=", "requests", ".", "get", "(", "rsc_url", ",", "params", "=", "_data", ",", "headers", "=", "self", ".", "headers", ")", "if", "req", ".", "status_code", "==", "200", ":", "self", ".", "_response", "=", "json", ".", "loads", "(", "req", ".", "text", ")", "if", "int", "(", "self", ".", "_response", "[", "'response_code'", "]", ")", "==", "00", ":", "return", "(", "True", ",", "self", ".", "_response", ")", "else", ":", "return", "(", "False", ",", "self", ".", "_response", "[", "'response_text'", "]", ")", "else", ":", "return", "(", "500", ",", "\"Request Failed\"", ")" ]

[ "Processes", "the", "current", "transaction" ]

[ "def", "add_header", "(", "self", ",", "header", ")", ":", "if", "type", "(", "header", ")", "is", "dict", ":", "self", ".", "_headers", ".", "update", "(", "header", ")", "else", ":", "raise", "ValueError", "(", "\"Dictionary expected, got '%s' instead\"", "%", "type", "(", "header", ")", ")" ]

[ "Add", "a", "custom", "HTTP", "header", "to", "the", "client", "s", "request", "headers" ]

[ "def", "changelog_cli", "(", "ctx", ")", ":", "# type: () -> None", "if", "ctx", ".", "invoked_subcommand", ":", "return", "from", "peltak", ".", "core", "import", "shell", "from", ".", "import", "logic", "shell", ".", "cprint", "(", "logic", ".", "changelog", "(", ")", ")" ]

[ "Generate", "changelog", "from", "commit", "messages", "." ]

[ "def", "convert_to_argument", "(", "self", ")", ":", "field_list", "=", "[", "\"action\"", ",", "\"nargs\"", ",", "\"const\"", ",", "\"default\"", ",", "\"type\"", ",", "\"choices\"", ",", "\"required\"", ",", "\"help\"", ",", "\"metavar\"", ",", "\"dest\"", "]", "return", "(", "self", ".", "name", ",", "{", "field", ":", "getattr", "(", "self", ",", "field", ")", "for", "field", "in", "field_list", "if", "getattr", "(", "self", ",", "field", ")", "is", "not", "None", "}", ")" ]

[ "Convert", "the", "Argument", "object", "to", "a", "tuple", "use", "in", ":", "meth", ":", "~argparse", ".", "ArgumentParser", ".", "add_argument", "calls", "on", "the", "parser" ]

[ "def", "get_default_name", "(", "self", ")", ":", "long_names", "=", "[", "name", "for", "name", "in", "self", ".", "name", "if", "name", ".", "startswith", "(", "\"--\"", ")", "]", "short_names", "=", "[", "name", "for", "name", "in", "self", ".", "name", "if", "not", "name", ".", "startswith", "(", "\"--\"", ")", "]", "if", "long_names", ":", "return", "to_snake_case", "(", "long_names", "[", "0", "]", ".", "lstrip", "(", "\"-\"", ")", ")", "return", "to_snake_case", "(", "short_names", "[", "0", "]", ".", "lstrip", "(", "\"-\"", ")", ")" ]

[ "Return", "the", "default", "generated", "name", "to", "store", "value", "on", "the", "parser", "for", "this", "option", "." ]

[ "def", "get_filename", "(", "self", ",", "base_dir", "=", "None", ",", "modality", "=", "None", ")", ":", "filename", "=", "'sub-'", "+", "self", ".", "subject", "if", "self", ".", "session", "is", "not", "None", ":", "filename", "+=", "'_ses-'", "+", "self", ".", "session", "if", "self", ".", "task", "is", "not", "None", ":", "filename", "+=", "'_task-'", "+", "self", ".", "task", "if", "self", ".", "run", "is", "not", "None", "and", "self", ".", "direction", "is", "None", ":", "filename", "+=", "'_run-'", "+", "self", ".", "run", "if", "self", ".", "acquisition", "is", "not", "None", ":", "filename", "+=", "'_acq-'", "+", "self", ".", "acquisition", "if", "self", ".", "direction", "is", "not", "None", ":", "filename", "+=", "'_dir-'", "+", "self", ".", "direction", "if", "self", ".", "run", "is", "not", "None", "and", "self", ".", "direction", "is", "not", "None", ":", "filename", "+=", "'_run-'", "+", "self", ".", "run", "if", "self", ".", "modality", "is", "not", "None", ":", "filename", "+=", "'_'", "+", "self", ".", "modality", "if", "self", ".", "extension", "is", "not", "None", ":", "filename", "+=", "self", ".", "extension", "if", "base_dir", "is", "None", ":", "return", "filename", "else", ":", "dir_name", "=", "base_dir", "/", "(", "'sub-'", "+", "self", ".", "subject", ")", "if", "self", ".", "session", "is", "not", "None", ":", "dir_name", "/=", "'ses-'", "+", "self", ".", "session", "if", "modality", "is", "not", "None", ":", "dir_name", "/=", "modality", "else", ":", "dir_name", "=", "add_modality", "(", "dir_name", ",", "self", ".", "modality", ")", "return", "dir_name", "/", "filename" ]

[ "Construct", "filename", "based", "on", "the", "attributes", "." ]

[ "def", "get", "(", "self", ",", "filter_lambda", "=", "None", ",", "map_lambda", "=", "None", ")", ":", "if", "filter_lambda", "is", "None", ":", "filter_lambda", "=", "lambda", "x", ":", "True", "if", "map_lambda", "is", "None", ":", "map_lambda", "=", "lambda", "x", ":", "x", "return", "list", "(", "map", "(", "map_lambda", ",", "filter", "(", "filter_lambda", ",", "self", ".", "tsv", ")", ")", ")" ]

[ "Select", "elements", "of", "the", "TSV", "using", "python", "filter", "and", "map", "." ]

[ "def", "connect", "(", "self", ",", "client_id", ":", "str", "=", "None", ",", "client_secret", ":", "str", "=", "None", ")", "->", "dict", ":", "# instanciated or direct call", "if", "not", "client_id", "and", "not", "client_secret", ":", "client_id", "=", "self", ".", "client_id", "client_secret", "=", "self", ".", "client_secret", "else", ":", "pass", "# Basic Authentication header in Base64 (https://en.wikipedia.org/wiki/Base64)", "# see: http://tools.ietf.org/html/rfc2617#section-2", "# using Client Credentials Grant method", "# see: http://tools.ietf.org/html/rfc6749#section-4.4", "payload", "=", "{", "\"grant_type\"", ":", "\"client_credentials\"", "}", "head", "=", "{", "\"user-agent\"", ":", "self", ".", "app_name", "}", "# passing request to get a 24h bearer", "# see: http://tools.ietf.org/html/rfc6750#section-2", "id_url", "=", "\"https://id.{}.isogeo.com/oauth/token\"", ".", "format", "(", "self", ".", "api_url", ")", "try", ":", "conn", "=", "self", ".", "post", "(", "id_url", ",", "auth", "=", "(", "client_id", ",", "client_secret", ")", ",", "headers", "=", "head", ",", "data", "=", "payload", ",", "proxies", "=", "self", ".", "proxies", ",", "verify", "=", "self", ".", "ssl", ",", ")", "except", "ConnectionError", "as", "e", ":", "raise", "ConnectionError", "(", "\"Connection to Isogeo ID\"", "\"failed: {}\"", ".", "format", "(", "e", ")", ")", "# just a fast check", "check_params", "=", "checker", ".", "check_api_response", "(", "conn", ")", "if", "check_params", "==", "1", ":", "pass", "elif", "isinstance", "(", "check_params", ",", "tuple", ")", "and", "len", "(", "check_params", ")", "==", "2", ":", "raise", "ValueError", "(", "2", ",", "check_params", ")", "# getting access", "self", ".", "token", "=", "conn", ".", "json", "(", ")", "# add expiration date - calculating with a prevention of 10%", "expiration_delay", "=", "self", ".", "token", ".", "get", "(", "\"expires_in\"", ",", "3600", ")", "-", "(", "self", ".", "token", ".", "get", "(", "\"expires_in\"", ",", "3600", ")", "/", "10", ")", "self", ".", "token", "[", "\"expires_at\"", "]", "=", "datetime", ".", "utcnow", "(", ")", "+", "timedelta", "(", "seconds", "=", "expiration_delay", ")", "# end of method", "return", "self", ".", "token" ]

[ "Authenticate", "application", "and", "get", "token", "bearer", "." ]

[ "def", "_check_bearer_validity", "(", "decorated_func", ")", ":", "@", "wraps", "(", "decorated_func", ")", "def", "wrapper", "(", "self", ",", "*", "args", ",", "*", "*", "kwargs", ")", ":", "# compare token expiration date and ask for a new one if it's expired", "if", "datetime", ".", "now", "(", ")", "<", "self", ".", "token", ".", "get", "(", "\"expires_at\"", ")", ":", "self", ".", "connect", "(", ")", "logging", ".", "debug", "(", "\"Token was about to expire, so has been renewed.\"", ")", "else", ":", "logging", ".", "debug", "(", "\"Token is still valid.\"", ")", "pass", "# let continue running the original function", "return", "decorated_func", "(", "self", ",", "*", "args", ",", "*", "*", "kwargs", ")", "return", "wrapper" ]

[ "Check", "API", "Bearer", "token", "validity", "." ]

[ "def", "search", "(", "self", ",", "token", ":", "dict", "=", "None", ",", "query", ":", "str", "=", "\"\"", ",", "bbox", ":", "list", "=", "None", ",", "poly", ":", "str", "=", "None", ",", "georel", ":", "str", "=", "None", ",", "order_by", ":", "str", "=", "\"_created\"", ",", "order_dir", ":", "str", "=", "\"desc\"", ",", "page_size", ":", "int", "=", "100", ",", "offset", ":", "int", "=", "0", ",", "share", ":", "str", "=", "None", ",", "specific_md", ":", "list", "=", "[", "]", ",", "include", ":", "list", "=", "[", "]", ",", "whole_share", ":", "bool", "=", "True", ",", "check", ":", "bool", "=", "True", ",", "augment", ":", "bool", "=", "False", ",", "tags_as_dicts", ":", "bool", "=", "False", ",", "prot", ":", "str", "=", "\"https\"", ",", ")", "->", "dict", ":", "# specific resources specific parsing", "specific_md", "=", "checker", ".", "_check_filter_specific_md", "(", "specific_md", ")", "# sub resources specific parsing", "include", "=", "checker", ".", "_check_filter_includes", "(", "include", ")", "# handling request parameters", "payload", "=", "{", "\"_id\"", ":", "specific_md", ",", "\"_include\"", ":", "include", ",", "\"_lang\"", ":", "self", ".", "lang", ",", "\"_limit\"", ":", "page_size", ",", "\"_offset\"", ":", "offset", ",", "\"box\"", ":", "bbox", ",", "\"geo\"", ":", "poly", ",", "\"rel\"", ":", "georel", ",", "\"ob\"", ":", "order_by", ",", "\"od\"", ":", "order_dir", ",", "\"q\"", ":", "query", ",", "\"s\"", ":", "share", ",", "}", "if", "check", ":", "checker", ".", "check_request_parameters", "(", "payload", ")", "else", ":", "pass", "# search request", "search_url", "=", "\"{}://v1.{}.isogeo.com/resources/search\"", ".", "format", "(", "prot", ",", "self", ".", "api_url", ")", "try", ":", "search_req", "=", "self", ".", "get", "(", "search_url", ",", "headers", "=", "self", ".", "header", ",", "params", "=", "payload", ",", "proxies", "=", "self", ".", "proxies", ",", "verify", "=", "self", ".", "ssl", ",", ")", "except", "Exception", "as", "e", ":", "logging", ".", "error", "(", "e", ")", "raise", "Exception", "# fast response check", "checker", ".", "check_api_response", "(", "search_req", ")", "# serializing result into dict and storing resources in variables", "search_rez", "=", "search_req", ".", "json", "(", ")", "resources_count", "=", "search_rez", ".", "get", "(", "\"total\"", ")", "# total of metadatas shared", "# handling Isogeo API pagination", "# see: http://help.isogeo.com/api/fr/methods/pagination.html", "if", "resources_count", ">", "page_size", "and", "whole_share", ":", "# if API returned more than one page of results, let's get the rest!", "metadatas", "=", "[", "]", "# a recipient list", "payload", "[", "\"_limit\"", "]", "=", "100", "# now it'll get pages of 100 resources", "# let's parse pages", "for", "idx", "in", "range", "(", "0", ",", "int", "(", "ceil", "(", "resources_count", "/", "100", ")", ")", "+", "1", ")", ":", "payload", "[", "\"_offset\"", "]", "=", "idx", "*", "100", "search_req", "=", "self", ".", "get", "(", "search_url", ",", "headers", "=", "self", ".", "header", ",", "params", "=", "payload", ",", "proxies", "=", "self", ".", "proxies", ",", "verify", "=", "self", ".", "ssl", ",", ")", "# storing results by addition", "metadatas", ".", "extend", "(", "search_req", ".", "json", "(", ")", ".", "get", "(", "\"results\"", ")", ")", "search_rez", "[", "\"results\"", "]", "=", "metadatas", "else", ":", "pass", "# add shares to tags and query", "if", "augment", ":", "self", ".", "add_tags_shares", "(", "search_rez", ".", "get", "(", "\"tags\"", ")", ")", "if", "share", ":", "search_rez", ".", "get", "(", "\"query\"", ")", "[", "\"_shares\"", "]", "=", "[", "share", "]", "else", ":", "search_rez", ".", "get", "(", "\"query\"", ")", "[", "\"_shares\"", "]", "=", "[", "]", "else", ":", "pass", "# store tags in dicts", "if", "tags_as_dicts", ":", "new_tags", "=", "utils", ".", "tags_to_dict", "(", "tags", "=", "search_rez", ".", "get", "(", "\"tags\"", ")", ",", "prev_query", "=", "search_rez", ".", "get", "(", "\"query\"", ")", ")", "# clear", "search_rez", ".", "get", "(", "\"tags\"", ")", ".", "clear", "(", ")", "search_rez", ".", "get", "(", "\"query\"", ")", ".", "clear", "(", ")", "# update", "search_rez", ".", "get", "(", "\"tags\"", ")", ".", "update", "(", "new_tags", "[", "0", "]", ")", "search_rez", ".", "get", "(", "\"query\"", ")", ".", "update", "(", "new_tags", "[", "1", "]", ")", "else", ":", "pass", "# end of method", "return", "search_rez" ]

[ "Search", "within", "the", "resources", "shared", "to", "the", "application", "." ]

[ "def", "resource", "(", "self", ",", "token", ":", "dict", "=", "None", ",", "id_resource", ":", "str", "=", "None", ",", "subresource", "=", "None", ",", "include", ":", "list", "=", "[", "]", ",", "prot", ":", "str", "=", "\"https\"", ",", ")", "->", "dict", ":", "# if subresource route", "if", "isinstance", "(", "subresource", ",", "str", ")", ":", "subresource", "=", "\"/{}\"", ".", "format", "(", "checker", ".", "_check_subresource", "(", "subresource", ")", ")", "else", ":", "subresource", "=", "\"\"", "# _includes specific parsing", "include", "=", "checker", ".", "_check_filter_includes", "(", "include", ")", "# handling request parameters", "payload", "=", "{", "\"id\"", ":", "id_resource", ",", "\"_include\"", ":", "include", "}", "# resource search", "md_url", "=", "\"{}://v1.{}.isogeo.com/resources/{}{}\"", ".", "format", "(", "prot", ",", "self", ".", "api_url", ",", "id_resource", ",", "subresource", ")", "resource_req", "=", "self", ".", "get", "(", "md_url", ",", "headers", "=", "self", ".", "header", ",", "params", "=", "payload", ",", "proxies", "=", "self", ".", "proxies", ",", "verify", "=", "self", ".", "ssl", ",", ")", "checker", ".", "check_api_response", "(", "resource_req", ")", "# end of method", "return", "resource_req", ".", "json", "(", ")" ]

[ "Get", "complete", "or", "partial", "metadata", "about", "one", "specific", "resource", "." ]

[ "def", "shares", "(", "self", ",", "token", ":", "dict", "=", "None", ",", "prot", ":", "str", "=", "\"https\"", ")", "->", "dict", ":", "# passing auth parameter", "shares_url", "=", "\"{}://v1.{}.isogeo.com/shares/\"", ".", "format", "(", "prot", ",", "self", ".", "api_url", ")", "shares_req", "=", "self", ".", "get", "(", "shares_url", ",", "headers", "=", "self", ".", "header", ",", "proxies", "=", "self", ".", "proxies", ",", "verify", "=", "self", ".", "ssl", ")", "# checking response", "checker", ".", "check_api_response", "(", "shares_req", ")", "# end of method", "return", "shares_req", ".", "json", "(", ")" ]

[ "Get", "information", "about", "shares", "which", "feed", "the", "application", "." ]

[ "def", "share", "(", "self", ",", "share_id", ":", "str", ",", "token", ":", "dict", "=", "None", ",", "augment", ":", "bool", "=", "False", ",", "prot", ":", "str", "=", "\"https\"", ",", ")", "->", "dict", ":", "# passing auth parameter", "share_url", "=", "\"{}://v1.{}.isogeo.com/shares/{}\"", ".", "format", "(", "prot", ",", "self", ".", "api_url", ",", "share_id", ")", "share_req", "=", "self", ".", "get", "(", "share_url", ",", "headers", "=", "self", ".", "header", ",", "proxies", "=", "self", ".", "proxies", ",", "verify", "=", "self", ".", "ssl", ")", "# checking response", "checker", ".", "check_api_response", "(", "share_req", ")", "# enhance share model", "share", "=", "share_req", ".", "json", "(", ")", "if", "augment", ":", "share", "=", "utils", ".", "share_extender", "(", "share", ",", "self", ".", "search", "(", "whole_share", "=", "1", ",", "share", "=", "share_id", ")", ".", "get", "(", "\"results\"", ")", ")", "else", ":", "pass", "# end of method", "return", "share" ]

[ "Get", "information", "about", "a", "specific", "share", "and", "its", "applications", "." ]

[ "def", "licenses", "(", "self", ",", "token", ":", "dict", "=", "None", ",", "owner_id", ":", "str", "=", "None", ",", "prot", ":", "str", "=", "\"https\"", ")", "->", "dict", ":", "# handling request parameters", "payload", "=", "{", "\"gid\"", ":", "owner_id", "}", "# search request", "licenses_url", "=", "\"{}://v1.{}.isogeo.com/groups/{}/licenses\"", ".", "format", "(", "prot", ",", "self", ".", "api_url", ",", "owner_id", ")", "licenses_req", "=", "self", ".", "get", "(", "licenses_url", ",", "headers", "=", "self", ".", "header", ",", "params", "=", "payload", ",", "proxies", "=", "self", ".", "proxies", ",", "verify", "=", "self", ".", "ssl", ",", ")", "# checking response", "req_check", "=", "checker", ".", "check_api_response", "(", "licenses_req", ")", "if", "isinstance", "(", "req_check", ",", "tuple", ")", ":", "return", "req_check", "# end of method", "return", "licenses_req", ".", "json", "(", ")" ]

[ "Get", "information", "about", "licenses", "owned", "by", "a", "specific", "workgroup", "." ]

[ "def", "license", "(", "self", ",", "license_id", ":", "str", ",", "token", ":", "dict", "=", "None", ",", "prot", ":", "str", "=", "\"https\"", ")", "->", "dict", ":", "# handling request parameters", "payload", "=", "{", "\"lid\"", ":", "license_id", "}", "# search request", "license_url", "=", "\"{}://v1.{}.isogeo.com/licenses/{}\"", ".", "format", "(", "prot", ",", "self", ".", "api_url", ",", "license_id", ")", "license_req", "=", "self", ".", "get", "(", "license_url", ",", "headers", "=", "self", ".", "header", ",", "params", "=", "payload", ",", "proxies", "=", "self", ".", "proxies", ",", "verify", "=", "self", ".", "ssl", ",", ")", "# checking response", "checker", ".", "check_api_response", "(", "license_req", ")", "# end of method", "return", "license_req", ".", "json", "(", ")" ]

[ "Get", "details", "about", "a", "specific", "license", "." ]

[ "def", "thesauri", "(", "self", ",", "token", ":", "dict", "=", "None", ",", "prot", ":", "str", "=", "\"https\"", ")", "->", "dict", ":", "# passing auth parameter", "thez_url", "=", "\"{}://v1.{}.isogeo.com/thesauri\"", ".", "format", "(", "prot", ",", "self", ".", "api_url", ")", "thez_req", "=", "self", ".", "get", "(", "thez_url", ",", "headers", "=", "self", ".", "header", ",", "proxies", "=", "self", ".", "proxies", ",", "verify", "=", "self", ".", "ssl", ")", "# checking response", "checker", ".", "check_api_response", "(", "thez_req", ")", "# end of method", "return", "thez_req", ".", "json", "(", ")" ]

[ "Get", "list", "of", "available", "thesauri", "." ]

[ "def", "thesaurus", "(", "self", ",", "token", ":", "dict", "=", "None", ",", "thez_id", ":", "str", "=", "\"1616597fbc4348c8b11ef9d59cf594c8\"", ",", "prot", ":", "str", "=", "\"https\"", ",", ")", "->", "dict", ":", "# handling request parameters", "payload", "=", "{", "\"tid\"", ":", "thez_id", "}", "# passing auth parameter", "thez_url", "=", "\"{}://v1.{}.isogeo.com/thesauri/{}\"", ".", "format", "(", "prot", ",", "self", ".", "api_url", ",", "thez_id", ")", "thez_req", "=", "self", ".", "get", "(", "thez_url", ",", "headers", "=", "self", ".", "header", ",", "params", "=", "payload", ",", "proxies", "=", "self", ".", "proxies", ",", "verify", "=", "self", ".", "ssl", ",", ")", "# checking response", "checker", ".", "check_api_response", "(", "thez_req", ")", "# end of method", "return", "thez_req", ".", "json", "(", ")" ]

[ "Get", "a", "thesaurus", "." ]

[ "def", "keywords", "(", "self", ",", "token", ":", "dict", "=", "None", ",", "thez_id", ":", "str", "=", "\"1616597fbc4348c8b11ef9d59cf594c8\"", ",", "query", ":", "str", "=", "\"\"", ",", "offset", ":", "int", "=", "0", ",", "order_by", ":", "str", "=", "\"text\"", ",", "order_dir", ":", "str", "=", "\"desc\"", ",", "page_size", ":", "int", "=", "20", ",", "specific_md", ":", "list", "=", "[", "]", ",", "specific_tag", ":", "list", "=", "[", "]", ",", "include", ":", "list", "=", "[", "]", ",", "prot", ":", "str", "=", "\"https\"", ",", ")", "->", "dict", ":", "# specific resources specific parsing", "specific_md", "=", "checker", ".", "_check_filter_specific_md", "(", "specific_md", ")", "# sub resources specific parsing", "include", "=", "checker", ".", "_check_filter_includes", "(", "include", ",", "\"keyword\"", ")", "# specific tag specific parsing", "specific_tag", "=", "checker", ".", "_check_filter_specific_tag", "(", "specific_tag", ")", "# handling request parameters", "payload", "=", "{", "\"_id\"", ":", "specific_md", ",", "\"_include\"", ":", "include", ",", "\"_limit\"", ":", "page_size", ",", "\"_offset\"", ":", "offset", ",", "\"_tag\"", ":", "specific_tag", ",", "\"tid\"", ":", "thez_id", ",", "\"ob\"", ":", "order_by", ",", "\"od\"", ":", "order_dir", ",", "\"q\"", ":", "query", ",", "}", "# search request", "keywords_url", "=", "\"{}://v1.{}.isogeo.com/thesauri/{}/keywords/search\"", ".", "format", "(", "prot", ",", "self", ".", "api_url", ",", "thez_id", ")", "kwds_req", "=", "self", ".", "get", "(", "keywords_url", ",", "headers", "=", "self", ".", "header", ",", "params", "=", "payload", ",", "proxies", "=", "self", ".", "proxies", ",", "verify", "=", "self", ".", "ssl", ",", ")", "# checking response", "checker", ".", "check_api_response", "(", "kwds_req", ")", "# end of method", "return", "kwds_req", ".", "json", "(", ")" ]

[ "Search", "for", "keywords", "within", "a", "specific", "thesaurus", "." ]

[ "def", "dl_hosted", "(", "self", ",", "token", ":", "dict", "=", "None", ",", "resource_link", ":", "dict", "=", "None", ",", "encode_clean", ":", "bool", "=", "1", ",", "proxy_url", ":", "str", "=", "None", ",", "prot", ":", "str", "=", "\"https\"", ",", ")", "->", "tuple", ":", "# check resource link parameter type", "if", "not", "isinstance", "(", "resource_link", ",", "dict", ")", ":", "raise", "TypeError", "(", "\"Resource link expects a dictionary.\"", ")", "else", ":", "pass", "# check resource link type", "if", "not", "resource_link", ".", "get", "(", "\"type\"", ")", "==", "\"hosted\"", ":", "raise", "ValueError", "(", "\"Resource link passed is not a hosted one: {}\"", ".", "format", "(", "resource_link", ".", "get", "(", "\"type\"", ")", ")", ")", "else", ":", "pass", "# handling request parameters", "payload", "=", "{", "\"proxyUrl\"", ":", "proxy_url", "}", "# prepare URL request", "hosted_url", "=", "\"{}://v1.{}.isogeo.com/{}\"", ".", "format", "(", "prot", ",", "self", ".", "api_url", ",", "resource_link", ".", "get", "(", "\"url\"", ")", ")", "# send stream request", "hosted_req", "=", "self", ".", "get", "(", "hosted_url", ",", "headers", "=", "self", ".", "header", ",", "stream", "=", "True", ",", "params", "=", "payload", ",", "proxies", "=", "self", ".", "proxies", ",", "verify", "=", "self", ".", "ssl", ",", ")", "# quick check", "req_check", "=", "checker", ".", "check_api_response", "(", "hosted_req", ")", "if", "not", "req_check", ":", "raise", "ConnectionError", "(", "req_check", "[", "1", "]", ")", "else", ":", "pass", "# get filename from header", "content_disposition", "=", "hosted_req", ".", "headers", ".", "get", "(", "\"Content-Disposition\"", ")", "if", "content_disposition", ":", "filename", "=", "re", ".", "findall", "(", "\"filename=(.+)\"", ",", "content_disposition", ")", "[", "0", "]", "else", ":", "filename", "=", "resource_link", ".", "get", "(", "\"title\"", ")", "# remove special characters", "if", "encode_clean", ":", "filename", "=", "utils", ".", "encoded_words_to_text", "(", "filename", ")", "filename", "=", "re", ".", "sub", "(", "r\"[^\\w\\-_\\. ]\"", ",", "\"\"", ",", "filename", ")", "# well-formed size", "in_size", "=", "resource_link", ".", "get", "(", "\"size\"", ")", "for", "size_cat", "in", "(", "\"octets\"", ",", "\"Ko\"", ",", "\"Mo\"", ",", "\"Go\"", ")", ":", "if", "in_size", "<", "1024.0", ":", "out_size", "=", "\"%3.1f %s\"", "%", "(", "in_size", ",", "size_cat", ")", "in_size", "/=", "1024.0", "out_size", "=", "\"%3.1f %s\"", "%", "(", "in_size", ",", "\" To\"", ")", "# end of method", "return", "(", "hosted_req", ",", "filename", ",", "out_size", ")" ]

[ "Download", "hosted", "resource", "." ]

[ "def", "xml19139", "(", "self", ",", "token", ":", "dict", "=", "None", ",", "id_resource", ":", "str", "=", "None", ",", "proxy_url", "=", "None", ",", "prot", ":", "str", "=", "\"https\"", ",", ")", ":", "# check metadata UUID", "if", "not", "checker", ".", "check_is_uuid", "(", "id_resource", ")", ":", "raise", "ValueError", "(", "\"Metadata ID is not a correct UUID.\"", ")", "else", ":", "pass", "# handling request parameters", "payload", "=", "{", "\"proxyUrl\"", ":", "proxy_url", ",", "\"id\"", ":", "id_resource", "}", "# resource search", "md_url", "=", "\"{}://v1.{}.isogeo.com/resources/{}.xml\"", ".", "format", "(", "prot", ",", "self", ".", "api_url", ",", "id_resource", ")", "xml_req", "=", "self", ".", "get", "(", "md_url", ",", "headers", "=", "self", ".", "header", ",", "stream", "=", "True", ",", "params", "=", "payload", ",", "proxies", "=", "self", ".", "proxies", ",", "verify", "=", "self", ".", "ssl", ",", ")", "# end of method", "return", "xml_req" ]

[ "Get", "resource", "exported", "into", "XML", "ISO", "19139", "." ]

[ "def", "add_tags_shares", "(", "self", ",", "tags", ":", "dict", "=", "dict", "(", ")", ")", ":", "# check if shares_id have already been retrieved or not", "if", "not", "hasattr", "(", "self", ",", "\"shares_id\"", ")", ":", "shares", "=", "self", ".", "shares", "(", ")", "self", ".", "shares_id", "=", "{", "\"share:{}\"", ".", "format", "(", "i", ".", "get", "(", "\"_id\"", ")", ")", ":", "i", ".", "get", "(", "\"name\"", ")", "for", "i", "in", "shares", "}", "else", ":", "pass", "# update query tags", "tags", ".", "update", "(", "self", ".", "shares_id", ")" ]

[ "Add", "shares", "list", "to", "the", "tags", "attributes", "in", "search", "results", "." ]

[ "def", "get_app_properties", "(", "self", ",", "token", ":", "dict", "=", "None", ",", "prot", ":", "str", "=", "\"https\"", ")", ":", "# check if app properties have already been retrieved or not", "if", "not", "hasattr", "(", "self", ",", "\"app_properties\"", ")", ":", "first_app", "=", "self", ".", "shares", "(", ")", "[", "0", "]", ".", "get", "(", "\"applications\"", ")", "[", "0", "]", "app", "=", "{", "\"admin_url\"", ":", "\"{}/applications/{}\"", ".", "format", "(", "self", ".", "mng_url", ",", "first_app", ".", "get", "(", "\"_id\"", ")", ")", ",", "\"creation_date\"", ":", "first_app", ".", "get", "(", "\"_created\"", ")", ",", "\"last_update\"", ":", "first_app", ".", "get", "(", "\"_modified\"", ")", ",", "\"name\"", ":", "first_app", ".", "get", "(", "\"name\"", ")", ",", "\"type\"", ":", "first_app", ".", "get", "(", "\"type\"", ")", ",", "\"kind\"", ":", "first_app", ".", "get", "(", "\"kind\"", ")", ",", "\"url\"", ":", "first_app", ".", "get", "(", "\"url\"", ")", ",", "}", "self", ".", "app_properties", "=", "app", "else", ":", "pass" ]

[ "Get", "information", "about", "the", "application", "declared", "on", "Isogeo", "." ]

[ "def", "get_directives", "(", "self", ",", "token", ":", "dict", "=", "None", ",", "prot", ":", "str", "=", "\"https\"", ")", "->", "dict", ":", "# search request", "req_url", "=", "\"{}://v1.{}.isogeo.com/directives\"", ".", "format", "(", "prot", ",", "self", ".", "api_url", ")", "req", "=", "self", ".", "get", "(", "req_url", ",", "headers", "=", "self", ".", "header", ",", "proxies", "=", "self", ".", "proxies", ",", "verify", "=", "self", ".", "ssl", ")", "# checking response", "checker", ".", "check_api_response", "(", "req", ")", "# end of method", "return", "req", ".", "json", "(", ")" ]

[ "Get", "environment", "directives", "which", "represent", "INSPIRE", "limitations", "." ]

[ "def", "get_coordinate_systems", "(", "self", ",", "token", ":", "dict", "=", "None", ",", "srs_code", ":", "str", "=", "None", ",", "prot", ":", "str", "=", "\"https\"", ")", "->", "dict", ":", "# if specific format", "if", "isinstance", "(", "srs_code", ",", "str", ")", ":", "specific_srs", "=", "\"/{}\"", ".", "format", "(", "srs_code", ")", "else", ":", "specific_srs", "=", "\"\"", "# search request", "req_url", "=", "\"{}://v1.{}.isogeo.com/coordinate-systems{}\"", ".", "format", "(", "prot", ",", "self", ".", "api_url", ",", "specific_srs", ")", "req", "=", "self", ".", "get", "(", "req_url", ",", "headers", "=", "self", ".", "header", ",", "proxies", "=", "self", ".", "proxies", ",", "verify", "=", "self", ".", "ssl", ")", "# checking response", "checker", ".", "check_api_response", "(", "req", ")", "# end of method", "return", "req", ".", "json", "(", ")" ]

[ "Get", "available", "coordinate", "systems", "in", "Isogeo", "API", "." ]

[ "def", "get_formats", "(", "self", ",", "token", ":", "dict", "=", "None", ",", "format_code", ":", "str", "=", "None", ",", "prot", ":", "str", "=", "\"https\"", ")", "->", "dict", ":", "# if specific format", "if", "isinstance", "(", "format_code", ",", "str", ")", ":", "specific_format", "=", "\"/{}\"", ".", "format", "(", "format_code", ")", "else", ":", "specific_format", "=", "\"\"", "# search request", "req_url", "=", "\"{}://v1.{}.isogeo.com/formats{}\"", ".", "format", "(", "prot", ",", "self", ".", "api_url", ",", "specific_format", ")", "req", "=", "self", ".", "get", "(", "req_url", ",", "headers", "=", "self", ".", "header", ",", "proxies", "=", "self", ".", "proxies", ",", "verify", "=", "self", ".", "ssl", ")", "# checking response", "checker", ".", "check_api_response", "(", "req", ")", "# end of method", "return", "req", ".", "json", "(", ")" ]

[ "Get", "formats", "." ]

[ "def", "parse_bool", "(", "v", ",", "default", "=", "None", ",", "exceptions", ":", "bool", "=", "True", ")", "->", "bool", ":", "if", "isinstance", "(", "v", ",", "bool", ")", ":", "return", "v", "s", "=", "str", "(", "v", ")", ".", "lower", "(", ")", "if", "s", "in", "TRUE_VALUES", ":", "return", "True", "elif", "s", "in", "FALSE_VALUES", ":", "return", "False", "else", ":", "if", "exceptions", ":", "raise", "ValidationError", "(", "'Failed to parse boolean from \"{}\"'", ".", "format", "(", "v", ")", ")", "return", "default" ]

[ "Parses", "boolean", "value", ":", "param", "v", ":", "Input", "string", ":", "param", "default", ":", "Default", "value", "if", "exceptions", "=", "False", ":", "param", "exceptions", ":", "Raise", "exception", "on", "error", "or", "not", ":", "return", ":", "bool" ]

[ "def", "parse_datetime", "(", "v", ",", "default", "=", "None", ",", "tz", "=", "None", ",", "exceptions", ":", "bool", "=", "True", ")", "->", "datetime", ":", "try", ":", "t", "=", "dateutil_parse", "(", "v", ",", "default", "=", "datetime", "(", "2000", ",", "1", ",", "1", ")", ")", "if", "tz", "is", "None", ":", "tz", "=", "pytz", ".", "utc", "return", "t", "if", "t", ".", "tzinfo", "else", "tz", ".", "localize", "(", "t", ")", "except", "Exception", ":", "if", "exceptions", ":", "raise", "ValidationError", "(", "'Failed to parse datetime from \"{}\"'", ".", "format", "(", "v", ")", ")", "return", "default" ]

[ "Parses", "datetime", ":", "param", "v", ":", "Input", "string", ":", "param", "default", ":", "Default", "value", "if", "exceptions", "=", "False", ":", "param", "tz", ":", "Default", "pytz", "timezone", "or", "None", "if", "utc", ":", "param", "exceptions", ":", "Raise", "exception", "on", "error", "or", "not", ":", "return", ":", "datetime" ]

[ "def", "convert_boolean", "(", "string_value", ")", ":", "lean_string_value", "=", "string_value", ".", "strip", "(", ")", ".", "lower", "(", ")", "if", "lean_string_value", "in", "[", "'yes'", ",", "'true'", ",", "'on'", ",", "'1'", "]", ":", "return", "True", "elif", "lean_string_value", "in", "[", "'no'", ",", "'false'", ",", "'off'", ",", "'0'", "]", ":", "return", "False", "# Not recognised boolean if we get here", "raise", "ValueError", "(", "'Unrecognised boolean ({})'", ".", "format", "(", "lean_string_value", ")", ")" ]

[ "Converts", "a", "string", "to", "a", "boolean", "(", "see", "CONVERTERS", ")", ".", "There", "is", "a", "converter", "function", "for", "each", "column", "type", "." ]

[ "def", "_handle_hdr", "(", "self", ",", "hdr", ")", ":", "column_number", "=", "1", "for", "cell", "in", "hdr", ":", "cell_parts", "=", "cell", ".", "split", "(", "self", ".", "_type_sep", ")", "if", "len", "(", "cell_parts", ")", "not", "in", "[", "1", ",", "2", "]", ":", "raise", "ContentError", "(", "column_number", ",", "self", ".", "_c_reader", ".", "line_num", ",", "cell", ",", "'Expected name and type (up to 2 items)'", ")", "name", "=", "cell_parts", "[", "0", "]", ".", "strip", "(", ")", "if", "len", "(", "name", ")", "==", "0", ":", "raise", "ContentError", "(", "column_number", ",", "self", ".", "_c_reader", ".", "line_num", ",", "cell", ",", "'Column name is empty'", ")", "if", "name", "in", "self", ".", "_column_names", ":", "raise", "ContentError", "(", "column_number", ",", "self", ".", "_c_reader", ".", "line_num", ",", "name", ",", "'Duplicate column name'", ")", "if", "len", "(", "cell_parts", ")", "==", "2", ":", "column_type", "=", "cell_parts", "[", "1", "]", ".", "strip", "(", ")", ".", "lower", "(", ")", "if", "column_type", "not", "in", "CONVERTERS", ":", "raise", "UnknownTypeError", "(", "column_number", ",", "column_type", ")", "else", ":", "# Unspecified - assume built-in 'string'", "column_type", "=", "'string'", "self", ".", "_converters", ".", "append", "(", "[", "name", ",", "CONVERTERS", "[", "column_type", "]", "]", ")", "self", ".", "_column_names", ".", "append", "(", "name", ")", "column_number", "+=", "1" ]

[ "Given", "the", "file", "header", "line", "(", "or", "one", "provided", "when", "the", "object", "is", "instantiated", ")", "this", "method", "populates", "the", "self", ".", "_converters", "array", "a", "list", "of", "type", "converters", "indexed", "by", "the", "column", "name", "." ]

[ "def", "search_datasets", "(", "self", ",", "license", "=", "None", ",", "format", "=", "None", ",", "query", "=", "None", ",", "featured", "=", "None", ",", "owner", "=", "None", ",", "organization", "=", "None", ",", "badge", "=", "None", ",", "reuses", "=", "None", ",", "page_size", "=", "20", ",", "x_fields", "=", "None", ",", ")", ":", "# handling request parameters", "payload", "=", "{", "\"badge\"", ":", "badge", ",", "\"size\"", ":", "page_size", ",", "\"X-Fields\"", ":", "x_fields", "}", "# search request", "# head = {\"X-API-KEY\": self.api_key}", "search_url", "=", "\"{}/datasets\"", ".", "format", "(", "self", ".", "base_url", ",", "# org_id,", "# page_size", ")", "search_req", "=", "requests", ".", "get", "(", "search_url", ",", "# headers=head,", "params", "=", "payload", ",", ")", "# serializing result into dict and storing resources in variables", "logger", ".", "debug", "(", "search_req", ".", "url", ")", "return", "search_req", ".", "json", "(", ")" ]

[ "Search", "datasets", "within", "uData", "portal", "." ]

[ "def", "get_filters_values", "(", "self", ")", ":", "# DATASETS --", "# badges", "self", ".", "_DST_BADGES", "=", "requests", ".", "get", "(", "self", ".", "base_url", "+", "\"datasets/badges/\"", ")", ".", "json", "(", ")", "# licences", "self", ".", "_DST_LICENSES", "=", "{", "l", ".", "get", "(", "\"id\"", ")", ":", "l", ".", "get", "(", "\"title\"", ")", "for", "l", "in", "requests", ".", "get", "(", "self", ".", "base_url", "+", "\"datasets/licenses\"", ")", ".", "json", "(", ")", "}", "# frequencies", "self", ".", "_DST_FREQUENCIES", "=", "{", "f", ".", "get", "(", "\"id\"", ")", ":", "f", ".", "get", "(", "\"label\"", ")", "for", "f", "in", "requests", ".", "get", "(", "self", ".", "base_url", "+", "\"datasets/frequencies\"", ")", ".", "json", "(", ")", "}", "# ORGANIZATIONS --", "# badges", "self", ".", "_ORG_BADGES", "=", "requests", ".", "get", "(", "self", ".", "base_url", "+", "\"organizations/badges/\"", ")", ".", "json", "(", ")", "# # licences", "# self._DST_LICENSES = {l.get(\"id\"): l.get(\"title\")", "# for l in requests.get(self.base_url + \"datasets/licenses\").json()}", "# # frequencies", "# self._DST_FREQUENCIES = {f.get(\"id\"): f.get(\"label\")", "# for f in requests.get(self.base_url + \"datasets/frequencies\").json()}", "# SPATIAL --", "# granularities", "self", ".", "_GRANULARITIES", "=", "{", "g", ".", "get", "(", "\"id\"", ")", ":", "g", ".", "get", "(", "\"name\"", ")", "for", "g", "in", "requests", ".", "get", "(", "self", ".", "base_url", "+", "\"spatial/granularities\"", ")", ".", "json", "(", ")", "}", "# levels", "self", ".", "_LEVELS", "=", "{", "g", ".", "get", "(", "\"id\"", ")", ":", "g", ".", "get", "(", "\"name\"", ")", "for", "g", "in", "requests", ".", "get", "(", "self", ".", "base_url", "+", "\"spatial/levels\"", ")", ".", "json", "(", ")", "}", "# MISC --", "# facets", "self", ".", "_FACETS", "=", "(", "\"all\"", ",", "\"badge\"", ",", "\"featured\"", ",", "\"format\"", ",", "\"geozone\"", ",", "\"granularity\"", ",", "\"license\"", ",", "\"owner\"", ",", "\"organization\"", ",", "\"reuses\"", ",", "\"tag\"", ",", "\"temporal_coverage\"", ",", ")", "# reuses", "self", ".", "_REUSES", "=", "(", "\"none\"", ",", "\"few\"", ",", "\"quite\"", ",", "\"many\"", ")" ]

[ "Get", "different", "filters", "values", "as", "dicts", "." ]

[ "def", "deploy", "(", "app_id", ",", "version", ",", "promote", ",", "quiet", ")", ":", "# type: (str, str, bool, bool) -> None", "gae_app", "=", "GaeApp", ".", "for_branch", "(", "git", ".", "current_branch", "(", ")", ".", "name", ")", "if", "gae_app", "is", "None", "and", "None", "in", "(", "app_id", ",", "version", ")", ":", "msg", "=", "(", "\"Can't find an AppEngine app setup for branch <35>{}<32> and\"", "\"--project and --version were not given.\"", ")", "log", ".", "err", "(", "msg", ",", "git", ".", "current_branch", "(", ")", ".", "name", ")", "sys", ".", "exit", "(", "1", ")", "if", "version", "is", "not", "None", ":", "gae_app", ".", "version", "=", "version", "if", "app_id", "is", "not", "None", ":", "gae_app", ".", "app_id", "=", "app_id", "gae_app", ".", "deploy", "(", "promote", ",", "quiet", ")" ]

[ "Deploy", "the", "app", "to", "AppEngine", "." ]

[ "def", "devserver", "(", "port", ",", "admin_port", ",", "clear", ")", ":", "# type: (int, int, bool) -> None", "admin_port", "=", "admin_port", "or", "(", "port", "+", "1", ")", "args", "=", "[", "'--port={}'", ".", "format", "(", "port", ")", ",", "'--admin_port={}'", ".", "format", "(", "admin_port", ")", "]", "if", "clear", ":", "args", "+=", "[", "'--clear_datastore=yes'", "]", "with", "conf", ".", "within_proj_dir", "(", ")", ":", "shell", ".", "run", "(", "'dev_appserver.py . {args}'", ".", "format", "(", "args", "=", "' '", ".", "join", "(", "args", ")", ")", ")" ]

[ "Run", "devserver", "." ]

[ "def", "setup_ci", "(", ")", ":", "# type: () -> None", "gcloud_path", "=", "shell", ".", "run", "(", "'which gcloud'", ",", "capture", "=", "True", ")", ".", "stdout", ".", "strip", "(", ")", "sdk_path", "=", "normpath", "(", "join", "(", "gcloud_path", ",", "'../../platform/google_appengine'", ")", ")", "gcloud_cmd", "=", "gcloud_path", "+", "' --quiet'", "if", "not", "exists", "(", "sdk_path", ")", ":", "log", ".", "info", "(", "\"Installing AppEngine SDK\"", ")", "shell", ".", "run", "(", "'sudo {} components install app-engine-python'", ".", "format", "(", "gcloud_cmd", ")", ")", "else", ":", "# Only initialise once. To reinitialise, just build without cache.", "log", ".", "info", "(", "\"AppEngine SDK already initialised\"", ")", "log", ".", "info", "(", "\"Using service account authentication\"", ")", "shell", ".", "run", "(", "'{} auth activate-service-account --key-file {}'", ".", "format", "(", "gcloud_cmd", ",", "conf", ".", "proj_path", "(", "'ops/client_secret.json'", ")", ")", ")" ]

[ "Setup", "AppEngine", "SDK", "on", "CircleCI" ]

[ "def", "mark_experimental", "(", "fn", ")", ":", "# type: (FunctionType) -> FunctionType", "@", "wraps", "(", "fn", ")", "def", "wrapper", "(", "*", "args", ",", "*", "*", "kw", ")", ":", "# pylint: disable=missing-docstring", "from", "peltak", ".", "core", "import", "shell", "if", "shell", ".", "is_tty", ":", "warnings", ".", "warn", "(", "\"This command is has experimental status. The \"", "\"interface is not yet stable and might change \"", "\"without notice within with a patch version update. \"", "\"Use at your own risk\"", ")", "return", "fn", "(", "*", "args", ",", "*", "*", "kw", ")", "return", "wrapper" ]

[ "Mark", "function", "as", "experimental", "." ]

[ "def", "mark_deprecated", "(", "replaced_by", ")", ":", "# type: (Text) -> FunctionType", "def", "decorator", "(", "fn", ")", ":", "# pylint: disable=missing-docstring", "@", "wraps", "(", "fn", ")", "def", "wrapper", "(", "*", "args", ",", "*", "*", "kw", ")", ":", "# pylint: disable=missing-docstring", "from", "peltak", ".", "core", "import", "shell", "if", "shell", ".", "is_tty", ":", "warnings", ".", "warn", "(", "\"This command is has been deprecated. Please use \"", "\"{new} instead.\"", ".", "format", "(", "new", "=", "replaced_by", ")", ")", "return", "fn", "(", "*", "args", ",", "*", "*", "kw", ")", "return", "wrapper", "return", "decorator" ]

[ "Mark", "command", "as", "deprecated", "." ]

[ "def", "in_batches", "(", "iterable", ",", "batch_size", ")", ":", "# type: (Iterable[Any]) -> Generator[List[Any]]", "items", "=", "list", "(", "iterable", ")", "size", "=", "len", "(", "items", ")", "for", "i", "in", "range", "(", "0", ",", "size", ",", "batch_size", ")", ":", "yield", "items", "[", "i", ":", "min", "(", "i", "+", "batch_size", ",", "size", ")", "]" ]

[ "Split", "the", "given", "iterable", "into", "batches", "." ]

[ "def", "yaml_dump", "(", "data", ",", "stream", "=", "None", ")", ":", "# type: (YamlData, Optional[TextIO]) -> Text", "return", "yaml", ".", "dump", "(", "data", ",", "stream", "=", "stream", ",", "Dumper", "=", "Dumper", ",", "default_flow_style", "=", "False", ")" ]

[ "Dump", "data", "to", "a", "YAML", "string", "/", "file", "." ]

[ "def", "clear", "(", "cls", ",", "fn", ")", ":", "# type: (FunctionType) -> None", "if", "hasattr", "(", "fn", ",", "cls", ".", "CACHE_VAR", ")", ":", "delattr", "(", "fn", ",", "cls", ".", "CACHE_VAR", ")" ]

[ "Clear", "result", "cache", "on", "the", "given", "function", "." ]

[ "def", "start", "(", "name", ")", ":", "# type: (str) -> None", "branch", "=", "git", ".", "current_branch", "(", "refresh", "=", "True", ")", "task_branch", "=", "'task/'", "+", "common", ".", "to_branch_name", "(", "name", ")", "if", "branch", ".", "type", "not", "in", "(", "'feature'", ",", "'hotfix'", ")", ":", "log", ".", "err", "(", "\"Task branches can only branch off <33>feature<32> or \"", "\"<33>hotfix<32> branches\"", ")", "sys", ".", "exit", "(", "1", ")", "common", ".", "git_checkout", "(", "task_branch", ",", "create", "=", "True", ")" ]

[ "Start", "working", "on", "a", "new", "feature", "by", "branching", "off", "develop", "." ]

[ "def", "update", "(", ")", ":", "# type: () -> None", "branch", "=", "git", ".", "current_branch", "(", "refresh", "=", "True", ")", "base_branch", "=", "common", ".", "get_base_branch", "(", ")", "common", ".", "assert_branch_type", "(", "'task'", ")", "common", ".", "git_checkout", "(", "base_branch", ")", "common", ".", "git_pull", "(", "base_branch", ")", "common", ".", "git_checkout", "(", "branch", ".", "name", ")", "common", ".", "git_merge", "(", "branch", ".", "name", ",", "base_branch", ")" ]

[ "Update", "the", "feature", "with", "updates", "committed", "to", "develop", "." ]

[ "def", "finish", "(", ")", ":", "# type: () -> None", "pretend", "=", "context", ".", "get", "(", "'pretend'", ",", "False", ")", "if", "not", "pretend", "and", "(", "git", ".", "staged", "(", ")", "or", "git", ".", "unstaged", "(", ")", ")", ":", "log", ".", "err", "(", "\"You have uncommitted changes in your repo!\\n\"", "\"You need to stash them before you merge the hotfix branch\"", ")", "sys", ".", "exit", "(", "1", ")", "branch", "=", "git", ".", "current_branch", "(", "refresh", "=", "True", ")", "base", "=", "common", ".", "get_base_branch", "(", ")", "prompt", "=", "\"<32>Merge <33>{}<32> into <33>{}<0>?\"", ".", "format", "(", "branch", ".", "name", ",", "base", ")", "if", "not", "click", ".", "confirm", "(", "shell", ".", "fmt", "(", "prompt", ")", ")", ":", "log", ".", "info", "(", "\"Cancelled\"", ")", "return", "common", ".", "assert_branch_type", "(", "'task'", ")", "# Merge task into it's base feature branch", "common", ".", "git_checkout", "(", "base", ")", "common", ".", "git_pull", "(", "base", ")", "common", ".", "git_merge", "(", "base", ",", "branch", ".", "name", ")", "# Cleanup", "common", ".", "git_branch_delete", "(", "branch", ".", "name", ")", "common", ".", "git_prune", "(", ")", "common", ".", "git_checkout", "(", "base", ")" ]

[ "Merge", "current", "feature", "branch", "into", "develop", "." ]

[ "def", "merged", "(", ")", ":", "# type: () -> None", "base_branch", "=", "common", ".", "get_base_branch", "(", ")", "branch", "=", "git", ".", "current_branch", "(", "refresh", "=", "True", ")", "common", ".", "assert_branch_type", "(", "'task'", ")", "# Pull feature branch with the merged task", "common", ".", "git_checkout", "(", "base_branch", ")", "common", ".", "git_pull", "(", "base_branch", ")", "# Cleanup", "common", ".", "git_branch_delete", "(", "branch", ".", "name", ")", "common", ".", "git_prune", "(", ")", "common", ".", "git_checkout", "(", "base_branch", ")" ]

[ "Cleanup", "a", "remotely", "merged", "branch", "." ]

[ "def", "mutagen_call", "(", "action", ",", "path", ",", "func", ",", "*", "args", ",", "*", "*", "kwargs", ")", ":", "try", ":", "return", "func", "(", "*", "args", ",", "*", "*", "kwargs", ")", "except", "mutagen", ".", "MutagenError", "as", "exc", ":", "log", ".", "debug", "(", "u'%s failed: %s'", ",", "action", ",", "six", ".", "text_type", "(", "exc", ")", ")", "raise", "UnreadableFileError", "(", "path", ",", "six", ".", "text_type", "(", "exc", ")", ")", "except", "Exception", "as", "exc", ":", "# Isolate bugs in Mutagen.", "log", ".", "debug", "(", "u'%s'", ",", "traceback", ".", "format_exc", "(", ")", ")", "log", ".", "error", "(", "u'uncaught Mutagen exception in %s: %s'", ",", "action", ",", "exc", ")", "raise", "MutagenError", "(", "path", ",", "exc", ")" ]

[ "Call", "a", "Mutagen", "function", "with", "appropriate", "error", "handling", "." ]

[ "def", "_safe_cast", "(", "out_type", ",", "val", ")", ":", "if", "val", "is", "None", ":", "return", "None", "if", "out_type", "==", "int", ":", "if", "isinstance", "(", "val", ",", "int", ")", "or", "isinstance", "(", "val", ",", "float", ")", ":", "# Just a number.", "return", "int", "(", "val", ")", "else", ":", "# Process any other type as a string.", "if", "isinstance", "(", "val", ",", "bytes", ")", ":", "val", "=", "val", ".", "decode", "(", "'utf-8'", ",", "'ignore'", ")", "elif", "not", "isinstance", "(", "val", ",", "six", ".", "string_types", ")", ":", "val", "=", "six", ".", "text_type", "(", "val", ")", "# Get a number from the front of the string.", "match", "=", "re", ".", "match", "(", "r'[\\+-]?[0-9]+'", ",", "val", ".", "strip", "(", ")", ")", "return", "int", "(", "match", ".", "group", "(", "0", ")", ")", "if", "match", "else", "0", "elif", "out_type", "==", "bool", ":", "try", ":", "# Should work for strings, bools, ints:", "return", "bool", "(", "int", "(", "val", ")", ")", "except", "ValueError", ":", "return", "False", "elif", "out_type", "==", "six", ".", "text_type", ":", "if", "isinstance", "(", "val", ",", "bytes", ")", ":", "return", "val", ".", "decode", "(", "'utf-8'", ",", "'ignore'", ")", "elif", "isinstance", "(", "val", ",", "six", ".", "text_type", ")", ":", "return", "val", "else", ":", "return", "six", ".", "text_type", "(", "val", ")", "elif", "out_type", "==", "float", ":", "if", "isinstance", "(", "val", ",", "int", ")", "or", "isinstance", "(", "val", ",", "float", ")", ":", "return", "float", "(", "val", ")", "else", ":", "if", "isinstance", "(", "val", ",", "bytes", ")", ":", "val", "=", "val", ".", "decode", "(", "'utf-8'", ",", "'ignore'", ")", "else", ":", "val", "=", "six", ".", "text_type", "(", "val", ")", "match", "=", "re", ".", "match", "(", "r'[\\+-]?([0-9]+\\.?[0-9]*|[0-9]*\\.[0-9]+)'", ",", "val", ".", "strip", "(", ")", ")", "if", "match", ":", "val", "=", "match", ".", "group", "(", "0", ")", "if", "val", ":", "return", "float", "(", "val", ")", "return", "0.0", "else", ":", "return", "val" ]

[ "Try", "to", "covert", "val", "to", "out_type", "but", "never", "raise", "an", "exception", ".", "If", "the", "value", "can", "t", "be", "converted", "then", "a", "sensible", "default", "value", "is", "returned", ".", "out_type", "should", "be", "bool", "int", "or", "unicode", ";", "otherwise", "the", "value", "is", "just", "passed", "through", "." ]

[ "def", "_unpack_asf_image", "(", "data", ")", ":", "type", ",", "size", "=", "struct", ".", "unpack_from", "(", "'<bi'", ",", "data", ")", "pos", "=", "5", "mime", "=", "b''", "while", "data", "[", "pos", ":", "pos", "+", "2", "]", "!=", "b'\\x00\\x00'", ":", "mime", "+=", "data", "[", "pos", ":", "pos", "+", "2", "]", "pos", "+=", "2", "pos", "+=", "2", "description", "=", "b''", "while", "data", "[", "pos", ":", "pos", "+", "2", "]", "!=", "b'\\x00\\x00'", ":", "description", "+=", "data", "[", "pos", ":", "pos", "+", "2", "]", "pos", "+=", "2", "pos", "+=", "2", "image_data", "=", "data", "[", "pos", ":", "pos", "+", "size", "]", "return", "(", "mime", ".", "decode", "(", "\"utf-16-le\"", ")", ",", "image_data", ",", "type", ",", "description", ".", "decode", "(", "\"utf-16-le\"", ")", ")" ]

[ "Unpack", "image", "data", "from", "a", "WM", "/", "Picture", "tag", ".", "Return", "a", "tuple", "containing", "the", "MIME", "type", "the", "raw", "image", "data", "a", "type", "indicator", "and", "the", "image", "s", "description", "." ]

[ "def", "_pack_asf_image", "(", "mime", ",", "data", ",", "type", "=", "3", ",", "description", "=", "\"\"", ")", ":", "tag_data", "=", "struct", ".", "pack", "(", "'<bi'", ",", "type", ",", "len", "(", "data", ")", ")", "tag_data", "+=", "mime", ".", "encode", "(", "\"utf-16-le\"", ")", "+", "b'\\x00\\x00'", "tag_data", "+=", "description", ".", "encode", "(", "\"utf-16-le\"", ")", "+", "b'\\x00\\x00'", "tag_data", "+=", "data", "return", "tag_data" ]

[ "Pack", "image", "data", "for", "a", "WM", "/", "Picture", "tag", "." ]

[ "def", "_sc_decode", "(", "soundcheck", ")", ":", "# We decode binary data. If one of the formats gives us a text", "# string, interpret it as UTF-8.", "if", "isinstance", "(", "soundcheck", ",", "six", ".", "text_type", ")", ":", "soundcheck", "=", "soundcheck", ".", "encode", "(", "'utf-8'", ")", "# SoundCheck tags consist of 10 numbers, each represented by 8", "# characters of ASCII hex preceded by a space.", "try", ":", "soundcheck", "=", "codecs", ".", "decode", "(", "soundcheck", ".", "replace", "(", "b' '", ",", "b''", ")", ",", "'hex'", ")", "soundcheck", "=", "struct", ".", "unpack", "(", "'!iiiiiiiiii'", ",", "soundcheck", ")", "except", "(", "struct", ".", "error", ",", "TypeError", ",", "binascii", ".", "Error", ")", ":", "# SoundCheck isn't in the format we expect, so return default", "# values.", "return", "0.0", ",", "0.0", "# SoundCheck stores absolute calculated/measured RMS value in an", "# unknown unit. We need to find the ratio of this measurement", "# compared to a reference value of 1000 to get our gain in dB. We", "# play it safe by using the larger of the two values (i.e., the most", "# attenuation).", "maxgain", "=", "max", "(", "soundcheck", "[", ":", "2", "]", ")", "if", "maxgain", ">", "0", ":", "gain", "=", "math", ".", "log10", "(", "maxgain", "/", "1000.0", ")", "*", "-", "10", "else", ":", "# Invalid gain value found.", "gain", "=", "0.0", "# SoundCheck stores peak values as the actual value of the sample,", "# and again separately for the left and right channels. We need to", "# convert this to a percentage of full scale, which is 32768 for a", "# 16 bit sample. Once again, we play it safe by using the larger of", "# the two values.", "peak", "=", "max", "(", "soundcheck", "[", "6", ":", "8", "]", ")", "/", "32768.0", "return", "round", "(", "gain", ",", "2", ")", ",", "round", "(", "peak", ",", "6", ")" ]

[ "Convert", "a", "Sound", "Check", "bytestring", "value", "to", "a", "(", "gain", "peak", ")", "tuple", "as", "used", "by", "ReplayGain", "." ]

[ "def", "_sc_encode", "(", "gain", ",", "peak", ")", ":", "# SoundCheck stores the peak value as the actual value of the", "# sample, rather than the percentage of full scale that RG uses, so", "# we do a simple conversion assuming 16 bit samples.", "peak", "*=", "32768.0", "# SoundCheck stores absolute RMS values in some unknown units rather", "# than the dB values RG uses. We can calculate these absolute values", "# from the gain ratio using a reference value of 1000 units. We also", "# enforce the maximum value here, which is equivalent to about", "# -18.2dB.", "g1", "=", "int", "(", "min", "(", "round", "(", "(", "10", "**", "(", "gain", "/", "-", "10", ")", ")", "*", "1000", ")", ",", "65534", ")", ")", "# Same as above, except our reference level is 2500 units.", "g2", "=", "int", "(", "min", "(", "round", "(", "(", "10", "**", "(", "gain", "/", "-", "10", ")", ")", "*", "2500", ")", ",", "65534", ")", ")", "# The purpose of these values are unknown, but they also seem to be", "# unused so we just use zero.", "uk", "=", "0", "values", "=", "(", "g1", ",", "g1", ",", "g2", ",", "g2", ",", "uk", ",", "uk", ",", "int", "(", "peak", ")", ",", "int", "(", "peak", ")", ",", "uk", ",", "uk", ")", "return", "(", "u' %08X'", "*", "10", ")", "%", "values" ]

[ "Encode", "ReplayGain", "gain", "/", "peak", "values", "as", "a", "Sound", "Check", "string", "." ]

[ "def", "image_mime_type", "(", "data", ")", ":", "# This checks for a jpeg file with only the magic bytes (unrecognized by", "# imghdr.what). imghdr.what returns none for that type of file, so", "# _wider_test_jpeg is run in that case. It still returns None if it didn't", "# match such a jpeg file.", "kind", "=", "_imghdr_what_wrapper", "(", "data", ")", "if", "kind", "in", "[", "'gif'", ",", "'jpeg'", ",", "'png'", ",", "'tiff'", ",", "'bmp'", "]", ":", "return", "'image/{0}'", ".", "format", "(", "kind", ")", "elif", "kind", "==", "'pgm'", ":", "return", "'image/x-portable-graymap'", "elif", "kind", "==", "'pbm'", ":", "return", "'image/x-portable-bitmap'", "elif", "kind", "==", "'ppm'", ":", "return", "'image/x-portable-pixmap'", "elif", "kind", "==", "'xbm'", ":", "return", "'image/x-xbitmap'", "else", ":", "return", "'image/x-{0}'", ".", "format", "(", "kind", ")" ]

[ "Return", "the", "MIME", "type", "of", "the", "image", "data", "(", "a", "bytestring", ")", "." ]

[ "def", "deserialize", "(", "self", ",", "mutagen_value", ")", ":", "if", "self", ".", "suffix", "and", "isinstance", "(", "mutagen_value", ",", "six", ".", "text_type", ")", "and", "mutagen_value", ".", "endswith", "(", "self", ".", "suffix", ")", ":", "return", "mutagen_value", "[", ":", "-", "len", "(", "self", ".", "suffix", ")", "]", "else", ":", "return", "mutagen_value" ]

[ "Given", "a", "raw", "value", "stored", "on", "a", "Mutagen", "object", "decode", "and", "return", "the", "represented", "value", "." ]

[ "def", "set", "(", "self", ",", "mutagen_file", ",", "value", ")", ":", "self", ".", "store", "(", "mutagen_file", ",", "self", ".", "serialize", "(", "value", ")", ")" ]

[ "Assign", "the", "value", "for", "the", "field", "using", "this", "style", "." ]

[ "def", "serialize", "(", "self", ",", "value", ")", ":", "if", "isinstance", "(", "value", ",", "float", ")", "and", "self", ".", "as_type", "is", "six", ".", "text_type", ":", "value", "=", "u'{0:.{1}f}'", ".", "format", "(", "value", ",", "self", ".", "float_places", ")", "value", "=", "self", ".", "as_type", "(", "value", ")", "elif", "self", ".", "as_type", "is", "six", ".", "text_type", ":", "if", "isinstance", "(", "value", ",", "bool", ")", ":", "# Store bools as 1/0 instead of True/False.", "value", "=", "six", ".", "text_type", "(", "int", "(", "bool", "(", "value", ")", ")", ")", "elif", "isinstance", "(", "value", ",", "bytes", ")", ":", "value", "=", "value", ".", "decode", "(", "'utf-8'", ",", "'ignore'", ")", "else", ":", "value", "=", "six", ".", "text_type", "(", "value", ")", "else", ":", "value", "=", "self", ".", "as_type", "(", "value", ")", "if", "self", ".", "suffix", ":", "value", "+=", "self", ".", "suffix", "return", "value" ]

[ "Convert", "the", "external", "Python", "value", "to", "a", "type", "that", "is", "suitable", "for", "storing", "in", "a", "Mutagen", "file", "object", "." ]

[ "def", "get_list", "(", "self", ",", "mutagen_file", ")", ":", "return", "[", "self", ".", "deserialize", "(", "item", ")", "for", "item", "in", "self", ".", "fetch", "(", "mutagen_file", ")", "]" ]

[ "Get", "a", "list", "of", "all", "values", "for", "the", "field", "using", "this", "style", "." ]

[ "def", "set_list", "(", "self", ",", "mutagen_file", ",", "values", ")", ":", "self", ".", "store", "(", "mutagen_file", ",", "[", "self", ".", "serialize", "(", "value", ")", "for", "value", "in", "values", "]", ")" ]

[ "Set", "all", "values", "for", "the", "field", "using", "this", "style", ".", "values", "should", "be", "an", "iterable", "." ]

[ "def", "deserialize", "(", "self", ",", "apic_frame", ")", ":", "return", "Image", "(", "data", "=", "apic_frame", ".", "data", ",", "desc", "=", "apic_frame", ".", "desc", ",", "type", "=", "apic_frame", ".", "type", ")" ]

[ "Convert", "APIC", "frame", "into", "Image", "." ]

[ "def", "serialize", "(", "self", ",", "image", ")", ":", "assert", "isinstance", "(", "image", ",", "Image", ")", "frame", "=", "mutagen", ".", "id3", ".", "Frames", "[", "self", ".", "key", "]", "(", ")", "frame", ".", "data", "=", "image", ".", "data", "frame", ".", "mime", "=", "image", ".", "mime_type", "frame", ".", "desc", "=", "image", ".", "desc", "or", "u''", "# For compatibility with OS X/iTunes prefer latin-1 if possible.", "# See issue #899", "try", ":", "frame", ".", "desc", ".", "encode", "(", "\"latin-1\"", ")", "except", "UnicodeEncodeError", ":", "frame", ".", "encoding", "=", "mutagen", ".", "id3", ".", "Encoding", ".", "UTF16", "else", ":", "frame", ".", "encoding", "=", "mutagen", ".", "id3", ".", "Encoding", ".", "LATIN1", "frame", ".", "type", "=", "image", ".", "type_index", "return", "frame" ]

[ "Return", "an", "APIC", "frame", "populated", "with", "data", "from", "image", "." ]

[ "def", "serialize", "(", "self", ",", "image", ")", ":", "pic", "=", "mutagen", ".", "flac", ".", "Picture", "(", ")", "pic", ".", "data", "=", "image", ".", "data", "pic", ".", "type", "=", "image", ".", "type_index", "pic", ".", "mime", "=", "image", ".", "mime_type", "pic", ".", "desc", "=", "image", ".", "desc", "or", "u''", "# Encoding with base64 returns bytes on both Python 2 and 3.", "# Mutagen requires the data to be a Unicode string, so we decode", "# it before passing it along.", "return", "base64", ".", "b64encode", "(", "pic", ".", "write", "(", ")", ")", ".", "decode", "(", "'ascii'", ")" ]

[ "Turn", "a", "Image", "into", "a", "base64", "encoded", "FLAC", "picture", "block", "." ]

[ "def", "store", "(", "self", ",", "mutagen_file", ",", "pictures", ")", ":", "mutagen_file", ".", "clear_pictures", "(", ")", "for", "pic", "in", "pictures", ":", "mutagen_file", ".", "add_picture", "(", "pic", ")" ]

[ "pictures", "is", "a", "list", "of", "mutagen", ".", "flac", ".", "Picture", "instances", "." ]

[ "def", "serialize", "(", "self", ",", "image", ")", ":", "pic", "=", "mutagen", ".", "flac", ".", "Picture", "(", ")", "pic", ".", "data", "=", "image", ".", "data", "pic", ".", "type", "=", "image", ".", "type_index", "pic", ".", "mime", "=", "image", ".", "mime_type", "pic", ".", "desc", "=", "image", ".", "desc", "or", "u''", "return", "pic" ]

[ "Turn", "a", "Image", "into", "a", "mutagen", ".", "flac", ".", "Picture", "." ]

[ "def", "delete", "(", "self", ",", "mutagen_file", ")", ":", "for", "cover_tag", "in", "self", ".", "TAG_NAMES", ".", "values", "(", ")", ":", "try", ":", "del", "mutagen_file", "[", "cover_tag", "]", "except", "KeyError", ":", "pass" ]

[ "Remove", "all", "images", "from", "the", "file", "." ]

[ "def", "styles", "(", "self", ",", "mutagen_file", ")", ":", "for", "style", "in", "self", ".", "_styles", ":", "if", "mutagen_file", ".", "__class__", ".", "__name__", "in", "style", ".", "formats", ":", "yield", "style" ]

[ "Yields", "the", "list", "of", "storage", "styles", "of", "this", "field", "that", "can", "handle", "the", "MediaFile", "s", "format", "." ]

[ "def", "_none_value", "(", "self", ")", ":", "if", "self", ".", "out_type", "==", "int", ":", "return", "0", "elif", "self", ".", "out_type", "==", "float", ":", "return", "0.0", "elif", "self", ".", "out_type", "==", "bool", ":", "return", "False", "elif", "self", ".", "out_type", "==", "six", ".", "text_type", ":", "return", "u''" ]

[ "Get", "an", "appropriate", "null", "value", "for", "this", "field", "s", "type", ".", "This", "is", "used", "internally", "when", "setting", "the", "field", "to", "None", "." ]

[ "def", "_get_date_tuple", "(", "self", ",", "mediafile", ")", ":", "# Get the underlying data and split on hyphens and slashes.", "datestring", "=", "super", "(", "DateField", ",", "self", ")", ".", "__get__", "(", "mediafile", ",", "None", ")", "if", "isinstance", "(", "datestring", ",", "six", ".", "string_types", ")", ":", "datestring", "=", "re", ".", "sub", "(", "r'[Tt ].*$'", ",", "''", ",", "six", ".", "text_type", "(", "datestring", ")", ")", "items", "=", "re", ".", "split", "(", "'[-/]'", ",", "six", ".", "text_type", "(", "datestring", ")", ")", "else", ":", "items", "=", "[", "]", "# Ensure that we have exactly 3 components, possibly by", "# truncating or padding.", "items", "=", "items", "[", ":", "3", "]", "if", "len", "(", "items", ")", "<", "3", ":", "items", "+=", "[", "None", "]", "*", "(", "3", "-", "len", "(", "items", ")", ")", "# Use year field if year is missing.", "if", "not", "items", "[", "0", "]", "and", "hasattr", "(", "self", ",", "'_year_field'", ")", ":", "items", "[", "0", "]", "=", "self", ".", "_year_field", ".", "__get__", "(", "mediafile", ")", "# Convert each component to an integer if possible.", "items_", "=", "[", "]", "for", "item", "in", "items", ":", "try", ":", "items_", ".", "append", "(", "int", "(", "item", ")", ")", "except", "(", "TypeError", ",", "ValueError", ")", ":", "items_", ".", "append", "(", "None", ")", "return", "items_" ]

[ "Get", "a", "3", "-", "item", "sequence", "representing", "the", "date", "consisting", "of", "a", "year", "month", "and", "day", "number", ".", "Each", "number", "is", "either", "an", "integer", "or", "None", "." ]

[ "def", "_set_date_tuple", "(", "self", ",", "mediafile", ",", "year", ",", "month", "=", "None", ",", "day", "=", "None", ")", ":", "if", "year", "is", "None", ":", "self", ".", "__delete__", "(", "mediafile", ")", "return", "date", "=", "[", "u'{0:04d}'", ".", "format", "(", "int", "(", "year", ")", ")", "]", "if", "month", ":", "date", ".", "append", "(", "u'{0:02d}'", ".", "format", "(", "int", "(", "month", ")", ")", ")", "if", "month", "and", "day", ":", "date", ".", "append", "(", "u'{0:02d}'", ".", "format", "(", "int", "(", "day", ")", ")", ")", "date", "=", "map", "(", "six", ".", "text_type", ",", "date", ")", "super", "(", "DateField", ",", "self", ")", ".", "__set__", "(", "mediafile", ",", "u'-'", ".", "join", "(", "date", ")", ")", "if", "hasattr", "(", "self", ",", "'_year_field'", ")", ":", "self", ".", "_year_field", ".", "__set__", "(", "mediafile", ",", "year", ")" ]

[ "Set", "the", "value", "of", "the", "field", "given", "a", "year", "month", "and", "day", "number", ".", "Each", "number", "can", "be", "an", "integer", "or", "None", "to", "indicate", "an", "unset", "component", "." ]

[ "def", "save", "(", "self", ")", ":", "# Possibly save the tags to ID3v2.3.", "kwargs", "=", "{", "}", "if", "self", ".", "id3v23", ":", "id3", "=", "self", ".", "mgfile", "if", "hasattr", "(", "id3", ",", "'tags'", ")", ":", "# In case this is an MP3 object, not an ID3 object.", "id3", "=", "id3", ".", "tags", "id3", ".", "update_to_v23", "(", ")", "kwargs", "[", "'v2_version'", "]", "=", "3", "mutagen_call", "(", "'save'", ",", "self", ".", "path", ",", "self", ".", "mgfile", ".", "save", ",", "*", "*", "kwargs", ")" ]

[ "Write", "the", "object", "s", "tags", "back", "to", "the", "file", ".", "May", "throw", "UnreadableFileError", "." ]

[ "def", "fields", "(", "cls", ")", ":", "for", "property", ",", "descriptor", "in", "cls", ".", "__dict__", ".", "items", "(", ")", ":", "if", "isinstance", "(", "descriptor", ",", "MediaField", ")", ":", "if", "isinstance", "(", "property", ",", "bytes", ")", ":", "# On Python 2, class field names are bytes. This method", "# produces text strings.", "yield", "property", ".", "decode", "(", "'utf8'", ",", "'ignore'", ")", "else", ":", "yield", "property" ]

[ "Get", "the", "names", "of", "all", "writable", "properties", "that", "reflect", "metadata", "tags", "(", "i", ".", "e", ".", "those", "that", "are", "instances", "of", ":", "class", ":", "MediaField", ")", "." ]

[ "def", "_field_sort_name", "(", "cls", ",", "name", ")", ":", "if", "isinstance", "(", "cls", ".", "__dict__", "[", "name", "]", ",", "DateItemField", ")", ":", "name", "=", "re", ".", "sub", "(", "'year'", ",", "'date0'", ",", "name", ")", "name", "=", "re", ".", "sub", "(", "'month'", ",", "'date1'", ",", "name", ")", "name", "=", "re", ".", "sub", "(", "'day'", ",", "'date2'", ",", "name", ")", "return", "name" ]

[ "Get", "a", "sort", "key", "for", "a", "field", "name", "that", "determines", "the", "order", "fields", "should", "be", "written", "in", "." ]

[ "def", "sorted_fields", "(", "cls", ")", ":", "for", "property", "in", "sorted", "(", "cls", ".", "fields", "(", ")", ",", "key", "=", "cls", ".", "_field_sort_name", ")", ":", "yield", "property" ]

[ "Get", "the", "names", "of", "all", "writable", "metadata", "fields", "sorted", "in", "the", "order", "that", "they", "should", "be", "written", "." ]

[ "def", "add_field", "(", "cls", ",", "name", ",", "descriptor", ")", ":", "if", "not", "isinstance", "(", "descriptor", ",", "MediaField", ")", ":", "raise", "ValueError", "(", "u'{0} must be an instance of MediaField'", ".", "format", "(", "descriptor", ")", ")", "if", "name", "in", "cls", ".", "__dict__", ":", "raise", "ValueError", "(", "u'property \"{0}\" already exists on MediaField'", ".", "format", "(", "name", ")", ")", "setattr", "(", "cls", ",", "name", ",", "descriptor", ")" ]

[ "Add", "a", "field", "to", "store", "custom", "tags", "." ]

[ "def", "update", "(", "self", ",", "dict", ")", ":", "for", "field", "in", "self", ".", "sorted_fields", "(", ")", ":", "if", "field", "in", "dict", ":", "if", "dict", "[", "field", "]", "is", "None", ":", "delattr", "(", "self", ",", "field", ")", "else", ":", "setattr", "(", "self", ",", "field", ",", "dict", "[", "field", "]", ")" ]

[ "Set", "all", "field", "values", "from", "a", "dictionary", "." ]

[ "def", "samplerate", "(", "self", ")", ":", "if", "hasattr", "(", "self", ".", "mgfile", ".", "info", ",", "'sample_rate'", ")", ":", "return", "self", ".", "mgfile", ".", "info", ".", "sample_rate", "elif", "self", ".", "type", "==", "'opus'", ":", "# Opus is always 48kHz internally.", "return", "48000", "return", "0" ]

[ "The", "audio", "s", "sample", "rate", "(", "an", "int", ")", "." ]