Datasets:

---

CM

/

codexglue_code2text_python

like 8

[ "def", "set_outputs", "(", "self", ",", "*", "outputs", ")", ":", "self", ".", "_outputs", "=", "OrderedDict", "(", ")", "for", "output", "in", "outputs", ":", "out_name", "=", "None", "type_or_serialize", "=", "None", "if", "isinstance", "(", "(", "list", ",", "tuple", ")", ",", "output", ")", ":", "if", "len", "(", "output", ")", "==", "1", ":", "out_name", "=", "output", "[", "0", "]", "elif", "len", "(", "output", ")", "==", "2", ":", "out_name", "=", "output", "[", "0", "]", "type_or_serialize", "=", "output", "[", "1", "]", "else", ":", "raise", "ValueError", "(", "\"invalid output format\"", ")", "else", ":", "out_name", "=", "output", "self", ".", "add_output", "(", "out_name", ",", "type_or_serialize", ")" ]

[ "Set", "the", "outputs", "of", "the", "view" ]

[ "def", "add_output", "(", "self", ",", "out_name", ",", "type_or_serialize", "=", "None", ",", "*", "*", "kwargs", ")", ":", "if", "out_name", "not", "in", "self", ".", "engine", ".", "all_outputs", "(", ")", ":", "raise", "ValueError", "(", "\"'%s' is not generated by the engine %s\"", "%", "(", "out_name", ",", "self", ".", "engine", ".", "all_outputs", "(", ")", ")", ")", "if", "type_or_serialize", "is", "None", ":", "type_or_serialize", "=", "GenericType", "(", ")", "if", "not", "isinstance", "(", "type_or_serialize", ",", "GenericType", ")", "and", "callable", "(", "type_or_serialize", ")", ":", "type_or_serialize", "=", "GenericType", "(", "serialize", "=", "type_or_serialize", ")", "elif", "not", "isinstance", "(", "type_or_serialize", ",", "GenericType", ")", ":", "raise", "ValueError", "(", "\"the given 'type_or_serialize' is invalid\"", ")", "# register outpurs", "self", ".", "_outputs", "[", "out_name", "]", "=", "{", "'serializer'", ":", "type_or_serialize", ",", "'parameters'", ":", "kwargs", "if", "kwargs", "else", "{", "}", "}" ]

[ "Declare", "an", "output" ]

[ "def", "options", "(", "self", ")", ":", "#configure engine with an empty dict to ensure default selection/options", "self", ".", "engine", ".", "configure", "(", "{", "}", ")", "conf", "=", "self", ".", "engine", ".", "as_dict", "(", ")", "conf", "[", "\"returns\"", "]", "=", "[", "oname", "for", "oname", "in", "six", ".", "iterkeys", "(", "self", ".", "_outputs", ")", "]", "# Note: we overide args to only list the ones that are declared in this view", "conf", "[", "\"args\"", "]", "=", "[", "iname", "for", "iname", "in", "six", ".", "iterkeys", "(", "self", ".", "_inputs", ")", "]", "return", "jsonify", "(", "conf", ")" ]

[ "Engine", "options", "discover", "HTTP", "entry", "point" ]

[ "async", "def", "init_stream_from_settings", "(", "cfg", ":", "dict", ")", "->", "Stream", ":", "cfg_name", "=", "cfg", "[", "\"active_stream\"", "]", "stream_init_kwargs", "=", "cfg", "[", "\"streams\"", "]", "[", "cfg_name", "]", "stream", "=", "Stream", "(", "*", "*", "stream_init_kwargs", ")", "await", "stream", ".", "connect", "(", ")", "_stream_storage", ".", "push", "(", "cfg_name", ",", "stream", ")", "return", "stream" ]

[ "Shortcut", "to", "create", "Stream", "from", "configured", "settings", "." ]

[ "def", "interpret", "(", "self", ",", "infile", ")", ":", "data", "=", "[", "]", "for", "record", "in", "self", ".", "generate_records", "(", "infile", ")", ":", "data", ".", "append", "(", "record", ")", "return", "data" ]

[ "Process", "a", "file", "of", "rest", "and", "return", "list", "of", "dicts" ]

[ "def", "read_profile", "(", "name", ")", ":", "config", "=", "configparser", ".", "ConfigParser", "(", ")", "config", ".", "read", "(", "CONFIG_FILE", ")", "profile", "=", "config", "[", "name", "]", "repo", "=", "profile", "[", "\"repo\"", "]", "token", "=", "profile", "[", "\"token\"", "]", "return", "{", "\"repo\"", ":", "repo", ",", "\"token\"", ":", "token", "}" ]

[ "Get", "a", "named", "profile", "from", "the", "CONFIG_FILE", "." ]

[ "def", "write_profile", "(", "name", ",", "repo", ",", "token", ")", ":", "make_sure_folder_exists", "(", "CONFIG_FOLDER", ")", "config", "=", "configparser", ".", "ConfigParser", "(", ")", "config", ".", "read", "(", "CONFIG_FILE", ")", "profile", "=", "{", "\"repo\"", ":", "repo", ",", "\"token\"", ":", "token", "}", "config", "[", "name", "]", "=", "profile", "with", "open", "(", "CONFIG_FILE", ",", "\"w\"", ")", "as", "configfile", ":", "config", ".", "write", "(", "configfile", ")", "return", "profile" ]

[ "Save", "a", "profile", "to", "the", "CONFIG_FILE", "." ]

[ "def", "requirements", "(", "fname", ")", ":", "packages", "=", "Setup", ".", "read", "(", "fname", ",", "fail_silently", "=", "True", ")", ".", "split", "(", "'\\n'", ")", "packages", "=", "(", "p", ".", "strip", "(", ")", "for", "p", "in", "packages", ")", "packages", "=", "(", "p", "for", "p", "in", "packages", "if", "p", "and", "not", "p", ".", "startswith", "(", "'#'", ")", ")", "return", "list", "(", "packages", ")" ]

[ "Utility", "function", "to", "create", "a", "list", "of", "requirements", "from", "the", "output", "of", "the", "pip", "freeze", "command", "saved", "in", "a", "text", "file", "." ]

[ "def", "build_parser", "(", ")", ":", "import", "argparse", "description", "=", "\"A programmer's search tool, parallel and fast\"", "parser", "=", "argparse", ".", "ArgumentParser", "(", "description", "=", "description", ")", "parser", ".", "add_argument", "(", "'pattern'", ",", "metavar", "=", "'PATTERN'", ",", "action", "=", "'store'", ",", "help", "=", "'a python re regular expression'", ")", "parser", ".", "add_argument", "(", "'--ignore-case'", ",", "'-i'", ",", "dest", "=", "'ignorecase'", ",", "action", "=", "'store_true'", ",", "default", "=", "False", ",", "help", "=", "'ignore case when searching'", ")", "parser", ".", "add_argument", "(", "'--no-unicode'", ",", "'-u'", ",", "dest", "=", "'unicode'", ",", "action", "=", "'store_false'", ",", "default", "=", "True", ",", "help", "=", "'unicode-unfriendly searching'", ")", "parser", ".", "add_argument", "(", "'--no-multiline'", ",", "'-l'", ",", "dest", "=", "'multiline'", ",", "action", "=", "'store_false'", ",", "default", "=", "True", ",", "help", "=", "'don\\'t search over multiple lines'", ")", "parser", ".", "add_argument", "(", "'--dot-all'", ",", "'-a'", ",", "dest", "=", "'dot_all'", ",", "action", "=", "'store_true'", ",", "default", "=", "False", ",", "help", "=", "'dot in PATTERN matches newline'", ")", "parser", ".", "add_argument", "(", "'--escape'", ",", "'-e'", ",", "dest", "=", "'escape'", ",", "action", "=", "'store_true'", ",", "default", "=", "False", ",", "help", "=", "'treat PATTERN as a string instead of a regex'", ")", "if", "sys", ".", "version_info", ">=", "(", "2", ",", "6", ")", ":", "parser", ".", "add_argument", "(", "'--follow-links'", ",", "'-s'", ",", "dest", "=", "'follow_links'", ",", "action", "=", "'store_true'", ",", "default", "=", "False", ",", "help", "=", "'follow symlinks (Python >= 2.6 only)'", ")", "parser", ".", "add_argument", "(", "'--hidden'", ",", "'-n'", ",", "dest", "=", "'search_hidden'", ",", "action", "=", "'store_true'", ",", "default", "=", "False", ",", "help", "=", "'search hidden files and directories'", ")", "parser", ".", "add_argument", "(", "'--binary'", ",", "'-b'", ",", "dest", "=", "'search_binary'", ",", "action", "=", "'store_true'", ",", "default", "=", "False", ",", "help", "=", "'search binary files'", ")", "parser", ".", "add_argument", "(", "'--no-colors'", ",", "'-c'", ",", "dest", "=", "'use_ansi_colors'", ",", "action", "=", "'store_false'", ",", "default", "=", "True", ",", "help", "=", "\"don't print ANSI colors\"", ")", "parser", ".", "add_argument", "(", "'--stats'", ",", "'-t'", ",", "dest", "=", "'print_stats'", ",", "action", "=", "'store_true'", ",", "default", "=", "False", ",", "help", "=", "'print statistics'", ")", "parser", ".", "add_argument", "(", "'--num-processes'", ",", "'-p'", ",", "dest", "=", "'number_processes'", ",", "action", "=", "'store'", ",", "default", "=", "10", ",", "type", "=", "int", ",", "help", "=", "'number of child processes to concurrently search with'", ")", "parser", ".", "add_argument", "(", "'--exclude'", ",", "'-x'", ",", "metavar", "=", "'PATH_PATTERN'", ",", "dest", "=", "'exclude_path_patterns'", ",", "action", "=", "'append'", ",", "default", "=", "[", "]", ",", "type", "=", "str", ",", "help", "=", "'exclude paths matching PATH_PATTERN'", ")", "parser", ".", "add_argument", "(", "'--open-with'", ",", "'-o'", ",", "metavar", "=", "'COMMAND'", ",", "dest", "=", "'command_strings'", ",", "action", "=", "'append'", ",", "default", "=", "[", "]", ",", "type", "=", "str", ",", "help", "=", "'run each COMMAND where COMMAND is a string with a placeholder, %%s, for the absolute path of the matched file'", ")", "parser", ".", "add_argument", "(", "'directory'", ",", "metavar", "=", "'DIRECTORY'", ",", "nargs", "=", "'?'", ",", "default", "=", "getcwd", "(", ")", ",", "help", "=", "'a directory to search in (default cwd)'", ")", "return", "parser" ]

[ "Returns", "an", "argparse", ".", "ArgumentParser", "instance", "to", "parse", "the", "command", "line", "arguments", "for", "lk" ]

[ "def", "get_file_contents", "(", "path", ",", "binary", "=", "False", ")", ":", "# if this isn't a text file, we should raise an IOError", "f", "=", "open", "(", "path", ",", "'r'", ")", "file_contents", "=", "f", ".", "read", "(", ")", "f", ".", "close", "(", ")", "if", "not", "binary", "and", "file_contents", ".", "find", "(", "'\\000'", ")", ">=", "0", ":", "raise", "IOError", "(", "'Expected text file, got binary file'", ")", "return", "file_contents" ]

[ "Return", "the", "contents", "of", "the", "text", "file", "at", "path", ".", "If", "it", "is", "a", "binary", "file", "raise", "an", "IOError" ]

[ "def", "main", "(", ")", ":", "parser", "=", "build_parser", "(", ")", "args", "=", "parser", ".", "parse_args", "(", ")", "flags", "=", "re", ".", "LOCALE", "if", "args", ".", "dot_all", ":", "flags", "|=", "re", ".", "DOTALL", "if", "args", ".", "ignorecase", ":", "flags", "|=", "re", ".", "IGNORECASE", "if", "args", ".", "unicode", ":", "flags", "|=", "re", ".", "UNICODE", "if", "args", ".", "multiline", ":", "flags", "|=", "re", ".", "MULTILINE", "exclude_path_flags", "=", "re", ".", "UNICODE", "|", "re", ".", "LOCALE", "exclude_path_regexes", "=", "[", "re", ".", "compile", "(", "pattern", ",", "exclude_path_flags", ")", "for", "pattern", "in", "args", ".", "exclude_path_patterns", "]", "pattern", "=", "re", ".", "escape", "(", "args", ".", "pattern", ")", "if", "args", ".", "escape", "else", "args", ".", "pattern", "try", ":", "search_manager", "=", "SearchManager", "(", "regex", "=", "re", ".", "compile", "(", "pattern", ",", "flags", ")", ",", "number_processes", "=", "args", ".", "number_processes", ",", "search_hidden", "=", "args", ".", "search_hidden", ",", "follow_links", "=", "args", ".", "follow_links", ",", "search_binary", "=", "args", ".", "search_binary", ",", "use_ansi_colors", "=", "args", ".", "use_ansi_colors", ",", "print_stats", "=", "args", ".", "print_stats", ",", "exclude_path_regexes", "=", "exclude_path_regexes", ",", "command_strings", "=", "args", ".", "command_strings", ")", "search_manager", ".", "enqueue_directory", "(", "args", ".", "directory", ")", "search_manager", ".", "process_queue", "(", ")", "except", "(", "KeyboardInterruptError", ",", "KeyboardInterrupt", ")", ":", "sys", ".", "stdout", ".", "write", "(", "'\\n'", ")", "exit", "(", "1", ")" ]

[ "if", "lk", ".", "py", "is", "run", "as", "a", "script", "this", "function", "will", "run" ]

[ "def", "enqueue_directory", "(", "self", ",", "directory", ")", ":", "exclude_path_regexes", "=", "self", ".", "exclude_path_regexes", "[", ":", "]", "if", "not", "self", ".", "search_hidden", ":", "exclude_path_regexes", ".", "append", "(", "self", ".", "hidden_file_regex", ")", "else", ":", "exclude_path_regexes", ".", "remove", "(", "self", ".", "hidden_file_regex", ")", "self", ".", "mark", "=", "datetime", ".", "datetime", ".", "now", "(", ")", "def", "is_path_excluded", "(", "path", ")", ":", "\"\"\"\n return True if name matches on of the regexes in\n exclude_path_regexes, False otherwise\n \"\"\"", "for", "exclude_path_regex", "in", "exclude_path_regexes", ":", "for", "found", "in", "exclude_path_regex", ".", "finditer", "(", "path", ")", ":", "return", "False", "return", "True", "def", "search_walk", "(", ")", ":", "try", ":", "walk_generator", "=", "walk", "(", "directory", ",", "followlinks", "=", "self", ".", "follow_links", ")", "except", "TypeError", ":", "# for python less than 2.6", "walk_generator", "=", "walk", "(", "directory", ")", "for", "packed", "in", "walk_generator", ":", "directory_path", ",", "directory_names", ",", "file_names", "=", "packed", "directory_names", "[", ":", "]", "=", "filter", "(", "is_path_excluded", ",", "directory_names", ")", "file_names", "[", ":", "]", "=", "filter", "(", "is_path_excluded", ",", "file_names", ")", "yield", "directory_path", ",", "directory_names", ",", "file_names", "writer", "=", "ColorWriter", "(", "sys", ".", "stdout", ",", "self", ".", "use_ansi_colors", ")", "def", "print_directory_result", "(", "directory_result", ")", ":", "writer", ".", "print_result", "(", "directory_result", ")", "for", "command_string", "in", "self", ".", "command_strings", ":", "if", "command_string", ".", "find", "(", "'%s'", ")", "<", "0", ":", "command_string", "+=", "' %s'", "for", "file_name", ",", "line_result", "in", "directory_result", ".", "iter_line_results_items", "(", ")", ":", "file_path", "=", "path", ".", "join", "(", "directory_result", ".", "directory_path", ",", "file_name", ")", "Popen", "(", "command_string", "%", "file_path", ",", "shell", "=", "True", ")", "break", "for", "directory_path", ",", "directory_names", ",", "file_names", "in", "search_walk", "(", ")", ":", "process", "=", "Process", "(", "target", "=", "self", ".", "search_worker", ",", "args", "=", "(", "self", ".", "regex", ",", "directory_path", ",", "file_names", ",", "self", ".", "search_binary", ",", "print_directory_result", ")", ")", "self", ".", "queue", ".", "append", "(", "process", ")" ]

[ "add", "a", "search", "of", "the", "directory", "to", "the", "queue" ]

[ "def", "search_worker", "(", "self", ",", "regex", ",", "directory_path", ",", "names", ",", "binary", "=", "False", ",", "callback", "=", "None", ")", ":", "try", ":", "result", "=", "DirectoryResult", "(", "directory_path", ")", "def", "find_matches", "(", "name", ")", ":", "full_path", "=", "path", ".", "join", "(", "directory_path", ",", "name", ")", "file_contents", "=", "get_file_contents", "(", "full_path", ",", "binary", ")", "start", "=", "0", "match", "=", "regex", ".", "search", "(", "file_contents", ",", "start", ")", "while", "match", ":", "result", ".", "put", "(", "name", ",", "file_contents", ",", "match", ")", "start", "=", "match", ".", "end", "(", ")", "match", "=", "regex", ".", "search", "(", "file_contents", ",", "start", ")", "for", "name", "in", "names", ":", "try", ":", "find_matches", "(", "name", ")", "except", "IOError", ":", "pass", "if", "callback", ":", "callback", "(", "result", ")", "except", "KeyboardInterrupt", ",", "e", ":", "exit", "(", "1", ")" ]

[ "build", "a", "DirectoryResult", "for", "the", "given", "regex", "directory", "path", "and", "file", "names" ]

[ "def", "print_result", "(", "self", ",", "directory_result", ")", ":", "for", "file_name", ",", "line_results_dict", "in", "directory_result", ".", "iter_line_results_items", "(", ")", ":", "full_path", "=", "path", ".", "join", "(", "directory_result", ".", "directory_path", ",", "file_name", ")", "self", ".", "write", "(", "full_path", ",", "'green'", ")", "self", ".", "write", "(", "'\\n'", ")", "for", "line_number", ",", "line_results", "in", "sorted", "(", "line_results_dict", ".", "items", "(", ")", ")", ":", "self", ".", "write", "(", "'%s: '", "%", "(", "line_results", "[", "0", "]", ".", "line_number", ")", ")", "out", "=", "list", "(", "line_results", "[", "0", "]", ".", "left_of_group", "+", "line_results", "[", "0", "]", ".", "group", "+", "line_results", "[", "0", "]", ".", "right_of_group", ")", "offset", "=", "0", "for", "line_result", "in", "line_results", ":", "group_length", "=", "len", "(", "line_result", ".", "group", ")", "out", ".", "insert", "(", "offset", "+", "line_result", ".", "left_offset", "-", "1", ",", "self", ".", "colors", "[", "'blue'", "]", ")", "out", ".", "insert", "(", "offset", "+", "line_result", ".", "left_offset", "+", "group_length", ",", "self", ".", "colors", "[", "'end'", "]", ")", "offset", "+=", "group_length", "+", "1", "self", ".", "write", "(", "''", ".", "join", "(", "out", ")", "+", "'\\n'", ")", "self", ".", "write", "(", "'\\n'", ")" ]

[ "Print", "out", "the", "contents", "of", "the", "directory", "result", "using", "ANSI", "color", "codes", "if", "supported" ]

[ "def", "create_or_get_from_request", "(", "request", ")", ":", "saved", "=", "getattr", "(", "request", ",", "REQUEST_CACHE_FIELD", ",", "None", ")", "if", "isinstance", "(", "saved", ",", "RequestInfo", ")", ":", "return", "saved", "req", "=", "RequestInfo", "(", ")", "req", ".", "user_ip", "=", "request", ".", "META", ".", "get", "(", "'REMOTE_ADDR'", ")", "req", ".", "user_host", "=", "request", ".", "META", ".", "get", "(", "'REMOTE_HOST'", ")", "req", ".", "user_agent", "=", "request", ".", "META", ".", "get", "(", "'HTTP_USER_AGENT'", ")", "req", ".", "full_path", "=", "request", ".", "build_absolute_uri", "(", "request", ".", "get_full_path", "(", ")", ")", "req", ".", "method", "=", "request", ".", "META", ".", "get", "(", "'REQUEST_METHOD'", ")", "req", ".", "referer", "=", "request", ".", "META", ".", "get", "(", "'HTTP_REFERER'", ")", "req", ".", "save", "(", ")", "setattr", "(", "request", ",", "REQUEST_CACHE_FIELD", ",", "req", ")", "return", "req" ]

[ "Returns", "RequestInfo", "instance", "." ]

[ "def", "materialize", "(", "self", ")", ":", "if", "self", ".", "action_type", "==", "ActionType", ".", "DELETE", ":", "# On deletion current state is dumped to change_log", "# so it's enough to just restore it to object", "data", "=", "serializer", ".", "from_json", "(", "self", ".", "change_log", ")", "obj", "=", "serializer", ".", "restore_model", "(", "self", ".", "_tracked_model", ",", "data", ")", "return", "obj", "changes", "=", "History", ".", "objects", ".", "filter", "(", "model_name", "=", "self", ".", "model_name", ",", "app_label", "=", "self", ".", "app_label", ",", "table_id", "=", "self", ".", "table_id", ")", "changes", "=", "changes", ".", "filter", "(", "revision_ts__lte", "=", "self", ".", "revision_ts", ")", "changes", "=", "list", "(", "changes", ".", "order_by", "(", "'revision_ts'", ")", ")", "creation", "=", "changes", ".", "pop", "(", "0", ")", "data", "=", "serializer", ".", "from_json", "(", "creation", ".", "change_log", ")", "obj", "=", "serializer", ".", "restore_model", "(", "self", ".", "_tracked_model", ",", "data", ")", "for", "change", "in", "changes", ":", "change_log", "=", "serializer", ".", "from_json", "(", "change", ".", "change_log", ")", "for", "field", "in", "change_log", ":", "next_val", "=", "change_log", "[", "field", "]", "[", "Field", ".", "NEW", "]", "setattr", "(", "obj", ",", "field", ",", "next_val", ")", "return", "obj" ]

[ "Returns", "instance", "of", "TrackedModel", "created", "from", "current", "History", "snapshot", ".", "To", "rollback", "to", "current", "snapshot", "simply", "call", "save", "on", "materialized", "object", "." ]

[ "def", "_is_plugin_disabled", "(", "plugin", ")", ":", "item", "=", "_registered", ".", "get", "(", "plugin", ".", "name", ")", "if", "not", "item", ":", "return", "False", "_", ",", "props", "=", "item", "return", "bool", "(", "props", ".", "get", "(", "'disabled'", ")", ")" ]

[ "Determines", "if", "provided", "plugin", "is", "disabled", "from", "running", "for", "the", "active", "task", "." ]

[ "def", "_setup_events", "(", "plugin", ")", ":", "events", "=", "plugin", ".", "events", "if", "events", "and", "isinstance", "(", "events", ",", "(", "list", ",", "tuple", ")", ")", ":", "for", "event", "in", "[", "e", "for", "e", "in", "events", "if", "e", "in", "_EVENT_VALS", "]", ":", "register", "(", "'event'", ",", "event", ",", "plugin", ")" ]

[ "Handles", "setup", "or", "teardown", "of", "event", "hook", "registration", "for", "the", "provided", "plugin", "." ]

[ "def", "_setup_options", "(", "plugin", ")", ":", "options", "=", "plugin", ".", "options", "if", "options", "and", "isinstance", "(", "options", ",", "(", "list", ",", "tuple", ")", ")", ":", "for", "props", "in", "options", ":", "if", "isinstance", "(", "props", ",", "dict", ")", ":", "if", "'block'", "in", "props", "and", "'options'", "in", "props", ":", "# block", "block", "=", "props", "[", "'block'", "]", "option_list", "=", "props", "[", "'options'", "]", "# options for this block", "for", "props", "in", "option_list", ":", "if", "isinstance", "(", "props", ",", "dict", ")", ":", "name", "=", "props", ".", "pop", "(", "'name'", ",", "None", ")", "if", "name", ":", "key", "=", "\"{0}_{1}\"", ".", "format", "(", "block", ",", "name", ")", "register", "(", "'option'", ",", "key", ",", "plugin", ",", "props", ")", "else", ":", "# non-block option", "name", "=", "props", ".", "pop", "(", "'name'", ",", "None", ")", "if", "name", ":", "register", "(", "'option'", ",", "name", ",", "plugin", ",", "props", ")" ]

[ "Handles", "setup", "or", "teardown", "of", "option", "hook", "registration", "for", "the", "provided", "plugin", "." ]

[ "def", "register", "(", "hook_type", ",", "key", ",", "plugin_cls", ",", "properties", "=", "None", ")", ":", "def", "fetch_plugin", "(", ")", ":", "\"\"\" This function is used as a lazy evaluation of fetching the\n specified plugin. This is required, because at the time of\n registration of hooks (metaclass creation), the plugin class won't\n exist yet in the class namespace, which is required for the\n `Registry.get()` method. One benefit of this implementation is that\n we can reference the same object instance in each of the hook\n registries instead of making a new instance of the plugin for every\n registry that links to the same plugin.\n \"\"\"", "return", "_registered", ".", "get", "(", "plugin_cls", ".", "name", ")", "[", "0", "]", "# extended, strip type info", "# type information for plugin in main registry", "type_info", "=", "{", "}", "# register a command for plugin", "if", "hook_type", "==", "'command'", ":", "_command_hooks", ".", "register", "(", "key", ",", "fetch_plugin", ")", "type_info", "[", "'command'", "]", "=", "True", "# register event chain for plugin", "elif", "hook_type", "==", "'event'", ":", "if", "not", "key", "in", "_event_hooks", ":", "_event_hooks", "[", "key", "]", "=", "[", "]", "_event_hooks", "[", "key", "]", ".", "append", "(", "(", "plugin_cls", ".", "name", ",", "fetch_plugin", ")", ")", "type_info", "[", "'event'", "]", "=", "True", "# register an option for plugin", "elif", "hook_type", "==", "'option'", ":", "_option_hooks", ".", "register", "(", "key", ",", "fetch_plugin", ",", "properties", "or", "{", "}", ")", "type_info", "[", "'option'", "]", "=", "True", "else", ":", "return", "# register this class in main registry", "_registered", ".", "register", "(", "plugin_cls", ".", "name", ",", "plugin_cls", ",", "type_info", ")" ]

[ "Handles", "registration", "of", "a", "plugin", "hook", "in", "the", "global", "registries", "." ]

[ "def", "setup_sudo_access", "(", "plugin", ")", ":", "def", "run_root", "(", "self", ",", "command", ")", ":", "\"\"\" Executes a shell command as root.\n\n `command`\n Shell command string.\n\n Returns boolean.\n \"\"\"", "try", ":", "return", "not", "(", "common", ".", "shell_process", "(", "'sudo '", "+", "command", ")", "is", "None", ")", "except", "KeyboardInterrupt", ":", "# user cancelled", "return", "False", "plugin", ".", "run_root", "=", "types", ".", "MethodType", "(", "run_root", ",", "plugin", ")" ]

[ "Injects", "a", "run_root", "method", "into", "the", "provided", "plugin", "instance", "that", "forks", "a", "shell", "command", "using", "sudo", ".", "Used", "for", "command", "plugin", "needs", "." ]

[ "def", "get_registered", "(", "option_hooks", "=", "None", ",", "event_hooks", "=", "None", ",", "command_hooks", "=", "None", ",", "root_access", "=", "None", ",", "task_active", "=", "True", ")", ":", "plugins", "=", "[", "]", "for", "_", ",", "item", "in", "_registered", ":", "plugin", ",", "type_info", "=", "item", "# filter out any task-specific plugins", "if", "task_active", ":", "if", "type_info", ".", "get", "(", "'disabled'", ")", ":", "continue", "else", ":", "if", "plugin", ".", "options", "or", "plugin", ".", "task_only", ":", "continue", "if", "not", "option_hooks", "is", "None", ":", "if", "option_hooks", "!=", "bool", "(", "type_info", ".", "get", "(", "'option'", ")", ")", ":", "continue", "if", "not", "event_hooks", "is", "None", ":", "if", "event_hooks", "!=", "bool", "(", "type_info", ".", "get", "(", "'event'", ")", ")", ":", "continue", "if", "not", "command_hooks", "is", "None", ":", "if", "command_hooks", "!=", "bool", "(", "type_info", ".", "get", "(", "'command'", ")", ")", ":", "continue", "if", "not", "root_access", "is", "None", ":", "if", "root_access", "!=", "plugin", ".", "needs_root", ":", "continue", "plugins", ".", "append", "(", "plugin", ")", "return", "plugins" ]

[ "Returns", "a", "generator", "of", "registered", "plugins", "matching", "filters", "." ]

[ "def", "get_command_hook", "(", "command", ",", "task_active", "=", "True", ")", ":", "plugin_obj", "=", "_command_hooks", ".", "get", "(", "command", ")", "if", "plugin_obj", ":", "if", "task_active", "or", "(", "not", "plugin_obj", ".", "options", "and", "not", "plugin_obj", ".", "task_only", ")", ":", "if", "not", "_is_plugin_disabled", "(", "plugin_obj", ")", ":", "return", "plugin_obj", "return", "None" ]

[ "Gets", "registered", "command", "Plugin", "instance", "for", "the", "provided", "command", "." ]

[ "def", "run_event_hooks", "(", "event", ",", "task", ")", ":", "# get chain of classes registered for this event", "call_chain", "=", "_event_hooks", ".", "get", "(", "event", ")", "if", "call_chain", ":", "# lookup the associated class method for this event", "event_methods", "=", "{", "'task_start'", ":", "'on_taskstart'", ",", "'task_run'", ":", "'on_taskrun'", ",", "'task_end'", ":", "'on_taskend'", "}", "method", "=", "event_methods", ".", "get", "(", "event", ")", "if", "method", ":", "for", "_", ",", "get_plugin", "in", "call_chain", ":", "plugin_obj", "=", "get_plugin", "(", ")", "if", "not", "_is_plugin_disabled", "(", "plugin_obj", ")", ":", "try", ":", "getattr", "(", "plugin_obj", ",", "method", ")", "(", "task", ")", "# execute", "except", "Exception", ":", "# TODO: log these issues for plugin author or user", "pass" ]

[ "Executes", "registered", "task", "event", "plugins", "for", "the", "provided", "event", "and", "task", "." ]

[ "def", "run_option_hooks", "(", "parser", ",", "disable_missing", "=", "True", ")", ":", "plugins", "=", "[", "]", "state", "=", "{", "}", "# state information", "def", "_raise_error", "(", "msg", ",", "block", ")", ":", "\"\"\" Raises ``InvalidTaskConfig`` exception with given message.\n \"\"\"", "if", "block", ":", "msg", "+=", "u' (block: \"{0}\")'", ".", "format", "(", "block", ")", "raise", "errors", ".", "InvalidTaskConfig", "(", "parser", ".", "filename", ",", "reason", "=", "msg", ")", "def", "_run_hooks", "(", "options", ",", "block", ")", ":", "\"\"\" Runs option hooks for the block and options provided.\n \"\"\"", "for", "option", ",", "value_list", "in", "options", ":", "key", "=", "'{0}_{1}'", ".", "format", "(", "block", ",", "option", ")", "if", "block", "else", "option", "item", "=", "_option_hooks", ".", "get", "(", "key", ")", "if", "item", ":", "plugin_obj", ",", "props", "=", "item", "# enforce some properties", "if", "not", "key", "in", "state", ":", "state", "[", "key", "]", "=", "0", "state", "[", "key", "]", "+=", "1", "# currently only supports 'allow_duplicates'", "if", "not", "props", ".", "get", "(", "'allow_duplicates'", ",", "True", ")", "and", "state", "[", "key", "]", ">", "1", ":", "msg", "=", "u'Duplicate option \"{0}\"'", ".", "format", "(", "option", ")", "_raise_error", "(", "msg", ",", "block", ")", "try", ":", "plugin_obj", ".", "parse_option", "(", "option", ",", "block", ",", "*", "value_list", ")", "plugins", ".", "append", "(", "plugin_obj", ")", "except", "TypeError", ":", "# invalid value length", "msg", "=", "u'Value mismatch for option \"{0}\"'", ".", "format", "(", "option", ")", "_raise_error", "(", "msg", ",", "block", ")", "except", "ValueError", "as", "exc", ":", "msg", "=", "unicode", "(", "exc", ")", "if", "not", "msg", ":", "msg", "=", "(", "u'Invalid value provided for option \"{0}\"'", ".", "format", "(", "option", ")", ")", "_raise_error", "(", "msg", ",", "block", ")", "else", ":", "# invalid key found", "msg", "=", "u'Invalid option \"{0}\" found'", ".", "format", "(", "option", ")", "_raise_error", "(", "msg", ",", "block", ")", "# run hooks for non-block options", "_run_hooks", "(", "parser", ".", "options", ",", "None", ")", "# run hooks for blocks", "for", "block", ",", "option_list", "in", "parser", ".", "blocks", ":", "_run_hooks", "(", "option_list", ",", "block", ")", "# disable any plugins using option hooks that didn't match parser data", "if", "disable_missing", ":", "reg_plgs", "=", "get_registered", "(", "option_hooks", "=", "True", ")", "for", "plugin", "in", "[", "p", "for", "p", "in", "reg_plgs", "if", "p", "not", "in", "plugins", "]", ":", "disable_plugin_instance", "(", "plugin", ")" ]

[ "Executes", "registered", "plugins", "using", "option", "hooks", "for", "the", "provided", "SettingParser", "instance", "." ]

[ "def", "_recursive_merge", "(", "dct", ",", "merge_dct", ",", "raise_on_missing", ")", ":", "# type: (Dict[str, Any], Dict[str, Any], bool) -> Dict[str, Any]", "for", "k", ",", "v", "in", "merge_dct", ".", "items", "(", ")", ":", "if", "k", "in", "dct", ":", "if", "isinstance", "(", "dct", "[", "k", "]", ",", "dict", ")", "and", "isinstance", "(", "merge_dct", "[", "k", "]", ",", "BaseMapping", ")", ":", "dct", "[", "k", "]", "=", "_recursive_merge", "(", "dct", "[", "k", "]", ",", "merge_dct", "[", "k", "]", ",", "raise_on_missing", ")", "else", ":", "dct", "[", "k", "]", "=", "merge_dct", "[", "k", "]", "elif", "isinstance", "(", "dct", ",", "Extensible", ")", ":", "dct", "[", "k", "]", "=", "merge_dct", "[", "k", "]", "else", ":", "message", "=", "\"Unknown configuration key: '{k}'\"", ".", "format", "(", "k", "=", "k", ")", "if", "raise_on_missing", ":", "raise", "KeyError", "(", "message", ")", "else", ":", "logging", ".", "getLogger", "(", "__name__", ")", ".", "warning", "(", "message", ")", "return", "dct" ]

[ "Recursive", "dict", "merge" ]

[ "def", "apply", "(", "self", ",", "config", ",", "raise_on_unknown_key", "=", "True", ")", ":", "# type: (Dict[str, Any], bool) -> None", "_recursive_merge", "(", "self", ".", "_data", ",", "config", ",", "raise_on_unknown_key", ")" ]

[ "Apply", "additional", "configuration", "from", "a", "dictionary" ]

[ "def", "apply_object", "(", "self", ",", "config_obj", ",", "apply_on", "=", "None", ")", ":", "# type: (object, Optional[Tuple[str, ...]]) -> None", "self", ".", "_init_flat_pointers", "(", ")", "try", ":", "config_obj_keys", "=", "vars", "(", "config_obj", ")", ".", "keys", "(", ")", "# type: Iterable[str]", "except", "TypeError", ":", "config_obj_keys", "=", "filter", "(", "lambda", "k", ":", "k", "[", "0", "]", "!=", "'_'", ",", "dir", "(", "config_obj", ")", ")", "for", "config_key", "in", "config_obj_keys", ":", "if", "apply_on", ":", "flat_key", "=", "apply_on", "+", "(", "config_key", ",", ")", "else", ":", "flat_key", "=", "(", "config_key", ",", ")", "if", "flat_key", "in", "self", ".", "_flat_pointers", ":", "container", ",", "orig_key", "=", "self", ".", "_flat_pointers", "[", "flat_key", "]", "container", "[", "orig_key", "]", "=", "getattr", "(", "config_obj", ",", "config_key", ")" ]

[ "Apply", "additional", "configuration", "from", "any", "Python", "object" ]

[ "def", "apply_flat", "(", "self", ",", "config", ",", "namespace_separator", "=", "'_'", ",", "prefix", "=", "''", ")", ":", "# type: (Dict[str, Any], str, str) -> None", "self", ".", "_init_flat_pointers", "(", ")", "for", "key_stack", ",", "(", "container", ",", "orig_key", ")", "in", "self", ".", "_flat_pointers", ".", "items", "(", ")", ":", "flat_key", "=", "'{prefix}{joined_key}'", ".", "format", "(", "prefix", "=", "prefix", ",", "joined_key", "=", "namespace_separator", ".", "join", "(", "key_stack", ")", ")", "if", "flat_key", "in", "config", ":", "container", "[", "orig_key", "]", "=", "config", "[", "flat_key", "]" ]

[ "Apply", "additional", "configuration", "from", "a", "flattened", "dictionary" ]

[ "def", "cross", "(", "environment", ",", "book", ",", "row", ",", "sheet_source", ",", "column_source", ",", "column_key", ")", ":", "a", "=", "book", ".", "sheets", "[", "sheet_source", "]", "return", "environment", ".", "copy", "(", "a", ".", "get", "(", "*", "*", "{", "column_key", ":", "row", "[", "column_key", "]", "}", ")", "[", "column_source", "]", ")" ]

[ "Returns", "a", "single", "value", "from", "a", "column", "from", "a", "different", "dataset", "matching", "by", "the", "key", "." ]

[ "def", "column", "(", "environment", ",", "book", ",", "sheet_name", ",", "sheet_source", ",", "column_source", ",", "column_key", ")", ":", "a", "=", "book", ".", "sheets", "[", "sheet_source", "]", "b", "=", "book", ".", "sheets", "[", "sheet_name", "]", "return", "environment", ".", "copy", "(", "[", "a", ".", "get", "(", "*", "*", "{", "column_key", ":", "row", "[", "column_key", "]", "}", ")", "[", "column_source", "]", "for", "row", "in", "b", ".", "all", "(", ")", "]", ")" ]

[ "Returns", "an", "array", "of", "values", "from", "column", "from", "a", "different", "dataset", "ordered", "as", "the", "key", "." ]

[ "def", "main", "(", "input_file", ",", "output", ",", "format", ")", ":", "try", ":", "process_image", "(", "input_file", ",", "subfolder", "=", "output", ",", "ext", "=", "format", ")", "except", "Exception", "as", "e", ":", "sys", ".", "exit", "(", "e", ")" ]

[ "Converts", "an", "image", "file", "to", "a", "Leaflet", "map", "." ]

[ "def", "with_lock", "(", "lock", ",", "func", ",", "*", "args", ",", "*", "*", "kwargs", ")", ":", "d", "=", "lock", ".", "acquire", "(", ")", "def", "release_lock", "(", "result", ")", ":", "deferred", "=", "lock", ".", "release", "(", ")", "return", "deferred", ".", "addCallback", "(", "lambda", "x", ":", "result", ")", "def", "lock_acquired", "(", "lock", ")", ":", "return", "defer", ".", "maybeDeferred", "(", "func", ",", "*", "args", ",", "*", "*", "kwargs", ")", ".", "addBoth", "(", "release_lock", ")", "d", ".", "addCallback", "(", "lock_acquired", ")", "return", "d" ]

[ "A", "context", "manager", "for", "performing", "operations", "requiring", "a", "lock", "." ]

[ "def", "koji_instance", "(", "config", ",", "message", ",", "instance", "=", "None", ",", "*", "args", ",", "*", "*", "kw", ")", ":", "instance", "=", "kw", ".", "get", "(", "'instance'", ",", "instance", ")", "if", "not", "instance", ":", "return", "False", "instances", "=", "[", "item", ".", "strip", "(", ")", "for", "item", "in", "instance", ".", "split", "(", "','", ")", "]", "return", "message", "[", "'msg'", "]", ".", "get", "(", "'instance'", ")", "in", "instances" ]

[ "Particular", "koji", "instances" ]

[ "def", "add", "(", "self", ",", "value_id", ",", "name", ",", "value_class", ")", ":", "item", "=", "value_class", "(", "name", ",", "value_id", "=", "self", ".", "controller", ".", "component_id", "+", "\".\"", "+", "value_id", ",", "is_input", "=", "self", ".", "is_input", ",", "index", "=", "self", ".", "count", ",", "spine", "=", "self", ".", "controller", ".", "spine", ")", "#if self._inject and self.controller:", "# setattr(self.controller, value_id, item)", "#setattr(self, value_id, item)", "self", ".", "count", "+=", "1", "self", ".", "_items", "[", "value_id", "]", "=", "item", "if", "self", ".", "is_input", "and", "self", ".", "controller", ":", "item", ".", "add_observer", "(", "self", ".", "controller", ")", "return", "item" ]

[ "Factory", "function", "that", "creates", "a", "value", "." ]

[ "def", "register", "(", "self", ",", "name", ")", ":", "def", "decorator", "(", "func", ")", ":", "\"\"\"Inner decorator, not used directly.\n\n Args:\n func: obj. Parameterless function to register.\n\n Returns:\n func: decorated function.\n \"\"\"", "self", ".", "logic", "[", "name", "]", "=", "func", "@", "wraps", "(", "func", ")", "def", "wrapper", "(", ")", ":", "\"\"\"Wrapper, not used directly.\"\"\"", "raise", "RuntimeError", "(", "'working outside of request context'", ")", "return", "wrapper", "return", "decorator" ]

[ "Decorator", "for", "registering", "a", "named", "function", "in", "the", "sesion", "logic", "." ]

[ "def", "pass_session_attributes", "(", "self", ")", ":", "for", "key", ",", "value", "in", "six", ".", "iteritems", "(", "self", ".", "request", ".", "session", ".", "attributes", ")", ":", "self", ".", "response", ".", "sessionAttributes", "[", "key", "]", "=", "value" ]

[ "Copies", "request", "attributes", "to", "response" ]

[ "def", "dispatch", "(", "self", ")", ":", "if", "self", ".", "request", ".", "request", ".", "type", "==", "'IntentRequest'", ":", "name", "=", "self", ".", "request", ".", "request", ".", "intent", ".", "name", "else", ":", "name", "=", "self", ".", "request", ".", "request", ".", "type", "if", "name", "in", "self", ".", "logic", ":", "self", ".", "logic", "[", "name", "]", "(", ")", "else", ":", "error", "=", "'Unable to find a registered logic function named: {}'", "raise", "KeyError", "(", "error", ".", "format", "(", "name", ")", ")" ]

[ "Calls", "the", "matching", "logic", "function", "by", "request", "type", "or", "intent", "name", "." ]

[ "def", "process", "(", "self", ",", "body", ",", "url", "=", "None", ",", "sig", "=", "None", ")", ":", "self", ".", "request", "=", "RequestBody", "(", ")", "self", ".", "response", "=", "ResponseBody", "(", ")", "self", ".", "request", ".", "parse", "(", "body", ")", "app_id", "=", "self", ".", "request", ".", "session", ".", "application", ".", "application_id", "stamp", "=", "self", ".", "request", ".", "request", ".", "timestamp", "if", "not", "self", ".", "valid", ".", "request", "(", "app_id", ",", "body", ",", "stamp", ",", "url", ",", "sig", ")", ":", "return", "False", "self", ".", "pass_session_attributes", "(", ")", "self", ".", "dispatch", "(", ")", "if", "self", ".", "request", ".", "request", ".", "type", "==", "'SessionEndedRequest'", ":", "self", ".", "terminate", "(", ")", "return", "self", ".", "response", ".", "to_json", "(", ")" ]

[ "Process", "request", "body", "given", "skill", "logic", "." ]

[ "def", "walk", "(", "self", ",", "filters", ":", "str", "=", "None", ",", "filter_type", ":", "type", "=", "None", ",", "pprint", "=", "False", ",", "depth", "=", "-", "1", ")", ":", "children", "=", "self", ".", "children", "(", ")", "if", "children", "is", "None", ":", "children", "=", "[", "]", "res", "=", "[", "]", "if", "depth", "==", "0", ":", "return", "res", "elif", "depth", "!=", "-", "1", ":", "depth", "-=", "1", "for", "child", "in", "children", ":", "if", "isinstance", "(", "child", ",", "Formula", ")", ":", "tmp", "=", "child", ".", "walk", "(", "filters", "=", "filters", ",", "filter_type", "=", "filter_type", ",", "pprint", "=", "pprint", ",", "depth", "=", "depth", ")", "if", "tmp", ":", "res", ".", "extend", "(", "tmp", ")", "if", "filter_type", "is", "None", ":", "if", "filters", "is", "not", "None", ":", "if", "eval", "(", "filters", ")", "is", "True", ":", "res", ".", "append", "(", "self", ")", "else", ":", "res", ".", "append", "(", "self", ")", "elif", "isinstance", "(", "self", ",", "filter_type", ")", ":", "if", "filters", "is", "not", "None", ":", "if", "eval", "(", "filters", ")", "is", "True", ":", "res", ".", "append", "(", "self", ")", "else", ":", "res", ".", "append", "(", "self", ")", "if", "pprint", ":", "res", "=", "[", "str", "(", "x", ")", "+", "\" \"", "for", "x", "in", "res", "]", "res", "=", "\"\\n\"", ".", "join", "(", "res", ")", "return", "res" ]

[ "Iterate", "tree", "in", "pre", "-", "order", "wide", "-", "first", "search", "order" ]

[ "def", "red_workshift", "(", "request", ",", "message", "=", "None", ")", ":", "if", "message", ":", "messages", ".", "add_message", "(", "request", ",", "messages", ".", "ERROR", ",", "message", ")", "return", "HttpResponseRedirect", "(", "reverse", "(", "'workshift:view_semester'", ")", ")" ]

[ "Redirects", "to", "the", "base", "workshift", "page", "for", "users", "who", "are", "logged", "in" ]

[ "def", "_user_settings", "(", "self", ")", ":", "user_settings", "=", "getattr", "(", "settings", ",", "self", ".", "_name", ",", "{", "}", ")", "if", "not", "user_settings", "and", "self", ".", "_required", ":", "raise", "ImproperlyConfigured", "(", "\"Settings file is missing dict options with name {}\"", ".", "format", "(", "self", ".", "_name", ")", ")", "keys", "=", "frozenset", "(", "user_settings", ".", "keys", "(", ")", ")", "required", "=", "self", ".", "_required", "-", "keys", "if", "required", ":", "raise", "ImproperlyConfigured", "(", "\"Following options for {} are missing from settings file: {}\"", ".", "format", "(", "self", ".", "_name", ",", "', '", ".", "join", "(", "sorted", "(", "required", ")", ")", ")", ")", "removed", "=", "keys", "&", "self", ".", "_removed", "if", "removed", ":", "raise", "ImproperlyConfigured", "(", "\"Following options for {} have been removed: {}\"", ".", "format", "(", "self", ".", "_name", ",", "', '", ".", "join", "(", "sorted", "(", "removed", ")", ")", ")", ")", "return", "user_settings" ]

[ "Resolve", "settings", "dict", "from", "django", "settings", "module", ".", "Validate", "that", "all", "the", "required", "keys", "are", "present", "and", "also", "that", "none", "of", "the", "removed", "keys", "do", ".", "Result", "is", "cached", "." ]

[ "def", "copy", "(", "self", ",", "empty", "=", "False", ")", ":", "# Create an empty object", "newobject", "=", "self", ".", "__new__", "(", "self", ".", "__class__", ")", "if", "empty", ":", "return", "# And fill it !", "for", "prop", "in", "[", "\"_properties\"", ",", "\"_side_properties\"", ",", "\"_derived_properties\"", ",", "\"_build_properties\"", "]", ":", "if", "prop", "not", "in", "dir", "(", "self", ")", ":", "continue", "try", ":", "# Try to deep copy because but some time it does not work (e.g. wcs) ", "newobject", ".", "__dict__", "[", "prop", "]", "=", "copy", ".", "deepcopy", "(", "self", ".", "__dict__", "[", "prop", "]", ")", "except", ":", "newobject", ".", "__dict__", "[", "prop", "]", "=", "copy", ".", "copy", "(", "self", ".", "__dict__", "[", "prop", "]", ")", "# This be sure things are correct", "newobject", ".", "_update_", "(", ")", "# and return it", "return", "newobject" ]

[ "returns", "an", "independent", "copy", "of", "the", "current", "object", "." ]

[ "def", "msg", "(", "self", ",", "message", ",", "*", "args", ",", "*", "*", "kwargs", ")", ":", "target", "=", "kwargs", ".", "pop", "(", "'target'", ",", "None", ")", "raw", "=", "kwargs", ".", "pop", "(", "'raw'", ",", "False", ")", "if", "not", "target", ":", "target", "=", "self", ".", "line", ".", "sender", ".", "nick", "if", "self", ".", "line", ".", "pm", "else", "self", ".", "line", ".", "target", "if", "not", "raw", ":", "kw", "=", "{", "'m'", ":", "self", ",", "'b'", ":", "chr", "(", "2", ")", ",", "'c'", ":", "chr", "(", "3", ")", ",", "'u'", ":", "chr", "(", "31", ")", ",", "}", "kw", ".", "update", "(", "kwargs", ")", "try", ":", "message", "=", "message", ".", "format", "(", "*", "args", ",", "*", "*", "kw", ")", "except", "IndexError", ":", "if", "len", "(", "args", ")", "==", "1", "and", "isinstance", "(", "args", "[", "0", "]", ",", "list", ")", ":", "# Message might be: msg, [arg1, arg2], kwargs", "message", "=", "message", ".", "format", "(", "*", "args", "[", "0", "]", ",", "*", "*", "kw", ")", "else", ":", "raise", "self", ".", "connection", ".", "msg", "(", "target", ",", "message", ")" ]

[ "Shortcut", "to", "send", "a", "message", "through", "the", "connection", "." ]

[ "def", "shell_run", "(", "cmd", ",", "cin", "=", "None", ",", "cwd", "=", "None", ",", "timeout", "=", "10", ",", "critical", "=", "True", ",", "verbose", "=", "True", ")", ":", "res", "=", "dict", "(", "command", "=", "cmd", ")", "if", "cin", ":", "cin", "=", "str", "(", "cin", ")", "res", ".", "update", "(", "dict", "(", "stdin", "=", "cin", ")", ")", "if", "cwd", ":", "res", ".", "update", "(", "dict", "(", "cwd", "=", "cwd", ")", ")", "if", "isinstance", "(", "cmd", ",", "str", ")", ":", "cmd", "=", "_split", "(", "cmd", ")", "try", ":", "p", "=", "_Popen", "(", "cmd", ",", "stdin", "=", "_PIPE", ",", "stdout", "=", "_PIPE", ",", "stderr", "=", "_PIPE", ",", "bufsize", "=", "1", ",", "cwd", "=", "cwd", ",", "universal_newlines", "=", "True", ")", "except", "Exception", "as", "ex", ":", "res", ".", "update", "(", "dict", "(", "exception", "=", "str", "(", "ex", ")", ")", ")", "else", ":", "try", ":", "out", ",", "err", "=", "p", ".", "communicate", "(", "input", "=", "cin", ",", "timeout", "=", "timeout", ")", "if", "out", ":", "res", ".", "update", "(", "dict", "(", "stdout", "=", "[", "o", "for", "o", "in", "out", ".", "split", "(", "'\\n'", ")", "if", "o", "]", ")", ")", "if", "err", ":", "res", ".", "update", "(", "dict", "(", "stderr", "=", "[", "e", "for", "e", "in", "err", ".", "split", "(", "'\\n'", ")", "if", "e", "]", ")", ")", "res", ".", "update", "(", "dict", "(", "returncode", "=", "p", ".", "returncode", ")", ")", "except", "_TimeoutExpired", "as", "ex", ":", "res", ".", "update", "(", "dict", "(", "exception", "=", "str", "(", "ex", ")", ",", "timeout", "=", "timeout", ")", ")", "p", ".", "kill", "(", ")", "except", "Exception", "as", "ex", ":", "res", ".", "update", "(", "dict", "(", "exception", "=", "str", "(", "ex", ")", ")", ")", "res", ".", "update", "(", "out", "=", "(", "res", ".", "get", "(", "'exception'", ")", "or", "'\\n'", ".", "join", "(", "res", ".", "get", "(", "'stderr'", ")", "or", "res", ".", "get", "(", "'stdout'", ",", "''", ")", ")", ")", ")", "if", "res", ".", "get", "(", "'returncode'", ",", "-", "1", ")", "!=", "0", ":", "res", ".", "update", "(", "dict", "(", "critical", "=", "critical", ")", ")", "shell_notify", "(", "'error in shell command \\'%s\\''", "%", "(", "res", ".", "get", "(", "'command'", ")", ")", ",", "state", "=", "True", "if", "critical", "else", "None", ",", "more", "=", "res", ",", "verbose", "=", "verbose", ")", "return", "res" ]

[ "Runs", "a", "shell", "command", "within", "a", "controlled", "environment", "." ]

[ "def", "get_timestamp", "(", "time", "=", "True", ",", "precice", "=", "False", ")", ":", "f", "=", "'%Y.%m.%d'", "if", "time", ":", "f", "+=", "'-%H.%M.%S'", "if", "precice", ":", "f", "+=", "'-%f'", "return", "_datetime", ".", "now", "(", ")", ".", "strftime", "(", "f", ")" ]

[ "What", "time", "is", "it?" ]

[ "def", "get_hostname", "(", ")", ":", "h", "=", "shell_run", "(", "'uname -n'", ",", "critical", "=", "False", ",", "verbose", "=", "False", ")", "if", "not", "h", ":", "h", "=", "shell_run", "(", "'hostname'", ",", "critical", "=", "False", ",", "verbose", "=", "False", ")", "if", "not", "h", ":", "shell_notify", "(", "'could not retrieve hostname'", ",", "state", "=", "True", ")", "return", "str", "(", "h", ".", "get", "(", "'out'", ")", ")", ".", "split", "(", "'.'", ")", "[", "0", "]" ]

[ "Determines", "the", "current", "hostname", "by", "probing", "uname", "-", "n", ".", "Falls", "back", "to", "hostname", "in", "case", "of", "problems", "." ]

[ "def", "open_connection", "(", "self", ",", "verbose", "=", "False", ")", ":", "# Connect to server", "hostname", "=", "self", ".", "configs", ".", "get", "(", "'IMAP'", ",", "'hostname'", ")", "if", "verbose", ":", "print", "(", "'Connecting to '", "+", "hostname", ")", "connection", "=", "imaplib", ".", "IMAP4_SSL", "(", "hostname", ")", "# Authenticate", "username", "=", "self", ".", "configs", ".", "get", "(", "'IMAP'", ",", "'username'", ")", "password", "=", "self", ".", "configs", ".", "get", "(", "'IMAP'", ",", "'password'", ")", "if", "verbose", ":", "print", "(", "'Logging in as'", ",", "username", ")", "connection", ".", "login", "(", "username", ",", "password", ")", "return", "connection" ]

[ "Initializes", "a", "new", "IMAP4_SSL", "connection", "to", "an", "email", "server", "." ]

[ "def", "get_body", "(", "self", ",", "msg", ")", ":", "body", "=", "\"\"", "charset", "=", "\"\"", "if", "msg", ".", "is_multipart", "(", ")", ":", "for", "part", "in", "msg", ".", "walk", "(", ")", ":", "ctype", "=", "part", ".", "get_content_type", "(", ")", "cdispo", "=", "str", "(", "part", ".", "get", "(", "'Content-Disposition'", ")", ")", "# skip any text/plain (txt) attachments", "if", "ctype", "==", "'text/plain'", "and", "'attachment'", "not", "in", "cdispo", ":", "body", "=", "part", ".", "get_payload", "(", "decode", "=", "True", ")", "# decode", "charset", "=", "part", ".", "get_content_charset", "(", ")", "break", "# not multipart - i.e. plain text, no attachments, keeping fingers crossed", "else", ":", "body", "=", "msg", ".", "get_payload", "(", "decode", "=", "True", ")", "charset", "=", "msg", ".", "get_content_charset", "(", ")", "return", "body", ".", "decode", "(", "charset", ")" ]

[ "Extracts", "and", "returns", "the", "decoded", "body", "from", "an", "EmailMessage", "object" ]

[ "def", "get_subject", "(", "self", ",", "msg", ")", ":", "text", ",", "encoding", "=", "decode_header", "(", "msg", "[", "'subject'", "]", ")", "[", "-", "1", "]", "try", ":", "text", "=", "text", ".", "decode", "(", "encoding", ")", "# If it's already decoded, ignore error", "except", "AttributeError", ":", "pass", "return", "text" ]

[ "Extracts", "the", "subject", "line", "from", "an", "EmailMessage", "object", "." ]

[ "def", "run", "(", "self", ",", "conn", ",", "tmp", ",", "module_name", ",", "module_args", ",", "inject", ")", ":", "# shell and command module are the same", "if", "module_name", "==", "'shell'", ":", "module_name", "=", "'command'", "module_args", "+=", "\" #USE_SHELL\"", "(", "module_path", ",", "is_new_style", ",", "shebang", ")", "=", "self", ".", "runner", ".", "_copy_module", "(", "conn", ",", "tmp", ",", "module_name", ",", "module_args", ",", "inject", ")", "self", ".", "runner", ".", "_low_level_exec_command", "(", "conn", ",", "\"chmod a+rx %s\"", "%", "module_path", ",", "tmp", ")", "return", "self", ".", "runner", ".", "_execute_module", "(", "conn", ",", "tmp", ",", "'async_wrapper'", ",", "module_args", ",", "async_module", "=", "module_path", ",", "async_jid", "=", "self", ".", "runner", ".", "generated_jid", ",", "async_limit", "=", "self", ".", "runner", ".", "background", ",", "inject", "=", "inject", ")" ]

[ "transfer", "the", "given", "module", "name", "plus", "the", "async", "module", "then", "run", "it" ]

[ "def", "getparams", "(", "self", ",", "param", ")", ":", "return", "list", "(", "cparam", "for", "cparam", "in", "self", ".", "values", "(", ")", "if", "cparam", "==", "param", ")" ]

[ "Get", "parameters", "which", "match", "with", "input", "param", "." ]

[ "def", "main", "(", ")", ":", "version", "=", "'Python Exist %s'", "%", "__version__", "arguments", "=", "docopt", "(", "__doc__", ",", "version", "=", "version", ")", "ExistCli", "(", "arguments", ")" ]

[ "Parse", "the", "arguments", "and", "use", "them", "to", "create", "a", "ExistCli", "object" ]

[ "def", "read_config", "(", "self", ")", ":", "with", "open", "(", "self", ".", "config_file", ")", "as", "cfg", ":", "try", ":", "self", ".", "config", ".", "read_file", "(", "cfg", ")", "except", "AttributeError", ":", "self", ".", "config", ".", "readfp", "(", "cfg", ")", "self", ".", "client_id", "=", "self", ".", "config", ".", "get", "(", "'exist'", ",", "'client_id'", ")", "self", ".", "client_secret", "=", "self", ".", "config", ".", "get", "(", "'exist'", ",", "'client_secret'", ")", "self", ".", "access_token", "=", "self", ".", "config", ".", "get", "(", "'exist'", ",", "'access_token'", ")" ]

[ "Read", "credentials", "from", "the", "config", "file" ]

[ "def", "write_config", "(", "self", ",", "access_token", ")", ":", "self", ".", "config", ".", "add_section", "(", "'exist'", ")", "# TODO: config is reading 'None' as string during authorization, so clearing this out", "# if no id or secret is set - need to fix this later", "if", "self", ".", "client_id", ":", "self", ".", "config", ".", "set", "(", "'exist'", ",", "'client_id'", ",", "self", ".", "client_id", ")", "else", ":", "self", ".", "config", ".", "set", "(", "'exist'", ",", "'client_id'", ",", "''", ")", "if", "self", ".", "client_secret", ":", "self", ".", "config", ".", "set", "(", "'exist'", ",", "'client_secret'", ",", "self", ".", "client_secret", ")", "else", ":", "self", ".", "config", ".", "set", "(", "'exist'", ",", "'client_secret'", ",", "''", ")", "self", ".", "config", ".", "set", "(", "'exist'", ",", "'access_token'", ",", "access_token", ")", "with", "open", "(", "self", ".", "config_file", ",", "'w'", ")", "as", "cfg", ":", "self", ".", "config", ".", "write", "(", "cfg", ")", "print", "(", "'Credentials written to %s'", "%", "self", ".", "config_file", ")" ]

[ "Write", "credentials", "to", "the", "config", "file" ]

[ "def", "get_resource", "(", "self", ",", "arguments", ")", ":", "attribute_name", "=", "arguments", "[", "'<attribute_name>'", "]", "limit", "=", "arguments", "[", "'--limit'", "]", "page", "=", "arguments", "[", "'--page'", "]", "date_min", "=", "arguments", "[", "'--date_min'", "]", "date_max", "=", "arguments", "[", "'--date_max'", "]", "# feed in the config we have, and let the Exist class figure out the best", "# way to authenticate", "exist", "=", "Exist", "(", "self", ".", "client_id", ",", "self", ".", "client_secret", ",", "self", ".", "access_token", ")", "# TODO: Tidy this up since we are repeating ourselves a lot below", "if", "arguments", "[", "'user'", "]", ":", "result", "=", "exist", ".", "user", "(", ")", "elif", "arguments", "[", "'attributes'", "]", ":", "result", "=", "exist", ".", "attributes", "(", "attribute_name", ",", "limit", ",", "page", ",", "date_min", ",", "date_max", ")", "elif", "arguments", "[", "'insights'", "]", ":", "result", "=", "exist", ".", "insights", "(", "attribute_name", ",", "limit", ",", "page", ",", "date_min", ",", "date_max", ")", "elif", "arguments", "[", "'averages'", "]", ":", "result", "=", "exist", ".", "averages", "(", "attribute_name", ",", "limit", ",", "page", ",", "date_min", ",", "date_max", ")", "elif", "arguments", "[", "'correlations'", "]", ":", "result", "=", "exist", ".", "correlations", "(", "attribute_name", ",", "limit", ",", "page", ",", "date_min", ",", "date_max", ")", "elif", "arguments", "[", "'acquire_attributes'", "]", ":", "attributes_dict", "=", "[", "{", "'name'", ":", "x", ".", "split", "(", "':'", ")", "[", "0", "]", ",", "'active'", ":", "x", ".", "split", "(", "':'", ")", "[", "1", "]", "}", "for", "x", "in", "arguments", "[", "'<attribute:value>'", "]", "]", "result", "=", "exist", ".", "arquire_attributes", "(", "attributes_dict", ")", "elif", "arguments", "[", "'release_attributes'", "]", ":", "attributes_dict", "=", "[", "{", "'name'", ":", "x", "}", "for", "x", "in", "arguments", "[", "'<attribute_name>'", "]", "]", "result", "=", "exist", ".", "release_attributes", "(", "attributes_dict", ")", "elif", "arguments", "[", "'owned_attributes'", "]", ":", "result", "=", "exist", ".", "owned_attributes", "(", ")", "elif", "arguments", "[", "'update_attributes'", "]", ":", "attributes_dict", "=", "[", "{", "'name'", ":", "x", ".", "split", "(", "':'", ")", "[", "0", "]", ",", "'date'", ":", "x", ".", "split", "(", "':'", ")", "[", "1", "]", ",", "'value'", ":", "x", ".", "split", "(", "':'", ")", "[", "2", "]", "}", "for", "x", "in", "arguments", "[", "'<attribute:date:value>'", "]", "]", "result", "=", "exist", ".", "update_attributes", "(", "attributes_dict", ")", "pp", "=", "PrettyPrinter", "(", "indent", "=", "4", ")", "if", "isinstance", "(", "result", ",", "list", ")", ":", "pp", ".", "pprint", "(", "[", "res", ".", "data", "for", "res", "in", "result", "]", ")", "else", ":", "pp", ".", "pprint", "(", "result", ".", "data", ")" ]

[ "Gets", "the", "resource", "requested", "in", "the", "arguments" ]

[ "def", "authorize", "(", "self", ",", "api_token", "=", "None", ",", "username", "=", "None", ",", "password", "=", "None", ")", ":", "access_token", "=", "None", "if", "username", "and", "password", ":", "# if we have a username and password, go and collect a token", "auth", "=", "ExistAuthBasic", "(", "username", ",", "password", ")", "auth", ".", "authorize", "(", ")", "if", "auth", ".", "token", ":", "access_token", "=", "auth", ".", "token", "[", "'access_token'", "]", "elif", "api_token", ":", "# if we already have a token, just use that", "access_token", "=", "api_token", "else", ":", "# if we have a client_id and client_secret, we need to", "# authorize through the browser", "auth", "=", "ExistAuth", "(", "self", ".", "client_id", ",", "self", ".", "client_secret", ",", "'code'", ",", "self", ".", "redirect_uri", ")", "auth", ".", "browser_authorize", "(", ")", "if", "auth", ".", "token", ":", "access_token", "=", "auth", ".", "token", "[", "'access_token'", "]", "# store the access token in the config file", "if", "access_token", ":", "self", ".", "write_config", "(", "access_token", ")", "else", ":", "print", "(", "'ERROR: We were unable to authorize to use the Exist API.'", ")" ]

[ "Authorize", "a", "user", "using", "the", "browser", "and", "a", "CherryPy", "server", "and", "write", "the", "resulting", "credentials", "to", "a", "config", "file", "." ]

[ "def", "refresh_token", "(", "self", ",", "arguments", ")", ":", "new_access_token", "=", "None", "auth", "=", "ExistAuth", "(", "self", ".", "client_id", ",", "self", ".", "client_secret", ")", "resp", "=", "auth", ".", "refresh_token", "(", "self", ".", "access_token", ")", "if", "auth", ".", "token", ":", "new_access_token", "=", "auth", ".", "token", "[", "'access_token'", "]", "print", "(", "'OAuth token refreshed: %s'", "%", "new_access_token", ")", "self", ".", "write_config", "(", "new_access_token", ")", "else", ":", "print", "(", "'ERROR: We were unable to refresh the OAuth token | %s'", "%", "json", ".", "dumps", "(", "resp", ")", ")" ]

[ "Refresh", "a", "user", "s", "access", "token", "using", "existing", "the", "refresh", "token", "previously", "received", "in", "the", "auth", "flow", "." ]

[ "def", "_version_find_existing", "(", ")", ":", "_tool_run", "(", "'git fetch origin -t'", ")", "git_tags", "=", "[", "x", "for", "x", "in", "(", "y", ".", "strip", "(", ")", "for", "y", "in", "(", "_tool_run", "(", "'git tag -l'", ")", ".", "stdout", ".", "split", "(", "'\\n'", ")", ")", ")", "if", "x", "]", "return", "{", "tuple", "(", "int", "(", "n", ")", "if", "n", "else", "0", "for", "n", "in", "m", ".", "groups", "(", ")", ")", "for", "m", "in", "(", "_version_re", ".", "match", "(", "t", ")", "for", "t", "in", "git_tags", ")", "if", "m", "}" ]

[ "Returns", "set", "of", "existing", "versions", "in", "this", "repository", ".", "This", "information", "is", "backed", "by", "previously", "used", "version", "tags", "in", "git", ".", "Available", "tags", "are", "pulled", "from", "origin", "repository", "before", "." ]

[ "def", "_git_enable_branch", "(", "desired_branch", ")", ":", "preserved_branch", "=", "_git_get_current_branch", "(", ")", "try", ":", "if", "preserved_branch", "!=", "desired_branch", ":", "_tool_run", "(", "'git checkout '", "+", "desired_branch", ")", "yield", "finally", ":", "if", "preserved_branch", "and", "preserved_branch", "!=", "desired_branch", ":", "_tool_run", "(", "'git checkout '", "+", "preserved_branch", ")" ]

[ "Enable", "desired", "branch", "name", "." ]

[ "def", "mk_travis_config", "(", ")", ":", "t", "=", "dedent", "(", "\"\"\"\\\n language: python\n python: 3.4\n env:\n {jobs}\n install:\n - pip install -r requirements/ci.txt\n script:\n - invoke ci_run_job $TOX_JOB\n after_success:\n coveralls\n \"\"\"", ")", "jobs", "=", "[", "env", "for", "env", "in", "parseconfig", "(", "None", ",", "'tox'", ")", ".", "envlist", "if", "not", "env", ".", "startswith", "(", "'cov-'", ")", "]", "jobs", "+=", "'coverage'", ",", "print", "(", "t", ".", "format", "(", "jobs", "=", "(", "'\\n'", ".", "join", "(", "(", "' - TOX_JOB='", "+", "job", ")", "for", "job", "in", "jobs", ")", ")", ")", ")" ]

[ "Generate", "configuration", "for", "travis", "." ]

[ "def", "mkrelease", "(", "finish", "=", "'yes'", ",", "version", "=", "''", ")", ":", "if", "not", "version", ":", "version", "=", "_version_format", "(", "_version_guess_next", "(", ")", ")", "if", "_git_get_current_branch", "(", ")", "!=", "'release/'", "+", "version", ":", "_tool_run", "(", "'git checkout develop'", ",", "'git flow release start '", "+", "version", ")", "_project_patch_version", "(", "version", ")", "_project_patch_changelog", "(", ")", "patched_files", "=", "' '", ".", "join", "(", "[", "VERSION_FILE", ",", "CHANGES_FILE", "]", ")", "run", "(", "'git diff '", "+", "patched_files", ",", "pty", "=", "True", ")", "_tool_run", "(", "(", "'git commit -m \"Bump Version to {0!s}\" {1!s}'", ".", "format", "(", "version", ",", "patched_files", ")", ")", ")", "if", "finish", "not", "in", "(", "'no'", ",", "'n'", ",", ")", ":", "_tool_run", "(", "\"git flow release finish -m '{0}' {0}\"", ".", "format", "(", "version", ")", ",", "env", "=", "{", "b'GIT_MERGE_AUTOEDIT'", ":", "b'no'", ",", "}", ")", "_tool_run", "(", "'git push origin --tags develop master'", ")" ]

[ "Allocates", "the", "next", "version", "number", "and", "marks", "current", "develop", "branch", "state", "as", "a", "new", "release", "with", "the", "allocated", "version", "number", ".", "Syncs", "new", "state", "with", "origin", "repository", "." ]

[ "def", "get_allow_future", "(", "self", ")", ":", "qs", "=", "self", ".", "get_queryset", "(", ")", "post_edit_permission", "=", "'{}.edit_{}'", ".", "format", "(", "qs", ".", "model", ".", "_meta", ".", "app_label", ",", "qs", ".", "model", ".", "_meta", ".", "model_name", ")", "if", "self", ".", "request", ".", "user", ".", "has_perm", "(", "post_edit_permission", ")", ":", "return", "True", "return", "False" ]

[ "Only", "superusers", "and", "users", "with", "the", "permission", "can", "edit", "the", "post", "." ]

[ "def", "update_changed_requirements", "(", ")", ":", "reqs_path", "=", "join", "(", "env", ".", "proj_path", ",", "env", ".", "reqs_path", ")", "get_reqs", "=", "lambda", ":", "run", "(", "\"cat %s\"", "%", "reqs_path", ",", "show", "=", "False", ")", "old_reqs", "=", "get_reqs", "(", ")", "if", "env", ".", "reqs_path", "else", "\"\"", "yield", "if", "old_reqs", ":", "new_reqs", "=", "get_reqs", "(", ")", "if", "old_reqs", "==", "new_reqs", ":", "# Unpinned requirements should always be checked.", "for", "req", "in", "new_reqs", ".", "split", "(", "\"\\n\"", ")", ":", "if", "req", ".", "startswith", "(", "\"-e\"", ")", ":", "if", "\"@\"", "not", "in", "req", ":", "# Editable requirement without pinned commit.", "break", "elif", "req", ".", "strip", "(", ")", "and", "not", "req", ".", "startswith", "(", "\"#\"", ")", ":", "if", "not", "set", "(", "\">=<\"", ")", "&", "set", "(", "req", ")", ":", "# PyPI requirement without version.", "break", "else", ":", "# All requirements are pinned.", "return", "pip", "(", "\"-r %s/%s\"", "%", "(", "env", ".", "proj_path", ",", "env", ".", "reqs_path", ")", ")" ]

[ "Checks", "for", "changes", "in", "the", "requirements", "file", "across", "an", "update", "and", "gets", "new", "requirements", "if", "changes", "have", "occurred", "." ]

[ "def", "run", "(", "command", ",", "show", "=", "True", ",", "*", "args", ",", "*", "*", "kwargs", ")", ":", "if", "show", ":", "print_command", "(", "command", ")", "with", "hide", "(", "\"running\"", ")", ":", "return", "_run", "(", "command", ",", "*", "args", ",", "*", "*", "kwargs", ")" ]

[ "Runs", "a", "shell", "comand", "on", "the", "remote", "server", "." ]

[ "def", "sudo", "(", "command", ",", "show", "=", "True", ",", "*", "args", ",", "*", "*", "kwargs", ")", ":", "if", "show", ":", "print_command", "(", "command", ")", "with", "hide", "(", "\"running\"", ")", ":", "return", "_sudo", "(", "command", ",", "*", "args", ",", "*", "*", "kwargs", ")" ]

[ "Runs", "a", "command", "as", "sudo", "on", "the", "remote", "server", "." ]

[ "def", "get_templates", "(", ")", ":", "injected", "=", "{", "}", "for", "name", ",", "data", "in", "templates", ".", "items", "(", ")", ":", "injected", "[", "name", "]", "=", "dict", "(", "[", "(", "k", ",", "v", "%", "env", ")", "for", "k", ",", "v", "in", "data", ".", "items", "(", ")", "]", ")", "return", "injected" ]

[ "Returns", "each", "of", "the", "templates", "with", "env", "vars", "injected", "." ]

[ "def", "upload_template_and_reload", "(", "name", ")", ":", "template", "=", "get_templates", "(", ")", "[", "name", "]", "local_path", "=", "template", "[", "\"local_path\"", "]", "if", "not", "os", ".", "path", ".", "exists", "(", "local_path", ")", ":", "project_root", "=", "os", ".", "path", ".", "dirname", "(", "os", ".", "path", ".", "abspath", "(", "__file__", ")", ")", "local_path", "=", "os", ".", "path", ".", "join", "(", "project_root", ",", "local_path", ")", "remote_path", "=", "template", "[", "\"remote_path\"", "]", "reload_command", "=", "template", ".", "get", "(", "\"reload_command\"", ")", "owner", "=", "template", ".", "get", "(", "\"owner\"", ")", "mode", "=", "template", ".", "get", "(", "\"mode\"", ")", "remote_data", "=", "\"\"", "if", "exists", "(", "remote_path", ")", ":", "with", "hide", "(", "\"stdout\"", ")", ":", "remote_data", "=", "sudo", "(", "\"cat %s\"", "%", "remote_path", ",", "show", "=", "False", ")", "with", "open", "(", "local_path", ",", "\"r\"", ")", "as", "f", ":", "local_data", "=", "f", ".", "read", "(", ")", "# Escape all non-string-formatting-placeholder occurrences of '%':", "local_data", "=", "re", ".", "sub", "(", "r\"%(?!\\(\\w+\\)s)\"", ",", "\"%%\"", ",", "local_data", ")", "if", "\"%(db_pass)s\"", "in", "local_data", ":", "env", ".", "db_pass", "=", "db_pass", "(", ")", "local_data", "%=", "env", "clean", "=", "lambda", "s", ":", "s", ".", "replace", "(", "\"\\n\"", ",", "\"\"", ")", ".", "replace", "(", "\"\\r\"", ",", "\"\"", ")", ".", "strip", "(", ")", "if", "clean", "(", "remote_data", ")", "==", "clean", "(", "local_data", ")", ":", "return", "upload_template", "(", "local_path", ",", "remote_path", ",", "env", ",", "use_sudo", "=", "True", ",", "backup", "=", "False", ")", "if", "owner", ":", "sudo", "(", "\"chown %s %s\"", "%", "(", "owner", ",", "remote_path", ")", ")", "if", "mode", ":", "sudo", "(", "\"chmod %s %s\"", "%", "(", "mode", ",", "remote_path", ")", ")", "if", "reload_command", ":", "sudo", "(", "reload_command", ")" ]

[ "Uploads", "a", "template", "only", "if", "it", "has", "changed", "and", "if", "so", "reload", "the", "related", "service", "." ]

[ "def", "rsync_upload", "(", ")", ":", "excludes", "=", "[", "\"*.pyc\"", ",", "\"*.pyo\"", ",", "\"*.db\"", ",", "\".DS_Store\"", ",", "\".coverage\"", ",", "\"local_settings.py\"", ",", "\"/static\"", ",", "\"/.git\"", ",", "\"/.hg\"", "]", "local_dir", "=", "os", ".", "getcwd", "(", ")", "+", "os", ".", "sep", "return", "rsync_project", "(", "remote_dir", "=", "env", ".", "proj_path", ",", "local_dir", "=", "local_dir", ",", "exclude", "=", "excludes", ")" ]

[ "Uploads", "the", "project", "with", "rsync", "excluding", "some", "files", "and", "folders", "." ]

[ "def", "vcs_upload", "(", ")", ":", "if", "env", ".", "deploy_tool", "==", "\"git\"", ":", "remote_path", "=", "\"ssh://%s@%s%s\"", "%", "(", "env", ".", "user", ",", "env", ".", "host_string", ",", "env", ".", "repo_path", ")", "if", "not", "exists", "(", "env", ".", "repo_path", ")", ":", "run", "(", "\"mkdir -p %s\"", "%", "env", ".", "repo_path", ")", "with", "cd", "(", "env", ".", "repo_path", ")", ":", "run", "(", "\"git init --bare\"", ")", "local", "(", "\"git push -f %s master\"", "%", "remote_path", ")", "with", "cd", "(", "env", ".", "repo_path", ")", ":", "run", "(", "\"GIT_WORK_TREE=%s git checkout -f master\"", "%", "env", ".", "proj_path", ")", "run", "(", "\"GIT_WORK_TREE=%s git reset --hard\"", "%", "env", ".", "proj_path", ")", "elif", "env", ".", "deploy_tool", "==", "\"hg\"", ":", "remote_path", "=", "\"ssh://%s@%s/%s\"", "%", "(", "env", ".", "user", ",", "env", ".", "host_string", ",", "env", ".", "repo_path", ")", "with", "cd", "(", "env", ".", "repo_path", ")", ":", "if", "not", "exists", "(", "\"%s/.hg\"", "%", "env", ".", "repo_path", ")", ":", "run", "(", "\"hg init\"", ")", "print", "(", "env", ".", "repo_path", ")", "with", "fab_settings", "(", "warn_only", "=", "True", ")", ":", "push", "=", "local", "(", "\"hg push -f %s\"", "%", "remote_path", ")", "if", "push", ".", "return_code", "==", "255", ":", "abort", "(", ")", "run", "(", "\"hg update\"", ")" ]

[ "Uploads", "the", "project", "with", "the", "selected", "VCS", "tool", "." ]

[ "def", "postgres", "(", "command", ")", ":", "show", "=", "not", "command", ".", "startswith", "(", "\"psql\"", ")", "return", "sudo", "(", "command", ",", "show", "=", "show", ",", "user", "=", "\"postgres\"", ")" ]

[ "Runs", "the", "given", "command", "as", "the", "postgres", "user", "." ]

[ "def", "psql", "(", "sql", ",", "show", "=", "True", ")", ":", "out", "=", "postgres", "(", "'psql -c \"%s\"'", "%", "sql", ")", "if", "show", ":", "print_command", "(", "sql", ")", "return", "out" ]

[ "Runs", "SQL", "against", "the", "project", "s", "database", "." ]

[ "def", "backup", "(", "filename", ")", ":", "tmp_file", "=", "\"/tmp/%s\"", "%", "filename", "# We dump to /tmp because user \"postgres\" can't write to other user folders", "# We cd to / because user \"postgres\" might not have read permissions", "# elsewhere.", "with", "cd", "(", "\"/\"", ")", ":", "postgres", "(", "\"pg_dump -Fc %s > %s\"", "%", "(", "env", ".", "proj_name", ",", "tmp_file", ")", ")", "run", "(", "\"cp %s .\"", "%", "tmp_file", ")", "sudo", "(", "\"rm -f %s\"", "%", "tmp_file", ")" ]

[ "Backs", "up", "the", "project", "database", "." ]

[ "def", "python", "(", "code", ",", "show", "=", "True", ")", ":", "setup", "=", "\"import os;\"", "\"os.environ[\\'DJANGO_SETTINGS_MODULE\\']=\\'%s.settings\\';\"", "\"import django;\"", "\"django.setup();\"", "%", "env", ".", "proj_app", "full_code", "=", "'python -c \"%s%s\"'", "%", "(", "setup", ",", "code", ".", "replace", "(", "\"`\"", ",", "\"\\\\\\`\"", ")", ")", "with", "project", "(", ")", ":", "if", "show", ":", "print_command", "(", "code", ")", "result", "=", "run", "(", "full_code", ",", "show", "=", "False", ")", "return", "result" ]

[ "Runs", "Python", "code", "in", "the", "project", "s", "virtual", "environment", "with", "Django", "loaded", "." ]

[ "def", "install", "(", ")", ":", "# Install system requirements", "sudo", "(", "\"apt-get update -y -q\"", ")", "apt", "(", "\"nginx libjpeg-dev python-dev python-setuptools git-core \"", "\"postgresql libpq-dev memcached supervisor python-pip\"", ")", "run", "(", "\"mkdir -p /home/%s/logs\"", "%", "env", ".", "user", ")", "# Install Python requirements", "sudo", "(", "\"pip install -U pip virtualenv virtualenvwrapper mercurial\"", ")", "# Set up virtualenv", "run", "(", "\"mkdir -p %s\"", "%", "env", ".", "venv_home", ")", "run", "(", "\"echo 'export WORKON_HOME=%s' >> /home/%s/.bashrc\"", "%", "(", "env", ".", "venv_home", ",", "env", ".", "user", ")", ")", "run", "(", "\"echo 'source /usr/local/bin/virtualenvwrapper.sh' >> \"", "\"/home/%s/.bashrc\"", "%", "env", ".", "user", ")", "print", "(", "green", "(", "\"Successfully set up git, mercurial, pip, virtualenv, \"", "\"supervisor, memcached.\"", ",", "bold", "=", "True", ")", ")" ]

[ "Installs", "the", "base", "system", "and", "Python", "requirements", "for", "the", "entire", "server", "." ]

[ "def", "remove", "(", ")", ":", "if", "exists", "(", "env", ".", "venv_path", ")", ":", "run", "(", "\"rm -rf %s\"", "%", "env", ".", "venv_path", ")", "if", "exists", "(", "env", ".", "proj_path", ")", ":", "run", "(", "\"rm -rf %s\"", "%", "env", ".", "proj_path", ")", "for", "template", "in", "get_templates", "(", ")", ".", "values", "(", ")", ":", "remote_path", "=", "template", "[", "\"remote_path\"", "]", "if", "exists", "(", "remote_path", ")", ":", "sudo", "(", "\"rm %s\"", "%", "remote_path", ")", "if", "exists", "(", "env", ".", "repo_path", ")", ":", "run", "(", "\"rm -rf %s\"", "%", "env", ".", "repo_path", ")", "sudo", "(", "\"supervisorctl update\"", ")", "psql", "(", "\"DROP DATABASE IF EXISTS %s;\"", "%", "env", ".", "proj_name", ")", "psql", "(", "\"DROP USER IF EXISTS %s;\"", "%", "env", ".", "proj_name", ")" ]

[ "Blow", "away", "the", "current", "project", "." ]

[ "def", "deploy", "(", ")", ":", "if", "not", "exists", "(", "env", ".", "proj_path", ")", ":", "if", "confirm", "(", "\"Project does not exist in host server: %s\"", "\"\\nWould you like to create it?\"", "%", "env", ".", "proj_name", ")", ":", "create", "(", ")", "else", ":", "abort", "(", ")", "# Backup current version of the project", "with", "cd", "(", "env", ".", "proj_path", ")", ":", "backup", "(", "\"last.db\"", ")", "if", "env", ".", "deploy_tool", "in", "env", ".", "vcs_tools", ":", "with", "cd", "(", "env", ".", "repo_path", ")", ":", "if", "env", ".", "deploy_tool", "==", "\"git\"", ":", "run", "(", "\"git rev-parse HEAD > %s/last.commit\"", "%", "env", ".", "proj_path", ")", "elif", "env", ".", "deploy_tool", "==", "\"hg\"", ":", "run", "(", "\"hg id -i > last.commit\"", ")", "with", "project", "(", ")", ":", "static_dir", "=", "static", "(", ")", "if", "exists", "(", "static_dir", ")", ":", "run", "(", "\"tar -cf static.tar --exclude='*.thumbnails' %s\"", "%", "static_dir", ")", "else", ":", "with", "cd", "(", "join", "(", "env", ".", "proj_path", ",", "\"..\"", ")", ")", ":", "excludes", "=", "[", "\"*.pyc\"", ",", "\"*.pio\"", ",", "\"*.thumbnails\"", "]", "exclude_arg", "=", "\" \"", ".", "join", "(", "\"--exclude='%s'\"", "%", "e", "for", "e", "in", "excludes", ")", "run", "(", "\"tar -cf {0}.tar {1} {0}\"", ".", "format", "(", "env", ".", "proj_name", ",", "exclude_arg", ")", ")", "# Deploy latest version of the project", "with", "update_changed_requirements", "(", ")", ":", "if", "env", ".", "deploy_tool", "in", "env", ".", "vcs_tools", ":", "vcs_upload", "(", ")", "else", ":", "rsync_upload", "(", ")", "with", "project", "(", ")", ":", "manage", "(", "\"collectstatic -v 0 --noinput\"", ")", "manage", "(", "\"migrate --noinput\"", ")", "for", "name", "in", "get_templates", "(", ")", ":", "upload_template_and_reload", "(", "name", ")", "restart", "(", ")", "return", "True" ]

[ "Deploy", "latest", "version", "of", "the", "project", ".", "Backup", "current", "version", "of", "the", "project", "push", "latest", "version", "of", "the", "project", "via", "version", "control", "or", "rsync", "install", "new", "requirements", "sync", "and", "migrate", "the", "database", "collect", "any", "new", "static", "assets", "and", "restart", "gunicorn", "s", "worker", "processes", "for", "the", "project", "." ]

[ "def", "rollback", "(", ")", ":", "with", "update_changed_requirements", "(", ")", ":", "if", "env", ".", "deploy_tool", "in", "env", ".", "vcs_tools", ":", "with", "cd", "(", "env", ".", "repo_path", ")", ":", "if", "env", ".", "deploy_tool", "==", "\"git\"", ":", "run", "(", "\"GIT_WORK_TREE={0} git checkout -f \"", "\"`cat {0}/last.commit`\"", ".", "format", "(", "env", ".", "proj_path", ")", ")", "elif", "env", ".", "deploy_tool", "==", "\"hg\"", ":", "run", "(", "\"hg update -C `cat last.commit`\"", ")", "with", "project", "(", ")", ":", "with", "cd", "(", "join", "(", "static", "(", ")", ",", "\"..\"", ")", ")", ":", "run", "(", "\"tar -xf %s/static.tar\"", "%", "env", ".", "proj_path", ")", "else", ":", "with", "cd", "(", "env", ".", "proj_path", ".", "rsplit", "(", "\"/\"", ",", "1", ")", "[", "0", "]", ")", ":", "run", "(", "\"rm -rf %s\"", "%", "env", ".", "proj_name", ")", "run", "(", "\"tar -xf %s.tar\"", "%", "env", ".", "proj_name", ")", "with", "cd", "(", "env", ".", "proj_path", ")", ":", "restore", "(", "\"last.db\"", ")", "restart", "(", ")" ]

[ "Reverts", "project", "state", "to", "the", "last", "deploy", ".", "When", "a", "deploy", "is", "performed", "the", "current", "state", "of", "the", "project", "is", "backed", "up", ".", "This", "includes", "the", "project", "files", "the", "database", "and", "all", "static", "files", ".", "Calling", "rollback", "will", "revert", "all", "of", "these", "to", "their", "state", "prior", "to", "the", "last", "deploy", "." ]

[ "def", "delete_single", "(", "site", ",", "domain", ",", "delete_code", "=", "False", ",", "no_prompt", "=", "False", ")", ":", "click", ".", "secho", "(", "'Deleting installation \"{sn}\" hosted on the domain {dn}'", ".", "format", "(", "sn", "=", "site", ".", "name", ",", "dn", "=", "domain", ".", "name", ")", ",", "fg", "=", "'yellow'", ",", "bold", "=", "True", ")", "if", "not", "no_prompt", ":", "if", "delete_code", ":", "warn_text", "=", "click", ".", "style", "(", "'WARNING! THIS WILL PERMANENTLY DELETE THIS SITE AND ALL OF THE ASSOCIATED '", "'PROJECT CODE FILES!\\nTHIS MEANS ALL DATA FILES, INCLUDING ANY CREATED CUSTOM '", "'APPLICATIONS AND PLUGINS WILL BE PERMANENTLY AND IRREVOCABLY ERASED!'", ",", "fg", "=", "'red'", ",", "bold", "=", "True", ")", "click", ".", "echo", "(", "warn_text", ")", "prompt_text", "=", "click", ".", "style", "(", "'In order to continue, please re-input the site name'", ",", "fg", "=", "'white'", ",", "bold", "=", "True", ")", "prompt", "=", "click", ".", "prompt", "(", "prompt_text", ")", "# If our prompt doesn't match, abort", "if", "prompt", "!=", "site", ".", "name", ":", "click", ".", "secho", "(", "'Site name did not match, site will not be deleted. Aborting.'", ",", "fg", "=", "'red'", ",", "bold", "=", "True", ")", "raise", "click", ".", "Abort", "(", "'Site name prompt did not match'", ")", "else", ":", "prompt_text", "=", "click", ".", "style", "(", "'Are you sure you want to delete this site entry? Your project files will '", "'still be preserved.'", ",", "fg", "=", "'white'", ",", "bold", "=", "True", ")", "click", ".", "confirm", "(", "prompt_text", ",", "abort", "=", "True", ")", "site", ".", "delete", "(", ")", "if", "delete_code", ":", "_remove_code", "(", "site", ")", "# If this is the only site left in the domain, remove the domain now as well", "domain_sites", "=", "[", "ds", "for", "ds", "in", "domain", ".", "sites", "if", "ds", ".", "id", "!=", "site", ".", "id", "]", "if", "not", "len", "(", "domain_sites", ")", ":", "Session", ".", "delete", "(", "domain", ")", "Session", ".", "commit", "(", ")", "click", ".", "secho", "(", "'{sn} removed'", ".", "format", "(", "sn", "=", "site", ".", "name", ")", ",", "fg", "=", "'yellow'", ",", "bold", "=", "True", ")", "# Restart Nginx", "FNULL", "=", "open", "(", "os", ".", "devnull", ",", "'w'", ")", "subprocess", ".", "check_call", "(", "[", "'service'", ",", "'nginx'", ",", "'restart'", "]", ",", "stdout", "=", "FNULL", ",", "stderr", "=", "subprocess", ".", "STDOUT", ")" ]

[ "Delete", "a", "single", "site" ]

[ "def", "_remove_code", "(", "site", ")", ":", "def", "handle_error", "(", "function", ",", "path", ",", "excinfo", ")", ":", "click", ".", "secho", "(", "'Failed to remove path ({em}): {p}'", ".", "format", "(", "em", "=", "excinfo", ".", "message", ",", "p", "=", "path", ")", ",", "err", "=", "True", ",", "fg", "=", "'red'", ")", "if", "os", ".", "path", ".", "exists", "(", "site", ".", "root", ")", ":", "shutil", ".", "rmtree", "(", "site", ".", "root", ",", "onerror", "=", "handle_error", ")" ]

[ "Delete", "project", "files" ]

[ "def", "_handler", "(", "self", ",", "conn", ")", ":", "incoming", "=", "self", ".", "recv", "(", "conn", ")", "self", ".", "log", "(", "DEBUG", ",", "incoming", ")", "try", ":", "# E.g. ['twister', [7, 'invert'], {'guess_type': True}]", "task", ",", "args", ",", "kw", "=", "self", ".", "codec", ".", "decode", "(", "incoming", ")", "# OK, so we've received the information. Now to use it.", "self", ".", "log", "(", "INFO", ",", "'Fulfilling task %r'", "%", "task", ")", "self", ".", "started_task", "(", ")", "pass_backend", "=", "False", "obj", "=", "self", ".", "tasks", "[", "task", "]", "if", "_is_iter", "(", "obj", ")", ":", "# (callable, bool)", "obj", ",", "pass_backend", "=", "obj", "if", "pass_backend", ":", "# Have to do this, since args is a list", "args", "=", "[", "self", "]", "+", "args", "# Get and package the result", "res", "=", "[", "'success'", ",", "obj", "(", "*", "args", ",", "*", "*", "kw", ")", "]", "except", "Exception", "as", "e", ":", "self", ".", "log", "(", "ERROR", ",", "'Error while fullfilling task %r: %r'", "%", "(", "task", ",", "e", ")", ")", "res", "=", "[", "'error'", ",", "e", ".", "__class__", ".", "__name__", ",", "e", ".", "args", "]", "if", "self", ".", "tracebacks", ":", "show_err", "(", ")", "else", ":", "self", ".", "log", "(", "INFO", ",", "'Finished fulfilling task %r'", "%", "task", ")", "finally", ":", "self", ".", "send", "(", "conn", ",", "self", ".", "codec", ".", "encode", "(", "res", ")", ")", "self", ".", "finished_task", "(", ")", "conn", ".", "close", "(", ")" ]

[ "Connection", "handler", "thread", ".", "Takes", "care", "of", "communication", "with", "the", "client", "and", "running", "the", "proper", "task", "or", "applying", "a", "signal", "." ]

[ "def", "stop_server", "(", "self", ")", ":", "self", ".", "stop", "=", "True", "while", "self", ".", "task_count", ":", "time", ".", "sleep", "(", "END_RESP", ")", "self", ".", "terminate", "=", "True" ]

[ "Stop", "receiving", "connections", "wait", "for", "all", "tasks", "to", "end", "and", "then", "terminate", "the", "server", "." ]

[ "def", "fastqIterator", "(", "fn", ",", "verbose", "=", "False", ",", "allowNameMissmatch", "=", "False", ")", ":", "it", "=", "fastqIteratorSimple", "(", "fn", ",", "verbose", "=", "verbose", ",", "allowNameMissmatch", "=", "allowNameMissmatch", ")", "for", "s", "in", "it", ":", "yield", "s" ]

[ "A", "generator", "function", "which", "yields", "FastqSequence", "objects", "read", "from", "a", "file", "or", "stream", ".", "This", "is", "a", "general", "function", "which", "wraps", "fastqIteratorSimple", ".", "In", "future", "releases", "we", "may", "allow", "dynamic", "switching", "of", "which", "base", "iterator", "is", "used", "." ]

[ "def", "during", "(", "rrule", ",", "duration", "=", "None", ",", "timestamp", "=", "None", ",", "*", "*", "kwargs", ")", ":", "result", "=", "False", "# if rrule is a string expression", "if", "isinstance", "(", "rrule", ",", "string_types", ")", ":", "rrule_object", "=", "rrule_class", ".", "rrulestr", "(", "rrule", ")", "else", ":", "rrule_object", "=", "rrule_class", "(", "*", "*", "rrule", ")", "# if timestamp is None, use now", "if", "timestamp", "is", "None", ":", "timestamp", "=", "time", "(", ")", "# get now object", "now", "=", "datetime", ".", "fromtimestamp", "(", "timestamp", ")", "# get delta object", "duration_delta", "=", "now", "if", "duration", "is", "None", "else", "relativedelta", "(", "*", "*", "duration", ")", "# get last date", "last_date", "=", "rrule_object", ".", "before", "(", "now", ",", "inc", "=", "True", ")", "# if a previous date exists", "if", "last_date", "is", "not", "None", ":", "next_date", "=", "last_date", "+", "duration_delta", "# check if now is between last_date and next_date", "result", "=", "last_date", "<=", "now", "<=", "next_date", "return", "result" ]

[ "Check", "if", "input", "timestamp", "is", "in", "rrule", "+", "duration", "period" ]

[ "def", "_any", "(", "confs", "=", "None", ",", "*", "*", "kwargs", ")", ":", "result", "=", "False", "if", "confs", "is", "not", "None", ":", "# ensure confs is a list", "if", "isinstance", "(", "confs", ",", "string_types", ")", "or", "isinstance", "(", "confs", ",", "dict", ")", ":", "confs", "=", "[", "confs", "]", "for", "conf", "in", "confs", ":", "result", "=", "run", "(", "conf", ",", "*", "*", "kwargs", ")", "if", "result", ":", "# leave function as soon as a result if True", "break", "return", "result" ]

[ "True", "iif", "at", "least", "one", "input", "condition", "is", "equivalent", "to", "True", "." ]

[ "def", "_all", "(", "confs", "=", "None", ",", "*", "*", "kwargs", ")", ":", "result", "=", "False", "if", "confs", "is", "not", "None", ":", "# ensure confs is a list", "if", "isinstance", "(", "confs", ",", "string_types", ")", "or", "isinstance", "(", "confs", ",", "dict", ")", ":", "confs", "=", "[", "confs", "]", "# if at least one conf exists, result is True by default", "result", "=", "True", "for", "conf", "in", "confs", ":", "result", "=", "run", "(", "conf", ",", "*", "*", "kwargs", ")", "# stop when a result is False", "if", "not", "result", ":", "break", "return", "result" ]

[ "True", "iif", "all", "input", "confs", "are", "True", "." ]

[ "def", "_not", "(", "condition", "=", "None", ",", "*", "*", "kwargs", ")", ":", "result", "=", "True", "if", "condition", "is", "not", "None", ":", "result", "=", "not", "run", "(", "condition", ",", "*", "*", "kwargs", ")", "return", "result" ]

[ "Return", "the", "opposite", "of", "input", "condition", "." ]

[ "def", "condition", "(", "condition", "=", "None", ",", "statement", "=", "None", ",", "_else", "=", "None", ",", "*", "*", "kwargs", ")", ":", "result", "=", "None", "checked", "=", "False", "if", "condition", "is", "not", "None", ":", "checked", "=", "run", "(", "condition", ",", "*", "*", "kwargs", ")", "if", "checked", ":", "# if condition is checked", "if", "statement", "is", "not", "None", ":", "# process statement", "result", "=", "run", "(", "statement", ",", "*", "*", "kwargs", ")", "elif", "_else", "is", "not", "None", ":", "# else process _else statement", "result", "=", "run", "(", "_else", ",", "*", "*", "kwargs", ")", "return", "result" ]

[ "Run", "an", "statement", "if", "input", "condition", "is", "checked", "and", "return", "statement", "result", "." ]

[ "def", "switch", "(", "confs", "=", "None", ",", "remain", "=", "False", ",", "all_checked", "=", "False", ",", "_default", "=", "None", ",", "*", "*", "kwargs", ")", ":", "# init result", "result", "=", "[", "]", "if", "remain", "else", "None", "# check if remain and one task has already been checked.", "remaining", "=", "False", "if", "confs", "is", "not", "None", ":", "if", "isinstance", "(", "confs", ",", "string_types", ")", "or", "isinstance", "(", "confs", ",", "dict", ")", ":", "confs", "=", "[", "confs", "]", "for", "conf", "in", "confs", ":", "# check if task has to be checked or not", "check", "=", "remaining", "if", "not", "check", ":", "# try to check current conf", "check", "=", "run", "(", "conf", "=", "conf", ",", "*", "*", "kwargs", ")", "# if task is checked or remaining", "if", "check", ":", "if", "STATEMENT", "in", "conf", ":", "# if statements exist, run them", "statement", "=", "conf", "[", "STATEMENT", "]", "statement_result", "=", "run", "(", "statement", ",", "*", "*", "kwargs", ")", "# save result", "if", "not", "remain", ":", "# if not remain, result is statement_result", "result", "=", "statement_result", "else", ":", "# else, add statement_result to result", "result", ".", "append", "(", "statement_result", ")", "# if remain", "if", "remain", ":", "# change of remaining status", "if", "not", "remaining", ":", "remaining", "=", "True", "elif", "all_checked", ":", "pass", "else", ":", "# leave execution if one statement has been executed", "break", "# process _default statement if necessary", "if", "_default", "is", "not", "None", "and", "(", "remaining", "or", "(", "not", "result", ")", "or", "all_checked", ")", ":", "last_result", "=", "run", "(", "_default", ",", "*", "*", "kwargs", ")", "if", "not", "remain", ":", "result", "=", "last_result", "else", ":", "result", ".", "append", "(", "last_result", ")", "return", "result" ]

[ "Execute", "first", "statement", "among", "conf", "where", "task", "result", "is", "True", ".", "If", "remain", "process", "all", "statements", "conf", "starting", "from", "the", "first", "checked", "conf", "." ]

[ "def", "error", "(", "self", ",", "message", ")", ":", "if", "self", ".", "_debug", ":", "import", "pdb", "_", ",", "_", ",", "tb", "=", "sys", ".", "exc_info", "(", ")", "if", "tb", ":", "pdb", ".", "post_mortem", "(", "tb", ")", "else", ":", "pdb", ".", "set_trace", "(", ")", "self", ".", "print_usage", "(", "sys", ".", "stderr", ")", "self", ".", "exit", "(", "2", ",", "(", "'\\nERROR: {}\\n'", ")", ".", "format", "(", "message", ")", ")" ]

[ "Overrides", "error", "to", "control", "printing", "output" ]

[ "def", "format_help", "(", "self", ")", ":", "formatter", "=", "self", ".", "_get_formatter", "(", ")", "# usage", "formatter", ".", "add_usage", "(", "self", ".", "usage", ",", "self", ".", "_actions", ",", "self", ".", "_mutually_exclusive_groups", ")", "# description", "formatter", ".", "add_text", "(", "self", ".", "description", ")", "# positionals, optionals and user-defined groups, except SubParsers", "for", "action_group", "in", "self", ".", "_action_groups", ":", "if", "is_subparser", "(", "action_group", ")", ":", "continue", "formatter", ".", "start_section", "(", "action_group", ".", "title", ")", "formatter", ".", "add_text", "(", "action_group", ".", "description", ")", "formatter", ".", "add_arguments", "(", "action_group", ".", "_group_actions", ")", "formatter", ".", "end_section", "(", ")", "# epilog", "formatter", ".", "add_text", "(", "self", ".", "epilog", ")", "# determine help from format above", "return", "formatter", ".", "format_help", "(", ")" ]

[ "Overrides", "format_help", "to", "not", "print", "subparsers" ]

[ "def", "open_attributes_file", "(", "self", ")", ":", "if", "not", "self", ".", "saveable", "(", ")", ":", "raise", "AttributeError", "(", "\"Cannot open attribute file without a valid file\"", ")", "if", "self", ".", "_db_closed", ":", "self", ".", "_fd", "=", "FileDict", "(", "self", ".", "_file_name", ",", "db_ext", "=", "self", ".", "_db_ext", ",", "read_only", "=", "self", ".", "_read_only", ",", "clear", "=", "False", ",", "cache_size", "=", "0", ",", "immutable_vals", "=", "False", ",", "stringify_keys", "=", "False", ",", "cache_misses", "=", "False", ")", "self", ".", "_db_closed", "=", "False" ]

[ "Called", "during", "initialization", ".", "Only", "needs", "to", "be", "explicitly", "called", "if", "save_and_close_attributes", "is", "explicitly", "called", "beforehand", "." ]

[ "def", "save_and_close_attributes", "(", "self", ")", ":", "if", "not", "self", ".", "saveable", "(", ")", ":", "raise", "AttributeError", "(", "\"Cannot save attribute file without a valid file\"", ")", "if", "not", "self", ".", "_db_closed", ":", "self", ".", "_db_closed", "=", "True", "if", "not", "self", ".", "_read_only", ":", "self", ".", "save_attributes", "(", ")", "self", ".", "_fd", ".", "close", "(", ")" ]

[ "Performs", "the", "same", "function", "as", "save_attributes", "but", "also", "closes", "the", "attribute", "file", "." ]

[ "def", "split_task_parameters", "(", "line", ")", ":", "if", "line", "is", "None", ":", "result", "=", "[", "]", "else", ":", "result", "=", "[", "parameter", ".", "strip", "(", ")", "for", "parameter", "in", "line", ".", "split", "(", "\",\"", ")", "]", "return", "result" ]

[ "Split", "a", "string", "of", "comma", "separated", "words", "." ]

[ "def", "find_tasks", "(", "lines", ")", ":", "tasks", "=", "[", "]", "linenumbers", "=", "[", "]", "pattern", "=", "re", ".", "compile", "(", "TASK_PATTERN", ")", "for", "n", ",", "line", "in", "enumerate", "(", "lines", ")", ":", "if", "\"#\"", "in", "line", "and", "\"<-\"", "in", "line", ":", "m", "=", "pattern", ".", "match", "(", "line", ")", "if", "m", "is", "not", "None", ":", "groupdict", "=", "m", ".", "groupdict", "(", ")", "linenumbers", ".", "append", "(", "n", ")", "for", "key", "in", "groupdict", ":", "groupdict", "[", "key", "]", "=", "split_task_parameters", "(", "groupdict", "[", "key", "]", ")", "logging", ".", "debug", "(", "\"{0}: {1}\"", ".", "format", "(", "key", ",", "\", \"", ".", "join", "(", "groupdict", "[", "key", "]", ")", ")", ")", "tasks", ".", "append", "(", "groupdict", ")", "linenumbers", ".", "append", "(", "len", "(", "lines", ")", ")", "return", "tasks", ",", "linenumbers" ]

[ "Find", "task", "lines", "and", "corresponding", "line", "numbers", "in", "a", "list", "of", "lines", "." ]

[ "def", "create_environment", "(", "preamble", ")", ":", "environment", "=", "copy", ".", "deepcopy", "(", "os", ".", "environ", ")", "for", "line", "in", "preamble", ":", "logging", ".", "debug", "(", "line", ")", "if", "\"=\"", "in", "line", "and", "not", "line", ".", "startswith", "(", "\"#\"", ")", ":", "tmp", "=", "line", ".", "split", "(", "\"=\"", ")", "key", "=", "tmp", "[", "0", "]", ".", "strip", "(", ")", "value", "=", "tmp", "[", "1", "]", ".", "strip", "(", ")", "logging", ".", "debug", "(", "\"Found variable {} with value {}\"", ".", "format", "(", "key", ",", "value", ")", ")", "environment", ".", "update", "(", "{", "key", ":", "value", "}", ")", "logging", ".", "debug", "(", "\"Env {}\"", ".", "format", "(", "environment", ")", ")", "return", "environment" ]

[ "Create", "a", "dictionary", "of", "variables", "obtained", "from", "the", "preamble", "of", "the", "task", "file", "and", "the", "environment", "the", "program", "is", "running", "on", "." ]

[ "def", "parse_input_file", "(", "text", ",", "variables", "=", "None", ")", ":", "text", "=", "find_includes", "(", "text", ")", "lines", "=", "text", ".", "splitlines", "(", ")", "tasks", ",", "linenumbers", "=", "find_tasks", "(", "lines", ")", "preamble", "=", "[", "line", "for", "line", "in", "lines", "[", ":", "linenumbers", "[", "0", "]", "]", "]", "logging", ".", "debug", "(", "\"Preamble:\\n{}\"", ".", "format", "(", "\"\\n\"", ".", "join", "(", "preamble", ")", ")", ")", "if", "variables", "is", "not", "None", ":", "preamble", "+=", "\"\\n\"", "+", "\"\\n\"", ".", "join", "(", "variables", ")", "environment", "=", "create_environment", "(", "preamble", ")", "code_sections", "=", "[", "]", "for", "n", "in", "range", "(", "len", "(", "linenumbers", ")", "-", "1", ")", ":", "code_sections", ".", "append", "(", "(", "linenumbers", "[", "n", "]", ",", "linenumbers", "[", "n", "+", "1", "]", ")", ")", "for", "n", ",", "task", "in", "zip", "(", "code_sections", ",", "tasks", ")", ":", "task", "[", "\"code\"", "]", "=", "lines", "[", "n", "[", "0", "]", ":", "n", "[", "1", "]", "]", "task", "[", "\"environment\"", "]", "=", "environment", "clean_tasks", "=", "[", "]", "for", "task", "in", "tasks", ":", "clean_tasks", ".", "append", "(", "Task", "(", "*", "*", "task", ")", ")", "return", "clean_tasks" ]

[ "Parser", "for", "a", "file", "with", "syntax", "somewhat", "similar", "to", "Drake", "." ]

[ "def", "_to_fields", "(", "self", ",", "*", "values", ")", ":", "result", "=", "[", "]", "for", "related_instance", "in", "values", ":", "if", "not", "isinstance", "(", "related_instance", ",", "model", ".", "RedisModel", ")", ":", "related_instance", "=", "self", ".", "related_field", ".", "_model", "(", "related_instance", ")", "result", ".", "append", "(", "getattr", "(", "related_instance", ",", "self", ".", "related_field", ".", "name", ")", ")", "return", "result" ]

[ "Take", "a", "list", "of", "values", "which", "must", "be", "primary", "keys", "of", "the", "model", "linked", "to", "the", "related", "collection", "and", "return", "a", "list", "of", "related", "fields", "." ]

[ "def", "_reverse_call", "(", "self", ",", "related_method", ",", "*", "values", ")", ":", "related_fields", "=", "self", ".", "_to_fields", "(", "*", "values", ")", "for", "related_field", "in", "related_fields", ":", "if", "callable", "(", "related_method", ")", ":", "related_method", "(", "related_field", ",", "self", ".", "instance", ".", "_pk", ")", "else", ":", "getattr", "(", "related_field", ",", "related_method", ")", "(", "self", ".", "instance", ".", "_pk", ")" ]

[ "Convert", "each", "value", "to", "a", "related", "field", "then", "call", "the", "method", "on", "each", "field", "passing", "self", ".", "instance", "as", "argument", ".", "If", "related_method", "is", "a", "string", "it", "will", "be", "the", "method", "of", "the", "related", "field", ".", "If", "it", "s", "a", "callable", "it", "s", "a", "function", "which", "accept", "the", "related", "field", "and", "self", ".", "instance", "." ]

[ "def", "srem", "(", "self", ",", "*", "values", ")", ":", "self", ".", "_reverse_call", "(", "lambda", "related_field", ",", "value", ":", "related_field", ".", "delete", "(", ")", ",", "*", "values", ")" ]

[ "Do", "a", "set", "call", "with", "self", ".", "instance", "as", "parameter", "for", "each", "value", ".", "Values", "must", "be", "primary", "keys", "of", "the", "related", "model", "." ]