{\\n\",\n+ \" const url = await google.colab.kernel.proxyPort(6006, {\\\"cache\\\": true});\\n\",\n+ \" const iframe = document.createElement('iframe');\\n\",\n+ \" iframe.src = url;\\n\",\n+ \" iframe.setAttribute('width', '100%');\\n\",\n+ \" iframe.setAttribute('height', '800');\\n\",\n+ \" iframe.setAttribute('frameborder', 0);\\n\",\n+ \" document.body.appendChild(iframe);\\n\",\n+ \" })();\\n\",\n+ \" \"\n+ ],\n+ \"text/plain\": [\n+ \"<IPython.core.display.Javascript object>\"\n+ ]\n+ },\n+ \"metadata\": {\n+ \"tags\": []\n+ }\n+ }\n+ ]\n+ },\n+ {\n+ \"cell_type\": \"markdown\",\n+ \"metadata\": {\n+ \"id\": \"6EyKJ5zzETio\",\n+ \"colab_type\": \"text\"\n+ },\n+ \"source\": [\n+ \"# 🎉 Yeah it's training!\"\n+ ]\n+ },\n+ {\n+ \"cell_type\": \"code\",\n+ \"metadata\": {\n+ \"id\": \"RB44zvwfE3Zu\",\n+ \"colab_type\": \"code\",\n+ \"colab\": {}\n+ },\n+ \"source\": [\n+ \"\"\n+ ],\n+ \"execution_count\": 0,\n+ \"outputs\": []\n+ }\n+ ]\n+}\n\\ No newline at end of file\ndiff --git a/src/transformers/modeling_gpt2.py b/src/transformers/modeling_gpt2.py\nindex cda4c1fc29ed..e4bbc2d148c7 100644\n--- a/src/transformers/modeling_gpt2.py\n+++ b/src/transformers/modeling_gpt2.py\n@@ -145,7 +145,7 @@ def _attn(self, q, k, v, attention_mask=None, head_mask=None):\n w = w / (v.size(-1) ** 0.5)\n nd, ns = w.size(-2), w.size(-1)\n mask = self.bias[:, :, ns - nd : ns, :ns]\n- w = torch.where(mask, w, self.masked_bias)\n+ w = torch.where(mask, w, self.masked_bias.to(w.dtype))\n \n if attention_mask is not None:\n # Apply the attention mask\n"}}},{"rowIdx":5474,"cells":{"in_source_id":{"kind":"string","value":"facebookresearch__ParlAI-2649"},"issue":{"kind":"string","value":"Throw error if bool is used in add_argument?\nin our `ParlaiParser.add_argument`, if the type argument is a literal bool, we should either throw an error or maybe smartly switch to `'bool'` with a warning?\n"},"before_files":{"kind":"list like","value":[{"content":"#!/usr/bin/env python3\n\n# Copyright (c) Facebook, Inc. and its affiliates.\n# This source code is licensed under the MIT license found in the\n# LICENSE file in the root directory of this source tree.\n\"\"\"\nProvide an argument parser and default command line options for using ParlAI.\n\"\"\"\n\nimport argparse\nimport importlib\nimport os\nimport sys as _sys\nimport datetime\nimport parlai\n\ntry:\n import git\n\n GIT_AVAILABLE = True\nexcept ImportError:\n # silence the error\n GIT_AVAILABLE = False\n\nimport parlai.utils.logging as logging\nfrom parlai.core.build_data import modelzoo_path\nfrom parlai.core.loader import load_teacher_module, load_agent_module, load_world_module\nfrom parlai.tasks.tasks import ids_to_tasks\nfrom parlai.core.opt import Opt, load_opt_file\n\nfrom typing import List, Optional\n\n\ndef print_git_commit():\n \"\"\"\n Print the current git commit of ParlAI and parlai_internal.\n \"\"\"\n root = os.path.dirname(os.path.dirname(parlai.__file__))\n internal_root = os.path.join(root, 'parlai_internal')\n try:\n git_ = git.Git(root)\n current_commit = git_.rev_parse('HEAD')\n print(f'[ Current ParlAI commit: {current_commit} ]')\n except git.GitCommandNotFound:\n pass\n except git.GitCommandError:\n pass\n\n try:\n git_ = git.Git(internal_root)\n internal_commit = git_.rev_parse('HEAD')\n print(f'[ Current internal commit: {internal_commit} ]')\n except git.GitCommandNotFound:\n pass\n except git.GitCommandError:\n pass\n\n\ndef print_announcements(opt):\n \"\"\"\n Output any announcements the ParlAI team wishes to make to users.\n\n Also gives the user the option to suppress the output.\n \"\"\"\n # no annoucements to make right now\n return\n\n noannounce_file = os.path.join(opt.get('datapath'), 'noannouncements')\n if os.path.exists(noannounce_file):\n # user has suppressed announcements, don't do anything\n return\n\n # useful constants\n # all of these colors are bolded\n RESET = '\\033[0m'\n BOLD = '\\033[1m'\n RED = '\\033[1;91m'\n YELLOW = '\\033[1;93m'\n GREEN = '\\033[1;92m'\n BLUE = '\\033[1;96m'\n CYAN = '\\033[1;94m'\n MAGENTA = '\\033[1;95m'\n\n # only use colors if we're outputting to a terminal\n USE_COLORS = _sys.stdout.isatty()\n if not USE_COLORS:\n RESET = BOLD = RED = YELLOW = GREEN = BLUE = CYAN = MAGENTA = ''\n\n # generate the rainbow stars\n rainbow = [RED, YELLOW, GREEN, CYAN, BLUE, MAGENTA]\n size = 78 // len(rainbow)\n stars = ''.join([color + '*' * size for color in rainbow])\n stars += RESET\n\n # do the actual output\n print(\n '\\n'.join(\n [\n '',\n stars,\n BOLD,\n 'Announcements go here.',\n RESET,\n # don't bold the suppression command\n 'To suppress this message (and future announcements), run\\n`touch {}`'.format(\n noannounce_file\n ),\n stars,\n ]\n )\n )\n\n\ndef get_model_name(opt):\n \"\"\"\n Get the model name from either `--model` or `--model-file`.\n \"\"\"\n model = opt.get('model', None)\n if model is None:\n # try to get model name from model opt file\n model_file = opt.get('model_file', None)\n if model_file is not None:\n model_file = modelzoo_path(opt.get('datapath'), model_file)\n optfile = model_file + '.opt'\n if os.path.isfile(optfile):\n new_opt = load_opt_file(optfile)\n model = new_opt.get('model', None)\n return model\n\n\ndef str2none(value: str):\n \"\"\"\n If the value is a variant of `none`, return None.\n\n Otherwise, return the original value.\n \"\"\"\n if value.lower() == 'none':\n return None\n else:\n return value\n\n\ndef str2bool(value):\n \"\"\"\n Convert 'yes', 'false', '1', etc.\n\n into a boolean.\n \"\"\"\n v = value.lower()\n if v in ('yes', 'true', 't', '1', 'y'):\n return True\n elif v in ('no', 'false', 'f', 'n', '0'):\n return False\n else:\n raise argparse.ArgumentTypeError('Boolean value expected.')\n\n\ndef str2floats(s):\n \"\"\"\n Look for single float or comma-separated floats.\n \"\"\"\n return tuple(float(f) for f in s.split(','))\n\n\ndef str2class(value):\n \"\"\"\n From import path string, returns the class specified.\n\n For example, the string 'parlai.agents.drqa.drqa:SimpleDictionaryAgent' returns\n <class 'parlai.agents.drqa.drqa.SimpleDictionaryAgent'>.\n \"\"\"\n if ':' not in value:\n raise RuntimeError('Use a colon before the name of the class.')\n name = value.split(':')\n module = importlib.import_module(name[0])\n return getattr(module, name[1])\n\n\ndef class2str(value):\n \"\"\"\n Inverse of params.str2class().\n \"\"\"\n s = str(value)\n s = s[s.find('\\'') + 1 : s.rfind('\\'')] # pull out import path\n s = ':'.join(s.rsplit('.', 1)) # replace last period with ':'\n return s\n\n\ndef fix_underscores(args):\n \"\"\"\n Convert underscores to hyphens in args.\n\n For example, converts '--gradient_clip' to '--gradient-clip'.\n\n :param args: iterable, possibly containing args strings with underscores.\n \"\"\"\n if args:\n new_args = []\n for a in args:\n if type(a) is str and a.startswith('-'):\n a = a.replace('_', '-')\n new_args.append(a)\n args = new_args\n return args\n\n\nclass CustomHelpFormatter(argparse.HelpFormatter):\n \"\"\"\n Produce a custom-formatted `--help` option.\n\n See https://goo.gl/DKtHb5 for details.\n \"\"\"\n\n def __init__(self, *args, **kwargs):\n kwargs['max_help_position'] = 6\n kwargs['width'] = 80\n super().__init__(*args, **kwargs)\n\n def _format_action_invocation(self, action):\n if not action.option_strings or action.nargs == 0:\n return super()._format_action_invocation(action)\n default = self._get_default_metavar_for_optional(action)\n args_string = self._format_args(action, default)\n return ', '.join(action.option_strings) + ' ' + args_string\n\n def _get_help_string(self, action):\n help = action.help\n if '%(default)' not in action.help:\n if action.default is not argparse.SUPPRESS:\n defaulting_nargs = [argparse.OPTIONAL, argparse.ZERO_OR_MORE]\n if action.option_strings or action.nargs in defaulting_nargs:\n help += ' (default: %(default)s)'\n if (\n hasattr(action, 'recommended')\n and action.recommended\n and action.recommended != action.default\n ):\n help += '(recommended: %(recommended)s)'\n help = help.replace(')(recommended', ', recommended')\n return help\n\n\nclass ParlaiParser(argparse.ArgumentParser):\n \"\"\"\n Provide an opt-producer and CLI argument parser.\n\n Pseudo-extension of ``argparse`` which sets a number of parameters\n for the ParlAI framework. More options can be added specific to other\n modules by passing this object and calling ``add_arg()`` or\n ``add_argument()`` on it.\n\n For example, see ``parlai.core.dict.DictionaryAgent.add_cmdline_args``.\n\n :param add_parlai_args:\n (default True) initializes the default arguments for ParlAI\n package, including the data download paths and task arguments.\n :param add_model_args:\n (default False) initializes the default arguments for loading\n models, including initializing arguments from that model.\n \"\"\"\n\n def __init__(\n self, add_parlai_args=True, add_model_args=False, description='ParlAI parser'\n ):\n \"\"\"\n Initialize the ParlAI argparser.\n \"\"\"\n super().__init__(\n description=description,\n allow_abbrev=False,\n conflict_handler='resolve',\n formatter_class=CustomHelpFormatter,\n add_help=add_parlai_args,\n )\n self.register('type', 'nonestr', str2none)\n self.register('type', 'bool', str2bool)\n self.register('type', 'floats', str2floats)\n self.register('type', 'class', str2class)\n self.parlai_home = os.path.dirname(\n os.path.dirname(os.path.dirname(os.path.realpath(__file__)))\n )\n os.environ['PARLAI_HOME'] = self.parlai_home\n\n self.add_arg = self.add_argument\n\n # remember which args were specified on the command line\n self.overridable = {}\n\n if add_parlai_args:\n self.add_parlai_args()\n if add_model_args:\n self.add_model_args()\n\n def add_parlai_data_path(self, argument_group=None):\n \"\"\"\n Add --datapath CLI arg.\n \"\"\"\n if argument_group is None:\n argument_group = self\n argument_group.add_argument(\n '-dp',\n '--datapath',\n default=None,\n help='path to datasets, defaults to {parlai_dir}/data',\n )\n\n def add_mturk_args(self):\n \"\"\"\n Add standard mechanical turk arguments.\n \"\"\"\n mturk = self.add_argument_group('Mechanical Turk')\n default_log_path = os.path.join(self.parlai_home, 'logs', 'mturk')\n mturk.add_argument(\n '--mturk-log-path',\n default=default_log_path,\n help='path to MTurk logs, defaults to {parlai_dir}/logs/mturk',\n )\n mturk.add_argument(\n '-t',\n '--task',\n help='MTurk task, e.g. \"qa_data_collection\" or \"model_evaluator\"',\n )\n mturk.add_argument(\n '-nc',\n '--num-conversations',\n default=1,\n type=int,\n help='number of conversations you want to create for this task',\n )\n mturk.add_argument(\n '--unique',\n dest='unique_worker',\n default=False,\n action='store_true',\n help='enforce that no worker can work on your task twice',\n )\n mturk.add_argument(\n '--max-hits-per-worker',\n dest='max_hits_per_worker',\n default=0,\n type=int,\n help='Max number of hits each worker can perform during current group run',\n )\n mturk.add_argument(\n '--unique-qual-name',\n dest='unique_qual_name',\n default=None,\n type=str,\n help='qualification name to use for uniqueness between HITs',\n )\n mturk.add_argument(\n '-r',\n '--reward',\n default=0.05,\n type=float,\n help='reward for each worker for finishing the conversation, '\n 'in US dollars',\n )\n mturk.add_argument(\n '--sandbox',\n dest='is_sandbox',\n action='store_true',\n help='submit the HITs to MTurk sandbox site',\n )\n mturk.add_argument(\n '--live',\n dest='is_sandbox',\n action='store_false',\n help='submit the HITs to MTurk live site',\n )\n mturk.add_argument(\n '--debug',\n dest='is_debug',\n action='store_true',\n help='print and log all server interactions and messages',\n )\n mturk.add_argument(\n '--verbose',\n dest='verbose',\n action='store_true',\n help='print all messages sent to and from Turkers',\n )\n mturk.add_argument(\n '--hard-block',\n dest='hard_block',\n action='store_true',\n default=False,\n help='Hard block disconnecting Turkers from all of your HITs',\n )\n mturk.add_argument(\n '--log-level',\n dest='log_level',\n type=int,\n default=20,\n help='importance level for what to put into the logs. the lower '\n 'the level the more that gets logged. values are 0-50',\n )\n mturk.add_argument(\n '--disconnect-qualification',\n dest='disconnect_qualification',\n default=None,\n help='Qualification to use for soft blocking users for '\n 'disconnects. By default '\n 'turkers are never blocked, though setting this will allow '\n 'you to filter out turkers that have disconnected too many '\n 'times on previous HITs where this qualification was set.',\n )\n mturk.add_argument(\n '--block-qualification',\n dest='block_qualification',\n default=None,\n help='Qualification to use for soft blocking users. This '\n 'qualification is granted whenever soft_block_worker is '\n 'called, and can thus be used to filter workers out from a '\n 'single task or group of tasks by noted performance.',\n )\n mturk.add_argument(\n '--count-complete',\n dest='count_complete',\n default=False,\n action='store_true',\n help='continue until the requested number of conversations are '\n 'completed rather than attempted',\n )\n mturk.add_argument(\n '--allowed-conversations',\n dest='allowed_conversations',\n default=0,\n type=int,\n help='number of concurrent conversations that one mturk worker '\n 'is able to be involved in, 0 is unlimited',\n )\n mturk.add_argument(\n '--max-connections',\n dest='max_connections',\n default=30,\n type=int,\n help='number of HITs that can be launched at the same time, 0 is '\n 'unlimited.',\n )\n mturk.add_argument(\n '--min-messages',\n dest='min_messages',\n default=0,\n type=int,\n help='number of messages required to be sent by MTurk agent when '\n 'considering whether to approve a HIT in the event of a '\n 'partner disconnect. I.e. if the number of messages '\n 'exceeds this number, the turker can submit the HIT.',\n )\n mturk.add_argument(\n '--local',\n dest='local',\n default=False,\n action='store_true',\n help='Run the server locally on this server rather than setting up'\n ' a heroku server.',\n )\n mturk.add_argument(\n '--hobby',\n dest='hobby',\n default=False,\n action='store_true',\n help='Run the heroku server on the hobby tier.',\n )\n mturk.add_argument(\n '--max-time',\n dest='max_time',\n default=0,\n type=int,\n help='Maximum number of seconds per day that a worker is allowed '\n 'to work on this assignment',\n )\n mturk.add_argument(\n '--max-time-qual',\n dest='max_time_qual',\n default=None,\n help='Qualification to use to share the maximum time requirement '\n 'with other runs from other machines.',\n )\n mturk.add_argument(\n '--heroku-team',\n dest='heroku_team',\n default=None,\n help='Specify Heroku team name to use for launching Dynos.',\n )\n mturk.add_argument(\n '--tmp-dir',\n dest='tmp_dir',\n default=None,\n help='Specify location to use for scratch builds and such.',\n )\n\n # it helps to indicate to agents that they're in interactive mode, and\n # can avoid some otherwise troublesome behavior (not having candidates,\n # sharing self.replies, etc).\n mturk.set_defaults(interactive_mode=True)\n\n mturk.set_defaults(is_sandbox=True)\n mturk.set_defaults(is_debug=False)\n mturk.set_defaults(verbose=False)\n\n def add_chatservice_args(self):\n \"\"\"\n Arguments for all chat services.\n \"\"\"\n args = self.add_argument_group('Chat Services')\n args.add_argument(\n '--debug',\n dest='is_debug',\n action='store_true',\n help='print and log all server interactions and messages',\n )\n args.add_argument(\n '--config-path',\n default=None,\n type=str,\n help='/path/to/config/file for a given task.',\n )\n args.add_argument(\n '--password',\n dest='password',\n type=str,\n default=None,\n help='Require a password for entry to the bot',\n )\n\n def add_websockets_args(self):\n \"\"\"\n Add websocket arguments.\n \"\"\"\n self.add_chatservice_args()\n websockets = self.add_argument_group('Websockets')\n websockets.add_argument(\n '--port', default=35496, type=int, help='Port to run the websocket handler'\n )\n\n def add_messenger_args(self):\n \"\"\"\n Add Facebook Messenger arguments.\n \"\"\"\n self.add_chatservice_args()\n messenger = self.add_argument_group('Facebook Messenger')\n messenger.add_argument(\n '--verbose',\n dest='verbose',\n action='store_true',\n help='print all messages sent to and from Turkers',\n )\n messenger.add_argument(\n '--log-level',\n dest='log_level',\n type=int,\n default=20,\n help='importance level for what to put into the logs. the lower '\n 'the level the more that gets logged. values are 0-50',\n )\n messenger.add_argument(\n '--force-page-token',\n dest='force_page_token',\n action='store_true',\n help='override the page token stored in the cache for a new one',\n )\n messenger.add_argument(\n '--bypass-server-setup',\n dest='bypass_server_setup',\n action='store_true',\n default=False,\n help='should bypass traditional server and socket setup',\n )\n messenger.add_argument(\n '--local',\n dest='local',\n action='store_true',\n default=False,\n help='Run the server locally on this server rather than setting up'\n ' a heroku server.',\n )\n\n messenger.set_defaults(is_debug=False)\n messenger.set_defaults(verbose=False)\n\n def add_parlai_args(self, args=None):\n \"\"\"\n Add common ParlAI args across all scripts.\n \"\"\"\n parlai = self.add_argument_group('Main ParlAI Arguments')\n parlai.add_argument(\n '-o',\n '--init-opt',\n default=None,\n help='Path to json file of options. '\n 'Note: Further Command-line arguments override file-based options.',\n )\n parlai.add_argument(\n '-v',\n '--show-advanced-args',\n action='store_true',\n help='Show hidden command line options (advanced users only)',\n )\n parlai.add_argument(\n '-t', '--task', help='ParlAI task(s), e.g. \"babi:Task1\" or \"babi,cbt\"'\n )\n parlai.add_argument(\n '--download-path',\n default=None,\n hidden=True,\n help='path for non-data dependencies to store any needed files.'\n 'defaults to {parlai_dir}/downloads',\n )\n parlai.add_argument(\n '-dt',\n '--datatype',\n default='train',\n choices=[\n 'train',\n 'train:stream',\n 'train:ordered',\n 'train:ordered:stream',\n 'train:stream:ordered',\n 'train:evalmode',\n 'train:evalmode:stream',\n 'train:evalmode:ordered',\n 'train:evalmode:ordered:stream',\n 'train:evalmode:stream:ordered',\n 'valid',\n 'valid:stream',\n 'test',\n 'test:stream',\n ],\n help='choose from: train, train:ordered, valid, test. to stream '\n 'data add \":stream\" to any option (e.g., train:stream). '\n 'by default: train is random with replacement, '\n 'valid is ordered, test is ordered.',\n )\n parlai.add_argument(\n '-im',\n '--image-mode',\n default='raw',\n type=str,\n help='image preprocessor to use. default is \"raw\". set to \"none\" '\n 'to skip image loading.',\n hidden=True,\n )\n parlai.add_argument(\n '-nt',\n '--numthreads',\n default=1,\n type=int,\n help='number of threads. Used for hogwild if batchsize is 1, else '\n 'for number of threads in threadpool loading,',\n )\n parlai.add_argument(\n '--hide-labels',\n default=False,\n type='bool',\n hidden=True,\n help='default (False) moves labels in valid and test sets to the '\n 'eval_labels field. If True, they are hidden completely.',\n )\n parlai.add_argument(\n '-mtw',\n '--multitask-weights',\n type='floats',\n default=[1],\n help='list of floats, one for each task, specifying '\n 'the probability of drawing the task in multitask case',\n hidden=True,\n )\n parlai.add_argument(\n '-bs',\n '--batchsize',\n default=1,\n type=int,\n help='batch size for minibatch training schemes',\n )\n parlai.add_argument(\n '-dynb',\n '--dynamic-batching',\n default=None,\n type='nonestr',\n choices={None, 'full', 'batchsort'},\n help='Use dynamic batching',\n )\n self.add_parlai_data_path(parlai)\n\n def add_distributed_training_args(self):\n \"\"\"\n Add CLI args for distributed training.\n \"\"\"\n grp = self.add_argument_group('Distributed Training')\n grp.add_argument(\n '--distributed-world-size', type=int, help='Number of workers.'\n )\n grp.add_argument(\n '--verbose',\n type='bool',\n default=False,\n help='All workers print output.',\n hidden=True,\n )\n return grp\n\n def add_model_args(self):\n \"\"\"\n Add arguments related to models such as model files.\n \"\"\"\n model_args = self.add_argument_group('ParlAI Model Arguments')\n model_args.add_argument(\n '-m',\n '--model',\n default=None,\n help='the model class name. can match parlai/agents/<model> for '\n 'agents in that directory, or can provide a fully specified '\n 'module for `from X import Y` via `-m X:Y` '\n '(e.g. `-m parlai.agents.seq2seq.seq2seq:Seq2SeqAgent`)',\n )\n model_args.add_argument(\n '-mf',\n '--model-file',\n default=None,\n help='model file name for loading and saving models',\n )\n model_args.add_argument(\n '-im',\n '--init-model',\n default=None,\n type=str,\n help='load model weights and dict from this file',\n )\n model_args.add_argument(\n '--dict-class', hidden=True, help='the class of the dictionary agent uses'\n )\n\n def add_model_subargs(self, model):\n \"\"\"\n Add arguments specific to a particular model.\n \"\"\"\n agent = load_agent_module(model)\n try:\n if hasattr(agent, 'add_cmdline_args'):\n agent.add_cmdline_args(self)\n except argparse.ArgumentError:\n # already added\n pass\n try:\n if hasattr(agent, 'dictionary_class'):\n s = class2str(agent.dictionary_class())\n self.set_defaults(dict_class=s)\n except argparse.ArgumentError:\n # already added\n pass\n\n def add_task_args(self, task):\n \"\"\"\n Add arguments specific to the specified task.\n \"\"\"\n for t in ids_to_tasks(task).split(','):\n agent = load_teacher_module(t)\n try:\n if hasattr(agent, 'add_cmdline_args'):\n agent.add_cmdline_args(self)\n except argparse.ArgumentError:\n # already added\n pass\n\n def add_world_args(self, task, interactive_task, selfchat_task):\n \"\"\"\n Add arguments specific to the world.\n \"\"\"\n world_class = load_world_module(\n task, interactive_task=interactive_task, selfchat_task=selfchat_task\n )\n if world_class is not None and hasattr(world_class, 'add_cmdline_args'):\n try:\n world_class.add_cmdline_args(self)\n except argparse.ArgumentError:\n # already added\n pass\n\n def add_image_args(self, image_mode):\n \"\"\"\n Add additional arguments for handling images.\n \"\"\"\n try:\n parlai = self.add_argument_group('ParlAI Image Preprocessing Arguments')\n parlai.add_argument(\n '--image-size',\n type=int,\n default=256,\n help='resizing dimension for images',\n hidden=True,\n )\n parlai.add_argument(\n '--image-cropsize',\n type=int,\n default=224,\n help='crop dimension for images',\n hidden=True,\n )\n except argparse.ArgumentError:\n # already added\n pass\n\n def add_extra_args(self, args=None):\n \"\"\"\n Add more args depending on how known args are set.\n \"\"\"\n parsed = vars(self.parse_known_args(args, nohelp=True)[0])\n # Also load extra args options if a file is given.\n if parsed.get('init_opt', None) is not None:\n self._load_known_opts(parsed.get('init_opt'), parsed)\n parsed = self._infer_datapath(parsed)\n\n # find which image mode specified if any, and add additional arguments\n image_mode = parsed.get('image_mode', None)\n if image_mode is not None and image_mode != 'no_image_model':\n self.add_image_args(image_mode)\n\n # find which task specified if any, and add its specific arguments\n task = parsed.get('task', None)\n if task is not None:\n self.add_task_args(task)\n evaltask = parsed.get('evaltask', None)\n if evaltask is not None:\n self.add_task_args(evaltask)\n\n # find which model specified if any, and add its specific arguments\n model = get_model_name(parsed)\n if model is not None:\n self.add_model_subargs(model)\n\n # add world args, if we know a priori which world is being used\n if task is not None:\n self.add_world_args(\n task,\n parsed.get('interactive_task', False),\n parsed.get('selfchat_task', False),\n )\n\n # reset parser-level defaults over any model-level defaults\n try:\n self.set_defaults(**self._defaults)\n except AttributeError:\n raise RuntimeError(\n 'Please file an issue on github that argparse '\n 'got an attribute error when parsing.'\n )\n\n def parse_known_args(self, args=None, namespace=None, nohelp=False):\n \"\"\"\n Parse known args to ignore help flag.\n \"\"\"\n if args is None:\n # args default to the system args\n args = _sys.argv[1:]\n args = fix_underscores(args)\n\n if nohelp:\n # ignore help\n args = [a for a in args if a != '-h' and a != '--help']\n return super().parse_known_args(args, namespace)\n\n def _load_known_opts(self, optfile, parsed):\n \"\"\"\n Pull in CLI args for proper models/tasks/etc.\n\n Called before args are parsed; ``_load_opts`` is used for actually overriding\n opts after they are parsed.\n \"\"\"\n new_opt = load_opt_file(optfile)\n for key, value in new_opt.items():\n # existing command line parameters take priority.\n if key not in parsed or parsed[key] is None:\n parsed[key] = value\n\n def _load_opts(self, opt):\n optfile = opt.get('init_opt')\n new_opt = load_opt_file(optfile)\n for key, value in new_opt.items():\n # existing command line parameters take priority.\n if key not in opt:\n raise RuntimeError(\n 'Trying to set opt from file that does not exist: ' + str(key)\n )\n if key not in opt['override']:\n opt[key] = value\n opt['override'][key] = value\n\n def _infer_datapath(self, opt):\n \"\"\"\n Set the value for opt['datapath'] and opt['download_path'].\n\n Sets the value for opt['datapath'] and opt['download_path'], correctly\n respecting environmental variables and the default.\n \"\"\"\n # set environment variables\n # Priority for setting the datapath (same applies for download_path):\n # --datapath -> os.environ['PARLAI_DATAPATH'] -> <self.parlai_home>/data\n if opt.get('download_path'):\n os.environ['PARLAI_DOWNPATH'] = opt['download_path']\n elif os.environ.get('PARLAI_DOWNPATH') is None:\n os.environ['PARLAI_DOWNPATH'] = os.path.join(self.parlai_home, 'downloads')\n if opt.get('datapath'):\n os.environ['PARLAI_DATAPATH'] = opt['datapath']\n elif os.environ.get('PARLAI_DATAPATH') is None:\n os.environ['PARLAI_DATAPATH'] = os.path.join(self.parlai_home, 'data')\n\n opt['download_path'] = os.environ['PARLAI_DOWNPATH']\n opt['datapath'] = os.environ['PARLAI_DATAPATH']\n\n return opt\n\n def _process_args_to_opts(self, args_that_override: Optional[List[str]] = None):\n self.opt = Opt(vars(self.args))\n\n # custom post-parsing\n self.opt['parlai_home'] = self.parlai_home\n self.opt = self._infer_datapath(self.opt)\n\n # set all arguments specified in command line as overridable\n option_strings_dict = {}\n store_true = []\n store_false = []\n for group in self._action_groups:\n for a in group._group_actions:\n if hasattr(a, 'option_strings'):\n for option in a.option_strings:\n option_strings_dict[option] = a.dest\n if '_StoreTrueAction' in str(type(a)):\n store_true.append(option)\n elif '_StoreFalseAction' in str(type(a)):\n store_false.append(option)\n\n if args_that_override is None:\n args_that_override = _sys.argv[1:]\n\n for i in range(len(args_that_override)):\n if args_that_override[i] in option_strings_dict:\n if args_that_override[i] in store_true:\n self.overridable[option_strings_dict[args_that_override[i]]] = True\n elif args_that_override[i] in store_false:\n self.overridable[option_strings_dict[args_that_override[i]]] = False\n elif (\n i < len(args_that_override) - 1\n and args_that_override[i + 1][:1] != '-'\n ):\n key = option_strings_dict[args_that_override[i]]\n self.overridable[key] = self.opt[key]\n self.opt['override'] = self.overridable\n\n # load opts if a file is provided.\n if self.opt.get('init_opt', None) is not None:\n self._load_opts(self.opt)\n\n # map filenames that start with 'zoo:' to point to the model zoo dir\n options_to_change = {'model_file', 'dict_file', 'bpe_vocab', 'bpe_merge'}\n for each_key in options_to_change:\n if self.opt.get(each_key) is not None:\n self.opt[each_key] = modelzoo_path(\n self.opt.get('datapath'), self.opt[each_key]\n )\n if self.opt['override'].get(each_key) is not None:\n # also check override\n self.opt['override'][each_key] = modelzoo_path(\n self.opt.get('datapath'), self.opt['override'][each_key]\n )\n\n # add start time of an experiment\n self.opt['starttime'] = datetime.datetime.today().strftime('%b%d_%H-%M')\n\n def parse_and_process_known_args(self, args=None):\n \"\"\"\n Parse provided arguments and return parlai opts and unknown arg list.\n\n Runs the same arg->opt parsing that parse_args does, but doesn't throw an error\n if the args being parsed include additional command line arguments that parlai\n doesn't know what to do with.\n \"\"\"\n self.args, unknowns = super().parse_known_args(args=args)\n self._process_args_to_opts(args)\n return self.opt, unknowns\n\n def parse_args(self, args=None, namespace=None, print_args=True):\n \"\"\"\n Parse the provided arguments and returns a dictionary of the ``args``.\n\n We specifically remove items with ``None`` as values in order to support the\n style ``opt.get(key, default)``, which would otherwise return ``None``.\n \"\"\"\n self.add_extra_args(args)\n self.args = super().parse_args(args=args)\n\n self._process_args_to_opts(args)\n\n if print_args:\n self.print_args()\n if GIT_AVAILABLE:\n print_git_commit()\n print_announcements(self.opt)\n\n if os.environ.get('PARLAI_VERBOSE'):\n self.opt['verbose'] = True\n\n if self.opt.get('verbose'):\n logging.set_verbose_mode()\n\n return self.opt\n\n def _kwargs_to_str_args(self, **kwargs):\n \"\"\"\n Attempt to map from python-code kwargs into CLI args.\n\n e.g. model_file -> --model-file.\n\n Works with short options too, like t=\"convai2\".\n \"\"\"\n\n # we have to do this large block of repetitive code twice, the first\n # round is basically just to become aware of anything that would have\n # been added by add_extra_args\n kwname_to_action = {}\n for action in self._actions:\n if action.dest == 'help':\n # no help allowed\n continue\n for option_string in action.option_strings:\n kwname = option_string.lstrip('-').replace('-', '_')\n assert (kwname not in kwname_to_action) or (\n kwname_to_action[kwname] is action\n ), f\"No duplicate names! ({kwname}, {kwname_to_action[kwname]}, {action})\"\n kwname_to_action[kwname] = action\n\n string_args = []\n for kwname, value in kwargs.items():\n if kwname not in kwname_to_action:\n # best guess, we need to delay it. hopefully this gets added\n # during add_kw_Args\n continue\n action = kwname_to_action[kwname]\n last_option_string = action.option_strings[-1]\n if isinstance(action, argparse._StoreTrueAction) and bool(value):\n string_args.append(last_option_string)\n elif isinstance(action, argparse._StoreAction) and action.nargs is None:\n string_args.append(last_option_string)\n string_args.append(str(value))\n elif isinstance(action, argparse._StoreAction) and action.nargs in '*+':\n string_args.append(last_option_string)\n string_args.extend([str(v) for v in value])\n else:\n raise TypeError(f\"Don't know what to do with {action}\")\n\n # become aware of any extra args that might be specified if the user\n # provides something like model=\"transformer/generator\".\n self.add_extra_args(string_args)\n\n # do it again, this time knowing about ALL args.\n kwname_to_action = {}\n for action in self._actions:\n if action.dest == 'help':\n # no help allowed\n continue\n for option_string in action.option_strings:\n kwname = option_string.lstrip('-').replace('-', '_')\n assert (kwname not in kwname_to_action) or (\n kwname_to_action[kwname] is action\n ), f\"No duplicate names! ({kwname}, {kwname_to_action[kwname]}, {action})\"\n kwname_to_action[kwname] = action\n\n string_args = []\n for kwname, value in kwargs.items():\n # note we don't have the if kwname not in kwname_to_action here.\n # it MUST appear, or else we legitimately should be throwing a KeyError\n # because user has provided an unspecified option\n action = kwname_to_action[kwname]\n last_option_string = action.option_strings[-1]\n if isinstance(action, argparse._StoreTrueAction) and bool(value):\n string_args.append(last_option_string)\n elif isinstance(action, argparse._StoreAction) and action.nargs is None:\n string_args.append(last_option_string)\n string_args.append(str(value))\n elif isinstance(action, argparse._StoreAction) and action.nargs in '*+':\n string_args.append(last_option_string)\n string_args.extend([str(v) for v in value])\n else:\n raise TypeError(f\"Don't know what to do with {action}\")\n\n return string_args\n\n def parse_kwargs(self, **kwargs):\n \"\"\"\n Parse kwargs, with type checking etc.\n \"\"\"\n # hack: capture any error messages without raising a SystemExit\n def _captured_error(msg):\n raise ValueError(msg)\n\n old_error = self.error\n self.error = _captured_error\n try:\n string_args = self._kwargs_to_str_args(**kwargs)\n return self.parse_args(args=string_args, print_args=False)\n finally:\n self.error = old_error\n\n def print_args(self):\n \"\"\"\n Print out all the arguments in this parser.\n \"\"\"\n if not self.opt:\n self.parse_args(print_args=False)\n values = {}\n for key, value in self.opt.items():\n values[str(key)] = str(value)\n for group in self._action_groups:\n group_dict = {\n a.dest: getattr(self.args, a.dest, None) for a in group._group_actions\n }\n namespace = argparse.Namespace(**group_dict)\n count = 0\n for key in sorted(namespace.__dict__):\n if key in values:\n if count == 0:\n print('[ ' + group.title + ': ] ')\n count += 1\n print('[ ' + key + ': ' + values[key] + ' ]')\n\n def set_params(self, **kwargs):\n \"\"\"\n Set overridable kwargs.\n \"\"\"\n self.set_defaults(**kwargs)\n for k, v in kwargs.items():\n self.overridable[k] = v\n\n @property\n def show_advanced_args(self):\n \"\"\"\n Check if we should show arguments marked as hidden.\n \"\"\"\n if hasattr(self, '_show_advanced_args'):\n return self._show_advanced_args\n known_args, _ = self.parse_known_args(nohelp=True)\n if hasattr(known_args, 'show_advanced_args'):\n self._show_advanced_args = known_args.show_advanced_args\n else:\n self._show_advanced_args = True\n return self._show_advanced_args\n\n def _handle_custom_options(self, kwargs):\n \"\"\"\n Handle custom parlai options.\n\n Includes hidden, recommended. Future may include no_save and no_override.\n \"\"\"\n action_attr = {}\n if 'recommended' in kwargs:\n rec = kwargs.pop('recommended')\n action_attr['recommended'] = rec\n action_attr['hidden'] = kwargs.get('hidden', False)\n if 'hidden' in kwargs:\n hidden = kwargs.pop('hidden')\n if hidden:\n kwargs['help'] = argparse.SUPPRESS\n return kwargs, action_attr\n\n def add_argument(self, *args, **kwargs):\n \"\"\"\n Override to convert underscores to hyphens for consistency.\n \"\"\"\n kwargs, newattr = self._handle_custom_options(kwargs)\n action = super().add_argument(*fix_underscores(args), **kwargs)\n for k, v in newattr.items():\n setattr(action, k, v)\n return action\n\n def add_argument_group(self, *args, **kwargs):\n \"\"\"\n Override to make arg groups also convert underscores to hyphens.\n \"\"\"\n arg_group = super().add_argument_group(*args, **kwargs)\n original_add_arg = arg_group.add_argument\n\n def ag_add_argument(*args, **kwargs):\n kwargs, newattr = self._handle_custom_options(kwargs)\n action = original_add_arg(*fix_underscores(args), **kwargs)\n for k, v in newattr.items():\n setattr(action, k, v)\n return action\n\n arg_group.add_argument = ag_add_argument # override _ => -\n arg_group.add_argument_group = self.add_argument_group\n return arg_group\n\n def error(self, message):\n \"\"\"\n Override to print custom error message.\n \"\"\"\n self.print_help()\n _sys.stderr.write('\\nParse Error: %s\\n' % message)\n _sys.exit(2)\n","path":"parlai/core/params.py"}],"string":"[\n {\n \"content\": \"#!/usr/bin/env python3\\n\\n# Copyright (c) Facebook, Inc. and its affiliates.\\n# This source code is licensed under the MIT license found in the\\n# LICENSE file in the root directory of this source tree.\\n\\\"\\\"\\\"\\nProvide an argument parser and default command line options for using ParlAI.\\n\\\"\\\"\\\"\\n\\nimport argparse\\nimport importlib\\nimport os\\nimport sys as _sys\\nimport datetime\\nimport parlai\\n\\ntry:\\n import git\\n\\n GIT_AVAILABLE = True\\nexcept ImportError:\\n # silence the error\\n GIT_AVAILABLE = False\\n\\nimport parlai.utils.logging as logging\\nfrom parlai.core.build_data import modelzoo_path\\nfrom parlai.core.loader import load_teacher_module, load_agent_module, load_world_module\\nfrom parlai.tasks.tasks import ids_to_tasks\\nfrom parlai.core.opt import Opt, load_opt_file\\n\\nfrom typing import List, Optional\\n\\n\\ndef print_git_commit():\\n \\\"\\\"\\\"\\n Print the current git commit of ParlAI and parlai_internal.\\n \\\"\\\"\\\"\\n root = os.path.dirname(os.path.dirname(parlai.__file__))\\n internal_root = os.path.join(root, 'parlai_internal')\\n try:\\n git_ = git.Git(root)\\n current_commit = git_.rev_parse('HEAD')\\n print(f'[ Current ParlAI commit: {current_commit} ]')\\n except git.GitCommandNotFound:\\n pass\\n except git.GitCommandError:\\n pass\\n\\n try:\\n git_ = git.Git(internal_root)\\n internal_commit = git_.rev_parse('HEAD')\\n print(f'[ Current internal commit: {internal_commit} ]')\\n except git.GitCommandNotFound:\\n pass\\n except git.GitCommandError:\\n pass\\n\\n\\ndef print_announcements(opt):\\n \\\"\\\"\\\"\\n Output any announcements the ParlAI team wishes to make to users.\\n\\n Also gives the user the option to suppress the output.\\n \\\"\\\"\\\"\\n # no annoucements to make right now\\n return\\n\\n noannounce_file = os.path.join(opt.get('datapath'), 'noannouncements')\\n if os.path.exists(noannounce_file):\\n # user has suppressed announcements, don't do anything\\n return\\n\\n # useful constants\\n # all of these colors are bolded\\n RESET = '\\\\033[0m'\\n BOLD = '\\\\033[1m'\\n RED = '\\\\033[1;91m'\\n YELLOW = '\\\\033[1;93m'\\n GREEN = '\\\\033[1;92m'\\n BLUE = '\\\\033[1;96m'\\n CYAN = '\\\\033[1;94m'\\n MAGENTA = '\\\\033[1;95m'\\n\\n # only use colors if we're outputting to a terminal\\n USE_COLORS = _sys.stdout.isatty()\\n if not USE_COLORS:\\n RESET = BOLD = RED = YELLOW = GREEN = BLUE = CYAN = MAGENTA = ''\\n\\n # generate the rainbow stars\\n rainbow = [RED, YELLOW, GREEN, CYAN, BLUE, MAGENTA]\\n size = 78 // len(rainbow)\\n stars = ''.join([color + '*' * size for color in rainbow])\\n stars += RESET\\n\\n # do the actual output\\n print(\\n '\\\\n'.join(\\n [\\n '',\\n stars,\\n BOLD,\\n 'Announcements go here.',\\n RESET,\\n # don't bold the suppression command\\n 'To suppress this message (and future announcements), run\\\\n`touch {}`'.format(\\n noannounce_file\\n ),\\n stars,\\n ]\\n )\\n )\\n\\n\\ndef get_model_name(opt):\\n \\\"\\\"\\\"\\n Get the model name from either `--model` or `--model-file`.\\n \\\"\\\"\\\"\\n model = opt.get('model', None)\\n if model is None:\\n # try to get model name from model opt file\\n model_file = opt.get('model_file', None)\\n if model_file is not None:\\n model_file = modelzoo_path(opt.get('datapath'), model_file)\\n optfile = model_file + '.opt'\\n if os.path.isfile(optfile):\\n new_opt = load_opt_file(optfile)\\n model = new_opt.get('model', None)\\n return model\\n\\n\\ndef str2none(value: str):\\n \\\"\\\"\\\"\\n If the value is a variant of `none`, return None.\\n\\n Otherwise, return the original value.\\n \\\"\\\"\\\"\\n if value.lower() == 'none':\\n return None\\n else:\\n return value\\n\\n\\ndef str2bool(value):\\n \\\"\\\"\\\"\\n Convert 'yes', 'false', '1', etc.\\n\\n into a boolean.\\n \\\"\\\"\\\"\\n v = value.lower()\\n if v in ('yes', 'true', 't', '1', 'y'):\\n return True\\n elif v in ('no', 'false', 'f', 'n', '0'):\\n return False\\n else:\\n raise argparse.ArgumentTypeError('Boolean value expected.')\\n\\n\\ndef str2floats(s):\\n \\\"\\\"\\\"\\n Look for single float or comma-separated floats.\\n \\\"\\\"\\\"\\n return tuple(float(f) for f in s.split(','))\\n\\n\\ndef str2class(value):\\n \\\"\\\"\\\"\\n From import path string, returns the class specified.\\n\\n For example, the string 'parlai.agents.drqa.drqa:SimpleDictionaryAgent' returns\\n <class 'parlai.agents.drqa.drqa.SimpleDictionaryAgent'>.\\n \\\"\\\"\\\"\\n if ':' not in value:\\n raise RuntimeError('Use a colon before the name of the class.')\\n name = value.split(':')\\n module = importlib.import_module(name[0])\\n return getattr(module, name[1])\\n\\n\\ndef class2str(value):\\n \\\"\\\"\\\"\\n Inverse of params.str2class().\\n \\\"\\\"\\\"\\n s = str(value)\\n s = s[s.find('\\\\'') + 1 : s.rfind('\\\\'')] # pull out import path\\n s = ':'.join(s.rsplit('.', 1)) # replace last period with ':'\\n return s\\n\\n\\ndef fix_underscores(args):\\n \\\"\\\"\\\"\\n Convert underscores to hyphens in args.\\n\\n For example, converts '--gradient_clip' to '--gradient-clip'.\\n\\n :param args: iterable, possibly containing args strings with underscores.\\n \\\"\\\"\\\"\\n if args:\\n new_args = []\\n for a in args:\\n if type(a) is str and a.startswith('-'):\\n a = a.replace('_', '-')\\n new_args.append(a)\\n args = new_args\\n return args\\n\\n\\nclass CustomHelpFormatter(argparse.HelpFormatter):\\n \\\"\\\"\\\"\\n Produce a custom-formatted `--help` option.\\n\\n See https://goo.gl/DKtHb5 for details.\\n \\\"\\\"\\\"\\n\\n def __init__(self, *args, **kwargs):\\n kwargs['max_help_position'] = 6\\n kwargs['width'] = 80\\n super().__init__(*args, **kwargs)\\n\\n def _format_action_invocation(self, action):\\n if not action.option_strings or action.nargs == 0:\\n return super()._format_action_invocation(action)\\n default = self._get_default_metavar_for_optional(action)\\n args_string = self._format_args(action, default)\\n return ', '.join(action.option_strings) + ' ' + args_string\\n\\n def _get_help_string(self, action):\\n help = action.help\\n if '%(default)' not in action.help:\\n if action.default is not argparse.SUPPRESS:\\n defaulting_nargs = [argparse.OPTIONAL, argparse.ZERO_OR_MORE]\\n if action.option_strings or action.nargs in defaulting_nargs:\\n help += ' (default: %(default)s)'\\n if (\\n hasattr(action, 'recommended')\\n and action.recommended\\n and action.recommended != action.default\\n ):\\n help += '(recommended: %(recommended)s)'\\n help = help.replace(')(recommended', ', recommended')\\n return help\\n\\n\\nclass ParlaiParser(argparse.ArgumentParser):\\n \\\"\\\"\\\"\\n Provide an opt-producer and CLI argument parser.\\n\\n Pseudo-extension of ``argparse`` which sets a number of parameters\\n for the ParlAI framework. More options can be added specific to other\\n modules by passing this object and calling ``add_arg()`` or\\n ``add_argument()`` on it.\\n\\n For example, see ``parlai.core.dict.DictionaryAgent.add_cmdline_args``.\\n\\n :param add_parlai_args:\\n (default True) initializes the default arguments for ParlAI\\n package, including the data download paths and task arguments.\\n :param add_model_args:\\n (default False) initializes the default arguments for loading\\n models, including initializing arguments from that model.\\n \\\"\\\"\\\"\\n\\n def __init__(\\n self, add_parlai_args=True, add_model_args=False, description='ParlAI parser'\\n ):\\n \\\"\\\"\\\"\\n Initialize the ParlAI argparser.\\n \\\"\\\"\\\"\\n super().__init__(\\n description=description,\\n allow_abbrev=False,\\n conflict_handler='resolve',\\n formatter_class=CustomHelpFormatter,\\n add_help=add_parlai_args,\\n )\\n self.register('type', 'nonestr', str2none)\\n self.register('type', 'bool', str2bool)\\n self.register('type', 'floats', str2floats)\\n self.register('type', 'class', str2class)\\n self.parlai_home = os.path.dirname(\\n os.path.dirname(os.path.dirname(os.path.realpath(__file__)))\\n )\\n os.environ['PARLAI_HOME'] = self.parlai_home\\n\\n self.add_arg = self.add_argument\\n\\n # remember which args were specified on the command line\\n self.overridable = {}\\n\\n if add_parlai_args:\\n self.add_parlai_args()\\n if add_model_args:\\n self.add_model_args()\\n\\n def add_parlai_data_path(self, argument_group=None):\\n \\\"\\\"\\\"\\n Add --datapath CLI arg.\\n \\\"\\\"\\\"\\n if argument_group is None:\\n argument_group = self\\n argument_group.add_argument(\\n '-dp',\\n '--datapath',\\n default=None,\\n help='path to datasets, defaults to {parlai_dir}/data',\\n )\\n\\n def add_mturk_args(self):\\n \\\"\\\"\\\"\\n Add standard mechanical turk arguments.\\n \\\"\\\"\\\"\\n mturk = self.add_argument_group('Mechanical Turk')\\n default_log_path = os.path.join(self.parlai_home, 'logs', 'mturk')\\n mturk.add_argument(\\n '--mturk-log-path',\\n default=default_log_path,\\n help='path to MTurk logs, defaults to {parlai_dir}/logs/mturk',\\n )\\n mturk.add_argument(\\n '-t',\\n '--task',\\n help='MTurk task, e.g. \\\"qa_data_collection\\\" or \\\"model_evaluator\\\"',\\n )\\n mturk.add_argument(\\n '-nc',\\n '--num-conversations',\\n default=1,\\n type=int,\\n help='number of conversations you want to create for this task',\\n )\\n mturk.add_argument(\\n '--unique',\\n dest='unique_worker',\\n default=False,\\n action='store_true',\\n help='enforce that no worker can work on your task twice',\\n )\\n mturk.add_argument(\\n '--max-hits-per-worker',\\n dest='max_hits_per_worker',\\n default=0,\\n type=int,\\n help='Max number of hits each worker can perform during current group run',\\n )\\n mturk.add_argument(\\n '--unique-qual-name',\\n dest='unique_qual_name',\\n default=None,\\n type=str,\\n help='qualification name to use for uniqueness between HITs',\\n )\\n mturk.add_argument(\\n '-r',\\n '--reward',\\n default=0.05,\\n type=float,\\n help='reward for each worker for finishing the conversation, '\\n 'in US dollars',\\n )\\n mturk.add_argument(\\n '--sandbox',\\n dest='is_sandbox',\\n action='store_true',\\n help='submit the HITs to MTurk sandbox site',\\n )\\n mturk.add_argument(\\n '--live',\\n dest='is_sandbox',\\n action='store_false',\\n help='submit the HITs to MTurk live site',\\n )\\n mturk.add_argument(\\n '--debug',\\n dest='is_debug',\\n action='store_true',\\n help='print and log all server interactions and messages',\\n )\\n mturk.add_argument(\\n '--verbose',\\n dest='verbose',\\n action='store_true',\\n help='print all messages sent to and from Turkers',\\n )\\n mturk.add_argument(\\n '--hard-block',\\n dest='hard_block',\\n action='store_true',\\n default=False,\\n help='Hard block disconnecting Turkers from all of your HITs',\\n )\\n mturk.add_argument(\\n '--log-level',\\n dest='log_level',\\n type=int,\\n default=20,\\n help='importance level for what to put into the logs. the lower '\\n 'the level the more that gets logged. values are 0-50',\\n )\\n mturk.add_argument(\\n '--disconnect-qualification',\\n dest='disconnect_qualification',\\n default=None,\\n help='Qualification to use for soft blocking users for '\\n 'disconnects. By default '\\n 'turkers are never blocked, though setting this will allow '\\n 'you to filter out turkers that have disconnected too many '\\n 'times on previous HITs where this qualification was set.',\\n )\\n mturk.add_argument(\\n '--block-qualification',\\n dest='block_qualification',\\n default=None,\\n help='Qualification to use for soft blocking users. This '\\n 'qualification is granted whenever soft_block_worker is '\\n 'called, and can thus be used to filter workers out from a '\\n 'single task or group of tasks by noted performance.',\\n )\\n mturk.add_argument(\\n '--count-complete',\\n dest='count_complete',\\n default=False,\\n action='store_true',\\n help='continue until the requested number of conversations are '\\n 'completed rather than attempted',\\n )\\n mturk.add_argument(\\n '--allowed-conversations',\\n dest='allowed_conversations',\\n default=0,\\n type=int,\\n help='number of concurrent conversations that one mturk worker '\\n 'is able to be involved in, 0 is unlimited',\\n )\\n mturk.add_argument(\\n '--max-connections',\\n dest='max_connections',\\n default=30,\\n type=int,\\n help='number of HITs that can be launched at the same time, 0 is '\\n 'unlimited.',\\n )\\n mturk.add_argument(\\n '--min-messages',\\n dest='min_messages',\\n default=0,\\n type=int,\\n help='number of messages required to be sent by MTurk agent when '\\n 'considering whether to approve a HIT in the event of a '\\n 'partner disconnect. I.e. if the number of messages '\\n 'exceeds this number, the turker can submit the HIT.',\\n )\\n mturk.add_argument(\\n '--local',\\n dest='local',\\n default=False,\\n action='store_true',\\n help='Run the server locally on this server rather than setting up'\\n ' a heroku server.',\\n )\\n mturk.add_argument(\\n '--hobby',\\n dest='hobby',\\n default=False,\\n action='store_true',\\n help='Run the heroku server on the hobby tier.',\\n )\\n mturk.add_argument(\\n '--max-time',\\n dest='max_time',\\n default=0,\\n type=int,\\n help='Maximum number of seconds per day that a worker is allowed '\\n 'to work on this assignment',\\n )\\n mturk.add_argument(\\n '--max-time-qual',\\n dest='max_time_qual',\\n default=None,\\n help='Qualification to use to share the maximum time requirement '\\n 'with other runs from other machines.',\\n )\\n mturk.add_argument(\\n '--heroku-team',\\n dest='heroku_team',\\n default=None,\\n help='Specify Heroku team name to use for launching Dynos.',\\n )\\n mturk.add_argument(\\n '--tmp-dir',\\n dest='tmp_dir',\\n default=None,\\n help='Specify location to use for scratch builds and such.',\\n )\\n\\n # it helps to indicate to agents that they're in interactive mode, and\\n # can avoid some otherwise troublesome behavior (not having candidates,\\n # sharing self.replies, etc).\\n mturk.set_defaults(interactive_mode=True)\\n\\n mturk.set_defaults(is_sandbox=True)\\n mturk.set_defaults(is_debug=False)\\n mturk.set_defaults(verbose=False)\\n\\n def add_chatservice_args(self):\\n \\\"\\\"\\\"\\n Arguments for all chat services.\\n \\\"\\\"\\\"\\n args = self.add_argument_group('Chat Services')\\n args.add_argument(\\n '--debug',\\n dest='is_debug',\\n action='store_true',\\n help='print and log all server interactions and messages',\\n )\\n args.add_argument(\\n '--config-path',\\n default=None,\\n type=str,\\n help='/path/to/config/file for a given task.',\\n )\\n args.add_argument(\\n '--password',\\n dest='password',\\n type=str,\\n default=None,\\n help='Require a password for entry to the bot',\\n )\\n\\n def add_websockets_args(self):\\n \\\"\\\"\\\"\\n Add websocket arguments.\\n \\\"\\\"\\\"\\n self.add_chatservice_args()\\n websockets = self.add_argument_group('Websockets')\\n websockets.add_argument(\\n '--port', default=35496, type=int, help='Port to run the websocket handler'\\n )\\n\\n def add_messenger_args(self):\\n \\\"\\\"\\\"\\n Add Facebook Messenger arguments.\\n \\\"\\\"\\\"\\n self.add_chatservice_args()\\n messenger = self.add_argument_group('Facebook Messenger')\\n messenger.add_argument(\\n '--verbose',\\n dest='verbose',\\n action='store_true',\\n help='print all messages sent to and from Turkers',\\n )\\n messenger.add_argument(\\n '--log-level',\\n dest='log_level',\\n type=int,\\n default=20,\\n help='importance level for what to put into the logs. the lower '\\n 'the level the more that gets logged. values are 0-50',\\n )\\n messenger.add_argument(\\n '--force-page-token',\\n dest='force_page_token',\\n action='store_true',\\n help='override the page token stored in the cache for a new one',\\n )\\n messenger.add_argument(\\n '--bypass-server-setup',\\n dest='bypass_server_setup',\\n action='store_true',\\n default=False,\\n help='should bypass traditional server and socket setup',\\n )\\n messenger.add_argument(\\n '--local',\\n dest='local',\\n action='store_true',\\n default=False,\\n help='Run the server locally on this server rather than setting up'\\n ' a heroku server.',\\n )\\n\\n messenger.set_defaults(is_debug=False)\\n messenger.set_defaults(verbose=False)\\n\\n def add_parlai_args(self, args=None):\\n \\\"\\\"\\\"\\n Add common ParlAI args across all scripts.\\n \\\"\\\"\\\"\\n parlai = self.add_argument_group('Main ParlAI Arguments')\\n parlai.add_argument(\\n '-o',\\n '--init-opt',\\n default=None,\\n help='Path to json file of options. '\\n 'Note: Further Command-line arguments override file-based options.',\\n )\\n parlai.add_argument(\\n '-v',\\n '--show-advanced-args',\\n action='store_true',\\n help='Show hidden command line options (advanced users only)',\\n )\\n parlai.add_argument(\\n '-t', '--task', help='ParlAI task(s), e.g. \\\"babi:Task1\\\" or \\\"babi,cbt\\\"'\\n )\\n parlai.add_argument(\\n '--download-path',\\n default=None,\\n hidden=True,\\n help='path for non-data dependencies to store any needed files.'\\n 'defaults to {parlai_dir}/downloads',\\n )\\n parlai.add_argument(\\n '-dt',\\n '--datatype',\\n default='train',\\n choices=[\\n 'train',\\n 'train:stream',\\n 'train:ordered',\\n 'train:ordered:stream',\\n 'train:stream:ordered',\\n 'train:evalmode',\\n 'train:evalmode:stream',\\n 'train:evalmode:ordered',\\n 'train:evalmode:ordered:stream',\\n 'train:evalmode:stream:ordered',\\n 'valid',\\n 'valid:stream',\\n 'test',\\n 'test:stream',\\n ],\\n help='choose from: train, train:ordered, valid, test. to stream '\\n 'data add \\\":stream\\\" to any option (e.g., train:stream). '\\n 'by default: train is random with replacement, '\\n 'valid is ordered, test is ordered.',\\n )\\n parlai.add_argument(\\n '-im',\\n '--image-mode',\\n default='raw',\\n type=str,\\n help='image preprocessor to use. default is \\\"raw\\\". set to \\\"none\\\" '\\n 'to skip image loading.',\\n hidden=True,\\n )\\n parlai.add_argument(\\n '-nt',\\n '--numthreads',\\n default=1,\\n type=int,\\n help='number of threads. Used for hogwild if batchsize is 1, else '\\n 'for number of threads in threadpool loading,',\\n )\\n parlai.add_argument(\\n '--hide-labels',\\n default=False,\\n type='bool',\\n hidden=True,\\n help='default (False) moves labels in valid and test sets to the '\\n 'eval_labels field. If True, they are hidden completely.',\\n )\\n parlai.add_argument(\\n '-mtw',\\n '--multitask-weights',\\n type='floats',\\n default=[1],\\n help='list of floats, one for each task, specifying '\\n 'the probability of drawing the task in multitask case',\\n hidden=True,\\n )\\n parlai.add_argument(\\n '-bs',\\n '--batchsize',\\n default=1,\\n type=int,\\n help='batch size for minibatch training schemes',\\n )\\n parlai.add_argument(\\n '-dynb',\\n '--dynamic-batching',\\n default=None,\\n type='nonestr',\\n choices={None, 'full', 'batchsort'},\\n help='Use dynamic batching',\\n )\\n self.add_parlai_data_path(parlai)\\n\\n def add_distributed_training_args(self):\\n \\\"\\\"\\\"\\n Add CLI args for distributed training.\\n \\\"\\\"\\\"\\n grp = self.add_argument_group('Distributed Training')\\n grp.add_argument(\\n '--distributed-world-size', type=int, help='Number of workers.'\\n )\\n grp.add_argument(\\n '--verbose',\\n type='bool',\\n default=False,\\n help='All workers print output.',\\n hidden=True,\\n )\\n return grp\\n\\n def add_model_args(self):\\n \\\"\\\"\\\"\\n Add arguments related to models such as model files.\\n \\\"\\\"\\\"\\n model_args = self.add_argument_group('ParlAI Model Arguments')\\n model_args.add_argument(\\n '-m',\\n '--model',\\n default=None,\\n help='the model class name. can match parlai/agents/<model> for '\\n 'agents in that directory, or can provide a fully specified '\\n 'module for `from X import Y` via `-m X:Y` '\\n '(e.g. `-m parlai.agents.seq2seq.seq2seq:Seq2SeqAgent`)',\\n )\\n model_args.add_argument(\\n '-mf',\\n '--model-file',\\n default=None,\\n help='model file name for loading and saving models',\\n )\\n model_args.add_argument(\\n '-im',\\n '--init-model',\\n default=None,\\n type=str,\\n help='load model weights and dict from this file',\\n )\\n model_args.add_argument(\\n '--dict-class', hidden=True, help='the class of the dictionary agent uses'\\n )\\n\\n def add_model_subargs(self, model):\\n \\\"\\\"\\\"\\n Add arguments specific to a particular model.\\n \\\"\\\"\\\"\\n agent = load_agent_module(model)\\n try:\\n if hasattr(agent, 'add_cmdline_args'):\\n agent.add_cmdline_args(self)\\n except argparse.ArgumentError:\\n # already added\\n pass\\n try:\\n if hasattr(agent, 'dictionary_class'):\\n s = class2str(agent.dictionary_class())\\n self.set_defaults(dict_class=s)\\n except argparse.ArgumentError:\\n # already added\\n pass\\n\\n def add_task_args(self, task):\\n \\\"\\\"\\\"\\n Add arguments specific to the specified task.\\n \\\"\\\"\\\"\\n for t in ids_to_tasks(task).split(','):\\n agent = load_teacher_module(t)\\n try:\\n if hasattr(agent, 'add_cmdline_args'):\\n agent.add_cmdline_args(self)\\n except argparse.ArgumentError:\\n # already added\\n pass\\n\\n def add_world_args(self, task, interactive_task, selfchat_task):\\n \\\"\\\"\\\"\\n Add arguments specific to the world.\\n \\\"\\\"\\\"\\n world_class = load_world_module(\\n task, interactive_task=interactive_task, selfchat_task=selfchat_task\\n )\\n if world_class is not None and hasattr(world_class, 'add_cmdline_args'):\\n try:\\n world_class.add_cmdline_args(self)\\n except argparse.ArgumentError:\\n # already added\\n pass\\n\\n def add_image_args(self, image_mode):\\n \\\"\\\"\\\"\\n Add additional arguments for handling images.\\n \\\"\\\"\\\"\\n try:\\n parlai = self.add_argument_group('ParlAI Image Preprocessing Arguments')\\n parlai.add_argument(\\n '--image-size',\\n type=int,\\n default=256,\\n help='resizing dimension for images',\\n hidden=True,\\n )\\n parlai.add_argument(\\n '--image-cropsize',\\n type=int,\\n default=224,\\n help='crop dimension for images',\\n hidden=True,\\n )\\n except argparse.ArgumentError:\\n # already added\\n pass\\n\\n def add_extra_args(self, args=None):\\n \\\"\\\"\\\"\\n Add more args depending on how known args are set.\\n \\\"\\\"\\\"\\n parsed = vars(self.parse_known_args(args, nohelp=True)[0])\\n # Also load extra args options if a file is given.\\n if parsed.get('init_opt', None) is not None:\\n self._load_known_opts(parsed.get('init_opt'), parsed)\\n parsed = self._infer_datapath(parsed)\\n\\n # find which image mode specified if any, and add additional arguments\\n image_mode = parsed.get('image_mode', None)\\n if image_mode is not None and image_mode != 'no_image_model':\\n self.add_image_args(image_mode)\\n\\n # find which task specified if any, and add its specific arguments\\n task = parsed.get('task', None)\\n if task is not None:\\n self.add_task_args(task)\\n evaltask = parsed.get('evaltask', None)\\n if evaltask is not None:\\n self.add_task_args(evaltask)\\n\\n # find which model specified if any, and add its specific arguments\\n model = get_model_name(parsed)\\n if model is not None:\\n self.add_model_subargs(model)\\n\\n # add world args, if we know a priori which world is being used\\n if task is not None:\\n self.add_world_args(\\n task,\\n parsed.get('interactive_task', False),\\n parsed.get('selfchat_task', False),\\n )\\n\\n # reset parser-level defaults over any model-level defaults\\n try:\\n self.set_defaults(**self._defaults)\\n except AttributeError:\\n raise RuntimeError(\\n 'Please file an issue on github that argparse '\\n 'got an attribute error when parsing.'\\n )\\n\\n def parse_known_args(self, args=None, namespace=None, nohelp=False):\\n \\\"\\\"\\\"\\n Parse known args to ignore help flag.\\n \\\"\\\"\\\"\\n if args is None:\\n # args default to the system args\\n args = _sys.argv[1:]\\n args = fix_underscores(args)\\n\\n if nohelp:\\n # ignore help\\n args = [a for a in args if a != '-h' and a != '--help']\\n return super().parse_known_args(args, namespace)\\n\\n def _load_known_opts(self, optfile, parsed):\\n \\\"\\\"\\\"\\n Pull in CLI args for proper models/tasks/etc.\\n\\n Called before args are parsed; ``_load_opts`` is used for actually overriding\\n opts after they are parsed.\\n \\\"\\\"\\\"\\n new_opt = load_opt_file(optfile)\\n for key, value in new_opt.items():\\n # existing command line parameters take priority.\\n if key not in parsed or parsed[key] is None:\\n parsed[key] = value\\n\\n def _load_opts(self, opt):\\n optfile = opt.get('init_opt')\\n new_opt = load_opt_file(optfile)\\n for key, value in new_opt.items():\\n # existing command line parameters take priority.\\n if key not in opt:\\n raise RuntimeError(\\n 'Trying to set opt from file that does not exist: ' + str(key)\\n )\\n if key not in opt['override']:\\n opt[key] = value\\n opt['override'][key] = value\\n\\n def _infer_datapath(self, opt):\\n \\\"\\\"\\\"\\n Set the value for opt['datapath'] and opt['download_path'].\\n\\n Sets the value for opt['datapath'] and opt['download_path'], correctly\\n respecting environmental variables and the default.\\n \\\"\\\"\\\"\\n # set environment variables\\n # Priority for setting the datapath (same applies for download_path):\\n # --datapath -> os.environ['PARLAI_DATAPATH'] -> <self.parlai_home>/data\\n if opt.get('download_path'):\\n os.environ['PARLAI_DOWNPATH'] = opt['download_path']\\n elif os.environ.get('PARLAI_DOWNPATH') is None:\\n os.environ['PARLAI_DOWNPATH'] = os.path.join(self.parlai_home, 'downloads')\\n if opt.get('datapath'):\\n os.environ['PARLAI_DATAPATH'] = opt['datapath']\\n elif os.environ.get('PARLAI_DATAPATH') is None:\\n os.environ['PARLAI_DATAPATH'] = os.path.join(self.parlai_home, 'data')\\n\\n opt['download_path'] = os.environ['PARLAI_DOWNPATH']\\n opt['datapath'] = os.environ['PARLAI_DATAPATH']\\n\\n return opt\\n\\n def _process_args_to_opts(self, args_that_override: Optional[List[str]] = None):\\n self.opt = Opt(vars(self.args))\\n\\n # custom post-parsing\\n self.opt['parlai_home'] = self.parlai_home\\n self.opt = self._infer_datapath(self.opt)\\n\\n # set all arguments specified in command line as overridable\\n option_strings_dict = {}\\n store_true = []\\n store_false = []\\n for group in self._action_groups:\\n for a in group._group_actions:\\n if hasattr(a, 'option_strings'):\\n for option in a.option_strings:\\n option_strings_dict[option] = a.dest\\n if '_StoreTrueAction' in str(type(a)):\\n store_true.append(option)\\n elif '_StoreFalseAction' in str(type(a)):\\n store_false.append(option)\\n\\n if args_that_override is None:\\n args_that_override = _sys.argv[1:]\\n\\n for i in range(len(args_that_override)):\\n if args_that_override[i] in option_strings_dict:\\n if args_that_override[i] in store_true:\\n self.overridable[option_strings_dict[args_that_override[i]]] = True\\n elif args_that_override[i] in store_false:\\n self.overridable[option_strings_dict[args_that_override[i]]] = False\\n elif (\\n i < len(args_that_override) - 1\\n and args_that_override[i + 1][:1] != '-'\\n ):\\n key = option_strings_dict[args_that_override[i]]\\n self.overridable[key] = self.opt[key]\\n self.opt['override'] = self.overridable\\n\\n # load opts if a file is provided.\\n if self.opt.get('init_opt', None) is not None:\\n self._load_opts(self.opt)\\n\\n # map filenames that start with 'zoo:' to point to the model zoo dir\\n options_to_change = {'model_file', 'dict_file', 'bpe_vocab', 'bpe_merge'}\\n for each_key in options_to_change:\\n if self.opt.get(each_key) is not None:\\n self.opt[each_key] = modelzoo_path(\\n self.opt.get('datapath'), self.opt[each_key]\\n )\\n if self.opt['override'].get(each_key) is not None:\\n # also check override\\n self.opt['override'][each_key] = modelzoo_path(\\n self.opt.get('datapath'), self.opt['override'][each_key]\\n )\\n\\n # add start time of an experiment\\n self.opt['starttime'] = datetime.datetime.today().strftime('%b%d_%H-%M')\\n\\n def parse_and_process_known_args(self, args=None):\\n \\\"\\\"\\\"\\n Parse provided arguments and return parlai opts and unknown arg list.\\n\\n Runs the same arg->opt parsing that parse_args does, but doesn't throw an error\\n if the args being parsed include additional command line arguments that parlai\\n doesn't know what to do with.\\n \\\"\\\"\\\"\\n self.args, unknowns = super().parse_known_args(args=args)\\n self._process_args_to_opts(args)\\n return self.opt, unknowns\\n\\n def parse_args(self, args=None, namespace=None, print_args=True):\\n \\\"\\\"\\\"\\n Parse the provided arguments and returns a dictionary of the ``args``.\\n\\n We specifically remove items with ``None`` as values in order to support the\\n style ``opt.get(key, default)``, which would otherwise return ``None``.\\n \\\"\\\"\\\"\\n self.add_extra_args(args)\\n self.args = super().parse_args(args=args)\\n\\n self._process_args_to_opts(args)\\n\\n if print_args:\\n self.print_args()\\n if GIT_AVAILABLE:\\n print_git_commit()\\n print_announcements(self.opt)\\n\\n if os.environ.get('PARLAI_VERBOSE'):\\n self.opt['verbose'] = True\\n\\n if self.opt.get('verbose'):\\n logging.set_verbose_mode()\\n\\n return self.opt\\n\\n def _kwargs_to_str_args(self, **kwargs):\\n \\\"\\\"\\\"\\n Attempt to map from python-code kwargs into CLI args.\\n\\n e.g. model_file -> --model-file.\\n\\n Works with short options too, like t=\\\"convai2\\\".\\n \\\"\\\"\\\"\\n\\n # we have to do this large block of repetitive code twice, the first\\n # round is basically just to become aware of anything that would have\\n # been added by add_extra_args\\n kwname_to_action = {}\\n for action in self._actions:\\n if action.dest == 'help':\\n # no help allowed\\n continue\\n for option_string in action.option_strings:\\n kwname = option_string.lstrip('-').replace('-', '_')\\n assert (kwname not in kwname_to_action) or (\\n kwname_to_action[kwname] is action\\n ), f\\\"No duplicate names! ({kwname}, {kwname_to_action[kwname]}, {action})\\\"\\n kwname_to_action[kwname] = action\\n\\n string_args = []\\n for kwname, value in kwargs.items():\\n if kwname not in kwname_to_action:\\n # best guess, we need to delay it. hopefully this gets added\\n # during add_kw_Args\\n continue\\n action = kwname_to_action[kwname]\\n last_option_string = action.option_strings[-1]\\n if isinstance(action, argparse._StoreTrueAction) and bool(value):\\n string_args.append(last_option_string)\\n elif isinstance(action, argparse._StoreAction) and action.nargs is None:\\n string_args.append(last_option_string)\\n string_args.append(str(value))\\n elif isinstance(action, argparse._StoreAction) and action.nargs in '*+':\\n string_args.append(last_option_string)\\n string_args.extend([str(v) for v in value])\\n else:\\n raise TypeError(f\\\"Don't know what to do with {action}\\\")\\n\\n # become aware of any extra args that might be specified if the user\\n # provides something like model=\\\"transformer/generator\\\".\\n self.add_extra_args(string_args)\\n\\n # do it again, this time knowing about ALL args.\\n kwname_to_action = {}\\n for action in self._actions:\\n if action.dest == 'help':\\n # no help allowed\\n continue\\n for option_string in action.option_strings:\\n kwname = option_string.lstrip('-').replace('-', '_')\\n assert (kwname not in kwname_to_action) or (\\n kwname_to_action[kwname] is action\\n ), f\\\"No duplicate names! ({kwname}, {kwname_to_action[kwname]}, {action})\\\"\\n kwname_to_action[kwname] = action\\n\\n string_args = []\\n for kwname, value in kwargs.items():\\n # note we don't have the if kwname not in kwname_to_action here.\\n # it MUST appear, or else we legitimately should be throwing a KeyError\\n # because user has provided an unspecified option\\n action = kwname_to_action[kwname]\\n last_option_string = action.option_strings[-1]\\n if isinstance(action, argparse._StoreTrueAction) and bool(value):\\n string_args.append(last_option_string)\\n elif isinstance(action, argparse._StoreAction) and action.nargs is None:\\n string_args.append(last_option_string)\\n string_args.append(str(value))\\n elif isinstance(action, argparse._StoreAction) and action.nargs in '*+':\\n string_args.append(last_option_string)\\n string_args.extend([str(v) for v in value])\\n else:\\n raise TypeError(f\\\"Don't know what to do with {action}\\\")\\n\\n return string_args\\n\\n def parse_kwargs(self, **kwargs):\\n \\\"\\\"\\\"\\n Parse kwargs, with type checking etc.\\n \\\"\\\"\\\"\\n # hack: capture any error messages without raising a SystemExit\\n def _captured_error(msg):\\n raise ValueError(msg)\\n\\n old_error = self.error\\n self.error = _captured_error\\n try:\\n string_args = self._kwargs_to_str_args(**kwargs)\\n return self.parse_args(args=string_args, print_args=False)\\n finally:\\n self.error = old_error\\n\\n def print_args(self):\\n \\\"\\\"\\\"\\n Print out all the arguments in this parser.\\n \\\"\\\"\\\"\\n if not self.opt:\\n self.parse_args(print_args=False)\\n values = {}\\n for key, value in self.opt.items():\\n values[str(key)] = str(value)\\n for group in self._action_groups:\\n group_dict = {\\n a.dest: getattr(self.args, a.dest, None) for a in group._group_actions\\n }\\n namespace = argparse.Namespace(**group_dict)\\n count = 0\\n for key in sorted(namespace.__dict__):\\n if key in values:\\n if count == 0:\\n print('[ ' + group.title + ': ] ')\\n count += 1\\n print('[ ' + key + ': ' + values[key] + ' ]')\\n\\n def set_params(self, **kwargs):\\n \\\"\\\"\\\"\\n Set overridable kwargs.\\n \\\"\\\"\\\"\\n self.set_defaults(**kwargs)\\n for k, v in kwargs.items():\\n self.overridable[k] = v\\n\\n @property\\n def show_advanced_args(self):\\n \\\"\\\"\\\"\\n Check if we should show arguments marked as hidden.\\n \\\"\\\"\\\"\\n if hasattr(self, '_show_advanced_args'):\\n return self._show_advanced_args\\n known_args, _ = self.parse_known_args(nohelp=True)\\n if hasattr(known_args, 'show_advanced_args'):\\n self._show_advanced_args = known_args.show_advanced_args\\n else:\\n self._show_advanced_args = True\\n return self._show_advanced_args\\n\\n def _handle_custom_options(self, kwargs):\\n \\\"\\\"\\\"\\n Handle custom parlai options.\\n\\n Includes hidden, recommended. Future may include no_save and no_override.\\n \\\"\\\"\\\"\\n action_attr = {}\\n if 'recommended' in kwargs:\\n rec = kwargs.pop('recommended')\\n action_attr['recommended'] = rec\\n action_attr['hidden'] = kwargs.get('hidden', False)\\n if 'hidden' in kwargs:\\n hidden = kwargs.pop('hidden')\\n if hidden:\\n kwargs['help'] = argparse.SUPPRESS\\n return kwargs, action_attr\\n\\n def add_argument(self, *args, **kwargs):\\n \\\"\\\"\\\"\\n Override to convert underscores to hyphens for consistency.\\n \\\"\\\"\\\"\\n kwargs, newattr = self._handle_custom_options(kwargs)\\n action = super().add_argument(*fix_underscores(args), **kwargs)\\n for k, v in newattr.items():\\n setattr(action, k, v)\\n return action\\n\\n def add_argument_group(self, *args, **kwargs):\\n \\\"\\\"\\\"\\n Override to make arg groups also convert underscores to hyphens.\\n \\\"\\\"\\\"\\n arg_group = super().add_argument_group(*args, **kwargs)\\n original_add_arg = arg_group.add_argument\\n\\n def ag_add_argument(*args, **kwargs):\\n kwargs, newattr = self._handle_custom_options(kwargs)\\n action = original_add_arg(*fix_underscores(args), **kwargs)\\n for k, v in newattr.items():\\n setattr(action, k, v)\\n return action\\n\\n arg_group.add_argument = ag_add_argument # override _ => -\\n arg_group.add_argument_group = self.add_argument_group\\n return arg_group\\n\\n def error(self, message):\\n \\\"\\\"\\\"\\n Override to print custom error message.\\n \\\"\\\"\\\"\\n self.print_help()\\n _sys.stderr.write('\\\\nParse Error: %s\\\\n' % message)\\n _sys.exit(2)\\n\",\n \"path\": \"parlai/core/params.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"#!/usr/bin/env python3\n\n# Copyright (c) Facebook, Inc. and its affiliates.\n# This source code is licensed under the MIT license found in the\n# LICENSE file in the root directory of this source tree.\n\"\"\"\nProvide an argument parser and default command line options for using ParlAI.\n\"\"\"\n\nimport argparse\nimport importlib\nimport os\nimport sys as _sys\nimport datetime\nimport parlai\n\ntry:\n import git\n\n GIT_AVAILABLE = True\nexcept ImportError:\n # silence the error\n GIT_AVAILABLE = False\n\nimport parlai.utils.logging as logging\nfrom parlai.core.build_data import modelzoo_path\nfrom parlai.core.loader import load_teacher_module, load_agent_module, load_world_module\nfrom parlai.tasks.tasks import ids_to_tasks\nfrom parlai.core.opt import Opt, load_opt_file\n\nfrom typing import List, Optional\n\n\ndef print_git_commit():\n \"\"\"\n Print the current git commit of ParlAI and parlai_internal.\n \"\"\"\n root = os.path.dirname(os.path.dirname(parlai.__file__))\n internal_root = os.path.join(root, 'parlai_internal')\n try:\n git_ = git.Git(root)\n current_commit = git_.rev_parse('HEAD')\n print(f'[ Current ParlAI commit: {current_commit} ]')\n except git.GitCommandNotFound:\n pass\n except git.GitCommandError:\n pass\n\n try:\n git_ = git.Git(internal_root)\n internal_commit = git_.rev_parse('HEAD')\n print(f'[ Current internal commit: {internal_commit} ]')\n except git.GitCommandNotFound:\n pass\n except git.GitCommandError:\n pass\n\n\ndef print_announcements(opt):\n \"\"\"\n Output any announcements the ParlAI team wishes to make to users.\n\n Also gives the user the option to suppress the output.\n \"\"\"\n # no annoucements to make right now\n return\n\n noannounce_file = os.path.join(opt.get('datapath'), 'noannouncements')\n if os.path.exists(noannounce_file):\n # user has suppressed announcements, don't do anything\n return\n\n # useful constants\n # all of these colors are bolded\n RESET = '\\033[0m'\n BOLD = '\\033[1m'\n RED = '\\033[1;91m'\n YELLOW = '\\033[1;93m'\n GREEN = '\\033[1;92m'\n BLUE = '\\033[1;96m'\n CYAN = '\\033[1;94m'\n MAGENTA = '\\033[1;95m'\n\n # only use colors if we're outputting to a terminal\n USE_COLORS = _sys.stdout.isatty()\n if not USE_COLORS:\n RESET = BOLD = RED = YELLOW = GREEN = BLUE = CYAN = MAGENTA = ''\n\n # generate the rainbow stars\n rainbow = [RED, YELLOW, GREEN, CYAN, BLUE, MAGENTA]\n size = 78 // len(rainbow)\n stars = ''.join([color + '*' * size for color in rainbow])\n stars += RESET\n\n # do the actual output\n print(\n '\\n'.join(\n [\n '',\n stars,\n BOLD,\n 'Announcements go here.',\n RESET,\n # don't bold the suppression command\n 'To suppress this message (and future announcements), run\\n`touch {}`'.format(\n noannounce_file\n ),\n stars,\n ]\n )\n )\n\n\ndef get_model_name(opt):\n \"\"\"\n Get the model name from either `--model` or `--model-file`.\n \"\"\"\n model = opt.get('model', None)\n if model is None:\n # try to get model name from model opt file\n model_file = opt.get('model_file', None)\n if model_file is not None:\n model_file = modelzoo_path(opt.get('datapath'), model_file)\n optfile = model_file + '.opt'\n if os.path.isfile(optfile):\n new_opt = load_opt_file(optfile)\n model = new_opt.get('model', None)\n return model\n\n\ndef str2none(value: str):\n \"\"\"\n If the value is a variant of `none`, return None.\n\n Otherwise, return the original value.\n \"\"\"\n if value.lower() == 'none':\n return None\n else:\n return value\n\n\ndef str2bool(value):\n \"\"\"\n Convert 'yes', 'false', '1', etc.\n\n into a boolean.\n \"\"\"\n v = value.lower()\n if v in ('yes', 'true', 't', '1', 'y'):\n return True\n elif v in ('no', 'false', 'f', 'n', '0'):\n return False\n else:\n raise argparse.ArgumentTypeError('Boolean value expected.')\n\n\ndef str2floats(s):\n \"\"\"\n Look for single float or comma-separated floats.\n \"\"\"\n return tuple(float(f) for f in s.split(','))\n\n\ndef str2class(value):\n \"\"\"\n From import path string, returns the class specified.\n\n For example, the string 'parlai.agents.drqa.drqa:SimpleDictionaryAgent' returns\n <class 'parlai.agents.drqa.drqa.SimpleDictionaryAgent'>.\n \"\"\"\n if ':' not in value:\n raise RuntimeError('Use a colon before the name of the class.')\n name = value.split(':')\n module = importlib.import_module(name[0])\n return getattr(module, name[1])\n\n\ndef class2str(value):\n \"\"\"\n Inverse of params.str2class().\n \"\"\"\n s = str(value)\n s = s[s.find('\\'') + 1 : s.rfind('\\'')] # pull out import path\n s = ':'.join(s.rsplit('.', 1)) # replace last period with ':'\n return s\n\n\ndef fix_underscores(args):\n \"\"\"\n Convert underscores to hyphens in args.\n\n For example, converts '--gradient_clip' to '--gradient-clip'.\n\n :param args: iterable, possibly containing args strings with underscores.\n \"\"\"\n if args:\n new_args = []\n for a in args:\n if type(a) is str and a.startswith('-'):\n a = a.replace('_', '-')\n new_args.append(a)\n args = new_args\n return args\n\n\nclass CustomHelpFormatter(argparse.HelpFormatter):\n \"\"\"\n Produce a custom-formatted `--help` option.\n\n See https://goo.gl/DKtHb5 for details.\n \"\"\"\n\n def __init__(self, *args, **kwargs):\n kwargs['max_help_position'] = 6\n kwargs['width'] = 80\n super().__init__(*args, **kwargs)\n\n def _format_action_invocation(self, action):\n if not action.option_strings or action.nargs == 0:\n return super()._format_action_invocation(action)\n default = self._get_default_metavar_for_optional(action)\n args_string = self._format_args(action, default)\n return ', '.join(action.option_strings) + ' ' + args_string\n\n def _get_help_string(self, action):\n help = action.help\n if '%(default)' not in action.help:\n if action.default is not argparse.SUPPRESS:\n defaulting_nargs = [argparse.OPTIONAL, argparse.ZERO_OR_MORE]\n if action.option_strings or action.nargs in defaulting_nargs:\n help += ' (default: %(default)s)'\n if (\n hasattr(action, 'recommended')\n and action.recommended\n and action.recommended != action.default\n ):\n help += '(recommended: %(recommended)s)'\n help = help.replace(')(recommended', ', recommended')\n return help\n\n\nclass ParlaiParser(argparse.ArgumentParser):\n \"\"\"\n Provide an opt-producer and CLI argument parser.\n\n Pseudo-extension of ``argparse`` which sets a number of parameters\n for the ParlAI framework. More options can be added specific to other\n modules by passing this object and calling ``add_arg()`` or\n ``add_argument()`` on it.\n\n For example, see ``parlai.core.dict.DictionaryAgent.add_cmdline_args``.\n\n :param add_parlai_args:\n (default True) initializes the default arguments for ParlAI\n package, including the data download paths and task arguments.\n :param add_model_args:\n (default False) initializes the default arguments for loading\n models, including initializing arguments from that model.\n \"\"\"\n\n def __init__(\n self, add_parlai_args=True, add_model_args=False, description='ParlAI parser'\n ):\n \"\"\"\n Initialize the ParlAI argparser.\n \"\"\"\n super().__init__(\n description=description,\n allow_abbrev=False,\n conflict_handler='resolve',\n formatter_class=CustomHelpFormatter,\n add_help=add_parlai_args,\n )\n self.register('type', 'nonestr', str2none)\n self.register('type', 'bool', str2bool)\n self.register('type', 'floats', str2floats)\n self.register('type', 'class', str2class)\n self.parlai_home = os.path.dirname(\n os.path.dirname(os.path.dirname(os.path.realpath(__file__)))\n )\n os.environ['PARLAI_HOME'] = self.parlai_home\n\n self.add_arg = self.add_argument\n\n # remember which args were specified on the command line\n self.overridable = {}\n\n if add_parlai_args:\n self.add_parlai_args()\n if add_model_args:\n self.add_model_args()\n\n def add_parlai_data_path(self, argument_group=None):\n \"\"\"\n Add --datapath CLI arg.\n \"\"\"\n if argument_group is None:\n argument_group = self\n argument_group.add_argument(\n '-dp',\n '--datapath',\n default=None,\n help='path to datasets, defaults to {parlai_dir}/data',\n )\n\n def add_mturk_args(self):\n \"\"\"\n Add standard mechanical turk arguments.\n \"\"\"\n mturk = self.add_argument_group('Mechanical Turk')\n default_log_path = os.path.join(self.parlai_home, 'logs', 'mturk')\n mturk.add_argument(\n '--mturk-log-path',\n default=default_log_path,\n help='path to MTurk logs, defaults to {parlai_dir}/logs/mturk',\n )\n mturk.add_argument(\n '-t',\n '--task',\n help='MTurk task, e.g. \"qa_data_collection\" or \"model_evaluator\"',\n )\n mturk.add_argument(\n '-nc',\n '--num-conversations',\n default=1,\n type=int,\n help='number of conversations you want to create for this task',\n )\n mturk.add_argument(\n '--unique',\n dest='unique_worker',\n default=False,\n action='store_true',\n help='enforce that no worker can work on your task twice',\n )\n mturk.add_argument(\n '--max-hits-per-worker',\n dest='max_hits_per_worker',\n default=0,\n type=int,\n help='Max number of hits each worker can perform during current group run',\n )\n mturk.add_argument(\n '--unique-qual-name',\n dest='unique_qual_name',\n default=None,\n type=str,\n help='qualification name to use for uniqueness between HITs',\n )\n mturk.add_argument(\n '-r',\n '--reward',\n default=0.05,\n type=float,\n help='reward for each worker for finishing the conversation, '\n 'in US dollars',\n )\n mturk.add_argument(\n '--sandbox',\n dest='is_sandbox',\n action='store_true',\n help='submit the HITs to MTurk sandbox site',\n )\n mturk.add_argument(\n '--live',\n dest='is_sandbox',\n action='store_false',\n help='submit the HITs to MTurk live site',\n )\n mturk.add_argument(\n '--debug',\n dest='is_debug',\n action='store_true',\n help='print and log all server interactions and messages',\n )\n mturk.add_argument(\n '--verbose',\n dest='verbose',\n action='store_true',\n help='print all messages sent to and from Turkers',\n )\n mturk.add_argument(\n '--hard-block',\n dest='hard_block',\n action='store_true',\n default=False,\n help='Hard block disconnecting Turkers from all of your HITs',\n )\n mturk.add_argument(\n '--log-level',\n dest='log_level',\n type=int,\n default=20,\n help='importance level for what to put into the logs. the lower '\n 'the level the more that gets logged. values are 0-50',\n )\n mturk.add_argument(\n '--disconnect-qualification',\n dest='disconnect_qualification',\n default=None,\n help='Qualification to use for soft blocking users for '\n 'disconnects. By default '\n 'turkers are never blocked, though setting this will allow '\n 'you to filter out turkers that have disconnected too many '\n 'times on previous HITs where this qualification was set.',\n )\n mturk.add_argument(\n '--block-qualification',\n dest='block_qualification',\n default=None,\n help='Qualification to use for soft blocking users. This '\n 'qualification is granted whenever soft_block_worker is '\n 'called, and can thus be used to filter workers out from a '\n 'single task or group of tasks by noted performance.',\n )\n mturk.add_argument(\n '--count-complete',\n dest='count_complete',\n default=False,\n action='store_true',\n help='continue until the requested number of conversations are '\n 'completed rather than attempted',\n )\n mturk.add_argument(\n '--allowed-conversations',\n dest='allowed_conversations',\n default=0,\n type=int,\n help='number of concurrent conversations that one mturk worker '\n 'is able to be involved in, 0 is unlimited',\n )\n mturk.add_argument(\n '--max-connections',\n dest='max_connections',\n default=30,\n type=int,\n help='number of HITs that can be launched at the same time, 0 is '\n 'unlimited.',\n )\n mturk.add_argument(\n '--min-messages',\n dest='min_messages',\n default=0,\n type=int,\n help='number of messages required to be sent by MTurk agent when '\n 'considering whether to approve a HIT in the event of a '\n 'partner disconnect. I.e. if the number of messages '\n 'exceeds this number, the turker can submit the HIT.',\n )\n mturk.add_argument(\n '--local',\n dest='local',\n default=False,\n action='store_true',\n help='Run the server locally on this server rather than setting up'\n ' a heroku server.',\n )\n mturk.add_argument(\n '--hobby',\n dest='hobby',\n default=False,\n action='store_true',\n help='Run the heroku server on the hobby tier.',\n )\n mturk.add_argument(\n '--max-time',\n dest='max_time',\n default=0,\n type=int,\n help='Maximum number of seconds per day that a worker is allowed '\n 'to work on this assignment',\n )\n mturk.add_argument(\n '--max-time-qual',\n dest='max_time_qual',\n default=None,\n help='Qualification to use to share the maximum time requirement '\n 'with other runs from other machines.',\n )\n mturk.add_argument(\n '--heroku-team',\n dest='heroku_team',\n default=None,\n help='Specify Heroku team name to use for launching Dynos.',\n )\n mturk.add_argument(\n '--tmp-dir',\n dest='tmp_dir',\n default=None,\n help='Specify location to use for scratch builds and such.',\n )\n\n # it helps to indicate to agents that they're in interactive mode, and\n # can avoid some otherwise troublesome behavior (not having candidates,\n # sharing self.replies, etc).\n mturk.set_defaults(interactive_mode=True)\n\n mturk.set_defaults(is_sandbox=True)\n mturk.set_defaults(is_debug=False)\n mturk.set_defaults(verbose=False)\n\n def add_chatservice_args(self):\n \"\"\"\n Arguments for all chat services.\n \"\"\"\n args = self.add_argument_group('Chat Services')\n args.add_argument(\n '--debug',\n dest='is_debug',\n action='store_true',\n help='print and log all server interactions and messages',\n )\n args.add_argument(\n '--config-path',\n default=None,\n type=str,\n help='/path/to/config/file for a given task.',\n )\n args.add_argument(\n '--password',\n dest='password',\n type=str,\n default=None,\n help='Require a password for entry to the bot',\n )\n\n def add_websockets_args(self):\n \"\"\"\n Add websocket arguments.\n \"\"\"\n self.add_chatservice_args()\n websockets = self.add_argument_group('Websockets')\n websockets.add_argument(\n '--port', default=35496, type=int, help='Port to run the websocket handler'\n )\n\n def add_messenger_args(self):\n \"\"\"\n Add Facebook Messenger arguments.\n \"\"\"\n self.add_chatservice_args()\n messenger = self.add_argument_group('Facebook Messenger')\n messenger.add_argument(\n '--verbose',\n dest='verbose',\n action='store_true',\n help='print all messages sent to and from Turkers',\n )\n messenger.add_argument(\n '--log-level',\n dest='log_level',\n type=int,\n default=20,\n help='importance level for what to put into the logs. the lower '\n 'the level the more that gets logged. values are 0-50',\n )\n messenger.add_argument(\n '--force-page-token',\n dest='force_page_token',\n action='store_true',\n help='override the page token stored in the cache for a new one',\n )\n messenger.add_argument(\n '--bypass-server-setup',\n dest='bypass_server_setup',\n action='store_true',\n default=False,\n help='should bypass traditional server and socket setup',\n )\n messenger.add_argument(\n '--local',\n dest='local',\n action='store_true',\n default=False,\n help='Run the server locally on this server rather than setting up'\n ' a heroku server.',\n )\n\n messenger.set_defaults(is_debug=False)\n messenger.set_defaults(verbose=False)\n\n def add_parlai_args(self, args=None):\n \"\"\"\n Add common ParlAI args across all scripts.\n \"\"\"\n parlai = self.add_argument_group('Main ParlAI Arguments')\n parlai.add_argument(\n '-o',\n '--init-opt',\n default=None,\n help='Path to json file of options. '\n 'Note: Further Command-line arguments override file-based options.',\n )\n parlai.add_argument(\n '-v',\n '--show-advanced-args',\n action='store_true',\n help='Show hidden command line options (advanced users only)',\n )\n parlai.add_argument(\n '-t', '--task', help='ParlAI task(s), e.g. \"babi:Task1\" or \"babi,cbt\"'\n )\n parlai.add_argument(\n '--download-path',\n default=None,\n hidden=True,\n help='path for non-data dependencies to store any needed files.'\n 'defaults to {parlai_dir}/downloads',\n )\n parlai.add_argument(\n '-dt',\n '--datatype',\n default='train',\n choices=[\n 'train',\n 'train:stream',\n 'train:ordered',\n 'train:ordered:stream',\n 'train:stream:ordered',\n 'train:evalmode',\n 'train:evalmode:stream',\n 'train:evalmode:ordered',\n 'train:evalmode:ordered:stream',\n 'train:evalmode:stream:ordered',\n 'valid',\n 'valid:stream',\n 'test',\n 'test:stream',\n ],\n help='choose from: train, train:ordered, valid, test. to stream '\n 'data add \":stream\" to any option (e.g., train:stream). '\n 'by default: train is random with replacement, '\n 'valid is ordered, test is ordered.',\n )\n parlai.add_argument(\n '-im',\n '--image-mode',\n default='raw',\n type=str,\n help='image preprocessor to use. default is \"raw\". set to \"none\" '\n 'to skip image loading.',\n hidden=True,\n )\n parlai.add_argument(\n '-nt',\n '--numthreads',\n default=1,\n type=int,\n help='number of threads. Used for hogwild if batchsize is 1, else '\n 'for number of threads in threadpool loading,',\n )\n parlai.add_argument(\n '--hide-labels',\n default=False,\n type='bool',\n hidden=True,\n help='default (False) moves labels in valid and test sets to the '\n 'eval_labels field. If True, they are hidden completely.',\n )\n parlai.add_argument(\n '-mtw',\n '--multitask-weights',\n type='floats',\n default=[1],\n help='list of floats, one for each task, specifying '\n 'the probability of drawing the task in multitask case',\n hidden=True,\n )\n parlai.add_argument(\n '-bs',\n '--batchsize',\n default=1,\n type=int,\n help='batch size for minibatch training schemes',\n )\n parlai.add_argument(\n '-dynb',\n '--dynamic-batching',\n default=None,\n type='nonestr',\n choices={None, 'full', 'batchsort'},\n help='Use dynamic batching',\n )\n self.add_parlai_data_path(parlai)\n\n def add_distributed_training_args(self):\n \"\"\"\n Add CLI args for distributed training.\n \"\"\"\n grp = self.add_argument_group('Distributed Training')\n grp.add_argument(\n '--distributed-world-size', type=int, help='Number of workers.'\n )\n grp.add_argument(\n '--verbose',\n type='bool',\n default=False,\n help='All workers print output.',\n hidden=True,\n )\n return grp\n\n def add_model_args(self):\n \"\"\"\n Add arguments related to models such as model files.\n \"\"\"\n model_args = self.add_argument_group('ParlAI Model Arguments')\n model_args.add_argument(\n '-m',\n '--model',\n default=None,\n help='the model class name. can match parlai/agents/<model> for '\n 'agents in that directory, or can provide a fully specified '\n 'module for `from X import Y` via `-m X:Y` '\n '(e.g. `-m parlai.agents.seq2seq.seq2seq:Seq2SeqAgent`)',\n )\n model_args.add_argument(\n '-mf',\n '--model-file',\n default=None,\n help='model file name for loading and saving models',\n )\n model_args.add_argument(\n '-im',\n '--init-model',\n default=None,\n type=str,\n help='load model weights and dict from this file',\n )\n model_args.add_argument(\n '--dict-class', hidden=True, help='the class of the dictionary agent uses'\n )\n\n def add_model_subargs(self, model):\n \"\"\"\n Add arguments specific to a particular model.\n \"\"\"\n agent = load_agent_module(model)\n try:\n if hasattr(agent, 'add_cmdline_args'):\n agent.add_cmdline_args(self)\n except argparse.ArgumentError:\n # already added\n pass\n try:\n if hasattr(agent, 'dictionary_class'):\n s = class2str(agent.dictionary_class())\n self.set_defaults(dict_class=s)\n except argparse.ArgumentError:\n # already added\n pass\n\n def add_task_args(self, task):\n \"\"\"\n Add arguments specific to the specified task.\n \"\"\"\n for t in ids_to_tasks(task).split(','):\n agent = load_teacher_module(t)\n try:\n if hasattr(agent, 'add_cmdline_args'):\n agent.add_cmdline_args(self)\n except argparse.ArgumentError:\n # already added\n pass\n\n def add_world_args(self, task, interactive_task, selfchat_task):\n \"\"\"\n Add arguments specific to the world.\n \"\"\"\n world_class = load_world_module(\n task, interactive_task=interactive_task, selfchat_task=selfchat_task\n )\n if world_class is not None and hasattr(world_class, 'add_cmdline_args'):\n try:\n world_class.add_cmdline_args(self)\n except argparse.ArgumentError:\n # already added\n pass\n\n def add_image_args(self, image_mode):\n \"\"\"\n Add additional arguments for handling images.\n \"\"\"\n try:\n parlai = self.add_argument_group('ParlAI Image Preprocessing Arguments')\n parlai.add_argument(\n '--image-size',\n type=int,\n default=256,\n help='resizing dimension for images',\n hidden=True,\n )\n parlai.add_argument(\n '--image-cropsize',\n type=int,\n default=224,\n help='crop dimension for images',\n hidden=True,\n )\n except argparse.ArgumentError:\n # already added\n pass\n\n def add_extra_args(self, args=None):\n \"\"\"\n Add more args depending on how known args are set.\n \"\"\"\n parsed = vars(self.parse_known_args(args, nohelp=True)[0])\n # Also load extra args options if a file is given.\n if parsed.get('init_opt', None) is not None:\n self._load_known_opts(parsed.get('init_opt'), parsed)\n parsed = self._infer_datapath(parsed)\n\n # find which image mode specified if any, and add additional arguments\n image_mode = parsed.get('image_mode', None)\n if image_mode is not None and image_mode != 'no_image_model':\n self.add_image_args(image_mode)\n\n # find which task specified if any, and add its specific arguments\n task = parsed.get('task', None)\n if task is not None:\n self.add_task_args(task)\n evaltask = parsed.get('evaltask', None)\n if evaltask is not None:\n self.add_task_args(evaltask)\n\n # find which model specified if any, and add its specific arguments\n model = get_model_name(parsed)\n if model is not None:\n self.add_model_subargs(model)\n\n # add world args, if we know a priori which world is being used\n if task is not None:\n self.add_world_args(\n task,\n parsed.get('interactive_task', False),\n parsed.get('selfchat_task', False),\n )\n\n # reset parser-level defaults over any model-level defaults\n try:\n self.set_defaults(**self._defaults)\n except AttributeError:\n raise RuntimeError(\n 'Please file an issue on github that argparse '\n 'got an attribute error when parsing.'\n )\n\n def parse_known_args(self, args=None, namespace=None, nohelp=False):\n \"\"\"\n Parse known args to ignore help flag.\n \"\"\"\n if args is None:\n # args default to the system args\n args = _sys.argv[1:]\n args = fix_underscores(args)\n\n if nohelp:\n # ignore help\n args = [a for a in args if a != '-h' and a != '--help']\n return super().parse_known_args(args, namespace)\n\n def _load_known_opts(self, optfile, parsed):\n \"\"\"\n Pull in CLI args for proper models/tasks/etc.\n\n Called before args are parsed; ``_load_opts`` is used for actually overriding\n opts after they are parsed.\n \"\"\"\n new_opt = load_opt_file(optfile)\n for key, value in new_opt.items():\n # existing command line parameters take priority.\n if key not in parsed or parsed[key] is None:\n parsed[key] = value\n\n def _load_opts(self, opt):\n optfile = opt.get('init_opt')\n new_opt = load_opt_file(optfile)\n for key, value in new_opt.items():\n # existing command line parameters take priority.\n if key not in opt:\n raise RuntimeError(\n 'Trying to set opt from file that does not exist: ' + str(key)\n )\n if key not in opt['override']:\n opt[key] = value\n opt['override'][key] = value\n\n def _infer_datapath(self, opt):\n \"\"\"\n Set the value for opt['datapath'] and opt['download_path'].\n\n Sets the value for opt['datapath'] and opt['download_path'], correctly\n respecting environmental variables and the default.\n \"\"\"\n # set environment variables\n # Priority for setting the datapath (same applies for download_path):\n # --datapath -> os.environ['PARLAI_DATAPATH'] -> <self.parlai_home>/data\n if opt.get('download_path'):\n os.environ['PARLAI_DOWNPATH'] = opt['download_path']\n elif os.environ.get('PARLAI_DOWNPATH') is None:\n os.environ['PARLAI_DOWNPATH'] = os.path.join(self.parlai_home, 'downloads')\n if opt.get('datapath'):\n os.environ['PARLAI_DATAPATH'] = opt['datapath']\n elif os.environ.get('PARLAI_DATAPATH') is None:\n os.environ['PARLAI_DATAPATH'] = os.path.join(self.parlai_home, 'data')\n\n opt['download_path'] = os.environ['PARLAI_DOWNPATH']\n opt['datapath'] = os.environ['PARLAI_DATAPATH']\n\n return opt\n\n def _process_args_to_opts(self, args_that_override: Optional[List[str]] = None):\n self.opt = Opt(vars(self.args))\n\n # custom post-parsing\n self.opt['parlai_home'] = self.parlai_home\n self.opt = self._infer_datapath(self.opt)\n\n # set all arguments specified in command line as overridable\n option_strings_dict = {}\n store_true = []\n store_false = []\n for group in self._action_groups:\n for a in group._group_actions:\n if hasattr(a, 'option_strings'):\n for option in a.option_strings:\n option_strings_dict[option] = a.dest\n if '_StoreTrueAction' in str(type(a)):\n store_true.append(option)\n elif '_StoreFalseAction' in str(type(a)):\n store_false.append(option)\n\n if args_that_override is None:\n args_that_override = _sys.argv[1:]\n\n for i in range(len(args_that_override)):\n if args_that_override[i] in option_strings_dict:\n if args_that_override[i] in store_true:\n self.overridable[option_strings_dict[args_that_override[i]]] = True\n elif args_that_override[i] in store_false:\n self.overridable[option_strings_dict[args_that_override[i]]] = False\n elif (\n i < len(args_that_override) - 1\n and args_that_override[i + 1][:1] != '-'\n ):\n key = option_strings_dict[args_that_override[i]]\n self.overridable[key] = self.opt[key]\n self.opt['override'] = self.overridable\n\n # load opts if a file is provided.\n if self.opt.get('init_opt', None) is not None:\n self._load_opts(self.opt)\n\n # map filenames that start with 'zoo:' to point to the model zoo dir\n options_to_change = {'model_file', 'dict_file', 'bpe_vocab', 'bpe_merge'}\n for each_key in options_to_change:\n if self.opt.get(each_key) is not None:\n self.opt[each_key] = modelzoo_path(\n self.opt.get('datapath'), self.opt[each_key]\n )\n if self.opt['override'].get(each_key) is not None:\n # also check override\n self.opt['override'][each_key] = modelzoo_path(\n self.opt.get('datapath'), self.opt['override'][each_key]\n )\n\n # add start time of an experiment\n self.opt['starttime'] = datetime.datetime.today().strftime('%b%d_%H-%M')\n\n def parse_and_process_known_args(self, args=None):\n \"\"\"\n Parse provided arguments and return parlai opts and unknown arg list.\n\n Runs the same arg->opt parsing that parse_args does, but doesn't throw an error\n if the args being parsed include additional command line arguments that parlai\n doesn't know what to do with.\n \"\"\"\n self.args, unknowns = super().parse_known_args(args=args)\n self._process_args_to_opts(args)\n return self.opt, unknowns\n\n def parse_args(self, args=None, namespace=None, print_args=True):\n \"\"\"\n Parse the provided arguments and returns a dictionary of the ``args``.\n\n We specifically remove items with ``None`` as values in order to support the\n style ``opt.get(key, default)``, which would otherwise return ``None``.\n \"\"\"\n self.add_extra_args(args)\n self.args = super().parse_args(args=args)\n\n self._process_args_to_opts(args)\n\n if print_args:\n self.print_args()\n if GIT_AVAILABLE:\n print_git_commit()\n print_announcements(self.opt)\n\n if os.environ.get('PARLAI_VERBOSE'):\n self.opt['verbose'] = True\n\n if self.opt.get('verbose'):\n logging.set_verbose_mode()\n\n return self.opt\n\n def _kwargs_to_str_args(self, **kwargs):\n \"\"\"\n Attempt to map from python-code kwargs into CLI args.\n\n e.g. model_file -> --model-file.\n\n Works with short options too, like t=\"convai2\".\n \"\"\"\n\n # we have to do this large block of repetitive code twice, the first\n # round is basically just to become aware of anything that would have\n # been added by add_extra_args\n kwname_to_action = {}\n for action in self._actions:\n if action.dest == 'help':\n # no help allowed\n continue\n for option_string in action.option_strings:\n kwname = option_string.lstrip('-').replace('-', '_')\n assert (kwname not in kwname_to_action) or (\n kwname_to_action[kwname] is action\n ), f\"No duplicate names! ({kwname}, {kwname_to_action[kwname]}, {action})\"\n kwname_to_action[kwname] = action\n\n string_args = []\n for kwname, value in kwargs.items():\n if kwname not in kwname_to_action:\n # best guess, we need to delay it. hopefully this gets added\n # during add_kw_Args\n continue\n action = kwname_to_action[kwname]\n last_option_string = action.option_strings[-1]\n if isinstance(action, argparse._StoreTrueAction) and bool(value):\n string_args.append(last_option_string)\n elif isinstance(action, argparse._StoreAction) and action.nargs is None:\n string_args.append(last_option_string)\n string_args.append(str(value))\n elif isinstance(action, argparse._StoreAction) and action.nargs in '*+':\n string_args.append(last_option_string)\n string_args.extend([str(v) for v in value])\n else:\n raise TypeError(f\"Don't know what to do with {action}\")\n\n # become aware of any extra args that might be specified if the user\n # provides something like model=\"transformer/generator\".\n self.add_extra_args(string_args)\n\n # do it again, this time knowing about ALL args.\n kwname_to_action = {}\n for action in self._actions:\n if action.dest == 'help':\n # no help allowed\n continue\n for option_string in action.option_strings:\n kwname = option_string.lstrip('-').replace('-', '_')\n assert (kwname not in kwname_to_action) or (\n kwname_to_action[kwname] is action\n ), f\"No duplicate names! ({kwname}, {kwname_to_action[kwname]}, {action})\"\n kwname_to_action[kwname] = action\n\n string_args = []\n for kwname, value in kwargs.items():\n # note we don't have the if kwname not in kwname_to_action here.\n # it MUST appear, or else we legitimately should be throwing a KeyError\n # because user has provided an unspecified option\n action = kwname_to_action[kwname]\n last_option_string = action.option_strings[-1]\n if isinstance(action, argparse._StoreTrueAction) and bool(value):\n string_args.append(last_option_string)\n elif isinstance(action, argparse._StoreAction) and action.nargs is None:\n string_args.append(last_option_string)\n string_args.append(str(value))\n elif isinstance(action, argparse._StoreAction) and action.nargs in '*+':\n string_args.append(last_option_string)\n string_args.extend([str(v) for v in value])\n else:\n raise TypeError(f\"Don't know what to do with {action}\")\n\n return string_args\n\n def parse_kwargs(self, **kwargs):\n \"\"\"\n Parse kwargs, with type checking etc.\n \"\"\"\n # hack: capture any error messages without raising a SystemExit\n def _captured_error(msg):\n raise ValueError(msg)\n\n old_error = self.error\n self.error = _captured_error\n try:\n string_args = self._kwargs_to_str_args(**kwargs)\n return self.parse_args(args=string_args, print_args=False)\n finally:\n self.error = old_error\n\n def print_args(self):\n \"\"\"\n Print out all the arguments in this parser.\n \"\"\"\n if not self.opt:\n self.parse_args(print_args=False)\n values = {}\n for key, value in self.opt.items():\n values[str(key)] = str(value)\n for group in self._action_groups:\n group_dict = {\n a.dest: getattr(self.args, a.dest, None) for a in group._group_actions\n }\n namespace = argparse.Namespace(**group_dict)\n count = 0\n for key in sorted(namespace.__dict__):\n if key in values:\n if count == 0:\n print('[ ' + group.title + ': ] ')\n count += 1\n print('[ ' + key + ': ' + values[key] + ' ]')\n\n def set_params(self, **kwargs):\n \"\"\"\n Set overridable kwargs.\n \"\"\"\n self.set_defaults(**kwargs)\n for k, v in kwargs.items():\n self.overridable[k] = v\n\n @property\n def show_advanced_args(self):\n \"\"\"\n Check if we should show arguments marked as hidden.\n \"\"\"\n if hasattr(self, '_show_advanced_args'):\n return self._show_advanced_args\n known_args, _ = self.parse_known_args(nohelp=True)\n if hasattr(known_args, 'show_advanced_args'):\n self._show_advanced_args = known_args.show_advanced_args\n else:\n self._show_advanced_args = True\n return self._show_advanced_args\n\n def _handle_custom_options(self, kwargs):\n \"\"\"\n Handle custom parlai options.\n\n Includes hidden, recommended. Future may include no_save and no_override.\n \"\"\"\n action_attr = {}\n if 'recommended' in kwargs:\n rec = kwargs.pop('recommended')\n action_attr['recommended'] = rec\n action_attr['hidden'] = kwargs.get('hidden', False)\n if 'hidden' in kwargs:\n hidden = kwargs.pop('hidden')\n if hidden:\n kwargs['help'] = argparse.SUPPRESS\n if 'type' in kwargs and kwargs['type'] is bool:\n # common error, we really want simple form\n kwargs['type'] = 'bool'\n return kwargs, action_attr\n\n def add_argument(self, *args, **kwargs):\n \"\"\"\n Override to convert underscores to hyphens for consistency.\n \"\"\"\n kwargs, newattr = self._handle_custom_options(kwargs)\n action = super().add_argument(*fix_underscores(args), **kwargs)\n for k, v in newattr.items():\n setattr(action, k, v)\n return action\n\n def add_argument_group(self, *args, **kwargs):\n \"\"\"\n Override to make arg groups also convert underscores to hyphens.\n \"\"\"\n arg_group = super().add_argument_group(*args, **kwargs)\n original_add_arg = arg_group.add_argument\n\n def ag_add_argument(*args, **kwargs):\n kwargs, newattr = self._handle_custom_options(kwargs)\n action = original_add_arg(*fix_underscores(args), **kwargs)\n for k, v in newattr.items():\n setattr(action, k, v)\n return action\n\n arg_group.add_argument = ag_add_argument # override _ => -\n arg_group.add_argument_group = self.add_argument_group\n return arg_group\n\n def error(self, message):\n \"\"\"\n Override to print custom error message.\n \"\"\"\n self.print_help()\n _sys.stderr.write('\\nParse Error: %s\\n' % message)\n _sys.exit(2)\n","path":"parlai/core/params.py"}],"string":"[\n {\n \"content\": \"#!/usr/bin/env python3\\n\\n# Copyright (c) Facebook, Inc. and its affiliates.\\n# This source code is licensed under the MIT license found in the\\n# LICENSE file in the root directory of this source tree.\\n\\\"\\\"\\\"\\nProvide an argument parser and default command line options for using ParlAI.\\n\\\"\\\"\\\"\\n\\nimport argparse\\nimport importlib\\nimport os\\nimport sys as _sys\\nimport datetime\\nimport parlai\\n\\ntry:\\n import git\\n\\n GIT_AVAILABLE = True\\nexcept ImportError:\\n # silence the error\\n GIT_AVAILABLE = False\\n\\nimport parlai.utils.logging as logging\\nfrom parlai.core.build_data import modelzoo_path\\nfrom parlai.core.loader import load_teacher_module, load_agent_module, load_world_module\\nfrom parlai.tasks.tasks import ids_to_tasks\\nfrom parlai.core.opt import Opt, load_opt_file\\n\\nfrom typing import List, Optional\\n\\n\\ndef print_git_commit():\\n \\\"\\\"\\\"\\n Print the current git commit of ParlAI and parlai_internal.\\n \\\"\\\"\\\"\\n root = os.path.dirname(os.path.dirname(parlai.__file__))\\n internal_root = os.path.join(root, 'parlai_internal')\\n try:\\n git_ = git.Git(root)\\n current_commit = git_.rev_parse('HEAD')\\n print(f'[ Current ParlAI commit: {current_commit} ]')\\n except git.GitCommandNotFound:\\n pass\\n except git.GitCommandError:\\n pass\\n\\n try:\\n git_ = git.Git(internal_root)\\n internal_commit = git_.rev_parse('HEAD')\\n print(f'[ Current internal commit: {internal_commit} ]')\\n except git.GitCommandNotFound:\\n pass\\n except git.GitCommandError:\\n pass\\n\\n\\ndef print_announcements(opt):\\n \\\"\\\"\\\"\\n Output any announcements the ParlAI team wishes to make to users.\\n\\n Also gives the user the option to suppress the output.\\n \\\"\\\"\\\"\\n # no annoucements to make right now\\n return\\n\\n noannounce_file = os.path.join(opt.get('datapath'), 'noannouncements')\\n if os.path.exists(noannounce_file):\\n # user has suppressed announcements, don't do anything\\n return\\n\\n # useful constants\\n # all of these colors are bolded\\n RESET = '\\\\033[0m'\\n BOLD = '\\\\033[1m'\\n RED = '\\\\033[1;91m'\\n YELLOW = '\\\\033[1;93m'\\n GREEN = '\\\\033[1;92m'\\n BLUE = '\\\\033[1;96m'\\n CYAN = '\\\\033[1;94m'\\n MAGENTA = '\\\\033[1;95m'\\n\\n # only use colors if we're outputting to a terminal\\n USE_COLORS = _sys.stdout.isatty()\\n if not USE_COLORS:\\n RESET = BOLD = RED = YELLOW = GREEN = BLUE = CYAN = MAGENTA = ''\\n\\n # generate the rainbow stars\\n rainbow = [RED, YELLOW, GREEN, CYAN, BLUE, MAGENTA]\\n size = 78 // len(rainbow)\\n stars = ''.join([color + '*' * size for color in rainbow])\\n stars += RESET\\n\\n # do the actual output\\n print(\\n '\\\\n'.join(\\n [\\n '',\\n stars,\\n BOLD,\\n 'Announcements go here.',\\n RESET,\\n # don't bold the suppression command\\n 'To suppress this message (and future announcements), run\\\\n`touch {}`'.format(\\n noannounce_file\\n ),\\n stars,\\n ]\\n )\\n )\\n\\n\\ndef get_model_name(opt):\\n \\\"\\\"\\\"\\n Get the model name from either `--model` or `--model-file`.\\n \\\"\\\"\\\"\\n model = opt.get('model', None)\\n if model is None:\\n # try to get model name from model opt file\\n model_file = opt.get('model_file', None)\\n if model_file is not None:\\n model_file = modelzoo_path(opt.get('datapath'), model_file)\\n optfile = model_file + '.opt'\\n if os.path.isfile(optfile):\\n new_opt = load_opt_file(optfile)\\n model = new_opt.get('model', None)\\n return model\\n\\n\\ndef str2none(value: str):\\n \\\"\\\"\\\"\\n If the value is a variant of `none`, return None.\\n\\n Otherwise, return the original value.\\n \\\"\\\"\\\"\\n if value.lower() == 'none':\\n return None\\n else:\\n return value\\n\\n\\ndef str2bool(value):\\n \\\"\\\"\\\"\\n Convert 'yes', 'false', '1', etc.\\n\\n into a boolean.\\n \\\"\\\"\\\"\\n v = value.lower()\\n if v in ('yes', 'true', 't', '1', 'y'):\\n return True\\n elif v in ('no', 'false', 'f', 'n', '0'):\\n return False\\n else:\\n raise argparse.ArgumentTypeError('Boolean value expected.')\\n\\n\\ndef str2floats(s):\\n \\\"\\\"\\\"\\n Look for single float or comma-separated floats.\\n \\\"\\\"\\\"\\n return tuple(float(f) for f in s.split(','))\\n\\n\\ndef str2class(value):\\n \\\"\\\"\\\"\\n From import path string, returns the class specified.\\n\\n For example, the string 'parlai.agents.drqa.drqa:SimpleDictionaryAgent' returns\\n <class 'parlai.agents.drqa.drqa.SimpleDictionaryAgent'>.\\n \\\"\\\"\\\"\\n if ':' not in value:\\n raise RuntimeError('Use a colon before the name of the class.')\\n name = value.split(':')\\n module = importlib.import_module(name[0])\\n return getattr(module, name[1])\\n\\n\\ndef class2str(value):\\n \\\"\\\"\\\"\\n Inverse of params.str2class().\\n \\\"\\\"\\\"\\n s = str(value)\\n s = s[s.find('\\\\'') + 1 : s.rfind('\\\\'')] # pull out import path\\n s = ':'.join(s.rsplit('.', 1)) # replace last period with ':'\\n return s\\n\\n\\ndef fix_underscores(args):\\n \\\"\\\"\\\"\\n Convert underscores to hyphens in args.\\n\\n For example, converts '--gradient_clip' to '--gradient-clip'.\\n\\n :param args: iterable, possibly containing args strings with underscores.\\n \\\"\\\"\\\"\\n if args:\\n new_args = []\\n for a in args:\\n if type(a) is str and a.startswith('-'):\\n a = a.replace('_', '-')\\n new_args.append(a)\\n args = new_args\\n return args\\n\\n\\nclass CustomHelpFormatter(argparse.HelpFormatter):\\n \\\"\\\"\\\"\\n Produce a custom-formatted `--help` option.\\n\\n See https://goo.gl/DKtHb5 for details.\\n \\\"\\\"\\\"\\n\\n def __init__(self, *args, **kwargs):\\n kwargs['max_help_position'] = 6\\n kwargs['width'] = 80\\n super().__init__(*args, **kwargs)\\n\\n def _format_action_invocation(self, action):\\n if not action.option_strings or action.nargs == 0:\\n return super()._format_action_invocation(action)\\n default = self._get_default_metavar_for_optional(action)\\n args_string = self._format_args(action, default)\\n return ', '.join(action.option_strings) + ' ' + args_string\\n\\n def _get_help_string(self, action):\\n help = action.help\\n if '%(default)' not in action.help:\\n if action.default is not argparse.SUPPRESS:\\n defaulting_nargs = [argparse.OPTIONAL, argparse.ZERO_OR_MORE]\\n if action.option_strings or action.nargs in defaulting_nargs:\\n help += ' (default: %(default)s)'\\n if (\\n hasattr(action, 'recommended')\\n and action.recommended\\n and action.recommended != action.default\\n ):\\n help += '(recommended: %(recommended)s)'\\n help = help.replace(')(recommended', ', recommended')\\n return help\\n\\n\\nclass ParlaiParser(argparse.ArgumentParser):\\n \\\"\\\"\\\"\\n Provide an opt-producer and CLI argument parser.\\n\\n Pseudo-extension of ``argparse`` which sets a number of parameters\\n for the ParlAI framework. More options can be added specific to other\\n modules by passing this object and calling ``add_arg()`` or\\n ``add_argument()`` on it.\\n\\n For example, see ``parlai.core.dict.DictionaryAgent.add_cmdline_args``.\\n\\n :param add_parlai_args:\\n (default True) initializes the default arguments for ParlAI\\n package, including the data download paths and task arguments.\\n :param add_model_args:\\n (default False) initializes the default arguments for loading\\n models, including initializing arguments from that model.\\n \\\"\\\"\\\"\\n\\n def __init__(\\n self, add_parlai_args=True, add_model_args=False, description='ParlAI parser'\\n ):\\n \\\"\\\"\\\"\\n Initialize the ParlAI argparser.\\n \\\"\\\"\\\"\\n super().__init__(\\n description=description,\\n allow_abbrev=False,\\n conflict_handler='resolve',\\n formatter_class=CustomHelpFormatter,\\n add_help=add_parlai_args,\\n )\\n self.register('type', 'nonestr', str2none)\\n self.register('type', 'bool', str2bool)\\n self.register('type', 'floats', str2floats)\\n self.register('type', 'class', str2class)\\n self.parlai_home = os.path.dirname(\\n os.path.dirname(os.path.dirname(os.path.realpath(__file__)))\\n )\\n os.environ['PARLAI_HOME'] = self.parlai_home\\n\\n self.add_arg = self.add_argument\\n\\n # remember which args were specified on the command line\\n self.overridable = {}\\n\\n if add_parlai_args:\\n self.add_parlai_args()\\n if add_model_args:\\n self.add_model_args()\\n\\n def add_parlai_data_path(self, argument_group=None):\\n \\\"\\\"\\\"\\n Add --datapath CLI arg.\\n \\\"\\\"\\\"\\n if argument_group is None:\\n argument_group = self\\n argument_group.add_argument(\\n '-dp',\\n '--datapath',\\n default=None,\\n help='path to datasets, defaults to {parlai_dir}/data',\\n )\\n\\n def add_mturk_args(self):\\n \\\"\\\"\\\"\\n Add standard mechanical turk arguments.\\n \\\"\\\"\\\"\\n mturk = self.add_argument_group('Mechanical Turk')\\n default_log_path = os.path.join(self.parlai_home, 'logs', 'mturk')\\n mturk.add_argument(\\n '--mturk-log-path',\\n default=default_log_path,\\n help='path to MTurk logs, defaults to {parlai_dir}/logs/mturk',\\n )\\n mturk.add_argument(\\n '-t',\\n '--task',\\n help='MTurk task, e.g. \\\"qa_data_collection\\\" or \\\"model_evaluator\\\"',\\n )\\n mturk.add_argument(\\n '-nc',\\n '--num-conversations',\\n default=1,\\n type=int,\\n help='number of conversations you want to create for this task',\\n )\\n mturk.add_argument(\\n '--unique',\\n dest='unique_worker',\\n default=False,\\n action='store_true',\\n help='enforce that no worker can work on your task twice',\\n )\\n mturk.add_argument(\\n '--max-hits-per-worker',\\n dest='max_hits_per_worker',\\n default=0,\\n type=int,\\n help='Max number of hits each worker can perform during current group run',\\n )\\n mturk.add_argument(\\n '--unique-qual-name',\\n dest='unique_qual_name',\\n default=None,\\n type=str,\\n help='qualification name to use for uniqueness between HITs',\\n )\\n mturk.add_argument(\\n '-r',\\n '--reward',\\n default=0.05,\\n type=float,\\n help='reward for each worker for finishing the conversation, '\\n 'in US dollars',\\n )\\n mturk.add_argument(\\n '--sandbox',\\n dest='is_sandbox',\\n action='store_true',\\n help='submit the HITs to MTurk sandbox site',\\n )\\n mturk.add_argument(\\n '--live',\\n dest='is_sandbox',\\n action='store_false',\\n help='submit the HITs to MTurk live site',\\n )\\n mturk.add_argument(\\n '--debug',\\n dest='is_debug',\\n action='store_true',\\n help='print and log all server interactions and messages',\\n )\\n mturk.add_argument(\\n '--verbose',\\n dest='verbose',\\n action='store_true',\\n help='print all messages sent to and from Turkers',\\n )\\n mturk.add_argument(\\n '--hard-block',\\n dest='hard_block',\\n action='store_true',\\n default=False,\\n help='Hard block disconnecting Turkers from all of your HITs',\\n )\\n mturk.add_argument(\\n '--log-level',\\n dest='log_level',\\n type=int,\\n default=20,\\n help='importance level for what to put into the logs. the lower '\\n 'the level the more that gets logged. values are 0-50',\\n )\\n mturk.add_argument(\\n '--disconnect-qualification',\\n dest='disconnect_qualification',\\n default=None,\\n help='Qualification to use for soft blocking users for '\\n 'disconnects. By default '\\n 'turkers are never blocked, though setting this will allow '\\n 'you to filter out turkers that have disconnected too many '\\n 'times on previous HITs where this qualification was set.',\\n )\\n mturk.add_argument(\\n '--block-qualification',\\n dest='block_qualification',\\n default=None,\\n help='Qualification to use for soft blocking users. This '\\n 'qualification is granted whenever soft_block_worker is '\\n 'called, and can thus be used to filter workers out from a '\\n 'single task or group of tasks by noted performance.',\\n )\\n mturk.add_argument(\\n '--count-complete',\\n dest='count_complete',\\n default=False,\\n action='store_true',\\n help='continue until the requested number of conversations are '\\n 'completed rather than attempted',\\n )\\n mturk.add_argument(\\n '--allowed-conversations',\\n dest='allowed_conversations',\\n default=0,\\n type=int,\\n help='number of concurrent conversations that one mturk worker '\\n 'is able to be involved in, 0 is unlimited',\\n )\\n mturk.add_argument(\\n '--max-connections',\\n dest='max_connections',\\n default=30,\\n type=int,\\n help='number of HITs that can be launched at the same time, 0 is '\\n 'unlimited.',\\n )\\n mturk.add_argument(\\n '--min-messages',\\n dest='min_messages',\\n default=0,\\n type=int,\\n help='number of messages required to be sent by MTurk agent when '\\n 'considering whether to approve a HIT in the event of a '\\n 'partner disconnect. I.e. if the number of messages '\\n 'exceeds this number, the turker can submit the HIT.',\\n )\\n mturk.add_argument(\\n '--local',\\n dest='local',\\n default=False,\\n action='store_true',\\n help='Run the server locally on this server rather than setting up'\\n ' a heroku server.',\\n )\\n mturk.add_argument(\\n '--hobby',\\n dest='hobby',\\n default=False,\\n action='store_true',\\n help='Run the heroku server on the hobby tier.',\\n )\\n mturk.add_argument(\\n '--max-time',\\n dest='max_time',\\n default=0,\\n type=int,\\n help='Maximum number of seconds per day that a worker is allowed '\\n 'to work on this assignment',\\n )\\n mturk.add_argument(\\n '--max-time-qual',\\n dest='max_time_qual',\\n default=None,\\n help='Qualification to use to share the maximum time requirement '\\n 'with other runs from other machines.',\\n )\\n mturk.add_argument(\\n '--heroku-team',\\n dest='heroku_team',\\n default=None,\\n help='Specify Heroku team name to use for launching Dynos.',\\n )\\n mturk.add_argument(\\n '--tmp-dir',\\n dest='tmp_dir',\\n default=None,\\n help='Specify location to use for scratch builds and such.',\\n )\\n\\n # it helps to indicate to agents that they're in interactive mode, and\\n # can avoid some otherwise troublesome behavior (not having candidates,\\n # sharing self.replies, etc).\\n mturk.set_defaults(interactive_mode=True)\\n\\n mturk.set_defaults(is_sandbox=True)\\n mturk.set_defaults(is_debug=False)\\n mturk.set_defaults(verbose=False)\\n\\n def add_chatservice_args(self):\\n \\\"\\\"\\\"\\n Arguments for all chat services.\\n \\\"\\\"\\\"\\n args = self.add_argument_group('Chat Services')\\n args.add_argument(\\n '--debug',\\n dest='is_debug',\\n action='store_true',\\n help='print and log all server interactions and messages',\\n )\\n args.add_argument(\\n '--config-path',\\n default=None,\\n type=str,\\n help='/path/to/config/file for a given task.',\\n )\\n args.add_argument(\\n '--password',\\n dest='password',\\n type=str,\\n default=None,\\n help='Require a password for entry to the bot',\\n )\\n\\n def add_websockets_args(self):\\n \\\"\\\"\\\"\\n Add websocket arguments.\\n \\\"\\\"\\\"\\n self.add_chatservice_args()\\n websockets = self.add_argument_group('Websockets')\\n websockets.add_argument(\\n '--port', default=35496, type=int, help='Port to run the websocket handler'\\n )\\n\\n def add_messenger_args(self):\\n \\\"\\\"\\\"\\n Add Facebook Messenger arguments.\\n \\\"\\\"\\\"\\n self.add_chatservice_args()\\n messenger = self.add_argument_group('Facebook Messenger')\\n messenger.add_argument(\\n '--verbose',\\n dest='verbose',\\n action='store_true',\\n help='print all messages sent to and from Turkers',\\n )\\n messenger.add_argument(\\n '--log-level',\\n dest='log_level',\\n type=int,\\n default=20,\\n help='importance level for what to put into the logs. the lower '\\n 'the level the more that gets logged. values are 0-50',\\n )\\n messenger.add_argument(\\n '--force-page-token',\\n dest='force_page_token',\\n action='store_true',\\n help='override the page token stored in the cache for a new one',\\n )\\n messenger.add_argument(\\n '--bypass-server-setup',\\n dest='bypass_server_setup',\\n action='store_true',\\n default=False,\\n help='should bypass traditional server and socket setup',\\n )\\n messenger.add_argument(\\n '--local',\\n dest='local',\\n action='store_true',\\n default=False,\\n help='Run the server locally on this server rather than setting up'\\n ' a heroku server.',\\n )\\n\\n messenger.set_defaults(is_debug=False)\\n messenger.set_defaults(verbose=False)\\n\\n def add_parlai_args(self, args=None):\\n \\\"\\\"\\\"\\n Add common ParlAI args across all scripts.\\n \\\"\\\"\\\"\\n parlai = self.add_argument_group('Main ParlAI Arguments')\\n parlai.add_argument(\\n '-o',\\n '--init-opt',\\n default=None,\\n help='Path to json file of options. '\\n 'Note: Further Command-line arguments override file-based options.',\\n )\\n parlai.add_argument(\\n '-v',\\n '--show-advanced-args',\\n action='store_true',\\n help='Show hidden command line options (advanced users only)',\\n )\\n parlai.add_argument(\\n '-t', '--task', help='ParlAI task(s), e.g. \\\"babi:Task1\\\" or \\\"babi,cbt\\\"'\\n )\\n parlai.add_argument(\\n '--download-path',\\n default=None,\\n hidden=True,\\n help='path for non-data dependencies to store any needed files.'\\n 'defaults to {parlai_dir}/downloads',\\n )\\n parlai.add_argument(\\n '-dt',\\n '--datatype',\\n default='train',\\n choices=[\\n 'train',\\n 'train:stream',\\n 'train:ordered',\\n 'train:ordered:stream',\\n 'train:stream:ordered',\\n 'train:evalmode',\\n 'train:evalmode:stream',\\n 'train:evalmode:ordered',\\n 'train:evalmode:ordered:stream',\\n 'train:evalmode:stream:ordered',\\n 'valid',\\n 'valid:stream',\\n 'test',\\n 'test:stream',\\n ],\\n help='choose from: train, train:ordered, valid, test. to stream '\\n 'data add \\\":stream\\\" to any option (e.g., train:stream). '\\n 'by default: train is random with replacement, '\\n 'valid is ordered, test is ordered.',\\n )\\n parlai.add_argument(\\n '-im',\\n '--image-mode',\\n default='raw',\\n type=str,\\n help='image preprocessor to use. default is \\\"raw\\\". set to \\\"none\\\" '\\n 'to skip image loading.',\\n hidden=True,\\n )\\n parlai.add_argument(\\n '-nt',\\n '--numthreads',\\n default=1,\\n type=int,\\n help='number of threads. Used for hogwild if batchsize is 1, else '\\n 'for number of threads in threadpool loading,',\\n )\\n parlai.add_argument(\\n '--hide-labels',\\n default=False,\\n type='bool',\\n hidden=True,\\n help='default (False) moves labels in valid and test sets to the '\\n 'eval_labels field. If True, they are hidden completely.',\\n )\\n parlai.add_argument(\\n '-mtw',\\n '--multitask-weights',\\n type='floats',\\n default=[1],\\n help='list of floats, one for each task, specifying '\\n 'the probability of drawing the task in multitask case',\\n hidden=True,\\n )\\n parlai.add_argument(\\n '-bs',\\n '--batchsize',\\n default=1,\\n type=int,\\n help='batch size for minibatch training schemes',\\n )\\n parlai.add_argument(\\n '-dynb',\\n '--dynamic-batching',\\n default=None,\\n type='nonestr',\\n choices={None, 'full', 'batchsort'},\\n help='Use dynamic batching',\\n )\\n self.add_parlai_data_path(parlai)\\n\\n def add_distributed_training_args(self):\\n \\\"\\\"\\\"\\n Add CLI args for distributed training.\\n \\\"\\\"\\\"\\n grp = self.add_argument_group('Distributed Training')\\n grp.add_argument(\\n '--distributed-world-size', type=int, help='Number of workers.'\\n )\\n grp.add_argument(\\n '--verbose',\\n type='bool',\\n default=False,\\n help='All workers print output.',\\n hidden=True,\\n )\\n return grp\\n\\n def add_model_args(self):\\n \\\"\\\"\\\"\\n Add arguments related to models such as model files.\\n \\\"\\\"\\\"\\n model_args = self.add_argument_group('ParlAI Model Arguments')\\n model_args.add_argument(\\n '-m',\\n '--model',\\n default=None,\\n help='the model class name. can match parlai/agents/<model> for '\\n 'agents in that directory, or can provide a fully specified '\\n 'module for `from X import Y` via `-m X:Y` '\\n '(e.g. `-m parlai.agents.seq2seq.seq2seq:Seq2SeqAgent`)',\\n )\\n model_args.add_argument(\\n '-mf',\\n '--model-file',\\n default=None,\\n help='model file name for loading and saving models',\\n )\\n model_args.add_argument(\\n '-im',\\n '--init-model',\\n default=None,\\n type=str,\\n help='load model weights and dict from this file',\\n )\\n model_args.add_argument(\\n '--dict-class', hidden=True, help='the class of the dictionary agent uses'\\n )\\n\\n def add_model_subargs(self, model):\\n \\\"\\\"\\\"\\n Add arguments specific to a particular model.\\n \\\"\\\"\\\"\\n agent = load_agent_module(model)\\n try:\\n if hasattr(agent, 'add_cmdline_args'):\\n agent.add_cmdline_args(self)\\n except argparse.ArgumentError:\\n # already added\\n pass\\n try:\\n if hasattr(agent, 'dictionary_class'):\\n s = class2str(agent.dictionary_class())\\n self.set_defaults(dict_class=s)\\n except argparse.ArgumentError:\\n # already added\\n pass\\n\\n def add_task_args(self, task):\\n \\\"\\\"\\\"\\n Add arguments specific to the specified task.\\n \\\"\\\"\\\"\\n for t in ids_to_tasks(task).split(','):\\n agent = load_teacher_module(t)\\n try:\\n if hasattr(agent, 'add_cmdline_args'):\\n agent.add_cmdline_args(self)\\n except argparse.ArgumentError:\\n # already added\\n pass\\n\\n def add_world_args(self, task, interactive_task, selfchat_task):\\n \\\"\\\"\\\"\\n Add arguments specific to the world.\\n \\\"\\\"\\\"\\n world_class = load_world_module(\\n task, interactive_task=interactive_task, selfchat_task=selfchat_task\\n )\\n if world_class is not None and hasattr(world_class, 'add_cmdline_args'):\\n try:\\n world_class.add_cmdline_args(self)\\n except argparse.ArgumentError:\\n # already added\\n pass\\n\\n def add_image_args(self, image_mode):\\n \\\"\\\"\\\"\\n Add additional arguments for handling images.\\n \\\"\\\"\\\"\\n try:\\n parlai = self.add_argument_group('ParlAI Image Preprocessing Arguments')\\n parlai.add_argument(\\n '--image-size',\\n type=int,\\n default=256,\\n help='resizing dimension for images',\\n hidden=True,\\n )\\n parlai.add_argument(\\n '--image-cropsize',\\n type=int,\\n default=224,\\n help='crop dimension for images',\\n hidden=True,\\n )\\n except argparse.ArgumentError:\\n # already added\\n pass\\n\\n def add_extra_args(self, args=None):\\n \\\"\\\"\\\"\\n Add more args depending on how known args are set.\\n \\\"\\\"\\\"\\n parsed = vars(self.parse_known_args(args, nohelp=True)[0])\\n # Also load extra args options if a file is given.\\n if parsed.get('init_opt', None) is not None:\\n self._load_known_opts(parsed.get('init_opt'), parsed)\\n parsed = self._infer_datapath(parsed)\\n\\n # find which image mode specified if any, and add additional arguments\\n image_mode = parsed.get('image_mode', None)\\n if image_mode is not None and image_mode != 'no_image_model':\\n self.add_image_args(image_mode)\\n\\n # find which task specified if any, and add its specific arguments\\n task = parsed.get('task', None)\\n if task is not None:\\n self.add_task_args(task)\\n evaltask = parsed.get('evaltask', None)\\n if evaltask is not None:\\n self.add_task_args(evaltask)\\n\\n # find which model specified if any, and add its specific arguments\\n model = get_model_name(parsed)\\n if model is not None:\\n self.add_model_subargs(model)\\n\\n # add world args, if we know a priori which world is being used\\n if task is not None:\\n self.add_world_args(\\n task,\\n parsed.get('interactive_task', False),\\n parsed.get('selfchat_task', False),\\n )\\n\\n # reset parser-level defaults over any model-level defaults\\n try:\\n self.set_defaults(**self._defaults)\\n except AttributeError:\\n raise RuntimeError(\\n 'Please file an issue on github that argparse '\\n 'got an attribute error when parsing.'\\n )\\n\\n def parse_known_args(self, args=None, namespace=None, nohelp=False):\\n \\\"\\\"\\\"\\n Parse known args to ignore help flag.\\n \\\"\\\"\\\"\\n if args is None:\\n # args default to the system args\\n args = _sys.argv[1:]\\n args = fix_underscores(args)\\n\\n if nohelp:\\n # ignore help\\n args = [a for a in args if a != '-h' and a != '--help']\\n return super().parse_known_args(args, namespace)\\n\\n def _load_known_opts(self, optfile, parsed):\\n \\\"\\\"\\\"\\n Pull in CLI args for proper models/tasks/etc.\\n\\n Called before args are parsed; ``_load_opts`` is used for actually overriding\\n opts after they are parsed.\\n \\\"\\\"\\\"\\n new_opt = load_opt_file(optfile)\\n for key, value in new_opt.items():\\n # existing command line parameters take priority.\\n if key not in parsed or parsed[key] is None:\\n parsed[key] = value\\n\\n def _load_opts(self, opt):\\n optfile = opt.get('init_opt')\\n new_opt = load_opt_file(optfile)\\n for key, value in new_opt.items():\\n # existing command line parameters take priority.\\n if key not in opt:\\n raise RuntimeError(\\n 'Trying to set opt from file that does not exist: ' + str(key)\\n )\\n if key not in opt['override']:\\n opt[key] = value\\n opt['override'][key] = value\\n\\n def _infer_datapath(self, opt):\\n \\\"\\\"\\\"\\n Set the value for opt['datapath'] and opt['download_path'].\\n\\n Sets the value for opt['datapath'] and opt['download_path'], correctly\\n respecting environmental variables and the default.\\n \\\"\\\"\\\"\\n # set environment variables\\n # Priority for setting the datapath (same applies for download_path):\\n # --datapath -> os.environ['PARLAI_DATAPATH'] -> <self.parlai_home>/data\\n if opt.get('download_path'):\\n os.environ['PARLAI_DOWNPATH'] = opt['download_path']\\n elif os.environ.get('PARLAI_DOWNPATH') is None:\\n os.environ['PARLAI_DOWNPATH'] = os.path.join(self.parlai_home, 'downloads')\\n if opt.get('datapath'):\\n os.environ['PARLAI_DATAPATH'] = opt['datapath']\\n elif os.environ.get('PARLAI_DATAPATH') is None:\\n os.environ['PARLAI_DATAPATH'] = os.path.join(self.parlai_home, 'data')\\n\\n opt['download_path'] = os.environ['PARLAI_DOWNPATH']\\n opt['datapath'] = os.environ['PARLAI_DATAPATH']\\n\\n return opt\\n\\n def _process_args_to_opts(self, args_that_override: Optional[List[str]] = None):\\n self.opt = Opt(vars(self.args))\\n\\n # custom post-parsing\\n self.opt['parlai_home'] = self.parlai_home\\n self.opt = self._infer_datapath(self.opt)\\n\\n # set all arguments specified in command line as overridable\\n option_strings_dict = {}\\n store_true = []\\n store_false = []\\n for group in self._action_groups:\\n for a in group._group_actions:\\n if hasattr(a, 'option_strings'):\\n for option in a.option_strings:\\n option_strings_dict[option] = a.dest\\n if '_StoreTrueAction' in str(type(a)):\\n store_true.append(option)\\n elif '_StoreFalseAction' in str(type(a)):\\n store_false.append(option)\\n\\n if args_that_override is None:\\n args_that_override = _sys.argv[1:]\\n\\n for i in range(len(args_that_override)):\\n if args_that_override[i] in option_strings_dict:\\n if args_that_override[i] in store_true:\\n self.overridable[option_strings_dict[args_that_override[i]]] = True\\n elif args_that_override[i] in store_false:\\n self.overridable[option_strings_dict[args_that_override[i]]] = False\\n elif (\\n i < len(args_that_override) - 1\\n and args_that_override[i + 1][:1] != '-'\\n ):\\n key = option_strings_dict[args_that_override[i]]\\n self.overridable[key] = self.opt[key]\\n self.opt['override'] = self.overridable\\n\\n # load opts if a file is provided.\\n if self.opt.get('init_opt', None) is not None:\\n self._load_opts(self.opt)\\n\\n # map filenames that start with 'zoo:' to point to the model zoo dir\\n options_to_change = {'model_file', 'dict_file', 'bpe_vocab', 'bpe_merge'}\\n for each_key in options_to_change:\\n if self.opt.get(each_key) is not None:\\n self.opt[each_key] = modelzoo_path(\\n self.opt.get('datapath'), self.opt[each_key]\\n )\\n if self.opt['override'].get(each_key) is not None:\\n # also check override\\n self.opt['override'][each_key] = modelzoo_path(\\n self.opt.get('datapath'), self.opt['override'][each_key]\\n )\\n\\n # add start time of an experiment\\n self.opt['starttime'] = datetime.datetime.today().strftime('%b%d_%H-%M')\\n\\n def parse_and_process_known_args(self, args=None):\\n \\\"\\\"\\\"\\n Parse provided arguments and return parlai opts and unknown arg list.\\n\\n Runs the same arg->opt parsing that parse_args does, but doesn't throw an error\\n if the args being parsed include additional command line arguments that parlai\\n doesn't know what to do with.\\n \\\"\\\"\\\"\\n self.args, unknowns = super().parse_known_args(args=args)\\n self._process_args_to_opts(args)\\n return self.opt, unknowns\\n\\n def parse_args(self, args=None, namespace=None, print_args=True):\\n \\\"\\\"\\\"\\n Parse the provided arguments and returns a dictionary of the ``args``.\\n\\n We specifically remove items with ``None`` as values in order to support the\\n style ``opt.get(key, default)``, which would otherwise return ``None``.\\n \\\"\\\"\\\"\\n self.add_extra_args(args)\\n self.args = super().parse_args(args=args)\\n\\n self._process_args_to_opts(args)\\n\\n if print_args:\\n self.print_args()\\n if GIT_AVAILABLE:\\n print_git_commit()\\n print_announcements(self.opt)\\n\\n if os.environ.get('PARLAI_VERBOSE'):\\n self.opt['verbose'] = True\\n\\n if self.opt.get('verbose'):\\n logging.set_verbose_mode()\\n\\n return self.opt\\n\\n def _kwargs_to_str_args(self, **kwargs):\\n \\\"\\\"\\\"\\n Attempt to map from python-code kwargs into CLI args.\\n\\n e.g. model_file -> --model-file.\\n\\n Works with short options too, like t=\\\"convai2\\\".\\n \\\"\\\"\\\"\\n\\n # we have to do this large block of repetitive code twice, the first\\n # round is basically just to become aware of anything that would have\\n # been added by add_extra_args\\n kwname_to_action = {}\\n for action in self._actions:\\n if action.dest == 'help':\\n # no help allowed\\n continue\\n for option_string in action.option_strings:\\n kwname = option_string.lstrip('-').replace('-', '_')\\n assert (kwname not in kwname_to_action) or (\\n kwname_to_action[kwname] is action\\n ), f\\\"No duplicate names! ({kwname}, {kwname_to_action[kwname]}, {action})\\\"\\n kwname_to_action[kwname] = action\\n\\n string_args = []\\n for kwname, value in kwargs.items():\\n if kwname not in kwname_to_action:\\n # best guess, we need to delay it. hopefully this gets added\\n # during add_kw_Args\\n continue\\n action = kwname_to_action[kwname]\\n last_option_string = action.option_strings[-1]\\n if isinstance(action, argparse._StoreTrueAction) and bool(value):\\n string_args.append(last_option_string)\\n elif isinstance(action, argparse._StoreAction) and action.nargs is None:\\n string_args.append(last_option_string)\\n string_args.append(str(value))\\n elif isinstance(action, argparse._StoreAction) and action.nargs in '*+':\\n string_args.append(last_option_string)\\n string_args.extend([str(v) for v in value])\\n else:\\n raise TypeError(f\\\"Don't know what to do with {action}\\\")\\n\\n # become aware of any extra args that might be specified if the user\\n # provides something like model=\\\"transformer/generator\\\".\\n self.add_extra_args(string_args)\\n\\n # do it again, this time knowing about ALL args.\\n kwname_to_action = {}\\n for action in self._actions:\\n if action.dest == 'help':\\n # no help allowed\\n continue\\n for option_string in action.option_strings:\\n kwname = option_string.lstrip('-').replace('-', '_')\\n assert (kwname not in kwname_to_action) or (\\n kwname_to_action[kwname] is action\\n ), f\\\"No duplicate names! ({kwname}, {kwname_to_action[kwname]}, {action})\\\"\\n kwname_to_action[kwname] = action\\n\\n string_args = []\\n for kwname, value in kwargs.items():\\n # note we don't have the if kwname not in kwname_to_action here.\\n # it MUST appear, or else we legitimately should be throwing a KeyError\\n # because user has provided an unspecified option\\n action = kwname_to_action[kwname]\\n last_option_string = action.option_strings[-1]\\n if isinstance(action, argparse._StoreTrueAction) and bool(value):\\n string_args.append(last_option_string)\\n elif isinstance(action, argparse._StoreAction) and action.nargs is None:\\n string_args.append(last_option_string)\\n string_args.append(str(value))\\n elif isinstance(action, argparse._StoreAction) and action.nargs in '*+':\\n string_args.append(last_option_string)\\n string_args.extend([str(v) for v in value])\\n else:\\n raise TypeError(f\\\"Don't know what to do with {action}\\\")\\n\\n return string_args\\n\\n def parse_kwargs(self, **kwargs):\\n \\\"\\\"\\\"\\n Parse kwargs, with type checking etc.\\n \\\"\\\"\\\"\\n # hack: capture any error messages without raising a SystemExit\\n def _captured_error(msg):\\n raise ValueError(msg)\\n\\n old_error = self.error\\n self.error = _captured_error\\n try:\\n string_args = self._kwargs_to_str_args(**kwargs)\\n return self.parse_args(args=string_args, print_args=False)\\n finally:\\n self.error = old_error\\n\\n def print_args(self):\\n \\\"\\\"\\\"\\n Print out all the arguments in this parser.\\n \\\"\\\"\\\"\\n if not self.opt:\\n self.parse_args(print_args=False)\\n values = {}\\n for key, value in self.opt.items():\\n values[str(key)] = str(value)\\n for group in self._action_groups:\\n group_dict = {\\n a.dest: getattr(self.args, a.dest, None) for a in group._group_actions\\n }\\n namespace = argparse.Namespace(**group_dict)\\n count = 0\\n for key in sorted(namespace.__dict__):\\n if key in values:\\n if count == 0:\\n print('[ ' + group.title + ': ] ')\\n count += 1\\n print('[ ' + key + ': ' + values[key] + ' ]')\\n\\n def set_params(self, **kwargs):\\n \\\"\\\"\\\"\\n Set overridable kwargs.\\n \\\"\\\"\\\"\\n self.set_defaults(**kwargs)\\n for k, v in kwargs.items():\\n self.overridable[k] = v\\n\\n @property\\n def show_advanced_args(self):\\n \\\"\\\"\\\"\\n Check if we should show arguments marked as hidden.\\n \\\"\\\"\\\"\\n if hasattr(self, '_show_advanced_args'):\\n return self._show_advanced_args\\n known_args, _ = self.parse_known_args(nohelp=True)\\n if hasattr(known_args, 'show_advanced_args'):\\n self._show_advanced_args = known_args.show_advanced_args\\n else:\\n self._show_advanced_args = True\\n return self._show_advanced_args\\n\\n def _handle_custom_options(self, kwargs):\\n \\\"\\\"\\\"\\n Handle custom parlai options.\\n\\n Includes hidden, recommended. Future may include no_save and no_override.\\n \\\"\\\"\\\"\\n action_attr = {}\\n if 'recommended' in kwargs:\\n rec = kwargs.pop('recommended')\\n action_attr['recommended'] = rec\\n action_attr['hidden'] = kwargs.get('hidden', False)\\n if 'hidden' in kwargs:\\n hidden = kwargs.pop('hidden')\\n if hidden:\\n kwargs['help'] = argparse.SUPPRESS\\n if 'type' in kwargs and kwargs['type'] is bool:\\n # common error, we really want simple form\\n kwargs['type'] = 'bool'\\n return kwargs, action_attr\\n\\n def add_argument(self, *args, **kwargs):\\n \\\"\\\"\\\"\\n Override to convert underscores to hyphens for consistency.\\n \\\"\\\"\\\"\\n kwargs, newattr = self._handle_custom_options(kwargs)\\n action = super().add_argument(*fix_underscores(args), **kwargs)\\n for k, v in newattr.items():\\n setattr(action, k, v)\\n return action\\n\\n def add_argument_group(self, *args, **kwargs):\\n \\\"\\\"\\\"\\n Override to make arg groups also convert underscores to hyphens.\\n \\\"\\\"\\\"\\n arg_group = super().add_argument_group(*args, **kwargs)\\n original_add_arg = arg_group.add_argument\\n\\n def ag_add_argument(*args, **kwargs):\\n kwargs, newattr = self._handle_custom_options(kwargs)\\n action = original_add_arg(*fix_underscores(args), **kwargs)\\n for k, v in newattr.items():\\n setattr(action, k, v)\\n return action\\n\\n arg_group.add_argument = ag_add_argument # override _ => -\\n arg_group.add_argument_group = self.add_argument_group\\n return arg_group\\n\\n def error(self, message):\\n \\\"\\\"\\\"\\n Override to print custom error message.\\n \\\"\\\"\\\"\\n self.print_help()\\n _sys.stderr.write('\\\\nParse Error: %s\\\\n' % message)\\n _sys.exit(2)\\n\",\n \"path\": \"parlai/core/params.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/parlai/core/params.py b/parlai/core/params.py\nindex 12d5bf7a67c..3740da152c7 100644\n--- a/parlai/core/params.py\n+++ b/parlai/core/params.py\n@@ -1162,6 +1162,9 @@ def _handle_custom_options(self, kwargs):\n hidden = kwargs.pop('hidden')\n if hidden:\n kwargs['help'] = argparse.SUPPRESS\n+ if 'type' in kwargs and kwargs['type'] is bool:\n+ # common error, we really want simple form\n+ kwargs['type'] = 'bool'\n return kwargs, action_attr\n \n def add_argument(self, *args, **kwargs):\ndiff --git a/tests/test_params.py b/tests/test_params.py\nindex b790e88acd1..de9b1144bf2 100644\n--- a/tests/test_params.py\n+++ b/tests/test_params.py\n@@ -120,6 +120,46 @@ def test_parse_kwargs(self):\n parser = ParlaiParser(True, True)\n parser.parse_kwargs(model='transformer/generator', fake_arg='foo')\n \n+ def test_bool(self):\n+ \"\"\"\n+ test add_argument(type=bool)\n+ \"\"\"\n+ parser = ParlaiParser(True, True)\n+ parser.add_argument('--foo', type=bool)\n+ opt = parser.parse_args(['--foo', 'true'])\n+ assert opt['foo'] is True\n+ opt = parser.parse_args(['--foo', 'False'])\n+ assert opt['foo'] is False\n+ opt = parser.parse_args(['--foo', '0'])\n+ assert opt['foo'] is False\n+\n+ group = parser.add_argument_group('foo container')\n+ group.add_argument('--bar', type=bool)\n+ opt = parser.parse_args(['--bar', 'true'])\n+ assert opt['bar'] is True\n+ opt = parser.parse_args(['--bar', 'False'])\n+ assert opt['bar'] is False\n+ opt = parser.parse_args(['--bar', '0'])\n+ assert opt['bar'] is False\n+\n+ parser = ParlaiParser(True, True)\n+ parser.add_argument('--foo', type='bool')\n+ opt = parser.parse_args(['--foo', 'true'])\n+ assert opt['foo'] is True\n+ opt = parser.parse_args(['--foo', 'False'])\n+ assert opt['foo'] is False\n+ opt = parser.parse_args(['--foo', '0'])\n+ assert opt['foo'] is False\n+\n+ group = parser.add_argument_group('foo container')\n+ group.add_argument('--bar', type='bool')\n+ opt = parser.parse_args(['--bar', 'true'])\n+ assert opt['bar'] is True\n+ opt = parser.parse_args(['--bar', 'False'])\n+ assert opt['bar'] is False\n+ opt = parser.parse_args(['--bar', '0'])\n+ assert opt['bar'] is False\n+\n \n if __name__ == '__main__':\n unittest.main()\n"}}},{"rowIdx":5475,"cells":{"in_source_id":{"kind":"string","value":"scoutapp__scout_apm_python-146"},"issue":{"kind":"string","value":"PyYAML security alert\nOur application is getting a GitHub security alert from PyYAML, and this is the only package that has it as a dependency in our graph. It looks like this package no longer uses that package, but it is still declared as a dependency.\r\n\r\nIf this assessment is correct, the dependency should be removed from the `setup.py` and a new release upload to PyPI.\r\n\r\nhttps://nvd.nist.gov/vuln/detail/CVE-2017-18342\n"},"before_files":{"kind":"list like","value":[{"content":"import os\nimport sys\nfrom glob import glob\n\nfrom setuptools import Extension, find_packages, setup\n\nlong_description = (\n \"Scout Application Performance Monitoring Agent - https://scoutapp.com\"\n)\nif os.path.exists(\"README.md\"):\n long_description = open(\"README.md\").read()\n\n# Try to compile the extensions, except for platforms or versions\n# where our extensions are not supported\ncompile_extensions = True\n\nsetup_args = {\n \"name\": \"scout_apm\",\n \"version\": \"2.0.0\",\n \"description\": \"Scout Application Performance Monitoring Agent\",\n \"long_description\": long_description,\n \"long_description_content_type\": \"text/markdown\",\n \"url\": \"https://github.com/scoutapp/scout_apm_python\",\n \"author\": \"Scout\",\n \"author_email\": \"support@scoutapp.com\",\n \"license\": \"MIT\",\n \"zip_safe\": False,\n \"python_requires\": \">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, <4\",\n \"packages\": find_packages(\"src\"),\n \"package_dir\": {\"\": \"src\"},\n \"py_modules\": [os.splitext(os.basename(path))[0] for path in glob(\"src/*.py\")],\n \"ext_modules\": [\n Extension(\"scout_apm.core.objtrace\", [\"src/scout_apm/core/ext/objtrace.c\"])\n ],\n \"entry_points\": {\n \"console_scripts\": [\n \"core-agent-manager = scout_apm.core.cli.core_agent_manager:main\"\n ]\n },\n \"install_requires\": [\"psutil\", \"PyYAML\", \"requests\"],\n \"keywords\": \"apm performance monitoring development\",\n \"classifiers\": [\n \"Development Status :: 5 - Production/Stable\",\n \"Intended Audience :: Developers\",\n \"Topic :: System :: Monitoring\",\n \"License :: OSI Approved :: MIT License\",\n \"Operating System :: MacOS\",\n \"Operating System :: POSIX\",\n \"Operating System :: POSIX :: Linux\",\n \"Programming Language :: Python :: 2\",\n \"Programming Language :: Python :: 2.7\",\n \"Programming Language :: Python :: 3\",\n \"Programming Language :: Python :: 3.4\",\n \"Programming Language :: Python :: 3.5\",\n \"Programming Language :: Python :: 3.6\",\n \"Programming Language :: Python :: 3.7\",\n ],\n}\n\nif sys.version_info <= (3, 0):\n compile_extensions = False\n\nif sys.platform.startswith(\"java\"):\n compile_extensions = False\n\nif \"__pypy__\" in sys.builtin_module_names:\n compile_extensions = False\n\nif not compile_extensions:\n del setup_args[\"ext_modules\"]\n\nsetup(**setup_args)\n","path":"setup.py"}],"string":"[\n {\n \"content\": \"import os\\nimport sys\\nfrom glob import glob\\n\\nfrom setuptools import Extension, find_packages, setup\\n\\nlong_description = (\\n \\\"Scout Application Performance Monitoring Agent - https://scoutapp.com\\\"\\n)\\nif os.path.exists(\\\"README.md\\\"):\\n long_description = open(\\\"README.md\\\").read()\\n\\n# Try to compile the extensions, except for platforms or versions\\n# where our extensions are not supported\\ncompile_extensions = True\\n\\nsetup_args = {\\n \\\"name\\\": \\\"scout_apm\\\",\\n \\\"version\\\": \\\"2.0.0\\\",\\n \\\"description\\\": \\\"Scout Application Performance Monitoring Agent\\\",\\n \\\"long_description\\\": long_description,\\n \\\"long_description_content_type\\\": \\\"text/markdown\\\",\\n \\\"url\\\": \\\"https://github.com/scoutapp/scout_apm_python\\\",\\n \\\"author\\\": \\\"Scout\\\",\\n \\\"author_email\\\": \\\"support@scoutapp.com\\\",\\n \\\"license\\\": \\\"MIT\\\",\\n \\\"zip_safe\\\": False,\\n \\\"python_requires\\\": \\\">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, <4\\\",\\n \\\"packages\\\": find_packages(\\\"src\\\"),\\n \\\"package_dir\\\": {\\\"\\\": \\\"src\\\"},\\n \\\"py_modules\\\": [os.splitext(os.basename(path))[0] for path in glob(\\\"src/*.py\\\")],\\n \\\"ext_modules\\\": [\\n Extension(\\\"scout_apm.core.objtrace\\\", [\\\"src/scout_apm/core/ext/objtrace.c\\\"])\\n ],\\n \\\"entry_points\\\": {\\n \\\"console_scripts\\\": [\\n \\\"core-agent-manager = scout_apm.core.cli.core_agent_manager:main\\\"\\n ]\\n },\\n \\\"install_requires\\\": [\\\"psutil\\\", \\\"PyYAML\\\", \\\"requests\\\"],\\n \\\"keywords\\\": \\\"apm performance monitoring development\\\",\\n \\\"classifiers\\\": [\\n \\\"Development Status :: 5 - Production/Stable\\\",\\n \\\"Intended Audience :: Developers\\\",\\n \\\"Topic :: System :: Monitoring\\\",\\n \\\"License :: OSI Approved :: MIT License\\\",\\n \\\"Operating System :: MacOS\\\",\\n \\\"Operating System :: POSIX\\\",\\n \\\"Operating System :: POSIX :: Linux\\\",\\n \\\"Programming Language :: Python :: 2\\\",\\n \\\"Programming Language :: Python :: 2.7\\\",\\n \\\"Programming Language :: Python :: 3\\\",\\n \\\"Programming Language :: Python :: 3.4\\\",\\n \\\"Programming Language :: Python :: 3.5\\\",\\n \\\"Programming Language :: Python :: 3.6\\\",\\n \\\"Programming Language :: Python :: 3.7\\\",\\n ],\\n}\\n\\nif sys.version_info <= (3, 0):\\n compile_extensions = False\\n\\nif sys.platform.startswith(\\\"java\\\"):\\n compile_extensions = False\\n\\nif \\\"__pypy__\\\" in sys.builtin_module_names:\\n compile_extensions = False\\n\\nif not compile_extensions:\\n del setup_args[\\\"ext_modules\\\"]\\n\\nsetup(**setup_args)\\n\",\n \"path\": \"setup.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"import os\nimport sys\nfrom glob import glob\n\nfrom setuptools import Extension, find_packages, setup\n\nlong_description = (\n \"Scout Application Performance Monitoring Agent - https://scoutapp.com\"\n)\nif os.path.exists(\"README.md\"):\n long_description = open(\"README.md\").read()\n\n# Try to compile the extensions, except for platforms or versions\n# where our extensions are not supported\ncompile_extensions = True\n\nsetup_args = {\n \"name\": \"scout_apm\",\n \"version\": \"2.0.0\",\n \"description\": \"Scout Application Performance Monitoring Agent\",\n \"long_description\": long_description,\n \"long_description_content_type\": \"text/markdown\",\n \"url\": \"https://github.com/scoutapp/scout_apm_python\",\n \"author\": \"Scout\",\n \"author_email\": \"support@scoutapp.com\",\n \"license\": \"MIT\",\n \"zip_safe\": False,\n \"python_requires\": \">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, <4\",\n \"packages\": find_packages(\"src\"),\n \"package_dir\": {\"\": \"src\"},\n \"py_modules\": [os.splitext(os.basename(path))[0] for path in glob(\"src/*.py\")],\n \"ext_modules\": [\n Extension(\"scout_apm.core.objtrace\", [\"src/scout_apm/core/ext/objtrace.c\"])\n ],\n \"entry_points\": {\n \"console_scripts\": [\n \"core-agent-manager = scout_apm.core.cli.core_agent_manager:main\"\n ]\n },\n \"install_requires\": [\"psutil\", \"requests\"],\n \"keywords\": \"apm performance monitoring development\",\n \"classifiers\": [\n \"Development Status :: 5 - Production/Stable\",\n \"Intended Audience :: Developers\",\n \"Topic :: System :: Monitoring\",\n \"License :: OSI Approved :: MIT License\",\n \"Operating System :: MacOS\",\n \"Operating System :: POSIX\",\n \"Operating System :: POSIX :: Linux\",\n \"Programming Language :: Python :: 2\",\n \"Programming Language :: Python :: 2.7\",\n \"Programming Language :: Python :: 3\",\n \"Programming Language :: Python :: 3.4\",\n \"Programming Language :: Python :: 3.5\",\n \"Programming Language :: Python :: 3.6\",\n \"Programming Language :: Python :: 3.7\",\n ],\n}\n\nif sys.version_info <= (3, 0):\n compile_extensions = False\n\nif sys.platform.startswith(\"java\"):\n compile_extensions = False\n\nif \"__pypy__\" in sys.builtin_module_names:\n compile_extensions = False\n\nif not compile_extensions:\n del setup_args[\"ext_modules\"]\n\nsetup(**setup_args)\n","path":"setup.py"}],"string":"[\n {\n \"content\": \"import os\\nimport sys\\nfrom glob import glob\\n\\nfrom setuptools import Extension, find_packages, setup\\n\\nlong_description = (\\n \\\"Scout Application Performance Monitoring Agent - https://scoutapp.com\\\"\\n)\\nif os.path.exists(\\\"README.md\\\"):\\n long_description = open(\\\"README.md\\\").read()\\n\\n# Try to compile the extensions, except for platforms or versions\\n# where our extensions are not supported\\ncompile_extensions = True\\n\\nsetup_args = {\\n \\\"name\\\": \\\"scout_apm\\\",\\n \\\"version\\\": \\\"2.0.0\\\",\\n \\\"description\\\": \\\"Scout Application Performance Monitoring Agent\\\",\\n \\\"long_description\\\": long_description,\\n \\\"long_description_content_type\\\": \\\"text/markdown\\\",\\n \\\"url\\\": \\\"https://github.com/scoutapp/scout_apm_python\\\",\\n \\\"author\\\": \\\"Scout\\\",\\n \\\"author_email\\\": \\\"support@scoutapp.com\\\",\\n \\\"license\\\": \\\"MIT\\\",\\n \\\"zip_safe\\\": False,\\n \\\"python_requires\\\": \\\">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, <4\\\",\\n \\\"packages\\\": find_packages(\\\"src\\\"),\\n \\\"package_dir\\\": {\\\"\\\": \\\"src\\\"},\\n \\\"py_modules\\\": [os.splitext(os.basename(path))[0] for path in glob(\\\"src/*.py\\\")],\\n \\\"ext_modules\\\": [\\n Extension(\\\"scout_apm.core.objtrace\\\", [\\\"src/scout_apm/core/ext/objtrace.c\\\"])\\n ],\\n \\\"entry_points\\\": {\\n \\\"console_scripts\\\": [\\n \\\"core-agent-manager = scout_apm.core.cli.core_agent_manager:main\\\"\\n ]\\n },\\n \\\"install_requires\\\": [\\\"psutil\\\", \\\"requests\\\"],\\n \\\"keywords\\\": \\\"apm performance monitoring development\\\",\\n \\\"classifiers\\\": [\\n \\\"Development Status :: 5 - Production/Stable\\\",\\n \\\"Intended Audience :: Developers\\\",\\n \\\"Topic :: System :: Monitoring\\\",\\n \\\"License :: OSI Approved :: MIT License\\\",\\n \\\"Operating System :: MacOS\\\",\\n \\\"Operating System :: POSIX\\\",\\n \\\"Operating System :: POSIX :: Linux\\\",\\n \\\"Programming Language :: Python :: 2\\\",\\n \\\"Programming Language :: Python :: 2.7\\\",\\n \\\"Programming Language :: Python :: 3\\\",\\n \\\"Programming Language :: Python :: 3.4\\\",\\n \\\"Programming Language :: Python :: 3.5\\\",\\n \\\"Programming Language :: Python :: 3.6\\\",\\n \\\"Programming Language :: Python :: 3.7\\\",\\n ],\\n}\\n\\nif sys.version_info <= (3, 0):\\n compile_extensions = False\\n\\nif sys.platform.startswith(\\\"java\\\"):\\n compile_extensions = False\\n\\nif \\\"__pypy__\\\" in sys.builtin_module_names:\\n compile_extensions = False\\n\\nif not compile_extensions:\\n del setup_args[\\\"ext_modules\\\"]\\n\\nsetup(**setup_args)\\n\",\n \"path\": \"setup.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md\nindex 7901ca54..501be101 100644\n--- a/DEVELOPMENT.md\n+++ b/DEVELOPMENT.md\n@@ -89,7 +89,7 @@ for example 2.7 and 3.7. In that case, do the whole setup for each virtualenv.\n \n Install all test dependencies:\n \n- $ pip install bottle celery Django elasticsearch flask flask-sqlalchemy jinja2 mock psutil pymongo pyramid pytest pytest-travis-fold pytest-cov PyYAML redis requests sqlalchemy urllib3 webtest\n+ $ pip install bottle celery Django elasticsearch flask flask-sqlalchemy jinja2 mock psutil pymongo pyramid pytest pytest-travis-fold pytest-cov redis requests sqlalchemy urllib3 webtest\n \n Run tests with:\n \ndiff --git a/requirements.txt b/requirements.txt\nindex bc5d83ff..75d1bd25 100644\n--- a/requirements.txt\n+++ b/requirements.txt\n@@ -1,3 +1,2 @@\n psutil\n-PyYAML\n requests\ndiff --git a/setup.py b/setup.py\nindex 790d1359..143fa10b 100644\n--- a/setup.py\n+++ b/setup.py\n@@ -37,7 +37,7 @@\n \"core-agent-manager = scout_apm.core.cli.core_agent_manager:main\"\n ]\n },\n- \"install_requires\": [\"psutil\", \"PyYAML\", \"requests\"],\n+ \"install_requires\": [\"psutil\", \"requests\"],\n \"keywords\": \"apm performance monitoring development\",\n \"classifiers\": [\n \"Development Status :: 5 - Production/Stable\",\ndiff --git a/tox.ini b/tox.ini\nindex 76eaf532..6e547533 100644\n--- a/tox.ini\n+++ b/tox.ini\n@@ -42,7 +42,6 @@ deps =\n pytest\n pytest-travis-fold\n pytest-cov\n- PyYAML\n redis\n requests\n sqlalchemy\n"}}},{"rowIdx":5476,"cells":{"in_source_id":{"kind":"string","value":"fidals__shopelectro-462"},"issue":{"kind":"string","value":"dc-volumes.yml:27-28: Repair npm container reusing at...\nThe puzzle `449-27d8c19e` from #449 has to be resolved:\n\nhttps://github.com/fidals/shopelectro/blob/f8ce85246c00411fcb21d025b0fb42abab81c7d5/docker/dc-volumes.yml#L27-L28\n\nThe puzzle was created by duker33 on 28-Jul-18. \n\nEstimate: 60 minutes, \n\nIf you have any technical questions, don't ask me, submit new tickets instead. The task will be \"done\" when the problem is fixed and the text of the puzzle is _removed_ from the source code. Here is more about [PDD](http://www.yegor256.com/2009/03/04/pdd.html) and [about me](http://www.yegor256.com/2017/04/05/pdd-in-action.html).\nВ Firefox не поставить оценку товару\nНе нажимаются звездочки, когда хочешь оставить отзыв о товаре\r\n\r\nFirefox 58.0.2, чистый профиль. В Chromium работают\n"},"before_files":{"kind":"list like","value":[{"content":"import glob\nimport logging\nimport math\nimport os\nimport shutil\nimport subprocess\nimport time\nfrom contextlib import contextmanager\nfrom itertools import chain\nfrom typing import Iterator, Dict\nfrom uuid import UUID\nfrom xml.etree import ElementTree\n\nimport requests\nfrom django.conf import settings\n\nfrom shopelectro.exception import DownloadFilesError\n\nlogger = logging.getLogger(__name__)\nDOWNLOAD_FILES_TIMEOUT = 15.0\nUUID_TYPE = str\nData = Dict[str, Dict[str, dict]]\nNOT_SAVE_TEMPLATE = '{entity} with name=\"{name}\" has no {field}. It\\'ll not be' \\\n ' saved'\n\n\ndef floor(x: float, precision=0) -> float:\n \"\"\"\n The same behaviour as `math.floor`, but with precision.\n\n >>> floor(1.234, precision=2) # result: 1.23\n \"\"\"\n k = 10**precision\n return math.floor(x * k) / k\n\n\ndef is_correct_uuid(uuid_):\n try:\n val = UUID(uuid_)\n except (ValueError, TypeError):\n return False\n return str(val) == uuid_\n\n\nclass XmlFile:\n\n namespace = '{urn:1C.ru:commerceml_2}'\n\n def __init__(self, fetch_callback, xml_path_pattern, xpath_queries,\n extra_options=None):\n self.fetch_callback = fetch_callback\n self.xml_path_pattern = xml_path_pattern\n self.xpath_queries = xpath_queries\n self.extra_options = extra_options or {}\n\n @property\n def parsed_files(self):\n \"\"\"Get parsed xml files, that matched the path pattern.\"\"\"\n xml_files = glob.glob(os.path.join(\n settings.ASSETS_DIR, self.xml_path_pattern\n ))\n assert xml_files, 'Files on path {} does not exist.'.format(\n self.xml_path_pattern\n )\n return [ElementTree.parse(file) for file in xml_files]\n\n @property\n def xpaths(self):\n \"\"\"Get xpath queries for xml.\"\"\"\n return {\n name: query.format(self.namespace)\n for name, query in self.xpath_queries.items()\n }\n\n def get_data(self) -> Iterator:\n \"\"\"\n Get data from xml files.\n\n Example files with products names or prices.\n \"\"\"\n return chain.from_iterable(\n self.fetch_callback(file, self)\n for file in self.parsed_files\n )\n\n\n@contextmanager\ndef collect_errors(error_types: tuple):\n errors = []\n\n @contextmanager\n def collect():\n try:\n yield\n except error_types as error:\n errors.append(error)\n yield collect\n if errors:\n raise errors[0]\n\n\n@contextmanager\ndef download_catalog(destination):\n \"\"\"Download catalog's xml files and delete after handle them.\"\"\"\n wget_command = (\n 'wget -r -P {} ftp://{}:{}@{}/webdata/'\n ' 2>&1 | grep \"время\\|time\\|Downloaded\"'.format(\n destination,\n settings.FTP_USER,\n settings.FTP_PASS,\n settings.FTP_IP,\n )\n )\n\n try:\n subprocess.run(wget_command, timeout=DOWNLOAD_FILES_TIMEOUT, shell=True)\n except subprocess.TimeoutExpired as e:\n raise DownloadFilesError(str(e))\n\n assert os.path.exists(os.path.join(\n destination, settings.FTP_IP)), 'Files do not downloaded...'\n logger.info('Download catalog - completed...')\n\n try:\n yield\n finally:\n # remove downloaded data\n shutil.rmtree(os.path.join(destination, settings.FTP_IP))\n\n\ndef report(error):\n report_url = getattr(settings, 'SLACK_REPORT_URL', None)\n if report_url is not None:\n requests.post(\n url=report_url,\n json={\n 'text': '*Не удалось обновить каталог Shopelectro.*\\n'\n '*Время*: {}\\n'\n '*Ошибка*: {}'.format(time.ctime(), error),\n }\n )\n","path":"shopelectro/management/commands/_update_catalog/utils.py"}],"string":"[\n {\n \"content\": \"import glob\\nimport logging\\nimport math\\nimport os\\nimport shutil\\nimport subprocess\\nimport time\\nfrom contextlib import contextmanager\\nfrom itertools import chain\\nfrom typing import Iterator, Dict\\nfrom uuid import UUID\\nfrom xml.etree import ElementTree\\n\\nimport requests\\nfrom django.conf import settings\\n\\nfrom shopelectro.exception import DownloadFilesError\\n\\nlogger = logging.getLogger(__name__)\\nDOWNLOAD_FILES_TIMEOUT = 15.0\\nUUID_TYPE = str\\nData = Dict[str, Dict[str, dict]]\\nNOT_SAVE_TEMPLATE = '{entity} with name=\\\"{name}\\\" has no {field}. It\\\\'ll not be' \\\\\\n ' saved'\\n\\n\\ndef floor(x: float, precision=0) -> float:\\n \\\"\\\"\\\"\\n The same behaviour as `math.floor`, but with precision.\\n\\n >>> floor(1.234, precision=2) # result: 1.23\\n \\\"\\\"\\\"\\n k = 10**precision\\n return math.floor(x * k) / k\\n\\n\\ndef is_correct_uuid(uuid_):\\n try:\\n val = UUID(uuid_)\\n except (ValueError, TypeError):\\n return False\\n return str(val) == uuid_\\n\\n\\nclass XmlFile:\\n\\n namespace = '{urn:1C.ru:commerceml_2}'\\n\\n def __init__(self, fetch_callback, xml_path_pattern, xpath_queries,\\n extra_options=None):\\n self.fetch_callback = fetch_callback\\n self.xml_path_pattern = xml_path_pattern\\n self.xpath_queries = xpath_queries\\n self.extra_options = extra_options or {}\\n\\n @property\\n def parsed_files(self):\\n \\\"\\\"\\\"Get parsed xml files, that matched the path pattern.\\\"\\\"\\\"\\n xml_files = glob.glob(os.path.join(\\n settings.ASSETS_DIR, self.xml_path_pattern\\n ))\\n assert xml_files, 'Files on path {} does not exist.'.format(\\n self.xml_path_pattern\\n )\\n return [ElementTree.parse(file) for file in xml_files]\\n\\n @property\\n def xpaths(self):\\n \\\"\\\"\\\"Get xpath queries for xml.\\\"\\\"\\\"\\n return {\\n name: query.format(self.namespace)\\n for name, query in self.xpath_queries.items()\\n }\\n\\n def get_data(self) -> Iterator:\\n \\\"\\\"\\\"\\n Get data from xml files.\\n\\n Example files with products names or prices.\\n \\\"\\\"\\\"\\n return chain.from_iterable(\\n self.fetch_callback(file, self)\\n for file in self.parsed_files\\n )\\n\\n\\n@contextmanager\\ndef collect_errors(error_types: tuple):\\n errors = []\\n\\n @contextmanager\\n def collect():\\n try:\\n yield\\n except error_types as error:\\n errors.append(error)\\n yield collect\\n if errors:\\n raise errors[0]\\n\\n\\n@contextmanager\\ndef download_catalog(destination):\\n \\\"\\\"\\\"Download catalog's xml files and delete after handle them.\\\"\\\"\\\"\\n wget_command = (\\n 'wget -r -P {} ftp://{}:{}@{}/webdata/'\\n ' 2>&1 | grep \\\"время\\\\|time\\\\|Downloaded\\\"'.format(\\n destination,\\n settings.FTP_USER,\\n settings.FTP_PASS,\\n settings.FTP_IP,\\n )\\n )\\n\\n try:\\n subprocess.run(wget_command, timeout=DOWNLOAD_FILES_TIMEOUT, shell=True)\\n except subprocess.TimeoutExpired as e:\\n raise DownloadFilesError(str(e))\\n\\n assert os.path.exists(os.path.join(\\n destination, settings.FTP_IP)), 'Files do not downloaded...'\\n logger.info('Download catalog - completed...')\\n\\n try:\\n yield\\n finally:\\n # remove downloaded data\\n shutil.rmtree(os.path.join(destination, settings.FTP_IP))\\n\\n\\ndef report(error):\\n report_url = getattr(settings, 'SLACK_REPORT_URL', None)\\n if report_url is not None:\\n requests.post(\\n url=report_url,\\n json={\\n 'text': '*Не удалось обновить каталог Shopelectro.*\\\\n'\\n '*Время*: {}\\\\n'\\n '*Ошибка*: {}'.format(time.ctime(), error),\\n }\\n )\\n\",\n \"path\": \"shopelectro/management/commands/_update_catalog/utils.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"import glob\nimport logging\nimport math\nimport os\nimport shutil\nimport subprocess\nimport time\nfrom contextlib import contextmanager\nfrom itertools import chain\nfrom typing import Iterator, Dict\nfrom uuid import UUID\nfrom xml.etree import ElementTree\n\nimport requests\nfrom django.conf import settings\n\nfrom shopelectro.exception import DownloadFilesError\n\nlogger = logging.getLogger(__name__)\nDOWNLOAD_FILES_TIMEOUT = 40.0\nUUID_TYPE = str\nData = Dict[str, Dict[str, dict]]\nNOT_SAVE_TEMPLATE = '{entity} with name=\"{name}\" has no {field}. It\\'ll not be' \\\n ' saved'\n\n\ndef floor(x: float, precision=0) -> float:\n \"\"\"\n The same behaviour as `math.floor`, but with precision.\n\n >>> floor(1.234, precision=2) # result: 1.23\n \"\"\"\n k = 10**precision\n return math.floor(x * k) / k\n\n\ndef is_correct_uuid(uuid_):\n try:\n val = UUID(uuid_)\n except (ValueError, TypeError):\n return False\n return str(val) == uuid_\n\n\nclass XmlFile:\n\n namespace = '{urn:1C.ru:commerceml_2}'\n\n def __init__(self, fetch_callback, xml_path_pattern, xpath_queries,\n extra_options=None):\n self.fetch_callback = fetch_callback\n self.xml_path_pattern = xml_path_pattern\n self.xpath_queries = xpath_queries\n self.extra_options = extra_options or {}\n\n @property\n def parsed_files(self):\n \"\"\"Get parsed xml files, that matched the path pattern.\"\"\"\n xml_files = glob.glob(os.path.join(\n settings.ASSETS_DIR, self.xml_path_pattern\n ))\n assert xml_files, 'Files on path {} does not exist.'.format(\n self.xml_path_pattern\n )\n return [ElementTree.parse(file) for file in xml_files]\n\n @property\n def xpaths(self):\n \"\"\"Get xpath queries for xml.\"\"\"\n return {\n name: query.format(self.namespace)\n for name, query in self.xpath_queries.items()\n }\n\n def get_data(self) -> Iterator:\n \"\"\"\n Get data from xml files.\n\n Example files with products names or prices.\n \"\"\"\n return chain.from_iterable(\n self.fetch_callback(file, self)\n for file in self.parsed_files\n )\n\n\n@contextmanager\ndef collect_errors(error_types: tuple):\n errors = []\n\n @contextmanager\n def collect():\n try:\n yield\n except error_types as error:\n errors.append(error)\n yield collect\n if errors:\n raise errors[0]\n\n\n@contextmanager\ndef download_catalog(destination):\n \"\"\"Download catalog's xml files and delete after handle them.\"\"\"\n wget_command = (\n 'wget -r -P {} ftp://{}:{}@{}/webdata/'\n ' 2>&1 | grep \"время\\|time\\|Downloaded\"'.format(\n destination,\n settings.FTP_USER,\n settings.FTP_PASS,\n settings.FTP_IP,\n )\n )\n\n try:\n subprocess.run(wget_command, timeout=DOWNLOAD_FILES_TIMEOUT, shell=True)\n except subprocess.TimeoutExpired as e:\n raise DownloadFilesError(str(e))\n\n assert os.path.exists(os.path.join(\n destination, settings.FTP_IP)), 'Files do not downloaded...'\n logger.info('Download catalog - completed...')\n\n try:\n yield\n finally:\n # remove downloaded data\n shutil.rmtree(os.path.join(destination, settings.FTP_IP))\n\n\ndef report(error):\n report_url = getattr(settings, 'SLACK_REPORT_URL', None)\n if report_url is not None:\n requests.post(\n url=report_url,\n json={\n 'text': '*Не удалось обновить каталог Shopelectro.*\\n'\n '*Время*: {}\\n'\n '*Ошибка*: {}'.format(time.ctime(), error),\n }\n )\n","path":"shopelectro/management/commands/_update_catalog/utils.py"}],"string":"[\n {\n \"content\": \"import glob\\nimport logging\\nimport math\\nimport os\\nimport shutil\\nimport subprocess\\nimport time\\nfrom contextlib import contextmanager\\nfrom itertools import chain\\nfrom typing import Iterator, Dict\\nfrom uuid import UUID\\nfrom xml.etree import ElementTree\\n\\nimport requests\\nfrom django.conf import settings\\n\\nfrom shopelectro.exception import DownloadFilesError\\n\\nlogger = logging.getLogger(__name__)\\nDOWNLOAD_FILES_TIMEOUT = 40.0\\nUUID_TYPE = str\\nData = Dict[str, Dict[str, dict]]\\nNOT_SAVE_TEMPLATE = '{entity} with name=\\\"{name}\\\" has no {field}. It\\\\'ll not be' \\\\\\n ' saved'\\n\\n\\ndef floor(x: float, precision=0) -> float:\\n \\\"\\\"\\\"\\n The same behaviour as `math.floor`, but with precision.\\n\\n >>> floor(1.234, precision=2) # result: 1.23\\n \\\"\\\"\\\"\\n k = 10**precision\\n return math.floor(x * k) / k\\n\\n\\ndef is_correct_uuid(uuid_):\\n try:\\n val = UUID(uuid_)\\n except (ValueError, TypeError):\\n return False\\n return str(val) == uuid_\\n\\n\\nclass XmlFile:\\n\\n namespace = '{urn:1C.ru:commerceml_2}'\\n\\n def __init__(self, fetch_callback, xml_path_pattern, xpath_queries,\\n extra_options=None):\\n self.fetch_callback = fetch_callback\\n self.xml_path_pattern = xml_path_pattern\\n self.xpath_queries = xpath_queries\\n self.extra_options = extra_options or {}\\n\\n @property\\n def parsed_files(self):\\n \\\"\\\"\\\"Get parsed xml files, that matched the path pattern.\\\"\\\"\\\"\\n xml_files = glob.glob(os.path.join(\\n settings.ASSETS_DIR, self.xml_path_pattern\\n ))\\n assert xml_files, 'Files on path {} does not exist.'.format(\\n self.xml_path_pattern\\n )\\n return [ElementTree.parse(file) for file in xml_files]\\n\\n @property\\n def xpaths(self):\\n \\\"\\\"\\\"Get xpath queries for xml.\\\"\\\"\\\"\\n return {\\n name: query.format(self.namespace)\\n for name, query in self.xpath_queries.items()\\n }\\n\\n def get_data(self) -> Iterator:\\n \\\"\\\"\\\"\\n Get data from xml files.\\n\\n Example files with products names or prices.\\n \\\"\\\"\\\"\\n return chain.from_iterable(\\n self.fetch_callback(file, self)\\n for file in self.parsed_files\\n )\\n\\n\\n@contextmanager\\ndef collect_errors(error_types: tuple):\\n errors = []\\n\\n @contextmanager\\n def collect():\\n try:\\n yield\\n except error_types as error:\\n errors.append(error)\\n yield collect\\n if errors:\\n raise errors[0]\\n\\n\\n@contextmanager\\ndef download_catalog(destination):\\n \\\"\\\"\\\"Download catalog's xml files and delete after handle them.\\\"\\\"\\\"\\n wget_command = (\\n 'wget -r -P {} ftp://{}:{}@{}/webdata/'\\n ' 2>&1 | grep \\\"время\\\\|time\\\\|Downloaded\\\"'.format(\\n destination,\\n settings.FTP_USER,\\n settings.FTP_PASS,\\n settings.FTP_IP,\\n )\\n )\\n\\n try:\\n subprocess.run(wget_command, timeout=DOWNLOAD_FILES_TIMEOUT, shell=True)\\n except subprocess.TimeoutExpired as e:\\n raise DownloadFilesError(str(e))\\n\\n assert os.path.exists(os.path.join(\\n destination, settings.FTP_IP)), 'Files do not downloaded...'\\n logger.info('Download catalog - completed...')\\n\\n try:\\n yield\\n finally:\\n # remove downloaded data\\n shutil.rmtree(os.path.join(destination, settings.FTP_IP))\\n\\n\\ndef report(error):\\n report_url = getattr(settings, 'SLACK_REPORT_URL', None)\\n if report_url is not None:\\n requests.post(\\n url=report_url,\\n json={\\n 'text': '*Не удалось обновить каталог Shopelectro.*\\\\n'\\n '*Время*: {}\\\\n'\\n '*Ошибка*: {}'.format(time.ctime(), error),\\n }\\n )\\n\",\n \"path\": \"shopelectro/management/commands/_update_catalog/utils.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/.drone.yml b/.drone.yml\nindex 389a46eb..de4ee2c8 100644\n--- a/.drone.yml\n+++ b/.drone.yml\n@@ -19,39 +19,32 @@ pipeline:\n when:\n event: [push, pull_request]\n \n- npm: # old `npm install`\n- image: node:slim\n+ nodejs-build: # with `npm install` inside\n+ image: docker/compose:1.22.0\n environment:\n - DEPS_DIR=/drone/deps\n commands:\n- - npm install\n- - npm install -g gulp-cli\n- - gulp build\n+ - cd docker/\n+ - cp drone_env/.env . && cp drone_env/* env_files/\n+ # nodejs build is not in `docker-build` section,\n+ # because we have this deps:\n+ # build nodejs -> gulp build -> build python-prod\n+ - docker-compose -f docker-compose-build.yml build nodejs\n+ volumes:\n+ - /var/run/docker.sock:/var/run/docker.sock\n when:\n event: [push, pull_request]\n \n-# @todo #352:30m Fix volumes collision for new drone `npm install`.\n-# `docker-compose run --rm nodejs gulp build` don't create\n-# build dir at host folder.\n-# When collision is resolved, change old `npm install` for new one.\n-\n-# npm: # new `npm install`\n-# image: docker/compose:1.17.1\n-# environment:\n-# - DEPS_DIR=/drone/deps\n-# commands:\n-# - cd docker/\n-# - cp drone_env/.env . && cp drone_env/* env_files/\n-# # nodejs build is not in `docker-build` section,\n-# # because we have this deps:\n-# # build nodejs -> gulp build -> build python-prod\n-# - docker-compose -f docker-compose-build.yml build nodejs\n-# # Build python images with sources and static files\n-# - docker-compose run --rm nodejs gulp build\n-# volumes:\n-# - /var/run/docker.sock:/var/run/docker.sock\n-# when:\n-# event: [push, pull_request]\n+ gulp-build:\n+ image: fidals/se-nodejs:dev\n+ environment:\n+ - DEPS_DIR=/drone/deps\n+ commands:\n+ - cd /usr/app/src/\n+ - gulp build\n+ - cp -r front_build/ /drone/shopelectro\n+ when:\n+ event: [push, pull_request]\n \n test:\n image: python\n@@ -98,7 +91,7 @@ pipeline:\n commands:\n - pdd --verbose\n --exclude=node_modules/**/* --exclude=static/**/*\n- --exclude=media/**/* --exclude=doc/build/**/*\n+ --exclude=media/**/*\n --exclude=.idea/**/*\n --exclude=front_build\n --exclude=front/images\n@@ -113,10 +106,9 @@ pipeline:\n environment:\n - DEPS_DIR=/drone/deps\n commands:\n- - cp -r /drone/shopelectro/build/ front/\n - cd docker\n # Build python images with sources and static files\n- - docker-compose -f docker-compose-build.yml build --no-cache nodejs python-dev python-prod\n+ - docker-compose -f docker-compose-build.yml build --no-cache python-dev python-prod\n volumes:\n - /var/run/docker.sock:/var/run/docker.sock\n when:\n@@ -139,7 +131,7 @@ pipeline:\n secrets: [ DOCKER_HUB_LOGIN, DOCKER_HUB_PASSWORD ]\n \n docker-up:\n- image: docker/compose:1.17.1\n+ image: docker/compose:1.22.0\n commands:\n - cd docker\n - cp drone_env/* env_files/\ndiff --git a/docker/dc-volumes.yml b/docker/dc-volumes.yml\ndeleted file mode 100644\nindex 6934a6f7..00000000\n--- a/docker/dc-volumes.yml\n+++ /dev/null\n@@ -1,45 +0,0 @@\n-version: '2'\n-\n-# temporary file, describes docker volumes mapping problem.\n-# Should be removed with the last pdd issue inside it.\n-\n-services:\n-\n- dc: # docker-compose in container\n- image: docker/compose:1.22.0\n- volumes:\n- - ./dc-volumes.yml:/dc-volumes.yml\n- # Map docker folder and socket according to this note:\n- # https://jpetazzo.github.io/2015/09/03/do-not-use-docker-in-docker-for-ci/\n- - /var/lib/docker:/var/lib/docker\n- - /var/run/docker.sock:/var/run/docker.sock\n- privileged: true\n- entrypoint: sh\n-\n- inner: # moves volumes\n- image: busybox\n- volumes:\n- - /build:/build\n- - /var/lib/docker:/var/lib/docker\n- - /var/run/docker.sock:/var/run/docker.sock\n-\n-\n-# @todo #449:60m Repair npm container reusing at drone.\n-# Second approach looks much more good in my taste.\n-#\n-# 1. Resolve volumes collision for `gulp build` step.\n-# How to reproduce collision:\n-# ```\n-# dc -f dc-volumes.yml run --rm dc\n-# /# docker-compose -f dc-volumes.yml run --rm inner \\\n-# sh -c \"echo 'bugaga' > /build/bu && ls build/ && cat build/bu\"\n-# bu\n-# bugaga\n-# /# ls\n-# ... no build dir\n-# ```\n-#\n-# 2. We can use \"docker-compose\" container only for `npm install`.\n-# But do gulp-build with standard drone mech.\n-# See this comment with code draft:\n-# https://github.com/fidals/shopelectro/pull/450#issuecomment-408243737\ndiff --git a/docker/docker-compose.yml b/docker/docker-compose.yml\nindex d6119f47..19da6b93 100644\n--- a/docker/docker-compose.yml\n+++ b/docker/docker-compose.yml\n@@ -44,6 +44,10 @@ services:\n #- ../gulpfile.babel.js:/usr/app/src/gulpfile.babel.js\n - ../front:/usr/app/src/front\n - ../front_build:/usr/app/src/front_build\n+ # @todo #457:15m Return back refarm deps to nodejs service.\n+\n+ # Uncomment next line if you dev refarm-site's front\n+ # - ../../refarm-site/:$DEPS_DIR/\n env_file:\n - env_files/paths\n \ndiff --git a/shopelectro/management/commands/_update_catalog/utils.py b/shopelectro/management/commands/_update_catalog/utils.py\nindex 79d4f517..fd438621 100644\n--- a/shopelectro/management/commands/_update_catalog/utils.py\n+++ b/shopelectro/management/commands/_update_catalog/utils.py\n@@ -17,7 +17,7 @@\n from shopelectro.exception import DownloadFilesError\n \n logger = logging.getLogger(__name__)\n-DOWNLOAD_FILES_TIMEOUT = 15.0\n+DOWNLOAD_FILES_TIMEOUT = 40.0\n UUID_TYPE = str\n Data = Dict[str, Dict[str, dict]]\n NOT_SAVE_TEMPLATE = '{entity} with name=\"{name}\" has no {field}. It\\'ll not be' \\\n"}}},{"rowIdx":5477,"cells":{"in_source_id":{"kind":"string","value":"saleor__saleor-3059"},"issue":{"kind":"string","value":"[Backend] [Cosmetics] CELERY_TASK_ALWAYS_EAGER strange set value\nIn settings present strange code: \r\n`CELERY_TASK_ALWAYS_EAGER = False if CELERY_BROKER_URL else True`\r\n\r\ncan easy rewrite to:\r\n`CELERY_TASK_ALWAYS_EAGER = not CELERY_BROKER_URL`\r\n\n"},"before_files":{"kind":"list like","value":[{"content":"import ast\nimport os.path\n\nimport dj_database_url\nimport dj_email_url\nimport django_cache_url\nfrom django.contrib.messages import constants as messages\nfrom django.utils.translation import gettext_lazy as _, pgettext_lazy\nfrom django_prices.templatetags.prices_i18n import get_currency_fraction\n\nfrom . import __version__\n\n\ndef get_list(text):\n return [item.strip() for item in text.split(',')]\n\n\ndef get_bool_from_env(name, default_value):\n if name in os.environ:\n value = os.environ[name]\n try:\n return ast.literal_eval(value)\n except ValueError as e:\n raise ValueError(\n '{} is an invalid value for {}'.format(value, name)) from e\n return default_value\n\n\nDEBUG = get_bool_from_env('DEBUG', True)\n\nSITE_ID = 1\n\nPROJECT_ROOT = os.path.normpath(os.path.join(os.path.dirname(__file__), '..'))\n\nROOT_URLCONF = 'saleor.urls'\n\nWSGI_APPLICATION = 'saleor.wsgi.application'\n\nADMINS = (\n # ('Your Name', 'your_email@example.com'),\n)\nMANAGERS = ADMINS\n\nINTERNAL_IPS = get_list(os.environ.get('INTERNAL_IPS', '127.0.0.1'))\n\n# Some cloud providers like Heroku export REDIS_URL variable instead of CACHE_URL\nREDIS_URL = os.environ.get('REDIS_URL')\nif REDIS_URL:\n CACHE_URL = os.environ.setdefault('CACHE_URL', REDIS_URL)\nCACHES = {'default': django_cache_url.config()}\n\nDATABASES = {\n 'default': dj_database_url.config(\n default='postgres://saleor:saleor@localhost:5432/saleor',\n conn_max_age=600)}\n\n\nTIME_ZONE = 'America/Chicago'\nLANGUAGE_CODE = 'en'\nLANGUAGES = [\n ('bg', _('Bulgarian')),\n ('cs', _('Czech')),\n ('de', _('German')),\n ('en', _('English')),\n ('es', _('Spanish')),\n ('fa-ir', _('Persian (Iran)')),\n ('fr', _('French')),\n ('hu', _('Hungarian')),\n ('it', _('Italian')),\n ('ja', _('Japanese')),\n ('ko', _('Korean')),\n ('nb', _('Norwegian')),\n ('nl', _('Dutch')),\n ('pl', _('Polish')),\n ('pt-br', _('Portuguese (Brazil)')),\n ('ro', _('Romanian')),\n ('ru', _('Russian')),\n ('ru-ru', _('Russian (Russia)')),\n ('sk', _('Slovak')),\n ('tr', _('Turkish')),\n ('uk', _('Ukrainian')),\n ('vi', _('Vietnamese')),\n ('zh-hans', _('Chinese')),\n ('zh-tw', _('Chinese (Taiwan)'))]\nLOCALE_PATHS = [os.path.join(PROJECT_ROOT, 'locale')]\nUSE_I18N = True\nUSE_L10N = True\nUSE_TZ = True\n\nFORM_RENDERER = 'django.forms.renderers.TemplatesSetting'\n\nEMAIL_URL = os.environ.get('EMAIL_URL')\nSENDGRID_USERNAME = os.environ.get('SENDGRID_USERNAME')\nSENDGRID_PASSWORD = os.environ.get('SENDGRID_PASSWORD')\nif not EMAIL_URL and SENDGRID_USERNAME and SENDGRID_PASSWORD:\n EMAIL_URL = 'smtp://%s:%s@smtp.sendgrid.net:587/?tls=True' % (\n SENDGRID_USERNAME, SENDGRID_PASSWORD)\nemail_config = dj_email_url.parse(EMAIL_URL or 'console://')\n\nEMAIL_FILE_PATH = email_config['EMAIL_FILE_PATH']\nEMAIL_HOST_USER = email_config['EMAIL_HOST_USER']\nEMAIL_HOST_PASSWORD = email_config['EMAIL_HOST_PASSWORD']\nEMAIL_HOST = email_config['EMAIL_HOST']\nEMAIL_PORT = email_config['EMAIL_PORT']\nEMAIL_BACKEND = email_config['EMAIL_BACKEND']\nEMAIL_USE_TLS = email_config['EMAIL_USE_TLS']\nEMAIL_USE_SSL = email_config['EMAIL_USE_SSL']\n\nENABLE_SSL = get_bool_from_env('ENABLE_SSL', False)\n\nif ENABLE_SSL:\n SECURE_SSL_REDIRECT = not DEBUG\n\nDEFAULT_FROM_EMAIL = os.environ.get('DEFAULT_FROM_EMAIL', EMAIL_HOST_USER)\nORDER_FROM_EMAIL = os.getenv('ORDER_FROM_EMAIL', DEFAULT_FROM_EMAIL)\n\nMEDIA_ROOT = os.path.join(PROJECT_ROOT, 'media')\nMEDIA_URL = os.environ.get('MEDIA_URL', '/media/')\n\nSTATIC_ROOT = os.path.join(PROJECT_ROOT, 'static')\nSTATIC_URL = os.environ.get('STATIC_URL', '/static/')\nSTATICFILES_DIRS = [\n ('assets', os.path.join(PROJECT_ROOT, 'saleor', 'static', 'assets')),\n ('favicons', os.path.join(PROJECT_ROOT, 'saleor', 'static', 'favicons')),\n ('images', os.path.join(PROJECT_ROOT, 'saleor', 'static', 'images')),\n ('dashboard', os.path.join(PROJECT_ROOT, 'saleor', 'static', 'dashboard'))]\nSTATICFILES_FINDERS = [\n 'django.contrib.staticfiles.finders.FileSystemFinder',\n 'django.contrib.staticfiles.finders.AppDirectoriesFinder']\n\ncontext_processors = [\n 'django.contrib.auth.context_processors.auth',\n 'django.template.context_processors.debug',\n 'django.template.context_processors.i18n',\n 'django.template.context_processors.media',\n 'django.template.context_processors.static',\n 'django.template.context_processors.tz',\n 'django.contrib.messages.context_processors.messages',\n 'django.template.context_processors.request',\n 'saleor.core.context_processors.default_currency',\n 'saleor.checkout.context_processors.cart_counter',\n 'saleor.core.context_processors.search_enabled',\n 'saleor.site.context_processors.site',\n 'social_django.context_processors.backends',\n 'social_django.context_processors.login_redirect']\n\nloaders = [\n 'django.template.loaders.filesystem.Loader',\n 'django.template.loaders.app_directories.Loader']\n\nif not DEBUG:\n loaders = [('django.template.loaders.cached.Loader', loaders)]\n\nTEMPLATES = [{\n 'BACKEND': 'django.template.backends.django.DjangoTemplates',\n 'DIRS': [os.path.join(PROJECT_ROOT, 'templates')],\n 'OPTIONS': {\n 'debug': DEBUG,\n 'context_processors': context_processors,\n 'loaders': loaders,\n 'string_if_invalid': '<< MISSING VARIABLE \"%s\" >>' if DEBUG else ''}}]\n\n# Make this unique, and don't share it with anybody.\nSECRET_KEY = os.environ.get('SECRET_KEY')\n\nMIDDLEWARE = [\n 'django.contrib.sessions.middleware.SessionMiddleware',\n 'django.middleware.security.SecurityMiddleware',\n 'django.middleware.common.CommonMiddleware',\n 'django.middleware.csrf.CsrfViewMiddleware',\n 'django.contrib.auth.middleware.AuthenticationMiddleware',\n 'django.contrib.messages.middleware.MessageMiddleware',\n 'django.middleware.locale.LocaleMiddleware',\n 'django_babel.middleware.LocaleMiddleware',\n 'saleor.core.middleware.discounts',\n 'saleor.core.middleware.google_analytics',\n 'saleor.core.middleware.country',\n 'saleor.core.middleware.currency',\n 'saleor.core.middleware.site',\n 'saleor.core.middleware.taxes',\n 'social_django.middleware.SocialAuthExceptionMiddleware',\n 'impersonate.middleware.ImpersonateMiddleware',\n 'saleor.graphql.middleware.jwt_middleware'\n]\n\nINSTALLED_APPS = [\n # External apps that need to go before django's\n 'storages',\n\n # Django modules\n 'django.contrib.contenttypes',\n 'django.contrib.sessions',\n 'django.contrib.messages',\n 'django.contrib.sitemaps',\n 'django.contrib.sites',\n 'django.contrib.staticfiles',\n 'django.contrib.auth',\n 'django.contrib.postgres',\n 'django.forms',\n\n # Local apps\n 'saleor.account',\n 'saleor.discount',\n 'saleor.product',\n 'saleor.checkout',\n 'saleor.core',\n 'saleor.graphql',\n 'saleor.menu',\n 'saleor.order.OrderAppConfig',\n 'saleor.dashboard',\n 'saleor.seo',\n 'saleor.shipping',\n 'saleor.search',\n 'saleor.site',\n 'saleor.data_feeds',\n 'saleor.page',\n\n # External apps\n 'versatileimagefield',\n 'django_babel',\n 'bootstrap4',\n 'django_measurement',\n 'django_prices',\n 'django_prices_openexchangerates',\n 'django_prices_vatlayer',\n 'graphene_django',\n 'mptt',\n 'payments',\n 'webpack_loader',\n 'social_django',\n 'django_countries',\n 'django_filters',\n 'django_celery_results',\n 'impersonate',\n 'phonenumber_field',\n 'captcha']\n\nif DEBUG:\n MIDDLEWARE.append(\n 'debug_toolbar.middleware.DebugToolbarMiddleware')\n INSTALLED_APPS.append('debug_toolbar')\n DEBUG_TOOLBAR_PANELS = [\n # adds a request history to the debug toolbar\n 'ddt_request_history.panels.request_history.RequestHistoryPanel',\n\n 'debug_toolbar.panels.versions.VersionsPanel',\n 'debug_toolbar.panels.timer.TimerPanel',\n 'debug_toolbar.panels.settings.SettingsPanel',\n 'debug_toolbar.panels.headers.HeadersPanel',\n 'debug_toolbar.panels.request.RequestPanel',\n 'debug_toolbar.panels.sql.SQLPanel',\n 'debug_toolbar.panels.templates.TemplatesPanel',\n 'debug_toolbar.panels.staticfiles.StaticFilesPanel',\n 'debug_toolbar.panels.cache.CachePanel',\n 'debug_toolbar.panels.signals.SignalsPanel',\n 'debug_toolbar.panels.logging.LoggingPanel',\n 'debug_toolbar.panels.redirects.RedirectsPanel',\n 'debug_toolbar.panels.profiling.ProfilingPanel',\n ]\n DEBUG_TOOLBAR_CONFIG = {\n 'RESULTS_CACHE_SIZE': 100}\n\nENABLE_SILK = get_bool_from_env('ENABLE_SILK', False)\nif ENABLE_SILK:\n MIDDLEWARE.insert(0, 'silk.middleware.SilkyMiddleware')\n INSTALLED_APPS.append('silk')\n\nLOGGING = {\n 'version': 1,\n 'disable_existing_loggers': False,\n 'root': {\n 'level': 'INFO',\n 'handlers': ['console']},\n 'formatters': {\n 'verbose': {\n 'format': (\n '%(levelname)s %(name)s %(message)s'\n ' [PID:%(process)d:%(threadName)s]')},\n 'simple': {\n 'format': '%(levelname)s %(message)s'}},\n 'filters': {\n 'require_debug_false': {\n '()': 'django.utils.log.RequireDebugFalse'}},\n 'handlers': {\n 'mail_admins': {\n 'level': 'ERROR',\n 'filters': ['require_debug_false'],\n 'class': 'django.utils.log.AdminEmailHandler'},\n 'console': {\n 'level': 'DEBUG',\n 'class': 'logging.StreamHandler',\n 'formatter': 'verbose'}},\n 'loggers': {\n 'django': {\n 'handlers': ['console', 'mail_admins'],\n 'level': 'INFO',\n 'propagate': True},\n 'django.server': {\n 'handlers': ['console'],\n 'level': 'INFO',\n 'propagate': True},\n 'saleor': {\n 'handlers': ['console'],\n 'level': 'DEBUG',\n 'propagate': True}}}\n\nAUTH_USER_MODEL = 'account.User'\n\nLOGIN_URL = '/account/login/'\n\nDEFAULT_COUNTRY = os.environ.get('DEFAULT_COUNTRY', 'US')\nDEFAULT_CURRENCY = os.environ.get('DEFAULT_CURRENCY', 'USD')\nDEFAULT_DECIMAL_PLACES = get_currency_fraction(DEFAULT_CURRENCY)\nAVAILABLE_CURRENCIES = [DEFAULT_CURRENCY]\nCOUNTRIES_OVERRIDE = {\n 'EU': pgettext_lazy(\n 'Name of political and economical union of european countries',\n 'European Union')}\n\nOPENEXCHANGERATES_API_KEY = os.environ.get('OPENEXCHANGERATES_API_KEY')\n\n# VAT configuration\n# Enabling vat requires valid vatlayer access key.\n# If you are subscribed to a paid vatlayer plan, you can enable HTTPS.\nVATLAYER_ACCESS_KEY = os.environ.get('VATLAYER_ACCESS_KEY')\nVATLAYER_USE_HTTPS = get_bool_from_env('VATLAYER_USE_HTTPS', False)\n\nACCOUNT_ACTIVATION_DAYS = 3\n\nLOGIN_REDIRECT_URL = 'home'\n\nGOOGLE_ANALYTICS_TRACKING_ID = os.environ.get('GOOGLE_ANALYTICS_TRACKING_ID')\n\n\ndef get_host():\n from django.contrib.sites.models import Site\n return Site.objects.get_current().domain\n\n\nPAYMENT_HOST = get_host\n\nPAYMENT_MODEL = 'order.Payment'\n\nPAYMENT_VARIANTS = {\n 'default': ('payments.dummy.DummyProvider', {})}\n\nSESSION_SERIALIZER = 'django.contrib.sessions.serializers.JSONSerializer'\n\n# Do not use cached session if locmem cache backend is used but fallback to use\n# default django.contrib.sessions.backends.db instead\nif not CACHES['default']['BACKEND'].endswith('LocMemCache'):\n SESSION_ENGINE = 'django.contrib.sessions.backends.cached_db'\n\nCHECKOUT_PAYMENT_CHOICES = [\n ('default', 'Dummy provider')]\n\nMESSAGE_TAGS = {\n messages.ERROR: 'danger'}\n\nLOW_STOCK_THRESHOLD = 10\nMAX_CART_LINE_QUANTITY = int(os.environ.get('MAX_CART_LINE_QUANTITY', 50))\n\nPAGINATE_BY = 16\nDASHBOARD_PAGINATE_BY = 30\nDASHBOARD_SEARCH_LIMIT = 5\n\nbootstrap4 = {\n 'set_placeholder': False,\n 'set_required': False,\n 'success_css_class': '',\n 'form_renderers': {\n 'default': 'saleor.core.utils.form_renderer.FormRenderer'}}\n\nTEST_RUNNER = ''\n\nALLOWED_HOSTS = get_list(\n os.environ.get('ALLOWED_HOSTS', 'localhost,127.0.0.1'))\n\nSECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https')\n\n# Amazon S3 configuration\nAWS_ACCESS_KEY_ID = os.environ.get('AWS_ACCESS_KEY_ID')\nAWS_LOCATION = os.environ.get('AWS_LOCATION', '')\nAWS_MEDIA_BUCKET_NAME = os.environ.get('AWS_MEDIA_BUCKET_NAME')\nAWS_MEDIA_CUSTOM_DOMAIN = os.environ.get('AWS_MEDIA_CUSTOM_DOMAIN')\nAWS_QUERYSTRING_AUTH = get_bool_from_env('AWS_QUERYSTRING_AUTH', False)\nAWS_S3_CUSTOM_DOMAIN = os.environ.get('AWS_STATIC_CUSTOM_DOMAIN')\nAWS_SECRET_ACCESS_KEY = os.environ.get('AWS_SECRET_ACCESS_KEY')\nAWS_STORAGE_BUCKET_NAME = os.environ.get('AWS_STORAGE_BUCKET_NAME')\n\nif AWS_STORAGE_BUCKET_NAME:\n STATICFILES_STORAGE = 'storages.backends.s3boto3.S3Boto3Storage'\n\nif AWS_MEDIA_BUCKET_NAME:\n DEFAULT_FILE_STORAGE = 'saleor.core.storages.S3MediaStorage'\n THUMBNAIL_DEFAULT_STORAGE = DEFAULT_FILE_STORAGE\n\nMESSAGE_STORAGE = 'django.contrib.messages.storage.session.SessionStorage'\n\nVERSATILEIMAGEFIELD_RENDITION_KEY_SETS = {\n 'products': [\n ('product_gallery', 'thumbnail__540x540'),\n ('product_gallery_2x', 'thumbnail__1080x1080'),\n ('product_small', 'thumbnail__60x60'),\n ('product_small_2x', 'thumbnail__120x120'),\n ('product_list', 'thumbnail__255x255'),\n ('product_list_2x', 'thumbnail__510x510')]}\n\nVERSATILEIMAGEFIELD_SETTINGS = {\n # Images should be pre-generated on Production environment\n 'create_images_on_demand': get_bool_from_env(\n 'CREATE_IMAGES_ON_DEMAND', DEBUG),\n}\n\nPLACEHOLDER_IMAGES = {\n 60: 'images/placeholder60x60.png',\n 120: 'images/placeholder120x120.png',\n 255: 'images/placeholder255x255.png',\n 540: 'images/placeholder540x540.png',\n 1080: 'images/placeholder1080x1080.png'}\n\nDEFAULT_PLACEHOLDER = 'images/placeholder255x255.png'\n\nWEBPACK_LOADER = {\n 'DEFAULT': {\n 'CACHE': not DEBUG,\n 'BUNDLE_DIR_NAME': 'assets/',\n 'STATS_FILE': os.path.join(PROJECT_ROOT, 'webpack-bundle.json'),\n 'POLL_INTERVAL': 0.1,\n 'IGNORE': [\n r'.+\\.hot-update\\.js',\n r'.+\\.map']}}\n\n\nLOGOUT_ON_PASSWORD_CHANGE = False\n\n# SEARCH CONFIGURATION\nDB_SEARCH_ENABLED = True\n\n# support deployment-dependant elastic enviroment variable\nES_URL = (os.environ.get('ELASTICSEARCH_URL') or\n os.environ.get('SEARCHBOX_URL') or os.environ.get('BONSAI_URL'))\n\nENABLE_SEARCH = bool(ES_URL) or DB_SEARCH_ENABLED # global search disabling\n\nSEARCH_BACKEND = 'saleor.search.backends.postgresql'\n\nif ES_URL:\n SEARCH_BACKEND = 'saleor.search.backends.elasticsearch'\n INSTALLED_APPS.append('django_elasticsearch_dsl')\n ELASTICSEARCH_DSL = {\n 'default': {\n 'hosts': ES_URL}}\n\nAUTHENTICATION_BACKENDS = [\n 'saleor.account.backends.facebook.CustomFacebookOAuth2',\n 'saleor.account.backends.google.CustomGoogleOAuth2',\n 'graphql_jwt.backends.JSONWebTokenBackend',\n 'django.contrib.auth.backends.ModelBackend']\n\nSOCIAL_AUTH_PIPELINE = [\n 'social_core.pipeline.social_auth.social_details',\n 'social_core.pipeline.social_auth.social_uid',\n 'social_core.pipeline.social_auth.auth_allowed',\n 'social_core.pipeline.social_auth.social_user',\n 'social_core.pipeline.social_auth.associate_by_email',\n 'social_core.pipeline.user.create_user',\n 'social_core.pipeline.social_auth.associate_user',\n 'social_core.pipeline.social_auth.load_extra_data',\n 'social_core.pipeline.user.user_details']\n\nSOCIAL_AUTH_USERNAME_IS_FULL_EMAIL = True\nSOCIAL_AUTH_USER_MODEL = AUTH_USER_MODEL\nSOCIAL_AUTH_FACEBOOK_SCOPE = ['email']\nSOCIAL_AUTH_FACEBOOK_PROFILE_EXTRA_PARAMS = {\n 'fields': 'id, email'}\n# As per March 2018, Facebook requires all traffic to go through HTTPS only\nSOCIAL_AUTH_REDIRECT_IS_HTTPS = True\n\n# CELERY SETTINGS\nCELERY_BROKER_URL = os.environ.get(\n 'CELERY_BROKER_URL', os.environ.get('CLOUDAMQP_URL')) or ''\nCELERY_TASK_ALWAYS_EAGER = False if CELERY_BROKER_URL else True\nCELERY_ACCEPT_CONTENT = ['json']\nCELERY_TASK_SERIALIZER = 'json'\nCELERY_RESULT_SERIALIZER = 'json'\nCELERY_RESULT_BACKEND = 'django-db'\n\n# Impersonate module settings\nIMPERSONATE = {\n 'URI_EXCLUSIONS': [r'^dashboard/'],\n 'CUSTOM_USER_QUERYSET': 'saleor.account.impersonate.get_impersonatable_users', # noqa\n 'USE_HTTP_REFERER': True,\n 'CUSTOM_ALLOW': 'saleor.account.impersonate.can_impersonate'}\n\n\n# Rich-text editor\nALLOWED_TAGS = [\n 'a',\n 'b',\n 'blockquote',\n 'br',\n 'em',\n 'h2',\n 'h3',\n 'i',\n 'img',\n 'li',\n 'ol',\n 'p',\n 'strong',\n 'ul']\nALLOWED_ATTRIBUTES = {\n '*': ['align', 'style'],\n 'a': ['href', 'title'],\n 'img': ['src']}\nALLOWED_STYLES = ['text-align']\n\n\n# Slugs for menus precreated in Django migrations\nDEFAULT_MENUS = {\n 'top_menu_name': 'navbar',\n 'bottom_menu_name': 'footer'}\n\n# This enable the new 'No Captcha reCaptcha' version (the simple checkbox)\n# instead of the old (deprecated) one. For more information see:\n# https://github.com/praekelt/django-recaptcha/blob/34af16ba1e/README.rst\nNOCAPTCHA = True\n\n# Set Google's reCaptcha keys\nRECAPTCHA_PUBLIC_KEY = os.environ.get('RECAPTCHA_PUBLIC_KEY')\nRECAPTCHA_PRIVATE_KEY = os.environ.get('RECAPTCHA_PRIVATE_KEY')\n\n\n# Sentry\nSENTRY_DSN = os.environ.get('SENTRY_DSN')\nif SENTRY_DSN:\n INSTALLED_APPS.append('raven.contrib.django.raven_compat')\n RAVEN_CONFIG = {\n 'dsn': SENTRY_DSN,\n 'release': __version__}\n\n\nSERIALIZATION_MODULES = {\n 'json': 'saleor.core.utils.json_serializer'}\n","path":"saleor/settings.py"}],"string":"[\n {\n \"content\": \"import ast\\nimport os.path\\n\\nimport dj_database_url\\nimport dj_email_url\\nimport django_cache_url\\nfrom django.contrib.messages import constants as messages\\nfrom django.utils.translation import gettext_lazy as _, pgettext_lazy\\nfrom django_prices.templatetags.prices_i18n import get_currency_fraction\\n\\nfrom . import __version__\\n\\n\\ndef get_list(text):\\n return [item.strip() for item in text.split(',')]\\n\\n\\ndef get_bool_from_env(name, default_value):\\n if name in os.environ:\\n value = os.environ[name]\\n try:\\n return ast.literal_eval(value)\\n except ValueError as e:\\n raise ValueError(\\n '{} is an invalid value for {}'.format(value, name)) from e\\n return default_value\\n\\n\\nDEBUG = get_bool_from_env('DEBUG', True)\\n\\nSITE_ID = 1\\n\\nPROJECT_ROOT = os.path.normpath(os.path.join(os.path.dirname(__file__), '..'))\\n\\nROOT_URLCONF = 'saleor.urls'\\n\\nWSGI_APPLICATION = 'saleor.wsgi.application'\\n\\nADMINS = (\\n # ('Your Name', 'your_email@example.com'),\\n)\\nMANAGERS = ADMINS\\n\\nINTERNAL_IPS = get_list(os.environ.get('INTERNAL_IPS', '127.0.0.1'))\\n\\n# Some cloud providers like Heroku export REDIS_URL variable instead of CACHE_URL\\nREDIS_URL = os.environ.get('REDIS_URL')\\nif REDIS_URL:\\n CACHE_URL = os.environ.setdefault('CACHE_URL', REDIS_URL)\\nCACHES = {'default': django_cache_url.config()}\\n\\nDATABASES = {\\n 'default': dj_database_url.config(\\n default='postgres://saleor:saleor@localhost:5432/saleor',\\n conn_max_age=600)}\\n\\n\\nTIME_ZONE = 'America/Chicago'\\nLANGUAGE_CODE = 'en'\\nLANGUAGES = [\\n ('bg', _('Bulgarian')),\\n ('cs', _('Czech')),\\n ('de', _('German')),\\n ('en', _('English')),\\n ('es', _('Spanish')),\\n ('fa-ir', _('Persian (Iran)')),\\n ('fr', _('French')),\\n ('hu', _('Hungarian')),\\n ('it', _('Italian')),\\n ('ja', _('Japanese')),\\n ('ko', _('Korean')),\\n ('nb', _('Norwegian')),\\n ('nl', _('Dutch')),\\n ('pl', _('Polish')),\\n ('pt-br', _('Portuguese (Brazil)')),\\n ('ro', _('Romanian')),\\n ('ru', _('Russian')),\\n ('ru-ru', _('Russian (Russia)')),\\n ('sk', _('Slovak')),\\n ('tr', _('Turkish')),\\n ('uk', _('Ukrainian')),\\n ('vi', _('Vietnamese')),\\n ('zh-hans', _('Chinese')),\\n ('zh-tw', _('Chinese (Taiwan)'))]\\nLOCALE_PATHS = [os.path.join(PROJECT_ROOT, 'locale')]\\nUSE_I18N = True\\nUSE_L10N = True\\nUSE_TZ = True\\n\\nFORM_RENDERER = 'django.forms.renderers.TemplatesSetting'\\n\\nEMAIL_URL = os.environ.get('EMAIL_URL')\\nSENDGRID_USERNAME = os.environ.get('SENDGRID_USERNAME')\\nSENDGRID_PASSWORD = os.environ.get('SENDGRID_PASSWORD')\\nif not EMAIL_URL and SENDGRID_USERNAME and SENDGRID_PASSWORD:\\n EMAIL_URL = 'smtp://%s:%s@smtp.sendgrid.net:587/?tls=True' % (\\n SENDGRID_USERNAME, SENDGRID_PASSWORD)\\nemail_config = dj_email_url.parse(EMAIL_URL or 'console://')\\n\\nEMAIL_FILE_PATH = email_config['EMAIL_FILE_PATH']\\nEMAIL_HOST_USER = email_config['EMAIL_HOST_USER']\\nEMAIL_HOST_PASSWORD = email_config['EMAIL_HOST_PASSWORD']\\nEMAIL_HOST = email_config['EMAIL_HOST']\\nEMAIL_PORT = email_config['EMAIL_PORT']\\nEMAIL_BACKEND = email_config['EMAIL_BACKEND']\\nEMAIL_USE_TLS = email_config['EMAIL_USE_TLS']\\nEMAIL_USE_SSL = email_config['EMAIL_USE_SSL']\\n\\nENABLE_SSL = get_bool_from_env('ENABLE_SSL', False)\\n\\nif ENABLE_SSL:\\n SECURE_SSL_REDIRECT = not DEBUG\\n\\nDEFAULT_FROM_EMAIL = os.environ.get('DEFAULT_FROM_EMAIL', EMAIL_HOST_USER)\\nORDER_FROM_EMAIL = os.getenv('ORDER_FROM_EMAIL', DEFAULT_FROM_EMAIL)\\n\\nMEDIA_ROOT = os.path.join(PROJECT_ROOT, 'media')\\nMEDIA_URL = os.environ.get('MEDIA_URL', '/media/')\\n\\nSTATIC_ROOT = os.path.join(PROJECT_ROOT, 'static')\\nSTATIC_URL = os.environ.get('STATIC_URL', '/static/')\\nSTATICFILES_DIRS = [\\n ('assets', os.path.join(PROJECT_ROOT, 'saleor', 'static', 'assets')),\\n ('favicons', os.path.join(PROJECT_ROOT, 'saleor', 'static', 'favicons')),\\n ('images', os.path.join(PROJECT_ROOT, 'saleor', 'static', 'images')),\\n ('dashboard', os.path.join(PROJECT_ROOT, 'saleor', 'static', 'dashboard'))]\\nSTATICFILES_FINDERS = [\\n 'django.contrib.staticfiles.finders.FileSystemFinder',\\n 'django.contrib.staticfiles.finders.AppDirectoriesFinder']\\n\\ncontext_processors = [\\n 'django.contrib.auth.context_processors.auth',\\n 'django.template.context_processors.debug',\\n 'django.template.context_processors.i18n',\\n 'django.template.context_processors.media',\\n 'django.template.context_processors.static',\\n 'django.template.context_processors.tz',\\n 'django.contrib.messages.context_processors.messages',\\n 'django.template.context_processors.request',\\n 'saleor.core.context_processors.default_currency',\\n 'saleor.checkout.context_processors.cart_counter',\\n 'saleor.core.context_processors.search_enabled',\\n 'saleor.site.context_processors.site',\\n 'social_django.context_processors.backends',\\n 'social_django.context_processors.login_redirect']\\n\\nloaders = [\\n 'django.template.loaders.filesystem.Loader',\\n 'django.template.loaders.app_directories.Loader']\\n\\nif not DEBUG:\\n loaders = [('django.template.loaders.cached.Loader', loaders)]\\n\\nTEMPLATES = [{\\n 'BACKEND': 'django.template.backends.django.DjangoTemplates',\\n 'DIRS': [os.path.join(PROJECT_ROOT, 'templates')],\\n 'OPTIONS': {\\n 'debug': DEBUG,\\n 'context_processors': context_processors,\\n 'loaders': loaders,\\n 'string_if_invalid': '<< MISSING VARIABLE \\\"%s\\\" >>' if DEBUG else ''}}]\\n\\n# Make this unique, and don't share it with anybody.\\nSECRET_KEY = os.environ.get('SECRET_KEY')\\n\\nMIDDLEWARE = [\\n 'django.contrib.sessions.middleware.SessionMiddleware',\\n 'django.middleware.security.SecurityMiddleware',\\n 'django.middleware.common.CommonMiddleware',\\n 'django.middleware.csrf.CsrfViewMiddleware',\\n 'django.contrib.auth.middleware.AuthenticationMiddleware',\\n 'django.contrib.messages.middleware.MessageMiddleware',\\n 'django.middleware.locale.LocaleMiddleware',\\n 'django_babel.middleware.LocaleMiddleware',\\n 'saleor.core.middleware.discounts',\\n 'saleor.core.middleware.google_analytics',\\n 'saleor.core.middleware.country',\\n 'saleor.core.middleware.currency',\\n 'saleor.core.middleware.site',\\n 'saleor.core.middleware.taxes',\\n 'social_django.middleware.SocialAuthExceptionMiddleware',\\n 'impersonate.middleware.ImpersonateMiddleware',\\n 'saleor.graphql.middleware.jwt_middleware'\\n]\\n\\nINSTALLED_APPS = [\\n # External apps that need to go before django's\\n 'storages',\\n\\n # Django modules\\n 'django.contrib.contenttypes',\\n 'django.contrib.sessions',\\n 'django.contrib.messages',\\n 'django.contrib.sitemaps',\\n 'django.contrib.sites',\\n 'django.contrib.staticfiles',\\n 'django.contrib.auth',\\n 'django.contrib.postgres',\\n 'django.forms',\\n\\n # Local apps\\n 'saleor.account',\\n 'saleor.discount',\\n 'saleor.product',\\n 'saleor.checkout',\\n 'saleor.core',\\n 'saleor.graphql',\\n 'saleor.menu',\\n 'saleor.order.OrderAppConfig',\\n 'saleor.dashboard',\\n 'saleor.seo',\\n 'saleor.shipping',\\n 'saleor.search',\\n 'saleor.site',\\n 'saleor.data_feeds',\\n 'saleor.page',\\n\\n # External apps\\n 'versatileimagefield',\\n 'django_babel',\\n 'bootstrap4',\\n 'django_measurement',\\n 'django_prices',\\n 'django_prices_openexchangerates',\\n 'django_prices_vatlayer',\\n 'graphene_django',\\n 'mptt',\\n 'payments',\\n 'webpack_loader',\\n 'social_django',\\n 'django_countries',\\n 'django_filters',\\n 'django_celery_results',\\n 'impersonate',\\n 'phonenumber_field',\\n 'captcha']\\n\\nif DEBUG:\\n MIDDLEWARE.append(\\n 'debug_toolbar.middleware.DebugToolbarMiddleware')\\n INSTALLED_APPS.append('debug_toolbar')\\n DEBUG_TOOLBAR_PANELS = [\\n # adds a request history to the debug toolbar\\n 'ddt_request_history.panels.request_history.RequestHistoryPanel',\\n\\n 'debug_toolbar.panels.versions.VersionsPanel',\\n 'debug_toolbar.panels.timer.TimerPanel',\\n 'debug_toolbar.panels.settings.SettingsPanel',\\n 'debug_toolbar.panels.headers.HeadersPanel',\\n 'debug_toolbar.panels.request.RequestPanel',\\n 'debug_toolbar.panels.sql.SQLPanel',\\n 'debug_toolbar.panels.templates.TemplatesPanel',\\n 'debug_toolbar.panels.staticfiles.StaticFilesPanel',\\n 'debug_toolbar.panels.cache.CachePanel',\\n 'debug_toolbar.panels.signals.SignalsPanel',\\n 'debug_toolbar.panels.logging.LoggingPanel',\\n 'debug_toolbar.panels.redirects.RedirectsPanel',\\n 'debug_toolbar.panels.profiling.ProfilingPanel',\\n ]\\n DEBUG_TOOLBAR_CONFIG = {\\n 'RESULTS_CACHE_SIZE': 100}\\n\\nENABLE_SILK = get_bool_from_env('ENABLE_SILK', False)\\nif ENABLE_SILK:\\n MIDDLEWARE.insert(0, 'silk.middleware.SilkyMiddleware')\\n INSTALLED_APPS.append('silk')\\n\\nLOGGING = {\\n 'version': 1,\\n 'disable_existing_loggers': False,\\n 'root': {\\n 'level': 'INFO',\\n 'handlers': ['console']},\\n 'formatters': {\\n 'verbose': {\\n 'format': (\\n '%(levelname)s %(name)s %(message)s'\\n ' [PID:%(process)d:%(threadName)s]')},\\n 'simple': {\\n 'format': '%(levelname)s %(message)s'}},\\n 'filters': {\\n 'require_debug_false': {\\n '()': 'django.utils.log.RequireDebugFalse'}},\\n 'handlers': {\\n 'mail_admins': {\\n 'level': 'ERROR',\\n 'filters': ['require_debug_false'],\\n 'class': 'django.utils.log.AdminEmailHandler'},\\n 'console': {\\n 'level': 'DEBUG',\\n 'class': 'logging.StreamHandler',\\n 'formatter': 'verbose'}},\\n 'loggers': {\\n 'django': {\\n 'handlers': ['console', 'mail_admins'],\\n 'level': 'INFO',\\n 'propagate': True},\\n 'django.server': {\\n 'handlers': ['console'],\\n 'level': 'INFO',\\n 'propagate': True},\\n 'saleor': {\\n 'handlers': ['console'],\\n 'level': 'DEBUG',\\n 'propagate': True}}}\\n\\nAUTH_USER_MODEL = 'account.User'\\n\\nLOGIN_URL = '/account/login/'\\n\\nDEFAULT_COUNTRY = os.environ.get('DEFAULT_COUNTRY', 'US')\\nDEFAULT_CURRENCY = os.environ.get('DEFAULT_CURRENCY', 'USD')\\nDEFAULT_DECIMAL_PLACES = get_currency_fraction(DEFAULT_CURRENCY)\\nAVAILABLE_CURRENCIES = [DEFAULT_CURRENCY]\\nCOUNTRIES_OVERRIDE = {\\n 'EU': pgettext_lazy(\\n 'Name of political and economical union of european countries',\\n 'European Union')}\\n\\nOPENEXCHANGERATES_API_KEY = os.environ.get('OPENEXCHANGERATES_API_KEY')\\n\\n# VAT configuration\\n# Enabling vat requires valid vatlayer access key.\\n# If you are subscribed to a paid vatlayer plan, you can enable HTTPS.\\nVATLAYER_ACCESS_KEY = os.environ.get('VATLAYER_ACCESS_KEY')\\nVATLAYER_USE_HTTPS = get_bool_from_env('VATLAYER_USE_HTTPS', False)\\n\\nACCOUNT_ACTIVATION_DAYS = 3\\n\\nLOGIN_REDIRECT_URL = 'home'\\n\\nGOOGLE_ANALYTICS_TRACKING_ID = os.environ.get('GOOGLE_ANALYTICS_TRACKING_ID')\\n\\n\\ndef get_host():\\n from django.contrib.sites.models import Site\\n return Site.objects.get_current().domain\\n\\n\\nPAYMENT_HOST = get_host\\n\\nPAYMENT_MODEL = 'order.Payment'\\n\\nPAYMENT_VARIANTS = {\\n 'default': ('payments.dummy.DummyProvider', {})}\\n\\nSESSION_SERIALIZER = 'django.contrib.sessions.serializers.JSONSerializer'\\n\\n# Do not use cached session if locmem cache backend is used but fallback to use\\n# default django.contrib.sessions.backends.db instead\\nif not CACHES['default']['BACKEND'].endswith('LocMemCache'):\\n SESSION_ENGINE = 'django.contrib.sessions.backends.cached_db'\\n\\nCHECKOUT_PAYMENT_CHOICES = [\\n ('default', 'Dummy provider')]\\n\\nMESSAGE_TAGS = {\\n messages.ERROR: 'danger'}\\n\\nLOW_STOCK_THRESHOLD = 10\\nMAX_CART_LINE_QUANTITY = int(os.environ.get('MAX_CART_LINE_QUANTITY', 50))\\n\\nPAGINATE_BY = 16\\nDASHBOARD_PAGINATE_BY = 30\\nDASHBOARD_SEARCH_LIMIT = 5\\n\\nbootstrap4 = {\\n 'set_placeholder': False,\\n 'set_required': False,\\n 'success_css_class': '',\\n 'form_renderers': {\\n 'default': 'saleor.core.utils.form_renderer.FormRenderer'}}\\n\\nTEST_RUNNER = ''\\n\\nALLOWED_HOSTS = get_list(\\n os.environ.get('ALLOWED_HOSTS', 'localhost,127.0.0.1'))\\n\\nSECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https')\\n\\n# Amazon S3 configuration\\nAWS_ACCESS_KEY_ID = os.environ.get('AWS_ACCESS_KEY_ID')\\nAWS_LOCATION = os.environ.get('AWS_LOCATION', '')\\nAWS_MEDIA_BUCKET_NAME = os.environ.get('AWS_MEDIA_BUCKET_NAME')\\nAWS_MEDIA_CUSTOM_DOMAIN = os.environ.get('AWS_MEDIA_CUSTOM_DOMAIN')\\nAWS_QUERYSTRING_AUTH = get_bool_from_env('AWS_QUERYSTRING_AUTH', False)\\nAWS_S3_CUSTOM_DOMAIN = os.environ.get('AWS_STATIC_CUSTOM_DOMAIN')\\nAWS_SECRET_ACCESS_KEY = os.environ.get('AWS_SECRET_ACCESS_KEY')\\nAWS_STORAGE_BUCKET_NAME = os.environ.get('AWS_STORAGE_BUCKET_NAME')\\n\\nif AWS_STORAGE_BUCKET_NAME:\\n STATICFILES_STORAGE = 'storages.backends.s3boto3.S3Boto3Storage'\\n\\nif AWS_MEDIA_BUCKET_NAME:\\n DEFAULT_FILE_STORAGE = 'saleor.core.storages.S3MediaStorage'\\n THUMBNAIL_DEFAULT_STORAGE = DEFAULT_FILE_STORAGE\\n\\nMESSAGE_STORAGE = 'django.contrib.messages.storage.session.SessionStorage'\\n\\nVERSATILEIMAGEFIELD_RENDITION_KEY_SETS = {\\n 'products': [\\n ('product_gallery', 'thumbnail__540x540'),\\n ('product_gallery_2x', 'thumbnail__1080x1080'),\\n ('product_small', 'thumbnail__60x60'),\\n ('product_small_2x', 'thumbnail__120x120'),\\n ('product_list', 'thumbnail__255x255'),\\n ('product_list_2x', 'thumbnail__510x510')]}\\n\\nVERSATILEIMAGEFIELD_SETTINGS = {\\n # Images should be pre-generated on Production environment\\n 'create_images_on_demand': get_bool_from_env(\\n 'CREATE_IMAGES_ON_DEMAND', DEBUG),\\n}\\n\\nPLACEHOLDER_IMAGES = {\\n 60: 'images/placeholder60x60.png',\\n 120: 'images/placeholder120x120.png',\\n 255: 'images/placeholder255x255.png',\\n 540: 'images/placeholder540x540.png',\\n 1080: 'images/placeholder1080x1080.png'}\\n\\nDEFAULT_PLACEHOLDER = 'images/placeholder255x255.png'\\n\\nWEBPACK_LOADER = {\\n 'DEFAULT': {\\n 'CACHE': not DEBUG,\\n 'BUNDLE_DIR_NAME': 'assets/',\\n 'STATS_FILE': os.path.join(PROJECT_ROOT, 'webpack-bundle.json'),\\n 'POLL_INTERVAL': 0.1,\\n 'IGNORE': [\\n r'.+\\\\.hot-update\\\\.js',\\n r'.+\\\\.map']}}\\n\\n\\nLOGOUT_ON_PASSWORD_CHANGE = False\\n\\n# SEARCH CONFIGURATION\\nDB_SEARCH_ENABLED = True\\n\\n# support deployment-dependant elastic enviroment variable\\nES_URL = (os.environ.get('ELASTICSEARCH_URL') or\\n os.environ.get('SEARCHBOX_URL') or os.environ.get('BONSAI_URL'))\\n\\nENABLE_SEARCH = bool(ES_URL) or DB_SEARCH_ENABLED # global search disabling\\n\\nSEARCH_BACKEND = 'saleor.search.backends.postgresql'\\n\\nif ES_URL:\\n SEARCH_BACKEND = 'saleor.search.backends.elasticsearch'\\n INSTALLED_APPS.append('django_elasticsearch_dsl')\\n ELASTICSEARCH_DSL = {\\n 'default': {\\n 'hosts': ES_URL}}\\n\\nAUTHENTICATION_BACKENDS = [\\n 'saleor.account.backends.facebook.CustomFacebookOAuth2',\\n 'saleor.account.backends.google.CustomGoogleOAuth2',\\n 'graphql_jwt.backends.JSONWebTokenBackend',\\n 'django.contrib.auth.backends.ModelBackend']\\n\\nSOCIAL_AUTH_PIPELINE = [\\n 'social_core.pipeline.social_auth.social_details',\\n 'social_core.pipeline.social_auth.social_uid',\\n 'social_core.pipeline.social_auth.auth_allowed',\\n 'social_core.pipeline.social_auth.social_user',\\n 'social_core.pipeline.social_auth.associate_by_email',\\n 'social_core.pipeline.user.create_user',\\n 'social_core.pipeline.social_auth.associate_user',\\n 'social_core.pipeline.social_auth.load_extra_data',\\n 'social_core.pipeline.user.user_details']\\n\\nSOCIAL_AUTH_USERNAME_IS_FULL_EMAIL = True\\nSOCIAL_AUTH_USER_MODEL = AUTH_USER_MODEL\\nSOCIAL_AUTH_FACEBOOK_SCOPE = ['email']\\nSOCIAL_AUTH_FACEBOOK_PROFILE_EXTRA_PARAMS = {\\n 'fields': 'id, email'}\\n# As per March 2018, Facebook requires all traffic to go through HTTPS only\\nSOCIAL_AUTH_REDIRECT_IS_HTTPS = True\\n\\n# CELERY SETTINGS\\nCELERY_BROKER_URL = os.environ.get(\\n 'CELERY_BROKER_URL', os.environ.get('CLOUDAMQP_URL')) or ''\\nCELERY_TASK_ALWAYS_EAGER = False if CELERY_BROKER_URL else True\\nCELERY_ACCEPT_CONTENT = ['json']\\nCELERY_TASK_SERIALIZER = 'json'\\nCELERY_RESULT_SERIALIZER = 'json'\\nCELERY_RESULT_BACKEND = 'django-db'\\n\\n# Impersonate module settings\\nIMPERSONATE = {\\n 'URI_EXCLUSIONS': [r'^dashboard/'],\\n 'CUSTOM_USER_QUERYSET': 'saleor.account.impersonate.get_impersonatable_users', # noqa\\n 'USE_HTTP_REFERER': True,\\n 'CUSTOM_ALLOW': 'saleor.account.impersonate.can_impersonate'}\\n\\n\\n# Rich-text editor\\nALLOWED_TAGS = [\\n 'a',\\n 'b',\\n 'blockquote',\\n 'br',\\n 'em',\\n 'h2',\\n 'h3',\\n 'i',\\n 'img',\\n 'li',\\n 'ol',\\n 'p',\\n 'strong',\\n 'ul']\\nALLOWED_ATTRIBUTES = {\\n '*': ['align', 'style'],\\n 'a': ['href', 'title'],\\n 'img': ['src']}\\nALLOWED_STYLES = ['text-align']\\n\\n\\n# Slugs for menus precreated in Django migrations\\nDEFAULT_MENUS = {\\n 'top_menu_name': 'navbar',\\n 'bottom_menu_name': 'footer'}\\n\\n# This enable the new 'No Captcha reCaptcha' version (the simple checkbox)\\n# instead of the old (deprecated) one. For more information see:\\n# https://github.com/praekelt/django-recaptcha/blob/34af16ba1e/README.rst\\nNOCAPTCHA = True\\n\\n# Set Google's reCaptcha keys\\nRECAPTCHA_PUBLIC_KEY = os.environ.get('RECAPTCHA_PUBLIC_KEY')\\nRECAPTCHA_PRIVATE_KEY = os.environ.get('RECAPTCHA_PRIVATE_KEY')\\n\\n\\n# Sentry\\nSENTRY_DSN = os.environ.get('SENTRY_DSN')\\nif SENTRY_DSN:\\n INSTALLED_APPS.append('raven.contrib.django.raven_compat')\\n RAVEN_CONFIG = {\\n 'dsn': SENTRY_DSN,\\n 'release': __version__}\\n\\n\\nSERIALIZATION_MODULES = {\\n 'json': 'saleor.core.utils.json_serializer'}\\n\",\n \"path\": \"saleor/settings.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"import ast\nimport os.path\n\nimport dj_database_url\nimport dj_email_url\nimport django_cache_url\nfrom django.contrib.messages import constants as messages\nfrom django.utils.translation import gettext_lazy as _, pgettext_lazy\nfrom django_prices.templatetags.prices_i18n import get_currency_fraction\n\nfrom . import __version__\n\n\ndef get_list(text):\n return [item.strip() for item in text.split(',')]\n\n\ndef get_bool_from_env(name, default_value):\n if name in os.environ:\n value = os.environ[name]\n try:\n return ast.literal_eval(value)\n except ValueError as e:\n raise ValueError(\n '{} is an invalid value for {}'.format(value, name)) from e\n return default_value\n\n\nDEBUG = get_bool_from_env('DEBUG', True)\n\nSITE_ID = 1\n\nPROJECT_ROOT = os.path.normpath(os.path.join(os.path.dirname(__file__), '..'))\n\nROOT_URLCONF = 'saleor.urls'\n\nWSGI_APPLICATION = 'saleor.wsgi.application'\n\nADMINS = (\n # ('Your Name', 'your_email@example.com'),\n)\nMANAGERS = ADMINS\n\nINTERNAL_IPS = get_list(os.environ.get('INTERNAL_IPS', '127.0.0.1'))\n\n# Some cloud providers like Heroku export REDIS_URL variable instead of CACHE_URL\nREDIS_URL = os.environ.get('REDIS_URL')\nif REDIS_URL:\n CACHE_URL = os.environ.setdefault('CACHE_URL', REDIS_URL)\nCACHES = {'default': django_cache_url.config()}\n\nDATABASES = {\n 'default': dj_database_url.config(\n default='postgres://saleor:saleor@localhost:5432/saleor',\n conn_max_age=600)}\n\n\nTIME_ZONE = 'America/Chicago'\nLANGUAGE_CODE = 'en'\nLANGUAGES = [\n ('bg', _('Bulgarian')),\n ('cs', _('Czech')),\n ('de', _('German')),\n ('en', _('English')),\n ('es', _('Spanish')),\n ('fa-ir', _('Persian (Iran)')),\n ('fr', _('French')),\n ('hu', _('Hungarian')),\n ('it', _('Italian')),\n ('ja', _('Japanese')),\n ('ko', _('Korean')),\n ('nb', _('Norwegian')),\n ('nl', _('Dutch')),\n ('pl', _('Polish')),\n ('pt-br', _('Portuguese (Brazil)')),\n ('ro', _('Romanian')),\n ('ru', _('Russian')),\n ('ru-ru', _('Russian (Russia)')),\n ('sk', _('Slovak')),\n ('tr', _('Turkish')),\n ('uk', _('Ukrainian')),\n ('vi', _('Vietnamese')),\n ('zh-hans', _('Chinese')),\n ('zh-tw', _('Chinese (Taiwan)'))]\nLOCALE_PATHS = [os.path.join(PROJECT_ROOT, 'locale')]\nUSE_I18N = True\nUSE_L10N = True\nUSE_TZ = True\n\nFORM_RENDERER = 'django.forms.renderers.TemplatesSetting'\n\nEMAIL_URL = os.environ.get('EMAIL_URL')\nSENDGRID_USERNAME = os.environ.get('SENDGRID_USERNAME')\nSENDGRID_PASSWORD = os.environ.get('SENDGRID_PASSWORD')\nif not EMAIL_URL and SENDGRID_USERNAME and SENDGRID_PASSWORD:\n EMAIL_URL = 'smtp://%s:%s@smtp.sendgrid.net:587/?tls=True' % (\n SENDGRID_USERNAME, SENDGRID_PASSWORD)\nemail_config = dj_email_url.parse(EMAIL_URL or 'console://')\n\nEMAIL_FILE_PATH = email_config['EMAIL_FILE_PATH']\nEMAIL_HOST_USER = email_config['EMAIL_HOST_USER']\nEMAIL_HOST_PASSWORD = email_config['EMAIL_HOST_PASSWORD']\nEMAIL_HOST = email_config['EMAIL_HOST']\nEMAIL_PORT = email_config['EMAIL_PORT']\nEMAIL_BACKEND = email_config['EMAIL_BACKEND']\nEMAIL_USE_TLS = email_config['EMAIL_USE_TLS']\nEMAIL_USE_SSL = email_config['EMAIL_USE_SSL']\n\nENABLE_SSL = get_bool_from_env('ENABLE_SSL', False)\n\nif ENABLE_SSL:\n SECURE_SSL_REDIRECT = not DEBUG\n\nDEFAULT_FROM_EMAIL = os.environ.get('DEFAULT_FROM_EMAIL', EMAIL_HOST_USER)\nORDER_FROM_EMAIL = os.getenv('ORDER_FROM_EMAIL', DEFAULT_FROM_EMAIL)\n\nMEDIA_ROOT = os.path.join(PROJECT_ROOT, 'media')\nMEDIA_URL = os.environ.get('MEDIA_URL', '/media/')\n\nSTATIC_ROOT = os.path.join(PROJECT_ROOT, 'static')\nSTATIC_URL = os.environ.get('STATIC_URL', '/static/')\nSTATICFILES_DIRS = [\n ('assets', os.path.join(PROJECT_ROOT, 'saleor', 'static', 'assets')),\n ('favicons', os.path.join(PROJECT_ROOT, 'saleor', 'static', 'favicons')),\n ('images', os.path.join(PROJECT_ROOT, 'saleor', 'static', 'images')),\n ('dashboard', os.path.join(PROJECT_ROOT, 'saleor', 'static', 'dashboard'))]\nSTATICFILES_FINDERS = [\n 'django.contrib.staticfiles.finders.FileSystemFinder',\n 'django.contrib.staticfiles.finders.AppDirectoriesFinder']\n\ncontext_processors = [\n 'django.contrib.auth.context_processors.auth',\n 'django.template.context_processors.debug',\n 'django.template.context_processors.i18n',\n 'django.template.context_processors.media',\n 'django.template.context_processors.static',\n 'django.template.context_processors.tz',\n 'django.contrib.messages.context_processors.messages',\n 'django.template.context_processors.request',\n 'saleor.core.context_processors.default_currency',\n 'saleor.checkout.context_processors.cart_counter',\n 'saleor.core.context_processors.search_enabled',\n 'saleor.site.context_processors.site',\n 'social_django.context_processors.backends',\n 'social_django.context_processors.login_redirect']\n\nloaders = [\n 'django.template.loaders.filesystem.Loader',\n 'django.template.loaders.app_directories.Loader']\n\nif not DEBUG:\n loaders = [('django.template.loaders.cached.Loader', loaders)]\n\nTEMPLATES = [{\n 'BACKEND': 'django.template.backends.django.DjangoTemplates',\n 'DIRS': [os.path.join(PROJECT_ROOT, 'templates')],\n 'OPTIONS': {\n 'debug': DEBUG,\n 'context_processors': context_processors,\n 'loaders': loaders,\n 'string_if_invalid': '<< MISSING VARIABLE \"%s\" >>' if DEBUG else ''}}]\n\n# Make this unique, and don't share it with anybody.\nSECRET_KEY = os.environ.get('SECRET_KEY')\n\nMIDDLEWARE = [\n 'django.contrib.sessions.middleware.SessionMiddleware',\n 'django.middleware.security.SecurityMiddleware',\n 'django.middleware.common.CommonMiddleware',\n 'django.middleware.csrf.CsrfViewMiddleware',\n 'django.contrib.auth.middleware.AuthenticationMiddleware',\n 'django.contrib.messages.middleware.MessageMiddleware',\n 'django.middleware.locale.LocaleMiddleware',\n 'django_babel.middleware.LocaleMiddleware',\n 'saleor.core.middleware.discounts',\n 'saleor.core.middleware.google_analytics',\n 'saleor.core.middleware.country',\n 'saleor.core.middleware.currency',\n 'saleor.core.middleware.site',\n 'saleor.core.middleware.taxes',\n 'social_django.middleware.SocialAuthExceptionMiddleware',\n 'impersonate.middleware.ImpersonateMiddleware',\n 'saleor.graphql.middleware.jwt_middleware'\n]\n\nINSTALLED_APPS = [\n # External apps that need to go before django's\n 'storages',\n\n # Django modules\n 'django.contrib.contenttypes',\n 'django.contrib.sessions',\n 'django.contrib.messages',\n 'django.contrib.sitemaps',\n 'django.contrib.sites',\n 'django.contrib.staticfiles',\n 'django.contrib.auth',\n 'django.contrib.postgres',\n 'django.forms',\n\n # Local apps\n 'saleor.account',\n 'saleor.discount',\n 'saleor.product',\n 'saleor.checkout',\n 'saleor.core',\n 'saleor.graphql',\n 'saleor.menu',\n 'saleor.order.OrderAppConfig',\n 'saleor.dashboard',\n 'saleor.seo',\n 'saleor.shipping',\n 'saleor.search',\n 'saleor.site',\n 'saleor.data_feeds',\n 'saleor.page',\n\n # External apps\n 'versatileimagefield',\n 'django_babel',\n 'bootstrap4',\n 'django_measurement',\n 'django_prices',\n 'django_prices_openexchangerates',\n 'django_prices_vatlayer',\n 'graphene_django',\n 'mptt',\n 'payments',\n 'webpack_loader',\n 'social_django',\n 'django_countries',\n 'django_filters',\n 'django_celery_results',\n 'impersonate',\n 'phonenumber_field',\n 'captcha']\n\nif DEBUG:\n MIDDLEWARE.append(\n 'debug_toolbar.middleware.DebugToolbarMiddleware')\n INSTALLED_APPS.append('debug_toolbar')\n DEBUG_TOOLBAR_PANELS = [\n # adds a request history to the debug toolbar\n 'ddt_request_history.panels.request_history.RequestHistoryPanel',\n\n 'debug_toolbar.panels.versions.VersionsPanel',\n 'debug_toolbar.panels.timer.TimerPanel',\n 'debug_toolbar.panels.settings.SettingsPanel',\n 'debug_toolbar.panels.headers.HeadersPanel',\n 'debug_toolbar.panels.request.RequestPanel',\n 'debug_toolbar.panels.sql.SQLPanel',\n 'debug_toolbar.panels.templates.TemplatesPanel',\n 'debug_toolbar.panels.staticfiles.StaticFilesPanel',\n 'debug_toolbar.panels.cache.CachePanel',\n 'debug_toolbar.panels.signals.SignalsPanel',\n 'debug_toolbar.panels.logging.LoggingPanel',\n 'debug_toolbar.panels.redirects.RedirectsPanel',\n 'debug_toolbar.panels.profiling.ProfilingPanel',\n ]\n DEBUG_TOOLBAR_CONFIG = {\n 'RESULTS_CACHE_SIZE': 100}\n\nENABLE_SILK = get_bool_from_env('ENABLE_SILK', False)\nif ENABLE_SILK:\n MIDDLEWARE.insert(0, 'silk.middleware.SilkyMiddleware')\n INSTALLED_APPS.append('silk')\n\nLOGGING = {\n 'version': 1,\n 'disable_existing_loggers': False,\n 'root': {\n 'level': 'INFO',\n 'handlers': ['console']},\n 'formatters': {\n 'verbose': {\n 'format': (\n '%(levelname)s %(name)s %(message)s'\n ' [PID:%(process)d:%(threadName)s]')},\n 'simple': {\n 'format': '%(levelname)s %(message)s'}},\n 'filters': {\n 'require_debug_false': {\n '()': 'django.utils.log.RequireDebugFalse'}},\n 'handlers': {\n 'mail_admins': {\n 'level': 'ERROR',\n 'filters': ['require_debug_false'],\n 'class': 'django.utils.log.AdminEmailHandler'},\n 'console': {\n 'level': 'DEBUG',\n 'class': 'logging.StreamHandler',\n 'formatter': 'verbose'}},\n 'loggers': {\n 'django': {\n 'handlers': ['console', 'mail_admins'],\n 'level': 'INFO',\n 'propagate': True},\n 'django.server': {\n 'handlers': ['console'],\n 'level': 'INFO',\n 'propagate': True},\n 'saleor': {\n 'handlers': ['console'],\n 'level': 'DEBUG',\n 'propagate': True}}}\n\nAUTH_USER_MODEL = 'account.User'\n\nLOGIN_URL = '/account/login/'\n\nDEFAULT_COUNTRY = os.environ.get('DEFAULT_COUNTRY', 'US')\nDEFAULT_CURRENCY = os.environ.get('DEFAULT_CURRENCY', 'USD')\nDEFAULT_DECIMAL_PLACES = get_currency_fraction(DEFAULT_CURRENCY)\nAVAILABLE_CURRENCIES = [DEFAULT_CURRENCY]\nCOUNTRIES_OVERRIDE = {\n 'EU': pgettext_lazy(\n 'Name of political and economical union of european countries',\n 'European Union')}\n\nOPENEXCHANGERATES_API_KEY = os.environ.get('OPENEXCHANGERATES_API_KEY')\n\n# VAT configuration\n# Enabling vat requires valid vatlayer access key.\n# If you are subscribed to a paid vatlayer plan, you can enable HTTPS.\nVATLAYER_ACCESS_KEY = os.environ.get('VATLAYER_ACCESS_KEY')\nVATLAYER_USE_HTTPS = get_bool_from_env('VATLAYER_USE_HTTPS', False)\n\nACCOUNT_ACTIVATION_DAYS = 3\n\nLOGIN_REDIRECT_URL = 'home'\n\nGOOGLE_ANALYTICS_TRACKING_ID = os.environ.get('GOOGLE_ANALYTICS_TRACKING_ID')\n\n\ndef get_host():\n from django.contrib.sites.models import Site\n return Site.objects.get_current().domain\n\n\nPAYMENT_HOST = get_host\n\nPAYMENT_MODEL = 'order.Payment'\n\nPAYMENT_VARIANTS = {\n 'default': ('payments.dummy.DummyProvider', {})}\n\nSESSION_SERIALIZER = 'django.contrib.sessions.serializers.JSONSerializer'\n\n# Do not use cached session if locmem cache backend is used but fallback to use\n# default django.contrib.sessions.backends.db instead\nif not CACHES['default']['BACKEND'].endswith('LocMemCache'):\n SESSION_ENGINE = 'django.contrib.sessions.backends.cached_db'\n\nCHECKOUT_PAYMENT_CHOICES = [\n ('default', 'Dummy provider')]\n\nMESSAGE_TAGS = {\n messages.ERROR: 'danger'}\n\nLOW_STOCK_THRESHOLD = 10\nMAX_CART_LINE_QUANTITY = int(os.environ.get('MAX_CART_LINE_QUANTITY', 50))\n\nPAGINATE_BY = 16\nDASHBOARD_PAGINATE_BY = 30\nDASHBOARD_SEARCH_LIMIT = 5\n\nbootstrap4 = {\n 'set_placeholder': False,\n 'set_required': False,\n 'success_css_class': '',\n 'form_renderers': {\n 'default': 'saleor.core.utils.form_renderer.FormRenderer'}}\n\nTEST_RUNNER = ''\n\nALLOWED_HOSTS = get_list(\n os.environ.get('ALLOWED_HOSTS', 'localhost,127.0.0.1'))\n\nSECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https')\n\n# Amazon S3 configuration\nAWS_ACCESS_KEY_ID = os.environ.get('AWS_ACCESS_KEY_ID')\nAWS_LOCATION = os.environ.get('AWS_LOCATION', '')\nAWS_MEDIA_BUCKET_NAME = os.environ.get('AWS_MEDIA_BUCKET_NAME')\nAWS_MEDIA_CUSTOM_DOMAIN = os.environ.get('AWS_MEDIA_CUSTOM_DOMAIN')\nAWS_QUERYSTRING_AUTH = get_bool_from_env('AWS_QUERYSTRING_AUTH', False)\nAWS_S3_CUSTOM_DOMAIN = os.environ.get('AWS_STATIC_CUSTOM_DOMAIN')\nAWS_SECRET_ACCESS_KEY = os.environ.get('AWS_SECRET_ACCESS_KEY')\nAWS_STORAGE_BUCKET_NAME = os.environ.get('AWS_STORAGE_BUCKET_NAME')\n\nif AWS_STORAGE_BUCKET_NAME:\n STATICFILES_STORAGE = 'storages.backends.s3boto3.S3Boto3Storage'\n\nif AWS_MEDIA_BUCKET_NAME:\n DEFAULT_FILE_STORAGE = 'saleor.core.storages.S3MediaStorage'\n THUMBNAIL_DEFAULT_STORAGE = DEFAULT_FILE_STORAGE\n\nMESSAGE_STORAGE = 'django.contrib.messages.storage.session.SessionStorage'\n\nVERSATILEIMAGEFIELD_RENDITION_KEY_SETS = {\n 'products': [\n ('product_gallery', 'thumbnail__540x540'),\n ('product_gallery_2x', 'thumbnail__1080x1080'),\n ('product_small', 'thumbnail__60x60'),\n ('product_small_2x', 'thumbnail__120x120'),\n ('product_list', 'thumbnail__255x255'),\n ('product_list_2x', 'thumbnail__510x510')]}\n\nVERSATILEIMAGEFIELD_SETTINGS = {\n # Images should be pre-generated on Production environment\n 'create_images_on_demand': get_bool_from_env(\n 'CREATE_IMAGES_ON_DEMAND', DEBUG),\n}\n\nPLACEHOLDER_IMAGES = {\n 60: 'images/placeholder60x60.png',\n 120: 'images/placeholder120x120.png',\n 255: 'images/placeholder255x255.png',\n 540: 'images/placeholder540x540.png',\n 1080: 'images/placeholder1080x1080.png'}\n\nDEFAULT_PLACEHOLDER = 'images/placeholder255x255.png'\n\nWEBPACK_LOADER = {\n 'DEFAULT': {\n 'CACHE': not DEBUG,\n 'BUNDLE_DIR_NAME': 'assets/',\n 'STATS_FILE': os.path.join(PROJECT_ROOT, 'webpack-bundle.json'),\n 'POLL_INTERVAL': 0.1,\n 'IGNORE': [\n r'.+\\.hot-update\\.js',\n r'.+\\.map']}}\n\n\nLOGOUT_ON_PASSWORD_CHANGE = False\n\n# SEARCH CONFIGURATION\nDB_SEARCH_ENABLED = True\n\n# support deployment-dependant elastic enviroment variable\nES_URL = (os.environ.get('ELASTICSEARCH_URL') or\n os.environ.get('SEARCHBOX_URL') or os.environ.get('BONSAI_URL'))\n\nENABLE_SEARCH = bool(ES_URL) or DB_SEARCH_ENABLED # global search disabling\n\nSEARCH_BACKEND = 'saleor.search.backends.postgresql'\n\nif ES_URL:\n SEARCH_BACKEND = 'saleor.search.backends.elasticsearch'\n INSTALLED_APPS.append('django_elasticsearch_dsl')\n ELASTICSEARCH_DSL = {\n 'default': {\n 'hosts': ES_URL}}\n\nAUTHENTICATION_BACKENDS = [\n 'saleor.account.backends.facebook.CustomFacebookOAuth2',\n 'saleor.account.backends.google.CustomGoogleOAuth2',\n 'graphql_jwt.backends.JSONWebTokenBackend',\n 'django.contrib.auth.backends.ModelBackend']\n\nSOCIAL_AUTH_PIPELINE = [\n 'social_core.pipeline.social_auth.social_details',\n 'social_core.pipeline.social_auth.social_uid',\n 'social_core.pipeline.social_auth.auth_allowed',\n 'social_core.pipeline.social_auth.social_user',\n 'social_core.pipeline.social_auth.associate_by_email',\n 'social_core.pipeline.user.create_user',\n 'social_core.pipeline.social_auth.associate_user',\n 'social_core.pipeline.social_auth.load_extra_data',\n 'social_core.pipeline.user.user_details']\n\nSOCIAL_AUTH_USERNAME_IS_FULL_EMAIL = True\nSOCIAL_AUTH_USER_MODEL = AUTH_USER_MODEL\nSOCIAL_AUTH_FACEBOOK_SCOPE = ['email']\nSOCIAL_AUTH_FACEBOOK_PROFILE_EXTRA_PARAMS = {\n 'fields': 'id, email'}\n# As per March 2018, Facebook requires all traffic to go through HTTPS only\nSOCIAL_AUTH_REDIRECT_IS_HTTPS = True\n\n# CELERY SETTINGS\nCELERY_BROKER_URL = os.environ.get(\n 'CELERY_BROKER_URL', os.environ.get('CLOUDAMQP_URL')) or ''\nCELERY_TASK_ALWAYS_EAGER = not CELERY_BROKER_URL\nCELERY_ACCEPT_CONTENT = ['json']\nCELERY_TASK_SERIALIZER = 'json'\nCELERY_RESULT_SERIALIZER = 'json'\nCELERY_RESULT_BACKEND = 'django-db'\n\n# Impersonate module settings\nIMPERSONATE = {\n 'URI_EXCLUSIONS': [r'^dashboard/'],\n 'CUSTOM_USER_QUERYSET': 'saleor.account.impersonate.get_impersonatable_users', # noqa\n 'USE_HTTP_REFERER': True,\n 'CUSTOM_ALLOW': 'saleor.account.impersonate.can_impersonate'}\n\n\n# Rich-text editor\nALLOWED_TAGS = [\n 'a',\n 'b',\n 'blockquote',\n 'br',\n 'em',\n 'h2',\n 'h3',\n 'i',\n 'img',\n 'li',\n 'ol',\n 'p',\n 'strong',\n 'ul']\nALLOWED_ATTRIBUTES = {\n '*': ['align', 'style'],\n 'a': ['href', 'title'],\n 'img': ['src']}\nALLOWED_STYLES = ['text-align']\n\n\n# Slugs for menus precreated in Django migrations\nDEFAULT_MENUS = {\n 'top_menu_name': 'navbar',\n 'bottom_menu_name': 'footer'}\n\n# This enable the new 'No Captcha reCaptcha' version (the simple checkbox)\n# instead of the old (deprecated) one. For more information see:\n# https://github.com/praekelt/django-recaptcha/blob/34af16ba1e/README.rst\nNOCAPTCHA = True\n\n# Set Google's reCaptcha keys\nRECAPTCHA_PUBLIC_KEY = os.environ.get('RECAPTCHA_PUBLIC_KEY')\nRECAPTCHA_PRIVATE_KEY = os.environ.get('RECAPTCHA_PRIVATE_KEY')\n\n\n# Sentry\nSENTRY_DSN = os.environ.get('SENTRY_DSN')\nif SENTRY_DSN:\n INSTALLED_APPS.append('raven.contrib.django.raven_compat')\n RAVEN_CONFIG = {\n 'dsn': SENTRY_DSN,\n 'release': __version__}\n\n\nSERIALIZATION_MODULES = {\n 'json': 'saleor.core.utils.json_serializer'}\n","path":"saleor/settings.py"}],"string":"[\n {\n \"content\": \"import ast\\nimport os.path\\n\\nimport dj_database_url\\nimport dj_email_url\\nimport django_cache_url\\nfrom django.contrib.messages import constants as messages\\nfrom django.utils.translation import gettext_lazy as _, pgettext_lazy\\nfrom django_prices.templatetags.prices_i18n import get_currency_fraction\\n\\nfrom . import __version__\\n\\n\\ndef get_list(text):\\n return [item.strip() for item in text.split(',')]\\n\\n\\ndef get_bool_from_env(name, default_value):\\n if name in os.environ:\\n value = os.environ[name]\\n try:\\n return ast.literal_eval(value)\\n except ValueError as e:\\n raise ValueError(\\n '{} is an invalid value for {}'.format(value, name)) from e\\n return default_value\\n\\n\\nDEBUG = get_bool_from_env('DEBUG', True)\\n\\nSITE_ID = 1\\n\\nPROJECT_ROOT = os.path.normpath(os.path.join(os.path.dirname(__file__), '..'))\\n\\nROOT_URLCONF = 'saleor.urls'\\n\\nWSGI_APPLICATION = 'saleor.wsgi.application'\\n\\nADMINS = (\\n # ('Your Name', 'your_email@example.com'),\\n)\\nMANAGERS = ADMINS\\n\\nINTERNAL_IPS = get_list(os.environ.get('INTERNAL_IPS', '127.0.0.1'))\\n\\n# Some cloud providers like Heroku export REDIS_URL variable instead of CACHE_URL\\nREDIS_URL = os.environ.get('REDIS_URL')\\nif REDIS_URL:\\n CACHE_URL = os.environ.setdefault('CACHE_URL', REDIS_URL)\\nCACHES = {'default': django_cache_url.config()}\\n\\nDATABASES = {\\n 'default': dj_database_url.config(\\n default='postgres://saleor:saleor@localhost:5432/saleor',\\n conn_max_age=600)}\\n\\n\\nTIME_ZONE = 'America/Chicago'\\nLANGUAGE_CODE = 'en'\\nLANGUAGES = [\\n ('bg', _('Bulgarian')),\\n ('cs', _('Czech')),\\n ('de', _('German')),\\n ('en', _('English')),\\n ('es', _('Spanish')),\\n ('fa-ir', _('Persian (Iran)')),\\n ('fr', _('French')),\\n ('hu', _('Hungarian')),\\n ('it', _('Italian')),\\n ('ja', _('Japanese')),\\n ('ko', _('Korean')),\\n ('nb', _('Norwegian')),\\n ('nl', _('Dutch')),\\n ('pl', _('Polish')),\\n ('pt-br', _('Portuguese (Brazil)')),\\n ('ro', _('Romanian')),\\n ('ru', _('Russian')),\\n ('ru-ru', _('Russian (Russia)')),\\n ('sk', _('Slovak')),\\n ('tr', _('Turkish')),\\n ('uk', _('Ukrainian')),\\n ('vi', _('Vietnamese')),\\n ('zh-hans', _('Chinese')),\\n ('zh-tw', _('Chinese (Taiwan)'))]\\nLOCALE_PATHS = [os.path.join(PROJECT_ROOT, 'locale')]\\nUSE_I18N = True\\nUSE_L10N = True\\nUSE_TZ = True\\n\\nFORM_RENDERER = 'django.forms.renderers.TemplatesSetting'\\n\\nEMAIL_URL = os.environ.get('EMAIL_URL')\\nSENDGRID_USERNAME = os.environ.get('SENDGRID_USERNAME')\\nSENDGRID_PASSWORD = os.environ.get('SENDGRID_PASSWORD')\\nif not EMAIL_URL and SENDGRID_USERNAME and SENDGRID_PASSWORD:\\n EMAIL_URL = 'smtp://%s:%s@smtp.sendgrid.net:587/?tls=True' % (\\n SENDGRID_USERNAME, SENDGRID_PASSWORD)\\nemail_config = dj_email_url.parse(EMAIL_URL or 'console://')\\n\\nEMAIL_FILE_PATH = email_config['EMAIL_FILE_PATH']\\nEMAIL_HOST_USER = email_config['EMAIL_HOST_USER']\\nEMAIL_HOST_PASSWORD = email_config['EMAIL_HOST_PASSWORD']\\nEMAIL_HOST = email_config['EMAIL_HOST']\\nEMAIL_PORT = email_config['EMAIL_PORT']\\nEMAIL_BACKEND = email_config['EMAIL_BACKEND']\\nEMAIL_USE_TLS = email_config['EMAIL_USE_TLS']\\nEMAIL_USE_SSL = email_config['EMAIL_USE_SSL']\\n\\nENABLE_SSL = get_bool_from_env('ENABLE_SSL', False)\\n\\nif ENABLE_SSL:\\n SECURE_SSL_REDIRECT = not DEBUG\\n\\nDEFAULT_FROM_EMAIL = os.environ.get('DEFAULT_FROM_EMAIL', EMAIL_HOST_USER)\\nORDER_FROM_EMAIL = os.getenv('ORDER_FROM_EMAIL', DEFAULT_FROM_EMAIL)\\n\\nMEDIA_ROOT = os.path.join(PROJECT_ROOT, 'media')\\nMEDIA_URL = os.environ.get('MEDIA_URL', '/media/')\\n\\nSTATIC_ROOT = os.path.join(PROJECT_ROOT, 'static')\\nSTATIC_URL = os.environ.get('STATIC_URL', '/static/')\\nSTATICFILES_DIRS = [\\n ('assets', os.path.join(PROJECT_ROOT, 'saleor', 'static', 'assets')),\\n ('favicons', os.path.join(PROJECT_ROOT, 'saleor', 'static', 'favicons')),\\n ('images', os.path.join(PROJECT_ROOT, 'saleor', 'static', 'images')),\\n ('dashboard', os.path.join(PROJECT_ROOT, 'saleor', 'static', 'dashboard'))]\\nSTATICFILES_FINDERS = [\\n 'django.contrib.staticfiles.finders.FileSystemFinder',\\n 'django.contrib.staticfiles.finders.AppDirectoriesFinder']\\n\\ncontext_processors = [\\n 'django.contrib.auth.context_processors.auth',\\n 'django.template.context_processors.debug',\\n 'django.template.context_processors.i18n',\\n 'django.template.context_processors.media',\\n 'django.template.context_processors.static',\\n 'django.template.context_processors.tz',\\n 'django.contrib.messages.context_processors.messages',\\n 'django.template.context_processors.request',\\n 'saleor.core.context_processors.default_currency',\\n 'saleor.checkout.context_processors.cart_counter',\\n 'saleor.core.context_processors.search_enabled',\\n 'saleor.site.context_processors.site',\\n 'social_django.context_processors.backends',\\n 'social_django.context_processors.login_redirect']\\n\\nloaders = [\\n 'django.template.loaders.filesystem.Loader',\\n 'django.template.loaders.app_directories.Loader']\\n\\nif not DEBUG:\\n loaders = [('django.template.loaders.cached.Loader', loaders)]\\n\\nTEMPLATES = [{\\n 'BACKEND': 'django.template.backends.django.DjangoTemplates',\\n 'DIRS': [os.path.join(PROJECT_ROOT, 'templates')],\\n 'OPTIONS': {\\n 'debug': DEBUG,\\n 'context_processors': context_processors,\\n 'loaders': loaders,\\n 'string_if_invalid': '<< MISSING VARIABLE \\\"%s\\\" >>' if DEBUG else ''}}]\\n\\n# Make this unique, and don't share it with anybody.\\nSECRET_KEY = os.environ.get('SECRET_KEY')\\n\\nMIDDLEWARE = [\\n 'django.contrib.sessions.middleware.SessionMiddleware',\\n 'django.middleware.security.SecurityMiddleware',\\n 'django.middleware.common.CommonMiddleware',\\n 'django.middleware.csrf.CsrfViewMiddleware',\\n 'django.contrib.auth.middleware.AuthenticationMiddleware',\\n 'django.contrib.messages.middleware.MessageMiddleware',\\n 'django.middleware.locale.LocaleMiddleware',\\n 'django_babel.middleware.LocaleMiddleware',\\n 'saleor.core.middleware.discounts',\\n 'saleor.core.middleware.google_analytics',\\n 'saleor.core.middleware.country',\\n 'saleor.core.middleware.currency',\\n 'saleor.core.middleware.site',\\n 'saleor.core.middleware.taxes',\\n 'social_django.middleware.SocialAuthExceptionMiddleware',\\n 'impersonate.middleware.ImpersonateMiddleware',\\n 'saleor.graphql.middleware.jwt_middleware'\\n]\\n\\nINSTALLED_APPS = [\\n # External apps that need to go before django's\\n 'storages',\\n\\n # Django modules\\n 'django.contrib.contenttypes',\\n 'django.contrib.sessions',\\n 'django.contrib.messages',\\n 'django.contrib.sitemaps',\\n 'django.contrib.sites',\\n 'django.contrib.staticfiles',\\n 'django.contrib.auth',\\n 'django.contrib.postgres',\\n 'django.forms',\\n\\n # Local apps\\n 'saleor.account',\\n 'saleor.discount',\\n 'saleor.product',\\n 'saleor.checkout',\\n 'saleor.core',\\n 'saleor.graphql',\\n 'saleor.menu',\\n 'saleor.order.OrderAppConfig',\\n 'saleor.dashboard',\\n 'saleor.seo',\\n 'saleor.shipping',\\n 'saleor.search',\\n 'saleor.site',\\n 'saleor.data_feeds',\\n 'saleor.page',\\n\\n # External apps\\n 'versatileimagefield',\\n 'django_babel',\\n 'bootstrap4',\\n 'django_measurement',\\n 'django_prices',\\n 'django_prices_openexchangerates',\\n 'django_prices_vatlayer',\\n 'graphene_django',\\n 'mptt',\\n 'payments',\\n 'webpack_loader',\\n 'social_django',\\n 'django_countries',\\n 'django_filters',\\n 'django_celery_results',\\n 'impersonate',\\n 'phonenumber_field',\\n 'captcha']\\n\\nif DEBUG:\\n MIDDLEWARE.append(\\n 'debug_toolbar.middleware.DebugToolbarMiddleware')\\n INSTALLED_APPS.append('debug_toolbar')\\n DEBUG_TOOLBAR_PANELS = [\\n # adds a request history to the debug toolbar\\n 'ddt_request_history.panels.request_history.RequestHistoryPanel',\\n\\n 'debug_toolbar.panels.versions.VersionsPanel',\\n 'debug_toolbar.panels.timer.TimerPanel',\\n 'debug_toolbar.panels.settings.SettingsPanel',\\n 'debug_toolbar.panels.headers.HeadersPanel',\\n 'debug_toolbar.panels.request.RequestPanel',\\n 'debug_toolbar.panels.sql.SQLPanel',\\n 'debug_toolbar.panels.templates.TemplatesPanel',\\n 'debug_toolbar.panels.staticfiles.StaticFilesPanel',\\n 'debug_toolbar.panels.cache.CachePanel',\\n 'debug_toolbar.panels.signals.SignalsPanel',\\n 'debug_toolbar.panels.logging.LoggingPanel',\\n 'debug_toolbar.panels.redirects.RedirectsPanel',\\n 'debug_toolbar.panels.profiling.ProfilingPanel',\\n ]\\n DEBUG_TOOLBAR_CONFIG = {\\n 'RESULTS_CACHE_SIZE': 100}\\n\\nENABLE_SILK = get_bool_from_env('ENABLE_SILK', False)\\nif ENABLE_SILK:\\n MIDDLEWARE.insert(0, 'silk.middleware.SilkyMiddleware')\\n INSTALLED_APPS.append('silk')\\n\\nLOGGING = {\\n 'version': 1,\\n 'disable_existing_loggers': False,\\n 'root': {\\n 'level': 'INFO',\\n 'handlers': ['console']},\\n 'formatters': {\\n 'verbose': {\\n 'format': (\\n '%(levelname)s %(name)s %(message)s'\\n ' [PID:%(process)d:%(threadName)s]')},\\n 'simple': {\\n 'format': '%(levelname)s %(message)s'}},\\n 'filters': {\\n 'require_debug_false': {\\n '()': 'django.utils.log.RequireDebugFalse'}},\\n 'handlers': {\\n 'mail_admins': {\\n 'level': 'ERROR',\\n 'filters': ['require_debug_false'],\\n 'class': 'django.utils.log.AdminEmailHandler'},\\n 'console': {\\n 'level': 'DEBUG',\\n 'class': 'logging.StreamHandler',\\n 'formatter': 'verbose'}},\\n 'loggers': {\\n 'django': {\\n 'handlers': ['console', 'mail_admins'],\\n 'level': 'INFO',\\n 'propagate': True},\\n 'django.server': {\\n 'handlers': ['console'],\\n 'level': 'INFO',\\n 'propagate': True},\\n 'saleor': {\\n 'handlers': ['console'],\\n 'level': 'DEBUG',\\n 'propagate': True}}}\\n\\nAUTH_USER_MODEL = 'account.User'\\n\\nLOGIN_URL = '/account/login/'\\n\\nDEFAULT_COUNTRY = os.environ.get('DEFAULT_COUNTRY', 'US')\\nDEFAULT_CURRENCY = os.environ.get('DEFAULT_CURRENCY', 'USD')\\nDEFAULT_DECIMAL_PLACES = get_currency_fraction(DEFAULT_CURRENCY)\\nAVAILABLE_CURRENCIES = [DEFAULT_CURRENCY]\\nCOUNTRIES_OVERRIDE = {\\n 'EU': pgettext_lazy(\\n 'Name of political and economical union of european countries',\\n 'European Union')}\\n\\nOPENEXCHANGERATES_API_KEY = os.environ.get('OPENEXCHANGERATES_API_KEY')\\n\\n# VAT configuration\\n# Enabling vat requires valid vatlayer access key.\\n# If you are subscribed to a paid vatlayer plan, you can enable HTTPS.\\nVATLAYER_ACCESS_KEY = os.environ.get('VATLAYER_ACCESS_KEY')\\nVATLAYER_USE_HTTPS = get_bool_from_env('VATLAYER_USE_HTTPS', False)\\n\\nACCOUNT_ACTIVATION_DAYS = 3\\n\\nLOGIN_REDIRECT_URL = 'home'\\n\\nGOOGLE_ANALYTICS_TRACKING_ID = os.environ.get('GOOGLE_ANALYTICS_TRACKING_ID')\\n\\n\\ndef get_host():\\n from django.contrib.sites.models import Site\\n return Site.objects.get_current().domain\\n\\n\\nPAYMENT_HOST = get_host\\n\\nPAYMENT_MODEL = 'order.Payment'\\n\\nPAYMENT_VARIANTS = {\\n 'default': ('payments.dummy.DummyProvider', {})}\\n\\nSESSION_SERIALIZER = 'django.contrib.sessions.serializers.JSONSerializer'\\n\\n# Do not use cached session if locmem cache backend is used but fallback to use\\n# default django.contrib.sessions.backends.db instead\\nif not CACHES['default']['BACKEND'].endswith('LocMemCache'):\\n SESSION_ENGINE = 'django.contrib.sessions.backends.cached_db'\\n\\nCHECKOUT_PAYMENT_CHOICES = [\\n ('default', 'Dummy provider')]\\n\\nMESSAGE_TAGS = {\\n messages.ERROR: 'danger'}\\n\\nLOW_STOCK_THRESHOLD = 10\\nMAX_CART_LINE_QUANTITY = int(os.environ.get('MAX_CART_LINE_QUANTITY', 50))\\n\\nPAGINATE_BY = 16\\nDASHBOARD_PAGINATE_BY = 30\\nDASHBOARD_SEARCH_LIMIT = 5\\n\\nbootstrap4 = {\\n 'set_placeholder': False,\\n 'set_required': False,\\n 'success_css_class': '',\\n 'form_renderers': {\\n 'default': 'saleor.core.utils.form_renderer.FormRenderer'}}\\n\\nTEST_RUNNER = ''\\n\\nALLOWED_HOSTS = get_list(\\n os.environ.get('ALLOWED_HOSTS', 'localhost,127.0.0.1'))\\n\\nSECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https')\\n\\n# Amazon S3 configuration\\nAWS_ACCESS_KEY_ID = os.environ.get('AWS_ACCESS_KEY_ID')\\nAWS_LOCATION = os.environ.get('AWS_LOCATION', '')\\nAWS_MEDIA_BUCKET_NAME = os.environ.get('AWS_MEDIA_BUCKET_NAME')\\nAWS_MEDIA_CUSTOM_DOMAIN = os.environ.get('AWS_MEDIA_CUSTOM_DOMAIN')\\nAWS_QUERYSTRING_AUTH = get_bool_from_env('AWS_QUERYSTRING_AUTH', False)\\nAWS_S3_CUSTOM_DOMAIN = os.environ.get('AWS_STATIC_CUSTOM_DOMAIN')\\nAWS_SECRET_ACCESS_KEY = os.environ.get('AWS_SECRET_ACCESS_KEY')\\nAWS_STORAGE_BUCKET_NAME = os.environ.get('AWS_STORAGE_BUCKET_NAME')\\n\\nif AWS_STORAGE_BUCKET_NAME:\\n STATICFILES_STORAGE = 'storages.backends.s3boto3.S3Boto3Storage'\\n\\nif AWS_MEDIA_BUCKET_NAME:\\n DEFAULT_FILE_STORAGE = 'saleor.core.storages.S3MediaStorage'\\n THUMBNAIL_DEFAULT_STORAGE = DEFAULT_FILE_STORAGE\\n\\nMESSAGE_STORAGE = 'django.contrib.messages.storage.session.SessionStorage'\\n\\nVERSATILEIMAGEFIELD_RENDITION_KEY_SETS = {\\n 'products': [\\n ('product_gallery', 'thumbnail__540x540'),\\n ('product_gallery_2x', 'thumbnail__1080x1080'),\\n ('product_small', 'thumbnail__60x60'),\\n ('product_small_2x', 'thumbnail__120x120'),\\n ('product_list', 'thumbnail__255x255'),\\n ('product_list_2x', 'thumbnail__510x510')]}\\n\\nVERSATILEIMAGEFIELD_SETTINGS = {\\n # Images should be pre-generated on Production environment\\n 'create_images_on_demand': get_bool_from_env(\\n 'CREATE_IMAGES_ON_DEMAND', DEBUG),\\n}\\n\\nPLACEHOLDER_IMAGES = {\\n 60: 'images/placeholder60x60.png',\\n 120: 'images/placeholder120x120.png',\\n 255: 'images/placeholder255x255.png',\\n 540: 'images/placeholder540x540.png',\\n 1080: 'images/placeholder1080x1080.png'}\\n\\nDEFAULT_PLACEHOLDER = 'images/placeholder255x255.png'\\n\\nWEBPACK_LOADER = {\\n 'DEFAULT': {\\n 'CACHE': not DEBUG,\\n 'BUNDLE_DIR_NAME': 'assets/',\\n 'STATS_FILE': os.path.join(PROJECT_ROOT, 'webpack-bundle.json'),\\n 'POLL_INTERVAL': 0.1,\\n 'IGNORE': [\\n r'.+\\\\.hot-update\\\\.js',\\n r'.+\\\\.map']}}\\n\\n\\nLOGOUT_ON_PASSWORD_CHANGE = False\\n\\n# SEARCH CONFIGURATION\\nDB_SEARCH_ENABLED = True\\n\\n# support deployment-dependant elastic enviroment variable\\nES_URL = (os.environ.get('ELASTICSEARCH_URL') or\\n os.environ.get('SEARCHBOX_URL') or os.environ.get('BONSAI_URL'))\\n\\nENABLE_SEARCH = bool(ES_URL) or DB_SEARCH_ENABLED # global search disabling\\n\\nSEARCH_BACKEND = 'saleor.search.backends.postgresql'\\n\\nif ES_URL:\\n SEARCH_BACKEND = 'saleor.search.backends.elasticsearch'\\n INSTALLED_APPS.append('django_elasticsearch_dsl')\\n ELASTICSEARCH_DSL = {\\n 'default': {\\n 'hosts': ES_URL}}\\n\\nAUTHENTICATION_BACKENDS = [\\n 'saleor.account.backends.facebook.CustomFacebookOAuth2',\\n 'saleor.account.backends.google.CustomGoogleOAuth2',\\n 'graphql_jwt.backends.JSONWebTokenBackend',\\n 'django.contrib.auth.backends.ModelBackend']\\n\\nSOCIAL_AUTH_PIPELINE = [\\n 'social_core.pipeline.social_auth.social_details',\\n 'social_core.pipeline.social_auth.social_uid',\\n 'social_core.pipeline.social_auth.auth_allowed',\\n 'social_core.pipeline.social_auth.social_user',\\n 'social_core.pipeline.social_auth.associate_by_email',\\n 'social_core.pipeline.user.create_user',\\n 'social_core.pipeline.social_auth.associate_user',\\n 'social_core.pipeline.social_auth.load_extra_data',\\n 'social_core.pipeline.user.user_details']\\n\\nSOCIAL_AUTH_USERNAME_IS_FULL_EMAIL = True\\nSOCIAL_AUTH_USER_MODEL = AUTH_USER_MODEL\\nSOCIAL_AUTH_FACEBOOK_SCOPE = ['email']\\nSOCIAL_AUTH_FACEBOOK_PROFILE_EXTRA_PARAMS = {\\n 'fields': 'id, email'}\\n# As per March 2018, Facebook requires all traffic to go through HTTPS only\\nSOCIAL_AUTH_REDIRECT_IS_HTTPS = True\\n\\n# CELERY SETTINGS\\nCELERY_BROKER_URL = os.environ.get(\\n 'CELERY_BROKER_URL', os.environ.get('CLOUDAMQP_URL')) or ''\\nCELERY_TASK_ALWAYS_EAGER = not CELERY_BROKER_URL\\nCELERY_ACCEPT_CONTENT = ['json']\\nCELERY_TASK_SERIALIZER = 'json'\\nCELERY_RESULT_SERIALIZER = 'json'\\nCELERY_RESULT_BACKEND = 'django-db'\\n\\n# Impersonate module settings\\nIMPERSONATE = {\\n 'URI_EXCLUSIONS': [r'^dashboard/'],\\n 'CUSTOM_USER_QUERYSET': 'saleor.account.impersonate.get_impersonatable_users', # noqa\\n 'USE_HTTP_REFERER': True,\\n 'CUSTOM_ALLOW': 'saleor.account.impersonate.can_impersonate'}\\n\\n\\n# Rich-text editor\\nALLOWED_TAGS = [\\n 'a',\\n 'b',\\n 'blockquote',\\n 'br',\\n 'em',\\n 'h2',\\n 'h3',\\n 'i',\\n 'img',\\n 'li',\\n 'ol',\\n 'p',\\n 'strong',\\n 'ul']\\nALLOWED_ATTRIBUTES = {\\n '*': ['align', 'style'],\\n 'a': ['href', 'title'],\\n 'img': ['src']}\\nALLOWED_STYLES = ['text-align']\\n\\n\\n# Slugs for menus precreated in Django migrations\\nDEFAULT_MENUS = {\\n 'top_menu_name': 'navbar',\\n 'bottom_menu_name': 'footer'}\\n\\n# This enable the new 'No Captcha reCaptcha' version (the simple checkbox)\\n# instead of the old (deprecated) one. For more information see:\\n# https://github.com/praekelt/django-recaptcha/blob/34af16ba1e/README.rst\\nNOCAPTCHA = True\\n\\n# Set Google's reCaptcha keys\\nRECAPTCHA_PUBLIC_KEY = os.environ.get('RECAPTCHA_PUBLIC_KEY')\\nRECAPTCHA_PRIVATE_KEY = os.environ.get('RECAPTCHA_PRIVATE_KEY')\\n\\n\\n# Sentry\\nSENTRY_DSN = os.environ.get('SENTRY_DSN')\\nif SENTRY_DSN:\\n INSTALLED_APPS.append('raven.contrib.django.raven_compat')\\n RAVEN_CONFIG = {\\n 'dsn': SENTRY_DSN,\\n 'release': __version__}\\n\\n\\nSERIALIZATION_MODULES = {\\n 'json': 'saleor.core.utils.json_serializer'}\\n\",\n \"path\": \"saleor/settings.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/saleor/settings.py b/saleor/settings.py\nindex 834500eb05e..319799bb02d 100644\n--- a/saleor/settings.py\n+++ b/saleor/settings.py\n@@ -480,7 +480,7 @@ def get_host():\n # CELERY SETTINGS\n CELERY_BROKER_URL = os.environ.get(\n 'CELERY_BROKER_URL', os.environ.get('CLOUDAMQP_URL')) or ''\n-CELERY_TASK_ALWAYS_EAGER = False if CELERY_BROKER_URL else True\n+CELERY_TASK_ALWAYS_EAGER = not CELERY_BROKER_URL\n CELERY_ACCEPT_CONTENT = ['json']\n CELERY_TASK_SERIALIZER = 'json'\n CELERY_RESULT_SERIALIZER = 'json'\n"}}},{"rowIdx":5478,"cells":{"in_source_id":{"kind":"string","value":"Gallopsled__pwntools-1057"},"issue":{"kind":"string","value":"DynELF._find_linkmap bug\nhttps://github.com/Gallopsled/pwntools/blob/b53e58a840c890340fa755a2229c3ff774c5f81e/pwnlib/dynelf.py#L450\r\n\r\nBug after commit bb25140807a4d\r\nMust be:\r\n\r\n```python\r\nw.status(\"r_debug.linkmap %#x\" % linkmap)\r\n```\n"},"before_files":{"kind":"list like","value":[{"content":"\"\"\"\nResolve symbols in loaded, dynamically-linked ELF binaries.\nGiven a function which can leak data at an arbitrary address,\nany symbol in any loaded library can be resolved.\n\nExample\n^^^^^^^^\n\n::\n\n # Assume a process or remote connection\n p = process('./pwnme')\n\n # Declare a function that takes a single address, and\n # leaks at least one byte at that address.\n def leak(address):\n data = p.read(address, 4)\n log.debug(\"%#x => %s\" % (address, (data or '').encode('hex')))\n return data\n\n # For the sake of this example, let's say that we\n # have any of these pointers. One is a pointer into\n # the target binary, the other two are pointers into libc\n main = 0xfeedf4ce\n libc = 0xdeadb000\n system = 0xdeadbeef\n\n # With our leaker, and a pointer into our target binary,\n # we can resolve the address of anything.\n #\n # We do not actually need to have a copy of the target\n # binary for this to work.\n d = DynELF(leak, main)\n assert d.lookup(None, 'libc') == libc\n assert d.lookup('system', 'libc') == system\n\n # However, if we *do* have a copy of the target binary,\n # we can speed up some of the steps.\n d = DynELF(leak, main, elf=ELF('./pwnme'))\n assert d.lookup(None, 'libc') == libc\n assert d.lookup('system', 'libc') == system\n\n # Alternately, we can resolve symbols inside another library,\n # given a pointer into it.\n d = DynELF(leak, libc + 0x1234)\n assert d.lookup('system') == system\n\nDynELF\n\"\"\"\nfrom __future__ import absolute_import\n\nimport ctypes\n\nfrom elftools.elf.enums import ENUM_D_TAG\n\nfrom pwnlib import elf\nfrom pwnlib import libcdb\nfrom pwnlib.context import context\nfrom pwnlib.elf import ELF\nfrom pwnlib.elf import constants\nfrom pwnlib.log import getLogger\nfrom pwnlib.memleak import MemLeak\nfrom pwnlib.util.fiddling import enhex\nfrom pwnlib.util.packing import unpack\nfrom pwnlib.util.web import wget\n\nlog = getLogger(__name__)\nsizeof = ctypes.sizeof\n\ndef sysv_hash(symbol):\n \"\"\"sysv_hash(str) -> int\n\n Function used to generate SYSV-style hashes for strings.\n \"\"\"\n h = 0\n g = 0\n for c in symbol:\n h = (h << 4) + ord(c)\n g = h & 0xf0000000\n h ^= (g >> 24)\n h &= ~g\n return h & 0xffffffff\n\ndef gnu_hash(s):\n \"\"\"gnu_hash(str) -> int\n\n Function used to generated GNU-style hashes for strings.\n \"\"\"\n h = 5381\n for c in s:\n h = h * 33 + ord(c)\n return h & 0xffffffff\n\nclass DynELF(object):\n '''\n DynELF knows how to resolve symbols in remote processes via an infoleak or\n memleak vulnerability encapsulated by :class:`pwnlib.memleak.MemLeak`.\n\n Implementation Details:\n\n Resolving Functions:\n\n In all ELFs which export symbols for importing by other libraries,\n (e.g. ``libc.so``) there are a series of tables which give exported\n symbol names, exported symbol addresses, and the ``hash`` of those\n exported symbols. By applying a hash function to the name of the\n desired symbol (e.g., ``'printf'``), it can be located in the hash\n table. Its location in the hash table provides an index into the\n string name table (strtab_), and the symbol address (symtab_).\n\n Assuming we have the base address of ``libc.so``, the way to resolve\n the address of ``printf`` is to locate the ``symtab``, ``strtab``,\n and hash table. The string ``\"printf\"`` is hashed according to the\n style of the hash table (SYSV_ or GNU_), and the hash table is\n walked until a matching entry is located. We can verify an exact\n match by checking the string table, and then get the offset into\n ``libc.so`` from the ``symtab``.\n\n Resolving Library Addresses:\n\n If we have a pointer into a dynamically-linked executable, we can\n leverage an internal linker structure called the `link map`_. This\n is a linked list structure which contains information about each\n loaded library, including its full path and base address.\n\n A pointer to the ``link map`` can be found in two ways. Both are\n referenced from entries in the DYNAMIC_ array.\n\n - In non-RELRO binaries, a pointer is placed in the `.got.plt`_ area\n in the binary. This is marked by finding the DT_PLTGOT_ area in the\n binary.\n - In all binaries, a pointer can be found in the area described by\n the DT_DEBUG_ area. This exists even in stripped binaries.\n\n For maximum flexibility, both mechanisms are used exhaustively.\n\n .. _symtab: https://refspecs.linuxbase.org/elf/gabi4+/ch4.symtab.html\n .. _strtab: https://refspecs.linuxbase.org/elf/gabi4+/ch4.strtab.html\n .. _.got.plt: https://refspecs.linuxbase.org/LSB_3.1.1/LSB-Core-generic/LSB-Core-generic/specialsections.html\n .. _DYNAMIC: http://www.sco.com/developers/gabi/latest/ch5.dynamic.html#dynamic_section\n .. _SYSV: https://refspecs.linuxbase.org/elf/gabi4+/ch5.dynamic.html#hash\n .. _GNU: https://blogs.oracle.com/ali/entry/gnu_hash_elf_sections\n .. _DT_DEBUG: https://reverseengineering.stackexchange.com/questions/6525/elf-link-map-when-linked-as-relro\n .. _link map: https://sourceware.org/git/?p=glibc.git;a=blob;f=elf/link.h;h=eaca8028e45a859ac280301a6e955a14eed1b887;hb=HEAD#l84\n .. _DT_PLTGOT: http://refspecs.linuxfoundation.org/ELF/zSeries/lzsabi0_zSeries/x2251.html\n '''\n\n def __init__(self, leak, pointer=None, elf=None, libcdb=True):\n '''\n Instantiates an object which can resolve symbols in a running binary\n given a :class:`pwnlib.memleak.MemLeak` leaker and a pointer inside\n the binary.\n\n Arguments:\n leak(MemLeak): Instance of pwnlib.memleak.MemLeak for leaking memory\n pointer(int): A pointer into a loaded ELF file\n elf(str,ELF): Path to the ELF file on disk, or a loaded :class:`pwnlib.elf.ELF`.\n libcdb(bool): Attempt to use libcdb to speed up libc lookups\n '''\n self.libcdb = libcdb\n self._elfclass = None\n self._elftype = None\n self._link_map = None\n self._waitfor = None\n self._bases = {}\n self._dynamic = None\n\n if not (pointer or (elf and elf.address)):\n log.error(\"Must specify either a pointer into a module and/or an ELF file with a valid base address\")\n\n pointer = pointer or elf.address\n\n if not isinstance(leak, MemLeak):\n leak = MemLeak(leak)\n\n if not elf:\n log.warn_once(\"No ELF provided. Leaking is much faster if you have a copy of the ELF being leaked.\")\n\n self.elf = elf\n self.leak = leak\n self.libbase = self._find_base(pointer or elf.address)\n\n if elf:\n self._find_linkmap_assisted(elf)\n\n @classmethod\n def for_one_lib_only(cls, leak, ptr):\n return cls(leak, ptr)\n\n @classmethod\n def from_lib_ptr(cls, leak, ptr):\n return cls(leak, ptr)\n\n @staticmethod\n def find_base(leak, ptr):\n \"\"\"Given a :class:`pwnlib.memleak.MemLeak` object and a pointer into a\n library, find its base address.\n \"\"\"\n return DynELF(leak, ptr).libbase\n\n @property\n def elfclass(self):\n \"\"\"32 or 64\"\"\"\n if not self._elfclass:\n elfclass = self.leak.field(self.libbase, elf.Elf_eident.EI_CLASS)\n self._elfclass = {constants.ELFCLASS32: 32,\n constants.ELFCLASS64: 64}[elfclass]\n return self._elfclass\n\n @property\n def elftype(self):\n \"\"\"e_type from the elf header. In practice the value will almost always\n be 'EXEC' or 'DYN'. If the value is architecture-specific (between\n ET_LOPROC and ET_HIPROC) or invalid, KeyError is raised.\n \"\"\"\n if not self._elftype:\n Ehdr = {32: elf.Elf32_Ehdr, 64: elf.Elf64_Ehdr}[self.elfclass]\n elftype = self.leak.field(self.libbase, Ehdr.e_type)\n self._elftype = {constants.ET_NONE: 'NONE',\n constants.ET_REL: 'REL',\n constants.ET_EXEC: 'EXEC',\n constants.ET_DYN: 'DYN',\n constants.ET_CORE: 'CORE'}[elftype]\n return self._elftype\n\n @property\n def link_map(self):\n \"\"\"Pointer to the runtime link_map object\"\"\"\n if not self._link_map:\n self._link_map = self._find_linkmap()\n return self._link_map\n\n @property\n def dynamic(self):\n \"\"\"\n Returns:\n Pointer to the ``.DYNAMIC`` area.\n \"\"\"\n if not self._dynamic:\n self._dynamic = self._find_dynamic_phdr()\n return self._dynamic\n\n def _find_linkmap_assisted(self, path):\n \"\"\"Uses an ELF file to assist in finding the link_map.\n \"\"\"\n if isinstance(path, ELF):\n path = path.path\n\n # Load a fresh copy of the ELF\n with context.local(log_level='error'):\n elf = ELF(path)\n elf.address = self.libbase\n\n w = self.waitfor(\"Loading from %r\" % elf.path)\n\n # Save our real leaker\n real_leak = self.leak\n\n # Create a fake leaker which just leaks out of the 'loaded' ELF\n # However, we may load things which are outside of the ELF (e.g.\n # the linkmap or GOT) so we need to fall back on the real leak.\n @MemLeak\n def fake_leak(address):\n try:\n return elf.read(address, 4)\n except ValueError:\n return real_leak.b(address)\n\n # Save off our real leaker, use the fake leaker\n self.leak = fake_leak\n\n # Get useful pointers for resolving the linkmap faster\n w.status(\"Searching for DT_PLTGOT\")\n pltgot = self._find_dt(constants.DT_PLTGOT)\n\n w.status(\"Searching for DT_DEBUG\")\n debug = self._find_dt(constants.DT_DEBUG)\n\n # Restore the real leaker\n self.leak = real_leak\n\n # Find the linkmap using the helper pointers\n self._find_linkmap(pltgot, debug)\n self.success('Done')\n\n def _find_base(self, ptr):\n page_size = 0x1000\n page_mask = ~(page_size - 1)\n\n ptr &= page_mask\n w = None\n\n while True:\n if self.leak.compare(ptr, '\\x7fELF'):\n break\n\n # See if we can short circuit the search\n fast = self._find_base_optimized(ptr)\n if fast:\n ptr = fast\n continue\n\n ptr -= page_size\n\n if ptr < 0:\n raise ValueError(\"Address is negative, something is wrong!\")\n\n # Defer creating the spinner in the event that 'ptr'\n # is already the base address\n w = w or self.waitfor(\"Finding base address\")\n self.status('%#x' % ptr)\n\n # If we created a spinner, print the success message\n if w:\n self.success('%#x' % ptr)\n\n return ptr\n\n def _find_base_optimized(self, ptr):\n if not self.elf:\n return None\n\n # If we have an ELF< we can probably speed this up a little bit?\n # Note that we add +0x20 onto the offset in order to avoid needing\n # to leak any bytes which contain '\\r\\n\\t\\b '\n ptr += 0x20\n data = self.leak.n(ptr, 32)\n if not data:\n return None\n\n # Do not permit multiple matches\n matches = list(self.elf.search(data))\n if len(matches) != 1:\n return None\n\n candidate = matches[0]\n candidate -= self.elf.address\n\n # The match should have the same page-alignment as our leaked data.\n if candidate & 0xfff != 0x20:\n return None\n\n # Adjust based on the original pointer we got, and the ELF's address.\n ptr -= candidate\n return ptr\n\n def _find_dynamic_phdr(self):\n \"\"\"\n Returns the address of the first Program Header with the type\n PT_DYNAMIC.\n \"\"\"\n leak = self.leak\n base = self.libbase\n\n #First find PT_DYNAMIC\n Ehdr = {32: elf.Elf32_Ehdr, 64: elf.Elf64_Ehdr}[self.elfclass]\n Phdr = {32: elf.Elf32_Phdr, 64: elf.Elf64_Phdr}[self.elfclass]\n\n self.status(\"PT_DYNAMIC\")\n\n phead = base + leak.field(base, Ehdr.e_phoff)\n self.status(\"PT_DYNAMIC header = %#x\" % phead)\n\n phnum = leak.field(base, Ehdr.e_phnum)\n self.status(\"PT_DYNAMIC count = %#x\" % phnum)\n\n for i in range(phnum):\n if leak.field_compare(phead, Phdr.p_type, constants.PT_DYNAMIC):\n break\n phead += sizeof(Phdr)\n else:\n self.failure(\"Could not find Program Header of type PT_DYNAMIC\")\n return None\n\n dynamic = leak.field(phead, Phdr.p_vaddr)\n self.status(\"PT_DYNAMIC @ %#x\" % dynamic)\n\n dynamic = self._make_absolute_ptr(dynamic)\n\n return dynamic\n\n def _find_dt(self, tag):\n \"\"\"\n Find an entry in the DYNAMIC array.\n\n Arguments:\n tag(int): Single tag to find\n\n Returns:\n Pointer to the data described by the specified entry.\n \"\"\"\n leak = self.leak\n base = self.libbase\n dynamic = self.dynamic\n name = next(k for k,v in ENUM_D_TAG.items() if v == tag)\n\n Dyn = {32: elf.Elf32_Dyn, 64: elf.Elf64_Dyn} [self.elfclass]\n\n # Found the _DYNAMIC program header, now find PLTGOT entry in it\n # An entry with a DT_NULL tag marks the end of the DYNAMIC array.\n while not leak.field_compare(dynamic, Dyn.d_tag, constants.DT_NULL):\n if leak.field_compare(dynamic, Dyn.d_tag, tag):\n break\n dynamic += sizeof(Dyn)\n else:\n self.failure(\"Could not find tag %s\" % name)\n return None\n\n self.status(\"Found %s at %#x\" % (name, dynamic))\n ptr = leak.field(dynamic, Dyn.d_ptr)\n\n ptr = self._make_absolute_ptr(ptr)\n\n return ptr\n\n\n def _find_linkmap(self, pltgot=None, debug=None):\n \"\"\"\n The linkmap is a chained structure created by the loader at runtime\n which contains information on the names and load addresses of all\n libraries.\n\n For non-RELRO binaries, a pointer to this is stored in the .got.plt\n area.\n\n For RELRO binaries, a pointer is additionally stored in the DT_DEBUG\n area.\n \"\"\"\n w = self.waitfor(\"Finding linkmap\")\n\n Got = {32: elf.Elf_i386_GOT, 64: elf.Elf_x86_64_GOT}[self.elfclass]\n r_debug = {32: elf.Elf32_r_debug, 64: elf.Elf64_r_debug}[self.elfclass]\n\n linkmap = None\n\n if not pltgot:\n w.status(\"Finding linkmap: DT_PLTGOT\")\n pltgot = self._find_dt(constants.DT_PLTGOT)\n\n if pltgot:\n w.status(\"GOT.linkmap\")\n linkmap = self.leak.field(pltgot, Got.linkmap)\n w.status(\"GOT.linkmap %#x\" % linkmap)\n\n if not linkmap:\n debug = debug or self._find_dt(constants.DT_DEBUG)\n if debug:\n w.status(\"r_debug.linkmap\")\n linkmap = self.leak.field(debug, r_debug.r_map)\n w.status(\"r_debug.linkmap %#x\" % result)\n\n if not linkmap:\n w.failure(\"Could not find DT_PLTGOT or DT_DEBUG\")\n return None\n\n linkmap = self._make_absolute_ptr(linkmap)\n\n w.success('%#x' % linkmap)\n return linkmap\n\n def waitfor(self, msg):\n if not self._waitfor:\n self._waitfor = log.waitfor(msg)\n else:\n self.status(msg)\n return self._waitfor\n\n def failure(self, msg):\n if not self._waitfor:\n log.failure(msg)\n else:\n self._waitfor.failure(msg)\n self._waitfor = None\n\n def success(self, msg):\n if not self._waitfor:\n log.success(msg)\n else:\n self._waitfor.success(msg)\n self._waitfor = None\n\n def status(self, msg):\n if not self._waitfor:\n log.info(msg)\n else:\n self._waitfor.status(msg)\n\n @property\n def libc(self):\n \"\"\"libc(self) -> ELF\n\n Leak the Build ID of the remote libc.so, download the file,\n and load an ``ELF`` object with the correct base address.\n\n Returns:\n An ELF object, or None.\n \"\"\"\n libc = 'libc.so'\n\n with self.waitfor('Downloading libc'):\n dynlib = self._dynamic_load_dynelf(libc)\n\n self.status(\"Trying lookup based on Build ID\")\n build_id = dynlib._lookup_build_id(libc)\n\n if not build_id:\n return None\n\n self.status(\"Trying lookup based on Build ID: %s\" % build_id)\n path = libcdb.search_by_build_id(build_id)\n\n if not path:\n return None\n\n libc = ELF(path)\n libc.address = dynlib.libbase\n return libc\n\n def lookup (self, symb = None, lib = None):\n \"\"\"lookup(symb = None, lib = None) -> int\n\n Find the address of ``symbol``, which is found in ``lib``.\n\n Arguments:\n symb(str): Named routine to look up\n If omitted, the base address of the library will be returned.\n lib(str): Substring to match for the library name.\n If omitted, the current library is searched.\n If set to ``'libc'``, ``'libc.so'`` is assumed.\n\n Returns:\n Address of the named symbol, or :const:`None`.\n \"\"\"\n result = None\n\n if lib == 'libc':\n lib = 'libc.so'\n\n #\n # Get a pretty name for the symbol to show the user\n #\n if symb and lib:\n pretty = '%r in %r' % (symb, lib)\n else:\n pretty = repr(symb or lib)\n\n if not pretty:\n self.failure(\"Must specify a library or symbol\")\n\n self.waitfor('Resolving %s' % pretty)\n\n #\n # If we are loading from a different library, create\n # a DynELF instance for it.\n #\n if lib is not None: dynlib = self._dynamic_load_dynelf(lib)\n else: dynlib = self\n\n if dynlib is None:\n log.failure(\"Could not find %r\" % lib)\n return None\n\n #\n # If we are resolving a symbol in the library, find it.\n #\n if symb and self.libcdb:\n # Try a quick lookup by build ID\n self.status(\"Trying lookup based on Build ID\")\n build_id = dynlib._lookup_build_id(lib=lib)\n if build_id:\n log.info(\"Trying lookup based on Build ID: %s\" % build_id)\n path = libcdb.search_by_build_id(build_id)\n if path:\n with context.local(log_level='error'):\n e = ELF(path)\n e.address = dynlib.libbase\n result = e.symbols[symb]\n if symb and not result:\n self.status(\"Trying remote lookup\")\n result = dynlib._lookup(symb)\n if not symb:\n result = dynlib.libbase\n\n #\n # Did we win?\n #\n if result: self.success(\"%#x\" % result)\n else: self.failure(\"Could not find %s\" % pretty)\n\n return result\n\n def bases(self):\n '''Resolve base addresses of all loaded libraries.\n\n Return a dictionary mapping library path to its base address.\n '''\n if not self._bases:\n leak = self.leak\n LinkMap = {32: elf.Elf32_Link_Map, 64: elf.Elf64_Link_Map}[self.elfclass]\n\n cur = self.link_map\n\n # make sure we rewind to the beginning!\n while leak.field(cur, LinkMap.l_prev):\n cur = leak.field(cur, LinkMap.l_prev)\n\n while cur:\n p_name = leak.field(cur, LinkMap.l_name)\n name = leak.s(p_name)\n addr = leak.field(cur, LinkMap.l_addr)\n cur = leak.field(cur, LinkMap.l_next)\n\n log.debug('Found %r @ %#x' % (name, addr))\n\n self._bases[name] = addr\n\n return self._bases\n\n def _dynamic_load_dynelf(self, libname):\n \"\"\"_dynamic_load_dynelf(libname) -> DynELF\n\n Looks up information about a loaded library via the link map.\n\n Arguments:\n libname(str): Name of the library to resolve, or a substring (e.g. 'libc.so')\n\n Returns:\n A DynELF instance for the loaded library, or None.\n \"\"\"\n cur = self.link_map\n leak = self.leak\n LinkMap = {32: elf.Elf32_Link_Map, 64: elf.Elf64_Link_Map}[self.elfclass]\n\n # make sure we rewind to the beginning!\n while leak.field(cur, LinkMap.l_prev):\n cur = leak.field(cur, LinkMap.l_prev)\n\n while cur:\n self.status(\"link_map entry %#x\" % cur)\n p_name = leak.field(cur, LinkMap.l_name)\n name = leak.s(p_name)\n\n if libname in name:\n break\n\n if name:\n self.status('Skipping %s' % name)\n\n cur = leak.field(cur, LinkMap.l_next)\n else:\n self.failure(\"Could not find library with name containing %r\" % libname)\n return None\n\n libbase = leak.field(cur, LinkMap.l_addr)\n\n self.status(\"Resolved library %r at %#x\" % (libname, libbase))\n\n lib = DynELF(leak, libbase)\n lib._dynamic = leak.field(cur, LinkMap.l_ld)\n lib._waitfor = self._waitfor\n return lib\n\n def _lookup(self, symb):\n \"\"\"Performs the actual symbol lookup within one ELF file.\"\"\"\n leak = self.leak\n Dyn = {32: elf.Elf32_Dyn, 64: elf.Elf64_Dyn}[self.elfclass]\n name = lambda tag: next(k for k,v in ENUM_D_TAG.items() if v == tag)\n\n self.status('.gnu.hash/.hash, .strtab and .symtab offsets')\n\n #\n # We need all three of the hash, string table, and symbol table.\n #\n hshtab = self._find_dt(constants.DT_GNU_HASH)\n strtab = self._find_dt(constants.DT_STRTAB)\n symtab = self._find_dt(constants.DT_SYMTAB)\n\n # Assume GNU hash will hit, since it is the default for GCC.\n if hshtab:\n hshtype = 'gnu'\n else:\n hshtab = self._find_dt(constants.DT_HASH)\n hshtype = 'sysv'\n\n if not all([strtab, symtab, hshtab]):\n self.failure(\"Could not find all tables\")\n\n strtab = self._make_absolute_ptr(strtab)\n symtab = self._make_absolute_ptr(symtab)\n hshtab = self._make_absolute_ptr(hshtab)\n\n #\n # Perform the hash lookup\n #\n routine = {'sysv': self._resolve_symbol_sysv,\n 'gnu': self._resolve_symbol_gnu}[hshtype]\n return routine(self.libbase, symb, hshtab, strtab, symtab)\n\n def _resolve_symbol_sysv(self, libbase, symb, hshtab, strtab, symtab):\n \"\"\"\n Internal Documentation:\n See the ELF manual for more information. Search for the phrase\n \"A hash table of Elf32_Word objects supports symbol table access\", or see:\n https://docs.oracle.com/cd/E19504-01/802-6319/6ia12qkfo/index.html#chapter6-48031\n\n struct Elf_Hash {\n uint32_t nbucket;\n uint32_t nchain;\n uint32_t bucket[nbucket];\n uint32_t chain[nchain];\n }\n\n You can force an ELF to use this type of symbol table by compiling\n with 'gcc -Wl,--hash-style=sysv'\n \"\"\"\n self.status('.hash parms')\n leak = self.leak\n Sym = {32: elf.Elf32_Sym, 64: elf.Elf64_Sym}[self.elfclass]\n\n nbucket = leak.field(hshtab, elf.Elf_HashTable.nbucket)\n bucketaddr = hshtab + sizeof(elf.Elf_HashTable)\n chain = bucketaddr + (nbucket * 4)\n\n self.status('hashmap')\n hsh = sysv_hash(symb) % nbucket\n\n # Get the index out of the bucket for the hash we computed\n idx = leak.d(bucketaddr, hsh)\n\n while idx != constants.STN_UNDEF:\n # Look up the symbol corresponding to the specified index\n sym = symtab + (idx * sizeof(Sym))\n symtype = leak.field(sym, Sym.st_info) & 0xf\n\n # We only care about functions\n if symtype == constants.STT_FUNC:\n\n # Leak the name of the function from the symbol table\n name = leak.s(strtab + leak.field(sym, Sym.st_name))\n\n # Make sure it matches the name of the symbol we were looking for.\n if name == symb:\n #Bingo\n addr = libbase + leak.field(sym, Sym.st_value)\n return addr\n\n self.status(\"%s (hash collision)\" % name)\n\n # The name did not match what we were looking for, or we assume\n # it did not since it was not a function.\n # Follow the chain for this particular hash.\n idx = leak.d(chain, idx)\n else:\n self.failure('Could not find a SYSV hash that matched %#x' % hsh)\n return None\n\n def _resolve_symbol_gnu(self, libbase, symb, hshtab, strtab, symtab):\n \"\"\"\n Internal Documentation:\n The GNU hash structure is a bit more complex than the normal hash\n structure.\n\n Again, Oracle has good documentation.\n https://blogs.oracle.com/ali/entry/gnu_hash_elf_sections\n\n You can force an ELF to use this type of symbol table by compiling\n with 'gcc -Wl,--hash-style=gnu'\n \"\"\"\n self.status('.gnu.hash parms')\n leak = self.leak\n Sym = {32: elf.Elf32_Sym, 64: elf.Elf64_Sym}[self.elfclass]\n\n # The number of hash buckets (hash % nbuckets)\n nbuckets = leak.field(hshtab, elf.GNU_HASH.nbuckets)\n\n # Index of the first accessible symbol in the hash table\n # Numbering doesn't start at zero, it starts at symndx\n symndx = leak.field(hshtab, elf.GNU_HASH.symndx)\n\n # Number of things in the bloom filter.\n # We don't care about the contents, but we have to skip over it.\n maskwords = leak.field(hshtab, elf.GNU_HASH.maskwords)\n\n # Skip over the bloom filter to get to the buckets\n elfword = self.elfclass / 8\n buckets = hshtab + sizeof(elf.GNU_HASH) + (elfword * maskwords)\n\n # The chains come after the buckets\n chains = buckets + (4 * nbuckets)\n\n self.status('hash chain index')\n\n # Hash the symbol, find its bucket\n hsh = gnu_hash(symb)\n bucket = hsh % nbuckets\n\n # Get the first index in the chain for that bucket\n ndx = leak.d(buckets, bucket)\n if ndx == 0:\n self.failure('Empty chain')\n return None\n\n # Find the start of the chain, taking into account that numbering\n # effectively starts at 'symndx' within the chains.\n chain = chains + 4 * (ndx - symndx)\n\n self.status('hash chain')\n\n # Iteratively get the I'th entry from the hash chain, until we find\n # one that matches.\n i = 0\n hsh &= ~1\n\n # The least significant bit is used as a stopper bit.\n # It is set to 1 when a symbol is the last symbol in a given hash chain.\n hsh2 = 0\n while not hsh2 & 1:\n hsh2 = leak.d(chain, i)\n if hsh == (hsh2 & ~1):\n # Check for collision on hash values\n sym = symtab + sizeof(Sym) * (ndx + i)\n name = leak.s(strtab + leak.field(sym, Sym.st_name))\n\n if name == symb:\n # No collision, get offset and calculate address\n offset = leak.field(sym, Sym.st_value)\n addr = offset + libbase\n return addr\n\n self.status(\"%s (hash collision)\" % name)\n\n # Collision or no match, continue to the next item\n i += 1\n else:\n self.failure('Could not find a GNU hash that matched %#x' % hsh)\n return None\n\n def _lookup_build_id(self, lib = None):\n\n libbase = self.libbase\n if not self.link_map:\n self.status(\"No linkmap found\")\n return None\n\n if lib is not None:\n libbase = self.lookup(symb = None, lib = lib)\n\n if not libbase:\n self.status(\"Couldn't find libc base\")\n return None\n\n for offset in libcdb.get_build_id_offsets():\n address = libbase + offset\n if self.leak.compare(address + 0xC, \"GNU\\x00\"):\n return enhex(''.join(self.leak.raw(address + 0x10, 20)))\n else:\n self.status(\"Magic did not match\")\n pass\n\n def _make_absolute_ptr(self, ptr_or_offset):\n \"\"\"For shared libraries (or PIE executables), many ELF fields may\n contain offsets rather than actual pointers. If the ELF type is 'DYN',\n the argument may be an offset. It will not necessarily be an offset,\n because the run-time linker may have fixed it up to be a real pointer\n already. In this case an educated guess is made, and the ELF base\n address is added to the value if it is determined to be an offset.\n \"\"\"\n if_ptr = ptr_or_offset\n if_offset = ptr_or_offset + self.libbase\n\n # if the ELF type is not DYN, the value is a pointer\n\n if self.elftype != 'DYN':\n return if_ptr\n\n # if the ELF type may be DYN, guess\n\n if 0 < ptr_or_offset < self.libbase:\n return if_offset\n else:\n return if_ptr\n\n def stack(self):\n \"\"\"Finds a pointer to the stack via __environ, which is an exported\n symbol in libc, which points to the environment block.\n \"\"\"\n symbols = ['environ', '_environ', '__environ']\n\n for symbol in symbols:\n environ = self.lookup(symbol, 'libc')\n\n if environ:\n break\n else:\n log.error(\"Could not find the stack\")\n\n stack = self.leak.p(environ)\n\n self.success('*environ: %#x' % stack)\n\n return stack\n\n def heap(self):\n \"\"\"Finds the beginning of the heap via __curbrk, which is an exported\n symbol in the linker, which points to the current brk.\n \"\"\"\n curbrk = self.lookup('__curbrk', 'libc')\n brk = self.leak.p(curbrk)\n\n self.success('*curbrk: %#x' % brk)\n\n return brk\n","path":"pwnlib/dynelf.py"}],"string":"[\n {\n \"content\": \"\\\"\\\"\\\"\\nResolve symbols in loaded, dynamically-linked ELF binaries.\\nGiven a function which can leak data at an arbitrary address,\\nany symbol in any loaded library can be resolved.\\n\\nExample\\n^^^^^^^^\\n\\n::\\n\\n # Assume a process or remote connection\\n p = process('./pwnme')\\n\\n # Declare a function that takes a single address, and\\n # leaks at least one byte at that address.\\n def leak(address):\\n data = p.read(address, 4)\\n log.debug(\\\"%#x => %s\\\" % (address, (data or '').encode('hex')))\\n return data\\n\\n # For the sake of this example, let's say that we\\n # have any of these pointers. One is a pointer into\\n # the target binary, the other two are pointers into libc\\n main = 0xfeedf4ce\\n libc = 0xdeadb000\\n system = 0xdeadbeef\\n\\n # With our leaker, and a pointer into our target binary,\\n # we can resolve the address of anything.\\n #\\n # We do not actually need to have a copy of the target\\n # binary for this to work.\\n d = DynELF(leak, main)\\n assert d.lookup(None, 'libc') == libc\\n assert d.lookup('system', 'libc') == system\\n\\n # However, if we *do* have a copy of the target binary,\\n # we can speed up some of the steps.\\n d = DynELF(leak, main, elf=ELF('./pwnme'))\\n assert d.lookup(None, 'libc') == libc\\n assert d.lookup('system', 'libc') == system\\n\\n # Alternately, we can resolve symbols inside another library,\\n # given a pointer into it.\\n d = DynELF(leak, libc + 0x1234)\\n assert d.lookup('system') == system\\n\\nDynELF\\n\\\"\\\"\\\"\\nfrom __future__ import absolute_import\\n\\nimport ctypes\\n\\nfrom elftools.elf.enums import ENUM_D_TAG\\n\\nfrom pwnlib import elf\\nfrom pwnlib import libcdb\\nfrom pwnlib.context import context\\nfrom pwnlib.elf import ELF\\nfrom pwnlib.elf import constants\\nfrom pwnlib.log import getLogger\\nfrom pwnlib.memleak import MemLeak\\nfrom pwnlib.util.fiddling import enhex\\nfrom pwnlib.util.packing import unpack\\nfrom pwnlib.util.web import wget\\n\\nlog = getLogger(__name__)\\nsizeof = ctypes.sizeof\\n\\ndef sysv_hash(symbol):\\n \\\"\\\"\\\"sysv_hash(str) -> int\\n\\n Function used to generate SYSV-style hashes for strings.\\n \\\"\\\"\\\"\\n h = 0\\n g = 0\\n for c in symbol:\\n h = (h << 4) + ord(c)\\n g = h & 0xf0000000\\n h ^= (g >> 24)\\n h &= ~g\\n return h & 0xffffffff\\n\\ndef gnu_hash(s):\\n \\\"\\\"\\\"gnu_hash(str) -> int\\n\\n Function used to generated GNU-style hashes for strings.\\n \\\"\\\"\\\"\\n h = 5381\\n for c in s:\\n h = h * 33 + ord(c)\\n return h & 0xffffffff\\n\\nclass DynELF(object):\\n '''\\n DynELF knows how to resolve symbols in remote processes via an infoleak or\\n memleak vulnerability encapsulated by :class:`pwnlib.memleak.MemLeak`.\\n\\n Implementation Details:\\n\\n Resolving Functions:\\n\\n In all ELFs which export symbols for importing by other libraries,\\n (e.g. ``libc.so``) there are a series of tables which give exported\\n symbol names, exported symbol addresses, and the ``hash`` of those\\n exported symbols. By applying a hash function to the name of the\\n desired symbol (e.g., ``'printf'``), it can be located in the hash\\n table. Its location in the hash table provides an index into the\\n string name table (strtab_), and the symbol address (symtab_).\\n\\n Assuming we have the base address of ``libc.so``, the way to resolve\\n the address of ``printf`` is to locate the ``symtab``, ``strtab``,\\n and hash table. The string ``\\\"printf\\\"`` is hashed according to the\\n style of the hash table (SYSV_ or GNU_), and the hash table is\\n walked until a matching entry is located. We can verify an exact\\n match by checking the string table, and then get the offset into\\n ``libc.so`` from the ``symtab``.\\n\\n Resolving Library Addresses:\\n\\n If we have a pointer into a dynamically-linked executable, we can\\n leverage an internal linker structure called the `link map`_. This\\n is a linked list structure which contains information about each\\n loaded library, including its full path and base address.\\n\\n A pointer to the ``link map`` can be found in two ways. Both are\\n referenced from entries in the DYNAMIC_ array.\\n\\n - In non-RELRO binaries, a pointer is placed in the `.got.plt`_ area\\n in the binary. This is marked by finding the DT_PLTGOT_ area in the\\n binary.\\n - In all binaries, a pointer can be found in the area described by\\n the DT_DEBUG_ area. This exists even in stripped binaries.\\n\\n For maximum flexibility, both mechanisms are used exhaustively.\\n\\n .. _symtab: https://refspecs.linuxbase.org/elf/gabi4+/ch4.symtab.html\\n .. _strtab: https://refspecs.linuxbase.org/elf/gabi4+/ch4.strtab.html\\n .. _.got.plt: https://refspecs.linuxbase.org/LSB_3.1.1/LSB-Core-generic/LSB-Core-generic/specialsections.html\\n .. _DYNAMIC: http://www.sco.com/developers/gabi/latest/ch5.dynamic.html#dynamic_section\\n .. _SYSV: https://refspecs.linuxbase.org/elf/gabi4+/ch5.dynamic.html#hash\\n .. _GNU: https://blogs.oracle.com/ali/entry/gnu_hash_elf_sections\\n .. _DT_DEBUG: https://reverseengineering.stackexchange.com/questions/6525/elf-link-map-when-linked-as-relro\\n .. _link map: https://sourceware.org/git/?p=glibc.git;a=blob;f=elf/link.h;h=eaca8028e45a859ac280301a6e955a14eed1b887;hb=HEAD#l84\\n .. _DT_PLTGOT: http://refspecs.linuxfoundation.org/ELF/zSeries/lzsabi0_zSeries/x2251.html\\n '''\\n\\n def __init__(self, leak, pointer=None, elf=None, libcdb=True):\\n '''\\n Instantiates an object which can resolve symbols in a running binary\\n given a :class:`pwnlib.memleak.MemLeak` leaker and a pointer inside\\n the binary.\\n\\n Arguments:\\n leak(MemLeak): Instance of pwnlib.memleak.MemLeak for leaking memory\\n pointer(int): A pointer into a loaded ELF file\\n elf(str,ELF): Path to the ELF file on disk, or a loaded :class:`pwnlib.elf.ELF`.\\n libcdb(bool): Attempt to use libcdb to speed up libc lookups\\n '''\\n self.libcdb = libcdb\\n self._elfclass = None\\n self._elftype = None\\n self._link_map = None\\n self._waitfor = None\\n self._bases = {}\\n self._dynamic = None\\n\\n if not (pointer or (elf and elf.address)):\\n log.error(\\\"Must specify either a pointer into a module and/or an ELF file with a valid base address\\\")\\n\\n pointer = pointer or elf.address\\n\\n if not isinstance(leak, MemLeak):\\n leak = MemLeak(leak)\\n\\n if not elf:\\n log.warn_once(\\\"No ELF provided. Leaking is much faster if you have a copy of the ELF being leaked.\\\")\\n\\n self.elf = elf\\n self.leak = leak\\n self.libbase = self._find_base(pointer or elf.address)\\n\\n if elf:\\n self._find_linkmap_assisted(elf)\\n\\n @classmethod\\n def for_one_lib_only(cls, leak, ptr):\\n return cls(leak, ptr)\\n\\n @classmethod\\n def from_lib_ptr(cls, leak, ptr):\\n return cls(leak, ptr)\\n\\n @staticmethod\\n def find_base(leak, ptr):\\n \\\"\\\"\\\"Given a :class:`pwnlib.memleak.MemLeak` object and a pointer into a\\n library, find its base address.\\n \\\"\\\"\\\"\\n return DynELF(leak, ptr).libbase\\n\\n @property\\n def elfclass(self):\\n \\\"\\\"\\\"32 or 64\\\"\\\"\\\"\\n if not self._elfclass:\\n elfclass = self.leak.field(self.libbase, elf.Elf_eident.EI_CLASS)\\n self._elfclass = {constants.ELFCLASS32: 32,\\n constants.ELFCLASS64: 64}[elfclass]\\n return self._elfclass\\n\\n @property\\n def elftype(self):\\n \\\"\\\"\\\"e_type from the elf header. In practice the value will almost always\\n be 'EXEC' or 'DYN'. If the value is architecture-specific (between\\n ET_LOPROC and ET_HIPROC) or invalid, KeyError is raised.\\n \\\"\\\"\\\"\\n if not self._elftype:\\n Ehdr = {32: elf.Elf32_Ehdr, 64: elf.Elf64_Ehdr}[self.elfclass]\\n elftype = self.leak.field(self.libbase, Ehdr.e_type)\\n self._elftype = {constants.ET_NONE: 'NONE',\\n constants.ET_REL: 'REL',\\n constants.ET_EXEC: 'EXEC',\\n constants.ET_DYN: 'DYN',\\n constants.ET_CORE: 'CORE'}[elftype]\\n return self._elftype\\n\\n @property\\n def link_map(self):\\n \\\"\\\"\\\"Pointer to the runtime link_map object\\\"\\\"\\\"\\n if not self._link_map:\\n self._link_map = self._find_linkmap()\\n return self._link_map\\n\\n @property\\n def dynamic(self):\\n \\\"\\\"\\\"\\n Returns:\\n Pointer to the ``.DYNAMIC`` area.\\n \\\"\\\"\\\"\\n if not self._dynamic:\\n self._dynamic = self._find_dynamic_phdr()\\n return self._dynamic\\n\\n def _find_linkmap_assisted(self, path):\\n \\\"\\\"\\\"Uses an ELF file to assist in finding the link_map.\\n \\\"\\\"\\\"\\n if isinstance(path, ELF):\\n path = path.path\\n\\n # Load a fresh copy of the ELF\\n with context.local(log_level='error'):\\n elf = ELF(path)\\n elf.address = self.libbase\\n\\n w = self.waitfor(\\\"Loading from %r\\\" % elf.path)\\n\\n # Save our real leaker\\n real_leak = self.leak\\n\\n # Create a fake leaker which just leaks out of the 'loaded' ELF\\n # However, we may load things which are outside of the ELF (e.g.\\n # the linkmap or GOT) so we need to fall back on the real leak.\\n @MemLeak\\n def fake_leak(address):\\n try:\\n return elf.read(address, 4)\\n except ValueError:\\n return real_leak.b(address)\\n\\n # Save off our real leaker, use the fake leaker\\n self.leak = fake_leak\\n\\n # Get useful pointers for resolving the linkmap faster\\n w.status(\\\"Searching for DT_PLTGOT\\\")\\n pltgot = self._find_dt(constants.DT_PLTGOT)\\n\\n w.status(\\\"Searching for DT_DEBUG\\\")\\n debug = self._find_dt(constants.DT_DEBUG)\\n\\n # Restore the real leaker\\n self.leak = real_leak\\n\\n # Find the linkmap using the helper pointers\\n self._find_linkmap(pltgot, debug)\\n self.success('Done')\\n\\n def _find_base(self, ptr):\\n page_size = 0x1000\\n page_mask = ~(page_size - 1)\\n\\n ptr &= page_mask\\n w = None\\n\\n while True:\\n if self.leak.compare(ptr, '\\\\x7fELF'):\\n break\\n\\n # See if we can short circuit the search\\n fast = self._find_base_optimized(ptr)\\n if fast:\\n ptr = fast\\n continue\\n\\n ptr -= page_size\\n\\n if ptr < 0:\\n raise ValueError(\\\"Address is negative, something is wrong!\\\")\\n\\n # Defer creating the spinner in the event that 'ptr'\\n # is already the base address\\n w = w or self.waitfor(\\\"Finding base address\\\")\\n self.status('%#x' % ptr)\\n\\n # If we created a spinner, print the success message\\n if w:\\n self.success('%#x' % ptr)\\n\\n return ptr\\n\\n def _find_base_optimized(self, ptr):\\n if not self.elf:\\n return None\\n\\n # If we have an ELF< we can probably speed this up a little bit?\\n # Note that we add +0x20 onto the offset in order to avoid needing\\n # to leak any bytes which contain '\\\\r\\\\n\\\\t\\\\b '\\n ptr += 0x20\\n data = self.leak.n(ptr, 32)\\n if not data:\\n return None\\n\\n # Do not permit multiple matches\\n matches = list(self.elf.search(data))\\n if len(matches) != 1:\\n return None\\n\\n candidate = matches[0]\\n candidate -= self.elf.address\\n\\n # The match should have the same page-alignment as our leaked data.\\n if candidate & 0xfff != 0x20:\\n return None\\n\\n # Adjust based on the original pointer we got, and the ELF's address.\\n ptr -= candidate\\n return ptr\\n\\n def _find_dynamic_phdr(self):\\n \\\"\\\"\\\"\\n Returns the address of the first Program Header with the type\\n PT_DYNAMIC.\\n \\\"\\\"\\\"\\n leak = self.leak\\n base = self.libbase\\n\\n #First find PT_DYNAMIC\\n Ehdr = {32: elf.Elf32_Ehdr, 64: elf.Elf64_Ehdr}[self.elfclass]\\n Phdr = {32: elf.Elf32_Phdr, 64: elf.Elf64_Phdr}[self.elfclass]\\n\\n self.status(\\\"PT_DYNAMIC\\\")\\n\\n phead = base + leak.field(base, Ehdr.e_phoff)\\n self.status(\\\"PT_DYNAMIC header = %#x\\\" % phead)\\n\\n phnum = leak.field(base, Ehdr.e_phnum)\\n self.status(\\\"PT_DYNAMIC count = %#x\\\" % phnum)\\n\\n for i in range(phnum):\\n if leak.field_compare(phead, Phdr.p_type, constants.PT_DYNAMIC):\\n break\\n phead += sizeof(Phdr)\\n else:\\n self.failure(\\\"Could not find Program Header of type PT_DYNAMIC\\\")\\n return None\\n\\n dynamic = leak.field(phead, Phdr.p_vaddr)\\n self.status(\\\"PT_DYNAMIC @ %#x\\\" % dynamic)\\n\\n dynamic = self._make_absolute_ptr(dynamic)\\n\\n return dynamic\\n\\n def _find_dt(self, tag):\\n \\\"\\\"\\\"\\n Find an entry in the DYNAMIC array.\\n\\n Arguments:\\n tag(int): Single tag to find\\n\\n Returns:\\n Pointer to the data described by the specified entry.\\n \\\"\\\"\\\"\\n leak = self.leak\\n base = self.libbase\\n dynamic = self.dynamic\\n name = next(k for k,v in ENUM_D_TAG.items() if v == tag)\\n\\n Dyn = {32: elf.Elf32_Dyn, 64: elf.Elf64_Dyn} [self.elfclass]\\n\\n # Found the _DYNAMIC program header, now find PLTGOT entry in it\\n # An entry with a DT_NULL tag marks the end of the DYNAMIC array.\\n while not leak.field_compare(dynamic, Dyn.d_tag, constants.DT_NULL):\\n if leak.field_compare(dynamic, Dyn.d_tag, tag):\\n break\\n dynamic += sizeof(Dyn)\\n else:\\n self.failure(\\\"Could not find tag %s\\\" % name)\\n return None\\n\\n self.status(\\\"Found %s at %#x\\\" % (name, dynamic))\\n ptr = leak.field(dynamic, Dyn.d_ptr)\\n\\n ptr = self._make_absolute_ptr(ptr)\\n\\n return ptr\\n\\n\\n def _find_linkmap(self, pltgot=None, debug=None):\\n \\\"\\\"\\\"\\n The linkmap is a chained structure created by the loader at runtime\\n which contains information on the names and load addresses of all\\n libraries.\\n\\n For non-RELRO binaries, a pointer to this is stored in the .got.plt\\n area.\\n\\n For RELRO binaries, a pointer is additionally stored in the DT_DEBUG\\n area.\\n \\\"\\\"\\\"\\n w = self.waitfor(\\\"Finding linkmap\\\")\\n\\n Got = {32: elf.Elf_i386_GOT, 64: elf.Elf_x86_64_GOT}[self.elfclass]\\n r_debug = {32: elf.Elf32_r_debug, 64: elf.Elf64_r_debug}[self.elfclass]\\n\\n linkmap = None\\n\\n if not pltgot:\\n w.status(\\\"Finding linkmap: DT_PLTGOT\\\")\\n pltgot = self._find_dt(constants.DT_PLTGOT)\\n\\n if pltgot:\\n w.status(\\\"GOT.linkmap\\\")\\n linkmap = self.leak.field(pltgot, Got.linkmap)\\n w.status(\\\"GOT.linkmap %#x\\\" % linkmap)\\n\\n if not linkmap:\\n debug = debug or self._find_dt(constants.DT_DEBUG)\\n if debug:\\n w.status(\\\"r_debug.linkmap\\\")\\n linkmap = self.leak.field(debug, r_debug.r_map)\\n w.status(\\\"r_debug.linkmap %#x\\\" % result)\\n\\n if not linkmap:\\n w.failure(\\\"Could not find DT_PLTGOT or DT_DEBUG\\\")\\n return None\\n\\n linkmap = self._make_absolute_ptr(linkmap)\\n\\n w.success('%#x' % linkmap)\\n return linkmap\\n\\n def waitfor(self, msg):\\n if not self._waitfor:\\n self._waitfor = log.waitfor(msg)\\n else:\\n self.status(msg)\\n return self._waitfor\\n\\n def failure(self, msg):\\n if not self._waitfor:\\n log.failure(msg)\\n else:\\n self._waitfor.failure(msg)\\n self._waitfor = None\\n\\n def success(self, msg):\\n if not self._waitfor:\\n log.success(msg)\\n else:\\n self._waitfor.success(msg)\\n self._waitfor = None\\n\\n def status(self, msg):\\n if not self._waitfor:\\n log.info(msg)\\n else:\\n self._waitfor.status(msg)\\n\\n @property\\n def libc(self):\\n \\\"\\\"\\\"libc(self) -> ELF\\n\\n Leak the Build ID of the remote libc.so, download the file,\\n and load an ``ELF`` object with the correct base address.\\n\\n Returns:\\n An ELF object, or None.\\n \\\"\\\"\\\"\\n libc = 'libc.so'\\n\\n with self.waitfor('Downloading libc'):\\n dynlib = self._dynamic_load_dynelf(libc)\\n\\n self.status(\\\"Trying lookup based on Build ID\\\")\\n build_id = dynlib._lookup_build_id(libc)\\n\\n if not build_id:\\n return None\\n\\n self.status(\\\"Trying lookup based on Build ID: %s\\\" % build_id)\\n path = libcdb.search_by_build_id(build_id)\\n\\n if not path:\\n return None\\n\\n libc = ELF(path)\\n libc.address = dynlib.libbase\\n return libc\\n\\n def lookup (self, symb = None, lib = None):\\n \\\"\\\"\\\"lookup(symb = None, lib = None) -> int\\n\\n Find the address of ``symbol``, which is found in ``lib``.\\n\\n Arguments:\\n symb(str): Named routine to look up\\n If omitted, the base address of the library will be returned.\\n lib(str): Substring to match for the library name.\\n If omitted, the current library is searched.\\n If set to ``'libc'``, ``'libc.so'`` is assumed.\\n\\n Returns:\\n Address of the named symbol, or :const:`None`.\\n \\\"\\\"\\\"\\n result = None\\n\\n if lib == 'libc':\\n lib = 'libc.so'\\n\\n #\\n # Get a pretty name for the symbol to show the user\\n #\\n if symb and lib:\\n pretty = '%r in %r' % (symb, lib)\\n else:\\n pretty = repr(symb or lib)\\n\\n if not pretty:\\n self.failure(\\\"Must specify a library or symbol\\\")\\n\\n self.waitfor('Resolving %s' % pretty)\\n\\n #\\n # If we are loading from a different library, create\\n # a DynELF instance for it.\\n #\\n if lib is not None: dynlib = self._dynamic_load_dynelf(lib)\\n else: dynlib = self\\n\\n if dynlib is None:\\n log.failure(\\\"Could not find %r\\\" % lib)\\n return None\\n\\n #\\n # If we are resolving a symbol in the library, find it.\\n #\\n if symb and self.libcdb:\\n # Try a quick lookup by build ID\\n self.status(\\\"Trying lookup based on Build ID\\\")\\n build_id = dynlib._lookup_build_id(lib=lib)\\n if build_id:\\n log.info(\\\"Trying lookup based on Build ID: %s\\\" % build_id)\\n path = libcdb.search_by_build_id(build_id)\\n if path:\\n with context.local(log_level='error'):\\n e = ELF(path)\\n e.address = dynlib.libbase\\n result = e.symbols[symb]\\n if symb and not result:\\n self.status(\\\"Trying remote lookup\\\")\\n result = dynlib._lookup(symb)\\n if not symb:\\n result = dynlib.libbase\\n\\n #\\n # Did we win?\\n #\\n if result: self.success(\\\"%#x\\\" % result)\\n else: self.failure(\\\"Could not find %s\\\" % pretty)\\n\\n return result\\n\\n def bases(self):\\n '''Resolve base addresses of all loaded libraries.\\n\\n Return a dictionary mapping library path to its base address.\\n '''\\n if not self._bases:\\n leak = self.leak\\n LinkMap = {32: elf.Elf32_Link_Map, 64: elf.Elf64_Link_Map}[self.elfclass]\\n\\n cur = self.link_map\\n\\n # make sure we rewind to the beginning!\\n while leak.field(cur, LinkMap.l_prev):\\n cur = leak.field(cur, LinkMap.l_prev)\\n\\n while cur:\\n p_name = leak.field(cur, LinkMap.l_name)\\n name = leak.s(p_name)\\n addr = leak.field(cur, LinkMap.l_addr)\\n cur = leak.field(cur, LinkMap.l_next)\\n\\n log.debug('Found %r @ %#x' % (name, addr))\\n\\n self._bases[name] = addr\\n\\n return self._bases\\n\\n def _dynamic_load_dynelf(self, libname):\\n \\\"\\\"\\\"_dynamic_load_dynelf(libname) -> DynELF\\n\\n Looks up information about a loaded library via the link map.\\n\\n Arguments:\\n libname(str): Name of the library to resolve, or a substring (e.g. 'libc.so')\\n\\n Returns:\\n A DynELF instance for the loaded library, or None.\\n \\\"\\\"\\\"\\n cur = self.link_map\\n leak = self.leak\\n LinkMap = {32: elf.Elf32_Link_Map, 64: elf.Elf64_Link_Map}[self.elfclass]\\n\\n # make sure we rewind to the beginning!\\n while leak.field(cur, LinkMap.l_prev):\\n cur = leak.field(cur, LinkMap.l_prev)\\n\\n while cur:\\n self.status(\\\"link_map entry %#x\\\" % cur)\\n p_name = leak.field(cur, LinkMap.l_name)\\n name = leak.s(p_name)\\n\\n if libname in name:\\n break\\n\\n if name:\\n self.status('Skipping %s' % name)\\n\\n cur = leak.field(cur, LinkMap.l_next)\\n else:\\n self.failure(\\\"Could not find library with name containing %r\\\" % libname)\\n return None\\n\\n libbase = leak.field(cur, LinkMap.l_addr)\\n\\n self.status(\\\"Resolved library %r at %#x\\\" % (libname, libbase))\\n\\n lib = DynELF(leak, libbase)\\n lib._dynamic = leak.field(cur, LinkMap.l_ld)\\n lib._waitfor = self._waitfor\\n return lib\\n\\n def _lookup(self, symb):\\n \\\"\\\"\\\"Performs the actual symbol lookup within one ELF file.\\\"\\\"\\\"\\n leak = self.leak\\n Dyn = {32: elf.Elf32_Dyn, 64: elf.Elf64_Dyn}[self.elfclass]\\n name = lambda tag: next(k for k,v in ENUM_D_TAG.items() if v == tag)\\n\\n self.status('.gnu.hash/.hash, .strtab and .symtab offsets')\\n\\n #\\n # We need all three of the hash, string table, and symbol table.\\n #\\n hshtab = self._find_dt(constants.DT_GNU_HASH)\\n strtab = self._find_dt(constants.DT_STRTAB)\\n symtab = self._find_dt(constants.DT_SYMTAB)\\n\\n # Assume GNU hash will hit, since it is the default for GCC.\\n if hshtab:\\n hshtype = 'gnu'\\n else:\\n hshtab = self._find_dt(constants.DT_HASH)\\n hshtype = 'sysv'\\n\\n if not all([strtab, symtab, hshtab]):\\n self.failure(\\\"Could not find all tables\\\")\\n\\n strtab = self._make_absolute_ptr(strtab)\\n symtab = self._make_absolute_ptr(symtab)\\n hshtab = self._make_absolute_ptr(hshtab)\\n\\n #\\n # Perform the hash lookup\\n #\\n routine = {'sysv': self._resolve_symbol_sysv,\\n 'gnu': self._resolve_symbol_gnu}[hshtype]\\n return routine(self.libbase, symb, hshtab, strtab, symtab)\\n\\n def _resolve_symbol_sysv(self, libbase, symb, hshtab, strtab, symtab):\\n \\\"\\\"\\\"\\n Internal Documentation:\\n See the ELF manual for more information. Search for the phrase\\n \\\"A hash table of Elf32_Word objects supports symbol table access\\\", or see:\\n https://docs.oracle.com/cd/E19504-01/802-6319/6ia12qkfo/index.html#chapter6-48031\\n\\n struct Elf_Hash {\\n uint32_t nbucket;\\n uint32_t nchain;\\n uint32_t bucket[nbucket];\\n uint32_t chain[nchain];\\n }\\n\\n You can force an ELF to use this type of symbol table by compiling\\n with 'gcc -Wl,--hash-style=sysv'\\n \\\"\\\"\\\"\\n self.status('.hash parms')\\n leak = self.leak\\n Sym = {32: elf.Elf32_Sym, 64: elf.Elf64_Sym}[self.elfclass]\\n\\n nbucket = leak.field(hshtab, elf.Elf_HashTable.nbucket)\\n bucketaddr = hshtab + sizeof(elf.Elf_HashTable)\\n chain = bucketaddr + (nbucket * 4)\\n\\n self.status('hashmap')\\n hsh = sysv_hash(symb) % nbucket\\n\\n # Get the index out of the bucket for the hash we computed\\n idx = leak.d(bucketaddr, hsh)\\n\\n while idx != constants.STN_UNDEF:\\n # Look up the symbol corresponding to the specified index\\n sym = symtab + (idx * sizeof(Sym))\\n symtype = leak.field(sym, Sym.st_info) & 0xf\\n\\n # We only care about functions\\n if symtype == constants.STT_FUNC:\\n\\n # Leak the name of the function from the symbol table\\n name = leak.s(strtab + leak.field(sym, Sym.st_name))\\n\\n # Make sure it matches the name of the symbol we were looking for.\\n if name == symb:\\n #Bingo\\n addr = libbase + leak.field(sym, Sym.st_value)\\n return addr\\n\\n self.status(\\\"%s (hash collision)\\\" % name)\\n\\n # The name did not match what we were looking for, or we assume\\n # it did not since it was not a function.\\n # Follow the chain for this particular hash.\\n idx = leak.d(chain, idx)\\n else:\\n self.failure('Could not find a SYSV hash that matched %#x' % hsh)\\n return None\\n\\n def _resolve_symbol_gnu(self, libbase, symb, hshtab, strtab, symtab):\\n \\\"\\\"\\\"\\n Internal Documentation:\\n The GNU hash structure is a bit more complex than the normal hash\\n structure.\\n\\n Again, Oracle has good documentation.\\n https://blogs.oracle.com/ali/entry/gnu_hash_elf_sections\\n\\n You can force an ELF to use this type of symbol table by compiling\\n with 'gcc -Wl,--hash-style=gnu'\\n \\\"\\\"\\\"\\n self.status('.gnu.hash parms')\\n leak = self.leak\\n Sym = {32: elf.Elf32_Sym, 64: elf.Elf64_Sym}[self.elfclass]\\n\\n # The number of hash buckets (hash % nbuckets)\\n nbuckets = leak.field(hshtab, elf.GNU_HASH.nbuckets)\\n\\n # Index of the first accessible symbol in the hash table\\n # Numbering doesn't start at zero, it starts at symndx\\n symndx = leak.field(hshtab, elf.GNU_HASH.symndx)\\n\\n # Number of things in the bloom filter.\\n # We don't care about the contents, but we have to skip over it.\\n maskwords = leak.field(hshtab, elf.GNU_HASH.maskwords)\\n\\n # Skip over the bloom filter to get to the buckets\\n elfword = self.elfclass / 8\\n buckets = hshtab + sizeof(elf.GNU_HASH) + (elfword * maskwords)\\n\\n # The chains come after the buckets\\n chains = buckets + (4 * nbuckets)\\n\\n self.status('hash chain index')\\n\\n # Hash the symbol, find its bucket\\n hsh = gnu_hash(symb)\\n bucket = hsh % nbuckets\\n\\n # Get the first index in the chain for that bucket\\n ndx = leak.d(buckets, bucket)\\n if ndx == 0:\\n self.failure('Empty chain')\\n return None\\n\\n # Find the start of the chain, taking into account that numbering\\n # effectively starts at 'symndx' within the chains.\\n chain = chains + 4 * (ndx - symndx)\\n\\n self.status('hash chain')\\n\\n # Iteratively get the I'th entry from the hash chain, until we find\\n # one that matches.\\n i = 0\\n hsh &= ~1\\n\\n # The least significant bit is used as a stopper bit.\\n # It is set to 1 when a symbol is the last symbol in a given hash chain.\\n hsh2 = 0\\n while not hsh2 & 1:\\n hsh2 = leak.d(chain, i)\\n if hsh == (hsh2 & ~1):\\n # Check for collision on hash values\\n sym = symtab + sizeof(Sym) * (ndx + i)\\n name = leak.s(strtab + leak.field(sym, Sym.st_name))\\n\\n if name == symb:\\n # No collision, get offset and calculate address\\n offset = leak.field(sym, Sym.st_value)\\n addr = offset + libbase\\n return addr\\n\\n self.status(\\\"%s (hash collision)\\\" % name)\\n\\n # Collision or no match, continue to the next item\\n i += 1\\n else:\\n self.failure('Could not find a GNU hash that matched %#x' % hsh)\\n return None\\n\\n def _lookup_build_id(self, lib = None):\\n\\n libbase = self.libbase\\n if not self.link_map:\\n self.status(\\\"No linkmap found\\\")\\n return None\\n\\n if lib is not None:\\n libbase = self.lookup(symb = None, lib = lib)\\n\\n if not libbase:\\n self.status(\\\"Couldn't find libc base\\\")\\n return None\\n\\n for offset in libcdb.get_build_id_offsets():\\n address = libbase + offset\\n if self.leak.compare(address + 0xC, \\\"GNU\\\\x00\\\"):\\n return enhex(''.join(self.leak.raw(address + 0x10, 20)))\\n else:\\n self.status(\\\"Magic did not match\\\")\\n pass\\n\\n def _make_absolute_ptr(self, ptr_or_offset):\\n \\\"\\\"\\\"For shared libraries (or PIE executables), many ELF fields may\\n contain offsets rather than actual pointers. If the ELF type is 'DYN',\\n the argument may be an offset. It will not necessarily be an offset,\\n because the run-time linker may have fixed it up to be a real pointer\\n already. In this case an educated guess is made, and the ELF base\\n address is added to the value if it is determined to be an offset.\\n \\\"\\\"\\\"\\n if_ptr = ptr_or_offset\\n if_offset = ptr_or_offset + self.libbase\\n\\n # if the ELF type is not DYN, the value is a pointer\\n\\n if self.elftype != 'DYN':\\n return if_ptr\\n\\n # if the ELF type may be DYN, guess\\n\\n if 0 < ptr_or_offset < self.libbase:\\n return if_offset\\n else:\\n return if_ptr\\n\\n def stack(self):\\n \\\"\\\"\\\"Finds a pointer to the stack via __environ, which is an exported\\n symbol in libc, which points to the environment block.\\n \\\"\\\"\\\"\\n symbols = ['environ', '_environ', '__environ']\\n\\n for symbol in symbols:\\n environ = self.lookup(symbol, 'libc')\\n\\n if environ:\\n break\\n else:\\n log.error(\\\"Could not find the stack\\\")\\n\\n stack = self.leak.p(environ)\\n\\n self.success('*environ: %#x' % stack)\\n\\n return stack\\n\\n def heap(self):\\n \\\"\\\"\\\"Finds the beginning of the heap via __curbrk, which is an exported\\n symbol in the linker, which points to the current brk.\\n \\\"\\\"\\\"\\n curbrk = self.lookup('__curbrk', 'libc')\\n brk = self.leak.p(curbrk)\\n\\n self.success('*curbrk: %#x' % brk)\\n\\n return brk\\n\",\n \"path\": \"pwnlib/dynelf.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"\"\"\"\nResolve symbols in loaded, dynamically-linked ELF binaries.\nGiven a function which can leak data at an arbitrary address,\nany symbol in any loaded library can be resolved.\n\nExample\n^^^^^^^^\n\n::\n\n # Assume a process or remote connection\n p = process('./pwnme')\n\n # Declare a function that takes a single address, and\n # leaks at least one byte at that address.\n def leak(address):\n data = p.read(address, 4)\n log.debug(\"%#x => %s\" % (address, (data or '').encode('hex')))\n return data\n\n # For the sake of this example, let's say that we\n # have any of these pointers. One is a pointer into\n # the target binary, the other two are pointers into libc\n main = 0xfeedf4ce\n libc = 0xdeadb000\n system = 0xdeadbeef\n\n # With our leaker, and a pointer into our target binary,\n # we can resolve the address of anything.\n #\n # We do not actually need to have a copy of the target\n # binary for this to work.\n d = DynELF(leak, main)\n assert d.lookup(None, 'libc') == libc\n assert d.lookup('system', 'libc') == system\n\n # However, if we *do* have a copy of the target binary,\n # we can speed up some of the steps.\n d = DynELF(leak, main, elf=ELF('./pwnme'))\n assert d.lookup(None, 'libc') == libc\n assert d.lookup('system', 'libc') == system\n\n # Alternately, we can resolve symbols inside another library,\n # given a pointer into it.\n d = DynELF(leak, libc + 0x1234)\n assert d.lookup('system') == system\n\nDynELF\n\"\"\"\nfrom __future__ import absolute_import\n\nimport ctypes\n\nfrom elftools.elf.enums import ENUM_D_TAG\n\nfrom pwnlib import elf\nfrom pwnlib import libcdb\nfrom pwnlib.context import context\nfrom pwnlib.elf import ELF\nfrom pwnlib.elf import constants\nfrom pwnlib.log import getLogger\nfrom pwnlib.memleak import MemLeak\nfrom pwnlib.util.fiddling import enhex\nfrom pwnlib.util.packing import unpack\nfrom pwnlib.util.web import wget\n\nlog = getLogger(__name__)\nsizeof = ctypes.sizeof\n\ndef sysv_hash(symbol):\n \"\"\"sysv_hash(str) -> int\n\n Function used to generate SYSV-style hashes for strings.\n \"\"\"\n h = 0\n g = 0\n for c in symbol:\n h = (h << 4) + ord(c)\n g = h & 0xf0000000\n h ^= (g >> 24)\n h &= ~g\n return h & 0xffffffff\n\ndef gnu_hash(s):\n \"\"\"gnu_hash(str) -> int\n\n Function used to generated GNU-style hashes for strings.\n \"\"\"\n h = 5381\n for c in s:\n h = h * 33 + ord(c)\n return h & 0xffffffff\n\nclass DynELF(object):\n '''\n DynELF knows how to resolve symbols in remote processes via an infoleak or\n memleak vulnerability encapsulated by :class:`pwnlib.memleak.MemLeak`.\n\n Implementation Details:\n\n Resolving Functions:\n\n In all ELFs which export symbols for importing by other libraries,\n (e.g. ``libc.so``) there are a series of tables which give exported\n symbol names, exported symbol addresses, and the ``hash`` of those\n exported symbols. By applying a hash function to the name of the\n desired symbol (e.g., ``'printf'``), it can be located in the hash\n table. Its location in the hash table provides an index into the\n string name table (strtab_), and the symbol address (symtab_).\n\n Assuming we have the base address of ``libc.so``, the way to resolve\n the address of ``printf`` is to locate the ``symtab``, ``strtab``,\n and hash table. The string ``\"printf\"`` is hashed according to the\n style of the hash table (SYSV_ or GNU_), and the hash table is\n walked until a matching entry is located. We can verify an exact\n match by checking the string table, and then get the offset into\n ``libc.so`` from the ``symtab``.\n\n Resolving Library Addresses:\n\n If we have a pointer into a dynamically-linked executable, we can\n leverage an internal linker structure called the `link map`_. This\n is a linked list structure which contains information about each\n loaded library, including its full path and base address.\n\n A pointer to the ``link map`` can be found in two ways. Both are\n referenced from entries in the DYNAMIC_ array.\n\n - In non-RELRO binaries, a pointer is placed in the `.got.plt`_ area\n in the binary. This is marked by finding the DT_PLTGOT_ area in the\n binary.\n - In all binaries, a pointer can be found in the area described by\n the DT_DEBUG_ area. This exists even in stripped binaries.\n\n For maximum flexibility, both mechanisms are used exhaustively.\n\n .. _symtab: https://refspecs.linuxbase.org/elf/gabi4+/ch4.symtab.html\n .. _strtab: https://refspecs.linuxbase.org/elf/gabi4+/ch4.strtab.html\n .. _.got.plt: https://refspecs.linuxbase.org/LSB_3.1.1/LSB-Core-generic/LSB-Core-generic/specialsections.html\n .. _DYNAMIC: http://www.sco.com/developers/gabi/latest/ch5.dynamic.html#dynamic_section\n .. _SYSV: https://refspecs.linuxbase.org/elf/gabi4+/ch5.dynamic.html#hash\n .. _GNU: https://blogs.oracle.com/ali/entry/gnu_hash_elf_sections\n .. _DT_DEBUG: https://reverseengineering.stackexchange.com/questions/6525/elf-link-map-when-linked-as-relro\n .. _link map: https://sourceware.org/git/?p=glibc.git;a=blob;f=elf/link.h;h=eaca8028e45a859ac280301a6e955a14eed1b887;hb=HEAD#l84\n .. _DT_PLTGOT: http://refspecs.linuxfoundation.org/ELF/zSeries/lzsabi0_zSeries/x2251.html\n '''\n\n def __init__(self, leak, pointer=None, elf=None, libcdb=True):\n '''\n Instantiates an object which can resolve symbols in a running binary\n given a :class:`pwnlib.memleak.MemLeak` leaker and a pointer inside\n the binary.\n\n Arguments:\n leak(MemLeak): Instance of pwnlib.memleak.MemLeak for leaking memory\n pointer(int): A pointer into a loaded ELF file\n elf(str,ELF): Path to the ELF file on disk, or a loaded :class:`pwnlib.elf.ELF`.\n libcdb(bool): Attempt to use libcdb to speed up libc lookups\n '''\n self.libcdb = libcdb\n self._elfclass = None\n self._elftype = None\n self._link_map = None\n self._waitfor = None\n self._bases = {}\n self._dynamic = None\n\n if not (pointer or (elf and elf.address)):\n log.error(\"Must specify either a pointer into a module and/or an ELF file with a valid base address\")\n\n pointer = pointer or elf.address\n\n if not isinstance(leak, MemLeak):\n leak = MemLeak(leak)\n\n if not elf:\n log.warn_once(\"No ELF provided. Leaking is much faster if you have a copy of the ELF being leaked.\")\n\n self.elf = elf\n self.leak = leak\n self.libbase = self._find_base(pointer or elf.address)\n\n if elf:\n self._find_linkmap_assisted(elf)\n\n @classmethod\n def for_one_lib_only(cls, leak, ptr):\n return cls(leak, ptr)\n\n @classmethod\n def from_lib_ptr(cls, leak, ptr):\n return cls(leak, ptr)\n\n @staticmethod\n def find_base(leak, ptr):\n \"\"\"Given a :class:`pwnlib.memleak.MemLeak` object and a pointer into a\n library, find its base address.\n \"\"\"\n return DynELF(leak, ptr).libbase\n\n @property\n def elfclass(self):\n \"\"\"32 or 64\"\"\"\n if not self._elfclass:\n elfclass = self.leak.field(self.libbase, elf.Elf_eident.EI_CLASS)\n self._elfclass = {constants.ELFCLASS32: 32,\n constants.ELFCLASS64: 64}[elfclass]\n return self._elfclass\n\n @property\n def elftype(self):\n \"\"\"e_type from the elf header. In practice the value will almost always\n be 'EXEC' or 'DYN'. If the value is architecture-specific (between\n ET_LOPROC and ET_HIPROC) or invalid, KeyError is raised.\n \"\"\"\n if not self._elftype:\n Ehdr = {32: elf.Elf32_Ehdr, 64: elf.Elf64_Ehdr}[self.elfclass]\n elftype = self.leak.field(self.libbase, Ehdr.e_type)\n self._elftype = {constants.ET_NONE: 'NONE',\n constants.ET_REL: 'REL',\n constants.ET_EXEC: 'EXEC',\n constants.ET_DYN: 'DYN',\n constants.ET_CORE: 'CORE'}[elftype]\n return self._elftype\n\n @property\n def link_map(self):\n \"\"\"Pointer to the runtime link_map object\"\"\"\n if not self._link_map:\n self._link_map = self._find_linkmap()\n return self._link_map\n\n @property\n def dynamic(self):\n \"\"\"\n Returns:\n Pointer to the ``.DYNAMIC`` area.\n \"\"\"\n if not self._dynamic:\n self._dynamic = self._find_dynamic_phdr()\n return self._dynamic\n\n def _find_linkmap_assisted(self, path):\n \"\"\"Uses an ELF file to assist in finding the link_map.\n \"\"\"\n if isinstance(path, ELF):\n path = path.path\n\n # Load a fresh copy of the ELF\n with context.local(log_level='error'):\n elf = ELF(path)\n elf.address = self.libbase\n\n w = self.waitfor(\"Loading from %r\" % elf.path)\n\n # Save our real leaker\n real_leak = self.leak\n\n # Create a fake leaker which just leaks out of the 'loaded' ELF\n # However, we may load things which are outside of the ELF (e.g.\n # the linkmap or GOT) so we need to fall back on the real leak.\n @MemLeak\n def fake_leak(address):\n try:\n return elf.read(address, 4)\n except ValueError:\n return real_leak.b(address)\n\n # Save off our real leaker, use the fake leaker\n self.leak = fake_leak\n\n # Get useful pointers for resolving the linkmap faster\n w.status(\"Searching for DT_PLTGOT\")\n pltgot = self._find_dt(constants.DT_PLTGOT)\n\n w.status(\"Searching for DT_DEBUG\")\n debug = self._find_dt(constants.DT_DEBUG)\n\n # Restore the real leaker\n self.leak = real_leak\n\n # Find the linkmap using the helper pointers\n self._find_linkmap(pltgot, debug)\n self.success('Done')\n\n def _find_base(self, ptr):\n page_size = 0x1000\n page_mask = ~(page_size - 1)\n\n ptr &= page_mask\n w = None\n\n while True:\n if self.leak.compare(ptr, '\\x7fELF'):\n break\n\n # See if we can short circuit the search\n fast = self._find_base_optimized(ptr)\n if fast:\n ptr = fast\n continue\n\n ptr -= page_size\n\n if ptr < 0:\n raise ValueError(\"Address is negative, something is wrong!\")\n\n # Defer creating the spinner in the event that 'ptr'\n # is already the base address\n w = w or self.waitfor(\"Finding base address\")\n self.status('%#x' % ptr)\n\n # If we created a spinner, print the success message\n if w:\n self.success('%#x' % ptr)\n\n return ptr\n\n def _find_base_optimized(self, ptr):\n if not self.elf:\n return None\n\n # If we have an ELF< we can probably speed this up a little bit?\n # Note that we add +0x20 onto the offset in order to avoid needing\n # to leak any bytes which contain '\\r\\n\\t\\b '\n ptr += 0x20\n data = self.leak.n(ptr, 32)\n if not data:\n return None\n\n # Do not permit multiple matches\n matches = list(self.elf.search(data))\n if len(matches) != 1:\n return None\n\n candidate = matches[0]\n candidate -= self.elf.address\n\n # The match should have the same page-alignment as our leaked data.\n if candidate & 0xfff != 0x20:\n return None\n\n # Adjust based on the original pointer we got, and the ELF's address.\n ptr -= candidate\n return ptr\n\n def _find_dynamic_phdr(self):\n \"\"\"\n Returns the address of the first Program Header with the type\n PT_DYNAMIC.\n \"\"\"\n leak = self.leak\n base = self.libbase\n\n #First find PT_DYNAMIC\n Ehdr = {32: elf.Elf32_Ehdr, 64: elf.Elf64_Ehdr}[self.elfclass]\n Phdr = {32: elf.Elf32_Phdr, 64: elf.Elf64_Phdr}[self.elfclass]\n\n self.status(\"PT_DYNAMIC\")\n\n phead = base + leak.field(base, Ehdr.e_phoff)\n self.status(\"PT_DYNAMIC header = %#x\" % phead)\n\n phnum = leak.field(base, Ehdr.e_phnum)\n self.status(\"PT_DYNAMIC count = %#x\" % phnum)\n\n for i in range(phnum):\n if leak.field_compare(phead, Phdr.p_type, constants.PT_DYNAMIC):\n break\n phead += sizeof(Phdr)\n else:\n self.failure(\"Could not find Program Header of type PT_DYNAMIC\")\n return None\n\n dynamic = leak.field(phead, Phdr.p_vaddr)\n self.status(\"PT_DYNAMIC @ %#x\" % dynamic)\n\n dynamic = self._make_absolute_ptr(dynamic)\n\n return dynamic\n\n def _find_dt(self, tag):\n \"\"\"\n Find an entry in the DYNAMIC array.\n\n Arguments:\n tag(int): Single tag to find\n\n Returns:\n Pointer to the data described by the specified entry.\n \"\"\"\n leak = self.leak\n base = self.libbase\n dynamic = self.dynamic\n name = next(k for k,v in ENUM_D_TAG.items() if v == tag)\n\n Dyn = {32: elf.Elf32_Dyn, 64: elf.Elf64_Dyn} [self.elfclass]\n\n # Found the _DYNAMIC program header, now find PLTGOT entry in it\n # An entry with a DT_NULL tag marks the end of the DYNAMIC array.\n while not leak.field_compare(dynamic, Dyn.d_tag, constants.DT_NULL):\n if leak.field_compare(dynamic, Dyn.d_tag, tag):\n break\n dynamic += sizeof(Dyn)\n else:\n self.failure(\"Could not find tag %s\" % name)\n return None\n\n self.status(\"Found %s at %#x\" % (name, dynamic))\n ptr = leak.field(dynamic, Dyn.d_ptr)\n\n ptr = self._make_absolute_ptr(ptr)\n\n return ptr\n\n\n def _find_linkmap(self, pltgot=None, debug=None):\n \"\"\"\n The linkmap is a chained structure created by the loader at runtime\n which contains information on the names and load addresses of all\n libraries.\n\n For non-RELRO binaries, a pointer to this is stored in the .got.plt\n area.\n\n For RELRO binaries, a pointer is additionally stored in the DT_DEBUG\n area.\n \"\"\"\n w = self.waitfor(\"Finding linkmap\")\n\n Got = {32: elf.Elf_i386_GOT, 64: elf.Elf_x86_64_GOT}[self.elfclass]\n r_debug = {32: elf.Elf32_r_debug, 64: elf.Elf64_r_debug}[self.elfclass]\n\n linkmap = None\n\n if not pltgot:\n w.status(\"Finding linkmap: DT_PLTGOT\")\n pltgot = self._find_dt(constants.DT_PLTGOT)\n\n if pltgot:\n w.status(\"GOT.linkmap\")\n linkmap = self.leak.field(pltgot, Got.linkmap)\n w.status(\"GOT.linkmap %#x\" % linkmap)\n\n if not linkmap:\n debug = debug or self._find_dt(constants.DT_DEBUG)\n if debug:\n w.status(\"r_debug.linkmap\")\n linkmap = self.leak.field(debug, r_debug.r_map)\n w.status(\"r_debug.linkmap %#x\" % linkmap)\n\n if not linkmap:\n w.failure(\"Could not find DT_PLTGOT or DT_DEBUG\")\n return None\n\n linkmap = self._make_absolute_ptr(linkmap)\n\n w.success('%#x' % linkmap)\n return linkmap\n\n def waitfor(self, msg):\n if not self._waitfor:\n self._waitfor = log.waitfor(msg)\n else:\n self.status(msg)\n return self._waitfor\n\n def failure(self, msg):\n if not self._waitfor:\n log.failure(msg)\n else:\n self._waitfor.failure(msg)\n self._waitfor = None\n\n def success(self, msg):\n if not self._waitfor:\n log.success(msg)\n else:\n self._waitfor.success(msg)\n self._waitfor = None\n\n def status(self, msg):\n if not self._waitfor:\n log.info(msg)\n else:\n self._waitfor.status(msg)\n\n @property\n def libc(self):\n \"\"\"libc(self) -> ELF\n\n Leak the Build ID of the remote libc.so, download the file,\n and load an ``ELF`` object with the correct base address.\n\n Returns:\n An ELF object, or None.\n \"\"\"\n libc = 'libc.so'\n\n with self.waitfor('Downloading libc'):\n dynlib = self._dynamic_load_dynelf(libc)\n\n self.status(\"Trying lookup based on Build ID\")\n build_id = dynlib._lookup_build_id(libc)\n\n if not build_id:\n return None\n\n self.status(\"Trying lookup based on Build ID: %s\" % build_id)\n path = libcdb.search_by_build_id(build_id)\n\n if not path:\n return None\n\n libc = ELF(path)\n libc.address = dynlib.libbase\n return libc\n\n def lookup (self, symb = None, lib = None):\n \"\"\"lookup(symb = None, lib = None) -> int\n\n Find the address of ``symbol``, which is found in ``lib``.\n\n Arguments:\n symb(str): Named routine to look up\n If omitted, the base address of the library will be returned.\n lib(str): Substring to match for the library name.\n If omitted, the current library is searched.\n If set to ``'libc'``, ``'libc.so'`` is assumed.\n\n Returns:\n Address of the named symbol, or :const:`None`.\n \"\"\"\n result = None\n\n if lib == 'libc':\n lib = 'libc.so'\n\n #\n # Get a pretty name for the symbol to show the user\n #\n if symb and lib:\n pretty = '%r in %r' % (symb, lib)\n else:\n pretty = repr(symb or lib)\n\n if not pretty:\n self.failure(\"Must specify a library or symbol\")\n\n self.waitfor('Resolving %s' % pretty)\n\n #\n # If we are loading from a different library, create\n # a DynELF instance for it.\n #\n if lib is not None: dynlib = self._dynamic_load_dynelf(lib)\n else: dynlib = self\n\n if dynlib is None:\n log.failure(\"Could not find %r\" % lib)\n return None\n\n #\n # If we are resolving a symbol in the library, find it.\n #\n if symb and self.libcdb:\n # Try a quick lookup by build ID\n self.status(\"Trying lookup based on Build ID\")\n build_id = dynlib._lookup_build_id(lib=lib)\n if build_id:\n log.info(\"Trying lookup based on Build ID: %s\" % build_id)\n path = libcdb.search_by_build_id(build_id)\n if path:\n with context.local(log_level='error'):\n e = ELF(path)\n e.address = dynlib.libbase\n result = e.symbols[symb]\n if symb and not result:\n self.status(\"Trying remote lookup\")\n result = dynlib._lookup(symb)\n if not symb:\n result = dynlib.libbase\n\n #\n # Did we win?\n #\n if result: self.success(\"%#x\" % result)\n else: self.failure(\"Could not find %s\" % pretty)\n\n return result\n\n def bases(self):\n '''Resolve base addresses of all loaded libraries.\n\n Return a dictionary mapping library path to its base address.\n '''\n if not self._bases:\n leak = self.leak\n LinkMap = {32: elf.Elf32_Link_Map, 64: elf.Elf64_Link_Map}[self.elfclass]\n\n cur = self.link_map\n\n # make sure we rewind to the beginning!\n while leak.field(cur, LinkMap.l_prev):\n cur = leak.field(cur, LinkMap.l_prev)\n\n while cur:\n p_name = leak.field(cur, LinkMap.l_name)\n name = leak.s(p_name)\n addr = leak.field(cur, LinkMap.l_addr)\n cur = leak.field(cur, LinkMap.l_next)\n\n log.debug('Found %r @ %#x' % (name, addr))\n\n self._bases[name] = addr\n\n return self._bases\n\n def _dynamic_load_dynelf(self, libname):\n \"\"\"_dynamic_load_dynelf(libname) -> DynELF\n\n Looks up information about a loaded library via the link map.\n\n Arguments:\n libname(str): Name of the library to resolve, or a substring (e.g. 'libc.so')\n\n Returns:\n A DynELF instance for the loaded library, or None.\n \"\"\"\n cur = self.link_map\n leak = self.leak\n LinkMap = {32: elf.Elf32_Link_Map, 64: elf.Elf64_Link_Map}[self.elfclass]\n\n # make sure we rewind to the beginning!\n while leak.field(cur, LinkMap.l_prev):\n cur = leak.field(cur, LinkMap.l_prev)\n\n while cur:\n self.status(\"link_map entry %#x\" % cur)\n p_name = leak.field(cur, LinkMap.l_name)\n name = leak.s(p_name)\n\n if libname in name:\n break\n\n if name:\n self.status('Skipping %s' % name)\n\n cur = leak.field(cur, LinkMap.l_next)\n else:\n self.failure(\"Could not find library with name containing %r\" % libname)\n return None\n\n libbase = leak.field(cur, LinkMap.l_addr)\n\n self.status(\"Resolved library %r at %#x\" % (libname, libbase))\n\n lib = DynELF(leak, libbase)\n lib._dynamic = leak.field(cur, LinkMap.l_ld)\n lib._waitfor = self._waitfor\n return lib\n\n def _lookup(self, symb):\n \"\"\"Performs the actual symbol lookup within one ELF file.\"\"\"\n leak = self.leak\n Dyn = {32: elf.Elf32_Dyn, 64: elf.Elf64_Dyn}[self.elfclass]\n name = lambda tag: next(k for k,v in ENUM_D_TAG.items() if v == tag)\n\n self.status('.gnu.hash/.hash, .strtab and .symtab offsets')\n\n #\n # We need all three of the hash, string table, and symbol table.\n #\n hshtab = self._find_dt(constants.DT_GNU_HASH)\n strtab = self._find_dt(constants.DT_STRTAB)\n symtab = self._find_dt(constants.DT_SYMTAB)\n\n # Assume GNU hash will hit, since it is the default for GCC.\n if hshtab:\n hshtype = 'gnu'\n else:\n hshtab = self._find_dt(constants.DT_HASH)\n hshtype = 'sysv'\n\n if not all([strtab, symtab, hshtab]):\n self.failure(\"Could not find all tables\")\n\n strtab = self._make_absolute_ptr(strtab)\n symtab = self._make_absolute_ptr(symtab)\n hshtab = self._make_absolute_ptr(hshtab)\n\n #\n # Perform the hash lookup\n #\n routine = {'sysv': self._resolve_symbol_sysv,\n 'gnu': self._resolve_symbol_gnu}[hshtype]\n return routine(self.libbase, symb, hshtab, strtab, symtab)\n\n def _resolve_symbol_sysv(self, libbase, symb, hshtab, strtab, symtab):\n \"\"\"\n Internal Documentation:\n See the ELF manual for more information. Search for the phrase\n \"A hash table of Elf32_Word objects supports symbol table access\", or see:\n https://docs.oracle.com/cd/E19504-01/802-6319/6ia12qkfo/index.html#chapter6-48031\n\n struct Elf_Hash {\n uint32_t nbucket;\n uint32_t nchain;\n uint32_t bucket[nbucket];\n uint32_t chain[nchain];\n }\n\n You can force an ELF to use this type of symbol table by compiling\n with 'gcc -Wl,--hash-style=sysv'\n \"\"\"\n self.status('.hash parms')\n leak = self.leak\n Sym = {32: elf.Elf32_Sym, 64: elf.Elf64_Sym}[self.elfclass]\n\n nbucket = leak.field(hshtab, elf.Elf_HashTable.nbucket)\n bucketaddr = hshtab + sizeof(elf.Elf_HashTable)\n chain = bucketaddr + (nbucket * 4)\n\n self.status('hashmap')\n hsh = sysv_hash(symb) % nbucket\n\n # Get the index out of the bucket for the hash we computed\n idx = leak.d(bucketaddr, hsh)\n\n while idx != constants.STN_UNDEF:\n # Look up the symbol corresponding to the specified index\n sym = symtab + (idx * sizeof(Sym))\n symtype = leak.field(sym, Sym.st_info) & 0xf\n\n # We only care about functions\n if symtype == constants.STT_FUNC:\n\n # Leak the name of the function from the symbol table\n name = leak.s(strtab + leak.field(sym, Sym.st_name))\n\n # Make sure it matches the name of the symbol we were looking for.\n if name == symb:\n #Bingo\n addr = libbase + leak.field(sym, Sym.st_value)\n return addr\n\n self.status(\"%s (hash collision)\" % name)\n\n # The name did not match what we were looking for, or we assume\n # it did not since it was not a function.\n # Follow the chain for this particular hash.\n idx = leak.d(chain, idx)\n else:\n self.failure('Could not find a SYSV hash that matched %#x' % hsh)\n return None\n\n def _resolve_symbol_gnu(self, libbase, symb, hshtab, strtab, symtab):\n \"\"\"\n Internal Documentation:\n The GNU hash structure is a bit more complex than the normal hash\n structure.\n\n Again, Oracle has good documentation.\n https://blogs.oracle.com/ali/entry/gnu_hash_elf_sections\n\n You can force an ELF to use this type of symbol table by compiling\n with 'gcc -Wl,--hash-style=gnu'\n \"\"\"\n self.status('.gnu.hash parms')\n leak = self.leak\n Sym = {32: elf.Elf32_Sym, 64: elf.Elf64_Sym}[self.elfclass]\n\n # The number of hash buckets (hash % nbuckets)\n nbuckets = leak.field(hshtab, elf.GNU_HASH.nbuckets)\n\n # Index of the first accessible symbol in the hash table\n # Numbering doesn't start at zero, it starts at symndx\n symndx = leak.field(hshtab, elf.GNU_HASH.symndx)\n\n # Number of things in the bloom filter.\n # We don't care about the contents, but we have to skip over it.\n maskwords = leak.field(hshtab, elf.GNU_HASH.maskwords)\n\n # Skip over the bloom filter to get to the buckets\n elfword = self.elfclass / 8\n buckets = hshtab + sizeof(elf.GNU_HASH) + (elfword * maskwords)\n\n # The chains come after the buckets\n chains = buckets + (4 * nbuckets)\n\n self.status('hash chain index')\n\n # Hash the symbol, find its bucket\n hsh = gnu_hash(symb)\n bucket = hsh % nbuckets\n\n # Get the first index in the chain for that bucket\n ndx = leak.d(buckets, bucket)\n if ndx == 0:\n self.failure('Empty chain')\n return None\n\n # Find the start of the chain, taking into account that numbering\n # effectively starts at 'symndx' within the chains.\n chain = chains + 4 * (ndx - symndx)\n\n self.status('hash chain')\n\n # Iteratively get the I'th entry from the hash chain, until we find\n # one that matches.\n i = 0\n hsh &= ~1\n\n # The least significant bit is used as a stopper bit.\n # It is set to 1 when a symbol is the last symbol in a given hash chain.\n hsh2 = 0\n while not hsh2 & 1:\n hsh2 = leak.d(chain, i)\n if hsh == (hsh2 & ~1):\n # Check for collision on hash values\n sym = symtab + sizeof(Sym) * (ndx + i)\n name = leak.s(strtab + leak.field(sym, Sym.st_name))\n\n if name == symb:\n # No collision, get offset and calculate address\n offset = leak.field(sym, Sym.st_value)\n addr = offset + libbase\n return addr\n\n self.status(\"%s (hash collision)\" % name)\n\n # Collision or no match, continue to the next item\n i += 1\n else:\n self.failure('Could not find a GNU hash that matched %#x' % hsh)\n return None\n\n def _lookup_build_id(self, lib = None):\n\n libbase = self.libbase\n if not self.link_map:\n self.status(\"No linkmap found\")\n return None\n\n if lib is not None:\n libbase = self.lookup(symb = None, lib = lib)\n\n if not libbase:\n self.status(\"Couldn't find libc base\")\n return None\n\n for offset in libcdb.get_build_id_offsets():\n address = libbase + offset\n if self.leak.compare(address + 0xC, \"GNU\\x00\"):\n return enhex(''.join(self.leak.raw(address + 0x10, 20)))\n else:\n self.status(\"Magic did not match\")\n pass\n\n def _make_absolute_ptr(self, ptr_or_offset):\n \"\"\"For shared libraries (or PIE executables), many ELF fields may\n contain offsets rather than actual pointers. If the ELF type is 'DYN',\n the argument may be an offset. It will not necessarily be an offset,\n because the run-time linker may have fixed it up to be a real pointer\n already. In this case an educated guess is made, and the ELF base\n address is added to the value if it is determined to be an offset.\n \"\"\"\n if_ptr = ptr_or_offset\n if_offset = ptr_or_offset + self.libbase\n\n # if the ELF type is not DYN, the value is a pointer\n\n if self.elftype != 'DYN':\n return if_ptr\n\n # if the ELF type may be DYN, guess\n\n if 0 < ptr_or_offset < self.libbase:\n return if_offset\n else:\n return if_ptr\n\n def stack(self):\n \"\"\"Finds a pointer to the stack via __environ, which is an exported\n symbol in libc, which points to the environment block.\n \"\"\"\n symbols = ['environ', '_environ', '__environ']\n\n for symbol in symbols:\n environ = self.lookup(symbol, 'libc')\n\n if environ:\n break\n else:\n log.error(\"Could not find the stack\")\n\n stack = self.leak.p(environ)\n\n self.success('*environ: %#x' % stack)\n\n return stack\n\n def heap(self):\n \"\"\"Finds the beginning of the heap via __curbrk, which is an exported\n symbol in the linker, which points to the current brk.\n \"\"\"\n curbrk = self.lookup('__curbrk', 'libc')\n brk = self.leak.p(curbrk)\n\n self.success('*curbrk: %#x' % brk)\n\n return brk\n","path":"pwnlib/dynelf.py"}],"string":"[\n {\n \"content\": \"\\\"\\\"\\\"\\nResolve symbols in loaded, dynamically-linked ELF binaries.\\nGiven a function which can leak data at an arbitrary address,\\nany symbol in any loaded library can be resolved.\\n\\nExample\\n^^^^^^^^\\n\\n::\\n\\n # Assume a process or remote connection\\n p = process('./pwnme')\\n\\n # Declare a function that takes a single address, and\\n # leaks at least one byte at that address.\\n def leak(address):\\n data = p.read(address, 4)\\n log.debug(\\\"%#x => %s\\\" % (address, (data or '').encode('hex')))\\n return data\\n\\n # For the sake of this example, let's say that we\\n # have any of these pointers. One is a pointer into\\n # the target binary, the other two are pointers into libc\\n main = 0xfeedf4ce\\n libc = 0xdeadb000\\n system = 0xdeadbeef\\n\\n # With our leaker, and a pointer into our target binary,\\n # we can resolve the address of anything.\\n #\\n # We do not actually need to have a copy of the target\\n # binary for this to work.\\n d = DynELF(leak, main)\\n assert d.lookup(None, 'libc') == libc\\n assert d.lookup('system', 'libc') == system\\n\\n # However, if we *do* have a copy of the target binary,\\n # we can speed up some of the steps.\\n d = DynELF(leak, main, elf=ELF('./pwnme'))\\n assert d.lookup(None, 'libc') == libc\\n assert d.lookup('system', 'libc') == system\\n\\n # Alternately, we can resolve symbols inside another library,\\n # given a pointer into it.\\n d = DynELF(leak, libc + 0x1234)\\n assert d.lookup('system') == system\\n\\nDynELF\\n\\\"\\\"\\\"\\nfrom __future__ import absolute_import\\n\\nimport ctypes\\n\\nfrom elftools.elf.enums import ENUM_D_TAG\\n\\nfrom pwnlib import elf\\nfrom pwnlib import libcdb\\nfrom pwnlib.context import context\\nfrom pwnlib.elf import ELF\\nfrom pwnlib.elf import constants\\nfrom pwnlib.log import getLogger\\nfrom pwnlib.memleak import MemLeak\\nfrom pwnlib.util.fiddling import enhex\\nfrom pwnlib.util.packing import unpack\\nfrom pwnlib.util.web import wget\\n\\nlog = getLogger(__name__)\\nsizeof = ctypes.sizeof\\n\\ndef sysv_hash(symbol):\\n \\\"\\\"\\\"sysv_hash(str) -> int\\n\\n Function used to generate SYSV-style hashes for strings.\\n \\\"\\\"\\\"\\n h = 0\\n g = 0\\n for c in symbol:\\n h = (h << 4) + ord(c)\\n g = h & 0xf0000000\\n h ^= (g >> 24)\\n h &= ~g\\n return h & 0xffffffff\\n\\ndef gnu_hash(s):\\n \\\"\\\"\\\"gnu_hash(str) -> int\\n\\n Function used to generated GNU-style hashes for strings.\\n \\\"\\\"\\\"\\n h = 5381\\n for c in s:\\n h = h * 33 + ord(c)\\n return h & 0xffffffff\\n\\nclass DynELF(object):\\n '''\\n DynELF knows how to resolve symbols in remote processes via an infoleak or\\n memleak vulnerability encapsulated by :class:`pwnlib.memleak.MemLeak`.\\n\\n Implementation Details:\\n\\n Resolving Functions:\\n\\n In all ELFs which export symbols for importing by other libraries,\\n (e.g. ``libc.so``) there are a series of tables which give exported\\n symbol names, exported symbol addresses, and the ``hash`` of those\\n exported symbols. By applying a hash function to the name of the\\n desired symbol (e.g., ``'printf'``), it can be located in the hash\\n table. Its location in the hash table provides an index into the\\n string name table (strtab_), and the symbol address (symtab_).\\n\\n Assuming we have the base address of ``libc.so``, the way to resolve\\n the address of ``printf`` is to locate the ``symtab``, ``strtab``,\\n and hash table. The string ``\\\"printf\\\"`` is hashed according to the\\n style of the hash table (SYSV_ or GNU_), and the hash table is\\n walked until a matching entry is located. We can verify an exact\\n match by checking the string table, and then get the offset into\\n ``libc.so`` from the ``symtab``.\\n\\n Resolving Library Addresses:\\n\\n If we have a pointer into a dynamically-linked executable, we can\\n leverage an internal linker structure called the `link map`_. This\\n is a linked list structure which contains information about each\\n loaded library, including its full path and base address.\\n\\n A pointer to the ``link map`` can be found in two ways. Both are\\n referenced from entries in the DYNAMIC_ array.\\n\\n - In non-RELRO binaries, a pointer is placed in the `.got.plt`_ area\\n in the binary. This is marked by finding the DT_PLTGOT_ area in the\\n binary.\\n - In all binaries, a pointer can be found in the area described by\\n the DT_DEBUG_ area. This exists even in stripped binaries.\\n\\n For maximum flexibility, both mechanisms are used exhaustively.\\n\\n .. _symtab: https://refspecs.linuxbase.org/elf/gabi4+/ch4.symtab.html\\n .. _strtab: https://refspecs.linuxbase.org/elf/gabi4+/ch4.strtab.html\\n .. _.got.plt: https://refspecs.linuxbase.org/LSB_3.1.1/LSB-Core-generic/LSB-Core-generic/specialsections.html\\n .. _DYNAMIC: http://www.sco.com/developers/gabi/latest/ch5.dynamic.html#dynamic_section\\n .. _SYSV: https://refspecs.linuxbase.org/elf/gabi4+/ch5.dynamic.html#hash\\n .. _GNU: https://blogs.oracle.com/ali/entry/gnu_hash_elf_sections\\n .. _DT_DEBUG: https://reverseengineering.stackexchange.com/questions/6525/elf-link-map-when-linked-as-relro\\n .. _link map: https://sourceware.org/git/?p=glibc.git;a=blob;f=elf/link.h;h=eaca8028e45a859ac280301a6e955a14eed1b887;hb=HEAD#l84\\n .. _DT_PLTGOT: http://refspecs.linuxfoundation.org/ELF/zSeries/lzsabi0_zSeries/x2251.html\\n '''\\n\\n def __init__(self, leak, pointer=None, elf=None, libcdb=True):\\n '''\\n Instantiates an object which can resolve symbols in a running binary\\n given a :class:`pwnlib.memleak.MemLeak` leaker and a pointer inside\\n the binary.\\n\\n Arguments:\\n leak(MemLeak): Instance of pwnlib.memleak.MemLeak for leaking memory\\n pointer(int): A pointer into a loaded ELF file\\n elf(str,ELF): Path to the ELF file on disk, or a loaded :class:`pwnlib.elf.ELF`.\\n libcdb(bool): Attempt to use libcdb to speed up libc lookups\\n '''\\n self.libcdb = libcdb\\n self._elfclass = None\\n self._elftype = None\\n self._link_map = None\\n self._waitfor = None\\n self._bases = {}\\n self._dynamic = None\\n\\n if not (pointer or (elf and elf.address)):\\n log.error(\\\"Must specify either a pointer into a module and/or an ELF file with a valid base address\\\")\\n\\n pointer = pointer or elf.address\\n\\n if not isinstance(leak, MemLeak):\\n leak = MemLeak(leak)\\n\\n if not elf:\\n log.warn_once(\\\"No ELF provided. Leaking is much faster if you have a copy of the ELF being leaked.\\\")\\n\\n self.elf = elf\\n self.leak = leak\\n self.libbase = self._find_base(pointer or elf.address)\\n\\n if elf:\\n self._find_linkmap_assisted(elf)\\n\\n @classmethod\\n def for_one_lib_only(cls, leak, ptr):\\n return cls(leak, ptr)\\n\\n @classmethod\\n def from_lib_ptr(cls, leak, ptr):\\n return cls(leak, ptr)\\n\\n @staticmethod\\n def find_base(leak, ptr):\\n \\\"\\\"\\\"Given a :class:`pwnlib.memleak.MemLeak` object and a pointer into a\\n library, find its base address.\\n \\\"\\\"\\\"\\n return DynELF(leak, ptr).libbase\\n\\n @property\\n def elfclass(self):\\n \\\"\\\"\\\"32 or 64\\\"\\\"\\\"\\n if not self._elfclass:\\n elfclass = self.leak.field(self.libbase, elf.Elf_eident.EI_CLASS)\\n self._elfclass = {constants.ELFCLASS32: 32,\\n constants.ELFCLASS64: 64}[elfclass]\\n return self._elfclass\\n\\n @property\\n def elftype(self):\\n \\\"\\\"\\\"e_type from the elf header. In practice the value will almost always\\n be 'EXEC' or 'DYN'. If the value is architecture-specific (between\\n ET_LOPROC and ET_HIPROC) or invalid, KeyError is raised.\\n \\\"\\\"\\\"\\n if not self._elftype:\\n Ehdr = {32: elf.Elf32_Ehdr, 64: elf.Elf64_Ehdr}[self.elfclass]\\n elftype = self.leak.field(self.libbase, Ehdr.e_type)\\n self._elftype = {constants.ET_NONE: 'NONE',\\n constants.ET_REL: 'REL',\\n constants.ET_EXEC: 'EXEC',\\n constants.ET_DYN: 'DYN',\\n constants.ET_CORE: 'CORE'}[elftype]\\n return self._elftype\\n\\n @property\\n def link_map(self):\\n \\\"\\\"\\\"Pointer to the runtime link_map object\\\"\\\"\\\"\\n if not self._link_map:\\n self._link_map = self._find_linkmap()\\n return self._link_map\\n\\n @property\\n def dynamic(self):\\n \\\"\\\"\\\"\\n Returns:\\n Pointer to the ``.DYNAMIC`` area.\\n \\\"\\\"\\\"\\n if not self._dynamic:\\n self._dynamic = self._find_dynamic_phdr()\\n return self._dynamic\\n\\n def _find_linkmap_assisted(self, path):\\n \\\"\\\"\\\"Uses an ELF file to assist in finding the link_map.\\n \\\"\\\"\\\"\\n if isinstance(path, ELF):\\n path = path.path\\n\\n # Load a fresh copy of the ELF\\n with context.local(log_level='error'):\\n elf = ELF(path)\\n elf.address = self.libbase\\n\\n w = self.waitfor(\\\"Loading from %r\\\" % elf.path)\\n\\n # Save our real leaker\\n real_leak = self.leak\\n\\n # Create a fake leaker which just leaks out of the 'loaded' ELF\\n # However, we may load things which are outside of the ELF (e.g.\\n # the linkmap or GOT) so we need to fall back on the real leak.\\n @MemLeak\\n def fake_leak(address):\\n try:\\n return elf.read(address, 4)\\n except ValueError:\\n return real_leak.b(address)\\n\\n # Save off our real leaker, use the fake leaker\\n self.leak = fake_leak\\n\\n # Get useful pointers for resolving the linkmap faster\\n w.status(\\\"Searching for DT_PLTGOT\\\")\\n pltgot = self._find_dt(constants.DT_PLTGOT)\\n\\n w.status(\\\"Searching for DT_DEBUG\\\")\\n debug = self._find_dt(constants.DT_DEBUG)\\n\\n # Restore the real leaker\\n self.leak = real_leak\\n\\n # Find the linkmap using the helper pointers\\n self._find_linkmap(pltgot, debug)\\n self.success('Done')\\n\\n def _find_base(self, ptr):\\n page_size = 0x1000\\n page_mask = ~(page_size - 1)\\n\\n ptr &= page_mask\\n w = None\\n\\n while True:\\n if self.leak.compare(ptr, '\\\\x7fELF'):\\n break\\n\\n # See if we can short circuit the search\\n fast = self._find_base_optimized(ptr)\\n if fast:\\n ptr = fast\\n continue\\n\\n ptr -= page_size\\n\\n if ptr < 0:\\n raise ValueError(\\\"Address is negative, something is wrong!\\\")\\n\\n # Defer creating the spinner in the event that 'ptr'\\n # is already the base address\\n w = w or self.waitfor(\\\"Finding base address\\\")\\n self.status('%#x' % ptr)\\n\\n # If we created a spinner, print the success message\\n if w:\\n self.success('%#x' % ptr)\\n\\n return ptr\\n\\n def _find_base_optimized(self, ptr):\\n if not self.elf:\\n return None\\n\\n # If we have an ELF< we can probably speed this up a little bit?\\n # Note that we add +0x20 onto the offset in order to avoid needing\\n # to leak any bytes which contain '\\\\r\\\\n\\\\t\\\\b '\\n ptr += 0x20\\n data = self.leak.n(ptr, 32)\\n if not data:\\n return None\\n\\n # Do not permit multiple matches\\n matches = list(self.elf.search(data))\\n if len(matches) != 1:\\n return None\\n\\n candidate = matches[0]\\n candidate -= self.elf.address\\n\\n # The match should have the same page-alignment as our leaked data.\\n if candidate & 0xfff != 0x20:\\n return None\\n\\n # Adjust based on the original pointer we got, and the ELF's address.\\n ptr -= candidate\\n return ptr\\n\\n def _find_dynamic_phdr(self):\\n \\\"\\\"\\\"\\n Returns the address of the first Program Header with the type\\n PT_DYNAMIC.\\n \\\"\\\"\\\"\\n leak = self.leak\\n base = self.libbase\\n\\n #First find PT_DYNAMIC\\n Ehdr = {32: elf.Elf32_Ehdr, 64: elf.Elf64_Ehdr}[self.elfclass]\\n Phdr = {32: elf.Elf32_Phdr, 64: elf.Elf64_Phdr}[self.elfclass]\\n\\n self.status(\\\"PT_DYNAMIC\\\")\\n\\n phead = base + leak.field(base, Ehdr.e_phoff)\\n self.status(\\\"PT_DYNAMIC header = %#x\\\" % phead)\\n\\n phnum = leak.field(base, Ehdr.e_phnum)\\n self.status(\\\"PT_DYNAMIC count = %#x\\\" % phnum)\\n\\n for i in range(phnum):\\n if leak.field_compare(phead, Phdr.p_type, constants.PT_DYNAMIC):\\n break\\n phead += sizeof(Phdr)\\n else:\\n self.failure(\\\"Could not find Program Header of type PT_DYNAMIC\\\")\\n return None\\n\\n dynamic = leak.field(phead, Phdr.p_vaddr)\\n self.status(\\\"PT_DYNAMIC @ %#x\\\" % dynamic)\\n\\n dynamic = self._make_absolute_ptr(dynamic)\\n\\n return dynamic\\n\\n def _find_dt(self, tag):\\n \\\"\\\"\\\"\\n Find an entry in the DYNAMIC array.\\n\\n Arguments:\\n tag(int): Single tag to find\\n\\n Returns:\\n Pointer to the data described by the specified entry.\\n \\\"\\\"\\\"\\n leak = self.leak\\n base = self.libbase\\n dynamic = self.dynamic\\n name = next(k for k,v in ENUM_D_TAG.items() if v == tag)\\n\\n Dyn = {32: elf.Elf32_Dyn, 64: elf.Elf64_Dyn} [self.elfclass]\\n\\n # Found the _DYNAMIC program header, now find PLTGOT entry in it\\n # An entry with a DT_NULL tag marks the end of the DYNAMIC array.\\n while not leak.field_compare(dynamic, Dyn.d_tag, constants.DT_NULL):\\n if leak.field_compare(dynamic, Dyn.d_tag, tag):\\n break\\n dynamic += sizeof(Dyn)\\n else:\\n self.failure(\\\"Could not find tag %s\\\" % name)\\n return None\\n\\n self.status(\\\"Found %s at %#x\\\" % (name, dynamic))\\n ptr = leak.field(dynamic, Dyn.d_ptr)\\n\\n ptr = self._make_absolute_ptr(ptr)\\n\\n return ptr\\n\\n\\n def _find_linkmap(self, pltgot=None, debug=None):\\n \\\"\\\"\\\"\\n The linkmap is a chained structure created by the loader at runtime\\n which contains information on the names and load addresses of all\\n libraries.\\n\\n For non-RELRO binaries, a pointer to this is stored in the .got.plt\\n area.\\n\\n For RELRO binaries, a pointer is additionally stored in the DT_DEBUG\\n area.\\n \\\"\\\"\\\"\\n w = self.waitfor(\\\"Finding linkmap\\\")\\n\\n Got = {32: elf.Elf_i386_GOT, 64: elf.Elf_x86_64_GOT}[self.elfclass]\\n r_debug = {32: elf.Elf32_r_debug, 64: elf.Elf64_r_debug}[self.elfclass]\\n\\n linkmap = None\\n\\n if not pltgot:\\n w.status(\\\"Finding linkmap: DT_PLTGOT\\\")\\n pltgot = self._find_dt(constants.DT_PLTGOT)\\n\\n if pltgot:\\n w.status(\\\"GOT.linkmap\\\")\\n linkmap = self.leak.field(pltgot, Got.linkmap)\\n w.status(\\\"GOT.linkmap %#x\\\" % linkmap)\\n\\n if not linkmap:\\n debug = debug or self._find_dt(constants.DT_DEBUG)\\n if debug:\\n w.status(\\\"r_debug.linkmap\\\")\\n linkmap = self.leak.field(debug, r_debug.r_map)\\n w.status(\\\"r_debug.linkmap %#x\\\" % linkmap)\\n\\n if not linkmap:\\n w.failure(\\\"Could not find DT_PLTGOT or DT_DEBUG\\\")\\n return None\\n\\n linkmap = self._make_absolute_ptr(linkmap)\\n\\n w.success('%#x' % linkmap)\\n return linkmap\\n\\n def waitfor(self, msg):\\n if not self._waitfor:\\n self._waitfor = log.waitfor(msg)\\n else:\\n self.status(msg)\\n return self._waitfor\\n\\n def failure(self, msg):\\n if not self._waitfor:\\n log.failure(msg)\\n else:\\n self._waitfor.failure(msg)\\n self._waitfor = None\\n\\n def success(self, msg):\\n if not self._waitfor:\\n log.success(msg)\\n else:\\n self._waitfor.success(msg)\\n self._waitfor = None\\n\\n def status(self, msg):\\n if not self._waitfor:\\n log.info(msg)\\n else:\\n self._waitfor.status(msg)\\n\\n @property\\n def libc(self):\\n \\\"\\\"\\\"libc(self) -> ELF\\n\\n Leak the Build ID of the remote libc.so, download the file,\\n and load an ``ELF`` object with the correct base address.\\n\\n Returns:\\n An ELF object, or None.\\n \\\"\\\"\\\"\\n libc = 'libc.so'\\n\\n with self.waitfor('Downloading libc'):\\n dynlib = self._dynamic_load_dynelf(libc)\\n\\n self.status(\\\"Trying lookup based on Build ID\\\")\\n build_id = dynlib._lookup_build_id(libc)\\n\\n if not build_id:\\n return None\\n\\n self.status(\\\"Trying lookup based on Build ID: %s\\\" % build_id)\\n path = libcdb.search_by_build_id(build_id)\\n\\n if not path:\\n return None\\n\\n libc = ELF(path)\\n libc.address = dynlib.libbase\\n return libc\\n\\n def lookup (self, symb = None, lib = None):\\n \\\"\\\"\\\"lookup(symb = None, lib = None) -> int\\n\\n Find the address of ``symbol``, which is found in ``lib``.\\n\\n Arguments:\\n symb(str): Named routine to look up\\n If omitted, the base address of the library will be returned.\\n lib(str): Substring to match for the library name.\\n If omitted, the current library is searched.\\n If set to ``'libc'``, ``'libc.so'`` is assumed.\\n\\n Returns:\\n Address of the named symbol, or :const:`None`.\\n \\\"\\\"\\\"\\n result = None\\n\\n if lib == 'libc':\\n lib = 'libc.so'\\n\\n #\\n # Get a pretty name for the symbol to show the user\\n #\\n if symb and lib:\\n pretty = '%r in %r' % (symb, lib)\\n else:\\n pretty = repr(symb or lib)\\n\\n if not pretty:\\n self.failure(\\\"Must specify a library or symbol\\\")\\n\\n self.waitfor('Resolving %s' % pretty)\\n\\n #\\n # If we are loading from a different library, create\\n # a DynELF instance for it.\\n #\\n if lib is not None: dynlib = self._dynamic_load_dynelf(lib)\\n else: dynlib = self\\n\\n if dynlib is None:\\n log.failure(\\\"Could not find %r\\\" % lib)\\n return None\\n\\n #\\n # If we are resolving a symbol in the library, find it.\\n #\\n if symb and self.libcdb:\\n # Try a quick lookup by build ID\\n self.status(\\\"Trying lookup based on Build ID\\\")\\n build_id = dynlib._lookup_build_id(lib=lib)\\n if build_id:\\n log.info(\\\"Trying lookup based on Build ID: %s\\\" % build_id)\\n path = libcdb.search_by_build_id(build_id)\\n if path:\\n with context.local(log_level='error'):\\n e = ELF(path)\\n e.address = dynlib.libbase\\n result = e.symbols[symb]\\n if symb and not result:\\n self.status(\\\"Trying remote lookup\\\")\\n result = dynlib._lookup(symb)\\n if not symb:\\n result = dynlib.libbase\\n\\n #\\n # Did we win?\\n #\\n if result: self.success(\\\"%#x\\\" % result)\\n else: self.failure(\\\"Could not find %s\\\" % pretty)\\n\\n return result\\n\\n def bases(self):\\n '''Resolve base addresses of all loaded libraries.\\n\\n Return a dictionary mapping library path to its base address.\\n '''\\n if not self._bases:\\n leak = self.leak\\n LinkMap = {32: elf.Elf32_Link_Map, 64: elf.Elf64_Link_Map}[self.elfclass]\\n\\n cur = self.link_map\\n\\n # make sure we rewind to the beginning!\\n while leak.field(cur, LinkMap.l_prev):\\n cur = leak.field(cur, LinkMap.l_prev)\\n\\n while cur:\\n p_name = leak.field(cur, LinkMap.l_name)\\n name = leak.s(p_name)\\n addr = leak.field(cur, LinkMap.l_addr)\\n cur = leak.field(cur, LinkMap.l_next)\\n\\n log.debug('Found %r @ %#x' % (name, addr))\\n\\n self._bases[name] = addr\\n\\n return self._bases\\n\\n def _dynamic_load_dynelf(self, libname):\\n \\\"\\\"\\\"_dynamic_load_dynelf(libname) -> DynELF\\n\\n Looks up information about a loaded library via the link map.\\n\\n Arguments:\\n libname(str): Name of the library to resolve, or a substring (e.g. 'libc.so')\\n\\n Returns:\\n A DynELF instance for the loaded library, or None.\\n \\\"\\\"\\\"\\n cur = self.link_map\\n leak = self.leak\\n LinkMap = {32: elf.Elf32_Link_Map, 64: elf.Elf64_Link_Map}[self.elfclass]\\n\\n # make sure we rewind to the beginning!\\n while leak.field(cur, LinkMap.l_prev):\\n cur = leak.field(cur, LinkMap.l_prev)\\n\\n while cur:\\n self.status(\\\"link_map entry %#x\\\" % cur)\\n p_name = leak.field(cur, LinkMap.l_name)\\n name = leak.s(p_name)\\n\\n if libname in name:\\n break\\n\\n if name:\\n self.status('Skipping %s' % name)\\n\\n cur = leak.field(cur, LinkMap.l_next)\\n else:\\n self.failure(\\\"Could not find library with name containing %r\\\" % libname)\\n return None\\n\\n libbase = leak.field(cur, LinkMap.l_addr)\\n\\n self.status(\\\"Resolved library %r at %#x\\\" % (libname, libbase))\\n\\n lib = DynELF(leak, libbase)\\n lib._dynamic = leak.field(cur, LinkMap.l_ld)\\n lib._waitfor = self._waitfor\\n return lib\\n\\n def _lookup(self, symb):\\n \\\"\\\"\\\"Performs the actual symbol lookup within one ELF file.\\\"\\\"\\\"\\n leak = self.leak\\n Dyn = {32: elf.Elf32_Dyn, 64: elf.Elf64_Dyn}[self.elfclass]\\n name = lambda tag: next(k for k,v in ENUM_D_TAG.items() if v == tag)\\n\\n self.status('.gnu.hash/.hash, .strtab and .symtab offsets')\\n\\n #\\n # We need all three of the hash, string table, and symbol table.\\n #\\n hshtab = self._find_dt(constants.DT_GNU_HASH)\\n strtab = self._find_dt(constants.DT_STRTAB)\\n symtab = self._find_dt(constants.DT_SYMTAB)\\n\\n # Assume GNU hash will hit, since it is the default for GCC.\\n if hshtab:\\n hshtype = 'gnu'\\n else:\\n hshtab = self._find_dt(constants.DT_HASH)\\n hshtype = 'sysv'\\n\\n if not all([strtab, symtab, hshtab]):\\n self.failure(\\\"Could not find all tables\\\")\\n\\n strtab = self._make_absolute_ptr(strtab)\\n symtab = self._make_absolute_ptr(symtab)\\n hshtab = self._make_absolute_ptr(hshtab)\\n\\n #\\n # Perform the hash lookup\\n #\\n routine = {'sysv': self._resolve_symbol_sysv,\\n 'gnu': self._resolve_symbol_gnu}[hshtype]\\n return routine(self.libbase, symb, hshtab, strtab, symtab)\\n\\n def _resolve_symbol_sysv(self, libbase, symb, hshtab, strtab, symtab):\\n \\\"\\\"\\\"\\n Internal Documentation:\\n See the ELF manual for more information. Search for the phrase\\n \\\"A hash table of Elf32_Word objects supports symbol table access\\\", or see:\\n https://docs.oracle.com/cd/E19504-01/802-6319/6ia12qkfo/index.html#chapter6-48031\\n\\n struct Elf_Hash {\\n uint32_t nbucket;\\n uint32_t nchain;\\n uint32_t bucket[nbucket];\\n uint32_t chain[nchain];\\n }\\n\\n You can force an ELF to use this type of symbol table by compiling\\n with 'gcc -Wl,--hash-style=sysv'\\n \\\"\\\"\\\"\\n self.status('.hash parms')\\n leak = self.leak\\n Sym = {32: elf.Elf32_Sym, 64: elf.Elf64_Sym}[self.elfclass]\\n\\n nbucket = leak.field(hshtab, elf.Elf_HashTable.nbucket)\\n bucketaddr = hshtab + sizeof(elf.Elf_HashTable)\\n chain = bucketaddr + (nbucket * 4)\\n\\n self.status('hashmap')\\n hsh = sysv_hash(symb) % nbucket\\n\\n # Get the index out of the bucket for the hash we computed\\n idx = leak.d(bucketaddr, hsh)\\n\\n while idx != constants.STN_UNDEF:\\n # Look up the symbol corresponding to the specified index\\n sym = symtab + (idx * sizeof(Sym))\\n symtype = leak.field(sym, Sym.st_info) & 0xf\\n\\n # We only care about functions\\n if symtype == constants.STT_FUNC:\\n\\n # Leak the name of the function from the symbol table\\n name = leak.s(strtab + leak.field(sym, Sym.st_name))\\n\\n # Make sure it matches the name of the symbol we were looking for.\\n if name == symb:\\n #Bingo\\n addr = libbase + leak.field(sym, Sym.st_value)\\n return addr\\n\\n self.status(\\\"%s (hash collision)\\\" % name)\\n\\n # The name did not match what we were looking for, or we assume\\n # it did not since it was not a function.\\n # Follow the chain for this particular hash.\\n idx = leak.d(chain, idx)\\n else:\\n self.failure('Could not find a SYSV hash that matched %#x' % hsh)\\n return None\\n\\n def _resolve_symbol_gnu(self, libbase, symb, hshtab, strtab, symtab):\\n \\\"\\\"\\\"\\n Internal Documentation:\\n The GNU hash structure is a bit more complex than the normal hash\\n structure.\\n\\n Again, Oracle has good documentation.\\n https://blogs.oracle.com/ali/entry/gnu_hash_elf_sections\\n\\n You can force an ELF to use this type of symbol table by compiling\\n with 'gcc -Wl,--hash-style=gnu'\\n \\\"\\\"\\\"\\n self.status('.gnu.hash parms')\\n leak = self.leak\\n Sym = {32: elf.Elf32_Sym, 64: elf.Elf64_Sym}[self.elfclass]\\n\\n # The number of hash buckets (hash % nbuckets)\\n nbuckets = leak.field(hshtab, elf.GNU_HASH.nbuckets)\\n\\n # Index of the first accessible symbol in the hash table\\n # Numbering doesn't start at zero, it starts at symndx\\n symndx = leak.field(hshtab, elf.GNU_HASH.symndx)\\n\\n # Number of things in the bloom filter.\\n # We don't care about the contents, but we have to skip over it.\\n maskwords = leak.field(hshtab, elf.GNU_HASH.maskwords)\\n\\n # Skip over the bloom filter to get to the buckets\\n elfword = self.elfclass / 8\\n buckets = hshtab + sizeof(elf.GNU_HASH) + (elfword * maskwords)\\n\\n # The chains come after the buckets\\n chains = buckets + (4 * nbuckets)\\n\\n self.status('hash chain index')\\n\\n # Hash the symbol, find its bucket\\n hsh = gnu_hash(symb)\\n bucket = hsh % nbuckets\\n\\n # Get the first index in the chain for that bucket\\n ndx = leak.d(buckets, bucket)\\n if ndx == 0:\\n self.failure('Empty chain')\\n return None\\n\\n # Find the start of the chain, taking into account that numbering\\n # effectively starts at 'symndx' within the chains.\\n chain = chains + 4 * (ndx - symndx)\\n\\n self.status('hash chain')\\n\\n # Iteratively get the I'th entry from the hash chain, until we find\\n # one that matches.\\n i = 0\\n hsh &= ~1\\n\\n # The least significant bit is used as a stopper bit.\\n # It is set to 1 when a symbol is the last symbol in a given hash chain.\\n hsh2 = 0\\n while not hsh2 & 1:\\n hsh2 = leak.d(chain, i)\\n if hsh == (hsh2 & ~1):\\n # Check for collision on hash values\\n sym = symtab + sizeof(Sym) * (ndx + i)\\n name = leak.s(strtab + leak.field(sym, Sym.st_name))\\n\\n if name == symb:\\n # No collision, get offset and calculate address\\n offset = leak.field(sym, Sym.st_value)\\n addr = offset + libbase\\n return addr\\n\\n self.status(\\\"%s (hash collision)\\\" % name)\\n\\n # Collision or no match, continue to the next item\\n i += 1\\n else:\\n self.failure('Could not find a GNU hash that matched %#x' % hsh)\\n return None\\n\\n def _lookup_build_id(self, lib = None):\\n\\n libbase = self.libbase\\n if not self.link_map:\\n self.status(\\\"No linkmap found\\\")\\n return None\\n\\n if lib is not None:\\n libbase = self.lookup(symb = None, lib = lib)\\n\\n if not libbase:\\n self.status(\\\"Couldn't find libc base\\\")\\n return None\\n\\n for offset in libcdb.get_build_id_offsets():\\n address = libbase + offset\\n if self.leak.compare(address + 0xC, \\\"GNU\\\\x00\\\"):\\n return enhex(''.join(self.leak.raw(address + 0x10, 20)))\\n else:\\n self.status(\\\"Magic did not match\\\")\\n pass\\n\\n def _make_absolute_ptr(self, ptr_or_offset):\\n \\\"\\\"\\\"For shared libraries (or PIE executables), many ELF fields may\\n contain offsets rather than actual pointers. If the ELF type is 'DYN',\\n the argument may be an offset. It will not necessarily be an offset,\\n because the run-time linker may have fixed it up to be a real pointer\\n already. In this case an educated guess is made, and the ELF base\\n address is added to the value if it is determined to be an offset.\\n \\\"\\\"\\\"\\n if_ptr = ptr_or_offset\\n if_offset = ptr_or_offset + self.libbase\\n\\n # if the ELF type is not DYN, the value is a pointer\\n\\n if self.elftype != 'DYN':\\n return if_ptr\\n\\n # if the ELF type may be DYN, guess\\n\\n if 0 < ptr_or_offset < self.libbase:\\n return if_offset\\n else:\\n return if_ptr\\n\\n def stack(self):\\n \\\"\\\"\\\"Finds a pointer to the stack via __environ, which is an exported\\n symbol in libc, which points to the environment block.\\n \\\"\\\"\\\"\\n symbols = ['environ', '_environ', '__environ']\\n\\n for symbol in symbols:\\n environ = self.lookup(symbol, 'libc')\\n\\n if environ:\\n break\\n else:\\n log.error(\\\"Could not find the stack\\\")\\n\\n stack = self.leak.p(environ)\\n\\n self.success('*environ: %#x' % stack)\\n\\n return stack\\n\\n def heap(self):\\n \\\"\\\"\\\"Finds the beginning of the heap via __curbrk, which is an exported\\n symbol in the linker, which points to the current brk.\\n \\\"\\\"\\\"\\n curbrk = self.lookup('__curbrk', 'libc')\\n brk = self.leak.p(curbrk)\\n\\n self.success('*curbrk: %#x' % brk)\\n\\n return brk\\n\",\n \"path\": \"pwnlib/dynelf.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/pwnlib/dynelf.py b/pwnlib/dynelf.py\nindex b3f502647..83714496e 100644\n--- a/pwnlib/dynelf.py\n+++ b/pwnlib/dynelf.py\n@@ -447,7 +447,7 @@ def _find_linkmap(self, pltgot=None, debug=None):\n if debug:\n w.status(\"r_debug.linkmap\")\n linkmap = self.leak.field(debug, r_debug.r_map)\n- w.status(\"r_debug.linkmap %#x\" % result)\n+ w.status(\"r_debug.linkmap %#x\" % linkmap)\n \n if not linkmap:\n w.failure(\"Could not find DT_PLTGOT or DT_DEBUG\")\n"}}},{"rowIdx":5479,"cells":{"in_source_id":{"kind":"string","value":"pyodide__pyodide-3074"},"issue":{"kind":"string","value":"Export version from pyodide JS module\n## 🚀 Feature\r\n\r\nIn `pyodide.d.ts` I see `declare let version: string;` but it's not exported. It'd be great if it was exported so that I can do this:\r\n\r\n```ts\r\nimport {version} from \"pyodide\";\r\n```\r\n\r\n### Motivation\r\n\r\nI have [some code](https://github.com/alexmojaki/pyodide-worker-runner/blob/e7dd3d0ee1dff457bf9d6104944477840a83e5a7/lib/index.ts#L16) that roughly looks like this:\r\n\r\n```ts\r\nimport {loadPyodide, PyodideInterface} from \"pyodide\";\r\n\r\nconst version = \"0.21.1\";\r\nconst indexURL = `https://cdn.jsdelivr.net/pyodide/v${version}/full/`;\r\nconst pyodide: PyodideInterface = await loadPyodide({indexURL});\r\nif (pyodide.version !== version) {\r\n throw new Error(\r\n `loadPyodide loaded version ${pyodide.version} instead of ${version}`,\r\n );\r\n}\r\n```\r\n\r\nI'd like to import `version` instead of setting it manually, so that it always automatically matches whatever version of pyodide is installed.\n"},"before_files":{"kind":"list like","value":[{"content":"#!/usr/bin/env python3\n\nimport argparse\nimport difflib\nimport functools\nimport itertools\nimport pathlib\nimport re\nfrom ast import Str\nfrom collections import namedtuple\nfrom collections.abc import Callable\n\nCORE_VERSION_REGEX = r\"(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)\"\n\nPYTHON_VERSION_REGEX = CORE_VERSION_REGEX + (\n r\"((?P<pre>a|b|rc)(?P<preversion>\\d+))?\" r\"(\\.(?P<dev>dev)(?P<devversion>\\d+))?\"\n)\n\nJS_VERSION_REGEX = CORE_VERSION_REGEX + (\n r\"(\\-(?P<pre>alpha|beta|rc)\\.(?P<preversion>\\d+))?\"\n r\"(\\-(?P<dev>dev)\\.(?P<devversion>\\d+))?\"\n)\n\n\ndef build_version_pattern(pattern):\n return re.compile(\n pattern.format(\n python_version=f\"(?P<version>{PYTHON_VERSION_REGEX})\",\n js_version=f\"(?P<version>{JS_VERSION_REGEX})\",\n )\n )\n\n\nROOT = pathlib.Path(__file__).resolve().parent.parent\nTarget = namedtuple(\"target\", (\"file\", \"pattern\", \"prerelease\"))\nPYTHON_TARGETS = [\n Target(\n file=ROOT / \"src/py/pyodide/__init__.py\",\n pattern=build_version_pattern('__version__ = \"{python_version}\"'),\n prerelease=True,\n ),\n Target(\n file=ROOT / \"src/py/setup.cfg\",\n pattern=build_version_pattern(\"version = {python_version}\"),\n prerelease=True,\n ),\n Target(\n ROOT / \"pyodide-build/pyodide_build/__init__.py\",\n pattern=build_version_pattern('__version__ = \"{python_version}\"'),\n prerelease=True,\n ),\n Target(\n ROOT / \"docs/conf.py\",\n build_version_pattern('pyodide_version = \"{python_version}\"'),\n prerelease=True,\n ),\n Target(\n ROOT / \"run_docker\",\n build_version_pattern('PYODIDE_PREBUILT_IMAGE_TAG=\"{python_version}\"'),\n prerelease=False,\n ),\n Target(\n ROOT / \"docs/project/about.md\",\n build_version_pattern(r\"version\\s*=\\s*{{{python_version}}}\"),\n prerelease=False,\n ),\n]\n\nJS_TARGETS = [\n Target(\n ROOT / \"src/js/package.json\",\n build_version_pattern(r'\"pyodide\",\\s*\"version\": \"{js_version}\"'),\n prerelease=True,\n ),\n Target(\n ROOT / \"src/js/package-lock.json\",\n build_version_pattern(r'\"pyodide\",\\s*\"version\": \"{js_version}\"'),\n prerelease=True,\n ),\n]\n\n\n@functools.lru_cache\ndef python_version_to_js_version(version: str) -> Str:\n \"\"\"\n Convert Python version name to JS version name\n These two are different in prerelease or dev versions.\n e.g. 1.2.3a0 <==> 1.2.3-alpha.0\n 4.5.6.dev2 <==> 4.5.6-dev.2\n \"\"\"\n match = re.match(PYTHON_VERSION_REGEX, version)\n matches = match.groupdict()\n\n prerelease = matches[\"pre\"] is not None\n devrelease = matches[\"dev\"] is not None\n\n if prerelease and devrelease:\n raise ValueError(\"Cannot have both prerelease and devrelease\")\n elif prerelease:\n matches[\"pre\"] = matches[\"pre\"].replace(\"a\", \"alpha\").replace(\"b\", \"beta\")\n return \"{major}.{minor}.{patch}-{pre}.{preversion}\".format(**matches)\n elif devrelease:\n return \"{major}.{minor}.{patch}-{dev}.{devversion}\".format(**matches)\n else:\n return \"{major}.{minor}.{patch}\".format(**matches)\n\n\n@functools.lru_cache\ndef is_core_version(version: str) -> bool:\n match = re.fullmatch(CORE_VERSION_REGEX, version)\n if match is None:\n return False\n\n return True\n\n\ndef parse_current_version(target: Target) -> str:\n \"\"\"Parse current version\"\"\"\n content = target.file.read_text()\n match = target.pattern.search(content)\n\n if match is None:\n raise ValueError(f\"Unabled to detect version string: {target.file}\")\n\n return match.groupdict()[\"version\"]\n\n\ndef generate_updated_content(\n target: Target, current_version: str, new_version: str\n) -> Callable:\n file = target.file\n pattern = target.pattern\n content = file.read_text()\n\n if current_version == new_version:\n return None\n\n # Some files only required to be bumped on core version release.\n # For example, we don't deploy prebuilt docker images for dev release.\n if not target.prerelease:\n if not is_core_version(new_version):\n print(f\"[*] {file}: Skipped (not targeting a core version)\")\n return None\n\n new_content = content\n startpos = 0\n while match := pattern.search(new_content, pos=startpos):\n version = match.groupdict()[\"version\"]\n if version == current_version:\n start, end = match.span()\n new_span = new_content[start:end].replace(current_version, new_version)\n new_content = new_content[:start] + new_span + new_content[end:]\n startpos = end\n elif version == new_version:\n break\n else:\n raise ValueError(\n f\"'{file}' contains invalid version: expected '{current_version}' but found '{version}'\"\n )\n\n show_diff(content, new_content, file)\n\n return new_content\n\n\ndef show_diff(before: str, after: str, file: pathlib.Path):\n diffs = list(\n difflib.unified_diff(\n before.splitlines(keepends=True), after.splitlines(keepends=True), n=0\n )\n )[2:]\n print(f\"[*] Diff of '{file}':\\n\")\n print(\"\".join(diffs))\n\n\ndef parse_args():\n parser = argparse.ArgumentParser(\"Bump version strings in the Pyodide repository\")\n parser.add_argument(\"--new-version\", help=\"New version\")\n parser.add_argument(\n \"--dry-run\", action=\"store_true\", help=\"Don't actually write anything\"\n )\n\n return parser.parse_args()\n\n\ndef main():\n args = parse_args()\n\n if args.new_version is None:\n new_version = input(\"New version (e.g. 0.22.0, 0.22.0a0, 0.22.0.dev0): \")\n else:\n new_version = args.new_version\n\n if re.fullmatch(PYTHON_VERSION_REGEX, new_version) is None:\n raise ValueError(f\"Invalid new version: {new_version}\")\n\n new_version_py = new_version\n new_version_js = python_version_to_js_version(new_version)\n\n # We want to update files in all-or-nothing strategy,\n # so we keep the queue of update functions\n update_queue = []\n\n targets = itertools.chain(\n zip(PYTHON_TARGETS, [new_version_py] * len(PYTHON_TARGETS)),\n zip(JS_TARGETS, [new_version_js] * len(JS_TARGETS)),\n )\n for target, new_version in targets:\n current_version = parse_current_version(target)\n new_content = generate_updated_content(target, current_version, new_version)\n if new_content is not None:\n update_queue.append((target, new_content))\n\n if args.dry_run:\n return\n\n for target, content in update_queue:\n target.file.write_text(content)\n\n\nif __name__ == \"__main__\":\n main()\n","path":"tools/bump_version.py"}],"string":"[\n {\n \"content\": \"#!/usr/bin/env python3\\n\\nimport argparse\\nimport difflib\\nimport functools\\nimport itertools\\nimport pathlib\\nimport re\\nfrom ast import Str\\nfrom collections import namedtuple\\nfrom collections.abc import Callable\\n\\nCORE_VERSION_REGEX = r\\\"(?P<major>\\\\d+)\\\\.(?P<minor>\\\\d+)\\\\.(?P<patch>\\\\d+)\\\"\\n\\nPYTHON_VERSION_REGEX = CORE_VERSION_REGEX + (\\n r\\\"((?P<pre>a|b|rc)(?P<preversion>\\\\d+))?\\\" r\\\"(\\\\.(?P<dev>dev)(?P<devversion>\\\\d+))?\\\"\\n)\\n\\nJS_VERSION_REGEX = CORE_VERSION_REGEX + (\\n r\\\"(\\\\-(?P<pre>alpha|beta|rc)\\\\.(?P<preversion>\\\\d+))?\\\"\\n r\\\"(\\\\-(?P<dev>dev)\\\\.(?P<devversion>\\\\d+))?\\\"\\n)\\n\\n\\ndef build_version_pattern(pattern):\\n return re.compile(\\n pattern.format(\\n python_version=f\\\"(?P<version>{PYTHON_VERSION_REGEX})\\\",\\n js_version=f\\\"(?P<version>{JS_VERSION_REGEX})\\\",\\n )\\n )\\n\\n\\nROOT = pathlib.Path(__file__).resolve().parent.parent\\nTarget = namedtuple(\\\"target\\\", (\\\"file\\\", \\\"pattern\\\", \\\"prerelease\\\"))\\nPYTHON_TARGETS = [\\n Target(\\n file=ROOT / \\\"src/py/pyodide/__init__.py\\\",\\n pattern=build_version_pattern('__version__ = \\\"{python_version}\\\"'),\\n prerelease=True,\\n ),\\n Target(\\n file=ROOT / \\\"src/py/setup.cfg\\\",\\n pattern=build_version_pattern(\\\"version = {python_version}\\\"),\\n prerelease=True,\\n ),\\n Target(\\n ROOT / \\\"pyodide-build/pyodide_build/__init__.py\\\",\\n pattern=build_version_pattern('__version__ = \\\"{python_version}\\\"'),\\n prerelease=True,\\n ),\\n Target(\\n ROOT / \\\"docs/conf.py\\\",\\n build_version_pattern('pyodide_version = \\\"{python_version}\\\"'),\\n prerelease=True,\\n ),\\n Target(\\n ROOT / \\\"run_docker\\\",\\n build_version_pattern('PYODIDE_PREBUILT_IMAGE_TAG=\\\"{python_version}\\\"'),\\n prerelease=False,\\n ),\\n Target(\\n ROOT / \\\"docs/project/about.md\\\",\\n build_version_pattern(r\\\"version\\\\s*=\\\\s*{{{python_version}}}\\\"),\\n prerelease=False,\\n ),\\n]\\n\\nJS_TARGETS = [\\n Target(\\n ROOT / \\\"src/js/package.json\\\",\\n build_version_pattern(r'\\\"pyodide\\\",\\\\s*\\\"version\\\": \\\"{js_version}\\\"'),\\n prerelease=True,\\n ),\\n Target(\\n ROOT / \\\"src/js/package-lock.json\\\",\\n build_version_pattern(r'\\\"pyodide\\\",\\\\s*\\\"version\\\": \\\"{js_version}\\\"'),\\n prerelease=True,\\n ),\\n]\\n\\n\\n@functools.lru_cache\\ndef python_version_to_js_version(version: str) -> Str:\\n \\\"\\\"\\\"\\n Convert Python version name to JS version name\\n These two are different in prerelease or dev versions.\\n e.g. 1.2.3a0 <==> 1.2.3-alpha.0\\n 4.5.6.dev2 <==> 4.5.6-dev.2\\n \\\"\\\"\\\"\\n match = re.match(PYTHON_VERSION_REGEX, version)\\n matches = match.groupdict()\\n\\n prerelease = matches[\\\"pre\\\"] is not None\\n devrelease = matches[\\\"dev\\\"] is not None\\n\\n if prerelease and devrelease:\\n raise ValueError(\\\"Cannot have both prerelease and devrelease\\\")\\n elif prerelease:\\n matches[\\\"pre\\\"] = matches[\\\"pre\\\"].replace(\\\"a\\\", \\\"alpha\\\").replace(\\\"b\\\", \\\"beta\\\")\\n return \\\"{major}.{minor}.{patch}-{pre}.{preversion}\\\".format(**matches)\\n elif devrelease:\\n return \\\"{major}.{minor}.{patch}-{dev}.{devversion}\\\".format(**matches)\\n else:\\n return \\\"{major}.{minor}.{patch}\\\".format(**matches)\\n\\n\\n@functools.lru_cache\\ndef is_core_version(version: str) -> bool:\\n match = re.fullmatch(CORE_VERSION_REGEX, version)\\n if match is None:\\n return False\\n\\n return True\\n\\n\\ndef parse_current_version(target: Target) -> str:\\n \\\"\\\"\\\"Parse current version\\\"\\\"\\\"\\n content = target.file.read_text()\\n match = target.pattern.search(content)\\n\\n if match is None:\\n raise ValueError(f\\\"Unabled to detect version string: {target.file}\\\")\\n\\n return match.groupdict()[\\\"version\\\"]\\n\\n\\ndef generate_updated_content(\\n target: Target, current_version: str, new_version: str\\n) -> Callable:\\n file = target.file\\n pattern = target.pattern\\n content = file.read_text()\\n\\n if current_version == new_version:\\n return None\\n\\n # Some files only required to be bumped on core version release.\\n # For example, we don't deploy prebuilt docker images for dev release.\\n if not target.prerelease:\\n if not is_core_version(new_version):\\n print(f\\\"[*] {file}: Skipped (not targeting a core version)\\\")\\n return None\\n\\n new_content = content\\n startpos = 0\\n while match := pattern.search(new_content, pos=startpos):\\n version = match.groupdict()[\\\"version\\\"]\\n if version == current_version:\\n start, end = match.span()\\n new_span = new_content[start:end].replace(current_version, new_version)\\n new_content = new_content[:start] + new_span + new_content[end:]\\n startpos = end\\n elif version == new_version:\\n break\\n else:\\n raise ValueError(\\n f\\\"'{file}' contains invalid version: expected '{current_version}' but found '{version}'\\\"\\n )\\n\\n show_diff(content, new_content, file)\\n\\n return new_content\\n\\n\\ndef show_diff(before: str, after: str, file: pathlib.Path):\\n diffs = list(\\n difflib.unified_diff(\\n before.splitlines(keepends=True), after.splitlines(keepends=True), n=0\\n )\\n )[2:]\\n print(f\\\"[*] Diff of '{file}':\\\\n\\\")\\n print(\\\"\\\".join(diffs))\\n\\n\\ndef parse_args():\\n parser = argparse.ArgumentParser(\\\"Bump version strings in the Pyodide repository\\\")\\n parser.add_argument(\\\"--new-version\\\", help=\\\"New version\\\")\\n parser.add_argument(\\n \\\"--dry-run\\\", action=\\\"store_true\\\", help=\\\"Don't actually write anything\\\"\\n )\\n\\n return parser.parse_args()\\n\\n\\ndef main():\\n args = parse_args()\\n\\n if args.new_version is None:\\n new_version = input(\\\"New version (e.g. 0.22.0, 0.22.0a0, 0.22.0.dev0): \\\")\\n else:\\n new_version = args.new_version\\n\\n if re.fullmatch(PYTHON_VERSION_REGEX, new_version) is None:\\n raise ValueError(f\\\"Invalid new version: {new_version}\\\")\\n\\n new_version_py = new_version\\n new_version_js = python_version_to_js_version(new_version)\\n\\n # We want to update files in all-or-nothing strategy,\\n # so we keep the queue of update functions\\n update_queue = []\\n\\n targets = itertools.chain(\\n zip(PYTHON_TARGETS, [new_version_py] * len(PYTHON_TARGETS)),\\n zip(JS_TARGETS, [new_version_js] * len(JS_TARGETS)),\\n )\\n for target, new_version in targets:\\n current_version = parse_current_version(target)\\n new_content = generate_updated_content(target, current_version, new_version)\\n if new_content is not None:\\n update_queue.append((target, new_content))\\n\\n if args.dry_run:\\n return\\n\\n for target, content in update_queue:\\n target.file.write_text(content)\\n\\n\\nif __name__ == \\\"__main__\\\":\\n main()\\n\",\n \"path\": \"tools/bump_version.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"#!/usr/bin/env python3\n\nimport argparse\nimport difflib\nimport functools\nimport itertools\nimport pathlib\nimport re\nfrom ast import Str\nfrom collections import namedtuple\nfrom collections.abc import Callable\n\nCORE_VERSION_REGEX = r\"(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)\"\n\nPYTHON_VERSION_REGEX = CORE_VERSION_REGEX + (\n r\"((?P<pre>a|b|rc)(?P<preversion>\\d+))?\" r\"(\\.(?P<dev>dev)(?P<devversion>\\d+))?\"\n)\n\nJS_VERSION_REGEX = CORE_VERSION_REGEX + (\n r\"(\\-(?P<pre>alpha|beta|rc)\\.(?P<preversion>\\d+))?\"\n r\"(\\-(?P<dev>dev)\\.(?P<devversion>\\d+))?\"\n)\n\n\ndef build_version_pattern(pattern):\n return re.compile(\n pattern.format(\n python_version=f\"(?P<version>{PYTHON_VERSION_REGEX})\",\n js_version=f\"(?P<version>{JS_VERSION_REGEX})\",\n )\n )\n\n\nROOT = pathlib.Path(__file__).resolve().parent.parent\nTarget = namedtuple(\"target\", (\"file\", \"pattern\", \"prerelease\"))\nPYTHON_TARGETS = [\n Target(\n file=ROOT / \"src/py/pyodide/__init__.py\",\n pattern=build_version_pattern('__version__ = \"{python_version}\"'),\n prerelease=True,\n ),\n Target(\n file=ROOT / \"src/py/setup.cfg\",\n pattern=build_version_pattern(\"version = {python_version}\"),\n prerelease=True,\n ),\n Target(\n ROOT / \"pyodide-build/pyodide_build/__init__.py\",\n pattern=build_version_pattern('__version__ = \"{python_version}\"'),\n prerelease=True,\n ),\n Target(\n ROOT / \"docs/conf.py\",\n build_version_pattern('pyodide_version = \"{python_version}\"'),\n prerelease=True,\n ),\n Target(\n ROOT / \"run_docker\",\n build_version_pattern('PYODIDE_PREBUILT_IMAGE_TAG=\"{python_version}\"'),\n prerelease=False,\n ),\n Target(\n ROOT / \"docs/project/about.md\",\n build_version_pattern(r\"version\\s*=\\s*{{{python_version}}}\"),\n prerelease=False,\n ),\n Target(\n ROOT / \"src/js/version.ts\",\n build_version_pattern('version: string = \"{python_version}\"'),\n prerelease=True,\n ),\n Target(\n ROOT / \"src/core/pre.js\",\n build_version_pattern('API.version = \"{python_version}\"'),\n prerelease=True,\n ),\n]\n\nJS_TARGETS = [\n Target(\n ROOT / \"src/js/package.json\",\n build_version_pattern(r'\"pyodide\",\\s*\"version\": \"{js_version}\"'),\n prerelease=True,\n ),\n Target(\n ROOT / \"src/js/package-lock.json\",\n build_version_pattern(r'\"pyodide\",\\s*\"version\": \"{js_version}\"'),\n prerelease=True,\n ),\n]\n\n\n@functools.lru_cache\ndef python_version_to_js_version(version: str) -> Str:\n \"\"\"\n Convert Python version name to JS version name\n These two are different in prerelease or dev versions.\n e.g. 1.2.3a0 <==> 1.2.3-alpha.0\n 4.5.6.dev2 <==> 4.5.6-dev.2\n \"\"\"\n match = re.match(PYTHON_VERSION_REGEX, version)\n matches = match.groupdict()\n\n prerelease = matches[\"pre\"] is not None\n devrelease = matches[\"dev\"] is not None\n\n if prerelease and devrelease:\n raise ValueError(\"Cannot have both prerelease and devrelease\")\n elif prerelease:\n matches[\"pre\"] = matches[\"pre\"].replace(\"a\", \"alpha\").replace(\"b\", \"beta\")\n return \"{major}.{minor}.{patch}-{pre}.{preversion}\".format(**matches)\n elif devrelease:\n return \"{major}.{minor}.{patch}-{dev}.{devversion}\".format(**matches)\n else:\n return \"{major}.{minor}.{patch}\".format(**matches)\n\n\n@functools.lru_cache\ndef is_core_version(version: str) -> bool:\n match = re.fullmatch(CORE_VERSION_REGEX, version)\n if match is None:\n return False\n\n return True\n\n\ndef parse_current_version(target: Target) -> str:\n \"\"\"Parse current version\"\"\"\n content = target.file.read_text()\n match = target.pattern.search(content)\n\n if match is None:\n raise ValueError(f\"Unabled to detect version string: {target.file}\")\n\n return match.groupdict()[\"version\"]\n\n\ndef generate_updated_content(\n target: Target, current_version: str, new_version: str\n) -> Callable:\n file = target.file\n pattern = target.pattern\n content = file.read_text()\n\n if current_version == new_version:\n return None\n\n # Some files only required to be bumped on core version release.\n # For example, we don't deploy prebuilt docker images for dev release.\n if not target.prerelease:\n if not is_core_version(new_version):\n print(f\"[*] {file}: Skipped (not targeting a core version)\")\n return None\n\n new_content = content\n startpos = 0\n while match := pattern.search(new_content, pos=startpos):\n version = match.groupdict()[\"version\"]\n if version == current_version:\n start, end = match.span()\n new_span = new_content[start:end].replace(current_version, new_version)\n new_content = new_content[:start] + new_span + new_content[end:]\n startpos = end\n elif version == new_version:\n break\n else:\n raise ValueError(\n f\"'{file}' contains invalid version: expected '{current_version}' but found '{version}'\"\n )\n\n show_diff(content, new_content, file)\n\n return new_content\n\n\ndef show_diff(before: str, after: str, file: pathlib.Path):\n diffs = list(\n difflib.unified_diff(\n before.splitlines(keepends=True), after.splitlines(keepends=True), n=0\n )\n )[2:]\n print(f\"[*] Diff of '{file}':\\n\")\n print(\"\".join(diffs))\n\n\ndef parse_args():\n parser = argparse.ArgumentParser(\"Bump version strings in the Pyodide repository\")\n parser.add_argument(\"--new-version\", help=\"New version\")\n parser.add_argument(\n \"--dry-run\", action=\"store_true\", help=\"Don't actually write anything\"\n )\n\n return parser.parse_args()\n\n\ndef main():\n args = parse_args()\n\n if args.new_version is None:\n new_version = input(\"New version (e.g. 0.22.0, 0.22.0a0, 0.22.0.dev0): \")\n else:\n new_version = args.new_version\n\n if re.fullmatch(PYTHON_VERSION_REGEX, new_version) is None:\n raise ValueError(f\"Invalid new version: {new_version}\")\n\n new_version_py = new_version\n new_version_js = python_version_to_js_version(new_version)\n\n # We want to update files in all-or-nothing strategy,\n # so we keep the queue of update functions\n update_queue = []\n\n targets = itertools.chain(\n zip(PYTHON_TARGETS, [new_version_py] * len(PYTHON_TARGETS)),\n zip(JS_TARGETS, [new_version_js] * len(JS_TARGETS)),\n )\n for target, new_version in targets:\n current_version = parse_current_version(target)\n new_content = generate_updated_content(target, current_version, new_version)\n if new_content is not None:\n update_queue.append((target, new_content))\n\n if args.dry_run:\n return\n\n for target, content in update_queue:\n target.file.write_text(content)\n\n\nif __name__ == \"__main__\":\n main()\n","path":"tools/bump_version.py"}],"string":"[\n {\n \"content\": \"#!/usr/bin/env python3\\n\\nimport argparse\\nimport difflib\\nimport functools\\nimport itertools\\nimport pathlib\\nimport re\\nfrom ast import Str\\nfrom collections import namedtuple\\nfrom collections.abc import Callable\\n\\nCORE_VERSION_REGEX = r\\\"(?P<major>\\\\d+)\\\\.(?P<minor>\\\\d+)\\\\.(?P<patch>\\\\d+)\\\"\\n\\nPYTHON_VERSION_REGEX = CORE_VERSION_REGEX + (\\n r\\\"((?P<pre>a|b|rc)(?P<preversion>\\\\d+))?\\\" r\\\"(\\\\.(?P<dev>dev)(?P<devversion>\\\\d+))?\\\"\\n)\\n\\nJS_VERSION_REGEX = CORE_VERSION_REGEX + (\\n r\\\"(\\\\-(?P<pre>alpha|beta|rc)\\\\.(?P<preversion>\\\\d+))?\\\"\\n r\\\"(\\\\-(?P<dev>dev)\\\\.(?P<devversion>\\\\d+))?\\\"\\n)\\n\\n\\ndef build_version_pattern(pattern):\\n return re.compile(\\n pattern.format(\\n python_version=f\\\"(?P<version>{PYTHON_VERSION_REGEX})\\\",\\n js_version=f\\\"(?P<version>{JS_VERSION_REGEX})\\\",\\n )\\n )\\n\\n\\nROOT = pathlib.Path(__file__).resolve().parent.parent\\nTarget = namedtuple(\\\"target\\\", (\\\"file\\\", \\\"pattern\\\", \\\"prerelease\\\"))\\nPYTHON_TARGETS = [\\n Target(\\n file=ROOT / \\\"src/py/pyodide/__init__.py\\\",\\n pattern=build_version_pattern('__version__ = \\\"{python_version}\\\"'),\\n prerelease=True,\\n ),\\n Target(\\n file=ROOT / \\\"src/py/setup.cfg\\\",\\n pattern=build_version_pattern(\\\"version = {python_version}\\\"),\\n prerelease=True,\\n ),\\n Target(\\n ROOT / \\\"pyodide-build/pyodide_build/__init__.py\\\",\\n pattern=build_version_pattern('__version__ = \\\"{python_version}\\\"'),\\n prerelease=True,\\n ),\\n Target(\\n ROOT / \\\"docs/conf.py\\\",\\n build_version_pattern('pyodide_version = \\\"{python_version}\\\"'),\\n prerelease=True,\\n ),\\n Target(\\n ROOT / \\\"run_docker\\\",\\n build_version_pattern('PYODIDE_PREBUILT_IMAGE_TAG=\\\"{python_version}\\\"'),\\n prerelease=False,\\n ),\\n Target(\\n ROOT / \\\"docs/project/about.md\\\",\\n build_version_pattern(r\\\"version\\\\s*=\\\\s*{{{python_version}}}\\\"),\\n prerelease=False,\\n ),\\n Target(\\n ROOT / \\\"src/js/version.ts\\\",\\n build_version_pattern('version: string = \\\"{python_version}\\\"'),\\n prerelease=True,\\n ),\\n Target(\\n ROOT / \\\"src/core/pre.js\\\",\\n build_version_pattern('API.version = \\\"{python_version}\\\"'),\\n prerelease=True,\\n ),\\n]\\n\\nJS_TARGETS = [\\n Target(\\n ROOT / \\\"src/js/package.json\\\",\\n build_version_pattern(r'\\\"pyodide\\\",\\\\s*\\\"version\\\": \\\"{js_version}\\\"'),\\n prerelease=True,\\n ),\\n Target(\\n ROOT / \\\"src/js/package-lock.json\\\",\\n build_version_pattern(r'\\\"pyodide\\\",\\\\s*\\\"version\\\": \\\"{js_version}\\\"'),\\n prerelease=True,\\n ),\\n]\\n\\n\\n@functools.lru_cache\\ndef python_version_to_js_version(version: str) -> Str:\\n \\\"\\\"\\\"\\n Convert Python version name to JS version name\\n These two are different in prerelease or dev versions.\\n e.g. 1.2.3a0 <==> 1.2.3-alpha.0\\n 4.5.6.dev2 <==> 4.5.6-dev.2\\n \\\"\\\"\\\"\\n match = re.match(PYTHON_VERSION_REGEX, version)\\n matches = match.groupdict()\\n\\n prerelease = matches[\\\"pre\\\"] is not None\\n devrelease = matches[\\\"dev\\\"] is not None\\n\\n if prerelease and devrelease:\\n raise ValueError(\\\"Cannot have both prerelease and devrelease\\\")\\n elif prerelease:\\n matches[\\\"pre\\\"] = matches[\\\"pre\\\"].replace(\\\"a\\\", \\\"alpha\\\").replace(\\\"b\\\", \\\"beta\\\")\\n return \\\"{major}.{minor}.{patch}-{pre}.{preversion}\\\".format(**matches)\\n elif devrelease:\\n return \\\"{major}.{minor}.{patch}-{dev}.{devversion}\\\".format(**matches)\\n else:\\n return \\\"{major}.{minor}.{patch}\\\".format(**matches)\\n\\n\\n@functools.lru_cache\\ndef is_core_version(version: str) -> bool:\\n match = re.fullmatch(CORE_VERSION_REGEX, version)\\n if match is None:\\n return False\\n\\n return True\\n\\n\\ndef parse_current_version(target: Target) -> str:\\n \\\"\\\"\\\"Parse current version\\\"\\\"\\\"\\n content = target.file.read_text()\\n match = target.pattern.search(content)\\n\\n if match is None:\\n raise ValueError(f\\\"Unabled to detect version string: {target.file}\\\")\\n\\n return match.groupdict()[\\\"version\\\"]\\n\\n\\ndef generate_updated_content(\\n target: Target, current_version: str, new_version: str\\n) -> Callable:\\n file = target.file\\n pattern = target.pattern\\n content = file.read_text()\\n\\n if current_version == new_version:\\n return None\\n\\n # Some files only required to be bumped on core version release.\\n # For example, we don't deploy prebuilt docker images for dev release.\\n if not target.prerelease:\\n if not is_core_version(new_version):\\n print(f\\\"[*] {file}: Skipped (not targeting a core version)\\\")\\n return None\\n\\n new_content = content\\n startpos = 0\\n while match := pattern.search(new_content, pos=startpos):\\n version = match.groupdict()[\\\"version\\\"]\\n if version == current_version:\\n start, end = match.span()\\n new_span = new_content[start:end].replace(current_version, new_version)\\n new_content = new_content[:start] + new_span + new_content[end:]\\n startpos = end\\n elif version == new_version:\\n break\\n else:\\n raise ValueError(\\n f\\\"'{file}' contains invalid version: expected '{current_version}' but found '{version}'\\\"\\n )\\n\\n show_diff(content, new_content, file)\\n\\n return new_content\\n\\n\\ndef show_diff(before: str, after: str, file: pathlib.Path):\\n diffs = list(\\n difflib.unified_diff(\\n before.splitlines(keepends=True), after.splitlines(keepends=True), n=0\\n )\\n )[2:]\\n print(f\\\"[*] Diff of '{file}':\\\\n\\\")\\n print(\\\"\\\".join(diffs))\\n\\n\\ndef parse_args():\\n parser = argparse.ArgumentParser(\\\"Bump version strings in the Pyodide repository\\\")\\n parser.add_argument(\\\"--new-version\\\", help=\\\"New version\\\")\\n parser.add_argument(\\n \\\"--dry-run\\\", action=\\\"store_true\\\", help=\\\"Don't actually write anything\\\"\\n )\\n\\n return parser.parse_args()\\n\\n\\ndef main():\\n args = parse_args()\\n\\n if args.new_version is None:\\n new_version = input(\\\"New version (e.g. 0.22.0, 0.22.0a0, 0.22.0.dev0): \\\")\\n else:\\n new_version = args.new_version\\n\\n if re.fullmatch(PYTHON_VERSION_REGEX, new_version) is None:\\n raise ValueError(f\\\"Invalid new version: {new_version}\\\")\\n\\n new_version_py = new_version\\n new_version_js = python_version_to_js_version(new_version)\\n\\n # We want to update files in all-or-nothing strategy,\\n # so we keep the queue of update functions\\n update_queue = []\\n\\n targets = itertools.chain(\\n zip(PYTHON_TARGETS, [new_version_py] * len(PYTHON_TARGETS)),\\n zip(JS_TARGETS, [new_version_js] * len(JS_TARGETS)),\\n )\\n for target, new_version in targets:\\n current_version = parse_current_version(target)\\n new_content = generate_updated_content(target, current_version, new_version)\\n if new_content is not None:\\n update_queue.append((target, new_content))\\n\\n if args.dry_run:\\n return\\n\\n for target, content in update_queue:\\n target.file.write_text(content)\\n\\n\\nif __name__ == \\\"__main__\\\":\\n main()\\n\",\n \"path\": \"tools/bump_version.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/docs/project/changelog.md b/docs/project/changelog.md\nindex 22d5ba5b90d..effae95b349 100644\n--- a/docs/project/changelog.md\n+++ b/docs/project/changelog.md\n@@ -67,6 +67,10 @@ substitutions:\n {pr}`3015` included in 0.21.2) and if there is a variable in top level scope\n called `__dirname` we use that for the `indexURL`.\n \n+- {{ Fix }} `loadPyodide` will now raise error when the version of\n+ JavaScript and Python Pyodide package does not match.\n+ {pr}`3074`\n+\n ### Build System / Package Loading\n \n - New packages: pycryptodomex {pr}`2966`, pycryptodome {pr}`2965`\ndiff --git a/src/core/pre.js b/src/core/pre.js\nindex 9a8b6e21a31..9139b15c89d 100644\n--- a/src/core/pre.js\n+++ b/src/core/pre.js\n@@ -2,4 +2,5 @@ const API = Module.API;\n const Hiwire = {};\n const Tests = {};\n API.tests = Tests;\n+API.version = \"0.22.0.dev0\";\n Module.hiwire = Hiwire;\ndiff --git a/src/js/api.ts b/src/js/api.ts\nindex 6137544a9c7..3a529d84ee6 100644\n--- a/src/js/api.ts\n+++ b/src/js/api.ts\n@@ -7,6 +7,7 @@ import { loadPackage, loadedPackages } from \"./load-package\";\n import { isPyProxy, PyBuffer, PyProxy, TypedArray } from \"./pyproxy.gen\";\n import { PythonError } from \"./error_handling.gen\";\n import { loadBinaryFile } from \"./compat\";\n+import version from \"./version\";\n export { loadPackage, loadedPackages, isPyProxy };\n import \"./error_handling.gen.js\";\n \n@@ -29,16 +30,6 @@ export let pyodide_py: PyProxy; // actually defined in loadPyodide (see pyodide.\n */\n export let globals: PyProxy; // actually defined in loadPyodide (see pyodide.js)\n \n-/**\n- *\n- * The Pyodide version.\n- *\n- * It can be either the exact release version (e.g. ``0.1.0``), or\n- * the latest release version followed by the number of commits since, and\n- * the git hash of the current commit (e.g. ``0.1.0-1-bd84646``).\n- */\n-export let version: string = \"\"; // actually defined in loadPyodide (see pyodide.js)\n-\n /**\n * Just like `runPython` except uses a different globals dict and gets\n * `eval_code` from `_pyodide` so that it can work before `pyodide` is imported.\ndiff --git a/src/js/pyodide.ts b/src/js/pyodide.ts\nindex 91eef6705f6..6bb291a9481 100644\n--- a/src/js/pyodide.ts\n+++ b/src/js/pyodide.ts\n@@ -11,6 +11,7 @@ import {\n } from \"./compat\";\n \n import { createModule, setStandardStreams, setHomeDirectory } from \"./module\";\n+import version from \"./version\";\n \n import type { PyodideInterface } from \"./api.js\";\n import type { PyProxy, PyProxyDict } from \"./pyproxy.gen\";\n@@ -34,6 +35,8 @@ export type {\n \n export type Py2JsResult = any;\n \n+export { version };\n+\n /**\n * A proxy around globals that falls back to checking for a builtin if has or\n * get fails to find a global with the given key. Note that this proxy is\n@@ -144,11 +147,9 @@ function finalizeBootstrap(API: any, config: ConfigType) {\n API.pyodide_code = import_module(\"pyodide.code\");\n API.pyodide_ffi = import_module(\"pyodide.ffi\");\n API.package_loader = import_module(\"pyodide._package_loader\");\n- API.version = API.pyodide_py.__version__;\n \n // copy some last constants onto public API.\n pyodide.pyodide_py = API.pyodide_py;\n- pyodide.version = API.version;\n pyodide.globals = API.globals;\n return pyodide;\n }\n@@ -327,6 +328,15 @@ export async function loadPyodide(\n throw Module.exited.toThrow;\n }\n \n+ if (API.version !== version) {\n+ throw new Error(\n+ `\\\n+Pyodide version does not match: '${version}' <==> '${API.version}'. \\\n+If you updated the Pyodide version, make sure you also updated the 'indexURL' parameter passed to loadPyodide.\\\n+`\n+ );\n+ }\n+\n // Disable further loading of Emscripten file_packager stuff.\n Module.locateFile = (path: string) => {\n throw new Error(\"Didn't expect to load any more file_packager files!\");\n@@ -337,6 +347,7 @@ export async function loadPyodide(\n Module._pyodide_init();\n \n const pyodide = finalizeBootstrap(API, config);\n+\n // API.runPython works starting here.\n if (!pyodide.version.includes(\"dev\")) {\n // Currently only used in Node to download packages the first time they are\n@@ -344,7 +355,7 @@ export async function loadPyodide(\n API.setCdnUrl(`https://cdn.jsdelivr.net/pyodide/v${pyodide.version}/full/`);\n }\n await API.packageIndexReady;\n- if (API.repodata_info.version !== pyodide.version) {\n+ if (API.repodata_info.version !== version) {\n throw new Error(\"Lock file version doesn't match Pyodide version\");\n }\n API.package_loader.init_loaded_packages();\ndiff --git a/src/js/pyodide.umd.ts b/src/js/pyodide.umd.ts\nindex a7bfb8040e1..eb4963116fe 100644\n--- a/src/js/pyodide.umd.ts\n+++ b/src/js/pyodide.umd.ts\n@@ -1,3 +1,3 @@\n-import { loadPyodide } from \"./pyodide\";\n-export { loadPyodide };\n+import { loadPyodide, version } from \"./pyodide\";\n+export { loadPyodide, version };\n (globalThis as any).loadPyodide = loadPyodide;\ndiff --git a/src/js/version.ts b/src/js/version.ts\nnew file mode 100644\nindex 00000000000..fb540bcbf6e\n--- /dev/null\n+++ b/src/js/version.ts\n@@ -0,0 +1,10 @@\n+/**\n+ *\n+ * The Pyodide version.\n+ *\n+ * The version here follows PEP440 which is different from the one in package.json,\n+ * as we want to compare this with the version of Pyodide Python package without conversion.\n+ */\n+const version: string = \"0.22.0.dev0\";\n+\n+export default version;\ndiff --git a/src/tests/test_pyodide.py b/src/tests/test_pyodide.py\nindex 02969121882..c8b1178eadb 100644\n--- a/src/tests/test_pyodide.py\n+++ b/src/tests/test_pyodide.py\n@@ -1126,6 +1126,24 @@ def test_home_directory(selenium_standalone_noload):\n )\n \n \n+def test_version_variable(selenium):\n+ js_version = selenium.run_js(\n+ \"\"\"\n+ return pyodide.version\n+ \"\"\"\n+ )\n+\n+ core_version = selenium.run_js(\n+ \"\"\"\n+ return pyodide._api.version\n+ \"\"\"\n+ )\n+\n+ from pyodide import __version__ as py_version\n+\n+ assert js_version == py_version == core_version\n+\n+\n def test_sys_path0(selenium):\n selenium.run_js(\n \"\"\"\ndiff --git a/tools/bump_version.py b/tools/bump_version.py\nindex fbab4253cd3..f51b5771e53 100755\n--- a/tools/bump_version.py\n+++ b/tools/bump_version.py\n@@ -64,6 +64,16 @@ def build_version_pattern(pattern):\n build_version_pattern(r\"version\\s*=\\s*{{{python_version}}}\"),\n prerelease=False,\n ),\n+ Target(\n+ ROOT / \"src/js/version.ts\",\n+ build_version_pattern('version: string = \"{python_version}\"'),\n+ prerelease=True,\n+ ),\n+ Target(\n+ ROOT / \"src/core/pre.js\",\n+ build_version_pattern('API.version = \"{python_version}\"'),\n+ prerelease=True,\n+ ),\n ]\n \n JS_TARGETS = [\n"}}},{"rowIdx":5480,"cells":{"in_source_id":{"kind":"string","value":"google__personfinder-457"},"issue":{"kind":"string","value":"dmp_csv cron job should not be run for deactivated repos\n\n"},"before_files":{"kind":"list like","value":[{"content":"#!/usr/bin/python2.7\n# Copyright 2010 Google Inc.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport calendar\nimport datetime\nimport logging\nimport time\nimport StringIO\n\nfrom google.appengine import runtime\nfrom google.appengine.api import datastore_errors\nfrom google.appengine.api import quota\nfrom google.appengine.api import taskqueue\nfrom google.appengine.ext import db\n\nimport cloud_storage\nimport config\nimport const\nimport delete\nimport model\nimport photo\nimport pfif\nimport record_writer\nimport utils\n\n\nCPU_MEGACYCLES_PER_REQUEST = 1000\nEXPIRED_TTL = datetime.timedelta(delete.EXPIRED_TTL_DAYS, 0, 0)\nFETCH_LIMIT = 100\nPFIF = pfif.PFIF_VERSIONS[pfif.PFIF_DEFAULT_VERSION]\n\n\nclass ScanForExpired(utils.BaseHandler):\n \"\"\"Common logic for scanning the Person table looking for things to delete.\n\n The common logic handles iterating through the query, updating the expiry\n date and wiping/deleting as needed. The is_expired flag on all records whose\n expiry_date has passed. Records that expired more than EXPIRED_TTL in the\n past will also have their data fields, notes, and photos permanently\n deleted.\n\n Subclasses set the query and task_name.\"\"\"\n repo_required = False\n\n def task_name(self):\n \"\"\"Subclasses should implement this.\"\"\"\n pass\n\n def query(self):\n \"\"\"Subclasses should implement this.\"\"\"\n pass\n\n def schedule_next_task(self, cursor):\n \"\"\"Schedule the next task for to carry on with this query.\n \"\"\"\n self.add_task_for_repo(self.repo, self.task_name(), self.ACTION,\n cursor=cursor, queue_name='expiry')\n\n def get(self):\n if self.repo:\n query = self.query()\n if self.params.cursor:\n query.with_cursor(self.params.cursor)\n cursor = self.params.cursor\n try:\n for person in query:\n # query.cursor() returns a cursor which returns the entity\n # next to this \"person\" as the first result.\n next_cursor = query.cursor()\n was_expired = person.is_expired\n person.put_expiry_flags()\n if (utils.get_utcnow() - person.get_effective_expiry_date()\n > EXPIRED_TTL):\n person.wipe_contents()\n else:\n # treat this as a regular deletion.\n if person.is_expired and not was_expired:\n delete.delete_person(self, person)\n cursor = next_cursor\n except runtime.DeadlineExceededError:\n self.schedule_next_task(cursor)\n except datastore_errors.Timeout:\n # This exception is sometimes raised, maybe when the query\n # object live too long?\n self.schedule_next_task(cursor)\n else:\n for repo in model.Repo.list():\n self.add_task_for_repo(repo, self.task_name(), self.ACTION)\n\nclass DeleteExpired(ScanForExpired):\n \"\"\"Scan for person records with expiry date thats past.\"\"\"\n ACTION = 'tasks/delete_expired'\n\n def task_name(self):\n return 'delete-expired'\n\n def query(self):\n return model.Person.past_due_records(self.repo)\n\nclass DeleteOld(ScanForExpired):\n \"\"\"Scan for person records with old source dates for expiration.\"\"\"\n ACTION = 'tasks/delete_old'\n\n def task_name(self):\n return 'delete-old'\n\n def query(self):\n return model.Person.potentially_expired_records(self.repo)\n\n\nclass CleanUpInTestMode(utils.BaseHandler):\n \"\"\"If the repository is in \"test mode\", this task deletes all entries older\n than DELETION_AGE_SECONDS (defined below), regardless of their actual\n expiration specification.\n\n We delete entries quickly so that most of the test data does not persist in\n real mode, and to reduce the effect of spam.\n \"\"\"\n repo_required = False\n ACTION = 'tasks/clean_up_in_test_mode'\n\n # Entries older than this age in seconds are deleted in test mode.\n #\n # If you are maintaining a single repository and switching it between test\n # mode (for drills) and real mode (for real crises), you should be sure to\n # switch to real mode within DELETION_AGE_SECONDS after a real crisis\n # occurs, because:\n # - When the crisis happens, the users may be confused and enter real\n # information on the repository, even though it's still in test mode.\n # (All pages show \"test mode\" message, but some users may be still\n # confused.)\n # - If we fail to make the switch in DELETION_AGE_SECONDS, such real\n # entries are deleted.\n # - If we make the switch in DELETION_AGE_SECONDS, such entries are not\n # deleted, and handled as a part of real mode data.\n DELETION_AGE_SECONDS = 24 * 3600\n\n def __init__(self, request, response, env):\n utils.BaseHandler.__init__(self, request, response, env)\n self.__listener = None\n\n def task_name(self):\n return 'clean-up-in-test-mode'\n\n def schedule_next_task(self, cursor, utcnow):\n \"\"\"Schedule the next task for to carry on with this query.\n \"\"\"\n self.add_task_for_repo(\n self.repo,\n self.task_name(),\n self.ACTION,\n utcnow=str(calendar.timegm(utcnow.utctimetuple())),\n cursor=cursor,\n queue_name='clean_up_in_test_mode')\n\n def in_test_mode(self, repo):\n \"\"\"Returns True if the repository is in test mode.\"\"\"\n return config.get('test_mode', repo=repo)\n\n def get(self):\n if self.repo:\n # To reuse the cursor from the previous task, we need to apply\n # exactly the same filter. So we use utcnow previously used\n # instead of the current time.\n utcnow = self.params.utcnow or utils.get_utcnow()\n max_entry_date = (\n utcnow -\n datetime.timedelta(\n seconds=CleanUpInTestMode.DELETION_AGE_SECONDS))\n query = model.Person.all_in_repo(self.repo)\n query.filter('entry_date <=', max_entry_date)\n if self.params.cursor:\n query.with_cursor(self.params.cursor)\n cursor = self.params.cursor\n # Uses query.get() instead of \"for person in query\".\n # If we use for-loop, query.cursor() points to an unexpected\n # position.\n person = query.get()\n # When the repository is no longer in test mode, aborts the\n # deletion.\n try:\n while person and self.in_test_mode(self.repo):\n if self.__listener:\n self.__listener.before_deletion(person.key())\n person.delete_related_entities(delete_self=True)\n cursor = query.cursor()\n person = query.get()\n except runtime.DeadlineExceededError:\n self.schedule_next_task(cursor, utcnow)\n except datastore_errors.Timeout:\n # This exception is sometimes raised, maybe when the query\n # object live too long?\n self.schedule_next_task(cursor, utcnow)\n \n else:\n for repo in model.Repo.list():\n if self.in_test_mode(repo):\n self.add_task_for_repo(repo, self.task_name(), self.ACTION)\n\n def set_listener(self, listener):\n self.__listener = listener\n\n\ndef run_count(make_query, update_counter, counter):\n \"\"\"Scans the entities matching a query up to FETCH_LIMIT.\n \n Returns False if we finished counting all entries.\"\"\"\n # Get the next batch of entities.\n query = make_query()\n if counter.last_key:\n query = query.filter('__key__ >', db.Key(counter.last_key))\n entities = query.order('__key__').fetch(FETCH_LIMIT)\n if not entities:\n counter.last_key = ''\n return False\n\n # Pass the entities to the counting function.\n for entity in entities:\n update_counter(counter, entity)\n\n # Remember where we left off.\n counter.last_key = str(entities[-1].key())\n return True\n\n\nclass CountBase(utils.BaseHandler):\n \"\"\"A base handler for counting tasks. Making a request to this handler\n without a specified repo will start tasks for all repositories in parallel.\n Each subclass of this class handles one scan through the datastore.\"\"\"\n repo_required = False # can run without a repo\n\n SCAN_NAME = '' # Each subclass should choose a unique scan_name.\n ACTION = '' # Each subclass should set the action path that it handles.\n\n def get(self):\n if self.repo: # Do some counting.\n try:\n counter = model.Counter.get_unfinished_or_create(\n self.repo, self.SCAN_NAME)\n entities_remaining = True\n while entities_remaining:\n # Batch the db updates.\n for _ in xrange(100):\n entities_remaining = run_count(\n self.make_query, self.update_counter, counter)\n if not entities_remaining:\n break\n # And put the updates at once.\n counter.put()\n except runtime.DeadlineExceededError:\n # Continue counting in another task.\n self.add_task_for_repo(self.repo, self.SCAN_NAME, self.ACTION)\n else: # Launch counting tasks for all repositories.\n for repo in model.Repo.list():\n self.add_task_for_repo(repo, self.SCAN_NAME, self.ACTION)\n\n def make_query(self):\n \"\"\"Subclasses should implement this. This will be called to get the\n datastore query; it should always return the same query.\"\"\"\n\n def update_counter(self, counter, entity):\n \"\"\"Subclasses should implement this. This will be called once for\n each entity that matches the query; it should call increment() on\n the counter object for whatever accumulators it wants to increment.\"\"\"\n\n\nclass CountPerson(CountBase):\n SCAN_NAME = 'person'\n ACTION = 'tasks/count/person'\n\n def make_query(self):\n return model.Person.all().filter('repo =', self.repo)\n\n def update_counter(self, counter, person):\n found = ''\n if person.latest_found is not None:\n found = person.latest_found and 'TRUE' or 'FALSE'\n\n counter.increment('all')\n counter.increment('original_domain=' + (person.original_domain or ''))\n counter.increment('sex=' + (person.sex or ''))\n counter.increment('home_country=' + (person.home_country or ''))\n counter.increment('photo=' + (person.photo_url and 'present' or ''))\n counter.increment('num_notes=%d' % len(person.get_notes()))\n counter.increment('status=' + (person.latest_status or ''))\n counter.increment('found=' + found)\n if person.author_email: # author e-mail address present?\n counter.increment('author_email')\n if person.author_phone: # author phone number present?\n counter.increment('author_phone')\n counter.increment(\n 'linked_persons=%d' % len(person.get_linked_persons()))\n\n\nclass CountNote(CountBase):\n SCAN_NAME = 'note'\n ACTION = 'tasks/count/note'\n\n def make_query(self):\n return model.Note.all().filter('repo =', self.repo)\n\n def update_counter(self, counter, note):\n author_made_contact = ''\n if note.author_made_contact is not None:\n author_made_contact = note.author_made_contact and 'TRUE' or 'FALSE'\n\n counter.increment('all')\n counter.increment('status=' + (note.status or ''))\n counter.increment('original_domain=' + (note.original_domain or ''))\n counter.increment('author_made_contact=' + author_made_contact)\n if note.last_known_location: # last known location specified?\n counter.increment('last_known_location')\n if note.author_email: # author e-mail address present?\n counter.increment('author_email')\n if note.author_phone: # author phone number present?\n counter.increment('author_phone')\n if note.linked_person_record_id: # linked to another person?\n counter.increment('linked_person')\n\n\nclass AddReviewedProperty(CountBase):\n \"\"\"Sets 'reviewed' to False on all notes that have no 'reviewed' property.\n This task is for migrating datastores that were created before the\n 'reviewed' property existed; 'reviewed' has to be set to False so that\n the Notes will be indexed.\"\"\"\n SCAN_NAME = 'unreview-note'\n ACTION = 'tasks/count/unreview_note'\n\n def make_query(self):\n return model.Note.all().filter('repo =', self.repo)\n\n def update_counter(self, counter, note):\n if not note.reviewed:\n note.reviewed = False\n note.put()\n\n\nclass UpdateDeadStatus(CountBase):\n \"\"\"This task looks for Person records with the status 'believed_dead',\n checks for the last non-hidden Note, and updates the status if necessary.\n This is designed specifically to address bogus 'believed_dead' notes that\n are flagged as spam. (This is a cleanup task, not a counting task.)\"\"\"\n SCAN_NAME = 'update-dead-status'\n ACTION = 'tasks/count/update_dead_status'\n\n def make_query(self):\n return model.Person.all().filter('repo =', self.repo\n ).filter('latest_status =', 'believed_dead')\n\n def update_counter(self, counter, person):\n person.update_latest_status()\n\n\nclass UpdateStatus(CountBase):\n \"\"\"This task scans Person records, looks for the last non-hidden Note, and\n updates latest_status. (This is a cleanup task, not a counting task.)\"\"\"\n SCAN_NAME = 'update-status'\n ACTION = 'tasks/count/update_status'\n\n def make_query(self):\n return model.Person.all().filter('repo =', self.repo)\n\n def update_counter(self, counter, person):\n person.update_latest_status()\n\n\nclass Reindex(CountBase):\n \"\"\"A handler for re-indexing Persons.\"\"\"\n SCAN_NAME = 'reindex'\n ACTION = 'tasks/count/reindex'\n\n def make_query(self):\n return model.Person.all().filter('repo =', self.repo)\n\n def update_counter(self, counter, person):\n person.update_index(['old', 'new'])\n person.put()\n\n\nclass NotifyManyUnreviewedNotes(utils.BaseHandler):\n \"\"\"This task sends email notification when the number of unreviewed notes\n exceeds threshold.\n \"\"\"\n repo_required = False # can run without a repo\n ACTION = 'tasks/notify_many_unreviewed_notes'\n\n def task_name(self):\n return 'notify-bad-review-status'\n\n def get(self):\n if self.repo:\n try:\n count_of_unreviewed_notes = (\n model.Note.get_unreviewed_notes_count(self.repo))\n self._maybe_notify(count_of_unreviewed_notes)\n except runtime.DeadlineExceededError:\n logging.info(\"DeadlineExceededError occurs\")\n self.add_task_for_repo(\n self.repo, self.task_name(), self.ACTION)\n except datastore_errors.Timeout:\n logging.info(\"Timeout occurs in datastore\")\n self.add_task_for_repo(\n self.repo, self.task_name(), self.ACTION)\n else:\n for repo in model.Repo.list():\n self.add_task_for_repo(\n repo, self.task_name(), self.ACTION)\n\n def _subject(self):\n return \"Please review your notes in %(repo_name)s\" % {\n \"repo_name\": self.env.repo,\n }\n\n def _body(self, count_of_unreviewed_notes):\n return \"%(repo_name)s has %(num_unreviewed)s unreviewed notes.\" % {\n \"repo_name\": self.env.repo,\n \"num_unreviewed\": count_of_unreviewed_notes,\n }\n\n def _maybe_notify(self, count_of_unreviewed_notes):\n # TODO(yaboo@): Response should be modified\n if self._should_notify(count_of_unreviewed_notes):\n self.send_mail(self.config.get('notification_email'),\n subject=self._subject(),\n body=self._body(count_of_unreviewed_notes))\n\n def _should_notify(self, count_of_unreviewed_notes):\n if not self.config.get('notification_email'):\n return False\n\n return count_of_unreviewed_notes > self.config.get(\n 'unreviewed_notes_threshold')\n\n\nclass ThumbnailPreparer(utils.BaseHandler):\n \"\"\"A class to run the thumbnail preparation job (for uploaded photos).\"\"\"\n\n repo_required = False\n ACTION = 'tasks/thumbnail_preparer'\n\n def get(self):\n # We don't retry this task automatically, because it's looking for\n # everything that doesn't already have a thumbnail every time --\n # anything that doesn't get done now will be retried anyway on the next\n # iteration of the cron job.\n if self.repo:\n for p in (model.Photo.all()\n .filter('thumbnail_data =', None)\n .filter('repo =', self.repo)):\n photo.set_thumbnail(p)\n else:\n for repo in model.Repo.list():\n self.add_task_for_repo(repo, 'prepare-thumbnails', self.ACTION)\n\n\nclass DumpCSV(utils.BaseHandler):\n \"\"\"Dumps a CSV file containing all the records in each repository to Google\n Cloud Storage.\n \n People with BULK_READ API access can download the CSV file.\n \n Currently the CSV file only contains person records.\n \n This task requires special setup to run on a dev app server. See the\n docstring of cloud_storage.CloudStorage class for instruction.\n \"\"\"\n # TODO(gimite): Include note records in the CSV file.\n\n repo_required = False\n ACTION = 'tasks/dump_csv'\n\n # Lifetime of a single task is 10 min. It stops fetching and starts\n # uploading after 4 min, assuming uploading takes similar time as\n # fetching.\n MAX_FETCH_TIME = datetime.timedelta(minutes=4)\n \n def __init__(self, *args, **kwargs):\n super(DumpCSV, self).__init__(*args, **kwargs)\n self.storage = cloud_storage.CloudStorage()\n\n def task_name(self):\n return 'dump-csv'\n\n def schedule_next_task(self, cursor, timestamp):\n \"\"\"Schedule the next task for to carry on with this query.\n \"\"\"\n self.add_task_for_repo(\n self.repo,\n self.task_name(),\n self.ACTION,\n cursor=cursor,\n timestamp=str(calendar.timegm(timestamp.utctimetuple())))\n\n def get(self):\n if self.repo:\n self.run_task_for_repo(self.repo)\n else:\n # Sets lifetime of objects in Google Cloud Storage to 2 days. This\n # cleans up old CSV files, while it makes sure that it doesn't\n # delete CSV files users are currently downloading. Note that CSV\n # files are updated every 24 hours.\n #\n # The lifetime is applied globally for all objects in the bucket.\n # This is OK because Cloud Storage is only used for CSV files for\n # now. It may need a way to control lifetime per object (see the\n # docstring of cloud_storage.CloudStorage) if it starts using\n # Cloud Storage for other purposes.\n #\n # It is enough to call this only once for the bucket, but here is\n # just a convenient place to call it.\n self.storage.set_objects_lifetime(lifetime_days=2)\n\n for repo in model.Repo.list():\n self.add_task_for_repo(repo, self.task_name(), self.ACTION)\n\n def run_task_for_repo(self, repo):\n start_time = utils.get_utcnow()\n timestamp = self.params.timestamp or start_time\n base_name = '%s-persons-%s' % (\n repo, timestamp.strftime('%Y-%m-%d-%H%M%S'))\n is_first = not self.params.cursor\n\n query = model.Person.all_in_repo(repo).order('entry_date')\n if self.params.cursor:\n query.with_cursor(self.params.cursor)\n\n csv_io = StringIO.StringIO()\n writer = record_writer.PersonCsvWriter(csv_io, write_header=is_first)\n\n has_data = False\n scan_completed = False\n while True:\n persons = query.fetch(limit=FETCH_LIMIT)\n if persons:\n has_data = True\n else:\n scan_completed = True\n break\n records = [PFIF.person_to_dict(person) for person in persons]\n # So far it only supports dump of records without sensitive fields.\n utils.filter_sensitive_fields(records)\n writer.write(records)\n if utils.get_utcnow() >= start_time + self.MAX_FETCH_TIME:\n break\n query.with_cursor(query.cursor())\n\n final_csv_name = '%s.csv' % base_name\n temp_csv_name = '%s.temp.csv' % base_name\n\n if is_first:\n self.storage.insert_object(\n final_csv_name, 'text/csv', csv_io.getvalue())\n elif has_data:\n # Creates a temporary CSV file with new records, and append it to\n # the final CSV file.\n self.storage.insert_object(\n temp_csv_name, 'text/csv', csv_io.getvalue())\n self.storage.compose_objects(\n [final_csv_name, temp_csv_name], final_csv_name, 'text/csv')\n\n if scan_completed:\n config.set_for_repo(repo, latest_csv_object_name=final_csv_name)\n else:\n self.schedule_next_task(query.cursor(), timestamp)\n","path":"app/tasks.py"}],"string":"[\n {\n \"content\": \"#!/usr/bin/python2.7\\n# Copyright 2010 Google Inc.\\n#\\n# Licensed under the Apache License, Version 2.0 (the \\\"License\\\");\\n# you may not use this file except in compliance with the License.\\n# You may obtain a copy of the License at\\n#\\n# http://www.apache.org/licenses/LICENSE-2.0\\n#\\n# Unless required by applicable law or agreed to in writing, software\\n# distributed under the License is distributed on an \\\"AS IS\\\" BASIS,\\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\\n# See the License for the specific language governing permissions and\\n# limitations under the License.\\n\\nimport calendar\\nimport datetime\\nimport logging\\nimport time\\nimport StringIO\\n\\nfrom google.appengine import runtime\\nfrom google.appengine.api import datastore_errors\\nfrom google.appengine.api import quota\\nfrom google.appengine.api import taskqueue\\nfrom google.appengine.ext import db\\n\\nimport cloud_storage\\nimport config\\nimport const\\nimport delete\\nimport model\\nimport photo\\nimport pfif\\nimport record_writer\\nimport utils\\n\\n\\nCPU_MEGACYCLES_PER_REQUEST = 1000\\nEXPIRED_TTL = datetime.timedelta(delete.EXPIRED_TTL_DAYS, 0, 0)\\nFETCH_LIMIT = 100\\nPFIF = pfif.PFIF_VERSIONS[pfif.PFIF_DEFAULT_VERSION]\\n\\n\\nclass ScanForExpired(utils.BaseHandler):\\n \\\"\\\"\\\"Common logic for scanning the Person table looking for things to delete.\\n\\n The common logic handles iterating through the query, updating the expiry\\n date and wiping/deleting as needed. The is_expired flag on all records whose\\n expiry_date has passed. Records that expired more than EXPIRED_TTL in the\\n past will also have their data fields, notes, and photos permanently\\n deleted.\\n\\n Subclasses set the query and task_name.\\\"\\\"\\\"\\n repo_required = False\\n\\n def task_name(self):\\n \\\"\\\"\\\"Subclasses should implement this.\\\"\\\"\\\"\\n pass\\n\\n def query(self):\\n \\\"\\\"\\\"Subclasses should implement this.\\\"\\\"\\\"\\n pass\\n\\n def schedule_next_task(self, cursor):\\n \\\"\\\"\\\"Schedule the next task for to carry on with this query.\\n \\\"\\\"\\\"\\n self.add_task_for_repo(self.repo, self.task_name(), self.ACTION,\\n cursor=cursor, queue_name='expiry')\\n\\n def get(self):\\n if self.repo:\\n query = self.query()\\n if self.params.cursor:\\n query.with_cursor(self.params.cursor)\\n cursor = self.params.cursor\\n try:\\n for person in query:\\n # query.cursor() returns a cursor which returns the entity\\n # next to this \\\"person\\\" as the first result.\\n next_cursor = query.cursor()\\n was_expired = person.is_expired\\n person.put_expiry_flags()\\n if (utils.get_utcnow() - person.get_effective_expiry_date()\\n > EXPIRED_TTL):\\n person.wipe_contents()\\n else:\\n # treat this as a regular deletion.\\n if person.is_expired and not was_expired:\\n delete.delete_person(self, person)\\n cursor = next_cursor\\n except runtime.DeadlineExceededError:\\n self.schedule_next_task(cursor)\\n except datastore_errors.Timeout:\\n # This exception is sometimes raised, maybe when the query\\n # object live too long?\\n self.schedule_next_task(cursor)\\n else:\\n for repo in model.Repo.list():\\n self.add_task_for_repo(repo, self.task_name(), self.ACTION)\\n\\nclass DeleteExpired(ScanForExpired):\\n \\\"\\\"\\\"Scan for person records with expiry date thats past.\\\"\\\"\\\"\\n ACTION = 'tasks/delete_expired'\\n\\n def task_name(self):\\n return 'delete-expired'\\n\\n def query(self):\\n return model.Person.past_due_records(self.repo)\\n\\nclass DeleteOld(ScanForExpired):\\n \\\"\\\"\\\"Scan for person records with old source dates for expiration.\\\"\\\"\\\"\\n ACTION = 'tasks/delete_old'\\n\\n def task_name(self):\\n return 'delete-old'\\n\\n def query(self):\\n return model.Person.potentially_expired_records(self.repo)\\n\\n\\nclass CleanUpInTestMode(utils.BaseHandler):\\n \\\"\\\"\\\"If the repository is in \\\"test mode\\\", this task deletes all entries older\\n than DELETION_AGE_SECONDS (defined below), regardless of their actual\\n expiration specification.\\n\\n We delete entries quickly so that most of the test data does not persist in\\n real mode, and to reduce the effect of spam.\\n \\\"\\\"\\\"\\n repo_required = False\\n ACTION = 'tasks/clean_up_in_test_mode'\\n\\n # Entries older than this age in seconds are deleted in test mode.\\n #\\n # If you are maintaining a single repository and switching it between test\\n # mode (for drills) and real mode (for real crises), you should be sure to\\n # switch to real mode within DELETION_AGE_SECONDS after a real crisis\\n # occurs, because:\\n # - When the crisis happens, the users may be confused and enter real\\n # information on the repository, even though it's still in test mode.\\n # (All pages show \\\"test mode\\\" message, but some users may be still\\n # confused.)\\n # - If we fail to make the switch in DELETION_AGE_SECONDS, such real\\n # entries are deleted.\\n # - If we make the switch in DELETION_AGE_SECONDS, such entries are not\\n # deleted, and handled as a part of real mode data.\\n DELETION_AGE_SECONDS = 24 * 3600\\n\\n def __init__(self, request, response, env):\\n utils.BaseHandler.__init__(self, request, response, env)\\n self.__listener = None\\n\\n def task_name(self):\\n return 'clean-up-in-test-mode'\\n\\n def schedule_next_task(self, cursor, utcnow):\\n \\\"\\\"\\\"Schedule the next task for to carry on with this query.\\n \\\"\\\"\\\"\\n self.add_task_for_repo(\\n self.repo,\\n self.task_name(),\\n self.ACTION,\\n utcnow=str(calendar.timegm(utcnow.utctimetuple())),\\n cursor=cursor,\\n queue_name='clean_up_in_test_mode')\\n\\n def in_test_mode(self, repo):\\n \\\"\\\"\\\"Returns True if the repository is in test mode.\\\"\\\"\\\"\\n return config.get('test_mode', repo=repo)\\n\\n def get(self):\\n if self.repo:\\n # To reuse the cursor from the previous task, we need to apply\\n # exactly the same filter. So we use utcnow previously used\\n # instead of the current time.\\n utcnow = self.params.utcnow or utils.get_utcnow()\\n max_entry_date = (\\n utcnow -\\n datetime.timedelta(\\n seconds=CleanUpInTestMode.DELETION_AGE_SECONDS))\\n query = model.Person.all_in_repo(self.repo)\\n query.filter('entry_date <=', max_entry_date)\\n if self.params.cursor:\\n query.with_cursor(self.params.cursor)\\n cursor = self.params.cursor\\n # Uses query.get() instead of \\\"for person in query\\\".\\n # If we use for-loop, query.cursor() points to an unexpected\\n # position.\\n person = query.get()\\n # When the repository is no longer in test mode, aborts the\\n # deletion.\\n try:\\n while person and self.in_test_mode(self.repo):\\n if self.__listener:\\n self.__listener.before_deletion(person.key())\\n person.delete_related_entities(delete_self=True)\\n cursor = query.cursor()\\n person = query.get()\\n except runtime.DeadlineExceededError:\\n self.schedule_next_task(cursor, utcnow)\\n except datastore_errors.Timeout:\\n # This exception is sometimes raised, maybe when the query\\n # object live too long?\\n self.schedule_next_task(cursor, utcnow)\\n \\n else:\\n for repo in model.Repo.list():\\n if self.in_test_mode(repo):\\n self.add_task_for_repo(repo, self.task_name(), self.ACTION)\\n\\n def set_listener(self, listener):\\n self.__listener = listener\\n\\n\\ndef run_count(make_query, update_counter, counter):\\n \\\"\\\"\\\"Scans the entities matching a query up to FETCH_LIMIT.\\n \\n Returns False if we finished counting all entries.\\\"\\\"\\\"\\n # Get the next batch of entities.\\n query = make_query()\\n if counter.last_key:\\n query = query.filter('__key__ >', db.Key(counter.last_key))\\n entities = query.order('__key__').fetch(FETCH_LIMIT)\\n if not entities:\\n counter.last_key = ''\\n return False\\n\\n # Pass the entities to the counting function.\\n for entity in entities:\\n update_counter(counter, entity)\\n\\n # Remember where we left off.\\n counter.last_key = str(entities[-1].key())\\n return True\\n\\n\\nclass CountBase(utils.BaseHandler):\\n \\\"\\\"\\\"A base handler for counting tasks. Making a request to this handler\\n without a specified repo will start tasks for all repositories in parallel.\\n Each subclass of this class handles one scan through the datastore.\\\"\\\"\\\"\\n repo_required = False # can run without a repo\\n\\n SCAN_NAME = '' # Each subclass should choose a unique scan_name.\\n ACTION = '' # Each subclass should set the action path that it handles.\\n\\n def get(self):\\n if self.repo: # Do some counting.\\n try:\\n counter = model.Counter.get_unfinished_or_create(\\n self.repo, self.SCAN_NAME)\\n entities_remaining = True\\n while entities_remaining:\\n # Batch the db updates.\\n for _ in xrange(100):\\n entities_remaining = run_count(\\n self.make_query, self.update_counter, counter)\\n if not entities_remaining:\\n break\\n # And put the updates at once.\\n counter.put()\\n except runtime.DeadlineExceededError:\\n # Continue counting in another task.\\n self.add_task_for_repo(self.repo, self.SCAN_NAME, self.ACTION)\\n else: # Launch counting tasks for all repositories.\\n for repo in model.Repo.list():\\n self.add_task_for_repo(repo, self.SCAN_NAME, self.ACTION)\\n\\n def make_query(self):\\n \\\"\\\"\\\"Subclasses should implement this. This will be called to get the\\n datastore query; it should always return the same query.\\\"\\\"\\\"\\n\\n def update_counter(self, counter, entity):\\n \\\"\\\"\\\"Subclasses should implement this. This will be called once for\\n each entity that matches the query; it should call increment() on\\n the counter object for whatever accumulators it wants to increment.\\\"\\\"\\\"\\n\\n\\nclass CountPerson(CountBase):\\n SCAN_NAME = 'person'\\n ACTION = 'tasks/count/person'\\n\\n def make_query(self):\\n return model.Person.all().filter('repo =', self.repo)\\n\\n def update_counter(self, counter, person):\\n found = ''\\n if person.latest_found is not None:\\n found = person.latest_found and 'TRUE' or 'FALSE'\\n\\n counter.increment('all')\\n counter.increment('original_domain=' + (person.original_domain or ''))\\n counter.increment('sex=' + (person.sex or ''))\\n counter.increment('home_country=' + (person.home_country or ''))\\n counter.increment('photo=' + (person.photo_url and 'present' or ''))\\n counter.increment('num_notes=%d' % len(person.get_notes()))\\n counter.increment('status=' + (person.latest_status or ''))\\n counter.increment('found=' + found)\\n if person.author_email: # author e-mail address present?\\n counter.increment('author_email')\\n if person.author_phone: # author phone number present?\\n counter.increment('author_phone')\\n counter.increment(\\n 'linked_persons=%d' % len(person.get_linked_persons()))\\n\\n\\nclass CountNote(CountBase):\\n SCAN_NAME = 'note'\\n ACTION = 'tasks/count/note'\\n\\n def make_query(self):\\n return model.Note.all().filter('repo =', self.repo)\\n\\n def update_counter(self, counter, note):\\n author_made_contact = ''\\n if note.author_made_contact is not None:\\n author_made_contact = note.author_made_contact and 'TRUE' or 'FALSE'\\n\\n counter.increment('all')\\n counter.increment('status=' + (note.status or ''))\\n counter.increment('original_domain=' + (note.original_domain or ''))\\n counter.increment('author_made_contact=' + author_made_contact)\\n if note.last_known_location: # last known location specified?\\n counter.increment('last_known_location')\\n if note.author_email: # author e-mail address present?\\n counter.increment('author_email')\\n if note.author_phone: # author phone number present?\\n counter.increment('author_phone')\\n if note.linked_person_record_id: # linked to another person?\\n counter.increment('linked_person')\\n\\n\\nclass AddReviewedProperty(CountBase):\\n \\\"\\\"\\\"Sets 'reviewed' to False on all notes that have no 'reviewed' property.\\n This task is for migrating datastores that were created before the\\n 'reviewed' property existed; 'reviewed' has to be set to False so that\\n the Notes will be indexed.\\\"\\\"\\\"\\n SCAN_NAME = 'unreview-note'\\n ACTION = 'tasks/count/unreview_note'\\n\\n def make_query(self):\\n return model.Note.all().filter('repo =', self.repo)\\n\\n def update_counter(self, counter, note):\\n if not note.reviewed:\\n note.reviewed = False\\n note.put()\\n\\n\\nclass UpdateDeadStatus(CountBase):\\n \\\"\\\"\\\"This task looks for Person records with the status 'believed_dead',\\n checks for the last non-hidden Note, and updates the status if necessary.\\n This is designed specifically to address bogus 'believed_dead' notes that\\n are flagged as spam. (This is a cleanup task, not a counting task.)\\\"\\\"\\\"\\n SCAN_NAME = 'update-dead-status'\\n ACTION = 'tasks/count/update_dead_status'\\n\\n def make_query(self):\\n return model.Person.all().filter('repo =', self.repo\\n ).filter('latest_status =', 'believed_dead')\\n\\n def update_counter(self, counter, person):\\n person.update_latest_status()\\n\\n\\nclass UpdateStatus(CountBase):\\n \\\"\\\"\\\"This task scans Person records, looks for the last non-hidden Note, and\\n updates latest_status. (This is a cleanup task, not a counting task.)\\\"\\\"\\\"\\n SCAN_NAME = 'update-status'\\n ACTION = 'tasks/count/update_status'\\n\\n def make_query(self):\\n return model.Person.all().filter('repo =', self.repo)\\n\\n def update_counter(self, counter, person):\\n person.update_latest_status()\\n\\n\\nclass Reindex(CountBase):\\n \\\"\\\"\\\"A handler for re-indexing Persons.\\\"\\\"\\\"\\n SCAN_NAME = 'reindex'\\n ACTION = 'tasks/count/reindex'\\n\\n def make_query(self):\\n return model.Person.all().filter('repo =', self.repo)\\n\\n def update_counter(self, counter, person):\\n person.update_index(['old', 'new'])\\n person.put()\\n\\n\\nclass NotifyManyUnreviewedNotes(utils.BaseHandler):\\n \\\"\\\"\\\"This task sends email notification when the number of unreviewed notes\\n exceeds threshold.\\n \\\"\\\"\\\"\\n repo_required = False # can run without a repo\\n ACTION = 'tasks/notify_many_unreviewed_notes'\\n\\n def task_name(self):\\n return 'notify-bad-review-status'\\n\\n def get(self):\\n if self.repo:\\n try:\\n count_of_unreviewed_notes = (\\n model.Note.get_unreviewed_notes_count(self.repo))\\n self._maybe_notify(count_of_unreviewed_notes)\\n except runtime.DeadlineExceededError:\\n logging.info(\\\"DeadlineExceededError occurs\\\")\\n self.add_task_for_repo(\\n self.repo, self.task_name(), self.ACTION)\\n except datastore_errors.Timeout:\\n logging.info(\\\"Timeout occurs in datastore\\\")\\n self.add_task_for_repo(\\n self.repo, self.task_name(), self.ACTION)\\n else:\\n for repo in model.Repo.list():\\n self.add_task_for_repo(\\n repo, self.task_name(), self.ACTION)\\n\\n def _subject(self):\\n return \\\"Please review your notes in %(repo_name)s\\\" % {\\n \\\"repo_name\\\": self.env.repo,\\n }\\n\\n def _body(self, count_of_unreviewed_notes):\\n return \\\"%(repo_name)s has %(num_unreviewed)s unreviewed notes.\\\" % {\\n \\\"repo_name\\\": self.env.repo,\\n \\\"num_unreviewed\\\": count_of_unreviewed_notes,\\n }\\n\\n def _maybe_notify(self, count_of_unreviewed_notes):\\n # TODO(yaboo@): Response should be modified\\n if self._should_notify(count_of_unreviewed_notes):\\n self.send_mail(self.config.get('notification_email'),\\n subject=self._subject(),\\n body=self._body(count_of_unreviewed_notes))\\n\\n def _should_notify(self, count_of_unreviewed_notes):\\n if not self.config.get('notification_email'):\\n return False\\n\\n return count_of_unreviewed_notes > self.config.get(\\n 'unreviewed_notes_threshold')\\n\\n\\nclass ThumbnailPreparer(utils.BaseHandler):\\n \\\"\\\"\\\"A class to run the thumbnail preparation job (for uploaded photos).\\\"\\\"\\\"\\n\\n repo_required = False\\n ACTION = 'tasks/thumbnail_preparer'\\n\\n def get(self):\\n # We don't retry this task automatically, because it's looking for\\n # everything that doesn't already have a thumbnail every time --\\n # anything that doesn't get done now will be retried anyway on the next\\n # iteration of the cron job.\\n if self.repo:\\n for p in (model.Photo.all()\\n .filter('thumbnail_data =', None)\\n .filter('repo =', self.repo)):\\n photo.set_thumbnail(p)\\n else:\\n for repo in model.Repo.list():\\n self.add_task_for_repo(repo, 'prepare-thumbnails', self.ACTION)\\n\\n\\nclass DumpCSV(utils.BaseHandler):\\n \\\"\\\"\\\"Dumps a CSV file containing all the records in each repository to Google\\n Cloud Storage.\\n \\n People with BULK_READ API access can download the CSV file.\\n \\n Currently the CSV file only contains person records.\\n \\n This task requires special setup to run on a dev app server. See the\\n docstring of cloud_storage.CloudStorage class for instruction.\\n \\\"\\\"\\\"\\n # TODO(gimite): Include note records in the CSV file.\\n\\n repo_required = False\\n ACTION = 'tasks/dump_csv'\\n\\n # Lifetime of a single task is 10 min. It stops fetching and starts\\n # uploading after 4 min, assuming uploading takes similar time as\\n # fetching.\\n MAX_FETCH_TIME = datetime.timedelta(minutes=4)\\n \\n def __init__(self, *args, **kwargs):\\n super(DumpCSV, self).__init__(*args, **kwargs)\\n self.storage = cloud_storage.CloudStorage()\\n\\n def task_name(self):\\n return 'dump-csv'\\n\\n def schedule_next_task(self, cursor, timestamp):\\n \\\"\\\"\\\"Schedule the next task for to carry on with this query.\\n \\\"\\\"\\\"\\n self.add_task_for_repo(\\n self.repo,\\n self.task_name(),\\n self.ACTION,\\n cursor=cursor,\\n timestamp=str(calendar.timegm(timestamp.utctimetuple())))\\n\\n def get(self):\\n if self.repo:\\n self.run_task_for_repo(self.repo)\\n else:\\n # Sets lifetime of objects in Google Cloud Storage to 2 days. This\\n # cleans up old CSV files, while it makes sure that it doesn't\\n # delete CSV files users are currently downloading. Note that CSV\\n # files are updated every 24 hours.\\n #\\n # The lifetime is applied globally for all objects in the bucket.\\n # This is OK because Cloud Storage is only used for CSV files for\\n # now. It may need a way to control lifetime per object (see the\\n # docstring of cloud_storage.CloudStorage) if it starts using\\n # Cloud Storage for other purposes.\\n #\\n # It is enough to call this only once for the bucket, but here is\\n # just a convenient place to call it.\\n self.storage.set_objects_lifetime(lifetime_days=2)\\n\\n for repo in model.Repo.list():\\n self.add_task_for_repo(repo, self.task_name(), self.ACTION)\\n\\n def run_task_for_repo(self, repo):\\n start_time = utils.get_utcnow()\\n timestamp = self.params.timestamp or start_time\\n base_name = '%s-persons-%s' % (\\n repo, timestamp.strftime('%Y-%m-%d-%H%M%S'))\\n is_first = not self.params.cursor\\n\\n query = model.Person.all_in_repo(repo).order('entry_date')\\n if self.params.cursor:\\n query.with_cursor(self.params.cursor)\\n\\n csv_io = StringIO.StringIO()\\n writer = record_writer.PersonCsvWriter(csv_io, write_header=is_first)\\n\\n has_data = False\\n scan_completed = False\\n while True:\\n persons = query.fetch(limit=FETCH_LIMIT)\\n if persons:\\n has_data = True\\n else:\\n scan_completed = True\\n break\\n records = [PFIF.person_to_dict(person) for person in persons]\\n # So far it only supports dump of records without sensitive fields.\\n utils.filter_sensitive_fields(records)\\n writer.write(records)\\n if utils.get_utcnow() >= start_time + self.MAX_FETCH_TIME:\\n break\\n query.with_cursor(query.cursor())\\n\\n final_csv_name = '%s.csv' % base_name\\n temp_csv_name = '%s.temp.csv' % base_name\\n\\n if is_first:\\n self.storage.insert_object(\\n final_csv_name, 'text/csv', csv_io.getvalue())\\n elif has_data:\\n # Creates a temporary CSV file with new records, and append it to\\n # the final CSV file.\\n self.storage.insert_object(\\n temp_csv_name, 'text/csv', csv_io.getvalue())\\n self.storage.compose_objects(\\n [final_csv_name, temp_csv_name], final_csv_name, 'text/csv')\\n\\n if scan_completed:\\n config.set_for_repo(repo, latest_csv_object_name=final_csv_name)\\n else:\\n self.schedule_next_task(query.cursor(), timestamp)\\n\",\n \"path\": \"app/tasks.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"#!/usr/bin/python2.7\n# Copyright 2010 Google Inc.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport calendar\nimport datetime\nimport logging\nimport time\nimport StringIO\n\nfrom google.appengine import runtime\nfrom google.appengine.api import datastore_errors\nfrom google.appengine.api import quota\nfrom google.appengine.api import taskqueue\nfrom google.appengine.ext import db\n\nimport cloud_storage\nimport config\nimport const\nimport delete\nimport model\nimport photo\nimport pfif\nimport record_writer\nimport utils\n\n\nCPU_MEGACYCLES_PER_REQUEST = 1000\nEXPIRED_TTL = datetime.timedelta(delete.EXPIRED_TTL_DAYS, 0, 0)\nFETCH_LIMIT = 100\nPFIF = pfif.PFIF_VERSIONS[pfif.PFIF_DEFAULT_VERSION]\n\n\nclass ScanForExpired(utils.BaseHandler):\n \"\"\"Common logic for scanning the Person table looking for things to delete.\n\n The common logic handles iterating through the query, updating the expiry\n date and wiping/deleting as needed. The is_expired flag on all records whose\n expiry_date has passed. Records that expired more than EXPIRED_TTL in the\n past will also have their data fields, notes, and photos permanently\n deleted.\n\n Subclasses set the query and task_name.\"\"\"\n repo_required = False\n\n def task_name(self):\n \"\"\"Subclasses should implement this.\"\"\"\n pass\n\n def query(self):\n \"\"\"Subclasses should implement this.\"\"\"\n pass\n\n def schedule_next_task(self, cursor):\n \"\"\"Schedule the next task for to carry on with this query.\n \"\"\"\n self.add_task_for_repo(self.repo, self.task_name(), self.ACTION,\n cursor=cursor, queue_name='expiry')\n\n def get(self):\n if self.repo:\n query = self.query()\n if self.params.cursor:\n query.with_cursor(self.params.cursor)\n cursor = self.params.cursor\n try:\n for person in query:\n # query.cursor() returns a cursor which returns the entity\n # next to this \"person\" as the first result.\n next_cursor = query.cursor()\n was_expired = person.is_expired\n person.put_expiry_flags()\n if (utils.get_utcnow() - person.get_effective_expiry_date()\n > EXPIRED_TTL):\n person.wipe_contents()\n else:\n # treat this as a regular deletion.\n if person.is_expired and not was_expired:\n delete.delete_person(self, person)\n cursor = next_cursor\n except runtime.DeadlineExceededError:\n self.schedule_next_task(cursor)\n except datastore_errors.Timeout:\n # This exception is sometimes raised, maybe when the query\n # object live too long?\n self.schedule_next_task(cursor)\n else:\n for repo in model.Repo.list():\n self.add_task_for_repo(repo, self.task_name(), self.ACTION)\n\nclass DeleteExpired(ScanForExpired):\n \"\"\"Scan for person records with expiry date thats past.\"\"\"\n ACTION = 'tasks/delete_expired'\n\n def task_name(self):\n return 'delete-expired'\n\n def query(self):\n return model.Person.past_due_records(self.repo)\n\nclass DeleteOld(ScanForExpired):\n \"\"\"Scan for person records with old source dates for expiration.\"\"\"\n ACTION = 'tasks/delete_old'\n\n def task_name(self):\n return 'delete-old'\n\n def query(self):\n return model.Person.potentially_expired_records(self.repo)\n\n\nclass CleanUpInTestMode(utils.BaseHandler):\n \"\"\"If the repository is in \"test mode\", this task deletes all entries older\n than DELETION_AGE_SECONDS (defined below), regardless of their actual\n expiration specification.\n\n We delete entries quickly so that most of the test data does not persist in\n real mode, and to reduce the effect of spam.\n \"\"\"\n repo_required = False\n ACTION = 'tasks/clean_up_in_test_mode'\n\n # Entries older than this age in seconds are deleted in test mode.\n #\n # If you are maintaining a single repository and switching it between test\n # mode (for drills) and real mode (for real crises), you should be sure to\n # switch to real mode within DELETION_AGE_SECONDS after a real crisis\n # occurs, because:\n # - When the crisis happens, the users may be confused and enter real\n # information on the repository, even though it's still in test mode.\n # (All pages show \"test mode\" message, but some users may be still\n # confused.)\n # - If we fail to make the switch in DELETION_AGE_SECONDS, such real\n # entries are deleted.\n # - If we make the switch in DELETION_AGE_SECONDS, such entries are not\n # deleted, and handled as a part of real mode data.\n DELETION_AGE_SECONDS = 24 * 3600\n\n def __init__(self, request, response, env):\n utils.BaseHandler.__init__(self, request, response, env)\n self.__listener = None\n\n def task_name(self):\n return 'clean-up-in-test-mode'\n\n def schedule_next_task(self, cursor, utcnow):\n \"\"\"Schedule the next task for to carry on with this query.\n \"\"\"\n self.add_task_for_repo(\n self.repo,\n self.task_name(),\n self.ACTION,\n utcnow=str(calendar.timegm(utcnow.utctimetuple())),\n cursor=cursor,\n queue_name='clean_up_in_test_mode')\n\n def in_test_mode(self, repo):\n \"\"\"Returns True if the repository is in test mode.\"\"\"\n return config.get('test_mode', repo=repo)\n\n def get(self):\n if self.repo:\n # To reuse the cursor from the previous task, we need to apply\n # exactly the same filter. So we use utcnow previously used\n # instead of the current time.\n utcnow = self.params.utcnow or utils.get_utcnow()\n max_entry_date = (\n utcnow -\n datetime.timedelta(\n seconds=CleanUpInTestMode.DELETION_AGE_SECONDS))\n query = model.Person.all_in_repo(self.repo)\n query.filter('entry_date <=', max_entry_date)\n if self.params.cursor:\n query.with_cursor(self.params.cursor)\n cursor = self.params.cursor\n # Uses query.get() instead of \"for person in query\".\n # If we use for-loop, query.cursor() points to an unexpected\n # position.\n person = query.get()\n # When the repository is no longer in test mode, aborts the\n # deletion.\n try:\n while person and self.in_test_mode(self.repo):\n if self.__listener:\n self.__listener.before_deletion(person.key())\n person.delete_related_entities(delete_self=True)\n cursor = query.cursor()\n person = query.get()\n except runtime.DeadlineExceededError:\n self.schedule_next_task(cursor, utcnow)\n except datastore_errors.Timeout:\n # This exception is sometimes raised, maybe when the query\n # object live too long?\n self.schedule_next_task(cursor, utcnow)\n \n else:\n for repo in model.Repo.list():\n if self.in_test_mode(repo):\n self.add_task_for_repo(repo, self.task_name(), self.ACTION)\n\n def set_listener(self, listener):\n self.__listener = listener\n\n\ndef run_count(make_query, update_counter, counter):\n \"\"\"Scans the entities matching a query up to FETCH_LIMIT.\n \n Returns False if we finished counting all entries.\"\"\"\n # Get the next batch of entities.\n query = make_query()\n if counter.last_key:\n query = query.filter('__key__ >', db.Key(counter.last_key))\n entities = query.order('__key__').fetch(FETCH_LIMIT)\n if not entities:\n counter.last_key = ''\n return False\n\n # Pass the entities to the counting function.\n for entity in entities:\n update_counter(counter, entity)\n\n # Remember where we left off.\n counter.last_key = str(entities[-1].key())\n return True\n\n\nclass CountBase(utils.BaseHandler):\n \"\"\"A base handler for counting tasks. Making a request to this handler\n without a specified repo will start tasks for all repositories in parallel.\n Each subclass of this class handles one scan through the datastore.\"\"\"\n repo_required = False # can run without a repo\n\n SCAN_NAME = '' # Each subclass should choose a unique scan_name.\n ACTION = '' # Each subclass should set the action path that it handles.\n\n def get(self):\n if self.repo: # Do some counting.\n try:\n counter = model.Counter.get_unfinished_or_create(\n self.repo, self.SCAN_NAME)\n entities_remaining = True\n while entities_remaining:\n # Batch the db updates.\n for _ in xrange(100):\n entities_remaining = run_count(\n self.make_query, self.update_counter, counter)\n if not entities_remaining:\n break\n # And put the updates at once.\n counter.put()\n except runtime.DeadlineExceededError:\n # Continue counting in another task.\n self.add_task_for_repo(self.repo, self.SCAN_NAME, self.ACTION)\n else: # Launch counting tasks for all repositories.\n for repo in model.Repo.list():\n self.add_task_for_repo(repo, self.SCAN_NAME, self.ACTION)\n\n def make_query(self):\n \"\"\"Subclasses should implement this. This will be called to get the\n datastore query; it should always return the same query.\"\"\"\n\n def update_counter(self, counter, entity):\n \"\"\"Subclasses should implement this. This will be called once for\n each entity that matches the query; it should call increment() on\n the counter object for whatever accumulators it wants to increment.\"\"\"\n\n\nclass CountPerson(CountBase):\n SCAN_NAME = 'person'\n ACTION = 'tasks/count/person'\n\n def make_query(self):\n return model.Person.all().filter('repo =', self.repo)\n\n def update_counter(self, counter, person):\n found = ''\n if person.latest_found is not None:\n found = person.latest_found and 'TRUE' or 'FALSE'\n\n counter.increment('all')\n counter.increment('original_domain=' + (person.original_domain or ''))\n counter.increment('sex=' + (person.sex or ''))\n counter.increment('home_country=' + (person.home_country or ''))\n counter.increment('photo=' + (person.photo_url and 'present' or ''))\n counter.increment('num_notes=%d' % len(person.get_notes()))\n counter.increment('status=' + (person.latest_status or ''))\n counter.increment('found=' + found)\n if person.author_email: # author e-mail address present?\n counter.increment('author_email')\n if person.author_phone: # author phone number present?\n counter.increment('author_phone')\n counter.increment(\n 'linked_persons=%d' % len(person.get_linked_persons()))\n\n\nclass CountNote(CountBase):\n SCAN_NAME = 'note'\n ACTION = 'tasks/count/note'\n\n def make_query(self):\n return model.Note.all().filter('repo =', self.repo)\n\n def update_counter(self, counter, note):\n author_made_contact = ''\n if note.author_made_contact is not None:\n author_made_contact = note.author_made_contact and 'TRUE' or 'FALSE'\n\n counter.increment('all')\n counter.increment('status=' + (note.status or ''))\n counter.increment('original_domain=' + (note.original_domain or ''))\n counter.increment('author_made_contact=' + author_made_contact)\n if note.last_known_location: # last known location specified?\n counter.increment('last_known_location')\n if note.author_email: # author e-mail address present?\n counter.increment('author_email')\n if note.author_phone: # author phone number present?\n counter.increment('author_phone')\n if note.linked_person_record_id: # linked to another person?\n counter.increment('linked_person')\n\n\nclass AddReviewedProperty(CountBase):\n \"\"\"Sets 'reviewed' to False on all notes that have no 'reviewed' property.\n This task is for migrating datastores that were created before the\n 'reviewed' property existed; 'reviewed' has to be set to False so that\n the Notes will be indexed.\"\"\"\n SCAN_NAME = 'unreview-note'\n ACTION = 'tasks/count/unreview_note'\n\n def make_query(self):\n return model.Note.all().filter('repo =', self.repo)\n\n def update_counter(self, counter, note):\n if not note.reviewed:\n note.reviewed = False\n note.put()\n\n\nclass UpdateDeadStatus(CountBase):\n \"\"\"This task looks for Person records with the status 'believed_dead',\n checks for the last non-hidden Note, and updates the status if necessary.\n This is designed specifically to address bogus 'believed_dead' notes that\n are flagged as spam. (This is a cleanup task, not a counting task.)\"\"\"\n SCAN_NAME = 'update-dead-status'\n ACTION = 'tasks/count/update_dead_status'\n\n def make_query(self):\n return model.Person.all().filter('repo =', self.repo\n ).filter('latest_status =', 'believed_dead')\n\n def update_counter(self, counter, person):\n person.update_latest_status()\n\n\nclass UpdateStatus(CountBase):\n \"\"\"This task scans Person records, looks for the last non-hidden Note, and\n updates latest_status. (This is a cleanup task, not a counting task.)\"\"\"\n SCAN_NAME = 'update-status'\n ACTION = 'tasks/count/update_status'\n\n def make_query(self):\n return model.Person.all().filter('repo =', self.repo)\n\n def update_counter(self, counter, person):\n person.update_latest_status()\n\n\nclass Reindex(CountBase):\n \"\"\"A handler for re-indexing Persons.\"\"\"\n SCAN_NAME = 'reindex'\n ACTION = 'tasks/count/reindex'\n\n def make_query(self):\n return model.Person.all().filter('repo =', self.repo)\n\n def update_counter(self, counter, person):\n person.update_index(['old', 'new'])\n person.put()\n\n\nclass NotifyManyUnreviewedNotes(utils.BaseHandler):\n \"\"\"This task sends email notification when the number of unreviewed notes\n exceeds threshold.\n \"\"\"\n repo_required = False # can run without a repo\n ACTION = 'tasks/notify_many_unreviewed_notes'\n\n def task_name(self):\n return 'notify-bad-review-status'\n\n def get(self):\n if self.repo:\n try:\n count_of_unreviewed_notes = (\n model.Note.get_unreviewed_notes_count(self.repo))\n self._maybe_notify(count_of_unreviewed_notes)\n except runtime.DeadlineExceededError:\n logging.info(\"DeadlineExceededError occurs\")\n self.add_task_for_repo(\n self.repo, self.task_name(), self.ACTION)\n except datastore_errors.Timeout:\n logging.info(\"Timeout occurs in datastore\")\n self.add_task_for_repo(\n self.repo, self.task_name(), self.ACTION)\n else:\n for repo in model.Repo.list():\n self.add_task_for_repo(\n repo, self.task_name(), self.ACTION)\n\n def _subject(self):\n return \"Please review your notes in %(repo_name)s\" % {\n \"repo_name\": self.env.repo,\n }\n\n def _body(self, count_of_unreviewed_notes):\n return \"%(repo_name)s has %(num_unreviewed)s unreviewed notes.\" % {\n \"repo_name\": self.env.repo,\n \"num_unreviewed\": count_of_unreviewed_notes,\n }\n\n def _maybe_notify(self, count_of_unreviewed_notes):\n # TODO(yaboo@): Response should be modified\n if self._should_notify(count_of_unreviewed_notes):\n self.send_mail(self.config.get('notification_email'),\n subject=self._subject(),\n body=self._body(count_of_unreviewed_notes))\n\n def _should_notify(self, count_of_unreviewed_notes):\n if not self.config.get('notification_email'):\n return False\n\n return count_of_unreviewed_notes > self.config.get(\n 'unreviewed_notes_threshold')\n\n\nclass ThumbnailPreparer(utils.BaseHandler):\n \"\"\"A class to run the thumbnail preparation job (for uploaded photos).\"\"\"\n\n repo_required = False\n ACTION = 'tasks/thumbnail_preparer'\n\n def get(self):\n # We don't retry this task automatically, because it's looking for\n # everything that doesn't already have a thumbnail every time --\n # anything that doesn't get done now will be retried anyway on the next\n # iteration of the cron job.\n if self.repo:\n for p in (model.Photo.all()\n .filter('thumbnail_data =', None)\n .filter('repo =', self.repo)):\n photo.set_thumbnail(p)\n else:\n for repo in model.Repo.list():\n self.add_task_for_repo(repo, 'prepare-thumbnails', self.ACTION)\n\n\nclass DumpCSV(utils.BaseHandler):\n \"\"\"Dumps a CSV file containing all the records in each repository to Google\n Cloud Storage.\n \n People with BULK_READ API access can download the CSV file.\n \n Currently the CSV file only contains person records.\n \n This task requires special setup to run on a dev app server. See the\n docstring of cloud_storage.CloudStorage class for instruction.\n \"\"\"\n # TODO(gimite): Include note records in the CSV file.\n\n repo_required = False\n ACTION = 'tasks/dump_csv'\n\n # Lifetime of a single task is 10 min. It stops fetching and starts\n # uploading after 4 min, assuming uploading takes similar time as\n # fetching.\n MAX_FETCH_TIME = datetime.timedelta(minutes=4)\n \n def __init__(self, *args, **kwargs):\n super(DumpCSV, self).__init__(*args, **kwargs)\n self.storage = cloud_storage.CloudStorage()\n\n def task_name(self):\n return 'dump-csv'\n\n def schedule_next_task(self, cursor, timestamp):\n \"\"\"Schedule the next task for to carry on with this query.\n \"\"\"\n self.add_task_for_repo(\n self.repo,\n self.task_name(),\n self.ACTION,\n cursor=cursor,\n timestamp=str(calendar.timegm(timestamp.utctimetuple())))\n\n def get(self):\n if self.repo:\n self.run_task_for_repo(self.repo)\n else:\n # Sets lifetime of objects in Google Cloud Storage to 2 days. This\n # cleans up old CSV files, while it makes sure that it doesn't\n # delete CSV files users are currently downloading. Note that CSV\n # files are updated every 24 hours.\n #\n # The lifetime is applied globally for all objects in the bucket.\n # This is OK because Cloud Storage is only used for CSV files for\n # now. It may need a way to control lifetime per object (see the\n # docstring of cloud_storage.CloudStorage) if it starts using\n # Cloud Storage for other purposes.\n #\n # It is enough to call this only once for the bucket, but here is\n # just a convenient place to call it.\n self.storage.set_objects_lifetime(lifetime_days=2)\n\n for repo in model.Repo.list_active():\n self.add_task_for_repo(repo, self.task_name(), self.ACTION)\n\n def run_task_for_repo(self, repo):\n start_time = utils.get_utcnow()\n timestamp = self.params.timestamp or start_time\n base_name = '%s-persons-%s' % (\n repo, timestamp.strftime('%Y-%m-%d-%H%M%S'))\n is_first = not self.params.cursor\n\n query = model.Person.all_in_repo(repo).order('entry_date')\n if self.params.cursor:\n query.with_cursor(self.params.cursor)\n\n csv_io = StringIO.StringIO()\n writer = record_writer.PersonCsvWriter(csv_io, write_header=is_first)\n\n has_data = False\n scan_completed = False\n while True:\n persons = query.fetch(limit=FETCH_LIMIT)\n if persons:\n has_data = True\n else:\n scan_completed = True\n break\n records = [PFIF.person_to_dict(person) for person in persons]\n # So far it only supports dump of records without sensitive fields.\n utils.filter_sensitive_fields(records)\n writer.write(records)\n if utils.get_utcnow() >= start_time + self.MAX_FETCH_TIME:\n break\n query.with_cursor(query.cursor())\n\n final_csv_name = '%s.csv' % base_name\n temp_csv_name = '%s.temp.csv' % base_name\n\n if is_first:\n self.storage.insert_object(\n final_csv_name, 'text/csv', csv_io.getvalue())\n elif has_data:\n # Creates a temporary CSV file with new records, and append it to\n # the final CSV file.\n self.storage.insert_object(\n temp_csv_name, 'text/csv', csv_io.getvalue())\n self.storage.compose_objects(\n [final_csv_name, temp_csv_name], final_csv_name, 'text/csv')\n\n if scan_completed:\n config.set_for_repo(repo, latest_csv_object_name=final_csv_name)\n else:\n self.schedule_next_task(query.cursor(), timestamp)\n","path":"app/tasks.py"}],"string":"[\n {\n \"content\": \"#!/usr/bin/python2.7\\n# Copyright 2010 Google Inc.\\n#\\n# Licensed under the Apache License, Version 2.0 (the \\\"License\\\");\\n# you may not use this file except in compliance with the License.\\n# You may obtain a copy of the License at\\n#\\n# http://www.apache.org/licenses/LICENSE-2.0\\n#\\n# Unless required by applicable law or agreed to in writing, software\\n# distributed under the License is distributed on an \\\"AS IS\\\" BASIS,\\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\\n# See the License for the specific language governing permissions and\\n# limitations under the License.\\n\\nimport calendar\\nimport datetime\\nimport logging\\nimport time\\nimport StringIO\\n\\nfrom google.appengine import runtime\\nfrom google.appengine.api import datastore_errors\\nfrom google.appengine.api import quota\\nfrom google.appengine.api import taskqueue\\nfrom google.appengine.ext import db\\n\\nimport cloud_storage\\nimport config\\nimport const\\nimport delete\\nimport model\\nimport photo\\nimport pfif\\nimport record_writer\\nimport utils\\n\\n\\nCPU_MEGACYCLES_PER_REQUEST = 1000\\nEXPIRED_TTL = datetime.timedelta(delete.EXPIRED_TTL_DAYS, 0, 0)\\nFETCH_LIMIT = 100\\nPFIF = pfif.PFIF_VERSIONS[pfif.PFIF_DEFAULT_VERSION]\\n\\n\\nclass ScanForExpired(utils.BaseHandler):\\n \\\"\\\"\\\"Common logic for scanning the Person table looking for things to delete.\\n\\n The common logic handles iterating through the query, updating the expiry\\n date and wiping/deleting as needed. The is_expired flag on all records whose\\n expiry_date has passed. Records that expired more than EXPIRED_TTL in the\\n past will also have their data fields, notes, and photos permanently\\n deleted.\\n\\n Subclasses set the query and task_name.\\\"\\\"\\\"\\n repo_required = False\\n\\n def task_name(self):\\n \\\"\\\"\\\"Subclasses should implement this.\\\"\\\"\\\"\\n pass\\n\\n def query(self):\\n \\\"\\\"\\\"Subclasses should implement this.\\\"\\\"\\\"\\n pass\\n\\n def schedule_next_task(self, cursor):\\n \\\"\\\"\\\"Schedule the next task for to carry on with this query.\\n \\\"\\\"\\\"\\n self.add_task_for_repo(self.repo, self.task_name(), self.ACTION,\\n cursor=cursor, queue_name='expiry')\\n\\n def get(self):\\n if self.repo:\\n query = self.query()\\n if self.params.cursor:\\n query.with_cursor(self.params.cursor)\\n cursor = self.params.cursor\\n try:\\n for person in query:\\n # query.cursor() returns a cursor which returns the entity\\n # next to this \\\"person\\\" as the first result.\\n next_cursor = query.cursor()\\n was_expired = person.is_expired\\n person.put_expiry_flags()\\n if (utils.get_utcnow() - person.get_effective_expiry_date()\\n > EXPIRED_TTL):\\n person.wipe_contents()\\n else:\\n # treat this as a regular deletion.\\n if person.is_expired and not was_expired:\\n delete.delete_person(self, person)\\n cursor = next_cursor\\n except runtime.DeadlineExceededError:\\n self.schedule_next_task(cursor)\\n except datastore_errors.Timeout:\\n # This exception is sometimes raised, maybe when the query\\n # object live too long?\\n self.schedule_next_task(cursor)\\n else:\\n for repo in model.Repo.list():\\n self.add_task_for_repo(repo, self.task_name(), self.ACTION)\\n\\nclass DeleteExpired(ScanForExpired):\\n \\\"\\\"\\\"Scan for person records with expiry date thats past.\\\"\\\"\\\"\\n ACTION = 'tasks/delete_expired'\\n\\n def task_name(self):\\n return 'delete-expired'\\n\\n def query(self):\\n return model.Person.past_due_records(self.repo)\\n\\nclass DeleteOld(ScanForExpired):\\n \\\"\\\"\\\"Scan for person records with old source dates for expiration.\\\"\\\"\\\"\\n ACTION = 'tasks/delete_old'\\n\\n def task_name(self):\\n return 'delete-old'\\n\\n def query(self):\\n return model.Person.potentially_expired_records(self.repo)\\n\\n\\nclass CleanUpInTestMode(utils.BaseHandler):\\n \\\"\\\"\\\"If the repository is in \\\"test mode\\\", this task deletes all entries older\\n than DELETION_AGE_SECONDS (defined below), regardless of their actual\\n expiration specification.\\n\\n We delete entries quickly so that most of the test data does not persist in\\n real mode, and to reduce the effect of spam.\\n \\\"\\\"\\\"\\n repo_required = False\\n ACTION = 'tasks/clean_up_in_test_mode'\\n\\n # Entries older than this age in seconds are deleted in test mode.\\n #\\n # If you are maintaining a single repository and switching it between test\\n # mode (for drills) and real mode (for real crises), you should be sure to\\n # switch to real mode within DELETION_AGE_SECONDS after a real crisis\\n # occurs, because:\\n # - When the crisis happens, the users may be confused and enter real\\n # information on the repository, even though it's still in test mode.\\n # (All pages show \\\"test mode\\\" message, but some users may be still\\n # confused.)\\n # - If we fail to make the switch in DELETION_AGE_SECONDS, such real\\n # entries are deleted.\\n # - If we make the switch in DELETION_AGE_SECONDS, such entries are not\\n # deleted, and handled as a part of real mode data.\\n DELETION_AGE_SECONDS = 24 * 3600\\n\\n def __init__(self, request, response, env):\\n utils.BaseHandler.__init__(self, request, response, env)\\n self.__listener = None\\n\\n def task_name(self):\\n return 'clean-up-in-test-mode'\\n\\n def schedule_next_task(self, cursor, utcnow):\\n \\\"\\\"\\\"Schedule the next task for to carry on with this query.\\n \\\"\\\"\\\"\\n self.add_task_for_repo(\\n self.repo,\\n self.task_name(),\\n self.ACTION,\\n utcnow=str(calendar.timegm(utcnow.utctimetuple())),\\n cursor=cursor,\\n queue_name='clean_up_in_test_mode')\\n\\n def in_test_mode(self, repo):\\n \\\"\\\"\\\"Returns True if the repository is in test mode.\\\"\\\"\\\"\\n return config.get('test_mode', repo=repo)\\n\\n def get(self):\\n if self.repo:\\n # To reuse the cursor from the previous task, we need to apply\\n # exactly the same filter. So we use utcnow previously used\\n # instead of the current time.\\n utcnow = self.params.utcnow or utils.get_utcnow()\\n max_entry_date = (\\n utcnow -\\n datetime.timedelta(\\n seconds=CleanUpInTestMode.DELETION_AGE_SECONDS))\\n query = model.Person.all_in_repo(self.repo)\\n query.filter('entry_date <=', max_entry_date)\\n if self.params.cursor:\\n query.with_cursor(self.params.cursor)\\n cursor = self.params.cursor\\n # Uses query.get() instead of \\\"for person in query\\\".\\n # If we use for-loop, query.cursor() points to an unexpected\\n # position.\\n person = query.get()\\n # When the repository is no longer in test mode, aborts the\\n # deletion.\\n try:\\n while person and self.in_test_mode(self.repo):\\n if self.__listener:\\n self.__listener.before_deletion(person.key())\\n person.delete_related_entities(delete_self=True)\\n cursor = query.cursor()\\n person = query.get()\\n except runtime.DeadlineExceededError:\\n self.schedule_next_task(cursor, utcnow)\\n except datastore_errors.Timeout:\\n # This exception is sometimes raised, maybe when the query\\n # object live too long?\\n self.schedule_next_task(cursor, utcnow)\\n \\n else:\\n for repo in model.Repo.list():\\n if self.in_test_mode(repo):\\n self.add_task_for_repo(repo, self.task_name(), self.ACTION)\\n\\n def set_listener(self, listener):\\n self.__listener = listener\\n\\n\\ndef run_count(make_query, update_counter, counter):\\n \\\"\\\"\\\"Scans the entities matching a query up to FETCH_LIMIT.\\n \\n Returns False if we finished counting all entries.\\\"\\\"\\\"\\n # Get the next batch of entities.\\n query = make_query()\\n if counter.last_key:\\n query = query.filter('__key__ >', db.Key(counter.last_key))\\n entities = query.order('__key__').fetch(FETCH_LIMIT)\\n if not entities:\\n counter.last_key = ''\\n return False\\n\\n # Pass the entities to the counting function.\\n for entity in entities:\\n update_counter(counter, entity)\\n\\n # Remember where we left off.\\n counter.last_key = str(entities[-1].key())\\n return True\\n\\n\\nclass CountBase(utils.BaseHandler):\\n \\\"\\\"\\\"A base handler for counting tasks. Making a request to this handler\\n without a specified repo will start tasks for all repositories in parallel.\\n Each subclass of this class handles one scan through the datastore.\\\"\\\"\\\"\\n repo_required = False # can run without a repo\\n\\n SCAN_NAME = '' # Each subclass should choose a unique scan_name.\\n ACTION = '' # Each subclass should set the action path that it handles.\\n\\n def get(self):\\n if self.repo: # Do some counting.\\n try:\\n counter = model.Counter.get_unfinished_or_create(\\n self.repo, self.SCAN_NAME)\\n entities_remaining = True\\n while entities_remaining:\\n # Batch the db updates.\\n for _ in xrange(100):\\n entities_remaining = run_count(\\n self.make_query, self.update_counter, counter)\\n if not entities_remaining:\\n break\\n # And put the updates at once.\\n counter.put()\\n except runtime.DeadlineExceededError:\\n # Continue counting in another task.\\n self.add_task_for_repo(self.repo, self.SCAN_NAME, self.ACTION)\\n else: # Launch counting tasks for all repositories.\\n for repo in model.Repo.list():\\n self.add_task_for_repo(repo, self.SCAN_NAME, self.ACTION)\\n\\n def make_query(self):\\n \\\"\\\"\\\"Subclasses should implement this. This will be called to get the\\n datastore query; it should always return the same query.\\\"\\\"\\\"\\n\\n def update_counter(self, counter, entity):\\n \\\"\\\"\\\"Subclasses should implement this. This will be called once for\\n each entity that matches the query; it should call increment() on\\n the counter object for whatever accumulators it wants to increment.\\\"\\\"\\\"\\n\\n\\nclass CountPerson(CountBase):\\n SCAN_NAME = 'person'\\n ACTION = 'tasks/count/person'\\n\\n def make_query(self):\\n return model.Person.all().filter('repo =', self.repo)\\n\\n def update_counter(self, counter, person):\\n found = ''\\n if person.latest_found is not None:\\n found = person.latest_found and 'TRUE' or 'FALSE'\\n\\n counter.increment('all')\\n counter.increment('original_domain=' + (person.original_domain or ''))\\n counter.increment('sex=' + (person.sex or ''))\\n counter.increment('home_country=' + (person.home_country or ''))\\n counter.increment('photo=' + (person.photo_url and 'present' or ''))\\n counter.increment('num_notes=%d' % len(person.get_notes()))\\n counter.increment('status=' + (person.latest_status or ''))\\n counter.increment('found=' + found)\\n if person.author_email: # author e-mail address present?\\n counter.increment('author_email')\\n if person.author_phone: # author phone number present?\\n counter.increment('author_phone')\\n counter.increment(\\n 'linked_persons=%d' % len(person.get_linked_persons()))\\n\\n\\nclass CountNote(CountBase):\\n SCAN_NAME = 'note'\\n ACTION = 'tasks/count/note'\\n\\n def make_query(self):\\n return model.Note.all().filter('repo =', self.repo)\\n\\n def update_counter(self, counter, note):\\n author_made_contact = ''\\n if note.author_made_contact is not None:\\n author_made_contact = note.author_made_contact and 'TRUE' or 'FALSE'\\n\\n counter.increment('all')\\n counter.increment('status=' + (note.status or ''))\\n counter.increment('original_domain=' + (note.original_domain or ''))\\n counter.increment('author_made_contact=' + author_made_contact)\\n if note.last_known_location: # last known location specified?\\n counter.increment('last_known_location')\\n if note.author_email: # author e-mail address present?\\n counter.increment('author_email')\\n if note.author_phone: # author phone number present?\\n counter.increment('author_phone')\\n if note.linked_person_record_id: # linked to another person?\\n counter.increment('linked_person')\\n\\n\\nclass AddReviewedProperty(CountBase):\\n \\\"\\\"\\\"Sets 'reviewed' to False on all notes that have no 'reviewed' property.\\n This task is for migrating datastores that were created before the\\n 'reviewed' property existed; 'reviewed' has to be set to False so that\\n the Notes will be indexed.\\\"\\\"\\\"\\n SCAN_NAME = 'unreview-note'\\n ACTION = 'tasks/count/unreview_note'\\n\\n def make_query(self):\\n return model.Note.all().filter('repo =', self.repo)\\n\\n def update_counter(self, counter, note):\\n if not note.reviewed:\\n note.reviewed = False\\n note.put()\\n\\n\\nclass UpdateDeadStatus(CountBase):\\n \\\"\\\"\\\"This task looks for Person records with the status 'believed_dead',\\n checks for the last non-hidden Note, and updates the status if necessary.\\n This is designed specifically to address bogus 'believed_dead' notes that\\n are flagged as spam. (This is a cleanup task, not a counting task.)\\\"\\\"\\\"\\n SCAN_NAME = 'update-dead-status'\\n ACTION = 'tasks/count/update_dead_status'\\n\\n def make_query(self):\\n return model.Person.all().filter('repo =', self.repo\\n ).filter('latest_status =', 'believed_dead')\\n\\n def update_counter(self, counter, person):\\n person.update_latest_status()\\n\\n\\nclass UpdateStatus(CountBase):\\n \\\"\\\"\\\"This task scans Person records, looks for the last non-hidden Note, and\\n updates latest_status. (This is a cleanup task, not a counting task.)\\\"\\\"\\\"\\n SCAN_NAME = 'update-status'\\n ACTION = 'tasks/count/update_status'\\n\\n def make_query(self):\\n return model.Person.all().filter('repo =', self.repo)\\n\\n def update_counter(self, counter, person):\\n person.update_latest_status()\\n\\n\\nclass Reindex(CountBase):\\n \\\"\\\"\\\"A handler for re-indexing Persons.\\\"\\\"\\\"\\n SCAN_NAME = 'reindex'\\n ACTION = 'tasks/count/reindex'\\n\\n def make_query(self):\\n return model.Person.all().filter('repo =', self.repo)\\n\\n def update_counter(self, counter, person):\\n person.update_index(['old', 'new'])\\n person.put()\\n\\n\\nclass NotifyManyUnreviewedNotes(utils.BaseHandler):\\n \\\"\\\"\\\"This task sends email notification when the number of unreviewed notes\\n exceeds threshold.\\n \\\"\\\"\\\"\\n repo_required = False # can run without a repo\\n ACTION = 'tasks/notify_many_unreviewed_notes'\\n\\n def task_name(self):\\n return 'notify-bad-review-status'\\n\\n def get(self):\\n if self.repo:\\n try:\\n count_of_unreviewed_notes = (\\n model.Note.get_unreviewed_notes_count(self.repo))\\n self._maybe_notify(count_of_unreviewed_notes)\\n except runtime.DeadlineExceededError:\\n logging.info(\\\"DeadlineExceededError occurs\\\")\\n self.add_task_for_repo(\\n self.repo, self.task_name(), self.ACTION)\\n except datastore_errors.Timeout:\\n logging.info(\\\"Timeout occurs in datastore\\\")\\n self.add_task_for_repo(\\n self.repo, self.task_name(), self.ACTION)\\n else:\\n for repo in model.Repo.list():\\n self.add_task_for_repo(\\n repo, self.task_name(), self.ACTION)\\n\\n def _subject(self):\\n return \\\"Please review your notes in %(repo_name)s\\\" % {\\n \\\"repo_name\\\": self.env.repo,\\n }\\n\\n def _body(self, count_of_unreviewed_notes):\\n return \\\"%(repo_name)s has %(num_unreviewed)s unreviewed notes.\\\" % {\\n \\\"repo_name\\\": self.env.repo,\\n \\\"num_unreviewed\\\": count_of_unreviewed_notes,\\n }\\n\\n def _maybe_notify(self, count_of_unreviewed_notes):\\n # TODO(yaboo@): Response should be modified\\n if self._should_notify(count_of_unreviewed_notes):\\n self.send_mail(self.config.get('notification_email'),\\n subject=self._subject(),\\n body=self._body(count_of_unreviewed_notes))\\n\\n def _should_notify(self, count_of_unreviewed_notes):\\n if not self.config.get('notification_email'):\\n return False\\n\\n return count_of_unreviewed_notes > self.config.get(\\n 'unreviewed_notes_threshold')\\n\\n\\nclass ThumbnailPreparer(utils.BaseHandler):\\n \\\"\\\"\\\"A class to run the thumbnail preparation job (for uploaded photos).\\\"\\\"\\\"\\n\\n repo_required = False\\n ACTION = 'tasks/thumbnail_preparer'\\n\\n def get(self):\\n # We don't retry this task automatically, because it's looking for\\n # everything that doesn't already have a thumbnail every time --\\n # anything that doesn't get done now will be retried anyway on the next\\n # iteration of the cron job.\\n if self.repo:\\n for p in (model.Photo.all()\\n .filter('thumbnail_data =', None)\\n .filter('repo =', self.repo)):\\n photo.set_thumbnail(p)\\n else:\\n for repo in model.Repo.list():\\n self.add_task_for_repo(repo, 'prepare-thumbnails', self.ACTION)\\n\\n\\nclass DumpCSV(utils.BaseHandler):\\n \\\"\\\"\\\"Dumps a CSV file containing all the records in each repository to Google\\n Cloud Storage.\\n \\n People with BULK_READ API access can download the CSV file.\\n \\n Currently the CSV file only contains person records.\\n \\n This task requires special setup to run on a dev app server. See the\\n docstring of cloud_storage.CloudStorage class for instruction.\\n \\\"\\\"\\\"\\n # TODO(gimite): Include note records in the CSV file.\\n\\n repo_required = False\\n ACTION = 'tasks/dump_csv'\\n\\n # Lifetime of a single task is 10 min. It stops fetching and starts\\n # uploading after 4 min, assuming uploading takes similar time as\\n # fetching.\\n MAX_FETCH_TIME = datetime.timedelta(minutes=4)\\n \\n def __init__(self, *args, **kwargs):\\n super(DumpCSV, self).__init__(*args, **kwargs)\\n self.storage = cloud_storage.CloudStorage()\\n\\n def task_name(self):\\n return 'dump-csv'\\n\\n def schedule_next_task(self, cursor, timestamp):\\n \\\"\\\"\\\"Schedule the next task for to carry on with this query.\\n \\\"\\\"\\\"\\n self.add_task_for_repo(\\n self.repo,\\n self.task_name(),\\n self.ACTION,\\n cursor=cursor,\\n timestamp=str(calendar.timegm(timestamp.utctimetuple())))\\n\\n def get(self):\\n if self.repo:\\n self.run_task_for_repo(self.repo)\\n else:\\n # Sets lifetime of objects in Google Cloud Storage to 2 days. This\\n # cleans up old CSV files, while it makes sure that it doesn't\\n # delete CSV files users are currently downloading. Note that CSV\\n # files are updated every 24 hours.\\n #\\n # The lifetime is applied globally for all objects in the bucket.\\n # This is OK because Cloud Storage is only used for CSV files for\\n # now. It may need a way to control lifetime per object (see the\\n # docstring of cloud_storage.CloudStorage) if it starts using\\n # Cloud Storage for other purposes.\\n #\\n # It is enough to call this only once for the bucket, but here is\\n # just a convenient place to call it.\\n self.storage.set_objects_lifetime(lifetime_days=2)\\n\\n for repo in model.Repo.list_active():\\n self.add_task_for_repo(repo, self.task_name(), self.ACTION)\\n\\n def run_task_for_repo(self, repo):\\n start_time = utils.get_utcnow()\\n timestamp = self.params.timestamp or start_time\\n base_name = '%s-persons-%s' % (\\n repo, timestamp.strftime('%Y-%m-%d-%H%M%S'))\\n is_first = not self.params.cursor\\n\\n query = model.Person.all_in_repo(repo).order('entry_date')\\n if self.params.cursor:\\n query.with_cursor(self.params.cursor)\\n\\n csv_io = StringIO.StringIO()\\n writer = record_writer.PersonCsvWriter(csv_io, write_header=is_first)\\n\\n has_data = False\\n scan_completed = False\\n while True:\\n persons = query.fetch(limit=FETCH_LIMIT)\\n if persons:\\n has_data = True\\n else:\\n scan_completed = True\\n break\\n records = [PFIF.person_to_dict(person) for person in persons]\\n # So far it only supports dump of records without sensitive fields.\\n utils.filter_sensitive_fields(records)\\n writer.write(records)\\n if utils.get_utcnow() >= start_time + self.MAX_FETCH_TIME:\\n break\\n query.with_cursor(query.cursor())\\n\\n final_csv_name = '%s.csv' % base_name\\n temp_csv_name = '%s.temp.csv' % base_name\\n\\n if is_first:\\n self.storage.insert_object(\\n final_csv_name, 'text/csv', csv_io.getvalue())\\n elif has_data:\\n # Creates a temporary CSV file with new records, and append it to\\n # the final CSV file.\\n self.storage.insert_object(\\n temp_csv_name, 'text/csv', csv_io.getvalue())\\n self.storage.compose_objects(\\n [final_csv_name, temp_csv_name], final_csv_name, 'text/csv')\\n\\n if scan_completed:\\n config.set_for_repo(repo, latest_csv_object_name=final_csv_name)\\n else:\\n self.schedule_next_task(query.cursor(), timestamp)\\n\",\n \"path\": \"app/tasks.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/app/tasks.py b/app/tasks.py\nindex 2bb2a6c2ca..72f537c07f 100644\n--- a/app/tasks.py\n+++ b/app/tasks.py\n@@ -522,7 +522,7 @@ def get(self):\n # just a convenient place to call it.\n self.storage.set_objects_lifetime(lifetime_days=2)\n \n- for repo in model.Repo.list():\n+ for repo in model.Repo.list_active():\n self.add_task_for_repo(repo, self.task_name(), self.ACTION)\n \n def run_task_for_repo(self, repo):\n"}}},{"rowIdx":5481,"cells":{"in_source_id":{"kind":"string","value":"mozilla__bugbug-3721"},"issue":{"kind":"string","value":"MEI: Have a measure of incoming/closed defects vs. existing open\nBased on [this doc](https://docs.google.com/document/d/1nWP3DtSWneYT8ietXuBa6uPszMKMgICXf3b2dwMVXYk/edit#heading=h.9joq5dbpnw41).\r\n\r\n```\r\nIncoming(TimeInterval) := NumOpenedDefects(TimeInterval) / NumOpenDefects(Start(TimeInterval))\r\nClosed(TimeInterval) := NumClosedDefects(TimeInterval) / NumOpenDefects(Start(TimeInterval))\r\n```\r\n\r\nGiven that `NumOpenDefects(Start(TimeInterval))` is hard to query live, we estimate it by:\r\n\r\n```\r\nNumOpenDefects(Start(TimeInterval)) := NumOpenDefects(End(TimeInterval)) + NumClosedDefects(TimeInterval) - NumOpenedDefects(TimeInterval)\r\n```\r\n\r\nsuch that if the calculation is run with an end date of the time interval that is close to today we can use the up-to-date values for components and severity without bothering too much for deviations.\r\n\n"},"before_files":{"kind":"list like","value":[{"content":"# -*- coding: utf-8 -*-\n# This Source Code Form is subject to the terms of the Mozilla Public\n# License, v. 2.0. If a copy of the MPL was not distributed with this file,\n# You can obtain one at http://mozilla.org/MPL/2.0/.\n\nimport collections\nimport csv\nimport math\nimport re\nfrom datetime import datetime\nfrom logging import INFO, basicConfig, getLogger\nfrom typing import Iterable, Iterator, NewType, Optional\n\nimport tenacity\nfrom dateutil.relativedelta import relativedelta\nfrom libmozdata.bugzilla import Bugzilla\nfrom tqdm import tqdm\n\nfrom bugbug import db, utils\n\nbasicConfig(level=INFO)\nlogger = getLogger(__name__)\n\nBugDict = NewType(\"BugDict\", dict)\n\nBUGS_DB = \"data/bugs.json\"\ndb.register(\n BUGS_DB,\n \"https://community-tc.services.mozilla.com/api/index/v1/task/project.bugbug.data_bugs.latest/artifacts/public/bugs.json.zst\",\n 9,\n)\n\nPRODUCTS = (\n \"Cloud Services\",\n \"Core\",\n \"Data Platform and Tools\",\n \"DevTools\",\n \"Developer Infrastructure\",\n \"External Software Affecting Firefox\",\n \"Fenix\",\n \"Firefox\",\n \"Firefox Build System\",\n \"Firefox for iOS\",\n \"GeckoView\",\n \"Invalid Bugs\",\n \"JSS\",\n \"NSPR\",\n \"NSS\",\n \"Release Engineering\",\n \"Remote Protocol\",\n \"Shield\",\n \"Testing\",\n \"Toolkit\",\n \"Web Compatibility\",\n \"WebExtensions\",\n)\n\nATTACHMENT_INCLUDE_FIELDS = [\n \"id\",\n \"flags\",\n \"is_patch\",\n \"content_type\",\n \"creation_time\",\n \"file_name\",\n]\n\nCOMMENT_INCLUDE_FIELDS = [\"id\", \"count\", \"text\", \"creation_time\"]\n\nPRODUCT_COMPONENT_CSV_REPORT_URL = \"https://bugzilla.mozilla.org/report.cgi\"\n\nPHAB_REVISION_PATTERN = re.compile(r\"phabricator-D([0-9]+)-url.txt\")\n\nMAINTENANCE_EFFECTIVENESS_SEVERITY_WEIGHTS = {\n \"--\": 3,\n \"S1\": 8,\n \"S2\": 5,\n \"S3\": 2,\n \"S4\": 1,\n}\nMAINTENANCE_EFFECTIVENESS_SEVERITY_DEFAULT_WEIGHT = 3\n\nINCLUDE_FIELDS = [\"_default\", \"filed_via\"]\n\n\ndef get_bugs(include_invalid: Optional[bool] = False) -> Iterator[BugDict]:\n yield from (\n bug\n for bug in db.read(BUGS_DB)\n if include_invalid or bug[\"product\"] != \"Invalid Bugs\"\n )\n\n\ndef set_token(token):\n Bugzilla.TOKEN = token\n\n\ndef get_ids(params):\n assert \"include_fields\" not in params or params[\"include_fields\"] == \"id\"\n\n old_CHUNK_SIZE = Bugzilla.BUGZILLA_CHUNK_SIZE\n try:\n Bugzilla.BUGZILLA_CHUNK_SIZE = 7000\n\n all_ids = []\n\n def bughandler(bug):\n all_ids.append(bug[\"id\"])\n\n params[\"include_fields\"] = \"id\"\n\n Bugzilla(params, bughandler=bughandler).get_data().wait()\n finally:\n Bugzilla.BUGZILLA_CHUNK_SIZE = old_CHUNK_SIZE\n\n return all_ids\n\n\ndef get(ids_or_query):\n new_bugs = {}\n\n def bughandler(bug):\n bug_id = int(bug[\"id\"])\n\n if bug_id not in new_bugs:\n new_bugs[bug_id] = dict()\n\n new_bugs[bug_id].update(bug)\n\n def commenthandler(bug, bug_id):\n bug_id = int(bug_id)\n\n if bug_id not in new_bugs:\n new_bugs[bug_id] = dict()\n\n new_bugs[bug_id][\"comments\"] = bug[\"comments\"]\n\n def attachmenthandler(bug, bug_id):\n bug_id = int(bug_id)\n\n if bug_id not in new_bugs:\n new_bugs[bug_id] = dict()\n\n new_bugs[bug_id][\"attachments\"] = bug\n\n def historyhandler(bug):\n bug_id = int(bug[\"id\"])\n\n if bug_id not in new_bugs:\n new_bugs[bug_id] = dict()\n\n new_bugs[bug_id][\"history\"] = bug[\"history\"]\n\n Bugzilla(\n ids_or_query,\n include_fields=INCLUDE_FIELDS,\n bughandler=bughandler,\n commenthandler=commenthandler,\n comment_include_fields=COMMENT_INCLUDE_FIELDS,\n attachmenthandler=attachmenthandler,\n attachment_include_fields=ATTACHMENT_INCLUDE_FIELDS,\n historyhandler=historyhandler,\n ).get_data().wait()\n\n return new_bugs\n\n\ndef get_ids_between(date_from, date_to=None, security=False, resolution=None):\n params = {\n \"f1\": \"creation_ts\",\n \"o1\": \"greaterthan\",\n \"v1\": date_from.strftime(\"%Y-%m-%d\"),\n \"product\": PRODUCTS,\n }\n\n if date_to is not None:\n params[\"f2\"] = \"creation_ts\"\n params[\"o2\"] = \"lessthan\"\n params[\"v2\"] = date_to.strftime(\"%Y-%m-%d\")\n\n if not security:\n params[\"f3\"] = \"bug_group\"\n params[\"o3\"] = \"isempty\"\n\n if resolution is not None:\n params[\"resolution\"] = resolution\n\n return get_ids(params)\n\n\ndef download_bugs(bug_ids: Iterable[int], security: bool = False) -> list[BugDict]:\n old_bug_count = 0\n new_bug_ids_set = set(int(bug_id) for bug_id in bug_ids)\n for bug in get_bugs(include_invalid=True):\n old_bug_count += 1\n new_bug_ids_set.discard(int(bug[\"id\"]))\n\n logger.info(\"Loaded %d bugs.\", old_bug_count)\n\n new_bug_ids = sorted(list(new_bug_ids_set))\n\n chunks = (\n new_bug_ids[i : (i + Bugzilla.BUGZILLA_CHUNK_SIZE)]\n for i in range(0, len(new_bug_ids), Bugzilla.BUGZILLA_CHUNK_SIZE)\n )\n\n @tenacity.retry(\n stop=tenacity.stop_after_attempt(7),\n wait=tenacity.wait_exponential(multiplier=1, min=16, max=64),\n )\n def get_chunk(chunk: list[int]) -> list[BugDict]:\n new_bugs = get(chunk)\n\n if not security:\n new_bugs = [bug for bug in new_bugs.values() if len(bug[\"groups\"]) == 0]\n\n return new_bugs\n\n all_new_bugs = []\n\n with tqdm(total=len(new_bug_ids)) as progress_bar:\n for chunk in chunks:\n new_bugs = get_chunk(chunk)\n\n progress_bar.update(len(chunk))\n\n db.append(BUGS_DB, new_bugs)\n\n all_new_bugs += new_bugs\n\n return all_new_bugs\n\n\ndef _find_linked(\n bug_map: dict[int, BugDict], bug: BugDict, link_type: str\n) -> list[int]:\n return sum(\n (\n _find_linked(bug_map, bug_map[b], link_type)\n for b in bug[link_type]\n if b in bug_map\n ),\n [b for b in bug[link_type] if b in bug_map],\n )\n\n\ndef find_blocked_by(bug_map: dict[int, BugDict], bug: BugDict) -> list[int]:\n return _find_linked(bug_map, bug, \"blocks\")\n\n\ndef find_blocking(bug_map: dict[int, BugDict], bug: BugDict) -> list[int]:\n return _find_linked(bug_map, bug, \"depends_on\")\n\n\ndef get_fixed_versions(bug):\n versions = set()\n\n target_milestone_patterns = [\n re.compile(\"mozilla([0-9]+)\"),\n re.compile(\"([0-9]+) Branch\"),\n re.compile(\"Firefox ([0-9]+)\"),\n ]\n for target_milestone_pattern in target_milestone_patterns:\n m = target_milestone_pattern.match(bug[\"target_milestone\"])\n if m:\n versions.add(int(m.group(1)))\n\n status_pattern = re.compile(\"cf_status_firefox([0-9]+)\")\n for field, value in bug.items():\n if value != \"fixed\":\n continue\n\n m = status_pattern.match(field)\n if m:\n versions.add(int(m.group(1)))\n\n return list(versions)\n\n\ndef delete_bugs(match):\n db.delete(BUGS_DB, match)\n\n\ndef count_bugs(bug_query_params):\n bug_query_params[\"count_only\"] = 1\n\n r = utils.get_session(\"bugzilla\").get(\n \"https://bugzilla.mozilla.org/rest/bug\", params=bug_query_params\n )\n r.raise_for_status()\n count = r.json()[\"bug_count\"]\n\n return count\n\n\ndef get_product_component_count(months: int = 12) -> dict[str, int]:\n \"\"\"Get the number of bugs per component.\n\n Returns:\n a dictionary where keys are full components (in the form of\n `{product}::{component}`) and the value of the number of bugs for the\n given full components. Full component with 0 bugs are returned.\n \"\"\"\n since = datetime.utcnow() - relativedelta(months=months)\n\n # Base params\n params = {\n \"f1\": \"creation_ts\",\n \"o1\": \"greaterthan\",\n \"v1\": since.strftime(\"%Y-%m-%d\"),\n \"x_axis_field\": \"product\",\n \"y_axis_field\": \"component\",\n \"action\": \"wrap\",\n \"ctype\": \"csv\",\n \"format\": \"table\",\n }\n\n csv_file = utils.get_session(\"bugzilla\").get(\n PRODUCT_COMPONENT_CSV_REPORT_URL, params=params\n )\n csv_file.raise_for_status()\n content = csv_file.text\n\n csv_content = content.splitlines()\n component_key = \"Component / Product\"\n\n bugs_number = {}\n\n csv_reader = csv.DictReader(csv_content)\n for row in csv_reader:\n # Extract the component key\n component = row[component_key]\n\n for product, raw_value in row.items():\n if product == component_key:\n continue\n\n value = int(raw_value)\n # If there are no bugs, the product/component pair doesn't exist.\n if value == 0:\n continue\n\n full_comp = f\"{product}::{component}\"\n bugs_number[full_comp] = value\n\n return bugs_number\n\n\ndef get_active_product_components(products=[]) -> set[tuple[str, str]]:\n r = utils.get_session(\"bugzilla\").get(\n \"https://bugzilla.mozilla.org/rest/product\",\n params={\n \"type\": \"accessible\",\n \"include_fields\": [\n \"name\",\n \"is_active\",\n \"components.name\",\n \"components.is_active\",\n ],\n \"names\": products,\n },\n headers={\"X-Bugzilla-API-Key\": Bugzilla.TOKEN, \"User-Agent\": \"bugbug\"},\n )\n r.raise_for_status()\n\n return set(\n (product[\"name\"], component[\"name\"])\n for product in r.json()[\"products\"]\n if product[\"is_active\"]\n for component in product[\"components\"]\n if component[\"is_active\"]\n )\n\n\ndef get_component_team_mapping() -> dict[str, dict[str, str]]:\n r = utils.get_session(\"bugzilla\").get(\n \"https://bugzilla.mozilla.org/rest/product\",\n params={\n \"type\": \"accessible\",\n \"include_fields\": [\"name\", \"components.name\", \"components.team_name\"],\n },\n headers={\"X-Bugzilla-API-Key\": Bugzilla.TOKEN, \"User-Agent\": \"bugbug\"},\n )\n r.raise_for_status()\n\n mapping: dict[str, dict[str, str]] = collections.defaultdict(dict)\n for product in r.json()[\"products\"]:\n for component in product[\"components\"]:\n mapping[product[\"name\"]][component[\"name\"]] = component[\"team_name\"]\n\n return mapping\n\n\ndef get_groups_users(group_names: list[str]) -> list[str]:\n r = utils.get_session(\"bugzilla\").get(\n \"https://bugzilla.mozilla.org/rest/group\",\n params={\n \"names\": group_names,\n \"membership\": \"1\",\n },\n headers={\"X-Bugzilla-API-Key\": Bugzilla.TOKEN, \"User-Agent\": \"bugbug\"},\n )\n r.raise_for_status()\n\n return [\n member[\"email\"]\n for group in r.json()[\"groups\"]\n for member in group[\"membership\"]\n ]\n\n\ndef get_revision_ids(bug: BugDict) -> list[int]:\n revision_ids = []\n\n for attachment in bug[\"attachments\"]:\n if attachment[\"content_type\"] != \"text/x-phabricator-request\":\n continue\n\n match = PHAB_REVISION_PATTERN.search(attachment[\"file_name\"])\n if match is None:\n continue\n\n revision_ids.append(int(match.group(1)))\n\n return revision_ids\n\n\ndef get_last_activity_excluding_bots(bug: BugDict) -> str:\n email_parts = [\n \"@bots.tld\",\n \"@mozilla.tld\",\n \"nobody@mozilla.org\",\n ]\n\n for history in bug[\"history\"][::-1]:\n if not any(email_part in history[\"who\"] for email_part in email_parts):\n return history[\"when\"]\n\n return bug[\"creation_time\"]\n\n\ndef calculate_maintenance_effectiveness_indicator(\n team,\n from_date,\n to_date,\n components=None,\n):\n data: dict[str, dict[str, int]] = {\n \"open\": {},\n \"opened\": {},\n \"closed\": {},\n }\n\n logger.info(\n \"Calculating maintenance effectiveness indicator for the %s team from %s to %s\",\n team,\n from_date,\n to_date,\n )\n\n for severity in MAINTENANCE_EFFECTIVENESS_SEVERITY_WEIGHTS.keys():\n params = {\n \"count_only\": 1,\n \"type\": \"defect\",\n \"team_name\": team,\n }\n\n if severity != \"--\":\n params[\"bug_severity\"] = severity\n\n if components is not None:\n params[\"component\"] = components\n\n for query_type in data.keys():\n if query_type in (\"opened\", \"closed\"):\n params.update(\n {\n \"chfieldfrom\": from_date.strftime(\"%Y-%m-%d\"),\n \"chfieldto\": to_date.strftime(\"%Y-%m-%d\"),\n }\n )\n\n if query_type == \"open\":\n params.update(\n {\n \"f1\": \"resolution\",\n \"o1\": \"equals\",\n \"v1\": \"---\",\n }\n )\n elif query_type == \"opened\":\n params[\"chfield\"] = \"[Bug creation]\"\n elif query_type == \"closed\":\n params.update(\n {\n \"chfield\": \"cf_last_resolved\",\n \"f1\": \"resolution\",\n \"o1\": \"notequals\",\n \"v1\": \"---\",\n }\n )\n\n r = utils.get_session(\"bugzilla\").get(\n \"https://bugzilla.mozilla.org/rest/bug\",\n params=params,\n headers={\"X-Bugzilla-API-Key\": Bugzilla.TOKEN, \"User-Agent\": \"bugbug\"},\n )\n r.raise_for_status()\n\n data[query_type][severity] = r.json()[\"bug_count\"]\n\n # Calculate number of bugs without severity set.\n for query_type in data.keys():\n data[query_type][\"--\"] = data[query_type][\"--\"] - sum(\n data[query_type][s]\n for s in MAINTENANCE_EFFECTIVENESS_SEVERITY_WEIGHTS.keys()\n if s != \"--\"\n )\n\n open_defects = sum(data[\"open\"].values())\n opened_defects = sum(data[\"opened\"].values())\n closed_defects = sum(data[\"closed\"].values())\n\n print(\"Before applying weights:\")\n print(data)\n\n for query_type in data.keys():\n # Apply weights.\n for (\n severity,\n weight,\n ) in MAINTENANCE_EFFECTIVENESS_SEVERITY_WEIGHTS.items():\n data[query_type][severity] *= weight\n\n print(\"After applying weights:\")\n print(data)\n\n weighed_open_defects = sum(data[\"open\"].values())\n weighed_opened_defects = sum(data[\"opened\"].values())\n weighed_closed_defects = sum(data[\"closed\"].values())\n\n if weighed_opened_defects > 0:\n mei = 100 * weighed_closed_defects / weighed_opened_defects\n else:\n mei = 100 * (weighed_closed_defects + 1)\n\n duration = (to_date - from_date).total_seconds() / 31536000\n\n if closed_defects > opened_defects:\n bdtime = duration * (open_defects / (closed_defects - opened_defects))\n else:\n bdtime = math.inf\n\n if weighed_closed_defects > weighed_opened_defects:\n wbdtime = duration * (\n weighed_open_defects / (weighed_closed_defects - weighed_opened_defects)\n )\n else:\n wbdtime = math.inf\n\n return {\n \"ME%\": mei,\n \"BDTime\": bdtime,\n \"WBDTime\": wbdtime,\n }\n","path":"bugbug/bugzilla.py"}],"string":"[\n {\n \"content\": \"# -*- coding: utf-8 -*-\\n# This Source Code Form is subject to the terms of the Mozilla Public\\n# License, v. 2.0. If a copy of the MPL was not distributed with this file,\\n# You can obtain one at http://mozilla.org/MPL/2.0/.\\n\\nimport collections\\nimport csv\\nimport math\\nimport re\\nfrom datetime import datetime\\nfrom logging import INFO, basicConfig, getLogger\\nfrom typing import Iterable, Iterator, NewType, Optional\\n\\nimport tenacity\\nfrom dateutil.relativedelta import relativedelta\\nfrom libmozdata.bugzilla import Bugzilla\\nfrom tqdm import tqdm\\n\\nfrom bugbug import db, utils\\n\\nbasicConfig(level=INFO)\\nlogger = getLogger(__name__)\\n\\nBugDict = NewType(\\\"BugDict\\\", dict)\\n\\nBUGS_DB = \\\"data/bugs.json\\\"\\ndb.register(\\n BUGS_DB,\\n \\\"https://community-tc.services.mozilla.com/api/index/v1/task/project.bugbug.data_bugs.latest/artifacts/public/bugs.json.zst\\\",\\n 9,\\n)\\n\\nPRODUCTS = (\\n \\\"Cloud Services\\\",\\n \\\"Core\\\",\\n \\\"Data Platform and Tools\\\",\\n \\\"DevTools\\\",\\n \\\"Developer Infrastructure\\\",\\n \\\"External Software Affecting Firefox\\\",\\n \\\"Fenix\\\",\\n \\\"Firefox\\\",\\n \\\"Firefox Build System\\\",\\n \\\"Firefox for iOS\\\",\\n \\\"GeckoView\\\",\\n \\\"Invalid Bugs\\\",\\n \\\"JSS\\\",\\n \\\"NSPR\\\",\\n \\\"NSS\\\",\\n \\\"Release Engineering\\\",\\n \\\"Remote Protocol\\\",\\n \\\"Shield\\\",\\n \\\"Testing\\\",\\n \\\"Toolkit\\\",\\n \\\"Web Compatibility\\\",\\n \\\"WebExtensions\\\",\\n)\\n\\nATTACHMENT_INCLUDE_FIELDS = [\\n \\\"id\\\",\\n \\\"flags\\\",\\n \\\"is_patch\\\",\\n \\\"content_type\\\",\\n \\\"creation_time\\\",\\n \\\"file_name\\\",\\n]\\n\\nCOMMENT_INCLUDE_FIELDS = [\\\"id\\\", \\\"count\\\", \\\"text\\\", \\\"creation_time\\\"]\\n\\nPRODUCT_COMPONENT_CSV_REPORT_URL = \\\"https://bugzilla.mozilla.org/report.cgi\\\"\\n\\nPHAB_REVISION_PATTERN = re.compile(r\\\"phabricator-D([0-9]+)-url.txt\\\")\\n\\nMAINTENANCE_EFFECTIVENESS_SEVERITY_WEIGHTS = {\\n \\\"--\\\": 3,\\n \\\"S1\\\": 8,\\n \\\"S2\\\": 5,\\n \\\"S3\\\": 2,\\n \\\"S4\\\": 1,\\n}\\nMAINTENANCE_EFFECTIVENESS_SEVERITY_DEFAULT_WEIGHT = 3\\n\\nINCLUDE_FIELDS = [\\\"_default\\\", \\\"filed_via\\\"]\\n\\n\\ndef get_bugs(include_invalid: Optional[bool] = False) -> Iterator[BugDict]:\\n yield from (\\n bug\\n for bug in db.read(BUGS_DB)\\n if include_invalid or bug[\\\"product\\\"] != \\\"Invalid Bugs\\\"\\n )\\n\\n\\ndef set_token(token):\\n Bugzilla.TOKEN = token\\n\\n\\ndef get_ids(params):\\n assert \\\"include_fields\\\" not in params or params[\\\"include_fields\\\"] == \\\"id\\\"\\n\\n old_CHUNK_SIZE = Bugzilla.BUGZILLA_CHUNK_SIZE\\n try:\\n Bugzilla.BUGZILLA_CHUNK_SIZE = 7000\\n\\n all_ids = []\\n\\n def bughandler(bug):\\n all_ids.append(bug[\\\"id\\\"])\\n\\n params[\\\"include_fields\\\"] = \\\"id\\\"\\n\\n Bugzilla(params, bughandler=bughandler).get_data().wait()\\n finally:\\n Bugzilla.BUGZILLA_CHUNK_SIZE = old_CHUNK_SIZE\\n\\n return all_ids\\n\\n\\ndef get(ids_or_query):\\n new_bugs = {}\\n\\n def bughandler(bug):\\n bug_id = int(bug[\\\"id\\\"])\\n\\n if bug_id not in new_bugs:\\n new_bugs[bug_id] = dict()\\n\\n new_bugs[bug_id].update(bug)\\n\\n def commenthandler(bug, bug_id):\\n bug_id = int(bug_id)\\n\\n if bug_id not in new_bugs:\\n new_bugs[bug_id] = dict()\\n\\n new_bugs[bug_id][\\\"comments\\\"] = bug[\\\"comments\\\"]\\n\\n def attachmenthandler(bug, bug_id):\\n bug_id = int(bug_id)\\n\\n if bug_id not in new_bugs:\\n new_bugs[bug_id] = dict()\\n\\n new_bugs[bug_id][\\\"attachments\\\"] = bug\\n\\n def historyhandler(bug):\\n bug_id = int(bug[\\\"id\\\"])\\n\\n if bug_id not in new_bugs:\\n new_bugs[bug_id] = dict()\\n\\n new_bugs[bug_id][\\\"history\\\"] = bug[\\\"history\\\"]\\n\\n Bugzilla(\\n ids_or_query,\\n include_fields=INCLUDE_FIELDS,\\n bughandler=bughandler,\\n commenthandler=commenthandler,\\n comment_include_fields=COMMENT_INCLUDE_FIELDS,\\n attachmenthandler=attachmenthandler,\\n attachment_include_fields=ATTACHMENT_INCLUDE_FIELDS,\\n historyhandler=historyhandler,\\n ).get_data().wait()\\n\\n return new_bugs\\n\\n\\ndef get_ids_between(date_from, date_to=None, security=False, resolution=None):\\n params = {\\n \\\"f1\\\": \\\"creation_ts\\\",\\n \\\"o1\\\": \\\"greaterthan\\\",\\n \\\"v1\\\": date_from.strftime(\\\"%Y-%m-%d\\\"),\\n \\\"product\\\": PRODUCTS,\\n }\\n\\n if date_to is not None:\\n params[\\\"f2\\\"] = \\\"creation_ts\\\"\\n params[\\\"o2\\\"] = \\\"lessthan\\\"\\n params[\\\"v2\\\"] = date_to.strftime(\\\"%Y-%m-%d\\\")\\n\\n if not security:\\n params[\\\"f3\\\"] = \\\"bug_group\\\"\\n params[\\\"o3\\\"] = \\\"isempty\\\"\\n\\n if resolution is not None:\\n params[\\\"resolution\\\"] = resolution\\n\\n return get_ids(params)\\n\\n\\ndef download_bugs(bug_ids: Iterable[int], security: bool = False) -> list[BugDict]:\\n old_bug_count = 0\\n new_bug_ids_set = set(int(bug_id) for bug_id in bug_ids)\\n for bug in get_bugs(include_invalid=True):\\n old_bug_count += 1\\n new_bug_ids_set.discard(int(bug[\\\"id\\\"]))\\n\\n logger.info(\\\"Loaded %d bugs.\\\", old_bug_count)\\n\\n new_bug_ids = sorted(list(new_bug_ids_set))\\n\\n chunks = (\\n new_bug_ids[i : (i + Bugzilla.BUGZILLA_CHUNK_SIZE)]\\n for i in range(0, len(new_bug_ids), Bugzilla.BUGZILLA_CHUNK_SIZE)\\n )\\n\\n @tenacity.retry(\\n stop=tenacity.stop_after_attempt(7),\\n wait=tenacity.wait_exponential(multiplier=1, min=16, max=64),\\n )\\n def get_chunk(chunk: list[int]) -> list[BugDict]:\\n new_bugs = get(chunk)\\n\\n if not security:\\n new_bugs = [bug for bug in new_bugs.values() if len(bug[\\\"groups\\\"]) == 0]\\n\\n return new_bugs\\n\\n all_new_bugs = []\\n\\n with tqdm(total=len(new_bug_ids)) as progress_bar:\\n for chunk in chunks:\\n new_bugs = get_chunk(chunk)\\n\\n progress_bar.update(len(chunk))\\n\\n db.append(BUGS_DB, new_bugs)\\n\\n all_new_bugs += new_bugs\\n\\n return all_new_bugs\\n\\n\\ndef _find_linked(\\n bug_map: dict[int, BugDict], bug: BugDict, link_type: str\\n) -> list[int]:\\n return sum(\\n (\\n _find_linked(bug_map, bug_map[b], link_type)\\n for b in bug[link_type]\\n if b in bug_map\\n ),\\n [b for b in bug[link_type] if b in bug_map],\\n )\\n\\n\\ndef find_blocked_by(bug_map: dict[int, BugDict], bug: BugDict) -> list[int]:\\n return _find_linked(bug_map, bug, \\\"blocks\\\")\\n\\n\\ndef find_blocking(bug_map: dict[int, BugDict], bug: BugDict) -> list[int]:\\n return _find_linked(bug_map, bug, \\\"depends_on\\\")\\n\\n\\ndef get_fixed_versions(bug):\\n versions = set()\\n\\n target_milestone_patterns = [\\n re.compile(\\\"mozilla([0-9]+)\\\"),\\n re.compile(\\\"([0-9]+) Branch\\\"),\\n re.compile(\\\"Firefox ([0-9]+)\\\"),\\n ]\\n for target_milestone_pattern in target_milestone_patterns:\\n m = target_milestone_pattern.match(bug[\\\"target_milestone\\\"])\\n if m:\\n versions.add(int(m.group(1)))\\n\\n status_pattern = re.compile(\\\"cf_status_firefox([0-9]+)\\\")\\n for field, value in bug.items():\\n if value != \\\"fixed\\\":\\n continue\\n\\n m = status_pattern.match(field)\\n if m:\\n versions.add(int(m.group(1)))\\n\\n return list(versions)\\n\\n\\ndef delete_bugs(match):\\n db.delete(BUGS_DB, match)\\n\\n\\ndef count_bugs(bug_query_params):\\n bug_query_params[\\\"count_only\\\"] = 1\\n\\n r = utils.get_session(\\\"bugzilla\\\").get(\\n \\\"https://bugzilla.mozilla.org/rest/bug\\\", params=bug_query_params\\n )\\n r.raise_for_status()\\n count = r.json()[\\\"bug_count\\\"]\\n\\n return count\\n\\n\\ndef get_product_component_count(months: int = 12) -> dict[str, int]:\\n \\\"\\\"\\\"Get the number of bugs per component.\\n\\n Returns:\\n a dictionary where keys are full components (in the form of\\n `{product}::{component}`) and the value of the number of bugs for the\\n given full components. Full component with 0 bugs are returned.\\n \\\"\\\"\\\"\\n since = datetime.utcnow() - relativedelta(months=months)\\n\\n # Base params\\n params = {\\n \\\"f1\\\": \\\"creation_ts\\\",\\n \\\"o1\\\": \\\"greaterthan\\\",\\n \\\"v1\\\": since.strftime(\\\"%Y-%m-%d\\\"),\\n \\\"x_axis_field\\\": \\\"product\\\",\\n \\\"y_axis_field\\\": \\\"component\\\",\\n \\\"action\\\": \\\"wrap\\\",\\n \\\"ctype\\\": \\\"csv\\\",\\n \\\"format\\\": \\\"table\\\",\\n }\\n\\n csv_file = utils.get_session(\\\"bugzilla\\\").get(\\n PRODUCT_COMPONENT_CSV_REPORT_URL, params=params\\n )\\n csv_file.raise_for_status()\\n content = csv_file.text\\n\\n csv_content = content.splitlines()\\n component_key = \\\"Component / Product\\\"\\n\\n bugs_number = {}\\n\\n csv_reader = csv.DictReader(csv_content)\\n for row in csv_reader:\\n # Extract the component key\\n component = row[component_key]\\n\\n for product, raw_value in row.items():\\n if product == component_key:\\n continue\\n\\n value = int(raw_value)\\n # If there are no bugs, the product/component pair doesn't exist.\\n if value == 0:\\n continue\\n\\n full_comp = f\\\"{product}::{component}\\\"\\n bugs_number[full_comp] = value\\n\\n return bugs_number\\n\\n\\ndef get_active_product_components(products=[]) -> set[tuple[str, str]]:\\n r = utils.get_session(\\\"bugzilla\\\").get(\\n \\\"https://bugzilla.mozilla.org/rest/product\\\",\\n params={\\n \\\"type\\\": \\\"accessible\\\",\\n \\\"include_fields\\\": [\\n \\\"name\\\",\\n \\\"is_active\\\",\\n \\\"components.name\\\",\\n \\\"components.is_active\\\",\\n ],\\n \\\"names\\\": products,\\n },\\n headers={\\\"X-Bugzilla-API-Key\\\": Bugzilla.TOKEN, \\\"User-Agent\\\": \\\"bugbug\\\"},\\n )\\n r.raise_for_status()\\n\\n return set(\\n (product[\\\"name\\\"], component[\\\"name\\\"])\\n for product in r.json()[\\\"products\\\"]\\n if product[\\\"is_active\\\"]\\n for component in product[\\\"components\\\"]\\n if component[\\\"is_active\\\"]\\n )\\n\\n\\ndef get_component_team_mapping() -> dict[str, dict[str, str]]:\\n r = utils.get_session(\\\"bugzilla\\\").get(\\n \\\"https://bugzilla.mozilla.org/rest/product\\\",\\n params={\\n \\\"type\\\": \\\"accessible\\\",\\n \\\"include_fields\\\": [\\\"name\\\", \\\"components.name\\\", \\\"components.team_name\\\"],\\n },\\n headers={\\\"X-Bugzilla-API-Key\\\": Bugzilla.TOKEN, \\\"User-Agent\\\": \\\"bugbug\\\"},\\n )\\n r.raise_for_status()\\n\\n mapping: dict[str, dict[str, str]] = collections.defaultdict(dict)\\n for product in r.json()[\\\"products\\\"]:\\n for component in product[\\\"components\\\"]:\\n mapping[product[\\\"name\\\"]][component[\\\"name\\\"]] = component[\\\"team_name\\\"]\\n\\n return mapping\\n\\n\\ndef get_groups_users(group_names: list[str]) -> list[str]:\\n r = utils.get_session(\\\"bugzilla\\\").get(\\n \\\"https://bugzilla.mozilla.org/rest/group\\\",\\n params={\\n \\\"names\\\": group_names,\\n \\\"membership\\\": \\\"1\\\",\\n },\\n headers={\\\"X-Bugzilla-API-Key\\\": Bugzilla.TOKEN, \\\"User-Agent\\\": \\\"bugbug\\\"},\\n )\\n r.raise_for_status()\\n\\n return [\\n member[\\\"email\\\"]\\n for group in r.json()[\\\"groups\\\"]\\n for member in group[\\\"membership\\\"]\\n ]\\n\\n\\ndef get_revision_ids(bug: BugDict) -> list[int]:\\n revision_ids = []\\n\\n for attachment in bug[\\\"attachments\\\"]:\\n if attachment[\\\"content_type\\\"] != \\\"text/x-phabricator-request\\\":\\n continue\\n\\n match = PHAB_REVISION_PATTERN.search(attachment[\\\"file_name\\\"])\\n if match is None:\\n continue\\n\\n revision_ids.append(int(match.group(1)))\\n\\n return revision_ids\\n\\n\\ndef get_last_activity_excluding_bots(bug: BugDict) -> str:\\n email_parts = [\\n \\\"@bots.tld\\\",\\n \\\"@mozilla.tld\\\",\\n \\\"nobody@mozilla.org\\\",\\n ]\\n\\n for history in bug[\\\"history\\\"][::-1]:\\n if not any(email_part in history[\\\"who\\\"] for email_part in email_parts):\\n return history[\\\"when\\\"]\\n\\n return bug[\\\"creation_time\\\"]\\n\\n\\ndef calculate_maintenance_effectiveness_indicator(\\n team,\\n from_date,\\n to_date,\\n components=None,\\n):\\n data: dict[str, dict[str, int]] = {\\n \\\"open\\\": {},\\n \\\"opened\\\": {},\\n \\\"closed\\\": {},\\n }\\n\\n logger.info(\\n \\\"Calculating maintenance effectiveness indicator for the %s team from %s to %s\\\",\\n team,\\n from_date,\\n to_date,\\n )\\n\\n for severity in MAINTENANCE_EFFECTIVENESS_SEVERITY_WEIGHTS.keys():\\n params = {\\n \\\"count_only\\\": 1,\\n \\\"type\\\": \\\"defect\\\",\\n \\\"team_name\\\": team,\\n }\\n\\n if severity != \\\"--\\\":\\n params[\\\"bug_severity\\\"] = severity\\n\\n if components is not None:\\n params[\\\"component\\\"] = components\\n\\n for query_type in data.keys():\\n if query_type in (\\\"opened\\\", \\\"closed\\\"):\\n params.update(\\n {\\n \\\"chfieldfrom\\\": from_date.strftime(\\\"%Y-%m-%d\\\"),\\n \\\"chfieldto\\\": to_date.strftime(\\\"%Y-%m-%d\\\"),\\n }\\n )\\n\\n if query_type == \\\"open\\\":\\n params.update(\\n {\\n \\\"f1\\\": \\\"resolution\\\",\\n \\\"o1\\\": \\\"equals\\\",\\n \\\"v1\\\": \\\"---\\\",\\n }\\n )\\n elif query_type == \\\"opened\\\":\\n params[\\\"chfield\\\"] = \\\"[Bug creation]\\\"\\n elif query_type == \\\"closed\\\":\\n params.update(\\n {\\n \\\"chfield\\\": \\\"cf_last_resolved\\\",\\n \\\"f1\\\": \\\"resolution\\\",\\n \\\"o1\\\": \\\"notequals\\\",\\n \\\"v1\\\": \\\"---\\\",\\n }\\n )\\n\\n r = utils.get_session(\\\"bugzilla\\\").get(\\n \\\"https://bugzilla.mozilla.org/rest/bug\\\",\\n params=params,\\n headers={\\\"X-Bugzilla-API-Key\\\": Bugzilla.TOKEN, \\\"User-Agent\\\": \\\"bugbug\\\"},\\n )\\n r.raise_for_status()\\n\\n data[query_type][severity] = r.json()[\\\"bug_count\\\"]\\n\\n # Calculate number of bugs without severity set.\\n for query_type in data.keys():\\n data[query_type][\\\"--\\\"] = data[query_type][\\\"--\\\"] - sum(\\n data[query_type][s]\\n for s in MAINTENANCE_EFFECTIVENESS_SEVERITY_WEIGHTS.keys()\\n if s != \\\"--\\\"\\n )\\n\\n open_defects = sum(data[\\\"open\\\"].values())\\n opened_defects = sum(data[\\\"opened\\\"].values())\\n closed_defects = sum(data[\\\"closed\\\"].values())\\n\\n print(\\\"Before applying weights:\\\")\\n print(data)\\n\\n for query_type in data.keys():\\n # Apply weights.\\n for (\\n severity,\\n weight,\\n ) in MAINTENANCE_EFFECTIVENESS_SEVERITY_WEIGHTS.items():\\n data[query_type][severity] *= weight\\n\\n print(\\\"After applying weights:\\\")\\n print(data)\\n\\n weighed_open_defects = sum(data[\\\"open\\\"].values())\\n weighed_opened_defects = sum(data[\\\"opened\\\"].values())\\n weighed_closed_defects = sum(data[\\\"closed\\\"].values())\\n\\n if weighed_opened_defects > 0:\\n mei = 100 * weighed_closed_defects / weighed_opened_defects\\n else:\\n mei = 100 * (weighed_closed_defects + 1)\\n\\n duration = (to_date - from_date).total_seconds() / 31536000\\n\\n if closed_defects > opened_defects:\\n bdtime = duration * (open_defects / (closed_defects - opened_defects))\\n else:\\n bdtime = math.inf\\n\\n if weighed_closed_defects > weighed_opened_defects:\\n wbdtime = duration * (\\n weighed_open_defects / (weighed_closed_defects - weighed_opened_defects)\\n )\\n else:\\n wbdtime = math.inf\\n\\n return {\\n \\\"ME%\\\": mei,\\n \\\"BDTime\\\": bdtime,\\n \\\"WBDTime\\\": wbdtime,\\n }\\n\",\n \"path\": \"bugbug/bugzilla.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"# -*- coding: utf-8 -*-\n# This Source Code Form is subject to the terms of the Mozilla Public\n# License, v. 2.0. If a copy of the MPL was not distributed with this file,\n# You can obtain one at http://mozilla.org/MPL/2.0/.\n\nimport collections\nimport csv\nimport math\nimport re\nfrom datetime import datetime\nfrom logging import INFO, basicConfig, getLogger\nfrom typing import Iterable, Iterator, NewType, Optional\n\nimport tenacity\nfrom dateutil.relativedelta import relativedelta\nfrom libmozdata.bugzilla import Bugzilla\nfrom tqdm import tqdm\n\nfrom bugbug import db, utils\n\nbasicConfig(level=INFO)\nlogger = getLogger(__name__)\n\nBugDict = NewType(\"BugDict\", dict)\n\nBUGS_DB = \"data/bugs.json\"\ndb.register(\n BUGS_DB,\n \"https://community-tc.services.mozilla.com/api/index/v1/task/project.bugbug.data_bugs.latest/artifacts/public/bugs.json.zst\",\n 9,\n)\n\nPRODUCTS = (\n \"Cloud Services\",\n \"Core\",\n \"Data Platform and Tools\",\n \"DevTools\",\n \"Developer Infrastructure\",\n \"External Software Affecting Firefox\",\n \"Fenix\",\n \"Firefox\",\n \"Firefox Build System\",\n \"Firefox for iOS\",\n \"GeckoView\",\n \"Invalid Bugs\",\n \"JSS\",\n \"NSPR\",\n \"NSS\",\n \"Release Engineering\",\n \"Remote Protocol\",\n \"Shield\",\n \"Testing\",\n \"Toolkit\",\n \"Web Compatibility\",\n \"WebExtensions\",\n)\n\nATTACHMENT_INCLUDE_FIELDS = [\n \"id\",\n \"flags\",\n \"is_patch\",\n \"content_type\",\n \"creation_time\",\n \"file_name\",\n]\n\nCOMMENT_INCLUDE_FIELDS = [\"id\", \"count\", \"text\", \"creation_time\"]\n\nPRODUCT_COMPONENT_CSV_REPORT_URL = \"https://bugzilla.mozilla.org/report.cgi\"\n\nPHAB_REVISION_PATTERN = re.compile(r\"phabricator-D([0-9]+)-url.txt\")\n\nMAINTENANCE_EFFECTIVENESS_SEVERITY_WEIGHTS = {\n \"--\": 3,\n \"S1\": 8,\n \"S2\": 5,\n \"S3\": 2,\n \"S4\": 1,\n}\nMAINTENANCE_EFFECTIVENESS_SEVERITY_DEFAULT_WEIGHT = 3\n\nINCLUDE_FIELDS = [\"_default\", \"filed_via\"]\n\n\ndef get_bugs(include_invalid: Optional[bool] = False) -> Iterator[BugDict]:\n yield from (\n bug\n for bug in db.read(BUGS_DB)\n if include_invalid or bug[\"product\"] != \"Invalid Bugs\"\n )\n\n\ndef set_token(token):\n Bugzilla.TOKEN = token\n\n\ndef get_ids(params):\n assert \"include_fields\" not in params or params[\"include_fields\"] == \"id\"\n\n old_CHUNK_SIZE = Bugzilla.BUGZILLA_CHUNK_SIZE\n try:\n Bugzilla.BUGZILLA_CHUNK_SIZE = 7000\n\n all_ids = []\n\n def bughandler(bug):\n all_ids.append(bug[\"id\"])\n\n params[\"include_fields\"] = \"id\"\n\n Bugzilla(params, bughandler=bughandler).get_data().wait()\n finally:\n Bugzilla.BUGZILLA_CHUNK_SIZE = old_CHUNK_SIZE\n\n return all_ids\n\n\ndef get(ids_or_query):\n new_bugs = {}\n\n def bughandler(bug):\n bug_id = int(bug[\"id\"])\n\n if bug_id not in new_bugs:\n new_bugs[bug_id] = dict()\n\n new_bugs[bug_id].update(bug)\n\n def commenthandler(bug, bug_id):\n bug_id = int(bug_id)\n\n if bug_id not in new_bugs:\n new_bugs[bug_id] = dict()\n\n new_bugs[bug_id][\"comments\"] = bug[\"comments\"]\n\n def attachmenthandler(bug, bug_id):\n bug_id = int(bug_id)\n\n if bug_id not in new_bugs:\n new_bugs[bug_id] = dict()\n\n new_bugs[bug_id][\"attachments\"] = bug\n\n def historyhandler(bug):\n bug_id = int(bug[\"id\"])\n\n if bug_id not in new_bugs:\n new_bugs[bug_id] = dict()\n\n new_bugs[bug_id][\"history\"] = bug[\"history\"]\n\n Bugzilla(\n ids_or_query,\n include_fields=INCLUDE_FIELDS,\n bughandler=bughandler,\n commenthandler=commenthandler,\n comment_include_fields=COMMENT_INCLUDE_FIELDS,\n attachmenthandler=attachmenthandler,\n attachment_include_fields=ATTACHMENT_INCLUDE_FIELDS,\n historyhandler=historyhandler,\n ).get_data().wait()\n\n return new_bugs\n\n\ndef get_ids_between(date_from, date_to=None, security=False, resolution=None):\n params = {\n \"f1\": \"creation_ts\",\n \"o1\": \"greaterthan\",\n \"v1\": date_from.strftime(\"%Y-%m-%d\"),\n \"product\": PRODUCTS,\n }\n\n if date_to is not None:\n params[\"f2\"] = \"creation_ts\"\n params[\"o2\"] = \"lessthan\"\n params[\"v2\"] = date_to.strftime(\"%Y-%m-%d\")\n\n if not security:\n params[\"f3\"] = \"bug_group\"\n params[\"o3\"] = \"isempty\"\n\n if resolution is not None:\n params[\"resolution\"] = resolution\n\n return get_ids(params)\n\n\ndef download_bugs(bug_ids: Iterable[int], security: bool = False) -> list[BugDict]:\n old_bug_count = 0\n new_bug_ids_set = set(int(bug_id) for bug_id in bug_ids)\n for bug in get_bugs(include_invalid=True):\n old_bug_count += 1\n new_bug_ids_set.discard(int(bug[\"id\"]))\n\n logger.info(\"Loaded %d bugs.\", old_bug_count)\n\n new_bug_ids = sorted(list(new_bug_ids_set))\n\n chunks = (\n new_bug_ids[i : (i + Bugzilla.BUGZILLA_CHUNK_SIZE)]\n for i in range(0, len(new_bug_ids), Bugzilla.BUGZILLA_CHUNK_SIZE)\n )\n\n @tenacity.retry(\n stop=tenacity.stop_after_attempt(7),\n wait=tenacity.wait_exponential(multiplier=1, min=16, max=64),\n )\n def get_chunk(chunk: list[int]) -> list[BugDict]:\n new_bugs = get(chunk)\n\n if not security:\n new_bugs = [bug for bug in new_bugs.values() if len(bug[\"groups\"]) == 0]\n\n return new_bugs\n\n all_new_bugs = []\n\n with tqdm(total=len(new_bug_ids)) as progress_bar:\n for chunk in chunks:\n new_bugs = get_chunk(chunk)\n\n progress_bar.update(len(chunk))\n\n db.append(BUGS_DB, new_bugs)\n\n all_new_bugs += new_bugs\n\n return all_new_bugs\n\n\ndef _find_linked(\n bug_map: dict[int, BugDict], bug: BugDict, link_type: str\n) -> list[int]:\n return sum(\n (\n _find_linked(bug_map, bug_map[b], link_type)\n for b in bug[link_type]\n if b in bug_map\n ),\n [b for b in bug[link_type] if b in bug_map],\n )\n\n\ndef find_blocked_by(bug_map: dict[int, BugDict], bug: BugDict) -> list[int]:\n return _find_linked(bug_map, bug, \"blocks\")\n\n\ndef find_blocking(bug_map: dict[int, BugDict], bug: BugDict) -> list[int]:\n return _find_linked(bug_map, bug, \"depends_on\")\n\n\ndef get_fixed_versions(bug):\n versions = set()\n\n target_milestone_patterns = [\n re.compile(\"mozilla([0-9]+)\"),\n re.compile(\"([0-9]+) Branch\"),\n re.compile(\"Firefox ([0-9]+)\"),\n ]\n for target_milestone_pattern in target_milestone_patterns:\n m = target_milestone_pattern.match(bug[\"target_milestone\"])\n if m:\n versions.add(int(m.group(1)))\n\n status_pattern = re.compile(\"cf_status_firefox([0-9]+)\")\n for field, value in bug.items():\n if value != \"fixed\":\n continue\n\n m = status_pattern.match(field)\n if m:\n versions.add(int(m.group(1)))\n\n return list(versions)\n\n\ndef delete_bugs(match):\n db.delete(BUGS_DB, match)\n\n\ndef count_bugs(bug_query_params):\n bug_query_params[\"count_only\"] = 1\n\n r = utils.get_session(\"bugzilla\").get(\n \"https://bugzilla.mozilla.org/rest/bug\", params=bug_query_params\n )\n r.raise_for_status()\n count = r.json()[\"bug_count\"]\n\n return count\n\n\ndef get_product_component_count(months: int = 12) -> dict[str, int]:\n \"\"\"Get the number of bugs per component.\n\n Returns:\n a dictionary where keys are full components (in the form of\n `{product}::{component}`) and the value of the number of bugs for the\n given full components. Full component with 0 bugs are returned.\n \"\"\"\n since = datetime.utcnow() - relativedelta(months=months)\n\n # Base params\n params = {\n \"f1\": \"creation_ts\",\n \"o1\": \"greaterthan\",\n \"v1\": since.strftime(\"%Y-%m-%d\"),\n \"x_axis_field\": \"product\",\n \"y_axis_field\": \"component\",\n \"action\": \"wrap\",\n \"ctype\": \"csv\",\n \"format\": \"table\",\n }\n\n csv_file = utils.get_session(\"bugzilla\").get(\n PRODUCT_COMPONENT_CSV_REPORT_URL, params=params\n )\n csv_file.raise_for_status()\n content = csv_file.text\n\n csv_content = content.splitlines()\n component_key = \"Component / Product\"\n\n bugs_number = {}\n\n csv_reader = csv.DictReader(csv_content)\n for row in csv_reader:\n # Extract the component key\n component = row[component_key]\n\n for product, raw_value in row.items():\n if product == component_key:\n continue\n\n value = int(raw_value)\n # If there are no bugs, the product/component pair doesn't exist.\n if value == 0:\n continue\n\n full_comp = f\"{product}::{component}\"\n bugs_number[full_comp] = value\n\n return bugs_number\n\n\ndef get_active_product_components(products=[]) -> set[tuple[str, str]]:\n r = utils.get_session(\"bugzilla\").get(\n \"https://bugzilla.mozilla.org/rest/product\",\n params={\n \"type\": \"accessible\",\n \"include_fields\": [\n \"name\",\n \"is_active\",\n \"components.name\",\n \"components.is_active\",\n ],\n \"names\": products,\n },\n headers={\"X-Bugzilla-API-Key\": Bugzilla.TOKEN, \"User-Agent\": \"bugbug\"},\n )\n r.raise_for_status()\n\n return set(\n (product[\"name\"], component[\"name\"])\n for product in r.json()[\"products\"]\n if product[\"is_active\"]\n for component in product[\"components\"]\n if component[\"is_active\"]\n )\n\n\ndef get_component_team_mapping() -> dict[str, dict[str, str]]:\n r = utils.get_session(\"bugzilla\").get(\n \"https://bugzilla.mozilla.org/rest/product\",\n params={\n \"type\": \"accessible\",\n \"include_fields\": [\"name\", \"components.name\", \"components.team_name\"],\n },\n headers={\"X-Bugzilla-API-Key\": Bugzilla.TOKEN, \"User-Agent\": \"bugbug\"},\n )\n r.raise_for_status()\n\n mapping: dict[str, dict[str, str]] = collections.defaultdict(dict)\n for product in r.json()[\"products\"]:\n for component in product[\"components\"]:\n mapping[product[\"name\"]][component[\"name\"]] = component[\"team_name\"]\n\n return mapping\n\n\ndef get_groups_users(group_names: list[str]) -> list[str]:\n r = utils.get_session(\"bugzilla\").get(\n \"https://bugzilla.mozilla.org/rest/group\",\n params={\n \"names\": group_names,\n \"membership\": \"1\",\n },\n headers={\"X-Bugzilla-API-Key\": Bugzilla.TOKEN, \"User-Agent\": \"bugbug\"},\n )\n r.raise_for_status()\n\n return [\n member[\"email\"]\n for group in r.json()[\"groups\"]\n for member in group[\"membership\"]\n ]\n\n\ndef get_revision_ids(bug: BugDict) -> list[int]:\n revision_ids = []\n\n for attachment in bug[\"attachments\"]:\n if attachment[\"content_type\"] != \"text/x-phabricator-request\":\n continue\n\n match = PHAB_REVISION_PATTERN.search(attachment[\"file_name\"])\n if match is None:\n continue\n\n revision_ids.append(int(match.group(1)))\n\n return revision_ids\n\n\ndef get_last_activity_excluding_bots(bug: BugDict) -> str:\n email_parts = [\n \"@bots.tld\",\n \"@mozilla.tld\",\n \"nobody@mozilla.org\",\n ]\n\n for history in bug[\"history\"][::-1]:\n if not any(email_part in history[\"who\"] for email_part in email_parts):\n return history[\"when\"]\n\n return bug[\"creation_time\"]\n\n\ndef calculate_maintenance_effectiveness_indicator(\n team,\n from_date,\n to_date,\n components=None,\n):\n data: dict[str, dict[str, int]] = {\n \"open\": {},\n \"opened\": {},\n \"closed\": {},\n }\n\n logger.info(\n \"Calculating maintenance effectiveness indicator for the %s team from %s to %s\",\n team,\n from_date,\n to_date,\n )\n\n for severity in MAINTENANCE_EFFECTIVENESS_SEVERITY_WEIGHTS.keys():\n params = {\n \"count_only\": 1,\n \"type\": \"defect\",\n \"team_name\": team,\n }\n\n if severity != \"--\":\n params[\"bug_severity\"] = severity\n\n if components is not None:\n params[\"component\"] = components\n\n for query_type in data.keys():\n if query_type in (\"opened\", \"closed\"):\n params.update(\n {\n \"chfieldfrom\": from_date.strftime(\"%Y-%m-%d\"),\n \"chfieldto\": to_date.strftime(\"%Y-%m-%d\"),\n }\n )\n\n if query_type == \"open\":\n params.update(\n {\n \"f1\": \"resolution\",\n \"o1\": \"equals\",\n \"v1\": \"---\",\n }\n )\n elif query_type == \"opened\":\n params[\"chfield\"] = \"[Bug creation]\"\n elif query_type == \"closed\":\n params.update(\n {\n \"chfield\": \"cf_last_resolved\",\n \"f1\": \"resolution\",\n \"o1\": \"notequals\",\n \"v1\": \"---\",\n }\n )\n\n r = utils.get_session(\"bugzilla\").get(\n \"https://bugzilla.mozilla.org/rest/bug\",\n params=params,\n headers={\"X-Bugzilla-API-Key\": Bugzilla.TOKEN, \"User-Agent\": \"bugbug\"},\n )\n r.raise_for_status()\n\n data[query_type][severity] = r.json()[\"bug_count\"]\n\n # Calculate number of bugs without severity set.\n for query_type in data.keys():\n data[query_type][\"--\"] = data[query_type][\"--\"] - sum(\n data[query_type][s]\n for s in MAINTENANCE_EFFECTIVENESS_SEVERITY_WEIGHTS.keys()\n if s != \"--\"\n )\n\n open_defects = sum(data[\"open\"].values())\n opened_defects = sum(data[\"opened\"].values())\n closed_defects = sum(data[\"closed\"].values())\n\n print(\"Before applying weights:\")\n print(data)\n\n for query_type in data.keys():\n # Apply weights.\n for (\n severity,\n weight,\n ) in MAINTENANCE_EFFECTIVENESS_SEVERITY_WEIGHTS.items():\n data[query_type][severity] *= weight\n\n print(\"After applying weights:\")\n print(data)\n\n weighed_open_defects = sum(data[\"open\"].values())\n weighed_opened_defects = sum(data[\"opened\"].values())\n weighed_closed_defects = sum(data[\"closed\"].values())\n\n if weighed_opened_defects > 0:\n mei = 100 * weighed_closed_defects / weighed_opened_defects\n else:\n mei = 100 * (weighed_closed_defects + 1)\n\n duration = (to_date - from_date).total_seconds() / 31536000\n\n if closed_defects > opened_defects:\n bdtime = duration * (open_defects / (closed_defects - opened_defects))\n else:\n bdtime = math.inf\n\n if weighed_closed_defects > weighed_opened_defects:\n wbdtime = duration * (\n weighed_open_defects / (weighed_closed_defects - weighed_opened_defects)\n )\n else:\n wbdtime = math.inf\n\n estimated_start_open_defects = open_defects + closed_defects - opened_defects\n incoming = 100 * opened_defects / estimated_start_open_defects\n closed = 100 * closed_defects / estimated_start_open_defects\n\n return {\n \"ME%\": mei,\n \"BDTime\": bdtime,\n \"WBDTime\": wbdtime,\n \"Incoming%\": incoming,\n \"Closed%\": closed,\n }\n","path":"bugbug/bugzilla.py"}],"string":"[\n {\n \"content\": \"# -*- coding: utf-8 -*-\\n# This Source Code Form is subject to the terms of the Mozilla Public\\n# License, v. 2.0. If a copy of the MPL was not distributed with this file,\\n# You can obtain one at http://mozilla.org/MPL/2.0/.\\n\\nimport collections\\nimport csv\\nimport math\\nimport re\\nfrom datetime import datetime\\nfrom logging import INFO, basicConfig, getLogger\\nfrom typing import Iterable, Iterator, NewType, Optional\\n\\nimport tenacity\\nfrom dateutil.relativedelta import relativedelta\\nfrom libmozdata.bugzilla import Bugzilla\\nfrom tqdm import tqdm\\n\\nfrom bugbug import db, utils\\n\\nbasicConfig(level=INFO)\\nlogger = getLogger(__name__)\\n\\nBugDict = NewType(\\\"BugDict\\\", dict)\\n\\nBUGS_DB = \\\"data/bugs.json\\\"\\ndb.register(\\n BUGS_DB,\\n \\\"https://community-tc.services.mozilla.com/api/index/v1/task/project.bugbug.data_bugs.latest/artifacts/public/bugs.json.zst\\\",\\n 9,\\n)\\n\\nPRODUCTS = (\\n \\\"Cloud Services\\\",\\n \\\"Core\\\",\\n \\\"Data Platform and Tools\\\",\\n \\\"DevTools\\\",\\n \\\"Developer Infrastructure\\\",\\n \\\"External Software Affecting Firefox\\\",\\n \\\"Fenix\\\",\\n \\\"Firefox\\\",\\n \\\"Firefox Build System\\\",\\n \\\"Firefox for iOS\\\",\\n \\\"GeckoView\\\",\\n \\\"Invalid Bugs\\\",\\n \\\"JSS\\\",\\n \\\"NSPR\\\",\\n \\\"NSS\\\",\\n \\\"Release Engineering\\\",\\n \\\"Remote Protocol\\\",\\n \\\"Shield\\\",\\n \\\"Testing\\\",\\n \\\"Toolkit\\\",\\n \\\"Web Compatibility\\\",\\n \\\"WebExtensions\\\",\\n)\\n\\nATTACHMENT_INCLUDE_FIELDS = [\\n \\\"id\\\",\\n \\\"flags\\\",\\n \\\"is_patch\\\",\\n \\\"content_type\\\",\\n \\\"creation_time\\\",\\n \\\"file_name\\\",\\n]\\n\\nCOMMENT_INCLUDE_FIELDS = [\\\"id\\\", \\\"count\\\", \\\"text\\\", \\\"creation_time\\\"]\\n\\nPRODUCT_COMPONENT_CSV_REPORT_URL = \\\"https://bugzilla.mozilla.org/report.cgi\\\"\\n\\nPHAB_REVISION_PATTERN = re.compile(r\\\"phabricator-D([0-9]+)-url.txt\\\")\\n\\nMAINTENANCE_EFFECTIVENESS_SEVERITY_WEIGHTS = {\\n \\\"--\\\": 3,\\n \\\"S1\\\": 8,\\n \\\"S2\\\": 5,\\n \\\"S3\\\": 2,\\n \\\"S4\\\": 1,\\n}\\nMAINTENANCE_EFFECTIVENESS_SEVERITY_DEFAULT_WEIGHT = 3\\n\\nINCLUDE_FIELDS = [\\\"_default\\\", \\\"filed_via\\\"]\\n\\n\\ndef get_bugs(include_invalid: Optional[bool] = False) -> Iterator[BugDict]:\\n yield from (\\n bug\\n for bug in db.read(BUGS_DB)\\n if include_invalid or bug[\\\"product\\\"] != \\\"Invalid Bugs\\\"\\n )\\n\\n\\ndef set_token(token):\\n Bugzilla.TOKEN = token\\n\\n\\ndef get_ids(params):\\n assert \\\"include_fields\\\" not in params or params[\\\"include_fields\\\"] == \\\"id\\\"\\n\\n old_CHUNK_SIZE = Bugzilla.BUGZILLA_CHUNK_SIZE\\n try:\\n Bugzilla.BUGZILLA_CHUNK_SIZE = 7000\\n\\n all_ids = []\\n\\n def bughandler(bug):\\n all_ids.append(bug[\\\"id\\\"])\\n\\n params[\\\"include_fields\\\"] = \\\"id\\\"\\n\\n Bugzilla(params, bughandler=bughandler).get_data().wait()\\n finally:\\n Bugzilla.BUGZILLA_CHUNK_SIZE = old_CHUNK_SIZE\\n\\n return all_ids\\n\\n\\ndef get(ids_or_query):\\n new_bugs = {}\\n\\n def bughandler(bug):\\n bug_id = int(bug[\\\"id\\\"])\\n\\n if bug_id not in new_bugs:\\n new_bugs[bug_id] = dict()\\n\\n new_bugs[bug_id].update(bug)\\n\\n def commenthandler(bug, bug_id):\\n bug_id = int(bug_id)\\n\\n if bug_id not in new_bugs:\\n new_bugs[bug_id] = dict()\\n\\n new_bugs[bug_id][\\\"comments\\\"] = bug[\\\"comments\\\"]\\n\\n def attachmenthandler(bug, bug_id):\\n bug_id = int(bug_id)\\n\\n if bug_id not in new_bugs:\\n new_bugs[bug_id] = dict()\\n\\n new_bugs[bug_id][\\\"attachments\\\"] = bug\\n\\n def historyhandler(bug):\\n bug_id = int(bug[\\\"id\\\"])\\n\\n if bug_id not in new_bugs:\\n new_bugs[bug_id] = dict()\\n\\n new_bugs[bug_id][\\\"history\\\"] = bug[\\\"history\\\"]\\n\\n Bugzilla(\\n ids_or_query,\\n include_fields=INCLUDE_FIELDS,\\n bughandler=bughandler,\\n commenthandler=commenthandler,\\n comment_include_fields=COMMENT_INCLUDE_FIELDS,\\n attachmenthandler=attachmenthandler,\\n attachment_include_fields=ATTACHMENT_INCLUDE_FIELDS,\\n historyhandler=historyhandler,\\n ).get_data().wait()\\n\\n return new_bugs\\n\\n\\ndef get_ids_between(date_from, date_to=None, security=False, resolution=None):\\n params = {\\n \\\"f1\\\": \\\"creation_ts\\\",\\n \\\"o1\\\": \\\"greaterthan\\\",\\n \\\"v1\\\": date_from.strftime(\\\"%Y-%m-%d\\\"),\\n \\\"product\\\": PRODUCTS,\\n }\\n\\n if date_to is not None:\\n params[\\\"f2\\\"] = \\\"creation_ts\\\"\\n params[\\\"o2\\\"] = \\\"lessthan\\\"\\n params[\\\"v2\\\"] = date_to.strftime(\\\"%Y-%m-%d\\\")\\n\\n if not security:\\n params[\\\"f3\\\"] = \\\"bug_group\\\"\\n params[\\\"o3\\\"] = \\\"isempty\\\"\\n\\n if resolution is not None:\\n params[\\\"resolution\\\"] = resolution\\n\\n return get_ids(params)\\n\\n\\ndef download_bugs(bug_ids: Iterable[int], security: bool = False) -> list[BugDict]:\\n old_bug_count = 0\\n new_bug_ids_set = set(int(bug_id) for bug_id in bug_ids)\\n for bug in get_bugs(include_invalid=True):\\n old_bug_count += 1\\n new_bug_ids_set.discard(int(bug[\\\"id\\\"]))\\n\\n logger.info(\\\"Loaded %d bugs.\\\", old_bug_count)\\n\\n new_bug_ids = sorted(list(new_bug_ids_set))\\n\\n chunks = (\\n new_bug_ids[i : (i + Bugzilla.BUGZILLA_CHUNK_SIZE)]\\n for i in range(0, len(new_bug_ids), Bugzilla.BUGZILLA_CHUNK_SIZE)\\n )\\n\\n @tenacity.retry(\\n stop=tenacity.stop_after_attempt(7),\\n wait=tenacity.wait_exponential(multiplier=1, min=16, max=64),\\n )\\n def get_chunk(chunk: list[int]) -> list[BugDict]:\\n new_bugs = get(chunk)\\n\\n if not security:\\n new_bugs = [bug for bug in new_bugs.values() if len(bug[\\\"groups\\\"]) == 0]\\n\\n return new_bugs\\n\\n all_new_bugs = []\\n\\n with tqdm(total=len(new_bug_ids)) as progress_bar:\\n for chunk in chunks:\\n new_bugs = get_chunk(chunk)\\n\\n progress_bar.update(len(chunk))\\n\\n db.append(BUGS_DB, new_bugs)\\n\\n all_new_bugs += new_bugs\\n\\n return all_new_bugs\\n\\n\\ndef _find_linked(\\n bug_map: dict[int, BugDict], bug: BugDict, link_type: str\\n) -> list[int]:\\n return sum(\\n (\\n _find_linked(bug_map, bug_map[b], link_type)\\n for b in bug[link_type]\\n if b in bug_map\\n ),\\n [b for b in bug[link_type] if b in bug_map],\\n )\\n\\n\\ndef find_blocked_by(bug_map: dict[int, BugDict], bug: BugDict) -> list[int]:\\n return _find_linked(bug_map, bug, \\\"blocks\\\")\\n\\n\\ndef find_blocking(bug_map: dict[int, BugDict], bug: BugDict) -> list[int]:\\n return _find_linked(bug_map, bug, \\\"depends_on\\\")\\n\\n\\ndef get_fixed_versions(bug):\\n versions = set()\\n\\n target_milestone_patterns = [\\n re.compile(\\\"mozilla([0-9]+)\\\"),\\n re.compile(\\\"([0-9]+) Branch\\\"),\\n re.compile(\\\"Firefox ([0-9]+)\\\"),\\n ]\\n for target_milestone_pattern in target_milestone_patterns:\\n m = target_milestone_pattern.match(bug[\\\"target_milestone\\\"])\\n if m:\\n versions.add(int(m.group(1)))\\n\\n status_pattern = re.compile(\\\"cf_status_firefox([0-9]+)\\\")\\n for field, value in bug.items():\\n if value != \\\"fixed\\\":\\n continue\\n\\n m = status_pattern.match(field)\\n if m:\\n versions.add(int(m.group(1)))\\n\\n return list(versions)\\n\\n\\ndef delete_bugs(match):\\n db.delete(BUGS_DB, match)\\n\\n\\ndef count_bugs(bug_query_params):\\n bug_query_params[\\\"count_only\\\"] = 1\\n\\n r = utils.get_session(\\\"bugzilla\\\").get(\\n \\\"https://bugzilla.mozilla.org/rest/bug\\\", params=bug_query_params\\n )\\n r.raise_for_status()\\n count = r.json()[\\\"bug_count\\\"]\\n\\n return count\\n\\n\\ndef get_product_component_count(months: int = 12) -> dict[str, int]:\\n \\\"\\\"\\\"Get the number of bugs per component.\\n\\n Returns:\\n a dictionary where keys are full components (in the form of\\n `{product}::{component}`) and the value of the number of bugs for the\\n given full components. Full component with 0 bugs are returned.\\n \\\"\\\"\\\"\\n since = datetime.utcnow() - relativedelta(months=months)\\n\\n # Base params\\n params = {\\n \\\"f1\\\": \\\"creation_ts\\\",\\n \\\"o1\\\": \\\"greaterthan\\\",\\n \\\"v1\\\": since.strftime(\\\"%Y-%m-%d\\\"),\\n \\\"x_axis_field\\\": \\\"product\\\",\\n \\\"y_axis_field\\\": \\\"component\\\",\\n \\\"action\\\": \\\"wrap\\\",\\n \\\"ctype\\\": \\\"csv\\\",\\n \\\"format\\\": \\\"table\\\",\\n }\\n\\n csv_file = utils.get_session(\\\"bugzilla\\\").get(\\n PRODUCT_COMPONENT_CSV_REPORT_URL, params=params\\n )\\n csv_file.raise_for_status()\\n content = csv_file.text\\n\\n csv_content = content.splitlines()\\n component_key = \\\"Component / Product\\\"\\n\\n bugs_number = {}\\n\\n csv_reader = csv.DictReader(csv_content)\\n for row in csv_reader:\\n # Extract the component key\\n component = row[component_key]\\n\\n for product, raw_value in row.items():\\n if product == component_key:\\n continue\\n\\n value = int(raw_value)\\n # If there are no bugs, the product/component pair doesn't exist.\\n if value == 0:\\n continue\\n\\n full_comp = f\\\"{product}::{component}\\\"\\n bugs_number[full_comp] = value\\n\\n return bugs_number\\n\\n\\ndef get_active_product_components(products=[]) -> set[tuple[str, str]]:\\n r = utils.get_session(\\\"bugzilla\\\").get(\\n \\\"https://bugzilla.mozilla.org/rest/product\\\",\\n params={\\n \\\"type\\\": \\\"accessible\\\",\\n \\\"include_fields\\\": [\\n \\\"name\\\",\\n \\\"is_active\\\",\\n \\\"components.name\\\",\\n \\\"components.is_active\\\",\\n ],\\n \\\"names\\\": products,\\n },\\n headers={\\\"X-Bugzilla-API-Key\\\": Bugzilla.TOKEN, \\\"User-Agent\\\": \\\"bugbug\\\"},\\n )\\n r.raise_for_status()\\n\\n return set(\\n (product[\\\"name\\\"], component[\\\"name\\\"])\\n for product in r.json()[\\\"products\\\"]\\n if product[\\\"is_active\\\"]\\n for component in product[\\\"components\\\"]\\n if component[\\\"is_active\\\"]\\n )\\n\\n\\ndef get_component_team_mapping() -> dict[str, dict[str, str]]:\\n r = utils.get_session(\\\"bugzilla\\\").get(\\n \\\"https://bugzilla.mozilla.org/rest/product\\\",\\n params={\\n \\\"type\\\": \\\"accessible\\\",\\n \\\"include_fields\\\": [\\\"name\\\", \\\"components.name\\\", \\\"components.team_name\\\"],\\n },\\n headers={\\\"X-Bugzilla-API-Key\\\": Bugzilla.TOKEN, \\\"User-Agent\\\": \\\"bugbug\\\"},\\n )\\n r.raise_for_status()\\n\\n mapping: dict[str, dict[str, str]] = collections.defaultdict(dict)\\n for product in r.json()[\\\"products\\\"]:\\n for component in product[\\\"components\\\"]:\\n mapping[product[\\\"name\\\"]][component[\\\"name\\\"]] = component[\\\"team_name\\\"]\\n\\n return mapping\\n\\n\\ndef get_groups_users(group_names: list[str]) -> list[str]:\\n r = utils.get_session(\\\"bugzilla\\\").get(\\n \\\"https://bugzilla.mozilla.org/rest/group\\\",\\n params={\\n \\\"names\\\": group_names,\\n \\\"membership\\\": \\\"1\\\",\\n },\\n headers={\\\"X-Bugzilla-API-Key\\\": Bugzilla.TOKEN, \\\"User-Agent\\\": \\\"bugbug\\\"},\\n )\\n r.raise_for_status()\\n\\n return [\\n member[\\\"email\\\"]\\n for group in r.json()[\\\"groups\\\"]\\n for member in group[\\\"membership\\\"]\\n ]\\n\\n\\ndef get_revision_ids(bug: BugDict) -> list[int]:\\n revision_ids = []\\n\\n for attachment in bug[\\\"attachments\\\"]:\\n if attachment[\\\"content_type\\\"] != \\\"text/x-phabricator-request\\\":\\n continue\\n\\n match = PHAB_REVISION_PATTERN.search(attachment[\\\"file_name\\\"])\\n if match is None:\\n continue\\n\\n revision_ids.append(int(match.group(1)))\\n\\n return revision_ids\\n\\n\\ndef get_last_activity_excluding_bots(bug: BugDict) -> str:\\n email_parts = [\\n \\\"@bots.tld\\\",\\n \\\"@mozilla.tld\\\",\\n \\\"nobody@mozilla.org\\\",\\n ]\\n\\n for history in bug[\\\"history\\\"][::-1]:\\n if not any(email_part in history[\\\"who\\\"] for email_part in email_parts):\\n return history[\\\"when\\\"]\\n\\n return bug[\\\"creation_time\\\"]\\n\\n\\ndef calculate_maintenance_effectiveness_indicator(\\n team,\\n from_date,\\n to_date,\\n components=None,\\n):\\n data: dict[str, dict[str, int]] = {\\n \\\"open\\\": {},\\n \\\"opened\\\": {},\\n \\\"closed\\\": {},\\n }\\n\\n logger.info(\\n \\\"Calculating maintenance effectiveness indicator for the %s team from %s to %s\\\",\\n team,\\n from_date,\\n to_date,\\n )\\n\\n for severity in MAINTENANCE_EFFECTIVENESS_SEVERITY_WEIGHTS.keys():\\n params = {\\n \\\"count_only\\\": 1,\\n \\\"type\\\": \\\"defect\\\",\\n \\\"team_name\\\": team,\\n }\\n\\n if severity != \\\"--\\\":\\n params[\\\"bug_severity\\\"] = severity\\n\\n if components is not None:\\n params[\\\"component\\\"] = components\\n\\n for query_type in data.keys():\\n if query_type in (\\\"opened\\\", \\\"closed\\\"):\\n params.update(\\n {\\n \\\"chfieldfrom\\\": from_date.strftime(\\\"%Y-%m-%d\\\"),\\n \\\"chfieldto\\\": to_date.strftime(\\\"%Y-%m-%d\\\"),\\n }\\n )\\n\\n if query_type == \\\"open\\\":\\n params.update(\\n {\\n \\\"f1\\\": \\\"resolution\\\",\\n \\\"o1\\\": \\\"equals\\\",\\n \\\"v1\\\": \\\"---\\\",\\n }\\n )\\n elif query_type == \\\"opened\\\":\\n params[\\\"chfield\\\"] = \\\"[Bug creation]\\\"\\n elif query_type == \\\"closed\\\":\\n params.update(\\n {\\n \\\"chfield\\\": \\\"cf_last_resolved\\\",\\n \\\"f1\\\": \\\"resolution\\\",\\n \\\"o1\\\": \\\"notequals\\\",\\n \\\"v1\\\": \\\"---\\\",\\n }\\n )\\n\\n r = utils.get_session(\\\"bugzilla\\\").get(\\n \\\"https://bugzilla.mozilla.org/rest/bug\\\",\\n params=params,\\n headers={\\\"X-Bugzilla-API-Key\\\": Bugzilla.TOKEN, \\\"User-Agent\\\": \\\"bugbug\\\"},\\n )\\n r.raise_for_status()\\n\\n data[query_type][severity] = r.json()[\\\"bug_count\\\"]\\n\\n # Calculate number of bugs without severity set.\\n for query_type in data.keys():\\n data[query_type][\\\"--\\\"] = data[query_type][\\\"--\\\"] - sum(\\n data[query_type][s]\\n for s in MAINTENANCE_EFFECTIVENESS_SEVERITY_WEIGHTS.keys()\\n if s != \\\"--\\\"\\n )\\n\\n open_defects = sum(data[\\\"open\\\"].values())\\n opened_defects = sum(data[\\\"opened\\\"].values())\\n closed_defects = sum(data[\\\"closed\\\"].values())\\n\\n print(\\\"Before applying weights:\\\")\\n print(data)\\n\\n for query_type in data.keys():\\n # Apply weights.\\n for (\\n severity,\\n weight,\\n ) in MAINTENANCE_EFFECTIVENESS_SEVERITY_WEIGHTS.items():\\n data[query_type][severity] *= weight\\n\\n print(\\\"After applying weights:\\\")\\n print(data)\\n\\n weighed_open_defects = sum(data[\\\"open\\\"].values())\\n weighed_opened_defects = sum(data[\\\"opened\\\"].values())\\n weighed_closed_defects = sum(data[\\\"closed\\\"].values())\\n\\n if weighed_opened_defects > 0:\\n mei = 100 * weighed_closed_defects / weighed_opened_defects\\n else:\\n mei = 100 * (weighed_closed_defects + 1)\\n\\n duration = (to_date - from_date).total_seconds() / 31536000\\n\\n if closed_defects > opened_defects:\\n bdtime = duration * (open_defects / (closed_defects - opened_defects))\\n else:\\n bdtime = math.inf\\n\\n if weighed_closed_defects > weighed_opened_defects:\\n wbdtime = duration * (\\n weighed_open_defects / (weighed_closed_defects - weighed_opened_defects)\\n )\\n else:\\n wbdtime = math.inf\\n\\n estimated_start_open_defects = open_defects + closed_defects - opened_defects\\n incoming = 100 * opened_defects / estimated_start_open_defects\\n closed = 100 * closed_defects / estimated_start_open_defects\\n\\n return {\\n \\\"ME%\\\": mei,\\n \\\"BDTime\\\": bdtime,\\n \\\"WBDTime\\\": wbdtime,\\n \\\"Incoming%\\\": incoming,\\n \\\"Closed%\\\": closed,\\n }\\n\",\n \"path\": \"bugbug/bugzilla.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/bugbug/bugzilla.py b/bugbug/bugzilla.py\nindex a2bb9e271f..41ba51d1ea 100644\n--- a/bugbug/bugzilla.py\n+++ b/bugbug/bugzilla.py\n@@ -557,8 +557,14 @@ def calculate_maintenance_effectiveness_indicator(\n else:\n wbdtime = math.inf\n \n+ estimated_start_open_defects = open_defects + closed_defects - opened_defects\n+ incoming = 100 * opened_defects / estimated_start_open_defects\n+ closed = 100 * closed_defects / estimated_start_open_defects\n+\n return {\n \"ME%\": mei,\n \"BDTime\": bdtime,\n \"WBDTime\": wbdtime,\n+ \"Incoming%\": incoming,\n+ \"Closed%\": closed,\n }\n"}}},{"rowIdx":5482,"cells":{"in_source_id":{"kind":"string","value":"pyqtgraph__pyqtgraph-1168"},"issue":{"kind":"string","value":"Hiding nested group parameters\nHiding groups nested in groups does not work after the widget is shown. Look at this minimal example:\r\n\r\n```\r\nimport os\r\nimport pyqtgraph.parametertree.ParameterTree as ParameterTree\r\nfrom pyqtgraph.parametertree import Parameter, parameterTypes\r\nfrom pyqtgraph.Qt import QtCore, QtGui\r\n\r\nclass MyGroup(parameterTypes.GroupParameter):\r\n\r\n def __init__(self, *args):\r\n super().__init__(name='GroupA')\r\n self.addChild(parameterTypes.ListParameter(name='idx', values=[0, 1, 2, 3], value=0))\r\n for i in range(4):\r\n self.addChild(Parameter.create(name=str(i), type='group', children=[{\r\n 'name' : 'member', 'type' : 'str'\r\n }]))\r\n # self.addChild(Parameter.create(name=str(i), type='str')) # works fine\r\n\r\n def treeStateChanged(self, param, changes):\r\n super().treeStateChanged(param, changes)\r\n if param is self.child('idx'):\r\n # Show the element at this index\r\n self.update_value()\r\n \r\n def update_value(self):\r\n # Destroy the old child\r\n idx = self.child('idx').value()\r\n for child in self.children():\r\n if child.name() != 'idx' and child.name() != str(idx):\r\n child.hide()\r\n self.child(str(idx)).show()\r\n\r\np = MyGroup()\r\ntree.addParameters(p)\r\nwin = QtGui.QWidget()\r\nlayout = QtGui.QGridLayout()\r\nwin.setLayout(layout)\r\nlayout.addWidget(tree)\r\nwin.show()\r\n\r\n## Start Qt event loop unless running in interactive mode or using pyside.\r\nif __name__ == '__main__':\r\n import sys\r\n if (sys.flags.interactive != 1) or not hasattr(QtCore, 'PYQT_VERSION'):\r\n QtGui.QApplication.instance().exec_()\r\n```\r\n\r\nI create a Group that holds a list parameter, the value of which determines, which of the subgroups should be visible. When setting up the tree, all works well, only the group with name '0' is visible. However when changing the value of the list parameter 'idx', no changes appear whatsoever. Note that when using any parameter type other than group, (that is, instead of adding group parameters as children appending e.g. action, str, etc.) everything works just as intended.\n"},"before_files":{"kind":"list like","value":[{"content":"from ..Qt import QtCore, QtGui\nfrom ..python2_3 import asUnicode\nfrom .Parameter import Parameter, registerParameterType\nfrom .ParameterItem import ParameterItem\nfrom ..widgets.SpinBox import SpinBox\nfrom ..widgets.ColorButton import ColorButton\nfrom ..colormap import ColorMap\n#from ..widgets.GradientWidget import GradientWidget ## creates import loop\nfrom .. import pixmaps as pixmaps\nfrom .. import functions as fn\nimport os, sys\nfrom ..pgcollections import OrderedDict\n\nclass WidgetParameterItem(ParameterItem):\n \"\"\"\n ParameterTree item with:\n \n * label in second column for displaying value\n * simple widget for editing value (displayed instead of label when item is selected)\n * button that resets value to default\n \n ========================== =============================================================\n **Registered Types:**\n int Displays a :class:`SpinBox <pyqtgraph.SpinBox>` in integer\n mode.\n float Displays a :class:`SpinBox <pyqtgraph.SpinBox>`.\n bool Displays a QCheckBox\n str Displays a QLineEdit\n color Displays a :class:`ColorButton <pyqtgraph.ColorButton>`\n colormap Displays a :class:`GradientWidget <pyqtgraph.GradientWidget>`\n ========================== =============================================================\n \n This class can be subclassed by overriding makeWidget() to provide a custom widget.\n \"\"\"\n def __init__(self, param, depth):\n ParameterItem.__init__(self, param, depth)\n \n self.hideWidget = True ## hide edit widget, replace with label when not selected\n ## set this to False to keep the editor widget always visible\n \n \n ## build widget into column 1 with a display label and default button.\n w = self.makeWidget() \n self.widget = w\n self.eventProxy = EventProxy(w, self.widgetEventFilter)\n \n opts = self.param.opts\n if 'tip' in opts:\n w.setToolTip(opts['tip'])\n \n self.defaultBtn = QtGui.QPushButton()\n self.defaultBtn.setFixedWidth(20)\n self.defaultBtn.setFixedHeight(20)\n modDir = os.path.dirname(__file__)\n self.defaultBtn.setIcon(QtGui.QIcon(pixmaps.getPixmap('default')))\n self.defaultBtn.clicked.connect(self.defaultClicked)\n \n self.displayLabel = QtGui.QLabel()\n \n layout = QtGui.QHBoxLayout()\n layout.setContentsMargins(0, 0, 0, 0)\n layout.setSpacing(2)\n layout.addWidget(w)\n layout.addWidget(self.displayLabel)\n layout.addWidget(self.defaultBtn)\n self.layoutWidget = QtGui.QWidget()\n self.layoutWidget.setLayout(layout)\n \n if w.sigChanged is not None:\n w.sigChanged.connect(self.widgetValueChanged)\n \n if hasattr(w, 'sigChanging'):\n w.sigChanging.connect(self.widgetValueChanging)\n \n ## update value shown in widget. \n if opts.get('value', None) is not None:\n self.valueChanged(self, opts['value'], force=True)\n else:\n ## no starting value was given; use whatever the widget has\n self.widgetValueChanged()\n\n self.updateDefaultBtn()\n\n def makeWidget(self):\n \"\"\"\n Return a single widget that should be placed in the second tree column.\n The widget must be given three attributes:\n \n ========== ============================================================\n sigChanged a signal that is emitted when the widget's value is changed\n value a function that returns the value\n setValue a function that sets the value\n ========== ============================================================\n \n This is a good function to override in subclasses.\n \"\"\"\n opts = self.param.opts\n t = opts['type']\n if t in ('int', 'float'):\n defs = {\n 'value': 0, 'min': None, 'max': None,\n 'step': 1.0, 'dec': False, \n 'siPrefix': False, 'suffix': '', 'decimals': 3,\n }\n if t == 'int':\n defs['int'] = True\n defs['minStep'] = 1.0\n defs['format'] = '{value:d}'\n for k in defs:\n if k in opts:\n defs[k] = opts[k]\n if 'limits' in opts:\n defs['min'], defs['max'] = opts['limits']\n w = SpinBox()\n w.setOpts(**defs)\n w.sigChanged = w.sigValueChanged\n w.sigChanging = w.sigValueChanging\n elif t == 'bool':\n w = QtGui.QCheckBox()\n w.sigChanged = w.toggled\n w.value = w.isChecked\n w.setValue = w.setChecked\n w.setEnabled(not opts.get('readonly', False))\n self.hideWidget = False\n elif t == 'str':\n w = QtGui.QLineEdit()\n w.setStyleSheet('border: 0px')\n w.sigChanged = w.editingFinished\n w.value = lambda: asUnicode(w.text())\n w.setValue = lambda v: w.setText(asUnicode(v))\n w.sigChanging = w.textChanged\n elif t == 'color':\n w = ColorButton()\n w.sigChanged = w.sigColorChanged\n w.sigChanging = w.sigColorChanging\n w.value = w.color\n w.setValue = w.setColor\n self.hideWidget = False\n w.setFlat(True)\n w.setEnabled(not opts.get('readonly', False)) \n elif t == 'colormap':\n from ..widgets.GradientWidget import GradientWidget ## need this here to avoid import loop\n w = GradientWidget(orientation='bottom')\n w.sigChanged = w.sigGradientChangeFinished\n w.sigChanging = w.sigGradientChanged\n w.value = w.colorMap\n w.setValue = w.setColorMap\n self.hideWidget = False\n else:\n raise Exception(\"Unknown type '%s'\" % asUnicode(t))\n return w\n \n def widgetEventFilter(self, obj, ev):\n ## filter widget's events\n ## catch TAB to change focus\n ## catch focusOut to hide editor\n if ev.type() == ev.KeyPress:\n if ev.key() == QtCore.Qt.Key_Tab:\n self.focusNext(forward=True)\n return True ## don't let anyone else see this event\n elif ev.key() == QtCore.Qt.Key_Backtab:\n self.focusNext(forward=False)\n return True ## don't let anyone else see this event\n \n #elif ev.type() == ev.FocusOut:\n #self.hideEditor()\n return False\n \n def setFocus(self):\n self.showEditor()\n \n def isFocusable(self):\n return self.param.writable() \n \n def valueChanged(self, param, val, force=False):\n ## called when the parameter's value has changed\n ParameterItem.valueChanged(self, param, val)\n self.widget.sigChanged.disconnect(self.widgetValueChanged)\n try:\n if force or val != self.widget.value():\n self.widget.setValue(val)\n self.updateDisplayLabel(val) ## always make sure label is updated, even if values match!\n finally:\n self.widget.sigChanged.connect(self.widgetValueChanged)\n self.updateDefaultBtn()\n \n def updateDefaultBtn(self):\n ## enable/disable default btn \n self.defaultBtn.setEnabled(not self.param.valueIsDefault() and self.param.writable()) \n \n # hide / show\n self.defaultBtn.setVisible(not self.param.readonly())\n\n def updateDisplayLabel(self, value=None):\n \"\"\"Update the display label to reflect the value of the parameter.\"\"\"\n if value is None:\n value = self.param.value()\n opts = self.param.opts\n if isinstance(self.widget, QtGui.QAbstractSpinBox):\n text = asUnicode(self.widget.lineEdit().text())\n elif isinstance(self.widget, QtGui.QComboBox):\n text = self.widget.currentText()\n else:\n text = asUnicode(value)\n self.displayLabel.setText(text)\n\n def widgetValueChanged(self):\n ## called when the widget's value has been changed by the user\n val = self.widget.value()\n newVal = self.param.setValue(val)\n\n def widgetValueChanging(self, *args):\n \"\"\"\n Called when the widget's value is changing, but not finalized.\n For example: editing text before pressing enter or changing focus.\n \"\"\"\n # This is a bit sketchy: assume the last argument of each signal is\n # the value..\n self.param.sigValueChanging.emit(self.param, args[-1])\n \n def selected(self, sel):\n \"\"\"Called when this item has been selected (sel=True) OR deselected (sel=False)\"\"\"\n ParameterItem.selected(self, sel)\n \n if self.widget is None:\n return\n if sel and self.param.writable():\n self.showEditor()\n elif self.hideWidget:\n self.hideEditor()\n\n def showEditor(self):\n self.widget.show()\n self.displayLabel.hide()\n self.widget.setFocus(QtCore.Qt.OtherFocusReason)\n if isinstance(self.widget, SpinBox):\n self.widget.selectNumber() # select the numerical portion of the text for quick editing\n\n def hideEditor(self):\n self.widget.hide()\n self.displayLabel.show()\n\n def limitsChanged(self, param, limits):\n \"\"\"Called when the parameter's limits have changed\"\"\"\n ParameterItem.limitsChanged(self, param, limits)\n \n t = self.param.opts['type']\n if t == 'int' or t == 'float':\n self.widget.setOpts(bounds=limits)\n else:\n return ## don't know what to do with any other types..\n\n def defaultChanged(self, param, value):\n self.updateDefaultBtn()\n\n def treeWidgetChanged(self):\n \"\"\"Called when this item is added or removed from a tree.\"\"\"\n ParameterItem.treeWidgetChanged(self)\n \n ## add all widgets for this item into the tree\n if self.widget is not None:\n tree = self.treeWidget()\n if tree is None:\n return\n tree.setItemWidget(self, 1, self.layoutWidget)\n self.displayLabel.hide()\n self.selected(False) \n\n def defaultClicked(self):\n self.param.setToDefault()\n\n def optsChanged(self, param, opts):\n \"\"\"Called when any options are changed that are not\n name, value, default, or limits\"\"\"\n #print \"opts changed:\", opts\n ParameterItem.optsChanged(self, param, opts)\n \n if 'readonly' in opts:\n self.updateDefaultBtn()\n if isinstance(self.widget, (QtGui.QCheckBox,ColorButton)):\n self.widget.setEnabled(not opts['readonly'])\n \n ## If widget is a SpinBox, pass options straight through\n if isinstance(self.widget, SpinBox):\n # send only options supported by spinbox\n sbOpts = {}\n if 'units' in opts and 'suffix' not in opts:\n sbOpts['suffix'] = opts['units']\n for k,v in opts.items():\n if k in self.widget.opts:\n sbOpts[k] = v\n self.widget.setOpts(**sbOpts)\n self.updateDisplayLabel()\n \n \nclass EventProxy(QtCore.QObject):\n def __init__(self, qobj, callback):\n QtCore.QObject.__init__(self)\n self.callback = callback\n qobj.installEventFilter(self)\n \n def eventFilter(self, obj, ev):\n return self.callback(obj, ev)\n\n\nclass SimpleParameter(Parameter):\n itemClass = WidgetParameterItem\n \n def __init__(self, *args, **kargs):\n Parameter.__init__(self, *args, **kargs)\n \n ## override a few methods for color parameters\n if self.opts['type'] == 'color':\n self.value = self.colorValue\n self.saveState = self.saveColorState\n \n def colorValue(self):\n return fn.mkColor(Parameter.value(self))\n \n def saveColorState(self, *args, **kwds):\n state = Parameter.saveState(self, *args, **kwds)\n state['value'] = fn.colorTuple(self.value())\n return state\n \n def _interpretValue(self, v):\n fn = {\n 'int': int,\n 'float': float,\n 'bool': bool,\n 'str': asUnicode,\n 'color': self._interpColor,\n 'colormap': self._interpColormap,\n }[self.opts['type']]\n return fn(v)\n \n def _interpColor(self, v):\n return fn.mkColor(v)\n \n def _interpColormap(self, v):\n if not isinstance(v, ColorMap):\n raise TypeError(\"Cannot set colormap parameter from object %r\" % v)\n return v\n \n \n \nregisterParameterType('int', SimpleParameter, override=True)\nregisterParameterType('float', SimpleParameter, override=True)\nregisterParameterType('bool', SimpleParameter, override=True)\nregisterParameterType('str', SimpleParameter, override=True)\nregisterParameterType('color', SimpleParameter, override=True)\nregisterParameterType('colormap', SimpleParameter, override=True)\n\n\n\n\nclass GroupParameterItem(ParameterItem):\n \"\"\"\n Group parameters are used mainly as a generic parent item that holds (and groups!) a set\n of child parameters. It also provides a simple mechanism for displaying a button or combo\n that can be used to add new parameters to the group.\n \"\"\"\n def __init__(self, param, depth):\n ParameterItem.__init__(self, param, depth)\n self.updateDepth(depth) \n \n self.addItem = None\n if 'addText' in param.opts:\n addText = param.opts['addText']\n if 'addList' in param.opts:\n self.addWidget = QtGui.QComboBox()\n self.addWidget.setSizeAdjustPolicy(QtGui.QComboBox.AdjustToContents)\n self.updateAddList()\n self.addWidget.currentIndexChanged.connect(self.addChanged)\n else:\n self.addWidget = QtGui.QPushButton(addText)\n self.addWidget.clicked.connect(self.addClicked)\n w = QtGui.QWidget()\n l = QtGui.QHBoxLayout()\n l.setContentsMargins(0,0,0,0)\n w.setLayout(l)\n l.addWidget(self.addWidget)\n l.addStretch()\n #l.addItem(QtGui.QSpacerItem(200, 10, QtGui.QSizePolicy.Expanding, QtGui.QSizePolicy.Minimum))\n self.addWidgetBox = w\n self.addItem = QtGui.QTreeWidgetItem([])\n self.addItem.setFlags(QtCore.Qt.ItemIsEnabled)\n ParameterItem.addChild(self, self.addItem)\n \n def updateDepth(self, depth):\n ## Change item's appearance based on its depth in the tree\n ## This allows highest-level groups to be displayed more prominently.\n if depth == 0:\n for c in [0,1]:\n self.setBackground(c, QtGui.QBrush(QtGui.QColor(100,100,100)))\n self.setForeground(c, QtGui.QBrush(QtGui.QColor(220,220,255)))\n font = self.font(c)\n font.setBold(True)\n font.setPointSize(font.pointSize()+1)\n self.setFont(c, font)\n self.setSizeHint(0, QtCore.QSize(0, 25))\n else:\n for c in [0,1]:\n self.setBackground(c, QtGui.QBrush(QtGui.QColor(220,220,220)))\n self.setForeground(c, QtGui.QBrush(QtGui.QColor(50,50,50)))\n font = self.font(c)\n font.setBold(True)\n #font.setPointSize(font.pointSize()+1)\n self.setFont(c, font)\n self.setSizeHint(0, QtCore.QSize(0, 20))\n \n def addClicked(self):\n \"\"\"Called when \"add new\" button is clicked\n The parameter MUST have an 'addNew' method defined.\n \"\"\"\n self.param.addNew()\n\n def addChanged(self):\n \"\"\"Called when \"add new\" combo is changed\n The parameter MUST have an 'addNew' method defined.\n \"\"\"\n if self.addWidget.currentIndex() == 0:\n return\n typ = asUnicode(self.addWidget.currentText())\n self.param.addNew(typ)\n self.addWidget.setCurrentIndex(0)\n\n def treeWidgetChanged(self):\n ParameterItem.treeWidgetChanged(self)\n self.treeWidget().setFirstItemColumnSpanned(self, True)\n if self.addItem is not None:\n self.treeWidget().setItemWidget(self.addItem, 0, self.addWidgetBox)\n self.treeWidget().setFirstItemColumnSpanned(self.addItem, True)\n \n def addChild(self, child): ## make sure added childs are actually inserted before add btn\n if self.addItem is not None:\n ParameterItem.insertChild(self, self.childCount()-1, child)\n else:\n ParameterItem.addChild(self, child)\n \n def optsChanged(self, param, changed):\n if 'addList' in changed:\n self.updateAddList()\n \n def updateAddList(self):\n self.addWidget.blockSignals(True)\n try:\n self.addWidget.clear()\n self.addWidget.addItem(self.param.opts['addText'])\n for t in self.param.opts['addList']:\n self.addWidget.addItem(t)\n finally:\n self.addWidget.blockSignals(False)\n \nclass GroupParameter(Parameter):\n \"\"\"\n Group parameters are used mainly as a generic parent item that holds (and groups!) a set\n of child parameters. \n \n It also provides a simple mechanism for displaying a button or combo\n that can be used to add new parameters to the group. To enable this, the group \n must be initialized with the 'addText' option (the text will be displayed on\n a button which, when clicked, will cause addNew() to be called). If the 'addList'\n option is specified as well, then a dropdown-list of addable items will be displayed\n instead of a button.\n \"\"\"\n itemClass = GroupParameterItem\n \n sigAddNew = QtCore.Signal(object, object) # self, type\n\n def addNew(self, typ=None):\n \"\"\"\n This method is called when the user has requested to add a new item to the group.\n By default, it emits ``sigAddNew(self, typ)``.\n \"\"\"\n self.sigAddNew.emit(self, typ)\n \n def setAddList(self, vals):\n \"\"\"Change the list of options available for the user to add to the group.\"\"\"\n self.setOpts(addList=vals)\n\n \n\nregisterParameterType('group', GroupParameter, override=True)\n\n\n\n\n\nclass ListParameterItem(WidgetParameterItem):\n \"\"\"\n WidgetParameterItem subclass providing comboBox that lets the user select from a list of options.\n \n \"\"\"\n def __init__(self, param, depth):\n self.targetValue = None\n WidgetParameterItem.__init__(self, param, depth)\n \n \n def makeWidget(self):\n opts = self.param.opts\n t = opts['type']\n w = QtGui.QComboBox()\n w.setMaximumHeight(20) ## set to match height of spin box and line edit\n w.sigChanged = w.currentIndexChanged\n w.value = self.value\n w.setValue = self.setValue\n self.widget = w ## needs to be set before limits are changed\n self.limitsChanged(self.param, self.param.opts['limits'])\n if len(self.forward) > 0:\n self.setValue(self.param.value())\n return w\n \n def value(self):\n key = asUnicode(self.widget.currentText())\n \n return self.forward.get(key, None)\n \n def setValue(self, val):\n self.targetValue = val\n if val not in self.reverse[0]:\n self.widget.setCurrentIndex(0)\n else:\n key = self.reverse[1][self.reverse[0].index(val)]\n ind = self.widget.findText(key)\n self.widget.setCurrentIndex(ind)\n\n def limitsChanged(self, param, limits):\n # set up forward / reverse mappings for name:value\n \n if len(limits) == 0:\n limits = [''] ## Can never have an empty list--there is always at least a singhe blank item.\n \n self.forward, self.reverse = ListParameter.mapping(limits)\n try:\n self.widget.blockSignals(True)\n val = self.targetValue #asUnicode(self.widget.currentText())\n \n self.widget.clear()\n for k in self.forward:\n self.widget.addItem(k)\n if k == val:\n self.widget.setCurrentIndex(self.widget.count()-1)\n self.updateDisplayLabel()\n finally:\n self.widget.blockSignals(False)\n \n\n\nclass ListParameter(Parameter):\n itemClass = ListParameterItem\n\n def __init__(self, **opts):\n self.forward = OrderedDict() ## {name: value, ...}\n self.reverse = ([], []) ## ([value, ...], [name, ...])\n \n ## Parameter uses 'limits' option to define the set of allowed values\n if 'values' in opts:\n opts['limits'] = opts['values']\n if opts.get('limits', None) is None:\n opts['limits'] = []\n Parameter.__init__(self, **opts)\n self.setLimits(opts['limits'])\n \n def setLimits(self, limits):\n self.forward, self.reverse = self.mapping(limits)\n \n Parameter.setLimits(self, limits)\n if len(self.reverse[0]) > 0 and self.value() not in self.reverse[0]:\n self.setValue(self.reverse[0][0])\n \n #def addItem(self, name, value=None):\n #if name in self.forward:\n #raise Exception(\"Name '%s' is already in use for this parameter\" % name)\n #limits = self.opts['limits']\n #if isinstance(limits, dict):\n #limits = limits.copy()\n #limits[name] = value\n #self.setLimits(limits)\n #else:\n #if value is not None:\n #raise Exception ## raise exception or convert to dict?\n #limits = limits[:]\n #limits.append(name)\n ## what if limits == None?\n \n @staticmethod\n def mapping(limits):\n ## Return forward and reverse mapping objects given a limit specification\n forward = OrderedDict() ## {name: value, ...}\n reverse = ([], []) ## ([value, ...], [name, ...])\n if isinstance(limits, dict):\n for k, v in limits.items():\n forward[k] = v\n reverse[0].append(v)\n reverse[1].append(k)\n else:\n for v in limits:\n n = asUnicode(v)\n forward[n] = v\n reverse[0].append(v)\n reverse[1].append(n)\n return forward, reverse\n\nregisterParameterType('list', ListParameter, override=True)\n\n\n\nclass ActionParameterItem(ParameterItem):\n def __init__(self, param, depth):\n ParameterItem.__init__(self, param, depth)\n self.layoutWidget = QtGui.QWidget()\n self.layout = QtGui.QHBoxLayout()\n self.layout.setContentsMargins(0, 0, 0, 0)\n self.layoutWidget.setLayout(self.layout)\n title = param.opts.get('title', None)\n if title is None:\n title = param.name()\n self.button = QtGui.QPushButton(title)\n #self.layout.addSpacing(100)\n self.layout.addWidget(self.button)\n self.layout.addStretch()\n self.button.clicked.connect(self.buttonClicked)\n param.sigNameChanged.connect(self.paramRenamed)\n self.setText(0, '')\n \n def treeWidgetChanged(self):\n ParameterItem.treeWidgetChanged(self)\n tree = self.treeWidget()\n if tree is None:\n return\n \n tree.setFirstItemColumnSpanned(self, True)\n tree.setItemWidget(self, 0, self.layoutWidget)\n \n def paramRenamed(self, param, name):\n self.button.setText(name)\n \n def buttonClicked(self):\n self.param.activate()\n \nclass ActionParameter(Parameter):\n \"\"\"Used for displaying a button within the tree.\"\"\"\n itemClass = ActionParameterItem\n sigActivated = QtCore.Signal(object)\n \n def activate(self):\n self.sigActivated.emit(self)\n self.emitStateChanged('activated', None)\n \nregisterParameterType('action', ActionParameter, override=True)\n\n\n\nclass TextParameterItem(WidgetParameterItem):\n def __init__(self, param, depth):\n WidgetParameterItem.__init__(self, param, depth)\n self.hideWidget = False\n self.subItem = QtGui.QTreeWidgetItem()\n self.addChild(self.subItem)\n\n def treeWidgetChanged(self):\n ## TODO: fix so that superclass method can be called\n ## (WidgetParameter should just natively support this style)\n #WidgetParameterItem.treeWidgetChanged(self)\n self.treeWidget().setFirstItemColumnSpanned(self.subItem, True)\n self.treeWidget().setItemWidget(self.subItem, 0, self.textBox)\n \n # for now, these are copied from ParameterItem.treeWidgetChanged\n self.setHidden(not self.param.opts.get('visible', True))\n self.setExpanded(self.param.opts.get('expanded', True))\n \n def makeWidget(self):\n self.textBox = QtGui.QTextEdit()\n self.textBox.setMaximumHeight(100)\n self.textBox.setReadOnly(self.param.opts.get('readonly', False))\n self.textBox.value = lambda: str(self.textBox.toPlainText())\n self.textBox.setValue = self.textBox.setPlainText\n self.textBox.sigChanged = self.textBox.textChanged\n return self.textBox\n \nclass TextParameter(Parameter):\n \"\"\"Editable string; displayed as large text box in the tree.\"\"\"\n itemClass = TextParameterItem\n\n \n \nregisterParameterType('text', TextParameter, override=True)\n","path":"pyqtgraph/parametertree/parameterTypes.py"}],"string":"[\n {\n \"content\": \"from ..Qt import QtCore, QtGui\\nfrom ..python2_3 import asUnicode\\nfrom .Parameter import Parameter, registerParameterType\\nfrom .ParameterItem import ParameterItem\\nfrom ..widgets.SpinBox import SpinBox\\nfrom ..widgets.ColorButton import ColorButton\\nfrom ..colormap import ColorMap\\n#from ..widgets.GradientWidget import GradientWidget ## creates import loop\\nfrom .. import pixmaps as pixmaps\\nfrom .. import functions as fn\\nimport os, sys\\nfrom ..pgcollections import OrderedDict\\n\\nclass WidgetParameterItem(ParameterItem):\\n \\\"\\\"\\\"\\n ParameterTree item with:\\n \\n * label in second column for displaying value\\n * simple widget for editing value (displayed instead of label when item is selected)\\n * button that resets value to default\\n \\n ========================== =============================================================\\n **Registered Types:**\\n int Displays a :class:`SpinBox <pyqtgraph.SpinBox>` in integer\\n mode.\\n float Displays a :class:`SpinBox <pyqtgraph.SpinBox>`.\\n bool Displays a QCheckBox\\n str Displays a QLineEdit\\n color Displays a :class:`ColorButton <pyqtgraph.ColorButton>`\\n colormap Displays a :class:`GradientWidget <pyqtgraph.GradientWidget>`\\n ========================== =============================================================\\n \\n This class can be subclassed by overriding makeWidget() to provide a custom widget.\\n \\\"\\\"\\\"\\n def __init__(self, param, depth):\\n ParameterItem.__init__(self, param, depth)\\n \\n self.hideWidget = True ## hide edit widget, replace with label when not selected\\n ## set this to False to keep the editor widget always visible\\n \\n \\n ## build widget into column 1 with a display label and default button.\\n w = self.makeWidget() \\n self.widget = w\\n self.eventProxy = EventProxy(w, self.widgetEventFilter)\\n \\n opts = self.param.opts\\n if 'tip' in opts:\\n w.setToolTip(opts['tip'])\\n \\n self.defaultBtn = QtGui.QPushButton()\\n self.defaultBtn.setFixedWidth(20)\\n self.defaultBtn.setFixedHeight(20)\\n modDir = os.path.dirname(__file__)\\n self.defaultBtn.setIcon(QtGui.QIcon(pixmaps.getPixmap('default')))\\n self.defaultBtn.clicked.connect(self.defaultClicked)\\n \\n self.displayLabel = QtGui.QLabel()\\n \\n layout = QtGui.QHBoxLayout()\\n layout.setContentsMargins(0, 0, 0, 0)\\n layout.setSpacing(2)\\n layout.addWidget(w)\\n layout.addWidget(self.displayLabel)\\n layout.addWidget(self.defaultBtn)\\n self.layoutWidget = QtGui.QWidget()\\n self.layoutWidget.setLayout(layout)\\n \\n if w.sigChanged is not None:\\n w.sigChanged.connect(self.widgetValueChanged)\\n \\n if hasattr(w, 'sigChanging'):\\n w.sigChanging.connect(self.widgetValueChanging)\\n \\n ## update value shown in widget. \\n if opts.get('value', None) is not None:\\n self.valueChanged(self, opts['value'], force=True)\\n else:\\n ## no starting value was given; use whatever the widget has\\n self.widgetValueChanged()\\n\\n self.updateDefaultBtn()\\n\\n def makeWidget(self):\\n \\\"\\\"\\\"\\n Return a single widget that should be placed in the second tree column.\\n The widget must be given three attributes:\\n \\n ========== ============================================================\\n sigChanged a signal that is emitted when the widget's value is changed\\n value a function that returns the value\\n setValue a function that sets the value\\n ========== ============================================================\\n \\n This is a good function to override in subclasses.\\n \\\"\\\"\\\"\\n opts = self.param.opts\\n t = opts['type']\\n if t in ('int', 'float'):\\n defs = {\\n 'value': 0, 'min': None, 'max': None,\\n 'step': 1.0, 'dec': False, \\n 'siPrefix': False, 'suffix': '', 'decimals': 3,\\n }\\n if t == 'int':\\n defs['int'] = True\\n defs['minStep'] = 1.0\\n defs['format'] = '{value:d}'\\n for k in defs:\\n if k in opts:\\n defs[k] = opts[k]\\n if 'limits' in opts:\\n defs['min'], defs['max'] = opts['limits']\\n w = SpinBox()\\n w.setOpts(**defs)\\n w.sigChanged = w.sigValueChanged\\n w.sigChanging = w.sigValueChanging\\n elif t == 'bool':\\n w = QtGui.QCheckBox()\\n w.sigChanged = w.toggled\\n w.value = w.isChecked\\n w.setValue = w.setChecked\\n w.setEnabled(not opts.get('readonly', False))\\n self.hideWidget = False\\n elif t == 'str':\\n w = QtGui.QLineEdit()\\n w.setStyleSheet('border: 0px')\\n w.sigChanged = w.editingFinished\\n w.value = lambda: asUnicode(w.text())\\n w.setValue = lambda v: w.setText(asUnicode(v))\\n w.sigChanging = w.textChanged\\n elif t == 'color':\\n w = ColorButton()\\n w.sigChanged = w.sigColorChanged\\n w.sigChanging = w.sigColorChanging\\n w.value = w.color\\n w.setValue = w.setColor\\n self.hideWidget = False\\n w.setFlat(True)\\n w.setEnabled(not opts.get('readonly', False)) \\n elif t == 'colormap':\\n from ..widgets.GradientWidget import GradientWidget ## need this here to avoid import loop\\n w = GradientWidget(orientation='bottom')\\n w.sigChanged = w.sigGradientChangeFinished\\n w.sigChanging = w.sigGradientChanged\\n w.value = w.colorMap\\n w.setValue = w.setColorMap\\n self.hideWidget = False\\n else:\\n raise Exception(\\\"Unknown type '%s'\\\" % asUnicode(t))\\n return w\\n \\n def widgetEventFilter(self, obj, ev):\\n ## filter widget's events\\n ## catch TAB to change focus\\n ## catch focusOut to hide editor\\n if ev.type() == ev.KeyPress:\\n if ev.key() == QtCore.Qt.Key_Tab:\\n self.focusNext(forward=True)\\n return True ## don't let anyone else see this event\\n elif ev.key() == QtCore.Qt.Key_Backtab:\\n self.focusNext(forward=False)\\n return True ## don't let anyone else see this event\\n \\n #elif ev.type() == ev.FocusOut:\\n #self.hideEditor()\\n return False\\n \\n def setFocus(self):\\n self.showEditor()\\n \\n def isFocusable(self):\\n return self.param.writable() \\n \\n def valueChanged(self, param, val, force=False):\\n ## called when the parameter's value has changed\\n ParameterItem.valueChanged(self, param, val)\\n self.widget.sigChanged.disconnect(self.widgetValueChanged)\\n try:\\n if force or val != self.widget.value():\\n self.widget.setValue(val)\\n self.updateDisplayLabel(val) ## always make sure label is updated, even if values match!\\n finally:\\n self.widget.sigChanged.connect(self.widgetValueChanged)\\n self.updateDefaultBtn()\\n \\n def updateDefaultBtn(self):\\n ## enable/disable default btn \\n self.defaultBtn.setEnabled(not self.param.valueIsDefault() and self.param.writable()) \\n \\n # hide / show\\n self.defaultBtn.setVisible(not self.param.readonly())\\n\\n def updateDisplayLabel(self, value=None):\\n \\\"\\\"\\\"Update the display label to reflect the value of the parameter.\\\"\\\"\\\"\\n if value is None:\\n value = self.param.value()\\n opts = self.param.opts\\n if isinstance(self.widget, QtGui.QAbstractSpinBox):\\n text = asUnicode(self.widget.lineEdit().text())\\n elif isinstance(self.widget, QtGui.QComboBox):\\n text = self.widget.currentText()\\n else:\\n text = asUnicode(value)\\n self.displayLabel.setText(text)\\n\\n def widgetValueChanged(self):\\n ## called when the widget's value has been changed by the user\\n val = self.widget.value()\\n newVal = self.param.setValue(val)\\n\\n def widgetValueChanging(self, *args):\\n \\\"\\\"\\\"\\n Called when the widget's value is changing, but not finalized.\\n For example: editing text before pressing enter or changing focus.\\n \\\"\\\"\\\"\\n # This is a bit sketchy: assume the last argument of each signal is\\n # the value..\\n self.param.sigValueChanging.emit(self.param, args[-1])\\n \\n def selected(self, sel):\\n \\\"\\\"\\\"Called when this item has been selected (sel=True) OR deselected (sel=False)\\\"\\\"\\\"\\n ParameterItem.selected(self, sel)\\n \\n if self.widget is None:\\n return\\n if sel and self.param.writable():\\n self.showEditor()\\n elif self.hideWidget:\\n self.hideEditor()\\n\\n def showEditor(self):\\n self.widget.show()\\n self.displayLabel.hide()\\n self.widget.setFocus(QtCore.Qt.OtherFocusReason)\\n if isinstance(self.widget, SpinBox):\\n self.widget.selectNumber() # select the numerical portion of the text for quick editing\\n\\n def hideEditor(self):\\n self.widget.hide()\\n self.displayLabel.show()\\n\\n def limitsChanged(self, param, limits):\\n \\\"\\\"\\\"Called when the parameter's limits have changed\\\"\\\"\\\"\\n ParameterItem.limitsChanged(self, param, limits)\\n \\n t = self.param.opts['type']\\n if t == 'int' or t == 'float':\\n self.widget.setOpts(bounds=limits)\\n else:\\n return ## don't know what to do with any other types..\\n\\n def defaultChanged(self, param, value):\\n self.updateDefaultBtn()\\n\\n def treeWidgetChanged(self):\\n \\\"\\\"\\\"Called when this item is added or removed from a tree.\\\"\\\"\\\"\\n ParameterItem.treeWidgetChanged(self)\\n \\n ## add all widgets for this item into the tree\\n if self.widget is not None:\\n tree = self.treeWidget()\\n if tree is None:\\n return\\n tree.setItemWidget(self, 1, self.layoutWidget)\\n self.displayLabel.hide()\\n self.selected(False) \\n\\n def defaultClicked(self):\\n self.param.setToDefault()\\n\\n def optsChanged(self, param, opts):\\n \\\"\\\"\\\"Called when any options are changed that are not\\n name, value, default, or limits\\\"\\\"\\\"\\n #print \\\"opts changed:\\\", opts\\n ParameterItem.optsChanged(self, param, opts)\\n \\n if 'readonly' in opts:\\n self.updateDefaultBtn()\\n if isinstance(self.widget, (QtGui.QCheckBox,ColorButton)):\\n self.widget.setEnabled(not opts['readonly'])\\n \\n ## If widget is a SpinBox, pass options straight through\\n if isinstance(self.widget, SpinBox):\\n # send only options supported by spinbox\\n sbOpts = {}\\n if 'units' in opts and 'suffix' not in opts:\\n sbOpts['suffix'] = opts['units']\\n for k,v in opts.items():\\n if k in self.widget.opts:\\n sbOpts[k] = v\\n self.widget.setOpts(**sbOpts)\\n self.updateDisplayLabel()\\n \\n \\nclass EventProxy(QtCore.QObject):\\n def __init__(self, qobj, callback):\\n QtCore.QObject.__init__(self)\\n self.callback = callback\\n qobj.installEventFilter(self)\\n \\n def eventFilter(self, obj, ev):\\n return self.callback(obj, ev)\\n\\n\\nclass SimpleParameter(Parameter):\\n itemClass = WidgetParameterItem\\n \\n def __init__(self, *args, **kargs):\\n Parameter.__init__(self, *args, **kargs)\\n \\n ## override a few methods for color parameters\\n if self.opts['type'] == 'color':\\n self.value = self.colorValue\\n self.saveState = self.saveColorState\\n \\n def colorValue(self):\\n return fn.mkColor(Parameter.value(self))\\n \\n def saveColorState(self, *args, **kwds):\\n state = Parameter.saveState(self, *args, **kwds)\\n state['value'] = fn.colorTuple(self.value())\\n return state\\n \\n def _interpretValue(self, v):\\n fn = {\\n 'int': int,\\n 'float': float,\\n 'bool': bool,\\n 'str': asUnicode,\\n 'color': self._interpColor,\\n 'colormap': self._interpColormap,\\n }[self.opts['type']]\\n return fn(v)\\n \\n def _interpColor(self, v):\\n return fn.mkColor(v)\\n \\n def _interpColormap(self, v):\\n if not isinstance(v, ColorMap):\\n raise TypeError(\\\"Cannot set colormap parameter from object %r\\\" % v)\\n return v\\n \\n \\n \\nregisterParameterType('int', SimpleParameter, override=True)\\nregisterParameterType('float', SimpleParameter, override=True)\\nregisterParameterType('bool', SimpleParameter, override=True)\\nregisterParameterType('str', SimpleParameter, override=True)\\nregisterParameterType('color', SimpleParameter, override=True)\\nregisterParameterType('colormap', SimpleParameter, override=True)\\n\\n\\n\\n\\nclass GroupParameterItem(ParameterItem):\\n \\\"\\\"\\\"\\n Group parameters are used mainly as a generic parent item that holds (and groups!) a set\\n of child parameters. It also provides a simple mechanism for displaying a button or combo\\n that can be used to add new parameters to the group.\\n \\\"\\\"\\\"\\n def __init__(self, param, depth):\\n ParameterItem.__init__(self, param, depth)\\n self.updateDepth(depth) \\n \\n self.addItem = None\\n if 'addText' in param.opts:\\n addText = param.opts['addText']\\n if 'addList' in param.opts:\\n self.addWidget = QtGui.QComboBox()\\n self.addWidget.setSizeAdjustPolicy(QtGui.QComboBox.AdjustToContents)\\n self.updateAddList()\\n self.addWidget.currentIndexChanged.connect(self.addChanged)\\n else:\\n self.addWidget = QtGui.QPushButton(addText)\\n self.addWidget.clicked.connect(self.addClicked)\\n w = QtGui.QWidget()\\n l = QtGui.QHBoxLayout()\\n l.setContentsMargins(0,0,0,0)\\n w.setLayout(l)\\n l.addWidget(self.addWidget)\\n l.addStretch()\\n #l.addItem(QtGui.QSpacerItem(200, 10, QtGui.QSizePolicy.Expanding, QtGui.QSizePolicy.Minimum))\\n self.addWidgetBox = w\\n self.addItem = QtGui.QTreeWidgetItem([])\\n self.addItem.setFlags(QtCore.Qt.ItemIsEnabled)\\n ParameterItem.addChild(self, self.addItem)\\n \\n def updateDepth(self, depth):\\n ## Change item's appearance based on its depth in the tree\\n ## This allows highest-level groups to be displayed more prominently.\\n if depth == 0:\\n for c in [0,1]:\\n self.setBackground(c, QtGui.QBrush(QtGui.QColor(100,100,100)))\\n self.setForeground(c, QtGui.QBrush(QtGui.QColor(220,220,255)))\\n font = self.font(c)\\n font.setBold(True)\\n font.setPointSize(font.pointSize()+1)\\n self.setFont(c, font)\\n self.setSizeHint(0, QtCore.QSize(0, 25))\\n else:\\n for c in [0,1]:\\n self.setBackground(c, QtGui.QBrush(QtGui.QColor(220,220,220)))\\n self.setForeground(c, QtGui.QBrush(QtGui.QColor(50,50,50)))\\n font = self.font(c)\\n font.setBold(True)\\n #font.setPointSize(font.pointSize()+1)\\n self.setFont(c, font)\\n self.setSizeHint(0, QtCore.QSize(0, 20))\\n \\n def addClicked(self):\\n \\\"\\\"\\\"Called when \\\"add new\\\" button is clicked\\n The parameter MUST have an 'addNew' method defined.\\n \\\"\\\"\\\"\\n self.param.addNew()\\n\\n def addChanged(self):\\n \\\"\\\"\\\"Called when \\\"add new\\\" combo is changed\\n The parameter MUST have an 'addNew' method defined.\\n \\\"\\\"\\\"\\n if self.addWidget.currentIndex() == 0:\\n return\\n typ = asUnicode(self.addWidget.currentText())\\n self.param.addNew(typ)\\n self.addWidget.setCurrentIndex(0)\\n\\n def treeWidgetChanged(self):\\n ParameterItem.treeWidgetChanged(self)\\n self.treeWidget().setFirstItemColumnSpanned(self, True)\\n if self.addItem is not None:\\n self.treeWidget().setItemWidget(self.addItem, 0, self.addWidgetBox)\\n self.treeWidget().setFirstItemColumnSpanned(self.addItem, True)\\n \\n def addChild(self, child): ## make sure added childs are actually inserted before add btn\\n if self.addItem is not None:\\n ParameterItem.insertChild(self, self.childCount()-1, child)\\n else:\\n ParameterItem.addChild(self, child)\\n \\n def optsChanged(self, param, changed):\\n if 'addList' in changed:\\n self.updateAddList()\\n \\n def updateAddList(self):\\n self.addWidget.blockSignals(True)\\n try:\\n self.addWidget.clear()\\n self.addWidget.addItem(self.param.opts['addText'])\\n for t in self.param.opts['addList']:\\n self.addWidget.addItem(t)\\n finally:\\n self.addWidget.blockSignals(False)\\n \\nclass GroupParameter(Parameter):\\n \\\"\\\"\\\"\\n Group parameters are used mainly as a generic parent item that holds (and groups!) a set\\n of child parameters. \\n \\n It also provides a simple mechanism for displaying a button or combo\\n that can be used to add new parameters to the group. To enable this, the group \\n must be initialized with the 'addText' option (the text will be displayed on\\n a button which, when clicked, will cause addNew() to be called). If the 'addList'\\n option is specified as well, then a dropdown-list of addable items will be displayed\\n instead of a button.\\n \\\"\\\"\\\"\\n itemClass = GroupParameterItem\\n \\n sigAddNew = QtCore.Signal(object, object) # self, type\\n\\n def addNew(self, typ=None):\\n \\\"\\\"\\\"\\n This method is called when the user has requested to add a new item to the group.\\n By default, it emits ``sigAddNew(self, typ)``.\\n \\\"\\\"\\\"\\n self.sigAddNew.emit(self, typ)\\n \\n def setAddList(self, vals):\\n \\\"\\\"\\\"Change the list of options available for the user to add to the group.\\\"\\\"\\\"\\n self.setOpts(addList=vals)\\n\\n \\n\\nregisterParameterType('group', GroupParameter, override=True)\\n\\n\\n\\n\\n\\nclass ListParameterItem(WidgetParameterItem):\\n \\\"\\\"\\\"\\n WidgetParameterItem subclass providing comboBox that lets the user select from a list of options.\\n \\n \\\"\\\"\\\"\\n def __init__(self, param, depth):\\n self.targetValue = None\\n WidgetParameterItem.__init__(self, param, depth)\\n \\n \\n def makeWidget(self):\\n opts = self.param.opts\\n t = opts['type']\\n w = QtGui.QComboBox()\\n w.setMaximumHeight(20) ## set to match height of spin box and line edit\\n w.sigChanged = w.currentIndexChanged\\n w.value = self.value\\n w.setValue = self.setValue\\n self.widget = w ## needs to be set before limits are changed\\n self.limitsChanged(self.param, self.param.opts['limits'])\\n if len(self.forward) > 0:\\n self.setValue(self.param.value())\\n return w\\n \\n def value(self):\\n key = asUnicode(self.widget.currentText())\\n \\n return self.forward.get(key, None)\\n \\n def setValue(self, val):\\n self.targetValue = val\\n if val not in self.reverse[0]:\\n self.widget.setCurrentIndex(0)\\n else:\\n key = self.reverse[1][self.reverse[0].index(val)]\\n ind = self.widget.findText(key)\\n self.widget.setCurrentIndex(ind)\\n\\n def limitsChanged(self, param, limits):\\n # set up forward / reverse mappings for name:value\\n \\n if len(limits) == 0:\\n limits = [''] ## Can never have an empty list--there is always at least a singhe blank item.\\n \\n self.forward, self.reverse = ListParameter.mapping(limits)\\n try:\\n self.widget.blockSignals(True)\\n val = self.targetValue #asUnicode(self.widget.currentText())\\n \\n self.widget.clear()\\n for k in self.forward:\\n self.widget.addItem(k)\\n if k == val:\\n self.widget.setCurrentIndex(self.widget.count()-1)\\n self.updateDisplayLabel()\\n finally:\\n self.widget.blockSignals(False)\\n \\n\\n\\nclass ListParameter(Parameter):\\n itemClass = ListParameterItem\\n\\n def __init__(self, **opts):\\n self.forward = OrderedDict() ## {name: value, ...}\\n self.reverse = ([], []) ## ([value, ...], [name, ...])\\n \\n ## Parameter uses 'limits' option to define the set of allowed values\\n if 'values' in opts:\\n opts['limits'] = opts['values']\\n if opts.get('limits', None) is None:\\n opts['limits'] = []\\n Parameter.__init__(self, **opts)\\n self.setLimits(opts['limits'])\\n \\n def setLimits(self, limits):\\n self.forward, self.reverse = self.mapping(limits)\\n \\n Parameter.setLimits(self, limits)\\n if len(self.reverse[0]) > 0 and self.value() not in self.reverse[0]:\\n self.setValue(self.reverse[0][0])\\n \\n #def addItem(self, name, value=None):\\n #if name in self.forward:\\n #raise Exception(\\\"Name '%s' is already in use for this parameter\\\" % name)\\n #limits = self.opts['limits']\\n #if isinstance(limits, dict):\\n #limits = limits.copy()\\n #limits[name] = value\\n #self.setLimits(limits)\\n #else:\\n #if value is not None:\\n #raise Exception ## raise exception or convert to dict?\\n #limits = limits[:]\\n #limits.append(name)\\n ## what if limits == None?\\n \\n @staticmethod\\n def mapping(limits):\\n ## Return forward and reverse mapping objects given a limit specification\\n forward = OrderedDict() ## {name: value, ...}\\n reverse = ([], []) ## ([value, ...], [name, ...])\\n if isinstance(limits, dict):\\n for k, v in limits.items():\\n forward[k] = v\\n reverse[0].append(v)\\n reverse[1].append(k)\\n else:\\n for v in limits:\\n n = asUnicode(v)\\n forward[n] = v\\n reverse[0].append(v)\\n reverse[1].append(n)\\n return forward, reverse\\n\\nregisterParameterType('list', ListParameter, override=True)\\n\\n\\n\\nclass ActionParameterItem(ParameterItem):\\n def __init__(self, param, depth):\\n ParameterItem.__init__(self, param, depth)\\n self.layoutWidget = QtGui.QWidget()\\n self.layout = QtGui.QHBoxLayout()\\n self.layout.setContentsMargins(0, 0, 0, 0)\\n self.layoutWidget.setLayout(self.layout)\\n title = param.opts.get('title', None)\\n if title is None:\\n title = param.name()\\n self.button = QtGui.QPushButton(title)\\n #self.layout.addSpacing(100)\\n self.layout.addWidget(self.button)\\n self.layout.addStretch()\\n self.button.clicked.connect(self.buttonClicked)\\n param.sigNameChanged.connect(self.paramRenamed)\\n self.setText(0, '')\\n \\n def treeWidgetChanged(self):\\n ParameterItem.treeWidgetChanged(self)\\n tree = self.treeWidget()\\n if tree is None:\\n return\\n \\n tree.setFirstItemColumnSpanned(self, True)\\n tree.setItemWidget(self, 0, self.layoutWidget)\\n \\n def paramRenamed(self, param, name):\\n self.button.setText(name)\\n \\n def buttonClicked(self):\\n self.param.activate()\\n \\nclass ActionParameter(Parameter):\\n \\\"\\\"\\\"Used for displaying a button within the tree.\\\"\\\"\\\"\\n itemClass = ActionParameterItem\\n sigActivated = QtCore.Signal(object)\\n \\n def activate(self):\\n self.sigActivated.emit(self)\\n self.emitStateChanged('activated', None)\\n \\nregisterParameterType('action', ActionParameter, override=True)\\n\\n\\n\\nclass TextParameterItem(WidgetParameterItem):\\n def __init__(self, param, depth):\\n WidgetParameterItem.__init__(self, param, depth)\\n self.hideWidget = False\\n self.subItem = QtGui.QTreeWidgetItem()\\n self.addChild(self.subItem)\\n\\n def treeWidgetChanged(self):\\n ## TODO: fix so that superclass method can be called\\n ## (WidgetParameter should just natively support this style)\\n #WidgetParameterItem.treeWidgetChanged(self)\\n self.treeWidget().setFirstItemColumnSpanned(self.subItem, True)\\n self.treeWidget().setItemWidget(self.subItem, 0, self.textBox)\\n \\n # for now, these are copied from ParameterItem.treeWidgetChanged\\n self.setHidden(not self.param.opts.get('visible', True))\\n self.setExpanded(self.param.opts.get('expanded', True))\\n \\n def makeWidget(self):\\n self.textBox = QtGui.QTextEdit()\\n self.textBox.setMaximumHeight(100)\\n self.textBox.setReadOnly(self.param.opts.get('readonly', False))\\n self.textBox.value = lambda: str(self.textBox.toPlainText())\\n self.textBox.setValue = self.textBox.setPlainText\\n self.textBox.sigChanged = self.textBox.textChanged\\n return self.textBox\\n \\nclass TextParameter(Parameter):\\n \\\"\\\"\\\"Editable string; displayed as large text box in the tree.\\\"\\\"\\\"\\n itemClass = TextParameterItem\\n\\n \\n \\nregisterParameterType('text', TextParameter, override=True)\\n\",\n \"path\": \"pyqtgraph/parametertree/parameterTypes.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"from ..Qt import QtCore, QtGui\nfrom ..python2_3 import asUnicode\nfrom .Parameter import Parameter, registerParameterType\nfrom .ParameterItem import ParameterItem\nfrom ..widgets.SpinBox import SpinBox\nfrom ..widgets.ColorButton import ColorButton\nfrom ..colormap import ColorMap\n#from ..widgets.GradientWidget import GradientWidget ## creates import loop\nfrom .. import pixmaps as pixmaps\nfrom .. import functions as fn\nimport os, sys\nfrom ..pgcollections import OrderedDict\n\nclass WidgetParameterItem(ParameterItem):\n \"\"\"\n ParameterTree item with:\n \n * label in second column for displaying value\n * simple widget for editing value (displayed instead of label when item is selected)\n * button that resets value to default\n \n ========================== =============================================================\n **Registered Types:**\n int Displays a :class:`SpinBox <pyqtgraph.SpinBox>` in integer\n mode.\n float Displays a :class:`SpinBox <pyqtgraph.SpinBox>`.\n bool Displays a QCheckBox\n str Displays a QLineEdit\n color Displays a :class:`ColorButton <pyqtgraph.ColorButton>`\n colormap Displays a :class:`GradientWidget <pyqtgraph.GradientWidget>`\n ========================== =============================================================\n \n This class can be subclassed by overriding makeWidget() to provide a custom widget.\n \"\"\"\n def __init__(self, param, depth):\n ParameterItem.__init__(self, param, depth)\n \n self.hideWidget = True ## hide edit widget, replace with label when not selected\n ## set this to False to keep the editor widget always visible\n \n \n ## build widget into column 1 with a display label and default button.\n w = self.makeWidget() \n self.widget = w\n self.eventProxy = EventProxy(w, self.widgetEventFilter)\n \n opts = self.param.opts\n if 'tip' in opts:\n w.setToolTip(opts['tip'])\n \n self.defaultBtn = QtGui.QPushButton()\n self.defaultBtn.setFixedWidth(20)\n self.defaultBtn.setFixedHeight(20)\n modDir = os.path.dirname(__file__)\n self.defaultBtn.setIcon(QtGui.QIcon(pixmaps.getPixmap('default')))\n self.defaultBtn.clicked.connect(self.defaultClicked)\n \n self.displayLabel = QtGui.QLabel()\n \n layout = QtGui.QHBoxLayout()\n layout.setContentsMargins(0, 0, 0, 0)\n layout.setSpacing(2)\n layout.addWidget(w)\n layout.addWidget(self.displayLabel)\n layout.addWidget(self.defaultBtn)\n self.layoutWidget = QtGui.QWidget()\n self.layoutWidget.setLayout(layout)\n \n if w.sigChanged is not None:\n w.sigChanged.connect(self.widgetValueChanged)\n \n if hasattr(w, 'sigChanging'):\n w.sigChanging.connect(self.widgetValueChanging)\n \n ## update value shown in widget. \n if opts.get('value', None) is not None:\n self.valueChanged(self, opts['value'], force=True)\n else:\n ## no starting value was given; use whatever the widget has\n self.widgetValueChanged()\n\n self.updateDefaultBtn()\n\n def makeWidget(self):\n \"\"\"\n Return a single widget that should be placed in the second tree column.\n The widget must be given three attributes:\n \n ========== ============================================================\n sigChanged a signal that is emitted when the widget's value is changed\n value a function that returns the value\n setValue a function that sets the value\n ========== ============================================================\n \n This is a good function to override in subclasses.\n \"\"\"\n opts = self.param.opts\n t = opts['type']\n if t in ('int', 'float'):\n defs = {\n 'value': 0, 'min': None, 'max': None,\n 'step': 1.0, 'dec': False, \n 'siPrefix': False, 'suffix': '', 'decimals': 3,\n }\n if t == 'int':\n defs['int'] = True\n defs['minStep'] = 1.0\n defs['format'] = '{value:d}'\n for k in defs:\n if k in opts:\n defs[k] = opts[k]\n if 'limits' in opts:\n defs['min'], defs['max'] = opts['limits']\n w = SpinBox()\n w.setOpts(**defs)\n w.sigChanged = w.sigValueChanged\n w.sigChanging = w.sigValueChanging\n elif t == 'bool':\n w = QtGui.QCheckBox()\n w.sigChanged = w.toggled\n w.value = w.isChecked\n w.setValue = w.setChecked\n w.setEnabled(not opts.get('readonly', False))\n self.hideWidget = False\n elif t == 'str':\n w = QtGui.QLineEdit()\n w.setStyleSheet('border: 0px')\n w.sigChanged = w.editingFinished\n w.value = lambda: asUnicode(w.text())\n w.setValue = lambda v: w.setText(asUnicode(v))\n w.sigChanging = w.textChanged\n elif t == 'color':\n w = ColorButton()\n w.sigChanged = w.sigColorChanged\n w.sigChanging = w.sigColorChanging\n w.value = w.color\n w.setValue = w.setColor\n self.hideWidget = False\n w.setFlat(True)\n w.setEnabled(not opts.get('readonly', False)) \n elif t == 'colormap':\n from ..widgets.GradientWidget import GradientWidget ## need this here to avoid import loop\n w = GradientWidget(orientation='bottom')\n w.sigChanged = w.sigGradientChangeFinished\n w.sigChanging = w.sigGradientChanged\n w.value = w.colorMap\n w.setValue = w.setColorMap\n self.hideWidget = False\n else:\n raise Exception(\"Unknown type '%s'\" % asUnicode(t))\n return w\n \n def widgetEventFilter(self, obj, ev):\n ## filter widget's events\n ## catch TAB to change focus\n ## catch focusOut to hide editor\n if ev.type() == ev.KeyPress:\n if ev.key() == QtCore.Qt.Key_Tab:\n self.focusNext(forward=True)\n return True ## don't let anyone else see this event\n elif ev.key() == QtCore.Qt.Key_Backtab:\n self.focusNext(forward=False)\n return True ## don't let anyone else see this event\n \n #elif ev.type() == ev.FocusOut:\n #self.hideEditor()\n return False\n \n def setFocus(self):\n self.showEditor()\n \n def isFocusable(self):\n return self.param.writable() \n \n def valueChanged(self, param, val, force=False):\n ## called when the parameter's value has changed\n ParameterItem.valueChanged(self, param, val)\n self.widget.sigChanged.disconnect(self.widgetValueChanged)\n try:\n if force or val != self.widget.value():\n self.widget.setValue(val)\n self.updateDisplayLabel(val) ## always make sure label is updated, even if values match!\n finally:\n self.widget.sigChanged.connect(self.widgetValueChanged)\n self.updateDefaultBtn()\n \n def updateDefaultBtn(self):\n ## enable/disable default btn \n self.defaultBtn.setEnabled(not self.param.valueIsDefault() and self.param.writable()) \n \n # hide / show\n self.defaultBtn.setVisible(not self.param.readonly())\n\n def updateDisplayLabel(self, value=None):\n \"\"\"Update the display label to reflect the value of the parameter.\"\"\"\n if value is None:\n value = self.param.value()\n opts = self.param.opts\n if isinstance(self.widget, QtGui.QAbstractSpinBox):\n text = asUnicode(self.widget.lineEdit().text())\n elif isinstance(self.widget, QtGui.QComboBox):\n text = self.widget.currentText()\n else:\n text = asUnicode(value)\n self.displayLabel.setText(text)\n\n def widgetValueChanged(self):\n ## called when the widget's value has been changed by the user\n val = self.widget.value()\n newVal = self.param.setValue(val)\n\n def widgetValueChanging(self, *args):\n \"\"\"\n Called when the widget's value is changing, but not finalized.\n For example: editing text before pressing enter or changing focus.\n \"\"\"\n # This is a bit sketchy: assume the last argument of each signal is\n # the value..\n self.param.sigValueChanging.emit(self.param, args[-1])\n \n def selected(self, sel):\n \"\"\"Called when this item has been selected (sel=True) OR deselected (sel=False)\"\"\"\n ParameterItem.selected(self, sel)\n \n if self.widget is None:\n return\n if sel and self.param.writable():\n self.showEditor()\n elif self.hideWidget:\n self.hideEditor()\n\n def showEditor(self):\n self.widget.show()\n self.displayLabel.hide()\n self.widget.setFocus(QtCore.Qt.OtherFocusReason)\n if isinstance(self.widget, SpinBox):\n self.widget.selectNumber() # select the numerical portion of the text for quick editing\n\n def hideEditor(self):\n self.widget.hide()\n self.displayLabel.show()\n\n def limitsChanged(self, param, limits):\n \"\"\"Called when the parameter's limits have changed\"\"\"\n ParameterItem.limitsChanged(self, param, limits)\n \n t = self.param.opts['type']\n if t == 'int' or t == 'float':\n self.widget.setOpts(bounds=limits)\n else:\n return ## don't know what to do with any other types..\n\n def defaultChanged(self, param, value):\n self.updateDefaultBtn()\n\n def treeWidgetChanged(self):\n \"\"\"Called when this item is added or removed from a tree.\"\"\"\n ParameterItem.treeWidgetChanged(self)\n \n ## add all widgets for this item into the tree\n if self.widget is not None:\n tree = self.treeWidget()\n if tree is None:\n return\n tree.setItemWidget(self, 1, self.layoutWidget)\n self.displayLabel.hide()\n self.selected(False) \n\n def defaultClicked(self):\n self.param.setToDefault()\n\n def optsChanged(self, param, opts):\n \"\"\"Called when any options are changed that are not\n name, value, default, or limits\"\"\"\n #print \"opts changed:\", opts\n ParameterItem.optsChanged(self, param, opts)\n \n if 'readonly' in opts:\n self.updateDefaultBtn()\n if isinstance(self.widget, (QtGui.QCheckBox,ColorButton)):\n self.widget.setEnabled(not opts['readonly'])\n \n ## If widget is a SpinBox, pass options straight through\n if isinstance(self.widget, SpinBox):\n # send only options supported by spinbox\n sbOpts = {}\n if 'units' in opts and 'suffix' not in opts:\n sbOpts['suffix'] = opts['units']\n for k,v in opts.items():\n if k in self.widget.opts:\n sbOpts[k] = v\n self.widget.setOpts(**sbOpts)\n self.updateDisplayLabel()\n \n \nclass EventProxy(QtCore.QObject):\n def __init__(self, qobj, callback):\n QtCore.QObject.__init__(self)\n self.callback = callback\n qobj.installEventFilter(self)\n \n def eventFilter(self, obj, ev):\n return self.callback(obj, ev)\n\n\nclass SimpleParameter(Parameter):\n itemClass = WidgetParameterItem\n \n def __init__(self, *args, **kargs):\n Parameter.__init__(self, *args, **kargs)\n \n ## override a few methods for color parameters\n if self.opts['type'] == 'color':\n self.value = self.colorValue\n self.saveState = self.saveColorState\n \n def colorValue(self):\n return fn.mkColor(Parameter.value(self))\n \n def saveColorState(self, *args, **kwds):\n state = Parameter.saveState(self, *args, **kwds)\n state['value'] = fn.colorTuple(self.value())\n return state\n \n def _interpretValue(self, v):\n fn = {\n 'int': int,\n 'float': float,\n 'bool': bool,\n 'str': asUnicode,\n 'color': self._interpColor,\n 'colormap': self._interpColormap,\n }[self.opts['type']]\n return fn(v)\n \n def _interpColor(self, v):\n return fn.mkColor(v)\n \n def _interpColormap(self, v):\n if not isinstance(v, ColorMap):\n raise TypeError(\"Cannot set colormap parameter from object %r\" % v)\n return v\n \n \n \nregisterParameterType('int', SimpleParameter, override=True)\nregisterParameterType('float', SimpleParameter, override=True)\nregisterParameterType('bool', SimpleParameter, override=True)\nregisterParameterType('str', SimpleParameter, override=True)\nregisterParameterType('color', SimpleParameter, override=True)\nregisterParameterType('colormap', SimpleParameter, override=True)\n\n\n\n\nclass GroupParameterItem(ParameterItem):\n \"\"\"\n Group parameters are used mainly as a generic parent item that holds (and groups!) a set\n of child parameters. It also provides a simple mechanism for displaying a button or combo\n that can be used to add new parameters to the group.\n \"\"\"\n def __init__(self, param, depth):\n ParameterItem.__init__(self, param, depth)\n self.updateDepth(depth) \n \n self.addItem = None\n if 'addText' in param.opts:\n addText = param.opts['addText']\n if 'addList' in param.opts:\n self.addWidget = QtGui.QComboBox()\n self.addWidget.setSizeAdjustPolicy(QtGui.QComboBox.AdjustToContents)\n self.updateAddList()\n self.addWidget.currentIndexChanged.connect(self.addChanged)\n else:\n self.addWidget = QtGui.QPushButton(addText)\n self.addWidget.clicked.connect(self.addClicked)\n w = QtGui.QWidget()\n l = QtGui.QHBoxLayout()\n l.setContentsMargins(0,0,0,0)\n w.setLayout(l)\n l.addWidget(self.addWidget)\n l.addStretch()\n #l.addItem(QtGui.QSpacerItem(200, 10, QtGui.QSizePolicy.Expanding, QtGui.QSizePolicy.Minimum))\n self.addWidgetBox = w\n self.addItem = QtGui.QTreeWidgetItem([])\n self.addItem.setFlags(QtCore.Qt.ItemIsEnabled)\n ParameterItem.addChild(self, self.addItem)\n \n def updateDepth(self, depth):\n ## Change item's appearance based on its depth in the tree\n ## This allows highest-level groups to be displayed more prominently.\n if depth == 0:\n for c in [0,1]:\n self.setBackground(c, QtGui.QBrush(QtGui.QColor(100,100,100)))\n self.setForeground(c, QtGui.QBrush(QtGui.QColor(220,220,255)))\n font = self.font(c)\n font.setBold(True)\n font.setPointSize(font.pointSize()+1)\n self.setFont(c, font)\n self.setSizeHint(0, QtCore.QSize(0, 25))\n else:\n for c in [0,1]:\n self.setBackground(c, QtGui.QBrush(QtGui.QColor(220,220,220)))\n self.setForeground(c, QtGui.QBrush(QtGui.QColor(50,50,50)))\n font = self.font(c)\n font.setBold(True)\n #font.setPointSize(font.pointSize()+1)\n self.setFont(c, font)\n self.setSizeHint(0, QtCore.QSize(0, 20))\n \n def addClicked(self):\n \"\"\"Called when \"add new\" button is clicked\n The parameter MUST have an 'addNew' method defined.\n \"\"\"\n self.param.addNew()\n\n def addChanged(self):\n \"\"\"Called when \"add new\" combo is changed\n The parameter MUST have an 'addNew' method defined.\n \"\"\"\n if self.addWidget.currentIndex() == 0:\n return\n typ = asUnicode(self.addWidget.currentText())\n self.param.addNew(typ)\n self.addWidget.setCurrentIndex(0)\n\n def treeWidgetChanged(self):\n ParameterItem.treeWidgetChanged(self)\n self.treeWidget().setFirstItemColumnSpanned(self, True)\n if self.addItem is not None:\n self.treeWidget().setItemWidget(self.addItem, 0, self.addWidgetBox)\n self.treeWidget().setFirstItemColumnSpanned(self.addItem, True)\n \n def addChild(self, child): ## make sure added childs are actually inserted before add btn\n if self.addItem is not None:\n ParameterItem.insertChild(self, self.childCount()-1, child)\n else:\n ParameterItem.addChild(self, child)\n \n def optsChanged(self, param, opts):\n ParameterItem.optsChanged(self, param, opts)\n \n if 'addList' in opts:\n self.updateAddList()\n \n def updateAddList(self):\n self.addWidget.blockSignals(True)\n try:\n self.addWidget.clear()\n self.addWidget.addItem(self.param.opts['addText'])\n for t in self.param.opts['addList']:\n self.addWidget.addItem(t)\n finally:\n self.addWidget.blockSignals(False)\n \nclass GroupParameter(Parameter):\n \"\"\"\n Group parameters are used mainly as a generic parent item that holds (and groups!) a set\n of child parameters. \n \n It also provides a simple mechanism for displaying a button or combo\n that can be used to add new parameters to the group. To enable this, the group \n must be initialized with the 'addText' option (the text will be displayed on\n a button which, when clicked, will cause addNew() to be called). If the 'addList'\n option is specified as well, then a dropdown-list of addable items will be displayed\n instead of a button.\n \"\"\"\n itemClass = GroupParameterItem\n \n sigAddNew = QtCore.Signal(object, object) # self, type\n\n def addNew(self, typ=None):\n \"\"\"\n This method is called when the user has requested to add a new item to the group.\n By default, it emits ``sigAddNew(self, typ)``.\n \"\"\"\n self.sigAddNew.emit(self, typ)\n \n def setAddList(self, vals):\n \"\"\"Change the list of options available for the user to add to the group.\"\"\"\n self.setOpts(addList=vals)\n\n \n\nregisterParameterType('group', GroupParameter, override=True)\n\n\n\n\n\nclass ListParameterItem(WidgetParameterItem):\n \"\"\"\n WidgetParameterItem subclass providing comboBox that lets the user select from a list of options.\n \n \"\"\"\n def __init__(self, param, depth):\n self.targetValue = None\n WidgetParameterItem.__init__(self, param, depth)\n \n \n def makeWidget(self):\n opts = self.param.opts\n t = opts['type']\n w = QtGui.QComboBox()\n w.setMaximumHeight(20) ## set to match height of spin box and line edit\n w.sigChanged = w.currentIndexChanged\n w.value = self.value\n w.setValue = self.setValue\n self.widget = w ## needs to be set before limits are changed\n self.limitsChanged(self.param, self.param.opts['limits'])\n if len(self.forward) > 0:\n self.setValue(self.param.value())\n return w\n \n def value(self):\n key = asUnicode(self.widget.currentText())\n \n return self.forward.get(key, None)\n \n def setValue(self, val):\n self.targetValue = val\n if val not in self.reverse[0]:\n self.widget.setCurrentIndex(0)\n else:\n key = self.reverse[1][self.reverse[0].index(val)]\n ind = self.widget.findText(key)\n self.widget.setCurrentIndex(ind)\n\n def limitsChanged(self, param, limits):\n # set up forward / reverse mappings for name:value\n \n if len(limits) == 0:\n limits = [''] ## Can never have an empty list--there is always at least a singhe blank item.\n \n self.forward, self.reverse = ListParameter.mapping(limits)\n try:\n self.widget.blockSignals(True)\n val = self.targetValue #asUnicode(self.widget.currentText())\n \n self.widget.clear()\n for k in self.forward:\n self.widget.addItem(k)\n if k == val:\n self.widget.setCurrentIndex(self.widget.count()-1)\n self.updateDisplayLabel()\n finally:\n self.widget.blockSignals(False)\n \n\n\nclass ListParameter(Parameter):\n itemClass = ListParameterItem\n\n def __init__(self, **opts):\n self.forward = OrderedDict() ## {name: value, ...}\n self.reverse = ([], []) ## ([value, ...], [name, ...])\n \n ## Parameter uses 'limits' option to define the set of allowed values\n if 'values' in opts:\n opts['limits'] = opts['values']\n if opts.get('limits', None) is None:\n opts['limits'] = []\n Parameter.__init__(self, **opts)\n self.setLimits(opts['limits'])\n \n def setLimits(self, limits):\n self.forward, self.reverse = self.mapping(limits)\n \n Parameter.setLimits(self, limits)\n if len(self.reverse[0]) > 0 and self.value() not in self.reverse[0]:\n self.setValue(self.reverse[0][0])\n \n #def addItem(self, name, value=None):\n #if name in self.forward:\n #raise Exception(\"Name '%s' is already in use for this parameter\" % name)\n #limits = self.opts['limits']\n #if isinstance(limits, dict):\n #limits = limits.copy()\n #limits[name] = value\n #self.setLimits(limits)\n #else:\n #if value is not None:\n #raise Exception ## raise exception or convert to dict?\n #limits = limits[:]\n #limits.append(name)\n ## what if limits == None?\n \n @staticmethod\n def mapping(limits):\n ## Return forward and reverse mapping objects given a limit specification\n forward = OrderedDict() ## {name: value, ...}\n reverse = ([], []) ## ([value, ...], [name, ...])\n if isinstance(limits, dict):\n for k, v in limits.items():\n forward[k] = v\n reverse[0].append(v)\n reverse[1].append(k)\n else:\n for v in limits:\n n = asUnicode(v)\n forward[n] = v\n reverse[0].append(v)\n reverse[1].append(n)\n return forward, reverse\n\nregisterParameterType('list', ListParameter, override=True)\n\n\n\nclass ActionParameterItem(ParameterItem):\n def __init__(self, param, depth):\n ParameterItem.__init__(self, param, depth)\n self.layoutWidget = QtGui.QWidget()\n self.layout = QtGui.QHBoxLayout()\n self.layout.setContentsMargins(0, 0, 0, 0)\n self.layoutWidget.setLayout(self.layout)\n title = param.opts.get('title', None)\n if title is None:\n title = param.name()\n self.button = QtGui.QPushButton(title)\n #self.layout.addSpacing(100)\n self.layout.addWidget(self.button)\n self.layout.addStretch()\n self.button.clicked.connect(self.buttonClicked)\n param.sigNameChanged.connect(self.paramRenamed)\n self.setText(0, '')\n \n def treeWidgetChanged(self):\n ParameterItem.treeWidgetChanged(self)\n tree = self.treeWidget()\n if tree is None:\n return\n \n tree.setFirstItemColumnSpanned(self, True)\n tree.setItemWidget(self, 0, self.layoutWidget)\n \n def paramRenamed(self, param, name):\n self.button.setText(name)\n \n def buttonClicked(self):\n self.param.activate()\n \nclass ActionParameter(Parameter):\n \"\"\"Used for displaying a button within the tree.\"\"\"\n itemClass = ActionParameterItem\n sigActivated = QtCore.Signal(object)\n \n def activate(self):\n self.sigActivated.emit(self)\n self.emitStateChanged('activated', None)\n \nregisterParameterType('action', ActionParameter, override=True)\n\n\n\nclass TextParameterItem(WidgetParameterItem):\n def __init__(self, param, depth):\n WidgetParameterItem.__init__(self, param, depth)\n self.hideWidget = False\n self.subItem = QtGui.QTreeWidgetItem()\n self.addChild(self.subItem)\n\n def treeWidgetChanged(self):\n ## TODO: fix so that superclass method can be called\n ## (WidgetParameter should just natively support this style)\n #WidgetParameterItem.treeWidgetChanged(self)\n self.treeWidget().setFirstItemColumnSpanned(self.subItem, True)\n self.treeWidget().setItemWidget(self.subItem, 0, self.textBox)\n \n # for now, these are copied from ParameterItem.treeWidgetChanged\n self.setHidden(not self.param.opts.get('visible', True))\n self.setExpanded(self.param.opts.get('expanded', True))\n \n def makeWidget(self):\n self.textBox = QtGui.QTextEdit()\n self.textBox.setMaximumHeight(100)\n self.textBox.setReadOnly(self.param.opts.get('readonly', False))\n self.textBox.value = lambda: str(self.textBox.toPlainText())\n self.textBox.setValue = self.textBox.setPlainText\n self.textBox.sigChanged = self.textBox.textChanged\n return self.textBox\n \nclass TextParameter(Parameter):\n \"\"\"Editable string; displayed as large text box in the tree.\"\"\"\n itemClass = TextParameterItem\n\n \n \nregisterParameterType('text', TextParameter, override=True)\n","path":"pyqtgraph/parametertree/parameterTypes.py"}],"string":"[\n {\n \"content\": \"from ..Qt import QtCore, QtGui\\nfrom ..python2_3 import asUnicode\\nfrom .Parameter import Parameter, registerParameterType\\nfrom .ParameterItem import ParameterItem\\nfrom ..widgets.SpinBox import SpinBox\\nfrom ..widgets.ColorButton import ColorButton\\nfrom ..colormap import ColorMap\\n#from ..widgets.GradientWidget import GradientWidget ## creates import loop\\nfrom .. import pixmaps as pixmaps\\nfrom .. import functions as fn\\nimport os, sys\\nfrom ..pgcollections import OrderedDict\\n\\nclass WidgetParameterItem(ParameterItem):\\n \\\"\\\"\\\"\\n ParameterTree item with:\\n \\n * label in second column for displaying value\\n * simple widget for editing value (displayed instead of label when item is selected)\\n * button that resets value to default\\n \\n ========================== =============================================================\\n **Registered Types:**\\n int Displays a :class:`SpinBox <pyqtgraph.SpinBox>` in integer\\n mode.\\n float Displays a :class:`SpinBox <pyqtgraph.SpinBox>`.\\n bool Displays a QCheckBox\\n str Displays a QLineEdit\\n color Displays a :class:`ColorButton <pyqtgraph.ColorButton>`\\n colormap Displays a :class:`GradientWidget <pyqtgraph.GradientWidget>`\\n ========================== =============================================================\\n \\n This class can be subclassed by overriding makeWidget() to provide a custom widget.\\n \\\"\\\"\\\"\\n def __init__(self, param, depth):\\n ParameterItem.__init__(self, param, depth)\\n \\n self.hideWidget = True ## hide edit widget, replace with label when not selected\\n ## set this to False to keep the editor widget always visible\\n \\n \\n ## build widget into column 1 with a display label and default button.\\n w = self.makeWidget() \\n self.widget = w\\n self.eventProxy = EventProxy(w, self.widgetEventFilter)\\n \\n opts = self.param.opts\\n if 'tip' in opts:\\n w.setToolTip(opts['tip'])\\n \\n self.defaultBtn = QtGui.QPushButton()\\n self.defaultBtn.setFixedWidth(20)\\n self.defaultBtn.setFixedHeight(20)\\n modDir = os.path.dirname(__file__)\\n self.defaultBtn.setIcon(QtGui.QIcon(pixmaps.getPixmap('default')))\\n self.defaultBtn.clicked.connect(self.defaultClicked)\\n \\n self.displayLabel = QtGui.QLabel()\\n \\n layout = QtGui.QHBoxLayout()\\n layout.setContentsMargins(0, 0, 0, 0)\\n layout.setSpacing(2)\\n layout.addWidget(w)\\n layout.addWidget(self.displayLabel)\\n layout.addWidget(self.defaultBtn)\\n self.layoutWidget = QtGui.QWidget()\\n self.layoutWidget.setLayout(layout)\\n \\n if w.sigChanged is not None:\\n w.sigChanged.connect(self.widgetValueChanged)\\n \\n if hasattr(w, 'sigChanging'):\\n w.sigChanging.connect(self.widgetValueChanging)\\n \\n ## update value shown in widget. \\n if opts.get('value', None) is not None:\\n self.valueChanged(self, opts['value'], force=True)\\n else:\\n ## no starting value was given; use whatever the widget has\\n self.widgetValueChanged()\\n\\n self.updateDefaultBtn()\\n\\n def makeWidget(self):\\n \\\"\\\"\\\"\\n Return a single widget that should be placed in the second tree column.\\n The widget must be given three attributes:\\n \\n ========== ============================================================\\n sigChanged a signal that is emitted when the widget's value is changed\\n value a function that returns the value\\n setValue a function that sets the value\\n ========== ============================================================\\n \\n This is a good function to override in subclasses.\\n \\\"\\\"\\\"\\n opts = self.param.opts\\n t = opts['type']\\n if t in ('int', 'float'):\\n defs = {\\n 'value': 0, 'min': None, 'max': None,\\n 'step': 1.0, 'dec': False, \\n 'siPrefix': False, 'suffix': '', 'decimals': 3,\\n }\\n if t == 'int':\\n defs['int'] = True\\n defs['minStep'] = 1.0\\n defs['format'] = '{value:d}'\\n for k in defs:\\n if k in opts:\\n defs[k] = opts[k]\\n if 'limits' in opts:\\n defs['min'], defs['max'] = opts['limits']\\n w = SpinBox()\\n w.setOpts(**defs)\\n w.sigChanged = w.sigValueChanged\\n w.sigChanging = w.sigValueChanging\\n elif t == 'bool':\\n w = QtGui.QCheckBox()\\n w.sigChanged = w.toggled\\n w.value = w.isChecked\\n w.setValue = w.setChecked\\n w.setEnabled(not opts.get('readonly', False))\\n self.hideWidget = False\\n elif t == 'str':\\n w = QtGui.QLineEdit()\\n w.setStyleSheet('border: 0px')\\n w.sigChanged = w.editingFinished\\n w.value = lambda: asUnicode(w.text())\\n w.setValue = lambda v: w.setText(asUnicode(v))\\n w.sigChanging = w.textChanged\\n elif t == 'color':\\n w = ColorButton()\\n w.sigChanged = w.sigColorChanged\\n w.sigChanging = w.sigColorChanging\\n w.value = w.color\\n w.setValue = w.setColor\\n self.hideWidget = False\\n w.setFlat(True)\\n w.setEnabled(not opts.get('readonly', False)) \\n elif t == 'colormap':\\n from ..widgets.GradientWidget import GradientWidget ## need this here to avoid import loop\\n w = GradientWidget(orientation='bottom')\\n w.sigChanged = w.sigGradientChangeFinished\\n w.sigChanging = w.sigGradientChanged\\n w.value = w.colorMap\\n w.setValue = w.setColorMap\\n self.hideWidget = False\\n else:\\n raise Exception(\\\"Unknown type '%s'\\\" % asUnicode(t))\\n return w\\n \\n def widgetEventFilter(self, obj, ev):\\n ## filter widget's events\\n ## catch TAB to change focus\\n ## catch focusOut to hide editor\\n if ev.type() == ev.KeyPress:\\n if ev.key() == QtCore.Qt.Key_Tab:\\n self.focusNext(forward=True)\\n return True ## don't let anyone else see this event\\n elif ev.key() == QtCore.Qt.Key_Backtab:\\n self.focusNext(forward=False)\\n return True ## don't let anyone else see this event\\n \\n #elif ev.type() == ev.FocusOut:\\n #self.hideEditor()\\n return False\\n \\n def setFocus(self):\\n self.showEditor()\\n \\n def isFocusable(self):\\n return self.param.writable() \\n \\n def valueChanged(self, param, val, force=False):\\n ## called when the parameter's value has changed\\n ParameterItem.valueChanged(self, param, val)\\n self.widget.sigChanged.disconnect(self.widgetValueChanged)\\n try:\\n if force or val != self.widget.value():\\n self.widget.setValue(val)\\n self.updateDisplayLabel(val) ## always make sure label is updated, even if values match!\\n finally:\\n self.widget.sigChanged.connect(self.widgetValueChanged)\\n self.updateDefaultBtn()\\n \\n def updateDefaultBtn(self):\\n ## enable/disable default btn \\n self.defaultBtn.setEnabled(not self.param.valueIsDefault() and self.param.writable()) \\n \\n # hide / show\\n self.defaultBtn.setVisible(not self.param.readonly())\\n\\n def updateDisplayLabel(self, value=None):\\n \\\"\\\"\\\"Update the display label to reflect the value of the parameter.\\\"\\\"\\\"\\n if value is None:\\n value = self.param.value()\\n opts = self.param.opts\\n if isinstance(self.widget, QtGui.QAbstractSpinBox):\\n text = asUnicode(self.widget.lineEdit().text())\\n elif isinstance(self.widget, QtGui.QComboBox):\\n text = self.widget.currentText()\\n else:\\n text = asUnicode(value)\\n self.displayLabel.setText(text)\\n\\n def widgetValueChanged(self):\\n ## called when the widget's value has been changed by the user\\n val = self.widget.value()\\n newVal = self.param.setValue(val)\\n\\n def widgetValueChanging(self, *args):\\n \\\"\\\"\\\"\\n Called when the widget's value is changing, but not finalized.\\n For example: editing text before pressing enter or changing focus.\\n \\\"\\\"\\\"\\n # This is a bit sketchy: assume the last argument of each signal is\\n # the value..\\n self.param.sigValueChanging.emit(self.param, args[-1])\\n \\n def selected(self, sel):\\n \\\"\\\"\\\"Called when this item has been selected (sel=True) OR deselected (sel=False)\\\"\\\"\\\"\\n ParameterItem.selected(self, sel)\\n \\n if self.widget is None:\\n return\\n if sel and self.param.writable():\\n self.showEditor()\\n elif self.hideWidget:\\n self.hideEditor()\\n\\n def showEditor(self):\\n self.widget.show()\\n self.displayLabel.hide()\\n self.widget.setFocus(QtCore.Qt.OtherFocusReason)\\n if isinstance(self.widget, SpinBox):\\n self.widget.selectNumber() # select the numerical portion of the text for quick editing\\n\\n def hideEditor(self):\\n self.widget.hide()\\n self.displayLabel.show()\\n\\n def limitsChanged(self, param, limits):\\n \\\"\\\"\\\"Called when the parameter's limits have changed\\\"\\\"\\\"\\n ParameterItem.limitsChanged(self, param, limits)\\n \\n t = self.param.opts['type']\\n if t == 'int' or t == 'float':\\n self.widget.setOpts(bounds=limits)\\n else:\\n return ## don't know what to do with any other types..\\n\\n def defaultChanged(self, param, value):\\n self.updateDefaultBtn()\\n\\n def treeWidgetChanged(self):\\n \\\"\\\"\\\"Called when this item is added or removed from a tree.\\\"\\\"\\\"\\n ParameterItem.treeWidgetChanged(self)\\n \\n ## add all widgets for this item into the tree\\n if self.widget is not None:\\n tree = self.treeWidget()\\n if tree is None:\\n return\\n tree.setItemWidget(self, 1, self.layoutWidget)\\n self.displayLabel.hide()\\n self.selected(False) \\n\\n def defaultClicked(self):\\n self.param.setToDefault()\\n\\n def optsChanged(self, param, opts):\\n \\\"\\\"\\\"Called when any options are changed that are not\\n name, value, default, or limits\\\"\\\"\\\"\\n #print \\\"opts changed:\\\", opts\\n ParameterItem.optsChanged(self, param, opts)\\n \\n if 'readonly' in opts:\\n self.updateDefaultBtn()\\n if isinstance(self.widget, (QtGui.QCheckBox,ColorButton)):\\n self.widget.setEnabled(not opts['readonly'])\\n \\n ## If widget is a SpinBox, pass options straight through\\n if isinstance(self.widget, SpinBox):\\n # send only options supported by spinbox\\n sbOpts = {}\\n if 'units' in opts and 'suffix' not in opts:\\n sbOpts['suffix'] = opts['units']\\n for k,v in opts.items():\\n if k in self.widget.opts:\\n sbOpts[k] = v\\n self.widget.setOpts(**sbOpts)\\n self.updateDisplayLabel()\\n \\n \\nclass EventProxy(QtCore.QObject):\\n def __init__(self, qobj, callback):\\n QtCore.QObject.__init__(self)\\n self.callback = callback\\n qobj.installEventFilter(self)\\n \\n def eventFilter(self, obj, ev):\\n return self.callback(obj, ev)\\n\\n\\nclass SimpleParameter(Parameter):\\n itemClass = WidgetParameterItem\\n \\n def __init__(self, *args, **kargs):\\n Parameter.__init__(self, *args, **kargs)\\n \\n ## override a few methods for color parameters\\n if self.opts['type'] == 'color':\\n self.value = self.colorValue\\n self.saveState = self.saveColorState\\n \\n def colorValue(self):\\n return fn.mkColor(Parameter.value(self))\\n \\n def saveColorState(self, *args, **kwds):\\n state = Parameter.saveState(self, *args, **kwds)\\n state['value'] = fn.colorTuple(self.value())\\n return state\\n \\n def _interpretValue(self, v):\\n fn = {\\n 'int': int,\\n 'float': float,\\n 'bool': bool,\\n 'str': asUnicode,\\n 'color': self._interpColor,\\n 'colormap': self._interpColormap,\\n }[self.opts['type']]\\n return fn(v)\\n \\n def _interpColor(self, v):\\n return fn.mkColor(v)\\n \\n def _interpColormap(self, v):\\n if not isinstance(v, ColorMap):\\n raise TypeError(\\\"Cannot set colormap parameter from object %r\\\" % v)\\n return v\\n \\n \\n \\nregisterParameterType('int', SimpleParameter, override=True)\\nregisterParameterType('float', SimpleParameter, override=True)\\nregisterParameterType('bool', SimpleParameter, override=True)\\nregisterParameterType('str', SimpleParameter, override=True)\\nregisterParameterType('color', SimpleParameter, override=True)\\nregisterParameterType('colormap', SimpleParameter, override=True)\\n\\n\\n\\n\\nclass GroupParameterItem(ParameterItem):\\n \\\"\\\"\\\"\\n Group parameters are used mainly as a generic parent item that holds (and groups!) a set\\n of child parameters. It also provides a simple mechanism for displaying a button or combo\\n that can be used to add new parameters to the group.\\n \\\"\\\"\\\"\\n def __init__(self, param, depth):\\n ParameterItem.__init__(self, param, depth)\\n self.updateDepth(depth) \\n \\n self.addItem = None\\n if 'addText' in param.opts:\\n addText = param.opts['addText']\\n if 'addList' in param.opts:\\n self.addWidget = QtGui.QComboBox()\\n self.addWidget.setSizeAdjustPolicy(QtGui.QComboBox.AdjustToContents)\\n self.updateAddList()\\n self.addWidget.currentIndexChanged.connect(self.addChanged)\\n else:\\n self.addWidget = QtGui.QPushButton(addText)\\n self.addWidget.clicked.connect(self.addClicked)\\n w = QtGui.QWidget()\\n l = QtGui.QHBoxLayout()\\n l.setContentsMargins(0,0,0,0)\\n w.setLayout(l)\\n l.addWidget(self.addWidget)\\n l.addStretch()\\n #l.addItem(QtGui.QSpacerItem(200, 10, QtGui.QSizePolicy.Expanding, QtGui.QSizePolicy.Minimum))\\n self.addWidgetBox = w\\n self.addItem = QtGui.QTreeWidgetItem([])\\n self.addItem.setFlags(QtCore.Qt.ItemIsEnabled)\\n ParameterItem.addChild(self, self.addItem)\\n \\n def updateDepth(self, depth):\\n ## Change item's appearance based on its depth in the tree\\n ## This allows highest-level groups to be displayed more prominently.\\n if depth == 0:\\n for c in [0,1]:\\n self.setBackground(c, QtGui.QBrush(QtGui.QColor(100,100,100)))\\n self.setForeground(c, QtGui.QBrush(QtGui.QColor(220,220,255)))\\n font = self.font(c)\\n font.setBold(True)\\n font.setPointSize(font.pointSize()+1)\\n self.setFont(c, font)\\n self.setSizeHint(0, QtCore.QSize(0, 25))\\n else:\\n for c in [0,1]:\\n self.setBackground(c, QtGui.QBrush(QtGui.QColor(220,220,220)))\\n self.setForeground(c, QtGui.QBrush(QtGui.QColor(50,50,50)))\\n font = self.font(c)\\n font.setBold(True)\\n #font.setPointSize(font.pointSize()+1)\\n self.setFont(c, font)\\n self.setSizeHint(0, QtCore.QSize(0, 20))\\n \\n def addClicked(self):\\n \\\"\\\"\\\"Called when \\\"add new\\\" button is clicked\\n The parameter MUST have an 'addNew' method defined.\\n \\\"\\\"\\\"\\n self.param.addNew()\\n\\n def addChanged(self):\\n \\\"\\\"\\\"Called when \\\"add new\\\" combo is changed\\n The parameter MUST have an 'addNew' method defined.\\n \\\"\\\"\\\"\\n if self.addWidget.currentIndex() == 0:\\n return\\n typ = asUnicode(self.addWidget.currentText())\\n self.param.addNew(typ)\\n self.addWidget.setCurrentIndex(0)\\n\\n def treeWidgetChanged(self):\\n ParameterItem.treeWidgetChanged(self)\\n self.treeWidget().setFirstItemColumnSpanned(self, True)\\n if self.addItem is not None:\\n self.treeWidget().setItemWidget(self.addItem, 0, self.addWidgetBox)\\n self.treeWidget().setFirstItemColumnSpanned(self.addItem, True)\\n \\n def addChild(self, child): ## make sure added childs are actually inserted before add btn\\n if self.addItem is not None:\\n ParameterItem.insertChild(self, self.childCount()-1, child)\\n else:\\n ParameterItem.addChild(self, child)\\n \\n def optsChanged(self, param, opts):\\n ParameterItem.optsChanged(self, param, opts)\\n \\n if 'addList' in opts:\\n self.updateAddList()\\n \\n def updateAddList(self):\\n self.addWidget.blockSignals(True)\\n try:\\n self.addWidget.clear()\\n self.addWidget.addItem(self.param.opts['addText'])\\n for t in self.param.opts['addList']:\\n self.addWidget.addItem(t)\\n finally:\\n self.addWidget.blockSignals(False)\\n \\nclass GroupParameter(Parameter):\\n \\\"\\\"\\\"\\n Group parameters are used mainly as a generic parent item that holds (and groups!) a set\\n of child parameters. \\n \\n It also provides a simple mechanism for displaying a button or combo\\n that can be used to add new parameters to the group. To enable this, the group \\n must be initialized with the 'addText' option (the text will be displayed on\\n a button which, when clicked, will cause addNew() to be called). If the 'addList'\\n option is specified as well, then a dropdown-list of addable items will be displayed\\n instead of a button.\\n \\\"\\\"\\\"\\n itemClass = GroupParameterItem\\n \\n sigAddNew = QtCore.Signal(object, object) # self, type\\n\\n def addNew(self, typ=None):\\n \\\"\\\"\\\"\\n This method is called when the user has requested to add a new item to the group.\\n By default, it emits ``sigAddNew(self, typ)``.\\n \\\"\\\"\\\"\\n self.sigAddNew.emit(self, typ)\\n \\n def setAddList(self, vals):\\n \\\"\\\"\\\"Change the list of options available for the user to add to the group.\\\"\\\"\\\"\\n self.setOpts(addList=vals)\\n\\n \\n\\nregisterParameterType('group', GroupParameter, override=True)\\n\\n\\n\\n\\n\\nclass ListParameterItem(WidgetParameterItem):\\n \\\"\\\"\\\"\\n WidgetParameterItem subclass providing comboBox that lets the user select from a list of options.\\n \\n \\\"\\\"\\\"\\n def __init__(self, param, depth):\\n self.targetValue = None\\n WidgetParameterItem.__init__(self, param, depth)\\n \\n \\n def makeWidget(self):\\n opts = self.param.opts\\n t = opts['type']\\n w = QtGui.QComboBox()\\n w.setMaximumHeight(20) ## set to match height of spin box and line edit\\n w.sigChanged = w.currentIndexChanged\\n w.value = self.value\\n w.setValue = self.setValue\\n self.widget = w ## needs to be set before limits are changed\\n self.limitsChanged(self.param, self.param.opts['limits'])\\n if len(self.forward) > 0:\\n self.setValue(self.param.value())\\n return w\\n \\n def value(self):\\n key = asUnicode(self.widget.currentText())\\n \\n return self.forward.get(key, None)\\n \\n def setValue(self, val):\\n self.targetValue = val\\n if val not in self.reverse[0]:\\n self.widget.setCurrentIndex(0)\\n else:\\n key = self.reverse[1][self.reverse[0].index(val)]\\n ind = self.widget.findText(key)\\n self.widget.setCurrentIndex(ind)\\n\\n def limitsChanged(self, param, limits):\\n # set up forward / reverse mappings for name:value\\n \\n if len(limits) == 0:\\n limits = [''] ## Can never have an empty list--there is always at least a singhe blank item.\\n \\n self.forward, self.reverse = ListParameter.mapping(limits)\\n try:\\n self.widget.blockSignals(True)\\n val = self.targetValue #asUnicode(self.widget.currentText())\\n \\n self.widget.clear()\\n for k in self.forward:\\n self.widget.addItem(k)\\n if k == val:\\n self.widget.setCurrentIndex(self.widget.count()-1)\\n self.updateDisplayLabel()\\n finally:\\n self.widget.blockSignals(False)\\n \\n\\n\\nclass ListParameter(Parameter):\\n itemClass = ListParameterItem\\n\\n def __init__(self, **opts):\\n self.forward = OrderedDict() ## {name: value, ...}\\n self.reverse = ([], []) ## ([value, ...], [name, ...])\\n \\n ## Parameter uses 'limits' option to define the set of allowed values\\n if 'values' in opts:\\n opts['limits'] = opts['values']\\n if opts.get('limits', None) is None:\\n opts['limits'] = []\\n Parameter.__init__(self, **opts)\\n self.setLimits(opts['limits'])\\n \\n def setLimits(self, limits):\\n self.forward, self.reverse = self.mapping(limits)\\n \\n Parameter.setLimits(self, limits)\\n if len(self.reverse[0]) > 0 and self.value() not in self.reverse[0]:\\n self.setValue(self.reverse[0][0])\\n \\n #def addItem(self, name, value=None):\\n #if name in self.forward:\\n #raise Exception(\\\"Name '%s' is already in use for this parameter\\\" % name)\\n #limits = self.opts['limits']\\n #if isinstance(limits, dict):\\n #limits = limits.copy()\\n #limits[name] = value\\n #self.setLimits(limits)\\n #else:\\n #if value is not None:\\n #raise Exception ## raise exception or convert to dict?\\n #limits = limits[:]\\n #limits.append(name)\\n ## what if limits == None?\\n \\n @staticmethod\\n def mapping(limits):\\n ## Return forward and reverse mapping objects given a limit specification\\n forward = OrderedDict() ## {name: value, ...}\\n reverse = ([], []) ## ([value, ...], [name, ...])\\n if isinstance(limits, dict):\\n for k, v in limits.items():\\n forward[k] = v\\n reverse[0].append(v)\\n reverse[1].append(k)\\n else:\\n for v in limits:\\n n = asUnicode(v)\\n forward[n] = v\\n reverse[0].append(v)\\n reverse[1].append(n)\\n return forward, reverse\\n\\nregisterParameterType('list', ListParameter, override=True)\\n\\n\\n\\nclass ActionParameterItem(ParameterItem):\\n def __init__(self, param, depth):\\n ParameterItem.__init__(self, param, depth)\\n self.layoutWidget = QtGui.QWidget()\\n self.layout = QtGui.QHBoxLayout()\\n self.layout.setContentsMargins(0, 0, 0, 0)\\n self.layoutWidget.setLayout(self.layout)\\n title = param.opts.get('title', None)\\n if title is None:\\n title = param.name()\\n self.button = QtGui.QPushButton(title)\\n #self.layout.addSpacing(100)\\n self.layout.addWidget(self.button)\\n self.layout.addStretch()\\n self.button.clicked.connect(self.buttonClicked)\\n param.sigNameChanged.connect(self.paramRenamed)\\n self.setText(0, '')\\n \\n def treeWidgetChanged(self):\\n ParameterItem.treeWidgetChanged(self)\\n tree = self.treeWidget()\\n if tree is None:\\n return\\n \\n tree.setFirstItemColumnSpanned(self, True)\\n tree.setItemWidget(self, 0, self.layoutWidget)\\n \\n def paramRenamed(self, param, name):\\n self.button.setText(name)\\n \\n def buttonClicked(self):\\n self.param.activate()\\n \\nclass ActionParameter(Parameter):\\n \\\"\\\"\\\"Used for displaying a button within the tree.\\\"\\\"\\\"\\n itemClass = ActionParameterItem\\n sigActivated = QtCore.Signal(object)\\n \\n def activate(self):\\n self.sigActivated.emit(self)\\n self.emitStateChanged('activated', None)\\n \\nregisterParameterType('action', ActionParameter, override=True)\\n\\n\\n\\nclass TextParameterItem(WidgetParameterItem):\\n def __init__(self, param, depth):\\n WidgetParameterItem.__init__(self, param, depth)\\n self.hideWidget = False\\n self.subItem = QtGui.QTreeWidgetItem()\\n self.addChild(self.subItem)\\n\\n def treeWidgetChanged(self):\\n ## TODO: fix so that superclass method can be called\\n ## (WidgetParameter should just natively support this style)\\n #WidgetParameterItem.treeWidgetChanged(self)\\n self.treeWidget().setFirstItemColumnSpanned(self.subItem, True)\\n self.treeWidget().setItemWidget(self.subItem, 0, self.textBox)\\n \\n # for now, these are copied from ParameterItem.treeWidgetChanged\\n self.setHidden(not self.param.opts.get('visible', True))\\n self.setExpanded(self.param.opts.get('expanded', True))\\n \\n def makeWidget(self):\\n self.textBox = QtGui.QTextEdit()\\n self.textBox.setMaximumHeight(100)\\n self.textBox.setReadOnly(self.param.opts.get('readonly', False))\\n self.textBox.value = lambda: str(self.textBox.toPlainText())\\n self.textBox.setValue = self.textBox.setPlainText\\n self.textBox.sigChanged = self.textBox.textChanged\\n return self.textBox\\n \\nclass TextParameter(Parameter):\\n \\\"\\\"\\\"Editable string; displayed as large text box in the tree.\\\"\\\"\\\"\\n itemClass = TextParameterItem\\n\\n \\n \\nregisterParameterType('text', TextParameter, override=True)\\n\",\n \"path\": \"pyqtgraph/parametertree/parameterTypes.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/pyqtgraph/parametertree/parameterTypes.py b/pyqtgraph/parametertree/parameterTypes.py\nindex b728fb8edb..a8e3781dc8 100644\n--- a/pyqtgraph/parametertree/parameterTypes.py\n+++ b/pyqtgraph/parametertree/parameterTypes.py\n@@ -437,8 +437,10 @@ def addChild(self, child): ## make sure added childs are actually inserted befo\n else:\n ParameterItem.addChild(self, child)\n \n- def optsChanged(self, param, changed):\n- if 'addList' in changed:\n+ def optsChanged(self, param, opts):\n+ ParameterItem.optsChanged(self, param, opts)\n+ \n+ if 'addList' in opts:\n self.updateAddList()\n \n def updateAddList(self):\n"}}},{"rowIdx":5483,"cells":{"in_source_id":{"kind":"string","value":"ckan__ckan-5937"},"issue":{"kind":"string","value":"sqlalchemy setting \"pool_pre_ping\"\n**CKAN version**\r\n\r\nIntroduced in commit https://github.com/ckan/ckan/commit/ae9eb1360028a77b35506716eed2768349827806 which is related at least to 2.9.0, 2.9.1, 2.9.2. \r\n\r\n**Describe the bug**\r\n\r\nThis is the ckan code:\r\n```python\r\n # Enable pessimistic disconnect handling (added in SQLAlchemy 1.2)\r\n # to eliminate database errors due to stale pooled connections\r\n config.setdefault('pool_pre_ping', True)\r\n\r\n # Initialize SQLAlchemy\r\n engine = sqlalchemy.engine_from_config(config)\r\n```\r\n\r\nThis is the sqlalchemy function:\r\n```python\r\n def engine_from_config(configuration, prefix=\"sqlalchemy.\", **kwargs):\r\n```\r\n\r\nI guess the `pool_pre_ping` config is not taken into account by sqlalchemy since it's missing the prefix.\r\n\n"},"before_files":{"kind":"list like","value":[{"content":"# encoding: utf-8\n\n'''CKAN environment configuration'''\nimport os\nimport logging\nimport warnings\nimport pytz\n\nimport six\nimport sqlalchemy\n\nfrom six.moves.urllib.parse import urlparse\n\nimport ckan.model as model\nimport ckan.plugins as p\nimport ckan.lib.plugins as lib_plugins\nimport ckan.lib.helpers as helpers\nimport ckan.lib.app_globals as app_globals\nfrom ckan.lib.redis import is_redis_available\nimport ckan.lib.render as render\nimport ckan.lib.search as search\nimport ckan.logic as logic\nimport ckan.authz as authz\nimport ckan.lib.jinja_extensions as jinja_extensions\nfrom ckan.lib.webassets_tools import webassets_init\nfrom ckan.lib.i18n import build_js_translations\n\nfrom ckan.common import _, ungettext, config\nfrom ckan.exceptions import CkanConfigurationException\n\nif six.PY2:\n from pylons import config as pylons_config\n\n\nlog = logging.getLogger(__name__)\n\n\n# Suppress benign warning 'Unbuilt egg for setuptools'\nwarnings.simplefilter('ignore', UserWarning)\n\n\ndef load_environment(conf):\n \"\"\"\n Configure the Pylons environment via the ``pylons.config`` object. This\n code should only need to be run once.\n \"\"\"\n if six.PY2:\n # this must be run at a time when the env is semi-setup, thus inlined\n # here. Required by the deliverance plugin and iATI\n from pylons.wsgiapp import PylonsApp\n import pkg_resources\n find_controller_generic = getattr(\n PylonsApp.find_controller,\n '_old_find_controller',\n PylonsApp.find_controller)\n\n # This is from pylons 1.0 source, will monkey-patch into 0.9.7\n def find_controller(self, controller):\n if controller in self.controller_classes:\n return self.controller_classes[controller]\n # Check to see if its a dotted name\n if '.' in controller or ':' in controller:\n ep = pkg_resources.EntryPoint.parse('x={0}'.format(controller))\n\n if hasattr(ep, 'resolve'):\n # setuptools >= 10.2\n mycontroller = ep.resolve()\n else:\n # setuptools >= 11.3\n mycontroller = ep.load(False)\n\n self.controller_classes[controller] = mycontroller\n return mycontroller\n return find_controller_generic(self, controller)\n find_controller._old_find_controller = find_controller_generic\n PylonsApp.find_controller = find_controller\n\n os.environ['CKAN_CONFIG'] = conf['__file__']\n\n # Pylons paths\n root = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))\n\n valid_base_public_folder_names = ['public']\n static_files = conf.get('ckan.base_public_folder', 'public')\n conf['ckan.base_public_folder'] = static_files\n\n if static_files not in valid_base_public_folder_names:\n raise CkanConfigurationException(\n 'You provided an invalid value for ckan.base_public_folder. '\n 'Possible values are: \"public\".'\n )\n\n log.info('Loading static files from %s' % static_files)\n paths = dict(root=root,\n controllers=os.path.join(root, 'controllers'),\n static_files=os.path.join(root, static_files),\n templates=[])\n\n # Initialize main CKAN config object\n config.update(conf)\n\n if six.PY2:\n # Initialize Pylons own config object\n pylons_config.init_app(\n conf['global_conf'], conf, package='ckan', paths=paths)\n\n # Update the main CKAN config object with the Pylons specific stuff,\n # as it is quite hard to keep them separated. This should be removed\n # once Pylons support is dropped\n config.update(pylons_config)\n\n # Setup the SQLAlchemy database engine\n # Suppress a couple of sqlalchemy warnings\n msgs = ['^Unicode type received non-unicode bind param value',\n \"^Did not recognize type 'BIGINT' of column 'size'\",\n \"^Did not recognize type 'tsvector' of column 'search_vector'\"\n ]\n for msg in msgs:\n warnings.filterwarnings('ignore', msg, sqlalchemy.exc.SAWarning)\n\n # load all CKAN plugins\n p.load_all()\n\n # Check Redis availability\n if not is_redis_available():\n log.critical('Could not connect to Redis.')\n\n app_globals.reset()\n\n # issue #3260: remove idle transaction\n # Session that was used for getting all config params nor committed,\n # neither removed and we have idle connection as result\n model.Session.commit()\n\n # Build JavaScript translations. Must be done after plugins have\n # been loaded.\n build_js_translations()\n\n\n# A mapping of config settings that can be overridden by env vars.\n# Note: Do not remove the following lines, they are used in the docs\n# Start CONFIG_FROM_ENV_VARS\nCONFIG_FROM_ENV_VARS = {\n 'sqlalchemy.url': 'CKAN_SQLALCHEMY_URL',\n 'ckan.datastore.write_url': 'CKAN_DATASTORE_WRITE_URL',\n 'ckan.datastore.read_url': 'CKAN_DATASTORE_READ_URL',\n 'ckan.redis.url': 'CKAN_REDIS_URL',\n 'solr_url': 'CKAN_SOLR_URL',\n 'solr_user': 'CKAN_SOLR_USER',\n 'solr_password': 'CKAN_SOLR_PASSWORD',\n 'ckan.site_id': 'CKAN_SITE_ID',\n 'ckan.site_url': 'CKAN_SITE_URL',\n 'ckan.storage_path': 'CKAN_STORAGE_PATH',\n 'ckan.datapusher.url': 'CKAN_DATAPUSHER_URL',\n 'smtp.server': 'CKAN_SMTP_SERVER',\n 'smtp.starttls': 'CKAN_SMTP_STARTTLS',\n 'smtp.user': 'CKAN_SMTP_USER',\n 'smtp.password': 'CKAN_SMTP_PASSWORD',\n 'smtp.mail_from': 'CKAN_SMTP_MAIL_FROM',\n 'ckan.max_resource_size': 'CKAN_MAX_UPLOAD_SIZE_MB'\n}\n# End CONFIG_FROM_ENV_VARS\n\n\ndef update_config():\n ''' This code needs to be run when the config is changed to take those\n changes into account. It is called whenever a plugin is loaded as the\n plugin might have changed the config values (for instance it might\n change ckan.site_url) '''\n\n webassets_init()\n\n for plugin in p.PluginImplementations(p.IConfigurer):\n # must do update in place as this does not work:\n # config = plugin.update_config(config)\n plugin.update_config(config)\n\n # Set whitelisted env vars on config object\n # This is set up before globals are initialized\n\n ckan_db = os.environ.get('CKAN_DB', None)\n if ckan_db:\n msg = 'Setting CKAN_DB as an env var is deprecated and will be' \\\n ' removed in a future release. Use CKAN_SQLALCHEMY_URL instead.'\n log.warn(msg)\n config['sqlalchemy.url'] = ckan_db\n\n for option in CONFIG_FROM_ENV_VARS:\n from_env = os.environ.get(CONFIG_FROM_ENV_VARS[option], None)\n if from_env:\n config[option] = from_env\n\n root = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))\n\n site_url = config.get('ckan.site_url', '')\n if not site_url:\n raise RuntimeError(\n 'ckan.site_url is not configured and it must have a value.'\n ' Please amend your .ini file.')\n if not site_url.lower().startswith('http'):\n raise RuntimeError(\n 'ckan.site_url should be a full URL, including the schema '\n '(http or https)')\n\n display_timezone = config.get('ckan.display_timezone', '')\n if (display_timezone and\n display_timezone != 'server' and\n display_timezone not in pytz.all_timezones):\n raise CkanConfigurationException(\n \"ckan.display_timezone is not 'server' or a valid timezone\"\n )\n\n # Remove backslash from site_url if present\n config['ckan.site_url'] = config['ckan.site_url'].rstrip('/')\n\n ckan_host = config['ckan.host'] = urlparse(site_url).netloc\n if config.get('ckan.site_id') is None:\n if ':' in ckan_host:\n ckan_host, port = ckan_host.split(':')\n assert ckan_host, 'You need to configure ckan.site_url or ' \\\n 'ckan.site_id for SOLR search-index rebuild to work.'\n config['ckan.site_id'] = ckan_host\n\n # ensure that a favicon has been set\n favicon = config.get('ckan.favicon', '/base/images/ckan.ico')\n config['ckan.favicon'] = favicon\n\n # Init SOLR settings and check if the schema is compatible\n # from ckan.lib.search import SolrSettings, check_solr_schema_version\n\n # lib.search is imported here as we need the config enabled and parsed\n search.SolrSettings.init(config.get('solr_url'),\n config.get('solr_user'),\n config.get('solr_password'))\n search.check_solr_schema_version()\n\n lib_plugins.reset_package_plugins()\n lib_plugins.register_package_plugins()\n lib_plugins.reset_group_plugins()\n lib_plugins.register_group_plugins()\n\n # initialise the globals\n app_globals.app_globals._init()\n\n helpers.load_plugin_helpers()\n config['pylons.h'] = helpers.helper_functions\n\n # Templates and CSS loading from configuration\n valid_base_templates_folder_names = ['templates']\n templates = config.get('ckan.base_templates_folder', 'templates')\n config['ckan.base_templates_folder'] = templates\n\n if templates not in valid_base_templates_folder_names:\n raise CkanConfigurationException(\n 'You provided an invalid value for ckan.base_templates_folder. '\n 'Possible values are: \"templates\".'\n )\n\n jinja2_templates_path = os.path.join(root, templates)\n log.info('Loading templates from %s' % jinja2_templates_path)\n template_paths = [jinja2_templates_path]\n\n extra_template_paths = config.get('extra_template_paths', '')\n if extra_template_paths:\n # must be first for them to override defaults\n template_paths = extra_template_paths.split(',') + template_paths\n config['computed_template_paths'] = template_paths\n\n # Markdown ignores the logger config, so to get rid of excessive\n # markdown debug messages in the log, set it to the level of the\n # root logger.\n logging.getLogger(\"MARKDOWN\").setLevel(logging.getLogger().level)\n\n if six.PY2:\n # Create Jinja2 environment\n env = jinja_extensions.Environment(\n **jinja_extensions.get_jinja_env_options())\n env.install_gettext_callables(_, ungettext, newstyle=True)\n # custom filters\n env.policies['ext.i18n.trimmed'] = True\n env.filters['empty_and_escape'] = jinja_extensions.empty_and_escape\n config['pylons.app_globals'].jinja_env = env\n\n # CONFIGURATION OPTIONS HERE (note: all config options will override\n # any Pylons config options)\n\n # Enable pessimistic disconnect handling (added in SQLAlchemy 1.2)\n # to eliminate database errors due to stale pooled connections\n config.setdefault('pool_pre_ping', True)\n\n # Initialize SQLAlchemy\n engine = sqlalchemy.engine_from_config(config)\n model.init_model(engine)\n\n for plugin in p.PluginImplementations(p.IConfigurable):\n plugin.configure(config)\n\n # reset the template cache - we do this here so that when we load the\n # environment it is clean\n render.reset_template_info_cache()\n\n # clear other caches\n logic.clear_actions_cache()\n logic.clear_validators_cache()\n authz.clear_auth_functions_cache()\n\n # Here we create the site user if they are not already in the database\n try:\n logic.get_action('get_site_user')({'ignore_auth': True}, None)\n except (sqlalchemy.exc.ProgrammingError, sqlalchemy.exc.OperationalError):\n # (ProgrammingError for Postgres, OperationalError for SQLite)\n # The database is not initialised. This is a bit dirty. This occurs\n # when running tests.\n pass\n except sqlalchemy.exc.InternalError:\n # The database is not initialised. Travis hits this\n pass\n\n # Close current session and open database connections to ensure a clean\n # clean environment even if an error occurs later on\n model.Session.remove()\n model.Session.bind.dispose()\n","path":"ckan/config/environment.py"}],"string":"[\n {\n \"content\": \"# encoding: utf-8\\n\\n'''CKAN environment configuration'''\\nimport os\\nimport logging\\nimport warnings\\nimport pytz\\n\\nimport six\\nimport sqlalchemy\\n\\nfrom six.moves.urllib.parse import urlparse\\n\\nimport ckan.model as model\\nimport ckan.plugins as p\\nimport ckan.lib.plugins as lib_plugins\\nimport ckan.lib.helpers as helpers\\nimport ckan.lib.app_globals as app_globals\\nfrom ckan.lib.redis import is_redis_available\\nimport ckan.lib.render as render\\nimport ckan.lib.search as search\\nimport ckan.logic as logic\\nimport ckan.authz as authz\\nimport ckan.lib.jinja_extensions as jinja_extensions\\nfrom ckan.lib.webassets_tools import webassets_init\\nfrom ckan.lib.i18n import build_js_translations\\n\\nfrom ckan.common import _, ungettext, config\\nfrom ckan.exceptions import CkanConfigurationException\\n\\nif six.PY2:\\n from pylons import config as pylons_config\\n\\n\\nlog = logging.getLogger(__name__)\\n\\n\\n# Suppress benign warning 'Unbuilt egg for setuptools'\\nwarnings.simplefilter('ignore', UserWarning)\\n\\n\\ndef load_environment(conf):\\n \\\"\\\"\\\"\\n Configure the Pylons environment via the ``pylons.config`` object. This\\n code should only need to be run once.\\n \\\"\\\"\\\"\\n if six.PY2:\\n # this must be run at a time when the env is semi-setup, thus inlined\\n # here. Required by the deliverance plugin and iATI\\n from pylons.wsgiapp import PylonsApp\\n import pkg_resources\\n find_controller_generic = getattr(\\n PylonsApp.find_controller,\\n '_old_find_controller',\\n PylonsApp.find_controller)\\n\\n # This is from pylons 1.0 source, will monkey-patch into 0.9.7\\n def find_controller(self, controller):\\n if controller in self.controller_classes:\\n return self.controller_classes[controller]\\n # Check to see if its a dotted name\\n if '.' in controller or ':' in controller:\\n ep = pkg_resources.EntryPoint.parse('x={0}'.format(controller))\\n\\n if hasattr(ep, 'resolve'):\\n # setuptools >= 10.2\\n mycontroller = ep.resolve()\\n else:\\n # setuptools >= 11.3\\n mycontroller = ep.load(False)\\n\\n self.controller_classes[controller] = mycontroller\\n return mycontroller\\n return find_controller_generic(self, controller)\\n find_controller._old_find_controller = find_controller_generic\\n PylonsApp.find_controller = find_controller\\n\\n os.environ['CKAN_CONFIG'] = conf['__file__']\\n\\n # Pylons paths\\n root = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))\\n\\n valid_base_public_folder_names = ['public']\\n static_files = conf.get('ckan.base_public_folder', 'public')\\n conf['ckan.base_public_folder'] = static_files\\n\\n if static_files not in valid_base_public_folder_names:\\n raise CkanConfigurationException(\\n 'You provided an invalid value for ckan.base_public_folder. '\\n 'Possible values are: \\\"public\\\".'\\n )\\n\\n log.info('Loading static files from %s' % static_files)\\n paths = dict(root=root,\\n controllers=os.path.join(root, 'controllers'),\\n static_files=os.path.join(root, static_files),\\n templates=[])\\n\\n # Initialize main CKAN config object\\n config.update(conf)\\n\\n if six.PY2:\\n # Initialize Pylons own config object\\n pylons_config.init_app(\\n conf['global_conf'], conf, package='ckan', paths=paths)\\n\\n # Update the main CKAN config object with the Pylons specific stuff,\\n # as it is quite hard to keep them separated. This should be removed\\n # once Pylons support is dropped\\n config.update(pylons_config)\\n\\n # Setup the SQLAlchemy database engine\\n # Suppress a couple of sqlalchemy warnings\\n msgs = ['^Unicode type received non-unicode bind param value',\\n \\\"^Did not recognize type 'BIGINT' of column 'size'\\\",\\n \\\"^Did not recognize type 'tsvector' of column 'search_vector'\\\"\\n ]\\n for msg in msgs:\\n warnings.filterwarnings('ignore', msg, sqlalchemy.exc.SAWarning)\\n\\n # load all CKAN plugins\\n p.load_all()\\n\\n # Check Redis availability\\n if not is_redis_available():\\n log.critical('Could not connect to Redis.')\\n\\n app_globals.reset()\\n\\n # issue #3260: remove idle transaction\\n # Session that was used for getting all config params nor committed,\\n # neither removed and we have idle connection as result\\n model.Session.commit()\\n\\n # Build JavaScript translations. Must be done after plugins have\\n # been loaded.\\n build_js_translations()\\n\\n\\n# A mapping of config settings that can be overridden by env vars.\\n# Note: Do not remove the following lines, they are used in the docs\\n# Start CONFIG_FROM_ENV_VARS\\nCONFIG_FROM_ENV_VARS = {\\n 'sqlalchemy.url': 'CKAN_SQLALCHEMY_URL',\\n 'ckan.datastore.write_url': 'CKAN_DATASTORE_WRITE_URL',\\n 'ckan.datastore.read_url': 'CKAN_DATASTORE_READ_URL',\\n 'ckan.redis.url': 'CKAN_REDIS_URL',\\n 'solr_url': 'CKAN_SOLR_URL',\\n 'solr_user': 'CKAN_SOLR_USER',\\n 'solr_password': 'CKAN_SOLR_PASSWORD',\\n 'ckan.site_id': 'CKAN_SITE_ID',\\n 'ckan.site_url': 'CKAN_SITE_URL',\\n 'ckan.storage_path': 'CKAN_STORAGE_PATH',\\n 'ckan.datapusher.url': 'CKAN_DATAPUSHER_URL',\\n 'smtp.server': 'CKAN_SMTP_SERVER',\\n 'smtp.starttls': 'CKAN_SMTP_STARTTLS',\\n 'smtp.user': 'CKAN_SMTP_USER',\\n 'smtp.password': 'CKAN_SMTP_PASSWORD',\\n 'smtp.mail_from': 'CKAN_SMTP_MAIL_FROM',\\n 'ckan.max_resource_size': 'CKAN_MAX_UPLOAD_SIZE_MB'\\n}\\n# End CONFIG_FROM_ENV_VARS\\n\\n\\ndef update_config():\\n ''' This code needs to be run when the config is changed to take those\\n changes into account. It is called whenever a plugin is loaded as the\\n plugin might have changed the config values (for instance it might\\n change ckan.site_url) '''\\n\\n webassets_init()\\n\\n for plugin in p.PluginImplementations(p.IConfigurer):\\n # must do update in place as this does not work:\\n # config = plugin.update_config(config)\\n plugin.update_config(config)\\n\\n # Set whitelisted env vars on config object\\n # This is set up before globals are initialized\\n\\n ckan_db = os.environ.get('CKAN_DB', None)\\n if ckan_db:\\n msg = 'Setting CKAN_DB as an env var is deprecated and will be' \\\\\\n ' removed in a future release. Use CKAN_SQLALCHEMY_URL instead.'\\n log.warn(msg)\\n config['sqlalchemy.url'] = ckan_db\\n\\n for option in CONFIG_FROM_ENV_VARS:\\n from_env = os.environ.get(CONFIG_FROM_ENV_VARS[option], None)\\n if from_env:\\n config[option] = from_env\\n\\n root = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))\\n\\n site_url = config.get('ckan.site_url', '')\\n if not site_url:\\n raise RuntimeError(\\n 'ckan.site_url is not configured and it must have a value.'\\n ' Please amend your .ini file.')\\n if not site_url.lower().startswith('http'):\\n raise RuntimeError(\\n 'ckan.site_url should be a full URL, including the schema '\\n '(http or https)')\\n\\n display_timezone = config.get('ckan.display_timezone', '')\\n if (display_timezone and\\n display_timezone != 'server' and\\n display_timezone not in pytz.all_timezones):\\n raise CkanConfigurationException(\\n \\\"ckan.display_timezone is not 'server' or a valid timezone\\\"\\n )\\n\\n # Remove backslash from site_url if present\\n config['ckan.site_url'] = config['ckan.site_url'].rstrip('/')\\n\\n ckan_host = config['ckan.host'] = urlparse(site_url).netloc\\n if config.get('ckan.site_id') is None:\\n if ':' in ckan_host:\\n ckan_host, port = ckan_host.split(':')\\n assert ckan_host, 'You need to configure ckan.site_url or ' \\\\\\n 'ckan.site_id for SOLR search-index rebuild to work.'\\n config['ckan.site_id'] = ckan_host\\n\\n # ensure that a favicon has been set\\n favicon = config.get('ckan.favicon', '/base/images/ckan.ico')\\n config['ckan.favicon'] = favicon\\n\\n # Init SOLR settings and check if the schema is compatible\\n # from ckan.lib.search import SolrSettings, check_solr_schema_version\\n\\n # lib.search is imported here as we need the config enabled and parsed\\n search.SolrSettings.init(config.get('solr_url'),\\n config.get('solr_user'),\\n config.get('solr_password'))\\n search.check_solr_schema_version()\\n\\n lib_plugins.reset_package_plugins()\\n lib_plugins.register_package_plugins()\\n lib_plugins.reset_group_plugins()\\n lib_plugins.register_group_plugins()\\n\\n # initialise the globals\\n app_globals.app_globals._init()\\n\\n helpers.load_plugin_helpers()\\n config['pylons.h'] = helpers.helper_functions\\n\\n # Templates and CSS loading from configuration\\n valid_base_templates_folder_names = ['templates']\\n templates = config.get('ckan.base_templates_folder', 'templates')\\n config['ckan.base_templates_folder'] = templates\\n\\n if templates not in valid_base_templates_folder_names:\\n raise CkanConfigurationException(\\n 'You provided an invalid value for ckan.base_templates_folder. '\\n 'Possible values are: \\\"templates\\\".'\\n )\\n\\n jinja2_templates_path = os.path.join(root, templates)\\n log.info('Loading templates from %s' % jinja2_templates_path)\\n template_paths = [jinja2_templates_path]\\n\\n extra_template_paths = config.get('extra_template_paths', '')\\n if extra_template_paths:\\n # must be first for them to override defaults\\n template_paths = extra_template_paths.split(',') + template_paths\\n config['computed_template_paths'] = template_paths\\n\\n # Markdown ignores the logger config, so to get rid of excessive\\n # markdown debug messages in the log, set it to the level of the\\n # root logger.\\n logging.getLogger(\\\"MARKDOWN\\\").setLevel(logging.getLogger().level)\\n\\n if six.PY2:\\n # Create Jinja2 environment\\n env = jinja_extensions.Environment(\\n **jinja_extensions.get_jinja_env_options())\\n env.install_gettext_callables(_, ungettext, newstyle=True)\\n # custom filters\\n env.policies['ext.i18n.trimmed'] = True\\n env.filters['empty_and_escape'] = jinja_extensions.empty_and_escape\\n config['pylons.app_globals'].jinja_env = env\\n\\n # CONFIGURATION OPTIONS HERE (note: all config options will override\\n # any Pylons config options)\\n\\n # Enable pessimistic disconnect handling (added in SQLAlchemy 1.2)\\n # to eliminate database errors due to stale pooled connections\\n config.setdefault('pool_pre_ping', True)\\n\\n # Initialize SQLAlchemy\\n engine = sqlalchemy.engine_from_config(config)\\n model.init_model(engine)\\n\\n for plugin in p.PluginImplementations(p.IConfigurable):\\n plugin.configure(config)\\n\\n # reset the template cache - we do this here so that when we load the\\n # environment it is clean\\n render.reset_template_info_cache()\\n\\n # clear other caches\\n logic.clear_actions_cache()\\n logic.clear_validators_cache()\\n authz.clear_auth_functions_cache()\\n\\n # Here we create the site user if they are not already in the database\\n try:\\n logic.get_action('get_site_user')({'ignore_auth': True}, None)\\n except (sqlalchemy.exc.ProgrammingError, sqlalchemy.exc.OperationalError):\\n # (ProgrammingError for Postgres, OperationalError for SQLite)\\n # The database is not initialised. This is a bit dirty. This occurs\\n # when running tests.\\n pass\\n except sqlalchemy.exc.InternalError:\\n # The database is not initialised. Travis hits this\\n pass\\n\\n # Close current session and open database connections to ensure a clean\\n # clean environment even if an error occurs later on\\n model.Session.remove()\\n model.Session.bind.dispose()\\n\",\n \"path\": \"ckan/config/environment.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"# encoding: utf-8\n\n'''CKAN environment configuration'''\nimport os\nimport logging\nimport warnings\nimport pytz\n\nimport six\nimport sqlalchemy\n\nfrom six.moves.urllib.parse import urlparse\n\nimport ckan.model as model\nimport ckan.plugins as p\nimport ckan.lib.plugins as lib_plugins\nimport ckan.lib.helpers as helpers\nimport ckan.lib.app_globals as app_globals\nfrom ckan.lib.redis import is_redis_available\nimport ckan.lib.render as render\nimport ckan.lib.search as search\nimport ckan.logic as logic\nimport ckan.authz as authz\nimport ckan.lib.jinja_extensions as jinja_extensions\nfrom ckan.lib.webassets_tools import webassets_init\nfrom ckan.lib.i18n import build_js_translations\n\nfrom ckan.common import _, ungettext, config\nfrom ckan.exceptions import CkanConfigurationException\n\nif six.PY2:\n from pylons import config as pylons_config\n\n\nlog = logging.getLogger(__name__)\n\n\n# Suppress benign warning 'Unbuilt egg for setuptools'\nwarnings.simplefilter('ignore', UserWarning)\n\n\ndef load_environment(conf):\n \"\"\"\n Configure the Pylons environment via the ``pylons.config`` object. This\n code should only need to be run once.\n \"\"\"\n if six.PY2:\n # this must be run at a time when the env is semi-setup, thus inlined\n # here. Required by the deliverance plugin and iATI\n from pylons.wsgiapp import PylonsApp\n import pkg_resources\n find_controller_generic = getattr(\n PylonsApp.find_controller,\n '_old_find_controller',\n PylonsApp.find_controller)\n\n # This is from pylons 1.0 source, will monkey-patch into 0.9.7\n def find_controller(self, controller):\n if controller in self.controller_classes:\n return self.controller_classes[controller]\n # Check to see if its a dotted name\n if '.' in controller or ':' in controller:\n ep = pkg_resources.EntryPoint.parse('x={0}'.format(controller))\n\n if hasattr(ep, 'resolve'):\n # setuptools >= 10.2\n mycontroller = ep.resolve()\n else:\n # setuptools >= 11.3\n mycontroller = ep.load(False)\n\n self.controller_classes[controller] = mycontroller\n return mycontroller\n return find_controller_generic(self, controller)\n find_controller._old_find_controller = find_controller_generic\n PylonsApp.find_controller = find_controller\n\n os.environ['CKAN_CONFIG'] = conf['__file__']\n\n # Pylons paths\n root = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))\n\n valid_base_public_folder_names = ['public']\n static_files = conf.get('ckan.base_public_folder', 'public')\n conf['ckan.base_public_folder'] = static_files\n\n if static_files not in valid_base_public_folder_names:\n raise CkanConfigurationException(\n 'You provided an invalid value for ckan.base_public_folder. '\n 'Possible values are: \"public\".'\n )\n\n log.info('Loading static files from %s' % static_files)\n paths = dict(root=root,\n controllers=os.path.join(root, 'controllers'),\n static_files=os.path.join(root, static_files),\n templates=[])\n\n # Initialize main CKAN config object\n config.update(conf)\n\n if six.PY2:\n # Initialize Pylons own config object\n pylons_config.init_app(\n conf['global_conf'], conf, package='ckan', paths=paths)\n\n # Update the main CKAN config object with the Pylons specific stuff,\n # as it is quite hard to keep them separated. This should be removed\n # once Pylons support is dropped\n config.update(pylons_config)\n\n # Setup the SQLAlchemy database engine\n # Suppress a couple of sqlalchemy warnings\n msgs = ['^Unicode type received non-unicode bind param value',\n \"^Did not recognize type 'BIGINT' of column 'size'\",\n \"^Did not recognize type 'tsvector' of column 'search_vector'\"\n ]\n for msg in msgs:\n warnings.filterwarnings('ignore', msg, sqlalchemy.exc.SAWarning)\n\n # load all CKAN plugins\n p.load_all()\n\n # Check Redis availability\n if not is_redis_available():\n log.critical('Could not connect to Redis.')\n\n app_globals.reset()\n\n # issue #3260: remove idle transaction\n # Session that was used for getting all config params nor committed,\n # neither removed and we have idle connection as result\n model.Session.commit()\n\n # Build JavaScript translations. Must be done after plugins have\n # been loaded.\n build_js_translations()\n\n\n# A mapping of config settings that can be overridden by env vars.\n# Note: Do not remove the following lines, they are used in the docs\n# Start CONFIG_FROM_ENV_VARS\nCONFIG_FROM_ENV_VARS = {\n 'sqlalchemy.url': 'CKAN_SQLALCHEMY_URL',\n 'ckan.datastore.write_url': 'CKAN_DATASTORE_WRITE_URL',\n 'ckan.datastore.read_url': 'CKAN_DATASTORE_READ_URL',\n 'ckan.redis.url': 'CKAN_REDIS_URL',\n 'solr_url': 'CKAN_SOLR_URL',\n 'solr_user': 'CKAN_SOLR_USER',\n 'solr_password': 'CKAN_SOLR_PASSWORD',\n 'ckan.site_id': 'CKAN_SITE_ID',\n 'ckan.site_url': 'CKAN_SITE_URL',\n 'ckan.storage_path': 'CKAN_STORAGE_PATH',\n 'ckan.datapusher.url': 'CKAN_DATAPUSHER_URL',\n 'smtp.server': 'CKAN_SMTP_SERVER',\n 'smtp.starttls': 'CKAN_SMTP_STARTTLS',\n 'smtp.user': 'CKAN_SMTP_USER',\n 'smtp.password': 'CKAN_SMTP_PASSWORD',\n 'smtp.mail_from': 'CKAN_SMTP_MAIL_FROM',\n 'ckan.max_resource_size': 'CKAN_MAX_UPLOAD_SIZE_MB'\n}\n# End CONFIG_FROM_ENV_VARS\n\n\ndef update_config():\n ''' This code needs to be run when the config is changed to take those\n changes into account. It is called whenever a plugin is loaded as the\n plugin might have changed the config values (for instance it might\n change ckan.site_url) '''\n\n webassets_init()\n\n for plugin in p.PluginImplementations(p.IConfigurer):\n # must do update in place as this does not work:\n # config = plugin.update_config(config)\n plugin.update_config(config)\n\n # Set whitelisted env vars on config object\n # This is set up before globals are initialized\n\n ckan_db = os.environ.get('CKAN_DB', None)\n if ckan_db:\n msg = 'Setting CKAN_DB as an env var is deprecated and will be' \\\n ' removed in a future release. Use CKAN_SQLALCHEMY_URL instead.'\n log.warn(msg)\n config['sqlalchemy.url'] = ckan_db\n\n for option in CONFIG_FROM_ENV_VARS:\n from_env = os.environ.get(CONFIG_FROM_ENV_VARS[option], None)\n if from_env:\n config[option] = from_env\n\n root = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))\n\n site_url = config.get('ckan.site_url', '')\n if not site_url:\n raise RuntimeError(\n 'ckan.site_url is not configured and it must have a value.'\n ' Please amend your .ini file.')\n if not site_url.lower().startswith('http'):\n raise RuntimeError(\n 'ckan.site_url should be a full URL, including the schema '\n '(http or https)')\n\n display_timezone = config.get('ckan.display_timezone', '')\n if (display_timezone and\n display_timezone != 'server' and\n display_timezone not in pytz.all_timezones):\n raise CkanConfigurationException(\n \"ckan.display_timezone is not 'server' or a valid timezone\"\n )\n\n # Remove backslash from site_url if present\n config['ckan.site_url'] = config['ckan.site_url'].rstrip('/')\n\n ckan_host = config['ckan.host'] = urlparse(site_url).netloc\n if config.get('ckan.site_id') is None:\n if ':' in ckan_host:\n ckan_host, port = ckan_host.split(':')\n assert ckan_host, 'You need to configure ckan.site_url or ' \\\n 'ckan.site_id for SOLR search-index rebuild to work.'\n config['ckan.site_id'] = ckan_host\n\n # ensure that a favicon has been set\n favicon = config.get('ckan.favicon', '/base/images/ckan.ico')\n config['ckan.favicon'] = favicon\n\n # Init SOLR settings and check if the schema is compatible\n # from ckan.lib.search import SolrSettings, check_solr_schema_version\n\n # lib.search is imported here as we need the config enabled and parsed\n search.SolrSettings.init(config.get('solr_url'),\n config.get('solr_user'),\n config.get('solr_password'))\n search.check_solr_schema_version()\n\n lib_plugins.reset_package_plugins()\n lib_plugins.register_package_plugins()\n lib_plugins.reset_group_plugins()\n lib_plugins.register_group_plugins()\n\n # initialise the globals\n app_globals.app_globals._init()\n\n helpers.load_plugin_helpers()\n config['pylons.h'] = helpers.helper_functions\n\n # Templates and CSS loading from configuration\n valid_base_templates_folder_names = ['templates']\n templates = config.get('ckan.base_templates_folder', 'templates')\n config['ckan.base_templates_folder'] = templates\n\n if templates not in valid_base_templates_folder_names:\n raise CkanConfigurationException(\n 'You provided an invalid value for ckan.base_templates_folder. '\n 'Possible values are: \"templates\".'\n )\n\n jinja2_templates_path = os.path.join(root, templates)\n log.info('Loading templates from %s' % jinja2_templates_path)\n template_paths = [jinja2_templates_path]\n\n extra_template_paths = config.get('extra_template_paths', '')\n if extra_template_paths:\n # must be first for them to override defaults\n template_paths = extra_template_paths.split(',') + template_paths\n config['computed_template_paths'] = template_paths\n\n # Markdown ignores the logger config, so to get rid of excessive\n # markdown debug messages in the log, set it to the level of the\n # root logger.\n logging.getLogger(\"MARKDOWN\").setLevel(logging.getLogger().level)\n\n if six.PY2:\n # Create Jinja2 environment\n env = jinja_extensions.Environment(\n **jinja_extensions.get_jinja_env_options())\n env.install_gettext_callables(_, ungettext, newstyle=True)\n # custom filters\n env.policies['ext.i18n.trimmed'] = True\n env.filters['empty_and_escape'] = jinja_extensions.empty_and_escape\n config['pylons.app_globals'].jinja_env = env\n\n # CONFIGURATION OPTIONS HERE (note: all config options will override\n # any Pylons config options)\n\n # Enable pessimistic disconnect handling (added in SQLAlchemy 1.2)\n # to eliminate database errors due to stale pooled connections\n config.setdefault('sqlalchemy.pool_pre_ping', True)\n\n # Initialize SQLAlchemy\n engine = sqlalchemy.engine_from_config(config)\n model.init_model(engine)\n\n for plugin in p.PluginImplementations(p.IConfigurable):\n plugin.configure(config)\n\n # reset the template cache - we do this here so that when we load the\n # environment it is clean\n render.reset_template_info_cache()\n\n # clear other caches\n logic.clear_actions_cache()\n logic.clear_validators_cache()\n authz.clear_auth_functions_cache()\n\n # Here we create the site user if they are not already in the database\n try:\n logic.get_action('get_site_user')({'ignore_auth': True}, None)\n except (sqlalchemy.exc.ProgrammingError, sqlalchemy.exc.OperationalError):\n # (ProgrammingError for Postgres, OperationalError for SQLite)\n # The database is not initialised. This is a bit dirty. This occurs\n # when running tests.\n pass\n except sqlalchemy.exc.InternalError:\n # The database is not initialised. Travis hits this\n pass\n\n # Close current session and open database connections to ensure a clean\n # clean environment even if an error occurs later on\n model.Session.remove()\n model.Session.bind.dispose()\n","path":"ckan/config/environment.py"}],"string":"[\n {\n \"content\": \"# encoding: utf-8\\n\\n'''CKAN environment configuration'''\\nimport os\\nimport logging\\nimport warnings\\nimport pytz\\n\\nimport six\\nimport sqlalchemy\\n\\nfrom six.moves.urllib.parse import urlparse\\n\\nimport ckan.model as model\\nimport ckan.plugins as p\\nimport ckan.lib.plugins as lib_plugins\\nimport ckan.lib.helpers as helpers\\nimport ckan.lib.app_globals as app_globals\\nfrom ckan.lib.redis import is_redis_available\\nimport ckan.lib.render as render\\nimport ckan.lib.search as search\\nimport ckan.logic as logic\\nimport ckan.authz as authz\\nimport ckan.lib.jinja_extensions as jinja_extensions\\nfrom ckan.lib.webassets_tools import webassets_init\\nfrom ckan.lib.i18n import build_js_translations\\n\\nfrom ckan.common import _, ungettext, config\\nfrom ckan.exceptions import CkanConfigurationException\\n\\nif six.PY2:\\n from pylons import config as pylons_config\\n\\n\\nlog = logging.getLogger(__name__)\\n\\n\\n# Suppress benign warning 'Unbuilt egg for setuptools'\\nwarnings.simplefilter('ignore', UserWarning)\\n\\n\\ndef load_environment(conf):\\n \\\"\\\"\\\"\\n Configure the Pylons environment via the ``pylons.config`` object. This\\n code should only need to be run once.\\n \\\"\\\"\\\"\\n if six.PY2:\\n # this must be run at a time when the env is semi-setup, thus inlined\\n # here. Required by the deliverance plugin and iATI\\n from pylons.wsgiapp import PylonsApp\\n import pkg_resources\\n find_controller_generic = getattr(\\n PylonsApp.find_controller,\\n '_old_find_controller',\\n PylonsApp.find_controller)\\n\\n # This is from pylons 1.0 source, will monkey-patch into 0.9.7\\n def find_controller(self, controller):\\n if controller in self.controller_classes:\\n return self.controller_classes[controller]\\n # Check to see if its a dotted name\\n if '.' in controller or ':' in controller:\\n ep = pkg_resources.EntryPoint.parse('x={0}'.format(controller))\\n\\n if hasattr(ep, 'resolve'):\\n # setuptools >= 10.2\\n mycontroller = ep.resolve()\\n else:\\n # setuptools >= 11.3\\n mycontroller = ep.load(False)\\n\\n self.controller_classes[controller] = mycontroller\\n return mycontroller\\n return find_controller_generic(self, controller)\\n find_controller._old_find_controller = find_controller_generic\\n PylonsApp.find_controller = find_controller\\n\\n os.environ['CKAN_CONFIG'] = conf['__file__']\\n\\n # Pylons paths\\n root = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))\\n\\n valid_base_public_folder_names = ['public']\\n static_files = conf.get('ckan.base_public_folder', 'public')\\n conf['ckan.base_public_folder'] = static_files\\n\\n if static_files not in valid_base_public_folder_names:\\n raise CkanConfigurationException(\\n 'You provided an invalid value for ckan.base_public_folder. '\\n 'Possible values are: \\\"public\\\".'\\n )\\n\\n log.info('Loading static files from %s' % static_files)\\n paths = dict(root=root,\\n controllers=os.path.join(root, 'controllers'),\\n static_files=os.path.join(root, static_files),\\n templates=[])\\n\\n # Initialize main CKAN config object\\n config.update(conf)\\n\\n if six.PY2:\\n # Initialize Pylons own config object\\n pylons_config.init_app(\\n conf['global_conf'], conf, package='ckan', paths=paths)\\n\\n # Update the main CKAN config object with the Pylons specific stuff,\\n # as it is quite hard to keep them separated. This should be removed\\n # once Pylons support is dropped\\n config.update(pylons_config)\\n\\n # Setup the SQLAlchemy database engine\\n # Suppress a couple of sqlalchemy warnings\\n msgs = ['^Unicode type received non-unicode bind param value',\\n \\\"^Did not recognize type 'BIGINT' of column 'size'\\\",\\n \\\"^Did not recognize type 'tsvector' of column 'search_vector'\\\"\\n ]\\n for msg in msgs:\\n warnings.filterwarnings('ignore', msg, sqlalchemy.exc.SAWarning)\\n\\n # load all CKAN plugins\\n p.load_all()\\n\\n # Check Redis availability\\n if not is_redis_available():\\n log.critical('Could not connect to Redis.')\\n\\n app_globals.reset()\\n\\n # issue #3260: remove idle transaction\\n # Session that was used for getting all config params nor committed,\\n # neither removed and we have idle connection as result\\n model.Session.commit()\\n\\n # Build JavaScript translations. Must be done after plugins have\\n # been loaded.\\n build_js_translations()\\n\\n\\n# A mapping of config settings that can be overridden by env vars.\\n# Note: Do not remove the following lines, they are used in the docs\\n# Start CONFIG_FROM_ENV_VARS\\nCONFIG_FROM_ENV_VARS = {\\n 'sqlalchemy.url': 'CKAN_SQLALCHEMY_URL',\\n 'ckan.datastore.write_url': 'CKAN_DATASTORE_WRITE_URL',\\n 'ckan.datastore.read_url': 'CKAN_DATASTORE_READ_URL',\\n 'ckan.redis.url': 'CKAN_REDIS_URL',\\n 'solr_url': 'CKAN_SOLR_URL',\\n 'solr_user': 'CKAN_SOLR_USER',\\n 'solr_password': 'CKAN_SOLR_PASSWORD',\\n 'ckan.site_id': 'CKAN_SITE_ID',\\n 'ckan.site_url': 'CKAN_SITE_URL',\\n 'ckan.storage_path': 'CKAN_STORAGE_PATH',\\n 'ckan.datapusher.url': 'CKAN_DATAPUSHER_URL',\\n 'smtp.server': 'CKAN_SMTP_SERVER',\\n 'smtp.starttls': 'CKAN_SMTP_STARTTLS',\\n 'smtp.user': 'CKAN_SMTP_USER',\\n 'smtp.password': 'CKAN_SMTP_PASSWORD',\\n 'smtp.mail_from': 'CKAN_SMTP_MAIL_FROM',\\n 'ckan.max_resource_size': 'CKAN_MAX_UPLOAD_SIZE_MB'\\n}\\n# End CONFIG_FROM_ENV_VARS\\n\\n\\ndef update_config():\\n ''' This code needs to be run when the config is changed to take those\\n changes into account. It is called whenever a plugin is loaded as the\\n plugin might have changed the config values (for instance it might\\n change ckan.site_url) '''\\n\\n webassets_init()\\n\\n for plugin in p.PluginImplementations(p.IConfigurer):\\n # must do update in place as this does not work:\\n # config = plugin.update_config(config)\\n plugin.update_config(config)\\n\\n # Set whitelisted env vars on config object\\n # This is set up before globals are initialized\\n\\n ckan_db = os.environ.get('CKAN_DB', None)\\n if ckan_db:\\n msg = 'Setting CKAN_DB as an env var is deprecated and will be' \\\\\\n ' removed in a future release. Use CKAN_SQLALCHEMY_URL instead.'\\n log.warn(msg)\\n config['sqlalchemy.url'] = ckan_db\\n\\n for option in CONFIG_FROM_ENV_VARS:\\n from_env = os.environ.get(CONFIG_FROM_ENV_VARS[option], None)\\n if from_env:\\n config[option] = from_env\\n\\n root = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))\\n\\n site_url = config.get('ckan.site_url', '')\\n if not site_url:\\n raise RuntimeError(\\n 'ckan.site_url is not configured and it must have a value.'\\n ' Please amend your .ini file.')\\n if not site_url.lower().startswith('http'):\\n raise RuntimeError(\\n 'ckan.site_url should be a full URL, including the schema '\\n '(http or https)')\\n\\n display_timezone = config.get('ckan.display_timezone', '')\\n if (display_timezone and\\n display_timezone != 'server' and\\n display_timezone not in pytz.all_timezones):\\n raise CkanConfigurationException(\\n \\\"ckan.display_timezone is not 'server' or a valid timezone\\\"\\n )\\n\\n # Remove backslash from site_url if present\\n config['ckan.site_url'] = config['ckan.site_url'].rstrip('/')\\n\\n ckan_host = config['ckan.host'] = urlparse(site_url).netloc\\n if config.get('ckan.site_id') is None:\\n if ':' in ckan_host:\\n ckan_host, port = ckan_host.split(':')\\n assert ckan_host, 'You need to configure ckan.site_url or ' \\\\\\n 'ckan.site_id for SOLR search-index rebuild to work.'\\n config['ckan.site_id'] = ckan_host\\n\\n # ensure that a favicon has been set\\n favicon = config.get('ckan.favicon', '/base/images/ckan.ico')\\n config['ckan.favicon'] = favicon\\n\\n # Init SOLR settings and check if the schema is compatible\\n # from ckan.lib.search import SolrSettings, check_solr_schema_version\\n\\n # lib.search is imported here as we need the config enabled and parsed\\n search.SolrSettings.init(config.get('solr_url'),\\n config.get('solr_user'),\\n config.get('solr_password'))\\n search.check_solr_schema_version()\\n\\n lib_plugins.reset_package_plugins()\\n lib_plugins.register_package_plugins()\\n lib_plugins.reset_group_plugins()\\n lib_plugins.register_group_plugins()\\n\\n # initialise the globals\\n app_globals.app_globals._init()\\n\\n helpers.load_plugin_helpers()\\n config['pylons.h'] = helpers.helper_functions\\n\\n # Templates and CSS loading from configuration\\n valid_base_templates_folder_names = ['templates']\\n templates = config.get('ckan.base_templates_folder', 'templates')\\n config['ckan.base_templates_folder'] = templates\\n\\n if templates not in valid_base_templates_folder_names:\\n raise CkanConfigurationException(\\n 'You provided an invalid value for ckan.base_templates_folder. '\\n 'Possible values are: \\\"templates\\\".'\\n )\\n\\n jinja2_templates_path = os.path.join(root, templates)\\n log.info('Loading templates from %s' % jinja2_templates_path)\\n template_paths = [jinja2_templates_path]\\n\\n extra_template_paths = config.get('extra_template_paths', '')\\n if extra_template_paths:\\n # must be first for them to override defaults\\n template_paths = extra_template_paths.split(',') + template_paths\\n config['computed_template_paths'] = template_paths\\n\\n # Markdown ignores the logger config, so to get rid of excessive\\n # markdown debug messages in the log, set it to the level of the\\n # root logger.\\n logging.getLogger(\\\"MARKDOWN\\\").setLevel(logging.getLogger().level)\\n\\n if six.PY2:\\n # Create Jinja2 environment\\n env = jinja_extensions.Environment(\\n **jinja_extensions.get_jinja_env_options())\\n env.install_gettext_callables(_, ungettext, newstyle=True)\\n # custom filters\\n env.policies['ext.i18n.trimmed'] = True\\n env.filters['empty_and_escape'] = jinja_extensions.empty_and_escape\\n config['pylons.app_globals'].jinja_env = env\\n\\n # CONFIGURATION OPTIONS HERE (note: all config options will override\\n # any Pylons config options)\\n\\n # Enable pessimistic disconnect handling (added in SQLAlchemy 1.2)\\n # to eliminate database errors due to stale pooled connections\\n config.setdefault('sqlalchemy.pool_pre_ping', True)\\n\\n # Initialize SQLAlchemy\\n engine = sqlalchemy.engine_from_config(config)\\n model.init_model(engine)\\n\\n for plugin in p.PluginImplementations(p.IConfigurable):\\n plugin.configure(config)\\n\\n # reset the template cache - we do this here so that when we load the\\n # environment it is clean\\n render.reset_template_info_cache()\\n\\n # clear other caches\\n logic.clear_actions_cache()\\n logic.clear_validators_cache()\\n authz.clear_auth_functions_cache()\\n\\n # Here we create the site user if they are not already in the database\\n try:\\n logic.get_action('get_site_user')({'ignore_auth': True}, None)\\n except (sqlalchemy.exc.ProgrammingError, sqlalchemy.exc.OperationalError):\\n # (ProgrammingError for Postgres, OperationalError for SQLite)\\n # The database is not initialised. This is a bit dirty. This occurs\\n # when running tests.\\n pass\\n except sqlalchemy.exc.InternalError:\\n # The database is not initialised. Travis hits this\\n pass\\n\\n # Close current session and open database connections to ensure a clean\\n # clean environment even if an error occurs later on\\n model.Session.remove()\\n model.Session.bind.dispose()\\n\",\n \"path\": \"ckan/config/environment.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/ckan/config/environment.py b/ckan/config/environment.py\nindex a6be2cc0f91..6af279e5ffe 100644\n--- a/ckan/config/environment.py\n+++ b/ckan/config/environment.py\n@@ -286,7 +286,7 @@ def update_config():\n \n # Enable pessimistic disconnect handling (added in SQLAlchemy 1.2)\n # to eliminate database errors due to stale pooled connections\n- config.setdefault('pool_pre_ping', True)\n+ config.setdefault('sqlalchemy.pool_pre_ping', True)\n \n # Initialize SQLAlchemy\n engine = sqlalchemy.engine_from_config(config)\ndiff --git a/doc/maintaining/configuration.rst b/doc/maintaining/configuration.rst\nindex 9a03d6d794a..0d5db36f051 100644\n--- a/doc/maintaining/configuration.rst\n+++ b/doc/maintaining/configuration.rst\n@@ -310,6 +310,25 @@ This defines the database that CKAN is to use. The format is::\n \n sqlalchemy.url = postgres://USERNAME:PASSWORD@HOST/DBNAME\n \n+.. _sqlalchemy.any:\n+\n+sqlalchemy.*\n+^^^^^^^^^^^^\n+\n+Example::\n+\n+ sqlalchemy.pool_pre_ping=True\n+ sqlalchemy.pool_size=10\n+ sqlalchemy.max_overflow=20\n+\n+Custom sqlalchemy config parameters used to establish the main\n+database connection.\n+\n+To get the list of all the available properties check the `SQLAlchemy documentation`_\n+\n+.. _SQLAlchemy documentation: http://docs.sqlalchemy.org/en/rel_0_9/core/engines.html#engine-creation-api\n+\n+\n .. start_config-datastore-urls\n \n .. _ckan.datastore.write_url:\n"}}},{"rowIdx":5484,"cells":{"in_source_id":{"kind":"string","value":"pallets__werkzeug-2103"},"issue":{"kind":"string","value":"LocalStack class has strange behavior under asyncio\nThe new `LocalStack` implementation based on the contextvars module has a strange behavior when used under asyncio. The problem appears to be related to the inheritance of contexts that occur between a parent and children async tasks, combined with the fact that the stack is implemented with a mutable list.\r\n\r\nConsider the following example:\r\n\r\n```python\r\nimport asyncio\r\nfrom werkzeug.local import LocalStack\r\n\r\nls = LocalStack()\r\n\r\nasync def task(n):\r\n ls.push(n)\r\n for i in range(3):\r\n await asyncio.sleep(1)\r\n print(f'task {n}: {ls.top}')\r\n\r\nasync def main():\r\n tasks = [asyncio.create_task(task(i)) for i in range(3)]\r\n await asyncio.wait(tasks)\r\n\r\nasyncio.run(main())\r\n```\r\n\r\nThis works perfectly fine, with each task having its own private stack. The output is:\r\n\r\n```\r\n(venv) $ python local.py\r\ntask 0: 0\r\ntask 1: 1\r\ntask 2: 2\r\ntask 0: 0\r\ntask 1: 1\r\ntask 2: 2\r\ntask 0: 0\r\ntask 1: 1\r\ntask 2: 2\r\n```\r\n\r\nNow I change the `main()` function to also push something to the stack:\r\n\r\n```python\r\nasync def main():\r\n ls.push(42)\r\n tasks = [asyncio.create_task(task(i)) for i in range(3)]\r\n await asyncio.wait(tasks)\r\n```\r\n\r\nNow all the tasks have a single shared stack and a push from one task directly affect the others:\r\n\r\n```\r\ntask 0: 2\r\ntask 1: 2\r\ntask 2: 2\r\ntask 0: 2\r\ntask 1: 2\r\ntask 2: 2\r\ntask 0: 2\r\ntask 1: 2\r\ntask 2: 2\r\n```\r\n\r\nThe problem is that `LocalStack` uses a list to keep the stack. If this list is initialized before the child tasks are started, then these tasks will inherit the list from the parent task, and assume it is theirs to push/pop. Since the list is mutable, changes to the list affect all tasks.\r\n\r\nIf, on the other side, the child tasks are started with the local stack uninitialized, then the tasks will inherit an empty context, so then each will create their own mutable list and everything works as expected.\r\n\r\nEnvironment:\r\n\r\n- Python version: 3.7 and up\r\n- Werkzeug version: 2.x release candidates\r\n\n"},"before_files":{"kind":"list like","value":[{"content":"import copy\nimport math\nimport operator\nimport sys\nimport typing as t\nimport warnings\nfrom functools import partial\nfrom functools import update_wrapper\n\nfrom .wsgi import ClosingIterator\n\nif t.TYPE_CHECKING:\n from wsgiref.types import WSGIApplication\n\ntry:\n from greenlet import getcurrent as _get_ident\nexcept ImportError:\n from threading import get_ident as _get_ident\n\n\ndef get_ident():\n warnings.warn(\n \"'get_ident' is deprecated and will be removed in Werkzeug\"\n \" 2.1. Use 'greenlet.getcurrent' or 'threading.get_ident' for\"\n \" previous behavior.\",\n DeprecationWarning,\n stacklevel=2,\n )\n return _get_ident()\n\n\nclass _CannotUseContextVar(Exception):\n pass\n\n\ntry:\n from contextvars import ContextVar\n\n if \"gevent\" in sys.modules or \"eventlet\" in sys.modules:\n # Both use greenlet, so first check it has patched\n # ContextVars, Greenlet <0.4.17 does not.\n import greenlet\n\n greenlet_patched = getattr(greenlet, \"GREENLET_USE_CONTEXT_VARS\", False)\n\n if not greenlet_patched:\n # If Gevent is used, check it has patched ContextVars,\n # <20.5 does not.\n try:\n from gevent.monkey import is_object_patched\n except ImportError:\n # Gevent isn't used, but Greenlet is and hasn't patched\n raise _CannotUseContextVar()\n else:\n if is_object_patched(\"threading\", \"local\") and not is_object_patched(\n \"contextvars\", \"ContextVar\"\n ):\n raise _CannotUseContextVar()\n\n\nexcept (ImportError, _CannotUseContextVar):\n\n class ContextVar: # type: ignore\n \"\"\"A fake ContextVar based on the previous greenlet/threading\n ident function. Used on Python 3.6, eventlet, and old versions\n of gevent.\n \"\"\"\n\n def __init__(self, _name):\n self.storage = {}\n\n def get(self, default):\n return self.storage.get(_get_ident(), default)\n\n def set(self, value):\n self.storage[_get_ident()] = value\n\n\ndef release_local(local: t.Union[\"Local\", \"LocalStack\"]) -> None:\n \"\"\"Releases the contents of the local for the current context.\n This makes it possible to use locals without a manager.\n\n Example::\n\n >>> loc = Local()\n >>> loc.foo = 42\n >>> release_local(loc)\n >>> hasattr(loc, 'foo')\n False\n\n With this function one can release :class:`Local` objects as well\n as :class:`LocalStack` objects. However it is not possible to\n release data held by proxies that way, one always has to retain\n a reference to the underlying local object in order to be able\n to release it.\n\n .. versionadded:: 0.6.1\n \"\"\"\n local.__release_local__()\n\n\nclass Local:\n __slots__ = (\"_storage\",)\n\n def __init__(self) -> None:\n object.__setattr__(self, \"_storage\", ContextVar(\"local_storage\"))\n\n @property\n def __storage__(self):\n warnings.warn(\n \"'__storage__' is deprecated and will be removed in Werkzeug 2.1.\",\n DeprecationWarning,\n stacklevel=2,\n )\n return self._storage.get({})\n\n @property\n def __ident_func__(self):\n warnings.warn(\n \"'__ident_func__' is deprecated and will be removed in\"\n \" Werkzeug 2.1. It should not be used in Python 3.7+.\",\n DeprecationWarning,\n stacklevel=2,\n )\n return _get_ident\n\n @__ident_func__.setter\n def __ident_func__(self, func):\n warnings.warn(\n \"'__ident_func__' is deprecated and will be removed in\"\n \" Werkzeug 2.1. Setting it no longer has any effect.\",\n DeprecationWarning,\n stacklevel=2,\n )\n\n def __iter__(self) -> t.Iterator[t.Tuple[int, t.Any]]:\n return iter(self._storage.get({}).items())\n\n def __call__(self, proxy: str) -> \"LocalProxy\":\n \"\"\"Create a proxy for a name.\"\"\"\n return LocalProxy(self, proxy)\n\n def __release_local__(self) -> None:\n self._storage.set({})\n\n def __getattr__(self, name: str) -> t.Any:\n values = self._storage.get({})\n try:\n return values[name]\n except KeyError:\n raise AttributeError(name)\n\n def __setattr__(self, name: str, value: t.Any) -> None:\n values = self._storage.get({}).copy()\n values[name] = value\n self._storage.set(values)\n\n def __delattr__(self, name: str) -> None:\n values = self._storage.get({}).copy()\n try:\n del values[name]\n self._storage.set(values)\n except KeyError:\n raise AttributeError(name)\n\n\nclass LocalStack:\n \"\"\"This class works similar to a :class:`Local` but keeps a stack\n of objects instead. This is best explained with an example::\n\n >>> ls = LocalStack()\n >>> ls.push(42)\n >>> ls.top\n 42\n >>> ls.push(23)\n >>> ls.top\n 23\n >>> ls.pop()\n 23\n >>> ls.top\n 42\n\n They can be force released by using a :class:`LocalManager` or with\n the :func:`release_local` function but the correct way is to pop the\n item from the stack after using. When the stack is empty it will\n no longer be bound to the current context (and as such released).\n\n By calling the stack without arguments it returns a proxy that resolves to\n the topmost item on the stack.\n\n .. versionadded:: 0.6.1\n \"\"\"\n\n def __init__(self) -> None:\n self._local = Local()\n\n def __release_local__(self) -> None:\n self._local.__release_local__()\n\n @property\n def __ident_func__(self) -> t.Callable[[], int]:\n return self._local.__ident_func__\n\n @__ident_func__.setter\n def __ident_func__(self, value: t.Callable[[], int]) -> None:\n object.__setattr__(self._local, \"__ident_func__\", value)\n\n def __call__(self) -> \"LocalProxy\":\n def _lookup():\n rv = self.top\n if rv is None:\n raise RuntimeError(\"object unbound\")\n return rv\n\n return LocalProxy(_lookup)\n\n def push(self, obj: t.Any) -> t.List[t.Any]:\n \"\"\"Pushes a new item to the stack\"\"\"\n rv = getattr(self._local, \"stack\", None)\n if rv is None:\n self._local.stack = rv = []\n rv.append(obj)\n return rv\n\n def pop(self) -> t.Any:\n \"\"\"Removes the topmost item from the stack, will return the\n old value or `None` if the stack was already empty.\n \"\"\"\n stack = getattr(self._local, \"stack\", None)\n if stack is None:\n return None\n elif len(stack) == 1:\n release_local(self._local)\n return stack[-1]\n else:\n return stack.pop()\n\n @property\n def top(self) -> t.Any:\n \"\"\"The topmost item on the stack. If the stack is empty,\n `None` is returned.\n \"\"\"\n try:\n return self._local.stack[-1]\n except (AttributeError, IndexError):\n return None\n\n\nclass LocalManager:\n \"\"\"Local objects cannot manage themselves. For that you need a local\n manager. You can pass a local manager multiple locals or add them\n later y appending them to `manager.locals`. Every time the manager\n cleans up, it will clean up all the data left in the locals for this\n context.\n\n .. versionchanged:: 2.0\n ``ident_func`` is deprecated and will be removed in Werkzeug\n 2.1.\n\n .. versionchanged:: 0.6.1\n The :func:`release_local` function can be used instead of a\n manager.\n\n .. versionchanged:: 0.7\n The ``ident_func`` parameter was added.\n \"\"\"\n\n def __init__(\n self,\n locals: t.Optional[t.Iterable[t.Union[Local, LocalStack]]] = None,\n ident_func: None = None,\n ) -> None:\n if locals is None:\n self.locals = []\n elif isinstance(locals, Local):\n self.locals = [locals]\n else:\n self.locals = list(locals)\n\n if ident_func is not None:\n warnings.warn(\n \"'ident_func' is deprecated and will be removed in\"\n \" Werkzeug 2.1. Setting it no longer has any effect.\",\n DeprecationWarning,\n stacklevel=2,\n )\n\n @property\n def ident_func(self):\n warnings.warn(\n \"'ident_func' is deprecated and will be removed in Werkzeug 2.1.\",\n DeprecationWarning,\n stacklevel=2,\n )\n return _get_ident\n\n @ident_func.setter\n def ident_func(self, func):\n warnings.warn(\n \"'ident_func' is deprecated and will be removedin Werkzeug\"\n \" 2.1. Setting it no longer has any effect.\",\n DeprecationWarning,\n stacklevel=2,\n )\n\n def get_ident(self) -> int:\n \"\"\"Return the context identifier the local objects use internally for\n this context. You cannot override this method to change the behavior\n but use it to link other context local objects (such as SQLAlchemy's\n scoped sessions) to the Werkzeug locals.\n\n .. deprecated:: 2.0\n Will be removed in Werkzeug 2.1.\n\n .. versionchanged:: 0.7\n You can pass a different ident function to the local manager that\n will then be propagated to all the locals passed to the\n constructor.\n \"\"\"\n warnings.warn(\n \"'get_ident' is deprecated and will be removed in Werkzeug 2.1.\",\n DeprecationWarning,\n stacklevel=2,\n )\n return self.ident_func()\n\n def cleanup(self):\n \"\"\"Manually clean up the data in the locals for this context. Call\n this at the end of the request or use `make_middleware()`.\n \"\"\"\n for local in self.locals:\n release_local(local)\n\n def make_middleware(self, app: \"WSGIApplication\") -> \"WSGIApplication\":\n \"\"\"Wrap a WSGI application so that cleaning up happens after\n request end.\n \"\"\"\n\n def application(environ, start_response):\n return ClosingIterator(app(environ, start_response), self.cleanup)\n\n return application\n\n def middleware(self, func: \"WSGIApplication\") -> \"WSGIApplication\":\n \"\"\"Like `make_middleware` but for decorating functions.\n\n Example usage::\n\n @manager.middleware\n def application(environ, start_response):\n ...\n\n The difference to `make_middleware` is that the function passed\n will have all the arguments copied from the inner application\n (name, docstring, module).\n \"\"\"\n return update_wrapper(self.make_middleware(func), func)\n\n def __repr__(self) -> str:\n return f\"<{type(self).__name__} storages: {len(self.locals)}>\"\n\n\nclass _ProxyLookup:\n \"\"\"Descriptor that handles proxied attribute lookup for\n :class:`LocalProxy`.\n\n :param f: The built-in function this attribute is accessed through.\n Instead of looking up the special method, the function call\n is redone on the object.\n :param fallback: Call this method if the proxy is unbound instead of\n raising a :exc:`RuntimeError`.\n :param class_value: Value to return when accessed from the class.\n Used for ``__doc__`` so building docs still works.\n \"\"\"\n\n __slots__ = (\"bind_f\", \"fallback\", \"class_value\", \"name\")\n\n def __init__(self, f=None, fallback=None, class_value=None):\n if hasattr(f, \"__get__\"):\n # A Python function, can be turned into a bound method.\n\n def bind_f(instance, obj):\n return f.__get__(obj, type(obj))\n\n elif f is not None:\n # A C function, use partial to bind the first argument.\n\n def bind_f(instance, obj):\n return partial(f, obj)\n\n else:\n # Use getattr, which will produce a bound method.\n bind_f = None\n\n self.bind_f = bind_f\n self.fallback = fallback\n self.class_value = class_value\n\n def __set_name__(self, owner, name):\n self.name = name\n\n def __get__(self, instance, owner=None):\n if instance is None:\n if self.class_value is not None:\n return self.class_value\n\n return self\n\n try:\n obj = instance._get_current_object()\n except RuntimeError:\n if self.fallback is None:\n raise\n\n return self.fallback.__get__(instance, owner)\n\n if self.bind_f is not None:\n return self.bind_f(instance, obj)\n\n return getattr(obj, self.name)\n\n def __repr__(self):\n return f\"proxy {self.name}\"\n\n def __call__(self, instance, *args, **kwargs):\n \"\"\"Support calling unbound methods from the class. For example,\n this happens with ``copy.copy``, which does\n ``type(x).__copy__(x)``. ``type(x)`` can't be proxied, so it\n returns the proxy type and descriptor.\n \"\"\"\n return self.__get__(instance, type(instance))(*args, **kwargs)\n\n\nclass _ProxyIOp(_ProxyLookup):\n \"\"\"Look up an augmented assignment method on a proxied object. The\n method is wrapped to return the proxy instead of the object.\n \"\"\"\n\n __slots__ = ()\n\n def __init__(self, f=None, fallback=None):\n super().__init__(f, fallback)\n\n def bind_f(instance, obj):\n def i_op(self, other):\n f(self, other)\n return instance\n\n return i_op.__get__(obj, type(obj))\n\n self.bind_f = bind_f\n\n\ndef _l_to_r_op(op):\n \"\"\"Swap the argument order to turn an l-op into an r-op.\"\"\"\n\n def r_op(obj, other):\n return op(other, obj)\n\n return r_op\n\n\nclass LocalProxy:\n \"\"\"A proxy to the object bound to a :class:`Local`. All operations\n on the proxy are forwarded to the bound object. If no object is\n bound, a :exc:`RuntimeError` is raised.\n\n .. code-block:: python\n\n from werkzeug.local import Local\n l = Local()\n\n # a proxy to whatever l.user is set to\n user = l(\"user\")\n\n from werkzeug.local import LocalStack\n _request_stack = LocalStack()\n\n # a proxy to _request_stack.top\n request = _request_stack()\n\n # a proxy to the session attribute of the request proxy\n session = LocalProxy(lambda: request.session)\n\n ``__repr__`` and ``__class__`` are forwarded, so ``repr(x)`` and\n ``isinstance(x, cls)`` will look like the proxied object. Use\n ``issubclass(type(x), LocalProxy)`` to check if an object is a\n proxy.\n\n .. code-block:: python\n\n repr(user) # <User admin>\n isinstance(user, User) # True\n issubclass(type(user), LocalProxy) # True\n\n :param local: The :class:`Local` or callable that provides the\n proxied object.\n :param name: The attribute name to look up on a :class:`Local`. Not\n used if a callable is given.\n\n .. versionchanged:: 2.0\n Updated proxied attributes and methods to reflect the current\n data model.\n\n .. versionchanged:: 0.6.1\n The class can be instantiated with a callable.\n \"\"\"\n\n __slots__ = (\"__local\", \"__name\", \"__wrapped__\")\n\n def __init__(\n self,\n local: t.Union[\"Local\", t.Callable[[], t.Any]],\n name: t.Optional[str] = None,\n ) -> None:\n object.__setattr__(self, \"_LocalProxy__local\", local)\n object.__setattr__(self, \"_LocalProxy__name\", name)\n\n if callable(local) and not hasattr(local, \"__release_local__\"):\n # \"local\" is a callable that is not an instance of Local or\n # LocalManager: mark it as a wrapped function.\n object.__setattr__(self, \"__wrapped__\", local)\n\n def _get_current_object(self) -> t.Any:\n \"\"\"Return the current object. This is useful if you want the real\n object behind the proxy at a time for performance reasons or because\n you want to pass the object into a different context.\n \"\"\"\n if not hasattr(self.__local, \"__release_local__\"): # type: ignore\n return self.__local() # type: ignore\n\n try:\n return getattr(self.__local, self.__name) # type: ignore\n except AttributeError:\n raise RuntimeError(f\"no object bound to {self.__name}\") # type: ignore\n\n __doc__ = _ProxyLookup( # type: ignore\n class_value=__doc__, fallback=lambda self: type(self).__doc__\n )\n # __del__ should only delete the proxy\n __repr__ = _ProxyLookup(\n repr, fallback=lambda self: f\"<{type(self).__name__} unbound>\"\n )\n __str__ = _ProxyLookup(str)\n __bytes__ = _ProxyLookup(bytes)\n __format__ = _ProxyLookup() # type: ignore\n __lt__ = _ProxyLookup(operator.lt)\n __le__ = _ProxyLookup(operator.le)\n __eq__ = _ProxyLookup(operator.eq)\n __ne__ = _ProxyLookup(operator.ne)\n __gt__ = _ProxyLookup(operator.gt)\n __ge__ = _ProxyLookup(operator.ge)\n __hash__ = _ProxyLookup(hash) # type: ignore\n __bool__ = _ProxyLookup(bool, fallback=lambda self: False)\n __getattr__ = _ProxyLookup(getattr)\n # __getattribute__ triggered through __getattr__\n __setattr__ = _ProxyLookup(setattr)\n __delattr__ = _ProxyLookup(delattr)\n __dir__ = _ProxyLookup(dir, fallback=lambda self: []) # type: ignore\n # __get__ (proxying descriptor not supported)\n # __set__ (descriptor)\n # __delete__ (descriptor)\n # __set_name__ (descriptor)\n # __objclass__ (descriptor)\n # __slots__ used by proxy itself\n # __dict__ (__getattr__)\n # __weakref__ (__getattr__)\n # __init_subclass__ (proxying metaclass not supported)\n # __prepare__ (metaclass)\n __class__ = _ProxyLookup(fallback=lambda self: type(self)) # type: ignore\n __instancecheck__ = _ProxyLookup(lambda self, other: isinstance(other, self))\n __subclasscheck__ = _ProxyLookup(lambda self, other: issubclass(other, self))\n # __class_getitem__ triggered through __getitem__\n __call__ = _ProxyLookup(lambda self, *args, **kwargs: self(*args, **kwargs))\n __len__ = _ProxyLookup(len)\n __length_hint__ = _ProxyLookup(operator.length_hint)\n __getitem__ = _ProxyLookup(operator.getitem)\n __setitem__ = _ProxyLookup(operator.setitem)\n __delitem__ = _ProxyLookup(operator.delitem)\n # __missing__ triggered through __getitem__\n __iter__ = _ProxyLookup(iter)\n __next__ = _ProxyLookup(next)\n __reversed__ = _ProxyLookup(reversed)\n __contains__ = _ProxyLookup(operator.contains)\n __add__ = _ProxyLookup(operator.add)\n __sub__ = _ProxyLookup(operator.sub)\n __mul__ = _ProxyLookup(operator.mul)\n __matmul__ = _ProxyLookup(operator.matmul)\n __truediv__ = _ProxyLookup(operator.truediv)\n __floordiv__ = _ProxyLookup(operator.floordiv)\n __mod__ = _ProxyLookup(operator.mod)\n __divmod__ = _ProxyLookup(divmod)\n __pow__ = _ProxyLookup(pow)\n __lshift__ = _ProxyLookup(operator.lshift)\n __rshift__ = _ProxyLookup(operator.rshift)\n __and__ = _ProxyLookup(operator.and_)\n __xor__ = _ProxyLookup(operator.xor)\n __or__ = _ProxyLookup(operator.or_)\n __radd__ = _ProxyLookup(_l_to_r_op(operator.add))\n __rsub__ = _ProxyLookup(_l_to_r_op(operator.sub))\n __rmul__ = _ProxyLookup(_l_to_r_op(operator.mul))\n __rmatmul__ = _ProxyLookup(_l_to_r_op(operator.matmul))\n __rtruediv__ = _ProxyLookup(_l_to_r_op(operator.truediv))\n __rfloordiv__ = _ProxyLookup(_l_to_r_op(operator.floordiv))\n __rmod__ = _ProxyLookup(_l_to_r_op(operator.mod))\n __rdivmod__ = _ProxyLookup(_l_to_r_op(divmod))\n __rpow__ = _ProxyLookup(_l_to_r_op(pow))\n __rlshift__ = _ProxyLookup(_l_to_r_op(operator.lshift))\n __rrshift__ = _ProxyLookup(_l_to_r_op(operator.rshift))\n __rand__ = _ProxyLookup(_l_to_r_op(operator.and_))\n __rxor__ = _ProxyLookup(_l_to_r_op(operator.xor))\n __ror__ = _ProxyLookup(_l_to_r_op(operator.or_))\n __iadd__ = _ProxyIOp(operator.iadd)\n __isub__ = _ProxyIOp(operator.isub)\n __imul__ = _ProxyIOp(operator.imul)\n __imatmul__ = _ProxyIOp(operator.imatmul)\n __itruediv__ = _ProxyIOp(operator.itruediv)\n __ifloordiv__ = _ProxyIOp(operator.ifloordiv)\n __imod__ = _ProxyIOp(operator.imod)\n __ipow__ = _ProxyIOp(operator.ipow)\n __ilshift__ = _ProxyIOp(operator.ilshift)\n __irshift__ = _ProxyIOp(operator.irshift)\n __iand__ = _ProxyIOp(operator.iand)\n __ixor__ = _ProxyIOp(operator.ixor)\n __ior__ = _ProxyIOp(operator.ior)\n __neg__ = _ProxyLookup(operator.neg)\n __pos__ = _ProxyLookup(operator.pos)\n __abs__ = _ProxyLookup(abs)\n __invert__ = _ProxyLookup(operator.invert)\n __complex__ = _ProxyLookup(complex)\n __int__ = _ProxyLookup(int)\n __float__ = _ProxyLookup(float)\n __index__ = _ProxyLookup(operator.index)\n __round__ = _ProxyLookup(round)\n __trunc__ = _ProxyLookup(math.trunc)\n __floor__ = _ProxyLookup(math.floor)\n __ceil__ = _ProxyLookup(math.ceil)\n __enter__ = _ProxyLookup()\n __exit__ = _ProxyLookup()\n __await__ = _ProxyLookup()\n __aiter__ = _ProxyLookup()\n __anext__ = _ProxyLookup()\n __aenter__ = _ProxyLookup()\n __aexit__ = _ProxyLookup()\n __copy__ = _ProxyLookup(copy.copy)\n __deepcopy__ = _ProxyLookup(copy.deepcopy)\n # __getnewargs_ex__ (pickle through proxy not supported)\n # __getnewargs__ (pickle)\n # __getstate__ (pickle)\n # __setstate__ (pickle)\n # __reduce__ (pickle)\n # __reduce_ex__ (pickle)\n","path":"src/werkzeug/local.py"}],"string":"[\n {\n \"content\": \"import copy\\nimport math\\nimport operator\\nimport sys\\nimport typing as t\\nimport warnings\\nfrom functools import partial\\nfrom functools import update_wrapper\\n\\nfrom .wsgi import ClosingIterator\\n\\nif t.TYPE_CHECKING:\\n from wsgiref.types import WSGIApplication\\n\\ntry:\\n from greenlet import getcurrent as _get_ident\\nexcept ImportError:\\n from threading import get_ident as _get_ident\\n\\n\\ndef get_ident():\\n warnings.warn(\\n \\\"'get_ident' is deprecated and will be removed in Werkzeug\\\"\\n \\\" 2.1. Use 'greenlet.getcurrent' or 'threading.get_ident' for\\\"\\n \\\" previous behavior.\\\",\\n DeprecationWarning,\\n stacklevel=2,\\n )\\n return _get_ident()\\n\\n\\nclass _CannotUseContextVar(Exception):\\n pass\\n\\n\\ntry:\\n from contextvars import ContextVar\\n\\n if \\\"gevent\\\" in sys.modules or \\\"eventlet\\\" in sys.modules:\\n # Both use greenlet, so first check it has patched\\n # ContextVars, Greenlet <0.4.17 does not.\\n import greenlet\\n\\n greenlet_patched = getattr(greenlet, \\\"GREENLET_USE_CONTEXT_VARS\\\", False)\\n\\n if not greenlet_patched:\\n # If Gevent is used, check it has patched ContextVars,\\n # <20.5 does not.\\n try:\\n from gevent.monkey import is_object_patched\\n except ImportError:\\n # Gevent isn't used, but Greenlet is and hasn't patched\\n raise _CannotUseContextVar()\\n else:\\n if is_object_patched(\\\"threading\\\", \\\"local\\\") and not is_object_patched(\\n \\\"contextvars\\\", \\\"ContextVar\\\"\\n ):\\n raise _CannotUseContextVar()\\n\\n\\nexcept (ImportError, _CannotUseContextVar):\\n\\n class ContextVar: # type: ignore\\n \\\"\\\"\\\"A fake ContextVar based on the previous greenlet/threading\\n ident function. Used on Python 3.6, eventlet, and old versions\\n of gevent.\\n \\\"\\\"\\\"\\n\\n def __init__(self, _name):\\n self.storage = {}\\n\\n def get(self, default):\\n return self.storage.get(_get_ident(), default)\\n\\n def set(self, value):\\n self.storage[_get_ident()] = value\\n\\n\\ndef release_local(local: t.Union[\\\"Local\\\", \\\"LocalStack\\\"]) -> None:\\n \\\"\\\"\\\"Releases the contents of the local for the current context.\\n This makes it possible to use locals without a manager.\\n\\n Example::\\n\\n >>> loc = Local()\\n >>> loc.foo = 42\\n >>> release_local(loc)\\n >>> hasattr(loc, 'foo')\\n False\\n\\n With this function one can release :class:`Local` objects as well\\n as :class:`LocalStack` objects. However it is not possible to\\n release data held by proxies that way, one always has to retain\\n a reference to the underlying local object in order to be able\\n to release it.\\n\\n .. versionadded:: 0.6.1\\n \\\"\\\"\\\"\\n local.__release_local__()\\n\\n\\nclass Local:\\n __slots__ = (\\\"_storage\\\",)\\n\\n def __init__(self) -> None:\\n object.__setattr__(self, \\\"_storage\\\", ContextVar(\\\"local_storage\\\"))\\n\\n @property\\n def __storage__(self):\\n warnings.warn(\\n \\\"'__storage__' is deprecated and will be removed in Werkzeug 2.1.\\\",\\n DeprecationWarning,\\n stacklevel=2,\\n )\\n return self._storage.get({})\\n\\n @property\\n def __ident_func__(self):\\n warnings.warn(\\n \\\"'__ident_func__' is deprecated and will be removed in\\\"\\n \\\" Werkzeug 2.1. It should not be used in Python 3.7+.\\\",\\n DeprecationWarning,\\n stacklevel=2,\\n )\\n return _get_ident\\n\\n @__ident_func__.setter\\n def __ident_func__(self, func):\\n warnings.warn(\\n \\\"'__ident_func__' is deprecated and will be removed in\\\"\\n \\\" Werkzeug 2.1. Setting it no longer has any effect.\\\",\\n DeprecationWarning,\\n stacklevel=2,\\n )\\n\\n def __iter__(self) -> t.Iterator[t.Tuple[int, t.Any]]:\\n return iter(self._storage.get({}).items())\\n\\n def __call__(self, proxy: str) -> \\\"LocalProxy\\\":\\n \\\"\\\"\\\"Create a proxy for a name.\\\"\\\"\\\"\\n return LocalProxy(self, proxy)\\n\\n def __release_local__(self) -> None:\\n self._storage.set({})\\n\\n def __getattr__(self, name: str) -> t.Any:\\n values = self._storage.get({})\\n try:\\n return values[name]\\n except KeyError:\\n raise AttributeError(name)\\n\\n def __setattr__(self, name: str, value: t.Any) -> None:\\n values = self._storage.get({}).copy()\\n values[name] = value\\n self._storage.set(values)\\n\\n def __delattr__(self, name: str) -> None:\\n values = self._storage.get({}).copy()\\n try:\\n del values[name]\\n self._storage.set(values)\\n except KeyError:\\n raise AttributeError(name)\\n\\n\\nclass LocalStack:\\n \\\"\\\"\\\"This class works similar to a :class:`Local` but keeps a stack\\n of objects instead. This is best explained with an example::\\n\\n >>> ls = LocalStack()\\n >>> ls.push(42)\\n >>> ls.top\\n 42\\n >>> ls.push(23)\\n >>> ls.top\\n 23\\n >>> ls.pop()\\n 23\\n >>> ls.top\\n 42\\n\\n They can be force released by using a :class:`LocalManager` or with\\n the :func:`release_local` function but the correct way is to pop the\\n item from the stack after using. When the stack is empty it will\\n no longer be bound to the current context (and as such released).\\n\\n By calling the stack without arguments it returns a proxy that resolves to\\n the topmost item on the stack.\\n\\n .. versionadded:: 0.6.1\\n \\\"\\\"\\\"\\n\\n def __init__(self) -> None:\\n self._local = Local()\\n\\n def __release_local__(self) -> None:\\n self._local.__release_local__()\\n\\n @property\\n def __ident_func__(self) -> t.Callable[[], int]:\\n return self._local.__ident_func__\\n\\n @__ident_func__.setter\\n def __ident_func__(self, value: t.Callable[[], int]) -> None:\\n object.__setattr__(self._local, \\\"__ident_func__\\\", value)\\n\\n def __call__(self) -> \\\"LocalProxy\\\":\\n def _lookup():\\n rv = self.top\\n if rv is None:\\n raise RuntimeError(\\\"object unbound\\\")\\n return rv\\n\\n return LocalProxy(_lookup)\\n\\n def push(self, obj: t.Any) -> t.List[t.Any]:\\n \\\"\\\"\\\"Pushes a new item to the stack\\\"\\\"\\\"\\n rv = getattr(self._local, \\\"stack\\\", None)\\n if rv is None:\\n self._local.stack = rv = []\\n rv.append(obj)\\n return rv\\n\\n def pop(self) -> t.Any:\\n \\\"\\\"\\\"Removes the topmost item from the stack, will return the\\n old value or `None` if the stack was already empty.\\n \\\"\\\"\\\"\\n stack = getattr(self._local, \\\"stack\\\", None)\\n if stack is None:\\n return None\\n elif len(stack) == 1:\\n release_local(self._local)\\n return stack[-1]\\n else:\\n return stack.pop()\\n\\n @property\\n def top(self) -> t.Any:\\n \\\"\\\"\\\"The topmost item on the stack. If the stack is empty,\\n `None` is returned.\\n \\\"\\\"\\\"\\n try:\\n return self._local.stack[-1]\\n except (AttributeError, IndexError):\\n return None\\n\\n\\nclass LocalManager:\\n \\\"\\\"\\\"Local objects cannot manage themselves. For that you need a local\\n manager. You can pass a local manager multiple locals or add them\\n later y appending them to `manager.locals`. Every time the manager\\n cleans up, it will clean up all the data left in the locals for this\\n context.\\n\\n .. versionchanged:: 2.0\\n ``ident_func`` is deprecated and will be removed in Werkzeug\\n 2.1.\\n\\n .. versionchanged:: 0.6.1\\n The :func:`release_local` function can be used instead of a\\n manager.\\n\\n .. versionchanged:: 0.7\\n The ``ident_func`` parameter was added.\\n \\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n locals: t.Optional[t.Iterable[t.Union[Local, LocalStack]]] = None,\\n ident_func: None = None,\\n ) -> None:\\n if locals is None:\\n self.locals = []\\n elif isinstance(locals, Local):\\n self.locals = [locals]\\n else:\\n self.locals = list(locals)\\n\\n if ident_func is not None:\\n warnings.warn(\\n \\\"'ident_func' is deprecated and will be removed in\\\"\\n \\\" Werkzeug 2.1. Setting it no longer has any effect.\\\",\\n DeprecationWarning,\\n stacklevel=2,\\n )\\n\\n @property\\n def ident_func(self):\\n warnings.warn(\\n \\\"'ident_func' is deprecated and will be removed in Werkzeug 2.1.\\\",\\n DeprecationWarning,\\n stacklevel=2,\\n )\\n return _get_ident\\n\\n @ident_func.setter\\n def ident_func(self, func):\\n warnings.warn(\\n \\\"'ident_func' is deprecated and will be removedin Werkzeug\\\"\\n \\\" 2.1. Setting it no longer has any effect.\\\",\\n DeprecationWarning,\\n stacklevel=2,\\n )\\n\\n def get_ident(self) -> int:\\n \\\"\\\"\\\"Return the context identifier the local objects use internally for\\n this context. You cannot override this method to change the behavior\\n but use it to link other context local objects (such as SQLAlchemy's\\n scoped sessions) to the Werkzeug locals.\\n\\n .. deprecated:: 2.0\\n Will be removed in Werkzeug 2.1.\\n\\n .. versionchanged:: 0.7\\n You can pass a different ident function to the local manager that\\n will then be propagated to all the locals passed to the\\n constructor.\\n \\\"\\\"\\\"\\n warnings.warn(\\n \\\"'get_ident' is deprecated and will be removed in Werkzeug 2.1.\\\",\\n DeprecationWarning,\\n stacklevel=2,\\n )\\n return self.ident_func()\\n\\n def cleanup(self):\\n \\\"\\\"\\\"Manually clean up the data in the locals for this context. Call\\n this at the end of the request or use `make_middleware()`.\\n \\\"\\\"\\\"\\n for local in self.locals:\\n release_local(local)\\n\\n def make_middleware(self, app: \\\"WSGIApplication\\\") -> \\\"WSGIApplication\\\":\\n \\\"\\\"\\\"Wrap a WSGI application so that cleaning up happens after\\n request end.\\n \\\"\\\"\\\"\\n\\n def application(environ, start_response):\\n return ClosingIterator(app(environ, start_response), self.cleanup)\\n\\n return application\\n\\n def middleware(self, func: \\\"WSGIApplication\\\") -> \\\"WSGIApplication\\\":\\n \\\"\\\"\\\"Like `make_middleware` but for decorating functions.\\n\\n Example usage::\\n\\n @manager.middleware\\n def application(environ, start_response):\\n ...\\n\\n The difference to `make_middleware` is that the function passed\\n will have all the arguments copied from the inner application\\n (name, docstring, module).\\n \\\"\\\"\\\"\\n return update_wrapper(self.make_middleware(func), func)\\n\\n def __repr__(self) -> str:\\n return f\\\"<{type(self).__name__} storages: {len(self.locals)}>\\\"\\n\\n\\nclass _ProxyLookup:\\n \\\"\\\"\\\"Descriptor that handles proxied attribute lookup for\\n :class:`LocalProxy`.\\n\\n :param f: The built-in function this attribute is accessed through.\\n Instead of looking up the special method, the function call\\n is redone on the object.\\n :param fallback: Call this method if the proxy is unbound instead of\\n raising a :exc:`RuntimeError`.\\n :param class_value: Value to return when accessed from the class.\\n Used for ``__doc__`` so building docs still works.\\n \\\"\\\"\\\"\\n\\n __slots__ = (\\\"bind_f\\\", \\\"fallback\\\", \\\"class_value\\\", \\\"name\\\")\\n\\n def __init__(self, f=None, fallback=None, class_value=None):\\n if hasattr(f, \\\"__get__\\\"):\\n # A Python function, can be turned into a bound method.\\n\\n def bind_f(instance, obj):\\n return f.__get__(obj, type(obj))\\n\\n elif f is not None:\\n # A C function, use partial to bind the first argument.\\n\\n def bind_f(instance, obj):\\n return partial(f, obj)\\n\\n else:\\n # Use getattr, which will produce a bound method.\\n bind_f = None\\n\\n self.bind_f = bind_f\\n self.fallback = fallback\\n self.class_value = class_value\\n\\n def __set_name__(self, owner, name):\\n self.name = name\\n\\n def __get__(self, instance, owner=None):\\n if instance is None:\\n if self.class_value is not None:\\n return self.class_value\\n\\n return self\\n\\n try:\\n obj = instance._get_current_object()\\n except RuntimeError:\\n if self.fallback is None:\\n raise\\n\\n return self.fallback.__get__(instance, owner)\\n\\n if self.bind_f is not None:\\n return self.bind_f(instance, obj)\\n\\n return getattr(obj, self.name)\\n\\n def __repr__(self):\\n return f\\\"proxy {self.name}\\\"\\n\\n def __call__(self, instance, *args, **kwargs):\\n \\\"\\\"\\\"Support calling unbound methods from the class. For example,\\n this happens with ``copy.copy``, which does\\n ``type(x).__copy__(x)``. ``type(x)`` can't be proxied, so it\\n returns the proxy type and descriptor.\\n \\\"\\\"\\\"\\n return self.__get__(instance, type(instance))(*args, **kwargs)\\n\\n\\nclass _ProxyIOp(_ProxyLookup):\\n \\\"\\\"\\\"Look up an augmented assignment method on a proxied object. The\\n method is wrapped to return the proxy instead of the object.\\n \\\"\\\"\\\"\\n\\n __slots__ = ()\\n\\n def __init__(self, f=None, fallback=None):\\n super().__init__(f, fallback)\\n\\n def bind_f(instance, obj):\\n def i_op(self, other):\\n f(self, other)\\n return instance\\n\\n return i_op.__get__(obj, type(obj))\\n\\n self.bind_f = bind_f\\n\\n\\ndef _l_to_r_op(op):\\n \\\"\\\"\\\"Swap the argument order to turn an l-op into an r-op.\\\"\\\"\\\"\\n\\n def r_op(obj, other):\\n return op(other, obj)\\n\\n return r_op\\n\\n\\nclass LocalProxy:\\n \\\"\\\"\\\"A proxy to the object bound to a :class:`Local`. All operations\\n on the proxy are forwarded to the bound object. If no object is\\n bound, a :exc:`RuntimeError` is raised.\\n\\n .. code-block:: python\\n\\n from werkzeug.local import Local\\n l = Local()\\n\\n # a proxy to whatever l.user is set to\\n user = l(\\\"user\\\")\\n\\n from werkzeug.local import LocalStack\\n _request_stack = LocalStack()\\n\\n # a proxy to _request_stack.top\\n request = _request_stack()\\n\\n # a proxy to the session attribute of the request proxy\\n session = LocalProxy(lambda: request.session)\\n\\n ``__repr__`` and ``__class__`` are forwarded, so ``repr(x)`` and\\n ``isinstance(x, cls)`` will look like the proxied object. Use\\n ``issubclass(type(x), LocalProxy)`` to check if an object is a\\n proxy.\\n\\n .. code-block:: python\\n\\n repr(user) # <User admin>\\n isinstance(user, User) # True\\n issubclass(type(user), LocalProxy) # True\\n\\n :param local: The :class:`Local` or callable that provides the\\n proxied object.\\n :param name: The attribute name to look up on a :class:`Local`. Not\\n used if a callable is given.\\n\\n .. versionchanged:: 2.0\\n Updated proxied attributes and methods to reflect the current\\n data model.\\n\\n .. versionchanged:: 0.6.1\\n The class can be instantiated with a callable.\\n \\\"\\\"\\\"\\n\\n __slots__ = (\\\"__local\\\", \\\"__name\\\", \\\"__wrapped__\\\")\\n\\n def __init__(\\n self,\\n local: t.Union[\\\"Local\\\", t.Callable[[], t.Any]],\\n name: t.Optional[str] = None,\\n ) -> None:\\n object.__setattr__(self, \\\"_LocalProxy__local\\\", local)\\n object.__setattr__(self, \\\"_LocalProxy__name\\\", name)\\n\\n if callable(local) and not hasattr(local, \\\"__release_local__\\\"):\\n # \\\"local\\\" is a callable that is not an instance of Local or\\n # LocalManager: mark it as a wrapped function.\\n object.__setattr__(self, \\\"__wrapped__\\\", local)\\n\\n def _get_current_object(self) -> t.Any:\\n \\\"\\\"\\\"Return the current object. This is useful if you want the real\\n object behind the proxy at a time for performance reasons or because\\n you want to pass the object into a different context.\\n \\\"\\\"\\\"\\n if not hasattr(self.__local, \\\"__release_local__\\\"): # type: ignore\\n return self.__local() # type: ignore\\n\\n try:\\n return getattr(self.__local, self.__name) # type: ignore\\n except AttributeError:\\n raise RuntimeError(f\\\"no object bound to {self.__name}\\\") # type: ignore\\n\\n __doc__ = _ProxyLookup( # type: ignore\\n class_value=__doc__, fallback=lambda self: type(self).__doc__\\n )\\n # __del__ should only delete the proxy\\n __repr__ = _ProxyLookup(\\n repr, fallback=lambda self: f\\\"<{type(self).__name__} unbound>\\\"\\n )\\n __str__ = _ProxyLookup(str)\\n __bytes__ = _ProxyLookup(bytes)\\n __format__ = _ProxyLookup() # type: ignore\\n __lt__ = _ProxyLookup(operator.lt)\\n __le__ = _ProxyLookup(operator.le)\\n __eq__ = _ProxyLookup(operator.eq)\\n __ne__ = _ProxyLookup(operator.ne)\\n __gt__ = _ProxyLookup(operator.gt)\\n __ge__ = _ProxyLookup(operator.ge)\\n __hash__ = _ProxyLookup(hash) # type: ignore\\n __bool__ = _ProxyLookup(bool, fallback=lambda self: False)\\n __getattr__ = _ProxyLookup(getattr)\\n # __getattribute__ triggered through __getattr__\\n __setattr__ = _ProxyLookup(setattr)\\n __delattr__ = _ProxyLookup(delattr)\\n __dir__ = _ProxyLookup(dir, fallback=lambda self: []) # type: ignore\\n # __get__ (proxying descriptor not supported)\\n # __set__ (descriptor)\\n # __delete__ (descriptor)\\n # __set_name__ (descriptor)\\n # __objclass__ (descriptor)\\n # __slots__ used by proxy itself\\n # __dict__ (__getattr__)\\n # __weakref__ (__getattr__)\\n # __init_subclass__ (proxying metaclass not supported)\\n # __prepare__ (metaclass)\\n __class__ = _ProxyLookup(fallback=lambda self: type(self)) # type: ignore\\n __instancecheck__ = _ProxyLookup(lambda self, other: isinstance(other, self))\\n __subclasscheck__ = _ProxyLookup(lambda self, other: issubclass(other, self))\\n # __class_getitem__ triggered through __getitem__\\n __call__ = _ProxyLookup(lambda self, *args, **kwargs: self(*args, **kwargs))\\n __len__ = _ProxyLookup(len)\\n __length_hint__ = _ProxyLookup(operator.length_hint)\\n __getitem__ = _ProxyLookup(operator.getitem)\\n __setitem__ = _ProxyLookup(operator.setitem)\\n __delitem__ = _ProxyLookup(operator.delitem)\\n # __missing__ triggered through __getitem__\\n __iter__ = _ProxyLookup(iter)\\n __next__ = _ProxyLookup(next)\\n __reversed__ = _ProxyLookup(reversed)\\n __contains__ = _ProxyLookup(operator.contains)\\n __add__ = _ProxyLookup(operator.add)\\n __sub__ = _ProxyLookup(operator.sub)\\n __mul__ = _ProxyLookup(operator.mul)\\n __matmul__ = _ProxyLookup(operator.matmul)\\n __truediv__ = _ProxyLookup(operator.truediv)\\n __floordiv__ = _ProxyLookup(operator.floordiv)\\n __mod__ = _ProxyLookup(operator.mod)\\n __divmod__ = _ProxyLookup(divmod)\\n __pow__ = _ProxyLookup(pow)\\n __lshift__ = _ProxyLookup(operator.lshift)\\n __rshift__ = _ProxyLookup(operator.rshift)\\n __and__ = _ProxyLookup(operator.and_)\\n __xor__ = _ProxyLookup(operator.xor)\\n __or__ = _ProxyLookup(operator.or_)\\n __radd__ = _ProxyLookup(_l_to_r_op(operator.add))\\n __rsub__ = _ProxyLookup(_l_to_r_op(operator.sub))\\n __rmul__ = _ProxyLookup(_l_to_r_op(operator.mul))\\n __rmatmul__ = _ProxyLookup(_l_to_r_op(operator.matmul))\\n __rtruediv__ = _ProxyLookup(_l_to_r_op(operator.truediv))\\n __rfloordiv__ = _ProxyLookup(_l_to_r_op(operator.floordiv))\\n __rmod__ = _ProxyLookup(_l_to_r_op(operator.mod))\\n __rdivmod__ = _ProxyLookup(_l_to_r_op(divmod))\\n __rpow__ = _ProxyLookup(_l_to_r_op(pow))\\n __rlshift__ = _ProxyLookup(_l_to_r_op(operator.lshift))\\n __rrshift__ = _ProxyLookup(_l_to_r_op(operator.rshift))\\n __rand__ = _ProxyLookup(_l_to_r_op(operator.and_))\\n __rxor__ = _ProxyLookup(_l_to_r_op(operator.xor))\\n __ror__ = _ProxyLookup(_l_to_r_op(operator.or_))\\n __iadd__ = _ProxyIOp(operator.iadd)\\n __isub__ = _ProxyIOp(operator.isub)\\n __imul__ = _ProxyIOp(operator.imul)\\n __imatmul__ = _ProxyIOp(operator.imatmul)\\n __itruediv__ = _ProxyIOp(operator.itruediv)\\n __ifloordiv__ = _ProxyIOp(operator.ifloordiv)\\n __imod__ = _ProxyIOp(operator.imod)\\n __ipow__ = _ProxyIOp(operator.ipow)\\n __ilshift__ = _ProxyIOp(operator.ilshift)\\n __irshift__ = _ProxyIOp(operator.irshift)\\n __iand__ = _ProxyIOp(operator.iand)\\n __ixor__ = _ProxyIOp(operator.ixor)\\n __ior__ = _ProxyIOp(operator.ior)\\n __neg__ = _ProxyLookup(operator.neg)\\n __pos__ = _ProxyLookup(operator.pos)\\n __abs__ = _ProxyLookup(abs)\\n __invert__ = _ProxyLookup(operator.invert)\\n __complex__ = _ProxyLookup(complex)\\n __int__ = _ProxyLookup(int)\\n __float__ = _ProxyLookup(float)\\n __index__ = _ProxyLookup(operator.index)\\n __round__ = _ProxyLookup(round)\\n __trunc__ = _ProxyLookup(math.trunc)\\n __floor__ = _ProxyLookup(math.floor)\\n __ceil__ = _ProxyLookup(math.ceil)\\n __enter__ = _ProxyLookup()\\n __exit__ = _ProxyLookup()\\n __await__ = _ProxyLookup()\\n __aiter__ = _ProxyLookup()\\n __anext__ = _ProxyLookup()\\n __aenter__ = _ProxyLookup()\\n __aexit__ = _ProxyLookup()\\n __copy__ = _ProxyLookup(copy.copy)\\n __deepcopy__ = _ProxyLookup(copy.deepcopy)\\n # __getnewargs_ex__ (pickle through proxy not supported)\\n # __getnewargs__ (pickle)\\n # __getstate__ (pickle)\\n # __setstate__ (pickle)\\n # __reduce__ (pickle)\\n # __reduce_ex__ (pickle)\\n\",\n \"path\": \"src/werkzeug/local.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"import copy\nimport math\nimport operator\nimport sys\nimport typing as t\nimport warnings\nfrom functools import partial\nfrom functools import update_wrapper\n\nfrom .wsgi import ClosingIterator\n\nif t.TYPE_CHECKING:\n from wsgiref.types import WSGIApplication\n\ntry:\n from greenlet import getcurrent as _get_ident\nexcept ImportError:\n from threading import get_ident as _get_ident\n\n\ndef get_ident():\n warnings.warn(\n \"'get_ident' is deprecated and will be removed in Werkzeug\"\n \" version 2.1. Use 'greenlet.getcurrent' or\"\n \" 'threading.get_ident' for previous behavior.\",\n DeprecationWarning,\n stacklevel=2,\n )\n return _get_ident()\n\n\nclass _CannotUseContextVar(Exception):\n pass\n\n\ntry:\n from contextvars import ContextVar\n\n if \"gevent\" in sys.modules or \"eventlet\" in sys.modules:\n # Both use greenlet, so first check it has patched\n # ContextVars, Greenlet <0.4.17 does not.\n import greenlet\n\n greenlet_patched = getattr(greenlet, \"GREENLET_USE_CONTEXT_VARS\", False)\n\n if not greenlet_patched:\n # If Gevent is used, check it has patched ContextVars,\n # <20.5 does not.\n try:\n from gevent.monkey import is_object_patched\n except ImportError:\n # Gevent isn't used, but Greenlet is and hasn't patched\n raise _CannotUseContextVar()\n else:\n if is_object_patched(\"threading\", \"local\") and not is_object_patched(\n \"contextvars\", \"ContextVar\"\n ):\n raise _CannotUseContextVar()\n\n\nexcept (ImportError, _CannotUseContextVar):\n\n class ContextVar: # type: ignore\n \"\"\"A fake ContextVar based on the previous greenlet/threading\n ident function. Used on Python 3.6, eventlet, and old versions\n of gevent.\n \"\"\"\n\n def __init__(self, _name):\n self.storage = {}\n\n def get(self, default):\n return self.storage.get(_get_ident(), default)\n\n def set(self, value):\n self.storage[_get_ident()] = value\n\n\ndef release_local(local: t.Union[\"Local\", \"LocalStack\"]) -> None:\n \"\"\"Releases the contents of the local for the current context.\n This makes it possible to use locals without a manager.\n\n Example::\n\n >>> loc = Local()\n >>> loc.foo = 42\n >>> release_local(loc)\n >>> hasattr(loc, 'foo')\n False\n\n With this function one can release :class:`Local` objects as well\n as :class:`LocalStack` objects. However it is not possible to\n release data held by proxies that way, one always has to retain\n a reference to the underlying local object in order to be able\n to release it.\n\n .. versionadded:: 0.6.1\n \"\"\"\n local.__release_local__()\n\n\nclass Local:\n __slots__ = (\"_storage\",)\n\n def __init__(self) -> None:\n object.__setattr__(self, \"_storage\", ContextVar(\"local_storage\"))\n\n @property\n def __storage__(self):\n warnings.warn(\n \"'__storage__' is deprecated and will be removed in\"\n \" Werkzeug version 2.1.\",\n DeprecationWarning,\n stacklevel=2,\n )\n return self._storage.get({})\n\n @property\n def __ident_func__(self):\n warnings.warn(\n \"'__ident_func__' is deprecated and will be removed in\"\n \" Werkzeug version 2.1. It should not be used in Python\"\n \" 3.7+\",\n DeprecationWarning,\n stacklevel=2,\n )\n return _get_ident\n\n @__ident_func__.setter\n def __ident_func__(self, func):\n warnings.warn(\n \"'__ident_func__' is deprecated and will be removed in\"\n \" Werkzeug version 2.1. Setting it no longer has any\"\n \" effect.\",\n DeprecationWarning,\n stacklevel=2,\n )\n\n def __iter__(self) -> t.Iterator[t.Tuple[int, t.Any]]:\n return iter(self._storage.get({}).items())\n\n def __call__(self, proxy: str) -> \"LocalProxy\":\n \"\"\"Create a proxy for a name.\"\"\"\n return LocalProxy(self, proxy)\n\n def __release_local__(self) -> None:\n self._storage.set({})\n\n def __getattr__(self, name: str) -> t.Any:\n values = self._storage.get({})\n try:\n return values[name]\n except KeyError:\n raise AttributeError(name)\n\n def __setattr__(self, name: str, value: t.Any) -> None:\n values = self._storage.get({}).copy()\n values[name] = value\n self._storage.set(values)\n\n def __delattr__(self, name: str) -> None:\n values = self._storage.get({}).copy()\n try:\n del values[name]\n self._storage.set(values)\n except KeyError:\n raise AttributeError(name)\n\n\nclass LocalStack:\n \"\"\"This class works similar to a :class:`Local` but keeps a stack\n of objects instead. This is best explained with an example::\n\n >>> ls = LocalStack()\n >>> ls.push(42)\n >>> ls.top\n 42\n >>> ls.push(23)\n >>> ls.top\n 23\n >>> ls.pop()\n 23\n >>> ls.top\n 42\n\n They can be force released by using a :class:`LocalManager` or with\n the :func:`release_local` function but the correct way is to pop the\n item from the stack after using. When the stack is empty it will\n no longer be bound to the current context (and as such released).\n\n By calling the stack without arguments it returns a proxy that resolves to\n the topmost item on the stack.\n\n .. versionadded:: 0.6.1\n \"\"\"\n\n def __init__(self) -> None:\n self._local = Local()\n\n def __release_local__(self) -> None:\n self._local.__release_local__()\n\n @property\n def __ident_func__(self) -> t.Callable[[], int]:\n return self._local.__ident_func__\n\n @__ident_func__.setter\n def __ident_func__(self, value: t.Callable[[], int]) -> None:\n object.__setattr__(self._local, \"__ident_func__\", value)\n\n def __call__(self) -> \"LocalProxy\":\n def _lookup():\n rv = self.top\n if rv is None:\n raise RuntimeError(\"object unbound\")\n return rv\n\n return LocalProxy(_lookup)\n\n def push(self, obj: t.Any) -> t.List[t.Any]:\n \"\"\"Pushes a new item to the stack\"\"\"\n rv = getattr(self._local, \"stack\", []).copy()\n rv.append(obj)\n self._local.stack = rv\n return rv\n\n def pop(self) -> t.Any:\n \"\"\"Removes the topmost item from the stack, will return the\n old value or `None` if the stack was already empty.\n \"\"\"\n stack = getattr(self._local, \"stack\", None)\n if stack is None:\n return None\n elif len(stack) == 1:\n release_local(self._local)\n return stack[-1]\n else:\n return stack.pop()\n\n @property\n def top(self) -> t.Any:\n \"\"\"The topmost item on the stack. If the stack is empty,\n `None` is returned.\n \"\"\"\n try:\n return self._local.stack[-1]\n except (AttributeError, IndexError):\n return None\n\n\nclass LocalManager:\n \"\"\"Local objects cannot manage themselves. For that you need a local\n manager. You can pass a local manager multiple locals or add them\n later y appending them to `manager.locals`. Every time the manager\n cleans up, it will clean up all the data left in the locals for this\n context.\n\n .. versionchanged:: 2.0.0\n ``ident_func`` is deprecated and will be removed in version 2.1.\n\n .. versionchanged:: 0.6.1\n The :func:`release_local` function can be used instead of a\n manager.\n\n .. versionchanged:: 0.7\n The ``ident_func`` parameter was added.\n \"\"\"\n\n def __init__(\n self,\n locals: t.Optional[t.Iterable[t.Union[Local, LocalStack]]] = None,\n ident_func: None = None,\n ) -> None:\n if locals is None:\n self.locals = []\n elif isinstance(locals, Local):\n self.locals = [locals]\n else:\n self.locals = list(locals)\n\n if ident_func is not None:\n warnings.warn(\n \"'ident_func' is deprecated and will be removed in\"\n \" Werkzeug version 2.1. Setting it no longer has any\"\n \" effect.\",\n DeprecationWarning,\n stacklevel=2,\n )\n\n @property\n def ident_func(self):\n warnings.warn(\n \"'ident_func' is deprecated and will be removed in Werkzeug\"\n \" version 2.1.\",\n DeprecationWarning,\n stacklevel=2,\n )\n return _get_ident\n\n @ident_func.setter\n def ident_func(self, func):\n warnings.warn(\n \"'ident_func' is deprecated and will be removedin Werkzeug\"\n \" version 2.1. Setting it no longer has any effect.\",\n DeprecationWarning,\n stacklevel=2,\n )\n\n def get_ident(self) -> int:\n \"\"\"Return the context identifier the local objects use internally for\n this context. You cannot override this method to change the behavior\n but use it to link other context local objects (such as SQLAlchemy's\n scoped sessions) to the Werkzeug locals.\n\n .. deprecated:: 2.0.0\n Will be removed in version 2.1.\n\n .. versionchanged:: 0.7\n You can pass a different ident function to the local manager that\n will then be propagated to all the locals passed to the\n constructor.\n \"\"\"\n warnings.warn(\n \"'get_ident' is deprecated and will be removed in Werkzeug version 2.1.\",\n DeprecationWarning,\n stacklevel=2,\n )\n return self.ident_func()\n\n def cleanup(self):\n \"\"\"Manually clean up the data in the locals for this context. Call\n this at the end of the request or use `make_middleware()`.\n \"\"\"\n for local in self.locals:\n release_local(local)\n\n def make_middleware(self, app: \"WSGIApplication\") -> \"WSGIApplication\":\n \"\"\"Wrap a WSGI application so that cleaning up happens after\n request end.\n \"\"\"\n\n def application(environ, start_response):\n return ClosingIterator(app(environ, start_response), self.cleanup)\n\n return application\n\n def middleware(self, func: \"WSGIApplication\") -> \"WSGIApplication\":\n \"\"\"Like `make_middleware` but for decorating functions.\n\n Example usage::\n\n @manager.middleware\n def application(environ, start_response):\n ...\n\n The difference to `make_middleware` is that the function passed\n will have all the arguments copied from the inner application\n (name, docstring, module).\n \"\"\"\n return update_wrapper(self.make_middleware(func), func)\n\n def __repr__(self) -> str:\n return f\"<{type(self).__name__} storages: {len(self.locals)}>\"\n\n\nclass _ProxyLookup:\n \"\"\"Descriptor that handles proxied attribute lookup for\n :class:`LocalProxy`.\n\n :param f: The built-in function this attribute is accessed through.\n Instead of looking up the special method, the function call\n is redone on the object.\n :param fallback: Call this method if the proxy is unbound instead of\n raising a :exc:`RuntimeError`.\n :param class_value: Value to return when accessed from the class.\n Used for ``__doc__`` so building docs still works.\n \"\"\"\n\n __slots__ = (\"bind_f\", \"fallback\", \"class_value\", \"name\")\n\n def __init__(self, f=None, fallback=None, class_value=None):\n if hasattr(f, \"__get__\"):\n # A Python function, can be turned into a bound method.\n\n def bind_f(instance, obj):\n return f.__get__(obj, type(obj))\n\n elif f is not None:\n # A C function, use partial to bind the first argument.\n\n def bind_f(instance, obj):\n return partial(f, obj)\n\n else:\n # Use getattr, which will produce a bound method.\n bind_f = None\n\n self.bind_f = bind_f\n self.fallback = fallback\n self.class_value = class_value\n\n def __set_name__(self, owner, name):\n self.name = name\n\n def __get__(self, instance, owner=None):\n if instance is None:\n if self.class_value is not None:\n return self.class_value\n\n return self\n\n try:\n obj = instance._get_current_object()\n except RuntimeError:\n if self.fallback is None:\n raise\n\n return self.fallback.__get__(instance, owner)\n\n if self.bind_f is not None:\n return self.bind_f(instance, obj)\n\n return getattr(obj, self.name)\n\n def __repr__(self):\n return f\"proxy {self.name}\"\n\n def __call__(self, instance, *args, **kwargs):\n \"\"\"Support calling unbound methods from the class. For example,\n this happens with ``copy.copy``, which does\n ``type(x).__copy__(x)``. ``type(x)`` can't be proxied, so it\n returns the proxy type and descriptor.\n \"\"\"\n return self.__get__(instance, type(instance))(*args, **kwargs)\n\n\nclass _ProxyIOp(_ProxyLookup):\n \"\"\"Look up an augmented assignment method on a proxied object. The\n method is wrapped to return the proxy instead of the object.\n \"\"\"\n\n __slots__ = ()\n\n def __init__(self, f=None, fallback=None):\n super().__init__(f, fallback)\n\n def bind_f(instance, obj):\n def i_op(self, other):\n f(self, other)\n return instance\n\n return i_op.__get__(obj, type(obj))\n\n self.bind_f = bind_f\n\n\ndef _l_to_r_op(op):\n \"\"\"Swap the argument order to turn an l-op into an r-op.\"\"\"\n\n def r_op(obj, other):\n return op(other, obj)\n\n return r_op\n\n\nclass LocalProxy:\n \"\"\"A proxy to the object bound to a :class:`Local`. All operations\n on the proxy are forwarded to the bound object. If no object is\n bound, a :exc:`RuntimeError` is raised.\n\n .. code-block:: python\n\n from werkzeug.local import Local\n l = Local()\n\n # a proxy to whatever l.user is set to\n user = l(\"user\")\n\n from werkzeug.local import LocalStack\n _request_stack = LocalStack()\n\n # a proxy to _request_stack.top\n request = _request_stack()\n\n # a proxy to the session attribute of the request proxy\n session = LocalProxy(lambda: request.session)\n\n ``__repr__`` and ``__class__`` are forwarded, so ``repr(x)`` and\n ``isinstance(x, cls)`` will look like the proxied object. Use\n ``issubclass(type(x), LocalProxy)`` to check if an object is a\n proxy.\n\n .. code-block:: python\n\n repr(user) # <User admin>\n isinstance(user, User) # True\n issubclass(type(user), LocalProxy) # True\n\n :param local: The :class:`Local` or callable that provides the\n proxied object.\n :param name: The attribute name to look up on a :class:`Local`. Not\n used if a callable is given.\n\n .. versionchanged:: 2.0\n Updated proxied attributes and methods to reflect the current\n data model.\n\n .. versionchanged:: 0.6.1\n The class can be instantiated with a callable.\n \"\"\"\n\n __slots__ = (\"__local\", \"__name\", \"__wrapped__\")\n\n def __init__(\n self,\n local: t.Union[\"Local\", t.Callable[[], t.Any]],\n name: t.Optional[str] = None,\n ) -> None:\n object.__setattr__(self, \"_LocalProxy__local\", local)\n object.__setattr__(self, \"_LocalProxy__name\", name)\n\n if callable(local) and not hasattr(local, \"__release_local__\"):\n # \"local\" is a callable that is not an instance of Local or\n # LocalManager: mark it as a wrapped function.\n object.__setattr__(self, \"__wrapped__\", local)\n\n def _get_current_object(self) -> t.Any:\n \"\"\"Return the current object. This is useful if you want the real\n object behind the proxy at a time for performance reasons or because\n you want to pass the object into a different context.\n \"\"\"\n if not hasattr(self.__local, \"__release_local__\"): # type: ignore\n return self.__local() # type: ignore\n\n try:\n return getattr(self.__local, self.__name) # type: ignore\n except AttributeError:\n raise RuntimeError(f\"no object bound to {self.__name}\") # type: ignore\n\n __doc__ = _ProxyLookup( # type: ignore\n class_value=__doc__, fallback=lambda self: type(self).__doc__\n )\n # __del__ should only delete the proxy\n __repr__ = _ProxyLookup(\n repr, fallback=lambda self: f\"<{type(self).__name__} unbound>\"\n )\n __str__ = _ProxyLookup(str)\n __bytes__ = _ProxyLookup(bytes)\n __format__ = _ProxyLookup() # type: ignore\n __lt__ = _ProxyLookup(operator.lt)\n __le__ = _ProxyLookup(operator.le)\n __eq__ = _ProxyLookup(operator.eq)\n __ne__ = _ProxyLookup(operator.ne)\n __gt__ = _ProxyLookup(operator.gt)\n __ge__ = _ProxyLookup(operator.ge)\n __hash__ = _ProxyLookup(hash) # type: ignore\n __bool__ = _ProxyLookup(bool, fallback=lambda self: False)\n __getattr__ = _ProxyLookup(getattr)\n # __getattribute__ triggered through __getattr__\n __setattr__ = _ProxyLookup(setattr)\n __delattr__ = _ProxyLookup(delattr)\n __dir__ = _ProxyLookup(dir, fallback=lambda self: []) # type: ignore\n # __get__ (proxying descriptor not supported)\n # __set__ (descriptor)\n # __delete__ (descriptor)\n # __set_name__ (descriptor)\n # __objclass__ (descriptor)\n # __slots__ used by proxy itself\n # __dict__ (__getattr__)\n # __weakref__ (__getattr__)\n # __init_subclass__ (proxying metaclass not supported)\n # __prepare__ (metaclass)\n __class__ = _ProxyLookup(fallback=lambda self: type(self)) # type: ignore\n __instancecheck__ = _ProxyLookup(lambda self, other: isinstance(other, self))\n __subclasscheck__ = _ProxyLookup(lambda self, other: issubclass(other, self))\n # __class_getitem__ triggered through __getitem__\n __call__ = _ProxyLookup(lambda self, *args, **kwargs: self(*args, **kwargs))\n __len__ = _ProxyLookup(len)\n __length_hint__ = _ProxyLookup(operator.length_hint)\n __getitem__ = _ProxyLookup(operator.getitem)\n __setitem__ = _ProxyLookup(operator.setitem)\n __delitem__ = _ProxyLookup(operator.delitem)\n # __missing__ triggered through __getitem__\n __iter__ = _ProxyLookup(iter)\n __next__ = _ProxyLookup(next)\n __reversed__ = _ProxyLookup(reversed)\n __contains__ = _ProxyLookup(operator.contains)\n __add__ = _ProxyLookup(operator.add)\n __sub__ = _ProxyLookup(operator.sub)\n __mul__ = _ProxyLookup(operator.mul)\n __matmul__ = _ProxyLookup(operator.matmul)\n __truediv__ = _ProxyLookup(operator.truediv)\n __floordiv__ = _ProxyLookup(operator.floordiv)\n __mod__ = _ProxyLookup(operator.mod)\n __divmod__ = _ProxyLookup(divmod)\n __pow__ = _ProxyLookup(pow)\n __lshift__ = _ProxyLookup(operator.lshift)\n __rshift__ = _ProxyLookup(operator.rshift)\n __and__ = _ProxyLookup(operator.and_)\n __xor__ = _ProxyLookup(operator.xor)\n __or__ = _ProxyLookup(operator.or_)\n __radd__ = _ProxyLookup(_l_to_r_op(operator.add))\n __rsub__ = _ProxyLookup(_l_to_r_op(operator.sub))\n __rmul__ = _ProxyLookup(_l_to_r_op(operator.mul))\n __rmatmul__ = _ProxyLookup(_l_to_r_op(operator.matmul))\n __rtruediv__ = _ProxyLookup(_l_to_r_op(operator.truediv))\n __rfloordiv__ = _ProxyLookup(_l_to_r_op(operator.floordiv))\n __rmod__ = _ProxyLookup(_l_to_r_op(operator.mod))\n __rdivmod__ = _ProxyLookup(_l_to_r_op(divmod))\n __rpow__ = _ProxyLookup(_l_to_r_op(pow))\n __rlshift__ = _ProxyLookup(_l_to_r_op(operator.lshift))\n __rrshift__ = _ProxyLookup(_l_to_r_op(operator.rshift))\n __rand__ = _ProxyLookup(_l_to_r_op(operator.and_))\n __rxor__ = _ProxyLookup(_l_to_r_op(operator.xor))\n __ror__ = _ProxyLookup(_l_to_r_op(operator.or_))\n __iadd__ = _ProxyIOp(operator.iadd)\n __isub__ = _ProxyIOp(operator.isub)\n __imul__ = _ProxyIOp(operator.imul)\n __imatmul__ = _ProxyIOp(operator.imatmul)\n __itruediv__ = _ProxyIOp(operator.itruediv)\n __ifloordiv__ = _ProxyIOp(operator.ifloordiv)\n __imod__ = _ProxyIOp(operator.imod)\n __ipow__ = _ProxyIOp(operator.ipow)\n __ilshift__ = _ProxyIOp(operator.ilshift)\n __irshift__ = _ProxyIOp(operator.irshift)\n __iand__ = _ProxyIOp(operator.iand)\n __ixor__ = _ProxyIOp(operator.ixor)\n __ior__ = _ProxyIOp(operator.ior)\n __neg__ = _ProxyLookup(operator.neg)\n __pos__ = _ProxyLookup(operator.pos)\n __abs__ = _ProxyLookup(abs)\n __invert__ = _ProxyLookup(operator.invert)\n __complex__ = _ProxyLookup(complex)\n __int__ = _ProxyLookup(int)\n __float__ = _ProxyLookup(float)\n __index__ = _ProxyLookup(operator.index)\n __round__ = _ProxyLookup(round)\n __trunc__ = _ProxyLookup(math.trunc)\n __floor__ = _ProxyLookup(math.floor)\n __ceil__ = _ProxyLookup(math.ceil)\n __enter__ = _ProxyLookup()\n __exit__ = _ProxyLookup()\n __await__ = _ProxyLookup()\n __aiter__ = _ProxyLookup()\n __anext__ = _ProxyLookup()\n __aenter__ = _ProxyLookup()\n __aexit__ = _ProxyLookup()\n __copy__ = _ProxyLookup(copy.copy)\n __deepcopy__ = _ProxyLookup(copy.deepcopy)\n # __getnewargs_ex__ (pickle through proxy not supported)\n # __getnewargs__ (pickle)\n # __getstate__ (pickle)\n # __setstate__ (pickle)\n # __reduce__ (pickle)\n # __reduce_ex__ (pickle)\n","path":"src/werkzeug/local.py"}],"string":"[\n {\n \"content\": \"import copy\\nimport math\\nimport operator\\nimport sys\\nimport typing as t\\nimport warnings\\nfrom functools import partial\\nfrom functools import update_wrapper\\n\\nfrom .wsgi import ClosingIterator\\n\\nif t.TYPE_CHECKING:\\n from wsgiref.types import WSGIApplication\\n\\ntry:\\n from greenlet import getcurrent as _get_ident\\nexcept ImportError:\\n from threading import get_ident as _get_ident\\n\\n\\ndef get_ident():\\n warnings.warn(\\n \\\"'get_ident' is deprecated and will be removed in Werkzeug\\\"\\n \\\" version 2.1. Use 'greenlet.getcurrent' or\\\"\\n \\\" 'threading.get_ident' for previous behavior.\\\",\\n DeprecationWarning,\\n stacklevel=2,\\n )\\n return _get_ident()\\n\\n\\nclass _CannotUseContextVar(Exception):\\n pass\\n\\n\\ntry:\\n from contextvars import ContextVar\\n\\n if \\\"gevent\\\" in sys.modules or \\\"eventlet\\\" in sys.modules:\\n # Both use greenlet, so first check it has patched\\n # ContextVars, Greenlet <0.4.17 does not.\\n import greenlet\\n\\n greenlet_patched = getattr(greenlet, \\\"GREENLET_USE_CONTEXT_VARS\\\", False)\\n\\n if not greenlet_patched:\\n # If Gevent is used, check it has patched ContextVars,\\n # <20.5 does not.\\n try:\\n from gevent.monkey import is_object_patched\\n except ImportError:\\n # Gevent isn't used, but Greenlet is and hasn't patched\\n raise _CannotUseContextVar()\\n else:\\n if is_object_patched(\\\"threading\\\", \\\"local\\\") and not is_object_patched(\\n \\\"contextvars\\\", \\\"ContextVar\\\"\\n ):\\n raise _CannotUseContextVar()\\n\\n\\nexcept (ImportError, _CannotUseContextVar):\\n\\n class ContextVar: # type: ignore\\n \\\"\\\"\\\"A fake ContextVar based on the previous greenlet/threading\\n ident function. Used on Python 3.6, eventlet, and old versions\\n of gevent.\\n \\\"\\\"\\\"\\n\\n def __init__(self, _name):\\n self.storage = {}\\n\\n def get(self, default):\\n return self.storage.get(_get_ident(), default)\\n\\n def set(self, value):\\n self.storage[_get_ident()] = value\\n\\n\\ndef release_local(local: t.Union[\\\"Local\\\", \\\"LocalStack\\\"]) -> None:\\n \\\"\\\"\\\"Releases the contents of the local for the current context.\\n This makes it possible to use locals without a manager.\\n\\n Example::\\n\\n >>> loc = Local()\\n >>> loc.foo = 42\\n >>> release_local(loc)\\n >>> hasattr(loc, 'foo')\\n False\\n\\n With this function one can release :class:`Local` objects as well\\n as :class:`LocalStack` objects. However it is not possible to\\n release data held by proxies that way, one always has to retain\\n a reference to the underlying local object in order to be able\\n to release it.\\n\\n .. versionadded:: 0.6.1\\n \\\"\\\"\\\"\\n local.__release_local__()\\n\\n\\nclass Local:\\n __slots__ = (\\\"_storage\\\",)\\n\\n def __init__(self) -> None:\\n object.__setattr__(self, \\\"_storage\\\", ContextVar(\\\"local_storage\\\"))\\n\\n @property\\n def __storage__(self):\\n warnings.warn(\\n \\\"'__storage__' is deprecated and will be removed in\\\"\\n \\\" Werkzeug version 2.1.\\\",\\n DeprecationWarning,\\n stacklevel=2,\\n )\\n return self._storage.get({})\\n\\n @property\\n def __ident_func__(self):\\n warnings.warn(\\n \\\"'__ident_func__' is deprecated and will be removed in\\\"\\n \\\" Werkzeug version 2.1. It should not be used in Python\\\"\\n \\\" 3.7+\\\",\\n DeprecationWarning,\\n stacklevel=2,\\n )\\n return _get_ident\\n\\n @__ident_func__.setter\\n def __ident_func__(self, func):\\n warnings.warn(\\n \\\"'__ident_func__' is deprecated and will be removed in\\\"\\n \\\" Werkzeug version 2.1. Setting it no longer has any\\\"\\n \\\" effect.\\\",\\n DeprecationWarning,\\n stacklevel=2,\\n )\\n\\n def __iter__(self) -> t.Iterator[t.Tuple[int, t.Any]]:\\n return iter(self._storage.get({}).items())\\n\\n def __call__(self, proxy: str) -> \\\"LocalProxy\\\":\\n \\\"\\\"\\\"Create a proxy for a name.\\\"\\\"\\\"\\n return LocalProxy(self, proxy)\\n\\n def __release_local__(self) -> None:\\n self._storage.set({})\\n\\n def __getattr__(self, name: str) -> t.Any:\\n values = self._storage.get({})\\n try:\\n return values[name]\\n except KeyError:\\n raise AttributeError(name)\\n\\n def __setattr__(self, name: str, value: t.Any) -> None:\\n values = self._storage.get({}).copy()\\n values[name] = value\\n self._storage.set(values)\\n\\n def __delattr__(self, name: str) -> None:\\n values = self._storage.get({}).copy()\\n try:\\n del values[name]\\n self._storage.set(values)\\n except KeyError:\\n raise AttributeError(name)\\n\\n\\nclass LocalStack:\\n \\\"\\\"\\\"This class works similar to a :class:`Local` but keeps a stack\\n of objects instead. This is best explained with an example::\\n\\n >>> ls = LocalStack()\\n >>> ls.push(42)\\n >>> ls.top\\n 42\\n >>> ls.push(23)\\n >>> ls.top\\n 23\\n >>> ls.pop()\\n 23\\n >>> ls.top\\n 42\\n\\n They can be force released by using a :class:`LocalManager` or with\\n the :func:`release_local` function but the correct way is to pop the\\n item from the stack after using. When the stack is empty it will\\n no longer be bound to the current context (and as such released).\\n\\n By calling the stack without arguments it returns a proxy that resolves to\\n the topmost item on the stack.\\n\\n .. versionadded:: 0.6.1\\n \\\"\\\"\\\"\\n\\n def __init__(self) -> None:\\n self._local = Local()\\n\\n def __release_local__(self) -> None:\\n self._local.__release_local__()\\n\\n @property\\n def __ident_func__(self) -> t.Callable[[], int]:\\n return self._local.__ident_func__\\n\\n @__ident_func__.setter\\n def __ident_func__(self, value: t.Callable[[], int]) -> None:\\n object.__setattr__(self._local, \\\"__ident_func__\\\", value)\\n\\n def __call__(self) -> \\\"LocalProxy\\\":\\n def _lookup():\\n rv = self.top\\n if rv is None:\\n raise RuntimeError(\\\"object unbound\\\")\\n return rv\\n\\n return LocalProxy(_lookup)\\n\\n def push(self, obj: t.Any) -> t.List[t.Any]:\\n \\\"\\\"\\\"Pushes a new item to the stack\\\"\\\"\\\"\\n rv = getattr(self._local, \\\"stack\\\", []).copy()\\n rv.append(obj)\\n self._local.stack = rv\\n return rv\\n\\n def pop(self) -> t.Any:\\n \\\"\\\"\\\"Removes the topmost item from the stack, will return the\\n old value or `None` if the stack was already empty.\\n \\\"\\\"\\\"\\n stack = getattr(self._local, \\\"stack\\\", None)\\n if stack is None:\\n return None\\n elif len(stack) == 1:\\n release_local(self._local)\\n return stack[-1]\\n else:\\n return stack.pop()\\n\\n @property\\n def top(self) -> t.Any:\\n \\\"\\\"\\\"The topmost item on the stack. If the stack is empty,\\n `None` is returned.\\n \\\"\\\"\\\"\\n try:\\n return self._local.stack[-1]\\n except (AttributeError, IndexError):\\n return None\\n\\n\\nclass LocalManager:\\n \\\"\\\"\\\"Local objects cannot manage themselves. For that you need a local\\n manager. You can pass a local manager multiple locals or add them\\n later y appending them to `manager.locals`. Every time the manager\\n cleans up, it will clean up all the data left in the locals for this\\n context.\\n\\n .. versionchanged:: 2.0.0\\n ``ident_func`` is deprecated and will be removed in version 2.1.\\n\\n .. versionchanged:: 0.6.1\\n The :func:`release_local` function can be used instead of a\\n manager.\\n\\n .. versionchanged:: 0.7\\n The ``ident_func`` parameter was added.\\n \\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n locals: t.Optional[t.Iterable[t.Union[Local, LocalStack]]] = None,\\n ident_func: None = None,\\n ) -> None:\\n if locals is None:\\n self.locals = []\\n elif isinstance(locals, Local):\\n self.locals = [locals]\\n else:\\n self.locals = list(locals)\\n\\n if ident_func is not None:\\n warnings.warn(\\n \\\"'ident_func' is deprecated and will be removed in\\\"\\n \\\" Werkzeug version 2.1. Setting it no longer has any\\\"\\n \\\" effect.\\\",\\n DeprecationWarning,\\n stacklevel=2,\\n )\\n\\n @property\\n def ident_func(self):\\n warnings.warn(\\n \\\"'ident_func' is deprecated and will be removed in Werkzeug\\\"\\n \\\" version 2.1.\\\",\\n DeprecationWarning,\\n stacklevel=2,\\n )\\n return _get_ident\\n\\n @ident_func.setter\\n def ident_func(self, func):\\n warnings.warn(\\n \\\"'ident_func' is deprecated and will be removedin Werkzeug\\\"\\n \\\" version 2.1. Setting it no longer has any effect.\\\",\\n DeprecationWarning,\\n stacklevel=2,\\n )\\n\\n def get_ident(self) -> int:\\n \\\"\\\"\\\"Return the context identifier the local objects use internally for\\n this context. You cannot override this method to change the behavior\\n but use it to link other context local objects (such as SQLAlchemy's\\n scoped sessions) to the Werkzeug locals.\\n\\n .. deprecated:: 2.0.0\\n Will be removed in version 2.1.\\n\\n .. versionchanged:: 0.7\\n You can pass a different ident function to the local manager that\\n will then be propagated to all the locals passed to the\\n constructor.\\n \\\"\\\"\\\"\\n warnings.warn(\\n \\\"'get_ident' is deprecated and will be removed in Werkzeug version 2.1.\\\",\\n DeprecationWarning,\\n stacklevel=2,\\n )\\n return self.ident_func()\\n\\n def cleanup(self):\\n \\\"\\\"\\\"Manually clean up the data in the locals for this context. Call\\n this at the end of the request or use `make_middleware()`.\\n \\\"\\\"\\\"\\n for local in self.locals:\\n release_local(local)\\n\\n def make_middleware(self, app: \\\"WSGIApplication\\\") -> \\\"WSGIApplication\\\":\\n \\\"\\\"\\\"Wrap a WSGI application so that cleaning up happens after\\n request end.\\n \\\"\\\"\\\"\\n\\n def application(environ, start_response):\\n return ClosingIterator(app(environ, start_response), self.cleanup)\\n\\n return application\\n\\n def middleware(self, func: \\\"WSGIApplication\\\") -> \\\"WSGIApplication\\\":\\n \\\"\\\"\\\"Like `make_middleware` but for decorating functions.\\n\\n Example usage::\\n\\n @manager.middleware\\n def application(environ, start_response):\\n ...\\n\\n The difference to `make_middleware` is that the function passed\\n will have all the arguments copied from the inner application\\n (name, docstring, module).\\n \\\"\\\"\\\"\\n return update_wrapper(self.make_middleware(func), func)\\n\\n def __repr__(self) -> str:\\n return f\\\"<{type(self).__name__} storages: {len(self.locals)}>\\\"\\n\\n\\nclass _ProxyLookup:\\n \\\"\\\"\\\"Descriptor that handles proxied attribute lookup for\\n :class:`LocalProxy`.\\n\\n :param f: The built-in function this attribute is accessed through.\\n Instead of looking up the special method, the function call\\n is redone on the object.\\n :param fallback: Call this method if the proxy is unbound instead of\\n raising a :exc:`RuntimeError`.\\n :param class_value: Value to return when accessed from the class.\\n Used for ``__doc__`` so building docs still works.\\n \\\"\\\"\\\"\\n\\n __slots__ = (\\\"bind_f\\\", \\\"fallback\\\", \\\"class_value\\\", \\\"name\\\")\\n\\n def __init__(self, f=None, fallback=None, class_value=None):\\n if hasattr(f, \\\"__get__\\\"):\\n # A Python function, can be turned into a bound method.\\n\\n def bind_f(instance, obj):\\n return f.__get__(obj, type(obj))\\n\\n elif f is not None:\\n # A C function, use partial to bind the first argument.\\n\\n def bind_f(instance, obj):\\n return partial(f, obj)\\n\\n else:\\n # Use getattr, which will produce a bound method.\\n bind_f = None\\n\\n self.bind_f = bind_f\\n self.fallback = fallback\\n self.class_value = class_value\\n\\n def __set_name__(self, owner, name):\\n self.name = name\\n\\n def __get__(self, instance, owner=None):\\n if instance is None:\\n if self.class_value is not None:\\n return self.class_value\\n\\n return self\\n\\n try:\\n obj = instance._get_current_object()\\n except RuntimeError:\\n if self.fallback is None:\\n raise\\n\\n return self.fallback.__get__(instance, owner)\\n\\n if self.bind_f is not None:\\n return self.bind_f(instance, obj)\\n\\n return getattr(obj, self.name)\\n\\n def __repr__(self):\\n return f\\\"proxy {self.name}\\\"\\n\\n def __call__(self, instance, *args, **kwargs):\\n \\\"\\\"\\\"Support calling unbound methods from the class. For example,\\n this happens with ``copy.copy``, which does\\n ``type(x).__copy__(x)``. ``type(x)`` can't be proxied, so it\\n returns the proxy type and descriptor.\\n \\\"\\\"\\\"\\n return self.__get__(instance, type(instance))(*args, **kwargs)\\n\\n\\nclass _ProxyIOp(_ProxyLookup):\\n \\\"\\\"\\\"Look up an augmented assignment method on a proxied object. The\\n method is wrapped to return the proxy instead of the object.\\n \\\"\\\"\\\"\\n\\n __slots__ = ()\\n\\n def __init__(self, f=None, fallback=None):\\n super().__init__(f, fallback)\\n\\n def bind_f(instance, obj):\\n def i_op(self, other):\\n f(self, other)\\n return instance\\n\\n return i_op.__get__(obj, type(obj))\\n\\n self.bind_f = bind_f\\n\\n\\ndef _l_to_r_op(op):\\n \\\"\\\"\\\"Swap the argument order to turn an l-op into an r-op.\\\"\\\"\\\"\\n\\n def r_op(obj, other):\\n return op(other, obj)\\n\\n return r_op\\n\\n\\nclass LocalProxy:\\n \\\"\\\"\\\"A proxy to the object bound to a :class:`Local`. All operations\\n on the proxy are forwarded to the bound object. If no object is\\n bound, a :exc:`RuntimeError` is raised.\\n\\n .. code-block:: python\\n\\n from werkzeug.local import Local\\n l = Local()\\n\\n # a proxy to whatever l.user is set to\\n user = l(\\\"user\\\")\\n\\n from werkzeug.local import LocalStack\\n _request_stack = LocalStack()\\n\\n # a proxy to _request_stack.top\\n request = _request_stack()\\n\\n # a proxy to the session attribute of the request proxy\\n session = LocalProxy(lambda: request.session)\\n\\n ``__repr__`` and ``__class__`` are forwarded, so ``repr(x)`` and\\n ``isinstance(x, cls)`` will look like the proxied object. Use\\n ``issubclass(type(x), LocalProxy)`` to check if an object is a\\n proxy.\\n\\n .. code-block:: python\\n\\n repr(user) # <User admin>\\n isinstance(user, User) # True\\n issubclass(type(user), LocalProxy) # True\\n\\n :param local: The :class:`Local` or callable that provides the\\n proxied object.\\n :param name: The attribute name to look up on a :class:`Local`. Not\\n used if a callable is given.\\n\\n .. versionchanged:: 2.0\\n Updated proxied attributes and methods to reflect the current\\n data model.\\n\\n .. versionchanged:: 0.6.1\\n The class can be instantiated with a callable.\\n \\\"\\\"\\\"\\n\\n __slots__ = (\\\"__local\\\", \\\"__name\\\", \\\"__wrapped__\\\")\\n\\n def __init__(\\n self,\\n local: t.Union[\\\"Local\\\", t.Callable[[], t.Any]],\\n name: t.Optional[str] = None,\\n ) -> None:\\n object.__setattr__(self, \\\"_LocalProxy__local\\\", local)\\n object.__setattr__(self, \\\"_LocalProxy__name\\\", name)\\n\\n if callable(local) and not hasattr(local, \\\"__release_local__\\\"):\\n # \\\"local\\\" is a callable that is not an instance of Local or\\n # LocalManager: mark it as a wrapped function.\\n object.__setattr__(self, \\\"__wrapped__\\\", local)\\n\\n def _get_current_object(self) -> t.Any:\\n \\\"\\\"\\\"Return the current object. This is useful if you want the real\\n object behind the proxy at a time for performance reasons or because\\n you want to pass the object into a different context.\\n \\\"\\\"\\\"\\n if not hasattr(self.__local, \\\"__release_local__\\\"): # type: ignore\\n return self.__local() # type: ignore\\n\\n try:\\n return getattr(self.__local, self.__name) # type: ignore\\n except AttributeError:\\n raise RuntimeError(f\\\"no object bound to {self.__name}\\\") # type: ignore\\n\\n __doc__ = _ProxyLookup( # type: ignore\\n class_value=__doc__, fallback=lambda self: type(self).__doc__\\n )\\n # __del__ should only delete the proxy\\n __repr__ = _ProxyLookup(\\n repr, fallback=lambda self: f\\\"<{type(self).__name__} unbound>\\\"\\n )\\n __str__ = _ProxyLookup(str)\\n __bytes__ = _ProxyLookup(bytes)\\n __format__ = _ProxyLookup() # type: ignore\\n __lt__ = _ProxyLookup(operator.lt)\\n __le__ = _ProxyLookup(operator.le)\\n __eq__ = _ProxyLookup(operator.eq)\\n __ne__ = _ProxyLookup(operator.ne)\\n __gt__ = _ProxyLookup(operator.gt)\\n __ge__ = _ProxyLookup(operator.ge)\\n __hash__ = _ProxyLookup(hash) # type: ignore\\n __bool__ = _ProxyLookup(bool, fallback=lambda self: False)\\n __getattr__ = _ProxyLookup(getattr)\\n # __getattribute__ triggered through __getattr__\\n __setattr__ = _ProxyLookup(setattr)\\n __delattr__ = _ProxyLookup(delattr)\\n __dir__ = _ProxyLookup(dir, fallback=lambda self: []) # type: ignore\\n # __get__ (proxying descriptor not supported)\\n # __set__ (descriptor)\\n # __delete__ (descriptor)\\n # __set_name__ (descriptor)\\n # __objclass__ (descriptor)\\n # __slots__ used by proxy itself\\n # __dict__ (__getattr__)\\n # __weakref__ (__getattr__)\\n # __init_subclass__ (proxying metaclass not supported)\\n # __prepare__ (metaclass)\\n __class__ = _ProxyLookup(fallback=lambda self: type(self)) # type: ignore\\n __instancecheck__ = _ProxyLookup(lambda self, other: isinstance(other, self))\\n __subclasscheck__ = _ProxyLookup(lambda self, other: issubclass(other, self))\\n # __class_getitem__ triggered through __getitem__\\n __call__ = _ProxyLookup(lambda self, *args, **kwargs: self(*args, **kwargs))\\n __len__ = _ProxyLookup(len)\\n __length_hint__ = _ProxyLookup(operator.length_hint)\\n __getitem__ = _ProxyLookup(operator.getitem)\\n __setitem__ = _ProxyLookup(operator.setitem)\\n __delitem__ = _ProxyLookup(operator.delitem)\\n # __missing__ triggered through __getitem__\\n __iter__ = _ProxyLookup(iter)\\n __next__ = _ProxyLookup(next)\\n __reversed__ = _ProxyLookup(reversed)\\n __contains__ = _ProxyLookup(operator.contains)\\n __add__ = _ProxyLookup(operator.add)\\n __sub__ = _ProxyLookup(operator.sub)\\n __mul__ = _ProxyLookup(operator.mul)\\n __matmul__ = _ProxyLookup(operator.matmul)\\n __truediv__ = _ProxyLookup(operator.truediv)\\n __floordiv__ = _ProxyLookup(operator.floordiv)\\n __mod__ = _ProxyLookup(operator.mod)\\n __divmod__ = _ProxyLookup(divmod)\\n __pow__ = _ProxyLookup(pow)\\n __lshift__ = _ProxyLookup(operator.lshift)\\n __rshift__ = _ProxyLookup(operator.rshift)\\n __and__ = _ProxyLookup(operator.and_)\\n __xor__ = _ProxyLookup(operator.xor)\\n __or__ = _ProxyLookup(operator.or_)\\n __radd__ = _ProxyLookup(_l_to_r_op(operator.add))\\n __rsub__ = _ProxyLookup(_l_to_r_op(operator.sub))\\n __rmul__ = _ProxyLookup(_l_to_r_op(operator.mul))\\n __rmatmul__ = _ProxyLookup(_l_to_r_op(operator.matmul))\\n __rtruediv__ = _ProxyLookup(_l_to_r_op(operator.truediv))\\n __rfloordiv__ = _ProxyLookup(_l_to_r_op(operator.floordiv))\\n __rmod__ = _ProxyLookup(_l_to_r_op(operator.mod))\\n __rdivmod__ = _ProxyLookup(_l_to_r_op(divmod))\\n __rpow__ = _ProxyLookup(_l_to_r_op(pow))\\n __rlshift__ = _ProxyLookup(_l_to_r_op(operator.lshift))\\n __rrshift__ = _ProxyLookup(_l_to_r_op(operator.rshift))\\n __rand__ = _ProxyLookup(_l_to_r_op(operator.and_))\\n __rxor__ = _ProxyLookup(_l_to_r_op(operator.xor))\\n __ror__ = _ProxyLookup(_l_to_r_op(operator.or_))\\n __iadd__ = _ProxyIOp(operator.iadd)\\n __isub__ = _ProxyIOp(operator.isub)\\n __imul__ = _ProxyIOp(operator.imul)\\n __imatmul__ = _ProxyIOp(operator.imatmul)\\n __itruediv__ = _ProxyIOp(operator.itruediv)\\n __ifloordiv__ = _ProxyIOp(operator.ifloordiv)\\n __imod__ = _ProxyIOp(operator.imod)\\n __ipow__ = _ProxyIOp(operator.ipow)\\n __ilshift__ = _ProxyIOp(operator.ilshift)\\n __irshift__ = _ProxyIOp(operator.irshift)\\n __iand__ = _ProxyIOp(operator.iand)\\n __ixor__ = _ProxyIOp(operator.ixor)\\n __ior__ = _ProxyIOp(operator.ior)\\n __neg__ = _ProxyLookup(operator.neg)\\n __pos__ = _ProxyLookup(operator.pos)\\n __abs__ = _ProxyLookup(abs)\\n __invert__ = _ProxyLookup(operator.invert)\\n __complex__ = _ProxyLookup(complex)\\n __int__ = _ProxyLookup(int)\\n __float__ = _ProxyLookup(float)\\n __index__ = _ProxyLookup(operator.index)\\n __round__ = _ProxyLookup(round)\\n __trunc__ = _ProxyLookup(math.trunc)\\n __floor__ = _ProxyLookup(math.floor)\\n __ceil__ = _ProxyLookup(math.ceil)\\n __enter__ = _ProxyLookup()\\n __exit__ = _ProxyLookup()\\n __await__ = _ProxyLookup()\\n __aiter__ = _ProxyLookup()\\n __anext__ = _ProxyLookup()\\n __aenter__ = _ProxyLookup()\\n __aexit__ = _ProxyLookup()\\n __copy__ = _ProxyLookup(copy.copy)\\n __deepcopy__ = _ProxyLookup(copy.deepcopy)\\n # __getnewargs_ex__ (pickle through proxy not supported)\\n # __getnewargs__ (pickle)\\n # __getstate__ (pickle)\\n # __setstate__ (pickle)\\n # __reduce__ (pickle)\\n # __reduce_ex__ (pickle)\\n\",\n \"path\": \"src/werkzeug/local.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/src/werkzeug/local.py b/src/werkzeug/local.py\nindex 9e9fdd615..e1773a838 100644\n--- a/src/werkzeug/local.py\n+++ b/src/werkzeug/local.py\n@@ -219,10 +219,9 @@ def _lookup():\n \n def push(self, obj: t.Any) -> t.List[t.Any]:\n \"\"\"Pushes a new item to the stack\"\"\"\n- rv = getattr(self._local, \"stack\", None)\n- if rv is None:\n- self._local.stack = rv = []\n+ rv = getattr(self._local, \"stack\", []).copy()\n rv.append(obj)\n+ self._local.stack = rv\n return rv\n \n def pop(self) -> t.Any:\ndiff --git a/tests/test_local.py b/tests/test_local.py\nindex d5c68e66c..537fc32fb 100644\n--- a/tests/test_local.py\n+++ b/tests/test_local.py\n@@ -106,6 +106,23 @@ def test_local_stack():\n assert repr(proxy) == \"<LocalProxy unbound>\"\n \n \n+@pytest.mark.skipif(\n+ sys.version_info < (3, 7),\n+ reason=\"Locals are not task local in Python 3.6\",\n+)\n+def test_local_stack_asyncio():\n+ ls = local.LocalStack()\n+ ls.push(1)\n+\n+ async def task():\n+ ls.push(1)\n+ assert len(ls._local.stack) == 2\n+\n+ loop = asyncio.get_event_loop()\n+ futures = [asyncio.ensure_future(task()) for _ in range(3)]\n+ loop.run_until_complete(asyncio.gather(*futures))\n+\n+\n @pytest.mark.skipif(\n sys.version_info > (3, 6),\n reason=\"The ident is not supported in Python3.7 or higher\",\n"}}},{"rowIdx":5485,"cells":{"in_source_id":{"kind":"string","value":"zulip__zulip-20148"},"issue":{"kind":"string","value":"Clear `prefers_web_public_view` cookie when logging in or registering an account\nIn #19902, we added functionality to remember who had accessed Zulip as a spectator and immediately take them to the spectator experience. We probably want to clear the `prefers_web_public_view` cookie when logging in via `do_login` or registering a new account, since the user likely doesn't want to get the spectator experience on future visits to the site.\n"},"before_files":{"kind":"list like","value":[{"content":"import logging\nimport secrets\nfrom typing import List, Optional, Tuple\n\nfrom django.conf import settings\nfrom django.http import HttpRequest, HttpResponse\nfrom django.shortcuts import redirect, render\nfrom django.utils.cache import patch_cache_control\n\nfrom zerver.context_processors import get_valid_realm_from_request\nfrom zerver.decorator import web_public_view, zulip_login_required, zulip_redirect_to_login\nfrom zerver.forms import ToSForm\nfrom zerver.lib.actions import do_change_tos_version, realm_user_count\nfrom zerver.lib.compatibility import is_outdated_desktop_app, is_unsupported_browser\nfrom zerver.lib.home import build_page_params_for_home_page_load, get_user_permission_info\nfrom zerver.lib.request import RequestNotes\nfrom zerver.lib.streams import access_stream_by_name\nfrom zerver.lib.subdomains import get_subdomain\nfrom zerver.lib.utils import statsd\nfrom zerver.models import PreregistrationUser, Realm, Stream, UserProfile\nfrom zerver.views.auth import get_safe_redirect_to\nfrom zerver.views.portico import hello_view\n\n\ndef need_accept_tos(user_profile: Optional[UserProfile]) -> bool:\n if user_profile is None:\n return False\n\n if settings.TERMS_OF_SERVICE is None: # nocoverage\n return False\n\n if settings.TOS_VERSION is None:\n return False\n\n return int(settings.TOS_VERSION.split(\".\")[0]) > user_profile.major_tos_version()\n\n\n@zulip_login_required\ndef accounts_accept_terms(request: HttpRequest) -> HttpResponse:\n assert request.user.is_authenticated\n\n if request.method == \"POST\":\n form = ToSForm(request.POST)\n if form.is_valid():\n do_change_tos_version(request.user, settings.TOS_VERSION)\n return redirect(home)\n else:\n form = ToSForm()\n\n email = request.user.delivery_email\n special_message_template = None\n if request.user.tos_version is None and settings.FIRST_TIME_TOS_TEMPLATE is not None:\n special_message_template = \"zerver/\" + settings.FIRST_TIME_TOS_TEMPLATE\n return render(\n request,\n \"zerver/accounts_accept_terms.html\",\n context={\n \"form\": form,\n \"email\": email,\n \"special_message_template\": special_message_template,\n },\n )\n\n\ndef detect_narrowed_window(\n request: HttpRequest, user_profile: Optional[UserProfile]\n) -> Tuple[List[List[str]], Optional[Stream], Optional[str]]:\n \"\"\"This function implements Zulip's support for a mini Zulip window\n that just handles messages from a single narrow\"\"\"\n if user_profile is None:\n return [], None, None\n\n narrow: List[List[str]] = []\n narrow_stream = None\n narrow_topic = request.GET.get(\"topic\")\n\n if request.GET.get(\"stream\"):\n try:\n # TODO: We should support stream IDs and PMs here as well.\n narrow_stream_name = request.GET.get(\"stream\")\n (narrow_stream, ignored_sub) = access_stream_by_name(user_profile, narrow_stream_name)\n narrow = [[\"stream\", narrow_stream.name]]\n except Exception:\n logging.warning(\"Invalid narrow requested, ignoring\", extra=dict(request=request))\n if narrow_stream is not None and narrow_topic is not None:\n narrow.append([\"topic\", narrow_topic])\n return narrow, narrow_stream, narrow_topic\n\n\ndef update_last_reminder(user_profile: Optional[UserProfile]) -> None:\n \"\"\"Reset our don't-spam-users-with-email counter since the\n user has since logged in\n \"\"\"\n if user_profile is None:\n return\n\n if user_profile.last_reminder is not None: # nocoverage\n # TODO: Look into the history of last_reminder; we may have\n # eliminated that as a useful concept for non-bot users.\n user_profile.last_reminder = None\n user_profile.save(update_fields=[\"last_reminder\"])\n\n\ndef home(request: HttpRequest) -> HttpResponse:\n if not settings.ROOT_DOMAIN_LANDING_PAGE:\n return home_real(request)\n\n # If settings.ROOT_DOMAIN_LANDING_PAGE, sends the user the landing\n # page, not the login form, on the root domain\n\n subdomain = get_subdomain(request)\n if subdomain != Realm.SUBDOMAIN_FOR_ROOT_DOMAIN:\n return home_real(request)\n\n return hello_view(request)\n\n\n@web_public_view\ndef home_real(request: HttpRequest) -> HttpResponse:\n # Before we do any real work, check if the app is banned.\n client_user_agent = request.META.get(\"HTTP_USER_AGENT\", \"\")\n (insecure_desktop_app, banned_desktop_app, auto_update_broken) = is_outdated_desktop_app(\n client_user_agent\n )\n if banned_desktop_app:\n return render(\n request,\n \"zerver/insecure_desktop_app.html\",\n context={\n \"auto_update_broken\": auto_update_broken,\n },\n )\n (unsupported_browser, browser_name) = is_unsupported_browser(client_user_agent)\n if unsupported_browser:\n return render(\n request,\n \"zerver/unsupported_browser.html\",\n context={\n \"browser_name\": browser_name,\n },\n )\n\n # We need to modify the session object every two weeks or it will expire.\n # This line makes reloading the page a sufficient action to keep the\n # session alive.\n request.session.modified = True\n\n if request.user.is_authenticated:\n user_profile = request.user\n realm = user_profile.realm\n else:\n realm = get_valid_realm_from_request(request)\n\n # TODO: Ideally, we'd open Zulip directly as a spectator if\n # the URL had clicked a link to content on a web-public\n # stream. We could maybe do this by parsing `next`, but it's\n # not super convenient with Zulip's hash-based URL scheme.\n\n # The \"Access without an account\" button on the login page\n # submits a POST to this page with this hidden field set.\n if request.POST.get(\"prefers_web_public_view\") == \"true\":\n request.session[\"prefers_web_public_view\"] = True\n # We serve a redirect here, rather than serving a page, to\n # avoid browser \"Confirm form resubmission\" prompts on reload.\n redirect_to = get_safe_redirect_to(request.POST.get(\"next\"), realm.uri)\n return redirect(redirect_to)\n\n prefers_web_public_view = request.session.get(\"prefers_web_public_view\")\n if not prefers_web_public_view:\n # For users who haven't opted into the spectator\n # experience, we redirect to the login page.\n return zulip_redirect_to_login(request, settings.HOME_NOT_LOGGED_IN)\n\n # For users who have selected public access, we load the\n # spectator experience. We fall through to the shared code\n # for loading the application, with user_profile=None encoding\n # that we're a spectator, not a logged-in user.\n user_profile = None\n\n update_last_reminder(user_profile)\n\n statsd.incr(\"views.home\")\n\n # If a user hasn't signed the current Terms of Service, send them there\n if need_accept_tos(user_profile):\n return accounts_accept_terms(request)\n\n narrow, narrow_stream, narrow_topic = detect_narrowed_window(request, user_profile)\n\n if user_profile is not None:\n first_in_realm = realm_user_count(user_profile.realm) == 1\n # If you are the only person in the realm and you didn't invite\n # anyone, we'll continue to encourage you to do so on the frontend.\n prompt_for_invites = (\n first_in_realm\n and not PreregistrationUser.objects.filter(referred_by=user_profile).count()\n )\n needs_tutorial = user_profile.tutorial_status == UserProfile.TUTORIAL_WAITING\n\n else:\n first_in_realm = False\n prompt_for_invites = False\n # The current tutorial doesn't super make sense for logged-out users.\n needs_tutorial = False\n\n queue_id, page_params = build_page_params_for_home_page_load(\n request=request,\n user_profile=user_profile,\n realm=realm,\n insecure_desktop_app=insecure_desktop_app,\n narrow=narrow,\n narrow_stream=narrow_stream,\n narrow_topic=narrow_topic,\n first_in_realm=first_in_realm,\n prompt_for_invites=prompt_for_invites,\n needs_tutorial=needs_tutorial,\n )\n\n log_data = RequestNotes.get_notes(request).log_data\n assert log_data is not None\n log_data[\"extra\"] = f\"[{queue_id}]\"\n\n csp_nonce = secrets.token_hex(24)\n\n user_permission_info = get_user_permission_info(user_profile)\n\n response = render(\n request,\n \"zerver/app/index.html\",\n context={\n \"user_profile\": user_profile,\n \"page_params\": page_params,\n \"csp_nonce\": csp_nonce,\n \"color_scheme\": user_permission_info.color_scheme,\n },\n )\n patch_cache_control(response, no_cache=True, no_store=True, must_revalidate=True)\n return response\n\n\n@zulip_login_required\ndef desktop_home(request: HttpRequest) -> HttpResponse:\n return redirect(home)\n","path":"zerver/views/home.py"}],"string":"[\n {\n \"content\": \"import logging\\nimport secrets\\nfrom typing import List, Optional, Tuple\\n\\nfrom django.conf import settings\\nfrom django.http import HttpRequest, HttpResponse\\nfrom django.shortcuts import redirect, render\\nfrom django.utils.cache import patch_cache_control\\n\\nfrom zerver.context_processors import get_valid_realm_from_request\\nfrom zerver.decorator import web_public_view, zulip_login_required, zulip_redirect_to_login\\nfrom zerver.forms import ToSForm\\nfrom zerver.lib.actions import do_change_tos_version, realm_user_count\\nfrom zerver.lib.compatibility import is_outdated_desktop_app, is_unsupported_browser\\nfrom zerver.lib.home import build_page_params_for_home_page_load, get_user_permission_info\\nfrom zerver.lib.request import RequestNotes\\nfrom zerver.lib.streams import access_stream_by_name\\nfrom zerver.lib.subdomains import get_subdomain\\nfrom zerver.lib.utils import statsd\\nfrom zerver.models import PreregistrationUser, Realm, Stream, UserProfile\\nfrom zerver.views.auth import get_safe_redirect_to\\nfrom zerver.views.portico import hello_view\\n\\n\\ndef need_accept_tos(user_profile: Optional[UserProfile]) -> bool:\\n if user_profile is None:\\n return False\\n\\n if settings.TERMS_OF_SERVICE is None: # nocoverage\\n return False\\n\\n if settings.TOS_VERSION is None:\\n return False\\n\\n return int(settings.TOS_VERSION.split(\\\".\\\")[0]) > user_profile.major_tos_version()\\n\\n\\n@zulip_login_required\\ndef accounts_accept_terms(request: HttpRequest) -> HttpResponse:\\n assert request.user.is_authenticated\\n\\n if request.method == \\\"POST\\\":\\n form = ToSForm(request.POST)\\n if form.is_valid():\\n do_change_tos_version(request.user, settings.TOS_VERSION)\\n return redirect(home)\\n else:\\n form = ToSForm()\\n\\n email = request.user.delivery_email\\n special_message_template = None\\n if request.user.tos_version is None and settings.FIRST_TIME_TOS_TEMPLATE is not None:\\n special_message_template = \\\"zerver/\\\" + settings.FIRST_TIME_TOS_TEMPLATE\\n return render(\\n request,\\n \\\"zerver/accounts_accept_terms.html\\\",\\n context={\\n \\\"form\\\": form,\\n \\\"email\\\": email,\\n \\\"special_message_template\\\": special_message_template,\\n },\\n )\\n\\n\\ndef detect_narrowed_window(\\n request: HttpRequest, user_profile: Optional[UserProfile]\\n) -> Tuple[List[List[str]], Optional[Stream], Optional[str]]:\\n \\\"\\\"\\\"This function implements Zulip's support for a mini Zulip window\\n that just handles messages from a single narrow\\\"\\\"\\\"\\n if user_profile is None:\\n return [], None, None\\n\\n narrow: List[List[str]] = []\\n narrow_stream = None\\n narrow_topic = request.GET.get(\\\"topic\\\")\\n\\n if request.GET.get(\\\"stream\\\"):\\n try:\\n # TODO: We should support stream IDs and PMs here as well.\\n narrow_stream_name = request.GET.get(\\\"stream\\\")\\n (narrow_stream, ignored_sub) = access_stream_by_name(user_profile, narrow_stream_name)\\n narrow = [[\\\"stream\\\", narrow_stream.name]]\\n except Exception:\\n logging.warning(\\\"Invalid narrow requested, ignoring\\\", extra=dict(request=request))\\n if narrow_stream is not None and narrow_topic is not None:\\n narrow.append([\\\"topic\\\", narrow_topic])\\n return narrow, narrow_stream, narrow_topic\\n\\n\\ndef update_last_reminder(user_profile: Optional[UserProfile]) -> None:\\n \\\"\\\"\\\"Reset our don't-spam-users-with-email counter since the\\n user has since logged in\\n \\\"\\\"\\\"\\n if user_profile is None:\\n return\\n\\n if user_profile.last_reminder is not None: # nocoverage\\n # TODO: Look into the history of last_reminder; we may have\\n # eliminated that as a useful concept for non-bot users.\\n user_profile.last_reminder = None\\n user_profile.save(update_fields=[\\\"last_reminder\\\"])\\n\\n\\ndef home(request: HttpRequest) -> HttpResponse:\\n if not settings.ROOT_DOMAIN_LANDING_PAGE:\\n return home_real(request)\\n\\n # If settings.ROOT_DOMAIN_LANDING_PAGE, sends the user the landing\\n # page, not the login form, on the root domain\\n\\n subdomain = get_subdomain(request)\\n if subdomain != Realm.SUBDOMAIN_FOR_ROOT_DOMAIN:\\n return home_real(request)\\n\\n return hello_view(request)\\n\\n\\n@web_public_view\\ndef home_real(request: HttpRequest) -> HttpResponse:\\n # Before we do any real work, check if the app is banned.\\n client_user_agent = request.META.get(\\\"HTTP_USER_AGENT\\\", \\\"\\\")\\n (insecure_desktop_app, banned_desktop_app, auto_update_broken) = is_outdated_desktop_app(\\n client_user_agent\\n )\\n if banned_desktop_app:\\n return render(\\n request,\\n \\\"zerver/insecure_desktop_app.html\\\",\\n context={\\n \\\"auto_update_broken\\\": auto_update_broken,\\n },\\n )\\n (unsupported_browser, browser_name) = is_unsupported_browser(client_user_agent)\\n if unsupported_browser:\\n return render(\\n request,\\n \\\"zerver/unsupported_browser.html\\\",\\n context={\\n \\\"browser_name\\\": browser_name,\\n },\\n )\\n\\n # We need to modify the session object every two weeks or it will expire.\\n # This line makes reloading the page a sufficient action to keep the\\n # session alive.\\n request.session.modified = True\\n\\n if request.user.is_authenticated:\\n user_profile = request.user\\n realm = user_profile.realm\\n else:\\n realm = get_valid_realm_from_request(request)\\n\\n # TODO: Ideally, we'd open Zulip directly as a spectator if\\n # the URL had clicked a link to content on a web-public\\n # stream. We could maybe do this by parsing `next`, but it's\\n # not super convenient with Zulip's hash-based URL scheme.\\n\\n # The \\\"Access without an account\\\" button on the login page\\n # submits a POST to this page with this hidden field set.\\n if request.POST.get(\\\"prefers_web_public_view\\\") == \\\"true\\\":\\n request.session[\\\"prefers_web_public_view\\\"] = True\\n # We serve a redirect here, rather than serving a page, to\\n # avoid browser \\\"Confirm form resubmission\\\" prompts on reload.\\n redirect_to = get_safe_redirect_to(request.POST.get(\\\"next\\\"), realm.uri)\\n return redirect(redirect_to)\\n\\n prefers_web_public_view = request.session.get(\\\"prefers_web_public_view\\\")\\n if not prefers_web_public_view:\\n # For users who haven't opted into the spectator\\n # experience, we redirect to the login page.\\n return zulip_redirect_to_login(request, settings.HOME_NOT_LOGGED_IN)\\n\\n # For users who have selected public access, we load the\\n # spectator experience. We fall through to the shared code\\n # for loading the application, with user_profile=None encoding\\n # that we're a spectator, not a logged-in user.\\n user_profile = None\\n\\n update_last_reminder(user_profile)\\n\\n statsd.incr(\\\"views.home\\\")\\n\\n # If a user hasn't signed the current Terms of Service, send them there\\n if need_accept_tos(user_profile):\\n return accounts_accept_terms(request)\\n\\n narrow, narrow_stream, narrow_topic = detect_narrowed_window(request, user_profile)\\n\\n if user_profile is not None:\\n first_in_realm = realm_user_count(user_profile.realm) == 1\\n # If you are the only person in the realm and you didn't invite\\n # anyone, we'll continue to encourage you to do so on the frontend.\\n prompt_for_invites = (\\n first_in_realm\\n and not PreregistrationUser.objects.filter(referred_by=user_profile).count()\\n )\\n needs_tutorial = user_profile.tutorial_status == UserProfile.TUTORIAL_WAITING\\n\\n else:\\n first_in_realm = False\\n prompt_for_invites = False\\n # The current tutorial doesn't super make sense for logged-out users.\\n needs_tutorial = False\\n\\n queue_id, page_params = build_page_params_for_home_page_load(\\n request=request,\\n user_profile=user_profile,\\n realm=realm,\\n insecure_desktop_app=insecure_desktop_app,\\n narrow=narrow,\\n narrow_stream=narrow_stream,\\n narrow_topic=narrow_topic,\\n first_in_realm=first_in_realm,\\n prompt_for_invites=prompt_for_invites,\\n needs_tutorial=needs_tutorial,\\n )\\n\\n log_data = RequestNotes.get_notes(request).log_data\\n assert log_data is not None\\n log_data[\\\"extra\\\"] = f\\\"[{queue_id}]\\\"\\n\\n csp_nonce = secrets.token_hex(24)\\n\\n user_permission_info = get_user_permission_info(user_profile)\\n\\n response = render(\\n request,\\n \\\"zerver/app/index.html\\\",\\n context={\\n \\\"user_profile\\\": user_profile,\\n \\\"page_params\\\": page_params,\\n \\\"csp_nonce\\\": csp_nonce,\\n \\\"color_scheme\\\": user_permission_info.color_scheme,\\n },\\n )\\n patch_cache_control(response, no_cache=True, no_store=True, must_revalidate=True)\\n return response\\n\\n\\n@zulip_login_required\\ndef desktop_home(request: HttpRequest) -> HttpResponse:\\n return redirect(home)\\n\",\n \"path\": \"zerver/views/home.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"import logging\nimport secrets\nfrom typing import List, Optional, Tuple\n\nfrom django.conf import settings\nfrom django.http import HttpRequest, HttpResponse\nfrom django.shortcuts import redirect, render\nfrom django.utils.cache import patch_cache_control\n\nfrom zerver.context_processors import get_valid_realm_from_request\nfrom zerver.decorator import web_public_view, zulip_login_required, zulip_redirect_to_login\nfrom zerver.forms import ToSForm\nfrom zerver.lib.actions import do_change_tos_version, realm_user_count\nfrom zerver.lib.compatibility import is_outdated_desktop_app, is_unsupported_browser\nfrom zerver.lib.home import build_page_params_for_home_page_load, get_user_permission_info\nfrom zerver.lib.request import RequestNotes\nfrom zerver.lib.streams import access_stream_by_name\nfrom zerver.lib.subdomains import get_subdomain\nfrom zerver.lib.utils import statsd\nfrom zerver.models import PreregistrationUser, Realm, Stream, UserProfile\nfrom zerver.views.auth import get_safe_redirect_to\nfrom zerver.views.portico import hello_view\n\n\ndef need_accept_tos(user_profile: Optional[UserProfile]) -> bool:\n if user_profile is None:\n return False\n\n if settings.TERMS_OF_SERVICE is None: # nocoverage\n return False\n\n if settings.TOS_VERSION is None:\n return False\n\n return int(settings.TOS_VERSION.split(\".\")[0]) > user_profile.major_tos_version()\n\n\n@zulip_login_required\ndef accounts_accept_terms(request: HttpRequest) -> HttpResponse:\n assert request.user.is_authenticated\n\n if request.method == \"POST\":\n form = ToSForm(request.POST)\n if form.is_valid():\n do_change_tos_version(request.user, settings.TOS_VERSION)\n return redirect(home)\n else:\n form = ToSForm()\n\n email = request.user.delivery_email\n special_message_template = None\n if request.user.tos_version is None and settings.FIRST_TIME_TOS_TEMPLATE is not None:\n special_message_template = \"zerver/\" + settings.FIRST_TIME_TOS_TEMPLATE\n return render(\n request,\n \"zerver/accounts_accept_terms.html\",\n context={\n \"form\": form,\n \"email\": email,\n \"special_message_template\": special_message_template,\n },\n )\n\n\ndef detect_narrowed_window(\n request: HttpRequest, user_profile: Optional[UserProfile]\n) -> Tuple[List[List[str]], Optional[Stream], Optional[str]]:\n \"\"\"This function implements Zulip's support for a mini Zulip window\n that just handles messages from a single narrow\"\"\"\n if user_profile is None:\n return [], None, None\n\n narrow: List[List[str]] = []\n narrow_stream = None\n narrow_topic = request.GET.get(\"topic\")\n\n if request.GET.get(\"stream\"):\n try:\n # TODO: We should support stream IDs and PMs here as well.\n narrow_stream_name = request.GET.get(\"stream\")\n (narrow_stream, ignored_sub) = access_stream_by_name(user_profile, narrow_stream_name)\n narrow = [[\"stream\", narrow_stream.name]]\n except Exception:\n logging.warning(\"Invalid narrow requested, ignoring\", extra=dict(request=request))\n if narrow_stream is not None and narrow_topic is not None:\n narrow.append([\"topic\", narrow_topic])\n return narrow, narrow_stream, narrow_topic\n\n\ndef update_last_reminder(user_profile: Optional[UserProfile]) -> None:\n \"\"\"Reset our don't-spam-users-with-email counter since the\n user has since logged in\n \"\"\"\n if user_profile is None:\n return\n\n if user_profile.last_reminder is not None: # nocoverage\n # TODO: Look into the history of last_reminder; we may have\n # eliminated that as a useful concept for non-bot users.\n user_profile.last_reminder = None\n user_profile.save(update_fields=[\"last_reminder\"])\n\n\ndef home(request: HttpRequest) -> HttpResponse:\n if not settings.ROOT_DOMAIN_LANDING_PAGE:\n return home_real(request)\n\n # If settings.ROOT_DOMAIN_LANDING_PAGE, sends the user the landing\n # page, not the login form, on the root domain\n\n subdomain = get_subdomain(request)\n if subdomain != Realm.SUBDOMAIN_FOR_ROOT_DOMAIN:\n return home_real(request)\n\n return hello_view(request)\n\n\n@web_public_view\ndef home_real(request: HttpRequest) -> HttpResponse:\n # Before we do any real work, check if the app is banned.\n client_user_agent = request.META.get(\"HTTP_USER_AGENT\", \"\")\n (insecure_desktop_app, banned_desktop_app, auto_update_broken) = is_outdated_desktop_app(\n client_user_agent\n )\n if banned_desktop_app:\n return render(\n request,\n \"zerver/insecure_desktop_app.html\",\n context={\n \"auto_update_broken\": auto_update_broken,\n },\n )\n (unsupported_browser, browser_name) = is_unsupported_browser(client_user_agent)\n if unsupported_browser:\n return render(\n request,\n \"zerver/unsupported_browser.html\",\n context={\n \"browser_name\": browser_name,\n },\n )\n\n # We need to modify the session object every two weeks or it will expire.\n # This line makes reloading the page a sufficient action to keep the\n # session alive.\n request.session.modified = True\n\n if request.user.is_authenticated:\n user_profile = request.user\n realm = user_profile.realm\n\n # User is logged in and hence no longer `prefers_web_public_view`.\n if \"prefers_web_public_view\" in request.session.keys():\n del request.session[\"prefers_web_public_view\"]\n else:\n realm = get_valid_realm_from_request(request)\n\n # TODO: Ideally, we'd open Zulip directly as a spectator if\n # the URL had clicked a link to content on a web-public\n # stream. We could maybe do this by parsing `next`, but it's\n # not super convenient with Zulip's hash-based URL scheme.\n\n # The \"Access without an account\" button on the login page\n # submits a POST to this page with this hidden field set.\n if request.POST.get(\"prefers_web_public_view\") == \"true\":\n request.session[\"prefers_web_public_view\"] = True\n # We serve a redirect here, rather than serving a page, to\n # avoid browser \"Confirm form resubmission\" prompts on reload.\n redirect_to = get_safe_redirect_to(request.POST.get(\"next\"), realm.uri)\n return redirect(redirect_to)\n\n prefers_web_public_view = request.session.get(\"prefers_web_public_view\")\n if not prefers_web_public_view:\n # For users who haven't opted into the spectator\n # experience, we redirect to the login page.\n return zulip_redirect_to_login(request, settings.HOME_NOT_LOGGED_IN)\n\n # For users who have selected public access, we load the\n # spectator experience. We fall through to the shared code\n # for loading the application, with user_profile=None encoding\n # that we're a spectator, not a logged-in user.\n user_profile = None\n\n update_last_reminder(user_profile)\n\n statsd.incr(\"views.home\")\n\n # If a user hasn't signed the current Terms of Service, send them there\n if need_accept_tos(user_profile):\n return accounts_accept_terms(request)\n\n narrow, narrow_stream, narrow_topic = detect_narrowed_window(request, user_profile)\n\n if user_profile is not None:\n first_in_realm = realm_user_count(user_profile.realm) == 1\n # If you are the only person in the realm and you didn't invite\n # anyone, we'll continue to encourage you to do so on the frontend.\n prompt_for_invites = (\n first_in_realm\n and not PreregistrationUser.objects.filter(referred_by=user_profile).count()\n )\n needs_tutorial = user_profile.tutorial_status == UserProfile.TUTORIAL_WAITING\n\n else:\n first_in_realm = False\n prompt_for_invites = False\n # The current tutorial doesn't super make sense for logged-out users.\n needs_tutorial = False\n\n queue_id, page_params = build_page_params_for_home_page_load(\n request=request,\n user_profile=user_profile,\n realm=realm,\n insecure_desktop_app=insecure_desktop_app,\n narrow=narrow,\n narrow_stream=narrow_stream,\n narrow_topic=narrow_topic,\n first_in_realm=first_in_realm,\n prompt_for_invites=prompt_for_invites,\n needs_tutorial=needs_tutorial,\n )\n\n log_data = RequestNotes.get_notes(request).log_data\n assert log_data is not None\n log_data[\"extra\"] = f\"[{queue_id}]\"\n\n csp_nonce = secrets.token_hex(24)\n\n user_permission_info = get_user_permission_info(user_profile)\n\n response = render(\n request,\n \"zerver/app/index.html\",\n context={\n \"user_profile\": user_profile,\n \"page_params\": page_params,\n \"csp_nonce\": csp_nonce,\n \"color_scheme\": user_permission_info.color_scheme,\n },\n )\n patch_cache_control(response, no_cache=True, no_store=True, must_revalidate=True)\n return response\n\n\n@zulip_login_required\ndef desktop_home(request: HttpRequest) -> HttpResponse:\n return redirect(home)\n","path":"zerver/views/home.py"}],"string":"[\n {\n \"content\": \"import logging\\nimport secrets\\nfrom typing import List, Optional, Tuple\\n\\nfrom django.conf import settings\\nfrom django.http import HttpRequest, HttpResponse\\nfrom django.shortcuts import redirect, render\\nfrom django.utils.cache import patch_cache_control\\n\\nfrom zerver.context_processors import get_valid_realm_from_request\\nfrom zerver.decorator import web_public_view, zulip_login_required, zulip_redirect_to_login\\nfrom zerver.forms import ToSForm\\nfrom zerver.lib.actions import do_change_tos_version, realm_user_count\\nfrom zerver.lib.compatibility import is_outdated_desktop_app, is_unsupported_browser\\nfrom zerver.lib.home import build_page_params_for_home_page_load, get_user_permission_info\\nfrom zerver.lib.request import RequestNotes\\nfrom zerver.lib.streams import access_stream_by_name\\nfrom zerver.lib.subdomains import get_subdomain\\nfrom zerver.lib.utils import statsd\\nfrom zerver.models import PreregistrationUser, Realm, Stream, UserProfile\\nfrom zerver.views.auth import get_safe_redirect_to\\nfrom zerver.views.portico import hello_view\\n\\n\\ndef need_accept_tos(user_profile: Optional[UserProfile]) -> bool:\\n if user_profile is None:\\n return False\\n\\n if settings.TERMS_OF_SERVICE is None: # nocoverage\\n return False\\n\\n if settings.TOS_VERSION is None:\\n return False\\n\\n return int(settings.TOS_VERSION.split(\\\".\\\")[0]) > user_profile.major_tos_version()\\n\\n\\n@zulip_login_required\\ndef accounts_accept_terms(request: HttpRequest) -> HttpResponse:\\n assert request.user.is_authenticated\\n\\n if request.method == \\\"POST\\\":\\n form = ToSForm(request.POST)\\n if form.is_valid():\\n do_change_tos_version(request.user, settings.TOS_VERSION)\\n return redirect(home)\\n else:\\n form = ToSForm()\\n\\n email = request.user.delivery_email\\n special_message_template = None\\n if request.user.tos_version is None and settings.FIRST_TIME_TOS_TEMPLATE is not None:\\n special_message_template = \\\"zerver/\\\" + settings.FIRST_TIME_TOS_TEMPLATE\\n return render(\\n request,\\n \\\"zerver/accounts_accept_terms.html\\\",\\n context={\\n \\\"form\\\": form,\\n \\\"email\\\": email,\\n \\\"special_message_template\\\": special_message_template,\\n },\\n )\\n\\n\\ndef detect_narrowed_window(\\n request: HttpRequest, user_profile: Optional[UserProfile]\\n) -> Tuple[List[List[str]], Optional[Stream], Optional[str]]:\\n \\\"\\\"\\\"This function implements Zulip's support for a mini Zulip window\\n that just handles messages from a single narrow\\\"\\\"\\\"\\n if user_profile is None:\\n return [], None, None\\n\\n narrow: List[List[str]] = []\\n narrow_stream = None\\n narrow_topic = request.GET.get(\\\"topic\\\")\\n\\n if request.GET.get(\\\"stream\\\"):\\n try:\\n # TODO: We should support stream IDs and PMs here as well.\\n narrow_stream_name = request.GET.get(\\\"stream\\\")\\n (narrow_stream, ignored_sub) = access_stream_by_name(user_profile, narrow_stream_name)\\n narrow = [[\\\"stream\\\", narrow_stream.name]]\\n except Exception:\\n logging.warning(\\\"Invalid narrow requested, ignoring\\\", extra=dict(request=request))\\n if narrow_stream is not None and narrow_topic is not None:\\n narrow.append([\\\"topic\\\", narrow_topic])\\n return narrow, narrow_stream, narrow_topic\\n\\n\\ndef update_last_reminder(user_profile: Optional[UserProfile]) -> None:\\n \\\"\\\"\\\"Reset our don't-spam-users-with-email counter since the\\n user has since logged in\\n \\\"\\\"\\\"\\n if user_profile is None:\\n return\\n\\n if user_profile.last_reminder is not None: # nocoverage\\n # TODO: Look into the history of last_reminder; we may have\\n # eliminated that as a useful concept for non-bot users.\\n user_profile.last_reminder = None\\n user_profile.save(update_fields=[\\\"last_reminder\\\"])\\n\\n\\ndef home(request: HttpRequest) -> HttpResponse:\\n if not settings.ROOT_DOMAIN_LANDING_PAGE:\\n return home_real(request)\\n\\n # If settings.ROOT_DOMAIN_LANDING_PAGE, sends the user the landing\\n # page, not the login form, on the root domain\\n\\n subdomain = get_subdomain(request)\\n if subdomain != Realm.SUBDOMAIN_FOR_ROOT_DOMAIN:\\n return home_real(request)\\n\\n return hello_view(request)\\n\\n\\n@web_public_view\\ndef home_real(request: HttpRequest) -> HttpResponse:\\n # Before we do any real work, check if the app is banned.\\n client_user_agent = request.META.get(\\\"HTTP_USER_AGENT\\\", \\\"\\\")\\n (insecure_desktop_app, banned_desktop_app, auto_update_broken) = is_outdated_desktop_app(\\n client_user_agent\\n )\\n if banned_desktop_app:\\n return render(\\n request,\\n \\\"zerver/insecure_desktop_app.html\\\",\\n context={\\n \\\"auto_update_broken\\\": auto_update_broken,\\n },\\n )\\n (unsupported_browser, browser_name) = is_unsupported_browser(client_user_agent)\\n if unsupported_browser:\\n return render(\\n request,\\n \\\"zerver/unsupported_browser.html\\\",\\n context={\\n \\\"browser_name\\\": browser_name,\\n },\\n )\\n\\n # We need to modify the session object every two weeks or it will expire.\\n # This line makes reloading the page a sufficient action to keep the\\n # session alive.\\n request.session.modified = True\\n\\n if request.user.is_authenticated:\\n user_profile = request.user\\n realm = user_profile.realm\\n\\n # User is logged in and hence no longer `prefers_web_public_view`.\\n if \\\"prefers_web_public_view\\\" in request.session.keys():\\n del request.session[\\\"prefers_web_public_view\\\"]\\n else:\\n realm = get_valid_realm_from_request(request)\\n\\n # TODO: Ideally, we'd open Zulip directly as a spectator if\\n # the URL had clicked a link to content on a web-public\\n # stream. We could maybe do this by parsing `next`, but it's\\n # not super convenient with Zulip's hash-based URL scheme.\\n\\n # The \\\"Access without an account\\\" button on the login page\\n # submits a POST to this page with this hidden field set.\\n if request.POST.get(\\\"prefers_web_public_view\\\") == \\\"true\\\":\\n request.session[\\\"prefers_web_public_view\\\"] = True\\n # We serve a redirect here, rather than serving a page, to\\n # avoid browser \\\"Confirm form resubmission\\\" prompts on reload.\\n redirect_to = get_safe_redirect_to(request.POST.get(\\\"next\\\"), realm.uri)\\n return redirect(redirect_to)\\n\\n prefers_web_public_view = request.session.get(\\\"prefers_web_public_view\\\")\\n if not prefers_web_public_view:\\n # For users who haven't opted into the spectator\\n # experience, we redirect to the login page.\\n return zulip_redirect_to_login(request, settings.HOME_NOT_LOGGED_IN)\\n\\n # For users who have selected public access, we load the\\n # spectator experience. We fall through to the shared code\\n # for loading the application, with user_profile=None encoding\\n # that we're a spectator, not a logged-in user.\\n user_profile = None\\n\\n update_last_reminder(user_profile)\\n\\n statsd.incr(\\\"views.home\\\")\\n\\n # If a user hasn't signed the current Terms of Service, send them there\\n if need_accept_tos(user_profile):\\n return accounts_accept_terms(request)\\n\\n narrow, narrow_stream, narrow_topic = detect_narrowed_window(request, user_profile)\\n\\n if user_profile is not None:\\n first_in_realm = realm_user_count(user_profile.realm) == 1\\n # If you are the only person in the realm and you didn't invite\\n # anyone, we'll continue to encourage you to do so on the frontend.\\n prompt_for_invites = (\\n first_in_realm\\n and not PreregistrationUser.objects.filter(referred_by=user_profile).count()\\n )\\n needs_tutorial = user_profile.tutorial_status == UserProfile.TUTORIAL_WAITING\\n\\n else:\\n first_in_realm = False\\n prompt_for_invites = False\\n # The current tutorial doesn't super make sense for logged-out users.\\n needs_tutorial = False\\n\\n queue_id, page_params = build_page_params_for_home_page_load(\\n request=request,\\n user_profile=user_profile,\\n realm=realm,\\n insecure_desktop_app=insecure_desktop_app,\\n narrow=narrow,\\n narrow_stream=narrow_stream,\\n narrow_topic=narrow_topic,\\n first_in_realm=first_in_realm,\\n prompt_for_invites=prompt_for_invites,\\n needs_tutorial=needs_tutorial,\\n )\\n\\n log_data = RequestNotes.get_notes(request).log_data\\n assert log_data is not None\\n log_data[\\\"extra\\\"] = f\\\"[{queue_id}]\\\"\\n\\n csp_nonce = secrets.token_hex(24)\\n\\n user_permission_info = get_user_permission_info(user_profile)\\n\\n response = render(\\n request,\\n \\\"zerver/app/index.html\\\",\\n context={\\n \\\"user_profile\\\": user_profile,\\n \\\"page_params\\\": page_params,\\n \\\"csp_nonce\\\": csp_nonce,\\n \\\"color_scheme\\\": user_permission_info.color_scheme,\\n },\\n )\\n patch_cache_control(response, no_cache=True, no_store=True, must_revalidate=True)\\n return response\\n\\n\\n@zulip_login_required\\ndef desktop_home(request: HttpRequest) -> HttpResponse:\\n return redirect(home)\\n\",\n \"path\": \"zerver/views/home.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/zerver/tests/test_home.py b/zerver/tests/test_home.py\nindex 7b74a8ba7f38f..c346468ff3799 100644\n--- a/zerver/tests/test_home.py\n+++ b/zerver/tests/test_home.py\n@@ -330,6 +330,12 @@ def test_logged_out_home(self) -> None:\n ]\n expected_keys = [i for i in self.expected_page_params_keys if i not in removed_keys]\n self.assertEqual(actual_keys, expected_keys)\n+ self.assertEqual(self.client.session.get(\"prefers_web_public_view\"), True)\n+\n+ # Web public session key should clear once user is logged in\n+ self.login(\"hamlet\")\n+ self.client_get(\"/\")\n+ self.assertEqual(self.client.session.get(\"prefers_web_public_view\"), None)\n \n def test_home_under_2fa_without_otp_device(self) -> None:\n with self.settings(TWO_FACTOR_AUTHENTICATION_ENABLED=True):\ndiff --git a/zerver/views/home.py b/zerver/views/home.py\nindex 9a9d4dcb4eb20..802e2c5c4c8e9 100644\n--- a/zerver/views/home.py\n+++ b/zerver/views/home.py\n@@ -148,6 +148,10 @@ def home_real(request: HttpRequest) -> HttpResponse:\n if request.user.is_authenticated:\n user_profile = request.user\n realm = user_profile.realm\n+\n+ # User is logged in and hence no longer `prefers_web_public_view`.\n+ if \"prefers_web_public_view\" in request.session.keys():\n+ del request.session[\"prefers_web_public_view\"]\n else:\n realm = get_valid_realm_from_request(request)\n \n"}}},{"rowIdx":5486,"cells":{"in_source_id":{"kind":"string","value":"rasterio__rasterio-618"},"issue":{"kind":"string","value":"YCbCr JPEG-in-TIFF breaks rio-info\nOne creates a YCbCr JPEG-in-TIFF with GDAL using `photometric=YCbCr` and `compress=JPEG` options. But reading the TIFFs tags to get the compression method returns \"YCbCr JPEG\", a value that's not in `rasterio.enums.Compression`.\n\nReference: http://www.gdal.org/frmt_gtiff.html\n\nSolution: normalize \"YCbCr JPEG\" to \"JPEG\" and add source color space to rio-info's output.\n\n"},"before_files":{"kind":"list like","value":[{"content":"\nfrom enum import Enum, IntEnum\n\n\nclass ColorInterp(IntEnum):\n undefined=0\n grey=1\n gray=1\n palette=2\n red=3\n green=4\n blue=5\n alpha=6\n hue=7\n saturation=8\n lightness=9\n cyan=10\n magenta=11\n yellow=12\n black=13\n\n\nclass Resampling(Enum):\n nearest='NEAREST'\n gauss='GAUSS'\n cubic='CUBIC'\n average='AVERAGE'\n mode='MODE'\n average_magphase='AVERAGE_MAGPHASE'\n none='NONE'\n\n\nclass Compression(Enum):\n jpeg='JPEG'\n lzw='LZW'\n packbits='PACKBITS'\n deflate='DEFLATE'\n ccittrle='CCITTRLE'\n ccittfax3='CCITTFAX3'\n ccittfax4='CCITTFAX4'\n lzma='LZMA'\n none='NONE'\n\n\nclass Interleaving(Enum):\n pixel='PIXEL'\n line='LINE'\n band='BAND'\n\n\nclass MaskFlags(IntEnum):\n all_valid=1\n per_dataset=2\n alpha=4\n nodata=8\n","path":"rasterio/enums.py"}],"string":"[\n {\n \"content\": \"\\nfrom enum import Enum, IntEnum\\n\\n\\nclass ColorInterp(IntEnum):\\n undefined=0\\n grey=1\\n gray=1\\n palette=2\\n red=3\\n green=4\\n blue=5\\n alpha=6\\n hue=7\\n saturation=8\\n lightness=9\\n cyan=10\\n magenta=11\\n yellow=12\\n black=13\\n\\n\\nclass Resampling(Enum):\\n nearest='NEAREST'\\n gauss='GAUSS'\\n cubic='CUBIC'\\n average='AVERAGE'\\n mode='MODE'\\n average_magphase='AVERAGE_MAGPHASE'\\n none='NONE'\\n\\n\\nclass Compression(Enum):\\n jpeg='JPEG'\\n lzw='LZW'\\n packbits='PACKBITS'\\n deflate='DEFLATE'\\n ccittrle='CCITTRLE'\\n ccittfax3='CCITTFAX3'\\n ccittfax4='CCITTFAX4'\\n lzma='LZMA'\\n none='NONE'\\n\\n\\nclass Interleaving(Enum):\\n pixel='PIXEL'\\n line='LINE'\\n band='BAND'\\n\\n\\nclass MaskFlags(IntEnum):\\n all_valid=1\\n per_dataset=2\\n alpha=4\\n nodata=8\\n\",\n \"path\": \"rasterio/enums.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"\nfrom enum import Enum, IntEnum\n\n\nclass ColorInterp(IntEnum):\n undefined=0\n grey=1\n gray=1\n palette=2\n red=3\n green=4\n blue=5\n alpha=6\n hue=7\n saturation=8\n lightness=9\n cyan=10\n magenta=11\n yellow=12\n black=13\n Y=14\n Cb=15\n Cr=16\n\n\nclass Resampling(Enum):\n nearest='NEAREST'\n gauss='GAUSS'\n cubic='CUBIC'\n average='AVERAGE'\n mode='MODE'\n average_magphase='AVERAGE_MAGPHASE'\n none='NONE'\n\n\nclass Compression(Enum):\n jpeg='JPEG'\n lzw='LZW'\n packbits='PACKBITS'\n deflate='DEFLATE'\n ccittrle='CCITTRLE'\n ccittfax3='CCITTFAX3'\n ccittfax4='CCITTFAX4'\n lzma='LZMA'\n none='NONE'\n\n\nclass Interleaving(Enum):\n pixel='PIXEL'\n line='LINE'\n band='BAND'\n\n\nclass MaskFlags(IntEnum):\n all_valid=1\n per_dataset=2\n alpha=4\n nodata=8\n\n\nclass PhotometricInterp(Enum):\n black='MINISBLACK'\n white='MINISWHITE'\n rgb='RGB'\n cmyk='CMYK'\n ycbcr='YCbCr'\n cielab='CIELAB'\n icclab='ICCLAB'\n itulab='ITULAB'\n","path":"rasterio/enums.py"}],"string":"[\n {\n \"content\": \"\\nfrom enum import Enum, IntEnum\\n\\n\\nclass ColorInterp(IntEnum):\\n undefined=0\\n grey=1\\n gray=1\\n palette=2\\n red=3\\n green=4\\n blue=5\\n alpha=6\\n hue=7\\n saturation=8\\n lightness=9\\n cyan=10\\n magenta=11\\n yellow=12\\n black=13\\n Y=14\\n Cb=15\\n Cr=16\\n\\n\\nclass Resampling(Enum):\\n nearest='NEAREST'\\n gauss='GAUSS'\\n cubic='CUBIC'\\n average='AVERAGE'\\n mode='MODE'\\n average_magphase='AVERAGE_MAGPHASE'\\n none='NONE'\\n\\n\\nclass Compression(Enum):\\n jpeg='JPEG'\\n lzw='LZW'\\n packbits='PACKBITS'\\n deflate='DEFLATE'\\n ccittrle='CCITTRLE'\\n ccittfax3='CCITTFAX3'\\n ccittfax4='CCITTFAX4'\\n lzma='LZMA'\\n none='NONE'\\n\\n\\nclass Interleaving(Enum):\\n pixel='PIXEL'\\n line='LINE'\\n band='BAND'\\n\\n\\nclass MaskFlags(IntEnum):\\n all_valid=1\\n per_dataset=2\\n alpha=4\\n nodata=8\\n\\n\\nclass PhotometricInterp(Enum):\\n black='MINISBLACK'\\n white='MINISWHITE'\\n rgb='RGB'\\n cmyk='CMYK'\\n ycbcr='YCbCr'\\n cielab='CIELAB'\\n icclab='ICCLAB'\\n itulab='ITULAB'\\n\",\n \"path\": \"rasterio/enums.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/README.rst b/README.rst\nindex 8cc6fc760..eaac96cf0 100644\n--- a/README.rst\n+++ b/README.rst\n@@ -7,8 +7,8 @@ Rasterio reads and writes geospatial raster datasets.\n .. image:: https://travis-ci.org/mapbox/rasterio.png?branch=master\n :target: https://travis-ci.org/mapbox/rasterio\n \n-.. image:: https://coveralls.io/repos/mapbox/rasterio/badge.png\n- :target: https://coveralls.io/r/mapbox/rasterio\n+.. image:: https://coveralls.io/repos/github/mapbox/rasterio/badge.svg?branch=master\n+ :target: https://coveralls.io/github/mapbox/rasterio?branch=master\n \n Rasterio employs GDAL under the hood for file I/O and raster formatting. Its\n functions typically accept and return Numpy ndarrays. Rasterio is designed to\ndiff --git a/rasterio/_base.pyx b/rasterio/_base.pyx\nindex 32e0ee05c..32e4ff81e 100644\n--- a/rasterio/_base.pyx\n+++ b/rasterio/_base.pyx\n@@ -20,7 +20,8 @@ from rasterio import dtypes\n from rasterio.coords import BoundingBox\n from rasterio.errors import RasterioIOError\n from rasterio.transform import Affine\n-from rasterio.enums import ColorInterp, Compression, Interleaving\n+from rasterio.enums import (\n+ ColorInterp, Compression, Interleaving, PhotometricInterp)\n from rasterio.vfs import parse_path, vsi_path\n \n \n@@ -488,6 +489,8 @@ cdef class DatasetReader(object):\n def compression(self):\n val = self.tags(ns='IMAGE_STRUCTURE').get('COMPRESSION')\n if val:\n+ # 'YCbCr JPEG' will be normalized to 'JPEG'\n+ val = val.split(' ')[-1]\n return Compression(val)\n else:\n return None\n@@ -500,6 +503,14 @@ cdef class DatasetReader(object):\n else:\n return None\n \n+ @property\n+ def photometric(self):\n+ val = self.tags(ns='IMAGE_STRUCTURE').get('SOURCE_COLOR_SPACE')\n+ if val:\n+ return PhotometricInterp(val)\n+ else:\n+ return None\n+\n @property\n def is_tiled(self):\n if len(self.block_shapes) == 0:\n@@ -514,7 +525,8 @@ cdef class DatasetReader(object):\n \"\"\"\n def __get__(self):\n m = self.meta\n- m.update(self.tags(ns='rio_creation_kwds'))\n+ m.update((k, v.lower()) for k, v in self.tags(\n+ ns='rio_creation_kwds').items())\n if self.is_tiled:\n m.update(\n blockxsize=self.block_shapes[0][1],\n@@ -526,6 +538,8 @@ cdef class DatasetReader(object):\n m['compress'] = self.compression.name\n if self.interleaving:\n m['interleave'] = self.interleaving.name\n+ if self.photometric:\n+ m['photometric'] = self.photometric.name\n return m\n \n def lnglat(self):\ndiff --git a/rasterio/enums.py b/rasterio/enums.py\nindex 68563ee51..f62ffaa13 100644\n--- a/rasterio/enums.py\n+++ b/rasterio/enums.py\n@@ -18,6 +18,9 @@ class ColorInterp(IntEnum):\n magenta=11\n yellow=12\n black=13\n+ Y=14\n+ Cb=15\n+ Cr=16\n \n \n class Resampling(Enum):\n@@ -53,3 +56,14 @@ class MaskFlags(IntEnum):\n per_dataset=2\n alpha=4\n nodata=8\n+\n+\n+class PhotometricInterp(Enum):\n+ black='MINISBLACK'\n+ white='MINISWHITE'\n+ rgb='RGB'\n+ cmyk='CMYK'\n+ ycbcr='YCbCr'\n+ cielab='CIELAB'\n+ icclab='ICCLAB'\n+ itulab='ITULAB'\ndiff --git a/tests/test_colorinterp.py b/tests/test_colorinterp.py\nindex d05e8a245..84d843fe4 100644\n--- a/tests/test_colorinterp.py\n+++ b/tests/test_colorinterp.py\n@@ -1,25 +1,52 @@\n+import pytest\n \n import rasterio\n-from rasterio.enums import ColorInterp\n+from rasterio.enums import ColorInterp, PhotometricInterp\n \n \n-def test_colorinterp(tmpdir):\n- \n+def test_cmyk_interp(tmpdir):\n+ \"\"\"A CMYK TIFF has cyan, magenta, yellow, black bands.\"\"\"\n with rasterio.drivers():\n-\n with rasterio.open('tests/data/RGB.byte.tif') as src:\n- assert src.colorinterp(1) == ColorInterp.red\n- assert src.colorinterp(2) == ColorInterp.green\n- assert src.colorinterp(3) == ColorInterp.blue\n- \n- tiffname = str(tmpdir.join('foo.tif'))\n- \n- meta = src.meta\n+ meta = src.meta\n meta['photometric'] = 'CMYK'\n meta['count'] = 4\n+ tiffname = str(tmpdir.join('foo.tif'))\n with rasterio.open(tiffname, 'w', **meta) as dst:\n+ assert dst.profile['photometric'] == 'cmyk'\n assert dst.colorinterp(1) == ColorInterp.cyan\n assert dst.colorinterp(2) == ColorInterp.magenta\n assert dst.colorinterp(3) == ColorInterp.yellow\n assert dst.colorinterp(4) == ColorInterp.black\n \n+\n+def test_ycbcr_interp(tmpdir):\n+ \"\"\"A YCbCr TIFF has red, green, blue bands.\"\"\"\n+ with rasterio.drivers():\n+ with rasterio.open('tests/data/RGB.byte.tif') as src:\n+ meta = src.meta\n+ meta['photometric'] = 'ycbcr'\n+ meta['compress'] = 'jpeg'\n+ meta['count'] = 3\n+ tiffname = str(tmpdir.join('foo.tif'))\n+ with rasterio.open(tiffname, 'w', **meta) as dst:\n+ assert dst.colorinterp(1) == ColorInterp.red\n+ assert dst.colorinterp(2) == ColorInterp.green\n+ assert dst.colorinterp(3) == ColorInterp.blue\n+\n+\n+@pytest.mark.xfail()\n+def test_ycbcr_no_convert(tmpdir):\n+ \"\"\"An unconverted YCbCr TIFF has Y, Cb, Cr bands.\"\"\"\n+ with rasterio.drivers(GDAL_JPEG_TO_RGB=False):\n+ with rasterio.open('tests/data/RGB.byte.tif') as src:\n+ meta = src.meta\n+ meta['photometric'] = 'ycbcr'\n+ meta['compress'] = 'jpeg'\n+ meta['count'] = 3\n+ tiffname = str(tmpdir.join('foo.tif'))\n+ with rasterio.open(tiffname, 'w', **meta) as dst:\n+ assert dst.profile['photometric'] == 'ycbcr'\n+ assert dst.colorinterp(1) == ColorInterp.Y\n+ assert dst.colorinterp(2) == ColorInterp.Cb\n+ assert dst.colorinterp(3) == ColorInterp.Cr\n"}}},{"rowIdx":5487,"cells":{"in_source_id":{"kind":"string","value":"internetarchive__openlibrary-9322"},"issue":{"kind":"string","value":"add a failing author name test\n<!-- What issue does this PR close? -->\r\nDemonstrates a bug in #9003\r\n\r\n<!-- What does this PR achieve? [feature|hotfix|fix|refactor] -->\r\n\r\n`Drini` -> `ini`\r\n\r\n**Expected:**\r\n`Drini` -> `Drini`\r\n\r\n😉 \r\n\r\n### Technical\r\n<!-- What should be noted about the implementation? -->\r\n\r\n### Testing\r\n<!-- Steps for reviewer to reproduce/verify what this PR does/fixes. -->\r\n\r\n### Screenshot\r\n<!-- If this PR touches UI, please post evidence (screenshots) of it behaving correctly. -->\r\n\r\n### Stakeholders\r\n<!-- @ tag the lead (as labeled on the issue) and other stakeholders -->\r\n@cdrini \r\n@scottbarnes \r\n\r\n<!-- Attribution Disclaimer: By proposing this pull request, I affirm to have made a best-effort and exercised my discretion to make sure relevant sections of this code which substantially leverage code suggestions, code generation, or code snippets from sources (e.g. Stack Overflow, GitHub) have been annotated with basic attribution so reviewers & contributors may have confidence and access to the correct context to evaluate and use this code. -->\r\n\n"},"before_files":{"kind":"list like","value":[{"content":"from typing import TYPE_CHECKING, Any, Final\nimport web\nfrom openlibrary.catalog.utils import flip_name, author_dates_match, key_int\nfrom openlibrary.core.helpers import extract_year\n\n\nif TYPE_CHECKING:\n from openlibrary.plugins.upstream.models import Author\n\n\n# Sort by descending length to remove the _longest_ match.\n# E.g. remove \"señorita\" and not \"señor\", when both match.\nHONORIFICS: Final = sorted(\n [\n 'countess',\n 'doctor',\n 'doktor',\n 'dr',\n 'dr.',\n 'frau',\n 'fräulein',\n 'herr',\n 'lady',\n 'lord',\n 'm.',\n 'madame',\n 'mademoiselle',\n 'miss',\n 'mister',\n 'mistress',\n 'mixter',\n 'mlle',\n 'mlle.',\n 'mme',\n 'mme.',\n 'monsieur',\n 'mr',\n 'mr.',\n 'mrs',\n 'mrs.',\n 'ms',\n 'ms.',\n 'mx',\n 'mx.',\n 'professor',\n 'señor',\n 'señora',\n 'señorita',\n 'sir',\n 'sr.',\n 'sra.',\n 'srta.',\n ],\n key=lambda x: len(x),\n reverse=True,\n)\n\nHONORIFC_NAME_EXECPTIONS = frozenset(\n {\n \"dr. seuss\",\n \"dr seuss\",\n \"dr oetker\",\n \"doctor oetker\",\n }\n)\n\n\ndef east_in_by_statement(rec, author):\n \"\"\"\n Returns False if there is no by_statement in rec.\n Otherwise returns whether author name uses eastern name order.\n TODO: elaborate on what this actually means, and how it is used.\n\n :param dict rec: import source edition record\n :param dict author: import source author dict: {\"name\": \"Some One\"}\n :rtype: bool\n \"\"\"\n\n if 'by_statement' not in rec:\n return False\n if 'authors' not in rec:\n return False\n name = author['name']\n flipped = flip_name(name)\n name = name.replace('.', '')\n name = name.replace(', ', '')\n if name == flipped.replace('.', ''):\n # name was not flipped\n return False\n return rec['by_statement'].find(name) != -1\n\n\ndef do_flip(author):\n \"\"\"\n Given an author import dict, flip its name in place\n i.e. Smith, John => John Smith\n\n :param dict author:\n :rtype: None\n \"\"\"\n if 'personal_name' in author and author['personal_name'] != author['name']:\n # Don't flip names if name is more complex than personal_name (legacy behaviour)\n return\n first_comma = author['name'].find(', ')\n if first_comma == -1:\n return\n # e.g: Harper, John Murdoch, 1845-\n if author['name'].find(',', first_comma + 1) != -1:\n return\n if author['name'].find('i.e.') != -1:\n return\n if author['name'].find('i. e.') != -1:\n return\n name = flip_name(author['name'])\n author['name'] = name\n if 'personal_name' in author:\n author['personal_name'] = name\n\n\ndef pick_from_matches(author, match):\n \"\"\"\n Finds the best match for author from a list of OL authors records, match.\n\n :param dict author: Author import representation\n :param list match: List of matching OL author records\n :rtype: dict\n :return: A single OL author record from match\n \"\"\"\n maybe = []\n if 'birth_date' in author and 'death_date' in author:\n maybe = [m for m in match if 'birth_date' in m and 'death_date' in m]\n elif 'date' in author:\n maybe = [m for m in match if 'date' in m]\n if not maybe:\n maybe = match\n if len(maybe) == 1:\n return maybe[0]\n return min(maybe, key=key_int)\n\n\ndef find_author(author: dict[str, Any]) -> list[\"Author\"]:\n \"\"\"\n Searches OL for an author by name.\n\n :param str name: Author's name\n :rtype: list\n :return: A list of OL author representations than match name\n \"\"\"\n\n def walk_redirects(obj, seen):\n seen.add(obj['key'])\n while obj['type']['key'] == '/type/redirect':\n assert obj['location'] != obj['key']\n obj = web.ctx.site.get(obj['location'])\n seen.add(obj['key'])\n return obj\n\n # Try for an 'exact' (case-insensitive) name match, but fall back to alternate_names,\n # then last name with identical birth and death dates (that are not themselves `None` or '').\n name = author[\"name\"].replace(\"*\", r\"\\*\")\n queries = [\n {\"type\": \"/type/author\", \"name~\": name},\n {\"type\": \"/type/author\", \"alternate_names~\": name},\n {\n \"type\": \"/type/author\",\n \"name~\": f\"* {name.split()[-1]}\",\n \"birth_date~\": f\"*{extract_year(author.get('birth_date', '')) or -1}*\",\n \"death_date~\": f\"*{extract_year(author.get('death_date', '')) or -1}*\",\n }, # Use `-1` to ensure an empty string from extract_year doesn't match empty dates.\n ]\n for query in queries:\n if reply := list(web.ctx.site.things(query)):\n break\n\n authors = [web.ctx.site.get(k) for k in reply]\n if any(a.type.key != '/type/author' for a in authors):\n seen: set[dict] = set()\n authors = [walk_redirects(a, seen) for a in authors if a['key'] not in seen]\n return authors\n\n\ndef find_entity(author: dict[str, Any]) -> \"Author | None\":\n \"\"\"\n Looks for an existing Author record in OL by name\n and returns it if found.\n\n :param dict author: Author import dict {\"name\": \"Some One\"}\n :return: Existing Author record if found, or None.\n \"\"\"\n name = author['name']\n things = find_author(author)\n et = author.get('entity_type')\n if et and et != 'person':\n if not things:\n return None\n db_entity = things[0]\n assert db_entity['type']['key'] == '/type/author'\n return db_entity\n if ', ' in name:\n flipped_name = flip_name(author[\"name\"])\n author_flipped_name = author.copy()\n things += find_author(author_flipped_name)\n match = []\n seen = set()\n for a in things:\n key = a['key']\n if key in seen:\n continue\n seen.add(key)\n orig_key = key\n assert a.type.key == '/type/author'\n if 'birth_date' in author and 'birth_date' not in a:\n continue\n if 'birth_date' not in author and 'birth_date' in a:\n continue\n if not author_dates_match(author, a):\n continue\n match.append(a)\n if not match:\n return None\n if len(match) == 1:\n return match[0]\n return pick_from_matches(author, match)\n\n\ndef remove_author_honorifics(name: str) -> str:\n \"\"\"\n Remove honorifics from an author's name field.\n\n If the author's name is only an honorific, it will return the original name.\n \"\"\"\n if name.casefold() in HONORIFC_NAME_EXECPTIONS:\n return name\n\n if honorific := next(\n (\n honorific\n for honorific in HONORIFICS\n if name.casefold().startswith(honorific)\n ),\n None,\n ):\n return name[len(honorific) :].lstrip() or name\n\n return name\n\n\ndef import_author(author: dict[str, Any], eastern=False) -> \"Author | dict[str, Any]\":\n \"\"\"\n Converts an import style new-author dictionary into an\n Open Library existing author, or new author candidate, representation.\n Does NOT create new authors.\n\n :param dict author: Author import record {\"name\": \"Some One\"}\n :param bool eastern: Eastern name order\n :return: Open Library style Author representation, either existing with \"key\",\n or new candidate without \"key\".\n \"\"\"\n if existing := find_entity(author):\n assert existing.type.key == '/type/author'\n for k in 'last_modified', 'id', 'revision', 'created':\n if existing.k:\n del existing.k\n new = existing\n if 'death_date' in author and 'death_date' not in existing:\n new['death_date'] = author['death_date']\n return new\n if author.get('entity_type') != 'org' and not eastern:\n do_flip(author)\n a = {'type': {'key': '/type/author'}}\n for f in 'name', 'title', 'personal_name', 'birth_date', 'death_date', 'date':\n if f in author:\n a[f] = author[f]\n return a\n\n\nclass InvalidLanguage(Exception):\n def __init__(self, code):\n self.code = code\n\n def __str__(self):\n return \"invalid language code: '%s'\" % self.code\n\n\ntype_map = {'description': 'text', 'notes': 'text', 'number_of_pages': 'int'}\n\n\ndef build_query(rec):\n \"\"\"\n Takes an edition record dict, rec, and returns an Open Library edition\n suitable for saving.\n\n :param dict rec: Edition record to add to Open Library\n :rtype: dict\n :return: Open Library style edition representation\n \"\"\"\n book = {\n 'type': {'key': '/type/edition'},\n }\n\n for k, v in rec.items():\n if k == 'authors':\n if v and v[0]:\n book['authors'] = []\n for author in v:\n author['name'] = remove_author_honorifics(author['name'])\n east = east_in_by_statement(rec, author)\n book['authors'].append(import_author(author, eastern=east))\n continue\n if k in ('languages', 'translated_from'):\n for language in v:\n if web.ctx.site.get('/languages/' + language) is None:\n raise InvalidLanguage(language)\n book[k] = [{'key': '/languages/' + language} for language in v]\n continue\n if k in type_map:\n t = '/type/' + type_map[k]\n if isinstance(v, list):\n book[k] = [{'type': t, 'value': i} for i in v]\n else:\n book[k] = {'type': t, 'value': v}\n else:\n book[k] = v\n return book\n","path":"openlibrary/catalog/add_book/load_book.py"}],"string":"[\n {\n \"content\": \"from typing import TYPE_CHECKING, Any, Final\\nimport web\\nfrom openlibrary.catalog.utils import flip_name, author_dates_match, key_int\\nfrom openlibrary.core.helpers import extract_year\\n\\n\\nif TYPE_CHECKING:\\n from openlibrary.plugins.upstream.models import Author\\n\\n\\n# Sort by descending length to remove the _longest_ match.\\n# E.g. remove \\\"señorita\\\" and not \\\"señor\\\", when both match.\\nHONORIFICS: Final = sorted(\\n [\\n 'countess',\\n 'doctor',\\n 'doktor',\\n 'dr',\\n 'dr.',\\n 'frau',\\n 'fräulein',\\n 'herr',\\n 'lady',\\n 'lord',\\n 'm.',\\n 'madame',\\n 'mademoiselle',\\n 'miss',\\n 'mister',\\n 'mistress',\\n 'mixter',\\n 'mlle',\\n 'mlle.',\\n 'mme',\\n 'mme.',\\n 'monsieur',\\n 'mr',\\n 'mr.',\\n 'mrs',\\n 'mrs.',\\n 'ms',\\n 'ms.',\\n 'mx',\\n 'mx.',\\n 'professor',\\n 'señor',\\n 'señora',\\n 'señorita',\\n 'sir',\\n 'sr.',\\n 'sra.',\\n 'srta.',\\n ],\\n key=lambda x: len(x),\\n reverse=True,\\n)\\n\\nHONORIFC_NAME_EXECPTIONS = frozenset(\\n {\\n \\\"dr. seuss\\\",\\n \\\"dr seuss\\\",\\n \\\"dr oetker\\\",\\n \\\"doctor oetker\\\",\\n }\\n)\\n\\n\\ndef east_in_by_statement(rec, author):\\n \\\"\\\"\\\"\\n Returns False if there is no by_statement in rec.\\n Otherwise returns whether author name uses eastern name order.\\n TODO: elaborate on what this actually means, and how it is used.\\n\\n :param dict rec: import source edition record\\n :param dict author: import source author dict: {\\\"name\\\": \\\"Some One\\\"}\\n :rtype: bool\\n \\\"\\\"\\\"\\n\\n if 'by_statement' not in rec:\\n return False\\n if 'authors' not in rec:\\n return False\\n name = author['name']\\n flipped = flip_name(name)\\n name = name.replace('.', '')\\n name = name.replace(', ', '')\\n if name == flipped.replace('.', ''):\\n # name was not flipped\\n return False\\n return rec['by_statement'].find(name) != -1\\n\\n\\ndef do_flip(author):\\n \\\"\\\"\\\"\\n Given an author import dict, flip its name in place\\n i.e. Smith, John => John Smith\\n\\n :param dict author:\\n :rtype: None\\n \\\"\\\"\\\"\\n if 'personal_name' in author and author['personal_name'] != author['name']:\\n # Don't flip names if name is more complex than personal_name (legacy behaviour)\\n return\\n first_comma = author['name'].find(', ')\\n if first_comma == -1:\\n return\\n # e.g: Harper, John Murdoch, 1845-\\n if author['name'].find(',', first_comma + 1) != -1:\\n return\\n if author['name'].find('i.e.') != -1:\\n return\\n if author['name'].find('i. e.') != -1:\\n return\\n name = flip_name(author['name'])\\n author['name'] = name\\n if 'personal_name' in author:\\n author['personal_name'] = name\\n\\n\\ndef pick_from_matches(author, match):\\n \\\"\\\"\\\"\\n Finds the best match for author from a list of OL authors records, match.\\n\\n :param dict author: Author import representation\\n :param list match: List of matching OL author records\\n :rtype: dict\\n :return: A single OL author record from match\\n \\\"\\\"\\\"\\n maybe = []\\n if 'birth_date' in author and 'death_date' in author:\\n maybe = [m for m in match if 'birth_date' in m and 'death_date' in m]\\n elif 'date' in author:\\n maybe = [m for m in match if 'date' in m]\\n if not maybe:\\n maybe = match\\n if len(maybe) == 1:\\n return maybe[0]\\n return min(maybe, key=key_int)\\n\\n\\ndef find_author(author: dict[str, Any]) -> list[\\\"Author\\\"]:\\n \\\"\\\"\\\"\\n Searches OL for an author by name.\\n\\n :param str name: Author's name\\n :rtype: list\\n :return: A list of OL author representations than match name\\n \\\"\\\"\\\"\\n\\n def walk_redirects(obj, seen):\\n seen.add(obj['key'])\\n while obj['type']['key'] == '/type/redirect':\\n assert obj['location'] != obj['key']\\n obj = web.ctx.site.get(obj['location'])\\n seen.add(obj['key'])\\n return obj\\n\\n # Try for an 'exact' (case-insensitive) name match, but fall back to alternate_names,\\n # then last name with identical birth and death dates (that are not themselves `None` or '').\\n name = author[\\\"name\\\"].replace(\\\"*\\\", r\\\"\\\\*\\\")\\n queries = [\\n {\\\"type\\\": \\\"/type/author\\\", \\\"name~\\\": name},\\n {\\\"type\\\": \\\"/type/author\\\", \\\"alternate_names~\\\": name},\\n {\\n \\\"type\\\": \\\"/type/author\\\",\\n \\\"name~\\\": f\\\"* {name.split()[-1]}\\\",\\n \\\"birth_date~\\\": f\\\"*{extract_year(author.get('birth_date', '')) or -1}*\\\",\\n \\\"death_date~\\\": f\\\"*{extract_year(author.get('death_date', '')) or -1}*\\\",\\n }, # Use `-1` to ensure an empty string from extract_year doesn't match empty dates.\\n ]\\n for query in queries:\\n if reply := list(web.ctx.site.things(query)):\\n break\\n\\n authors = [web.ctx.site.get(k) for k in reply]\\n if any(a.type.key != '/type/author' for a in authors):\\n seen: set[dict] = set()\\n authors = [walk_redirects(a, seen) for a in authors if a['key'] not in seen]\\n return authors\\n\\n\\ndef find_entity(author: dict[str, Any]) -> \\\"Author | None\\\":\\n \\\"\\\"\\\"\\n Looks for an existing Author record in OL by name\\n and returns it if found.\\n\\n :param dict author: Author import dict {\\\"name\\\": \\\"Some One\\\"}\\n :return: Existing Author record if found, or None.\\n \\\"\\\"\\\"\\n name = author['name']\\n things = find_author(author)\\n et = author.get('entity_type')\\n if et and et != 'person':\\n if not things:\\n return None\\n db_entity = things[0]\\n assert db_entity['type']['key'] == '/type/author'\\n return db_entity\\n if ', ' in name:\\n flipped_name = flip_name(author[\\\"name\\\"])\\n author_flipped_name = author.copy()\\n things += find_author(author_flipped_name)\\n match = []\\n seen = set()\\n for a in things:\\n key = a['key']\\n if key in seen:\\n continue\\n seen.add(key)\\n orig_key = key\\n assert a.type.key == '/type/author'\\n if 'birth_date' in author and 'birth_date' not in a:\\n continue\\n if 'birth_date' not in author and 'birth_date' in a:\\n continue\\n if not author_dates_match(author, a):\\n continue\\n match.append(a)\\n if not match:\\n return None\\n if len(match) == 1:\\n return match[0]\\n return pick_from_matches(author, match)\\n\\n\\ndef remove_author_honorifics(name: str) -> str:\\n \\\"\\\"\\\"\\n Remove honorifics from an author's name field.\\n\\n If the author's name is only an honorific, it will return the original name.\\n \\\"\\\"\\\"\\n if name.casefold() in HONORIFC_NAME_EXECPTIONS:\\n return name\\n\\n if honorific := next(\\n (\\n honorific\\n for honorific in HONORIFICS\\n if name.casefold().startswith(honorific)\\n ),\\n None,\\n ):\\n return name[len(honorific) :].lstrip() or name\\n\\n return name\\n\\n\\ndef import_author(author: dict[str, Any], eastern=False) -> \\\"Author | dict[str, Any]\\\":\\n \\\"\\\"\\\"\\n Converts an import style new-author dictionary into an\\n Open Library existing author, or new author candidate, representation.\\n Does NOT create new authors.\\n\\n :param dict author: Author import record {\\\"name\\\": \\\"Some One\\\"}\\n :param bool eastern: Eastern name order\\n :return: Open Library style Author representation, either existing with \\\"key\\\",\\n or new candidate without \\\"key\\\".\\n \\\"\\\"\\\"\\n if existing := find_entity(author):\\n assert existing.type.key == '/type/author'\\n for k in 'last_modified', 'id', 'revision', 'created':\\n if existing.k:\\n del existing.k\\n new = existing\\n if 'death_date' in author and 'death_date' not in existing:\\n new['death_date'] = author['death_date']\\n return new\\n if author.get('entity_type') != 'org' and not eastern:\\n do_flip(author)\\n a = {'type': {'key': '/type/author'}}\\n for f in 'name', 'title', 'personal_name', 'birth_date', 'death_date', 'date':\\n if f in author:\\n a[f] = author[f]\\n return a\\n\\n\\nclass InvalidLanguage(Exception):\\n def __init__(self, code):\\n self.code = code\\n\\n def __str__(self):\\n return \\\"invalid language code: '%s'\\\" % self.code\\n\\n\\ntype_map = {'description': 'text', 'notes': 'text', 'number_of_pages': 'int'}\\n\\n\\ndef build_query(rec):\\n \\\"\\\"\\\"\\n Takes an edition record dict, rec, and returns an Open Library edition\\n suitable for saving.\\n\\n :param dict rec: Edition record to add to Open Library\\n :rtype: dict\\n :return: Open Library style edition representation\\n \\\"\\\"\\\"\\n book = {\\n 'type': {'key': '/type/edition'},\\n }\\n\\n for k, v in rec.items():\\n if k == 'authors':\\n if v and v[0]:\\n book['authors'] = []\\n for author in v:\\n author['name'] = remove_author_honorifics(author['name'])\\n east = east_in_by_statement(rec, author)\\n book['authors'].append(import_author(author, eastern=east))\\n continue\\n if k in ('languages', 'translated_from'):\\n for language in v:\\n if web.ctx.site.get('/languages/' + language) is None:\\n raise InvalidLanguage(language)\\n book[k] = [{'key': '/languages/' + language} for language in v]\\n continue\\n if k in type_map:\\n t = '/type/' + type_map[k]\\n if isinstance(v, list):\\n book[k] = [{'type': t, 'value': i} for i in v]\\n else:\\n book[k] = {'type': t, 'value': v}\\n else:\\n book[k] = v\\n return book\\n\",\n \"path\": \"openlibrary/catalog/add_book/load_book.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"from typing import TYPE_CHECKING, Any, Final\nimport web\nfrom openlibrary.catalog.utils import flip_name, author_dates_match, key_int\nfrom openlibrary.core.helpers import extract_year\n\n\nif TYPE_CHECKING:\n from openlibrary.plugins.upstream.models import Author\n\n\n# Sort by descending length to remove the _longest_ match.\n# E.g. remove \"señorita\" and not \"señor\", when both match.\nHONORIFICS: Final = sorted(\n [\n 'countess',\n 'doctor',\n 'doktor',\n 'dr',\n 'dr.',\n 'frau',\n 'fräulein',\n 'herr',\n 'lady',\n 'lord',\n 'm.',\n 'madame',\n 'mademoiselle',\n 'miss',\n 'mister',\n 'mistress',\n 'mixter',\n 'mlle',\n 'mlle.',\n 'mme',\n 'mme.',\n 'monsieur',\n 'mr',\n 'mr.',\n 'mrs',\n 'mrs.',\n 'ms',\n 'ms.',\n 'mx',\n 'mx.',\n 'professor',\n 'señor',\n 'señora',\n 'señorita',\n 'sir',\n 'sr.',\n 'sra.',\n 'srta.',\n ],\n key=lambda x: len(x),\n reverse=True,\n)\n\nHONORIFC_NAME_EXECPTIONS = frozenset(\n {\n \"dr. seuss\",\n \"dr seuss\",\n \"dr oetker\",\n \"doctor oetker\",\n }\n)\n\n\ndef east_in_by_statement(rec, author):\n \"\"\"\n Returns False if there is no by_statement in rec.\n Otherwise returns whether author name uses eastern name order.\n TODO: elaborate on what this actually means, and how it is used.\n\n :param dict rec: import source edition record\n :param dict author: import source author dict: {\"name\": \"Some One\"}\n :rtype: bool\n \"\"\"\n\n if 'by_statement' not in rec:\n return False\n if 'authors' not in rec:\n return False\n name = author['name']\n flipped = flip_name(name)\n name = name.replace('.', '')\n name = name.replace(', ', '')\n if name == flipped.replace('.', ''):\n # name was not flipped\n return False\n return rec['by_statement'].find(name) != -1\n\n\ndef do_flip(author):\n \"\"\"\n Given an author import dict, flip its name in place\n i.e. Smith, John => John Smith\n\n :param dict author:\n :rtype: None\n \"\"\"\n if 'personal_name' in author and author['personal_name'] != author['name']:\n # Don't flip names if name is more complex than personal_name (legacy behaviour)\n return\n first_comma = author['name'].find(', ')\n if first_comma == -1:\n return\n # e.g: Harper, John Murdoch, 1845-\n if author['name'].find(',', first_comma + 1) != -1:\n return\n if author['name'].find('i.e.') != -1:\n return\n if author['name'].find('i. e.') != -1:\n return\n name = flip_name(author['name'])\n author['name'] = name\n if 'personal_name' in author:\n author['personal_name'] = name\n\n\ndef pick_from_matches(author, match):\n \"\"\"\n Finds the best match for author from a list of OL authors records, match.\n\n :param dict author: Author import representation\n :param list match: List of matching OL author records\n :rtype: dict\n :return: A single OL author record from match\n \"\"\"\n maybe = []\n if 'birth_date' in author and 'death_date' in author:\n maybe = [m for m in match if 'birth_date' in m and 'death_date' in m]\n elif 'date' in author:\n maybe = [m for m in match if 'date' in m]\n if not maybe:\n maybe = match\n if len(maybe) == 1:\n return maybe[0]\n return min(maybe, key=key_int)\n\n\ndef find_author(author: dict[str, Any]) -> list[\"Author\"]:\n \"\"\"\n Searches OL for an author by name.\n\n :param str name: Author's name\n :rtype: list\n :return: A list of OL author representations than match name\n \"\"\"\n\n def walk_redirects(obj, seen):\n seen.add(obj['key'])\n while obj['type']['key'] == '/type/redirect':\n assert obj['location'] != obj['key']\n obj = web.ctx.site.get(obj['location'])\n seen.add(obj['key'])\n return obj\n\n # Try for an 'exact' (case-insensitive) name match, but fall back to alternate_names,\n # then last name with identical birth and death dates (that are not themselves `None` or '').\n name = author[\"name\"].replace(\"*\", r\"\\*\")\n queries = [\n {\"type\": \"/type/author\", \"name~\": name},\n {\"type\": \"/type/author\", \"alternate_names~\": name},\n {\n \"type\": \"/type/author\",\n \"name~\": f\"* {name.split()[-1]}\",\n \"birth_date~\": f\"*{extract_year(author.get('birth_date', '')) or -1}*\",\n \"death_date~\": f\"*{extract_year(author.get('death_date', '')) or -1}*\",\n }, # Use `-1` to ensure an empty string from extract_year doesn't match empty dates.\n ]\n for query in queries:\n if reply := list(web.ctx.site.things(query)):\n break\n\n authors = [web.ctx.site.get(k) for k in reply]\n if any(a.type.key != '/type/author' for a in authors):\n seen: set[dict] = set()\n authors = [walk_redirects(a, seen) for a in authors if a['key'] not in seen]\n return authors\n\n\ndef find_entity(author: dict[str, Any]) -> \"Author | None\":\n \"\"\"\n Looks for an existing Author record in OL by name\n and returns it if found.\n\n :param dict author: Author import dict {\"name\": \"Some One\"}\n :return: Existing Author record if found, or None.\n \"\"\"\n name = author['name']\n things = find_author(author)\n et = author.get('entity_type')\n if et and et != 'person':\n if not things:\n return None\n db_entity = things[0]\n assert db_entity['type']['key'] == '/type/author'\n return db_entity\n if ', ' in name:\n flipped_name = flip_name(author[\"name\"])\n author_flipped_name = author.copy()\n things += find_author(author_flipped_name)\n match = []\n seen = set()\n for a in things:\n key = a['key']\n if key in seen:\n continue\n seen.add(key)\n orig_key = key\n assert a.type.key == '/type/author'\n if 'birth_date' in author and 'birth_date' not in a:\n continue\n if 'birth_date' not in author and 'birth_date' in a:\n continue\n if not author_dates_match(author, a):\n continue\n match.append(a)\n if not match:\n return None\n if len(match) == 1:\n return match[0]\n return pick_from_matches(author, match)\n\n\ndef remove_author_honorifics(name: str) -> str:\n \"\"\"\n Remove honorifics from an author's name field.\n\n If the author's name is only an honorific, it will return the original name.\n \"\"\"\n if name.casefold() in HONORIFC_NAME_EXECPTIONS:\n return name\n\n if honorific := next(\n (\n honorific\n for honorific in HONORIFICS\n if name.casefold().startswith(f\"{honorific} \") # Note the trailing space.\n ),\n None,\n ):\n return name[len(f\"{honorific} \") :].lstrip() or name\n\n return name\n\n\ndef import_author(author: dict[str, Any], eastern=False) -> \"Author | dict[str, Any]\":\n \"\"\"\n Converts an import style new-author dictionary into an\n Open Library existing author, or new author candidate, representation.\n Does NOT create new authors.\n\n :param dict author: Author import record {\"name\": \"Some One\"}\n :param bool eastern: Eastern name order\n :return: Open Library style Author representation, either existing with \"key\",\n or new candidate without \"key\".\n \"\"\"\n if existing := find_entity(author):\n assert existing.type.key == '/type/author'\n for k in 'last_modified', 'id', 'revision', 'created':\n if existing.k:\n del existing.k\n new = existing\n if 'death_date' in author and 'death_date' not in existing:\n new['death_date'] = author['death_date']\n return new\n if author.get('entity_type') != 'org' and not eastern:\n do_flip(author)\n a = {'type': {'key': '/type/author'}}\n for f in 'name', 'title', 'personal_name', 'birth_date', 'death_date', 'date':\n if f in author:\n a[f] = author[f]\n return a\n\n\nclass InvalidLanguage(Exception):\n def __init__(self, code):\n self.code = code\n\n def __str__(self):\n return \"invalid language code: '%s'\" % self.code\n\n\ntype_map = {'description': 'text', 'notes': 'text', 'number_of_pages': 'int'}\n\n\ndef build_query(rec):\n \"\"\"\n Takes an edition record dict, rec, and returns an Open Library edition\n suitable for saving.\n\n :param dict rec: Edition record to add to Open Library\n :rtype: dict\n :return: Open Library style edition representation\n \"\"\"\n book = {\n 'type': {'key': '/type/edition'},\n }\n\n for k, v in rec.items():\n if k == 'authors':\n if v and v[0]:\n book['authors'] = []\n for author in v:\n author['name'] = remove_author_honorifics(author['name'])\n east = east_in_by_statement(rec, author)\n book['authors'].append(import_author(author, eastern=east))\n continue\n if k in ('languages', 'translated_from'):\n for language in v:\n if web.ctx.site.get('/languages/' + language) is None:\n raise InvalidLanguage(language)\n book[k] = [{'key': '/languages/' + language} for language in v]\n continue\n if k in type_map:\n t = '/type/' + type_map[k]\n if isinstance(v, list):\n book[k] = [{'type': t, 'value': i} for i in v]\n else:\n book[k] = {'type': t, 'value': v}\n else:\n book[k] = v\n return book\n","path":"openlibrary/catalog/add_book/load_book.py"}],"string":"[\n {\n \"content\": \"from typing import TYPE_CHECKING, Any, Final\\nimport web\\nfrom openlibrary.catalog.utils import flip_name, author_dates_match, key_int\\nfrom openlibrary.core.helpers import extract_year\\n\\n\\nif TYPE_CHECKING:\\n from openlibrary.plugins.upstream.models import Author\\n\\n\\n# Sort by descending length to remove the _longest_ match.\\n# E.g. remove \\\"señorita\\\" and not \\\"señor\\\", when both match.\\nHONORIFICS: Final = sorted(\\n [\\n 'countess',\\n 'doctor',\\n 'doktor',\\n 'dr',\\n 'dr.',\\n 'frau',\\n 'fräulein',\\n 'herr',\\n 'lady',\\n 'lord',\\n 'm.',\\n 'madame',\\n 'mademoiselle',\\n 'miss',\\n 'mister',\\n 'mistress',\\n 'mixter',\\n 'mlle',\\n 'mlle.',\\n 'mme',\\n 'mme.',\\n 'monsieur',\\n 'mr',\\n 'mr.',\\n 'mrs',\\n 'mrs.',\\n 'ms',\\n 'ms.',\\n 'mx',\\n 'mx.',\\n 'professor',\\n 'señor',\\n 'señora',\\n 'señorita',\\n 'sir',\\n 'sr.',\\n 'sra.',\\n 'srta.',\\n ],\\n key=lambda x: len(x),\\n reverse=True,\\n)\\n\\nHONORIFC_NAME_EXECPTIONS = frozenset(\\n {\\n \\\"dr. seuss\\\",\\n \\\"dr seuss\\\",\\n \\\"dr oetker\\\",\\n \\\"doctor oetker\\\",\\n }\\n)\\n\\n\\ndef east_in_by_statement(rec, author):\\n \\\"\\\"\\\"\\n Returns False if there is no by_statement in rec.\\n Otherwise returns whether author name uses eastern name order.\\n TODO: elaborate on what this actually means, and how it is used.\\n\\n :param dict rec: import source edition record\\n :param dict author: import source author dict: {\\\"name\\\": \\\"Some One\\\"}\\n :rtype: bool\\n \\\"\\\"\\\"\\n\\n if 'by_statement' not in rec:\\n return False\\n if 'authors' not in rec:\\n return False\\n name = author['name']\\n flipped = flip_name(name)\\n name = name.replace('.', '')\\n name = name.replace(', ', '')\\n if name == flipped.replace('.', ''):\\n # name was not flipped\\n return False\\n return rec['by_statement'].find(name) != -1\\n\\n\\ndef do_flip(author):\\n \\\"\\\"\\\"\\n Given an author import dict, flip its name in place\\n i.e. Smith, John => John Smith\\n\\n :param dict author:\\n :rtype: None\\n \\\"\\\"\\\"\\n if 'personal_name' in author and author['personal_name'] != author['name']:\\n # Don't flip names if name is more complex than personal_name (legacy behaviour)\\n return\\n first_comma = author['name'].find(', ')\\n if first_comma == -1:\\n return\\n # e.g: Harper, John Murdoch, 1845-\\n if author['name'].find(',', first_comma + 1) != -1:\\n return\\n if author['name'].find('i.e.') != -1:\\n return\\n if author['name'].find('i. e.') != -1:\\n return\\n name = flip_name(author['name'])\\n author['name'] = name\\n if 'personal_name' in author:\\n author['personal_name'] = name\\n\\n\\ndef pick_from_matches(author, match):\\n \\\"\\\"\\\"\\n Finds the best match for author from a list of OL authors records, match.\\n\\n :param dict author: Author import representation\\n :param list match: List of matching OL author records\\n :rtype: dict\\n :return: A single OL author record from match\\n \\\"\\\"\\\"\\n maybe = []\\n if 'birth_date' in author and 'death_date' in author:\\n maybe = [m for m in match if 'birth_date' in m and 'death_date' in m]\\n elif 'date' in author:\\n maybe = [m for m in match if 'date' in m]\\n if not maybe:\\n maybe = match\\n if len(maybe) == 1:\\n return maybe[0]\\n return min(maybe, key=key_int)\\n\\n\\ndef find_author(author: dict[str, Any]) -> list[\\\"Author\\\"]:\\n \\\"\\\"\\\"\\n Searches OL for an author by name.\\n\\n :param str name: Author's name\\n :rtype: list\\n :return: A list of OL author representations than match name\\n \\\"\\\"\\\"\\n\\n def walk_redirects(obj, seen):\\n seen.add(obj['key'])\\n while obj['type']['key'] == '/type/redirect':\\n assert obj['location'] != obj['key']\\n obj = web.ctx.site.get(obj['location'])\\n seen.add(obj['key'])\\n return obj\\n\\n # Try for an 'exact' (case-insensitive) name match, but fall back to alternate_names,\\n # then last name with identical birth and death dates (that are not themselves `None` or '').\\n name = author[\\\"name\\\"].replace(\\\"*\\\", r\\\"\\\\*\\\")\\n queries = [\\n {\\\"type\\\": \\\"/type/author\\\", \\\"name~\\\": name},\\n {\\\"type\\\": \\\"/type/author\\\", \\\"alternate_names~\\\": name},\\n {\\n \\\"type\\\": \\\"/type/author\\\",\\n \\\"name~\\\": f\\\"* {name.split()[-1]}\\\",\\n \\\"birth_date~\\\": f\\\"*{extract_year(author.get('birth_date', '')) or -1}*\\\",\\n \\\"death_date~\\\": f\\\"*{extract_year(author.get('death_date', '')) or -1}*\\\",\\n }, # Use `-1` to ensure an empty string from extract_year doesn't match empty dates.\\n ]\\n for query in queries:\\n if reply := list(web.ctx.site.things(query)):\\n break\\n\\n authors = [web.ctx.site.get(k) for k in reply]\\n if any(a.type.key != '/type/author' for a in authors):\\n seen: set[dict] = set()\\n authors = [walk_redirects(a, seen) for a in authors if a['key'] not in seen]\\n return authors\\n\\n\\ndef find_entity(author: dict[str, Any]) -> \\\"Author | None\\\":\\n \\\"\\\"\\\"\\n Looks for an existing Author record in OL by name\\n and returns it if found.\\n\\n :param dict author: Author import dict {\\\"name\\\": \\\"Some One\\\"}\\n :return: Existing Author record if found, or None.\\n \\\"\\\"\\\"\\n name = author['name']\\n things = find_author(author)\\n et = author.get('entity_type')\\n if et and et != 'person':\\n if not things:\\n return None\\n db_entity = things[0]\\n assert db_entity['type']['key'] == '/type/author'\\n return db_entity\\n if ', ' in name:\\n flipped_name = flip_name(author[\\\"name\\\"])\\n author_flipped_name = author.copy()\\n things += find_author(author_flipped_name)\\n match = []\\n seen = set()\\n for a in things:\\n key = a['key']\\n if key in seen:\\n continue\\n seen.add(key)\\n orig_key = key\\n assert a.type.key == '/type/author'\\n if 'birth_date' in author and 'birth_date' not in a:\\n continue\\n if 'birth_date' not in author and 'birth_date' in a:\\n continue\\n if not author_dates_match(author, a):\\n continue\\n match.append(a)\\n if not match:\\n return None\\n if len(match) == 1:\\n return match[0]\\n return pick_from_matches(author, match)\\n\\n\\ndef remove_author_honorifics(name: str) -> str:\\n \\\"\\\"\\\"\\n Remove honorifics from an author's name field.\\n\\n If the author's name is only an honorific, it will return the original name.\\n \\\"\\\"\\\"\\n if name.casefold() in HONORIFC_NAME_EXECPTIONS:\\n return name\\n\\n if honorific := next(\\n (\\n honorific\\n for honorific in HONORIFICS\\n if name.casefold().startswith(f\\\"{honorific} \\\") # Note the trailing space.\\n ),\\n None,\\n ):\\n return name[len(f\\\"{honorific} \\\") :].lstrip() or name\\n\\n return name\\n\\n\\ndef import_author(author: dict[str, Any], eastern=False) -> \\\"Author | dict[str, Any]\\\":\\n \\\"\\\"\\\"\\n Converts an import style new-author dictionary into an\\n Open Library existing author, or new author candidate, representation.\\n Does NOT create new authors.\\n\\n :param dict author: Author import record {\\\"name\\\": \\\"Some One\\\"}\\n :param bool eastern: Eastern name order\\n :return: Open Library style Author representation, either existing with \\\"key\\\",\\n or new candidate without \\\"key\\\".\\n \\\"\\\"\\\"\\n if existing := find_entity(author):\\n assert existing.type.key == '/type/author'\\n for k in 'last_modified', 'id', 'revision', 'created':\\n if existing.k:\\n del existing.k\\n new = existing\\n if 'death_date' in author and 'death_date' not in existing:\\n new['death_date'] = author['death_date']\\n return new\\n if author.get('entity_type') != 'org' and not eastern:\\n do_flip(author)\\n a = {'type': {'key': '/type/author'}}\\n for f in 'name', 'title', 'personal_name', 'birth_date', 'death_date', 'date':\\n if f in author:\\n a[f] = author[f]\\n return a\\n\\n\\nclass InvalidLanguage(Exception):\\n def __init__(self, code):\\n self.code = code\\n\\n def __str__(self):\\n return \\\"invalid language code: '%s'\\\" % self.code\\n\\n\\ntype_map = {'description': 'text', 'notes': 'text', 'number_of_pages': 'int'}\\n\\n\\ndef build_query(rec):\\n \\\"\\\"\\\"\\n Takes an edition record dict, rec, and returns an Open Library edition\\n suitable for saving.\\n\\n :param dict rec: Edition record to add to Open Library\\n :rtype: dict\\n :return: Open Library style edition representation\\n \\\"\\\"\\\"\\n book = {\\n 'type': {'key': '/type/edition'},\\n }\\n\\n for k, v in rec.items():\\n if k == 'authors':\\n if v and v[0]:\\n book['authors'] = []\\n for author in v:\\n author['name'] = remove_author_honorifics(author['name'])\\n east = east_in_by_statement(rec, author)\\n book['authors'].append(import_author(author, eastern=east))\\n continue\\n if k in ('languages', 'translated_from'):\\n for language in v:\\n if web.ctx.site.get('/languages/' + language) is None:\\n raise InvalidLanguage(language)\\n book[k] = [{'key': '/languages/' + language} for language in v]\\n continue\\n if k in type_map:\\n t = '/type/' + type_map[k]\\n if isinstance(v, list):\\n book[k] = [{'type': t, 'value': i} for i in v]\\n else:\\n book[k] = {'type': t, 'value': v}\\n else:\\n book[k] = v\\n return book\\n\",\n \"path\": \"openlibrary/catalog/add_book/load_book.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/openlibrary/catalog/add_book/load_book.py b/openlibrary/catalog/add_book/load_book.py\nindex e47cb6e7792..958dcafb952 100644\n--- a/openlibrary/catalog/add_book/load_book.py\n+++ b/openlibrary/catalog/add_book/load_book.py\n@@ -236,11 +236,11 @@ def remove_author_honorifics(name: str) -> str:\n (\n honorific\n for honorific in HONORIFICS\n- if name.casefold().startswith(honorific)\n+ if name.casefold().startswith(f\"{honorific} \") # Note the trailing space.\n ),\n None,\n ):\n- return name[len(honorific) :].lstrip() or name\n+ return name[len(f\"{honorific} \") :].lstrip() or name\n \n return name\n \ndiff --git a/openlibrary/catalog/add_book/tests/test_load_book.py b/openlibrary/catalog/add_book/tests/test_load_book.py\nindex 5948ee23267..f95276283a9 100644\n--- a/openlibrary/catalog/add_book/tests/test_load_book.py\n+++ b/openlibrary/catalog/add_book/tests/test_load_book.py\n@@ -83,6 +83,7 @@ def add_three_existing_authors(self, mock_site):\n @pytest.mark.parametrize(\n [\"name\", \"expected\"],\n [\n+ (\"Drake von Drake\", \"Drake von Drake\"),\n (\"Dr. Seuss\", \"Dr. Seuss\"),\n (\"dr. Seuss\", \"dr. Seuss\"),\n (\"Dr Seuss\", \"Dr Seuss\"),\n"}}},{"rowIdx":5488,"cells":{"in_source_id":{"kind":"string","value":"readthedocs__readthedocs.org-5034"},"issue":{"kind":"string","value":"Setting default branch uses Version.slug instead of identifier\n## Details\r\n\r\n* Read the Docs project URL: https://readthedocs.org/projects/test-builds/\r\n* Build URL (if applicable): https://readthedocs.org/projects/test-builds/builds/8319150/\r\n* Read the Docs username (if applicable): humitos\r\n\r\n## Expected Result\r\n\r\nBuild the branch set as default branch as when it's built as [non default](https://readthedocs.org/projects/test-builds/builds/8307296/).\r\n\r\n> NOTE: the correct command here is `git checkout --force origin/branch/with/slashes`\r\n\r\n## Actual Result\r\n\r\nThe `git checkout --force branch-with-slashes` command fails because the branch does not exist.\r\n\r\n----\r\n\r\n`Project.default_branch` is saved in an improperly way.\r\n\r\n```\r\n>>> Version.objects.get(slug='branch-with-slashes').__dict__\r\n...\r\n 'type': 'branch',\r\n 'identifier': 'origin/branch/with/slashes',\r\n 'verbose_name': 'branch/with/slashes',\r\n 'slug': 'branch-with-slashes',\r\n>>> Version.objects.get(slug='branch-with-slashes').project.default_branch \r\n'branch-with-slashes'\r\n```\r\n\n"},"before_files":{"kind":"list like","value":[{"content":"# -*- coding: utf-8 -*-\n\"\"\"Project forms.\"\"\"\n\nfrom __future__ import (\n absolute_import,\n division,\n print_function,\n unicode_literals,\n)\n\nfrom random import choice\n\nfrom builtins import object\nfrom django import forms\nfrom django.conf import settings\nfrom django.contrib.auth.models import User\nfrom django.template.loader import render_to_string\nfrom django.utils.safestring import mark_safe\nfrom django.utils.translation import ugettext_lazy as _\nfrom future.backports.urllib.parse import urlparse\nfrom guardian.shortcuts import assign\nfrom textclassifier.validators import ClassifierValidator\n\nfrom readthedocs.builds.constants import TAG\nfrom readthedocs.core.utils import slugify, trigger_build\nfrom readthedocs.core.utils.extend import SettingsOverrideObject\nfrom readthedocs.integrations.models import Integration\nfrom readthedocs.oauth.models import RemoteRepository\nfrom readthedocs.projects import constants\nfrom readthedocs.projects.constants import PUBLIC\nfrom readthedocs.projects.exceptions import ProjectSpamError\nfrom readthedocs.projects.models import (\n Domain,\n EmailHook,\n Feature,\n Project,\n ProjectRelationship,\n WebHook,\n)\nfrom readthedocs.redirects.models import Redirect\n\n\nclass ProjectForm(forms.ModelForm):\n\n \"\"\"\n Project form.\n\n :param user: If provided, add this user as a project user on save\n \"\"\"\n\n required_css_class = 'required'\n\n def __init__(self, *args, **kwargs):\n self.user = kwargs.pop('user', None)\n super(ProjectForm, self).__init__(*args, **kwargs)\n\n def save(self, commit=True):\n project = super(ProjectForm, self).save(commit)\n if commit:\n if self.user and not project.users.filter(pk=self.user.pk).exists():\n project.users.add(self.user)\n return project\n\n\nclass ProjectTriggerBuildMixin(object):\n\n \"\"\"\n Mixin to trigger build on form save.\n\n This should be replaced with signals instead of calling trigger_build\n explicitly.\n \"\"\"\n\n def save(self, commit=True):\n \"\"\"Trigger build on commit save.\"\"\"\n project = super(ProjectTriggerBuildMixin, self).save(commit)\n if commit:\n trigger_build(project=project)\n return project\n\n\nclass ProjectBackendForm(forms.Form):\n\n \"\"\"Get the import backend.\"\"\"\n\n backend = forms.CharField()\n\n\nclass ProjectBasicsForm(ProjectForm):\n\n \"\"\"Form for basic project fields.\"\"\"\n\n class Meta(object):\n model = Project\n fields = ('name', 'repo', 'repo_type')\n\n remote_repository = forms.CharField(\n widget=forms.HiddenInput(),\n required=False,\n )\n\n def __init__(self, *args, **kwargs):\n show_advanced = kwargs.pop('show_advanced', False)\n super(ProjectBasicsForm, self).__init__(*args, **kwargs)\n if show_advanced:\n self.fields['advanced'] = forms.BooleanField(\n required=False,\n label=_('Edit advanced project options'),\n )\n self.fields['repo'].widget.attrs['placeholder'] = self.placehold_repo()\n self.fields['repo'].widget.attrs['required'] = True\n\n def save(self, commit=True):\n \"\"\"Add remote repository relationship to the project instance.\"\"\"\n instance = super(ProjectBasicsForm, self).save(commit)\n remote_repo = self.cleaned_data.get('remote_repository', None)\n if remote_repo:\n if commit:\n remote_repo.project = self.instance\n remote_repo.save()\n else:\n instance.remote_repository = remote_repo\n return instance\n\n def clean_name(self):\n name = self.cleaned_data.get('name', '')\n if not self.instance.pk:\n potential_slug = slugify(name)\n if Project.objects.filter(slug=potential_slug).exists():\n raise forms.ValidationError(\n _('Invalid project name, a project already exists with that name')) # yapf: disable # noqa\n if not potential_slug:\n # Check the generated slug won't be empty\n raise forms.ValidationError(\n _('Invalid project name'),\n )\n\n return name\n\n def clean_remote_repository(self):\n remote_repo = self.cleaned_data.get('remote_repository', None)\n if not remote_repo:\n return None\n try:\n return RemoteRepository.objects.get(\n pk=remote_repo,\n users=self.user,\n )\n except RemoteRepository.DoesNotExist:\n raise forms.ValidationError(_('Repository invalid'))\n\n def placehold_repo(self):\n return choice([\n 'https://bitbucket.org/cherrypy/cherrypy',\n 'https://bitbucket.org/birkenfeld/sphinx',\n 'https://bitbucket.org/hpk42/tox',\n 'https://github.com/zzzeek/sqlalchemy.git',\n 'https://github.com/django/django.git',\n 'https://github.com/fabric/fabric.git',\n 'https://github.com/ericholscher/django-kong.git',\n ])\n\n\nclass ProjectExtraForm(ProjectForm):\n\n \"\"\"Additional project information form.\"\"\"\n\n class Meta(object):\n model = Project\n fields = (\n 'description',\n 'documentation_type',\n 'language',\n 'programming_language',\n 'tags',\n 'project_url',\n )\n\n description = forms.CharField(\n validators=[ClassifierValidator(raises=ProjectSpamError)],\n required=False,\n widget=forms.Textarea,\n )\n\n\nclass ProjectAdvancedForm(ProjectTriggerBuildMixin, ProjectForm):\n\n \"\"\"Advanced project option form.\"\"\"\n\n python_interpreter = forms.ChoiceField(\n choices=constants.PYTHON_CHOICES,\n initial='python',\n help_text=_('The Python interpreter used to create the virtual '\n 'environment.'),\n )\n\n class Meta(object):\n model = Project\n fields = (\n # Standard build edits\n 'install_project',\n 'requirements_file',\n 'single_version',\n 'conf_py_file',\n 'default_branch',\n 'default_version',\n 'show_version_warning',\n 'enable_pdf_build',\n 'enable_epub_build',\n # Privacy\n 'privacy_level',\n # 'version_privacy_level',\n # Python specific\n 'use_system_packages',\n 'python_interpreter',\n # Fringe\n 'analytics_code',\n )\n\n def __init__(self, *args, **kwargs):\n super(ProjectAdvancedForm, self).__init__(*args, **kwargs)\n\n default_choice = (None, '-' * 9)\n all_versions = self.instance.versions.values_list(\n 'slug', 'verbose_name'\n )\n self.fields['default_branch'].widget = forms.Select(\n choices=[default_choice] + list(all_versions)\n )\n\n active_versions = self.instance.all_active_versions().values_list(\n 'slug', 'verbose_name'\n )\n self.fields['default_version'].widget = forms.Select(\n choices=active_versions\n )\n\n def clean_conf_py_file(self):\n filename = self.cleaned_data.get('conf_py_file', '').strip()\n if filename and 'conf.py' not in filename:\n raise forms.ValidationError(\n _('Your configuration file is invalid, make sure it contains '\n 'conf.py in it.')) # yapf: disable\n return filename\n\n\nclass UpdateProjectForm(ProjectTriggerBuildMixin, ProjectBasicsForm,\n ProjectExtraForm):\n class Meta(object):\n model = Project\n fields = (\n # Basics\n 'name',\n 'repo',\n 'repo_type',\n # Extra\n 'description',\n 'documentation_type',\n 'language',\n 'programming_language',\n 'project_url',\n 'tags',\n )\n\n def clean_language(self):\n language = self.cleaned_data['language']\n project = self.instance\n if project:\n msg = _(\n 'There is already a \"{lang}\" translation '\n 'for the {proj} project.'\n )\n if project.translations.filter(language=language).exists():\n raise forms.ValidationError(\n msg.format(lang=language, proj=project.slug)\n )\n main_project = project.main_language_project\n if main_project:\n if main_project.language == language:\n raise forms.ValidationError(\n msg.format(lang=language, proj=main_project.slug)\n )\n siblings = (\n main_project.translations\n .filter(language=language)\n .exclude(pk=project.pk)\n .exists()\n )\n if siblings:\n raise forms.ValidationError(\n msg.format(lang=language, proj=main_project.slug)\n )\n return language\n\n\nclass ProjectRelationshipBaseForm(forms.ModelForm):\n\n \"\"\"Form to add/update project relationships.\"\"\"\n\n parent = forms.CharField(widget=forms.HiddenInput(), required=False)\n\n class Meta(object):\n model = ProjectRelationship\n fields = '__all__'\n\n def __init__(self, *args, **kwargs):\n self.project = kwargs.pop('project')\n self.user = kwargs.pop('user')\n super(ProjectRelationshipBaseForm, self).__init__(*args, **kwargs)\n # Don't display the update form with an editable child, as it will be\n # filtered out from the queryset anyways.\n if hasattr(self, 'instance') and self.instance.pk is not None:\n self.fields['child'].queryset = Project.objects.filter(pk=self.instance.child.pk)\n else:\n self.fields['child'].queryset = self.get_subproject_queryset()\n\n def clean_parent(self):\n if self.project.superprojects.exists():\n # This validation error is mostly for testing, users shouldn't see\n # this in normal circumstances\n raise forms.ValidationError(\n _('Subproject nesting is not supported'))\n return self.project\n\n def clean_child(self):\n child = self.cleaned_data['child']\n if child == self.project:\n raise forms.ValidationError(\n _('A project can not be a subproject of itself'))\n return child\n\n def get_subproject_queryset(self):\n \"\"\"\n Return scrubbed subproject choice queryset.\n\n This removes projects that are either already a subproject of another\n project, or are a superproject, as neither case is supported.\n \"\"\"\n queryset = (\n Project.objects.for_admin_user(self.user)\n .exclude(subprojects__isnull=False)\n .exclude(superprojects__isnull=False)\n .exclude(pk=self.project.pk))\n return queryset\n\n\nclass ProjectRelationshipForm(SettingsOverrideObject):\n _default_class = ProjectRelationshipBaseForm\n\n\nclass DualCheckboxWidget(forms.CheckboxInput):\n\n \"\"\"Checkbox with link to the version's built documentation.\"\"\"\n\n def __init__(self, version, attrs=None, check_test=bool):\n super(DualCheckboxWidget, self).__init__(attrs, check_test)\n self.version = version\n\n def render(self, name, value, attrs=None, renderer=None):\n checkbox = super(DualCheckboxWidget, self).render(name, value, attrs, renderer)\n icon = self.render_icon()\n return mark_safe('{}{}'.format(checkbox, icon))\n\n def render_icon(self):\n context = {\n 'MEDIA_URL': settings.MEDIA_URL,\n 'built': self.version.built,\n 'uploaded': self.version.uploaded,\n 'url': self.version.get_absolute_url(),\n }\n return render_to_string('projects/includes/icon_built.html', context)\n\n\nclass BaseVersionsForm(forms.Form):\n\n \"\"\"Form for versions page.\"\"\"\n\n def save(self):\n versions = self.project.versions.all()\n for version in versions:\n self.save_version(version)\n default_version = self.cleaned_data.get('default-version', None)\n if default_version:\n self.project.default_version = default_version\n self.project.save()\n\n def save_version(self, version):\n \"\"\"Save version if there has been a change, trigger a rebuild.\"\"\"\n new_value = self.cleaned_data.get(\n 'version-{}'.format(version.slug),\n None,\n )\n privacy_level = self.cleaned_data.get(\n 'privacy-{}'.format(version.slug),\n None,\n )\n if ((new_value is None or new_value == version.active) and\n (privacy_level is None or privacy_level == version.privacy_level)): # yapf: disable # noqa\n return\n version.active = new_value\n version.privacy_level = privacy_level\n version.save()\n if version.active and not version.built and not version.uploaded:\n trigger_build(project=self.project, version=version)\n\n\ndef build_versions_form(project):\n \"\"\"Versions form with a list of versions and version privacy levels.\"\"\"\n attrs = {\n 'project': project,\n }\n versions_qs = project.versions.all() # Admin page, so show all versions\n active = versions_qs.filter(active=True)\n if active.exists():\n choices = [(version.slug, version.verbose_name) for version in active]\n attrs['default-version'] = forms.ChoiceField(\n label=_('Default Version'),\n choices=choices,\n initial=project.get_default_version(),\n )\n for version in versions_qs:\n field_name = 'version-{}'.format(version.slug)\n privacy_name = 'privacy-{}'.format(version.slug)\n if version.type == TAG:\n label = '{} ({})'.format(\n version.verbose_name,\n version.identifier[:8],\n )\n else:\n label = version.verbose_name\n attrs[field_name] = forms.BooleanField(\n label=label,\n widget=DualCheckboxWidget(version),\n initial=version.active,\n required=False,\n )\n attrs[privacy_name] = forms.ChoiceField(\n # This isn't a real label, but just a slug for the template\n label='privacy',\n choices=constants.PRIVACY_CHOICES,\n initial=version.privacy_level,\n )\n return type(str('VersionsForm'), (BaseVersionsForm,), attrs)\n\n\nclass BaseUploadHTMLForm(forms.Form):\n content = forms.FileField(label=_('Zip file of HTML'))\n overwrite = forms.BooleanField(required=False,\n label=_('Overwrite existing HTML?'))\n\n def __init__(self, *args, **kwargs):\n self.request = kwargs.pop('request', None)\n super(BaseUploadHTMLForm, self).__init__(*args, **kwargs)\n\n def clean(self):\n version_slug = self.cleaned_data['version']\n filename = self.request.FILES['content']\n version = self.project.versions.get(slug=version_slug)\n\n # Validation\n if version.active and not self.cleaned_data.get('overwrite', False):\n raise forms.ValidationError(_('That version is already active!'))\n if not filename.name.endswith('zip'):\n raise forms.ValidationError(_('Must upload a zip file.'))\n\n return self.cleaned_data\n\n\ndef build_upload_html_form(project):\n \"\"\"Upload HTML form with list of versions to upload HTML for.\"\"\"\n attrs = {\n 'project': project,\n }\n active = project.versions.public()\n if active.exists():\n choices = []\n choices += [(version.slug, version.verbose_name) for version in active]\n attrs['version'] = forms.ChoiceField(\n label=_('Version of the project you are uploading HTML for'),\n choices=choices,\n )\n return type('UploadHTMLForm', (BaseUploadHTMLForm,), attrs)\n\n\nclass UserForm(forms.Form):\n\n \"\"\"Project user association form.\"\"\"\n\n user = forms.CharField()\n\n def __init__(self, *args, **kwargs):\n self.project = kwargs.pop('project', None)\n super(UserForm, self).__init__(*args, **kwargs)\n\n def clean_user(self):\n name = self.cleaned_data['user']\n user_qs = User.objects.filter(username=name)\n if not user_qs.exists():\n raise forms.ValidationError(\n _('User {name} does not exist').format(name=name))\n self.user = user_qs[0]\n return name\n\n def save(self):\n self.project.users.add(self.user)\n # Force update of permissions\n assign('view_project', self.user, self.project)\n return self.user\n\n\nclass EmailHookForm(forms.Form):\n\n \"\"\"Project email notification form.\"\"\"\n\n email = forms.EmailField()\n\n def __init__(self, *args, **kwargs):\n self.project = kwargs.pop('project', None)\n super(EmailHookForm, self).__init__(*args, **kwargs)\n\n def clean_email(self):\n self.email = EmailHook.objects.get_or_create(\n email=self.cleaned_data['email'], project=self.project)[0]\n return self.email\n\n def save(self):\n self.project.emailhook_notifications.add(self.email)\n return self.project\n\n\nclass WebHookForm(forms.ModelForm):\n\n \"\"\"Project webhook form.\"\"\"\n\n def __init__(self, *args, **kwargs):\n self.project = kwargs.pop('project', None)\n super(WebHookForm, self).__init__(*args, **kwargs)\n\n def save(self, commit=True):\n self.webhook = WebHook.objects.get_or_create(\n url=self.cleaned_data['url'], project=self.project)[0]\n self.project.webhook_notifications.add(self.webhook)\n return self.project\n\n class Meta:\n model = WebHook\n fields = ['url']\n\n\nclass TranslationBaseForm(forms.Form):\n\n \"\"\"Project translation form.\"\"\"\n\n project = forms.ChoiceField()\n\n def __init__(self, *args, **kwargs):\n self.parent = kwargs.pop('parent', None)\n self.user = kwargs.pop('user')\n super(TranslationBaseForm, self).__init__(*args, **kwargs)\n self.fields['project'].choices = self.get_choices()\n\n def get_choices(self):\n return [\n (project.slug, '{project} ({lang})'.format(\n project=project.slug, lang=project.get_language_display()))\n for project in self.get_translation_queryset().all()\n ]\n\n def clean_project(self):\n translation_project_slug = self.cleaned_data['project']\n\n # Ensure parent project isn't already itself a translation\n if self.parent.main_language_project is not None:\n msg = 'Project \"{project}\" is already a translation'\n raise forms.ValidationError(\n (_(msg).format(project=self.parent.slug))\n )\n\n project_translation_qs = self.get_translation_queryset().filter(\n slug=translation_project_slug\n )\n if not project_translation_qs.exists():\n msg = 'Project \"{project}\" does not exist.'\n raise forms.ValidationError(\n (_(msg).format(project=translation_project_slug))\n )\n self.translation = project_translation_qs.first()\n if self.translation.language == self.parent.language:\n msg = (\n 'Both projects can not have the same language ({lang}).'\n )\n raise forms.ValidationError(\n _(msg).format(lang=self.parent.get_language_display())\n )\n exists_translation = (\n self.parent.translations\n .filter(language=self.translation.language)\n .exists()\n )\n if exists_translation:\n msg = (\n 'This project already has a translation for {lang}.'\n )\n raise forms.ValidationError(\n _(msg).format(lang=self.translation.get_language_display())\n )\n is_parent = self.translation.translations.exists()\n if is_parent:\n msg = (\n 'A project with existing translations '\n 'can not be added as a project translation.'\n )\n raise forms.ValidationError(_(msg))\n return translation_project_slug\n\n def get_translation_queryset(self):\n queryset = (\n Project.objects.for_admin_user(self.user)\n .filter(main_language_project=None)\n .exclude(pk=self.parent.pk)\n )\n return queryset\n\n def save(self):\n project = self.parent.translations.add(self.translation)\n # Run symlinking and other sync logic to make sure we are in a good\n # state.\n self.parent.save()\n return project\n\n\nclass TranslationForm(SettingsOverrideObject):\n _default_class = TranslationBaseForm\n\n\nclass RedirectForm(forms.ModelForm):\n\n \"\"\"Form for project redirects.\"\"\"\n\n class Meta(object):\n model = Redirect\n fields = ['redirect_type', 'from_url', 'to_url']\n\n def __init__(self, *args, **kwargs):\n self.project = kwargs.pop('project', None)\n super(RedirectForm, self).__init__(*args, **kwargs)\n\n def save(self, **_): # pylint: disable=arguments-differ\n # TODO this should respect the unused argument `commit`. It's not clear\n # why this needs to be a call to `create`, instead of relying on the\n # super `save()` call.\n redirect = Redirect.objects.create(\n project=self.project,\n redirect_type=self.cleaned_data['redirect_type'],\n from_url=self.cleaned_data['from_url'],\n to_url=self.cleaned_data['to_url'],\n )\n return redirect\n\n\nclass DomainBaseForm(forms.ModelForm):\n\n \"\"\"Form to configure a custom domain name for a project.\"\"\"\n\n project = forms.CharField(widget=forms.HiddenInput(), required=False)\n\n class Meta(object):\n model = Domain\n exclude = ['machine', 'cname', 'count'] # pylint: disable=modelform-uses-exclude\n\n def __init__(self, *args, **kwargs):\n self.project = kwargs.pop('project', None)\n super(DomainBaseForm, self).__init__(*args, **kwargs)\n\n def clean_project(self):\n return self.project\n\n def clean_domain(self):\n parsed = urlparse(self.cleaned_data['domain'])\n if parsed.scheme or parsed.netloc:\n domain_string = parsed.netloc\n else:\n domain_string = parsed.path\n return domain_string\n\n def clean_canonical(self):\n canonical = self.cleaned_data['canonical']\n _id = self.initial.get('id')\n if canonical and Domain.objects.filter(\n project=self.project, canonical=True\n ).exclude(pk=_id).exists():\n raise forms.ValidationError(\n _('Only 1 Domain can be canonical at a time.'))\n return canonical\n\n\nclass DomainForm(SettingsOverrideObject):\n _default_class = DomainBaseForm\n\n\nclass IntegrationForm(forms.ModelForm):\n\n \"\"\"\n Form to add an integration.\n\n This limits the choices of the integration type to webhook integration types\n \"\"\"\n\n project = forms.CharField(widget=forms.HiddenInput(), required=False)\n\n class Meta(object):\n model = Integration\n exclude = ['provider_data', 'exchanges'] # pylint: disable=modelform-uses-exclude\n\n def __init__(self, *args, **kwargs):\n self.project = kwargs.pop('project', None)\n super(IntegrationForm, self).__init__(*args, **kwargs)\n # Alter the integration type choices to only provider webhooks\n self.fields['integration_type'].choices = Integration.WEBHOOK_INTEGRATIONS # yapf: disable # noqa\n\n def clean_project(self):\n return self.project\n\n def save(self, commit=True):\n self.instance = Integration.objects.subclass(self.instance)\n return super(IntegrationForm, self).save(commit)\n\n\nclass ProjectAdvertisingForm(forms.ModelForm):\n\n \"\"\"Project promotion opt-out form.\"\"\"\n\n class Meta(object):\n model = Project\n fields = ['allow_promos']\n\n def __init__(self, *args, **kwargs):\n self.project = kwargs.pop('project', None)\n super(ProjectAdvertisingForm, self).__init__(*args, **kwargs)\n\n\nclass FeatureForm(forms.ModelForm):\n\n \"\"\"\n Project feature form for dynamic admin choices.\n\n This form converts the CharField into a ChoiceField on display. The\n underlying driver won't attempt to do validation on the choices, and so we\n can dynamically populate this list.\n \"\"\"\n\n feature_id = forms.ChoiceField()\n\n class Meta(object):\n model = Feature\n fields = ['projects', 'feature_id', 'default_true']\n\n def __init__(self, *args, **kwargs):\n super(FeatureForm, self).__init__(*args, **kwargs)\n self.fields['feature_id'].choices = Feature.FEATURES\n","path":"readthedocs/projects/forms.py"}],"string":"[\n {\n \"content\": \"# -*- coding: utf-8 -*-\\n\\\"\\\"\\\"Project forms.\\\"\\\"\\\"\\n\\nfrom __future__ import (\\n absolute_import,\\n division,\\n print_function,\\n unicode_literals,\\n)\\n\\nfrom random import choice\\n\\nfrom builtins import object\\nfrom django import forms\\nfrom django.conf import settings\\nfrom django.contrib.auth.models import User\\nfrom django.template.loader import render_to_string\\nfrom django.utils.safestring import mark_safe\\nfrom django.utils.translation import ugettext_lazy as _\\nfrom future.backports.urllib.parse import urlparse\\nfrom guardian.shortcuts import assign\\nfrom textclassifier.validators import ClassifierValidator\\n\\nfrom readthedocs.builds.constants import TAG\\nfrom readthedocs.core.utils import slugify, trigger_build\\nfrom readthedocs.core.utils.extend import SettingsOverrideObject\\nfrom readthedocs.integrations.models import Integration\\nfrom readthedocs.oauth.models import RemoteRepository\\nfrom readthedocs.projects import constants\\nfrom readthedocs.projects.constants import PUBLIC\\nfrom readthedocs.projects.exceptions import ProjectSpamError\\nfrom readthedocs.projects.models import (\\n Domain,\\n EmailHook,\\n Feature,\\n Project,\\n ProjectRelationship,\\n WebHook,\\n)\\nfrom readthedocs.redirects.models import Redirect\\n\\n\\nclass ProjectForm(forms.ModelForm):\\n\\n \\\"\\\"\\\"\\n Project form.\\n\\n :param user: If provided, add this user as a project user on save\\n \\\"\\\"\\\"\\n\\n required_css_class = 'required'\\n\\n def __init__(self, *args, **kwargs):\\n self.user = kwargs.pop('user', None)\\n super(ProjectForm, self).__init__(*args, **kwargs)\\n\\n def save(self, commit=True):\\n project = super(ProjectForm, self).save(commit)\\n if commit:\\n if self.user and not project.users.filter(pk=self.user.pk).exists():\\n project.users.add(self.user)\\n return project\\n\\n\\nclass ProjectTriggerBuildMixin(object):\\n\\n \\\"\\\"\\\"\\n Mixin to trigger build on form save.\\n\\n This should be replaced with signals instead of calling trigger_build\\n explicitly.\\n \\\"\\\"\\\"\\n\\n def save(self, commit=True):\\n \\\"\\\"\\\"Trigger build on commit save.\\\"\\\"\\\"\\n project = super(ProjectTriggerBuildMixin, self).save(commit)\\n if commit:\\n trigger_build(project=project)\\n return project\\n\\n\\nclass ProjectBackendForm(forms.Form):\\n\\n \\\"\\\"\\\"Get the import backend.\\\"\\\"\\\"\\n\\n backend = forms.CharField()\\n\\n\\nclass ProjectBasicsForm(ProjectForm):\\n\\n \\\"\\\"\\\"Form for basic project fields.\\\"\\\"\\\"\\n\\n class Meta(object):\\n model = Project\\n fields = ('name', 'repo', 'repo_type')\\n\\n remote_repository = forms.CharField(\\n widget=forms.HiddenInput(),\\n required=False,\\n )\\n\\n def __init__(self, *args, **kwargs):\\n show_advanced = kwargs.pop('show_advanced', False)\\n super(ProjectBasicsForm, self).__init__(*args, **kwargs)\\n if show_advanced:\\n self.fields['advanced'] = forms.BooleanField(\\n required=False,\\n label=_('Edit advanced project options'),\\n )\\n self.fields['repo'].widget.attrs['placeholder'] = self.placehold_repo()\\n self.fields['repo'].widget.attrs['required'] = True\\n\\n def save(self, commit=True):\\n \\\"\\\"\\\"Add remote repository relationship to the project instance.\\\"\\\"\\\"\\n instance = super(ProjectBasicsForm, self).save(commit)\\n remote_repo = self.cleaned_data.get('remote_repository', None)\\n if remote_repo:\\n if commit:\\n remote_repo.project = self.instance\\n remote_repo.save()\\n else:\\n instance.remote_repository = remote_repo\\n return instance\\n\\n def clean_name(self):\\n name = self.cleaned_data.get('name', '')\\n if not self.instance.pk:\\n potential_slug = slugify(name)\\n if Project.objects.filter(slug=potential_slug).exists():\\n raise forms.ValidationError(\\n _('Invalid project name, a project already exists with that name')) # yapf: disable # noqa\\n if not potential_slug:\\n # Check the generated slug won't be empty\\n raise forms.ValidationError(\\n _('Invalid project name'),\\n )\\n\\n return name\\n\\n def clean_remote_repository(self):\\n remote_repo = self.cleaned_data.get('remote_repository', None)\\n if not remote_repo:\\n return None\\n try:\\n return RemoteRepository.objects.get(\\n pk=remote_repo,\\n users=self.user,\\n )\\n except RemoteRepository.DoesNotExist:\\n raise forms.ValidationError(_('Repository invalid'))\\n\\n def placehold_repo(self):\\n return choice([\\n 'https://bitbucket.org/cherrypy/cherrypy',\\n 'https://bitbucket.org/birkenfeld/sphinx',\\n 'https://bitbucket.org/hpk42/tox',\\n 'https://github.com/zzzeek/sqlalchemy.git',\\n 'https://github.com/django/django.git',\\n 'https://github.com/fabric/fabric.git',\\n 'https://github.com/ericholscher/django-kong.git',\\n ])\\n\\n\\nclass ProjectExtraForm(ProjectForm):\\n\\n \\\"\\\"\\\"Additional project information form.\\\"\\\"\\\"\\n\\n class Meta(object):\\n model = Project\\n fields = (\\n 'description',\\n 'documentation_type',\\n 'language',\\n 'programming_language',\\n 'tags',\\n 'project_url',\\n )\\n\\n description = forms.CharField(\\n validators=[ClassifierValidator(raises=ProjectSpamError)],\\n required=False,\\n widget=forms.Textarea,\\n )\\n\\n\\nclass ProjectAdvancedForm(ProjectTriggerBuildMixin, ProjectForm):\\n\\n \\\"\\\"\\\"Advanced project option form.\\\"\\\"\\\"\\n\\n python_interpreter = forms.ChoiceField(\\n choices=constants.PYTHON_CHOICES,\\n initial='python',\\n help_text=_('The Python interpreter used to create the virtual '\\n 'environment.'),\\n )\\n\\n class Meta(object):\\n model = Project\\n fields = (\\n # Standard build edits\\n 'install_project',\\n 'requirements_file',\\n 'single_version',\\n 'conf_py_file',\\n 'default_branch',\\n 'default_version',\\n 'show_version_warning',\\n 'enable_pdf_build',\\n 'enable_epub_build',\\n # Privacy\\n 'privacy_level',\\n # 'version_privacy_level',\\n # Python specific\\n 'use_system_packages',\\n 'python_interpreter',\\n # Fringe\\n 'analytics_code',\\n )\\n\\n def __init__(self, *args, **kwargs):\\n super(ProjectAdvancedForm, self).__init__(*args, **kwargs)\\n\\n default_choice = (None, '-' * 9)\\n all_versions = self.instance.versions.values_list(\\n 'slug', 'verbose_name'\\n )\\n self.fields['default_branch'].widget = forms.Select(\\n choices=[default_choice] + list(all_versions)\\n )\\n\\n active_versions = self.instance.all_active_versions().values_list(\\n 'slug', 'verbose_name'\\n )\\n self.fields['default_version'].widget = forms.Select(\\n choices=active_versions\\n )\\n\\n def clean_conf_py_file(self):\\n filename = self.cleaned_data.get('conf_py_file', '').strip()\\n if filename and 'conf.py' not in filename:\\n raise forms.ValidationError(\\n _('Your configuration file is invalid, make sure it contains '\\n 'conf.py in it.')) # yapf: disable\\n return filename\\n\\n\\nclass UpdateProjectForm(ProjectTriggerBuildMixin, ProjectBasicsForm,\\n ProjectExtraForm):\\n class Meta(object):\\n model = Project\\n fields = (\\n # Basics\\n 'name',\\n 'repo',\\n 'repo_type',\\n # Extra\\n 'description',\\n 'documentation_type',\\n 'language',\\n 'programming_language',\\n 'project_url',\\n 'tags',\\n )\\n\\n def clean_language(self):\\n language = self.cleaned_data['language']\\n project = self.instance\\n if project:\\n msg = _(\\n 'There is already a \\\"{lang}\\\" translation '\\n 'for the {proj} project.'\\n )\\n if project.translations.filter(language=language).exists():\\n raise forms.ValidationError(\\n msg.format(lang=language, proj=project.slug)\\n )\\n main_project = project.main_language_project\\n if main_project:\\n if main_project.language == language:\\n raise forms.ValidationError(\\n msg.format(lang=language, proj=main_project.slug)\\n )\\n siblings = (\\n main_project.translations\\n .filter(language=language)\\n .exclude(pk=project.pk)\\n .exists()\\n )\\n if siblings:\\n raise forms.ValidationError(\\n msg.format(lang=language, proj=main_project.slug)\\n )\\n return language\\n\\n\\nclass ProjectRelationshipBaseForm(forms.ModelForm):\\n\\n \\\"\\\"\\\"Form to add/update project relationships.\\\"\\\"\\\"\\n\\n parent = forms.CharField(widget=forms.HiddenInput(), required=False)\\n\\n class Meta(object):\\n model = ProjectRelationship\\n fields = '__all__'\\n\\n def __init__(self, *args, **kwargs):\\n self.project = kwargs.pop('project')\\n self.user = kwargs.pop('user')\\n super(ProjectRelationshipBaseForm, self).__init__(*args, **kwargs)\\n # Don't display the update form with an editable child, as it will be\\n # filtered out from the queryset anyways.\\n if hasattr(self, 'instance') and self.instance.pk is not None:\\n self.fields['child'].queryset = Project.objects.filter(pk=self.instance.child.pk)\\n else:\\n self.fields['child'].queryset = self.get_subproject_queryset()\\n\\n def clean_parent(self):\\n if self.project.superprojects.exists():\\n # This validation error is mostly for testing, users shouldn't see\\n # this in normal circumstances\\n raise forms.ValidationError(\\n _('Subproject nesting is not supported'))\\n return self.project\\n\\n def clean_child(self):\\n child = self.cleaned_data['child']\\n if child == self.project:\\n raise forms.ValidationError(\\n _('A project can not be a subproject of itself'))\\n return child\\n\\n def get_subproject_queryset(self):\\n \\\"\\\"\\\"\\n Return scrubbed subproject choice queryset.\\n\\n This removes projects that are either already a subproject of another\\n project, or are a superproject, as neither case is supported.\\n \\\"\\\"\\\"\\n queryset = (\\n Project.objects.for_admin_user(self.user)\\n .exclude(subprojects__isnull=False)\\n .exclude(superprojects__isnull=False)\\n .exclude(pk=self.project.pk))\\n return queryset\\n\\n\\nclass ProjectRelationshipForm(SettingsOverrideObject):\\n _default_class = ProjectRelationshipBaseForm\\n\\n\\nclass DualCheckboxWidget(forms.CheckboxInput):\\n\\n \\\"\\\"\\\"Checkbox with link to the version's built documentation.\\\"\\\"\\\"\\n\\n def __init__(self, version, attrs=None, check_test=bool):\\n super(DualCheckboxWidget, self).__init__(attrs, check_test)\\n self.version = version\\n\\n def render(self, name, value, attrs=None, renderer=None):\\n checkbox = super(DualCheckboxWidget, self).render(name, value, attrs, renderer)\\n icon = self.render_icon()\\n return mark_safe('{}{}'.format(checkbox, icon))\\n\\n def render_icon(self):\\n context = {\\n 'MEDIA_URL': settings.MEDIA_URL,\\n 'built': self.version.built,\\n 'uploaded': self.version.uploaded,\\n 'url': self.version.get_absolute_url(),\\n }\\n return render_to_string('projects/includes/icon_built.html', context)\\n\\n\\nclass BaseVersionsForm(forms.Form):\\n\\n \\\"\\\"\\\"Form for versions page.\\\"\\\"\\\"\\n\\n def save(self):\\n versions = self.project.versions.all()\\n for version in versions:\\n self.save_version(version)\\n default_version = self.cleaned_data.get('default-version', None)\\n if default_version:\\n self.project.default_version = default_version\\n self.project.save()\\n\\n def save_version(self, version):\\n \\\"\\\"\\\"Save version if there has been a change, trigger a rebuild.\\\"\\\"\\\"\\n new_value = self.cleaned_data.get(\\n 'version-{}'.format(version.slug),\\n None,\\n )\\n privacy_level = self.cleaned_data.get(\\n 'privacy-{}'.format(version.slug),\\n None,\\n )\\n if ((new_value is None or new_value == version.active) and\\n (privacy_level is None or privacy_level == version.privacy_level)): # yapf: disable # noqa\\n return\\n version.active = new_value\\n version.privacy_level = privacy_level\\n version.save()\\n if version.active and not version.built and not version.uploaded:\\n trigger_build(project=self.project, version=version)\\n\\n\\ndef build_versions_form(project):\\n \\\"\\\"\\\"Versions form with a list of versions and version privacy levels.\\\"\\\"\\\"\\n attrs = {\\n 'project': project,\\n }\\n versions_qs = project.versions.all() # Admin page, so show all versions\\n active = versions_qs.filter(active=True)\\n if active.exists():\\n choices = [(version.slug, version.verbose_name) for version in active]\\n attrs['default-version'] = forms.ChoiceField(\\n label=_('Default Version'),\\n choices=choices,\\n initial=project.get_default_version(),\\n )\\n for version in versions_qs:\\n field_name = 'version-{}'.format(version.slug)\\n privacy_name = 'privacy-{}'.format(version.slug)\\n if version.type == TAG:\\n label = '{} ({})'.format(\\n version.verbose_name,\\n version.identifier[:8],\\n )\\n else:\\n label = version.verbose_name\\n attrs[field_name] = forms.BooleanField(\\n label=label,\\n widget=DualCheckboxWidget(version),\\n initial=version.active,\\n required=False,\\n )\\n attrs[privacy_name] = forms.ChoiceField(\\n # This isn't a real label, but just a slug for the template\\n label='privacy',\\n choices=constants.PRIVACY_CHOICES,\\n initial=version.privacy_level,\\n )\\n return type(str('VersionsForm'), (BaseVersionsForm,), attrs)\\n\\n\\nclass BaseUploadHTMLForm(forms.Form):\\n content = forms.FileField(label=_('Zip file of HTML'))\\n overwrite = forms.BooleanField(required=False,\\n label=_('Overwrite existing HTML?'))\\n\\n def __init__(self, *args, **kwargs):\\n self.request = kwargs.pop('request', None)\\n super(BaseUploadHTMLForm, self).__init__(*args, **kwargs)\\n\\n def clean(self):\\n version_slug = self.cleaned_data['version']\\n filename = self.request.FILES['content']\\n version = self.project.versions.get(slug=version_slug)\\n\\n # Validation\\n if version.active and not self.cleaned_data.get('overwrite', False):\\n raise forms.ValidationError(_('That version is already active!'))\\n if not filename.name.endswith('zip'):\\n raise forms.ValidationError(_('Must upload a zip file.'))\\n\\n return self.cleaned_data\\n\\n\\ndef build_upload_html_form(project):\\n \\\"\\\"\\\"Upload HTML form with list of versions to upload HTML for.\\\"\\\"\\\"\\n attrs = {\\n 'project': project,\\n }\\n active = project.versions.public()\\n if active.exists():\\n choices = []\\n choices += [(version.slug, version.verbose_name) for version in active]\\n attrs['version'] = forms.ChoiceField(\\n label=_('Version of the project you are uploading HTML for'),\\n choices=choices,\\n )\\n return type('UploadHTMLForm', (BaseUploadHTMLForm,), attrs)\\n\\n\\nclass UserForm(forms.Form):\\n\\n \\\"\\\"\\\"Project user association form.\\\"\\\"\\\"\\n\\n user = forms.CharField()\\n\\n def __init__(self, *args, **kwargs):\\n self.project = kwargs.pop('project', None)\\n super(UserForm, self).__init__(*args, **kwargs)\\n\\n def clean_user(self):\\n name = self.cleaned_data['user']\\n user_qs = User.objects.filter(username=name)\\n if not user_qs.exists():\\n raise forms.ValidationError(\\n _('User {name} does not exist').format(name=name))\\n self.user = user_qs[0]\\n return name\\n\\n def save(self):\\n self.project.users.add(self.user)\\n # Force update of permissions\\n assign('view_project', self.user, self.project)\\n return self.user\\n\\n\\nclass EmailHookForm(forms.Form):\\n\\n \\\"\\\"\\\"Project email notification form.\\\"\\\"\\\"\\n\\n email = forms.EmailField()\\n\\n def __init__(self, *args, **kwargs):\\n self.project = kwargs.pop('project', None)\\n super(EmailHookForm, self).__init__(*args, **kwargs)\\n\\n def clean_email(self):\\n self.email = EmailHook.objects.get_or_create(\\n email=self.cleaned_data['email'], project=self.project)[0]\\n return self.email\\n\\n def save(self):\\n self.project.emailhook_notifications.add(self.email)\\n return self.project\\n\\n\\nclass WebHookForm(forms.ModelForm):\\n\\n \\\"\\\"\\\"Project webhook form.\\\"\\\"\\\"\\n\\n def __init__(self, *args, **kwargs):\\n self.project = kwargs.pop('project', None)\\n super(WebHookForm, self).__init__(*args, **kwargs)\\n\\n def save(self, commit=True):\\n self.webhook = WebHook.objects.get_or_create(\\n url=self.cleaned_data['url'], project=self.project)[0]\\n self.project.webhook_notifications.add(self.webhook)\\n return self.project\\n\\n class Meta:\\n model = WebHook\\n fields = ['url']\\n\\n\\nclass TranslationBaseForm(forms.Form):\\n\\n \\\"\\\"\\\"Project translation form.\\\"\\\"\\\"\\n\\n project = forms.ChoiceField()\\n\\n def __init__(self, *args, **kwargs):\\n self.parent = kwargs.pop('parent', None)\\n self.user = kwargs.pop('user')\\n super(TranslationBaseForm, self).__init__(*args, **kwargs)\\n self.fields['project'].choices = self.get_choices()\\n\\n def get_choices(self):\\n return [\\n (project.slug, '{project} ({lang})'.format(\\n project=project.slug, lang=project.get_language_display()))\\n for project in self.get_translation_queryset().all()\\n ]\\n\\n def clean_project(self):\\n translation_project_slug = self.cleaned_data['project']\\n\\n # Ensure parent project isn't already itself a translation\\n if self.parent.main_language_project is not None:\\n msg = 'Project \\\"{project}\\\" is already a translation'\\n raise forms.ValidationError(\\n (_(msg).format(project=self.parent.slug))\\n )\\n\\n project_translation_qs = self.get_translation_queryset().filter(\\n slug=translation_project_slug\\n )\\n if not project_translation_qs.exists():\\n msg = 'Project \\\"{project}\\\" does not exist.'\\n raise forms.ValidationError(\\n (_(msg).format(project=translation_project_slug))\\n )\\n self.translation = project_translation_qs.first()\\n if self.translation.language == self.parent.language:\\n msg = (\\n 'Both projects can not have the same language ({lang}).'\\n )\\n raise forms.ValidationError(\\n _(msg).format(lang=self.parent.get_language_display())\\n )\\n exists_translation = (\\n self.parent.translations\\n .filter(language=self.translation.language)\\n .exists()\\n )\\n if exists_translation:\\n msg = (\\n 'This project already has a translation for {lang}.'\\n )\\n raise forms.ValidationError(\\n _(msg).format(lang=self.translation.get_language_display())\\n )\\n is_parent = self.translation.translations.exists()\\n if is_parent:\\n msg = (\\n 'A project with existing translations '\\n 'can not be added as a project translation.'\\n )\\n raise forms.ValidationError(_(msg))\\n return translation_project_slug\\n\\n def get_translation_queryset(self):\\n queryset = (\\n Project.objects.for_admin_user(self.user)\\n .filter(main_language_project=None)\\n .exclude(pk=self.parent.pk)\\n )\\n return queryset\\n\\n def save(self):\\n project = self.parent.translations.add(self.translation)\\n # Run symlinking and other sync logic to make sure we are in a good\\n # state.\\n self.parent.save()\\n return project\\n\\n\\nclass TranslationForm(SettingsOverrideObject):\\n _default_class = TranslationBaseForm\\n\\n\\nclass RedirectForm(forms.ModelForm):\\n\\n \\\"\\\"\\\"Form for project redirects.\\\"\\\"\\\"\\n\\n class Meta(object):\\n model = Redirect\\n fields = ['redirect_type', 'from_url', 'to_url']\\n\\n def __init__(self, *args, **kwargs):\\n self.project = kwargs.pop('project', None)\\n super(RedirectForm, self).__init__(*args, **kwargs)\\n\\n def save(self, **_): # pylint: disable=arguments-differ\\n # TODO this should respect the unused argument `commit`. It's not clear\\n # why this needs to be a call to `create`, instead of relying on the\\n # super `save()` call.\\n redirect = Redirect.objects.create(\\n project=self.project,\\n redirect_type=self.cleaned_data['redirect_type'],\\n from_url=self.cleaned_data['from_url'],\\n to_url=self.cleaned_data['to_url'],\\n )\\n return redirect\\n\\n\\nclass DomainBaseForm(forms.ModelForm):\\n\\n \\\"\\\"\\\"Form to configure a custom domain name for a project.\\\"\\\"\\\"\\n\\n project = forms.CharField(widget=forms.HiddenInput(), required=False)\\n\\n class Meta(object):\\n model = Domain\\n exclude = ['machine', 'cname', 'count'] # pylint: disable=modelform-uses-exclude\\n\\n def __init__(self, *args, **kwargs):\\n self.project = kwargs.pop('project', None)\\n super(DomainBaseForm, self).__init__(*args, **kwargs)\\n\\n def clean_project(self):\\n return self.project\\n\\n def clean_domain(self):\\n parsed = urlparse(self.cleaned_data['domain'])\\n if parsed.scheme or parsed.netloc:\\n domain_string = parsed.netloc\\n else:\\n domain_string = parsed.path\\n return domain_string\\n\\n def clean_canonical(self):\\n canonical = self.cleaned_data['canonical']\\n _id = self.initial.get('id')\\n if canonical and Domain.objects.filter(\\n project=self.project, canonical=True\\n ).exclude(pk=_id).exists():\\n raise forms.ValidationError(\\n _('Only 1 Domain can be canonical at a time.'))\\n return canonical\\n\\n\\nclass DomainForm(SettingsOverrideObject):\\n _default_class = DomainBaseForm\\n\\n\\nclass IntegrationForm(forms.ModelForm):\\n\\n \\\"\\\"\\\"\\n Form to add an integration.\\n\\n This limits the choices of the integration type to webhook integration types\\n \\\"\\\"\\\"\\n\\n project = forms.CharField(widget=forms.HiddenInput(), required=False)\\n\\n class Meta(object):\\n model = Integration\\n exclude = ['provider_data', 'exchanges'] # pylint: disable=modelform-uses-exclude\\n\\n def __init__(self, *args, **kwargs):\\n self.project = kwargs.pop('project', None)\\n super(IntegrationForm, self).__init__(*args, **kwargs)\\n # Alter the integration type choices to only provider webhooks\\n self.fields['integration_type'].choices = Integration.WEBHOOK_INTEGRATIONS # yapf: disable # noqa\\n\\n def clean_project(self):\\n return self.project\\n\\n def save(self, commit=True):\\n self.instance = Integration.objects.subclass(self.instance)\\n return super(IntegrationForm, self).save(commit)\\n\\n\\nclass ProjectAdvertisingForm(forms.ModelForm):\\n\\n \\\"\\\"\\\"Project promotion opt-out form.\\\"\\\"\\\"\\n\\n class Meta(object):\\n model = Project\\n fields = ['allow_promos']\\n\\n def __init__(self, *args, **kwargs):\\n self.project = kwargs.pop('project', None)\\n super(ProjectAdvertisingForm, self).__init__(*args, **kwargs)\\n\\n\\nclass FeatureForm(forms.ModelForm):\\n\\n \\\"\\\"\\\"\\n Project feature form for dynamic admin choices.\\n\\n This form converts the CharField into a ChoiceField on display. The\\n underlying driver won't attempt to do validation on the choices, and so we\\n can dynamically populate this list.\\n \\\"\\\"\\\"\\n\\n feature_id = forms.ChoiceField()\\n\\n class Meta(object):\\n model = Feature\\n fields = ['projects', 'feature_id', 'default_true']\\n\\n def __init__(self, *args, **kwargs):\\n super(FeatureForm, self).__init__(*args, **kwargs)\\n self.fields['feature_id'].choices = Feature.FEATURES\\n\",\n \"path\": \"readthedocs/projects/forms.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"# -*- coding: utf-8 -*-\n\"\"\"Project forms.\"\"\"\n\nfrom __future__ import (\n absolute_import,\n division,\n print_function,\n unicode_literals,\n)\n\nfrom random import choice\n\nfrom builtins import object\nfrom django import forms\nfrom django.conf import settings\nfrom django.contrib.auth.models import User\nfrom django.template.loader import render_to_string\nfrom django.utils.safestring import mark_safe\nfrom django.utils.translation import ugettext_lazy as _\nfrom future.backports.urllib.parse import urlparse\nfrom guardian.shortcuts import assign\nfrom textclassifier.validators import ClassifierValidator\n\nfrom readthedocs.builds.constants import TAG\nfrom readthedocs.core.utils import slugify, trigger_build\nfrom readthedocs.core.utils.extend import SettingsOverrideObject\nfrom readthedocs.integrations.models import Integration\nfrom readthedocs.oauth.models import RemoteRepository\nfrom readthedocs.projects import constants\nfrom readthedocs.projects.constants import PUBLIC\nfrom readthedocs.projects.exceptions import ProjectSpamError\nfrom readthedocs.projects.models import (\n Domain,\n EmailHook,\n Feature,\n Project,\n ProjectRelationship,\n WebHook,\n)\nfrom readthedocs.redirects.models import Redirect\n\n\nclass ProjectForm(forms.ModelForm):\n\n \"\"\"\n Project form.\n\n :param user: If provided, add this user as a project user on save\n \"\"\"\n\n required_css_class = 'required'\n\n def __init__(self, *args, **kwargs):\n self.user = kwargs.pop('user', None)\n super(ProjectForm, self).__init__(*args, **kwargs)\n\n def save(self, commit=True):\n project = super(ProjectForm, self).save(commit)\n if commit:\n if self.user and not project.users.filter(pk=self.user.pk).exists():\n project.users.add(self.user)\n return project\n\n\nclass ProjectTriggerBuildMixin(object):\n\n \"\"\"\n Mixin to trigger build on form save.\n\n This should be replaced with signals instead of calling trigger_build\n explicitly.\n \"\"\"\n\n def save(self, commit=True):\n \"\"\"Trigger build on commit save.\"\"\"\n project = super(ProjectTriggerBuildMixin, self).save(commit)\n if commit:\n trigger_build(project=project)\n return project\n\n\nclass ProjectBackendForm(forms.Form):\n\n \"\"\"Get the import backend.\"\"\"\n\n backend = forms.CharField()\n\n\nclass ProjectBasicsForm(ProjectForm):\n\n \"\"\"Form for basic project fields.\"\"\"\n\n class Meta(object):\n model = Project\n fields = ('name', 'repo', 'repo_type')\n\n remote_repository = forms.CharField(\n widget=forms.HiddenInput(),\n required=False,\n )\n\n def __init__(self, *args, **kwargs):\n show_advanced = kwargs.pop('show_advanced', False)\n super(ProjectBasicsForm, self).__init__(*args, **kwargs)\n if show_advanced:\n self.fields['advanced'] = forms.BooleanField(\n required=False,\n label=_('Edit advanced project options'),\n )\n self.fields['repo'].widget.attrs['placeholder'] = self.placehold_repo()\n self.fields['repo'].widget.attrs['required'] = True\n\n def save(self, commit=True):\n \"\"\"Add remote repository relationship to the project instance.\"\"\"\n instance = super(ProjectBasicsForm, self).save(commit)\n remote_repo = self.cleaned_data.get('remote_repository', None)\n if remote_repo:\n if commit:\n remote_repo.project = self.instance\n remote_repo.save()\n else:\n instance.remote_repository = remote_repo\n return instance\n\n def clean_name(self):\n name = self.cleaned_data.get('name', '')\n if not self.instance.pk:\n potential_slug = slugify(name)\n if Project.objects.filter(slug=potential_slug).exists():\n raise forms.ValidationError(\n _('Invalid project name, a project already exists with that name')) # yapf: disable # noqa\n if not potential_slug:\n # Check the generated slug won't be empty\n raise forms.ValidationError(\n _('Invalid project name'),\n )\n\n return name\n\n def clean_remote_repository(self):\n remote_repo = self.cleaned_data.get('remote_repository', None)\n if not remote_repo:\n return None\n try:\n return RemoteRepository.objects.get(\n pk=remote_repo,\n users=self.user,\n )\n except RemoteRepository.DoesNotExist:\n raise forms.ValidationError(_('Repository invalid'))\n\n def placehold_repo(self):\n return choice([\n 'https://bitbucket.org/cherrypy/cherrypy',\n 'https://bitbucket.org/birkenfeld/sphinx',\n 'https://bitbucket.org/hpk42/tox',\n 'https://github.com/zzzeek/sqlalchemy.git',\n 'https://github.com/django/django.git',\n 'https://github.com/fabric/fabric.git',\n 'https://github.com/ericholscher/django-kong.git',\n ])\n\n\nclass ProjectExtraForm(ProjectForm):\n\n \"\"\"Additional project information form.\"\"\"\n\n class Meta(object):\n model = Project\n fields = (\n 'description',\n 'documentation_type',\n 'language',\n 'programming_language',\n 'tags',\n 'project_url',\n )\n\n description = forms.CharField(\n validators=[ClassifierValidator(raises=ProjectSpamError)],\n required=False,\n widget=forms.Textarea,\n )\n\n\nclass ProjectAdvancedForm(ProjectTriggerBuildMixin, ProjectForm):\n\n \"\"\"Advanced project option form.\"\"\"\n\n python_interpreter = forms.ChoiceField(\n choices=constants.PYTHON_CHOICES,\n initial='python',\n help_text=_('The Python interpreter used to create the virtual '\n 'environment.'),\n )\n\n class Meta(object):\n model = Project\n fields = (\n # Standard build edits\n 'install_project',\n 'requirements_file',\n 'single_version',\n 'conf_py_file',\n 'default_branch',\n 'default_version',\n 'show_version_warning',\n 'enable_pdf_build',\n 'enable_epub_build',\n # Privacy\n 'privacy_level',\n # 'version_privacy_level',\n # Python specific\n 'use_system_packages',\n 'python_interpreter',\n # Fringe\n 'analytics_code',\n )\n\n def __init__(self, *args, **kwargs):\n super(ProjectAdvancedForm, self).__init__(*args, **kwargs)\n\n default_choice = (None, '-' * 9)\n all_versions = self.instance.versions.values_list(\n 'identifier', 'verbose_name'\n )\n self.fields['default_branch'].widget = forms.Select(\n choices=[default_choice] + list(all_versions)\n )\n\n active_versions = self.instance.all_active_versions().values_list(\n 'slug', 'verbose_name'\n )\n self.fields['default_version'].widget = forms.Select(\n choices=active_versions\n )\n\n def clean_conf_py_file(self):\n filename = self.cleaned_data.get('conf_py_file', '').strip()\n if filename and 'conf.py' not in filename:\n raise forms.ValidationError(\n _('Your configuration file is invalid, make sure it contains '\n 'conf.py in it.')) # yapf: disable\n return filename\n\n\nclass UpdateProjectForm(ProjectTriggerBuildMixin, ProjectBasicsForm,\n ProjectExtraForm):\n class Meta(object):\n model = Project\n fields = (\n # Basics\n 'name',\n 'repo',\n 'repo_type',\n # Extra\n 'description',\n 'documentation_type',\n 'language',\n 'programming_language',\n 'project_url',\n 'tags',\n )\n\n def clean_language(self):\n language = self.cleaned_data['language']\n project = self.instance\n if project:\n msg = _(\n 'There is already a \"{lang}\" translation '\n 'for the {proj} project.'\n )\n if project.translations.filter(language=language).exists():\n raise forms.ValidationError(\n msg.format(lang=language, proj=project.slug)\n )\n main_project = project.main_language_project\n if main_project:\n if main_project.language == language:\n raise forms.ValidationError(\n msg.format(lang=language, proj=main_project.slug)\n )\n siblings = (\n main_project.translations\n .filter(language=language)\n .exclude(pk=project.pk)\n .exists()\n )\n if siblings:\n raise forms.ValidationError(\n msg.format(lang=language, proj=main_project.slug)\n )\n return language\n\n\nclass ProjectRelationshipBaseForm(forms.ModelForm):\n\n \"\"\"Form to add/update project relationships.\"\"\"\n\n parent = forms.CharField(widget=forms.HiddenInput(), required=False)\n\n class Meta(object):\n model = ProjectRelationship\n fields = '__all__'\n\n def __init__(self, *args, **kwargs):\n self.project = kwargs.pop('project')\n self.user = kwargs.pop('user')\n super(ProjectRelationshipBaseForm, self).__init__(*args, **kwargs)\n # Don't display the update form with an editable child, as it will be\n # filtered out from the queryset anyways.\n if hasattr(self, 'instance') and self.instance.pk is not None:\n self.fields['child'].queryset = Project.objects.filter(pk=self.instance.child.pk)\n else:\n self.fields['child'].queryset = self.get_subproject_queryset()\n\n def clean_parent(self):\n if self.project.superprojects.exists():\n # This validation error is mostly for testing, users shouldn't see\n # this in normal circumstances\n raise forms.ValidationError(\n _('Subproject nesting is not supported'))\n return self.project\n\n def clean_child(self):\n child = self.cleaned_data['child']\n if child == self.project:\n raise forms.ValidationError(\n _('A project can not be a subproject of itself'))\n return child\n\n def get_subproject_queryset(self):\n \"\"\"\n Return scrubbed subproject choice queryset.\n\n This removes projects that are either already a subproject of another\n project, or are a superproject, as neither case is supported.\n \"\"\"\n queryset = (\n Project.objects.for_admin_user(self.user)\n .exclude(subprojects__isnull=False)\n .exclude(superprojects__isnull=False)\n .exclude(pk=self.project.pk))\n return queryset\n\n\nclass ProjectRelationshipForm(SettingsOverrideObject):\n _default_class = ProjectRelationshipBaseForm\n\n\nclass DualCheckboxWidget(forms.CheckboxInput):\n\n \"\"\"Checkbox with link to the version's built documentation.\"\"\"\n\n def __init__(self, version, attrs=None, check_test=bool):\n super(DualCheckboxWidget, self).__init__(attrs, check_test)\n self.version = version\n\n def render(self, name, value, attrs=None, renderer=None):\n checkbox = super(DualCheckboxWidget, self).render(name, value, attrs, renderer)\n icon = self.render_icon()\n return mark_safe('{}{}'.format(checkbox, icon))\n\n def render_icon(self):\n context = {\n 'MEDIA_URL': settings.MEDIA_URL,\n 'built': self.version.built,\n 'uploaded': self.version.uploaded,\n 'url': self.version.get_absolute_url(),\n }\n return render_to_string('projects/includes/icon_built.html', context)\n\n\nclass BaseVersionsForm(forms.Form):\n\n \"\"\"Form for versions page.\"\"\"\n\n def save(self):\n versions = self.project.versions.all()\n for version in versions:\n self.save_version(version)\n default_version = self.cleaned_data.get('default-version', None)\n if default_version:\n self.project.default_version = default_version\n self.project.save()\n\n def save_version(self, version):\n \"\"\"Save version if there has been a change, trigger a rebuild.\"\"\"\n new_value = self.cleaned_data.get(\n 'version-{}'.format(version.slug),\n None,\n )\n privacy_level = self.cleaned_data.get(\n 'privacy-{}'.format(version.slug),\n None,\n )\n if ((new_value is None or new_value == version.active) and\n (privacy_level is None or privacy_level == version.privacy_level)): # yapf: disable # noqa\n return\n version.active = new_value\n version.privacy_level = privacy_level\n version.save()\n if version.active and not version.built and not version.uploaded:\n trigger_build(project=self.project, version=version)\n\n\ndef build_versions_form(project):\n \"\"\"Versions form with a list of versions and version privacy levels.\"\"\"\n attrs = {\n 'project': project,\n }\n versions_qs = project.versions.all() # Admin page, so show all versions\n active = versions_qs.filter(active=True)\n if active.exists():\n choices = [(version.slug, version.verbose_name) for version in active]\n attrs['default-version'] = forms.ChoiceField(\n label=_('Default Version'),\n choices=choices,\n initial=project.get_default_version(),\n )\n for version in versions_qs:\n field_name = 'version-{}'.format(version.slug)\n privacy_name = 'privacy-{}'.format(version.slug)\n if version.type == TAG:\n label = '{} ({})'.format(\n version.verbose_name,\n version.identifier[:8],\n )\n else:\n label = version.verbose_name\n attrs[field_name] = forms.BooleanField(\n label=label,\n widget=DualCheckboxWidget(version),\n initial=version.active,\n required=False,\n )\n attrs[privacy_name] = forms.ChoiceField(\n # This isn't a real label, but just a slug for the template\n label='privacy',\n choices=constants.PRIVACY_CHOICES,\n initial=version.privacy_level,\n )\n return type(str('VersionsForm'), (BaseVersionsForm,), attrs)\n\n\nclass BaseUploadHTMLForm(forms.Form):\n content = forms.FileField(label=_('Zip file of HTML'))\n overwrite = forms.BooleanField(required=False,\n label=_('Overwrite existing HTML?'))\n\n def __init__(self, *args, **kwargs):\n self.request = kwargs.pop('request', None)\n super(BaseUploadHTMLForm, self).__init__(*args, **kwargs)\n\n def clean(self):\n version_slug = self.cleaned_data['version']\n filename = self.request.FILES['content']\n version = self.project.versions.get(slug=version_slug)\n\n # Validation\n if version.active and not self.cleaned_data.get('overwrite', False):\n raise forms.ValidationError(_('That version is already active!'))\n if not filename.name.endswith('zip'):\n raise forms.ValidationError(_('Must upload a zip file.'))\n\n return self.cleaned_data\n\n\ndef build_upload_html_form(project):\n \"\"\"Upload HTML form with list of versions to upload HTML for.\"\"\"\n attrs = {\n 'project': project,\n }\n active = project.versions.public()\n if active.exists():\n choices = []\n choices += [(version.slug, version.verbose_name) for version in active]\n attrs['version'] = forms.ChoiceField(\n label=_('Version of the project you are uploading HTML for'),\n choices=choices,\n )\n return type('UploadHTMLForm', (BaseUploadHTMLForm,), attrs)\n\n\nclass UserForm(forms.Form):\n\n \"\"\"Project user association form.\"\"\"\n\n user = forms.CharField()\n\n def __init__(self, *args, **kwargs):\n self.project = kwargs.pop('project', None)\n super(UserForm, self).__init__(*args, **kwargs)\n\n def clean_user(self):\n name = self.cleaned_data['user']\n user_qs = User.objects.filter(username=name)\n if not user_qs.exists():\n raise forms.ValidationError(\n _('User {name} does not exist').format(name=name))\n self.user = user_qs[0]\n return name\n\n def save(self):\n self.project.users.add(self.user)\n # Force update of permissions\n assign('view_project', self.user, self.project)\n return self.user\n\n\nclass EmailHookForm(forms.Form):\n\n \"\"\"Project email notification form.\"\"\"\n\n email = forms.EmailField()\n\n def __init__(self, *args, **kwargs):\n self.project = kwargs.pop('project', None)\n super(EmailHookForm, self).__init__(*args, **kwargs)\n\n def clean_email(self):\n self.email = EmailHook.objects.get_or_create(\n email=self.cleaned_data['email'], project=self.project)[0]\n return self.email\n\n def save(self):\n self.project.emailhook_notifications.add(self.email)\n return self.project\n\n\nclass WebHookForm(forms.ModelForm):\n\n \"\"\"Project webhook form.\"\"\"\n\n def __init__(self, *args, **kwargs):\n self.project = kwargs.pop('project', None)\n super(WebHookForm, self).__init__(*args, **kwargs)\n\n def save(self, commit=True):\n self.webhook = WebHook.objects.get_or_create(\n url=self.cleaned_data['url'], project=self.project)[0]\n self.project.webhook_notifications.add(self.webhook)\n return self.project\n\n class Meta:\n model = WebHook\n fields = ['url']\n\n\nclass TranslationBaseForm(forms.Form):\n\n \"\"\"Project translation form.\"\"\"\n\n project = forms.ChoiceField()\n\n def __init__(self, *args, **kwargs):\n self.parent = kwargs.pop('parent', None)\n self.user = kwargs.pop('user')\n super(TranslationBaseForm, self).__init__(*args, **kwargs)\n self.fields['project'].choices = self.get_choices()\n\n def get_choices(self):\n return [\n (project.slug, '{project} ({lang})'.format(\n project=project.slug, lang=project.get_language_display()))\n for project in self.get_translation_queryset().all()\n ]\n\n def clean_project(self):\n translation_project_slug = self.cleaned_data['project']\n\n # Ensure parent project isn't already itself a translation\n if self.parent.main_language_project is not None:\n msg = 'Project \"{project}\" is already a translation'\n raise forms.ValidationError(\n (_(msg).format(project=self.parent.slug))\n )\n\n project_translation_qs = self.get_translation_queryset().filter(\n slug=translation_project_slug\n )\n if not project_translation_qs.exists():\n msg = 'Project \"{project}\" does not exist.'\n raise forms.ValidationError(\n (_(msg).format(project=translation_project_slug))\n )\n self.translation = project_translation_qs.first()\n if self.translation.language == self.parent.language:\n msg = (\n 'Both projects can not have the same language ({lang}).'\n )\n raise forms.ValidationError(\n _(msg).format(lang=self.parent.get_language_display())\n )\n exists_translation = (\n self.parent.translations\n .filter(language=self.translation.language)\n .exists()\n )\n if exists_translation:\n msg = (\n 'This project already has a translation for {lang}.'\n )\n raise forms.ValidationError(\n _(msg).format(lang=self.translation.get_language_display())\n )\n is_parent = self.translation.translations.exists()\n if is_parent:\n msg = (\n 'A project with existing translations '\n 'can not be added as a project translation.'\n )\n raise forms.ValidationError(_(msg))\n return translation_project_slug\n\n def get_translation_queryset(self):\n queryset = (\n Project.objects.for_admin_user(self.user)\n .filter(main_language_project=None)\n .exclude(pk=self.parent.pk)\n )\n return queryset\n\n def save(self):\n project = self.parent.translations.add(self.translation)\n # Run symlinking and other sync logic to make sure we are in a good\n # state.\n self.parent.save()\n return project\n\n\nclass TranslationForm(SettingsOverrideObject):\n _default_class = TranslationBaseForm\n\n\nclass RedirectForm(forms.ModelForm):\n\n \"\"\"Form for project redirects.\"\"\"\n\n class Meta(object):\n model = Redirect\n fields = ['redirect_type', 'from_url', 'to_url']\n\n def __init__(self, *args, **kwargs):\n self.project = kwargs.pop('project', None)\n super(RedirectForm, self).__init__(*args, **kwargs)\n\n def save(self, **_): # pylint: disable=arguments-differ\n # TODO this should respect the unused argument `commit`. It's not clear\n # why this needs to be a call to `create`, instead of relying on the\n # super `save()` call.\n redirect = Redirect.objects.create(\n project=self.project,\n redirect_type=self.cleaned_data['redirect_type'],\n from_url=self.cleaned_data['from_url'],\n to_url=self.cleaned_data['to_url'],\n )\n return redirect\n\n\nclass DomainBaseForm(forms.ModelForm):\n\n \"\"\"Form to configure a custom domain name for a project.\"\"\"\n\n project = forms.CharField(widget=forms.HiddenInput(), required=False)\n\n class Meta(object):\n model = Domain\n exclude = ['machine', 'cname', 'count'] # pylint: disable=modelform-uses-exclude\n\n def __init__(self, *args, **kwargs):\n self.project = kwargs.pop('project', None)\n super(DomainBaseForm, self).__init__(*args, **kwargs)\n\n def clean_project(self):\n return self.project\n\n def clean_domain(self):\n parsed = urlparse(self.cleaned_data['domain'])\n if parsed.scheme or parsed.netloc:\n domain_string = parsed.netloc\n else:\n domain_string = parsed.path\n return domain_string\n\n def clean_canonical(self):\n canonical = self.cleaned_data['canonical']\n _id = self.initial.get('id')\n if canonical and Domain.objects.filter(\n project=self.project, canonical=True\n ).exclude(pk=_id).exists():\n raise forms.ValidationError(\n _('Only 1 Domain can be canonical at a time.'))\n return canonical\n\n\nclass DomainForm(SettingsOverrideObject):\n _default_class = DomainBaseForm\n\n\nclass IntegrationForm(forms.ModelForm):\n\n \"\"\"\n Form to add an integration.\n\n This limits the choices of the integration type to webhook integration types\n \"\"\"\n\n project = forms.CharField(widget=forms.HiddenInput(), required=False)\n\n class Meta(object):\n model = Integration\n exclude = ['provider_data', 'exchanges'] # pylint: disable=modelform-uses-exclude\n\n def __init__(self, *args, **kwargs):\n self.project = kwargs.pop('project', None)\n super(IntegrationForm, self).__init__(*args, **kwargs)\n # Alter the integration type choices to only provider webhooks\n self.fields['integration_type'].choices = Integration.WEBHOOK_INTEGRATIONS # yapf: disable # noqa\n\n def clean_project(self):\n return self.project\n\n def save(self, commit=True):\n self.instance = Integration.objects.subclass(self.instance)\n return super(IntegrationForm, self).save(commit)\n\n\nclass ProjectAdvertisingForm(forms.ModelForm):\n\n \"\"\"Project promotion opt-out form.\"\"\"\n\n class Meta(object):\n model = Project\n fields = ['allow_promos']\n\n def __init__(self, *args, **kwargs):\n self.project = kwargs.pop('project', None)\n super(ProjectAdvertisingForm, self).__init__(*args, **kwargs)\n\n\nclass FeatureForm(forms.ModelForm):\n\n \"\"\"\n Project feature form for dynamic admin choices.\n\n This form converts the CharField into a ChoiceField on display. The\n underlying driver won't attempt to do validation on the choices, and so we\n can dynamically populate this list.\n \"\"\"\n\n feature_id = forms.ChoiceField()\n\n class Meta(object):\n model = Feature\n fields = ['projects', 'feature_id', 'default_true']\n\n def __init__(self, *args, **kwargs):\n super(FeatureForm, self).__init__(*args, **kwargs)\n self.fields['feature_id'].choices = Feature.FEATURES\n","path":"readthedocs/projects/forms.py"}],"string":"[\n {\n \"content\": \"# -*- coding: utf-8 -*-\\n\\\"\\\"\\\"Project forms.\\\"\\\"\\\"\\n\\nfrom __future__ import (\\n absolute_import,\\n division,\\n print_function,\\n unicode_literals,\\n)\\n\\nfrom random import choice\\n\\nfrom builtins import object\\nfrom django import forms\\nfrom django.conf import settings\\nfrom django.contrib.auth.models import User\\nfrom django.template.loader import render_to_string\\nfrom django.utils.safestring import mark_safe\\nfrom django.utils.translation import ugettext_lazy as _\\nfrom future.backports.urllib.parse import urlparse\\nfrom guardian.shortcuts import assign\\nfrom textclassifier.validators import ClassifierValidator\\n\\nfrom readthedocs.builds.constants import TAG\\nfrom readthedocs.core.utils import slugify, trigger_build\\nfrom readthedocs.core.utils.extend import SettingsOverrideObject\\nfrom readthedocs.integrations.models import Integration\\nfrom readthedocs.oauth.models import RemoteRepository\\nfrom readthedocs.projects import constants\\nfrom readthedocs.projects.constants import PUBLIC\\nfrom readthedocs.projects.exceptions import ProjectSpamError\\nfrom readthedocs.projects.models import (\\n Domain,\\n EmailHook,\\n Feature,\\n Project,\\n ProjectRelationship,\\n WebHook,\\n)\\nfrom readthedocs.redirects.models import Redirect\\n\\n\\nclass ProjectForm(forms.ModelForm):\\n\\n \\\"\\\"\\\"\\n Project form.\\n\\n :param user: If provided, add this user as a project user on save\\n \\\"\\\"\\\"\\n\\n required_css_class = 'required'\\n\\n def __init__(self, *args, **kwargs):\\n self.user = kwargs.pop('user', None)\\n super(ProjectForm, self).__init__(*args, **kwargs)\\n\\n def save(self, commit=True):\\n project = super(ProjectForm, self).save(commit)\\n if commit:\\n if self.user and not project.users.filter(pk=self.user.pk).exists():\\n project.users.add(self.user)\\n return project\\n\\n\\nclass ProjectTriggerBuildMixin(object):\\n\\n \\\"\\\"\\\"\\n Mixin to trigger build on form save.\\n\\n This should be replaced with signals instead of calling trigger_build\\n explicitly.\\n \\\"\\\"\\\"\\n\\n def save(self, commit=True):\\n \\\"\\\"\\\"Trigger build on commit save.\\\"\\\"\\\"\\n project = super(ProjectTriggerBuildMixin, self).save(commit)\\n if commit:\\n trigger_build(project=project)\\n return project\\n\\n\\nclass ProjectBackendForm(forms.Form):\\n\\n \\\"\\\"\\\"Get the import backend.\\\"\\\"\\\"\\n\\n backend = forms.CharField()\\n\\n\\nclass ProjectBasicsForm(ProjectForm):\\n\\n \\\"\\\"\\\"Form for basic project fields.\\\"\\\"\\\"\\n\\n class Meta(object):\\n model = Project\\n fields = ('name', 'repo', 'repo_type')\\n\\n remote_repository = forms.CharField(\\n widget=forms.HiddenInput(),\\n required=False,\\n )\\n\\n def __init__(self, *args, **kwargs):\\n show_advanced = kwargs.pop('show_advanced', False)\\n super(ProjectBasicsForm, self).__init__(*args, **kwargs)\\n if show_advanced:\\n self.fields['advanced'] = forms.BooleanField(\\n required=False,\\n label=_('Edit advanced project options'),\\n )\\n self.fields['repo'].widget.attrs['placeholder'] = self.placehold_repo()\\n self.fields['repo'].widget.attrs['required'] = True\\n\\n def save(self, commit=True):\\n \\\"\\\"\\\"Add remote repository relationship to the project instance.\\\"\\\"\\\"\\n instance = super(ProjectBasicsForm, self).save(commit)\\n remote_repo = self.cleaned_data.get('remote_repository', None)\\n if remote_repo:\\n if commit:\\n remote_repo.project = self.instance\\n remote_repo.save()\\n else:\\n instance.remote_repository = remote_repo\\n return instance\\n\\n def clean_name(self):\\n name = self.cleaned_data.get('name', '')\\n if not self.instance.pk:\\n potential_slug = slugify(name)\\n if Project.objects.filter(slug=potential_slug).exists():\\n raise forms.ValidationError(\\n _('Invalid project name, a project already exists with that name')) # yapf: disable # noqa\\n if not potential_slug:\\n # Check the generated slug won't be empty\\n raise forms.ValidationError(\\n _('Invalid project name'),\\n )\\n\\n return name\\n\\n def clean_remote_repository(self):\\n remote_repo = self.cleaned_data.get('remote_repository', None)\\n if not remote_repo:\\n return None\\n try:\\n return RemoteRepository.objects.get(\\n pk=remote_repo,\\n users=self.user,\\n )\\n except RemoteRepository.DoesNotExist:\\n raise forms.ValidationError(_('Repository invalid'))\\n\\n def placehold_repo(self):\\n return choice([\\n 'https://bitbucket.org/cherrypy/cherrypy',\\n 'https://bitbucket.org/birkenfeld/sphinx',\\n 'https://bitbucket.org/hpk42/tox',\\n 'https://github.com/zzzeek/sqlalchemy.git',\\n 'https://github.com/django/django.git',\\n 'https://github.com/fabric/fabric.git',\\n 'https://github.com/ericholscher/django-kong.git',\\n ])\\n\\n\\nclass ProjectExtraForm(ProjectForm):\\n\\n \\\"\\\"\\\"Additional project information form.\\\"\\\"\\\"\\n\\n class Meta(object):\\n model = Project\\n fields = (\\n 'description',\\n 'documentation_type',\\n 'language',\\n 'programming_language',\\n 'tags',\\n 'project_url',\\n )\\n\\n description = forms.CharField(\\n validators=[ClassifierValidator(raises=ProjectSpamError)],\\n required=False,\\n widget=forms.Textarea,\\n )\\n\\n\\nclass ProjectAdvancedForm(ProjectTriggerBuildMixin, ProjectForm):\\n\\n \\\"\\\"\\\"Advanced project option form.\\\"\\\"\\\"\\n\\n python_interpreter = forms.ChoiceField(\\n choices=constants.PYTHON_CHOICES,\\n initial='python',\\n help_text=_('The Python interpreter used to create the virtual '\\n 'environment.'),\\n )\\n\\n class Meta(object):\\n model = Project\\n fields = (\\n # Standard build edits\\n 'install_project',\\n 'requirements_file',\\n 'single_version',\\n 'conf_py_file',\\n 'default_branch',\\n 'default_version',\\n 'show_version_warning',\\n 'enable_pdf_build',\\n 'enable_epub_build',\\n # Privacy\\n 'privacy_level',\\n # 'version_privacy_level',\\n # Python specific\\n 'use_system_packages',\\n 'python_interpreter',\\n # Fringe\\n 'analytics_code',\\n )\\n\\n def __init__(self, *args, **kwargs):\\n super(ProjectAdvancedForm, self).__init__(*args, **kwargs)\\n\\n default_choice = (None, '-' * 9)\\n all_versions = self.instance.versions.values_list(\\n 'identifier', 'verbose_name'\\n )\\n self.fields['default_branch'].widget = forms.Select(\\n choices=[default_choice] + list(all_versions)\\n )\\n\\n active_versions = self.instance.all_active_versions().values_list(\\n 'slug', 'verbose_name'\\n )\\n self.fields['default_version'].widget = forms.Select(\\n choices=active_versions\\n )\\n\\n def clean_conf_py_file(self):\\n filename = self.cleaned_data.get('conf_py_file', '').strip()\\n if filename and 'conf.py' not in filename:\\n raise forms.ValidationError(\\n _('Your configuration file is invalid, make sure it contains '\\n 'conf.py in it.')) # yapf: disable\\n return filename\\n\\n\\nclass UpdateProjectForm(ProjectTriggerBuildMixin, ProjectBasicsForm,\\n ProjectExtraForm):\\n class Meta(object):\\n model = Project\\n fields = (\\n # Basics\\n 'name',\\n 'repo',\\n 'repo_type',\\n # Extra\\n 'description',\\n 'documentation_type',\\n 'language',\\n 'programming_language',\\n 'project_url',\\n 'tags',\\n )\\n\\n def clean_language(self):\\n language = self.cleaned_data['language']\\n project = self.instance\\n if project:\\n msg = _(\\n 'There is already a \\\"{lang}\\\" translation '\\n 'for the {proj} project.'\\n )\\n if project.translations.filter(language=language).exists():\\n raise forms.ValidationError(\\n msg.format(lang=language, proj=project.slug)\\n )\\n main_project = project.main_language_project\\n if main_project:\\n if main_project.language == language:\\n raise forms.ValidationError(\\n msg.format(lang=language, proj=main_project.slug)\\n )\\n siblings = (\\n main_project.translations\\n .filter(language=language)\\n .exclude(pk=project.pk)\\n .exists()\\n )\\n if siblings:\\n raise forms.ValidationError(\\n msg.format(lang=language, proj=main_project.slug)\\n )\\n return language\\n\\n\\nclass ProjectRelationshipBaseForm(forms.ModelForm):\\n\\n \\\"\\\"\\\"Form to add/update project relationships.\\\"\\\"\\\"\\n\\n parent = forms.CharField(widget=forms.HiddenInput(), required=False)\\n\\n class Meta(object):\\n model = ProjectRelationship\\n fields = '__all__'\\n\\n def __init__(self, *args, **kwargs):\\n self.project = kwargs.pop('project')\\n self.user = kwargs.pop('user')\\n super(ProjectRelationshipBaseForm, self).__init__(*args, **kwargs)\\n # Don't display the update form with an editable child, as it will be\\n # filtered out from the queryset anyways.\\n if hasattr(self, 'instance') and self.instance.pk is not None:\\n self.fields['child'].queryset = Project.objects.filter(pk=self.instance.child.pk)\\n else:\\n self.fields['child'].queryset = self.get_subproject_queryset()\\n\\n def clean_parent(self):\\n if self.project.superprojects.exists():\\n # This validation error is mostly for testing, users shouldn't see\\n # this in normal circumstances\\n raise forms.ValidationError(\\n _('Subproject nesting is not supported'))\\n return self.project\\n\\n def clean_child(self):\\n child = self.cleaned_data['child']\\n if child == self.project:\\n raise forms.ValidationError(\\n _('A project can not be a subproject of itself'))\\n return child\\n\\n def get_subproject_queryset(self):\\n \\\"\\\"\\\"\\n Return scrubbed subproject choice queryset.\\n\\n This removes projects that are either already a subproject of another\\n project, or are a superproject, as neither case is supported.\\n \\\"\\\"\\\"\\n queryset = (\\n Project.objects.for_admin_user(self.user)\\n .exclude(subprojects__isnull=False)\\n .exclude(superprojects__isnull=False)\\n .exclude(pk=self.project.pk))\\n return queryset\\n\\n\\nclass ProjectRelationshipForm(SettingsOverrideObject):\\n _default_class = ProjectRelationshipBaseForm\\n\\n\\nclass DualCheckboxWidget(forms.CheckboxInput):\\n\\n \\\"\\\"\\\"Checkbox with link to the version's built documentation.\\\"\\\"\\\"\\n\\n def __init__(self, version, attrs=None, check_test=bool):\\n super(DualCheckboxWidget, self).__init__(attrs, check_test)\\n self.version = version\\n\\n def render(self, name, value, attrs=None, renderer=None):\\n checkbox = super(DualCheckboxWidget, self).render(name, value, attrs, renderer)\\n icon = self.render_icon()\\n return mark_safe('{}{}'.format(checkbox, icon))\\n\\n def render_icon(self):\\n context = {\\n 'MEDIA_URL': settings.MEDIA_URL,\\n 'built': self.version.built,\\n 'uploaded': self.version.uploaded,\\n 'url': self.version.get_absolute_url(),\\n }\\n return render_to_string('projects/includes/icon_built.html', context)\\n\\n\\nclass BaseVersionsForm(forms.Form):\\n\\n \\\"\\\"\\\"Form for versions page.\\\"\\\"\\\"\\n\\n def save(self):\\n versions = self.project.versions.all()\\n for version in versions:\\n self.save_version(version)\\n default_version = self.cleaned_data.get('default-version', None)\\n if default_version:\\n self.project.default_version = default_version\\n self.project.save()\\n\\n def save_version(self, version):\\n \\\"\\\"\\\"Save version if there has been a change, trigger a rebuild.\\\"\\\"\\\"\\n new_value = self.cleaned_data.get(\\n 'version-{}'.format(version.slug),\\n None,\\n )\\n privacy_level = self.cleaned_data.get(\\n 'privacy-{}'.format(version.slug),\\n None,\\n )\\n if ((new_value is None or new_value == version.active) and\\n (privacy_level is None or privacy_level == version.privacy_level)): # yapf: disable # noqa\\n return\\n version.active = new_value\\n version.privacy_level = privacy_level\\n version.save()\\n if version.active and not version.built and not version.uploaded:\\n trigger_build(project=self.project, version=version)\\n\\n\\ndef build_versions_form(project):\\n \\\"\\\"\\\"Versions form with a list of versions and version privacy levels.\\\"\\\"\\\"\\n attrs = {\\n 'project': project,\\n }\\n versions_qs = project.versions.all() # Admin page, so show all versions\\n active = versions_qs.filter(active=True)\\n if active.exists():\\n choices = [(version.slug, version.verbose_name) for version in active]\\n attrs['default-version'] = forms.ChoiceField(\\n label=_('Default Version'),\\n choices=choices,\\n initial=project.get_default_version(),\\n )\\n for version in versions_qs:\\n field_name = 'version-{}'.format(version.slug)\\n privacy_name = 'privacy-{}'.format(version.slug)\\n if version.type == TAG:\\n label = '{} ({})'.format(\\n version.verbose_name,\\n version.identifier[:8],\\n )\\n else:\\n label = version.verbose_name\\n attrs[field_name] = forms.BooleanField(\\n label=label,\\n widget=DualCheckboxWidget(version),\\n initial=version.active,\\n required=False,\\n )\\n attrs[privacy_name] = forms.ChoiceField(\\n # This isn't a real label, but just a slug for the template\\n label='privacy',\\n choices=constants.PRIVACY_CHOICES,\\n initial=version.privacy_level,\\n )\\n return type(str('VersionsForm'), (BaseVersionsForm,), attrs)\\n\\n\\nclass BaseUploadHTMLForm(forms.Form):\\n content = forms.FileField(label=_('Zip file of HTML'))\\n overwrite = forms.BooleanField(required=False,\\n label=_('Overwrite existing HTML?'))\\n\\n def __init__(self, *args, **kwargs):\\n self.request = kwargs.pop('request', None)\\n super(BaseUploadHTMLForm, self).__init__(*args, **kwargs)\\n\\n def clean(self):\\n version_slug = self.cleaned_data['version']\\n filename = self.request.FILES['content']\\n version = self.project.versions.get(slug=version_slug)\\n\\n # Validation\\n if version.active and not self.cleaned_data.get('overwrite', False):\\n raise forms.ValidationError(_('That version is already active!'))\\n if not filename.name.endswith('zip'):\\n raise forms.ValidationError(_('Must upload a zip file.'))\\n\\n return self.cleaned_data\\n\\n\\ndef build_upload_html_form(project):\\n \\\"\\\"\\\"Upload HTML form with list of versions to upload HTML for.\\\"\\\"\\\"\\n attrs = {\\n 'project': project,\\n }\\n active = project.versions.public()\\n if active.exists():\\n choices = []\\n choices += [(version.slug, version.verbose_name) for version in active]\\n attrs['version'] = forms.ChoiceField(\\n label=_('Version of the project you are uploading HTML for'),\\n choices=choices,\\n )\\n return type('UploadHTMLForm', (BaseUploadHTMLForm,), attrs)\\n\\n\\nclass UserForm(forms.Form):\\n\\n \\\"\\\"\\\"Project user association form.\\\"\\\"\\\"\\n\\n user = forms.CharField()\\n\\n def __init__(self, *args, **kwargs):\\n self.project = kwargs.pop('project', None)\\n super(UserForm, self).__init__(*args, **kwargs)\\n\\n def clean_user(self):\\n name = self.cleaned_data['user']\\n user_qs = User.objects.filter(username=name)\\n if not user_qs.exists():\\n raise forms.ValidationError(\\n _('User {name} does not exist').format(name=name))\\n self.user = user_qs[0]\\n return name\\n\\n def save(self):\\n self.project.users.add(self.user)\\n # Force update of permissions\\n assign('view_project', self.user, self.project)\\n return self.user\\n\\n\\nclass EmailHookForm(forms.Form):\\n\\n \\\"\\\"\\\"Project email notification form.\\\"\\\"\\\"\\n\\n email = forms.EmailField()\\n\\n def __init__(self, *args, **kwargs):\\n self.project = kwargs.pop('project', None)\\n super(EmailHookForm, self).__init__(*args, **kwargs)\\n\\n def clean_email(self):\\n self.email = EmailHook.objects.get_or_create(\\n email=self.cleaned_data['email'], project=self.project)[0]\\n return self.email\\n\\n def save(self):\\n self.project.emailhook_notifications.add(self.email)\\n return self.project\\n\\n\\nclass WebHookForm(forms.ModelForm):\\n\\n \\\"\\\"\\\"Project webhook form.\\\"\\\"\\\"\\n\\n def __init__(self, *args, **kwargs):\\n self.project = kwargs.pop('project', None)\\n super(WebHookForm, self).__init__(*args, **kwargs)\\n\\n def save(self, commit=True):\\n self.webhook = WebHook.objects.get_or_create(\\n url=self.cleaned_data['url'], project=self.project)[0]\\n self.project.webhook_notifications.add(self.webhook)\\n return self.project\\n\\n class Meta:\\n model = WebHook\\n fields = ['url']\\n\\n\\nclass TranslationBaseForm(forms.Form):\\n\\n \\\"\\\"\\\"Project translation form.\\\"\\\"\\\"\\n\\n project = forms.ChoiceField()\\n\\n def __init__(self, *args, **kwargs):\\n self.parent = kwargs.pop('parent', None)\\n self.user = kwargs.pop('user')\\n super(TranslationBaseForm, self).__init__(*args, **kwargs)\\n self.fields['project'].choices = self.get_choices()\\n\\n def get_choices(self):\\n return [\\n (project.slug, '{project} ({lang})'.format(\\n project=project.slug, lang=project.get_language_display()))\\n for project in self.get_translation_queryset().all()\\n ]\\n\\n def clean_project(self):\\n translation_project_slug = self.cleaned_data['project']\\n\\n # Ensure parent project isn't already itself a translation\\n if self.parent.main_language_project is not None:\\n msg = 'Project \\\"{project}\\\" is already a translation'\\n raise forms.ValidationError(\\n (_(msg).format(project=self.parent.slug))\\n )\\n\\n project_translation_qs = self.get_translation_queryset().filter(\\n slug=translation_project_slug\\n )\\n if not project_translation_qs.exists():\\n msg = 'Project \\\"{project}\\\" does not exist.'\\n raise forms.ValidationError(\\n (_(msg).format(project=translation_project_slug))\\n )\\n self.translation = project_translation_qs.first()\\n if self.translation.language == self.parent.language:\\n msg = (\\n 'Both projects can not have the same language ({lang}).'\\n )\\n raise forms.ValidationError(\\n _(msg).format(lang=self.parent.get_language_display())\\n )\\n exists_translation = (\\n self.parent.translations\\n .filter(language=self.translation.language)\\n .exists()\\n )\\n if exists_translation:\\n msg = (\\n 'This project already has a translation for {lang}.'\\n )\\n raise forms.ValidationError(\\n _(msg).format(lang=self.translation.get_language_display())\\n )\\n is_parent = self.translation.translations.exists()\\n if is_parent:\\n msg = (\\n 'A project with existing translations '\\n 'can not be added as a project translation.'\\n )\\n raise forms.ValidationError(_(msg))\\n return translation_project_slug\\n\\n def get_translation_queryset(self):\\n queryset = (\\n Project.objects.for_admin_user(self.user)\\n .filter(main_language_project=None)\\n .exclude(pk=self.parent.pk)\\n )\\n return queryset\\n\\n def save(self):\\n project = self.parent.translations.add(self.translation)\\n # Run symlinking and other sync logic to make sure we are in a good\\n # state.\\n self.parent.save()\\n return project\\n\\n\\nclass TranslationForm(SettingsOverrideObject):\\n _default_class = TranslationBaseForm\\n\\n\\nclass RedirectForm(forms.ModelForm):\\n\\n \\\"\\\"\\\"Form for project redirects.\\\"\\\"\\\"\\n\\n class Meta(object):\\n model = Redirect\\n fields = ['redirect_type', 'from_url', 'to_url']\\n\\n def __init__(self, *args, **kwargs):\\n self.project = kwargs.pop('project', None)\\n super(RedirectForm, self).__init__(*args, **kwargs)\\n\\n def save(self, **_): # pylint: disable=arguments-differ\\n # TODO this should respect the unused argument `commit`. It's not clear\\n # why this needs to be a call to `create`, instead of relying on the\\n # super `save()` call.\\n redirect = Redirect.objects.create(\\n project=self.project,\\n redirect_type=self.cleaned_data['redirect_type'],\\n from_url=self.cleaned_data['from_url'],\\n to_url=self.cleaned_data['to_url'],\\n )\\n return redirect\\n\\n\\nclass DomainBaseForm(forms.ModelForm):\\n\\n \\\"\\\"\\\"Form to configure a custom domain name for a project.\\\"\\\"\\\"\\n\\n project = forms.CharField(widget=forms.HiddenInput(), required=False)\\n\\n class Meta(object):\\n model = Domain\\n exclude = ['machine', 'cname', 'count'] # pylint: disable=modelform-uses-exclude\\n\\n def __init__(self, *args, **kwargs):\\n self.project = kwargs.pop('project', None)\\n super(DomainBaseForm, self).__init__(*args, **kwargs)\\n\\n def clean_project(self):\\n return self.project\\n\\n def clean_domain(self):\\n parsed = urlparse(self.cleaned_data['domain'])\\n if parsed.scheme or parsed.netloc:\\n domain_string = parsed.netloc\\n else:\\n domain_string = parsed.path\\n return domain_string\\n\\n def clean_canonical(self):\\n canonical = self.cleaned_data['canonical']\\n _id = self.initial.get('id')\\n if canonical and Domain.objects.filter(\\n project=self.project, canonical=True\\n ).exclude(pk=_id).exists():\\n raise forms.ValidationError(\\n _('Only 1 Domain can be canonical at a time.'))\\n return canonical\\n\\n\\nclass DomainForm(SettingsOverrideObject):\\n _default_class = DomainBaseForm\\n\\n\\nclass IntegrationForm(forms.ModelForm):\\n\\n \\\"\\\"\\\"\\n Form to add an integration.\\n\\n This limits the choices of the integration type to webhook integration types\\n \\\"\\\"\\\"\\n\\n project = forms.CharField(widget=forms.HiddenInput(), required=False)\\n\\n class Meta(object):\\n model = Integration\\n exclude = ['provider_data', 'exchanges'] # pylint: disable=modelform-uses-exclude\\n\\n def __init__(self, *args, **kwargs):\\n self.project = kwargs.pop('project', None)\\n super(IntegrationForm, self).__init__(*args, **kwargs)\\n # Alter the integration type choices to only provider webhooks\\n self.fields['integration_type'].choices = Integration.WEBHOOK_INTEGRATIONS # yapf: disable # noqa\\n\\n def clean_project(self):\\n return self.project\\n\\n def save(self, commit=True):\\n self.instance = Integration.objects.subclass(self.instance)\\n return super(IntegrationForm, self).save(commit)\\n\\n\\nclass ProjectAdvertisingForm(forms.ModelForm):\\n\\n \\\"\\\"\\\"Project promotion opt-out form.\\\"\\\"\\\"\\n\\n class Meta(object):\\n model = Project\\n fields = ['allow_promos']\\n\\n def __init__(self, *args, **kwargs):\\n self.project = kwargs.pop('project', None)\\n super(ProjectAdvertisingForm, self).__init__(*args, **kwargs)\\n\\n\\nclass FeatureForm(forms.ModelForm):\\n\\n \\\"\\\"\\\"\\n Project feature form for dynamic admin choices.\\n\\n This form converts the CharField into a ChoiceField on display. The\\n underlying driver won't attempt to do validation on the choices, and so we\\n can dynamically populate this list.\\n \\\"\\\"\\\"\\n\\n feature_id = forms.ChoiceField()\\n\\n class Meta(object):\\n model = Feature\\n fields = ['projects', 'feature_id', 'default_true']\\n\\n def __init__(self, *args, **kwargs):\\n super(FeatureForm, self).__init__(*args, **kwargs)\\n self.fields['feature_id'].choices = Feature.FEATURES\\n\",\n \"path\": \"readthedocs/projects/forms.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/readthedocs/projects/forms.py b/readthedocs/projects/forms.py\nindex e8bff7505f9..c21333e76d5 100644\n--- a/readthedocs/projects/forms.py\n+++ b/readthedocs/projects/forms.py\n@@ -222,7 +222,7 @@ def __init__(self, *args, **kwargs):\n \n default_choice = (None, '-' * 9)\n all_versions = self.instance.versions.values_list(\n- 'slug', 'verbose_name'\n+ 'identifier', 'verbose_name'\n )\n self.fields['default_branch'].widget = forms.Select(\n choices=[default_choice] + list(all_versions)\ndiff --git a/readthedocs/rtd_tests/tests/test_project_forms.py b/readthedocs/rtd_tests/tests/test_project_forms.py\nindex a407522505f..5dbec930400 100644\n--- a/readthedocs/rtd_tests/tests/test_project_forms.py\n+++ b/readthedocs/rtd_tests/tests/test_project_forms.py\n@@ -174,6 +174,7 @@ def setUp(self):\n slug='public-1',\n active=True,\n privacy_level=PUBLIC,\n+ identifier='public-1',\n )\n get(\n Version,\n@@ -181,6 +182,7 @@ def setUp(self):\n slug='public-2',\n active=True,\n privacy_level=PUBLIC,\n+ identifier='public-2',\n )\n get(\n Version,\n@@ -188,6 +190,15 @@ def setUp(self):\n slug='public-3',\n active=False,\n privacy_level=PROTECTED,\n+ identifier='public-3',\n+ )\n+ get(\n+ Version,\n+ project=self.project,\n+ slug='public-4',\n+ active=False,\n+ privacy_level=PUBLIC,\n+ identifier='public/4'\n )\n get(\n Version,\n@@ -195,6 +206,7 @@ def setUp(self):\n slug='private',\n active=True,\n privacy_level=PRIVATE,\n+ identifier='private',\n )\n get(\n Version,\n@@ -202,6 +214,7 @@ def setUp(self):\n slug='protected',\n active=True,\n privacy_level=PROTECTED,\n+ identifier='protected',\n )\n \n def test_list_only_active_versions_on_default_version(self):\n@@ -222,12 +235,12 @@ def test_list_all_versions_on_default_branch(self):\n self.assertTrue(self.project.versions.filter(slug=LATEST).exists())\n self.assertEqual(\n set(\n- slug\n- for slug, _ in form.fields['default_branch'].widget.choices\n+ identifier\n+ for identifier, _ in form.fields['default_branch'].widget.choices\n ),\n {\n- None, 'latest', 'public-1', 'public-2',\n- 'public-3', 'protected', 'private'\n+ None, 'master', 'public-1', 'public-2',\n+ 'public-3', 'public/4', 'protected', 'private'\n },\n )\n \n"}}},{"rowIdx":5489,"cells":{"in_source_id":{"kind":"string","value":"cloud-custodian__cloud-custodian-4868"},"issue":{"kind":"string","value":"c7n-org not respecting policy org region restrictions\nPushing two policy at org level to be deployed in separate regions. This is what I am doing:\r\n\r\nc7n-org run -c AWS/base/provisioning/NonProd/accounts.yml -r all -s /tmp/out -u AWS/policies/nonprod/01-common/asg-off-hours.yml\r\n\r\nPolicies look like this:\r\n\r\npolicies:\r\n- name: policy-1\r\n region: us-east-1\r\n resource: asg\r\n- name: policy-2\r\n region: us-east-2\r\n resource: ec2\r\n\r\nbut its pushing policy in all regions\n"},"before_files":{"kind":"list like","value":[{"content":"# Copyright 2017 Capital One Services, LLC\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\"\"\"Run a custodian policy across an organization's accounts\n\"\"\"\n\nfrom collections import Counter\nimport logging\nimport os\nimport time\nimport subprocess\nimport six\nimport sys\n\nimport multiprocessing\nfrom concurrent.futures import (\n ProcessPoolExecutor,\n as_completed)\nimport yaml\n\nimport boto3\nfrom botocore.compat import OrderedDict\nfrom botocore.exceptions import ClientError\nimport click\nimport jsonschema\n\nfrom c7n.credentials import assumed_session, SessionFactory\nfrom c7n.executor import MainThreadExecutor\nfrom c7n.config import Config\nfrom c7n.policy import PolicyCollection\nfrom c7n.provider import get_resource_class\nfrom c7n.reports.csvout import Formatter, fs_record_set\nfrom c7n.resources import load_resources\nfrom c7n.utils import CONN_CACHE, dumps\n\nfrom c7n_org.utils import environ, account_tags\nfrom c7n.utils import UnicodeWriter\n\nlog = logging.getLogger('c7n_org')\n\n# Workaround OSX issue, note this exists for py2 but there\n# isn't anything we can do in that case.\n# https://bugs.python.org/issue33725\nif sys.platform == 'darwin' and (\n sys.version_info.major > 3 and sys.version_info.minor > 4):\n multiprocessing.set_start_method('spawn')\n\n\nWORKER_COUNT = int(\n os.environ.get('C7N_ORG_PARALLEL', multiprocessing.cpu_count() * 4))\n\n\nCONFIG_SCHEMA = {\n '$schema': 'http://json-schema.org/schema#',\n 'id': 'http://schema.cloudcustodian.io/v0/orgrunner.json',\n 'definitions': {\n 'account': {\n 'type': 'object',\n 'additionalProperties': True,\n 'anyOf': [\n {'required': ['role', 'account_id']},\n {'required': ['profile', 'account_id']}\n ],\n 'properties': {\n 'name': {'type': 'string'},\n 'email': {'type': 'string'},\n 'account_id': {'type': 'string'},\n 'profile': {'type': 'string', 'minLength': 3},\n 'tags': {'type': 'array', 'items': {'type': 'string'}},\n 'regions': {'type': 'array', 'items': {'type': 'string'}},\n 'role': {'oneOf': [\n {'type': 'array', 'items': {'type': 'string'}},\n {'type': 'string', 'minLength': 3}]},\n 'external_id': {'type': 'string'},\n 'vars': {'type': 'object'},\n }\n },\n 'subscription': {\n 'type': 'object',\n 'additionalProperties': False,\n 'required': ['subscription_id'],\n 'properties': {\n 'subscription_id': {'type': 'string'},\n 'tags': {'type': 'array', 'items': {'type': 'string'}},\n 'name': {'type': 'string'},\n 'vars': {'type': 'object'},\n }\n },\n 'project': {\n 'type': 'object',\n 'additionalProperties': False,\n 'required': ['project_id'],\n 'properties': {\n 'project_id': {'type': 'string'},\n 'tags': {'type': 'array', 'items': {'type': 'string'}},\n 'name': {'type': 'string'},\n 'vars': {'type': 'object'},\n }\n },\n },\n 'type': 'object',\n 'additionalProperties': False,\n 'oneOf': [\n {'required': ['accounts']},\n {'required': ['projects']},\n {'required': ['subscriptions']}\n ],\n 'properties': {\n 'vars': {'type': 'object'},\n 'accounts': {\n 'type': 'array',\n 'items': {'$ref': '#/definitions/account'}\n },\n 'subscriptions': {\n 'type': 'array',\n 'items': {'$ref': '#/definitions/subscription'}\n },\n 'projects': {\n 'type': 'array',\n 'items': {'$ref': '#/definitions/project'}\n }\n }\n}\n\n\n@click.group()\ndef cli():\n \"\"\"custodian organization multi-account runner.\"\"\"\n\n\nclass LogFilter(object):\n \"\"\"We want to keep the main c7n-org cli output to be readable.\n\n We previously did so via squelching custodian's log output via\n level filter on the logger, however doing that meant that log\n outputs stored to output locations were also squelched.\n\n We effectively want differential handling at the top level logger\n stream handler, ie. we want `custodian` log messages to propagate\n to the root logger based on level, but we also want them to go the\n custodian logger's directly attached handlers on debug level.\n \"\"\"\n\n def filter(self, r):\n if not r.name.startswith('custodian'):\n return 1\n elif r.levelno >= logging.WARNING:\n return 1\n return 0\n\n\ndef init(config, use, debug, verbose, accounts, tags, policies, resource=None, policy_tags=()):\n level = verbose and logging.DEBUG or logging.INFO\n logging.basicConfig(\n level=level,\n format=\"%(asctime)s: %(name)s:%(levelname)s %(message)s\")\n\n logging.getLogger().setLevel(level)\n logging.getLogger('botocore').setLevel(logging.ERROR)\n logging.getLogger('s3transfer').setLevel(logging.WARNING)\n logging.getLogger('custodian.s3').setLevel(logging.ERROR)\n logging.getLogger('urllib3').setLevel(logging.WARNING)\n\n # Filter out custodian log messages on console output if not\n # at warning level or higher, see LogFilter docs and #2674\n for h in logging.getLogger().handlers:\n if isinstance(h, logging.StreamHandler):\n h.addFilter(LogFilter())\n\n with open(config, 'rb') as fh:\n accounts_config = yaml.safe_load(fh.read())\n jsonschema.validate(accounts_config, CONFIG_SCHEMA)\n\n if use:\n with open(use) as fh:\n custodian_config = yaml.safe_load(fh.read())\n else:\n custodian_config = {}\n\n accounts_config['accounts'] = list(accounts_iterator(accounts_config))\n filter_policies(custodian_config, policy_tags, policies, resource)\n filter_accounts(accounts_config, tags, accounts)\n\n load_resources()\n MainThreadExecutor.c7n_async = False\n executor = debug and MainThreadExecutor or ProcessPoolExecutor\n return accounts_config, custodian_config, executor\n\n\ndef resolve_regions(regions):\n if 'all' in regions:\n client = boto3.client('ec2')\n return [region['RegionName'] for region in client.describe_regions()['Regions']]\n if not regions:\n return ('us-east-1', 'us-west-2')\n return regions\n\n\ndef get_session(account, session_name, region):\n if account.get('role'):\n roles = account['role']\n if isinstance(roles, six.string_types):\n roles = [roles]\n s = None\n for r in roles:\n try:\n s = assumed_session(\n r, session_name, region=region,\n external_id=account.get('external_id'),\n session=s)\n except ClientError as e:\n log.error(\n \"unable to obtain credentials for account:%s role:%s error:%s\",\n account['name'], r, e)\n raise\n return s\n elif account.get('profile'):\n return SessionFactory(region, account['profile'])()\n else:\n raise ValueError(\n \"No profile or role assume specified for account %s\" % account)\n\n\ndef filter_accounts(accounts_config, tags, accounts, not_accounts=None):\n filtered_accounts = []\n for a in accounts_config.get('accounts', ()):\n if not_accounts and a['name'] in not_accounts:\n continue\n if accounts and a['name'] not in accounts:\n continue\n if tags:\n found = set()\n for t in tags:\n if t in a.get('tags', ()):\n found.add(t)\n if not found == set(tags):\n continue\n filtered_accounts.append(a)\n accounts_config['accounts'] = filtered_accounts\n\n\ndef filter_policies(policies_config, tags, policies, resource, not_policies=None):\n filtered_policies = []\n for p in policies_config.get('policies', ()):\n if not_policies and p['name'] in not_policies:\n continue\n if policies and p['name'] not in policies:\n continue\n if resource and p['resource'] != resource:\n continue\n if tags:\n found = set()\n for t in tags:\n if t in p.get('tags', ()):\n found.add(t)\n if not found == set(tags):\n continue\n filtered_policies.append(p)\n policies_config['policies'] = filtered_policies\n\n\ndef report_account(account, region, policies_config, output_path, cache_path, debug):\n output_path = os.path.join(output_path, account['name'], region)\n cache_path = os.path.join(cache_path, \"%s-%s.cache\" % (account['name'], region))\n\n config = Config.empty(\n region=region,\n output_dir=output_path,\n account_id=account['account_id'], metrics_enabled=False,\n cache=cache_path, log_group=None, profile=None, external_id=None)\n\n if account.get('role'):\n config['assume_role'] = account['role']\n config['external_id'] = account.get('external_id')\n elif account.get('profile'):\n config['profile'] = account['profile']\n\n policies = PolicyCollection.from_data(policies_config, config)\n records = []\n for p in policies:\n # initializee policy execution context for output access\n p.ctx.initialize()\n log.debug(\n \"Report policy:%s account:%s region:%s path:%s\",\n p.name, account['name'], region, output_path)\n policy_records = fs_record_set(p.ctx.log_dir, p.name)\n for r in policy_records:\n r['policy'] = p.name\n r['region'] = p.options.region\n r['account'] = account['name']\n for t in account.get('tags', ()):\n if ':' in t:\n k, v = t.split(':', 1)\n r[k] = v\n records.extend(policy_records)\n return records\n\n\n@cli.command()\n@click.option('-c', '--config', required=True, help=\"Accounts config file\")\n@click.option('-f', '--output', type=click.File('w'), default='-', help=\"Output File\")\n@click.option('-u', '--use', required=True)\n@click.option('-s', '--output-dir', required=True, type=click.Path())\n@click.option('-a', '--accounts', multiple=True, default=None)\n@click.option('--field', multiple=True)\n@click.option('--no-default-fields', default=False, is_flag=True)\n@click.option('-t', '--tags', multiple=True, default=None, help=\"Account tag filter\")\n@click.option('-r', '--region', default=None, multiple=True)\n@click.option('--debug', default=False, is_flag=True)\n@click.option('-v', '--verbose', default=False, help=\"Verbose\", is_flag=True)\n@click.option('-p', '--policy', multiple=True)\n@click.option('-l', '--policytags', 'policy_tags',\n multiple=True, default=None, help=\"Policy tag filter\")\n@click.option('--format', default='csv', type=click.Choice(['csv', 'json']))\n@click.option('--resource', default=None)\n@click.option('--cache-path', required=False, type=click.Path(), default=\"~/.cache/c7n-org\")\ndef report(config, output, use, output_dir, accounts,\n field, no_default_fields, tags, region, debug, verbose,\n policy, policy_tags, format, resource, cache_path):\n \"\"\"report on a cross account policy execution.\"\"\"\n accounts_config, custodian_config, executor = init(\n config, use, debug, verbose, accounts, tags, policy,\n resource=resource, policy_tags=policy_tags)\n\n resource_types = set()\n for p in custodian_config.get('policies'):\n resource_types.add(p['resource'])\n if len(resource_types) > 1:\n raise ValueError(\"can only report on one resource type at a time\")\n elif not len(custodian_config['policies']) > 0:\n raise ValueError(\"no matching policies found\")\n\n records = []\n with executor(max_workers=WORKER_COUNT) as w:\n futures = {}\n for a in accounts_config.get('accounts', ()):\n for r in resolve_regions(region or a.get('regions', ())):\n futures[w.submit(\n report_account,\n a, r,\n custodian_config,\n output_dir,\n cache_path,\n debug)] = (a, r)\n\n for f in as_completed(futures):\n a, r = futures[f]\n if f.exception():\n if debug:\n raise\n log.warning(\n \"Error running policy in %s @ %s exception: %s\",\n a['name'], r, f.exception())\n records.extend(f.result())\n\n log.debug(\n \"Found %d records across %d accounts and %d policies\",\n len(records), len(accounts_config['accounts']),\n len(custodian_config['policies']))\n\n if format == 'json':\n dumps(records, output, indent=2)\n return\n\n prefix_fields = OrderedDict(\n (('Account', 'account'), ('Region', 'region'), ('Policy', 'policy')))\n config = Config.empty()\n\n factory = get_resource_class(list(resource_types)[0])\n formatter = Formatter(\n factory.resource_type,\n extra_fields=field,\n include_default_fields=not(no_default_fields),\n include_region=False,\n include_policy=False,\n fields=prefix_fields)\n\n rows = formatter.to_csv(records, unique=False)\n writer = UnicodeWriter(output, formatter.headers())\n writer.writerow(formatter.headers())\n writer.writerows(rows)\n\n\ndef _get_env_creds(session, region):\n creds = session._session.get_credentials()\n env = {}\n env['AWS_ACCESS_KEY_ID'] = creds.access_key\n env['AWS_SECRET_ACCESS_KEY'] = creds.secret_key\n env['AWS_SESSION_TOKEN'] = creds.token\n env['AWS_DEFAULT_REGION'] = region\n return env\n\n\ndef run_account_script(account, region, output_dir, debug, script_args):\n try:\n session = get_session(account, \"org-script\", region)\n except ClientError:\n return 1\n\n env = os.environ.copy()\n env.update(_get_env_creds(session, region))\n\n log.info(\"running script on account:%s region:%s script: `%s`\",\n account['name'], region, \" \".join(script_args))\n\n if debug:\n subprocess.check_call(args=script_args, env=env)\n return 0\n\n output_dir = os.path.join(output_dir, account['name'], region)\n if not os.path.exists(output_dir):\n os.makedirs(output_dir)\n\n with open(os.path.join(output_dir, 'stdout'), 'wb') as stdout:\n with open(os.path.join(output_dir, 'stderr'), 'wb') as stderr:\n return subprocess.call(\n args=script_args, env=env, stdout=stdout, stderr=stderr)\n\n\n@cli.command(name='run-script', context_settings=dict(ignore_unknown_options=True))\n@click.option('-c', '--config', required=True, help=\"Accounts config file\")\n@click.option('-s', '--output-dir', required=True, type=click.Path())\n@click.option('-a', '--accounts', multiple=True, default=None)\n@click.option('-t', '--tags', multiple=True, default=None, help=\"Account tag filter\")\n@click.option('-r', '--region', default=None, multiple=True)\n@click.option('--echo', default=False, is_flag=True)\n@click.option('--serial', default=False, is_flag=True)\n@click.argument('script_args', nargs=-1, type=click.UNPROCESSED)\ndef run_script(config, output_dir, accounts, tags, region, echo, serial, script_args):\n \"\"\"run an aws script across accounts\"\"\"\n # TODO count up on success / error / error list by account\n accounts_config, custodian_config, executor = init(\n config, None, serial, True, accounts, tags, (), ())\n\n if echo:\n print(\"command to run: `%s`\" % (\" \".join(script_args)))\n return\n\n # Support fully quoted scripts, which are common to avoid parameter\n # overlap with c7n-org run-script.\n if len(script_args) == 1 and \" \" in script_args[0]:\n script_args = script_args[0].split()\n\n with executor(max_workers=WORKER_COUNT) as w:\n futures = {}\n for a in accounts_config.get('accounts', ()):\n for r in resolve_regions(region or a.get('regions', ())):\n futures[\n w.submit(run_account_script, a, r, output_dir,\n serial, script_args)] = (a, r)\n for f in as_completed(futures):\n a, r = futures[f]\n if f.exception():\n if serial:\n raise\n log.warning(\n \"Error running script in %s @ %s exception: %s\",\n a['name'], r, f.exception())\n exit_code = f.result()\n if exit_code == 0:\n log.info(\n \"ran script on account:%s region:%s script: `%s`\",\n a['name'], r, \" \".join(script_args))\n else:\n log.info(\n \"error running script on account:%s region:%s script: `%s`\",\n a['name'], r, \" \".join(script_args))\n\n\ndef accounts_iterator(config):\n for a in config.get('accounts', ()):\n yield a\n for a in config.get('subscriptions', ()):\n d = {'account_id': a['subscription_id'],\n 'name': a.get('name', a['subscription_id']),\n 'regions': ['global'],\n 'tags': a.get('tags', ())}\n yield d\n for a in config.get('projects', ()):\n d = {'account_id': a['project_id'],\n 'name': a.get('name', a['project_id']),\n 'regions': ['global'],\n 'tags': a.get('tags', ())}\n yield d\n\n\ndef run_account(account, region, policies_config, output_path,\n cache_period, cache_path, metrics, dryrun, debug):\n \"\"\"Execute a set of policies on an account.\n \"\"\"\n logging.getLogger('custodian.output').setLevel(logging.ERROR + 1)\n CONN_CACHE.session = None\n CONN_CACHE.time = None\n\n # allow users to specify interpolated output paths\n if '{' not in output_path:\n output_path = os.path.join(output_path, account['name'], region)\n\n cache_path = os.path.join(cache_path, \"%s-%s.cache\" % (account['account_id'], region))\n\n config = Config.empty(\n region=region, cache=cache_path,\n cache_period=cache_period, dryrun=dryrun, output_dir=output_path,\n account_id=account['account_id'], metrics_enabled=metrics,\n log_group=None, profile=None, external_id=None)\n\n env_vars = account_tags(account)\n\n if account.get('role'):\n if isinstance(account['role'], six.string_types):\n config['assume_role'] = account['role']\n config['external_id'] = account.get('external_id')\n else:\n env_vars.update(\n _get_env_creds(get_session(account, 'custodian', region), region))\n\n elif account.get('profile'):\n config['profile'] = account['profile']\n\n policies = PolicyCollection.from_data(policies_config, config)\n policy_counts = {}\n success = True\n st = time.time()\n\n with environ(**env_vars):\n for p in policies:\n # Variable expansion and non schema validation (not optional)\n p.expand_variables(p.get_variables(account.get('vars', {})))\n p.validate()\n\n log.debug(\n \"Running policy:%s account:%s region:%s\",\n p.name, account['name'], region)\n try:\n resources = p.run()\n policy_counts[p.name] = resources and len(resources) or 0\n if not resources:\n continue\n if not config.dryrun and p.execution_mode != 'pull':\n log.info(\"Ran account:%s region:%s policy:%s provisioned time:%0.2f\",\n account['name'], region, p.name, time.time() - st)\n continue\n log.info(\n \"Ran account:%s region:%s policy:%s matched:%d time:%0.2f\",\n account['name'], region, p.name, len(resources),\n time.time() - st)\n except ClientError as e:\n success = False\n if e.response['Error']['Code'] == 'AccessDenied':\n log.warning('Access denied api:%s policy:%s account:%s region:%s',\n e.operation_name, p.name, account['name'], region)\n return policy_counts, success\n log.error(\n \"Exception running policy:%s account:%s region:%s error:%s\",\n p.name, account['name'], region, e)\n continue\n except Exception as e:\n success = False\n log.error(\n \"Exception running policy:%s account:%s region:%s error:%s\",\n p.name, account['name'], region, e)\n if not debug:\n continue\n import traceback, pdb, sys\n traceback.print_exc()\n pdb.post_mortem(sys.exc_info()[-1])\n raise\n\n return policy_counts, success\n\n\n@cli.command(name='run')\n@click.option('-c', '--config', required=True, help=\"Accounts config file\")\n@click.option(\"-u\", \"--use\", required=True)\n@click.option('-s', '--output-dir', required=True, type=click.Path())\n@click.option('-a', '--accounts', multiple=True, default=None)\n@click.option('-t', '--tags', multiple=True, default=None, help=\"Account tag filter\")\n@click.option('-r', '--region', default=None, multiple=True)\n@click.option('-p', '--policy', multiple=True)\n@click.option('-l', '--policytags', 'policy_tags',\n multiple=True, default=None, help=\"Policy tag filter\")\n@click.option('--cache-period', default=15, type=int)\n@click.option('--cache-path', required=False,\n type=click.Path(\n writable=True, readable=True, exists=True,\n resolve_path=True, allow_dash=False,\n file_okay=False, dir_okay=True),\n default=None)\n@click.option(\"--metrics\", default=False, is_flag=True)\n@click.option(\"--metrics-uri\", default=None, help=\"Configure provider metrics target\")\n@click.option(\"--dryrun\", default=False, is_flag=True)\n@click.option('--debug', default=False, is_flag=True)\n@click.option('-v', '--verbose', default=False, help=\"Verbose\", is_flag=True)\ndef run(config, use, output_dir, accounts, tags, region,\n policy, policy_tags, cache_period, cache_path, metrics,\n dryrun, debug, verbose, metrics_uri):\n \"\"\"run a custodian policy across accounts\"\"\"\n accounts_config, custodian_config, executor = init(\n config, use, debug, verbose, accounts, tags, policy, policy_tags=policy_tags)\n policy_counts = Counter()\n success = True\n\n if metrics_uri:\n metrics = metrics_uri\n\n if not cache_path:\n cache_path = os.path.expanduser(\"~/.cache/c7n-org\")\n if not os.path.exists(cache_path):\n os.makedirs(cache_path)\n\n with executor(max_workers=WORKER_COUNT) as w:\n futures = {}\n for a in accounts_config['accounts']:\n for r in resolve_regions(region or a.get('regions', ())):\n futures[w.submit(\n run_account,\n a, r,\n custodian_config,\n output_dir,\n cache_period,\n cache_path,\n metrics,\n dryrun,\n debug)] = (a, r)\n\n for f in as_completed(futures):\n a, r = futures[f]\n if f.exception():\n if debug:\n raise\n log.warning(\n \"Error running policy in %s @ %s exception: %s\",\n a['name'], r, f.exception())\n\n account_region_pcounts, account_region_success = f.result()\n for p in account_region_pcounts:\n policy_counts[p] += account_region_pcounts[p]\n\n if not account_region_success:\n success = False\n\n log.info(\"Policy resource counts %s\" % policy_counts)\n\n if not success:\n sys.exit(1)\n","path":"tools/c7n_org/c7n_org/cli.py"}],"string":"[\n {\n \"content\": \"# Copyright 2017 Capital One Services, LLC\\n#\\n# Licensed under the Apache License, Version 2.0 (the \\\"License\\\");\\n# you may not use this file except in compliance with the License.\\n# You may obtain a copy of the License at\\n#\\n# http://www.apache.org/licenses/LICENSE-2.0\\n#\\n# Unless required by applicable law or agreed to in writing, software\\n# distributed under the License is distributed on an \\\"AS IS\\\" BASIS,\\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\\n# See the License for the specific language governing permissions and\\n# limitations under the License.\\n\\\"\\\"\\\"Run a custodian policy across an organization's accounts\\n\\\"\\\"\\\"\\n\\nfrom collections import Counter\\nimport logging\\nimport os\\nimport time\\nimport subprocess\\nimport six\\nimport sys\\n\\nimport multiprocessing\\nfrom concurrent.futures import (\\n ProcessPoolExecutor,\\n as_completed)\\nimport yaml\\n\\nimport boto3\\nfrom botocore.compat import OrderedDict\\nfrom botocore.exceptions import ClientError\\nimport click\\nimport jsonschema\\n\\nfrom c7n.credentials import assumed_session, SessionFactory\\nfrom c7n.executor import MainThreadExecutor\\nfrom c7n.config import Config\\nfrom c7n.policy import PolicyCollection\\nfrom c7n.provider import get_resource_class\\nfrom c7n.reports.csvout import Formatter, fs_record_set\\nfrom c7n.resources import load_resources\\nfrom c7n.utils import CONN_CACHE, dumps\\n\\nfrom c7n_org.utils import environ, account_tags\\nfrom c7n.utils import UnicodeWriter\\n\\nlog = logging.getLogger('c7n_org')\\n\\n# Workaround OSX issue, note this exists for py2 but there\\n# isn't anything we can do in that case.\\n# https://bugs.python.org/issue33725\\nif sys.platform == 'darwin' and (\\n sys.version_info.major > 3 and sys.version_info.minor > 4):\\n multiprocessing.set_start_method('spawn')\\n\\n\\nWORKER_COUNT = int(\\n os.environ.get('C7N_ORG_PARALLEL', multiprocessing.cpu_count() * 4))\\n\\n\\nCONFIG_SCHEMA = {\\n '$schema': 'http://json-schema.org/schema#',\\n 'id': 'http://schema.cloudcustodian.io/v0/orgrunner.json',\\n 'definitions': {\\n 'account': {\\n 'type': 'object',\\n 'additionalProperties': True,\\n 'anyOf': [\\n {'required': ['role', 'account_id']},\\n {'required': ['profile', 'account_id']}\\n ],\\n 'properties': {\\n 'name': {'type': 'string'},\\n 'email': {'type': 'string'},\\n 'account_id': {'type': 'string'},\\n 'profile': {'type': 'string', 'minLength': 3},\\n 'tags': {'type': 'array', 'items': {'type': 'string'}},\\n 'regions': {'type': 'array', 'items': {'type': 'string'}},\\n 'role': {'oneOf': [\\n {'type': 'array', 'items': {'type': 'string'}},\\n {'type': 'string', 'minLength': 3}]},\\n 'external_id': {'type': 'string'},\\n 'vars': {'type': 'object'},\\n }\\n },\\n 'subscription': {\\n 'type': 'object',\\n 'additionalProperties': False,\\n 'required': ['subscription_id'],\\n 'properties': {\\n 'subscription_id': {'type': 'string'},\\n 'tags': {'type': 'array', 'items': {'type': 'string'}},\\n 'name': {'type': 'string'},\\n 'vars': {'type': 'object'},\\n }\\n },\\n 'project': {\\n 'type': 'object',\\n 'additionalProperties': False,\\n 'required': ['project_id'],\\n 'properties': {\\n 'project_id': {'type': 'string'},\\n 'tags': {'type': 'array', 'items': {'type': 'string'}},\\n 'name': {'type': 'string'},\\n 'vars': {'type': 'object'},\\n }\\n },\\n },\\n 'type': 'object',\\n 'additionalProperties': False,\\n 'oneOf': [\\n {'required': ['accounts']},\\n {'required': ['projects']},\\n {'required': ['subscriptions']}\\n ],\\n 'properties': {\\n 'vars': {'type': 'object'},\\n 'accounts': {\\n 'type': 'array',\\n 'items': {'$ref': '#/definitions/account'}\\n },\\n 'subscriptions': {\\n 'type': 'array',\\n 'items': {'$ref': '#/definitions/subscription'}\\n },\\n 'projects': {\\n 'type': 'array',\\n 'items': {'$ref': '#/definitions/project'}\\n }\\n }\\n}\\n\\n\\n@click.group()\\ndef cli():\\n \\\"\\\"\\\"custodian organization multi-account runner.\\\"\\\"\\\"\\n\\n\\nclass LogFilter(object):\\n \\\"\\\"\\\"We want to keep the main c7n-org cli output to be readable.\\n\\n We previously did so via squelching custodian's log output via\\n level filter on the logger, however doing that meant that log\\n outputs stored to output locations were also squelched.\\n\\n We effectively want differential handling at the top level logger\\n stream handler, ie. we want `custodian` log messages to propagate\\n to the root logger based on level, but we also want them to go the\\n custodian logger's directly attached handlers on debug level.\\n \\\"\\\"\\\"\\n\\n def filter(self, r):\\n if not r.name.startswith('custodian'):\\n return 1\\n elif r.levelno >= logging.WARNING:\\n return 1\\n return 0\\n\\n\\ndef init(config, use, debug, verbose, accounts, tags, policies, resource=None, policy_tags=()):\\n level = verbose and logging.DEBUG or logging.INFO\\n logging.basicConfig(\\n level=level,\\n format=\\\"%(asctime)s: %(name)s:%(levelname)s %(message)s\\\")\\n\\n logging.getLogger().setLevel(level)\\n logging.getLogger('botocore').setLevel(logging.ERROR)\\n logging.getLogger('s3transfer').setLevel(logging.WARNING)\\n logging.getLogger('custodian.s3').setLevel(logging.ERROR)\\n logging.getLogger('urllib3').setLevel(logging.WARNING)\\n\\n # Filter out custodian log messages on console output if not\\n # at warning level or higher, see LogFilter docs and #2674\\n for h in logging.getLogger().handlers:\\n if isinstance(h, logging.StreamHandler):\\n h.addFilter(LogFilter())\\n\\n with open(config, 'rb') as fh:\\n accounts_config = yaml.safe_load(fh.read())\\n jsonschema.validate(accounts_config, CONFIG_SCHEMA)\\n\\n if use:\\n with open(use) as fh:\\n custodian_config = yaml.safe_load(fh.read())\\n else:\\n custodian_config = {}\\n\\n accounts_config['accounts'] = list(accounts_iterator(accounts_config))\\n filter_policies(custodian_config, policy_tags, policies, resource)\\n filter_accounts(accounts_config, tags, accounts)\\n\\n load_resources()\\n MainThreadExecutor.c7n_async = False\\n executor = debug and MainThreadExecutor or ProcessPoolExecutor\\n return accounts_config, custodian_config, executor\\n\\n\\ndef resolve_regions(regions):\\n if 'all' in regions:\\n client = boto3.client('ec2')\\n return [region['RegionName'] for region in client.describe_regions()['Regions']]\\n if not regions:\\n return ('us-east-1', 'us-west-2')\\n return regions\\n\\n\\ndef get_session(account, session_name, region):\\n if account.get('role'):\\n roles = account['role']\\n if isinstance(roles, six.string_types):\\n roles = [roles]\\n s = None\\n for r in roles:\\n try:\\n s = assumed_session(\\n r, session_name, region=region,\\n external_id=account.get('external_id'),\\n session=s)\\n except ClientError as e:\\n log.error(\\n \\\"unable to obtain credentials for account:%s role:%s error:%s\\\",\\n account['name'], r, e)\\n raise\\n return s\\n elif account.get('profile'):\\n return SessionFactory(region, account['profile'])()\\n else:\\n raise ValueError(\\n \\\"No profile or role assume specified for account %s\\\" % account)\\n\\n\\ndef filter_accounts(accounts_config, tags, accounts, not_accounts=None):\\n filtered_accounts = []\\n for a in accounts_config.get('accounts', ()):\\n if not_accounts and a['name'] in not_accounts:\\n continue\\n if accounts and a['name'] not in accounts:\\n continue\\n if tags:\\n found = set()\\n for t in tags:\\n if t in a.get('tags', ()):\\n found.add(t)\\n if not found == set(tags):\\n continue\\n filtered_accounts.append(a)\\n accounts_config['accounts'] = filtered_accounts\\n\\n\\ndef filter_policies(policies_config, tags, policies, resource, not_policies=None):\\n filtered_policies = []\\n for p in policies_config.get('policies', ()):\\n if not_policies and p['name'] in not_policies:\\n continue\\n if policies and p['name'] not in policies:\\n continue\\n if resource and p['resource'] != resource:\\n continue\\n if tags:\\n found = set()\\n for t in tags:\\n if t in p.get('tags', ()):\\n found.add(t)\\n if not found == set(tags):\\n continue\\n filtered_policies.append(p)\\n policies_config['policies'] = filtered_policies\\n\\n\\ndef report_account(account, region, policies_config, output_path, cache_path, debug):\\n output_path = os.path.join(output_path, account['name'], region)\\n cache_path = os.path.join(cache_path, \\\"%s-%s.cache\\\" % (account['name'], region))\\n\\n config = Config.empty(\\n region=region,\\n output_dir=output_path,\\n account_id=account['account_id'], metrics_enabled=False,\\n cache=cache_path, log_group=None, profile=None, external_id=None)\\n\\n if account.get('role'):\\n config['assume_role'] = account['role']\\n config['external_id'] = account.get('external_id')\\n elif account.get('profile'):\\n config['profile'] = account['profile']\\n\\n policies = PolicyCollection.from_data(policies_config, config)\\n records = []\\n for p in policies:\\n # initializee policy execution context for output access\\n p.ctx.initialize()\\n log.debug(\\n \\\"Report policy:%s account:%s region:%s path:%s\\\",\\n p.name, account['name'], region, output_path)\\n policy_records = fs_record_set(p.ctx.log_dir, p.name)\\n for r in policy_records:\\n r['policy'] = p.name\\n r['region'] = p.options.region\\n r['account'] = account['name']\\n for t in account.get('tags', ()):\\n if ':' in t:\\n k, v = t.split(':', 1)\\n r[k] = v\\n records.extend(policy_records)\\n return records\\n\\n\\n@cli.command()\\n@click.option('-c', '--config', required=True, help=\\\"Accounts config file\\\")\\n@click.option('-f', '--output', type=click.File('w'), default='-', help=\\\"Output File\\\")\\n@click.option('-u', '--use', required=True)\\n@click.option('-s', '--output-dir', required=True, type=click.Path())\\n@click.option('-a', '--accounts', multiple=True, default=None)\\n@click.option('--field', multiple=True)\\n@click.option('--no-default-fields', default=False, is_flag=True)\\n@click.option('-t', '--tags', multiple=True, default=None, help=\\\"Account tag filter\\\")\\n@click.option('-r', '--region', default=None, multiple=True)\\n@click.option('--debug', default=False, is_flag=True)\\n@click.option('-v', '--verbose', default=False, help=\\\"Verbose\\\", is_flag=True)\\n@click.option('-p', '--policy', multiple=True)\\n@click.option('-l', '--policytags', 'policy_tags',\\n multiple=True, default=None, help=\\\"Policy tag filter\\\")\\n@click.option('--format', default='csv', type=click.Choice(['csv', 'json']))\\n@click.option('--resource', default=None)\\n@click.option('--cache-path', required=False, type=click.Path(), default=\\\"~/.cache/c7n-org\\\")\\ndef report(config, output, use, output_dir, accounts,\\n field, no_default_fields, tags, region, debug, verbose,\\n policy, policy_tags, format, resource, cache_path):\\n \\\"\\\"\\\"report on a cross account policy execution.\\\"\\\"\\\"\\n accounts_config, custodian_config, executor = init(\\n config, use, debug, verbose, accounts, tags, policy,\\n resource=resource, policy_tags=policy_tags)\\n\\n resource_types = set()\\n for p in custodian_config.get('policies'):\\n resource_types.add(p['resource'])\\n if len(resource_types) > 1:\\n raise ValueError(\\\"can only report on one resource type at a time\\\")\\n elif not len(custodian_config['policies']) > 0:\\n raise ValueError(\\\"no matching policies found\\\")\\n\\n records = []\\n with executor(max_workers=WORKER_COUNT) as w:\\n futures = {}\\n for a in accounts_config.get('accounts', ()):\\n for r in resolve_regions(region or a.get('regions', ())):\\n futures[w.submit(\\n report_account,\\n a, r,\\n custodian_config,\\n output_dir,\\n cache_path,\\n debug)] = (a, r)\\n\\n for f in as_completed(futures):\\n a, r = futures[f]\\n if f.exception():\\n if debug:\\n raise\\n log.warning(\\n \\\"Error running policy in %s @ %s exception: %s\\\",\\n a['name'], r, f.exception())\\n records.extend(f.result())\\n\\n log.debug(\\n \\\"Found %d records across %d accounts and %d policies\\\",\\n len(records), len(accounts_config['accounts']),\\n len(custodian_config['policies']))\\n\\n if format == 'json':\\n dumps(records, output, indent=2)\\n return\\n\\n prefix_fields = OrderedDict(\\n (('Account', 'account'), ('Region', 'region'), ('Policy', 'policy')))\\n config = Config.empty()\\n\\n factory = get_resource_class(list(resource_types)[0])\\n formatter = Formatter(\\n factory.resource_type,\\n extra_fields=field,\\n include_default_fields=not(no_default_fields),\\n include_region=False,\\n include_policy=False,\\n fields=prefix_fields)\\n\\n rows = formatter.to_csv(records, unique=False)\\n writer = UnicodeWriter(output, formatter.headers())\\n writer.writerow(formatter.headers())\\n writer.writerows(rows)\\n\\n\\ndef _get_env_creds(session, region):\\n creds = session._session.get_credentials()\\n env = {}\\n env['AWS_ACCESS_KEY_ID'] = creds.access_key\\n env['AWS_SECRET_ACCESS_KEY'] = creds.secret_key\\n env['AWS_SESSION_TOKEN'] = creds.token\\n env['AWS_DEFAULT_REGION'] = region\\n return env\\n\\n\\ndef run_account_script(account, region, output_dir, debug, script_args):\\n try:\\n session = get_session(account, \\\"org-script\\\", region)\\n except ClientError:\\n return 1\\n\\n env = os.environ.copy()\\n env.update(_get_env_creds(session, region))\\n\\n log.info(\\\"running script on account:%s region:%s script: `%s`\\\",\\n account['name'], region, \\\" \\\".join(script_args))\\n\\n if debug:\\n subprocess.check_call(args=script_args, env=env)\\n return 0\\n\\n output_dir = os.path.join(output_dir, account['name'], region)\\n if not os.path.exists(output_dir):\\n os.makedirs(output_dir)\\n\\n with open(os.path.join(output_dir, 'stdout'), 'wb') as stdout:\\n with open(os.path.join(output_dir, 'stderr'), 'wb') as stderr:\\n return subprocess.call(\\n args=script_args, env=env, stdout=stdout, stderr=stderr)\\n\\n\\n@cli.command(name='run-script', context_settings=dict(ignore_unknown_options=True))\\n@click.option('-c', '--config', required=True, help=\\\"Accounts config file\\\")\\n@click.option('-s', '--output-dir', required=True, type=click.Path())\\n@click.option('-a', '--accounts', multiple=True, default=None)\\n@click.option('-t', '--tags', multiple=True, default=None, help=\\\"Account tag filter\\\")\\n@click.option('-r', '--region', default=None, multiple=True)\\n@click.option('--echo', default=False, is_flag=True)\\n@click.option('--serial', default=False, is_flag=True)\\n@click.argument('script_args', nargs=-1, type=click.UNPROCESSED)\\ndef run_script(config, output_dir, accounts, tags, region, echo, serial, script_args):\\n \\\"\\\"\\\"run an aws script across accounts\\\"\\\"\\\"\\n # TODO count up on success / error / error list by account\\n accounts_config, custodian_config, executor = init(\\n config, None, serial, True, accounts, tags, (), ())\\n\\n if echo:\\n print(\\\"command to run: `%s`\\\" % (\\\" \\\".join(script_args)))\\n return\\n\\n # Support fully quoted scripts, which are common to avoid parameter\\n # overlap with c7n-org run-script.\\n if len(script_args) == 1 and \\\" \\\" in script_args[0]:\\n script_args = script_args[0].split()\\n\\n with executor(max_workers=WORKER_COUNT) as w:\\n futures = {}\\n for a in accounts_config.get('accounts', ()):\\n for r in resolve_regions(region or a.get('regions', ())):\\n futures[\\n w.submit(run_account_script, a, r, output_dir,\\n serial, script_args)] = (a, r)\\n for f in as_completed(futures):\\n a, r = futures[f]\\n if f.exception():\\n if serial:\\n raise\\n log.warning(\\n \\\"Error running script in %s @ %s exception: %s\\\",\\n a['name'], r, f.exception())\\n exit_code = f.result()\\n if exit_code == 0:\\n log.info(\\n \\\"ran script on account:%s region:%s script: `%s`\\\",\\n a['name'], r, \\\" \\\".join(script_args))\\n else:\\n log.info(\\n \\\"error running script on account:%s region:%s script: `%s`\\\",\\n a['name'], r, \\\" \\\".join(script_args))\\n\\n\\ndef accounts_iterator(config):\\n for a in config.get('accounts', ()):\\n yield a\\n for a in config.get('subscriptions', ()):\\n d = {'account_id': a['subscription_id'],\\n 'name': a.get('name', a['subscription_id']),\\n 'regions': ['global'],\\n 'tags': a.get('tags', ())}\\n yield d\\n for a in config.get('projects', ()):\\n d = {'account_id': a['project_id'],\\n 'name': a.get('name', a['project_id']),\\n 'regions': ['global'],\\n 'tags': a.get('tags', ())}\\n yield d\\n\\n\\ndef run_account(account, region, policies_config, output_path,\\n cache_period, cache_path, metrics, dryrun, debug):\\n \\\"\\\"\\\"Execute a set of policies on an account.\\n \\\"\\\"\\\"\\n logging.getLogger('custodian.output').setLevel(logging.ERROR + 1)\\n CONN_CACHE.session = None\\n CONN_CACHE.time = None\\n\\n # allow users to specify interpolated output paths\\n if '{' not in output_path:\\n output_path = os.path.join(output_path, account['name'], region)\\n\\n cache_path = os.path.join(cache_path, \\\"%s-%s.cache\\\" % (account['account_id'], region))\\n\\n config = Config.empty(\\n region=region, cache=cache_path,\\n cache_period=cache_period, dryrun=dryrun, output_dir=output_path,\\n account_id=account['account_id'], metrics_enabled=metrics,\\n log_group=None, profile=None, external_id=None)\\n\\n env_vars = account_tags(account)\\n\\n if account.get('role'):\\n if isinstance(account['role'], six.string_types):\\n config['assume_role'] = account['role']\\n config['external_id'] = account.get('external_id')\\n else:\\n env_vars.update(\\n _get_env_creds(get_session(account, 'custodian', region), region))\\n\\n elif account.get('profile'):\\n config['profile'] = account['profile']\\n\\n policies = PolicyCollection.from_data(policies_config, config)\\n policy_counts = {}\\n success = True\\n st = time.time()\\n\\n with environ(**env_vars):\\n for p in policies:\\n # Variable expansion and non schema validation (not optional)\\n p.expand_variables(p.get_variables(account.get('vars', {})))\\n p.validate()\\n\\n log.debug(\\n \\\"Running policy:%s account:%s region:%s\\\",\\n p.name, account['name'], region)\\n try:\\n resources = p.run()\\n policy_counts[p.name] = resources and len(resources) or 0\\n if not resources:\\n continue\\n if not config.dryrun and p.execution_mode != 'pull':\\n log.info(\\\"Ran account:%s region:%s policy:%s provisioned time:%0.2f\\\",\\n account['name'], region, p.name, time.time() - st)\\n continue\\n log.info(\\n \\\"Ran account:%s region:%s policy:%s matched:%d time:%0.2f\\\",\\n account['name'], region, p.name, len(resources),\\n time.time() - st)\\n except ClientError as e:\\n success = False\\n if e.response['Error']['Code'] == 'AccessDenied':\\n log.warning('Access denied api:%s policy:%s account:%s region:%s',\\n e.operation_name, p.name, account['name'], region)\\n return policy_counts, success\\n log.error(\\n \\\"Exception running policy:%s account:%s region:%s error:%s\\\",\\n p.name, account['name'], region, e)\\n continue\\n except Exception as e:\\n success = False\\n log.error(\\n \\\"Exception running policy:%s account:%s region:%s error:%s\\\",\\n p.name, account['name'], region, e)\\n if not debug:\\n continue\\n import traceback, pdb, sys\\n traceback.print_exc()\\n pdb.post_mortem(sys.exc_info()[-1])\\n raise\\n\\n return policy_counts, success\\n\\n\\n@cli.command(name='run')\\n@click.option('-c', '--config', required=True, help=\\\"Accounts config file\\\")\\n@click.option(\\\"-u\\\", \\\"--use\\\", required=True)\\n@click.option('-s', '--output-dir', required=True, type=click.Path())\\n@click.option('-a', '--accounts', multiple=True, default=None)\\n@click.option('-t', '--tags', multiple=True, default=None, help=\\\"Account tag filter\\\")\\n@click.option('-r', '--region', default=None, multiple=True)\\n@click.option('-p', '--policy', multiple=True)\\n@click.option('-l', '--policytags', 'policy_tags',\\n multiple=True, default=None, help=\\\"Policy tag filter\\\")\\n@click.option('--cache-period', default=15, type=int)\\n@click.option('--cache-path', required=False,\\n type=click.Path(\\n writable=True, readable=True, exists=True,\\n resolve_path=True, allow_dash=False,\\n file_okay=False, dir_okay=True),\\n default=None)\\n@click.option(\\\"--metrics\\\", default=False, is_flag=True)\\n@click.option(\\\"--metrics-uri\\\", default=None, help=\\\"Configure provider metrics target\\\")\\n@click.option(\\\"--dryrun\\\", default=False, is_flag=True)\\n@click.option('--debug', default=False, is_flag=True)\\n@click.option('-v', '--verbose', default=False, help=\\\"Verbose\\\", is_flag=True)\\ndef run(config, use, output_dir, accounts, tags, region,\\n policy, policy_tags, cache_period, cache_path, metrics,\\n dryrun, debug, verbose, metrics_uri):\\n \\\"\\\"\\\"run a custodian policy across accounts\\\"\\\"\\\"\\n accounts_config, custodian_config, executor = init(\\n config, use, debug, verbose, accounts, tags, policy, policy_tags=policy_tags)\\n policy_counts = Counter()\\n success = True\\n\\n if metrics_uri:\\n metrics = metrics_uri\\n\\n if not cache_path:\\n cache_path = os.path.expanduser(\\\"~/.cache/c7n-org\\\")\\n if not os.path.exists(cache_path):\\n os.makedirs(cache_path)\\n\\n with executor(max_workers=WORKER_COUNT) as w:\\n futures = {}\\n for a in accounts_config['accounts']:\\n for r in resolve_regions(region or a.get('regions', ())):\\n futures[w.submit(\\n run_account,\\n a, r,\\n custodian_config,\\n output_dir,\\n cache_period,\\n cache_path,\\n metrics,\\n dryrun,\\n debug)] = (a, r)\\n\\n for f in as_completed(futures):\\n a, r = futures[f]\\n if f.exception():\\n if debug:\\n raise\\n log.warning(\\n \\\"Error running policy in %s @ %s exception: %s\\\",\\n a['name'], r, f.exception())\\n\\n account_region_pcounts, account_region_success = f.result()\\n for p in account_region_pcounts:\\n policy_counts[p] += account_region_pcounts[p]\\n\\n if not account_region_success:\\n success = False\\n\\n log.info(\\\"Policy resource counts %s\\\" % policy_counts)\\n\\n if not success:\\n sys.exit(1)\\n\",\n \"path\": \"tools/c7n_org/c7n_org/cli.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"# Copyright 2017 Capital One Services, LLC\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\"\"\"Run a custodian policy across an organization's accounts\n\"\"\"\n\nfrom collections import Counter\nimport logging\nimport os\nimport time\nimport subprocess\nimport six\nimport sys\n\nimport multiprocessing\nfrom concurrent.futures import (\n ProcessPoolExecutor,\n as_completed)\nimport yaml\n\nimport boto3\nfrom botocore.compat import OrderedDict\nfrom botocore.exceptions import ClientError\nimport click\nimport jsonschema\n\nfrom c7n.credentials import assumed_session, SessionFactory\nfrom c7n.executor import MainThreadExecutor\nfrom c7n.config import Config\nfrom c7n.policy import PolicyCollection\nfrom c7n.provider import get_resource_class\nfrom c7n.reports.csvout import Formatter, fs_record_set\nfrom c7n.resources import load_resources\nfrom c7n.utils import CONN_CACHE, dumps\n\nfrom c7n_org.utils import environ, account_tags\nfrom c7n.utils import UnicodeWriter\n\nlog = logging.getLogger('c7n_org')\n\n# Workaround OSX issue, note this exists for py2 but there\n# isn't anything we can do in that case.\n# https://bugs.python.org/issue33725\nif sys.platform == 'darwin' and (\n sys.version_info.major > 3 and sys.version_info.minor > 4):\n multiprocessing.set_start_method('spawn')\n\n\nWORKER_COUNT = int(\n os.environ.get('C7N_ORG_PARALLEL', multiprocessing.cpu_count() * 4))\n\n\nCONFIG_SCHEMA = {\n '$schema': 'http://json-schema.org/schema#',\n 'id': 'http://schema.cloudcustodian.io/v0/orgrunner.json',\n 'definitions': {\n 'account': {\n 'type': 'object',\n 'additionalProperties': True,\n 'anyOf': [\n {'required': ['role', 'account_id']},\n {'required': ['profile', 'account_id']}\n ],\n 'properties': {\n 'name': {'type': 'string'},\n 'email': {'type': 'string'},\n 'account_id': {'type': 'string'},\n 'profile': {'type': 'string', 'minLength': 3},\n 'tags': {'type': 'array', 'items': {'type': 'string'}},\n 'regions': {'type': 'array', 'items': {'type': 'string'}},\n 'role': {'oneOf': [\n {'type': 'array', 'items': {'type': 'string'}},\n {'type': 'string', 'minLength': 3}]},\n 'external_id': {'type': 'string'},\n 'vars': {'type': 'object'},\n }\n },\n 'subscription': {\n 'type': 'object',\n 'additionalProperties': False,\n 'required': ['subscription_id'],\n 'properties': {\n 'subscription_id': {'type': 'string'},\n 'tags': {'type': 'array', 'items': {'type': 'string'}},\n 'name': {'type': 'string'},\n 'vars': {'type': 'object'},\n }\n },\n 'project': {\n 'type': 'object',\n 'additionalProperties': False,\n 'required': ['project_id'],\n 'properties': {\n 'project_id': {'type': 'string'},\n 'tags': {'type': 'array', 'items': {'type': 'string'}},\n 'name': {'type': 'string'},\n 'vars': {'type': 'object'},\n }\n },\n },\n 'type': 'object',\n 'additionalProperties': False,\n 'oneOf': [\n {'required': ['accounts']},\n {'required': ['projects']},\n {'required': ['subscriptions']}\n ],\n 'properties': {\n 'vars': {'type': 'object'},\n 'accounts': {\n 'type': 'array',\n 'items': {'$ref': '#/definitions/account'}\n },\n 'subscriptions': {\n 'type': 'array',\n 'items': {'$ref': '#/definitions/subscription'}\n },\n 'projects': {\n 'type': 'array',\n 'items': {'$ref': '#/definitions/project'}\n }\n }\n}\n\n\n@click.group()\ndef cli():\n \"\"\"custodian organization multi-account runner.\"\"\"\n\n\nclass LogFilter(object):\n \"\"\"We want to keep the main c7n-org cli output to be readable.\n\n We previously did so via squelching custodian's log output via\n level filter on the logger, however doing that meant that log\n outputs stored to output locations were also squelched.\n\n We effectively want differential handling at the top level logger\n stream handler, ie. we want `custodian` log messages to propagate\n to the root logger based on level, but we also want them to go the\n custodian logger's directly attached handlers on debug level.\n \"\"\"\n\n def filter(self, r):\n if not r.name.startswith('custodian'):\n return 1\n elif r.levelno >= logging.WARNING:\n return 1\n return 0\n\n\ndef init(config, use, debug, verbose, accounts, tags, policies, resource=None, policy_tags=()):\n level = verbose and logging.DEBUG or logging.INFO\n logging.basicConfig(\n level=level,\n format=\"%(asctime)s: %(name)s:%(levelname)s %(message)s\")\n\n logging.getLogger().setLevel(level)\n logging.getLogger('botocore').setLevel(logging.ERROR)\n logging.getLogger('s3transfer').setLevel(logging.WARNING)\n logging.getLogger('custodian.s3').setLevel(logging.ERROR)\n logging.getLogger('urllib3').setLevel(logging.WARNING)\n\n # Filter out custodian log messages on console output if not\n # at warning level or higher, see LogFilter docs and #2674\n for h in logging.getLogger().handlers:\n if isinstance(h, logging.StreamHandler):\n h.addFilter(LogFilter())\n\n with open(config, 'rb') as fh:\n accounts_config = yaml.safe_load(fh.read())\n jsonschema.validate(accounts_config, CONFIG_SCHEMA)\n\n if use:\n with open(use) as fh:\n custodian_config = yaml.safe_load(fh.read())\n else:\n custodian_config = {}\n\n accounts_config['accounts'] = list(accounts_iterator(accounts_config))\n filter_policies(custodian_config, policy_tags, policies, resource)\n filter_accounts(accounts_config, tags, accounts)\n\n load_resources()\n MainThreadExecutor.c7n_async = False\n executor = debug and MainThreadExecutor or ProcessPoolExecutor\n return accounts_config, custodian_config, executor\n\n\ndef resolve_regions(regions):\n if 'all' in regions:\n client = boto3.client('ec2')\n return [region['RegionName'] for region in client.describe_regions()['Regions']]\n if not regions:\n return ('us-east-1', 'us-west-2')\n return regions\n\n\ndef get_session(account, session_name, region):\n if account.get('role'):\n roles = account['role']\n if isinstance(roles, six.string_types):\n roles = [roles]\n s = None\n for r in roles:\n try:\n s = assumed_session(\n r, session_name, region=region,\n external_id=account.get('external_id'),\n session=s)\n except ClientError as e:\n log.error(\n \"unable to obtain credentials for account:%s role:%s error:%s\",\n account['name'], r, e)\n raise\n return s\n elif account.get('profile'):\n return SessionFactory(region, account['profile'])()\n else:\n raise ValueError(\n \"No profile or role assume specified for account %s\" % account)\n\n\ndef filter_accounts(accounts_config, tags, accounts, not_accounts=None):\n filtered_accounts = []\n for a in accounts_config.get('accounts', ()):\n if not_accounts and a['name'] in not_accounts:\n continue\n if accounts and a['name'] not in accounts:\n continue\n if tags:\n found = set()\n for t in tags:\n if t in a.get('tags', ()):\n found.add(t)\n if not found == set(tags):\n continue\n filtered_accounts.append(a)\n accounts_config['accounts'] = filtered_accounts\n\n\ndef filter_policies(policies_config, tags, policies, resource, not_policies=None):\n filtered_policies = []\n for p in policies_config.get('policies', ()):\n if not_policies and p['name'] in not_policies:\n continue\n if policies and p['name'] not in policies:\n continue\n if resource and p['resource'] != resource:\n continue\n if tags:\n found = set()\n for t in tags:\n if t in p.get('tags', ()):\n found.add(t)\n if not found == set(tags):\n continue\n filtered_policies.append(p)\n policies_config['policies'] = filtered_policies\n\n\ndef report_account(account, region, policies_config, output_path, cache_path, debug):\n output_path = os.path.join(output_path, account['name'], region)\n cache_path = os.path.join(cache_path, \"%s-%s.cache\" % (account['name'], region))\n\n config = Config.empty(\n region=region,\n output_dir=output_path,\n account_id=account['account_id'], metrics_enabled=False,\n cache=cache_path, log_group=None, profile=None, external_id=None)\n\n if account.get('role'):\n config['assume_role'] = account['role']\n config['external_id'] = account.get('external_id')\n elif account.get('profile'):\n config['profile'] = account['profile']\n\n policies = PolicyCollection.from_data(policies_config, config)\n records = []\n for p in policies:\n # initializee policy execution context for output access\n p.ctx.initialize()\n log.debug(\n \"Report policy:%s account:%s region:%s path:%s\",\n p.name, account['name'], region, output_path)\n policy_records = fs_record_set(p.ctx.log_dir, p.name)\n for r in policy_records:\n r['policy'] = p.name\n r['region'] = p.options.region\n r['account'] = account['name']\n for t in account.get('tags', ()):\n if ':' in t:\n k, v = t.split(':', 1)\n r[k] = v\n records.extend(policy_records)\n return records\n\n\n@cli.command()\n@click.option('-c', '--config', required=True, help=\"Accounts config file\")\n@click.option('-f', '--output', type=click.File('w'), default='-', help=\"Output File\")\n@click.option('-u', '--use', required=True)\n@click.option('-s', '--output-dir', required=True, type=click.Path())\n@click.option('-a', '--accounts', multiple=True, default=None)\n@click.option('--field', multiple=True)\n@click.option('--no-default-fields', default=False, is_flag=True)\n@click.option('-t', '--tags', multiple=True, default=None, help=\"Account tag filter\")\n@click.option('-r', '--region', default=None, multiple=True)\n@click.option('--debug', default=False, is_flag=True)\n@click.option('-v', '--verbose', default=False, help=\"Verbose\", is_flag=True)\n@click.option('-p', '--policy', multiple=True)\n@click.option('-l', '--policytags', 'policy_tags',\n multiple=True, default=None, help=\"Policy tag filter\")\n@click.option('--format', default='csv', type=click.Choice(['csv', 'json']))\n@click.option('--resource', default=None)\n@click.option('--cache-path', required=False, type=click.Path(), default=\"~/.cache/c7n-org\")\ndef report(config, output, use, output_dir, accounts,\n field, no_default_fields, tags, region, debug, verbose,\n policy, policy_tags, format, resource, cache_path):\n \"\"\"report on a cross account policy execution.\"\"\"\n accounts_config, custodian_config, executor = init(\n config, use, debug, verbose, accounts, tags, policy,\n resource=resource, policy_tags=policy_tags)\n\n resource_types = set()\n for p in custodian_config.get('policies'):\n resource_types.add(p['resource'])\n if len(resource_types) > 1:\n raise ValueError(\"can only report on one resource type at a time\")\n elif not len(custodian_config['policies']) > 0:\n raise ValueError(\"no matching policies found\")\n\n records = []\n with executor(max_workers=WORKER_COUNT) as w:\n futures = {}\n for a in accounts_config.get('accounts', ()):\n for r in resolve_regions(region or a.get('regions', ())):\n futures[w.submit(\n report_account,\n a, r,\n custodian_config,\n output_dir,\n cache_path,\n debug)] = (a, r)\n\n for f in as_completed(futures):\n a, r = futures[f]\n if f.exception():\n if debug:\n raise\n log.warning(\n \"Error running policy in %s @ %s exception: %s\",\n a['name'], r, f.exception())\n records.extend(f.result())\n\n log.debug(\n \"Found %d records across %d accounts and %d policies\",\n len(records), len(accounts_config['accounts']),\n len(custodian_config['policies']))\n\n if format == 'json':\n dumps(records, output, indent=2)\n return\n\n prefix_fields = OrderedDict(\n (('Account', 'account'), ('Region', 'region'), ('Policy', 'policy')))\n config = Config.empty()\n\n factory = get_resource_class(list(resource_types)[0])\n formatter = Formatter(\n factory.resource_type,\n extra_fields=field,\n include_default_fields=not(no_default_fields),\n include_region=False,\n include_policy=False,\n fields=prefix_fields)\n\n rows = formatter.to_csv(records, unique=False)\n writer = UnicodeWriter(output, formatter.headers())\n writer.writerow(formatter.headers())\n writer.writerows(rows)\n\n\ndef _get_env_creds(session, region):\n creds = session._session.get_credentials()\n env = {}\n env['AWS_ACCESS_KEY_ID'] = creds.access_key\n env['AWS_SECRET_ACCESS_KEY'] = creds.secret_key\n env['AWS_SESSION_TOKEN'] = creds.token\n env['AWS_DEFAULT_REGION'] = region\n return env\n\n\ndef run_account_script(account, region, output_dir, debug, script_args):\n try:\n session = get_session(account, \"org-script\", region)\n except ClientError:\n return 1\n\n env = os.environ.copy()\n env.update(_get_env_creds(session, region))\n\n log.info(\"running script on account:%s region:%s script: `%s`\",\n account['name'], region, \" \".join(script_args))\n\n if debug:\n subprocess.check_call(args=script_args, env=env)\n return 0\n\n output_dir = os.path.join(output_dir, account['name'], region)\n if not os.path.exists(output_dir):\n os.makedirs(output_dir)\n\n with open(os.path.join(output_dir, 'stdout'), 'wb') as stdout:\n with open(os.path.join(output_dir, 'stderr'), 'wb') as stderr:\n return subprocess.call(\n args=script_args, env=env, stdout=stdout, stderr=stderr)\n\n\n@cli.command(name='run-script', context_settings=dict(ignore_unknown_options=True))\n@click.option('-c', '--config', required=True, help=\"Accounts config file\")\n@click.option('-s', '--output-dir', required=True, type=click.Path())\n@click.option('-a', '--accounts', multiple=True, default=None)\n@click.option('-t', '--tags', multiple=True, default=None, help=\"Account tag filter\")\n@click.option('-r', '--region', default=None, multiple=True)\n@click.option('--echo', default=False, is_flag=True)\n@click.option('--serial', default=False, is_flag=True)\n@click.argument('script_args', nargs=-1, type=click.UNPROCESSED)\ndef run_script(config, output_dir, accounts, tags, region, echo, serial, script_args):\n \"\"\"run an aws script across accounts\"\"\"\n # TODO count up on success / error / error list by account\n accounts_config, custodian_config, executor = init(\n config, None, serial, True, accounts, tags, (), ())\n\n if echo:\n print(\"command to run: `%s`\" % (\" \".join(script_args)))\n return\n\n # Support fully quoted scripts, which are common to avoid parameter\n # overlap with c7n-org run-script.\n if len(script_args) == 1 and \" \" in script_args[0]:\n script_args = script_args[0].split()\n\n with executor(max_workers=WORKER_COUNT) as w:\n futures = {}\n for a in accounts_config.get('accounts', ()):\n for r in resolve_regions(region or a.get('regions', ())):\n futures[\n w.submit(run_account_script, a, r, output_dir,\n serial, script_args)] = (a, r)\n for f in as_completed(futures):\n a, r = futures[f]\n if f.exception():\n if serial:\n raise\n log.warning(\n \"Error running script in %s @ %s exception: %s\",\n a['name'], r, f.exception())\n exit_code = f.result()\n if exit_code == 0:\n log.info(\n \"ran script on account:%s region:%s script: `%s`\",\n a['name'], r, \" \".join(script_args))\n else:\n log.info(\n \"error running script on account:%s region:%s script: `%s`\",\n a['name'], r, \" \".join(script_args))\n\n\ndef accounts_iterator(config):\n for a in config.get('accounts', ()):\n yield a\n for a in config.get('subscriptions', ()):\n d = {'account_id': a['subscription_id'],\n 'name': a.get('name', a['subscription_id']),\n 'regions': ['global'],\n 'tags': a.get('tags', ())}\n yield d\n for a in config.get('projects', ()):\n d = {'account_id': a['project_id'],\n 'name': a.get('name', a['project_id']),\n 'regions': ['global'],\n 'tags': a.get('tags', ())}\n yield d\n\n\ndef run_account(account, region, policies_config, output_path,\n cache_period, cache_path, metrics, dryrun, debug):\n \"\"\"Execute a set of policies on an account.\n \"\"\"\n logging.getLogger('custodian.output').setLevel(logging.ERROR + 1)\n CONN_CACHE.session = None\n CONN_CACHE.time = None\n\n # allow users to specify interpolated output paths\n if '{' not in output_path:\n output_path = os.path.join(output_path, account['name'], region)\n\n cache_path = os.path.join(cache_path, \"%s-%s.cache\" % (account['account_id'], region))\n\n config = Config.empty(\n region=region, cache=cache_path,\n cache_period=cache_period, dryrun=dryrun, output_dir=output_path,\n account_id=account['account_id'], metrics_enabled=metrics,\n log_group=None, profile=None, external_id=None)\n\n env_vars = account_tags(account)\n\n if account.get('role'):\n if isinstance(account['role'], six.string_types):\n config['assume_role'] = account['role']\n config['external_id'] = account.get('external_id')\n else:\n env_vars.update(\n _get_env_creds(get_session(account, 'custodian', region), region))\n\n elif account.get('profile'):\n config['profile'] = account['profile']\n\n policies = PolicyCollection.from_data(policies_config, config)\n policy_counts = {}\n success = True\n st = time.time()\n\n with environ(**env_vars):\n for p in policies:\n # Variable expansion and non schema validation (not optional)\n p.expand_variables(p.get_variables(account.get('vars', {})))\n p.validate()\n\n if p.region and p.region != region:\n continue\n\n log.debug(\n \"Running policy:%s account:%s region:%s\",\n p.name, account['name'], region)\n try:\n resources = p.run()\n policy_counts[p.name] = resources and len(resources) or 0\n if not resources:\n continue\n if not config.dryrun and p.execution_mode != 'pull':\n log.info(\"Ran account:%s region:%s policy:%s provisioned time:%0.2f\",\n account['name'], region, p.name, time.time() - st)\n continue\n log.info(\n \"Ran account:%s region:%s policy:%s matched:%d time:%0.2f\",\n account['name'], region, p.name, len(resources),\n time.time() - st)\n except ClientError as e:\n success = False\n if e.response['Error']['Code'] == 'AccessDenied':\n log.warning('Access denied api:%s policy:%s account:%s region:%s',\n e.operation_name, p.name, account['name'], region)\n return policy_counts, success\n log.error(\n \"Exception running policy:%s account:%s region:%s error:%s\",\n p.name, account['name'], region, e)\n continue\n except Exception as e:\n success = False\n log.error(\n \"Exception running policy:%s account:%s region:%s error:%s\",\n p.name, account['name'], region, e)\n if not debug:\n continue\n import traceback, pdb, sys\n traceback.print_exc()\n pdb.post_mortem(sys.exc_info()[-1])\n raise\n\n return policy_counts, success\n\n\n@cli.command(name='run')\n@click.option('-c', '--config', required=True, help=\"Accounts config file\")\n@click.option(\"-u\", \"--use\", required=True)\n@click.option('-s', '--output-dir', required=True, type=click.Path())\n@click.option('-a', '--accounts', multiple=True, default=None)\n@click.option('-t', '--tags', multiple=True, default=None, help=\"Account tag filter\")\n@click.option('-r', '--region', default=None, multiple=True)\n@click.option('-p', '--policy', multiple=True)\n@click.option('-l', '--policytags', 'policy_tags',\n multiple=True, default=None, help=\"Policy tag filter\")\n@click.option('--cache-period', default=15, type=int)\n@click.option('--cache-path', required=False,\n type=click.Path(\n writable=True, readable=True, exists=True,\n resolve_path=True, allow_dash=False,\n file_okay=False, dir_okay=True),\n default=None)\n@click.option(\"--metrics\", default=False, is_flag=True)\n@click.option(\"--metrics-uri\", default=None, help=\"Configure provider metrics target\")\n@click.option(\"--dryrun\", default=False, is_flag=True)\n@click.option('--debug', default=False, is_flag=True)\n@click.option('-v', '--verbose', default=False, help=\"Verbose\", is_flag=True)\ndef run(config, use, output_dir, accounts, tags, region,\n policy, policy_tags, cache_period, cache_path, metrics,\n dryrun, debug, verbose, metrics_uri):\n \"\"\"run a custodian policy across accounts\"\"\"\n accounts_config, custodian_config, executor = init(\n config, use, debug, verbose, accounts, tags, policy, policy_tags=policy_tags)\n policy_counts = Counter()\n success = True\n\n if metrics_uri:\n metrics = metrics_uri\n\n if not cache_path:\n cache_path = os.path.expanduser(\"~/.cache/c7n-org\")\n if not os.path.exists(cache_path):\n os.makedirs(cache_path)\n\n with executor(max_workers=WORKER_COUNT) as w:\n futures = {}\n for a in accounts_config['accounts']:\n for r in resolve_regions(region or a.get('regions', ())):\n futures[w.submit(\n run_account,\n a, r,\n custodian_config,\n output_dir,\n cache_period,\n cache_path,\n metrics,\n dryrun,\n debug)] = (a, r)\n\n for f in as_completed(futures):\n a, r = futures[f]\n if f.exception():\n if debug:\n raise\n log.warning(\n \"Error running policy in %s @ %s exception: %s\",\n a['name'], r, f.exception())\n\n account_region_pcounts, account_region_success = f.result()\n for p in account_region_pcounts:\n policy_counts[p] += account_region_pcounts[p]\n\n if not account_region_success:\n success = False\n\n log.info(\"Policy resource counts %s\" % policy_counts)\n\n if not success:\n sys.exit(1)\n","path":"tools/c7n_org/c7n_org/cli.py"}],"string":"[\n {\n \"content\": \"# Copyright 2017 Capital One Services, LLC\\n#\\n# Licensed under the Apache License, Version 2.0 (the \\\"License\\\");\\n# you may not use this file except in compliance with the License.\\n# You may obtain a copy of the License at\\n#\\n# http://www.apache.org/licenses/LICENSE-2.0\\n#\\n# Unless required by applicable law or agreed to in writing, software\\n# distributed under the License is distributed on an \\\"AS IS\\\" BASIS,\\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\\n# See the License for the specific language governing permissions and\\n# limitations under the License.\\n\\\"\\\"\\\"Run a custodian policy across an organization's accounts\\n\\\"\\\"\\\"\\n\\nfrom collections import Counter\\nimport logging\\nimport os\\nimport time\\nimport subprocess\\nimport six\\nimport sys\\n\\nimport multiprocessing\\nfrom concurrent.futures import (\\n ProcessPoolExecutor,\\n as_completed)\\nimport yaml\\n\\nimport boto3\\nfrom botocore.compat import OrderedDict\\nfrom botocore.exceptions import ClientError\\nimport click\\nimport jsonschema\\n\\nfrom c7n.credentials import assumed_session, SessionFactory\\nfrom c7n.executor import MainThreadExecutor\\nfrom c7n.config import Config\\nfrom c7n.policy import PolicyCollection\\nfrom c7n.provider import get_resource_class\\nfrom c7n.reports.csvout import Formatter, fs_record_set\\nfrom c7n.resources import load_resources\\nfrom c7n.utils import CONN_CACHE, dumps\\n\\nfrom c7n_org.utils import environ, account_tags\\nfrom c7n.utils import UnicodeWriter\\n\\nlog = logging.getLogger('c7n_org')\\n\\n# Workaround OSX issue, note this exists for py2 but there\\n# isn't anything we can do in that case.\\n# https://bugs.python.org/issue33725\\nif sys.platform == 'darwin' and (\\n sys.version_info.major > 3 and sys.version_info.minor > 4):\\n multiprocessing.set_start_method('spawn')\\n\\n\\nWORKER_COUNT = int(\\n os.environ.get('C7N_ORG_PARALLEL', multiprocessing.cpu_count() * 4))\\n\\n\\nCONFIG_SCHEMA = {\\n '$schema': 'http://json-schema.org/schema#',\\n 'id': 'http://schema.cloudcustodian.io/v0/orgrunner.json',\\n 'definitions': {\\n 'account': {\\n 'type': 'object',\\n 'additionalProperties': True,\\n 'anyOf': [\\n {'required': ['role', 'account_id']},\\n {'required': ['profile', 'account_id']}\\n ],\\n 'properties': {\\n 'name': {'type': 'string'},\\n 'email': {'type': 'string'},\\n 'account_id': {'type': 'string'},\\n 'profile': {'type': 'string', 'minLength': 3},\\n 'tags': {'type': 'array', 'items': {'type': 'string'}},\\n 'regions': {'type': 'array', 'items': {'type': 'string'}},\\n 'role': {'oneOf': [\\n {'type': 'array', 'items': {'type': 'string'}},\\n {'type': 'string', 'minLength': 3}]},\\n 'external_id': {'type': 'string'},\\n 'vars': {'type': 'object'},\\n }\\n },\\n 'subscription': {\\n 'type': 'object',\\n 'additionalProperties': False,\\n 'required': ['subscription_id'],\\n 'properties': {\\n 'subscription_id': {'type': 'string'},\\n 'tags': {'type': 'array', 'items': {'type': 'string'}},\\n 'name': {'type': 'string'},\\n 'vars': {'type': 'object'},\\n }\\n },\\n 'project': {\\n 'type': 'object',\\n 'additionalProperties': False,\\n 'required': ['project_id'],\\n 'properties': {\\n 'project_id': {'type': 'string'},\\n 'tags': {'type': 'array', 'items': {'type': 'string'}},\\n 'name': {'type': 'string'},\\n 'vars': {'type': 'object'},\\n }\\n },\\n },\\n 'type': 'object',\\n 'additionalProperties': False,\\n 'oneOf': [\\n {'required': ['accounts']},\\n {'required': ['projects']},\\n {'required': ['subscriptions']}\\n ],\\n 'properties': {\\n 'vars': {'type': 'object'},\\n 'accounts': {\\n 'type': 'array',\\n 'items': {'$ref': '#/definitions/account'}\\n },\\n 'subscriptions': {\\n 'type': 'array',\\n 'items': {'$ref': '#/definitions/subscription'}\\n },\\n 'projects': {\\n 'type': 'array',\\n 'items': {'$ref': '#/definitions/project'}\\n }\\n }\\n}\\n\\n\\n@click.group()\\ndef cli():\\n \\\"\\\"\\\"custodian organization multi-account runner.\\\"\\\"\\\"\\n\\n\\nclass LogFilter(object):\\n \\\"\\\"\\\"We want to keep the main c7n-org cli output to be readable.\\n\\n We previously did so via squelching custodian's log output via\\n level filter on the logger, however doing that meant that log\\n outputs stored to output locations were also squelched.\\n\\n We effectively want differential handling at the top level logger\\n stream handler, ie. we want `custodian` log messages to propagate\\n to the root logger based on level, but we also want them to go the\\n custodian logger's directly attached handlers on debug level.\\n \\\"\\\"\\\"\\n\\n def filter(self, r):\\n if not r.name.startswith('custodian'):\\n return 1\\n elif r.levelno >= logging.WARNING:\\n return 1\\n return 0\\n\\n\\ndef init(config, use, debug, verbose, accounts, tags, policies, resource=None, policy_tags=()):\\n level = verbose and logging.DEBUG or logging.INFO\\n logging.basicConfig(\\n level=level,\\n format=\\\"%(asctime)s: %(name)s:%(levelname)s %(message)s\\\")\\n\\n logging.getLogger().setLevel(level)\\n logging.getLogger('botocore').setLevel(logging.ERROR)\\n logging.getLogger('s3transfer').setLevel(logging.WARNING)\\n logging.getLogger('custodian.s3').setLevel(logging.ERROR)\\n logging.getLogger('urllib3').setLevel(logging.WARNING)\\n\\n # Filter out custodian log messages on console output if not\\n # at warning level or higher, see LogFilter docs and #2674\\n for h in logging.getLogger().handlers:\\n if isinstance(h, logging.StreamHandler):\\n h.addFilter(LogFilter())\\n\\n with open(config, 'rb') as fh:\\n accounts_config = yaml.safe_load(fh.read())\\n jsonschema.validate(accounts_config, CONFIG_SCHEMA)\\n\\n if use:\\n with open(use) as fh:\\n custodian_config = yaml.safe_load(fh.read())\\n else:\\n custodian_config = {}\\n\\n accounts_config['accounts'] = list(accounts_iterator(accounts_config))\\n filter_policies(custodian_config, policy_tags, policies, resource)\\n filter_accounts(accounts_config, tags, accounts)\\n\\n load_resources()\\n MainThreadExecutor.c7n_async = False\\n executor = debug and MainThreadExecutor or ProcessPoolExecutor\\n return accounts_config, custodian_config, executor\\n\\n\\ndef resolve_regions(regions):\\n if 'all' in regions:\\n client = boto3.client('ec2')\\n return [region['RegionName'] for region in client.describe_regions()['Regions']]\\n if not regions:\\n return ('us-east-1', 'us-west-2')\\n return regions\\n\\n\\ndef get_session(account, session_name, region):\\n if account.get('role'):\\n roles = account['role']\\n if isinstance(roles, six.string_types):\\n roles = [roles]\\n s = None\\n for r in roles:\\n try:\\n s = assumed_session(\\n r, session_name, region=region,\\n external_id=account.get('external_id'),\\n session=s)\\n except ClientError as e:\\n log.error(\\n \\\"unable to obtain credentials for account:%s role:%s error:%s\\\",\\n account['name'], r, e)\\n raise\\n return s\\n elif account.get('profile'):\\n return SessionFactory(region, account['profile'])()\\n else:\\n raise ValueError(\\n \\\"No profile or role assume specified for account %s\\\" % account)\\n\\n\\ndef filter_accounts(accounts_config, tags, accounts, not_accounts=None):\\n filtered_accounts = []\\n for a in accounts_config.get('accounts', ()):\\n if not_accounts and a['name'] in not_accounts:\\n continue\\n if accounts and a['name'] not in accounts:\\n continue\\n if tags:\\n found = set()\\n for t in tags:\\n if t in a.get('tags', ()):\\n found.add(t)\\n if not found == set(tags):\\n continue\\n filtered_accounts.append(a)\\n accounts_config['accounts'] = filtered_accounts\\n\\n\\ndef filter_policies(policies_config, tags, policies, resource, not_policies=None):\\n filtered_policies = []\\n for p in policies_config.get('policies', ()):\\n if not_policies and p['name'] in not_policies:\\n continue\\n if policies and p['name'] not in policies:\\n continue\\n if resource and p['resource'] != resource:\\n continue\\n if tags:\\n found = set()\\n for t in tags:\\n if t in p.get('tags', ()):\\n found.add(t)\\n if not found == set(tags):\\n continue\\n filtered_policies.append(p)\\n policies_config['policies'] = filtered_policies\\n\\n\\ndef report_account(account, region, policies_config, output_path, cache_path, debug):\\n output_path = os.path.join(output_path, account['name'], region)\\n cache_path = os.path.join(cache_path, \\\"%s-%s.cache\\\" % (account['name'], region))\\n\\n config = Config.empty(\\n region=region,\\n output_dir=output_path,\\n account_id=account['account_id'], metrics_enabled=False,\\n cache=cache_path, log_group=None, profile=None, external_id=None)\\n\\n if account.get('role'):\\n config['assume_role'] = account['role']\\n config['external_id'] = account.get('external_id')\\n elif account.get('profile'):\\n config['profile'] = account['profile']\\n\\n policies = PolicyCollection.from_data(policies_config, config)\\n records = []\\n for p in policies:\\n # initializee policy execution context for output access\\n p.ctx.initialize()\\n log.debug(\\n \\\"Report policy:%s account:%s region:%s path:%s\\\",\\n p.name, account['name'], region, output_path)\\n policy_records = fs_record_set(p.ctx.log_dir, p.name)\\n for r in policy_records:\\n r['policy'] = p.name\\n r['region'] = p.options.region\\n r['account'] = account['name']\\n for t in account.get('tags', ()):\\n if ':' in t:\\n k, v = t.split(':', 1)\\n r[k] = v\\n records.extend(policy_records)\\n return records\\n\\n\\n@cli.command()\\n@click.option('-c', '--config', required=True, help=\\\"Accounts config file\\\")\\n@click.option('-f', '--output', type=click.File('w'), default='-', help=\\\"Output File\\\")\\n@click.option('-u', '--use', required=True)\\n@click.option('-s', '--output-dir', required=True, type=click.Path())\\n@click.option('-a', '--accounts', multiple=True, default=None)\\n@click.option('--field', multiple=True)\\n@click.option('--no-default-fields', default=False, is_flag=True)\\n@click.option('-t', '--tags', multiple=True, default=None, help=\\\"Account tag filter\\\")\\n@click.option('-r', '--region', default=None, multiple=True)\\n@click.option('--debug', default=False, is_flag=True)\\n@click.option('-v', '--verbose', default=False, help=\\\"Verbose\\\", is_flag=True)\\n@click.option('-p', '--policy', multiple=True)\\n@click.option('-l', '--policytags', 'policy_tags',\\n multiple=True, default=None, help=\\\"Policy tag filter\\\")\\n@click.option('--format', default='csv', type=click.Choice(['csv', 'json']))\\n@click.option('--resource', default=None)\\n@click.option('--cache-path', required=False, type=click.Path(), default=\\\"~/.cache/c7n-org\\\")\\ndef report(config, output, use, output_dir, accounts,\\n field, no_default_fields, tags, region, debug, verbose,\\n policy, policy_tags, format, resource, cache_path):\\n \\\"\\\"\\\"report on a cross account policy execution.\\\"\\\"\\\"\\n accounts_config, custodian_config, executor = init(\\n config, use, debug, verbose, accounts, tags, policy,\\n resource=resource, policy_tags=policy_tags)\\n\\n resource_types = set()\\n for p in custodian_config.get('policies'):\\n resource_types.add(p['resource'])\\n if len(resource_types) > 1:\\n raise ValueError(\\\"can only report on one resource type at a time\\\")\\n elif not len(custodian_config['policies']) > 0:\\n raise ValueError(\\\"no matching policies found\\\")\\n\\n records = []\\n with executor(max_workers=WORKER_COUNT) as w:\\n futures = {}\\n for a in accounts_config.get('accounts', ()):\\n for r in resolve_regions(region or a.get('regions', ())):\\n futures[w.submit(\\n report_account,\\n a, r,\\n custodian_config,\\n output_dir,\\n cache_path,\\n debug)] = (a, r)\\n\\n for f in as_completed(futures):\\n a, r = futures[f]\\n if f.exception():\\n if debug:\\n raise\\n log.warning(\\n \\\"Error running policy in %s @ %s exception: %s\\\",\\n a['name'], r, f.exception())\\n records.extend(f.result())\\n\\n log.debug(\\n \\\"Found %d records across %d accounts and %d policies\\\",\\n len(records), len(accounts_config['accounts']),\\n len(custodian_config['policies']))\\n\\n if format == 'json':\\n dumps(records, output, indent=2)\\n return\\n\\n prefix_fields = OrderedDict(\\n (('Account', 'account'), ('Region', 'region'), ('Policy', 'policy')))\\n config = Config.empty()\\n\\n factory = get_resource_class(list(resource_types)[0])\\n formatter = Formatter(\\n factory.resource_type,\\n extra_fields=field,\\n include_default_fields=not(no_default_fields),\\n include_region=False,\\n include_policy=False,\\n fields=prefix_fields)\\n\\n rows = formatter.to_csv(records, unique=False)\\n writer = UnicodeWriter(output, formatter.headers())\\n writer.writerow(formatter.headers())\\n writer.writerows(rows)\\n\\n\\ndef _get_env_creds(session, region):\\n creds = session._session.get_credentials()\\n env = {}\\n env['AWS_ACCESS_KEY_ID'] = creds.access_key\\n env['AWS_SECRET_ACCESS_KEY'] = creds.secret_key\\n env['AWS_SESSION_TOKEN'] = creds.token\\n env['AWS_DEFAULT_REGION'] = region\\n return env\\n\\n\\ndef run_account_script(account, region, output_dir, debug, script_args):\\n try:\\n session = get_session(account, \\\"org-script\\\", region)\\n except ClientError:\\n return 1\\n\\n env = os.environ.copy()\\n env.update(_get_env_creds(session, region))\\n\\n log.info(\\\"running script on account:%s region:%s script: `%s`\\\",\\n account['name'], region, \\\" \\\".join(script_args))\\n\\n if debug:\\n subprocess.check_call(args=script_args, env=env)\\n return 0\\n\\n output_dir = os.path.join(output_dir, account['name'], region)\\n if not os.path.exists(output_dir):\\n os.makedirs(output_dir)\\n\\n with open(os.path.join(output_dir, 'stdout'), 'wb') as stdout:\\n with open(os.path.join(output_dir, 'stderr'), 'wb') as stderr:\\n return subprocess.call(\\n args=script_args, env=env, stdout=stdout, stderr=stderr)\\n\\n\\n@cli.command(name='run-script', context_settings=dict(ignore_unknown_options=True))\\n@click.option('-c', '--config', required=True, help=\\\"Accounts config file\\\")\\n@click.option('-s', '--output-dir', required=True, type=click.Path())\\n@click.option('-a', '--accounts', multiple=True, default=None)\\n@click.option('-t', '--tags', multiple=True, default=None, help=\\\"Account tag filter\\\")\\n@click.option('-r', '--region', default=None, multiple=True)\\n@click.option('--echo', default=False, is_flag=True)\\n@click.option('--serial', default=False, is_flag=True)\\n@click.argument('script_args', nargs=-1, type=click.UNPROCESSED)\\ndef run_script(config, output_dir, accounts, tags, region, echo, serial, script_args):\\n \\\"\\\"\\\"run an aws script across accounts\\\"\\\"\\\"\\n # TODO count up on success / error / error list by account\\n accounts_config, custodian_config, executor = init(\\n config, None, serial, True, accounts, tags, (), ())\\n\\n if echo:\\n print(\\\"command to run: `%s`\\\" % (\\\" \\\".join(script_args)))\\n return\\n\\n # Support fully quoted scripts, which are common to avoid parameter\\n # overlap with c7n-org run-script.\\n if len(script_args) == 1 and \\\" \\\" in script_args[0]:\\n script_args = script_args[0].split()\\n\\n with executor(max_workers=WORKER_COUNT) as w:\\n futures = {}\\n for a in accounts_config.get('accounts', ()):\\n for r in resolve_regions(region or a.get('regions', ())):\\n futures[\\n w.submit(run_account_script, a, r, output_dir,\\n serial, script_args)] = (a, r)\\n for f in as_completed(futures):\\n a, r = futures[f]\\n if f.exception():\\n if serial:\\n raise\\n log.warning(\\n \\\"Error running script in %s @ %s exception: %s\\\",\\n a['name'], r, f.exception())\\n exit_code = f.result()\\n if exit_code == 0:\\n log.info(\\n \\\"ran script on account:%s region:%s script: `%s`\\\",\\n a['name'], r, \\\" \\\".join(script_args))\\n else:\\n log.info(\\n \\\"error running script on account:%s region:%s script: `%s`\\\",\\n a['name'], r, \\\" \\\".join(script_args))\\n\\n\\ndef accounts_iterator(config):\\n for a in config.get('accounts', ()):\\n yield a\\n for a in config.get('subscriptions', ()):\\n d = {'account_id': a['subscription_id'],\\n 'name': a.get('name', a['subscription_id']),\\n 'regions': ['global'],\\n 'tags': a.get('tags', ())}\\n yield d\\n for a in config.get('projects', ()):\\n d = {'account_id': a['project_id'],\\n 'name': a.get('name', a['project_id']),\\n 'regions': ['global'],\\n 'tags': a.get('tags', ())}\\n yield d\\n\\n\\ndef run_account(account, region, policies_config, output_path,\\n cache_period, cache_path, metrics, dryrun, debug):\\n \\\"\\\"\\\"Execute a set of policies on an account.\\n \\\"\\\"\\\"\\n logging.getLogger('custodian.output').setLevel(logging.ERROR + 1)\\n CONN_CACHE.session = None\\n CONN_CACHE.time = None\\n\\n # allow users to specify interpolated output paths\\n if '{' not in output_path:\\n output_path = os.path.join(output_path, account['name'], region)\\n\\n cache_path = os.path.join(cache_path, \\\"%s-%s.cache\\\" % (account['account_id'], region))\\n\\n config = Config.empty(\\n region=region, cache=cache_path,\\n cache_period=cache_period, dryrun=dryrun, output_dir=output_path,\\n account_id=account['account_id'], metrics_enabled=metrics,\\n log_group=None, profile=None, external_id=None)\\n\\n env_vars = account_tags(account)\\n\\n if account.get('role'):\\n if isinstance(account['role'], six.string_types):\\n config['assume_role'] = account['role']\\n config['external_id'] = account.get('external_id')\\n else:\\n env_vars.update(\\n _get_env_creds(get_session(account, 'custodian', region), region))\\n\\n elif account.get('profile'):\\n config['profile'] = account['profile']\\n\\n policies = PolicyCollection.from_data(policies_config, config)\\n policy_counts = {}\\n success = True\\n st = time.time()\\n\\n with environ(**env_vars):\\n for p in policies:\\n # Variable expansion and non schema validation (not optional)\\n p.expand_variables(p.get_variables(account.get('vars', {})))\\n p.validate()\\n\\n if p.region and p.region != region:\\n continue\\n\\n log.debug(\\n \\\"Running policy:%s account:%s region:%s\\\",\\n p.name, account['name'], region)\\n try:\\n resources = p.run()\\n policy_counts[p.name] = resources and len(resources) or 0\\n if not resources:\\n continue\\n if not config.dryrun and p.execution_mode != 'pull':\\n log.info(\\\"Ran account:%s region:%s policy:%s provisioned time:%0.2f\\\",\\n account['name'], region, p.name, time.time() - st)\\n continue\\n log.info(\\n \\\"Ran account:%s region:%s policy:%s matched:%d time:%0.2f\\\",\\n account['name'], region, p.name, len(resources),\\n time.time() - st)\\n except ClientError as e:\\n success = False\\n if e.response['Error']['Code'] == 'AccessDenied':\\n log.warning('Access denied api:%s policy:%s account:%s region:%s',\\n e.operation_name, p.name, account['name'], region)\\n return policy_counts, success\\n log.error(\\n \\\"Exception running policy:%s account:%s region:%s error:%s\\\",\\n p.name, account['name'], region, e)\\n continue\\n except Exception as e:\\n success = False\\n log.error(\\n \\\"Exception running policy:%s account:%s region:%s error:%s\\\",\\n p.name, account['name'], region, e)\\n if not debug:\\n continue\\n import traceback, pdb, sys\\n traceback.print_exc()\\n pdb.post_mortem(sys.exc_info()[-1])\\n raise\\n\\n return policy_counts, success\\n\\n\\n@cli.command(name='run')\\n@click.option('-c', '--config', required=True, help=\\\"Accounts config file\\\")\\n@click.option(\\\"-u\\\", \\\"--use\\\", required=True)\\n@click.option('-s', '--output-dir', required=True, type=click.Path())\\n@click.option('-a', '--accounts', multiple=True, default=None)\\n@click.option('-t', '--tags', multiple=True, default=None, help=\\\"Account tag filter\\\")\\n@click.option('-r', '--region', default=None, multiple=True)\\n@click.option('-p', '--policy', multiple=True)\\n@click.option('-l', '--policytags', 'policy_tags',\\n multiple=True, default=None, help=\\\"Policy tag filter\\\")\\n@click.option('--cache-period', default=15, type=int)\\n@click.option('--cache-path', required=False,\\n type=click.Path(\\n writable=True, readable=True, exists=True,\\n resolve_path=True, allow_dash=False,\\n file_okay=False, dir_okay=True),\\n default=None)\\n@click.option(\\\"--metrics\\\", default=False, is_flag=True)\\n@click.option(\\\"--metrics-uri\\\", default=None, help=\\\"Configure provider metrics target\\\")\\n@click.option(\\\"--dryrun\\\", default=False, is_flag=True)\\n@click.option('--debug', default=False, is_flag=True)\\n@click.option('-v', '--verbose', default=False, help=\\\"Verbose\\\", is_flag=True)\\ndef run(config, use, output_dir, accounts, tags, region,\\n policy, policy_tags, cache_period, cache_path, metrics,\\n dryrun, debug, verbose, metrics_uri):\\n \\\"\\\"\\\"run a custodian policy across accounts\\\"\\\"\\\"\\n accounts_config, custodian_config, executor = init(\\n config, use, debug, verbose, accounts, tags, policy, policy_tags=policy_tags)\\n policy_counts = Counter()\\n success = True\\n\\n if metrics_uri:\\n metrics = metrics_uri\\n\\n if not cache_path:\\n cache_path = os.path.expanduser(\\\"~/.cache/c7n-org\\\")\\n if not os.path.exists(cache_path):\\n os.makedirs(cache_path)\\n\\n with executor(max_workers=WORKER_COUNT) as w:\\n futures = {}\\n for a in accounts_config['accounts']:\\n for r in resolve_regions(region or a.get('regions', ())):\\n futures[w.submit(\\n run_account,\\n a, r,\\n custodian_config,\\n output_dir,\\n cache_period,\\n cache_path,\\n metrics,\\n dryrun,\\n debug)] = (a, r)\\n\\n for f in as_completed(futures):\\n a, r = futures[f]\\n if f.exception():\\n if debug:\\n raise\\n log.warning(\\n \\\"Error running policy in %s @ %s exception: %s\\\",\\n a['name'], r, f.exception())\\n\\n account_region_pcounts, account_region_success = f.result()\\n for p in account_region_pcounts:\\n policy_counts[p] += account_region_pcounts[p]\\n\\n if not account_region_success:\\n success = False\\n\\n log.info(\\\"Policy resource counts %s\\\" % policy_counts)\\n\\n if not success:\\n sys.exit(1)\\n\",\n \"path\": \"tools/c7n_org/c7n_org/cli.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/tools/c7n_org/c7n_org/cli.py b/tools/c7n_org/c7n_org/cli.py\nindex 2541de52e25..25f7ccccaca 100644\n--- a/tools/c7n_org/c7n_org/cli.py\n+++ b/tools/c7n_org/c7n_org/cli.py\n@@ -538,6 +538,9 @@ def run_account(account, region, policies_config, output_path,\n p.expand_variables(p.get_variables(account.get('vars', {})))\n p.validate()\n \n+ if p.region and p.region != region:\n+ continue\n+\n log.debug(\n \"Running policy:%s account:%s region:%s\",\n p.name, account['name'], region)\n"}}},{"rowIdx":5490,"cells":{"in_source_id":{"kind":"string","value":"CiviWiki__OpenCiviWiki-521"},"issue":{"kind":"string","value":"Can't Publish New Thread\nI attempted to make a new thread on Civiwiki.org. I was able to create the content, but when I hit publish it throws a server error. \r\n\r\n\r\n\r\n\r\n\n"},"before_files":{"kind":"list like","value":[{"content":"import json\nimport PIL\nimport urllib\nimport uuid\n\nfrom notifications.signals import notify\n\n# django packages\nfrom django.db.models.query import F\nfrom django.contrib.auth.models import User\nfrom django.http import (\n JsonResponse,\n HttpResponse,\n HttpResponseServerError,\n HttpResponseForbidden,\n HttpResponseBadRequest\n)\n\nfrom django.core.files import File # need this for image file handling\nfrom django.contrib.auth.decorators import login_required\nfrom django.contrib.auth.decorators import user_passes_test\nfrom django.contrib.sites.shortcuts import get_current_site\n\n# civi packages\nfrom api.forms import UpdateProfileImage\nfrom api.models import Thread\nfrom api.tasks import send_mass_email\nfrom models import Account, Activity, Category, Civi, CiviImage, Invitation, Bill\nfrom core.custom_decorators import require_post_params\nfrom core.constants import US_STATES\n\n\n@login_required\n@require_post_params(params=['title', 'summary', 'category_id'])\ndef new_thread(request):\n new_thread_data = dict(\n title=request.POST['title'],\n summary=request.POST['summary'],\n category_id=request.POST['category_id'],\n author_id=request.user.id,\n level=request.POST['level']\n )\n state = request.POST['state']\n if state:\n new_thread_data['state'] = state\n\n new_t = Thread(**new_thread_data)\n new_t.save()\n\n return JsonResponse({'data': 'success', 'thread_id': new_t.pk})\n\n\n@login_required\n@require_post_params(params=['title', 'body', 'c_type', 'thread_id'])\ndef createCivi(request):\n '''\n USAGE:\n use this function to insert a new connected civi into the database.\n\n :return: (200, ok) (400, missing required parameter) (500, internal error)\n '''\n\n a = Account.objects.get(user=request.user)\n thread_id = request.POST.get('thread_id')\n data = {\n 'author': Account.objects.get(user=request.user),\n 'title': request.POST.get('title', ''),\n 'body': request.POST.get('body', ''),\n 'c_type': request.POST.get('c_type', ''),\n 'thread': Thread.objects.get(id=thread_id)\n }\n\n try:\n civi = Civi(**data)\n civi.save()\n links = request.POST.getlist('links[]', '')\n bills = request.POST.getlist('bills[]', '')\n if links:\n for civi_id in links:\n linked_civi = Civi.objects.get(id=civi_id)\n civi.linked_civis.add(linked_civi)\n\n if bills:\n for bill_id in bills:\n linked_bill = Bill.objects.get(id=bill_id)\n civi.linked_bills.add(linked_bill)\n\n # If response\n related_civi = request.POST.get('related_civi', '')\n if related_civi:\n parent_civi = Civi.objects.get(id=related_civi)\n parent_civi.responses.add(civi)\n\n if parent_civi.author.user.username != request.user.username:\n notify.send(\n request.user, # Actor User\n recipient=parent_civi.author.user, # Target User\n verb=u'responded to your civi', # Verb\n action_object=civi, # Action Object\n target=civi.thread, # Target Object\n popup_string=\"{user} responded to your civi in {thread}\".format(\n user=a.full_name,\n thread=civi.thread.title\n ),\n link=\"/{}/{}\".format(\"thread\", thread_id)\n )\n\n else: # not a reply, a regular civi\n c_qs = Civi.objects.filter(thread_id=thread_id)\n accounts = Account.objects.filter(pk__in=c_qs.distinct('author').values_list('author', flat=True))\n data = {\n \"command\": \"add\",\n \"data\": json.dumps(civi.dict_with_score(a.id)),\n }\n\n for act in accounts:\n if act.user.username != request.user.username:\n notify.send(\n request.user, # Actor User\n recipient=act.user, # Target User\n verb=u'created a new civi', # Verb\n action_object=civi, # Action Object\n target=civi.thread, # Target Object\n popup_string=\"{user} created a new civi in the thread {thread}\".format(\n user=a.full_name,\n thread=civi.thread.title\n ),\n link=\"/{}/{}\".format(\"thread\", thread_id)\n )\n\n return JsonResponse({'data': civi.dict_with_score(a.id)})\n except Exception as e:\n return HttpResponseServerError(reason=str(e))\n\n\n@login_required\n@require_post_params(params=['civi_id', 'rating'])\ndef rateCivi(request):\n civi_id = request.POST.get('civi_id', '')\n rating = request.POST.get('rating', '')\n account = Account.objects.get(user=request.user)\n\n voted_civi = Civi.objects.get(id=civi_id)\n\n if voted_civi.thread.is_draft:\n return HttpResponseServerError(reason=str(\"Cannot vote on a civi that is in a thread still in draft mode\"))\n\n try:\n prev_act = Activity.objects.get(civi=voted_civi, account=account)\n except Activity.DoesNotExist:\n prev_act = None\n\n activity_data = {\n 'account': account,\n 'thread': voted_civi.thread,\n 'civi': voted_civi,\n }\n\n activity_vote_key = 'votes_{}'.format(rating)\n vote_val = 'vote_{}'.format(rating)\n # F object doesn't cause losing data in case of race\n setattr(voted_civi, activity_vote_key, F(activity_vote_key) + 1)\n voted_civi.save()\n\n if prev_act:\n prev_act.activity_type = vote_val\n prev_act.save()\n act = prev_act\n else:\n act = Activity(**activity_data)\n act.save()\n\n data = {\n 'civi_id': act.civi.id,\n 'activity_type': act.activity_type,\n 'c_type': act.civi.c_type\n }\n return JsonResponse({'data': data})\n\n\n@login_required\ndef editCivi(request):\n civi_id = request.POST.get('civi_id', '')\n title = request.POST.get('title', '')\n body = request.POST.get('body', '')\n civi_type = request.POST.get('type', '')\n\n c = Civi.objects.get(id=civi_id)\n if (request.user.username != c.author.user.username):\n return HttpResponseBadRequest(reason=\"No Edit Rights\")\n\n try:\n c.title = title\n c.body = body\n c.c_type = civi_type\n c.save(update_fields=['title', 'body'])\n\n links = request.POST.getlist('links[]', '')\n c.linked_civis.clear()\n if links:\n for civiimage_id in links:\n linked_civi = Civi.objects.get(id=civiimage_id)\n c.linked_civis.add(linked_civi)\n\n image_remove_list = request.POST.getlist('image_remove_list[]', '')\n if image_remove_list:\n for image_id in image_remove_list:\n civi_image = CiviImage.objects.get(id=image_id)\n civi_image.delete()\n\n a = Account.objects.get(user=request.user)\n return JsonResponse(c.dict_with_score(a.id))\n except Exception as e:\n return HttpResponseServerError(reason=str(e))\n\n\n@login_required\ndef deleteCivi(request):\n civi_id = request.POST.get('civi_id', '')\n\n c = Civi.objects.get(id=civi_id)\n if (request.user.username != c.author.user.username):\n return HttpResponseBadRequest(reason=\"No Edit Rights\")\n\n try:\n c.delete()\n\n return HttpResponse('Success')\n except Exception as e:\n return HttpResponseServerError(reason=str(e))\n\n\n# TODO 1: profile image file upload\n# TODO 2: redo user editing\n# TODO 3: django forms\n# @login_required\n# def get_dist(request):\n# '''\n# Upon First registering or changing location information gets representative codes and addes them to the user array\n# '''\n# request = urllib2.Request(\"https://congress.api.sunlightfoundation.com/\")\n#\n# #S3tting the key as the value of an X-APIKEY HTTP request header.\n# data = {\n# \"apikey\": APIKEY,\n# \"fields\": [],\n#\n# }\n# request.add_data(json.dumps(data))\n#\n# response = urllib2.urlopen(request)\n# resp_parsed = json.loads(response.read())\n# reps = [for rep in resp_parsed.data]\n# Account.user(request.user).representatives = reps\n#\n\n@login_required\ndef editThread(request):\n thread_id = request.POST.get(\"thread_id\")\n non_required_params = [\"title\", \"summary\", \"category_id\", \"level\", \"state\"]\n is_draft = request.POST.get(\"is_draft\", True)\n\n if not thread_id:\n return HttpResponseBadRequest(reason=\"Invalid Thread Reference\")\n\n if not is_draft:\n Thread.objects.filter(id=thread_id).update(is_draft=False)\n\n return JsonResponse({'data': \"Success\"})\n\n try:\n req_edit_thread = Thread.objects.get(id=thread_id)\n\n if request.user.username != req_edit_thread.author.user.username:\n return HttpResponseBadRequest(\"No Edit Rights\")\n\n # set remaining parameters from request\n for param in non_required_params:\n request_value = request.POST.get(param)\n\n if request_value:\n setattr(req_edit_thread, param, request_value)\n\n req_edit_thread.save()\n except Exception as e:\n return HttpResponseServerError(reason=str(e))\n\n location = req_edit_thread.level if not req_edit_thread.state else dict(US_STATES).get(req_edit_thread.state)\n\n return_data = {\n \"thread_id\": thread_id,\n \"title\": req_edit_thread.title,\n \"summary\": req_edit_thread.summary,\n \"category\": {\n \"id\": req_edit_thread.category.id,\n \"name\": req_edit_thread.category.name\n },\n \"level\": req_edit_thread.level,\n \"state\": req_edit_thread.state if req_edit_thread.level == \"state\" else \"\",\n \"location\": location,\n }\n return JsonResponse({\"data\": return_data})\n\n\n\n@login_required\ndef uploadphoto(request):\n pass\n\n\n@login_required\ndef editUser(request):\n '''\n Edit Account Model\n '''\n request_data = request.POST\n user = request.user\n account = Account.objects.get(user=user)\n interests = request_data.get('interests', False)\n\n if interests:\n interests = list(interests)\n else:\n interests = account.interests\n\n data = {\n \"first_name\": request_data.get('first_name', account.first_name),\n \"last_name\": request_data.get('last_name', account.last_name),\n \"about_me\": request_data.get('about_me', account.about_me),\n \"address\": request_data.get('address', account.address),\n \"city\": request_data.get('city', account.city),\n \"state\": request_data.get('state', account.state),\n \"zip_code\": request_data.get('zip_code', account.zip_code),\n \"longitude\": request_data.get('longitude', account.longitude),\n \"latitude\": request_data.get('latitude', account.latitude),\n \"country\": request_data.get('country', account.country),\n }\n\n account.__dict__.update(data)\n\n try:\n account.save()\n except Exception as e:\n return HttpResponseServerError(reason=str(e))\n\n account.refresh_from_db()\n\n return JsonResponse(Account.objects.summarize(account))\n\n\n@login_required\ndef uploadProfileImage(request):\n if request.method == 'POST':\n form = UpdateProfileImage(request.POST, request.FILES)\n if form.is_valid():\n try:\n account = Account.objects.get(user=request.user)\n\n # Clean up previous image\n account.profile_image.delete()\n\n # Upload new image and set as profile picture\n account.profile_image = form.clean_profile_image()\n try:\n account.save()\n except Exception as e:\n response = {\n 'message': str(e),\n 'error': 'MODEL_SAVE_ERROR'\n }\n return JsonResponse(response, status=400)\n\n request.session[\"login_user_image\"] = account.profile_image_thumb_url\n\n response = {\n 'profile_image': account.profile_image_url\n }\n return JsonResponse(response, status=200)\n except Exception as e:\n response = {\n 'message': str(e),\n 'error': 'MODEL_ERROR'\n }\n return JsonResponse(response, status=400)\n else:\n response = {\n 'message': form.errors['profile_image'],\n 'error': 'FORM_ERROR'\n }\n return JsonResponse(response, status=400)\n\n else:\n return HttpResponseForbidden('allowed only via POST')\n\n\n@login_required\ndef clearProfileImage(request):\n if request.method == 'POST':\n try:\n account = Account.objects.get(user=request.user)\n\n # Clean up previous image\n account.profile_image.delete()\n account.save()\n\n return HttpResponse('Image Deleted')\n except Exception:\n return HttpResponseServerError(reason=str(\"default\"))\n else:\n return HttpResponseForbidden('allowed only via POST')\n\n\n@login_required\ndef uploadCiviImage(request):\n if request.method == 'POST':\n r = request.POST\n civi_id = r.get('civi_id')\n if not civi_id:\n return HttpResponseBadRequest(reason=\"Invalid Civi Reference\")\n\n try:\n c = Civi.objects.get(id=civi_id)\n\n attachment_links = request.POST.getlist('attachment_links[]')\n\n if attachment_links:\n for img_link in attachment_links:\n result = urllib.urlretrieve(img_link)\n img_file = File(open(result[0]))\n if check_image_with_pil(img_file):\n civi_image = CiviImage(title=\"\", civi=c, image=img_file)\n civi_image.save()\n\n if len(request.FILES) != 0:\n for image in request.FILES.getlist('attachment_image'):\n civi_image = CiviImage(title=\"\", civi=c, image=image)\n civi_image.save()\n\n data = {\n \"attachments\": [{'id': img.id, 'image_url': img.image_url} for img in c.images.all()],\n }\n return JsonResponse(data)\n\n except Exception as e:\n return HttpResponseServerError(reason=(str(e) + civi_id + str(request.FILES)))\n else:\n return HttpResponseForbidden('allowed only via POST')\n\n\ndef check_image_with_pil(image_file):\n try:\n PIL.Image.open(image_file)\n except IOError:\n return False\n return True\n\n\n@login_required\ndef uploadThreadImage(request):\n if request.method == 'POST':\n r = request.POST\n thread_id = r.get('thread_id')\n if not thread_id:\n return HttpResponseBadRequest(reason=\"Invalid Thread Reference\")\n\n try:\n thread = Thread.objects.get(id=thread_id)\n remove = r.get('remove', '')\n img_link = r.get('link', '')\n if remove:\n thread.image.delete()\n thread.save()\n\n elif img_link:\n thread.image.delete()\n result = urllib.urlretrieve(img_link)\n img_file = File(open(result[0]))\n if check_image_with_pil(img_file):\n thread.image = img_file\n thread.save()\n # else:\n # return HttpResponseBadRequest(\"Invalid Image\")\n else:\n # Clean up previous image\n thread.image.delete()\n\n # Upload new image and set as profile picture\n thread.image = request.FILES['attachment_image']\n thread.save()\n\n data = {\n 'image': thread.image_url\n }\n return JsonResponse(data)\n\n except Exception as e:\n return HttpResponseServerError(reason=(str(e)))\n else:\n return HttpResponseForbidden('allowed only via POST')\n\n\n@login_required\n@require_post_params(params=['target'])\ndef requestFollow(request):\n '''\n USAGE:\n Takes in user_id from current friend_requests list and joins accounts as friends.\n Does not join accounts as friends unless the POST friend is a valid member of the friend request array.\n\n Text POST:\n friend\n\n :return: (200, okay, list of friend information) (400, bad lookup) (500, error)\n '''\n if (request.user.username == request.POST.get('target', -1)):\n return HttpResponseBadRequest(reason=\"You cannot follow yourself, silly!\")\n\n try:\n account = Account.objects.get(user=request.user)\n target = User.objects.get(username=request.POST.get('target', -1))\n target_account = Account.objects.get(user=target)\n\n account.following.add(target_account)\n account.save()\n target_account.followers.add(account)\n target_account.save()\n data = {\n 'username': target.username,\n 'follow_status': True\n }\n\n notify.send(\n request.user, # Actor User\n recipient=target, # Target User\n verb=u'is following you', # Verb\n target=target_account, # Target Object\n popup_string=\"{user} is now following you\".format(user=account.full_name),\n link=\"/{}/{}\".format(\"profile\", request.user.username)\n )\n\n return JsonResponse({\"result\": data})\n except Account.DoesNotExist as e:\n return HttpResponseBadRequest(reason=str(e))\n except Exception as e:\n return HttpResponseServerError(reason=str(e))\n\n\n@login_required\n@require_post_params(params=['target'])\ndef requestUnfollow(request):\n '''\n USAGE:\n Takes in user_id from current friend_requests list and joins accounts as friends.\n Does not join accounts as friends unless the POST friend is a valid member of the friend request array.\n\n Text POST:\n friend\n\n :return: (200, okay, list of friend information) (400, bad lookup) (500, error)\n '''\n try:\n account = Account.objects.get(user=request.user)\n target = User.objects.get(username=request.POST.get('target', -1))\n target_account = Account.objects.get(user=target)\n\n account.following.remove(target_account)\n account.save()\n target_account.followers.remove(account)\n target_account.save()\n return JsonResponse({\"result\": \"Success\"})\n except Account.DoesNotExist as e:\n return HttpResponseBadRequest(reason=str(e))\n except Exception as e:\n return HttpResponseServerError(reason=str(e))\n\n\n@login_required\ndef editUserCategories(request):\n '''\n USAGE:\n Edits list of categories for the user\n\n '''\n try:\n account = Account.objects.get(user=request.user)\n categories = [int(i) for i in request.POST.getlist('categories[]')]\n account.categories.clear()\n for category in categories:\n account.categories.add(Category.objects.get(id=category))\n account.save()\n\n data = {\n 'user_categories': list(account.categories.values_list('id', flat=True)) or \"all_categories\"\n }\n return JsonResponse({\"result\": data})\n except Account.DoesNotExist as e:\n return HttpResponseBadRequest(reason=str(e))\n except Exception as e:\n return HttpResponseServerError(reason=str(e))\n\n\n@login_required\n@user_passes_test(lambda u: u.is_staff)\ndef invite(request):\n emails = request.POST.getlist('emailList[]', '')\n custom_message = request.POST.get('custom_message', '')\n\n if emails:\n user = User.objects.get(username=request.user.username)\n user_account = Account.objects.get(user=user)\n did_not_invite = []\n\n # TODO: Move this to string templates\n if custom_message:\n email_body = (\"{host_name} has invited you to be part of CiviWiki Beta \"\n \"with the following message: {custom_message}\").format(\n host_name=user_account.full_name,\n custom_message=custom_message\n )\n else:\n email_body = (\"{host_name} has invited you to be part of CiviWiki Beta. \"\n \"Follow the link below to get registered.\").format(\n host_name=user_account.full_name\n )\n\n email_messages = []\n valid_emails = []\n for email in emails:\n if Invitation.objects.filter(invitee_email=email).exists():\n did_not_invite.append(email)\n else:\n valid_emails.append(email)\n verification_hash = uuid.uuid4().hex[:31]\n data = {\n 'host_user': user,\n 'invitee_email': email,\n 'verification_code': verification_hash,\n }\n\n domain = get_current_site(request).domain\n base_url = \"http://{domain}/beta_register/{email}/{token}\"\n url_with_code = base_url.format(\n domain=domain,\n email=email,\n token=verification_hash\n )\n\n email_context = {\n 'title': \"You're Invited to Join CiviWiki Beta\",\n 'greeting': \"You're Invited to Join CiviWiki Beta\",\n 'body': email_body,\n 'link': url_with_code,\n 'recipient': [email]\n }\n email_messages.append(email_context)\n\n new_invitation = Invitation(**data)\n new_invitation.save()\n\n if email_messages:\n email_subject = \"Invitation to CiviWiki\"\n send_mass_email.delay(\n subject=email_subject,\n contexts=email_messages\n )\n\n if len(did_not_invite) == len(emails):\n response_data = {\n \"message\": \"Invitations exist for submitted email(s). No new invitations sent\",\n \"error\": \"INVALID_EMAIL_DATA\"\n }\n return JsonResponse(response_data, status=400)\n\n invitations = Invitation.objects.filter_by_host(host_user=user).order_by(\"-date_created\").all()\n invitees = [invitation.summarize() for invitation in invitations]\n\n response_data = {\n 'did_not_invite': did_not_invite,\n 'invitees': invitees\n }\n return JsonResponse(response_data)\n\n else:\n # Return an 'invalid login' error message.\n response = {\n \"message\": 'Invalid Email Data',\n \"error\": \"INVALID_EMAIL_DATA\"\n }\n return JsonResponse(response, status=400)\n","path":"project/api/write.py"}],"string":"[\n {\n \"content\": \"import json\\nimport PIL\\nimport urllib\\nimport uuid\\n\\nfrom notifications.signals import notify\\n\\n# django packages\\nfrom django.db.models.query import F\\nfrom django.contrib.auth.models import User\\nfrom django.http import (\\n JsonResponse,\\n HttpResponse,\\n HttpResponseServerError,\\n HttpResponseForbidden,\\n HttpResponseBadRequest\\n)\\n\\nfrom django.core.files import File # need this for image file handling\\nfrom django.contrib.auth.decorators import login_required\\nfrom django.contrib.auth.decorators import user_passes_test\\nfrom django.contrib.sites.shortcuts import get_current_site\\n\\n# civi packages\\nfrom api.forms import UpdateProfileImage\\nfrom api.models import Thread\\nfrom api.tasks import send_mass_email\\nfrom models import Account, Activity, Category, Civi, CiviImage, Invitation, Bill\\nfrom core.custom_decorators import require_post_params\\nfrom core.constants import US_STATES\\n\\n\\n@login_required\\n@require_post_params(params=['title', 'summary', 'category_id'])\\ndef new_thread(request):\\n new_thread_data = dict(\\n title=request.POST['title'],\\n summary=request.POST['summary'],\\n category_id=request.POST['category_id'],\\n author_id=request.user.id,\\n level=request.POST['level']\\n )\\n state = request.POST['state']\\n if state:\\n new_thread_data['state'] = state\\n\\n new_t = Thread(**new_thread_data)\\n new_t.save()\\n\\n return JsonResponse({'data': 'success', 'thread_id': new_t.pk})\\n\\n\\n@login_required\\n@require_post_params(params=['title', 'body', 'c_type', 'thread_id'])\\ndef createCivi(request):\\n '''\\n USAGE:\\n use this function to insert a new connected civi into the database.\\n\\n :return: (200, ok) (400, missing required parameter) (500, internal error)\\n '''\\n\\n a = Account.objects.get(user=request.user)\\n thread_id = request.POST.get('thread_id')\\n data = {\\n 'author': Account.objects.get(user=request.user),\\n 'title': request.POST.get('title', ''),\\n 'body': request.POST.get('body', ''),\\n 'c_type': request.POST.get('c_type', ''),\\n 'thread': Thread.objects.get(id=thread_id)\\n }\\n\\n try:\\n civi = Civi(**data)\\n civi.save()\\n links = request.POST.getlist('links[]', '')\\n bills = request.POST.getlist('bills[]', '')\\n if links:\\n for civi_id in links:\\n linked_civi = Civi.objects.get(id=civi_id)\\n civi.linked_civis.add(linked_civi)\\n\\n if bills:\\n for bill_id in bills:\\n linked_bill = Bill.objects.get(id=bill_id)\\n civi.linked_bills.add(linked_bill)\\n\\n # If response\\n related_civi = request.POST.get('related_civi', '')\\n if related_civi:\\n parent_civi = Civi.objects.get(id=related_civi)\\n parent_civi.responses.add(civi)\\n\\n if parent_civi.author.user.username != request.user.username:\\n notify.send(\\n request.user, # Actor User\\n recipient=parent_civi.author.user, # Target User\\n verb=u'responded to your civi', # Verb\\n action_object=civi, # Action Object\\n target=civi.thread, # Target Object\\n popup_string=\\\"{user} responded to your civi in {thread}\\\".format(\\n user=a.full_name,\\n thread=civi.thread.title\\n ),\\n link=\\\"/{}/{}\\\".format(\\\"thread\\\", thread_id)\\n )\\n\\n else: # not a reply, a regular civi\\n c_qs = Civi.objects.filter(thread_id=thread_id)\\n accounts = Account.objects.filter(pk__in=c_qs.distinct('author').values_list('author', flat=True))\\n data = {\\n \\\"command\\\": \\\"add\\\",\\n \\\"data\\\": json.dumps(civi.dict_with_score(a.id)),\\n }\\n\\n for act in accounts:\\n if act.user.username != request.user.username:\\n notify.send(\\n request.user, # Actor User\\n recipient=act.user, # Target User\\n verb=u'created a new civi', # Verb\\n action_object=civi, # Action Object\\n target=civi.thread, # Target Object\\n popup_string=\\\"{user} created a new civi in the thread {thread}\\\".format(\\n user=a.full_name,\\n thread=civi.thread.title\\n ),\\n link=\\\"/{}/{}\\\".format(\\\"thread\\\", thread_id)\\n )\\n\\n return JsonResponse({'data': civi.dict_with_score(a.id)})\\n except Exception as e:\\n return HttpResponseServerError(reason=str(e))\\n\\n\\n@login_required\\n@require_post_params(params=['civi_id', 'rating'])\\ndef rateCivi(request):\\n civi_id = request.POST.get('civi_id', '')\\n rating = request.POST.get('rating', '')\\n account = Account.objects.get(user=request.user)\\n\\n voted_civi = Civi.objects.get(id=civi_id)\\n\\n if voted_civi.thread.is_draft:\\n return HttpResponseServerError(reason=str(\\\"Cannot vote on a civi that is in a thread still in draft mode\\\"))\\n\\n try:\\n prev_act = Activity.objects.get(civi=voted_civi, account=account)\\n except Activity.DoesNotExist:\\n prev_act = None\\n\\n activity_data = {\\n 'account': account,\\n 'thread': voted_civi.thread,\\n 'civi': voted_civi,\\n }\\n\\n activity_vote_key = 'votes_{}'.format(rating)\\n vote_val = 'vote_{}'.format(rating)\\n # F object doesn't cause losing data in case of race\\n setattr(voted_civi, activity_vote_key, F(activity_vote_key) + 1)\\n voted_civi.save()\\n\\n if prev_act:\\n prev_act.activity_type = vote_val\\n prev_act.save()\\n act = prev_act\\n else:\\n act = Activity(**activity_data)\\n act.save()\\n\\n data = {\\n 'civi_id': act.civi.id,\\n 'activity_type': act.activity_type,\\n 'c_type': act.civi.c_type\\n }\\n return JsonResponse({'data': data})\\n\\n\\n@login_required\\ndef editCivi(request):\\n civi_id = request.POST.get('civi_id', '')\\n title = request.POST.get('title', '')\\n body = request.POST.get('body', '')\\n civi_type = request.POST.get('type', '')\\n\\n c = Civi.objects.get(id=civi_id)\\n if (request.user.username != c.author.user.username):\\n return HttpResponseBadRequest(reason=\\\"No Edit Rights\\\")\\n\\n try:\\n c.title = title\\n c.body = body\\n c.c_type = civi_type\\n c.save(update_fields=['title', 'body'])\\n\\n links = request.POST.getlist('links[]', '')\\n c.linked_civis.clear()\\n if links:\\n for civiimage_id in links:\\n linked_civi = Civi.objects.get(id=civiimage_id)\\n c.linked_civis.add(linked_civi)\\n\\n image_remove_list = request.POST.getlist('image_remove_list[]', '')\\n if image_remove_list:\\n for image_id in image_remove_list:\\n civi_image = CiviImage.objects.get(id=image_id)\\n civi_image.delete()\\n\\n a = Account.objects.get(user=request.user)\\n return JsonResponse(c.dict_with_score(a.id))\\n except Exception as e:\\n return HttpResponseServerError(reason=str(e))\\n\\n\\n@login_required\\ndef deleteCivi(request):\\n civi_id = request.POST.get('civi_id', '')\\n\\n c = Civi.objects.get(id=civi_id)\\n if (request.user.username != c.author.user.username):\\n return HttpResponseBadRequest(reason=\\\"No Edit Rights\\\")\\n\\n try:\\n c.delete()\\n\\n return HttpResponse('Success')\\n except Exception as e:\\n return HttpResponseServerError(reason=str(e))\\n\\n\\n# TODO 1: profile image file upload\\n# TODO 2: redo user editing\\n# TODO 3: django forms\\n# @login_required\\n# def get_dist(request):\\n# '''\\n# Upon First registering or changing location information gets representative codes and addes them to the user array\\n# '''\\n# request = urllib2.Request(\\\"https://congress.api.sunlightfoundation.com/\\\")\\n#\\n# #S3tting the key as the value of an X-APIKEY HTTP request header.\\n# data = {\\n# \\\"apikey\\\": APIKEY,\\n# \\\"fields\\\": [],\\n#\\n# }\\n# request.add_data(json.dumps(data))\\n#\\n# response = urllib2.urlopen(request)\\n# resp_parsed = json.loads(response.read())\\n# reps = [for rep in resp_parsed.data]\\n# Account.user(request.user).representatives = reps\\n#\\n\\n@login_required\\ndef editThread(request):\\n thread_id = request.POST.get(\\\"thread_id\\\")\\n non_required_params = [\\\"title\\\", \\\"summary\\\", \\\"category_id\\\", \\\"level\\\", \\\"state\\\"]\\n is_draft = request.POST.get(\\\"is_draft\\\", True)\\n\\n if not thread_id:\\n return HttpResponseBadRequest(reason=\\\"Invalid Thread Reference\\\")\\n\\n if not is_draft:\\n Thread.objects.filter(id=thread_id).update(is_draft=False)\\n\\n return JsonResponse({'data': \\\"Success\\\"})\\n\\n try:\\n req_edit_thread = Thread.objects.get(id=thread_id)\\n\\n if request.user.username != req_edit_thread.author.user.username:\\n return HttpResponseBadRequest(\\\"No Edit Rights\\\")\\n\\n # set remaining parameters from request\\n for param in non_required_params:\\n request_value = request.POST.get(param)\\n\\n if request_value:\\n setattr(req_edit_thread, param, request_value)\\n\\n req_edit_thread.save()\\n except Exception as e:\\n return HttpResponseServerError(reason=str(e))\\n\\n location = req_edit_thread.level if not req_edit_thread.state else dict(US_STATES).get(req_edit_thread.state)\\n\\n return_data = {\\n \\\"thread_id\\\": thread_id,\\n \\\"title\\\": req_edit_thread.title,\\n \\\"summary\\\": req_edit_thread.summary,\\n \\\"category\\\": {\\n \\\"id\\\": req_edit_thread.category.id,\\n \\\"name\\\": req_edit_thread.category.name\\n },\\n \\\"level\\\": req_edit_thread.level,\\n \\\"state\\\": req_edit_thread.state if req_edit_thread.level == \\\"state\\\" else \\\"\\\",\\n \\\"location\\\": location,\\n }\\n return JsonResponse({\\\"data\\\": return_data})\\n\\n\\n\\n@login_required\\ndef uploadphoto(request):\\n pass\\n\\n\\n@login_required\\ndef editUser(request):\\n '''\\n Edit Account Model\\n '''\\n request_data = request.POST\\n user = request.user\\n account = Account.objects.get(user=user)\\n interests = request_data.get('interests', False)\\n\\n if interests:\\n interests = list(interests)\\n else:\\n interests = account.interests\\n\\n data = {\\n \\\"first_name\\\": request_data.get('first_name', account.first_name),\\n \\\"last_name\\\": request_data.get('last_name', account.last_name),\\n \\\"about_me\\\": request_data.get('about_me', account.about_me),\\n \\\"address\\\": request_data.get('address', account.address),\\n \\\"city\\\": request_data.get('city', account.city),\\n \\\"state\\\": request_data.get('state', account.state),\\n \\\"zip_code\\\": request_data.get('zip_code', account.zip_code),\\n \\\"longitude\\\": request_data.get('longitude', account.longitude),\\n \\\"latitude\\\": request_data.get('latitude', account.latitude),\\n \\\"country\\\": request_data.get('country', account.country),\\n }\\n\\n account.__dict__.update(data)\\n\\n try:\\n account.save()\\n except Exception as e:\\n return HttpResponseServerError(reason=str(e))\\n\\n account.refresh_from_db()\\n\\n return JsonResponse(Account.objects.summarize(account))\\n\\n\\n@login_required\\ndef uploadProfileImage(request):\\n if request.method == 'POST':\\n form = UpdateProfileImage(request.POST, request.FILES)\\n if form.is_valid():\\n try:\\n account = Account.objects.get(user=request.user)\\n\\n # Clean up previous image\\n account.profile_image.delete()\\n\\n # Upload new image and set as profile picture\\n account.profile_image = form.clean_profile_image()\\n try:\\n account.save()\\n except Exception as e:\\n response = {\\n 'message': str(e),\\n 'error': 'MODEL_SAVE_ERROR'\\n }\\n return JsonResponse(response, status=400)\\n\\n request.session[\\\"login_user_image\\\"] = account.profile_image_thumb_url\\n\\n response = {\\n 'profile_image': account.profile_image_url\\n }\\n return JsonResponse(response, status=200)\\n except Exception as e:\\n response = {\\n 'message': str(e),\\n 'error': 'MODEL_ERROR'\\n }\\n return JsonResponse(response, status=400)\\n else:\\n response = {\\n 'message': form.errors['profile_image'],\\n 'error': 'FORM_ERROR'\\n }\\n return JsonResponse(response, status=400)\\n\\n else:\\n return HttpResponseForbidden('allowed only via POST')\\n\\n\\n@login_required\\ndef clearProfileImage(request):\\n if request.method == 'POST':\\n try:\\n account = Account.objects.get(user=request.user)\\n\\n # Clean up previous image\\n account.profile_image.delete()\\n account.save()\\n\\n return HttpResponse('Image Deleted')\\n except Exception:\\n return HttpResponseServerError(reason=str(\\\"default\\\"))\\n else:\\n return HttpResponseForbidden('allowed only via POST')\\n\\n\\n@login_required\\ndef uploadCiviImage(request):\\n if request.method == 'POST':\\n r = request.POST\\n civi_id = r.get('civi_id')\\n if not civi_id:\\n return HttpResponseBadRequest(reason=\\\"Invalid Civi Reference\\\")\\n\\n try:\\n c = Civi.objects.get(id=civi_id)\\n\\n attachment_links = request.POST.getlist('attachment_links[]')\\n\\n if attachment_links:\\n for img_link in attachment_links:\\n result = urllib.urlretrieve(img_link)\\n img_file = File(open(result[0]))\\n if check_image_with_pil(img_file):\\n civi_image = CiviImage(title=\\\"\\\", civi=c, image=img_file)\\n civi_image.save()\\n\\n if len(request.FILES) != 0:\\n for image in request.FILES.getlist('attachment_image'):\\n civi_image = CiviImage(title=\\\"\\\", civi=c, image=image)\\n civi_image.save()\\n\\n data = {\\n \\\"attachments\\\": [{'id': img.id, 'image_url': img.image_url} for img in c.images.all()],\\n }\\n return JsonResponse(data)\\n\\n except Exception as e:\\n return HttpResponseServerError(reason=(str(e) + civi_id + str(request.FILES)))\\n else:\\n return HttpResponseForbidden('allowed only via POST')\\n\\n\\ndef check_image_with_pil(image_file):\\n try:\\n PIL.Image.open(image_file)\\n except IOError:\\n return False\\n return True\\n\\n\\n@login_required\\ndef uploadThreadImage(request):\\n if request.method == 'POST':\\n r = request.POST\\n thread_id = r.get('thread_id')\\n if not thread_id:\\n return HttpResponseBadRequest(reason=\\\"Invalid Thread Reference\\\")\\n\\n try:\\n thread = Thread.objects.get(id=thread_id)\\n remove = r.get('remove', '')\\n img_link = r.get('link', '')\\n if remove:\\n thread.image.delete()\\n thread.save()\\n\\n elif img_link:\\n thread.image.delete()\\n result = urllib.urlretrieve(img_link)\\n img_file = File(open(result[0]))\\n if check_image_with_pil(img_file):\\n thread.image = img_file\\n thread.save()\\n # else:\\n # return HttpResponseBadRequest(\\\"Invalid Image\\\")\\n else:\\n # Clean up previous image\\n thread.image.delete()\\n\\n # Upload new image and set as profile picture\\n thread.image = request.FILES['attachment_image']\\n thread.save()\\n\\n data = {\\n 'image': thread.image_url\\n }\\n return JsonResponse(data)\\n\\n except Exception as e:\\n return HttpResponseServerError(reason=(str(e)))\\n else:\\n return HttpResponseForbidden('allowed only via POST')\\n\\n\\n@login_required\\n@require_post_params(params=['target'])\\ndef requestFollow(request):\\n '''\\n USAGE:\\n Takes in user_id from current friend_requests list and joins accounts as friends.\\n Does not join accounts as friends unless the POST friend is a valid member of the friend request array.\\n\\n Text POST:\\n friend\\n\\n :return: (200, okay, list of friend information) (400, bad lookup) (500, error)\\n '''\\n if (request.user.username == request.POST.get('target', -1)):\\n return HttpResponseBadRequest(reason=\\\"You cannot follow yourself, silly!\\\")\\n\\n try:\\n account = Account.objects.get(user=request.user)\\n target = User.objects.get(username=request.POST.get('target', -1))\\n target_account = Account.objects.get(user=target)\\n\\n account.following.add(target_account)\\n account.save()\\n target_account.followers.add(account)\\n target_account.save()\\n data = {\\n 'username': target.username,\\n 'follow_status': True\\n }\\n\\n notify.send(\\n request.user, # Actor User\\n recipient=target, # Target User\\n verb=u'is following you', # Verb\\n target=target_account, # Target Object\\n popup_string=\\\"{user} is now following you\\\".format(user=account.full_name),\\n link=\\\"/{}/{}\\\".format(\\\"profile\\\", request.user.username)\\n )\\n\\n return JsonResponse({\\\"result\\\": data})\\n except Account.DoesNotExist as e:\\n return HttpResponseBadRequest(reason=str(e))\\n except Exception as e:\\n return HttpResponseServerError(reason=str(e))\\n\\n\\n@login_required\\n@require_post_params(params=['target'])\\ndef requestUnfollow(request):\\n '''\\n USAGE:\\n Takes in user_id from current friend_requests list and joins accounts as friends.\\n Does not join accounts as friends unless the POST friend is a valid member of the friend request array.\\n\\n Text POST:\\n friend\\n\\n :return: (200, okay, list of friend information) (400, bad lookup) (500, error)\\n '''\\n try:\\n account = Account.objects.get(user=request.user)\\n target = User.objects.get(username=request.POST.get('target', -1))\\n target_account = Account.objects.get(user=target)\\n\\n account.following.remove(target_account)\\n account.save()\\n target_account.followers.remove(account)\\n target_account.save()\\n return JsonResponse({\\\"result\\\": \\\"Success\\\"})\\n except Account.DoesNotExist as e:\\n return HttpResponseBadRequest(reason=str(e))\\n except Exception as e:\\n return HttpResponseServerError(reason=str(e))\\n\\n\\n@login_required\\ndef editUserCategories(request):\\n '''\\n USAGE:\\n Edits list of categories for the user\\n\\n '''\\n try:\\n account = Account.objects.get(user=request.user)\\n categories = [int(i) for i in request.POST.getlist('categories[]')]\\n account.categories.clear()\\n for category in categories:\\n account.categories.add(Category.objects.get(id=category))\\n account.save()\\n\\n data = {\\n 'user_categories': list(account.categories.values_list('id', flat=True)) or \\\"all_categories\\\"\\n }\\n return JsonResponse({\\\"result\\\": data})\\n except Account.DoesNotExist as e:\\n return HttpResponseBadRequest(reason=str(e))\\n except Exception as e:\\n return HttpResponseServerError(reason=str(e))\\n\\n\\n@login_required\\n@user_passes_test(lambda u: u.is_staff)\\ndef invite(request):\\n emails = request.POST.getlist('emailList[]', '')\\n custom_message = request.POST.get('custom_message', '')\\n\\n if emails:\\n user = User.objects.get(username=request.user.username)\\n user_account = Account.objects.get(user=user)\\n did_not_invite = []\\n\\n # TODO: Move this to string templates\\n if custom_message:\\n email_body = (\\\"{host_name} has invited you to be part of CiviWiki Beta \\\"\\n \\\"with the following message: {custom_message}\\\").format(\\n host_name=user_account.full_name,\\n custom_message=custom_message\\n )\\n else:\\n email_body = (\\\"{host_name} has invited you to be part of CiviWiki Beta. \\\"\\n \\\"Follow the link below to get registered.\\\").format(\\n host_name=user_account.full_name\\n )\\n\\n email_messages = []\\n valid_emails = []\\n for email in emails:\\n if Invitation.objects.filter(invitee_email=email).exists():\\n did_not_invite.append(email)\\n else:\\n valid_emails.append(email)\\n verification_hash = uuid.uuid4().hex[:31]\\n data = {\\n 'host_user': user,\\n 'invitee_email': email,\\n 'verification_code': verification_hash,\\n }\\n\\n domain = get_current_site(request).domain\\n base_url = \\\"http://{domain}/beta_register/{email}/{token}\\\"\\n url_with_code = base_url.format(\\n domain=domain,\\n email=email,\\n token=verification_hash\\n )\\n\\n email_context = {\\n 'title': \\\"You're Invited to Join CiviWiki Beta\\\",\\n 'greeting': \\\"You're Invited to Join CiviWiki Beta\\\",\\n 'body': email_body,\\n 'link': url_with_code,\\n 'recipient': [email]\\n }\\n email_messages.append(email_context)\\n\\n new_invitation = Invitation(**data)\\n new_invitation.save()\\n\\n if email_messages:\\n email_subject = \\\"Invitation to CiviWiki\\\"\\n send_mass_email.delay(\\n subject=email_subject,\\n contexts=email_messages\\n )\\n\\n if len(did_not_invite) == len(emails):\\n response_data = {\\n \\\"message\\\": \\\"Invitations exist for submitted email(s). No new invitations sent\\\",\\n \\\"error\\\": \\\"INVALID_EMAIL_DATA\\\"\\n }\\n return JsonResponse(response_data, status=400)\\n\\n invitations = Invitation.objects.filter_by_host(host_user=user).order_by(\\\"-date_created\\\").all()\\n invitees = [invitation.summarize() for invitation in invitations]\\n\\n response_data = {\\n 'did_not_invite': did_not_invite,\\n 'invitees': invitees\\n }\\n return JsonResponse(response_data)\\n\\n else:\\n # Return an 'invalid login' error message.\\n response = {\\n \\\"message\\\": 'Invalid Email Data',\\n \\\"error\\\": \\\"INVALID_EMAIL_DATA\\\"\\n }\\n return JsonResponse(response, status=400)\\n\",\n \"path\": \"project/api/write.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"import json\nimport PIL\nimport urllib\nimport uuid\n\nfrom notifications.signals import notify\n\n# django packages\nfrom django.db.models.query import F\nfrom django.contrib.auth.models import User\nfrom django.http import (\n JsonResponse,\n HttpResponse,\n HttpResponseServerError,\n HttpResponseForbidden,\n HttpResponseBadRequest\n)\n\nfrom django.core.files import File # need this for image file handling\nfrom django.contrib.auth.decorators import login_required\nfrom django.contrib.auth.decorators import user_passes_test\nfrom django.contrib.sites.shortcuts import get_current_site\n\n# civi packages\nfrom api.forms import UpdateProfileImage\nfrom api.models import Thread\nfrom api.tasks import send_mass_email\nfrom models import Account, Activity, Category, Civi, CiviImage, Invitation, Bill\nfrom core.custom_decorators import require_post_params\nfrom core.constants import US_STATES\n\n\n@login_required\n@require_post_params(params=['title', 'summary', 'category_id'])\ndef new_thread(request):\n new_thread_data = dict(\n title=request.POST['title'],\n summary=request.POST['summary'],\n category_id=request.POST['category_id'],\n author_id=request.user.id,\n level=request.POST['level']\n )\n state = request.POST['state']\n if state:\n new_thread_data['state'] = state\n\n new_t = Thread(**new_thread_data)\n new_t.save()\n\n return JsonResponse({'data': 'success', 'thread_id': new_t.pk})\n\n\n@login_required\n@require_post_params(params=['title', 'body', 'c_type', 'thread_id'])\ndef createCivi(request):\n '''\n USAGE:\n use this function to insert a new connected civi into the database.\n\n :return: (200, ok) (400, missing required parameter) (500, internal error)\n '''\n\n a = Account.objects.get(user=request.user)\n thread_id = request.POST.get('thread_id')\n data = {\n 'author': Account.objects.get(user=request.user),\n 'title': request.POST.get('title', ''),\n 'body': request.POST.get('body', ''),\n 'c_type': request.POST.get('c_type', ''),\n 'thread': Thread.objects.get(id=thread_id)\n }\n\n try:\n civi = Civi(**data)\n civi.save()\n links = request.POST.getlist('links[]', '')\n bills = request.POST.getlist('bills[]', '')\n if links:\n for civi_id in links:\n linked_civi = Civi.objects.get(id=civi_id)\n civi.linked_civis.add(linked_civi)\n\n if bills:\n for bill_id in bills:\n linked_bill = Bill.objects.get(id=bill_id)\n civi.linked_bills.add(linked_bill)\n\n # If response\n related_civi = request.POST.get('related_civi', '')\n if related_civi:\n parent_civi = Civi.objects.get(id=related_civi)\n parent_civi.responses.add(civi)\n\n if parent_civi.author.user.username != request.user.username:\n notify.send(\n request.user, # Actor User\n recipient=parent_civi.author.user, # Target User\n verb=u'responded to your civi', # Verb\n action_object=civi, # Action Object\n target=civi.thread, # Target Object\n popup_string=\"{user} responded to your civi in {thread}\".format(\n user=a.full_name,\n thread=civi.thread.title\n ),\n link=\"/{}/{}\".format(\"thread\", thread_id)\n )\n\n else: # not a reply, a regular civi\n c_qs = Civi.objects.filter(thread_id=thread_id)\n accounts = Account.objects.filter(pk__in=c_qs.distinct('author').values_list('author', flat=True))\n data = {\n \"command\": \"add\",\n \"data\": json.dumps(civi.dict_with_score(a.id)),\n }\n\n for act in accounts:\n if act.user.username != request.user.username:\n notify.send(\n request.user, # Actor User\n recipient=act.user, # Target User\n verb=u'created a new civi', # Verb\n action_object=civi, # Action Object\n target=civi.thread, # Target Object\n popup_string=\"{user} created a new civi in the thread {thread}\".format(\n user=a.full_name,\n thread=civi.thread.title\n ),\n link=\"/{}/{}\".format(\"thread\", thread_id)\n )\n\n return JsonResponse({'data': civi.dict_with_score(a.id)})\n except Exception as e:\n return HttpResponseServerError(reason=str(e))\n\n\n@login_required\n@require_post_params(params=['civi_id', 'rating'])\ndef rateCivi(request):\n civi_id = request.POST.get('civi_id', '')\n rating = request.POST.get('rating', '')\n account = Account.objects.get(user=request.user)\n\n voted_civi = Civi.objects.get(id=civi_id)\n\n if voted_civi.thread.is_draft:\n return HttpResponseServerError(reason=str(\"Cannot vote on a civi that is in a thread still in draft mode\"))\n\n try:\n prev_act = Activity.objects.get(civi=voted_civi, account=account)\n except Activity.DoesNotExist:\n prev_act = None\n\n activity_data = {\n 'account': account,\n 'thread': voted_civi.thread,\n 'civi': voted_civi,\n }\n\n activity_vote_key = 'votes_{}'.format(rating)\n vote_val = 'vote_{}'.format(rating)\n # F object doesn't cause losing data in case of race\n setattr(voted_civi, activity_vote_key, F(activity_vote_key) + 1)\n voted_civi.save()\n\n if prev_act:\n prev_act.activity_type = vote_val\n prev_act.save()\n act = prev_act\n else:\n act = Activity(**activity_data)\n act.save()\n\n data = {\n 'civi_id': act.civi.id,\n 'activity_type': act.activity_type,\n 'c_type': act.civi.c_type\n }\n return JsonResponse({'data': data})\n\n\n@login_required\ndef editCivi(request):\n civi_id = request.POST.get('civi_id', '')\n title = request.POST.get('title', '')\n body = request.POST.get('body', '')\n civi_type = request.POST.get('type', '')\n\n c = Civi.objects.get(id=civi_id)\n if (request.user.username != c.author.user.username):\n return HttpResponseBadRequest(reason=\"No Edit Rights\")\n\n try:\n c.title = title\n c.body = body\n c.c_type = civi_type\n c.save(update_fields=['title', 'body'])\n\n links = request.POST.getlist('links[]', '')\n c.linked_civis.clear()\n if links:\n for civiimage_id in links:\n linked_civi = Civi.objects.get(id=civiimage_id)\n c.linked_civis.add(linked_civi)\n\n image_remove_list = request.POST.getlist('image_remove_list[]', '')\n if image_remove_list:\n for image_id in image_remove_list:\n civi_image = CiviImage.objects.get(id=image_id)\n civi_image.delete()\n\n a = Account.objects.get(user=request.user)\n return JsonResponse(c.dict_with_score(a.id))\n except Exception as e:\n return HttpResponseServerError(reason=str(e))\n\n\n@login_required\ndef deleteCivi(request):\n civi_id = request.POST.get('civi_id', '')\n\n c = Civi.objects.get(id=civi_id)\n if (request.user.username != c.author.user.username):\n return HttpResponseBadRequest(reason=\"No Edit Rights\")\n\n try:\n c.delete()\n\n return HttpResponse('Success')\n except Exception as e:\n return HttpResponseServerError(reason=str(e))\n\n\n# TODO 1: profile image file upload\n# TODO 2: redo user editing\n# TODO 3: django forms\n# @login_required\n# def get_dist(request):\n# '''\n# Upon First registering or changing location information gets representative codes and addes them to the user array\n# '''\n# request = urllib2.Request(\"https://congress.api.sunlightfoundation.com/\")\n#\n# #S3tting the key as the value of an X-APIKEY HTTP request header.\n# data = {\n# \"apikey\": APIKEY,\n# \"fields\": [],\n#\n# }\n# request.add_data(json.dumps(data))\n#\n# response = urllib2.urlopen(request)\n# resp_parsed = json.loads(response.read())\n# reps = [for rep in resp_parsed.data]\n# Account.user(request.user).representatives = reps\n#\n\n@login_required\ndef editThread(request):\n thread_id = request.POST.get(\"thread_id\")\n non_required_params = [\"title\", \"summary\", \"category_id\", \"level\", \"state\"]\n is_draft = request.POST.get(\"is_draft\", True)\n\n if not thread_id:\n return HttpResponseBadRequest(reason=\"Invalid Thread Reference\")\n\n # for some reason this is not cast to boolean in the request\n if is_draft == \"false\":\n Thread.objects.filter(id=thread_id).update(is_draft=False)\n\n return JsonResponse({'data': \"Success\"})\n\n try:\n req_edit_thread = Thread.objects.get(id=thread_id)\n\n if request.user.username != req_edit_thread.author.user.username:\n return HttpResponseBadRequest(\"No Edit Rights\")\n\n # set remaining parameters from request\n for param in non_required_params:\n request_value = request.POST.get(param)\n\n if request_value:\n setattr(req_edit_thread, param, request_value)\n\n req_edit_thread.save()\n except Exception as e:\n return HttpResponseServerError(reason=str(e))\n\n location = req_edit_thread.level if not req_edit_thread.state else dict(US_STATES).get(req_edit_thread.state)\n\n return_data = {\n \"thread_id\": thread_id,\n \"title\": req_edit_thread.title,\n \"summary\": req_edit_thread.summary,\n \"category\": {\n \"id\": req_edit_thread.category.id,\n \"name\": req_edit_thread.category.name\n },\n \"level\": req_edit_thread.level,\n \"state\": req_edit_thread.state if req_edit_thread.level == \"state\" else \"\",\n \"location\": location,\n }\n return JsonResponse({\"data\": return_data})\n\n\n\n@login_required\ndef uploadphoto(request):\n pass\n\n\n@login_required\ndef editUser(request):\n '''\n Edit Account Model\n '''\n request_data = request.POST\n user = request.user\n account = Account.objects.get(user=user)\n interests = request_data.get('interests', False)\n\n if interests:\n interests = list(interests)\n else:\n interests = account.interests\n\n data = {\n \"first_name\": request_data.get('first_name', account.first_name),\n \"last_name\": request_data.get('last_name', account.last_name),\n \"about_me\": request_data.get('about_me', account.about_me),\n \"address\": request_data.get('address', account.address),\n \"city\": request_data.get('city', account.city),\n \"state\": request_data.get('state', account.state),\n \"zip_code\": request_data.get('zip_code', account.zip_code),\n \"longitude\": request_data.get('longitude', account.longitude),\n \"latitude\": request_data.get('latitude', account.latitude),\n \"country\": request_data.get('country', account.country),\n }\n\n account.__dict__.update(data)\n\n try:\n account.save()\n except Exception as e:\n return HttpResponseServerError(reason=str(e))\n\n account.refresh_from_db()\n\n return JsonResponse(Account.objects.summarize(account))\n\n\n@login_required\ndef uploadProfileImage(request):\n if request.method == 'POST':\n form = UpdateProfileImage(request.POST, request.FILES)\n if form.is_valid():\n try:\n account = Account.objects.get(user=request.user)\n\n # Clean up previous image\n account.profile_image.delete()\n\n # Upload new image and set as profile picture\n account.profile_image = form.clean_profile_image()\n try:\n account.save()\n except Exception as e:\n response = {\n 'message': str(e),\n 'error': 'MODEL_SAVE_ERROR'\n }\n return JsonResponse(response, status=400)\n\n request.session[\"login_user_image\"] = account.profile_image_thumb_url\n\n response = {\n 'profile_image': account.profile_image_url\n }\n return JsonResponse(response, status=200)\n except Exception as e:\n response = {\n 'message': str(e),\n 'error': 'MODEL_ERROR'\n }\n return JsonResponse(response, status=400)\n else:\n response = {\n 'message': form.errors['profile_image'],\n 'error': 'FORM_ERROR'\n }\n return JsonResponse(response, status=400)\n\n else:\n return HttpResponseForbidden('allowed only via POST')\n\n\n@login_required\ndef clearProfileImage(request):\n if request.method == 'POST':\n try:\n account = Account.objects.get(user=request.user)\n\n # Clean up previous image\n account.profile_image.delete()\n account.save()\n\n return HttpResponse('Image Deleted')\n except Exception:\n return HttpResponseServerError(reason=str(\"default\"))\n else:\n return HttpResponseForbidden('allowed only via POST')\n\n\n@login_required\ndef uploadCiviImage(request):\n if request.method == 'POST':\n r = request.POST\n civi_id = r.get('civi_id')\n if not civi_id:\n return HttpResponseBadRequest(reason=\"Invalid Civi Reference\")\n\n try:\n c = Civi.objects.get(id=civi_id)\n\n attachment_links = request.POST.getlist('attachment_links[]')\n\n if attachment_links:\n for img_link in attachment_links:\n result = urllib.urlretrieve(img_link)\n img_file = File(open(result[0]))\n if check_image_with_pil(img_file):\n civi_image = CiviImage(title=\"\", civi=c, image=img_file)\n civi_image.save()\n\n if len(request.FILES) != 0:\n for image in request.FILES.getlist('attachment_image'):\n civi_image = CiviImage(title=\"\", civi=c, image=image)\n civi_image.save()\n\n data = {\n \"attachments\": [{'id': img.id, 'image_url': img.image_url} for img in c.images.all()],\n }\n return JsonResponse(data)\n\n except Exception as e:\n return HttpResponseServerError(reason=(str(e) + civi_id + str(request.FILES)))\n else:\n return HttpResponseForbidden('allowed only via POST')\n\n\ndef check_image_with_pil(image_file):\n try:\n PIL.Image.open(image_file)\n except IOError:\n return False\n return True\n\n\n@login_required\ndef uploadThreadImage(request):\n if request.method == 'POST':\n r = request.POST\n thread_id = r.get('thread_id')\n if not thread_id:\n return HttpResponseBadRequest(reason=\"Invalid Thread Reference\")\n\n try:\n thread = Thread.objects.get(id=thread_id)\n remove = r.get('remove', '')\n img_link = r.get('link', '')\n if remove:\n thread.image.delete()\n thread.save()\n\n elif img_link:\n thread.image.delete()\n result = urllib.urlretrieve(img_link)\n img_file = File(open(result[0]))\n if check_image_with_pil(img_file):\n thread.image = img_file\n thread.save()\n # else:\n # return HttpResponseBadRequest(\"Invalid Image\")\n else:\n # Clean up previous image\n thread.image.delete()\n\n # Upload new image and set as profile picture\n thread.image = request.FILES['attachment_image']\n thread.save()\n\n data = {\n 'image': thread.image_url\n }\n return JsonResponse(data)\n\n except Exception as e:\n return HttpResponseServerError(reason=(str(e)))\n else:\n return HttpResponseForbidden('allowed only via POST')\n\n\n@login_required\n@require_post_params(params=['target'])\ndef requestFollow(request):\n '''\n USAGE:\n Takes in user_id from current friend_requests list and joins accounts as friends.\n Does not join accounts as friends unless the POST friend is a valid member of the friend request array.\n\n Text POST:\n friend\n\n :return: (200, okay, list of friend information) (400, bad lookup) (500, error)\n '''\n if (request.user.username == request.POST.get('target', -1)):\n return HttpResponseBadRequest(reason=\"You cannot follow yourself, silly!\")\n\n try:\n account = Account.objects.get(user=request.user)\n target = User.objects.get(username=request.POST.get('target', -1))\n target_account = Account.objects.get(user=target)\n\n account.following.add(target_account)\n account.save()\n target_account.followers.add(account)\n target_account.save()\n data = {\n 'username': target.username,\n 'follow_status': True\n }\n\n notify.send(\n request.user, # Actor User\n recipient=target, # Target User\n verb=u'is following you', # Verb\n target=target_account, # Target Object\n popup_string=\"{user} is now following you\".format(user=account.full_name),\n link=\"/{}/{}\".format(\"profile\", request.user.username)\n )\n\n return JsonResponse({\"result\": data})\n except Account.DoesNotExist as e:\n return HttpResponseBadRequest(reason=str(e))\n except Exception as e:\n return HttpResponseServerError(reason=str(e))\n\n\n@login_required\n@require_post_params(params=['target'])\ndef requestUnfollow(request):\n '''\n USAGE:\n Takes in user_id from current friend_requests list and joins accounts as friends.\n Does not join accounts as friends unless the POST friend is a valid member of the friend request array.\n\n Text POST:\n friend\n\n :return: (200, okay, list of friend information) (400, bad lookup) (500, error)\n '''\n try:\n account = Account.objects.get(user=request.user)\n target = User.objects.get(username=request.POST.get('target', -1))\n target_account = Account.objects.get(user=target)\n\n account.following.remove(target_account)\n account.save()\n target_account.followers.remove(account)\n target_account.save()\n return JsonResponse({\"result\": \"Success\"})\n except Account.DoesNotExist as e:\n return HttpResponseBadRequest(reason=str(e))\n except Exception as e:\n return HttpResponseServerError(reason=str(e))\n\n\n@login_required\ndef editUserCategories(request):\n '''\n USAGE:\n Edits list of categories for the user\n\n '''\n try:\n account = Account.objects.get(user=request.user)\n categories = [int(i) for i in request.POST.getlist('categories[]')]\n account.categories.clear()\n for category in categories:\n account.categories.add(Category.objects.get(id=category))\n account.save()\n\n data = {\n 'user_categories': list(account.categories.values_list('id', flat=True)) or \"all_categories\"\n }\n return JsonResponse({\"result\": data})\n except Account.DoesNotExist as e:\n return HttpResponseBadRequest(reason=str(e))\n except Exception as e:\n return HttpResponseServerError(reason=str(e))\n\n\n@login_required\n@user_passes_test(lambda u: u.is_staff)\ndef invite(request):\n emails = request.POST.getlist('emailList[]', '')\n custom_message = request.POST.get('custom_message', '')\n\n if emails:\n user = User.objects.get(username=request.user.username)\n user_account = Account.objects.get(user=user)\n did_not_invite = []\n\n # TODO: Move this to string templates\n if custom_message:\n email_body = (\"{host_name} has invited you to be part of CiviWiki Beta \"\n \"with the following message: {custom_message}\").format(\n host_name=user_account.full_name,\n custom_message=custom_message\n )\n else:\n email_body = (\"{host_name} has invited you to be part of CiviWiki Beta. \"\n \"Follow the link below to get registered.\").format(\n host_name=user_account.full_name\n )\n\n email_messages = []\n valid_emails = []\n for email in emails:\n if Invitation.objects.filter(invitee_email=email).exists():\n did_not_invite.append(email)\n else:\n valid_emails.append(email)\n verification_hash = uuid.uuid4().hex[:31]\n data = {\n 'host_user': user,\n 'invitee_email': email,\n 'verification_code': verification_hash,\n }\n\n domain = get_current_site(request).domain\n base_url = \"http://{domain}/beta_register/{email}/{token}\"\n url_with_code = base_url.format(\n domain=domain,\n email=email,\n token=verification_hash\n )\n\n email_context = {\n 'title': \"You're Invited to Join CiviWiki Beta\",\n 'greeting': \"You're Invited to Join CiviWiki Beta\",\n 'body': email_body,\n 'link': url_with_code,\n 'recipient': [email]\n }\n email_messages.append(email_context)\n\n new_invitation = Invitation(**data)\n new_invitation.save()\n\n if email_messages:\n email_subject = \"Invitation to CiviWiki\"\n send_mass_email.delay(\n subject=email_subject,\n contexts=email_messages\n )\n\n if len(did_not_invite) == len(emails):\n response_data = {\n \"message\": \"Invitations exist for submitted email(s). No new invitations sent\",\n \"error\": \"INVALID_EMAIL_DATA\"\n }\n return JsonResponse(response_data, status=400)\n\n invitations = Invitation.objects.filter_by_host(host_user=user).order_by(\"-date_created\").all()\n invitees = [invitation.summarize() for invitation in invitations]\n\n response_data = {\n 'did_not_invite': did_not_invite,\n 'invitees': invitees\n }\n return JsonResponse(response_data)\n\n else:\n # Return an 'invalid login' error message.\n response = {\n \"message\": 'Invalid Email Data',\n \"error\": \"INVALID_EMAIL_DATA\"\n }\n return JsonResponse(response, status=400)\n","path":"project/api/write.py"}],"string":"[\n {\n \"content\": \"import json\\nimport PIL\\nimport urllib\\nimport uuid\\n\\nfrom notifications.signals import notify\\n\\n# django packages\\nfrom django.db.models.query import F\\nfrom django.contrib.auth.models import User\\nfrom django.http import (\\n JsonResponse,\\n HttpResponse,\\n HttpResponseServerError,\\n HttpResponseForbidden,\\n HttpResponseBadRequest\\n)\\n\\nfrom django.core.files import File # need this for image file handling\\nfrom django.contrib.auth.decorators import login_required\\nfrom django.contrib.auth.decorators import user_passes_test\\nfrom django.contrib.sites.shortcuts import get_current_site\\n\\n# civi packages\\nfrom api.forms import UpdateProfileImage\\nfrom api.models import Thread\\nfrom api.tasks import send_mass_email\\nfrom models import Account, Activity, Category, Civi, CiviImage, Invitation, Bill\\nfrom core.custom_decorators import require_post_params\\nfrom core.constants import US_STATES\\n\\n\\n@login_required\\n@require_post_params(params=['title', 'summary', 'category_id'])\\ndef new_thread(request):\\n new_thread_data = dict(\\n title=request.POST['title'],\\n summary=request.POST['summary'],\\n category_id=request.POST['category_id'],\\n author_id=request.user.id,\\n level=request.POST['level']\\n )\\n state = request.POST['state']\\n if state:\\n new_thread_data['state'] = state\\n\\n new_t = Thread(**new_thread_data)\\n new_t.save()\\n\\n return JsonResponse({'data': 'success', 'thread_id': new_t.pk})\\n\\n\\n@login_required\\n@require_post_params(params=['title', 'body', 'c_type', 'thread_id'])\\ndef createCivi(request):\\n '''\\n USAGE:\\n use this function to insert a new connected civi into the database.\\n\\n :return: (200, ok) (400, missing required parameter) (500, internal error)\\n '''\\n\\n a = Account.objects.get(user=request.user)\\n thread_id = request.POST.get('thread_id')\\n data = {\\n 'author': Account.objects.get(user=request.user),\\n 'title': request.POST.get('title', ''),\\n 'body': request.POST.get('body', ''),\\n 'c_type': request.POST.get('c_type', ''),\\n 'thread': Thread.objects.get(id=thread_id)\\n }\\n\\n try:\\n civi = Civi(**data)\\n civi.save()\\n links = request.POST.getlist('links[]', '')\\n bills = request.POST.getlist('bills[]', '')\\n if links:\\n for civi_id in links:\\n linked_civi = Civi.objects.get(id=civi_id)\\n civi.linked_civis.add(linked_civi)\\n\\n if bills:\\n for bill_id in bills:\\n linked_bill = Bill.objects.get(id=bill_id)\\n civi.linked_bills.add(linked_bill)\\n\\n # If response\\n related_civi = request.POST.get('related_civi', '')\\n if related_civi:\\n parent_civi = Civi.objects.get(id=related_civi)\\n parent_civi.responses.add(civi)\\n\\n if parent_civi.author.user.username != request.user.username:\\n notify.send(\\n request.user, # Actor User\\n recipient=parent_civi.author.user, # Target User\\n verb=u'responded to your civi', # Verb\\n action_object=civi, # Action Object\\n target=civi.thread, # Target Object\\n popup_string=\\\"{user} responded to your civi in {thread}\\\".format(\\n user=a.full_name,\\n thread=civi.thread.title\\n ),\\n link=\\\"/{}/{}\\\".format(\\\"thread\\\", thread_id)\\n )\\n\\n else: # not a reply, a regular civi\\n c_qs = Civi.objects.filter(thread_id=thread_id)\\n accounts = Account.objects.filter(pk__in=c_qs.distinct('author').values_list('author', flat=True))\\n data = {\\n \\\"command\\\": \\\"add\\\",\\n \\\"data\\\": json.dumps(civi.dict_with_score(a.id)),\\n }\\n\\n for act in accounts:\\n if act.user.username != request.user.username:\\n notify.send(\\n request.user, # Actor User\\n recipient=act.user, # Target User\\n verb=u'created a new civi', # Verb\\n action_object=civi, # Action Object\\n target=civi.thread, # Target Object\\n popup_string=\\\"{user} created a new civi in the thread {thread}\\\".format(\\n user=a.full_name,\\n thread=civi.thread.title\\n ),\\n link=\\\"/{}/{}\\\".format(\\\"thread\\\", thread_id)\\n )\\n\\n return JsonResponse({'data': civi.dict_with_score(a.id)})\\n except Exception as e:\\n return HttpResponseServerError(reason=str(e))\\n\\n\\n@login_required\\n@require_post_params(params=['civi_id', 'rating'])\\ndef rateCivi(request):\\n civi_id = request.POST.get('civi_id', '')\\n rating = request.POST.get('rating', '')\\n account = Account.objects.get(user=request.user)\\n\\n voted_civi = Civi.objects.get(id=civi_id)\\n\\n if voted_civi.thread.is_draft:\\n return HttpResponseServerError(reason=str(\\\"Cannot vote on a civi that is in a thread still in draft mode\\\"))\\n\\n try:\\n prev_act = Activity.objects.get(civi=voted_civi, account=account)\\n except Activity.DoesNotExist:\\n prev_act = None\\n\\n activity_data = {\\n 'account': account,\\n 'thread': voted_civi.thread,\\n 'civi': voted_civi,\\n }\\n\\n activity_vote_key = 'votes_{}'.format(rating)\\n vote_val = 'vote_{}'.format(rating)\\n # F object doesn't cause losing data in case of race\\n setattr(voted_civi, activity_vote_key, F(activity_vote_key) + 1)\\n voted_civi.save()\\n\\n if prev_act:\\n prev_act.activity_type = vote_val\\n prev_act.save()\\n act = prev_act\\n else:\\n act = Activity(**activity_data)\\n act.save()\\n\\n data = {\\n 'civi_id': act.civi.id,\\n 'activity_type': act.activity_type,\\n 'c_type': act.civi.c_type\\n }\\n return JsonResponse({'data': data})\\n\\n\\n@login_required\\ndef editCivi(request):\\n civi_id = request.POST.get('civi_id', '')\\n title = request.POST.get('title', '')\\n body = request.POST.get('body', '')\\n civi_type = request.POST.get('type', '')\\n\\n c = Civi.objects.get(id=civi_id)\\n if (request.user.username != c.author.user.username):\\n return HttpResponseBadRequest(reason=\\\"No Edit Rights\\\")\\n\\n try:\\n c.title = title\\n c.body = body\\n c.c_type = civi_type\\n c.save(update_fields=['title', 'body'])\\n\\n links = request.POST.getlist('links[]', '')\\n c.linked_civis.clear()\\n if links:\\n for civiimage_id in links:\\n linked_civi = Civi.objects.get(id=civiimage_id)\\n c.linked_civis.add(linked_civi)\\n\\n image_remove_list = request.POST.getlist('image_remove_list[]', '')\\n if image_remove_list:\\n for image_id in image_remove_list:\\n civi_image = CiviImage.objects.get(id=image_id)\\n civi_image.delete()\\n\\n a = Account.objects.get(user=request.user)\\n return JsonResponse(c.dict_with_score(a.id))\\n except Exception as e:\\n return HttpResponseServerError(reason=str(e))\\n\\n\\n@login_required\\ndef deleteCivi(request):\\n civi_id = request.POST.get('civi_id', '')\\n\\n c = Civi.objects.get(id=civi_id)\\n if (request.user.username != c.author.user.username):\\n return HttpResponseBadRequest(reason=\\\"No Edit Rights\\\")\\n\\n try:\\n c.delete()\\n\\n return HttpResponse('Success')\\n except Exception as e:\\n return HttpResponseServerError(reason=str(e))\\n\\n\\n# TODO 1: profile image file upload\\n# TODO 2: redo user editing\\n# TODO 3: django forms\\n# @login_required\\n# def get_dist(request):\\n# '''\\n# Upon First registering or changing location information gets representative codes and addes them to the user array\\n# '''\\n# request = urllib2.Request(\\\"https://congress.api.sunlightfoundation.com/\\\")\\n#\\n# #S3tting the key as the value of an X-APIKEY HTTP request header.\\n# data = {\\n# \\\"apikey\\\": APIKEY,\\n# \\\"fields\\\": [],\\n#\\n# }\\n# request.add_data(json.dumps(data))\\n#\\n# response = urllib2.urlopen(request)\\n# resp_parsed = json.loads(response.read())\\n# reps = [for rep in resp_parsed.data]\\n# Account.user(request.user).representatives = reps\\n#\\n\\n@login_required\\ndef editThread(request):\\n thread_id = request.POST.get(\\\"thread_id\\\")\\n non_required_params = [\\\"title\\\", \\\"summary\\\", \\\"category_id\\\", \\\"level\\\", \\\"state\\\"]\\n is_draft = request.POST.get(\\\"is_draft\\\", True)\\n\\n if not thread_id:\\n return HttpResponseBadRequest(reason=\\\"Invalid Thread Reference\\\")\\n\\n # for some reason this is not cast to boolean in the request\\n if is_draft == \\\"false\\\":\\n Thread.objects.filter(id=thread_id).update(is_draft=False)\\n\\n return JsonResponse({'data': \\\"Success\\\"})\\n\\n try:\\n req_edit_thread = Thread.objects.get(id=thread_id)\\n\\n if request.user.username != req_edit_thread.author.user.username:\\n return HttpResponseBadRequest(\\\"No Edit Rights\\\")\\n\\n # set remaining parameters from request\\n for param in non_required_params:\\n request_value = request.POST.get(param)\\n\\n if request_value:\\n setattr(req_edit_thread, param, request_value)\\n\\n req_edit_thread.save()\\n except Exception as e:\\n return HttpResponseServerError(reason=str(e))\\n\\n location = req_edit_thread.level if not req_edit_thread.state else dict(US_STATES).get(req_edit_thread.state)\\n\\n return_data = {\\n \\\"thread_id\\\": thread_id,\\n \\\"title\\\": req_edit_thread.title,\\n \\\"summary\\\": req_edit_thread.summary,\\n \\\"category\\\": {\\n \\\"id\\\": req_edit_thread.category.id,\\n \\\"name\\\": req_edit_thread.category.name\\n },\\n \\\"level\\\": req_edit_thread.level,\\n \\\"state\\\": req_edit_thread.state if req_edit_thread.level == \\\"state\\\" else \\\"\\\",\\n \\\"location\\\": location,\\n }\\n return JsonResponse({\\\"data\\\": return_data})\\n\\n\\n\\n@login_required\\ndef uploadphoto(request):\\n pass\\n\\n\\n@login_required\\ndef editUser(request):\\n '''\\n Edit Account Model\\n '''\\n request_data = request.POST\\n user = request.user\\n account = Account.objects.get(user=user)\\n interests = request_data.get('interests', False)\\n\\n if interests:\\n interests = list(interests)\\n else:\\n interests = account.interests\\n\\n data = {\\n \\\"first_name\\\": request_data.get('first_name', account.first_name),\\n \\\"last_name\\\": request_data.get('last_name', account.last_name),\\n \\\"about_me\\\": request_data.get('about_me', account.about_me),\\n \\\"address\\\": request_data.get('address', account.address),\\n \\\"city\\\": request_data.get('city', account.city),\\n \\\"state\\\": request_data.get('state', account.state),\\n \\\"zip_code\\\": request_data.get('zip_code', account.zip_code),\\n \\\"longitude\\\": request_data.get('longitude', account.longitude),\\n \\\"latitude\\\": request_data.get('latitude', account.latitude),\\n \\\"country\\\": request_data.get('country', account.country),\\n }\\n\\n account.__dict__.update(data)\\n\\n try:\\n account.save()\\n except Exception as e:\\n return HttpResponseServerError(reason=str(e))\\n\\n account.refresh_from_db()\\n\\n return JsonResponse(Account.objects.summarize(account))\\n\\n\\n@login_required\\ndef uploadProfileImage(request):\\n if request.method == 'POST':\\n form = UpdateProfileImage(request.POST, request.FILES)\\n if form.is_valid():\\n try:\\n account = Account.objects.get(user=request.user)\\n\\n # Clean up previous image\\n account.profile_image.delete()\\n\\n # Upload new image and set as profile picture\\n account.profile_image = form.clean_profile_image()\\n try:\\n account.save()\\n except Exception as e:\\n response = {\\n 'message': str(e),\\n 'error': 'MODEL_SAVE_ERROR'\\n }\\n return JsonResponse(response, status=400)\\n\\n request.session[\\\"login_user_image\\\"] = account.profile_image_thumb_url\\n\\n response = {\\n 'profile_image': account.profile_image_url\\n }\\n return JsonResponse(response, status=200)\\n except Exception as e:\\n response = {\\n 'message': str(e),\\n 'error': 'MODEL_ERROR'\\n }\\n return JsonResponse(response, status=400)\\n else:\\n response = {\\n 'message': form.errors['profile_image'],\\n 'error': 'FORM_ERROR'\\n }\\n return JsonResponse(response, status=400)\\n\\n else:\\n return HttpResponseForbidden('allowed only via POST')\\n\\n\\n@login_required\\ndef clearProfileImage(request):\\n if request.method == 'POST':\\n try:\\n account = Account.objects.get(user=request.user)\\n\\n # Clean up previous image\\n account.profile_image.delete()\\n account.save()\\n\\n return HttpResponse('Image Deleted')\\n except Exception:\\n return HttpResponseServerError(reason=str(\\\"default\\\"))\\n else:\\n return HttpResponseForbidden('allowed only via POST')\\n\\n\\n@login_required\\ndef uploadCiviImage(request):\\n if request.method == 'POST':\\n r = request.POST\\n civi_id = r.get('civi_id')\\n if not civi_id:\\n return HttpResponseBadRequest(reason=\\\"Invalid Civi Reference\\\")\\n\\n try:\\n c = Civi.objects.get(id=civi_id)\\n\\n attachment_links = request.POST.getlist('attachment_links[]')\\n\\n if attachment_links:\\n for img_link in attachment_links:\\n result = urllib.urlretrieve(img_link)\\n img_file = File(open(result[0]))\\n if check_image_with_pil(img_file):\\n civi_image = CiviImage(title=\\\"\\\", civi=c, image=img_file)\\n civi_image.save()\\n\\n if len(request.FILES) != 0:\\n for image in request.FILES.getlist('attachment_image'):\\n civi_image = CiviImage(title=\\\"\\\", civi=c, image=image)\\n civi_image.save()\\n\\n data = {\\n \\\"attachments\\\": [{'id': img.id, 'image_url': img.image_url} for img in c.images.all()],\\n }\\n return JsonResponse(data)\\n\\n except Exception as e:\\n return HttpResponseServerError(reason=(str(e) + civi_id + str(request.FILES)))\\n else:\\n return HttpResponseForbidden('allowed only via POST')\\n\\n\\ndef check_image_with_pil(image_file):\\n try:\\n PIL.Image.open(image_file)\\n except IOError:\\n return False\\n return True\\n\\n\\n@login_required\\ndef uploadThreadImage(request):\\n if request.method == 'POST':\\n r = request.POST\\n thread_id = r.get('thread_id')\\n if not thread_id:\\n return HttpResponseBadRequest(reason=\\\"Invalid Thread Reference\\\")\\n\\n try:\\n thread = Thread.objects.get(id=thread_id)\\n remove = r.get('remove', '')\\n img_link = r.get('link', '')\\n if remove:\\n thread.image.delete()\\n thread.save()\\n\\n elif img_link:\\n thread.image.delete()\\n result = urllib.urlretrieve(img_link)\\n img_file = File(open(result[0]))\\n if check_image_with_pil(img_file):\\n thread.image = img_file\\n thread.save()\\n # else:\\n # return HttpResponseBadRequest(\\\"Invalid Image\\\")\\n else:\\n # Clean up previous image\\n thread.image.delete()\\n\\n # Upload new image and set as profile picture\\n thread.image = request.FILES['attachment_image']\\n thread.save()\\n\\n data = {\\n 'image': thread.image_url\\n }\\n return JsonResponse(data)\\n\\n except Exception as e:\\n return HttpResponseServerError(reason=(str(e)))\\n else:\\n return HttpResponseForbidden('allowed only via POST')\\n\\n\\n@login_required\\n@require_post_params(params=['target'])\\ndef requestFollow(request):\\n '''\\n USAGE:\\n Takes in user_id from current friend_requests list and joins accounts as friends.\\n Does not join accounts as friends unless the POST friend is a valid member of the friend request array.\\n\\n Text POST:\\n friend\\n\\n :return: (200, okay, list of friend information) (400, bad lookup) (500, error)\\n '''\\n if (request.user.username == request.POST.get('target', -1)):\\n return HttpResponseBadRequest(reason=\\\"You cannot follow yourself, silly!\\\")\\n\\n try:\\n account = Account.objects.get(user=request.user)\\n target = User.objects.get(username=request.POST.get('target', -1))\\n target_account = Account.objects.get(user=target)\\n\\n account.following.add(target_account)\\n account.save()\\n target_account.followers.add(account)\\n target_account.save()\\n data = {\\n 'username': target.username,\\n 'follow_status': True\\n }\\n\\n notify.send(\\n request.user, # Actor User\\n recipient=target, # Target User\\n verb=u'is following you', # Verb\\n target=target_account, # Target Object\\n popup_string=\\\"{user} is now following you\\\".format(user=account.full_name),\\n link=\\\"/{}/{}\\\".format(\\\"profile\\\", request.user.username)\\n )\\n\\n return JsonResponse({\\\"result\\\": data})\\n except Account.DoesNotExist as e:\\n return HttpResponseBadRequest(reason=str(e))\\n except Exception as e:\\n return HttpResponseServerError(reason=str(e))\\n\\n\\n@login_required\\n@require_post_params(params=['target'])\\ndef requestUnfollow(request):\\n '''\\n USAGE:\\n Takes in user_id from current friend_requests list and joins accounts as friends.\\n Does not join accounts as friends unless the POST friend is a valid member of the friend request array.\\n\\n Text POST:\\n friend\\n\\n :return: (200, okay, list of friend information) (400, bad lookup) (500, error)\\n '''\\n try:\\n account = Account.objects.get(user=request.user)\\n target = User.objects.get(username=request.POST.get('target', -1))\\n target_account = Account.objects.get(user=target)\\n\\n account.following.remove(target_account)\\n account.save()\\n target_account.followers.remove(account)\\n target_account.save()\\n return JsonResponse({\\\"result\\\": \\\"Success\\\"})\\n except Account.DoesNotExist as e:\\n return HttpResponseBadRequest(reason=str(e))\\n except Exception as e:\\n return HttpResponseServerError(reason=str(e))\\n\\n\\n@login_required\\ndef editUserCategories(request):\\n '''\\n USAGE:\\n Edits list of categories for the user\\n\\n '''\\n try:\\n account = Account.objects.get(user=request.user)\\n categories = [int(i) for i in request.POST.getlist('categories[]')]\\n account.categories.clear()\\n for category in categories:\\n account.categories.add(Category.objects.get(id=category))\\n account.save()\\n\\n data = {\\n 'user_categories': list(account.categories.values_list('id', flat=True)) or \\\"all_categories\\\"\\n }\\n return JsonResponse({\\\"result\\\": data})\\n except Account.DoesNotExist as e:\\n return HttpResponseBadRequest(reason=str(e))\\n except Exception as e:\\n return HttpResponseServerError(reason=str(e))\\n\\n\\n@login_required\\n@user_passes_test(lambda u: u.is_staff)\\ndef invite(request):\\n emails = request.POST.getlist('emailList[]', '')\\n custom_message = request.POST.get('custom_message', '')\\n\\n if emails:\\n user = User.objects.get(username=request.user.username)\\n user_account = Account.objects.get(user=user)\\n did_not_invite = []\\n\\n # TODO: Move this to string templates\\n if custom_message:\\n email_body = (\\\"{host_name} has invited you to be part of CiviWiki Beta \\\"\\n \\\"with the following message: {custom_message}\\\").format(\\n host_name=user_account.full_name,\\n custom_message=custom_message\\n )\\n else:\\n email_body = (\\\"{host_name} has invited you to be part of CiviWiki Beta. \\\"\\n \\\"Follow the link below to get registered.\\\").format(\\n host_name=user_account.full_name\\n )\\n\\n email_messages = []\\n valid_emails = []\\n for email in emails:\\n if Invitation.objects.filter(invitee_email=email).exists():\\n did_not_invite.append(email)\\n else:\\n valid_emails.append(email)\\n verification_hash = uuid.uuid4().hex[:31]\\n data = {\\n 'host_user': user,\\n 'invitee_email': email,\\n 'verification_code': verification_hash,\\n }\\n\\n domain = get_current_site(request).domain\\n base_url = \\\"http://{domain}/beta_register/{email}/{token}\\\"\\n url_with_code = base_url.format(\\n domain=domain,\\n email=email,\\n token=verification_hash\\n )\\n\\n email_context = {\\n 'title': \\\"You're Invited to Join CiviWiki Beta\\\",\\n 'greeting': \\\"You're Invited to Join CiviWiki Beta\\\",\\n 'body': email_body,\\n 'link': url_with_code,\\n 'recipient': [email]\\n }\\n email_messages.append(email_context)\\n\\n new_invitation = Invitation(**data)\\n new_invitation.save()\\n\\n if email_messages:\\n email_subject = \\\"Invitation to CiviWiki\\\"\\n send_mass_email.delay(\\n subject=email_subject,\\n contexts=email_messages\\n )\\n\\n if len(did_not_invite) == len(emails):\\n response_data = {\\n \\\"message\\\": \\\"Invitations exist for submitted email(s). No new invitations sent\\\",\\n \\\"error\\\": \\\"INVALID_EMAIL_DATA\\\"\\n }\\n return JsonResponse(response_data, status=400)\\n\\n invitations = Invitation.objects.filter_by_host(host_user=user).order_by(\\\"-date_created\\\").all()\\n invitees = [invitation.summarize() for invitation in invitations]\\n\\n response_data = {\\n 'did_not_invite': did_not_invite,\\n 'invitees': invitees\\n }\\n return JsonResponse(response_data)\\n\\n else:\\n # Return an 'invalid login' error message.\\n response = {\\n \\\"message\\\": 'Invalid Email Data',\\n \\\"error\\\": \\\"INVALID_EMAIL_DATA\\\"\\n }\\n return JsonResponse(response, status=400)\\n\",\n \"path\": \"project/api/write.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/project/api/write.py b/project/api/write.py\nindex 2145dbb5a..795700ed9 100644\n--- a/project/api/write.py\n+++ b/project/api/write.py\n@@ -263,7 +263,8 @@ def editThread(request):\n if not thread_id:\n return HttpResponseBadRequest(reason=\"Invalid Thread Reference\")\n \n- if not is_draft:\n+ # for some reason this is not cast to boolean in the request\n+ if is_draft == \"false\":\n Thread.objects.filter(id=thread_id).update(is_draft=False)\n \n return JsonResponse({'data': \"Success\"})\ndiff --git a/project/webapp/static/js/feed.js b/project/webapp/static/js/feed.js\nindex 8b778a575..309fcefc3 100644\n--- a/project/webapp/static/js/feed.js\n+++ b/project/webapp/static/js/feed.js\n@@ -92,13 +92,36 @@ cw.FeedView = BB.View.extend({\n },\n \n renderFeedList: function() {\n+ var categories = this.options.categories;\n+\n+ // Annotate each thread with category name\n+ var annotatedThreads = this.threads.map(function(thread) {\n+ var thread_category_id = thread.thread.category_id;\n+\n+ var filtered_categories = categories.filter(function (category) {\n+ var thread_category_match = category.id === thread_category_id;\n+\n+ return thread_category_match;\n+ });\n+ \n+ if (filtered_categories.length === 1) {\n+ thread.thread.category_name = filtered_categories[0].name;\n+ } else {\n+ thread.thread.category_name = \"ambiguous category\";\n+ }\n+\n+ return thread;\n+ });\n+ \n var template_var = {\n- 'categories': this.options.categories,\n- 'threads': this.threads\n+ threads: this.threads\n };\n- this.$('#feed-list').empty().append(this.feedListTemplate(template_var));\n- this.$('.scroll-col').height($(window).height() - this.$('nav').height());\n- },\n+ \n+ this.$(\"#feed-list\")\n+ .empty()\n+ .append(this.feedListTemplate(template_var));\n+ this.$(\".scroll-col\").height($(window).height() - this.$(\"nav\").height());\n+ },\n \n setUserCategories: function (new_list) {\n this.options.user_categories = new_list;\ndiff --git a/project/webapp/static/js/thread.js b/project/webapp/static/js/thread.js\nindex 34b5ed6c1..4e3e9124f 100644\n--- a/project/webapp/static/js/thread.js\n+++ b/project/webapp/static/js/thread.js\n@@ -127,17 +127,6 @@ cw.CiviCollection = BB.Collection.extend({\n },\n });\n \n-// cw.CiviSubCollection = BB.Collection.extend({\n-// model: cw.CiviModel,\n-// comparator: function(model) {\n-// return -model.get('score');\n-// },\n-//\n-// initialize: function (options) {\n-// options = options || {};\n-// },\n-// });\n-\n cw.ResponseCollection = BB.Collection.extend({\n model: cw.CiviModel,\n \n@@ -163,7 +152,6 @@ cw.ThreadModel = BB.Model.extend({\n },\n \n parse: function(data){\n- console.log(data);\n return data;\n },\n \n@@ -192,7 +180,6 @@ cw.CiviView = BB.View.extend({\n \n events: {\n 'click .rating-button': 'clickRating',\n- // 'click .favorite': 'clickFavorite',\n 'click .edit': 'clickEdit',\n 'click .delete': 'deleteEdit',\n 'click .edit-confirm': 'saveEdit',\n@@ -205,10 +192,6 @@ cw.CiviView = BB.View.extend({\n 'input .civi-link-images': 'previewImageNames',\n 'click #add-image-link-input': 'addImageLinkInput',\n 'click #respond-button': 'addRebuttal',\n- // 'click .civi-grab-link': 'grabLink',\n- // vote\n- // changevote\n-\n },\n \n addImageLinkInput: function(){\n@@ -269,7 +252,6 @@ cw.CiviView = BB.View.extend({\n $modal.openModal();\n e.stopPropagation();\n },\n- // clean() function\n clickFavorite: function (e) {\n var _this = this;\n \n@@ -320,10 +302,6 @@ cw.CiviView = BB.View.extend({\n var rating = $this.data('rating');\n var civi_id = $(e.currentTarget).closest('.civi-card').data('civi-id');\n \n- // if (this.can_edit) {\n- // Materialize.toast('Trying to vote on your own civi? :}', 5000);\n- // return;\n- // }\n if (rating && civi_id){\n $.ajax({\n url: '/api/rate_civi/',\n@@ -334,10 +312,7 @@ cw.CiviView = BB.View.extend({\n },\n success: function (response) {\n Materialize.toast('Voted!', 5000);\n- // var score = $this.find('.rate-value');\n- // var new_vote = parseInt(score.text())+ 1;\n- // score.text(new_vote);\n- console.log(response.data);\n+\n var prev_votes = _this.parentView.model.get('user_votes');\n var prev_vote = _.findWhere(prev_votes, {civi_id: civi_id});\n if (!prev_vote) {\n@@ -449,7 +424,7 @@ cw.CiviView = BB.View.extend({\n }\n \n var new_type = this.$(\"#civi-type-form input[type='radio']:checked\").val();\n- console.log(new_type);\n+\n if (!new_body || !new_title){\n Materialize.toast('Please do not leave fields blank', 5000);\n return;\n@@ -754,7 +729,6 @@ cw.NewCiviView = BB.View.extend({\n \n cancelCivi: function () {\n this.$el.empty();\n- // $('.responses').height($('.responses-box').height());\n },\n \n createCivi: function (e) {\n@@ -862,16 +836,10 @@ cw.NewCiviView = BB.View.extend({\n }\n \n }, this);\n- // if(c_type ==='problem'){\n- // this.recommendedCivis.push(new_civi.id);\n- // this.otherCivis.push(new_civi.id);\n- // }\n+\n _this.options.parentView.initRecommended();\n _this.options.parentView.renderBodyContents(); //TODO: move renders into listeners\n- // _.each(new_civi.get('links'), function(link){\n- // console.log(link);\n- // _this.options.parentView.civis.findWhere({id: link}).view.render();\n- // });\n+\n _this.$el.empty();\n }\n \n@@ -935,11 +903,6 @@ cw.NewResponseView = BB.View.extend({\n 'input .civi-link-images': 'previewImageNames',\n 'click #add-image-link-input': 'addImageLinkInput',\n },\n- //\n- // show: function () {\n- // this.$('.new-response-modal').openModal();\n- // },\n- //\n hide: function () {\n $('#new-response-box').empty();\n $('#add-new-response').show();\n@@ -1148,16 +1111,18 @@ cw.EditThreadView = BB.View.extend({\n var _this = this;\n _this.$(e.currentTarget).addClass('disabled').attr('disabled', true);\n \n- var title = this.$el.find('#thread-title').val().trim(),\n- summary = this.$el.find('#thread-body').val().trim(),\n- level = this.$el.find('#thread-location').val(),\n- category_id = this.$el.find('#thread-category').val(),\n- state=\"\";\n+ var title = this.$el.find('#thread-title').val().trim();\n+ var summary = this.$el.find('#thread-body').val().trim();\n+ var level = this.$el.find('#thread-location').val();\n+ var category_id = this.$el.find('#thread-category').val();\n+ var state=\"\";\n+ \n if (level === \"state\" ) {\n state = this.$el.find('#thread-state').val();\n }\n+\n var thread_id = this.threadId;\n- console.log(title, summary, category_id, thread_id);\n+ \n if (title && summary && category_id) {\n $.ajax({\n url: '/api/edit_thread/',\n@@ -1353,7 +1318,7 @@ cw.LinkSelectView = BB.View.extend({\n };\n msdata.push(civi);\n });\n- console.log(msdata);\n+\n this.ms.setData(msdata);\n \n return this;\n@@ -1404,6 +1369,7 @@ cw.ThreadView = BB.View.extend({\n navTemplate: _.template($('#thread-nav-template').html()),\n responseWrapper: _.template($('#thread-response-template').html()),\n outlineTemplate: _.template($('#outline-template').html()),\n+ \n \n initialize: function (options) {\n options = options || {};\n@@ -1531,9 +1497,6 @@ cw.ThreadView = BB.View.extend({\n this.threadBodyRender();\n this.threadNavRender();\n \n- // this.$('.scroll-col').height($(window).sheight() - this.$('.body-banner').height());\n-\n-\n this.newCiviView = new cw.NewCiviView({\n model: this.model,\n parentView: this\n@@ -1590,7 +1553,16 @@ cw.ThreadView = BB.View.extend({\n renderOutline: function(){\n var _this = this;\n if (this.civis.length === 0){\n- this.$('#civi-outline').empty().append(this.outlineTemplate());\n+ // render with mock data to prevent errors\n+ var mockData = {\n+ is_draft: undefined,\n+ count: 0,\n+ problems: [],\n+ causes: [],\n+ solutions: []\n+ }\n+ \n+ this.$('#civi-outline').empty().append(this.outlineTemplate(mockData));\n }\n \n // Render Outline Template based on models\n@@ -1638,6 +1610,7 @@ cw.ThreadView = BB.View.extend({\n }\n \n var count;\n+\n if (this.is_draft) {\n count = {\n problem: highlightCount.problem,\n@@ -1657,6 +1630,7 @@ cw.ThreadView = BB.View.extend({\n count.totalOther = this.civiOtherViewTotals.problem + this.civiOtherViewTotals.cause + this.civiOtherViewTotals.solution - recCount.problem - otherCount.cause - otherCount.solution;\n \n renderData.count = count;\n+\n renderData.is_draft = this.is_draft;\n \n this.$('#civi-outline').empty().append(this.outlineTemplate(renderData));\n@@ -1686,8 +1660,14 @@ cw.ThreadView = BB.View.extend({\n \n // Calculate tracking\n this.calcCiviLocations();\n- // Padding so you can scroll and track the last civi element;\n- var scrollPadding = this.$('.main-thread').height() - this.civiLocations[this.civiLocations.length-1].height;\n+\n+ var scrollPadding = 100;\n+ \n+ if (this.civiLocations.length) {\n+ // Padding so you can scroll and track the last civi element;\n+ scrollPadding = this.$('.main-thread').height() - this.civiLocations[this.civiLocations.length-1].height;\n+ }\n+ \n this.$('.civi-padding').height(scrollPadding - 8);\n \n // Vote indication\n@@ -1758,15 +1738,10 @@ cw.ThreadView = BB.View.extend({\n this.outlineCivis[type] = civis;\n \n }, this);\n-\n-\n-\n- // _.each(this.civis.filterByType('cause'), this.civiRenderHelper, this);\n- // _.each(this.civis.filterByType('solution'), this.civiRenderHelper, this);\n },\n \n civiRenderHelper: function(civi){\n- var is_draft = this.is_draft;\n+ var is_draft = civi.is_draft;\n var can_edit = civi.get('author').username == this.username ? true : false;\n this.$('#thread-'+civi.get('type')+'s').append(new cw.CiviView({model: civi, can_edit: can_edit, is_draft: is_draft, parentView: this}).el);\n \n@@ -1778,13 +1753,6 @@ cw.ThreadView = BB.View.extend({\n _.each(savedVotes, function(v){\n this.$('#civi-'+ v.civi_id).find(\".\" +v.activity_type).addClass('current');\n });\n-\n- // // Indicate vote status on nav\n- // _.each(['problem', 'cause', 'solution'], function(type){\n- // if (this[type+'s'].length === 0) {\n- // this.$('.' + type + '-nav>.civi-nav-header').addClass('nav-inactive');\n- // }\n- // }, this);\n },\n \n renderResponses: function () {\n@@ -1908,14 +1876,11 @@ cw.ThreadView = BB.View.extend({\n var threadPos = this.$('.main-thread').position().top;\n var scrollPos = this.$('.main-thread').scrollTop();\n this.civiLocations = [];\n- // this.civiTops = [];\n- // this.civiTargets =\n+\n this.$('.civi-card').each(function (idx, civi) {\n var $civi = $(civi),\n $civiTop = $civi.position().top + scrollPos - threadPos;\n _this.civiLocations.push({top: $civiTop, bottom: $civiTop + $civi.height(), height: $civi.height(), target: $civi, id: $civi.attr('data-civi-id')});\n- // _this.civiTops.push($civiTop);\n- // _this.civiTargets.push({top: $civiTop, target: $civi, id: $civi.data('civi-id') });\n });\n },\n \n@@ -1927,29 +1892,6 @@ cw.ThreadView = BB.View.extend({\n return;\n }\n \n- // TODO: check if nav is folded, then just p-c-solution check\n- //\n- // if (firstTime) {\n- // var $newNavCivi = _this.$('[data-civi-nav-id=\"' + _this.civiLocations[0].id + '\"]');\n- // $newNavCivi.addClass('current');\n- //\n- // if (!_this.navExpanded) {\n- // $($newNavCivi.closest('.civi-nav-wrapper').siblings()[0]).addClass('current');\n- // }\n- //\n- // _this.currentNavCivi = _this.civiLocations[0].id;\n- // return;\n- // } else\n- // if (navChange) {\n- // var $currentNavCivi = _this.$('[data-civi-nav-id=\"' + _this.currentNavCivi + '\"]');\n- //\n- // if (this.navExpanded) {\n- // $($currentNavCivi.closest('.civi-nav-wrapper').siblings()[0]).removeClass('current');\n- // } else {\n- // $($currentNavCivi.closest('.civi-nav-wrapper').siblings()[0]).addClass('current');\n- // }\n- // return;\n- // }\n // 2. Go through list of heights to get current active civi\n var OFFSET = 100;\n var element = _.find(this.civiLocations, function (l) {\n@@ -1957,6 +1899,7 @@ cw.ThreadView = BB.View.extend({\n scrollPosition >= l.top - OFFSET &&\n scrollPosition < l.bottom - OFFSET;\n }, this);\n+\n // 3. Activate Corresponding Civi Card and Nav\n if (!element) return;\n else {\n@@ -1970,10 +1913,7 @@ cw.ThreadView = BB.View.extend({\n var _this = this;\n this.currentNavCivi = id || this.currentNavCivi;\n var $currentNavCivi = _this.$('[data-civi-nav-id=\"' + _this.currentNavCivi + '\"]');\n- // $newNavCivi = _this.$('[data-civi-nav-id=\"' + newCivi + '\"]');\n \n-\n- // $newNavCivi.addClass('current');\n if (!_this.navExpanded) {\n this.$('.civi-nav-header').removeClass('current');\n $($currentNavCivi.closest('.civi-nav-wrapper').siblings()[0]).addClass('current');\n@@ -1998,39 +1938,12 @@ cw.ThreadView = BB.View.extend({\n $newCivi.addClass('current');\n var civi_id = $newCivi.data('civi-id');\n \n- // var links = this.civis.get(civi_id).get('links');\n- // // var links_related = [];\n- // // _.each(links, function(link){\n- // // links_related = this.$('#civi-'+link).data('civi-links');\n- // // console.log(links_related);\n- // // if (!links_related) return;\n- // // if (links_related.length > 1){\n- // // links_related= links_related.split(\",\").map(Number);\n- // // } else {\n- // // links_related = parseInt(links_related);\n- // // }\n- // //\n- // // links = _.union(links, links_related);\n- // // },this);\n- // // console.log(links);\n- //\n- // _.each(this.$('.civi-card'), function(civiCard){\n- // // console.log(links, $(civiCard).data('civi-id'));\n- //\n- // if (links.indexOf($(civiCard).data('civi-id')) == -1 ){\n- // $(civiCard).removeClass('linked');\n- // } else {\n- // $(civiCard).addClass('linked');\n- // }\n- // });\n-\n this.currentCivi = $newCivi.attr('data-civi-id');\n if (!_.isUndefined(this.currentCivi)){\n this.responseCollection.civiId = this.currentCivi;\n this.responseCollection.fetch();\n }\n \n-\n } else {\n $currentCivi.removeClass('current');\n this.$('.civi-card').removeClass('linked');\ndiff --git a/project/webapp/templates/partials/feed/feed_list.html b/project/webapp/templates/partials/feed/feed_list.html\nindex 503a4648f..7a7de50ef 100644\n--- a/project/webapp/templates/partials/feed/feed_list.html\n+++ b/project/webapp/templates/partials/feed/feed_list.html\n@@ -2,7 +2,7 @@\n {{# if (threads.length > 0) { }}\n {{# _.each(threads, function (t) {}}\n <div class=\"col s12\">\n- {{= cw.underscorePartial('thread-card-template', ({thread_data: t, categories: categories}))}}\n+ {{= cw.underscorePartial('thread-card-template', ({thread_data: t}))}}\n </div>\n {{# }, this); }}\n {{# } else { }}\ndiff --git a/project/webapp/templates/partials/feed/thread_card.html b/project/webapp/templates/partials/feed/thread_card.html\nindex f3cdd8dfb..ad836780e 100644\n--- a/project/webapp/templates/partials/feed/thread_card.html\n+++ b/project/webapp/templates/partials/feed/thread_card.html\n@@ -8,7 +8,9 @@\n </div>\n </div>\n <div class=\"content col s9\">\n- <div class=\"thread-category\">({{ thread_data.thread.location }}) {{= categories[thread_data.thread.category_id].name }}</div>\n+ <div class=\"thread-category\">\n+ ({{ thread_data.thread.location }}) {{ thread_data.thread.category_name }}\n+ </div>\n <a href=\"thread/{{thread_data.thread.id}}\">\n \t\t <div class=\"thread-title\">{{ thread_data.thread.title }}</div>\n <div class=\"thread-summary\">{{ thread_data.thread.summary }}</div>\n"}}},{"rowIdx":5491,"cells":{"in_source_id":{"kind":"string","value":"pytorch__vision-2159"},"issue":{"kind":"string","value":"NMS returns different results on CPU & CUDA\n## 🐛 Bug\r\n\r\nHi, I noticed that results of `torchvision.ops.nms` in CPU and CUDA have different value\r\n\r\n## To Reproduce\r\n\r\nSteps to reproduce the behavior:\r\n\r\n1. `docker run --runtime=nvidia -it pytorch/pytorch:1.5-cuda10.1-cudnn7-devel bash`\r\n2. run this script :\r\n ```\r\nimport torch\r\nimport torchvision\r\nimport random\r\n\r\nrandom.seed(0)\r\ntorch.manual_seed(0)\r\ntorch.backends.cudnn.deterministic = True\r\n\r\nboxes_for_nms = torch.tensor([[0.3764, 0.0905, 0.6533, 0.4487],[0.3744, 0.0899, 0.6535, 0.4513],[0.3753, 0.0916, 0.6532, 0.4512]])\r\nscores = torch.tensor([1., 1., 1.])\r\niou_threshold = 0.2\r\n\r\ncpu_keep = torchvision.ops.nms(boxes_for_nms, scores, iou_threshold)\r\ngpu_keep = torchvision.ops.nms(boxes_for_nms.to('cuda'), scores.to('cuda'), iou_threshold)\r\n\r\nprint(torch.__version__, torchvision.__version__)\r\nprint('cpu keep', cpu_keep)\r\nprint('gpu keep', gpu_keep)\r\nprint('cpu==gpu', int(cpu_keep)==int(gpu_keep))\r\n ```\r\n3. output\r\n```\r\n1.5.0 0.6.0a0+82fd1c8\r\ncpu keep tensor([0])\r\ngpu keep tensor([2], device='cuda:0')\r\ncpu==gpu False\r\n```\r\n\r\n## Expected behavior\r\n\r\n`cpu==gpu True`\r\n\r\n## Environment\r\n\r\n```\r\nPyTorch version: 1.5.0\r\nIs debug build: No\r\nCUDA used to build PyTorch: 10.1\r\n\r\nOS: Ubuntu 18.04.3 LTS\r\nGCC version: (Ubuntu 7.4.0-1ubuntu1~18.04.1) 7.4.0\r\nCMake version: Could not collect\r\n\r\nPython version: 3.7\r\nIs CUDA available: Yes\r\nCUDA runtime version: 10.1.243\r\nGPU models and configuration: GPU 0: GeForce GTX 1060 with Max-Q Design\r\nNvidia driver version: 418.56\r\ncuDNN version: /usr/lib/x86_64-linux-gnu/libcudnn.so.7.6.5\r\n\r\nVersions of relevant libraries:\r\n[pip] numpy==1.18.1\r\n[pip] torch==1.5.0\r\n[pip] torchvision==0.6.0a0+82fd1c8\r\n[conda] blas 1.0 mkl \r\n[conda] cudatoolkit 10.1.243 h6bb024c_0 \r\n[conda] mkl 2020.0 166 \r\n[conda] mkl-service 2.3.0 py37he904b0f_0 \r\n[conda] mkl_fft 1.0.15 py37ha843d7b_0 \r\n[conda] mkl_random 1.1.0 py37hd6b4f25_0 \r\n[conda] numpy 1.18.1 py37h4f9e942_0 \r\n[conda] numpy-base 1.18.1 py37hde5b4d6_1 \r\n[conda] pytorch 1.5.0 py3.7_cuda10.1.243_cudnn7.6.3_0 pytorch\r\n[conda] torchvision 0.6.0 py37_cu101 pytorch\r\n```\r\n\r\n## Additional context\r\n\r\ntesting on pytorch 1.4.0 and torchvision 0.5.0 also yields different result, \r\n\n"},"before_files":{"kind":"list like","value":[{"content":"import torch\nfrom torch.jit.annotations import Tuple\nfrom torch import Tensor\nimport torchvision\n\n\ndef nms(boxes, scores, iou_threshold):\n # type: (Tensor, Tensor, float)\n \"\"\"\n Performs non-maximum suppression (NMS) on the boxes according\n to their intersection-over-union (IoU).\n\n NMS iteratively removes lower scoring boxes which have an\n IoU greater than iou_threshold with another (higher scoring)\n box.\n\n Parameters\n ----------\n boxes : Tensor[N, 4])\n boxes to perform NMS on. They\n are expected to be in (x1, y1, x2, y2) format\n scores : Tensor[N]\n scores for each one of the boxes\n iou_threshold : float\n discards all overlapping\n boxes with IoU > iou_threshold\n\n Returns\n -------\n keep : Tensor\n int64 tensor with the indices\n of the elements that have been kept\n by NMS, sorted in decreasing order of scores\n \"\"\"\n return torch.ops.torchvision.nms(boxes, scores, iou_threshold)\n\n\ndef batched_nms(boxes, scores, idxs, iou_threshold):\n # type: (Tensor, Tensor, Tensor, float)\n \"\"\"\n Performs non-maximum suppression in a batched fashion.\n\n Each index value correspond to a category, and NMS\n will not be applied between elements of different categories.\n\n Parameters\n ----------\n boxes : Tensor[N, 4]\n boxes where NMS will be performed. They\n are expected to be in (x1, y1, x2, y2) format\n scores : Tensor[N]\n scores for each one of the boxes\n idxs : Tensor[N]\n indices of the categories for each one of the boxes.\n iou_threshold : float\n discards all overlapping boxes\n with IoU > iou_threshold\n\n Returns\n -------\n keep : Tensor\n int64 tensor with the indices of\n the elements that have been kept by NMS, sorted\n in decreasing order of scores\n \"\"\"\n if boxes.numel() == 0:\n return torch.empty((0,), dtype=torch.int64, device=boxes.device)\n # strategy: in order to perform NMS independently per class.\n # we add an offset to all the boxes. The offset is dependent\n # only on the class idx, and is large enough so that boxes\n # from different classes do not overlap\n max_coordinate = boxes.max()\n offsets = idxs.to(boxes) * (max_coordinate + 1)\n boxes_for_nms = boxes + offsets[:, None]\n keep = nms(boxes_for_nms, scores, iou_threshold)\n return keep\n\n\ndef remove_small_boxes(boxes, min_size):\n # type: (Tensor, float)\n \"\"\"\n Remove boxes which contains at least one side smaller than min_size.\n\n Arguments:\n boxes (Tensor[N, 4]): boxes in (x1, y1, x2, y2) format\n min_size (float): minimum size\n\n Returns:\n keep (Tensor[K]): indices of the boxes that have both sides\n larger than min_size\n \"\"\"\n ws, hs = boxes[:, 2] - boxes[:, 0], boxes[:, 3] - boxes[:, 1]\n keep = (ws >= min_size) & (hs >= min_size)\n keep = keep.nonzero().squeeze(1)\n return keep\n\n\ndef clip_boxes_to_image(boxes, size):\n # type: (Tensor, Tuple[int, int])\n \"\"\"\n Clip boxes so that they lie inside an image of size `size`.\n\n Arguments:\n boxes (Tensor[N, 4]): boxes in (x1, y1, x2, y2) format\n size (Tuple[height, width]): size of the image\n\n Returns:\n clipped_boxes (Tensor[N, 4])\n \"\"\"\n dim = boxes.dim()\n boxes_x = boxes[..., 0::2]\n boxes_y = boxes[..., 1::2]\n height, width = size\n\n if torchvision._is_tracing():\n boxes_x = torch.max(boxes_x, torch.tensor(0, dtype=boxes.dtype, device=boxes.device))\n boxes_x = torch.min(boxes_x, torch.tensor(width, dtype=boxes.dtype, device=boxes.device))\n boxes_y = torch.max(boxes_y, torch.tensor(0, dtype=boxes.dtype, device=boxes.device))\n boxes_y = torch.min(boxes_y, torch.tensor(height, dtype=boxes.dtype, device=boxes.device))\n else:\n boxes_x = boxes_x.clamp(min=0, max=width)\n boxes_y = boxes_y.clamp(min=0, max=height)\n\n clipped_boxes = torch.stack((boxes_x, boxes_y), dim=dim)\n return clipped_boxes.reshape(boxes.shape)\n\n\ndef box_area(boxes):\n \"\"\"\n Computes the area of a set of bounding boxes, which are specified by its\n (x1, y1, x2, y2) coordinates.\n\n Arguments:\n boxes (Tensor[N, 4]): boxes for which the area will be computed. They\n are expected to be in (x1, y1, x2, y2) format\n\n Returns:\n area (Tensor[N]): area for each box\n \"\"\"\n return (boxes[:, 2] - boxes[:, 0]) * (boxes[:, 3] - boxes[:, 1])\n\n\n# implementation from https://github.com/kuangliu/torchcv/blob/master/torchcv/utils/box.py\n# with slight modifications\ndef box_iou(boxes1, boxes2):\n \"\"\"\n Return intersection-over-union (Jaccard index) of boxes.\n\n Both sets of boxes are expected to be in (x1, y1, x2, y2) format.\n\n Arguments:\n boxes1 (Tensor[N, 4])\n boxes2 (Tensor[M, 4])\n\n Returns:\n iou (Tensor[N, M]): the NxM matrix containing the pairwise\n IoU values for every element in boxes1 and boxes2\n \"\"\"\n area1 = box_area(boxes1)\n area2 = box_area(boxes2)\n\n lt = torch.max(boxes1[:, None, :2], boxes2[:, :2]) # [N,M,2]\n rb = torch.min(boxes1[:, None, 2:], boxes2[:, 2:]) # [N,M,2]\n\n wh = (rb - lt).clamp(min=0) # [N,M,2]\n inter = wh[:, :, 0] * wh[:, :, 1] # [N,M]\n\n iou = inter / (area1[:, None] + area2 - inter)\n return iou\n","path":"torchvision/ops/boxes.py"}],"string":"[\n {\n \"content\": \"import torch\\nfrom torch.jit.annotations import Tuple\\nfrom torch import Tensor\\nimport torchvision\\n\\n\\ndef nms(boxes, scores, iou_threshold):\\n # type: (Tensor, Tensor, float)\\n \\\"\\\"\\\"\\n Performs non-maximum suppression (NMS) on the boxes according\\n to their intersection-over-union (IoU).\\n\\n NMS iteratively removes lower scoring boxes which have an\\n IoU greater than iou_threshold with another (higher scoring)\\n box.\\n\\n Parameters\\n ----------\\n boxes : Tensor[N, 4])\\n boxes to perform NMS on. They\\n are expected to be in (x1, y1, x2, y2) format\\n scores : Tensor[N]\\n scores for each one of the boxes\\n iou_threshold : float\\n discards all overlapping\\n boxes with IoU > iou_threshold\\n\\n Returns\\n -------\\n keep : Tensor\\n int64 tensor with the indices\\n of the elements that have been kept\\n by NMS, sorted in decreasing order of scores\\n \\\"\\\"\\\"\\n return torch.ops.torchvision.nms(boxes, scores, iou_threshold)\\n\\n\\ndef batched_nms(boxes, scores, idxs, iou_threshold):\\n # type: (Tensor, Tensor, Tensor, float)\\n \\\"\\\"\\\"\\n Performs non-maximum suppression in a batched fashion.\\n\\n Each index value correspond to a category, and NMS\\n will not be applied between elements of different categories.\\n\\n Parameters\\n ----------\\n boxes : Tensor[N, 4]\\n boxes where NMS will be performed. They\\n are expected to be in (x1, y1, x2, y2) format\\n scores : Tensor[N]\\n scores for each one of the boxes\\n idxs : Tensor[N]\\n indices of the categories for each one of the boxes.\\n iou_threshold : float\\n discards all overlapping boxes\\n with IoU > iou_threshold\\n\\n Returns\\n -------\\n keep : Tensor\\n int64 tensor with the indices of\\n the elements that have been kept by NMS, sorted\\n in decreasing order of scores\\n \\\"\\\"\\\"\\n if boxes.numel() == 0:\\n return torch.empty((0,), dtype=torch.int64, device=boxes.device)\\n # strategy: in order to perform NMS independently per class.\\n # we add an offset to all the boxes. The offset is dependent\\n # only on the class idx, and is large enough so that boxes\\n # from different classes do not overlap\\n max_coordinate = boxes.max()\\n offsets = idxs.to(boxes) * (max_coordinate + 1)\\n boxes_for_nms = boxes + offsets[:, None]\\n keep = nms(boxes_for_nms, scores, iou_threshold)\\n return keep\\n\\n\\ndef remove_small_boxes(boxes, min_size):\\n # type: (Tensor, float)\\n \\\"\\\"\\\"\\n Remove boxes which contains at least one side smaller than min_size.\\n\\n Arguments:\\n boxes (Tensor[N, 4]): boxes in (x1, y1, x2, y2) format\\n min_size (float): minimum size\\n\\n Returns:\\n keep (Tensor[K]): indices of the boxes that have both sides\\n larger than min_size\\n \\\"\\\"\\\"\\n ws, hs = boxes[:, 2] - boxes[:, 0], boxes[:, 3] - boxes[:, 1]\\n keep = (ws >= min_size) & (hs >= min_size)\\n keep = keep.nonzero().squeeze(1)\\n return keep\\n\\n\\ndef clip_boxes_to_image(boxes, size):\\n # type: (Tensor, Tuple[int, int])\\n \\\"\\\"\\\"\\n Clip boxes so that they lie inside an image of size `size`.\\n\\n Arguments:\\n boxes (Tensor[N, 4]): boxes in (x1, y1, x2, y2) format\\n size (Tuple[height, width]): size of the image\\n\\n Returns:\\n clipped_boxes (Tensor[N, 4])\\n \\\"\\\"\\\"\\n dim = boxes.dim()\\n boxes_x = boxes[..., 0::2]\\n boxes_y = boxes[..., 1::2]\\n height, width = size\\n\\n if torchvision._is_tracing():\\n boxes_x = torch.max(boxes_x, torch.tensor(0, dtype=boxes.dtype, device=boxes.device))\\n boxes_x = torch.min(boxes_x, torch.tensor(width, dtype=boxes.dtype, device=boxes.device))\\n boxes_y = torch.max(boxes_y, torch.tensor(0, dtype=boxes.dtype, device=boxes.device))\\n boxes_y = torch.min(boxes_y, torch.tensor(height, dtype=boxes.dtype, device=boxes.device))\\n else:\\n boxes_x = boxes_x.clamp(min=0, max=width)\\n boxes_y = boxes_y.clamp(min=0, max=height)\\n\\n clipped_boxes = torch.stack((boxes_x, boxes_y), dim=dim)\\n return clipped_boxes.reshape(boxes.shape)\\n\\n\\ndef box_area(boxes):\\n \\\"\\\"\\\"\\n Computes the area of a set of bounding boxes, which are specified by its\\n (x1, y1, x2, y2) coordinates.\\n\\n Arguments:\\n boxes (Tensor[N, 4]): boxes for which the area will be computed. They\\n are expected to be in (x1, y1, x2, y2) format\\n\\n Returns:\\n area (Tensor[N]): area for each box\\n \\\"\\\"\\\"\\n return (boxes[:, 2] - boxes[:, 0]) * (boxes[:, 3] - boxes[:, 1])\\n\\n\\n# implementation from https://github.com/kuangliu/torchcv/blob/master/torchcv/utils/box.py\\n# with slight modifications\\ndef box_iou(boxes1, boxes2):\\n \\\"\\\"\\\"\\n Return intersection-over-union (Jaccard index) of boxes.\\n\\n Both sets of boxes are expected to be in (x1, y1, x2, y2) format.\\n\\n Arguments:\\n boxes1 (Tensor[N, 4])\\n boxes2 (Tensor[M, 4])\\n\\n Returns:\\n iou (Tensor[N, M]): the NxM matrix containing the pairwise\\n IoU values for every element in boxes1 and boxes2\\n \\\"\\\"\\\"\\n area1 = box_area(boxes1)\\n area2 = box_area(boxes2)\\n\\n lt = torch.max(boxes1[:, None, :2], boxes2[:, :2]) # [N,M,2]\\n rb = torch.min(boxes1[:, None, 2:], boxes2[:, 2:]) # [N,M,2]\\n\\n wh = (rb - lt).clamp(min=0) # [N,M,2]\\n inter = wh[:, :, 0] * wh[:, :, 1] # [N,M]\\n\\n iou = inter / (area1[:, None] + area2 - inter)\\n return iou\\n\",\n \"path\": \"torchvision/ops/boxes.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"import torch\nfrom torch.jit.annotations import Tuple\nfrom torch import Tensor\nimport torchvision\n\n\ndef nms(boxes, scores, iou_threshold):\n # type: (Tensor, Tensor, float)\n \"\"\"\n Performs non-maximum suppression (NMS) on the boxes according\n to their intersection-over-union (IoU).\n\n NMS iteratively removes lower scoring boxes which have an\n IoU greater than iou_threshold with another (higher scoring)\n box.\n\n If multiple boxes have the exact same score and satisfy the IoU \n criterion with respect to a reference box, the selected box is \n not guaranteed to be the same between CPU and GPU. This is similar \n to the behavior of argsort in PyTorch when repeated values are present.\n\n Parameters\n ----------\n boxes : Tensor[N, 4])\n boxes to perform NMS on. They\n are expected to be in (x1, y1, x2, y2) format\n scores : Tensor[N]\n scores for each one of the boxes\n iou_threshold : float\n discards all overlapping\n boxes with IoU > iou_threshold\n\n Returns\n -------\n keep : Tensor\n int64 tensor with the indices\n of the elements that have been kept\n by NMS, sorted in decreasing order of scores\n \"\"\"\n return torch.ops.torchvision.nms(boxes, scores, iou_threshold)\n\n\ndef batched_nms(boxes, scores, idxs, iou_threshold):\n # type: (Tensor, Tensor, Tensor, float)\n \"\"\"\n Performs non-maximum suppression in a batched fashion.\n\n Each index value correspond to a category, and NMS\n will not be applied between elements of different categories.\n\n Parameters\n ----------\n boxes : Tensor[N, 4]\n boxes where NMS will be performed. They\n are expected to be in (x1, y1, x2, y2) format\n scores : Tensor[N]\n scores for each one of the boxes\n idxs : Tensor[N]\n indices of the categories for each one of the boxes.\n iou_threshold : float\n discards all overlapping boxes\n with IoU > iou_threshold\n\n Returns\n -------\n keep : Tensor\n int64 tensor with the indices of\n the elements that have been kept by NMS, sorted\n in decreasing order of scores\n \"\"\"\n if boxes.numel() == 0:\n return torch.empty((0,), dtype=torch.int64, device=boxes.device)\n # strategy: in order to perform NMS independently per class.\n # we add an offset to all the boxes. The offset is dependent\n # only on the class idx, and is large enough so that boxes\n # from different classes do not overlap\n max_coordinate = boxes.max()\n offsets = idxs.to(boxes) * (max_coordinate + 1)\n boxes_for_nms = boxes + offsets[:, None]\n keep = nms(boxes_for_nms, scores, iou_threshold)\n return keep\n\n\ndef remove_small_boxes(boxes, min_size):\n # type: (Tensor, float)\n \"\"\"\n Remove boxes which contains at least one side smaller than min_size.\n\n Arguments:\n boxes (Tensor[N, 4]): boxes in (x1, y1, x2, y2) format\n min_size (float): minimum size\n\n Returns:\n keep (Tensor[K]): indices of the boxes that have both sides\n larger than min_size\n \"\"\"\n ws, hs = boxes[:, 2] - boxes[:, 0], boxes[:, 3] - boxes[:, 1]\n keep = (ws >= min_size) & (hs >= min_size)\n keep = keep.nonzero().squeeze(1)\n return keep\n\n\ndef clip_boxes_to_image(boxes, size):\n # type: (Tensor, Tuple[int, int])\n \"\"\"\n Clip boxes so that they lie inside an image of size `size`.\n\n Arguments:\n boxes (Tensor[N, 4]): boxes in (x1, y1, x2, y2) format\n size (Tuple[height, width]): size of the image\n\n Returns:\n clipped_boxes (Tensor[N, 4])\n \"\"\"\n dim = boxes.dim()\n boxes_x = boxes[..., 0::2]\n boxes_y = boxes[..., 1::2]\n height, width = size\n\n if torchvision._is_tracing():\n boxes_x = torch.max(boxes_x, torch.tensor(0, dtype=boxes.dtype, device=boxes.device))\n boxes_x = torch.min(boxes_x, torch.tensor(width, dtype=boxes.dtype, device=boxes.device))\n boxes_y = torch.max(boxes_y, torch.tensor(0, dtype=boxes.dtype, device=boxes.device))\n boxes_y = torch.min(boxes_y, torch.tensor(height, dtype=boxes.dtype, device=boxes.device))\n else:\n boxes_x = boxes_x.clamp(min=0, max=width)\n boxes_y = boxes_y.clamp(min=0, max=height)\n\n clipped_boxes = torch.stack((boxes_x, boxes_y), dim=dim)\n return clipped_boxes.reshape(boxes.shape)\n\n\ndef box_area(boxes):\n \"\"\"\n Computes the area of a set of bounding boxes, which are specified by its\n (x1, y1, x2, y2) coordinates.\n\n Arguments:\n boxes (Tensor[N, 4]): boxes for which the area will be computed. They\n are expected to be in (x1, y1, x2, y2) format\n\n Returns:\n area (Tensor[N]): area for each box\n \"\"\"\n return (boxes[:, 2] - boxes[:, 0]) * (boxes[:, 3] - boxes[:, 1])\n\n\n# implementation from https://github.com/kuangliu/torchcv/blob/master/torchcv/utils/box.py\n# with slight modifications\ndef box_iou(boxes1, boxes2):\n \"\"\"\n Return intersection-over-union (Jaccard index) of boxes.\n\n Both sets of boxes are expected to be in (x1, y1, x2, y2) format.\n\n Arguments:\n boxes1 (Tensor[N, 4])\n boxes2 (Tensor[M, 4])\n\n Returns:\n iou (Tensor[N, M]): the NxM matrix containing the pairwise\n IoU values for every element in boxes1 and boxes2\n \"\"\"\n area1 = box_area(boxes1)\n area2 = box_area(boxes2)\n\n lt = torch.max(boxes1[:, None, :2], boxes2[:, :2]) # [N,M,2]\n rb = torch.min(boxes1[:, None, 2:], boxes2[:, 2:]) # [N,M,2]\n\n wh = (rb - lt).clamp(min=0) # [N,M,2]\n inter = wh[:, :, 0] * wh[:, :, 1] # [N,M]\n\n iou = inter / (area1[:, None] + area2 - inter)\n return iou\n","path":"torchvision/ops/boxes.py"}],"string":"[\n {\n \"content\": \"import torch\\nfrom torch.jit.annotations import Tuple\\nfrom torch import Tensor\\nimport torchvision\\n\\n\\ndef nms(boxes, scores, iou_threshold):\\n # type: (Tensor, Tensor, float)\\n \\\"\\\"\\\"\\n Performs non-maximum suppression (NMS) on the boxes according\\n to their intersection-over-union (IoU).\\n\\n NMS iteratively removes lower scoring boxes which have an\\n IoU greater than iou_threshold with another (higher scoring)\\n box.\\n\\n If multiple boxes have the exact same score and satisfy the IoU \\n criterion with respect to a reference box, the selected box is \\n not guaranteed to be the same between CPU and GPU. This is similar \\n to the behavior of argsort in PyTorch when repeated values are present.\\n\\n Parameters\\n ----------\\n boxes : Tensor[N, 4])\\n boxes to perform NMS on. They\\n are expected to be in (x1, y1, x2, y2) format\\n scores : Tensor[N]\\n scores for each one of the boxes\\n iou_threshold : float\\n discards all overlapping\\n boxes with IoU > iou_threshold\\n\\n Returns\\n -------\\n keep : Tensor\\n int64 tensor with the indices\\n of the elements that have been kept\\n by NMS, sorted in decreasing order of scores\\n \\\"\\\"\\\"\\n return torch.ops.torchvision.nms(boxes, scores, iou_threshold)\\n\\n\\ndef batched_nms(boxes, scores, idxs, iou_threshold):\\n # type: (Tensor, Tensor, Tensor, float)\\n \\\"\\\"\\\"\\n Performs non-maximum suppression in a batched fashion.\\n\\n Each index value correspond to a category, and NMS\\n will not be applied between elements of different categories.\\n\\n Parameters\\n ----------\\n boxes : Tensor[N, 4]\\n boxes where NMS will be performed. They\\n are expected to be in (x1, y1, x2, y2) format\\n scores : Tensor[N]\\n scores for each one of the boxes\\n idxs : Tensor[N]\\n indices of the categories for each one of the boxes.\\n iou_threshold : float\\n discards all overlapping boxes\\n with IoU > iou_threshold\\n\\n Returns\\n -------\\n keep : Tensor\\n int64 tensor with the indices of\\n the elements that have been kept by NMS, sorted\\n in decreasing order of scores\\n \\\"\\\"\\\"\\n if boxes.numel() == 0:\\n return torch.empty((0,), dtype=torch.int64, device=boxes.device)\\n # strategy: in order to perform NMS independently per class.\\n # we add an offset to all the boxes. The offset is dependent\\n # only on the class idx, and is large enough so that boxes\\n # from different classes do not overlap\\n max_coordinate = boxes.max()\\n offsets = idxs.to(boxes) * (max_coordinate + 1)\\n boxes_for_nms = boxes + offsets[:, None]\\n keep = nms(boxes_for_nms, scores, iou_threshold)\\n return keep\\n\\n\\ndef remove_small_boxes(boxes, min_size):\\n # type: (Tensor, float)\\n \\\"\\\"\\\"\\n Remove boxes which contains at least one side smaller than min_size.\\n\\n Arguments:\\n boxes (Tensor[N, 4]): boxes in (x1, y1, x2, y2) format\\n min_size (float): minimum size\\n\\n Returns:\\n keep (Tensor[K]): indices of the boxes that have both sides\\n larger than min_size\\n \\\"\\\"\\\"\\n ws, hs = boxes[:, 2] - boxes[:, 0], boxes[:, 3] - boxes[:, 1]\\n keep = (ws >= min_size) & (hs >= min_size)\\n keep = keep.nonzero().squeeze(1)\\n return keep\\n\\n\\ndef clip_boxes_to_image(boxes, size):\\n # type: (Tensor, Tuple[int, int])\\n \\\"\\\"\\\"\\n Clip boxes so that they lie inside an image of size `size`.\\n\\n Arguments:\\n boxes (Tensor[N, 4]): boxes in (x1, y1, x2, y2) format\\n size (Tuple[height, width]): size of the image\\n\\n Returns:\\n clipped_boxes (Tensor[N, 4])\\n \\\"\\\"\\\"\\n dim = boxes.dim()\\n boxes_x = boxes[..., 0::2]\\n boxes_y = boxes[..., 1::2]\\n height, width = size\\n\\n if torchvision._is_tracing():\\n boxes_x = torch.max(boxes_x, torch.tensor(0, dtype=boxes.dtype, device=boxes.device))\\n boxes_x = torch.min(boxes_x, torch.tensor(width, dtype=boxes.dtype, device=boxes.device))\\n boxes_y = torch.max(boxes_y, torch.tensor(0, dtype=boxes.dtype, device=boxes.device))\\n boxes_y = torch.min(boxes_y, torch.tensor(height, dtype=boxes.dtype, device=boxes.device))\\n else:\\n boxes_x = boxes_x.clamp(min=0, max=width)\\n boxes_y = boxes_y.clamp(min=0, max=height)\\n\\n clipped_boxes = torch.stack((boxes_x, boxes_y), dim=dim)\\n return clipped_boxes.reshape(boxes.shape)\\n\\n\\ndef box_area(boxes):\\n \\\"\\\"\\\"\\n Computes the area of a set of bounding boxes, which are specified by its\\n (x1, y1, x2, y2) coordinates.\\n\\n Arguments:\\n boxes (Tensor[N, 4]): boxes for which the area will be computed. They\\n are expected to be in (x1, y1, x2, y2) format\\n\\n Returns:\\n area (Tensor[N]): area for each box\\n \\\"\\\"\\\"\\n return (boxes[:, 2] - boxes[:, 0]) * (boxes[:, 3] - boxes[:, 1])\\n\\n\\n# implementation from https://github.com/kuangliu/torchcv/blob/master/torchcv/utils/box.py\\n# with slight modifications\\ndef box_iou(boxes1, boxes2):\\n \\\"\\\"\\\"\\n Return intersection-over-union (Jaccard index) of boxes.\\n\\n Both sets of boxes are expected to be in (x1, y1, x2, y2) format.\\n\\n Arguments:\\n boxes1 (Tensor[N, 4])\\n boxes2 (Tensor[M, 4])\\n\\n Returns:\\n iou (Tensor[N, M]): the NxM matrix containing the pairwise\\n IoU values for every element in boxes1 and boxes2\\n \\\"\\\"\\\"\\n area1 = box_area(boxes1)\\n area2 = box_area(boxes2)\\n\\n lt = torch.max(boxes1[:, None, :2], boxes2[:, :2]) # [N,M,2]\\n rb = torch.min(boxes1[:, None, 2:], boxes2[:, 2:]) # [N,M,2]\\n\\n wh = (rb - lt).clamp(min=0) # [N,M,2]\\n inter = wh[:, :, 0] * wh[:, :, 1] # [N,M]\\n\\n iou = inter / (area1[:, None] + area2 - inter)\\n return iou\\n\",\n \"path\": \"torchvision/ops/boxes.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/torchvision/ops/boxes.py b/torchvision/ops/boxes.py\nindex 4bbc9c1fdad..686d6233354 100644\n--- a/torchvision/ops/boxes.py\n+++ b/torchvision/ops/boxes.py\n@@ -14,6 +14,11 @@ def nms(boxes, scores, iou_threshold):\n IoU greater than iou_threshold with another (higher scoring)\n box.\n \n+ If multiple boxes have the exact same score and satisfy the IoU \n+ criterion with respect to a reference box, the selected box is \n+ not guaranteed to be the same between CPU and GPU. This is similar \n+ to the behavior of argsort in PyTorch when repeated values are present.\n+\n Parameters\n ----------\n boxes : Tensor[N, 4])\n"}}},{"rowIdx":5492,"cells":{"in_source_id":{"kind":"string","value":"lutris__lutris-3941"},"issue":{"kind":"string","value":"MicroM8 runner does not work\nI installed the MicroM8 runner and tried to manually configure an Apple II game by selecting the runner and pointing it to an Apple II floppy. Debug output shows a “No game found in library” error, but no indication of specifically what file it is looking for that it can’t find.\r\n\r\n```\r\n~$ lutris -d lutris:rungame/10\r\n2021-10-10 18:18:51,525: Initializing lutris\r\n2021-10-10 18:18:52,016: Downloading DXVK releases to /home/********/.local/share/lutris/runtime/dxvk/dxvk_versions.json\r\n2021-10-10 18:18:52,017: Runtime updated. Initialization complete.\r\nINFO 2021-10-10 18:18:52,019 [application.do_command_line:315]:Lutris 0.5.8.3\r\nINFO 2021-10-10 18:18:52,019 [startup.check_driver:57]:Running Intel Mesa driver 21.2.1 on Mesa Intel(R) Xe Graphics (TGL GT2) (0x9a49)\r\nINFO 2021-10-10 18:18:52,019 [startup.check_driver:69]:GPU: 8086:9A49 1558:51A1 (i915 drivers)\r\nMESA-INTEL: warning: Performance support disabled, consider sysctl dev.i915.perf_stream_paranoid=0\r\n\r\nWARNING 2021-10-10 18:18:52,115 [application.do_command_line:455]:No game found in library\r\nINFO 2021-10-10 18:18:52,115 [application.do_shutdown:598]:Shutting down Lutris\r\nINFO 2021-10-10 18:18:52,118 [application.do_shutdown:598]:Shutting down Lutris\r\n```\n"},"before_files":{"kind":"list like","value":[{"content":"\"\"\"Base module for runners\"\"\"\nimport os\nfrom gettext import gettext as _\n\nfrom gi.repository import Gtk\n\nfrom lutris import runtime, settings\nfrom lutris.command import MonitoredCommand\nfrom lutris.config import LutrisConfig\nfrom lutris.database.games import get_game_by_field\nfrom lutris.exceptions import UnavailableLibraries\nfrom lutris.gui import dialogs\nfrom lutris.runners import RunnerInstallationError\nfrom lutris.util import system\nfrom lutris.util.extract import ExtractFailure, extract_archive\nfrom lutris.util.http import HTTPError, Request\nfrom lutris.util.linux import LINUX_SYSTEM\nfrom lutris.util.log import logger\n\n\nclass Runner: # pylint: disable=too-many-public-methods\n\n \"\"\"Generic runner (base class for other runners).\"\"\"\n\n multiple_versions = False\n platforms = []\n runnable_alone = False\n game_options = []\n runner_options = []\n system_options_override = []\n context_menu_entries = []\n require_libs = []\n runner_executable = None\n entry_point_option = \"main_file\"\n download_url = None\n arch = None # If the runner is only available for an architecture that isn't x86_64\n\n def __init__(self, config=None):\n \"\"\"Initialize runner.\"\"\"\n self.config = config\n if config:\n self.game_data = get_game_by_field(self.config.game_config_id, \"configpath\")\n else:\n self.game_data = {}\n\n def __lt__(self, other):\n return self.name < other.name\n\n @property\n def description(self):\n \"\"\"Return the class' docstring as the description.\"\"\"\n return self.__doc__\n\n @description.setter\n def description(self, value):\n \"\"\"Leave the ability to override the docstring.\"\"\"\n self.__doc__ = value # What the shit\n\n @property\n def name(self):\n return self.__class__.__name__\n\n @property\n def default_config(self):\n return LutrisConfig(runner_slug=self.name)\n\n @property\n def game_config(self):\n \"\"\"Return the cascaded game config as a dict.\"\"\"\n return self.config.game_config if self.config else {}\n\n @property\n def runner_config(self):\n \"\"\"Return the cascaded runner config as a dict.\"\"\"\n if self.config:\n return self.config.runner_config\n return self.default_config.runner_config\n\n @property\n def system_config(self):\n \"\"\"Return the cascaded system config as a dict.\"\"\"\n if self.config:\n return self.config.system_config\n return self.default_config.system_config\n\n @property\n def default_path(self):\n \"\"\"Return the default path where games are installed.\"\"\"\n return self.system_config.get(\"game_path\")\n\n @property\n def game_path(self):\n \"\"\"Return the directory where the game is installed.\"\"\"\n game_path = self.game_data.get(\"directory\")\n if game_path:\n return game_path\n\n # Default to the directory where the entry point is located.\n entry_point = self.game_config.get(self.entry_point_option)\n if entry_point:\n return os.path.dirname(os.path.expanduser(entry_point))\n return \"\"\n\n @property\n def library_folders(self):\n \"\"\"Return a list of paths where a game might be installed\"\"\"\n return []\n\n @property\n def working_dir(self):\n \"\"\"Return the working directory to use when running the game.\"\"\"\n return self.game_path or os.path.expanduser(\"~/\")\n\n @property\n def discord_client_id(self):\n if self.game_data.get(\"discord_client_id\"):\n return self.game_data.get(\"discord_client_id\")\n\n def get_platform(self):\n return self.platforms[0]\n\n def get_runner_options(self):\n runner_options = self.runner_options[:]\n if self.runner_executable:\n runner_options.append(\n {\n \"option\": \"runner_executable\",\n \"type\": \"file\",\n \"label\": _(\"Custom executable for the runner\"),\n \"advanced\": True,\n }\n )\n return runner_options\n\n def get_executable(self):\n if \"runner_executable\" in self.runner_config:\n runner_executable = self.runner_config[\"runner_executable\"]\n if os.path.isfile(runner_executable):\n return runner_executable\n if not self.runner_executable:\n raise ValueError(\"runner_executable not set for {}\".format(self.name))\n return os.path.join(settings.RUNNER_DIR, self.runner_executable)\n\n def get_env(self, os_env=False):\n \"\"\"Return environment variables used for a game.\"\"\"\n env = {}\n if os_env:\n env.update(os.environ.copy())\n\n # By default we'll set NVidia's shader disk cache to be\n # per-game, so it overflows less readily.\n env[\"__GL_SHADER_DISK_CACHE\"] = \"1\"\n env[\"__GL_SHADER_DISK_CACHE_PATH\"] = self.game_path\n\n # Override SDL2 controller configuration\n sdl_gamecontrollerconfig = self.system_config.get(\"sdl_gamecontrollerconfig\")\n if sdl_gamecontrollerconfig:\n path = os.path.expanduser(sdl_gamecontrollerconfig)\n if system.path_exists(path):\n with open(path, \"r\", encoding='utf-8') as controllerdb_file:\n sdl_gamecontrollerconfig = controllerdb_file.read()\n env[\"SDL_GAMECONTROLLERCONFIG\"] = sdl_gamecontrollerconfig\n\n # Set monitor to use for SDL 1 games\n if self.system_config.get(\"sdl_video_fullscreen\"):\n env[\"SDL_VIDEO_FULLSCREEN_DISPLAY\"] = self.system_config[\"sdl_video_fullscreen\"]\n\n # DRI Prime\n if self.system_config.get(\"dri_prime\"):\n env[\"DRI_PRIME\"] = \"1\"\n\n # Prime vars\n prime = self.system_config.get(\"prime\")\n if prime:\n env[\"__NV_PRIME_RENDER_OFFLOAD\"] = \"1\"\n env[\"__GLX_VENDOR_LIBRARY_NAME\"] = \"nvidia\"\n env[\"__VK_LAYER_NV_optimus\"] = \"NVIDIA_only\"\n\n # Set PulseAudio latency to 60ms\n if self.system_config.get(\"pulse_latency\"):\n env[\"PULSE_LATENCY_MSEC\"] = \"60\"\n\n # Vulkan ICD files\n vk_icd = self.system_config.get(\"vk_icd\")\n if vk_icd:\n env[\"VK_ICD_FILENAMES\"] = vk_icd\n\n runtime_ld_library_path = None\n\n if self.use_runtime():\n runtime_env = self.get_runtime_env()\n if \"LD_LIBRARY_PATH\" in runtime_env:\n runtime_ld_library_path = runtime_env[\"LD_LIBRARY_PATH\"]\n\n if runtime_ld_library_path:\n ld_library_path = env.get(\"LD_LIBRARY_PATH\")\n if not ld_library_path:\n ld_library_path = \"$LD_LIBRARY_PATH\"\n env[\"LD_LIBRARY_PATH\"] = \":\".join([runtime_ld_library_path, ld_library_path])\n\n # Apply user overrides at the end\n env.update(self.system_config.get(\"env\") or {})\n\n return env\n\n def get_runtime_env(self):\n \"\"\"Return runtime environment variables.\n\n This method may be overridden in runner classes.\n (Notably for Lutris wine builds)\n\n Returns:\n dict\n\n \"\"\"\n return runtime.get_env(prefer_system_libs=self.system_config.get(\"prefer_system_libs\", True))\n\n def prelaunch(self):\n \"\"\"Run actions before running the game, override this method in runners\"\"\"\n available_libs = set()\n for lib in set(self.require_libs):\n if lib in LINUX_SYSTEM.shared_libraries:\n if self.arch:\n if self.arch in [_lib.arch for _lib in LINUX_SYSTEM.shared_libraries[lib]]:\n available_libs.add(lib)\n else:\n available_libs.add(lib)\n unavailable_libs = set(self.require_libs) - available_libs\n if unavailable_libs:\n raise UnavailableLibraries(unavailable_libs, self.arch)\n return True\n\n def get_run_data(self):\n \"\"\"Return dict with command (exe & args list) and env vars (dict).\n\n Reimplement in derived runner if need be.\"\"\"\n return {\"command\": [self.get_executable()], \"env\": self.get_env()}\n\n def run(self, *args):\n \"\"\"Run the runner alone.\"\"\"\n if not self.runnable_alone:\n return\n if not self.is_installed():\n if not self.install_dialog():\n logger.info(\"Runner install cancelled\")\n return\n\n command_data = self.get_run_data()\n command = command_data.get(\"command\")\n env = (command_data.get(\"env\") or {}).copy()\n\n if hasattr(self, \"prelaunch\"):\n self.prelaunch()\n\n command_runner = MonitoredCommand(command, runner=self, env=env)\n command_runner.start()\n\n def use_runtime(self):\n if runtime.RUNTIME_DISABLED:\n logger.info(\"Runtime disabled by environment\")\n return False\n if self.system_config.get(\"disable_runtime\"):\n logger.info(\"Runtime disabled by system configuration\")\n return False\n return True\n\n def install_dialog(self):\n \"\"\"Ask the user if they want to install the runner.\n\n Return success of runner installation.\n \"\"\"\n dialog = dialogs.QuestionDialog(\n {\n \"question\": _(\"The required runner is not installed.\\n\"\n \"Do you wish to install it now?\"),\n \"title\": _(\"Required runner unavailable\"),\n }\n )\n if Gtk.ResponseType.YES == dialog.result:\n\n from lutris.gui.dialogs import ErrorDialog\n from lutris.gui.dialogs.download import simple_downloader\n try:\n if hasattr(self, \"get_version\"):\n version = self.get_version(use_default=False) # pylint: disable=no-member\n self.install(downloader=simple_downloader, version=version)\n else:\n self.install(downloader=simple_downloader)\n except RunnerInstallationError as ex:\n ErrorDialog(ex.message)\n\n return self.is_installed()\n return False\n\n def is_installed(self):\n \"\"\"Return whether the runner is installed\"\"\"\n return system.path_exists(self.get_executable())\n\n def get_runner_version(self, version=None):\n \"\"\"Get the appropriate version for a runner\n\n Params:\n version (str): Optional version to lookup, will return this one if found\n\n Returns:\n dict: Dict containing version, architecture and url for the runner, None\n if the data can't be retrieved.\n \"\"\"\n logger.info(\n \"Getting runner information for %s%s\",\n self.name,\n \" (version: %s)\" % version if version else \"\",\n )\n\n try:\n request = Request(\"{}/api/runners/{}\".format(settings.SITE_URL, self.name))\n runner_info = request.get().json\n\n if not runner_info:\n logger.error(\"Failed to get runner information\")\n except HTTPError as ex:\n logger.error(\"Unable to get runner information: %s\", ex)\n runner_info = None\n\n if not runner_info:\n return\n\n versions = runner_info.get(\"versions\") or []\n arch = LINUX_SYSTEM.arch\n if version:\n if version.endswith(\"-i386\") or version.endswith(\"-x86_64\"):\n version, arch = version.rsplit(\"-\", 1)\n versions = [v for v in versions if v[\"version\"] == version]\n versions_for_arch = [v for v in versions if v[\"architecture\"] == arch]\n if len(versions_for_arch) == 1:\n return versions_for_arch[0]\n\n if len(versions_for_arch) > 1:\n default_version = [v for v in versions_for_arch if v[\"default\"] is True]\n if default_version:\n return default_version[0]\n elif len(versions) == 1 and LINUX_SYSTEM.is_64_bit:\n return versions[0]\n elif len(versions) > 1 and LINUX_SYSTEM.is_64_bit:\n default_version = [v for v in versions if v[\"default\"] is True]\n if default_version:\n return default_version[0]\n # If we didn't find a proper version yet, return the first available.\n if len(versions_for_arch) >= 1:\n return versions_for_arch[0]\n\n def install(self, version=None, downloader=None, callback=None):\n \"\"\"Install runner using package management systems.\"\"\"\n logger.debug(\n \"Installing %s (version=%s, downloader=%s, callback=%s)\",\n self.name,\n version,\n downloader,\n callback,\n )\n opts = {\"downloader\": downloader, \"callback\": callback}\n if self.download_url:\n opts[\"dest\"] = os.path.join(settings.RUNNER_DIR, self.name)\n return self.download_and_extract(self.download_url, **opts)\n runner = self.get_runner_version(version)\n if not runner:\n raise RunnerInstallationError(\"Failed to retrieve {} ({}) information\".format(self.name, version))\n if not downloader:\n raise RuntimeError(\"Missing mandatory downloader for runner %s\" % self)\n\n if \"wine\" in self.name:\n opts[\"merge_single\"] = True\n opts[\"dest\"] = os.path.join(\n settings.RUNNER_DIR, self.name, \"{}-{}\".format(runner[\"version\"], runner[\"architecture\"])\n )\n\n if self.name == \"libretro\" and version:\n opts[\"merge_single\"] = False\n opts[\"dest\"] = os.path.join(settings.RUNNER_DIR, \"retroarch/cores\")\n self.download_and_extract(runner[\"url\"], **opts)\n\n def download_and_extract(self, url, dest=None, **opts):\n downloader = opts[\"downloader\"]\n merge_single = opts.get(\"merge_single\", False)\n callback = opts.get(\"callback\")\n tarball_filename = os.path.basename(url)\n runner_archive = os.path.join(settings.CACHE_DIR, tarball_filename)\n if not dest:\n dest = settings.RUNNER_DIR\n downloader(\n url, runner_archive, self.extract, {\n \"archive\": runner_archive,\n \"dest\": dest,\n \"merge_single\": merge_single,\n \"callback\": callback,\n }\n )\n\n def extract(self, archive=None, dest=None, merge_single=None, callback=None):\n if not system.path_exists(archive):\n raise RunnerInstallationError(\"Failed to extract {}\".format(archive))\n try:\n extract_archive(archive, dest, merge_single=merge_single)\n except ExtractFailure as ex:\n logger.error(\"Failed to extract the archive %s file may be corrupt\", archive)\n raise RunnerInstallationError(\"Failed to extract {}: {}\".format(archive, ex)) from ex\n os.remove(archive)\n\n if self.name == \"wine\":\n logger.debug(\"Clearing wine version cache\")\n from lutris.util.wine.wine import get_wine_versions\n get_wine_versions.cache_clear()\n\n if callback:\n callback()\n\n @staticmethod\n def remove_game_data(app_id=None, game_path=None):\n system.remove_folder(game_path)\n\n def can_uninstall(self):\n runner_path = os.path.join(settings.RUNNER_DIR, self.name)\n return os.path.isdir(runner_path)\n\n def uninstall(self):\n runner_path = os.path.join(settings.RUNNER_DIR, self.name)\n if os.path.isdir(runner_path):\n system.remove_folder(runner_path)\n\n def find_option(self, options_group, option_name):\n \"\"\"Retrieve an option dict if it exists in the group\"\"\"\n if options_group not in ['game_options', 'runner_options']:\n return None\n output = None\n for item in getattr(self, options_group):\n if item[\"option\"] == option_name:\n output = item\n break\n return output\n","path":"lutris/runners/runner.py"}],"string":"[\n {\n \"content\": \"\\\"\\\"\\\"Base module for runners\\\"\\\"\\\"\\nimport os\\nfrom gettext import gettext as _\\n\\nfrom gi.repository import Gtk\\n\\nfrom lutris import runtime, settings\\nfrom lutris.command import MonitoredCommand\\nfrom lutris.config import LutrisConfig\\nfrom lutris.database.games import get_game_by_field\\nfrom lutris.exceptions import UnavailableLibraries\\nfrom lutris.gui import dialogs\\nfrom lutris.runners import RunnerInstallationError\\nfrom lutris.util import system\\nfrom lutris.util.extract import ExtractFailure, extract_archive\\nfrom lutris.util.http import HTTPError, Request\\nfrom lutris.util.linux import LINUX_SYSTEM\\nfrom lutris.util.log import logger\\n\\n\\nclass Runner: # pylint: disable=too-many-public-methods\\n\\n \\\"\\\"\\\"Generic runner (base class for other runners).\\\"\\\"\\\"\\n\\n multiple_versions = False\\n platforms = []\\n runnable_alone = False\\n game_options = []\\n runner_options = []\\n system_options_override = []\\n context_menu_entries = []\\n require_libs = []\\n runner_executable = None\\n entry_point_option = \\\"main_file\\\"\\n download_url = None\\n arch = None # If the runner is only available for an architecture that isn't x86_64\\n\\n def __init__(self, config=None):\\n \\\"\\\"\\\"Initialize runner.\\\"\\\"\\\"\\n self.config = config\\n if config:\\n self.game_data = get_game_by_field(self.config.game_config_id, \\\"configpath\\\")\\n else:\\n self.game_data = {}\\n\\n def __lt__(self, other):\\n return self.name < other.name\\n\\n @property\\n def description(self):\\n \\\"\\\"\\\"Return the class' docstring as the description.\\\"\\\"\\\"\\n return self.__doc__\\n\\n @description.setter\\n def description(self, value):\\n \\\"\\\"\\\"Leave the ability to override the docstring.\\\"\\\"\\\"\\n self.__doc__ = value # What the shit\\n\\n @property\\n def name(self):\\n return self.__class__.__name__\\n\\n @property\\n def default_config(self):\\n return LutrisConfig(runner_slug=self.name)\\n\\n @property\\n def game_config(self):\\n \\\"\\\"\\\"Return the cascaded game config as a dict.\\\"\\\"\\\"\\n return self.config.game_config if self.config else {}\\n\\n @property\\n def runner_config(self):\\n \\\"\\\"\\\"Return the cascaded runner config as a dict.\\\"\\\"\\\"\\n if self.config:\\n return self.config.runner_config\\n return self.default_config.runner_config\\n\\n @property\\n def system_config(self):\\n \\\"\\\"\\\"Return the cascaded system config as a dict.\\\"\\\"\\\"\\n if self.config:\\n return self.config.system_config\\n return self.default_config.system_config\\n\\n @property\\n def default_path(self):\\n \\\"\\\"\\\"Return the default path where games are installed.\\\"\\\"\\\"\\n return self.system_config.get(\\\"game_path\\\")\\n\\n @property\\n def game_path(self):\\n \\\"\\\"\\\"Return the directory where the game is installed.\\\"\\\"\\\"\\n game_path = self.game_data.get(\\\"directory\\\")\\n if game_path:\\n return game_path\\n\\n # Default to the directory where the entry point is located.\\n entry_point = self.game_config.get(self.entry_point_option)\\n if entry_point:\\n return os.path.dirname(os.path.expanduser(entry_point))\\n return \\\"\\\"\\n\\n @property\\n def library_folders(self):\\n \\\"\\\"\\\"Return a list of paths where a game might be installed\\\"\\\"\\\"\\n return []\\n\\n @property\\n def working_dir(self):\\n \\\"\\\"\\\"Return the working directory to use when running the game.\\\"\\\"\\\"\\n return self.game_path or os.path.expanduser(\\\"~/\\\")\\n\\n @property\\n def discord_client_id(self):\\n if self.game_data.get(\\\"discord_client_id\\\"):\\n return self.game_data.get(\\\"discord_client_id\\\")\\n\\n def get_platform(self):\\n return self.platforms[0]\\n\\n def get_runner_options(self):\\n runner_options = self.runner_options[:]\\n if self.runner_executable:\\n runner_options.append(\\n {\\n \\\"option\\\": \\\"runner_executable\\\",\\n \\\"type\\\": \\\"file\\\",\\n \\\"label\\\": _(\\\"Custom executable for the runner\\\"),\\n \\\"advanced\\\": True,\\n }\\n )\\n return runner_options\\n\\n def get_executable(self):\\n if \\\"runner_executable\\\" in self.runner_config:\\n runner_executable = self.runner_config[\\\"runner_executable\\\"]\\n if os.path.isfile(runner_executable):\\n return runner_executable\\n if not self.runner_executable:\\n raise ValueError(\\\"runner_executable not set for {}\\\".format(self.name))\\n return os.path.join(settings.RUNNER_DIR, self.runner_executable)\\n\\n def get_env(self, os_env=False):\\n \\\"\\\"\\\"Return environment variables used for a game.\\\"\\\"\\\"\\n env = {}\\n if os_env:\\n env.update(os.environ.copy())\\n\\n # By default we'll set NVidia's shader disk cache to be\\n # per-game, so it overflows less readily.\\n env[\\\"__GL_SHADER_DISK_CACHE\\\"] = \\\"1\\\"\\n env[\\\"__GL_SHADER_DISK_CACHE_PATH\\\"] = self.game_path\\n\\n # Override SDL2 controller configuration\\n sdl_gamecontrollerconfig = self.system_config.get(\\\"sdl_gamecontrollerconfig\\\")\\n if sdl_gamecontrollerconfig:\\n path = os.path.expanduser(sdl_gamecontrollerconfig)\\n if system.path_exists(path):\\n with open(path, \\\"r\\\", encoding='utf-8') as controllerdb_file:\\n sdl_gamecontrollerconfig = controllerdb_file.read()\\n env[\\\"SDL_GAMECONTROLLERCONFIG\\\"] = sdl_gamecontrollerconfig\\n\\n # Set monitor to use for SDL 1 games\\n if self.system_config.get(\\\"sdl_video_fullscreen\\\"):\\n env[\\\"SDL_VIDEO_FULLSCREEN_DISPLAY\\\"] = self.system_config[\\\"sdl_video_fullscreen\\\"]\\n\\n # DRI Prime\\n if self.system_config.get(\\\"dri_prime\\\"):\\n env[\\\"DRI_PRIME\\\"] = \\\"1\\\"\\n\\n # Prime vars\\n prime = self.system_config.get(\\\"prime\\\")\\n if prime:\\n env[\\\"__NV_PRIME_RENDER_OFFLOAD\\\"] = \\\"1\\\"\\n env[\\\"__GLX_VENDOR_LIBRARY_NAME\\\"] = \\\"nvidia\\\"\\n env[\\\"__VK_LAYER_NV_optimus\\\"] = \\\"NVIDIA_only\\\"\\n\\n # Set PulseAudio latency to 60ms\\n if self.system_config.get(\\\"pulse_latency\\\"):\\n env[\\\"PULSE_LATENCY_MSEC\\\"] = \\\"60\\\"\\n\\n # Vulkan ICD files\\n vk_icd = self.system_config.get(\\\"vk_icd\\\")\\n if vk_icd:\\n env[\\\"VK_ICD_FILENAMES\\\"] = vk_icd\\n\\n runtime_ld_library_path = None\\n\\n if self.use_runtime():\\n runtime_env = self.get_runtime_env()\\n if \\\"LD_LIBRARY_PATH\\\" in runtime_env:\\n runtime_ld_library_path = runtime_env[\\\"LD_LIBRARY_PATH\\\"]\\n\\n if runtime_ld_library_path:\\n ld_library_path = env.get(\\\"LD_LIBRARY_PATH\\\")\\n if not ld_library_path:\\n ld_library_path = \\\"$LD_LIBRARY_PATH\\\"\\n env[\\\"LD_LIBRARY_PATH\\\"] = \\\":\\\".join([runtime_ld_library_path, ld_library_path])\\n\\n # Apply user overrides at the end\\n env.update(self.system_config.get(\\\"env\\\") or {})\\n\\n return env\\n\\n def get_runtime_env(self):\\n \\\"\\\"\\\"Return runtime environment variables.\\n\\n This method may be overridden in runner classes.\\n (Notably for Lutris wine builds)\\n\\n Returns:\\n dict\\n\\n \\\"\\\"\\\"\\n return runtime.get_env(prefer_system_libs=self.system_config.get(\\\"prefer_system_libs\\\", True))\\n\\n def prelaunch(self):\\n \\\"\\\"\\\"Run actions before running the game, override this method in runners\\\"\\\"\\\"\\n available_libs = set()\\n for lib in set(self.require_libs):\\n if lib in LINUX_SYSTEM.shared_libraries:\\n if self.arch:\\n if self.arch in [_lib.arch for _lib in LINUX_SYSTEM.shared_libraries[lib]]:\\n available_libs.add(lib)\\n else:\\n available_libs.add(lib)\\n unavailable_libs = set(self.require_libs) - available_libs\\n if unavailable_libs:\\n raise UnavailableLibraries(unavailable_libs, self.arch)\\n return True\\n\\n def get_run_data(self):\\n \\\"\\\"\\\"Return dict with command (exe & args list) and env vars (dict).\\n\\n Reimplement in derived runner if need be.\\\"\\\"\\\"\\n return {\\\"command\\\": [self.get_executable()], \\\"env\\\": self.get_env()}\\n\\n def run(self, *args):\\n \\\"\\\"\\\"Run the runner alone.\\\"\\\"\\\"\\n if not self.runnable_alone:\\n return\\n if not self.is_installed():\\n if not self.install_dialog():\\n logger.info(\\\"Runner install cancelled\\\")\\n return\\n\\n command_data = self.get_run_data()\\n command = command_data.get(\\\"command\\\")\\n env = (command_data.get(\\\"env\\\") or {}).copy()\\n\\n if hasattr(self, \\\"prelaunch\\\"):\\n self.prelaunch()\\n\\n command_runner = MonitoredCommand(command, runner=self, env=env)\\n command_runner.start()\\n\\n def use_runtime(self):\\n if runtime.RUNTIME_DISABLED:\\n logger.info(\\\"Runtime disabled by environment\\\")\\n return False\\n if self.system_config.get(\\\"disable_runtime\\\"):\\n logger.info(\\\"Runtime disabled by system configuration\\\")\\n return False\\n return True\\n\\n def install_dialog(self):\\n \\\"\\\"\\\"Ask the user if they want to install the runner.\\n\\n Return success of runner installation.\\n \\\"\\\"\\\"\\n dialog = dialogs.QuestionDialog(\\n {\\n \\\"question\\\": _(\\\"The required runner is not installed.\\\\n\\\"\\n \\\"Do you wish to install it now?\\\"),\\n \\\"title\\\": _(\\\"Required runner unavailable\\\"),\\n }\\n )\\n if Gtk.ResponseType.YES == dialog.result:\\n\\n from lutris.gui.dialogs import ErrorDialog\\n from lutris.gui.dialogs.download import simple_downloader\\n try:\\n if hasattr(self, \\\"get_version\\\"):\\n version = self.get_version(use_default=False) # pylint: disable=no-member\\n self.install(downloader=simple_downloader, version=version)\\n else:\\n self.install(downloader=simple_downloader)\\n except RunnerInstallationError as ex:\\n ErrorDialog(ex.message)\\n\\n return self.is_installed()\\n return False\\n\\n def is_installed(self):\\n \\\"\\\"\\\"Return whether the runner is installed\\\"\\\"\\\"\\n return system.path_exists(self.get_executable())\\n\\n def get_runner_version(self, version=None):\\n \\\"\\\"\\\"Get the appropriate version for a runner\\n\\n Params:\\n version (str): Optional version to lookup, will return this one if found\\n\\n Returns:\\n dict: Dict containing version, architecture and url for the runner, None\\n if the data can't be retrieved.\\n \\\"\\\"\\\"\\n logger.info(\\n \\\"Getting runner information for %s%s\\\",\\n self.name,\\n \\\" (version: %s)\\\" % version if version else \\\"\\\",\\n )\\n\\n try:\\n request = Request(\\\"{}/api/runners/{}\\\".format(settings.SITE_URL, self.name))\\n runner_info = request.get().json\\n\\n if not runner_info:\\n logger.error(\\\"Failed to get runner information\\\")\\n except HTTPError as ex:\\n logger.error(\\\"Unable to get runner information: %s\\\", ex)\\n runner_info = None\\n\\n if not runner_info:\\n return\\n\\n versions = runner_info.get(\\\"versions\\\") or []\\n arch = LINUX_SYSTEM.arch\\n if version:\\n if version.endswith(\\\"-i386\\\") or version.endswith(\\\"-x86_64\\\"):\\n version, arch = version.rsplit(\\\"-\\\", 1)\\n versions = [v for v in versions if v[\\\"version\\\"] == version]\\n versions_for_arch = [v for v in versions if v[\\\"architecture\\\"] == arch]\\n if len(versions_for_arch) == 1:\\n return versions_for_arch[0]\\n\\n if len(versions_for_arch) > 1:\\n default_version = [v for v in versions_for_arch if v[\\\"default\\\"] is True]\\n if default_version:\\n return default_version[0]\\n elif len(versions) == 1 and LINUX_SYSTEM.is_64_bit:\\n return versions[0]\\n elif len(versions) > 1 and LINUX_SYSTEM.is_64_bit:\\n default_version = [v for v in versions if v[\\\"default\\\"] is True]\\n if default_version:\\n return default_version[0]\\n # If we didn't find a proper version yet, return the first available.\\n if len(versions_for_arch) >= 1:\\n return versions_for_arch[0]\\n\\n def install(self, version=None, downloader=None, callback=None):\\n \\\"\\\"\\\"Install runner using package management systems.\\\"\\\"\\\"\\n logger.debug(\\n \\\"Installing %s (version=%s, downloader=%s, callback=%s)\\\",\\n self.name,\\n version,\\n downloader,\\n callback,\\n )\\n opts = {\\\"downloader\\\": downloader, \\\"callback\\\": callback}\\n if self.download_url:\\n opts[\\\"dest\\\"] = os.path.join(settings.RUNNER_DIR, self.name)\\n return self.download_and_extract(self.download_url, **opts)\\n runner = self.get_runner_version(version)\\n if not runner:\\n raise RunnerInstallationError(\\\"Failed to retrieve {} ({}) information\\\".format(self.name, version))\\n if not downloader:\\n raise RuntimeError(\\\"Missing mandatory downloader for runner %s\\\" % self)\\n\\n if \\\"wine\\\" in self.name:\\n opts[\\\"merge_single\\\"] = True\\n opts[\\\"dest\\\"] = os.path.join(\\n settings.RUNNER_DIR, self.name, \\\"{}-{}\\\".format(runner[\\\"version\\\"], runner[\\\"architecture\\\"])\\n )\\n\\n if self.name == \\\"libretro\\\" and version:\\n opts[\\\"merge_single\\\"] = False\\n opts[\\\"dest\\\"] = os.path.join(settings.RUNNER_DIR, \\\"retroarch/cores\\\")\\n self.download_and_extract(runner[\\\"url\\\"], **opts)\\n\\n def download_and_extract(self, url, dest=None, **opts):\\n downloader = opts[\\\"downloader\\\"]\\n merge_single = opts.get(\\\"merge_single\\\", False)\\n callback = opts.get(\\\"callback\\\")\\n tarball_filename = os.path.basename(url)\\n runner_archive = os.path.join(settings.CACHE_DIR, tarball_filename)\\n if not dest:\\n dest = settings.RUNNER_DIR\\n downloader(\\n url, runner_archive, self.extract, {\\n \\\"archive\\\": runner_archive,\\n \\\"dest\\\": dest,\\n \\\"merge_single\\\": merge_single,\\n \\\"callback\\\": callback,\\n }\\n )\\n\\n def extract(self, archive=None, dest=None, merge_single=None, callback=None):\\n if not system.path_exists(archive):\\n raise RunnerInstallationError(\\\"Failed to extract {}\\\".format(archive))\\n try:\\n extract_archive(archive, dest, merge_single=merge_single)\\n except ExtractFailure as ex:\\n logger.error(\\\"Failed to extract the archive %s file may be corrupt\\\", archive)\\n raise RunnerInstallationError(\\\"Failed to extract {}: {}\\\".format(archive, ex)) from ex\\n os.remove(archive)\\n\\n if self.name == \\\"wine\\\":\\n logger.debug(\\\"Clearing wine version cache\\\")\\n from lutris.util.wine.wine import get_wine_versions\\n get_wine_versions.cache_clear()\\n\\n if callback:\\n callback()\\n\\n @staticmethod\\n def remove_game_data(app_id=None, game_path=None):\\n system.remove_folder(game_path)\\n\\n def can_uninstall(self):\\n runner_path = os.path.join(settings.RUNNER_DIR, self.name)\\n return os.path.isdir(runner_path)\\n\\n def uninstall(self):\\n runner_path = os.path.join(settings.RUNNER_DIR, self.name)\\n if os.path.isdir(runner_path):\\n system.remove_folder(runner_path)\\n\\n def find_option(self, options_group, option_name):\\n \\\"\\\"\\\"Retrieve an option dict if it exists in the group\\\"\\\"\\\"\\n if options_group not in ['game_options', 'runner_options']:\\n return None\\n output = None\\n for item in getattr(self, options_group):\\n if item[\\\"option\\\"] == option_name:\\n output = item\\n break\\n return output\\n\",\n \"path\": \"lutris/runners/runner.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"\"\"\"Base module for runners\"\"\"\nimport os\nfrom gettext import gettext as _\n\nfrom gi.repository import Gtk\n\nfrom lutris import runtime, settings\nfrom lutris.command import MonitoredCommand\nfrom lutris.config import LutrisConfig\nfrom lutris.database.games import get_game_by_field\nfrom lutris.exceptions import UnavailableLibraries\nfrom lutris.gui import dialogs\nfrom lutris.runners import RunnerInstallationError\nfrom lutris.util import system\nfrom lutris.util.extract import ExtractFailure, extract_archive\nfrom lutris.util.http import HTTPError, Request\nfrom lutris.util.linux import LINUX_SYSTEM\nfrom lutris.util.log import logger\n\n\nclass Runner: # pylint: disable=too-many-public-methods\n\n \"\"\"Generic runner (base class for other runners).\"\"\"\n\n multiple_versions = False\n platforms = []\n runnable_alone = False\n game_options = []\n runner_options = []\n system_options_override = []\n context_menu_entries = []\n require_libs = []\n runner_executable = None\n entry_point_option = \"main_file\"\n download_url = None\n arch = None # If the runner is only available for an architecture that isn't x86_64\n\n def __init__(self, config=None):\n \"\"\"Initialize runner.\"\"\"\n self.config = config\n if config:\n self.game_data = get_game_by_field(self.config.game_config_id, \"configpath\")\n else:\n self.game_data = {}\n\n def __lt__(self, other):\n return self.name < other.name\n\n @property\n def description(self):\n \"\"\"Return the class' docstring as the description.\"\"\"\n return self.__doc__\n\n @description.setter\n def description(self, value):\n \"\"\"Leave the ability to override the docstring.\"\"\"\n self.__doc__ = value # What the shit\n\n @property\n def name(self):\n return self.__class__.__name__\n\n @property\n def default_config(self):\n return LutrisConfig(runner_slug=self.name)\n\n @property\n def game_config(self):\n \"\"\"Return the cascaded game config as a dict.\"\"\"\n return self.config.game_config if self.config else {}\n\n @property\n def runner_config(self):\n \"\"\"Return the cascaded runner config as a dict.\"\"\"\n if self.config:\n return self.config.runner_config\n return self.default_config.runner_config\n\n @property\n def system_config(self):\n \"\"\"Return the cascaded system config as a dict.\"\"\"\n if self.config:\n return self.config.system_config\n return self.default_config.system_config\n\n @property\n def default_path(self):\n \"\"\"Return the default path where games are installed.\"\"\"\n return self.system_config.get(\"game_path\")\n\n @property\n def game_path(self):\n \"\"\"Return the directory where the game is installed.\"\"\"\n game_path = self.game_data.get(\"directory\")\n if game_path:\n return game_path\n\n # Default to the directory where the entry point is located.\n entry_point = self.game_config.get(self.entry_point_option)\n if entry_point:\n return os.path.dirname(os.path.expanduser(entry_point))\n return \"\"\n\n @property\n def library_folders(self):\n \"\"\"Return a list of paths where a game might be installed\"\"\"\n return []\n\n @property\n def working_dir(self):\n \"\"\"Return the working directory to use when running the game.\"\"\"\n return self.game_path or os.path.expanduser(\"~/\")\n\n @property\n def discord_client_id(self):\n if self.game_data.get(\"discord_client_id\"):\n return self.game_data.get(\"discord_client_id\")\n\n def get_platform(self):\n return self.platforms[0]\n\n def get_runner_options(self):\n runner_options = self.runner_options[:]\n if self.runner_executable:\n runner_options.append(\n {\n \"option\": \"runner_executable\",\n \"type\": \"file\",\n \"label\": _(\"Custom executable for the runner\"),\n \"advanced\": True,\n }\n )\n return runner_options\n\n def get_executable(self):\n if \"runner_executable\" in self.runner_config:\n runner_executable = self.runner_config[\"runner_executable\"]\n if os.path.isfile(runner_executable):\n return runner_executable\n if not self.runner_executable:\n raise ValueError(\"runner_executable not set for {}\".format(self.name))\n return os.path.join(settings.RUNNER_DIR, self.runner_executable)\n\n def get_env(self, os_env=False):\n \"\"\"Return environment variables used for a game.\"\"\"\n env = {}\n if os_env:\n env.update(os.environ.copy())\n\n # By default we'll set NVidia's shader disk cache to be\n # per-game, so it overflows less readily.\n env[\"__GL_SHADER_DISK_CACHE\"] = \"1\"\n env[\"__GL_SHADER_DISK_CACHE_PATH\"] = self.game_path\n\n # Override SDL2 controller configuration\n sdl_gamecontrollerconfig = self.system_config.get(\"sdl_gamecontrollerconfig\")\n if sdl_gamecontrollerconfig:\n path = os.path.expanduser(sdl_gamecontrollerconfig)\n if system.path_exists(path):\n with open(path, \"r\", encoding='utf-8') as controllerdb_file:\n sdl_gamecontrollerconfig = controllerdb_file.read()\n env[\"SDL_GAMECONTROLLERCONFIG\"] = sdl_gamecontrollerconfig\n\n # Set monitor to use for SDL 1 games\n if self.system_config.get(\"sdl_video_fullscreen\"):\n env[\"SDL_VIDEO_FULLSCREEN_DISPLAY\"] = self.system_config[\"sdl_video_fullscreen\"]\n\n # DRI Prime\n if self.system_config.get(\"dri_prime\"):\n env[\"DRI_PRIME\"] = \"1\"\n\n # Prime vars\n prime = self.system_config.get(\"prime\")\n if prime:\n env[\"__NV_PRIME_RENDER_OFFLOAD\"] = \"1\"\n env[\"__GLX_VENDOR_LIBRARY_NAME\"] = \"nvidia\"\n env[\"__VK_LAYER_NV_optimus\"] = \"NVIDIA_only\"\n\n # Set PulseAudio latency to 60ms\n if self.system_config.get(\"pulse_latency\"):\n env[\"PULSE_LATENCY_MSEC\"] = \"60\"\n\n # Vulkan ICD files\n vk_icd = self.system_config.get(\"vk_icd\")\n if vk_icd:\n env[\"VK_ICD_FILENAMES\"] = vk_icd\n\n runtime_ld_library_path = None\n\n if self.use_runtime():\n runtime_env = self.get_runtime_env()\n if \"LD_LIBRARY_PATH\" in runtime_env:\n runtime_ld_library_path = runtime_env[\"LD_LIBRARY_PATH\"]\n\n if runtime_ld_library_path:\n ld_library_path = env.get(\"LD_LIBRARY_PATH\")\n if not ld_library_path:\n ld_library_path = \"$LD_LIBRARY_PATH\"\n env[\"LD_LIBRARY_PATH\"] = \":\".join([runtime_ld_library_path, ld_library_path])\n\n # Apply user overrides at the end\n env.update(self.system_config.get(\"env\") or {})\n\n return env\n\n def get_runtime_env(self):\n \"\"\"Return runtime environment variables.\n\n This method may be overridden in runner classes.\n (Notably for Lutris wine builds)\n\n Returns:\n dict\n\n \"\"\"\n return runtime.get_env(prefer_system_libs=self.system_config.get(\"prefer_system_libs\", True))\n\n def prelaunch(self):\n \"\"\"Run actions before running the game, override this method in runners\"\"\"\n available_libs = set()\n for lib in set(self.require_libs):\n if lib in LINUX_SYSTEM.shared_libraries:\n if self.arch:\n if self.arch in [_lib.arch for _lib in LINUX_SYSTEM.shared_libraries[lib]]:\n available_libs.add(lib)\n else:\n available_libs.add(lib)\n unavailable_libs = set(self.require_libs) - available_libs\n if unavailable_libs:\n raise UnavailableLibraries(unavailable_libs, self.arch)\n return True\n\n def get_run_data(self):\n \"\"\"Return dict with command (exe & args list) and env vars (dict).\n\n Reimplement in derived runner if need be.\"\"\"\n return {\"command\": [self.get_executable()], \"env\": self.get_env()}\n\n def run(self, *args):\n \"\"\"Run the runner alone.\"\"\"\n if not self.runnable_alone:\n return\n if not self.is_installed():\n if not self.install_dialog():\n logger.info(\"Runner install cancelled\")\n return\n\n command_data = self.get_run_data()\n command = command_data.get(\"command\")\n env = (command_data.get(\"env\") or {}).copy()\n\n if hasattr(self, \"prelaunch\"):\n self.prelaunch()\n\n command_runner = MonitoredCommand(command, runner=self, env=env)\n command_runner.start()\n\n def use_runtime(self):\n if runtime.RUNTIME_DISABLED:\n logger.info(\"Runtime disabled by environment\")\n return False\n if self.system_config.get(\"disable_runtime\"):\n logger.info(\"Runtime disabled by system configuration\")\n return False\n return True\n\n def install_dialog(self):\n \"\"\"Ask the user if they want to install the runner.\n\n Return success of runner installation.\n \"\"\"\n dialog = dialogs.QuestionDialog(\n {\n \"question\": _(\"The required runner is not installed.\\n\"\n \"Do you wish to install it now?\"),\n \"title\": _(\"Required runner unavailable\"),\n }\n )\n if Gtk.ResponseType.YES == dialog.result:\n\n from lutris.gui.dialogs import ErrorDialog\n from lutris.gui.dialogs.download import simple_downloader\n try:\n if hasattr(self, \"get_version\"):\n version = self.get_version(use_default=False) # pylint: disable=no-member\n self.install(downloader=simple_downloader, version=version)\n else:\n self.install(downloader=simple_downloader)\n except RunnerInstallationError as ex:\n ErrorDialog(ex.message)\n\n return self.is_installed()\n return False\n\n def is_installed(self):\n \"\"\"Return whether the runner is installed\"\"\"\n return system.path_exists(self.get_executable())\n\n def get_runner_version(self, version=None):\n \"\"\"Get the appropriate version for a runner\n\n Params:\n version (str): Optional version to lookup, will return this one if found\n\n Returns:\n dict: Dict containing version, architecture and url for the runner, None\n if the data can't be retrieved.\n \"\"\"\n logger.info(\n \"Getting runner information for %s%s\",\n self.name,\n \" (version: %s)\" % version if version else \"\",\n )\n\n try:\n request = Request(\"{}/api/runners/{}\".format(settings.SITE_URL, self.name))\n runner_info = request.get().json\n\n if not runner_info:\n logger.error(\"Failed to get runner information\")\n except HTTPError as ex:\n logger.error(\"Unable to get runner information: %s\", ex)\n runner_info = None\n\n if not runner_info:\n return\n\n versions = runner_info.get(\"versions\") or []\n arch = LINUX_SYSTEM.arch\n if version:\n if version.endswith(\"-i386\") or version.endswith(\"-x86_64\"):\n version, arch = version.rsplit(\"-\", 1)\n versions = [v for v in versions if v[\"version\"] == version]\n versions_for_arch = [v for v in versions if v[\"architecture\"] == arch]\n if len(versions_for_arch) == 1:\n return versions_for_arch[0]\n\n if len(versions_for_arch) > 1:\n default_version = [v for v in versions_for_arch if v[\"default\"] is True]\n if default_version:\n return default_version[0]\n elif len(versions) == 1 and LINUX_SYSTEM.is_64_bit:\n return versions[0]\n elif len(versions) > 1 and LINUX_SYSTEM.is_64_bit:\n default_version = [v for v in versions if v[\"default\"] is True]\n if default_version:\n return default_version[0]\n # If we didn't find a proper version yet, return the first available.\n if len(versions_for_arch) >= 1:\n return versions_for_arch[0]\n\n def install(self, version=None, downloader=None, callback=None):\n \"\"\"Install runner using package management systems.\"\"\"\n logger.debug(\n \"Installing %s (version=%s, downloader=%s, callback=%s)\",\n self.name,\n version,\n downloader,\n callback,\n )\n opts = {\"downloader\": downloader, \"callback\": callback}\n if self.download_url:\n opts[\"dest\"] = os.path.join(settings.RUNNER_DIR, self.name)\n return self.download_and_extract(self.download_url, **opts)\n runner = self.get_runner_version(version)\n if not runner:\n raise RunnerInstallationError(\"Failed to retrieve {} ({}) information\".format(self.name, version))\n if not downloader:\n raise RuntimeError(\"Missing mandatory downloader for runner %s\" % self)\n\n if \"wine\" in self.name:\n opts[\"merge_single\"] = True\n opts[\"dest\"] = os.path.join(\n settings.RUNNER_DIR, self.name, \"{}-{}\".format(runner[\"version\"], runner[\"architecture\"])\n )\n\n if self.name == \"libretro\" and version:\n opts[\"merge_single\"] = False\n opts[\"dest\"] = os.path.join(settings.RUNNER_DIR, \"retroarch/cores\")\n self.download_and_extract(runner[\"url\"], **opts)\n\n def download_and_extract(self, url, dest=None, **opts):\n downloader = opts[\"downloader\"]\n merge_single = opts.get(\"merge_single\", False)\n callback = opts.get(\"callback\")\n tarball_filename = os.path.basename(url)\n runner_archive = os.path.join(settings.CACHE_DIR, tarball_filename)\n if not dest:\n dest = settings.RUNNER_DIR\n downloader(\n url, runner_archive, self.extract, {\n \"archive\": runner_archive,\n \"dest\": dest,\n \"merge_single\": merge_single,\n \"callback\": callback,\n }\n )\n\n def extract(self, archive=None, dest=None, merge_single=None, callback=None):\n if not system.path_exists(archive):\n raise RunnerInstallationError(\"Failed to extract {}\".format(archive))\n try:\n extract_archive(archive, dest, merge_single=merge_single)\n except ExtractFailure as ex:\n logger.error(\"Failed to extract the archive %s file may be corrupt\", archive)\n raise RunnerInstallationError(\"Failed to extract {}: {}\".format(archive, ex)) from ex\n os.remove(archive)\n\n if self.name == \"wine\":\n logger.debug(\"Clearing wine version cache\")\n from lutris.util.wine.wine import get_wine_versions\n get_wine_versions.cache_clear()\n\n if self.runner_executable:\n runner_executable = os.path.join(settings.RUNNER_DIR, self.runner_executable)\n if os.path.isfile(runner_executable):\n system.make_executable(runner_executable)\n\n if callback:\n callback()\n\n @staticmethod\n def remove_game_data(app_id=None, game_path=None):\n system.remove_folder(game_path)\n\n def can_uninstall(self):\n runner_path = os.path.join(settings.RUNNER_DIR, self.name)\n return os.path.isdir(runner_path)\n\n def uninstall(self):\n runner_path = os.path.join(settings.RUNNER_DIR, self.name)\n if os.path.isdir(runner_path):\n system.remove_folder(runner_path)\n\n def find_option(self, options_group, option_name):\n \"\"\"Retrieve an option dict if it exists in the group\"\"\"\n if options_group not in ['game_options', 'runner_options']:\n return None\n output = None\n for item in getattr(self, options_group):\n if item[\"option\"] == option_name:\n output = item\n break\n return output\n","path":"lutris/runners/runner.py"}],"string":"[\n {\n \"content\": \"\\\"\\\"\\\"Base module for runners\\\"\\\"\\\"\\nimport os\\nfrom gettext import gettext as _\\n\\nfrom gi.repository import Gtk\\n\\nfrom lutris import runtime, settings\\nfrom lutris.command import MonitoredCommand\\nfrom lutris.config import LutrisConfig\\nfrom lutris.database.games import get_game_by_field\\nfrom lutris.exceptions import UnavailableLibraries\\nfrom lutris.gui import dialogs\\nfrom lutris.runners import RunnerInstallationError\\nfrom lutris.util import system\\nfrom lutris.util.extract import ExtractFailure, extract_archive\\nfrom lutris.util.http import HTTPError, Request\\nfrom lutris.util.linux import LINUX_SYSTEM\\nfrom lutris.util.log import logger\\n\\n\\nclass Runner: # pylint: disable=too-many-public-methods\\n\\n \\\"\\\"\\\"Generic runner (base class for other runners).\\\"\\\"\\\"\\n\\n multiple_versions = False\\n platforms = []\\n runnable_alone = False\\n game_options = []\\n runner_options = []\\n system_options_override = []\\n context_menu_entries = []\\n require_libs = []\\n runner_executable = None\\n entry_point_option = \\\"main_file\\\"\\n download_url = None\\n arch = None # If the runner is only available for an architecture that isn't x86_64\\n\\n def __init__(self, config=None):\\n \\\"\\\"\\\"Initialize runner.\\\"\\\"\\\"\\n self.config = config\\n if config:\\n self.game_data = get_game_by_field(self.config.game_config_id, \\\"configpath\\\")\\n else:\\n self.game_data = {}\\n\\n def __lt__(self, other):\\n return self.name < other.name\\n\\n @property\\n def description(self):\\n \\\"\\\"\\\"Return the class' docstring as the description.\\\"\\\"\\\"\\n return self.__doc__\\n\\n @description.setter\\n def description(self, value):\\n \\\"\\\"\\\"Leave the ability to override the docstring.\\\"\\\"\\\"\\n self.__doc__ = value # What the shit\\n\\n @property\\n def name(self):\\n return self.__class__.__name__\\n\\n @property\\n def default_config(self):\\n return LutrisConfig(runner_slug=self.name)\\n\\n @property\\n def game_config(self):\\n \\\"\\\"\\\"Return the cascaded game config as a dict.\\\"\\\"\\\"\\n return self.config.game_config if self.config else {}\\n\\n @property\\n def runner_config(self):\\n \\\"\\\"\\\"Return the cascaded runner config as a dict.\\\"\\\"\\\"\\n if self.config:\\n return self.config.runner_config\\n return self.default_config.runner_config\\n\\n @property\\n def system_config(self):\\n \\\"\\\"\\\"Return the cascaded system config as a dict.\\\"\\\"\\\"\\n if self.config:\\n return self.config.system_config\\n return self.default_config.system_config\\n\\n @property\\n def default_path(self):\\n \\\"\\\"\\\"Return the default path where games are installed.\\\"\\\"\\\"\\n return self.system_config.get(\\\"game_path\\\")\\n\\n @property\\n def game_path(self):\\n \\\"\\\"\\\"Return the directory where the game is installed.\\\"\\\"\\\"\\n game_path = self.game_data.get(\\\"directory\\\")\\n if game_path:\\n return game_path\\n\\n # Default to the directory where the entry point is located.\\n entry_point = self.game_config.get(self.entry_point_option)\\n if entry_point:\\n return os.path.dirname(os.path.expanduser(entry_point))\\n return \\\"\\\"\\n\\n @property\\n def library_folders(self):\\n \\\"\\\"\\\"Return a list of paths where a game might be installed\\\"\\\"\\\"\\n return []\\n\\n @property\\n def working_dir(self):\\n \\\"\\\"\\\"Return the working directory to use when running the game.\\\"\\\"\\\"\\n return self.game_path or os.path.expanduser(\\\"~/\\\")\\n\\n @property\\n def discord_client_id(self):\\n if self.game_data.get(\\\"discord_client_id\\\"):\\n return self.game_data.get(\\\"discord_client_id\\\")\\n\\n def get_platform(self):\\n return self.platforms[0]\\n\\n def get_runner_options(self):\\n runner_options = self.runner_options[:]\\n if self.runner_executable:\\n runner_options.append(\\n {\\n \\\"option\\\": \\\"runner_executable\\\",\\n \\\"type\\\": \\\"file\\\",\\n \\\"label\\\": _(\\\"Custom executable for the runner\\\"),\\n \\\"advanced\\\": True,\\n }\\n )\\n return runner_options\\n\\n def get_executable(self):\\n if \\\"runner_executable\\\" in self.runner_config:\\n runner_executable = self.runner_config[\\\"runner_executable\\\"]\\n if os.path.isfile(runner_executable):\\n return runner_executable\\n if not self.runner_executable:\\n raise ValueError(\\\"runner_executable not set for {}\\\".format(self.name))\\n return os.path.join(settings.RUNNER_DIR, self.runner_executable)\\n\\n def get_env(self, os_env=False):\\n \\\"\\\"\\\"Return environment variables used for a game.\\\"\\\"\\\"\\n env = {}\\n if os_env:\\n env.update(os.environ.copy())\\n\\n # By default we'll set NVidia's shader disk cache to be\\n # per-game, so it overflows less readily.\\n env[\\\"__GL_SHADER_DISK_CACHE\\\"] = \\\"1\\\"\\n env[\\\"__GL_SHADER_DISK_CACHE_PATH\\\"] = self.game_path\\n\\n # Override SDL2 controller configuration\\n sdl_gamecontrollerconfig = self.system_config.get(\\\"sdl_gamecontrollerconfig\\\")\\n if sdl_gamecontrollerconfig:\\n path = os.path.expanduser(sdl_gamecontrollerconfig)\\n if system.path_exists(path):\\n with open(path, \\\"r\\\", encoding='utf-8') as controllerdb_file:\\n sdl_gamecontrollerconfig = controllerdb_file.read()\\n env[\\\"SDL_GAMECONTROLLERCONFIG\\\"] = sdl_gamecontrollerconfig\\n\\n # Set monitor to use for SDL 1 games\\n if self.system_config.get(\\\"sdl_video_fullscreen\\\"):\\n env[\\\"SDL_VIDEO_FULLSCREEN_DISPLAY\\\"] = self.system_config[\\\"sdl_video_fullscreen\\\"]\\n\\n # DRI Prime\\n if self.system_config.get(\\\"dri_prime\\\"):\\n env[\\\"DRI_PRIME\\\"] = \\\"1\\\"\\n\\n # Prime vars\\n prime = self.system_config.get(\\\"prime\\\")\\n if prime:\\n env[\\\"__NV_PRIME_RENDER_OFFLOAD\\\"] = \\\"1\\\"\\n env[\\\"__GLX_VENDOR_LIBRARY_NAME\\\"] = \\\"nvidia\\\"\\n env[\\\"__VK_LAYER_NV_optimus\\\"] = \\\"NVIDIA_only\\\"\\n\\n # Set PulseAudio latency to 60ms\\n if self.system_config.get(\\\"pulse_latency\\\"):\\n env[\\\"PULSE_LATENCY_MSEC\\\"] = \\\"60\\\"\\n\\n # Vulkan ICD files\\n vk_icd = self.system_config.get(\\\"vk_icd\\\")\\n if vk_icd:\\n env[\\\"VK_ICD_FILENAMES\\\"] = vk_icd\\n\\n runtime_ld_library_path = None\\n\\n if self.use_runtime():\\n runtime_env = self.get_runtime_env()\\n if \\\"LD_LIBRARY_PATH\\\" in runtime_env:\\n runtime_ld_library_path = runtime_env[\\\"LD_LIBRARY_PATH\\\"]\\n\\n if runtime_ld_library_path:\\n ld_library_path = env.get(\\\"LD_LIBRARY_PATH\\\")\\n if not ld_library_path:\\n ld_library_path = \\\"$LD_LIBRARY_PATH\\\"\\n env[\\\"LD_LIBRARY_PATH\\\"] = \\\":\\\".join([runtime_ld_library_path, ld_library_path])\\n\\n # Apply user overrides at the end\\n env.update(self.system_config.get(\\\"env\\\") or {})\\n\\n return env\\n\\n def get_runtime_env(self):\\n \\\"\\\"\\\"Return runtime environment variables.\\n\\n This method may be overridden in runner classes.\\n (Notably for Lutris wine builds)\\n\\n Returns:\\n dict\\n\\n \\\"\\\"\\\"\\n return runtime.get_env(prefer_system_libs=self.system_config.get(\\\"prefer_system_libs\\\", True))\\n\\n def prelaunch(self):\\n \\\"\\\"\\\"Run actions before running the game, override this method in runners\\\"\\\"\\\"\\n available_libs = set()\\n for lib in set(self.require_libs):\\n if lib in LINUX_SYSTEM.shared_libraries:\\n if self.arch:\\n if self.arch in [_lib.arch for _lib in LINUX_SYSTEM.shared_libraries[lib]]:\\n available_libs.add(lib)\\n else:\\n available_libs.add(lib)\\n unavailable_libs = set(self.require_libs) - available_libs\\n if unavailable_libs:\\n raise UnavailableLibraries(unavailable_libs, self.arch)\\n return True\\n\\n def get_run_data(self):\\n \\\"\\\"\\\"Return dict with command (exe & args list) and env vars (dict).\\n\\n Reimplement in derived runner if need be.\\\"\\\"\\\"\\n return {\\\"command\\\": [self.get_executable()], \\\"env\\\": self.get_env()}\\n\\n def run(self, *args):\\n \\\"\\\"\\\"Run the runner alone.\\\"\\\"\\\"\\n if not self.runnable_alone:\\n return\\n if not self.is_installed():\\n if not self.install_dialog():\\n logger.info(\\\"Runner install cancelled\\\")\\n return\\n\\n command_data = self.get_run_data()\\n command = command_data.get(\\\"command\\\")\\n env = (command_data.get(\\\"env\\\") or {}).copy()\\n\\n if hasattr(self, \\\"prelaunch\\\"):\\n self.prelaunch()\\n\\n command_runner = MonitoredCommand(command, runner=self, env=env)\\n command_runner.start()\\n\\n def use_runtime(self):\\n if runtime.RUNTIME_DISABLED:\\n logger.info(\\\"Runtime disabled by environment\\\")\\n return False\\n if self.system_config.get(\\\"disable_runtime\\\"):\\n logger.info(\\\"Runtime disabled by system configuration\\\")\\n return False\\n return True\\n\\n def install_dialog(self):\\n \\\"\\\"\\\"Ask the user if they want to install the runner.\\n\\n Return success of runner installation.\\n \\\"\\\"\\\"\\n dialog = dialogs.QuestionDialog(\\n {\\n \\\"question\\\": _(\\\"The required runner is not installed.\\\\n\\\"\\n \\\"Do you wish to install it now?\\\"),\\n \\\"title\\\": _(\\\"Required runner unavailable\\\"),\\n }\\n )\\n if Gtk.ResponseType.YES == dialog.result:\\n\\n from lutris.gui.dialogs import ErrorDialog\\n from lutris.gui.dialogs.download import simple_downloader\\n try:\\n if hasattr(self, \\\"get_version\\\"):\\n version = self.get_version(use_default=False) # pylint: disable=no-member\\n self.install(downloader=simple_downloader, version=version)\\n else:\\n self.install(downloader=simple_downloader)\\n except RunnerInstallationError as ex:\\n ErrorDialog(ex.message)\\n\\n return self.is_installed()\\n return False\\n\\n def is_installed(self):\\n \\\"\\\"\\\"Return whether the runner is installed\\\"\\\"\\\"\\n return system.path_exists(self.get_executable())\\n\\n def get_runner_version(self, version=None):\\n \\\"\\\"\\\"Get the appropriate version for a runner\\n\\n Params:\\n version (str): Optional version to lookup, will return this one if found\\n\\n Returns:\\n dict: Dict containing version, architecture and url for the runner, None\\n if the data can't be retrieved.\\n \\\"\\\"\\\"\\n logger.info(\\n \\\"Getting runner information for %s%s\\\",\\n self.name,\\n \\\" (version: %s)\\\" % version if version else \\\"\\\",\\n )\\n\\n try:\\n request = Request(\\\"{}/api/runners/{}\\\".format(settings.SITE_URL, self.name))\\n runner_info = request.get().json\\n\\n if not runner_info:\\n logger.error(\\\"Failed to get runner information\\\")\\n except HTTPError as ex:\\n logger.error(\\\"Unable to get runner information: %s\\\", ex)\\n runner_info = None\\n\\n if not runner_info:\\n return\\n\\n versions = runner_info.get(\\\"versions\\\") or []\\n arch = LINUX_SYSTEM.arch\\n if version:\\n if version.endswith(\\\"-i386\\\") or version.endswith(\\\"-x86_64\\\"):\\n version, arch = version.rsplit(\\\"-\\\", 1)\\n versions = [v for v in versions if v[\\\"version\\\"] == version]\\n versions_for_arch = [v for v in versions if v[\\\"architecture\\\"] == arch]\\n if len(versions_for_arch) == 1:\\n return versions_for_arch[0]\\n\\n if len(versions_for_arch) > 1:\\n default_version = [v for v in versions_for_arch if v[\\\"default\\\"] is True]\\n if default_version:\\n return default_version[0]\\n elif len(versions) == 1 and LINUX_SYSTEM.is_64_bit:\\n return versions[0]\\n elif len(versions) > 1 and LINUX_SYSTEM.is_64_bit:\\n default_version = [v for v in versions if v[\\\"default\\\"] is True]\\n if default_version:\\n return default_version[0]\\n # If we didn't find a proper version yet, return the first available.\\n if len(versions_for_arch) >= 1:\\n return versions_for_arch[0]\\n\\n def install(self, version=None, downloader=None, callback=None):\\n \\\"\\\"\\\"Install runner using package management systems.\\\"\\\"\\\"\\n logger.debug(\\n \\\"Installing %s (version=%s, downloader=%s, callback=%s)\\\",\\n self.name,\\n version,\\n downloader,\\n callback,\\n )\\n opts = {\\\"downloader\\\": downloader, \\\"callback\\\": callback}\\n if self.download_url:\\n opts[\\\"dest\\\"] = os.path.join(settings.RUNNER_DIR, self.name)\\n return self.download_and_extract(self.download_url, **opts)\\n runner = self.get_runner_version(version)\\n if not runner:\\n raise RunnerInstallationError(\\\"Failed to retrieve {} ({}) information\\\".format(self.name, version))\\n if not downloader:\\n raise RuntimeError(\\\"Missing mandatory downloader for runner %s\\\" % self)\\n\\n if \\\"wine\\\" in self.name:\\n opts[\\\"merge_single\\\"] = True\\n opts[\\\"dest\\\"] = os.path.join(\\n settings.RUNNER_DIR, self.name, \\\"{}-{}\\\".format(runner[\\\"version\\\"], runner[\\\"architecture\\\"])\\n )\\n\\n if self.name == \\\"libretro\\\" and version:\\n opts[\\\"merge_single\\\"] = False\\n opts[\\\"dest\\\"] = os.path.join(settings.RUNNER_DIR, \\\"retroarch/cores\\\")\\n self.download_and_extract(runner[\\\"url\\\"], **opts)\\n\\n def download_and_extract(self, url, dest=None, **opts):\\n downloader = opts[\\\"downloader\\\"]\\n merge_single = opts.get(\\\"merge_single\\\", False)\\n callback = opts.get(\\\"callback\\\")\\n tarball_filename = os.path.basename(url)\\n runner_archive = os.path.join(settings.CACHE_DIR, tarball_filename)\\n if not dest:\\n dest = settings.RUNNER_DIR\\n downloader(\\n url, runner_archive, self.extract, {\\n \\\"archive\\\": runner_archive,\\n \\\"dest\\\": dest,\\n \\\"merge_single\\\": merge_single,\\n \\\"callback\\\": callback,\\n }\\n )\\n\\n def extract(self, archive=None, dest=None, merge_single=None, callback=None):\\n if not system.path_exists(archive):\\n raise RunnerInstallationError(\\\"Failed to extract {}\\\".format(archive))\\n try:\\n extract_archive(archive, dest, merge_single=merge_single)\\n except ExtractFailure as ex:\\n logger.error(\\\"Failed to extract the archive %s file may be corrupt\\\", archive)\\n raise RunnerInstallationError(\\\"Failed to extract {}: {}\\\".format(archive, ex)) from ex\\n os.remove(archive)\\n\\n if self.name == \\\"wine\\\":\\n logger.debug(\\\"Clearing wine version cache\\\")\\n from lutris.util.wine.wine import get_wine_versions\\n get_wine_versions.cache_clear()\\n\\n if self.runner_executable:\\n runner_executable = os.path.join(settings.RUNNER_DIR, self.runner_executable)\\n if os.path.isfile(runner_executable):\\n system.make_executable(runner_executable)\\n\\n if callback:\\n callback()\\n\\n @staticmethod\\n def remove_game_data(app_id=None, game_path=None):\\n system.remove_folder(game_path)\\n\\n def can_uninstall(self):\\n runner_path = os.path.join(settings.RUNNER_DIR, self.name)\\n return os.path.isdir(runner_path)\\n\\n def uninstall(self):\\n runner_path = os.path.join(settings.RUNNER_DIR, self.name)\\n if os.path.isdir(runner_path):\\n system.remove_folder(runner_path)\\n\\n def find_option(self, options_group, option_name):\\n \\\"\\\"\\\"Retrieve an option dict if it exists in the group\\\"\\\"\\\"\\n if options_group not in ['game_options', 'runner_options']:\\n return None\\n output = None\\n for item in getattr(self, options_group):\\n if item[\\\"option\\\"] == option_name:\\n output = item\\n break\\n return output\\n\",\n \"path\": \"lutris/runners/runner.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/lutris/runners/runner.py b/lutris/runners/runner.py\nindex 693433deb3..b855fb526c 100644\n--- a/lutris/runners/runner.py\n+++ b/lutris/runners/runner.py\n@@ -411,6 +411,11 @@ def extract(self, archive=None, dest=None, merge_single=None, callback=None):\n from lutris.util.wine.wine import get_wine_versions\n get_wine_versions.cache_clear()\n \n+ if self.runner_executable:\n+ runner_executable = os.path.join(settings.RUNNER_DIR, self.runner_executable)\n+ if os.path.isfile(runner_executable):\n+ system.make_executable(runner_executable)\n+\n if callback:\n callback()\n \n"}}},{"rowIdx":5493,"cells":{"in_source_id":{"kind":"string","value":"wemake-services__wemake-python-styleguide-884"},"issue":{"kind":"string","value":"Wrong and correct examples of nested annotations mixed up in docs for Union type\n# Bug report\r\n\r\n<!--\r\nHi, thanks for submitting a bug. We appreciate that.\r\n\r\nBut, we will need some information about what's wrong to help you.\r\n-->\r\n\r\n## What's wrong\r\n\r\nFrom ``NestedAnnotationsViolation`` class docstring:\r\n```\r\nExample::\r\n # Correct:\r\n Literal[1, 2, 3, \"foo\", 5, None]\r\n Union[Union[int, str], float]\r\n\r\n # Wrong:\r\n Literal[Literal[Literal[1, 2, 3], \"foo\"], 5, None]\r\n Union[int, str, float]\r\n```\r\nThere is a mistake: correct and wrong examples for ``Union`` type are mixed up. If I run flake8 passing it a file which contains ``Union[int, str, float]`` annotation, no error will be raised. And for ``Union[Union[int, str], float]`` WPS702 is raised. Both are expected behaviour I guess, just a mismatch in documentation.\r\n## How is that should be\r\n\r\n```\r\nExample::\r\n # Correct:\r\n Literal[1, 2, 3, \"foo\", 5, None]\r\n Union[int, str, float]\r\n\r\n # Wrong:\r\n Literal[Literal[Literal[1, 2, 3], \"foo\"], 5, None]\r\n Union[Union[int, str], float]\r\n```\r\n<!--\r\n\r\n Love wemake-python-styleguide? ❤️\r\n Do you want your bugs to be solved faster?\r\n\r\n Please consider supporting our collective:\r\n👉 https://opencollective.com/wemake-python-styleguide/donate\r\n\r\n-->\r\n\n"},"before_files":{"kind":"list like","value":[{"content":"# -*- coding: utf-8 -*-\n\n\"\"\"\nThese checks help to prevent incorrect usage of Python 3 typing annotations.\n\nWhile they maybe of a great help in writing clear\nand concise code, they still can be abused.\n\nOnce again, these rules are highly subjective. But, we love them.\n\n.. currentmodule:: wemake_python_styleguide.violations.annotations\n\nSummary\n-------\n\n.. autosummary::\n :nosignatures:\n\n LiteralNoneViolation\n NestedAnnotationsViolation\n\nAnnotation checks\n------------------\n\n.. autoclass:: LiteralNoneViolation\n.. autoclass:: NestedAnnotationsViolation\n\n\"\"\"\n\nfrom typing_extensions import final\n\nfrom wemake_python_styleguide.violations.base import ASTViolation\n\n\n@final\nclass LiteralNoneViolation(ASTViolation):\n \"\"\"\n Forbids to use ``Literal[None]`` typing annotation.\n\n Reasoning:\n Literal[None] is just the same as None.\n There's no need to use the first version.\n It is not type related, it is a consistency rule.\n\n Solution:\n Replace ``Literal[None]`` with ``None``.\n\n Example::\n\n # Correct:\n def func(empty: None):\n '''Empty function.'''\n\n # Wrong:\n def func(empty: Literal[None]):\n '''Empty function.'''\n\n .. versionadded:: 0.13.0\n\n \"\"\"\n\n code = 701\n error_template = 'Found useless `Literal[None]` typing annotation'\n\n\n@final\nclass NestedAnnotationsViolation(ASTViolation):\n \"\"\"\n Forbids use of nested Literal and Union Annotation.\n\n Reasoning:\n There is no need to nest certain annotations of the same type.\n They are exactly equivalent to the flattened version.\n Use the flattened version for consistency.\n\n Solution:\n Flatten consecutively nested ``typing.Literal`` and ``typing.Union``.\n\n Example::\n # Correct:\n Literal[1, 2, 3, \"foo\", 5, None]\n Union[Union[int, str], float]\n\n # Wrong:\n Literal[Literal[Literal[1, 2, 3], \"foo\"], 5, None]\n Union[int, str, float]\n\n .. versionadded:: 0.13.0\n\n \"\"\"\n\n error_template = 'Found redundant nested typing annotation'\n code = 702\n","path":"wemake_python_styleguide/violations/annotations.py"}],"string":"[\n {\n \"content\": \"# -*- coding: utf-8 -*-\\n\\n\\\"\\\"\\\"\\nThese checks help to prevent incorrect usage of Python 3 typing annotations.\\n\\nWhile they maybe of a great help in writing clear\\nand concise code, they still can be abused.\\n\\nOnce again, these rules are highly subjective. But, we love them.\\n\\n.. currentmodule:: wemake_python_styleguide.violations.annotations\\n\\nSummary\\n-------\\n\\n.. autosummary::\\n :nosignatures:\\n\\n LiteralNoneViolation\\n NestedAnnotationsViolation\\n\\nAnnotation checks\\n------------------\\n\\n.. autoclass:: LiteralNoneViolation\\n.. autoclass:: NestedAnnotationsViolation\\n\\n\\\"\\\"\\\"\\n\\nfrom typing_extensions import final\\n\\nfrom wemake_python_styleguide.violations.base import ASTViolation\\n\\n\\n@final\\nclass LiteralNoneViolation(ASTViolation):\\n \\\"\\\"\\\"\\n Forbids to use ``Literal[None]`` typing annotation.\\n\\n Reasoning:\\n Literal[None] is just the same as None.\\n There's no need to use the first version.\\n It is not type related, it is a consistency rule.\\n\\n Solution:\\n Replace ``Literal[None]`` with ``None``.\\n\\n Example::\\n\\n # Correct:\\n def func(empty: None):\\n '''Empty function.'''\\n\\n # Wrong:\\n def func(empty: Literal[None]):\\n '''Empty function.'''\\n\\n .. versionadded:: 0.13.0\\n\\n \\\"\\\"\\\"\\n\\n code = 701\\n error_template = 'Found useless `Literal[None]` typing annotation'\\n\\n\\n@final\\nclass NestedAnnotationsViolation(ASTViolation):\\n \\\"\\\"\\\"\\n Forbids use of nested Literal and Union Annotation.\\n\\n Reasoning:\\n There is no need to nest certain annotations of the same type.\\n They are exactly equivalent to the flattened version.\\n Use the flattened version for consistency.\\n\\n Solution:\\n Flatten consecutively nested ``typing.Literal`` and ``typing.Union``.\\n\\n Example::\\n # Correct:\\n Literal[1, 2, 3, \\\"foo\\\", 5, None]\\n Union[Union[int, str], float]\\n\\n # Wrong:\\n Literal[Literal[Literal[1, 2, 3], \\\"foo\\\"], 5, None]\\n Union[int, str, float]\\n\\n .. versionadded:: 0.13.0\\n\\n \\\"\\\"\\\"\\n\\n error_template = 'Found redundant nested typing annotation'\\n code = 702\\n\",\n \"path\": \"wemake_python_styleguide/violations/annotations.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"# -*- coding: utf-8 -*-\n\n\"\"\"\nThese checks help to prevent incorrect usage of Python 3 typing annotations.\n\nWhile they maybe of a great help in writing clear\nand concise code, they still can be abused.\n\nOnce again, these rules are highly subjective. But, we love them.\n\n.. currentmodule:: wemake_python_styleguide.violations.annotations\n\nSummary\n-------\n\n.. autosummary::\n :nosignatures:\n\n LiteralNoneViolation\n NestedAnnotationsViolation\n\nAnnotation checks\n------------------\n\n.. autoclass:: LiteralNoneViolation\n.. autoclass:: NestedAnnotationsViolation\n\n\"\"\"\n\nfrom typing_extensions import final\n\nfrom wemake_python_styleguide.violations.base import ASTViolation\n\n\n@final\nclass LiteralNoneViolation(ASTViolation):\n \"\"\"\n Forbids to use ``Literal[None]`` typing annotation.\n\n Reasoning:\n Literal[None] is just the same as None.\n There's no need to use the first version.\n It is not type related, it is a consistency rule.\n\n Solution:\n Replace ``Literal[None]`` with ``None``.\n\n Example::\n\n # Correct:\n def func(empty: None):\n '''Empty function.'''\n\n # Wrong:\n def func(empty: Literal[None]):\n '''Empty function.'''\n\n .. versionadded:: 0.13.0\n\n \"\"\"\n\n code = 701\n error_template = 'Found useless `Literal[None]` typing annotation'\n\n\n@final\nclass NestedAnnotationsViolation(ASTViolation):\n \"\"\"\n Forbids use of nested Literal and Union Annotation.\n\n Reasoning:\n There is no need to nest certain annotations of the same type.\n They are exactly equivalent to the flattened version.\n Use the flattened version for consistency.\n\n Solution:\n Flatten consecutively nested ``typing.Literal`` and ``typing.Union``.\n\n Example::\n # Correct:\n Literal[1, 2, 3, \"foo\", 5, None]\n Union[int, str, float]\n\n # Wrong:\n Literal[Literal[Literal[1, 2, 3], \"foo\"], 5, None]\n Union[Union[int, str], float]\n\n .. versionadded:: 0.13.0\n\n \"\"\"\n\n error_template = 'Found redundant nested typing annotation'\n code = 702\n","path":"wemake_python_styleguide/violations/annotations.py"}],"string":"[\n {\n \"content\": \"# -*- coding: utf-8 -*-\\n\\n\\\"\\\"\\\"\\nThese checks help to prevent incorrect usage of Python 3 typing annotations.\\n\\nWhile they maybe of a great help in writing clear\\nand concise code, they still can be abused.\\n\\nOnce again, these rules are highly subjective. But, we love them.\\n\\n.. currentmodule:: wemake_python_styleguide.violations.annotations\\n\\nSummary\\n-------\\n\\n.. autosummary::\\n :nosignatures:\\n\\n LiteralNoneViolation\\n NestedAnnotationsViolation\\n\\nAnnotation checks\\n------------------\\n\\n.. autoclass:: LiteralNoneViolation\\n.. autoclass:: NestedAnnotationsViolation\\n\\n\\\"\\\"\\\"\\n\\nfrom typing_extensions import final\\n\\nfrom wemake_python_styleguide.violations.base import ASTViolation\\n\\n\\n@final\\nclass LiteralNoneViolation(ASTViolation):\\n \\\"\\\"\\\"\\n Forbids to use ``Literal[None]`` typing annotation.\\n\\n Reasoning:\\n Literal[None] is just the same as None.\\n There's no need to use the first version.\\n It is not type related, it is a consistency rule.\\n\\n Solution:\\n Replace ``Literal[None]`` with ``None``.\\n\\n Example::\\n\\n # Correct:\\n def func(empty: None):\\n '''Empty function.'''\\n\\n # Wrong:\\n def func(empty: Literal[None]):\\n '''Empty function.'''\\n\\n .. versionadded:: 0.13.0\\n\\n \\\"\\\"\\\"\\n\\n code = 701\\n error_template = 'Found useless `Literal[None]` typing annotation'\\n\\n\\n@final\\nclass NestedAnnotationsViolation(ASTViolation):\\n \\\"\\\"\\\"\\n Forbids use of nested Literal and Union Annotation.\\n\\n Reasoning:\\n There is no need to nest certain annotations of the same type.\\n They are exactly equivalent to the flattened version.\\n Use the flattened version for consistency.\\n\\n Solution:\\n Flatten consecutively nested ``typing.Literal`` and ``typing.Union``.\\n\\n Example::\\n # Correct:\\n Literal[1, 2, 3, \\\"foo\\\", 5, None]\\n Union[int, str, float]\\n\\n # Wrong:\\n Literal[Literal[Literal[1, 2, 3], \\\"foo\\\"], 5, None]\\n Union[Union[int, str], float]\\n\\n .. versionadded:: 0.13.0\\n\\n \\\"\\\"\\\"\\n\\n error_template = 'Found redundant nested typing annotation'\\n code = 702\\n\",\n \"path\": \"wemake_python_styleguide/violations/annotations.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/wemake_python_styleguide/violations/annotations.py b/wemake_python_styleguide/violations/annotations.py\nindex 46c29c750..29a845f01 100644\n--- a/wemake_python_styleguide/violations/annotations.py\n+++ b/wemake_python_styleguide/violations/annotations.py\n@@ -79,11 +79,11 @@ class NestedAnnotationsViolation(ASTViolation):\n Example::\n # Correct:\n Literal[1, 2, 3, \"foo\", 5, None]\n- Union[Union[int, str], float]\n+ Union[int, str, float]\n \n # Wrong:\n Literal[Literal[Literal[1, 2, 3], \"foo\"], 5, None]\n- Union[int, str, float]\n+ Union[Union[int, str], float]\n \n .. versionadded:: 0.13.0\n \n"}}},{"rowIdx":5494,"cells":{"in_source_id":{"kind":"string","value":"biopython__biopython-4468"},"issue":{"kind":"string","value":"HMMER Parser doesn't work with Windows\nThe regex defined here:\r\n\r\nhttps://github.com/krdav/ANARCI_KD_copy/blob/5c4a17f6f0bc530b3e5154667e285eea1195a485/lib/python/anarci/Bio/SearchIO/HmmerIO/hmmer3_text.py#L24\r\n\r\nIs unable to find any matches in this output banner from hmmscan:\r\n\r\n'# C:\\\\msys64\\\\scr\\\\jou\\\\builds\\\\22-2\\\\build\\\\thirdparty\\\\bin\\\\Windows-x64\\\\hmmer\\\\bin\\\\hmmscan :: search sequence(s) against a profile database\\n'\r\n\r\nand as a result\r\n\r\nhttps://github.com/biopython/biopython/blob/9965ece1d76adc8ee65904f87ea68c0b1206050a/Bio/SearchIO/HmmerIO/hmmer3_text.py#L20\r\n\r\nSometimes leaves query_start, query_end, hit_start, and hit_end as None. It's worse than assigning without correction, and should really be an error, or handled gracefully with its current downstream warning.\n"},"before_files":{"kind":"list like","value":[{"content":"# Copyright 2012 by Wibowo Arindrarto. All rights reserved.\n# This file is part of the Biopython distribution and governed by your\n# choice of the \"Biopython License Agreement\" or the \"BSD 3-Clause License\".\n# Please see the LICENSE file that should have been included as part of this\n# package.\n\"\"\"Bio.SearchIO parser for HMMER plain text output format.\"\"\"\n\nimport re\n\nfrom Bio.SearchIO._utils import read_forward\nfrom Bio.SearchIO._model import QueryResult, Hit, HSP, HSPFragment\n\nfrom ._base import _BaseHmmerTextIndexer\n\n__all__ = (\"Hmmer3TextParser\", \"Hmmer3TextIndexer\")\n\n\n# precompile regex patterns for faster processing\n# regex for program name capture\n_RE_PROGRAM = re.compile(r\"^# (\\w*hmm\\w+) :: .*$\")\n# regex for version string capture\n_RE_VERSION = re.compile(r\"# \\w+ ([\\w+\\.]+) .*; http.*$\")\n# regex for option string capture\n_RE_OPT = re.compile(r\"^# (.+):\\s+(.+)$\")\n# regex for parsing query id and length, for parsing\n_QRE_ID_LEN_PTN = r\"^Query:\\s*(.*)\\s+\\[\\w=(\\d+)\\]\"\n_QRE_ID_LEN = re.compile(_QRE_ID_LEN_PTN)\n# regex for hsp validation\n_HRE_VALIDATE = re.compile(r\"score:\\s(-?\\d+\\.?\\d+)\\sbits.*value:\\s(.*)\")\n# regexes for parsing hsp alignment blocks\n_HRE_ANNOT_LINE = re.compile(r\"^(\\s+)(.+)\\s(\\w+)\")\n_HRE_ID_LINE = re.compile(r\"^(\\s+\\S+\\s+[0-9-]+ )(.+?)(\\s+[0-9-]+)\")\n\n\nclass Hmmer3TextParser:\n \"\"\"Parser for the HMMER 3.0 text output.\"\"\"\n\n def __init__(self, handle):\n \"\"\"Initialize the class.\"\"\"\n self.handle = handle\n self.line = read_forward(self.handle)\n self._meta = self._parse_preamble()\n\n def __iter__(self):\n \"\"\"Iterate over query results.\"\"\"\n yield from self._parse_qresult()\n\n def _read_until(self, bool_func):\n \"\"\"Read the file handle until the given function returns True (PRIVATE).\"\"\"\n while True:\n if not self.line or bool_func(self.line):\n return\n else:\n self.line = read_forward(self.handle)\n\n def _parse_preamble(self):\n \"\"\"Parse HMMER preamble (lines beginning with '#') (PRIVATE).\"\"\"\n meta = {}\n # bool flag for storing state ~ whether we are parsing the option\n # lines or not\n has_opts = False\n while True:\n # no pound sign means we've left the preamble\n if not self.line.startswith(\"#\"):\n break\n # dashes could either mean we are entering or leaving the options\n # section ~ so it's a switch for the has_opts flag\n elif \"- - -\" in self.line:\n if not has_opts:\n # if flag is false, that means we're entering opts\n # so switch the flag accordingly\n has_opts = True\n else:\n # if flag is true, that means we've reached the end of opts\n # so we can break out of the function\n break\n elif not has_opts:\n # try parsing program\n regx = re.search(_RE_PROGRAM, self.line)\n if regx:\n meta[\"program\"] = regx.group(1)\n # try parsing version\n regx = re.search(_RE_VERSION, self.line)\n if regx:\n meta[\"version\"] = regx.group(1)\n elif has_opts:\n regx = re.search(_RE_OPT, self.line)\n # if target in regx.group(1), then we store the key as target\n if \"target\" in regx.group(1):\n meta[\"target\"] = regx.group(2).strip()\n else:\n meta[regx.group(1)] = regx.group(2)\n\n self.line = read_forward(self.handle)\n\n return meta\n\n def _parse_qresult(self):\n \"\"\"Parse a HMMER3 query block (PRIVATE).\"\"\"\n self._read_until(lambda line: line.startswith(\"Query:\"))\n\n while self.line:\n regx = re.search(_QRE_ID_LEN, self.line)\n\n while not regx:\n self.line = read_forward(self.handle)\n regx = re.search(_QRE_ID_LEN, self.line)\n\n # get query id and length\n qid = regx.group(1).strip()\n # store qresult attributes\n qresult_attrs = {\n \"seq_len\": int(regx.group(2)),\n \"program\": self._meta.get(\"program\"),\n \"version\": self._meta.get(\"version\"),\n \"target\": self._meta.get(\"target\"),\n }\n\n # get description and accession, if they exist\n qdesc = \"<unknown description>\" # placeholder\n while not self.line.startswith(\"Scores for \"):\n self.line = read_forward(self.handle)\n\n if self.line.startswith(\"Accession:\"):\n acc = self.line.strip().split(\" \", 1)[1]\n qresult_attrs[\"accession\"] = acc.strip()\n elif self.line.startswith(\"Description:\"):\n qdesc = self.line.strip().split(\" \", 1)[1].strip()\n qresult_attrs[\"description\"] = qdesc\n\n # parse the query hits\n while self.line and \"//\" not in self.line:\n hit_list = self._parse_hit(qid, qdesc)\n # read through the statistics summary\n # TODO: parse and store this information?\n if self.line.startswith(\"Internal pipeline\"):\n while self.line and \"//\" not in self.line:\n self.line = read_forward(self.handle)\n\n # create qresult, set its attributes and yield\n # not initializing hit_list directly to handle empty hits\n # (i.e. need to set its query description manually)\n qresult = QueryResult(id=qid, hits=hit_list)\n for attr, value in qresult_attrs.items():\n setattr(qresult, attr, value)\n yield qresult\n self.line = read_forward(self.handle)\n\n # Skip line beginning with '# Alignment of', which are output\n # when running phmmer with the '-A' flag.\n if self.line.startswith(\"#\"):\n self.line = self.handle.readline()\n\n # HMMER >= 3.1 outputs '[ok]' at the end of all results file,\n # which means we can break the main loop when we see the line\n if \"[ok]\" in self.line:\n break\n\n def _parse_hit(self, qid, qdesc):\n \"\"\"Parse a HMMER3 hit block, beginning with the hit table (PRIVATE).\"\"\"\n # get to the end of the hit table delimiter and read one more line\n self._read_until(lambda line: line.startswith(\" ------- ------ -----\"))\n self.line = read_forward(self.handle)\n\n # assume every hit is in inclusion threshold until the inclusion\n # threshold line is encountered\n is_included = True\n\n # parse the hit table\n hit_attr_list = []\n while True:\n if not self.line:\n return []\n elif self.line.startswith(\" ------ inclusion\"):\n is_included = False\n self.line = read_forward(self.handle)\n # if there are no hits, then there are no hsps\n # so we forward-read until 'Internal pipeline..'\n elif self.line.startswith(\" [No hits detected that satisfy reporting\"):\n while True:\n self.line = read_forward(self.handle)\n if self.line.startswith(\"Internal pipeline\"):\n assert len(hit_attr_list) == 0\n return []\n elif self.line.startswith(\"Domain annotation for each \"):\n hit_list = self._create_hits(hit_attr_list, qid, qdesc)\n return hit_list\n # entering hit results row\n # parse the columns into a list\n row = [x for x in self.line.strip().split(\" \") if x]\n # join the description words if it's >1 word\n if len(row) > 10:\n row[9] = \" \".join(row[9:])\n # if there's no description, set it to an empty string\n elif len(row) < 10:\n row.append(\"\")\n assert len(row) == 10\n # create the hit object\n hit_attrs = {\n \"id\": row[8],\n \"query_id\": qid,\n \"evalue\": float(row[0]),\n \"bitscore\": float(row[1]),\n \"bias\": float(row[2]),\n # row[3:6] is not parsed, since the info is available\n # at the HSP level\n \"domain_exp_num\": float(row[6]),\n \"domain_obs_num\": int(row[7]),\n \"description\": row[9],\n \"is_included\": is_included,\n }\n hit_attr_list.append(hit_attrs)\n\n self.line = read_forward(self.handle)\n\n def _create_hits(self, hit_attrs, qid, qdesc):\n \"\"\"Parse a HMMER3 hsp block, beginning with the hsp table (PRIVATE).\"\"\"\n # read through until the beginning of the hsp block\n self._read_until(\n lambda line: line.startswith(\"Internal pipeline\") or line.startswith(\">>\")\n )\n\n # start parsing the hsp block\n hit_list = []\n while True:\n if self.line.startswith(\"Internal pipeline\"):\n # by this time we should've emptied the hit attr list\n assert len(hit_attrs) == 0\n return hit_list\n assert self.line.startswith(\">>\")\n hid, hdesc = self.line[len(\">> \") :].split(\" \", 1)\n hdesc = hdesc.strip()\n\n # read through the hsp table header and move one more line\n self._read_until(\n lambda line: line.startswith(\" --- ------ ----- --------\")\n or line.startswith(\" [No individual domains\")\n )\n self.line = read_forward(self.handle)\n\n # parse the hsp table for the current hit\n hsp_list = []\n while True:\n # break out of hsp parsing if there are no hits, it's the last hsp\n # or it's the start of a new hit\n if (\n self.line.startswith(\" [No targets detected that satisfy\")\n or self.line.startswith(\" [No individual domains\")\n or self.line.startswith(\"Internal pipeline statistics summary:\")\n or self.line.startswith(\" Alignments for each domain:\")\n or self.line.startswith(\">>\")\n ):\n hit_attr = hit_attrs.pop(0)\n hit = Hit(hsp_list)\n for attr, value in hit_attr.items():\n if attr == \"description\":\n cur_val = getattr(hit, attr)\n if cur_val and value and cur_val.startswith(value):\n continue\n setattr(hit, attr, value)\n if not hit:\n hit.query_description = qdesc\n hit_list.append(hit)\n break\n\n parsed = [x for x in self.line.strip().split(\" \") if x]\n assert len(parsed) == 16\n # parsed column order:\n # index, is_included, bitscore, bias, evalue_cond, evalue\n # hmmfrom, hmmto, query_ends, hit_ends, alifrom, alito,\n # envfrom, envto, acc_avg\n frag = HSPFragment(hid, qid)\n # set query and hit descriptions if they are defined / nonempty string\n if qdesc:\n frag.query_description = qdesc\n if hdesc:\n frag.hit_description = hdesc\n # HMMER3 results are always protein\n frag.molecule_type = \"protein\"\n # depending on whether the program is hmmsearch, hmmscan, or phmmer\n # {hmm,ali}{from,to} can either be hit_{from,to} or query_{from,to}\n # for hmmscan, hit is the hmm profile, query is the sequence\n if self._meta.get(\"program\") == \"hmmscan\":\n # adjust 'from' and 'to' coordinates to 0-based ones\n frag.hit_start = int(parsed[6]) - 1\n frag.hit_end = int(parsed[7])\n frag.query_start = int(parsed[9]) - 1\n frag.query_end = int(parsed[10])\n elif self._meta.get(\"program\") in [\"hmmsearch\", \"phmmer\"]:\n # adjust 'from' and 'to' coordinates to 0-based ones\n frag.hit_start = int(parsed[9]) - 1\n frag.hit_end = int(parsed[10])\n frag.query_start = int(parsed[6]) - 1\n frag.query_end = int(parsed[7])\n # strand is always 0, since HMMER now only handles protein\n frag.hit_strand = frag.query_strand = 0\n\n hsp = HSP([frag])\n hsp.domain_index = int(parsed[0])\n hsp.is_included = parsed[1] == \"!\"\n hsp.bitscore = float(parsed[2])\n hsp.bias = float(parsed[3])\n hsp.evalue_cond = float(parsed[4])\n hsp.evalue = float(parsed[5])\n if self._meta.get(\"program\") == \"hmmscan\":\n # adjust 'from' and 'to' coordinates to 0-based ones\n hsp.hit_endtype = parsed[8]\n hsp.query_endtype = parsed[11]\n elif self._meta.get(\"program\") in [\"hmmsearch\", \"phmmer\"]:\n # adjust 'from' and 'to' coordinates to 0-based ones\n hsp.hit_endtype = parsed[11]\n hsp.query_endtype = parsed[8]\n # adjust 'from' and 'to' coordinates to 0-based ones\n hsp.env_start = int(parsed[12]) - 1\n hsp.env_end = int(parsed[13])\n hsp.env_endtype = parsed[14]\n hsp.acc_avg = float(parsed[15])\n\n hsp_list.append(hsp)\n self.line = read_forward(self.handle)\n\n # parse the hsp alignments\n if self.line.startswith(\" Alignments for each domain:\"):\n self._parse_aln_block(hid, hit.hsps)\n\n def _parse_aln_block(self, hid, hsp_list):\n \"\"\"Parse a HMMER3 HSP alignment block (PRIVATE).\"\"\"\n self.line = read_forward(self.handle)\n dom_counter = 0\n while True:\n if self.line.startswith(\">>\") or self.line.startswith(\"Internal pipeline\"):\n return hsp_list\n assert self.line.startswith(\" == domain %i\" % (dom_counter + 1))\n # alias hsp to local var\n # but note that we're still changing the attrs of the actual\n # hsp inside the qresult as we're not creating a copy\n frag = hsp_list[dom_counter][0]\n # XXX: should we validate again here? regex is expensive..\n # regx = re.search(_HRE_VALIDATE, self.line)\n # assert hsp.bitscore == float(regx.group(1))\n # assert hsp.evalue_cond == float(regx.group(2))\n hmmseq = \"\"\n aliseq = \"\"\n annot = {}\n self.line = self.handle.readline()\n\n # parse all the alignment blocks in the hsp\n while True:\n regx = None\n\n # check for hit or query line\n # we don't check for the hit or query id specifically\n # to anticipate special cases where query id == hit id\n regx = re.search(_HRE_ID_LINE, self.line)\n if regx:\n # the first hit/query self.line we encounter is the hmmseq\n if len(hmmseq) == len(aliseq):\n hmmseq += regx.group(2)\n # and for subsequent self.lines, len(hmmseq) is either\n # > or == len(aliseq)\n elif len(hmmseq) > len(aliseq):\n aliseq += regx.group(2)\n assert len(hmmseq) >= len(aliseq)\n # check for start of new domain\n elif (\n self.line.startswith(\" == domain\")\n or self.line.startswith(\">>\")\n or self.line.startswith(\"Internal pipeline\")\n ):\n frag.aln_annotation = annot\n if self._meta.get(\"program\") == \"hmmscan\":\n frag.hit = hmmseq\n frag.query = aliseq\n elif self._meta.get(\"program\") in [\"hmmsearch\", \"phmmer\"]:\n frag.hit = aliseq\n frag.query = hmmseq\n dom_counter += 1\n hmmseq = \"\"\n aliseq = \"\"\n annot = {}\n break\n # otherwise check if it's an annotation line and parse it\n # len(hmmseq) is only != len(aliseq) when the cursor is parsing\n # the similarity character. Since we're not parsing that, we\n # check for when the condition is False (i.e. when it's ==)\n elif len(hmmseq) == len(aliseq):\n regx = re.search(_HRE_ANNOT_LINE, self.line)\n if regx:\n annot_name = regx.group(3)\n if annot_name in annot:\n annot[annot_name] += regx.group(2)\n else:\n annot[annot_name] = regx.group(2)\n\n self.line = self.handle.readline()\n\n\nclass Hmmer3TextIndexer(_BaseHmmerTextIndexer):\n \"\"\"Indexer class for HMMER plain text output.\"\"\"\n\n _parser = Hmmer3TextParser\n qresult_start = b\"Query: \"\n qresult_end = b\"//\"\n\n def __iter__(self):\n \"\"\"Iterate over Hmmer3TextIndexer; yields query results' key, offsets, 0.\"\"\"\n handle = self._handle\n handle.seek(0)\n start_offset = handle.tell()\n regex_id = re.compile(_QRE_ID_LEN_PTN.encode())\n\n while True:\n line = read_forward(handle)\n end_offset = handle.tell()\n\n if line.startswith(self.qresult_start):\n regx = re.search(regex_id, line)\n qresult_key = regx.group(1).strip()\n # qresult start offset is the offset of this line\n # (starts with the start mark)\n start_offset = end_offset - len(line)\n elif line.startswith(self.qresult_end):\n yield qresult_key.decode(), start_offset, 0\n start_offset = end_offset\n elif not line:\n break\n\n\n# if not used as a module, run the doctest\nif __name__ == \"__main__\":\n from Bio._utils import run_doctest\n\n run_doctest()\n","path":"Bio/SearchIO/HmmerIO/hmmer3_text.py"}],"string":"[\n {\n \"content\": \"# Copyright 2012 by Wibowo Arindrarto. All rights reserved.\\n# This file is part of the Biopython distribution and governed by your\\n# choice of the \\\"Biopython License Agreement\\\" or the \\\"BSD 3-Clause License\\\".\\n# Please see the LICENSE file that should have been included as part of this\\n# package.\\n\\\"\\\"\\\"Bio.SearchIO parser for HMMER plain text output format.\\\"\\\"\\\"\\n\\nimport re\\n\\nfrom Bio.SearchIO._utils import read_forward\\nfrom Bio.SearchIO._model import QueryResult, Hit, HSP, HSPFragment\\n\\nfrom ._base import _BaseHmmerTextIndexer\\n\\n__all__ = (\\\"Hmmer3TextParser\\\", \\\"Hmmer3TextIndexer\\\")\\n\\n\\n# precompile regex patterns for faster processing\\n# regex for program name capture\\n_RE_PROGRAM = re.compile(r\\\"^# (\\\\w*hmm\\\\w+) :: .*$\\\")\\n# regex for version string capture\\n_RE_VERSION = re.compile(r\\\"# \\\\w+ ([\\\\w+\\\\.]+) .*; http.*$\\\")\\n# regex for option string capture\\n_RE_OPT = re.compile(r\\\"^# (.+):\\\\s+(.+)$\\\")\\n# regex for parsing query id and length, for parsing\\n_QRE_ID_LEN_PTN = r\\\"^Query:\\\\s*(.*)\\\\s+\\\\[\\\\w=(\\\\d+)\\\\]\\\"\\n_QRE_ID_LEN = re.compile(_QRE_ID_LEN_PTN)\\n# regex for hsp validation\\n_HRE_VALIDATE = re.compile(r\\\"score:\\\\s(-?\\\\d+\\\\.?\\\\d+)\\\\sbits.*value:\\\\s(.*)\\\")\\n# regexes for parsing hsp alignment blocks\\n_HRE_ANNOT_LINE = re.compile(r\\\"^(\\\\s+)(.+)\\\\s(\\\\w+)\\\")\\n_HRE_ID_LINE = re.compile(r\\\"^(\\\\s+\\\\S+\\\\s+[0-9-]+ )(.+?)(\\\\s+[0-9-]+)\\\")\\n\\n\\nclass Hmmer3TextParser:\\n \\\"\\\"\\\"Parser for the HMMER 3.0 text output.\\\"\\\"\\\"\\n\\n def __init__(self, handle):\\n \\\"\\\"\\\"Initialize the class.\\\"\\\"\\\"\\n self.handle = handle\\n self.line = read_forward(self.handle)\\n self._meta = self._parse_preamble()\\n\\n def __iter__(self):\\n \\\"\\\"\\\"Iterate over query results.\\\"\\\"\\\"\\n yield from self._parse_qresult()\\n\\n def _read_until(self, bool_func):\\n \\\"\\\"\\\"Read the file handle until the given function returns True (PRIVATE).\\\"\\\"\\\"\\n while True:\\n if not self.line or bool_func(self.line):\\n return\\n else:\\n self.line = read_forward(self.handle)\\n\\n def _parse_preamble(self):\\n \\\"\\\"\\\"Parse HMMER preamble (lines beginning with '#') (PRIVATE).\\\"\\\"\\\"\\n meta = {}\\n # bool flag for storing state ~ whether we are parsing the option\\n # lines or not\\n has_opts = False\\n while True:\\n # no pound sign means we've left the preamble\\n if not self.line.startswith(\\\"#\\\"):\\n break\\n # dashes could either mean we are entering or leaving the options\\n # section ~ so it's a switch for the has_opts flag\\n elif \\\"- - -\\\" in self.line:\\n if not has_opts:\\n # if flag is false, that means we're entering opts\\n # so switch the flag accordingly\\n has_opts = True\\n else:\\n # if flag is true, that means we've reached the end of opts\\n # so we can break out of the function\\n break\\n elif not has_opts:\\n # try parsing program\\n regx = re.search(_RE_PROGRAM, self.line)\\n if regx:\\n meta[\\\"program\\\"] = regx.group(1)\\n # try parsing version\\n regx = re.search(_RE_VERSION, self.line)\\n if regx:\\n meta[\\\"version\\\"] = regx.group(1)\\n elif has_opts:\\n regx = re.search(_RE_OPT, self.line)\\n # if target in regx.group(1), then we store the key as target\\n if \\\"target\\\" in regx.group(1):\\n meta[\\\"target\\\"] = regx.group(2).strip()\\n else:\\n meta[regx.group(1)] = regx.group(2)\\n\\n self.line = read_forward(self.handle)\\n\\n return meta\\n\\n def _parse_qresult(self):\\n \\\"\\\"\\\"Parse a HMMER3 query block (PRIVATE).\\\"\\\"\\\"\\n self._read_until(lambda line: line.startswith(\\\"Query:\\\"))\\n\\n while self.line:\\n regx = re.search(_QRE_ID_LEN, self.line)\\n\\n while not regx:\\n self.line = read_forward(self.handle)\\n regx = re.search(_QRE_ID_LEN, self.line)\\n\\n # get query id and length\\n qid = regx.group(1).strip()\\n # store qresult attributes\\n qresult_attrs = {\\n \\\"seq_len\\\": int(regx.group(2)),\\n \\\"program\\\": self._meta.get(\\\"program\\\"),\\n \\\"version\\\": self._meta.get(\\\"version\\\"),\\n \\\"target\\\": self._meta.get(\\\"target\\\"),\\n }\\n\\n # get description and accession, if they exist\\n qdesc = \\\"<unknown description>\\\" # placeholder\\n while not self.line.startswith(\\\"Scores for \\\"):\\n self.line = read_forward(self.handle)\\n\\n if self.line.startswith(\\\"Accession:\\\"):\\n acc = self.line.strip().split(\\\" \\\", 1)[1]\\n qresult_attrs[\\\"accession\\\"] = acc.strip()\\n elif self.line.startswith(\\\"Description:\\\"):\\n qdesc = self.line.strip().split(\\\" \\\", 1)[1].strip()\\n qresult_attrs[\\\"description\\\"] = qdesc\\n\\n # parse the query hits\\n while self.line and \\\"//\\\" not in self.line:\\n hit_list = self._parse_hit(qid, qdesc)\\n # read through the statistics summary\\n # TODO: parse and store this information?\\n if self.line.startswith(\\\"Internal pipeline\\\"):\\n while self.line and \\\"//\\\" not in self.line:\\n self.line = read_forward(self.handle)\\n\\n # create qresult, set its attributes and yield\\n # not initializing hit_list directly to handle empty hits\\n # (i.e. need to set its query description manually)\\n qresult = QueryResult(id=qid, hits=hit_list)\\n for attr, value in qresult_attrs.items():\\n setattr(qresult, attr, value)\\n yield qresult\\n self.line = read_forward(self.handle)\\n\\n # Skip line beginning with '# Alignment of', which are output\\n # when running phmmer with the '-A' flag.\\n if self.line.startswith(\\\"#\\\"):\\n self.line = self.handle.readline()\\n\\n # HMMER >= 3.1 outputs '[ok]' at the end of all results file,\\n # which means we can break the main loop when we see the line\\n if \\\"[ok]\\\" in self.line:\\n break\\n\\n def _parse_hit(self, qid, qdesc):\\n \\\"\\\"\\\"Parse a HMMER3 hit block, beginning with the hit table (PRIVATE).\\\"\\\"\\\"\\n # get to the end of the hit table delimiter and read one more line\\n self._read_until(lambda line: line.startswith(\\\" ------- ------ -----\\\"))\\n self.line = read_forward(self.handle)\\n\\n # assume every hit is in inclusion threshold until the inclusion\\n # threshold line is encountered\\n is_included = True\\n\\n # parse the hit table\\n hit_attr_list = []\\n while True:\\n if not self.line:\\n return []\\n elif self.line.startswith(\\\" ------ inclusion\\\"):\\n is_included = False\\n self.line = read_forward(self.handle)\\n # if there are no hits, then there are no hsps\\n # so we forward-read until 'Internal pipeline..'\\n elif self.line.startswith(\\\" [No hits detected that satisfy reporting\\\"):\\n while True:\\n self.line = read_forward(self.handle)\\n if self.line.startswith(\\\"Internal pipeline\\\"):\\n assert len(hit_attr_list) == 0\\n return []\\n elif self.line.startswith(\\\"Domain annotation for each \\\"):\\n hit_list = self._create_hits(hit_attr_list, qid, qdesc)\\n return hit_list\\n # entering hit results row\\n # parse the columns into a list\\n row = [x for x in self.line.strip().split(\\\" \\\") if x]\\n # join the description words if it's >1 word\\n if len(row) > 10:\\n row[9] = \\\" \\\".join(row[9:])\\n # if there's no description, set it to an empty string\\n elif len(row) < 10:\\n row.append(\\\"\\\")\\n assert len(row) == 10\\n # create the hit object\\n hit_attrs = {\\n \\\"id\\\": row[8],\\n \\\"query_id\\\": qid,\\n \\\"evalue\\\": float(row[0]),\\n \\\"bitscore\\\": float(row[1]),\\n \\\"bias\\\": float(row[2]),\\n # row[3:6] is not parsed, since the info is available\\n # at the HSP level\\n \\\"domain_exp_num\\\": float(row[6]),\\n \\\"domain_obs_num\\\": int(row[7]),\\n \\\"description\\\": row[9],\\n \\\"is_included\\\": is_included,\\n }\\n hit_attr_list.append(hit_attrs)\\n\\n self.line = read_forward(self.handle)\\n\\n def _create_hits(self, hit_attrs, qid, qdesc):\\n \\\"\\\"\\\"Parse a HMMER3 hsp block, beginning with the hsp table (PRIVATE).\\\"\\\"\\\"\\n # read through until the beginning of the hsp block\\n self._read_until(\\n lambda line: line.startswith(\\\"Internal pipeline\\\") or line.startswith(\\\">>\\\")\\n )\\n\\n # start parsing the hsp block\\n hit_list = []\\n while True:\\n if self.line.startswith(\\\"Internal pipeline\\\"):\\n # by this time we should've emptied the hit attr list\\n assert len(hit_attrs) == 0\\n return hit_list\\n assert self.line.startswith(\\\">>\\\")\\n hid, hdesc = self.line[len(\\\">> \\\") :].split(\\\" \\\", 1)\\n hdesc = hdesc.strip()\\n\\n # read through the hsp table header and move one more line\\n self._read_until(\\n lambda line: line.startswith(\\\" --- ------ ----- --------\\\")\\n or line.startswith(\\\" [No individual domains\\\")\\n )\\n self.line = read_forward(self.handle)\\n\\n # parse the hsp table for the current hit\\n hsp_list = []\\n while True:\\n # break out of hsp parsing if there are no hits, it's the last hsp\\n # or it's the start of a new hit\\n if (\\n self.line.startswith(\\\" [No targets detected that satisfy\\\")\\n or self.line.startswith(\\\" [No individual domains\\\")\\n or self.line.startswith(\\\"Internal pipeline statistics summary:\\\")\\n or self.line.startswith(\\\" Alignments for each domain:\\\")\\n or self.line.startswith(\\\">>\\\")\\n ):\\n hit_attr = hit_attrs.pop(0)\\n hit = Hit(hsp_list)\\n for attr, value in hit_attr.items():\\n if attr == \\\"description\\\":\\n cur_val = getattr(hit, attr)\\n if cur_val and value and cur_val.startswith(value):\\n continue\\n setattr(hit, attr, value)\\n if not hit:\\n hit.query_description = qdesc\\n hit_list.append(hit)\\n break\\n\\n parsed = [x for x in self.line.strip().split(\\\" \\\") if x]\\n assert len(parsed) == 16\\n # parsed column order:\\n # index, is_included, bitscore, bias, evalue_cond, evalue\\n # hmmfrom, hmmto, query_ends, hit_ends, alifrom, alito,\\n # envfrom, envto, acc_avg\\n frag = HSPFragment(hid, qid)\\n # set query and hit descriptions if they are defined / nonempty string\\n if qdesc:\\n frag.query_description = qdesc\\n if hdesc:\\n frag.hit_description = hdesc\\n # HMMER3 results are always protein\\n frag.molecule_type = \\\"protein\\\"\\n # depending on whether the program is hmmsearch, hmmscan, or phmmer\\n # {hmm,ali}{from,to} can either be hit_{from,to} or query_{from,to}\\n # for hmmscan, hit is the hmm profile, query is the sequence\\n if self._meta.get(\\\"program\\\") == \\\"hmmscan\\\":\\n # adjust 'from' and 'to' coordinates to 0-based ones\\n frag.hit_start = int(parsed[6]) - 1\\n frag.hit_end = int(parsed[7])\\n frag.query_start = int(parsed[9]) - 1\\n frag.query_end = int(parsed[10])\\n elif self._meta.get(\\\"program\\\") in [\\\"hmmsearch\\\", \\\"phmmer\\\"]:\\n # adjust 'from' and 'to' coordinates to 0-based ones\\n frag.hit_start = int(parsed[9]) - 1\\n frag.hit_end = int(parsed[10])\\n frag.query_start = int(parsed[6]) - 1\\n frag.query_end = int(parsed[7])\\n # strand is always 0, since HMMER now only handles protein\\n frag.hit_strand = frag.query_strand = 0\\n\\n hsp = HSP([frag])\\n hsp.domain_index = int(parsed[0])\\n hsp.is_included = parsed[1] == \\\"!\\\"\\n hsp.bitscore = float(parsed[2])\\n hsp.bias = float(parsed[3])\\n hsp.evalue_cond = float(parsed[4])\\n hsp.evalue = float(parsed[5])\\n if self._meta.get(\\\"program\\\") == \\\"hmmscan\\\":\\n # adjust 'from' and 'to' coordinates to 0-based ones\\n hsp.hit_endtype = parsed[8]\\n hsp.query_endtype = parsed[11]\\n elif self._meta.get(\\\"program\\\") in [\\\"hmmsearch\\\", \\\"phmmer\\\"]:\\n # adjust 'from' and 'to' coordinates to 0-based ones\\n hsp.hit_endtype = parsed[11]\\n hsp.query_endtype = parsed[8]\\n # adjust 'from' and 'to' coordinates to 0-based ones\\n hsp.env_start = int(parsed[12]) - 1\\n hsp.env_end = int(parsed[13])\\n hsp.env_endtype = parsed[14]\\n hsp.acc_avg = float(parsed[15])\\n\\n hsp_list.append(hsp)\\n self.line = read_forward(self.handle)\\n\\n # parse the hsp alignments\\n if self.line.startswith(\\\" Alignments for each domain:\\\"):\\n self._parse_aln_block(hid, hit.hsps)\\n\\n def _parse_aln_block(self, hid, hsp_list):\\n \\\"\\\"\\\"Parse a HMMER3 HSP alignment block (PRIVATE).\\\"\\\"\\\"\\n self.line = read_forward(self.handle)\\n dom_counter = 0\\n while True:\\n if self.line.startswith(\\\">>\\\") or self.line.startswith(\\\"Internal pipeline\\\"):\\n return hsp_list\\n assert self.line.startswith(\\\" == domain %i\\\" % (dom_counter + 1))\\n # alias hsp to local var\\n # but note that we're still changing the attrs of the actual\\n # hsp inside the qresult as we're not creating a copy\\n frag = hsp_list[dom_counter][0]\\n # XXX: should we validate again here? regex is expensive..\\n # regx = re.search(_HRE_VALIDATE, self.line)\\n # assert hsp.bitscore == float(regx.group(1))\\n # assert hsp.evalue_cond == float(regx.group(2))\\n hmmseq = \\\"\\\"\\n aliseq = \\\"\\\"\\n annot = {}\\n self.line = self.handle.readline()\\n\\n # parse all the alignment blocks in the hsp\\n while True:\\n regx = None\\n\\n # check for hit or query line\\n # we don't check for the hit or query id specifically\\n # to anticipate special cases where query id == hit id\\n regx = re.search(_HRE_ID_LINE, self.line)\\n if regx:\\n # the first hit/query self.line we encounter is the hmmseq\\n if len(hmmseq) == len(aliseq):\\n hmmseq += regx.group(2)\\n # and for subsequent self.lines, len(hmmseq) is either\\n # > or == len(aliseq)\\n elif len(hmmseq) > len(aliseq):\\n aliseq += regx.group(2)\\n assert len(hmmseq) >= len(aliseq)\\n # check for start of new domain\\n elif (\\n self.line.startswith(\\\" == domain\\\")\\n or self.line.startswith(\\\">>\\\")\\n or self.line.startswith(\\\"Internal pipeline\\\")\\n ):\\n frag.aln_annotation = annot\\n if self._meta.get(\\\"program\\\") == \\\"hmmscan\\\":\\n frag.hit = hmmseq\\n frag.query = aliseq\\n elif self._meta.get(\\\"program\\\") in [\\\"hmmsearch\\\", \\\"phmmer\\\"]:\\n frag.hit = aliseq\\n frag.query = hmmseq\\n dom_counter += 1\\n hmmseq = \\\"\\\"\\n aliseq = \\\"\\\"\\n annot = {}\\n break\\n # otherwise check if it's an annotation line and parse it\\n # len(hmmseq) is only != len(aliseq) when the cursor is parsing\\n # the similarity character. Since we're not parsing that, we\\n # check for when the condition is False (i.e. when it's ==)\\n elif len(hmmseq) == len(aliseq):\\n regx = re.search(_HRE_ANNOT_LINE, self.line)\\n if regx:\\n annot_name = regx.group(3)\\n if annot_name in annot:\\n annot[annot_name] += regx.group(2)\\n else:\\n annot[annot_name] = regx.group(2)\\n\\n self.line = self.handle.readline()\\n\\n\\nclass Hmmer3TextIndexer(_BaseHmmerTextIndexer):\\n \\\"\\\"\\\"Indexer class for HMMER plain text output.\\\"\\\"\\\"\\n\\n _parser = Hmmer3TextParser\\n qresult_start = b\\\"Query: \\\"\\n qresult_end = b\\\"//\\\"\\n\\n def __iter__(self):\\n \\\"\\\"\\\"Iterate over Hmmer3TextIndexer; yields query results' key, offsets, 0.\\\"\\\"\\\"\\n handle = self._handle\\n handle.seek(0)\\n start_offset = handle.tell()\\n regex_id = re.compile(_QRE_ID_LEN_PTN.encode())\\n\\n while True:\\n line = read_forward(handle)\\n end_offset = handle.tell()\\n\\n if line.startswith(self.qresult_start):\\n regx = re.search(regex_id, line)\\n qresult_key = regx.group(1).strip()\\n # qresult start offset is the offset of this line\\n # (starts with the start mark)\\n start_offset = end_offset - len(line)\\n elif line.startswith(self.qresult_end):\\n yield qresult_key.decode(), start_offset, 0\\n start_offset = end_offset\\n elif not line:\\n break\\n\\n\\n# if not used as a module, run the doctest\\nif __name__ == \\\"__main__\\\":\\n from Bio._utils import run_doctest\\n\\n run_doctest()\\n\",\n \"path\": \"Bio/SearchIO/HmmerIO/hmmer3_text.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"# Copyright 2012 by Wibowo Arindrarto. All rights reserved.\n# This file is part of the Biopython distribution and governed by your\n# choice of the \"Biopython License Agreement\" or the \"BSD 3-Clause License\".\n# Please see the LICENSE file that should have been included as part of this\n# package.\n\"\"\"Bio.SearchIO parser for HMMER plain text output format.\"\"\"\n\nimport re\n\nfrom Bio.SearchIO._utils import read_forward\nfrom Bio.SearchIO._model import QueryResult, Hit, HSP, HSPFragment\n\nfrom ._base import _BaseHmmerTextIndexer\n\n__all__ = (\"Hmmer3TextParser\", \"Hmmer3TextIndexer\")\n\n\n# precompile regex patterns for faster processing\n# regex for program name capture\n_RE_PROGRAM = re.compile(r\"^# .*?(\\w?hmm\\w+) :: .*$\")\n# regex for version string capture\n_RE_VERSION = re.compile(r\"# \\w+ ([\\w+\\.]+) .*; http.*$\")\n# regex for option string capture\n_RE_OPT = re.compile(r\"^# (.+):\\s+(.+)$\")\n# regex for parsing query id and length, for parsing\n_QRE_ID_LEN_PTN = r\"^Query:\\s*(.*)\\s+\\[\\w=(\\d+)\\]\"\n_QRE_ID_LEN = re.compile(_QRE_ID_LEN_PTN)\n# regex for hsp validation\n_HRE_VALIDATE = re.compile(r\"score:\\s(-?\\d+\\.?\\d+)\\sbits.*value:\\s(.*)\")\n# regexes for parsing hsp alignment blocks\n_HRE_ANNOT_LINE = re.compile(r\"^(\\s+)(.+)\\s(\\w+)\")\n_HRE_ID_LINE = re.compile(r\"^(\\s+\\S+\\s+[0-9-]+ )(.+?)(\\s+[0-9-]+)\")\n\n\nclass Hmmer3TextParser:\n \"\"\"Parser for the HMMER 3.0 text output.\"\"\"\n\n def __init__(self, handle):\n \"\"\"Initialize the class.\"\"\"\n self.handle = handle\n self.line = read_forward(self.handle)\n self._meta = self._parse_preamble()\n\n def __iter__(self):\n \"\"\"Iterate over query results.\"\"\"\n yield from self._parse_qresult()\n\n def _read_until(self, bool_func):\n \"\"\"Read the file handle until the given function returns True (PRIVATE).\"\"\"\n while True:\n if not self.line or bool_func(self.line):\n return\n else:\n self.line = read_forward(self.handle)\n\n def _parse_preamble(self):\n \"\"\"Parse HMMER preamble (lines beginning with '#') (PRIVATE).\"\"\"\n meta = {}\n # bool flag for storing state ~ whether we are parsing the option\n # lines or not\n has_opts = False\n while True:\n # no pound sign means we've left the preamble\n if not self.line.startswith(\"#\"):\n break\n # dashes could either mean we are entering or leaving the options\n # section ~ so it's a switch for the has_opts flag\n elif \"- - -\" in self.line:\n if not has_opts:\n # if flag is false, that means we're entering opts\n # so switch the flag accordingly\n has_opts = True\n else:\n # if flag is true, that means we've reached the end of opts\n # so we can break out of the function\n break\n elif not has_opts:\n # try parsing program\n regx = re.search(_RE_PROGRAM, self.line)\n if regx:\n meta[\"program\"] = regx.group(1)\n # try parsing version\n regx = re.search(_RE_VERSION, self.line)\n if regx:\n meta[\"version\"] = regx.group(1)\n elif has_opts:\n regx = re.search(_RE_OPT, self.line)\n # if target in regx.group(1), then we store the key as target\n if \"target\" in regx.group(1):\n meta[\"target\"] = regx.group(2).strip()\n else:\n meta[regx.group(1)] = regx.group(2)\n\n self.line = read_forward(self.handle)\n\n return meta\n\n def _parse_qresult(self):\n \"\"\"Parse a HMMER3 query block (PRIVATE).\"\"\"\n self._read_until(lambda line: line.startswith(\"Query:\"))\n\n while self.line:\n regx = re.search(_QRE_ID_LEN, self.line)\n\n while not regx:\n self.line = read_forward(self.handle)\n regx = re.search(_QRE_ID_LEN, self.line)\n\n # get query id and length\n qid = regx.group(1).strip()\n # store qresult attributes\n qresult_attrs = {\n \"seq_len\": int(regx.group(2)),\n \"program\": self._meta.get(\"program\"),\n \"version\": self._meta.get(\"version\"),\n \"target\": self._meta.get(\"target\"),\n }\n\n # get description and accession, if they exist\n qdesc = \"<unknown description>\" # placeholder\n while not self.line.startswith(\"Scores for \"):\n self.line = read_forward(self.handle)\n\n if self.line.startswith(\"Accession:\"):\n acc = self.line.strip().split(\" \", 1)[1]\n qresult_attrs[\"accession\"] = acc.strip()\n elif self.line.startswith(\"Description:\"):\n qdesc = self.line.strip().split(\" \", 1)[1].strip()\n qresult_attrs[\"description\"] = qdesc\n\n # parse the query hits\n while self.line and \"//\" not in self.line:\n hit_list = self._parse_hit(qid, qdesc)\n # read through the statistics summary\n # TODO: parse and store this information?\n if self.line.startswith(\"Internal pipeline\"):\n while self.line and \"//\" not in self.line:\n self.line = read_forward(self.handle)\n\n # create qresult, set its attributes and yield\n # not initializing hit_list directly to handle empty hits\n # (i.e. need to set its query description manually)\n qresult = QueryResult(id=qid, hits=hit_list)\n for attr, value in qresult_attrs.items():\n setattr(qresult, attr, value)\n yield qresult\n self.line = read_forward(self.handle)\n\n # Skip line beginning with '# Alignment of', which are output\n # when running phmmer with the '-A' flag.\n if self.line.startswith(\"#\"):\n self.line = self.handle.readline()\n\n # HMMER >= 3.1 outputs '[ok]' at the end of all results file,\n # which means we can break the main loop when we see the line\n if \"[ok]\" in self.line:\n break\n\n def _parse_hit(self, qid, qdesc):\n \"\"\"Parse a HMMER3 hit block, beginning with the hit table (PRIVATE).\"\"\"\n # get to the end of the hit table delimiter and read one more line\n self._read_until(lambda line: line.startswith(\" ------- ------ -----\"))\n self.line = read_forward(self.handle)\n\n # assume every hit is in inclusion threshold until the inclusion\n # threshold line is encountered\n is_included = True\n\n # parse the hit table\n hit_attr_list = []\n while True:\n if not self.line:\n return []\n elif self.line.startswith(\" ------ inclusion\"):\n is_included = False\n self.line = read_forward(self.handle)\n # if there are no hits, then there are no hsps\n # so we forward-read until 'Internal pipeline..'\n elif self.line.startswith(\" [No hits detected that satisfy reporting\"):\n while True:\n self.line = read_forward(self.handle)\n if self.line.startswith(\"Internal pipeline\"):\n assert len(hit_attr_list) == 0\n return []\n elif self.line.startswith(\"Domain annotation for each \"):\n hit_list = self._create_hits(hit_attr_list, qid, qdesc)\n return hit_list\n # entering hit results row\n # parse the columns into a list\n row = [x for x in self.line.strip().split(\" \") if x]\n # join the description words if it's >1 word\n if len(row) > 10:\n row[9] = \" \".join(row[9:])\n # if there's no description, set it to an empty string\n elif len(row) < 10:\n row.append(\"\")\n assert len(row) == 10\n # create the hit object\n hit_attrs = {\n \"id\": row[8],\n \"query_id\": qid,\n \"evalue\": float(row[0]),\n \"bitscore\": float(row[1]),\n \"bias\": float(row[2]),\n # row[3:6] is not parsed, since the info is available\n # at the HSP level\n \"domain_exp_num\": float(row[6]),\n \"domain_obs_num\": int(row[7]),\n \"description\": row[9],\n \"is_included\": is_included,\n }\n hit_attr_list.append(hit_attrs)\n\n self.line = read_forward(self.handle)\n\n def _create_hits(self, hit_attrs, qid, qdesc):\n \"\"\"Parse a HMMER3 hsp block, beginning with the hsp table (PRIVATE).\"\"\"\n # read through until the beginning of the hsp block\n self._read_until(\n lambda line: line.startswith(\"Internal pipeline\") or line.startswith(\">>\")\n )\n\n # start parsing the hsp block\n hit_list = []\n while True:\n if self.line.startswith(\"Internal pipeline\"):\n # by this time we should've emptied the hit attr list\n assert len(hit_attrs) == 0\n return hit_list\n assert self.line.startswith(\">>\")\n hid, hdesc = self.line[len(\">> \") :].split(\" \", 1)\n hdesc = hdesc.strip()\n\n # read through the hsp table header and move one more line\n self._read_until(\n lambda line: line.startswith(\" --- ------ ----- --------\")\n or line.startswith(\" [No individual domains\")\n )\n self.line = read_forward(self.handle)\n\n # parse the hsp table for the current hit\n hsp_list = []\n while True:\n # break out of hsp parsing if there are no hits, it's the last hsp\n # or it's the start of a new hit\n if (\n self.line.startswith(\" [No targets detected that satisfy\")\n or self.line.startswith(\" [No individual domains\")\n or self.line.startswith(\"Internal pipeline statistics summary:\")\n or self.line.startswith(\" Alignments for each domain:\")\n or self.line.startswith(\">>\")\n ):\n hit_attr = hit_attrs.pop(0)\n hit = Hit(hsp_list)\n for attr, value in hit_attr.items():\n if attr == \"description\":\n cur_val = getattr(hit, attr)\n if cur_val and value and cur_val.startswith(value):\n continue\n setattr(hit, attr, value)\n if not hit:\n hit.query_description = qdesc\n hit_list.append(hit)\n break\n\n parsed = [x for x in self.line.strip().split(\" \") if x]\n assert len(parsed) == 16\n # parsed column order:\n # index, is_included, bitscore, bias, evalue_cond, evalue\n # hmmfrom, hmmto, query_ends, hit_ends, alifrom, alito,\n # envfrom, envto, acc_avg\n frag = HSPFragment(hid, qid)\n # set query and hit descriptions if they are defined / nonempty string\n if qdesc:\n frag.query_description = qdesc\n if hdesc:\n frag.hit_description = hdesc\n # HMMER3 results are always protein\n frag.molecule_type = \"protein\"\n # depending on whether the program is hmmsearch, hmmscan, or phmmer\n # {hmm,ali}{from,to} can either be hit_{from,to} or query_{from,to}\n # for hmmscan, hit is the hmm profile, query is the sequence\n if self._meta.get(\"program\") == \"hmmscan\":\n # adjust 'from' and 'to' coordinates to 0-based ones\n frag.hit_start = int(parsed[6]) - 1\n frag.hit_end = int(parsed[7])\n frag.query_start = int(parsed[9]) - 1\n frag.query_end = int(parsed[10])\n elif self._meta.get(\"program\") in [\"hmmsearch\", \"phmmer\"]:\n # adjust 'from' and 'to' coordinates to 0-based ones\n frag.hit_start = int(parsed[9]) - 1\n frag.hit_end = int(parsed[10])\n frag.query_start = int(parsed[6]) - 1\n frag.query_end = int(parsed[7])\n # strand is always 0, since HMMER now only handles protein\n frag.hit_strand = frag.query_strand = 0\n\n hsp = HSP([frag])\n hsp.domain_index = int(parsed[0])\n hsp.is_included = parsed[1] == \"!\"\n hsp.bitscore = float(parsed[2])\n hsp.bias = float(parsed[3])\n hsp.evalue_cond = float(parsed[4])\n hsp.evalue = float(parsed[5])\n if self._meta.get(\"program\") == \"hmmscan\":\n # adjust 'from' and 'to' coordinates to 0-based ones\n hsp.hit_endtype = parsed[8]\n hsp.query_endtype = parsed[11]\n elif self._meta.get(\"program\") in [\"hmmsearch\", \"phmmer\"]:\n # adjust 'from' and 'to' coordinates to 0-based ones\n hsp.hit_endtype = parsed[11]\n hsp.query_endtype = parsed[8]\n # adjust 'from' and 'to' coordinates to 0-based ones\n hsp.env_start = int(parsed[12]) - 1\n hsp.env_end = int(parsed[13])\n hsp.env_endtype = parsed[14]\n hsp.acc_avg = float(parsed[15])\n\n hsp_list.append(hsp)\n self.line = read_forward(self.handle)\n\n # parse the hsp alignments\n if self.line.startswith(\" Alignments for each domain:\"):\n self._parse_aln_block(hid, hit.hsps)\n\n def _parse_aln_block(self, hid, hsp_list):\n \"\"\"Parse a HMMER3 HSP alignment block (PRIVATE).\"\"\"\n self.line = read_forward(self.handle)\n dom_counter = 0\n while True:\n if self.line.startswith(\">>\") or self.line.startswith(\"Internal pipeline\"):\n return hsp_list\n assert self.line.startswith(\" == domain %i\" % (dom_counter + 1))\n # alias hsp to local var\n # but note that we're still changing the attrs of the actual\n # hsp inside the qresult as we're not creating a copy\n frag = hsp_list[dom_counter][0]\n # XXX: should we validate again here? regex is expensive..\n # regx = re.search(_HRE_VALIDATE, self.line)\n # assert hsp.bitscore == float(regx.group(1))\n # assert hsp.evalue_cond == float(regx.group(2))\n hmmseq = \"\"\n aliseq = \"\"\n annot = {}\n self.line = self.handle.readline()\n\n # parse all the alignment blocks in the hsp\n while True:\n regx = None\n\n # check for hit or query line\n # we don't check for the hit or query id specifically\n # to anticipate special cases where query id == hit id\n regx = re.search(_HRE_ID_LINE, self.line)\n if regx:\n # the first hit/query self.line we encounter is the hmmseq\n if len(hmmseq) == len(aliseq):\n hmmseq += regx.group(2)\n # and for subsequent self.lines, len(hmmseq) is either\n # > or == len(aliseq)\n elif len(hmmseq) > len(aliseq):\n aliseq += regx.group(2)\n assert len(hmmseq) >= len(aliseq)\n # check for start of new domain\n elif (\n self.line.startswith(\" == domain\")\n or self.line.startswith(\">>\")\n or self.line.startswith(\"Internal pipeline\")\n ):\n frag.aln_annotation = annot\n if self._meta.get(\"program\") == \"hmmscan\":\n frag.hit = hmmseq\n frag.query = aliseq\n elif self._meta.get(\"program\") in [\"hmmsearch\", \"phmmer\"]:\n frag.hit = aliseq\n frag.query = hmmseq\n dom_counter += 1\n hmmseq = \"\"\n aliseq = \"\"\n annot = {}\n break\n # otherwise check if it's an annotation line and parse it\n # len(hmmseq) is only != len(aliseq) when the cursor is parsing\n # the similarity character. Since we're not parsing that, we\n # check for when the condition is False (i.e. when it's ==)\n elif len(hmmseq) == len(aliseq):\n regx = re.search(_HRE_ANNOT_LINE, self.line)\n if regx:\n annot_name = regx.group(3)\n if annot_name in annot:\n annot[annot_name] += regx.group(2)\n else:\n annot[annot_name] = regx.group(2)\n\n self.line = self.handle.readline()\n\n\nclass Hmmer3TextIndexer(_BaseHmmerTextIndexer):\n \"\"\"Indexer class for HMMER plain text output.\"\"\"\n\n _parser = Hmmer3TextParser\n qresult_start = b\"Query: \"\n qresult_end = b\"//\"\n\n def __iter__(self):\n \"\"\"Iterate over Hmmer3TextIndexer; yields query results' key, offsets, 0.\"\"\"\n handle = self._handle\n handle.seek(0)\n start_offset = handle.tell()\n regex_id = re.compile(_QRE_ID_LEN_PTN.encode())\n\n while True:\n line = read_forward(handle)\n end_offset = handle.tell()\n\n if line.startswith(self.qresult_start):\n regx = re.search(regex_id, line)\n qresult_key = regx.group(1).strip()\n # qresult start offset is the offset of this line\n # (starts with the start mark)\n start_offset = end_offset - len(line)\n elif line.startswith(self.qresult_end):\n yield qresult_key.decode(), start_offset, 0\n start_offset = end_offset\n elif not line:\n break\n\n\n# if not used as a module, run the doctest\nif __name__ == \"__main__\":\n from Bio._utils import run_doctest\n\n run_doctest()\n","path":"Bio/SearchIO/HmmerIO/hmmer3_text.py"}],"string":"[\n {\n \"content\": \"# Copyright 2012 by Wibowo Arindrarto. All rights reserved.\\n# This file is part of the Biopython distribution and governed by your\\n# choice of the \\\"Biopython License Agreement\\\" or the \\\"BSD 3-Clause License\\\".\\n# Please see the LICENSE file that should have been included as part of this\\n# package.\\n\\\"\\\"\\\"Bio.SearchIO parser for HMMER plain text output format.\\\"\\\"\\\"\\n\\nimport re\\n\\nfrom Bio.SearchIO._utils import read_forward\\nfrom Bio.SearchIO._model import QueryResult, Hit, HSP, HSPFragment\\n\\nfrom ._base import _BaseHmmerTextIndexer\\n\\n__all__ = (\\\"Hmmer3TextParser\\\", \\\"Hmmer3TextIndexer\\\")\\n\\n\\n# precompile regex patterns for faster processing\\n# regex for program name capture\\n_RE_PROGRAM = re.compile(r\\\"^# .*?(\\\\w?hmm\\\\w+) :: .*$\\\")\\n# regex for version string capture\\n_RE_VERSION = re.compile(r\\\"# \\\\w+ ([\\\\w+\\\\.]+) .*; http.*$\\\")\\n# regex for option string capture\\n_RE_OPT = re.compile(r\\\"^# (.+):\\\\s+(.+)$\\\")\\n# regex for parsing query id and length, for parsing\\n_QRE_ID_LEN_PTN = r\\\"^Query:\\\\s*(.*)\\\\s+\\\\[\\\\w=(\\\\d+)\\\\]\\\"\\n_QRE_ID_LEN = re.compile(_QRE_ID_LEN_PTN)\\n# regex for hsp validation\\n_HRE_VALIDATE = re.compile(r\\\"score:\\\\s(-?\\\\d+\\\\.?\\\\d+)\\\\sbits.*value:\\\\s(.*)\\\")\\n# regexes for parsing hsp alignment blocks\\n_HRE_ANNOT_LINE = re.compile(r\\\"^(\\\\s+)(.+)\\\\s(\\\\w+)\\\")\\n_HRE_ID_LINE = re.compile(r\\\"^(\\\\s+\\\\S+\\\\s+[0-9-]+ )(.+?)(\\\\s+[0-9-]+)\\\")\\n\\n\\nclass Hmmer3TextParser:\\n \\\"\\\"\\\"Parser for the HMMER 3.0 text output.\\\"\\\"\\\"\\n\\n def __init__(self, handle):\\n \\\"\\\"\\\"Initialize the class.\\\"\\\"\\\"\\n self.handle = handle\\n self.line = read_forward(self.handle)\\n self._meta = self._parse_preamble()\\n\\n def __iter__(self):\\n \\\"\\\"\\\"Iterate over query results.\\\"\\\"\\\"\\n yield from self._parse_qresult()\\n\\n def _read_until(self, bool_func):\\n \\\"\\\"\\\"Read the file handle until the given function returns True (PRIVATE).\\\"\\\"\\\"\\n while True:\\n if not self.line or bool_func(self.line):\\n return\\n else:\\n self.line = read_forward(self.handle)\\n\\n def _parse_preamble(self):\\n \\\"\\\"\\\"Parse HMMER preamble (lines beginning with '#') (PRIVATE).\\\"\\\"\\\"\\n meta = {}\\n # bool flag for storing state ~ whether we are parsing the option\\n # lines or not\\n has_opts = False\\n while True:\\n # no pound sign means we've left the preamble\\n if not self.line.startswith(\\\"#\\\"):\\n break\\n # dashes could either mean we are entering or leaving the options\\n # section ~ so it's a switch for the has_opts flag\\n elif \\\"- - -\\\" in self.line:\\n if not has_opts:\\n # if flag is false, that means we're entering opts\\n # so switch the flag accordingly\\n has_opts = True\\n else:\\n # if flag is true, that means we've reached the end of opts\\n # so we can break out of the function\\n break\\n elif not has_opts:\\n # try parsing program\\n regx = re.search(_RE_PROGRAM, self.line)\\n if regx:\\n meta[\\\"program\\\"] = regx.group(1)\\n # try parsing version\\n regx = re.search(_RE_VERSION, self.line)\\n if regx:\\n meta[\\\"version\\\"] = regx.group(1)\\n elif has_opts:\\n regx = re.search(_RE_OPT, self.line)\\n # if target in regx.group(1), then we store the key as target\\n if \\\"target\\\" in regx.group(1):\\n meta[\\\"target\\\"] = regx.group(2).strip()\\n else:\\n meta[regx.group(1)] = regx.group(2)\\n\\n self.line = read_forward(self.handle)\\n\\n return meta\\n\\n def _parse_qresult(self):\\n \\\"\\\"\\\"Parse a HMMER3 query block (PRIVATE).\\\"\\\"\\\"\\n self._read_until(lambda line: line.startswith(\\\"Query:\\\"))\\n\\n while self.line:\\n regx = re.search(_QRE_ID_LEN, self.line)\\n\\n while not regx:\\n self.line = read_forward(self.handle)\\n regx = re.search(_QRE_ID_LEN, self.line)\\n\\n # get query id and length\\n qid = regx.group(1).strip()\\n # store qresult attributes\\n qresult_attrs = {\\n \\\"seq_len\\\": int(regx.group(2)),\\n \\\"program\\\": self._meta.get(\\\"program\\\"),\\n \\\"version\\\": self._meta.get(\\\"version\\\"),\\n \\\"target\\\": self._meta.get(\\\"target\\\"),\\n }\\n\\n # get description and accession, if they exist\\n qdesc = \\\"<unknown description>\\\" # placeholder\\n while not self.line.startswith(\\\"Scores for \\\"):\\n self.line = read_forward(self.handle)\\n\\n if self.line.startswith(\\\"Accession:\\\"):\\n acc = self.line.strip().split(\\\" \\\", 1)[1]\\n qresult_attrs[\\\"accession\\\"] = acc.strip()\\n elif self.line.startswith(\\\"Description:\\\"):\\n qdesc = self.line.strip().split(\\\" \\\", 1)[1].strip()\\n qresult_attrs[\\\"description\\\"] = qdesc\\n\\n # parse the query hits\\n while self.line and \\\"//\\\" not in self.line:\\n hit_list = self._parse_hit(qid, qdesc)\\n # read through the statistics summary\\n # TODO: parse and store this information?\\n if self.line.startswith(\\\"Internal pipeline\\\"):\\n while self.line and \\\"//\\\" not in self.line:\\n self.line = read_forward(self.handle)\\n\\n # create qresult, set its attributes and yield\\n # not initializing hit_list directly to handle empty hits\\n # (i.e. need to set its query description manually)\\n qresult = QueryResult(id=qid, hits=hit_list)\\n for attr, value in qresult_attrs.items():\\n setattr(qresult, attr, value)\\n yield qresult\\n self.line = read_forward(self.handle)\\n\\n # Skip line beginning with '# Alignment of', which are output\\n # when running phmmer with the '-A' flag.\\n if self.line.startswith(\\\"#\\\"):\\n self.line = self.handle.readline()\\n\\n # HMMER >= 3.1 outputs '[ok]' at the end of all results file,\\n # which means we can break the main loop when we see the line\\n if \\\"[ok]\\\" in self.line:\\n break\\n\\n def _parse_hit(self, qid, qdesc):\\n \\\"\\\"\\\"Parse a HMMER3 hit block, beginning with the hit table (PRIVATE).\\\"\\\"\\\"\\n # get to the end of the hit table delimiter and read one more line\\n self._read_until(lambda line: line.startswith(\\\" ------- ------ -----\\\"))\\n self.line = read_forward(self.handle)\\n\\n # assume every hit is in inclusion threshold until the inclusion\\n # threshold line is encountered\\n is_included = True\\n\\n # parse the hit table\\n hit_attr_list = []\\n while True:\\n if not self.line:\\n return []\\n elif self.line.startswith(\\\" ------ inclusion\\\"):\\n is_included = False\\n self.line = read_forward(self.handle)\\n # if there are no hits, then there are no hsps\\n # so we forward-read until 'Internal pipeline..'\\n elif self.line.startswith(\\\" [No hits detected that satisfy reporting\\\"):\\n while True:\\n self.line = read_forward(self.handle)\\n if self.line.startswith(\\\"Internal pipeline\\\"):\\n assert len(hit_attr_list) == 0\\n return []\\n elif self.line.startswith(\\\"Domain annotation for each \\\"):\\n hit_list = self._create_hits(hit_attr_list, qid, qdesc)\\n return hit_list\\n # entering hit results row\\n # parse the columns into a list\\n row = [x for x in self.line.strip().split(\\\" \\\") if x]\\n # join the description words if it's >1 word\\n if len(row) > 10:\\n row[9] = \\\" \\\".join(row[9:])\\n # if there's no description, set it to an empty string\\n elif len(row) < 10:\\n row.append(\\\"\\\")\\n assert len(row) == 10\\n # create the hit object\\n hit_attrs = {\\n \\\"id\\\": row[8],\\n \\\"query_id\\\": qid,\\n \\\"evalue\\\": float(row[0]),\\n \\\"bitscore\\\": float(row[1]),\\n \\\"bias\\\": float(row[2]),\\n # row[3:6] is not parsed, since the info is available\\n # at the HSP level\\n \\\"domain_exp_num\\\": float(row[6]),\\n \\\"domain_obs_num\\\": int(row[7]),\\n \\\"description\\\": row[9],\\n \\\"is_included\\\": is_included,\\n }\\n hit_attr_list.append(hit_attrs)\\n\\n self.line = read_forward(self.handle)\\n\\n def _create_hits(self, hit_attrs, qid, qdesc):\\n \\\"\\\"\\\"Parse a HMMER3 hsp block, beginning with the hsp table (PRIVATE).\\\"\\\"\\\"\\n # read through until the beginning of the hsp block\\n self._read_until(\\n lambda line: line.startswith(\\\"Internal pipeline\\\") or line.startswith(\\\">>\\\")\\n )\\n\\n # start parsing the hsp block\\n hit_list = []\\n while True:\\n if self.line.startswith(\\\"Internal pipeline\\\"):\\n # by this time we should've emptied the hit attr list\\n assert len(hit_attrs) == 0\\n return hit_list\\n assert self.line.startswith(\\\">>\\\")\\n hid, hdesc = self.line[len(\\\">> \\\") :].split(\\\" \\\", 1)\\n hdesc = hdesc.strip()\\n\\n # read through the hsp table header and move one more line\\n self._read_until(\\n lambda line: line.startswith(\\\" --- ------ ----- --------\\\")\\n or line.startswith(\\\" [No individual domains\\\")\\n )\\n self.line = read_forward(self.handle)\\n\\n # parse the hsp table for the current hit\\n hsp_list = []\\n while True:\\n # break out of hsp parsing if there are no hits, it's the last hsp\\n # or it's the start of a new hit\\n if (\\n self.line.startswith(\\\" [No targets detected that satisfy\\\")\\n or self.line.startswith(\\\" [No individual domains\\\")\\n or self.line.startswith(\\\"Internal pipeline statistics summary:\\\")\\n or self.line.startswith(\\\" Alignments for each domain:\\\")\\n or self.line.startswith(\\\">>\\\")\\n ):\\n hit_attr = hit_attrs.pop(0)\\n hit = Hit(hsp_list)\\n for attr, value in hit_attr.items():\\n if attr == \\\"description\\\":\\n cur_val = getattr(hit, attr)\\n if cur_val and value and cur_val.startswith(value):\\n continue\\n setattr(hit, attr, value)\\n if not hit:\\n hit.query_description = qdesc\\n hit_list.append(hit)\\n break\\n\\n parsed = [x for x in self.line.strip().split(\\\" \\\") if x]\\n assert len(parsed) == 16\\n # parsed column order:\\n # index, is_included, bitscore, bias, evalue_cond, evalue\\n # hmmfrom, hmmto, query_ends, hit_ends, alifrom, alito,\\n # envfrom, envto, acc_avg\\n frag = HSPFragment(hid, qid)\\n # set query and hit descriptions if they are defined / nonempty string\\n if qdesc:\\n frag.query_description = qdesc\\n if hdesc:\\n frag.hit_description = hdesc\\n # HMMER3 results are always protein\\n frag.molecule_type = \\\"protein\\\"\\n # depending on whether the program is hmmsearch, hmmscan, or phmmer\\n # {hmm,ali}{from,to} can either be hit_{from,to} or query_{from,to}\\n # for hmmscan, hit is the hmm profile, query is the sequence\\n if self._meta.get(\\\"program\\\") == \\\"hmmscan\\\":\\n # adjust 'from' and 'to' coordinates to 0-based ones\\n frag.hit_start = int(parsed[6]) - 1\\n frag.hit_end = int(parsed[7])\\n frag.query_start = int(parsed[9]) - 1\\n frag.query_end = int(parsed[10])\\n elif self._meta.get(\\\"program\\\") in [\\\"hmmsearch\\\", \\\"phmmer\\\"]:\\n # adjust 'from' and 'to' coordinates to 0-based ones\\n frag.hit_start = int(parsed[9]) - 1\\n frag.hit_end = int(parsed[10])\\n frag.query_start = int(parsed[6]) - 1\\n frag.query_end = int(parsed[7])\\n # strand is always 0, since HMMER now only handles protein\\n frag.hit_strand = frag.query_strand = 0\\n\\n hsp = HSP([frag])\\n hsp.domain_index = int(parsed[0])\\n hsp.is_included = parsed[1] == \\\"!\\\"\\n hsp.bitscore = float(parsed[2])\\n hsp.bias = float(parsed[3])\\n hsp.evalue_cond = float(parsed[4])\\n hsp.evalue = float(parsed[5])\\n if self._meta.get(\\\"program\\\") == \\\"hmmscan\\\":\\n # adjust 'from' and 'to' coordinates to 0-based ones\\n hsp.hit_endtype = parsed[8]\\n hsp.query_endtype = parsed[11]\\n elif self._meta.get(\\\"program\\\") in [\\\"hmmsearch\\\", \\\"phmmer\\\"]:\\n # adjust 'from' and 'to' coordinates to 0-based ones\\n hsp.hit_endtype = parsed[11]\\n hsp.query_endtype = parsed[8]\\n # adjust 'from' and 'to' coordinates to 0-based ones\\n hsp.env_start = int(parsed[12]) - 1\\n hsp.env_end = int(parsed[13])\\n hsp.env_endtype = parsed[14]\\n hsp.acc_avg = float(parsed[15])\\n\\n hsp_list.append(hsp)\\n self.line = read_forward(self.handle)\\n\\n # parse the hsp alignments\\n if self.line.startswith(\\\" Alignments for each domain:\\\"):\\n self._parse_aln_block(hid, hit.hsps)\\n\\n def _parse_aln_block(self, hid, hsp_list):\\n \\\"\\\"\\\"Parse a HMMER3 HSP alignment block (PRIVATE).\\\"\\\"\\\"\\n self.line = read_forward(self.handle)\\n dom_counter = 0\\n while True:\\n if self.line.startswith(\\\">>\\\") or self.line.startswith(\\\"Internal pipeline\\\"):\\n return hsp_list\\n assert self.line.startswith(\\\" == domain %i\\\" % (dom_counter + 1))\\n # alias hsp to local var\\n # but note that we're still changing the attrs of the actual\\n # hsp inside the qresult as we're not creating a copy\\n frag = hsp_list[dom_counter][0]\\n # XXX: should we validate again here? regex is expensive..\\n # regx = re.search(_HRE_VALIDATE, self.line)\\n # assert hsp.bitscore == float(regx.group(1))\\n # assert hsp.evalue_cond == float(regx.group(2))\\n hmmseq = \\\"\\\"\\n aliseq = \\\"\\\"\\n annot = {}\\n self.line = self.handle.readline()\\n\\n # parse all the alignment blocks in the hsp\\n while True:\\n regx = None\\n\\n # check for hit or query line\\n # we don't check for the hit or query id specifically\\n # to anticipate special cases where query id == hit id\\n regx = re.search(_HRE_ID_LINE, self.line)\\n if regx:\\n # the first hit/query self.line we encounter is the hmmseq\\n if len(hmmseq) == len(aliseq):\\n hmmseq += regx.group(2)\\n # and for subsequent self.lines, len(hmmseq) is either\\n # > or == len(aliseq)\\n elif len(hmmseq) > len(aliseq):\\n aliseq += regx.group(2)\\n assert len(hmmseq) >= len(aliseq)\\n # check for start of new domain\\n elif (\\n self.line.startswith(\\\" == domain\\\")\\n or self.line.startswith(\\\">>\\\")\\n or self.line.startswith(\\\"Internal pipeline\\\")\\n ):\\n frag.aln_annotation = annot\\n if self._meta.get(\\\"program\\\") == \\\"hmmscan\\\":\\n frag.hit = hmmseq\\n frag.query = aliseq\\n elif self._meta.get(\\\"program\\\") in [\\\"hmmsearch\\\", \\\"phmmer\\\"]:\\n frag.hit = aliseq\\n frag.query = hmmseq\\n dom_counter += 1\\n hmmseq = \\\"\\\"\\n aliseq = \\\"\\\"\\n annot = {}\\n break\\n # otherwise check if it's an annotation line and parse it\\n # len(hmmseq) is only != len(aliseq) when the cursor is parsing\\n # the similarity character. Since we're not parsing that, we\\n # check for when the condition is False (i.e. when it's ==)\\n elif len(hmmseq) == len(aliseq):\\n regx = re.search(_HRE_ANNOT_LINE, self.line)\\n if regx:\\n annot_name = regx.group(3)\\n if annot_name in annot:\\n annot[annot_name] += regx.group(2)\\n else:\\n annot[annot_name] = regx.group(2)\\n\\n self.line = self.handle.readline()\\n\\n\\nclass Hmmer3TextIndexer(_BaseHmmerTextIndexer):\\n \\\"\\\"\\\"Indexer class for HMMER plain text output.\\\"\\\"\\\"\\n\\n _parser = Hmmer3TextParser\\n qresult_start = b\\\"Query: \\\"\\n qresult_end = b\\\"//\\\"\\n\\n def __iter__(self):\\n \\\"\\\"\\\"Iterate over Hmmer3TextIndexer; yields query results' key, offsets, 0.\\\"\\\"\\\"\\n handle = self._handle\\n handle.seek(0)\\n start_offset = handle.tell()\\n regex_id = re.compile(_QRE_ID_LEN_PTN.encode())\\n\\n while True:\\n line = read_forward(handle)\\n end_offset = handle.tell()\\n\\n if line.startswith(self.qresult_start):\\n regx = re.search(regex_id, line)\\n qresult_key = regx.group(1).strip()\\n # qresult start offset is the offset of this line\\n # (starts with the start mark)\\n start_offset = end_offset - len(line)\\n elif line.startswith(self.qresult_end):\\n yield qresult_key.decode(), start_offset, 0\\n start_offset = end_offset\\n elif not line:\\n break\\n\\n\\n# if not used as a module, run the doctest\\nif __name__ == \\\"__main__\\\":\\n from Bio._utils import run_doctest\\n\\n run_doctest()\\n\",\n \"path\": \"Bio/SearchIO/HmmerIO/hmmer3_text.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/Bio/SearchIO/HmmerIO/hmmer3_text.py b/Bio/SearchIO/HmmerIO/hmmer3_text.py\nindex d564bed58b8..3cb88601f92 100644\n--- a/Bio/SearchIO/HmmerIO/hmmer3_text.py\n+++ b/Bio/SearchIO/HmmerIO/hmmer3_text.py\n@@ -17,7 +17,7 @@\n \n # precompile regex patterns for faster processing\n # regex for program name capture\n-_RE_PROGRAM = re.compile(r\"^# (\\w*hmm\\w+) :: .*$\")\n+_RE_PROGRAM = re.compile(r\"^# .*?(\\w?hmm\\w+) :: .*$\")\n # regex for version string capture\n _RE_VERSION = re.compile(r\"# \\w+ ([\\w+\\.]+) .*; http.*$\")\n # regex for option string capture\ndiff --git a/CONTRIB.rst b/CONTRIB.rst\nindex 645c3fee418..cd899a31742 100644\n--- a/CONTRIB.rst\n+++ b/CONTRIB.rst\n@@ -152,6 +152,7 @@ please open an issue on GitHub or mention it on the mailing list.\n - Jacek Śmietański <https://github.com/dadoskawina>\n - Jack Twilley <https://github.com/mathuin>\n - Jacob Beal <https://github.com/jakebeal>\n+- Jacob Byerly <https://github.com/byerlyj>\n - Jakub Lipinski <https://github.com/jakublipinski>\n - James Baker <https://github.com/JamesABaker>\n - James Casbon <https://github.com/jamescasbon>\ndiff --git a/NEWS.rst b/NEWS.rst\nindex 1ffae5d5709..2a6fda82941 100644\n--- a/NEWS.rst\n+++ b/NEWS.rst\n@@ -16,6 +16,10 @@ The latest news is at the top of this file.\n This release of Biopython supports Python 3.8, 3.9, 3.10, 3.11 and 3.12. It\n has also been tested on PyPy3.8 v7.8.16.\n \n+HMMER results with the full path to the hmmer executable in the banner are\n+now parsed correctly. This should help Windows users and users with python\n+installations in non-default locations.\n+\n We now have basic type hint annotations in various modules including ``Seq``,\n ``SeqRecord``, and ``SeqIO``. This should help anyone using an editor or IDE\n with type-aware autocomplete, or in conjunction with mypy as a pre-commit\n@@ -79,6 +83,7 @@ possible, especially the following contributors:\n - Arpan Sahoo (first contribution)\n - Benedict Carling (first contribution)\n - Cam McMenamie (first contribution)\n+- Jacob Byerly (first contribution)\n - João Rodrigues\n - Joe Greener\n - Michael R. Crusoe\ndiff --git a/Tests/Hmmer/README.txt b/Tests/Hmmer/README.txt\nindex e17c93200e6..b1b9429a69f 100644\n--- a/Tests/Hmmer/README.txt\n+++ b/Tests/Hmmer/README.txt\n@@ -19,6 +19,7 @@ text_30_hmmscan_007.out single query, one match, no alignment\n text_30_hmmscan_008.out single query, multiple matches, no alignment width\n text_30_hmmscan_009.out single query, alignment block(s) with large gaps (bug 3399 in Redmine)\n text_30_hmmscan_010.out\n+text_30_hmmscan_011.out single query, multiple matches, windows-style hmmscan executable path with whitespace\n text_31b1_hmmsearch_001.out multiple queries\n text_30_hmmsearch_001.out single query, no match\n text_30_hmmsearch_002.out single query, multiple matches, multiple hsps per match\ndiff --git a/Tests/Hmmer/text_30_hmmscan_011.out b/Tests/Hmmer/text_30_hmmscan_011.out\nnew file mode 100644\nindex 00000000000..3a5962b516e\n--- /dev/null\n+++ b/Tests/Hmmer/text_30_hmmscan_011.out\n@@ -0,0 +1,1425 @@\n+# C:\\msys64\\scr\\byerly\\builds\\NB\\20231025 _\\thirdparty\\bin\\Windows-x64\\hmmer\\bin\\hmmscan :: search sequence(s) against a profile database\n+# HMMER 3.1b2 (February 2015); http://hmmer.org/\n+# Copyright (C) 2015 Howard Hughes Medical Institute.\n+# Freely distributed under the GNU General Public License (GPLv3).\n+# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -\n+# query sequence file: C:\\Users\\byerly\\AppData\\Local\\Temp\\tmpt7psecrp.fasta\n+# target HMM database: C:\\msys64\\scr\\byerly\\builds\\NB\\20231025 _\\internal\\lib\\site-packages\\anarci\\dat\\HMMs\\ALL.hmm\n+# output directed to file: C:\\Users\\byerly\\AppData\\Local\\Temp\\tmp2u1a0mw3.txt\n+# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -\n+\n+Query: 6FR3 [L=202]\n+Scores for complete sequence (score includes all domains):\n+ --- full sequence --- --- best 1 domain --- -#dom-\n+ E-value score bias E-value score bias exp N Model Description\n+ ------- ------ ----- ------- ------ ----- ---- -- -------- -----------\n+ 3e-040 128.1 0.2 5.8e-040 127.2 0.0 1.6 2 human_A \n+ 3.4e-038 121.4 0.5 8.4e-038 120.2 0.0 1.8 2 mouse_A \n+ 5.4e-029 91.7 0.0 1.1e-028 90.7 0.0 1.5 2 human_D \n+ 1.6e-028 90.6 0.2 4.7e-028 89.1 0.0 1.8 2 mouse_D \n+ 1.4e-022 71.2 0.2 3.1e-022 70.0 0.0 1.6 2 mouse_B \n+ 9.4e-021 65.1 0.0 2.2e-020 64.0 0.0 1.6 1 human_B \n+ 2.8e-019 60.7 1.1 1e-018 58.9 0.1 2.0 2 rhesus_L \n+ 4.6e-018 56.7 1.3 1.5e-017 55.0 0.1 2.0 2 human_L \n+ 5.6e-017 53.2 0.9 1.2e-016 52.1 0.2 1.8 2 cow_L \n+ 1.2e-016 52.3 0.1 1.2e-016 52.3 0.1 1.7 1 pig_L \n+ 1.7e-016 51.5 0.6 2.4e-016 51.1 0.1 1.5 1 mouse_K \n+ 2.2e-016 51.3 1.0 7.3e-016 49.6 0.2 1.9 2 rabbit_L \n+ 1e-015 49.1 1.1 1e-015 49.1 0.1 1.5 1 rat_K \n+ 2.2e-015 47.8 0.7 3.9e-015 47.0 0.1 1.7 2 human_K \n+ 1.8e-014 45.1 0.5 3.9e-014 44.0 0.1 1.7 2 rat_L \n+ 2.8e-014 44.3 0.8 4.4e-014 43.7 0.2 1.5 2 pig_K \n+ 4e-014 43.9 0.1 8.2e-014 42.9 0.1 1.4 1 rhesus_K \n+ 5.7e-014 43.3 0.1 1.3e-013 42.2 0.1 1.5 1 mouse_L \n+ 1.7e-013 41.8 0.1 3.5e-013 40.8 0.1 1.5 1 cow_K \n+ 2e-013 41.6 0.1 3.5e-013 40.8 0.1 1.4 1 rabbit_K \n+ 3e-012 37.9 0.2 6.4e-012 36.9 0.0 1.6 2 rhesus_H \n+ 5.5e-012 36.7 0.0 9.6e-011 32.7 0.0 2.1 2 mouse_G \n+ 8.1e-012 36.4 0.1 1.9e-011 35.2 0.0 1.6 2 mouse_H \n+ 1.4e-011 35.8 0.3 3.8e-011 34.4 0.0 1.8 2 human_H \n+ 1e-010 33.1 0.2 5.1e-010 30.9 0.0 2.1 2 alpaca_H \n+ 7.8e-010 30.1 0.0 1.8e-009 28.9 0.0 1.6 1 rabbit_H \n+ 8.9e-010 30.1 0.1 2e-009 28.9 0.1 1.6 1 pig_H \n+ 5.8e-009 27.1 0.3 1.6e-008 25.7 0.1 1.8 2 cow_H \n+ 4.3e-008 24.2 0.1 1.5e-007 22.4 0.0 1.8 2 human_G \n+\n+\n+Domain annotation for each model (and alignments):\n+>> human_A \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 127.2 0.0 5.8e-040 5.8e-040 1 128 [] 2 111 .. 2 111 .. 0.97\n+ 2 ? -2.6 0.0 7.9 7.9 93 103 .. 145 155 .. 134 166 .. 0.73\n+\n+ Alignments for each domain:\n+ == domain 1 score: 127.2 bits; conditional E-value: 5.8e-040\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ human_A 1 aqkveqspqslsvqEgesvtlnCtystsatlllllseylfWYkqepgkglqllikllsalldeeekkklllllgrlsatlnkseksssLkitasqlsdsAvY 102\n+ +q+v+q p +lsv Ege++ lnC++++sa ++l+W++q+pgkgl++l+ ++s+ ++e+++ grl+a+l+ks+ +s+L+i asq++dsA+Y\n+ 6FR3 2 KQEVTQIPAALSVPEGENLVLNCSFTDSA------IYNLQWFRQDPGKGLTSLLLIQSS---QREQTS-----GRLNASLDKSSGRSTLYIAASQPGDSATY 89 \n+ 699**************************......9**********************8...999999.....***************************** PP\n+\n+ xxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ human_A 103 fCavsellllllkliFGkGTrLtVkp 128\n+ +Cav +++k++FG+GT+L+Vkp\n+ 6FR3 90 LCAVT----NFNKFYFGSGTKLNVKP 111\n+ ****9....699************99 PP\n+\n+ == domain 2 score: -2.6 bits; conditional E-value: 7.9\n+ xxxxxxxxxxx RF\n+ human_A 93 asqlsdsAvYf 103\n+ sq +ds vY+\n+ 6FR3 145 VSQSKDSDVYI 155\n+ 46777888875 PP\n+\n+>> mouse_A \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 120.2 0.0 8.4e-038 8.4e-038 1 128 [] 2 111 .. 2 111 .. 0.97\n+ 2 ? -1.1 0.1 2.7 2.7 91 103 .. 143 155 .. 127 169 .. 0.74\n+\n+ Alignments for each domain:\n+ == domain 1 score: 120.2 bits; conditional E-value: 8.4e-038\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ mouse_A 1 gqkveqspesltvqegesvtlnCsystsavllllaseylfWYkqepgeglqlLlkivsalldeekkeslllllgrfeatlnkseksssLhitsvqlsDsAvY 102\n+ +q+v+q p++l+v ege++ lnCs+++sa ++l+W++q+pg+gl++Ll i s+ +++++s gr++a l+ks+ +s+L i+++q+ DsA+Y\n+ 6FR3 2 KQEVTQIPAALSVPEGENLVLNCSFTDSA------IYNLQWFRQDPGKGLTSLLLIQSS---QREQTS-----GRLNASLDKSSGRSTLYIAASQPGDSATY 89 \n+ 599**************************......8**********************7...888888.....***************************** PP\n+\n+ xxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ mouse_A 103 fCalsellllllkltFGkGTkLtvkp 128\n+ +Ca++ +++k++FG+GTkL vkp\n+ 6FR3 90 LCAVT----NFNKFYFGSGTKLNVKP 111\n+ *****....699************98 PP\n+\n+ == domain 2 score: -1.1 bits; conditional E-value: 2.7\n+ xxxxxxxxxxxxx RF\n+ mouse_A 91 itsvqlsDsAvYf 103\n+ + +q +Ds vY \n+ 6FR3 143 TNVSQSKDSDVYI 155\n+ 4567888998886 PP\n+\n+>> human_D \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 90.7 0.0 1.1e-028 1.1e-028 2 128 .] 3 111 .. 2 111 .. 0.95\n+ 2 ? -2.7 0.0 8.9 8.9 16 27 .. 152 163 .. 140 180 .. 0.47\n+\n+ Alignments for each domain:\n+ == domain 1 score: 90.7 bits; conditional E-value: 1.1e-028\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ human_D 2 qkvtqsqpslsvqegeavtLnCsyetsasllllgnyylfWYkqepskeitflirqksslldkqekkedakklgrfsvkldkaaksasLkIsasqlgDsatYf 103\n+ q+vtq + lsv ege+ +LnCs++ sa+ y+l W++q p+k++t l+ ++ss ++e+++ gr++ +ldk+ ++L I asq+gDsatY+\n+ 6FR3 3 QEVTQIPAALSVPEGENLVLNCSFTDSAI------YNLQWFRQDPGKGLTSLLLIQSS---QREQTS-----GRLNASLDKSSGRSTLYIAASQPGDSATYL 90 \n+ 99**************************7......***************99999987...777777.....****************************** PP\n+\n+ xxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ human_D 104 CAleellllllqliFGkGtkliVep 128\n+ CA+ + +++++FG Gtkl V+p\n+ 6FR3 91 CAVTN----FNKFYFGSGTKLNVKP 111\n+ ***86....89************97 PP\n+\n+ == domain 2 score: -2.7 bits; conditional E-value: 8.9\n+ xxxxxxxxxxxx RF\n+ human_D 16 geavtLnCsyet 27 \n+ t +C + \n+ 6FR3 152 DVYITDKCVLDM 163\n+ 222333444444 PP\n+\n+>> mouse_D \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 89.1 0.0 4.7e-028 4.7e-028 2 128 .] 3 111 .. 2 111 .. 0.93\n+ 2 ? -0.9 0.1 3.3 3.3 94 102 .. 146 154 .. 127 184 .. 0.56\n+\n+ Alignments for each domain:\n+ == domain 1 score: 89.1 bits; conditional E-value: 4.7e-028\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ mouse_D 2 qkvtqsqkslsvqegeevtldCsyetsdvllllknyalfWYkqlpsgslvllikqassllkkekkesdasklgrlsvkfqkkeksisLeisasqledsatYf 103\n+ q+vtq +++lsv ege++ l+Cs++ s+ y l+W++q p+++l +l+ +ss + +++ grl++ ++k+ +++L i+asq+ dsatY \n+ 6FR3 3 QEVTQIPAALSVPEGENLVLNCSFTDSAI------YNLQWFRQDPGKGLTSLLLIQSS----QREQT---S-GRLNASLDKSSGRSTLYIAASQPGDSATYL 90 \n+ 89**************************5......*****************999974....44444...3.9***************************** PP\n+\n+ xxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ mouse_D 104 CaleellllllklvFGtGielfVEP 128\n+ Ca+ + ++k +FG G++l V P\n+ 6FR3 91 CAVTN----FNKFYFGSGTKLNVKP 111\n+ ****7....99************98 PP\n+\n+ == domain 2 score: -0.9 bits; conditional E-value: 3.3\n+ xxxxxxxxx RF\n+ mouse_D 94 sqledsatY 102\n+ sq +ds +Y\n+ 6FR3 146 SQSKDSDVY 154\n+ 333333333 PP\n+\n+>> mouse_B \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 70.0 0.0 3.1e-022 3.1e-022 2 126 .. 3 109 .. 2 110 .. 0.88\n+ 2 ? -2.0 0.0 5.7 5.7 22 29 .. 158 165 .. 129 188 .. 0.61\n+\n+ Alignments for each domain:\n+ == domain 1 score: 70.0 bits; conditional E-value: 3.1e-022\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ mouse_B 2 agvtQtPrhlvkekGqkvtLkCeqksghllllllaeamyWYrqdlgkelkllvysqnglllkkaleksdlpkerfsasrplkksessLkiesaeledsavYl 103\n+ ++vtQ P l + +G+++ L+C+ + + ++ W+rqd+gk+l+ l+ +q+ ++++++ r++as ++ +s+L i + +++dsa+Yl\n+ 6FR3 3 QEVTQIPAALSVPEGENLVLNCSFTDSA------IYNLQWFRQDPGKGLTSLLLIQS-------SQREQTS-GRLNASLDKSSGRSTLYIAASQPGDSATYL 90 \n+ 78**********************9999......799****************9999.......2333333.4666777767889***************** PP\n+\n+ xxxxxxxxxxxxxxxxxxxxxxx RF\n+ mouse_B 104 CasselllllleqyFGeGtrLtV 126\n+ Ca + +++ yFG+Gt+L V\n+ 6FR3 91 CAVTN----FNKFYFGSGTKLNV 109\n+ ****9....89**********98 PP\n+\n+ == domain 2 score: -2.0 bits; conditional E-value: 5.7\n+ xxxxxxxx RF\n+ mouse_B 22 kCeqksgh 29 \n+ kC ++++\n+ 6FR3 158 KCVLDMRS 165\n+ 34444444 PP\n+\n+>> human_B \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 64.0 0.0 2.2e-020 2.2e-020 2 126 .. 3 109 .. 2 110 .. 0.88\n+\n+ Alignments for each domain:\n+ == domain 1 score: 64.0 bits; conditional E-value: 2.2e-020\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ human_B 2 agvtQsPrykvtktgqkvtlrCsqisghllllllaetlyWYrqdlgqglelliysqegllleeatdksevpkdrfsaerplkkskstLklesaeledsavYl 103\n+ +vtQ P + + +g+++ l+Cs + + + +l W+rqd+g+gl+ l+ q+ +++ + s r +a+ ++ +stL + + +++dsa Yl\n+ 6FR3 3 QEVTQIPAALSVPEGENLVLNCSFTDSA------IYNLQWFRQDPGKGLTSLLLIQS----SQREQTS----GRLNASLDKSSGRSTLYIAASQPGDSATYL 90 \n+ 58*********************99999......899*************9999999....3333333....4456666656889***************** PP\n+\n+ xxxxxxxxxxxxxxxxxxxxxxx RF\n+ human_B 104 CAsslllllllelyFGeGtrLtV 126\n+ CA + +++ yFG+Gt+L V\n+ 6FR3 91 CAVTN----FNKFYFGSGTKLNV 109\n+ ****9....89**********98 PP\n+\n+>> rhesus_L \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 58.9 0.1 1e-018 1e-018 2 126 .. 3 109 .. 2 110 .. 0.91\n+ 2 ? 0.4 0.1 1.2 1.2 10 43 .. 144 178 .. 137 188 .. 0.77\n+\n+ Alignments for each domain:\n+ == domain 1 score: 58.9 bits; conditional E-value: 1e-018\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ rhesus_L 2 svltQppslvsaspgqsvrltCtgssskivlllgskyvsWyqqkpgqapklliyeksdlllsdskrpsgvpldRfsgskdasgntasLtisglqaeDEadY 102\n+ +++tQ p+++s+ g++ l C+ + s+i ++ +W++q pg+ + l+ + s++ + ++ R+ +s d+s+ +++L i++ q+ D a Y\n+ 6FR3 3 QEVTQIPAALSVPEGENLVLNCSFTDSAI------YNLQWFRQDPGKGLTSLLLIQ-------SSQREQTS-GRLNASLDKSSGRSTLYIAASQPGDSATY 89 \n+ 689****99****************9996......89**********988888777.......45556677.799************************** PP\n+\n+ xxxxxxxxxxxxxxxxxxxxxxxx RF\n+ rhesus_L 103 yCqswdlllllllvvFGeGTrLTv 126\n+ C++++ ++ FG+GT+L v\n+ 6FR3 90 LCAVTN----FNKFYFGSGTKLNV 109\n+ ******....78899*******86 PP\n+\n+ == domain 2 score: 0.4 bits; conditional E-value: 1.2\n+ xxxxxxxxxxxxx..xxxxxxxxxxxxxxxxxxxxx RF\n+ rhesus_L 10 lvsaspgqsvrlt..CtgssskivlllgskyvsWyq 43 \n+ +vs+s+ v +t C ++ ++ + ++++v+W \n+ 6FR3 144 NVSQSKDSDVYITdkCVLDMRSM-DFKSNSAVAWSN 178\n+ 37888888888877799998886.577888899965 PP\n+\n+>> human_L \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 55.0 0.1 1.5e-017 1.5e-017 2 126 .. 3 109 .. 2 110 .. 0.90\n+ 2 ? 0.5 0.1 1.1 1.1 10 42 .. 144 177 .. 137 192 .. 0.79\n+\n+ Alignments for each domain:\n+ == domain 1 score: 55.0 bits; conditional E-value: 1.5e-017\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ human_L 2 svltqppslvsvspgqtvtltCtgsssevvlllgskyvsWyqqkpgkaPklliyeksdlllsdskrpsgvpldRfsgskdasgntasLtisglqaeDEadYY 103\n+ +++tq p+++sv g++ l C+ + s++ ++ +W+ q pgk + l+ + s++ + ++ R+ +s d s+ +++L i+ q+ D a Y \n+ 6FR3 3 QEVTQIPAALSVPEGENLVLNCSFTDSAI------YNLQWFRQDPGKGLTSLLLIQ-------SSQREQTS-GRLNASLDKSSGRSTLYIAASQPGDSATYL 90 \n+ 589****99***************99996......89**********999888888.......33444555.699*************************** PP\n+\n+ xxxxxxxxxxxxxxxxxxxxxxx RF\n+ human_L 104 CaswdlllllllvvFGgGtkltv 126\n+ Ca+++ ++ FG+Gtkl v\n+ 6FR3 91 CAVTN----FNKFYFGSGTKLNV 109\n+ *****....77889*******88 PP\n+\n+ == domain 2 score: 0.5 bits; conditional E-value: 1.1\n+ xxxxxxxxxxxxx..xxxxxxxxxxxxxxxxxxxx RF\n+ human_L 10 lvsvspgqtvtlt..CtgsssevvlllgskyvsWy 42 \n+ +vs+s + v +t C ++ ++ + ++ +v+W \n+ 6FR3 144 NVSQSKDSDVYITdkCVLDMRSM-DFKSNSAVAWS 177\n+ 47888888888877799988886.58889999996 PP\n+\n+>> cow_L \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 52.1 0.2 1.2e-016 1.2e-016 3 126 .. 4 109 .. 2 110 .. 0.90\n+ 2 ? -1.0 0.0 3.3 3.3 10 42 .. 144 177 .. 139 197 .. 0.70\n+\n+ Alignments for each domain:\n+ == domain 1 score: 52.1 bits; conditional E-value: 1.2e-016\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ cow_L 3 vLtqpsslvsgslGqtvsitCsgsssnvglllsensvsWyqqipgsaprtliyeksdlllsdskrasGvpldrfsgskdasgntatLtisglqaeDeaDYyCas 106\n+ ++tq ++++s+ G++ + Cs ++s + ++ +W+ q pg+++ l+ + s+++++sG r+ +s d s+ +tL i++ q+ D a Y Ca+\n+ 6FR3 4 EVTQIPAALSVPEGENLVLNCSFTDSAI------YNLQWFRQDPGKGLTSLLLIQ----SSQREQTSG----RLNASLDKSSGRSTLYIAASQPGDSATYLCAV 93 \n+ 679*9999*****************997......799************999988....456777776....77899999************************ PP\n+\n+ xxxxxxxxxxxxxxxxxxxx RF\n+ cow_L 107 adlllllllavFGsGttltv 126\n+ ++ ++ FGsGt+l v\n+ 6FR3 94 TN----FNKFYFGSGTKLNV 109\n+ **....66778******987 PP\n+\n+ == domain 2 score: -1.0 bits; conditional E-value: 3.3\n+ xxxxxxxxxxxxx..xxxxxxxxxxxxxxxxxxxx RF\n+ cow_L 10 lvsgslGqtvsit..CsgsssnvglllsensvsWy 42 \n+ +vs+s v it C ++ ++ + s+ v W \n+ 6FR3 144 NVSQSKDSDVYITdkCVLDMRSM-DFKSNSAVAWS 177\n+ 47777777777766677777775.36667777774 PP\n+\n+>> pig_L \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 52.3 0.1 1.2e-016 1.2e-016 1 126 [. 3 109 .. 3 110 .. 0.85\n+\n+ Alignments for each domain:\n+ == domain 1 score: 52.3 bits; conditional E-value: 1.2e-016\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ pig_L 1 qavliqePsllsvslgetvtltCalssgsvvlllssnyvsWyqqkPGrpPkyliyftfaslskdnsratgvplssfsgaillsgnkatLtisGlqaeDeaDyfC 104\n+ q v +q P++lsv ge l C+++ + + +++ W+ q PG+ l+ + s +++++ g + s ++ s+ ++tL i+ q+ D a y C\n+ 6FR3 3 QEV-TQIPAALSVPEGENLVLNCSFTDSAI------YNLQWFRQDPGKGLTSLLLIQ--SSQREQTS--GRL--NASLDK--SSGRSTLYIAASQPGDSATYLC 91 \n+ 566.9*********************9999......7************99999999..43444444..444..446666..77899***************** PP\n+\n+ xxxxxxxxxxxxxxxxxxxxxx RF\n+ pig_L 105 allkllllllldrFGgGthLtv 126\n+ a ++ ++ FG Gt+L v\n+ 6FR3 92 AVTN----FNKFYFGSGTKLNV 109\n+ **99....66789*******98 PP\n+\n+>> mouse_K \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 51.1 0.1 2.4e-016 2.4e-016 3 127 .. 4 110 .. 2 111 .. 0.91\n+\n+ Alignments for each domain:\n+ == domain 1 score: 51.1 bits; conditional E-value: 2.4e-016\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ mouse_K 3 vltqspaslsvslgekvtisCkasqsilaskegssylaWyqqkpgqspklliyealllllllsnlasgvplsrfsgsgllsgtdftLtissveaedlatYyC 104\n+ +tq pa lsv ge+ ++C+ ++s +l+W+ q pg+ l+ s++++ + r+ +s s tL i ++ d atY C\n+ 6FR3 4 EVTQIPAALSVPEGENLVLNCSFTDSA------IYNLQWFRQDPGKGLTSLLLIQ-------SSQREQTS-GRLNASLDKSSGRSTLYIAASQPGDSATYLC 91 \n+ 68********************99998......689**********999988888.......66777777.79999999999999***************** PP\n+\n+ xxxxxxxxxxxxxxxxxxxxxxx RF\n+ mouse_K 105 qqsslllllllyTFGgGTKLEiK 127\n+ + ++ ++ + FG+GTKL +K\n+ 6FR3 92 AVTN----FNKFYFGSGTKLNVK 110\n+ *999....889**********99 PP\n+\n+>> rabbit_L \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 49.6 0.2 7.3e-016 7.3e-016 3 126 .. 4 109 .. 2 110 .. 0.90\n+ 2 ? 0.1 0.1 1.5 1.5 8 44 .. 142 179 .. 135 186 .. 0.79\n+\n+ Alignments for each domain:\n+ == domain 1 score: 49.6 bits; conditional E-value: 7.3e-016\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ rabbit_L 3 vltqppslvsasLgqtarltCtlssgeivllleeyaveWyqqkpGkaPrlllykdtdllleikkrgsGvpldrFsgskdssgnsasLtisglqaeDeAdYy 103\n+ ++tq p+++s+ g+ l C+ + + i y ++W++q pGk + ll ++ +++++sG r s d+s+ +L i+ q++D A Y \n+ 6FR3 4 EVTQIPAALSVPEGENLVLNCSFTDSAI------YNLQWFRQDPGKGLTSLLLIQSS----QREQTSG----RLNASLDKSSGRSTLYIAASQPGDSATYL 90 \n+ 689*9999*************9998887......89***********9999888844....6778887....56899999********************* PP\n+\n+ xxxxxxxxxxxxxxxxxxxxxxx RF\n+ rabbit_L 104 CasaelllllllvvFGGGtqLtv 126\n+ Ca+++ ++ + FG Gt+L v\n+ 6FR3 91 CAVTN----FNKFYFGSGTKLNV 109\n+ ****9....77899*******98 PP\n+\n+ == domain 2 score: 0.1 bits; conditional E-value: 1.5\n+ xxxxxxxxxxxxxxx..xxxxxxxxxxxxxxxxxxxxxx RF\n+ rabbit_L 8 pslvsasLgqtarlt..CtlssgeivllleeyaveWyqq 44 \n+ +++vs s ++ + +t C l+ ++ + ++av W ++\n+ 6FR3 142 QTNVSQSKDSDVYITdkCVLDMRSM-DFKSNSAVAWSNK 179\n+ 5568999999999987798988886.5888899999765 PP\n+\n+>> rat_K \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 49.1 0.1 1e-015 1e-015 3 127 .. 4 110 .. 2 111 .. 0.89\n+\n+ Alignments for each domain:\n+ == domain 1 score: 49.1 bits; conditional E-value: 1e-015\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ rat_K 3 qmtqspaslsvslgervtisCkasqdilksadgknylsWyqqkpgkspklliykalllllllsnlasgvplsrFsgsgllsgtdftltissleaedlavYyClq 106\n+ ++tq pa lsv ge+ ++C ++ +l+W+ q pgk l+ s+ ++ + r +s s tl i ++ d a+Y C \n+ 6FR3 4 EVTQIPAALSVPEGENLVLNCSFTDSA------IYNLQWFRQDPGKGLTSLLLIQ-------SSQREQTS-GRLNASLDKSSGRSTLYIAASQPGDSATYLCAV 93 \n+ 58*******************999998......567**********988777766.......56666667.79999998999999******************9 PP\n+\n+ xxxxxxxxxxxxxxxxxxxxx RF\n+ rat_K 107 sklllllllltFGaGtkLElk 127\n+ ++ ++ + FG+GtkL++k\n+ 6FR3 94 TN----FNKFYFGSGTKLNVK 110\n+ 99....78899********99 PP\n+\n+>> human_K \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 47.0 0.1 3.9e-015 3.9e-015 4 127 .. 5 110 .. 2 111 .. 0.84\n+ 2 ? -1.7 0.0 4.7 4.7 85 105 .. 137 157 .. 120 178 .. 0.69\n+\n+ Alignments for each domain:\n+ == domain 1 score: 47.0 bits; conditional E-value: 3.9e-015\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ human_K 4 ltqsPsslsvsvgdrvtisCrasqsilesddgssylaWyqqkpgkapklliyaalllllllsslasGvPlsrfsGsGllsGtdftltissleaedvavyyCq 105\n+ +tq P++lsv g++ ++C + s + +l+W++q pgk + l+ s+++ r+ s s tl i++ ++ d a+y C \n+ 6FR3 5 VTQIPAALSVPEGENLVLNCSFTDSAI------YNLQWFRQDPGKGLTSLLLIQ------SSQREQTS--GRLNASLDKSSGRSTLYIAASQPGDSATYLCA 92 \n+ 8*******************9999984......56**********877666655......24444433..47777777777788****************** PP\n+\n+ xxxxxxxxxxxxxxxxxxxxxx RF\n+ human_K 106 qaklllllllltfGqGtkveik 127\n+ ++ ++ + fG+Gtk+++k\n+ 6FR3 93 VTN----FNKFYFGSGTKLNVK 110\n+ 999....7889*********99 PP\n+\n+ == domain 2 score: -1.7 bits; conditional E-value: 4.7\n+ xxxxxxxxxxxxxxxxxxxxx RF\n+ human_K 85 tdftltissleaedvavyyCq 105\n+ tdf + + +++d vy \n+ 6FR3 137 TDFDSQTNVSQSKDSDVYITD 157\n+ 666666666667776666544 PP\n+\n+>> rat_L \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 44.0 0.1 3.9e-014 3.9e-014 3 126 .. 4 109 .. 2 110 .. 0.90\n+ 2 ? -1.6 0.1 5.1 5.1 11 42 .. 145 177 .. 139 192 .. 0.64\n+\n+ Alignments for each domain:\n+ == domain 1 score: 44.0 bits; conditional E-value: 3.9e-014\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ rat_L 3 vltqpnslvstslgstvklsCkrstgnitlllgsnYvnWyqqkedrsivtviykdllllllldkrpdgvpldrfsGsidsssnsaaLtitnvqieDeadYfCqs 106\n+ ++tq ++++s+ g+ + l C+ + +i +W++q +++ +++++ + ++r + + r s+d+ss++++L i q D a+Y C \n+ 6FR3 4 EVTQIPAALSVPEGENLVLNCSFTDSAI------YNLQWFRQDPGKGLTSLLLIQ------SSQREQ-TS-GRLNASLDKSSGRSTLYIAASQPGDSATYLCAV 93 \n+ 79999999*******************9......4589*************9988......466655.56.6******************************** PP\n+\n+ xxxxxxxxxxxxxxxxxxxx RF\n+ rat_L 107 yslllllllPvfGGGtkLtv 126\n+ ++ ++ fG GtkL v\n+ 6FR3 94 TN----FNKFYFGSGTKLNV 109\n+ *9....66778*******98 PP\n+\n+ == domain 2 score: -1.6 bits; conditional E-value: 5.1\n+ xxxxxxxxxxxx..xxxxxxxxxxxxxxxxxxxx RF\n+ rat_L 11 vstslgstvkls..CkrstgnitlllgsnYvnWy 42 \n+ vs s s v ++ C+ + ++ + +++ v W \n+ 6FR3 145 VSQSKDSDVYITdkCVLDMRSM-DFKSNSAVAWS 177\n+ 5555556555544477777776.45666666665 PP\n+\n+>> pig_K \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 43.7 0.2 4.4e-014 4.4e-014 4 127 .. 5 110 .. 3 111 .. 0.83\n+ 2 ? -2.7 0.0 9.6 9.6 85 103 .. 137 155 .. 118 173 .. 0.67\n+\n+ Alignments for each domain:\n+ == domain 1 score: 43.7 bits; conditional E-value: 4.4e-014\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ pig_K 4 ltqsPlslsvslGetvsiscrssqslesslygsnylaWyqqkpGksPk.lliyeallllllltnrasGvPldrfkGsgllsGtdftlkisrleaedvavyycqq 106\n+ +tq P++lsv Ge + c + s +l+W++q pGk ll+ ++ ++r+ r++ s s tl i+ + d a+y c \n+ 6FR3 5 VTQIPAALSVPEGENLVLNCSFTDSA------IYNLQWFRQDPGKGLTsLLLIQS-------SQREQTSG--RLNASLDKSSGRSTLYIAASQPGDSATYLCAV 93 \n+ 79******************999887......357**********8641555555.......34433333..6778877788899******************9 PP\n+\n+ xxxxxxxxxxxxxxxxxxxxx RF\n+ pig_K 107 aklllllllvtfGsGtklelk 127\n+ ++ ++ + fGsGtkl++k\n+ 6FR3 94 TN----FNKFYFGSGTKLNVK 110\n+ 99....7889********998 PP\n+\n+ == domain 2 score: -2.7 bits; conditional E-value: 9.6\n+ xxxxxxxxxxxxxxxxxxx RF\n+ pig_K 85 tdftlkisrleaedvavyy 103\n+ tdf + ++ d vy \n+ 6FR3 137 TDFDSQTNVSQSKDSDVYI 155\n+ 5555555555666666664 PP\n+\n+>> rhesus_K \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 42.9 0.1 8.2e-014 8.2e-014 4 127 .. 5 110 .. 3 111 .. 0.85\n+\n+ Alignments for each domain:\n+ == domain 1 score: 42.9 bits; conditional E-value: 8.2e-014\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ rhesus_K 4 mtqspsslsvsvgervtlisCrasqsilesddgssylaWyqqkpgkaPklliykalllllllssresgvpldrfsGsgllsgtdftltisslepedvavyy 104\n+ +tq p++lsv ge+ + C ++s +l+W++q pgk l+ s+re+ + r++ s s tl i+ +p d a+y \n+ 6FR3 5 VTQIPAALSVPEGENLV-LNCSFTDSA------IYNLQWFRQDPGKGLTSLLLIQ------SSQREQ-TS-GRLNASLDKSSGRSTLYIAASQPGDSATYL 90 \n+ 79***************.***999988......566**********988777666......244444.34.58888887888888**************** PP\n+\n+ xxxxxxxxxxxxxxxxxxxxxxx RF\n+ rhesus_K 105 CqqelllllllWtfGqGtkveik 127\n+ C + +++ + fG Gtk ++k\n+ 6FR3 91 CAVT---NFNKFYFGSGTKLNVK 110\n+ *999...788899*******999 PP\n+\n+>> mouse_L \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 42.2 0.1 1.3e-013 1.3e-013 4 126 .. 5 109 .. 2 110 .. 0.88\n+\n+ Alignments for each domain:\n+ == domain 1 score: 42.2 bits; conditional E-value: 1.3e-013\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ mouse_L 4 vtqesallttslGatvkltCrsstgavtllltsnyaeWvqekpdklfkgvigltkdlllgssnradGvPlarfsGsllliGdkaaltitgaqtedeaiyiCa 105\n+ vtq a+l++ G+ +l C + a+ + +W+++ p k + ++ + ss+r + r+ sl + l i+ q+ d a y+Ca\n+ 6FR3 5 VTQIPAALSVPEGENLVLNCSFTDSAI------YNLQWFRQDPGKGLTSLLLIQ------SSQREQTS--GRLNASLDKSSGRSTLYIAASQPGDSATYLCA 92 \n+ 8999999*************8876666......899**********99999888......45555554..59999999999999****************** PP\n+\n+ xxxxxxxxxxxxxxxxxxxxx RF\n+ mouse_L 106 lwylllllllyvfGgGtkvtv 126\n+ + + ++ + fG+Gtk+ v\n+ 6FR3 93 VTN----FNKFYFGSGTKLNV 109\n+ ***....889********987 PP\n+\n+>> cow_K \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 40.8 0.1 3.5e-013 3.5e-013 4 127 .. 5 110 .. 2 111 .. 0.88\n+\n+ Alignments for each domain:\n+ == domain 1 score: 40.8 bits; conditional E-value: 3.5e-013\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ cow_K 4 ltqtPlslsvilGetvsisckstqslkysldgktylrWlqqkPGqsPklliyqvlllllllsnrytgvpldrftgsgllsetdftltissveaedaavyyclqd 107\n+ +tq P+ lsv Ge++ + c t s y+ l+W++q PG+ +l+ s+r + + r+ +s s tl i+ + d+a+y c \n+ 6FR3 5 VTQIPAALSVPEGENLVLNCSFTDSAIYN------LQWFRQDPGKGLTSLLLIQ------SSQRE-QTS-GRLNASLDKSSGRSTLYIAASQPGDSATYLCAVT 94 \n+ 89************************997......**********998887655......35555.555.699999999999*******************998 PP\n+\n+ xxxxxxxxxxxxxxxxxxxx RF\n+ cow_K 108 tlllllllntfGqGtkveik 127\n+ ++ fG Gtk+++k\n+ 6FR3 95 N----FNKFYFGSGTKLNVK 110\n+ 8....566789******998 PP\n+\n+>> rabbit_K \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 40.8 0.1 3.5e-013 3.5e-013 3 127 .. 4 110 .. 2 111 .. 0.78\n+\n+ Alignments for each domain:\n+ == domain 1 score: 40.8 bits; conditional E-value: 3.5e-013\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ rabbit_K 3 vltqtpasvsaavGGtvtincqasqsvylllldnsylswyqqkpGqppk.lliysalllllllsklasGvplsrfsGsGllsGtqftltisGvqcddaaty 102\n+ +tq pa+ s + G + +nc ++s l+w++q pG+ ll+ ++ + r++ s s + tl i+ q d+aty\n+ 6FR3 4 EVTQIPAALSVPEGENLVLNCSFTDSAI------YNLQWFRQDPGKGLTsLLLIQSSQREQTS---------GRLNASLDKSSGRSTLYIAASQPGDSATY 89 \n+ 58*******************9988753......48*********975414444442222222.........35555555555688*************** PP\n+\n+ xxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ rabbit_K 103 ycqgsyllllllsltfGaGtkveik 127\n+ c+ + +++ fG+Gtk+++k\n+ 6FR3 90 LCAVTN----FNKFYFGSGTKLNVK 110\n+ ***999....67789********99 PP\n+\n+>> rhesus_H \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 36.9 0.0 6.4e-012 6.4e-012 10 125 .. 10 108 .. 2 110 .. 0.82\n+ 2 ? -2.5 0.1 9.6 9.6 87 97 .. 157 167 .. 136 184 .. 0.56\n+\n+ Alignments for each domain:\n+ == domain 1 score: 36.9 bits; conditional E-value: 6.4e-012\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ rhesus_H 10 lglvkPggeslrlsCaaslGftfsllsssyalsWvrqapgkglewvgaisskaesgsteyadslklgrvtisrdtskntlylqlsslkaeDtAvyYCarll 110\n+ ++l P ge l l C+++ ++ y l+W rq pgkgl + i+s+ ++ gr+ s d+s l + + D A+y Ca +\n+ 6FR3 10 AALSVPEGENLVLNCSFT-DSAI------YNLQWFRQDPGKGLTSLLLIQSS-------QREQTS-GRLNASLDKSSGRSTLYIAASQPGDSATYLCAV-T 94 \n+ 4788999********888.5555......9*******************999.......233445.8999****************************9.4 PP\n+\n+ xxxxxxxxxxxxxxx RF\n+ rhesus_H 111 llllfdvWGqGvlvt 125\n+ +++ f ++G G+ + \n+ 6FR3 95 NFNKF-YFGSGTKLN 108\n+ 44444.678887765 PP\n+\n+ == domain 2 score: -2.5 bits; conditional E-value: 9.6\n+ xxxxxxxxxxx RF\n+ rhesus_H 87 ntlylqlsslk 97 \n+ ++++l++ s++\n+ 6FR3 157 DKCVLDMRSMD 167\n+ 33444444443 PP\n+\n+>> mouse_G \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 32.7 0.0 9.6e-011 9.6e-011 15 128 .] 16 111 .. 5 111 .. 0.84\n+ 2 ? 2.0 0.0 0.31 0.31 8 42 .. 142 177 .. 120 188 .. 0.73\n+\n+ Alignments for each domain:\n+ == domain 1 score: 32.7 bits; conditional E-value: 9.6e-011\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ mouse_G 15 kdesaqisCkvslsvlklllsntaiHWYrqkkgqalerllyvstkllsevkvvekdfkdeklevsekfkdststlkinnvkeeDeatYYCAvWallllllhk 116\n+ ++e+ ++C+ + s + + W+rq +g+ l ll ++ ++++ + +l++s + ++ +stl i + D+atY CAv + +++ \n+ 6FR3 16 EGENLVLNCSFTDSAI------YNLQWFRQDPGKGLTSLLLIQSS--------QREQTSGRLNASLDKSSGRSTLYIAASQPGDSATYLCAVTN----FNKF 99 \n+ 5667777777777776......4579**************99973........455678899***999************************99....5555 PP\n+\n+ xxxxxxxxxxxx RF\n+ mouse_G 117 vFAeGtkLiviP 128\n+ F GtkL v P\n+ 6FR3 100 YFGSGTKLNVKP 111\n+ 79******8866 PP\n+\n+ == domain 2 score: 2.0 bits; conditional E-value: 0.31\n+ xxxxxxxxxxxxxx..xxxxxxxxxxxxxxxxxxxxx RF\n+ mouse_G 8 elsvtrrkdesaqi..sCkvslsvlklllsntaiHWY 42 \n+ + v + kd+ ++i +C + + + + sn+a+ W \n+ 6FR3 142 QTNVSQSKDSDVYItdKCVLDMRSM-DFKSNSAVAWS 177\n+ 3445555666666622587777776.57788888885 PP\n+\n+>> mouse_H \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 35.2 0.0 1.9e-011 1.9e-011 14 126 .. 15 109 .. 4 111 .. 0.80\n+ 2 ? -2.2 0.1 6.9 6.9 95 106 .. 147 158 .. 126 183 .. 0.63\n+\n+ Alignments for each domain:\n+ == domain 1 score: 35.2 bits; conditional E-value: 1.9e-011\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ mouse_H 14 kpgaslklsCkasgftlsllatsyamsWvrqspgkglewigeisskaesgstkyneklklgratlsrdkskstlylqlssltsedtavyyCareallllllf 115\n+ g+ l l C+ ++ ++ y+++W rq pgkgl + i+s+ e+ gr+ s dks+ + l + + d+a+y Ca + +++ \n+ 6FR3 15 PEGENLVLNCSFTDSAI------YNLQWFRQDPGKGLTSLLLIQSS-------QREQTS-GRLNASLDKSSGRSTLYIAASQPGDSATYLCAVT----NFNK 98 \n+ 45788899999888888......9*******************999.......234445.7777788888777777778889**********93....3334 PP\n+\n+ xxxxxxxxxxx RF\n+ mouse_H 116 dyWGqGttvtv 126\n+ y+G Gt + v\n+ 6FR3 99 FYFGSGTKLNV 109\n+ 499****9987 PP\n+\n+ == domain 2 score: -2.2 bits; conditional E-value: 6.9\n+ xxxxxxxxxxxx RF\n+ mouse_H 95 tsedtavyyCar 106\n+ +s+d+ vy +\n+ 6FR3 147 QSKDSDVYITDK 158\n+ 444555544433 PP\n+\n+>> human_H \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 34.4 0.0 3.8e-011 3.8e-011 16 124 .. 17 107 .. 5 110 .. 0.79\n+ 2 ? -1.6 0.1 4.9 4.9 84 95 .. 156 167 .. 127 189 .. 0.57\n+\n+ Alignments for each domain:\n+ == domain 1 score: 34.4 bits; conditional E-value: 3.8e-011\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ human_H 16 geslklsCaasGftlsllsssyalsWvrqapgkgLewvglisssaesgsteYaeslklgrvtisrdtskntlylqlsslraeDtavYyCarklllllllfdv 117\n+ ge l l C++ ++ y l+W rq pgkgL + li+ss + e+ gr+ s d+s l +++ ++ D a+Y Ca + +++ +\n+ 6FR3 17 GENLVLNCSFTDSAI------YNLQWFRQDPGKGLTSLLLIQSS--Q-----REQTS-GRLNASLDKSSGRSTLYIAASQPGDSATYLCAVT---NFNK-FY 100\n+ 566667776665555......9*******************999..2.....23344.8999****************************93...2223.36 PP\n+\n+ xxxxxxx RF\n+ human_H 118 WGqGtlv 124\n+ +G Gt \n+ 6FR3 101 FGSGTKL 107\n+ 7888865 PP\n+\n+ == domain 2 score: -1.6 bits; conditional E-value: 4.9\n+ xxxxxxxxxxxx RF\n+ human_H 84 kntlylqlsslr 95 \n+ +++ +l++ s++\n+ 6FR3 156 TDKCVLDMRSMD 167\n+ 233334444443 PP\n+\n+>> alpaca_H \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 30.9 0.0 5.1e-010 5.1e-010 16 126 .. 17 109 .. 7 111 .. 0.82\n+ 2 ? -0.4 0.1 2.4 2.4 89 112 .. 141 163 .. 120 186 .. 0.73\n+\n+ Alignments for each domain:\n+ == domain 1 score: 30.9 bits; conditional E-value: 5.1e-010\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ alpaca_H 16 ggslrlscaasGstftlltssyamswvrqaPGkglelvaaisldllgGstyyadsvklgrftisrdnakntlylqlnslkpedtavyycakllllllllld 116\n+ g+ l l c+ + s++ y ++w+rq PGkgl + i+++ + gr+ s d++ + l +++ +p d+a y ca ++++ \n+ 6FR3 17 GENLVLNCSFTDSAI------YNLQWFRQDPGKGLTSLLLIQSS-------QREQTS-GRLNASLDKSSGRSTLYIAASQPGDSATYLCAV----TNFNKF 99 \n+ 666777776665555......**************999999988.......345555.99********9999999***************9....344445 PP\n+\n+ xxxxxxxxxx RF\n+ alpaca_H 117 awGqGtlvtv 126\n+ ++G Gt++ v\n+ 6FR3 100 YFGSGTKLNV 109\n+ 8999998876 PP\n+\n+ == domain 2 score: -0.4 bits; conditional E-value: 2.4\n+ xxxxxxxxxxxxxxxxxxxxxxxx RF\n+ alpaca_H 89 lqlnslkpedtavyycakllllll 112\n+ q n +++d+ vy k ++l +\n+ 6FR3 141 SQTNVSQSKDSDVYITDK-CVLDM 163\n+ 577777888888888877.33333 PP\n+\n+>> rabbit_H \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 28.9 0.0 1.8e-009 1.8e-009 16 122 .. 17 105 .. 4 110 .. 0.77\n+\n+ Alignments for each domain:\n+ == domain 1 score: 28.9 bits; conditional E-value: 1.8e-009\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ rabbit_H 16 gdtLtltCtvsGfslslllssyavsWvrqapGkglewiglisssslsgstyyaswaklsrstisrntnentvtLkmtsltaaDtatyfCaralllllllld 116\n+ g+ L l C + ++ y+++W rq pGkgl + li+ss ++ +r s +++ tL +++ D aty+Ca +++ + \n+ 6FR3 17 GENLVLNCSFTDSAI------YNLQWFRQDPGKGLTSLLLIQSS---QR----EQTS-GRLNASLDKSSGRSTLYIAASQPGDSATYLCAVTNF----NKF 99 \n+ 567888887777777......********************999...22....2334.777788888888999*****************9222....122 PP\n+\n+ xxxxxx RF\n+ rabbit_H 117 lWGqGt 122\n+ +G+Gt\n+ 6FR3 100 YFGSGT 105\n+ 356666 PP\n+\n+>> pig_H \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 28.9 0.1 2e-009 2e-009 30 109 .. 26 96 .. 11 110 .. 0.79\n+\n+ Alignments for each domain:\n+ == domain 1 score: 28.9 bits; conditional E-value: 2e-009\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ pig_H 30 fllllssyavswvrqapgkglewlaaissssysgstyyadsvklgrftisrddsqntaylqmnslrtedtaryycarlll 109\n+ f + + y+++w rq pgkgl +l i+ss+ + gr+ s d+s + l + + + d+a y ca +++\n+ 6FR3 26 F-TDSAIYNLQWFRQDPGKGLTSLLLIQSSQR-------EQTS-GRLNASLDKSSGRSTLYIAASQPGDSATYLCAVTNF 96 \n+ 3.3456799********************933.......3445.9*******************************9332 PP\n+\n+>> cow_H \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 25.7 0.1 1.6e-008 1.6e-008 26 108 .. 27 95 .. 9 110 .. 0.76\n+ 2 ? -1.9 0.0 5.1 5.1 26 42 .. 162 177 .. 137 193 .. 0.64\n+\n+ Alignments for each domain:\n+ == domain 1 score: 25.7 bits; conditional E-value: 1.6e-008\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ cow_H 26 sGfslllllssyavgwvrqapGkalewlGgissglllGstgynpalklsrlsitkdnsksqvslsvssvttedtatyycakvk 108\n+ + + y ++w rq pGk l l i+s +t rl + d s + +l +++ + d+aty ca ++\n+ 6FR3 27 TD------SAIYNLQWFRQDPGKGLTSLLLIQSS-QREQT-------SGRLNASLDKSSGRSTLYIAASQPGDSATYLCAVTN 95 \n+ 33......345999*****************999.22222.......2578888899999999*****************844 PP\n+\n+ == domain 2 score: -1.9 bits; conditional E-value: 5.1\n+ xxxxxxxxxxxxxxxxx RF\n+ cow_H 26 sGfslllllssyavgwv 42 \n+ s+ + s+ av+w \n+ 6FR3 162 DMRSM-DFKSNSAVAWS 177\n+ 44444.44555566664 PP\n+\n+>> human_G \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 22.4 0.0 1.5e-007 1.5e-007 22 126 .. 23 109 .. 13 110 .. 0.75\n+ 2 ? -2.1 0.0 5.8 5.8 22 41 .. 158 176 .. 140 181 .. 0.62\n+\n+ Alignments for each domain:\n+ == domain 1 score: 22.4 bits; conditional E-value: 1.5e-007\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ human_G 22 tCdlsvinillllsatyihWYlhqeGkapqrLlyydsdllnskvvlesGissgkyetdasperkslklilrnlienDsgvYYCatWdlllllliklfgsGtk 123\n+ +C + +i + W+++ +Gk Ll ++s+ + + sG + + ++l + Ds++Y Ca+ + +++ fgsGtk\n+ 6FR3 23 NCSFTDSAI------YNLQWFRQDPGKGLTSLLLIQSS----QREQTSG----RLNASLDKSSGRSTLYIAASQPGDSATYLCAVTN----FNKFYFGSGTK 106\n+ 444444443......5589****************999....4444555....44433333356788999999************99....67779****** PP\n+\n+ xxx RF\n+ human_G 124 Liv 126\n+ L v\n+ 6FR3 107 LNV 109\n+ 976 PP\n+\n+ == domain 2 score: -2.1 bits; conditional E-value: 5.8\n+ xxxxxxxxxxxxxxxxxxxx RF\n+ human_G 22 tCdlsvinillllsatyihW 41 \n+ +C+l + + + s+ + W\n+ 6FR3 158 KCVLDMRS-MDFKSNSAVAW 176\n+ 47777777.46677777777 PP\n+\n+\n+\n+Internal pipeline statistics summary:\n+-------------------------------------\n+Query sequence(s): 1 (202 residues searched)\n+Target model(s): 29 (3712 nodes)\n+Passed MSV filter: 29 (1); expected 0.6 (0.02)\n+Passed bias filter: 29 (1); expected 0.6 (0.02)\n+Passed Vit filter: 29 (1); expected 0.0 (0.001)\n+Passed Fwd filter: 29 (1); expected 0.0 (1e-005)\n+Initial search space (Z): 29 [actual number of targets]\n+Domain search space (domZ): 29 [number of targets reported over threshold]\n+# CPU time: 0.04u 00:00:00.03 Elapsed: 00:00:00.00\n+# Mc/sec: inf\n+//\n+Query: 6FR3 [L=244]\n+Scores for complete sequence (score includes all domains):\n+ --- full sequence --- --- best 1 domain --- -#dom-\n+ E-value score bias E-value score bias exp N Model Description\n+ ------- ------ ----- ------- ------ ----- ---- -- -------- -----------\n+ 1.1e-043 139.2 0.1 2.4e-043 138.2 0.1 1.5 1 human_B \n+ 1.4e-038 122.9 0.1 3.3e-038 121.7 0.1 1.6 1 mouse_B \n+ 6.2e-025 78.6 0.0 1.2e-024 77.7 0.0 1.5 1 human_A \n+ 7e-025 78.4 0.1 1.2e-024 77.6 0.1 1.4 1 mouse_A \n+ 6.8e-022 68.8 0.0 1.8e-021 67.4 0.0 1.7 2 human_D \n+ 9.2e-022 68.7 0.5 3.5e-021 66.8 0.3 1.9 2 rhesus_L \n+ 1.5e-020 64.7 0.4 4.8e-020 63.1 0.3 1.8 2 human_L \n+ 1.4e-019 61.5 0.2 2.7e-019 60.7 0.2 1.4 1 cow_L \n+ 4.3e-019 60.1 0.0 1.3e-018 58.6 0.0 1.7 2 mouse_D \n+ 6.4e-019 59.4 0.4 4.4e-018 56.7 0.2 2.0 2 mouse_K \n+ 2.1e-018 57.8 0.2 3.3e-018 57.2 0.2 1.3 1 rabbit_L \n+ 4.3e-018 57.0 0.4 9.1e-018 56.0 0.2 1.6 1 pig_L \n+ 7.5e-018 56.0 0.2 2.3e-017 54.4 0.1 1.7 2 rat_K \n+ 1.1e-017 55.2 0.6 7.5e-017 52.6 0.4 2.0 2 human_K \n+ 5.5e-016 49.9 0.3 1.9e-015 48.2 0.3 1.8 2 rhesus_K \n+ 3.3e-015 47.3 0.1 5.9e-015 46.5 0.1 1.4 1 cow_K \n+ 1.5e-014 45.2 0.4 2.6e-014 44.4 0.4 1.3 1 pig_K \n+ 9.2e-014 42.6 0.1 2.1e-013 41.5 0.1 1.6 1 mouse_L \n+ 1.7e-013 42.0 0.5 2.5e-013 41.4 0.1 1.5 1 rat_L \n+ 2.8e-012 37.8 0.2 4.7e-012 37.1 0.2 1.4 1 rabbit_K \n+ 1.3e-011 35.5 0.0 2.5e-011 34.6 0.0 1.4 1 mouse_G \n+ 1.5e-011 35.5 0.0 3.7e-011 34.2 0.0 1.7 1 mouse_H \n+ 1.6e-011 35.6 0.0 3.5e-011 34.5 0.0 1.6 1 human_H \n+ 2e-011 34.9 0.0 3e-011 34.4 0.0 1.2 1 human_G \n+ 2.9e-010 31.5 0.0 5.5e-010 30.6 0.0 1.5 1 rhesus_H \n+ 7.1e-009 26.8 0.2 2.3e-008 25.1 0.0 1.9 2 cow_H \n+ 1.1e-008 26.3 0.0 6.7e-008 23.8 0.0 2.0 2 rabbit_H \n+ 5.9e-008 24.2 0.0 1.8e-007 22.6 0.0 1.8 1 alpaca_H \n+ 3e-007 21.9 0.0 6.5e-007 20.8 0.0 1.6 1 pig_H \n+\n+\n+Domain annotation for each model (and alignments):\n+>> human_B \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 138.2 0.1 2.4e-043 2.4e-043 1 127 [. 2 114 .. 2 115 .. 0.98\n+\n+ Alignments for each domain:\n+ == domain 1 score: 138.2 bits; conditional E-value: 2.4e-043\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ human_B 1 eagvtQsPrykvtktgqkvtlrCsqisghllllllaetlyWYrqdlgqglelliysqegllleeatdksevpkdrfsaerplkkskstLklesaeledsavY 102\n+ +agvtQ+Pry+++++gq+vtl+Cs+isgh ++++WY+q++gqgl++l+ + + e++++k+++p rfs +++ ++s+s+++++++el+dsa+Y\n+ 6FR3 2 KAGVTQTPRYLIKTRGQQVTLSCSPISGH-------RSVSWYQQTPGQGLQFLFEYFS----ETQRNKGNFP-GRFSGRQF-SNSRSEMNVSTLELGDSALY 90 \n+ 599**************************.......**********************....**********.********.******************** PP\n+\n+ xxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ human_B 103 lCAsslllllllelyFGeGtrLtVl 127\n+ lCAss ++ +l+FG+GtrLtV+\n+ 6FR3 91 LCASSF-DSGNSPLHFGNGTRLTVT 114\n+ *****7.99999************7 PP\n+\n+>> mouse_B \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 121.7 0.1 3.3e-038 3.3e-038 2 127 .. 3 114 .. 2 114 .. 0.97\n+\n+ Alignments for each domain:\n+ == domain 1 score: 121.7 bits; conditional E-value: 3.3e-038\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ mouse_B 2 agvtQtPrhlvkekGqkvtLkCeqksghllllllaeamyWYrqdlgkelkllvysqnglllkkaleksdlpkerfsasrplkksessLkiesaeledsavYl 103\n+ agvtQtPr+l+k++Gq+vtL+C+++sgh ++ WY+q++g++l++l+ + + + + +k+++p rfs ++ ++s+s+++++++el+dsa+Yl\n+ 6FR3 3 AGVTQTPRYLIKTRGQQVTLSCSPISGH-------RSVSWYQQTPGQGLQFLFEYFS----ETQRNKGNFP-GRFSGRQF-SNSRSEMNVSTLELGDSALYL 91 \n+ 79**************************.......**********************....99********.********.********************* PP\n+\n+ xxxxxxxxxxxxxxxxxxxxxxxx RF\n+ mouse_B 104 CasselllllleqyFGeGtrLtVl 127\n+ Cass ++ + FG+GtrLtV+\n+ 6FR3 92 CASSF-DSGNSPLHFGNGTRLTVT 114\n+ ****6.99999************6 PP\n+\n+>> human_A \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 77.7 0.0 1.2e-024 1.2e-024 3 127 .. 4 114 .. 2 115 .. 0.89\n+\n+ Alignments for each domain:\n+ == domain 1 score: 77.7 bits; conditional E-value: 1.2e-024\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ human_A 3 kveqspqslsvqEgesvtlnCtystsatlllllseylfWYkqepgkglqllikllsalldeeekkklllllgrlsatlnkseksssLkitasqlsdsAvYfC 104\n+ v+q+p l+ + g++vtl+C+ + +++ WY+q pg+glq+l+++ s+ +++k + + gr+s s+++s ++++ +l+dsA Y+C\n+ 6FR3 4 GVTQTPRYLIKTRGQQVTLSCSPISGH-------RSVSWYQQTPGQGLQFLFEYFSE--TQRNKGN---FPGRFSGRQ-FSNSRSEMNVSTLELGDSALYLC 92 \n+ 69*******************977666.......9********************97..6677777...889998753.3468999**************** PP\n+\n+ xxxxxxxxxxxxxxxxxxxxxxx RF\n+ human_A 105 avsellllllkliFGkGTrLtVk 127\n+ a s + ++ l FG+GTrLtV+\n+ 6FR3 93 ASS-FDSGNSPLHFGNGTRLTVT 114\n+ **9.899999***********96 PP\n+\n+>> mouse_A \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 77.6 0.1 1.2e-024 1.2e-024 3 127 .. 4 114 .. 2 115 .. 0.89\n+\n+ Alignments for each domain:\n+ == domain 1 score: 77.6 bits; conditional E-value: 1.2e-024\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ mouse_A 3 kveqspesltvqegesvtlnCsystsavllllaseylfWYkqepgeglqlLlkivsalldeekkeslllllgrfeatlnkseksssLhitsvqlsDsAvYfC 104\n+ v+q+p l + g++vtl+Cs + + +++ WY+q+pg+glq+L++++s+ ++++k + + grf+ + s+++s++++++ +l DsA+Y+C\n+ 6FR3 4 GVTQTPRYLIKTRGQQVTLSCSPISGH-------RSVSWYQQTPGQGLQFLFEYFSE--TQRNKGN---FPGRFSG-RQFSNSRSEMNVSTLELGDSALYLC 92 \n+ 69*******************976666.......9*********************7..5555555...8899976.57788999***************** PP\n+\n+ xxxxxxxxxxxxxxxxxxxxxxx RF\n+ mouse_A 105 alsellllllkltFGkGTkLtvk 127\n+ a s + ++ l+FG+GT+Ltv+\n+ 6FR3 93 ASS-FDSGNSPLHFGNGTRLTVT 114\n+ ***.899999***********96 PP\n+\n+>> human_D \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 67.4 0.0 1.8e-021 1.8e-021 4 127 .. 5 114 .. 2 115 .. 0.87\n+ 2 ? -2.2 0.0 6 6 9 29 .. 131 151 .. 127 168 .. 0.70\n+\n+ Alignments for each domain:\n+ == domain 1 score: 67.4 bits; conditional E-value: 1.8e-021\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ human_D 4 vtqsqpslsvqegeavtLnCsyetsasllllgnyylfWYkqepskeitflirqksslldkqekkedakklgrfsvkldkaaksasLkIsasqlgDsatYfCA 105\n+ vtq++ l+ g++vtL+Cs g++++ WY+q+p+++++fl+ s+ +++k + + grfs + ++ + +++s +lgDsa Y+CA\n+ 6FR3 5 VTQTPRYLIKTRGQQVTLSCSPI-------SGHRSVSWYQQTPGQGLQFLFEYFSE--TQRNKGN--FP-GRFSGR-QFSNSRSEMNVSTLELGDSALYLCA 93 \n+ 99******************843.......4789*****************99986..4555554..66.9***97.677888899**************** PP\n+\n+ xxxxxxxxxxxxxxxxxxxxxx RF\n+ human_D 106 leellllllqliFGkGtkliVe 127\n+ + + ++ +l FG Gt+l+V \n+ 6FR3 94 SS-FDSGNSPLHFGNGTRLTVT 114\n+ *8.79999************95 PP\n+\n+ == domain 2 score: -2.2 bits; conditional E-value: 6\n+ xxxxxxxxxxxxxxxxxxxxx RF\n+ human_D 9 pslsvqegeavtLnCsyetsa 29 \n+ ++ +++ +++tL C ++ \n+ 6FR3 131 SEAEISHTQKATLVCLATGFF 151\n+ 566788889999999876655 PP\n+\n+>> rhesus_L \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 66.8 0.3 3.5e-021 3.5e-021 3 126 .. 4 113 .. 2 114 .. 0.89\n+ 2 ? -1.0 0.0 3.3 3.3 7 28 .. 129 150 .. 124 169 .. 0.73\n+\n+ Alignments for each domain:\n+ == domain 1 score: 66.8 bits; conditional E-value: 3.5e-021\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ rhesus_L 3 vltQppslvsaspgqsvrltCtgssskivlllgskyvsWyqqkpgqapklliyeksdlllsdskrpsg.vpldRfsgskdasgntasLtisglqaeDEadY 102\n+ +tQ p ++ ++ gq+v+l+C+ s++ ++vsWyqq+pgq + l + s+++r+ g p Rfsg + s +++ + +s l+ D a Y\n+ 6FR3 4 GVTQTPRYLIKTRGQQVTLSCSPISGH-------RSVSWYQQTPGQGLQFLFEYF-----SETQRNKGnFP-GRFSGRQ-FSNSRSEMNVSTLELGDSALY 90 \n+ 68*******************999888.......57*************999998.....55888877256.******9.7777888************** PP\n+\n+ xxxxxxxxxxxxxxxxxxxxxxxx RF\n+ rhesus_L 103 yCqswdlllllllvvFGeGTrLTv 126\n+ C+s ++ FG+GTrLTv\n+ 6FR3 91 LCASSF-DSGNSPLHFGNGTRLTV 113\n+ **9988.78888999********9 PP\n+\n+ == domain 2 score: -1.0 bits; conditional E-value: 3.3\n+ xxxxxxxxxxxxxxxxxxxxxx RF\n+ rhesus_L 7 ppslvsaspgqsvrltCtgsss 28 \n+ +ps + s q+++l C + \n+ 6FR3 129 EPSEAEISHTQKATLVCLATGF 150\n+ 6777888999999999977654 PP\n+\n+>> human_L \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 63.1 0.3 4.8e-020 4.8e-020 3 126 .. 4 113 .. 2 114 .. 0.89\n+ 2 ? -1.8 0.0 5.7 5.7 7 25 .. 129 147 .. 125 162 .. 0.77\n+\n+ Alignments for each domain:\n+ == domain 1 score: 63.1 bits; conditional E-value: 4.8e-020\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ human_L 3 vltqppslvsvspgqtvtltCtgsssevvlllgskyvsWyqqkpgkaPklliyeksdlllsdskrpsg.vpldRfsgskdasgntasLtisglqaeDEadYY 103\n+ +tq p ++ ++ gq+vtl+C+ s++ + vsWyqq+pg+ + l + s +++r+ g p Rfsg + s +++ + +s l+ D a Y \n+ 6FR3 4 GVTQTPRYLIKTRGQQVTLSCSPISGH-------RSVSWYQQTPGQGLQFLFEYFS-----ETQRNKGnFP-GRFSGRQ-FSNSRSEMNVSTLELGDSALYL 91 \n+ 589****9*************998888.......57***************99994.....5777776256.9*****9.8899999*************** PP\n+\n+ xxxxxxxxxxxxxxxxxxxxxxx RF\n+ human_L 104 CaswdlllllllvvFGgGtkltv 126\n+ Cas ++ FG Gt+ltv\n+ 6FR3 92 CASSF-DSGNSPLHFGNGTRLTV 113\n+ **998.78888999********9 PP\n+\n+ == domain 2 score: -1.8 bits; conditional E-value: 5.7\n+ xxxxxxxxxxxxxxxxxxx RF\n+ human_L 7 ppslvsvspgqtvtltCtg 25 \n+ +ps + s q++tl C \n+ 6FR3 129 EPSEAEISHTQKATLVCLA 147\n+ 5676888999999999975 PP\n+\n+>> cow_L \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 60.7 0.2 2.7e-019 2.7e-019 3 126 .. 4 113 .. 2 114 .. 0.88\n+\n+ Alignments for each domain:\n+ == domain 1 score: 60.7 bits; conditional E-value: 2.7e-019\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ cow_L 3 vLtqpsslvsgslGqtvsitCsgsssnvglllsensvsWyqqipgsaprtliyeksdlllsdskrasG.vpldrfsgskdasgntatLtisglqaeDeaDYyCa 105\n+ +tq + ++ + Gq+v+++Cs s++ svsWyqq+pg++++ l s+++r+ G p rfsg + s+ + + +s+l+ D a Y Ca\n+ 6FR3 4 GVTQTPRYLIKTRGQQVTLSCSPISGH-------RSVSWYQQTPGQGLQFLFEYF-----SETQRNKGnFP-GRFSGRQ-FSNSRSEMNVSTLELGDSALYLCA 93 \n+ 67999999*************998887.......57*************998665.....67888888356.*****99.9*********************** PP\n+\n+ xxxxxxxxxxxxxxxxxxxxx RF\n+ cow_L 106 sadlllllllavFGsGttltv 126\n+ s ++ FG Gt+ltv\n+ 6FR3 94 SSF-DSGNSPLHFGNGTRLTV 113\n+ 987.57777788********9 PP\n+\n+>> mouse_D \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 58.6 0.0 1.3e-018 1.3e-018 3 126 .. 4 113 .. 2 114 .. 0.87\n+ 2 ? -1.5 0.0 5 5 10 44 .. 132 162 .. 128 199 .. 0.70\n+\n+ Alignments for each domain:\n+ == domain 1 score: 58.6 bits; conditional E-value: 1.3e-018\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ mouse_D 3 kvtqsqkslsvqegeevtldCsyetsdvllllknyalfWYkqlpsgslvllikqassllkkekkesdasklgrlsvkfqkkeksisLeisasqledsatYfC 104\n+ vtq+++ l + g++vtl+Cs + + ++++WY+q+p+++l++l++ s+ +++++ gr+s q +++++ +++s+ +l dsa Y C\n+ 6FR3 4 GVTQTPRYLIKTRGQQVTLSCSPISGH-------RSVSWYQQTPGQGLQFLFEYFSE-----TQRNKGNFPGRFSGR-QFSNSRSEMNVSTLELGDSALYLC 92 \n+ 599*******************88877.......79*****************9974.....444433345888875.67788899**************** PP\n+\n+ xxxxxxxxxxxxxxxxxxxxxx RF\n+ mouse_D 105 aleellllllklvFGtGielfV 126\n+ a++ + ++ l FG G+ l+V\n+ 6FR3 93 ASS-FDSGNSPLHFGNGTRLTV 113\n+ ***.599999***********9 PP\n+\n+ == domain 2 score: -1.5 bits; conditional E-value: 5\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ mouse_D 10 slsvqegeevtldCsyetsdvllllknyalfWYkq 44 \n+ + +++ +++tl C ++ + l+W+ \n+ 6FR3 132 EAEISHTQKATLVCLATGFFP----DHVELSWWVN 162\n+ 556677778888887665543....5667777755 PP\n+\n+>> mouse_K \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 56.7 0.2 4.4e-018 4.4e-018 4 126 .. 5 113 .. 2 114 .. 0.89\n+ 2 ? 0.4 0.0 1.1 1.1 8 42 .. 130 160 .. 125 169 .. 0.75\n+\n+ Alignments for each domain:\n+ == domain 1 score: 56.7 bits; conditional E-value: 4.4e-018\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ mouse_K 4 ltqspaslsvslgekvtisCkasqsilaskegssylaWyqqkpgqspklliyealllllllsnlasg.vplsrfsgsgllsgtdftLtissveaedlatYyC 104\n+ +tq+p +l + g++vt+sC+ i +g+++++Wyqq pgq + l + +++++g p rfsg +s++ +++s++e d a Y C\n+ 6FR3 5 VTQTPRYLIKTRGQQVTLSCSP---I----SGHRSVSWYQQTPGQGLQFLFEYF-----SETQRNKGnFP-GRFSGRQ-FSNSRSEMNVSTLELGDSALYLC 92 \n+ 8*******************86...5....35689****************999.....44555555277.******9.999******************** PP\n+\n+ xxxxxxxxxxxxxxxxxxxxxx RF\n+ mouse_K 105 qqsslllllllyTFGgGTKLEi 126\n+ + s ++ + FG GT+L +\n+ 6FR3 93 ASSF-DSGNSPLHFGNGTRLTV 113\n+ **99.889999********965 PP\n+\n+ == domain 2 score: 0.4 bits; conditional E-value: 1.1\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ mouse_K 8 paslsvslgekvtisCkasqsilaskegssylaWy 42 \n+ p+ +s +k+t+ C a+ ++ l+W+\n+ 6FR3 130 PSEAEISHTQKATLVCLATGFF----PDHVELSWW 160\n+ 666789999*******998766....345566665 PP\n+\n+>> rabbit_L \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 57.2 0.2 3.3e-018 3.3e-018 4 127 .. 5 114 .. 2 115 .. 0.89\n+\n+ Alignments for each domain:\n+ == domain 1 score: 57.2 bits; conditional E-value: 3.3e-018\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ rabbit_L 4 ltqppslvsasLgqtarltCtlssgeivllleeyaveWyqqkpGkaPrlllykdtdllleikkrgsGvpldrFsgskdssgnsasLtisglqaeDeAdYyC 104\n+ +tq+p ++ + gq ++l+C+ sg+ +v+Wyqq+pG+ + l+ + ++ ++++ p rFsg + s+ + +s+l +D A Y C\n+ 6FR3 5 VTQTPRYLIKTRGQQVTLSCSPISGHR-------SVSWYQQTPGQGLQFLFEYFSE----TQRNKGNFP-GRFSGRQ-FSNSRSEMNVSTLELGDSALYLC 92 \n+ 699999999999*********999996.......7*****************9977....455555567.*****99.8888889**************** PP\n+\n+ xxxxxxxxxxxxxxxxxxxxxxx RF\n+ rabbit_L 105 asaelllllllvvFGGGtqLtvt 127\n+ as+ ++ FG Gt Ltvt\n+ 6FR3 93 ASSF-DSGNSPLHFGNGTRLTVT 114\n+ *997.7889999**********9 PP\n+\n+>> pig_L \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 56.0 0.2 9.1e-018 9.1e-018 4 126 .. 5 113 .. 2 115 .. 0.90\n+\n+ Alignments for each domain:\n+ == domain 1 score: 56.0 bits; conditional E-value: 9.1e-018\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ pig_L 4 liqePsllsvslgetvtltCalssgsvvlllssnyvsWyqqkPGrpPkyliyftfaslskdnsratgvplssfsgaillsgnkatLtisGlqaeDeaDyfCall 107\n+ ++q P +l + g++vtl+C+ sg vsWyqq+PG+ ++l + s+ + + p +fsg + +s ++ + +s l D a y Ca+ \n+ 6FR3 5 VTQTPRYLIKTRGQQVTLSCSPISGHRS-------VSWYQQTPGQGLQFLFEYF----SETQRNKGNFP-GRFSGRQ-FSNSRSEMNVSTLELGDSALYLCASS 95 \n+ 69*******************9999885.......9**************9998....45566666677.9*****9.9***********************99 PP\n+\n+ xxxxxxxxxxxxxxxxxxx RF\n+ pig_L 108 kllllllldrFGgGthLtv 126\n+ ++ FG Gt+Ltv\n+ 6FR3 96 F-DSGNSPLHFGNGTRLTV 113\n+ 8.7888899*********9 PP\n+\n+>> rat_K \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 54.4 0.1 2.3e-017 2.3e-017 4 125 .. 5 112 .. 2 114 .. 0.89\n+ 2 ? -1.7 0.0 5.2 5.2 8 27 .. 130 149 .. 128 165 .. 0.71\n+\n+ Alignments for each domain:\n+ == domain 1 score: 54.4 bits; conditional E-value: 2.3e-017\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ rat_K 4 mtqspaslsvslgervtisCkasqdilksadgknylsWyqqkpgkspklliykalllllllsnlasg.vplsrFsgsgllsgtdftltissleaedlavYyClq 106\n+ +tq+p l + g++vt+sC i +g++++sWyqq pg+ + l +++++g p rFsg + +s++ +++s+le d a Y C \n+ 6FR3 5 VTQTPRYLIKTRGQQVTLSCSP---I----SGHRSVSWYQQTPGQGLQFLFEYF-----SETQRNKGnFP-GRFSGRQ-FSNSRSEMNVSTLELGDSALYLCAS 94 \n+ 8*******************64...6....57899*************998776.....45666666267.*****99.9***********************9 PP\n+\n+ xxxxxxxxxxxxxxxxxxx RF\n+ rat_K 107 sklllllllltFGaGtkLE 125\n+ s ++ l FG Gt+L \n+ 6FR3 95 SF-DSGNSPLHFGNGTRLT 112\n+ 98.888999********96 PP\n+\n+ == domain 2 score: -1.7 bits; conditional E-value: 5.2\n+ xxxxxxxxxxxxxxxxxxxx RF\n+ rat_K 8 paslsvslgervtisCkasq 27 \n+ p+ +s +++t+ C a \n+ 6FR3 130 PSEAEISHTQKATLVCLATG 149\n+ 56667889999999998865 PP\n+\n+>> human_K \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 52.6 0.4 7.5e-017 7.5e-017 4 126 .. 5 113 .. 2 114 .. 0.89\n+ 2 ? 0.1 0.0 1.3 1.3 8 29 .. 130 151 .. 126 168 .. 0.76\n+\n+ Alignments for each domain:\n+ == domain 1 score: 52.6 bits; conditional E-value: 7.5e-017\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ human_K 4 ltqsPsslsvsvgdrvtisCrasqsilesddgssylaWyqqkpgkapklliyaalllllllsslasG.vPlsrfsGsGllsGtdftltissleaedvavyyC 104\n+ +tq+P l + g++vt+sC i +g+ +++Wyqq pg+ ++l ++++ G P rfsG +s +++s+le d a y C\n+ 6FR3 5 VTQTPRYLIKTRGQQVTLSCSP---I----SGHRSVSWYQQTPGQGLQFLFEYF-----SETQRNKGnFP-GRFSGRQ-FSNSRSEMNVSTLELGDSALYLC 92 \n+ 7*******************75...5....46789***************9988.....55666666267.******9.9999******************* PP\n+\n+ xxxxxxxxxxxxxxxxxxxxxx RF\n+ human_K 105 qqaklllllllltfGqGtkvei 126\n+ + ++ l fG+Gt++ +\n+ 6FR3 93 ASSF-DSGNSPLHFGNGTRLTV 113\n+ *998.888999********976 PP\n+\n+ == domain 2 score: 0.1 bits; conditional E-value: 1.3\n+ xxxxxxxxxxxxxxxxxxxxxx RF\n+ human_K 8 PsslsvsvgdrvtisCrasqsi 29 \n+ Ps +s +++t+ C a+ \n+ 6FR3 130 PSEAEISHTQKATLVCLATGFF 151\n+ 88899999********987555 PP\n+\n+>> rhesus_K \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 48.2 0.3 1.9e-015 1.9e-015 4 125 .. 5 112 .. 3 114 .. 0.88\n+ 2 ? -1.7 0.0 5.2 5.2 8 30 .. 130 151 .. 127 167 .. 0.71\n+\n+ Alignments for each domain:\n+ == domain 1 score: 48.2 bits; conditional E-value: 1.9e-015\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ rhesus_K 4 mtqspsslsvsvgervtlisCrasqsilesddgssylaWyqqkpgkaPklliykalllllllssresg.vpldrfsGsgllsgtdftltisslepedvavy 103\n+ +tq+p l + g++vt +sC i +g+ +++Wyqq pg+ ++l + ++r++g p rfsG +s++ +++s le d a y\n+ 6FR3 5 VTQTPRYLIKTRGQQVT-LSCSP---I----SGHRSVSWYQQTPGQGLQFLFEYF-----SETQRNKGnFP-GRFSGRQ-FSNSRSEMNVSTLELGDSALY 90 \n+ 69***************.**965...5....46789**************99888.....45566655267.******9.999****************** PP\n+\n+ xxxxxxxxxxxxxxxxxxxxxx RF\n+ rhesus_K 104 yCqqelllllllWtfGqGtkve 125\n+ C ++ ++ fG Gt+ \n+ 6FR3 91 LCASSFDSGNSPLHFGNGTRLT 112\n+ *****99999*********975 PP\n+\n+ == domain 2 score: -1.7 bits; conditional E-value: 5.2\n+ xxxxxxxxxxxxxxxxxxxxxxx RF\n+ rhesus_K 8 psslsvsvgervtlisCrasqsi 30 \n+ ps +s +++t + C a+ +\n+ 6FR3 130 PSEAEISHTQKAT-LVCLATGFF 151\n+ 7778889999999.999886544 PP\n+\n+>> cow_K \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 46.5 0.1 5.9e-015 5.9e-015 4 125 .. 5 112 .. 2 114 .. 0.89\n+\n+ Alignments for each domain:\n+ == domain 1 score: 46.5 bits; conditional E-value: 5.9e-015\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ cow_K 4 ltqtPlslsvilGetvsisckstqslkysldgktylrWlqqkPGqsPklliyqvlllllllsnrytgvpldrftgsgllsetdftltissveaedaavyyclqd 107\n+ +tqtP +l + G++v++sc + +g+ ++W+qq PGq + l + ++r++g rf+g + +s++ + +s +e d+a y c +\n+ 6FR3 5 VTQTPRYLIKTRGQQVTLSCSP---I----SGHRSVSWYQQTPGQGLQFLFEYF-----SETQRNKGNFPGRFSGRQ-FSNSRSEMNVSTLELGDSALYLCASS 95 \n+ 8*******************64...4....58899************9998777.....67888888766*******.9***********************99 PP\n+\n+ xxxxxxxxxxxxxxxxxx RF\n+ cow_K 108 tlllllllntfGqGtkve 125\n+ ++ fG Gt++ \n+ 6FR3 96 F-DSGNSPLHFGNGTRLT 112\n+ 9.77777889*****975 PP\n+\n+>> pig_K \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 44.4 0.4 2.6e-014 2.6e-014 4 126 .. 5 113 .. 3 115 .. 0.87\n+\n+ Alignments for each domain:\n+ == domain 1 score: 44.4 bits; conditional E-value: 2.6e-014\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ pig_K 4 ltqsPlslsvslGetvsiscrssqslesslygsnylaWyqqkpGksPklliyeallllllltnrasGvPldrfkGsgllsGtdftlkisrleaedvavyycqqa 107\n+ +tq+P l + G+ v++sc + g++ ++Wyqq pG+ ++l t+r+ G rf+G + +s +++s le d a y c +\n+ 6FR3 5 VTQTPRYLIKTRGQQVTLSCSP---I----SGHRSVSWYQQTPGQGLQFLFEYF-----SETQRNKGNFPGRFSGRQ-FSNSRSEMNVSTLELGDSALYLCASS 95 \n+ 69******************64...4....467889************997544.....47888777544******9.9***********************99 PP\n+\n+ xxxxxxxxxxxxxxxxxxx RF\n+ pig_K 108 klllllllvtfGsGtklel 126\n+ ++ + fG+Gt+l +\n+ 6FR3 96 F-DSGNSPLHFGNGTRLTV 113\n+ 8.888999*******9975 PP\n+\n+>> mouse_L \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 41.5 0.1 2.1e-013 2.1e-013 2 126 .. 3 113 .. 2 115 .. 0.89\n+\n+ Alignments for each domain:\n+ == domain 1 score: 41.5 bits; conditional E-value: 2.1e-013\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ mouse_L 2 avvtqesallttslGatvkltCrsstgavtllltsnyaeWvqekpdklfkgvigltkdlllgssnradGvPlarfsGsllliGdkaaltitgaqtedeaiyi 103\n+ a vtq +l + G+ v+l C +g+ + + W+q+ p + + + + + n+++ P rfsG ++ + ++ d a+y+\n+ 6FR3 3 AGVTQTPRYLIKTRGQQVTLSCSPISGHRS-------VSWYQQTPGQGLQFLFEYFSE---TQRNKGN-FP-GRFSGRQ-FSNSRSEMNVSTLELGDSALYL 91 \n+ 569999999999****************96.......99************9998844...5555554.78.9*****9.899999**************** PP\n+\n+ xxxxxxxxxxxxxxxxxxxxxxx RF\n+ mouse_L 104 CalwylllllllyvfGgGtkvtv 126\n+ Ca ++ fG Gt++tv\n+ 6FR3 92 CASSF-DSGNSPLHFGNGTRLTV 113\n+ **998.77888899********9 PP\n+\n+>> rat_L \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 41.4 0.1 2.5e-013 2.5e-013 4 126 .. 5 113 .. 2 115 .. 0.81\n+\n+ Alignments for each domain:\n+ == domain 1 score: 41.4 bits; conditional E-value: 2.5e-013\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ rat_L 4 ltqpnslvstslgstvklsCkrstgnitlllgsnYvnWyqqkedrsivtviykdllllllldkrpdgvpldrfsGsidsssnsaaLtitnvqieDeadYfCqsy 107\n+ +tq + ++ + g+ v+lsC+ +g+ + v+Wyqq +++ + + ++ + +r +g rfsG + s++++ + + +++ D a Y C s \n+ 6FR3 5 VTQTPRYLIKTRGQQVTLSCSPISGH-------RSVSWYQQTPGQGLQFL-FEY----FSETQRNKGNFPGRFSGR-QFSNSRSEMNVSTLELGDSALYLCASS 95 \n+ 78888888889999999999877766.......78*********987655.444....456788888666******.68888899****************998 PP\n+\n+ xxxxxxxxxx.xxxxxxxxx RF\n+ rat_L 108 slllllllPv.fGGGtkLtv 126\n+ ++ P fG Gt+Ltv\n+ 6FR3 96 F--DSGNSPLhFGNGTRLTV 113\n+ 8..45555644********9 PP\n+\n+>> rabbit_K \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 37.1 0.2 4.7e-012 4.7e-012 4 126 .. 5 113 .. 2 115 .. 0.84\n+\n+ Alignments for each domain:\n+ == domain 1 score: 37.1 bits; conditional E-value: 4.7e-012\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ rabbit_K 4 ltqtpasvsaavGGtvtincqasqsvylllldnsylswyqqkpGqppklliysalllllllsklasGvplsrfsGsGllsGtqftltisGvqcddaatyyc 104\n+ +tqtp + G vt+ c +swyqq pGq ++l + + + p rfsG +s + + +s ++ d+a y c\n+ 6FR3 5 VTQTPRYLIKTRGQQVTLSCSPIS-------GHRSVSWYQQTPGQGLQFLFEYF----SETQRNKGNFP-GRFSGRQ-FSNSRSEMNVSTLELGDSALYLC 92 \n+ 689999999999999999996533.......45689**********99997666....34444555678.******9.9********************** PP\n+\n+ xxxxxxxxxxxxxxxxxxxxxx RF\n+ rabbit_K 105 qgsyllllllsltfGaGtkvei 126\n+ ++s+ ++ l fG+Gt++ +\n+ 6FR3 93 ASSF-DSGNSPLHFGNGTRLTV 113\n+ ****.7788889*******987 PP\n+\n+>> mouse_G \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 34.6 0.0 2.5e-011 2.5e-011 4 126 .. 5 113 .. 2 114 .. 0.83\n+\n+ Alignments for each domain:\n+ == domain 1 score: 34.6 bits; conditional E-value: 2.5e-011\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ mouse_G 4 leqtelsvtrrkdesaqisCkvslsvlklllsntaiHWYrqkkgqalerllyvstkllsevkvvekdfkdeklevsekfkdststlkinnvkeeDeatYYCA 105\n+ + qt ++++ +++++++sC+ + WY+q +gq l+ l+ + + ++++k+ ++ ++ f++s+s +++ ++ D+a+Y CA\n+ 6FR3 5 VTQTPRYLIKTRGQQVTLSCSPISGH-------RSVSWYQQTPGQGLQFLFEYFS-----ETQRNKGNFPGRFSGRQ-FSNSRSEMNVSTLELGDSALYLCA 93 \n+ 5688899*************854444.......479*************998875.....57888888888988765.6*********************** PP\n+\n+ xxxxxxxxxxxxxxxxxxxxx RF\n+ mouse_G 106 vWallllllhkvFAeGtkLiv 126\n+ + ++ F +Gt+L v\n+ 6FR3 94 SSF-DSGNSPLHFGNGTRLTV 113\n+ 876.4555555699***9987 PP\n+\n+>> mouse_H \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 34.2 0.0 3.7e-011 3.7e-011 14 127 .. 15 114 .. 5 115 .. 0.79\n+\n+ Alignments for each domain:\n+ == domain 1 score: 34.2 bits; conditional E-value: 3.7e-011\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ mouse_H 14 kpgaslklsCkasgftlsllatsyamsWvrqspgkglewigeisskaesgstkyneklklgratlsrdkskstlylqlssltsedtavyyCareallllllf 115\n+ g+ ++lsC+ + + +sW +q+pg+gl+++ e s++++++ ++ ++ g r+ s+s+ +++s+l+ d+a+y Ca ++ ++ \n+ 6FR3 15 TRGQQVTLSCSPI-------SGHRSVSWYQQTPGQGLQFLFEYFSETQRNKGNFPGRFS-G-----RQFSNSRSEMNVSTLELGDSALYLCAS-SFDSGNSP 102\n+ 4577888888642.......345579****************99998888888888888.4.....4567777779*****************.55555566 PP\n+\n+ xxxxxxxxxxxx RF\n+ mouse_H 116 dyWGqGttvtvs 127\n+ +G+Gt +tv \n+ 6FR3 103 LHFGNGTRLTVT 114\n+ 678*******95 PP\n+\n+>> human_H \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 34.5 0.0 3.5e-011 3.5e-011 15 127 .. 16 114 .. 5 115 .. 0.77\n+\n+ Alignments for each domain:\n+ == domain 1 score: 34.5 bits; conditional E-value: 3.5e-011\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ human_H 15 pgeslklsCaasGftlsllsssyalsWvrqapgkgLewvglisssaesgsteYaeslklgrvtisrdtskntlylqlsslraeDtavYyCarklllllllfd 116\n+ g+ ++lsC+ +s + ++sW +q+pg+gL+++ s+++ ++ ++ ++ r+ s++ +++s+l+ D a+Y Ca + + ++ \n+ 6FR3 16 RGQQVTLSCS-------PISGHRSVSWYQQTPGQGLQFLFEYFSETQRNKGNFPGRFS------GRQFSNSRSEMNVSTLELGDSALYLCASS-FDSGNSPL 103\n+ 4666666664.......33566789**************9988886666666665555......5678888899******************5.55555556 PP\n+\n+ xxxxxxxxxxx RF\n+ human_H 117 vWGqGtlvtvs 127\n+ ++G+Gt tv \n+ 6FR3 104 HFGNGTRLTVT 114\n+ 89******995 PP\n+\n+>> human_G \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 34.4 0.0 3e-011 3e-011 34 127 .. 28 114 .. 6 115 .. 0.83\n+\n+ Alignments for each domain:\n+ == domain 1 score: 34.4 bits; conditional E-value: 3e-011\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.xxxxxxxxxxxxxxxxxxxxx RF\n+ human_G 34 lsatyihWYlhqeGkapqrLlyydsdllnskvvlesGissgkyetdasperkslklilrnlienDsgvYYCat.WdlllllliklfgsGtkLivt 127\n+ ++ WY++ +G+ q+L y s+ ++ G +g+++ + ++ +++ + l+ Ds+ Y Ca +d ++ fg+Gt+L vt\n+ 6FR3 28 SGHRSVSWYQQTPGQGLQFLFEYFSE-----TQRNKGNFPGRFSGRQF-SNSRSEMNVSTLELGDSALYLCASsFD--SGNSPLHFGNGTRLTVT 114\n+ 34679***************998877.....66788999*****9999.99999******************7366..6666778*********9 PP\n+\n+>> rhesus_H \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 30.6 0.0 5.5e-010 5.5e-010 12 126 .. 12 113 .. 4 115 .. 0.75\n+\n+ Alignments for each domain:\n+ == domain 1 score: 30.6 bits; conditional E-value: 5.5e-010\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ rhesus_H 12 lvkPggeslrlsCaaslGftfsllsssyalsWvrqapgkglewvgaisskaesgsteyadslklgrvtisrdtskntlylqlsslkaeDtAvyYCarllll 112\n+ l+k g+ ++lsC+ s + +sW +q+pg+gl+++ + s++++++ ++ gr++ r+ s++ +++s l+ D A+y Ca + \n+ 6FR3 12 LIKTRGQQVTLSCSPI--------SGHRSVSWYQQTPGQGLQFLFEYFSETQRNKGNFP-----GRFS-GRQFSNSRSEMNVSTLELGDSALYLCASSFDS 98 \n+ 6777788889998644........356779*************9988877555555555.....5554.6778888999*****************96544 PP\n+\n+ xx.xxxxxxxxxxxx RF\n+ rhesus_H 113 ll.fdvWGqGvlvtv 126\n+ ++ +G+G+++tv\n+ 6FR3 99 GNsPLHFGNGTRLTV 113\n+ 331335799999998 PP\n+\n+>> cow_H \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 25.1 0.0 2.3e-008 2.3e-008 20 127 .. 21 114 .. 6 115 .. 0.77\n+ 2 ? -1.6 0.0 4.3 4.3 48 48 .. 164 164 .. 132 200 .. 0.54\n+\n+ Alignments for each domain:\n+ == domain 1 score: 25.1 bits; conditional E-value: 2.3e-008\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ cow_H 20 sltctvsGfslllllssyavgwvrqapGkalewlGgissglllGstgynpalklsrlsitkdnsksqvslsvssvttedtatyycakvkllllllvdawGrGlr 123\n+ +l+c + +++v+w +q+pG+ l++l + s+ t+ n + r+s ++ s s+ + vs++ d+a y ca + ++ +G+G r\n+ 6FR3 21 TLSC-------SPISGHRSVSWYQQTPGQGLQFLFEYFSE-----TQRNKGNFPGRFS-GRQFSNSRSEMNVSTLELGDSALYLCASSFDSGNSP-LHFGNGTR 110\n+ 3333.......23345789*****************9999.....7778877778888.577888888999****************66555554.57999999 PP\n+\n+ xxxx RF\n+ cow_H 124 vtvs 127\n+ tv+\n+ 6FR3 111 LTVT 114\n+ 9985 PP\n+\n+ == domain 2 score: -1.6 bits; conditional E-value: 4.3\n+ x RF\n+ cow_H 48 k 48 \n+ k\n+ 6FR3 164 K 164\n+ 1 PP\n+\n+>> rabbit_H \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 23.8 0.0 6.7e-008 6.7e-008 20 127 .. 21 114 .. 8 115 .. 0.69\n+ 2 ? -0.5 0.0 2.3 2.3 15 40 .. 137 158 .. 129 166 .. 0.68\n+\n+ Alignments for each domain:\n+ == domain 1 score: 23.8 bits; conditional E-value: 6.7e-008\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ rabbit_H 20 tltCtvsGfslslllssyavsWvrqapGkglewiglisssslsgstyyaswaklsrstisrntnentvtLkmtsltaaDtatyfCaralllllllldlWGq 120\n+ tl+C + + +vsW +q pG+gl+++ s++ ++ ++ + + +r +++ ++++++l D a y+Ca ++ ++ l +G+\n+ 6FR3 21 TLSCS-------PISGHRSVSWYQQTPGQGLQFLFEYFSETQRNKGNFPGRFS-GRQ-----FSNSRSEMNVSTLELGDSALYLCASSFDSGNSPL-HFGN 107\n+ 44443.......22345679************987666664555555555555.443.....3335556778888889*********777777776.58** PP\n+\n+ xxxxxxx RF\n+ rabbit_H 121 GtLvtvs 127\n+ Gt tv+\n+ 6FR3 108 GTRLTVT 114\n+ **99995 PP\n+\n+ == domain 2 score: -0.5 bits; conditional E-value: 2.3\n+ xxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ rabbit_H 15 pgdtLtltCtvsGfslslllssyavs 40 \n+ ++ tl C ++Gf + ++s\n+ 6FR3 137 HTQKATLVCLATGFFP----DHVELS 158\n+ 5667789999999855....444444 PP\n+\n+>> alpaca_H \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 22.6 0.0 1.8e-007 1.8e-007 17 127 .. 18 114 .. 6 115 .. 0.75\n+\n+ Alignments for each domain:\n+ == domain 1 score: 22.6 bits; conditional E-value: 1.8e-007\n+ xxxxxxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ alpaca_H 17 gslrlsca.asGstftlltssyamswvrqaPGkglelvaaisldllgGstyyadsvklgrftisrdnakntlylqlnslkpedtavyycakllllllllld 116\n+ + + lsc+ +s + +sw++q+PG+gl+++ ++ t + grf+ r + + +++++l+ d+a+y ca + ++ \n+ 6FR3 18 QQVTLSCSpIS--------GHRSVSWYQQTPGQGLQFLFEYFSE-----TQRNKGNFPGRFS-GRQFSNSRSEMNVSTLELGDSALYLCASSFDSGNSP-L 103\n+ 55555554223........34568*************9877777.....5555555558987.6888888889999***************55555555.5 PP\n+\n+ xxxxxxxxxxx RF\n+ alpaca_H 117 awGqGtlvtvs 127\n+ +G+Gt +tv+\n+ 6FR3 104 HFGNGTRLTVT 114\n+ 79*******96 PP\n+\n+>> pig_H \n+ # score bias c-Evalue i-Evalue hmmfrom hmm to alifrom ali to envfrom env to acc\n+ --- ------ ----- --------- --------- ------- ------- ------- ------- ------- ------- ----\n+ 1 ! 20.8 0.0 6.5e-007 6.5e-007 35 126 .. 29 113 .. 12 115 .. 0.78\n+\n+ Alignments for each domain:\n+ == domain 1 score: 20.8 bits; conditional E-value: 6.5e-007\n+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx RF\n+ pig_H 35 ssyavswvrqapgkglewlaaissssysgstyyadsvklgrftisrddsqntaylqmnslrtedtaryycarllllllllldswgrgvlvtv 126\n+ +vsw +q+pg+gl++l s t+ grf+ r+ s+ + +++++l d+a y ca + ++ l ++g+g+ +tv\n+ 6FR3 29 GHRSVSWYQQTPGQGLQFLFEYFSE-----TQRNKGNFPGRFS-GRQFSNSRSEMNVSTLELGDSALYLCASSFDSGNSPL-HFGNGTRLTV 113\n+ 45689**************876555.....5555555569997.56677788889999**************777776666.6899998887 PP\n+\n+\n+\n+Internal pipeline statistics summary:\n+-------------------------------------\n+Query sequence(s): 1 (244 residues searched)\n+Target model(s): 29 (3712 nodes)\n+Passed MSV filter: 29 (1); expected 0.6 (0.02)\n+Passed bias filter: 29 (1); expected 0.6 (0.02)\n+Passed Vit filter: 29 (1); expected 0.0 (0.001)\n+Passed Fwd filter: 29 (1); expected 0.0 (1e-005)\n+Initial search space (Z): 29 [actual number of targets]\n+Domain search space (domZ): 29 [number of targets reported over threshold]\n+# CPU time: 0.03u 00:00:00.03 Elapsed: 00:00:00.00\n+# Mc/sec: inf\n+//\n+[ok]\ndiff --git a/Tests/test_SearchIO_hmmer3_text.py b/Tests/test_SearchIO_hmmer3_text.py\nindex dc806fd2c95..dfa36f79b43 100644\n--- a/Tests/test_SearchIO_hmmer3_text.py\n+++ b/Tests/test_SearchIO_hmmer3_text.py\n@@ -1654,6 +1654,35 @@ def test_30_hmmscan_010(self):\n self.assertEqual(0, hit.domain_obs_num)\n self.assertEqual(0, len(hit))\n \n+ def test_30_hmmscan_011(self):\n+ \"\"\"Parsing hmmscan 3.0 (text_30_hmmscan_011).\"\"\"\n+ hmmer_file = get_file(\"text_30_hmmscan_011.out\")\n+ qresults = list(parse(hmmer_file, FMT))\n+ assert len(qresults) == 2\n+\n+ result = qresults[0]\n+ hit = result[-1]\n+ assert len(result) == 29\n+ assert hit.hsps[0].bitscore == 22.4\n+\n+ result = qresults[1]\n+ hit = result[-1]\n+ assert len(result) == 29\n+ assert hit.hsps[0].bitscore == 20.8\n+\n+ # Test getting program name when preamble contains full path and whitespace\n+ expected_db_target = (\n+ \"C:\\\\msys64\\\\scr\\\\byerly\\\\builds\\\\NB\\\\20231025 _\\\\internal\\\\lib\\\\\"\n+ \"site-packages\\\\anarci\\\\dat\\\\HMMs\\\\ALL.hmm\"\n+ )\n+ for idx, qresult in enumerate(qresults):\n+ assert qresult.program == \"hmmscan\", (\n+ \"Expected program 'hmmscan' for item at index \"\n+ f\"{idx}, found {qresult.program}\"\n+ )\n+ # hmm db path also contains space\n+ assert qresult.target == expected_db_target\n+\n \n class HmmersearchCases(unittest.TestCase):\n \"\"\"Test hmmsearch output.\"\"\"\n"}}},{"rowIdx":5495,"cells":{"in_source_id":{"kind":"string","value":"openshift__openshift-ansible-2358"},"issue":{"kind":"string","value":"enable service-serving-cert-signer by default\nCommands like `oadm router` want to take advantage of the service-serving-cert-signing controller. This requires that \n\n``` yaml\ncontrollerConfig:\n serviceServingCert:\n signer:\n certFile: service-signer.crt\n keyFile: service-signer.key\n```\n\nin the master-config.yaml be configured with a signer. This signs for internal DNS names and can be created using a command like:\n\n``` bash\noadm ca create-signer-cert --cert=service-signer.crt --key=service-signer.key --serial=service-signer-serial.txt\n```\n\nhttps://github.com/openshift/openshift-docs/pull/2324 has docs about using it.\n\n"},"before_files":{"kind":"list like","value":[{"content":"#!/usr/bin/python\n# -*- coding: utf-8 -*-\n# vim: expandtab:tabstop=4:shiftwidth=4\n'''\nCustom filters for use in openshift-master\n'''\nimport copy\nimport sys\nimport yaml\n\nfrom ansible import errors\nfrom distutils.version import LooseVersion\n\n# pylint: disable=no-name-in-module,import-error\ntry:\n # ansible-2.1\n from ansible.plugins.filter.core import to_bool as ansible_bool\nexcept ImportError:\n try:\n #ansible-2.0.x\n from ansible.runner.filter_plugins.core import bool as ansible_bool\n except ImportError:\n # ansible-1.9.x\n from ansible.plugins.filter.core import bool as ansible_bool\n\nclass IdentityProviderBase(object):\n \"\"\" IdentityProviderBase\n\n Attributes:\n name (str): Identity provider Name\n login (bool): Is this identity provider a login provider?\n challenge (bool): Is this identity provider a challenge provider?\n provider (dict): Provider specific config\n _idp (dict): internal copy of the IDP dict passed in\n _required (list): List of lists of strings for required attributes\n _optional (list): List of lists of strings for optional attributes\n _allow_additional (bool): Does this provider support attributes\n not in _required and _optional\n\n Args:\n api_version(str): OpenShift config version\n idp (dict): idp config dict\n\n Raises:\n AnsibleFilterError:\n \"\"\"\n # disabling this check since the number of instance attributes are\n # necessary for this class\n # pylint: disable=too-many-instance-attributes\n def __init__(self, api_version, idp):\n if api_version not in ['v1']:\n raise errors.AnsibleFilterError(\"|failed api version {0} unknown\".format(api_version))\n\n self._idp = copy.deepcopy(idp)\n\n if 'name' not in self._idp:\n raise errors.AnsibleFilterError(\"|failed identity provider missing a name\")\n\n if 'kind' not in self._idp:\n raise errors.AnsibleFilterError(\"|failed identity provider missing a kind\")\n\n self.name = self._idp.pop('name')\n self.login = ansible_bool(self._idp.pop('login', False))\n self.challenge = ansible_bool(self._idp.pop('challenge', False))\n self.provider = dict(apiVersion=api_version, kind=self._idp.pop('kind'))\n\n mm_keys = ('mappingMethod', 'mapping_method')\n mapping_method = None\n for key in mm_keys:\n if key in self._idp:\n mapping_method = self._idp.pop(key)\n if mapping_method is None:\n mapping_method = self.get_default('mappingMethod')\n self.mapping_method = mapping_method\n\n valid_mapping_methods = ['add', 'claim', 'generate', 'lookup']\n if self.mapping_method not in valid_mapping_methods:\n raise errors.AnsibleFilterError(\"|failed unkown mapping method \"\n \"for provider {0}\".format(self.__class__.__name__))\n self._required = []\n self._optional = []\n self._allow_additional = True\n\n @staticmethod\n def validate_idp_list(idp_list, openshift_version, deployment_type):\n ''' validates a list of idps '''\n login_providers = [x.name for x in idp_list if x.login]\n\n multiple_logins_unsupported = False\n if len(login_providers) > 1:\n if deployment_type in ['enterprise', 'online', 'atomic-enterprise', 'openshift-enterprise']:\n if LooseVersion(openshift_version) < LooseVersion('3.2'):\n multiple_logins_unsupported = True\n if deployment_type in ['origin']:\n if LooseVersion(openshift_version) < LooseVersion('1.2'):\n multiple_logins_unsupported = True\n if multiple_logins_unsupported:\n raise errors.AnsibleFilterError(\"|failed multiple providers are \"\n \"not allowed for login. login \"\n \"providers: {0}\".format(', '.join(login_providers)))\n\n names = [x.name for x in idp_list]\n if len(set(names)) != len(names):\n raise errors.AnsibleFilterError(\"|failed more than one provider configured with the same name\")\n\n for idp in idp_list:\n idp.validate()\n\n def validate(self):\n ''' validate an instance of this idp class '''\n pass\n\n @staticmethod\n def get_default(key):\n ''' get a default value for a given key '''\n if key == 'mappingMethod':\n return 'claim'\n else:\n return None\n\n def set_provider_item(self, items, required=False):\n ''' set a provider item based on the list of item names provided. '''\n for item in items:\n provider_key = items[0]\n if item in self._idp:\n self.provider[provider_key] = self._idp.pop(item)\n break\n else:\n default = self.get_default(provider_key)\n if default is not None:\n self.provider[provider_key] = default\n elif required:\n raise errors.AnsibleFilterError(\"|failed provider {0} missing \"\n \"required key {1}\".format(self.__class__.__name__, provider_key))\n\n def set_provider_items(self):\n ''' set the provider items for this idp '''\n for items in self._required:\n self.set_provider_item(items, True)\n for items in self._optional:\n self.set_provider_item(items)\n if self._allow_additional:\n for key in self._idp.keys():\n self.set_provider_item([key])\n else:\n if len(self._idp) > 0:\n raise errors.AnsibleFilterError(\"|failed provider {0} \"\n \"contains unknown keys \"\n \"{1}\".format(self.__class__.__name__, ', '.join(self._idp.keys())))\n\n def to_dict(self):\n ''' translate this idp to a dictionary '''\n return dict(name=self.name, challenge=self.challenge,\n login=self.login, mappingMethod=self.mapping_method,\n provider=self.provider)\n\n\nclass LDAPPasswordIdentityProvider(IdentityProviderBase):\n \"\"\" LDAPPasswordIdentityProvider\n\n Attributes:\n\n Args:\n api_version(str): OpenShift config version\n idp (dict): idp config dict\n\n Raises:\n AnsibleFilterError:\n \"\"\"\n def __init__(self, api_version, idp):\n IdentityProviderBase.__init__(self, api_version, idp)\n self._allow_additional = False\n self._required += [['attributes'], ['url'], ['insecure']]\n self._optional += [['ca'],\n ['bindDN', 'bind_dn'],\n ['bindPassword', 'bind_password']]\n\n self._idp['insecure'] = ansible_bool(self._idp.pop('insecure', False))\n\n if 'attributes' in self._idp and 'preferred_username' in self._idp['attributes']:\n pref_user = self._idp['attributes'].pop('preferred_username')\n self._idp['attributes']['preferredUsername'] = pref_user\n\n def validate(self):\n ''' validate this idp instance '''\n IdentityProviderBase.validate(self)\n if not isinstance(self.provider['attributes'], dict):\n raise errors.AnsibleFilterError(\"|failed attributes for provider \"\n \"{0} must be a dictionary\".format(self.__class__.__name__))\n\n attrs = ['id', 'email', 'name', 'preferredUsername']\n for attr in attrs:\n if attr in self.provider['attributes'] and not isinstance(self.provider['attributes'][attr], list):\n raise errors.AnsibleFilterError(\"|failed {0} attribute for \"\n \"provider {1} must be a list\".format(attr, self.__class__.__name__))\n\n unknown_attrs = set(self.provider['attributes'].keys()) - set(attrs)\n if len(unknown_attrs) > 0:\n raise errors.AnsibleFilterError(\"|failed provider {0} has unknown \"\n \"attributes: {1}\".format(self.__class__.__name__, ', '.join(unknown_attrs)))\n\n\nclass KeystonePasswordIdentityProvider(IdentityProviderBase):\n \"\"\" KeystoneIdentityProvider\n\n Attributes:\n\n Args:\n api_version(str): OpenShift config version\n idp (dict): idp config dict\n\n Raises:\n AnsibleFilterError:\n \"\"\"\n def __init__(self, api_version, idp):\n IdentityProviderBase.__init__(self, api_version, idp)\n self._allow_additional = False\n self._required += [['url'], ['domainName', 'domain_name']]\n self._optional += [['ca'], ['certFile', 'cert_file'], ['keyFile', 'key_file']]\n\n\nclass RequestHeaderIdentityProvider(IdentityProviderBase):\n \"\"\" RequestHeaderIdentityProvider\n\n Attributes:\n\n Args:\n api_version(str): OpenShift config version\n idp (dict): idp config dict\n\n Raises:\n AnsibleFilterError:\n \"\"\"\n def __init__(self, api_version, idp):\n IdentityProviderBase.__init__(self, api_version, idp)\n self._allow_additional = False\n self._required += [['headers']]\n self._optional += [['challengeURL', 'challenge_url'],\n ['loginURL', 'login_url'],\n ['clientCA', 'client_ca'],\n ['clientCommonNames', 'client_common_names'],\n ['emailHeaders', 'email_headers'],\n ['nameHeaders', 'name_headers'],\n ['preferredUsernameHeaders', 'preferred_username_headers']]\n\n def validate(self):\n ''' validate this idp instance '''\n IdentityProviderBase.validate(self)\n if not isinstance(self.provider['headers'], list):\n raise errors.AnsibleFilterError(\"|failed headers for provider {0} \"\n \"must be a list\".format(self.__class__.__name__))\n\n\nclass AllowAllPasswordIdentityProvider(IdentityProviderBase):\n \"\"\" AllowAllPasswordIdentityProvider\n\n Attributes:\n\n Args:\n api_version(str): OpenShift config version\n idp (dict): idp config dict\n\n Raises:\n AnsibleFilterError:\n \"\"\"\n def __init__(self, api_version, idp):\n IdentityProviderBase.__init__(self, api_version, idp)\n self._allow_additional = False\n\n\nclass DenyAllPasswordIdentityProvider(IdentityProviderBase):\n \"\"\" DenyAllPasswordIdentityProvider\n\n Attributes:\n\n Args:\n api_version(str): OpenShift config version\n idp (dict): idp config dict\n\n Raises:\n AnsibleFilterError:\n \"\"\"\n def __init__(self, api_version, idp):\n IdentityProviderBase.__init__(self, api_version, idp)\n self._allow_additional = False\n\n\nclass HTPasswdPasswordIdentityProvider(IdentityProviderBase):\n \"\"\" HTPasswdPasswordIdentity\n\n Attributes:\n\n Args:\n api_version(str): OpenShift config version\n idp (dict): idp config dict\n\n Raises:\n AnsibleFilterError:\n \"\"\"\n def __init__(self, api_version, idp):\n IdentityProviderBase.__init__(self, api_version, idp)\n self._allow_additional = False\n self._required += [['file', 'filename', 'fileName', 'file_name']]\n\n @staticmethod\n def get_default(key):\n if key == 'file':\n return '/etc/origin/htpasswd'\n else:\n return IdentityProviderBase.get_default(key)\n\n\nclass BasicAuthPasswordIdentityProvider(IdentityProviderBase):\n \"\"\" BasicAuthPasswordIdentityProvider\n\n Attributes:\n\n Args:\n api_version(str): OpenShift config version\n idp (dict): idp config dict\n\n Raises:\n AnsibleFilterError:\n \"\"\"\n def __init__(self, api_version, idp):\n IdentityProviderBase.__init__(self, api_version, idp)\n self._allow_additional = False\n self._required += [['url']]\n self._optional += [['ca'], ['certFile', 'cert_file'], ['keyFile', 'key_file']]\n\n\nclass IdentityProviderOauthBase(IdentityProviderBase):\n \"\"\" IdentityProviderOauthBase\n\n Attributes:\n\n Args:\n api_version(str): OpenShift config version\n idp (dict): idp config dict\n\n Raises:\n AnsibleFilterError:\n \"\"\"\n def __init__(self, api_version, idp):\n IdentityProviderBase.__init__(self, api_version, idp)\n self._allow_additional = False\n self._required += [['clientID', 'client_id'], ['clientSecret', 'client_secret']]\n\n def validate(self):\n ''' validate this idp instance '''\n IdentityProviderBase.validate(self)\n if self.challenge:\n raise errors.AnsibleFilterError(\"|failed provider {0} does not \"\n \"allow challenge authentication\".format(self.__class__.__name__))\n\n\nclass OpenIDIdentityProvider(IdentityProviderOauthBase):\n \"\"\" OpenIDIdentityProvider\n\n Attributes:\n\n Args:\n api_version(str): OpenShift config version\n idp (dict): idp config dict\n\n Raises:\n AnsibleFilterError:\n \"\"\"\n def __init__(self, api_version, idp):\n IdentityProviderOauthBase.__init__(self, api_version, idp)\n self._required += [['claims'], ['urls']]\n self._optional += [['ca'],\n ['extraScopes'],\n ['extraAuthorizeParameters']]\n if 'claims' in self._idp and 'preferred_username' in self._idp['claims']:\n pref_user = self._idp['claims'].pop('preferred_username')\n self._idp['claims']['preferredUsername'] = pref_user\n if 'urls' in self._idp and 'user_info' in self._idp['urls']:\n user_info = self._idp['urls'].pop('user_info')\n self._idp['urls']['userInfo'] = user_info\n if 'extra_scopes' in self._idp:\n self._idp['extraScopes'] = self._idp.pop('extra_scopes')\n if 'extra_authorize_parameters' in self._idp:\n self._idp['extraAuthorizeParameters'] = self._idp.pop('extra_authorize_parameters')\n\n if 'extraAuthorizeParameters' in self._idp:\n if 'include_granted_scopes' in self._idp['extraAuthorizeParameters']:\n val = ansible_bool(self._idp['extraAuthorizeParameters'].pop('include_granted_scopes'))\n self._idp['extraAuthorizeParameters']['include_granted_scopes'] = val\n\n\n def validate(self):\n ''' validate this idp instance '''\n IdentityProviderOauthBase.validate(self)\n if not isinstance(self.provider['claims'], dict):\n raise errors.AnsibleFilterError(\"|failed claims for provider {0} \"\n \"must be a dictionary\".format(self.__class__.__name__))\n\n for var, var_type in (('extraScopes', list), ('extraAuthorizeParameters', dict)):\n if var in self.provider and not isinstance(self.provider[var], var_type):\n raise errors.AnsibleFilterError(\"|failed {1} for provider \"\n \"{0} must be a {2}\".format(self.__class__.__name__,\n var,\n var_type.__class__.__name__))\n\n required_claims = ['id']\n optional_claims = ['email', 'name', 'preferredUsername']\n all_claims = required_claims + optional_claims\n\n for claim in required_claims:\n if claim in required_claims and claim not in self.provider['claims']:\n raise errors.AnsibleFilterError(\"|failed {0} claim missing \"\n \"for provider {1}\".format(claim, self.__class__.__name__))\n\n for claim in all_claims:\n if claim in self.provider['claims'] and not isinstance(self.provider['claims'][claim], list):\n raise errors.AnsibleFilterError(\"|failed {0} claims for \"\n \"provider {1} must be a list\".format(claim, self.__class__.__name__))\n\n unknown_claims = set(self.provider['claims'].keys()) - set(all_claims)\n if len(unknown_claims) > 0:\n raise errors.AnsibleFilterError(\"|failed provider {0} has unknown \"\n \"claims: {1}\".format(self.__class__.__name__, ', '.join(unknown_claims)))\n\n if not isinstance(self.provider['urls'], dict):\n raise errors.AnsibleFilterError(\"|failed urls for provider {0} \"\n \"must be a dictionary\".format(self.__class__.__name__))\n\n required_urls = ['authorize', 'token']\n optional_urls = ['userInfo']\n all_urls = required_urls + optional_urls\n\n for url in required_urls:\n if url not in self.provider['urls']:\n raise errors.AnsibleFilterError(\"|failed {0} url missing for \"\n \"provider {1}\".format(url, self.__class__.__name__))\n\n unknown_urls = set(self.provider['urls'].keys()) - set(all_urls)\n if len(unknown_urls) > 0:\n raise errors.AnsibleFilterError(\"|failed provider {0} has unknown \"\n \"urls: {1}\".format(self.__class__.__name__, ', '.join(unknown_urls)))\n\n\nclass GoogleIdentityProvider(IdentityProviderOauthBase):\n \"\"\" GoogleIdentityProvider\n\n Attributes:\n\n Args:\n api_version(str): OpenShift config version\n idp (dict): idp config dict\n\n Raises:\n AnsibleFilterError:\n \"\"\"\n def __init__(self, api_version, idp):\n IdentityProviderOauthBase.__init__(self, api_version, idp)\n self._optional += [['hostedDomain', 'hosted_domain']]\n\n\nclass GitHubIdentityProvider(IdentityProviderOauthBase):\n \"\"\" GitHubIdentityProvider\n\n Attributes:\n\n Args:\n api_version(str): OpenShift config version\n idp (dict): idp config dict\n\n Raises:\n AnsibleFilterError:\n \"\"\"\n def __init__(self, api_version, idp):\n IdentityProviderOauthBase.__init__(self, api_version, idp)\n self._optional += [['organizations']]\n\n\nclass FilterModule(object):\n ''' Custom ansible filters for use by the openshift_master role'''\n\n @staticmethod\n def translate_idps(idps, api_version, openshift_version, deployment_type):\n ''' Translates a list of dictionaries into a valid identityProviders config '''\n idp_list = []\n\n if not isinstance(idps, list):\n raise errors.AnsibleFilterError(\"|failed expects to filter on a list of identity providers\")\n for idp in idps:\n if not isinstance(idp, dict):\n raise errors.AnsibleFilterError(\"|failed identity providers must be a list of dictionaries\")\n\n cur_module = sys.modules[__name__]\n idp_class = getattr(cur_module, idp['kind'], None)\n idp_inst = idp_class(api_version, idp) if idp_class is not None else IdentityProviderBase(api_version, idp)\n idp_inst.set_provider_items()\n idp_list.append(idp_inst)\n\n\n IdentityProviderBase.validate_idp_list(idp_list, openshift_version, deployment_type)\n return yaml.safe_dump([idp.to_dict() for idp in idp_list], default_flow_style=False)\n\n @staticmethod\n def validate_pcs_cluster(data, masters=None):\n ''' Validates output from \"pcs status\", ensuring that each master\n provided is online.\n Ex: data = ('...',\n 'PCSD Status:',\n 'master1.example.com: Online',\n 'master2.example.com: Online',\n 'master3.example.com: Online',\n '...')\n masters = ['master1.example.com',\n 'master2.example.com',\n 'master3.example.com']\n returns True\n '''\n if not issubclass(type(data), basestring):\n raise errors.AnsibleFilterError(\"|failed expects data is a string or unicode\")\n if not issubclass(type(masters), list):\n raise errors.AnsibleFilterError(\"|failed expects masters is a list\")\n valid = True\n for master in masters:\n if \"{0}: Online\".format(master) not in data:\n valid = False\n return valid\n\n @staticmethod\n def certificates_to_synchronize(hostvars, include_keys=True):\n ''' Return certificates to synchronize based on facts. '''\n if not issubclass(type(hostvars), dict):\n raise errors.AnsibleFilterError(\"|failed expects hostvars is a dict\")\n certs = ['admin.crt',\n 'admin.key',\n 'admin.kubeconfig',\n 'master.kubelet-client.crt',\n 'master.kubelet-client.key',\n 'openshift-registry.crt',\n 'openshift-registry.key',\n 'openshift-registry.kubeconfig',\n 'openshift-router.crt',\n 'openshift-router.key',\n 'openshift-router.kubeconfig']\n if bool(include_keys):\n certs += ['serviceaccounts.private.key',\n 'serviceaccounts.public.key']\n if bool(hostvars['openshift']['common']['version_gte_3_1_or_1_1']):\n certs += ['master.proxy-client.crt',\n 'master.proxy-client.key']\n if not bool(hostvars['openshift']['common']['version_gte_3_2_or_1_2']):\n certs += ['openshift-master.crt',\n 'openshift-master.key',\n 'openshift-master.kubeconfig']\n return certs\n\n @staticmethod\n def oo_htpasswd_users_from_file(file_contents):\n ''' return a dictionary of htpasswd users from htpasswd file contents '''\n htpasswd_entries = {}\n if not isinstance(file_contents, basestring):\n raise errors.AnsibleFilterError(\"failed, expects to filter on a string\")\n for line in file_contents.splitlines():\n user = None\n passwd = None\n if len(line) == 0:\n continue\n if ':' in line:\n user, passwd = line.split(':', 1)\n\n if user is None or len(user) == 0 or passwd is None or len(passwd) == 0:\n error_msg = \"failed, expects each line to be a colon separated string representing the user and passwd\"\n raise errors.AnsibleFilterError(error_msg)\n htpasswd_entries[user] = passwd\n return htpasswd_entries\n\n\n def filters(self):\n ''' returns a mapping of filters to methods '''\n return {\"translate_idps\": self.translate_idps,\n \"validate_pcs_cluster\": self.validate_pcs_cluster,\n \"certificates_to_synchronize\": self.certificates_to_synchronize,\n \"oo_htpasswd_users_from_file\": self.oo_htpasswd_users_from_file}\n","path":"filter_plugins/openshift_master.py"}],"string":"[\n {\n \"content\": \"#!/usr/bin/python\\n# -*- coding: utf-8 -*-\\n# vim: expandtab:tabstop=4:shiftwidth=4\\n'''\\nCustom filters for use in openshift-master\\n'''\\nimport copy\\nimport sys\\nimport yaml\\n\\nfrom ansible import errors\\nfrom distutils.version import LooseVersion\\n\\n# pylint: disable=no-name-in-module,import-error\\ntry:\\n # ansible-2.1\\n from ansible.plugins.filter.core import to_bool as ansible_bool\\nexcept ImportError:\\n try:\\n #ansible-2.0.x\\n from ansible.runner.filter_plugins.core import bool as ansible_bool\\n except ImportError:\\n # ansible-1.9.x\\n from ansible.plugins.filter.core import bool as ansible_bool\\n\\nclass IdentityProviderBase(object):\\n \\\"\\\"\\\" IdentityProviderBase\\n\\n Attributes:\\n name (str): Identity provider Name\\n login (bool): Is this identity provider a login provider?\\n challenge (bool): Is this identity provider a challenge provider?\\n provider (dict): Provider specific config\\n _idp (dict): internal copy of the IDP dict passed in\\n _required (list): List of lists of strings for required attributes\\n _optional (list): List of lists of strings for optional attributes\\n _allow_additional (bool): Does this provider support attributes\\n not in _required and _optional\\n\\n Args:\\n api_version(str): OpenShift config version\\n idp (dict): idp config dict\\n\\n Raises:\\n AnsibleFilterError:\\n \\\"\\\"\\\"\\n # disabling this check since the number of instance attributes are\\n # necessary for this class\\n # pylint: disable=too-many-instance-attributes\\n def __init__(self, api_version, idp):\\n if api_version not in ['v1']:\\n raise errors.AnsibleFilterError(\\\"|failed api version {0} unknown\\\".format(api_version))\\n\\n self._idp = copy.deepcopy(idp)\\n\\n if 'name' not in self._idp:\\n raise errors.AnsibleFilterError(\\\"|failed identity provider missing a name\\\")\\n\\n if 'kind' not in self._idp:\\n raise errors.AnsibleFilterError(\\\"|failed identity provider missing a kind\\\")\\n\\n self.name = self._idp.pop('name')\\n self.login = ansible_bool(self._idp.pop('login', False))\\n self.challenge = ansible_bool(self._idp.pop('challenge', False))\\n self.provider = dict(apiVersion=api_version, kind=self._idp.pop('kind'))\\n\\n mm_keys = ('mappingMethod', 'mapping_method')\\n mapping_method = None\\n for key in mm_keys:\\n if key in self._idp:\\n mapping_method = self._idp.pop(key)\\n if mapping_method is None:\\n mapping_method = self.get_default('mappingMethod')\\n self.mapping_method = mapping_method\\n\\n valid_mapping_methods = ['add', 'claim', 'generate', 'lookup']\\n if self.mapping_method not in valid_mapping_methods:\\n raise errors.AnsibleFilterError(\\\"|failed unkown mapping method \\\"\\n \\\"for provider {0}\\\".format(self.__class__.__name__))\\n self._required = []\\n self._optional = []\\n self._allow_additional = True\\n\\n @staticmethod\\n def validate_idp_list(idp_list, openshift_version, deployment_type):\\n ''' validates a list of idps '''\\n login_providers = [x.name for x in idp_list if x.login]\\n\\n multiple_logins_unsupported = False\\n if len(login_providers) > 1:\\n if deployment_type in ['enterprise', 'online', 'atomic-enterprise', 'openshift-enterprise']:\\n if LooseVersion(openshift_version) < LooseVersion('3.2'):\\n multiple_logins_unsupported = True\\n if deployment_type in ['origin']:\\n if LooseVersion(openshift_version) < LooseVersion('1.2'):\\n multiple_logins_unsupported = True\\n if multiple_logins_unsupported:\\n raise errors.AnsibleFilterError(\\\"|failed multiple providers are \\\"\\n \\\"not allowed for login. login \\\"\\n \\\"providers: {0}\\\".format(', '.join(login_providers)))\\n\\n names = [x.name for x in idp_list]\\n if len(set(names)) != len(names):\\n raise errors.AnsibleFilterError(\\\"|failed more than one provider configured with the same name\\\")\\n\\n for idp in idp_list:\\n idp.validate()\\n\\n def validate(self):\\n ''' validate an instance of this idp class '''\\n pass\\n\\n @staticmethod\\n def get_default(key):\\n ''' get a default value for a given key '''\\n if key == 'mappingMethod':\\n return 'claim'\\n else:\\n return None\\n\\n def set_provider_item(self, items, required=False):\\n ''' set a provider item based on the list of item names provided. '''\\n for item in items:\\n provider_key = items[0]\\n if item in self._idp:\\n self.provider[provider_key] = self._idp.pop(item)\\n break\\n else:\\n default = self.get_default(provider_key)\\n if default is not None:\\n self.provider[provider_key] = default\\n elif required:\\n raise errors.AnsibleFilterError(\\\"|failed provider {0} missing \\\"\\n \\\"required key {1}\\\".format(self.__class__.__name__, provider_key))\\n\\n def set_provider_items(self):\\n ''' set the provider items for this idp '''\\n for items in self._required:\\n self.set_provider_item(items, True)\\n for items in self._optional:\\n self.set_provider_item(items)\\n if self._allow_additional:\\n for key in self._idp.keys():\\n self.set_provider_item([key])\\n else:\\n if len(self._idp) > 0:\\n raise errors.AnsibleFilterError(\\\"|failed provider {0} \\\"\\n \\\"contains unknown keys \\\"\\n \\\"{1}\\\".format(self.__class__.__name__, ', '.join(self._idp.keys())))\\n\\n def to_dict(self):\\n ''' translate this idp to a dictionary '''\\n return dict(name=self.name, challenge=self.challenge,\\n login=self.login, mappingMethod=self.mapping_method,\\n provider=self.provider)\\n\\n\\nclass LDAPPasswordIdentityProvider(IdentityProviderBase):\\n \\\"\\\"\\\" LDAPPasswordIdentityProvider\\n\\n Attributes:\\n\\n Args:\\n api_version(str): OpenShift config version\\n idp (dict): idp config dict\\n\\n Raises:\\n AnsibleFilterError:\\n \\\"\\\"\\\"\\n def __init__(self, api_version, idp):\\n IdentityProviderBase.__init__(self, api_version, idp)\\n self._allow_additional = False\\n self._required += [['attributes'], ['url'], ['insecure']]\\n self._optional += [['ca'],\\n ['bindDN', 'bind_dn'],\\n ['bindPassword', 'bind_password']]\\n\\n self._idp['insecure'] = ansible_bool(self._idp.pop('insecure', False))\\n\\n if 'attributes' in self._idp and 'preferred_username' in self._idp['attributes']:\\n pref_user = self._idp['attributes'].pop('preferred_username')\\n self._idp['attributes']['preferredUsername'] = pref_user\\n\\n def validate(self):\\n ''' validate this idp instance '''\\n IdentityProviderBase.validate(self)\\n if not isinstance(self.provider['attributes'], dict):\\n raise errors.AnsibleFilterError(\\\"|failed attributes for provider \\\"\\n \\\"{0} must be a dictionary\\\".format(self.__class__.__name__))\\n\\n attrs = ['id', 'email', 'name', 'preferredUsername']\\n for attr in attrs:\\n if attr in self.provider['attributes'] and not isinstance(self.provider['attributes'][attr], list):\\n raise errors.AnsibleFilterError(\\\"|failed {0} attribute for \\\"\\n \\\"provider {1} must be a list\\\".format(attr, self.__class__.__name__))\\n\\n unknown_attrs = set(self.provider['attributes'].keys()) - set(attrs)\\n if len(unknown_attrs) > 0:\\n raise errors.AnsibleFilterError(\\\"|failed provider {0} has unknown \\\"\\n \\\"attributes: {1}\\\".format(self.__class__.__name__, ', '.join(unknown_attrs)))\\n\\n\\nclass KeystonePasswordIdentityProvider(IdentityProviderBase):\\n \\\"\\\"\\\" KeystoneIdentityProvider\\n\\n Attributes:\\n\\n Args:\\n api_version(str): OpenShift config version\\n idp (dict): idp config dict\\n\\n Raises:\\n AnsibleFilterError:\\n \\\"\\\"\\\"\\n def __init__(self, api_version, idp):\\n IdentityProviderBase.__init__(self, api_version, idp)\\n self._allow_additional = False\\n self._required += [['url'], ['domainName', 'domain_name']]\\n self._optional += [['ca'], ['certFile', 'cert_file'], ['keyFile', 'key_file']]\\n\\n\\nclass RequestHeaderIdentityProvider(IdentityProviderBase):\\n \\\"\\\"\\\" RequestHeaderIdentityProvider\\n\\n Attributes:\\n\\n Args:\\n api_version(str): OpenShift config version\\n idp (dict): idp config dict\\n\\n Raises:\\n AnsibleFilterError:\\n \\\"\\\"\\\"\\n def __init__(self, api_version, idp):\\n IdentityProviderBase.__init__(self, api_version, idp)\\n self._allow_additional = False\\n self._required += [['headers']]\\n self._optional += [['challengeURL', 'challenge_url'],\\n ['loginURL', 'login_url'],\\n ['clientCA', 'client_ca'],\\n ['clientCommonNames', 'client_common_names'],\\n ['emailHeaders', 'email_headers'],\\n ['nameHeaders', 'name_headers'],\\n ['preferredUsernameHeaders', 'preferred_username_headers']]\\n\\n def validate(self):\\n ''' validate this idp instance '''\\n IdentityProviderBase.validate(self)\\n if not isinstance(self.provider['headers'], list):\\n raise errors.AnsibleFilterError(\\\"|failed headers for provider {0} \\\"\\n \\\"must be a list\\\".format(self.__class__.__name__))\\n\\n\\nclass AllowAllPasswordIdentityProvider(IdentityProviderBase):\\n \\\"\\\"\\\" AllowAllPasswordIdentityProvider\\n\\n Attributes:\\n\\n Args:\\n api_version(str): OpenShift config version\\n idp (dict): idp config dict\\n\\n Raises:\\n AnsibleFilterError:\\n \\\"\\\"\\\"\\n def __init__(self, api_version, idp):\\n IdentityProviderBase.__init__(self, api_version, idp)\\n self._allow_additional = False\\n\\n\\nclass DenyAllPasswordIdentityProvider(IdentityProviderBase):\\n \\\"\\\"\\\" DenyAllPasswordIdentityProvider\\n\\n Attributes:\\n\\n Args:\\n api_version(str): OpenShift config version\\n idp (dict): idp config dict\\n\\n Raises:\\n AnsibleFilterError:\\n \\\"\\\"\\\"\\n def __init__(self, api_version, idp):\\n IdentityProviderBase.__init__(self, api_version, idp)\\n self._allow_additional = False\\n\\n\\nclass HTPasswdPasswordIdentityProvider(IdentityProviderBase):\\n \\\"\\\"\\\" HTPasswdPasswordIdentity\\n\\n Attributes:\\n\\n Args:\\n api_version(str): OpenShift config version\\n idp (dict): idp config dict\\n\\n Raises:\\n AnsibleFilterError:\\n \\\"\\\"\\\"\\n def __init__(self, api_version, idp):\\n IdentityProviderBase.__init__(self, api_version, idp)\\n self._allow_additional = False\\n self._required += [['file', 'filename', 'fileName', 'file_name']]\\n\\n @staticmethod\\n def get_default(key):\\n if key == 'file':\\n return '/etc/origin/htpasswd'\\n else:\\n return IdentityProviderBase.get_default(key)\\n\\n\\nclass BasicAuthPasswordIdentityProvider(IdentityProviderBase):\\n \\\"\\\"\\\" BasicAuthPasswordIdentityProvider\\n\\n Attributes:\\n\\n Args:\\n api_version(str): OpenShift config version\\n idp (dict): idp config dict\\n\\n Raises:\\n AnsibleFilterError:\\n \\\"\\\"\\\"\\n def __init__(self, api_version, idp):\\n IdentityProviderBase.__init__(self, api_version, idp)\\n self._allow_additional = False\\n self._required += [['url']]\\n self._optional += [['ca'], ['certFile', 'cert_file'], ['keyFile', 'key_file']]\\n\\n\\nclass IdentityProviderOauthBase(IdentityProviderBase):\\n \\\"\\\"\\\" IdentityProviderOauthBase\\n\\n Attributes:\\n\\n Args:\\n api_version(str): OpenShift config version\\n idp (dict): idp config dict\\n\\n Raises:\\n AnsibleFilterError:\\n \\\"\\\"\\\"\\n def __init__(self, api_version, idp):\\n IdentityProviderBase.__init__(self, api_version, idp)\\n self._allow_additional = False\\n self._required += [['clientID', 'client_id'], ['clientSecret', 'client_secret']]\\n\\n def validate(self):\\n ''' validate this idp instance '''\\n IdentityProviderBase.validate(self)\\n if self.challenge:\\n raise errors.AnsibleFilterError(\\\"|failed provider {0} does not \\\"\\n \\\"allow challenge authentication\\\".format(self.__class__.__name__))\\n\\n\\nclass OpenIDIdentityProvider(IdentityProviderOauthBase):\\n \\\"\\\"\\\" OpenIDIdentityProvider\\n\\n Attributes:\\n\\n Args:\\n api_version(str): OpenShift config version\\n idp (dict): idp config dict\\n\\n Raises:\\n AnsibleFilterError:\\n \\\"\\\"\\\"\\n def __init__(self, api_version, idp):\\n IdentityProviderOauthBase.__init__(self, api_version, idp)\\n self._required += [['claims'], ['urls']]\\n self._optional += [['ca'],\\n ['extraScopes'],\\n ['extraAuthorizeParameters']]\\n if 'claims' in self._idp and 'preferred_username' in self._idp['claims']:\\n pref_user = self._idp['claims'].pop('preferred_username')\\n self._idp['claims']['preferredUsername'] = pref_user\\n if 'urls' in self._idp and 'user_info' in self._idp['urls']:\\n user_info = self._idp['urls'].pop('user_info')\\n self._idp['urls']['userInfo'] = user_info\\n if 'extra_scopes' in self._idp:\\n self._idp['extraScopes'] = self._idp.pop('extra_scopes')\\n if 'extra_authorize_parameters' in self._idp:\\n self._idp['extraAuthorizeParameters'] = self._idp.pop('extra_authorize_parameters')\\n\\n if 'extraAuthorizeParameters' in self._idp:\\n if 'include_granted_scopes' in self._idp['extraAuthorizeParameters']:\\n val = ansible_bool(self._idp['extraAuthorizeParameters'].pop('include_granted_scopes'))\\n self._idp['extraAuthorizeParameters']['include_granted_scopes'] = val\\n\\n\\n def validate(self):\\n ''' validate this idp instance '''\\n IdentityProviderOauthBase.validate(self)\\n if not isinstance(self.provider['claims'], dict):\\n raise errors.AnsibleFilterError(\\\"|failed claims for provider {0} \\\"\\n \\\"must be a dictionary\\\".format(self.__class__.__name__))\\n\\n for var, var_type in (('extraScopes', list), ('extraAuthorizeParameters', dict)):\\n if var in self.provider and not isinstance(self.provider[var], var_type):\\n raise errors.AnsibleFilterError(\\\"|failed {1} for provider \\\"\\n \\\"{0} must be a {2}\\\".format(self.__class__.__name__,\\n var,\\n var_type.__class__.__name__))\\n\\n required_claims = ['id']\\n optional_claims = ['email', 'name', 'preferredUsername']\\n all_claims = required_claims + optional_claims\\n\\n for claim in required_claims:\\n if claim in required_claims and claim not in self.provider['claims']:\\n raise errors.AnsibleFilterError(\\\"|failed {0} claim missing \\\"\\n \\\"for provider {1}\\\".format(claim, self.__class__.__name__))\\n\\n for claim in all_claims:\\n if claim in self.provider['claims'] and not isinstance(self.provider['claims'][claim], list):\\n raise errors.AnsibleFilterError(\\\"|failed {0} claims for \\\"\\n \\\"provider {1} must be a list\\\".format(claim, self.__class__.__name__))\\n\\n unknown_claims = set(self.provider['claims'].keys()) - set(all_claims)\\n if len(unknown_claims) > 0:\\n raise errors.AnsibleFilterError(\\\"|failed provider {0} has unknown \\\"\\n \\\"claims: {1}\\\".format(self.__class__.__name__, ', '.join(unknown_claims)))\\n\\n if not isinstance(self.provider['urls'], dict):\\n raise errors.AnsibleFilterError(\\\"|failed urls for provider {0} \\\"\\n \\\"must be a dictionary\\\".format(self.__class__.__name__))\\n\\n required_urls = ['authorize', 'token']\\n optional_urls = ['userInfo']\\n all_urls = required_urls + optional_urls\\n\\n for url in required_urls:\\n if url not in self.provider['urls']:\\n raise errors.AnsibleFilterError(\\\"|failed {0} url missing for \\\"\\n \\\"provider {1}\\\".format(url, self.__class__.__name__))\\n\\n unknown_urls = set(self.provider['urls'].keys()) - set(all_urls)\\n if len(unknown_urls) > 0:\\n raise errors.AnsibleFilterError(\\\"|failed provider {0} has unknown \\\"\\n \\\"urls: {1}\\\".format(self.__class__.__name__, ', '.join(unknown_urls)))\\n\\n\\nclass GoogleIdentityProvider(IdentityProviderOauthBase):\\n \\\"\\\"\\\" GoogleIdentityProvider\\n\\n Attributes:\\n\\n Args:\\n api_version(str): OpenShift config version\\n idp (dict): idp config dict\\n\\n Raises:\\n AnsibleFilterError:\\n \\\"\\\"\\\"\\n def __init__(self, api_version, idp):\\n IdentityProviderOauthBase.__init__(self, api_version, idp)\\n self._optional += [['hostedDomain', 'hosted_domain']]\\n\\n\\nclass GitHubIdentityProvider(IdentityProviderOauthBase):\\n \\\"\\\"\\\" GitHubIdentityProvider\\n\\n Attributes:\\n\\n Args:\\n api_version(str): OpenShift config version\\n idp (dict): idp config dict\\n\\n Raises:\\n AnsibleFilterError:\\n \\\"\\\"\\\"\\n def __init__(self, api_version, idp):\\n IdentityProviderOauthBase.__init__(self, api_version, idp)\\n self._optional += [['organizations']]\\n\\n\\nclass FilterModule(object):\\n ''' Custom ansible filters for use by the openshift_master role'''\\n\\n @staticmethod\\n def translate_idps(idps, api_version, openshift_version, deployment_type):\\n ''' Translates a list of dictionaries into a valid identityProviders config '''\\n idp_list = []\\n\\n if not isinstance(idps, list):\\n raise errors.AnsibleFilterError(\\\"|failed expects to filter on a list of identity providers\\\")\\n for idp in idps:\\n if not isinstance(idp, dict):\\n raise errors.AnsibleFilterError(\\\"|failed identity providers must be a list of dictionaries\\\")\\n\\n cur_module = sys.modules[__name__]\\n idp_class = getattr(cur_module, idp['kind'], None)\\n idp_inst = idp_class(api_version, idp) if idp_class is not None else IdentityProviderBase(api_version, idp)\\n idp_inst.set_provider_items()\\n idp_list.append(idp_inst)\\n\\n\\n IdentityProviderBase.validate_idp_list(idp_list, openshift_version, deployment_type)\\n return yaml.safe_dump([idp.to_dict() for idp in idp_list], default_flow_style=False)\\n\\n @staticmethod\\n def validate_pcs_cluster(data, masters=None):\\n ''' Validates output from \\\"pcs status\\\", ensuring that each master\\n provided is online.\\n Ex: data = ('...',\\n 'PCSD Status:',\\n 'master1.example.com: Online',\\n 'master2.example.com: Online',\\n 'master3.example.com: Online',\\n '...')\\n masters = ['master1.example.com',\\n 'master2.example.com',\\n 'master3.example.com']\\n returns True\\n '''\\n if not issubclass(type(data), basestring):\\n raise errors.AnsibleFilterError(\\\"|failed expects data is a string or unicode\\\")\\n if not issubclass(type(masters), list):\\n raise errors.AnsibleFilterError(\\\"|failed expects masters is a list\\\")\\n valid = True\\n for master in masters:\\n if \\\"{0}: Online\\\".format(master) not in data:\\n valid = False\\n return valid\\n\\n @staticmethod\\n def certificates_to_synchronize(hostvars, include_keys=True):\\n ''' Return certificates to synchronize based on facts. '''\\n if not issubclass(type(hostvars), dict):\\n raise errors.AnsibleFilterError(\\\"|failed expects hostvars is a dict\\\")\\n certs = ['admin.crt',\\n 'admin.key',\\n 'admin.kubeconfig',\\n 'master.kubelet-client.crt',\\n 'master.kubelet-client.key',\\n 'openshift-registry.crt',\\n 'openshift-registry.key',\\n 'openshift-registry.kubeconfig',\\n 'openshift-router.crt',\\n 'openshift-router.key',\\n 'openshift-router.kubeconfig']\\n if bool(include_keys):\\n certs += ['serviceaccounts.private.key',\\n 'serviceaccounts.public.key']\\n if bool(hostvars['openshift']['common']['version_gte_3_1_or_1_1']):\\n certs += ['master.proxy-client.crt',\\n 'master.proxy-client.key']\\n if not bool(hostvars['openshift']['common']['version_gte_3_2_or_1_2']):\\n certs += ['openshift-master.crt',\\n 'openshift-master.key',\\n 'openshift-master.kubeconfig']\\n return certs\\n\\n @staticmethod\\n def oo_htpasswd_users_from_file(file_contents):\\n ''' return a dictionary of htpasswd users from htpasswd file contents '''\\n htpasswd_entries = {}\\n if not isinstance(file_contents, basestring):\\n raise errors.AnsibleFilterError(\\\"failed, expects to filter on a string\\\")\\n for line in file_contents.splitlines():\\n user = None\\n passwd = None\\n if len(line) == 0:\\n continue\\n if ':' in line:\\n user, passwd = line.split(':', 1)\\n\\n if user is None or len(user) == 0 or passwd is None or len(passwd) == 0:\\n error_msg = \\\"failed, expects each line to be a colon separated string representing the user and passwd\\\"\\n raise errors.AnsibleFilterError(error_msg)\\n htpasswd_entries[user] = passwd\\n return htpasswd_entries\\n\\n\\n def filters(self):\\n ''' returns a mapping of filters to methods '''\\n return {\\\"translate_idps\\\": self.translate_idps,\\n \\\"validate_pcs_cluster\\\": self.validate_pcs_cluster,\\n \\\"certificates_to_synchronize\\\": self.certificates_to_synchronize,\\n \\\"oo_htpasswd_users_from_file\\\": self.oo_htpasswd_users_from_file}\\n\",\n \"path\": \"filter_plugins/openshift_master.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"#!/usr/bin/python\n# -*- coding: utf-8 -*-\n# vim: expandtab:tabstop=4:shiftwidth=4\n'''\nCustom filters for use in openshift-master\n'''\nimport copy\nimport sys\nimport yaml\n\nfrom ansible import errors\nfrom distutils.version import LooseVersion\n\n# pylint: disable=no-name-in-module,import-error\ntry:\n # ansible-2.1\n from ansible.plugins.filter.core import to_bool as ansible_bool\nexcept ImportError:\n try:\n #ansible-2.0.x\n from ansible.runner.filter_plugins.core import bool as ansible_bool\n except ImportError:\n # ansible-1.9.x\n from ansible.plugins.filter.core import bool as ansible_bool\n\nclass IdentityProviderBase(object):\n \"\"\" IdentityProviderBase\n\n Attributes:\n name (str): Identity provider Name\n login (bool): Is this identity provider a login provider?\n challenge (bool): Is this identity provider a challenge provider?\n provider (dict): Provider specific config\n _idp (dict): internal copy of the IDP dict passed in\n _required (list): List of lists of strings for required attributes\n _optional (list): List of lists of strings for optional attributes\n _allow_additional (bool): Does this provider support attributes\n not in _required and _optional\n\n Args:\n api_version(str): OpenShift config version\n idp (dict): idp config dict\n\n Raises:\n AnsibleFilterError:\n \"\"\"\n # disabling this check since the number of instance attributes are\n # necessary for this class\n # pylint: disable=too-many-instance-attributes\n def __init__(self, api_version, idp):\n if api_version not in ['v1']:\n raise errors.AnsibleFilterError(\"|failed api version {0} unknown\".format(api_version))\n\n self._idp = copy.deepcopy(idp)\n\n if 'name' not in self._idp:\n raise errors.AnsibleFilterError(\"|failed identity provider missing a name\")\n\n if 'kind' not in self._idp:\n raise errors.AnsibleFilterError(\"|failed identity provider missing a kind\")\n\n self.name = self._idp.pop('name')\n self.login = ansible_bool(self._idp.pop('login', False))\n self.challenge = ansible_bool(self._idp.pop('challenge', False))\n self.provider = dict(apiVersion=api_version, kind=self._idp.pop('kind'))\n\n mm_keys = ('mappingMethod', 'mapping_method')\n mapping_method = None\n for key in mm_keys:\n if key in self._idp:\n mapping_method = self._idp.pop(key)\n if mapping_method is None:\n mapping_method = self.get_default('mappingMethod')\n self.mapping_method = mapping_method\n\n valid_mapping_methods = ['add', 'claim', 'generate', 'lookup']\n if self.mapping_method not in valid_mapping_methods:\n raise errors.AnsibleFilterError(\"|failed unkown mapping method \"\n \"for provider {0}\".format(self.__class__.__name__))\n self._required = []\n self._optional = []\n self._allow_additional = True\n\n @staticmethod\n def validate_idp_list(idp_list, openshift_version, deployment_type):\n ''' validates a list of idps '''\n login_providers = [x.name for x in idp_list if x.login]\n\n multiple_logins_unsupported = False\n if len(login_providers) > 1:\n if deployment_type in ['enterprise', 'online', 'atomic-enterprise', 'openshift-enterprise']:\n if LooseVersion(openshift_version) < LooseVersion('3.2'):\n multiple_logins_unsupported = True\n if deployment_type in ['origin']:\n if LooseVersion(openshift_version) < LooseVersion('1.2'):\n multiple_logins_unsupported = True\n if multiple_logins_unsupported:\n raise errors.AnsibleFilterError(\"|failed multiple providers are \"\n \"not allowed for login. login \"\n \"providers: {0}\".format(', '.join(login_providers)))\n\n names = [x.name for x in idp_list]\n if len(set(names)) != len(names):\n raise errors.AnsibleFilterError(\"|failed more than one provider configured with the same name\")\n\n for idp in idp_list:\n idp.validate()\n\n def validate(self):\n ''' validate an instance of this idp class '''\n pass\n\n @staticmethod\n def get_default(key):\n ''' get a default value for a given key '''\n if key == 'mappingMethod':\n return 'claim'\n else:\n return None\n\n def set_provider_item(self, items, required=False):\n ''' set a provider item based on the list of item names provided. '''\n for item in items:\n provider_key = items[0]\n if item in self._idp:\n self.provider[provider_key] = self._idp.pop(item)\n break\n else:\n default = self.get_default(provider_key)\n if default is not None:\n self.provider[provider_key] = default\n elif required:\n raise errors.AnsibleFilterError(\"|failed provider {0} missing \"\n \"required key {1}\".format(self.__class__.__name__, provider_key))\n\n def set_provider_items(self):\n ''' set the provider items for this idp '''\n for items in self._required:\n self.set_provider_item(items, True)\n for items in self._optional:\n self.set_provider_item(items)\n if self._allow_additional:\n for key in self._idp.keys():\n self.set_provider_item([key])\n else:\n if len(self._idp) > 0:\n raise errors.AnsibleFilterError(\"|failed provider {0} \"\n \"contains unknown keys \"\n \"{1}\".format(self.__class__.__name__, ', '.join(self._idp.keys())))\n\n def to_dict(self):\n ''' translate this idp to a dictionary '''\n return dict(name=self.name, challenge=self.challenge,\n login=self.login, mappingMethod=self.mapping_method,\n provider=self.provider)\n\n\nclass LDAPPasswordIdentityProvider(IdentityProviderBase):\n \"\"\" LDAPPasswordIdentityProvider\n\n Attributes:\n\n Args:\n api_version(str): OpenShift config version\n idp (dict): idp config dict\n\n Raises:\n AnsibleFilterError:\n \"\"\"\n def __init__(self, api_version, idp):\n IdentityProviderBase.__init__(self, api_version, idp)\n self._allow_additional = False\n self._required += [['attributes'], ['url'], ['insecure']]\n self._optional += [['ca'],\n ['bindDN', 'bind_dn'],\n ['bindPassword', 'bind_password']]\n\n self._idp['insecure'] = ansible_bool(self._idp.pop('insecure', False))\n\n if 'attributes' in self._idp and 'preferred_username' in self._idp['attributes']:\n pref_user = self._idp['attributes'].pop('preferred_username')\n self._idp['attributes']['preferredUsername'] = pref_user\n\n def validate(self):\n ''' validate this idp instance '''\n IdentityProviderBase.validate(self)\n if not isinstance(self.provider['attributes'], dict):\n raise errors.AnsibleFilterError(\"|failed attributes for provider \"\n \"{0} must be a dictionary\".format(self.__class__.__name__))\n\n attrs = ['id', 'email', 'name', 'preferredUsername']\n for attr in attrs:\n if attr in self.provider['attributes'] and not isinstance(self.provider['attributes'][attr], list):\n raise errors.AnsibleFilterError(\"|failed {0} attribute for \"\n \"provider {1} must be a list\".format(attr, self.__class__.__name__))\n\n unknown_attrs = set(self.provider['attributes'].keys()) - set(attrs)\n if len(unknown_attrs) > 0:\n raise errors.AnsibleFilterError(\"|failed provider {0} has unknown \"\n \"attributes: {1}\".format(self.__class__.__name__, ', '.join(unknown_attrs)))\n\n\nclass KeystonePasswordIdentityProvider(IdentityProviderBase):\n \"\"\" KeystoneIdentityProvider\n\n Attributes:\n\n Args:\n api_version(str): OpenShift config version\n idp (dict): idp config dict\n\n Raises:\n AnsibleFilterError:\n \"\"\"\n def __init__(self, api_version, idp):\n IdentityProviderBase.__init__(self, api_version, idp)\n self._allow_additional = False\n self._required += [['url'], ['domainName', 'domain_name']]\n self._optional += [['ca'], ['certFile', 'cert_file'], ['keyFile', 'key_file']]\n\n\nclass RequestHeaderIdentityProvider(IdentityProviderBase):\n \"\"\" RequestHeaderIdentityProvider\n\n Attributes:\n\n Args:\n api_version(str): OpenShift config version\n idp (dict): idp config dict\n\n Raises:\n AnsibleFilterError:\n \"\"\"\n def __init__(self, api_version, idp):\n IdentityProviderBase.__init__(self, api_version, idp)\n self._allow_additional = False\n self._required += [['headers']]\n self._optional += [['challengeURL', 'challenge_url'],\n ['loginURL', 'login_url'],\n ['clientCA', 'client_ca'],\n ['clientCommonNames', 'client_common_names'],\n ['emailHeaders', 'email_headers'],\n ['nameHeaders', 'name_headers'],\n ['preferredUsernameHeaders', 'preferred_username_headers']]\n\n def validate(self):\n ''' validate this idp instance '''\n IdentityProviderBase.validate(self)\n if not isinstance(self.provider['headers'], list):\n raise errors.AnsibleFilterError(\"|failed headers for provider {0} \"\n \"must be a list\".format(self.__class__.__name__))\n\n\nclass AllowAllPasswordIdentityProvider(IdentityProviderBase):\n \"\"\" AllowAllPasswordIdentityProvider\n\n Attributes:\n\n Args:\n api_version(str): OpenShift config version\n idp (dict): idp config dict\n\n Raises:\n AnsibleFilterError:\n \"\"\"\n def __init__(self, api_version, idp):\n IdentityProviderBase.__init__(self, api_version, idp)\n self._allow_additional = False\n\n\nclass DenyAllPasswordIdentityProvider(IdentityProviderBase):\n \"\"\" DenyAllPasswordIdentityProvider\n\n Attributes:\n\n Args:\n api_version(str): OpenShift config version\n idp (dict): idp config dict\n\n Raises:\n AnsibleFilterError:\n \"\"\"\n def __init__(self, api_version, idp):\n IdentityProviderBase.__init__(self, api_version, idp)\n self._allow_additional = False\n\n\nclass HTPasswdPasswordIdentityProvider(IdentityProviderBase):\n \"\"\" HTPasswdPasswordIdentity\n\n Attributes:\n\n Args:\n api_version(str): OpenShift config version\n idp (dict): idp config dict\n\n Raises:\n AnsibleFilterError:\n \"\"\"\n def __init__(self, api_version, idp):\n IdentityProviderBase.__init__(self, api_version, idp)\n self._allow_additional = False\n self._required += [['file', 'filename', 'fileName', 'file_name']]\n\n @staticmethod\n def get_default(key):\n if key == 'file':\n return '/etc/origin/htpasswd'\n else:\n return IdentityProviderBase.get_default(key)\n\n\nclass BasicAuthPasswordIdentityProvider(IdentityProviderBase):\n \"\"\" BasicAuthPasswordIdentityProvider\n\n Attributes:\n\n Args:\n api_version(str): OpenShift config version\n idp (dict): idp config dict\n\n Raises:\n AnsibleFilterError:\n \"\"\"\n def __init__(self, api_version, idp):\n IdentityProviderBase.__init__(self, api_version, idp)\n self._allow_additional = False\n self._required += [['url']]\n self._optional += [['ca'], ['certFile', 'cert_file'], ['keyFile', 'key_file']]\n\n\nclass IdentityProviderOauthBase(IdentityProviderBase):\n \"\"\" IdentityProviderOauthBase\n\n Attributes:\n\n Args:\n api_version(str): OpenShift config version\n idp (dict): idp config dict\n\n Raises:\n AnsibleFilterError:\n \"\"\"\n def __init__(self, api_version, idp):\n IdentityProviderBase.__init__(self, api_version, idp)\n self._allow_additional = False\n self._required += [['clientID', 'client_id'], ['clientSecret', 'client_secret']]\n\n def validate(self):\n ''' validate this idp instance '''\n IdentityProviderBase.validate(self)\n if self.challenge:\n raise errors.AnsibleFilterError(\"|failed provider {0} does not \"\n \"allow challenge authentication\".format(self.__class__.__name__))\n\n\nclass OpenIDIdentityProvider(IdentityProviderOauthBase):\n \"\"\" OpenIDIdentityProvider\n\n Attributes:\n\n Args:\n api_version(str): OpenShift config version\n idp (dict): idp config dict\n\n Raises:\n AnsibleFilterError:\n \"\"\"\n def __init__(self, api_version, idp):\n IdentityProviderOauthBase.__init__(self, api_version, idp)\n self._required += [['claims'], ['urls']]\n self._optional += [['ca'],\n ['extraScopes'],\n ['extraAuthorizeParameters']]\n if 'claims' in self._idp and 'preferred_username' in self._idp['claims']:\n pref_user = self._idp['claims'].pop('preferred_username')\n self._idp['claims']['preferredUsername'] = pref_user\n if 'urls' in self._idp and 'user_info' in self._idp['urls']:\n user_info = self._idp['urls'].pop('user_info')\n self._idp['urls']['userInfo'] = user_info\n if 'extra_scopes' in self._idp:\n self._idp['extraScopes'] = self._idp.pop('extra_scopes')\n if 'extra_authorize_parameters' in self._idp:\n self._idp['extraAuthorizeParameters'] = self._idp.pop('extra_authorize_parameters')\n\n if 'extraAuthorizeParameters' in self._idp:\n if 'include_granted_scopes' in self._idp['extraAuthorizeParameters']:\n val = ansible_bool(self._idp['extraAuthorizeParameters'].pop('include_granted_scopes'))\n self._idp['extraAuthorizeParameters']['include_granted_scopes'] = val\n\n\n def validate(self):\n ''' validate this idp instance '''\n IdentityProviderOauthBase.validate(self)\n if not isinstance(self.provider['claims'], dict):\n raise errors.AnsibleFilterError(\"|failed claims for provider {0} \"\n \"must be a dictionary\".format(self.__class__.__name__))\n\n for var, var_type in (('extraScopes', list), ('extraAuthorizeParameters', dict)):\n if var in self.provider and not isinstance(self.provider[var], var_type):\n raise errors.AnsibleFilterError(\"|failed {1} for provider \"\n \"{0} must be a {2}\".format(self.__class__.__name__,\n var,\n var_type.__class__.__name__))\n\n required_claims = ['id']\n optional_claims = ['email', 'name', 'preferredUsername']\n all_claims = required_claims + optional_claims\n\n for claim in required_claims:\n if claim in required_claims and claim not in self.provider['claims']:\n raise errors.AnsibleFilterError(\"|failed {0} claim missing \"\n \"for provider {1}\".format(claim, self.__class__.__name__))\n\n for claim in all_claims:\n if claim in self.provider['claims'] and not isinstance(self.provider['claims'][claim], list):\n raise errors.AnsibleFilterError(\"|failed {0} claims for \"\n \"provider {1} must be a list\".format(claim, self.__class__.__name__))\n\n unknown_claims = set(self.provider['claims'].keys()) - set(all_claims)\n if len(unknown_claims) > 0:\n raise errors.AnsibleFilterError(\"|failed provider {0} has unknown \"\n \"claims: {1}\".format(self.__class__.__name__, ', '.join(unknown_claims)))\n\n if not isinstance(self.provider['urls'], dict):\n raise errors.AnsibleFilterError(\"|failed urls for provider {0} \"\n \"must be a dictionary\".format(self.__class__.__name__))\n\n required_urls = ['authorize', 'token']\n optional_urls = ['userInfo']\n all_urls = required_urls + optional_urls\n\n for url in required_urls:\n if url not in self.provider['urls']:\n raise errors.AnsibleFilterError(\"|failed {0} url missing for \"\n \"provider {1}\".format(url, self.__class__.__name__))\n\n unknown_urls = set(self.provider['urls'].keys()) - set(all_urls)\n if len(unknown_urls) > 0:\n raise errors.AnsibleFilterError(\"|failed provider {0} has unknown \"\n \"urls: {1}\".format(self.__class__.__name__, ', '.join(unknown_urls)))\n\n\nclass GoogleIdentityProvider(IdentityProviderOauthBase):\n \"\"\" GoogleIdentityProvider\n\n Attributes:\n\n Args:\n api_version(str): OpenShift config version\n idp (dict): idp config dict\n\n Raises:\n AnsibleFilterError:\n \"\"\"\n def __init__(self, api_version, idp):\n IdentityProviderOauthBase.__init__(self, api_version, idp)\n self._optional += [['hostedDomain', 'hosted_domain']]\n\n\nclass GitHubIdentityProvider(IdentityProviderOauthBase):\n \"\"\" GitHubIdentityProvider\n\n Attributes:\n\n Args:\n api_version(str): OpenShift config version\n idp (dict): idp config dict\n\n Raises:\n AnsibleFilterError:\n \"\"\"\n def __init__(self, api_version, idp):\n IdentityProviderOauthBase.__init__(self, api_version, idp)\n self._optional += [['organizations']]\n\n\nclass FilterModule(object):\n ''' Custom ansible filters for use by the openshift_master role'''\n\n @staticmethod\n def translate_idps(idps, api_version, openshift_version, deployment_type):\n ''' Translates a list of dictionaries into a valid identityProviders config '''\n idp_list = []\n\n if not isinstance(idps, list):\n raise errors.AnsibleFilterError(\"|failed expects to filter on a list of identity providers\")\n for idp in idps:\n if not isinstance(idp, dict):\n raise errors.AnsibleFilterError(\"|failed identity providers must be a list of dictionaries\")\n\n cur_module = sys.modules[__name__]\n idp_class = getattr(cur_module, idp['kind'], None)\n idp_inst = idp_class(api_version, idp) if idp_class is not None else IdentityProviderBase(api_version, idp)\n idp_inst.set_provider_items()\n idp_list.append(idp_inst)\n\n\n IdentityProviderBase.validate_idp_list(idp_list, openshift_version, deployment_type)\n return yaml.safe_dump([idp.to_dict() for idp in idp_list], default_flow_style=False)\n\n @staticmethod\n def validate_pcs_cluster(data, masters=None):\n ''' Validates output from \"pcs status\", ensuring that each master\n provided is online.\n Ex: data = ('...',\n 'PCSD Status:',\n 'master1.example.com: Online',\n 'master2.example.com: Online',\n 'master3.example.com: Online',\n '...')\n masters = ['master1.example.com',\n 'master2.example.com',\n 'master3.example.com']\n returns True\n '''\n if not issubclass(type(data), basestring):\n raise errors.AnsibleFilterError(\"|failed expects data is a string or unicode\")\n if not issubclass(type(masters), list):\n raise errors.AnsibleFilterError(\"|failed expects masters is a list\")\n valid = True\n for master in masters:\n if \"{0}: Online\".format(master) not in data:\n valid = False\n return valid\n\n @staticmethod\n def certificates_to_synchronize(hostvars, include_keys=True):\n ''' Return certificates to synchronize based on facts. '''\n if not issubclass(type(hostvars), dict):\n raise errors.AnsibleFilterError(\"|failed expects hostvars is a dict\")\n certs = ['admin.crt',\n 'admin.key',\n 'admin.kubeconfig',\n 'master.kubelet-client.crt',\n 'master.kubelet-client.key',\n 'openshift-registry.crt',\n 'openshift-registry.key',\n 'openshift-registry.kubeconfig',\n 'openshift-router.crt',\n 'openshift-router.key',\n 'openshift-router.kubeconfig']\n if bool(include_keys):\n certs += ['serviceaccounts.private.key',\n 'serviceaccounts.public.key']\n if bool(hostvars['openshift']['common']['version_gte_3_1_or_1_1']):\n certs += ['master.proxy-client.crt',\n 'master.proxy-client.key']\n if not bool(hostvars['openshift']['common']['version_gte_3_2_or_1_2']):\n certs += ['openshift-master.crt',\n 'openshift-master.key',\n 'openshift-master.kubeconfig']\n if bool(hostvars['openshift']['common']['version_gte_3_3_or_1_3']):\n certs += ['service-signer.crt',\n 'service-signer.key']\n return certs\n\n @staticmethod\n def oo_htpasswd_users_from_file(file_contents):\n ''' return a dictionary of htpasswd users from htpasswd file contents '''\n htpasswd_entries = {}\n if not isinstance(file_contents, basestring):\n raise errors.AnsibleFilterError(\"failed, expects to filter on a string\")\n for line in file_contents.splitlines():\n user = None\n passwd = None\n if len(line) == 0:\n continue\n if ':' in line:\n user, passwd = line.split(':', 1)\n\n if user is None or len(user) == 0 or passwd is None or len(passwd) == 0:\n error_msg = \"failed, expects each line to be a colon separated string representing the user and passwd\"\n raise errors.AnsibleFilterError(error_msg)\n htpasswd_entries[user] = passwd\n return htpasswd_entries\n\n\n def filters(self):\n ''' returns a mapping of filters to methods '''\n return {\"translate_idps\": self.translate_idps,\n \"validate_pcs_cluster\": self.validate_pcs_cluster,\n \"certificates_to_synchronize\": self.certificates_to_synchronize,\n \"oo_htpasswd_users_from_file\": self.oo_htpasswd_users_from_file}\n","path":"filter_plugins/openshift_master.py"}],"string":"[\n {\n \"content\": \"#!/usr/bin/python\\n# -*- coding: utf-8 -*-\\n# vim: expandtab:tabstop=4:shiftwidth=4\\n'''\\nCustom filters for use in openshift-master\\n'''\\nimport copy\\nimport sys\\nimport yaml\\n\\nfrom ansible import errors\\nfrom distutils.version import LooseVersion\\n\\n# pylint: disable=no-name-in-module,import-error\\ntry:\\n # ansible-2.1\\n from ansible.plugins.filter.core import to_bool as ansible_bool\\nexcept ImportError:\\n try:\\n #ansible-2.0.x\\n from ansible.runner.filter_plugins.core import bool as ansible_bool\\n except ImportError:\\n # ansible-1.9.x\\n from ansible.plugins.filter.core import bool as ansible_bool\\n\\nclass IdentityProviderBase(object):\\n \\\"\\\"\\\" IdentityProviderBase\\n\\n Attributes:\\n name (str): Identity provider Name\\n login (bool): Is this identity provider a login provider?\\n challenge (bool): Is this identity provider a challenge provider?\\n provider (dict): Provider specific config\\n _idp (dict): internal copy of the IDP dict passed in\\n _required (list): List of lists of strings for required attributes\\n _optional (list): List of lists of strings for optional attributes\\n _allow_additional (bool): Does this provider support attributes\\n not in _required and _optional\\n\\n Args:\\n api_version(str): OpenShift config version\\n idp (dict): idp config dict\\n\\n Raises:\\n AnsibleFilterError:\\n \\\"\\\"\\\"\\n # disabling this check since the number of instance attributes are\\n # necessary for this class\\n # pylint: disable=too-many-instance-attributes\\n def __init__(self, api_version, idp):\\n if api_version not in ['v1']:\\n raise errors.AnsibleFilterError(\\\"|failed api version {0} unknown\\\".format(api_version))\\n\\n self._idp = copy.deepcopy(idp)\\n\\n if 'name' not in self._idp:\\n raise errors.AnsibleFilterError(\\\"|failed identity provider missing a name\\\")\\n\\n if 'kind' not in self._idp:\\n raise errors.AnsibleFilterError(\\\"|failed identity provider missing a kind\\\")\\n\\n self.name = self._idp.pop('name')\\n self.login = ansible_bool(self._idp.pop('login', False))\\n self.challenge = ansible_bool(self._idp.pop('challenge', False))\\n self.provider = dict(apiVersion=api_version, kind=self._idp.pop('kind'))\\n\\n mm_keys = ('mappingMethod', 'mapping_method')\\n mapping_method = None\\n for key in mm_keys:\\n if key in self._idp:\\n mapping_method = self._idp.pop(key)\\n if mapping_method is None:\\n mapping_method = self.get_default('mappingMethod')\\n self.mapping_method = mapping_method\\n\\n valid_mapping_methods = ['add', 'claim', 'generate', 'lookup']\\n if self.mapping_method not in valid_mapping_methods:\\n raise errors.AnsibleFilterError(\\\"|failed unkown mapping method \\\"\\n \\\"for provider {0}\\\".format(self.__class__.__name__))\\n self._required = []\\n self._optional = []\\n self._allow_additional = True\\n\\n @staticmethod\\n def validate_idp_list(idp_list, openshift_version, deployment_type):\\n ''' validates a list of idps '''\\n login_providers = [x.name for x in idp_list if x.login]\\n\\n multiple_logins_unsupported = False\\n if len(login_providers) > 1:\\n if deployment_type in ['enterprise', 'online', 'atomic-enterprise', 'openshift-enterprise']:\\n if LooseVersion(openshift_version) < LooseVersion('3.2'):\\n multiple_logins_unsupported = True\\n if deployment_type in ['origin']:\\n if LooseVersion(openshift_version) < LooseVersion('1.2'):\\n multiple_logins_unsupported = True\\n if multiple_logins_unsupported:\\n raise errors.AnsibleFilterError(\\\"|failed multiple providers are \\\"\\n \\\"not allowed for login. login \\\"\\n \\\"providers: {0}\\\".format(', '.join(login_providers)))\\n\\n names = [x.name for x in idp_list]\\n if len(set(names)) != len(names):\\n raise errors.AnsibleFilterError(\\\"|failed more than one provider configured with the same name\\\")\\n\\n for idp in idp_list:\\n idp.validate()\\n\\n def validate(self):\\n ''' validate an instance of this idp class '''\\n pass\\n\\n @staticmethod\\n def get_default(key):\\n ''' get a default value for a given key '''\\n if key == 'mappingMethod':\\n return 'claim'\\n else:\\n return None\\n\\n def set_provider_item(self, items, required=False):\\n ''' set a provider item based on the list of item names provided. '''\\n for item in items:\\n provider_key = items[0]\\n if item in self._idp:\\n self.provider[provider_key] = self._idp.pop(item)\\n break\\n else:\\n default = self.get_default(provider_key)\\n if default is not None:\\n self.provider[provider_key] = default\\n elif required:\\n raise errors.AnsibleFilterError(\\\"|failed provider {0} missing \\\"\\n \\\"required key {1}\\\".format(self.__class__.__name__, provider_key))\\n\\n def set_provider_items(self):\\n ''' set the provider items for this idp '''\\n for items in self._required:\\n self.set_provider_item(items, True)\\n for items in self._optional:\\n self.set_provider_item(items)\\n if self._allow_additional:\\n for key in self._idp.keys():\\n self.set_provider_item([key])\\n else:\\n if len(self._idp) > 0:\\n raise errors.AnsibleFilterError(\\\"|failed provider {0} \\\"\\n \\\"contains unknown keys \\\"\\n \\\"{1}\\\".format(self.__class__.__name__, ', '.join(self._idp.keys())))\\n\\n def to_dict(self):\\n ''' translate this idp to a dictionary '''\\n return dict(name=self.name, challenge=self.challenge,\\n login=self.login, mappingMethod=self.mapping_method,\\n provider=self.provider)\\n\\n\\nclass LDAPPasswordIdentityProvider(IdentityProviderBase):\\n \\\"\\\"\\\" LDAPPasswordIdentityProvider\\n\\n Attributes:\\n\\n Args:\\n api_version(str): OpenShift config version\\n idp (dict): idp config dict\\n\\n Raises:\\n AnsibleFilterError:\\n \\\"\\\"\\\"\\n def __init__(self, api_version, idp):\\n IdentityProviderBase.__init__(self, api_version, idp)\\n self._allow_additional = False\\n self._required += [['attributes'], ['url'], ['insecure']]\\n self._optional += [['ca'],\\n ['bindDN', 'bind_dn'],\\n ['bindPassword', 'bind_password']]\\n\\n self._idp['insecure'] = ansible_bool(self._idp.pop('insecure', False))\\n\\n if 'attributes' in self._idp and 'preferred_username' in self._idp['attributes']:\\n pref_user = self._idp['attributes'].pop('preferred_username')\\n self._idp['attributes']['preferredUsername'] = pref_user\\n\\n def validate(self):\\n ''' validate this idp instance '''\\n IdentityProviderBase.validate(self)\\n if not isinstance(self.provider['attributes'], dict):\\n raise errors.AnsibleFilterError(\\\"|failed attributes for provider \\\"\\n \\\"{0} must be a dictionary\\\".format(self.__class__.__name__))\\n\\n attrs = ['id', 'email', 'name', 'preferredUsername']\\n for attr in attrs:\\n if attr in self.provider['attributes'] and not isinstance(self.provider['attributes'][attr], list):\\n raise errors.AnsibleFilterError(\\\"|failed {0} attribute for \\\"\\n \\\"provider {1} must be a list\\\".format(attr, self.__class__.__name__))\\n\\n unknown_attrs = set(self.provider['attributes'].keys()) - set(attrs)\\n if len(unknown_attrs) > 0:\\n raise errors.AnsibleFilterError(\\\"|failed provider {0} has unknown \\\"\\n \\\"attributes: {1}\\\".format(self.__class__.__name__, ', '.join(unknown_attrs)))\\n\\n\\nclass KeystonePasswordIdentityProvider(IdentityProviderBase):\\n \\\"\\\"\\\" KeystoneIdentityProvider\\n\\n Attributes:\\n\\n Args:\\n api_version(str): OpenShift config version\\n idp (dict): idp config dict\\n\\n Raises:\\n AnsibleFilterError:\\n \\\"\\\"\\\"\\n def __init__(self, api_version, idp):\\n IdentityProviderBase.__init__(self, api_version, idp)\\n self._allow_additional = False\\n self._required += [['url'], ['domainName', 'domain_name']]\\n self._optional += [['ca'], ['certFile', 'cert_file'], ['keyFile', 'key_file']]\\n\\n\\nclass RequestHeaderIdentityProvider(IdentityProviderBase):\\n \\\"\\\"\\\" RequestHeaderIdentityProvider\\n\\n Attributes:\\n\\n Args:\\n api_version(str): OpenShift config version\\n idp (dict): idp config dict\\n\\n Raises:\\n AnsibleFilterError:\\n \\\"\\\"\\\"\\n def __init__(self, api_version, idp):\\n IdentityProviderBase.__init__(self, api_version, idp)\\n self._allow_additional = False\\n self._required += [['headers']]\\n self._optional += [['challengeURL', 'challenge_url'],\\n ['loginURL', 'login_url'],\\n ['clientCA', 'client_ca'],\\n ['clientCommonNames', 'client_common_names'],\\n ['emailHeaders', 'email_headers'],\\n ['nameHeaders', 'name_headers'],\\n ['preferredUsernameHeaders', 'preferred_username_headers']]\\n\\n def validate(self):\\n ''' validate this idp instance '''\\n IdentityProviderBase.validate(self)\\n if not isinstance(self.provider['headers'], list):\\n raise errors.AnsibleFilterError(\\\"|failed headers for provider {0} \\\"\\n \\\"must be a list\\\".format(self.__class__.__name__))\\n\\n\\nclass AllowAllPasswordIdentityProvider(IdentityProviderBase):\\n \\\"\\\"\\\" AllowAllPasswordIdentityProvider\\n\\n Attributes:\\n\\n Args:\\n api_version(str): OpenShift config version\\n idp (dict): idp config dict\\n\\n Raises:\\n AnsibleFilterError:\\n \\\"\\\"\\\"\\n def __init__(self, api_version, idp):\\n IdentityProviderBase.__init__(self, api_version, idp)\\n self._allow_additional = False\\n\\n\\nclass DenyAllPasswordIdentityProvider(IdentityProviderBase):\\n \\\"\\\"\\\" DenyAllPasswordIdentityProvider\\n\\n Attributes:\\n\\n Args:\\n api_version(str): OpenShift config version\\n idp (dict): idp config dict\\n\\n Raises:\\n AnsibleFilterError:\\n \\\"\\\"\\\"\\n def __init__(self, api_version, idp):\\n IdentityProviderBase.__init__(self, api_version, idp)\\n self._allow_additional = False\\n\\n\\nclass HTPasswdPasswordIdentityProvider(IdentityProviderBase):\\n \\\"\\\"\\\" HTPasswdPasswordIdentity\\n\\n Attributes:\\n\\n Args:\\n api_version(str): OpenShift config version\\n idp (dict): idp config dict\\n\\n Raises:\\n AnsibleFilterError:\\n \\\"\\\"\\\"\\n def __init__(self, api_version, idp):\\n IdentityProviderBase.__init__(self, api_version, idp)\\n self._allow_additional = False\\n self._required += [['file', 'filename', 'fileName', 'file_name']]\\n\\n @staticmethod\\n def get_default(key):\\n if key == 'file':\\n return '/etc/origin/htpasswd'\\n else:\\n return IdentityProviderBase.get_default(key)\\n\\n\\nclass BasicAuthPasswordIdentityProvider(IdentityProviderBase):\\n \\\"\\\"\\\" BasicAuthPasswordIdentityProvider\\n\\n Attributes:\\n\\n Args:\\n api_version(str): OpenShift config version\\n idp (dict): idp config dict\\n\\n Raises:\\n AnsibleFilterError:\\n \\\"\\\"\\\"\\n def __init__(self, api_version, idp):\\n IdentityProviderBase.__init__(self, api_version, idp)\\n self._allow_additional = False\\n self._required += [['url']]\\n self._optional += [['ca'], ['certFile', 'cert_file'], ['keyFile', 'key_file']]\\n\\n\\nclass IdentityProviderOauthBase(IdentityProviderBase):\\n \\\"\\\"\\\" IdentityProviderOauthBase\\n\\n Attributes:\\n\\n Args:\\n api_version(str): OpenShift config version\\n idp (dict): idp config dict\\n\\n Raises:\\n AnsibleFilterError:\\n \\\"\\\"\\\"\\n def __init__(self, api_version, idp):\\n IdentityProviderBase.__init__(self, api_version, idp)\\n self._allow_additional = False\\n self._required += [['clientID', 'client_id'], ['clientSecret', 'client_secret']]\\n\\n def validate(self):\\n ''' validate this idp instance '''\\n IdentityProviderBase.validate(self)\\n if self.challenge:\\n raise errors.AnsibleFilterError(\\\"|failed provider {0} does not \\\"\\n \\\"allow challenge authentication\\\".format(self.__class__.__name__))\\n\\n\\nclass OpenIDIdentityProvider(IdentityProviderOauthBase):\\n \\\"\\\"\\\" OpenIDIdentityProvider\\n\\n Attributes:\\n\\n Args:\\n api_version(str): OpenShift config version\\n idp (dict): idp config dict\\n\\n Raises:\\n AnsibleFilterError:\\n \\\"\\\"\\\"\\n def __init__(self, api_version, idp):\\n IdentityProviderOauthBase.__init__(self, api_version, idp)\\n self._required += [['claims'], ['urls']]\\n self._optional += [['ca'],\\n ['extraScopes'],\\n ['extraAuthorizeParameters']]\\n if 'claims' in self._idp and 'preferred_username' in self._idp['claims']:\\n pref_user = self._idp['claims'].pop('preferred_username')\\n self._idp['claims']['preferredUsername'] = pref_user\\n if 'urls' in self._idp and 'user_info' in self._idp['urls']:\\n user_info = self._idp['urls'].pop('user_info')\\n self._idp['urls']['userInfo'] = user_info\\n if 'extra_scopes' in self._idp:\\n self._idp['extraScopes'] = self._idp.pop('extra_scopes')\\n if 'extra_authorize_parameters' in self._idp:\\n self._idp['extraAuthorizeParameters'] = self._idp.pop('extra_authorize_parameters')\\n\\n if 'extraAuthorizeParameters' in self._idp:\\n if 'include_granted_scopes' in self._idp['extraAuthorizeParameters']:\\n val = ansible_bool(self._idp['extraAuthorizeParameters'].pop('include_granted_scopes'))\\n self._idp['extraAuthorizeParameters']['include_granted_scopes'] = val\\n\\n\\n def validate(self):\\n ''' validate this idp instance '''\\n IdentityProviderOauthBase.validate(self)\\n if not isinstance(self.provider['claims'], dict):\\n raise errors.AnsibleFilterError(\\\"|failed claims for provider {0} \\\"\\n \\\"must be a dictionary\\\".format(self.__class__.__name__))\\n\\n for var, var_type in (('extraScopes', list), ('extraAuthorizeParameters', dict)):\\n if var in self.provider and not isinstance(self.provider[var], var_type):\\n raise errors.AnsibleFilterError(\\\"|failed {1} for provider \\\"\\n \\\"{0} must be a {2}\\\".format(self.__class__.__name__,\\n var,\\n var_type.__class__.__name__))\\n\\n required_claims = ['id']\\n optional_claims = ['email', 'name', 'preferredUsername']\\n all_claims = required_claims + optional_claims\\n\\n for claim in required_claims:\\n if claim in required_claims and claim not in self.provider['claims']:\\n raise errors.AnsibleFilterError(\\\"|failed {0} claim missing \\\"\\n \\\"for provider {1}\\\".format(claim, self.__class__.__name__))\\n\\n for claim in all_claims:\\n if claim in self.provider['claims'] and not isinstance(self.provider['claims'][claim], list):\\n raise errors.AnsibleFilterError(\\\"|failed {0} claims for \\\"\\n \\\"provider {1} must be a list\\\".format(claim, self.__class__.__name__))\\n\\n unknown_claims = set(self.provider['claims'].keys()) - set(all_claims)\\n if len(unknown_claims) > 0:\\n raise errors.AnsibleFilterError(\\\"|failed provider {0} has unknown \\\"\\n \\\"claims: {1}\\\".format(self.__class__.__name__, ', '.join(unknown_claims)))\\n\\n if not isinstance(self.provider['urls'], dict):\\n raise errors.AnsibleFilterError(\\\"|failed urls for provider {0} \\\"\\n \\\"must be a dictionary\\\".format(self.__class__.__name__))\\n\\n required_urls = ['authorize', 'token']\\n optional_urls = ['userInfo']\\n all_urls = required_urls + optional_urls\\n\\n for url in required_urls:\\n if url not in self.provider['urls']:\\n raise errors.AnsibleFilterError(\\\"|failed {0} url missing for \\\"\\n \\\"provider {1}\\\".format(url, self.__class__.__name__))\\n\\n unknown_urls = set(self.provider['urls'].keys()) - set(all_urls)\\n if len(unknown_urls) > 0:\\n raise errors.AnsibleFilterError(\\\"|failed provider {0} has unknown \\\"\\n \\\"urls: {1}\\\".format(self.__class__.__name__, ', '.join(unknown_urls)))\\n\\n\\nclass GoogleIdentityProvider(IdentityProviderOauthBase):\\n \\\"\\\"\\\" GoogleIdentityProvider\\n\\n Attributes:\\n\\n Args:\\n api_version(str): OpenShift config version\\n idp (dict): idp config dict\\n\\n Raises:\\n AnsibleFilterError:\\n \\\"\\\"\\\"\\n def __init__(self, api_version, idp):\\n IdentityProviderOauthBase.__init__(self, api_version, idp)\\n self._optional += [['hostedDomain', 'hosted_domain']]\\n\\n\\nclass GitHubIdentityProvider(IdentityProviderOauthBase):\\n \\\"\\\"\\\" GitHubIdentityProvider\\n\\n Attributes:\\n\\n Args:\\n api_version(str): OpenShift config version\\n idp (dict): idp config dict\\n\\n Raises:\\n AnsibleFilterError:\\n \\\"\\\"\\\"\\n def __init__(self, api_version, idp):\\n IdentityProviderOauthBase.__init__(self, api_version, idp)\\n self._optional += [['organizations']]\\n\\n\\nclass FilterModule(object):\\n ''' Custom ansible filters for use by the openshift_master role'''\\n\\n @staticmethod\\n def translate_idps(idps, api_version, openshift_version, deployment_type):\\n ''' Translates a list of dictionaries into a valid identityProviders config '''\\n idp_list = []\\n\\n if not isinstance(idps, list):\\n raise errors.AnsibleFilterError(\\\"|failed expects to filter on a list of identity providers\\\")\\n for idp in idps:\\n if not isinstance(idp, dict):\\n raise errors.AnsibleFilterError(\\\"|failed identity providers must be a list of dictionaries\\\")\\n\\n cur_module = sys.modules[__name__]\\n idp_class = getattr(cur_module, idp['kind'], None)\\n idp_inst = idp_class(api_version, idp) if idp_class is not None else IdentityProviderBase(api_version, idp)\\n idp_inst.set_provider_items()\\n idp_list.append(idp_inst)\\n\\n\\n IdentityProviderBase.validate_idp_list(idp_list, openshift_version, deployment_type)\\n return yaml.safe_dump([idp.to_dict() for idp in idp_list], default_flow_style=False)\\n\\n @staticmethod\\n def validate_pcs_cluster(data, masters=None):\\n ''' Validates output from \\\"pcs status\\\", ensuring that each master\\n provided is online.\\n Ex: data = ('...',\\n 'PCSD Status:',\\n 'master1.example.com: Online',\\n 'master2.example.com: Online',\\n 'master3.example.com: Online',\\n '...')\\n masters = ['master1.example.com',\\n 'master2.example.com',\\n 'master3.example.com']\\n returns True\\n '''\\n if not issubclass(type(data), basestring):\\n raise errors.AnsibleFilterError(\\\"|failed expects data is a string or unicode\\\")\\n if not issubclass(type(masters), list):\\n raise errors.AnsibleFilterError(\\\"|failed expects masters is a list\\\")\\n valid = True\\n for master in masters:\\n if \\\"{0}: Online\\\".format(master) not in data:\\n valid = False\\n return valid\\n\\n @staticmethod\\n def certificates_to_synchronize(hostvars, include_keys=True):\\n ''' Return certificates to synchronize based on facts. '''\\n if not issubclass(type(hostvars), dict):\\n raise errors.AnsibleFilterError(\\\"|failed expects hostvars is a dict\\\")\\n certs = ['admin.crt',\\n 'admin.key',\\n 'admin.kubeconfig',\\n 'master.kubelet-client.crt',\\n 'master.kubelet-client.key',\\n 'openshift-registry.crt',\\n 'openshift-registry.key',\\n 'openshift-registry.kubeconfig',\\n 'openshift-router.crt',\\n 'openshift-router.key',\\n 'openshift-router.kubeconfig']\\n if bool(include_keys):\\n certs += ['serviceaccounts.private.key',\\n 'serviceaccounts.public.key']\\n if bool(hostvars['openshift']['common']['version_gte_3_1_or_1_1']):\\n certs += ['master.proxy-client.crt',\\n 'master.proxy-client.key']\\n if not bool(hostvars['openshift']['common']['version_gte_3_2_or_1_2']):\\n certs += ['openshift-master.crt',\\n 'openshift-master.key',\\n 'openshift-master.kubeconfig']\\n if bool(hostvars['openshift']['common']['version_gte_3_3_or_1_3']):\\n certs += ['service-signer.crt',\\n 'service-signer.key']\\n return certs\\n\\n @staticmethod\\n def oo_htpasswd_users_from_file(file_contents):\\n ''' return a dictionary of htpasswd users from htpasswd file contents '''\\n htpasswd_entries = {}\\n if not isinstance(file_contents, basestring):\\n raise errors.AnsibleFilterError(\\\"failed, expects to filter on a string\\\")\\n for line in file_contents.splitlines():\\n user = None\\n passwd = None\\n if len(line) == 0:\\n continue\\n if ':' in line:\\n user, passwd = line.split(':', 1)\\n\\n if user is None or len(user) == 0 or passwd is None or len(passwd) == 0:\\n error_msg = \\\"failed, expects each line to be a colon separated string representing the user and passwd\\\"\\n raise errors.AnsibleFilterError(error_msg)\\n htpasswd_entries[user] = passwd\\n return htpasswd_entries\\n\\n\\n def filters(self):\\n ''' returns a mapping of filters to methods '''\\n return {\\\"translate_idps\\\": self.translate_idps,\\n \\\"validate_pcs_cluster\\\": self.validate_pcs_cluster,\\n \\\"certificates_to_synchronize\\\": self.certificates_to_synchronize,\\n \\\"oo_htpasswd_users_from_file\\\": self.oo_htpasswd_users_from_file}\\n\",\n \"path\": \"filter_plugins/openshift_master.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/filter_plugins/openshift_master.py b/filter_plugins/openshift_master.py\nindex d196d6c1f88..ee6a62ba55e 100644\n--- a/filter_plugins/openshift_master.py\n+++ b/filter_plugins/openshift_master.py\n@@ -550,6 +550,9 @@ def certificates_to_synchronize(hostvars, include_keys=True):\n certs += ['openshift-master.crt',\n 'openshift-master.key',\n 'openshift-master.kubeconfig']\n+ if bool(hostvars['openshift']['common']['version_gte_3_3_or_1_3']):\n+ certs += ['service-signer.crt',\n+ 'service-signer.key']\n return certs\n \n @staticmethod\ndiff --git a/roles/openshift_master/templates/master.yaml.v1.j2 b/roles/openshift_master/templates/master.yaml.v1.j2\nindex e9beed3b351..0430fc77927 100644\n--- a/roles/openshift_master/templates/master.yaml.v1.j2\n+++ b/roles/openshift_master/templates/master.yaml.v1.j2\n@@ -44,6 +44,13 @@ auditConfig:{{ openshift.master.audit_config | to_padded_yaml(level=1) }}\n {% endif %}\n controllerLeaseTTL: {{ openshift.master.controller_lease_ttl | default('30') }}\n {% endif %}\n+{% if openshift.common.version_gte_3_3_or_1_3 | bool %}\n+controllerConfig:\n+ serviceServingCert:\n+ signer:\n+ certFile: service-signer.crt\n+ keyFile: service-signer.key\n+{% endif %}\n controllers: '*'\n corsAllowedOrigins:\n {% for origin in ['127.0.0.1', 'localhost', openshift.common.ip, openshift.common.public_ip] | union(openshift.common.all_hostnames) | unique %}\n"}}},{"rowIdx":5496,"cells":{"in_source_id":{"kind":"string","value":"PennyLaneAI__pennylane-1223"},"issue":{"kind":"string","value":"Repeated applications of the torch interface result in an error when using templates\nConsider the following code:\r\n\r\n```python\r\nimport torch\r\nimport pennylane as qml\r\n\r\nn_qubits = 2\r\ndev = qml.device(\"default.qubit\", wires=n_qubits)\r\n\r\ndef circuit(weights):\r\n qml.templates.BasicEntanglerLayers(weights, wires=range(n_qubits))\r\n return qml.expval(qml.PauliZ(wires=0))\r\n\r\nqnode = qml.QNode(circuit, dev, interface=\"torch\")\r\n\r\nweights = torch.ones((3, 2))\r\nqnode(weights)\r\n\r\nqnode.to_torch()\r\n```\r\nHere, we are creating a QNode that contains `BasicEntanglerLayers` - an operation that was previously a tape (changed in https://github.com/PennyLaneAI/pennylane/pull/1138/). We then evaluate the QNode using `qnode(weights)`, which will cause the contained quantum tape to be converted to the Torch interface. Finally, we convert again to the torch interface in the last line. This results in the error:\r\n```\r\nTypeError: Cannot create a consistent method resolution\r\norder (MRO) for bases TorchInterface, TorchQuantumTape\r\n```\r\n\r\nInstead, if we were to use a different circuit without templates, the error does not appear:\r\n```python\r\ndef circuit(weights):\r\n for i in range(3):\r\n for j in range(2):\r\n qml.RY(weights[i, j], wires=j)\r\n return qml.expval(qml.PauliZ(wires=0))\r\n```\r\nAlso, the circuit with `BasicEntanglerLayers` does not cause an error before #1138 was merged in. Hence, the migration from templates to operations has introduced this issue.\r\n\r\nCould this be to do with the use of `expand()` by the templates? The `expand()` method returns a quantum tape, do we have to be careful about the interface?\r\n\r\n#### Additional information\r\n\r\nThis issue was identified due to [failing tests](https://github.com/PennyLaneAI/qml/runs/2314856986?check_suite_focus=true#step:8:1464) for the [TorchLayer](https://pennylane.ai/qml/demos/tutorial_qnn_module_torch.html) tutorial. This tutorial creates multiple `TorchLayer`s from the same QNode, resulting in `to_torch()` being called multiple times. We don't typically expect `to_torch()` to be called explicitly by users.\r\n\n"},"before_files":{"kind":"list like","value":[{"content":"# Copyright 2018-2021 Xanadu Quantum Technologies Inc.\n\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n\n# http://www.apache.org/licenses/LICENSE-2.0\n\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\"\"\"\nThis module contains the base quantum tape.\n\"\"\"\n# pylint: disable=too-many-instance-attributes,protected-access,too-many-branches,too-many-public-methods\nfrom collections import Counter, deque\nimport contextlib\nimport copy\nfrom threading import RLock\n\nimport numpy as np\n\nimport pennylane as qml\nfrom pennylane.queuing import AnnotatedQueue, QueuingContext, QueuingError\nfrom pennylane.operation import Sample\n\n# CV ops still need to support state preparation operations prior to any\n# other operation for PennyLane-SF tests to pass.\nSTATE_PREP_OPS = (\n qml.BasisState,\n qml.QubitStateVector,\n # qml.CatState,\n # qml.CoherentState,\n # qml.FockDensityMatrix,\n # qml.DisplacedSqueezedState,\n # qml.FockState,\n # qml.FockStateVector,\n # qml.ThermalState,\n # qml.GaussianState,\n)\n\n\nOPENQASM_GATES = {\n \"CNOT\": \"cx\",\n \"CZ\": \"cz\",\n \"U3\": \"u3\",\n \"U2\": \"u2\",\n \"U1\": \"u1\",\n \"Identity\": \"id\",\n \"PauliX\": \"x\",\n \"PauliY\": \"y\",\n \"PauliZ\": \"z\",\n \"Hadamard\": \"h\",\n \"S\": \"s\",\n \"S.inv\": \"sdg\",\n \"T\": \"t\",\n \"T.inv\": \"tdg\",\n \"RX\": \"rx\",\n \"RY\": \"ry\",\n \"RZ\": \"rz\",\n \"CRX\": \"crx\",\n \"CRY\": \"cry\",\n \"CRZ\": \"crz\",\n \"SWAP\": \"swap\",\n \"Toffoli\": \"ccx\",\n \"CSWAP\": \"cswap\",\n \"PhaseShift\": \"u1\",\n}\n\"\"\"\ndict[str, str]: Maps PennyLane gate names to equivalent QASM gate names.\n\nNote that QASM has two native gates:\n\n- ``U`` (equivalent to :class:`~.U3`)\n- ``CX`` (equivalent to :class:`~.CNOT`)\n\nAll other gates are defined in the file stdgates.inc:\nhttps://github.com/Qiskit/openqasm/blob/master/examples/stdgates.inc\n\"\"\"\n\n\ndef get_active_tape():\n \"\"\"Returns the currently recording tape.\n If no tape is currently recording, ``None`` is returned.\n\n **Example**\n\n >>> with qml.tape.QuantumTape():\n ... qml.RX(0.2, wires=\"a\")\n ... tape = qml.get_active_tape()\n ... qml.RY(0.1, wires=\"b\")\n >>> print(tape)\n <QuantumTape: wires=['a', 'b'], params=2>\n >>> print(qml.tape.get_active_tape())\n None\n \"\"\"\n return QueuingContext.active_context()\n\n\ndef expand_tape(tape, depth=1, stop_at=None, expand_measurements=False):\n \"\"\"Expand all objects in a tape to a specific depth.\n\n Args:\n depth (int): the depth the tape should be expanded\n stop_at (Callable): A function which accepts a queue object,\n and returns ``True`` if this object should *not* be expanded.\n If not provided, all objects that support expansion will be expanded.\n expand_measurements (bool): If ``True``, measurements will be expanded\n to basis rotations and computational basis measurements.\n\n **Example**\n\n Consider the following nested tape:\n\n .. code-block:: python\n\n with JacobianTape() as tape:\n qml.BasisState(np.array([1, 1]), wires=[0, 'a'])\n\n with JacobianTape() as tape2:\n qml.Rot(0.543, 0.1, 0.4, wires=0)\n\n qml.CNOT(wires=[0, 'a'])\n qml.RY(0.2, wires='a')\n qml.probs(wires=0), qml.probs(wires='a')\n\n The nested structure is preserved:\n\n >>> tape.operations\n [BasisState(array([1, 1]), wires=[0, 'a']),\n <JacobianTape: wires=[0], params=3>,\n CNOT(wires=[0, 'a']),\n RY(0.2, wires=['a'])]\n\n Calling ``expand_tape`` will return a tape with all nested tapes\n expanded, resulting in a single tape of quantum operations:\n\n >>> new_tape = expand_tape(tape)\n >>> new_tape.operations\n [PauliX(wires=[0]),\n PauliX(wires=['a']),\n Rot(0.543, 0.1, 0.4, wires=[0]),\n CNOT(wires=[0, 'a']),\n RY(0.2, wires=['a'])]\n \"\"\"\n if depth == 0:\n return tape\n\n if stop_at is None:\n # by default expand all objects\n stop_at = lambda obj: False\n\n new_tape = tape.__class__()\n\n # Check for observables acting on the same wire. If present, observables must be\n # qubit-wise commuting Pauli words. In this case, the tape is expanded with joint\n # rotations and the observables updated to the computational basis. Note that this\n # expansion acts on the original tape in place.\n if tape._obs_sharing_wires:\n try:\n rotations, diag_obs = qml.grouping.diagonalize_qwc_pauli_words(tape._obs_sharing_wires)\n except ValueError as e:\n raise qml.QuantumFunctionError(\n \"Only observables that are qubit-wise commuting \"\n \"Pauli words can be returned on the same wire\"\n ) from e\n\n tape._ops.extend(rotations)\n\n for o, i in zip(diag_obs, tape._obs_sharing_wires_id):\n new_m = qml.measure.MeasurementProcess(tape.measurements[i].return_type, obs=o)\n tape._measurements[i] = new_m\n\n for queue in (\"_prep\", \"_ops\", \"_measurements\"):\n for obj in getattr(tape, queue):\n\n stop = stop_at(obj)\n\n if not expand_measurements:\n # Measurements should not be expanded; treat measurements\n # as a stopping condition\n stop = stop or isinstance(obj, qml.measure.MeasurementProcess)\n\n if stop:\n # do not expand out the object; append it to the\n # new tape, and continue to the next object in the queue\n getattr(new_tape, queue).append(obj)\n continue\n\n if isinstance(obj, (qml.operation.Operation, qml.measure.MeasurementProcess)):\n # Object is an operation; query it for its expansion\n try:\n obj = obj.expand()\n except NotImplementedError:\n # Object does not define an expansion; treat this as\n # a stopping condition.\n getattr(new_tape, queue).append(obj)\n continue\n\n # recursively expand out the newly created tape\n expanded_tape = expand_tape(obj, stop_at=stop_at, depth=depth - 1)\n\n new_tape._prep += expanded_tape._prep\n new_tape._ops += expanded_tape._ops\n new_tape._measurements += expanded_tape._measurements\n\n # Update circuit info\n new_tape._update_circuit_info()\n return new_tape\n\n\n# pylint: disable=too-many-public-methods\nclass QuantumTape(AnnotatedQueue):\n \"\"\"A quantum tape recorder, that records, validates and executes variational quantum programs.\n\n Args:\n name (str): a name given to the quantum tape\n do_queue (bool): Whether to queue this tape in a parent tape context.\n\n **Example**\n\n .. code-block:: python\n\n import pennylane.tape\n\n with qml.tape.QuantumTape() as tape:\n qml.RX(0.432, wires=0)\n qml.RY(0.543, wires=0)\n qml.CNOT(wires=[0, 'a'])\n qml.RX(0.133, wires='a')\n qml.expval(qml.PauliZ(wires=[0]))\n\n Once constructed, information about the quantum circuit can be queried:\n\n >>> tape.operations\n [RX(0.432, wires=[0]), RY(0.543, wires=[0]), CNOT(wires=[0, 'a']), RX(0.133, wires=['a'])]\n >>> tape.observables\n [expval(PauliZ(wires=[0]))]\n >>> tape.get_parameters()\n [0.432, 0.543, 0.133]\n >>> tape.wires\n <Wires = [0, 'a']>\n >>> tape.num_params\n 3\n\n The :class:`~.CircuitGraph` can also be accessed:\n\n >>> tape.graph\n <pennylane.circuit_graph.CircuitGraph object at 0x7fcc0433a690>\n\n Once constructed, the quantum tape can be executed directly on a supported\n device:\n\n >>> dev = qml.device(\"default.qubit\", wires=[0, 'a'])\n\n Execution can take place either using the in-place constructed parameters,\n\n >>> tape.execute(dev)\n [0.77750694]\n\n or by providing parameters at run time:\n\n >>> tape.execute(dev, params=[0.1, 0.1, 0.1])\n [0.99003329]\n\n The trainable parameters of the tape can be explicitly set, and the values of\n the parameters modified in-place:\n\n >>> tape.trainable_params = {0} # set only the first parameter as free\n >>> tape.set_parameters(0.56)\n >>> tape.get_parameters()\n [0.56]\n >>> tape.get_parameters(trainable_only=False)\n [0.56, 0.543, 0.133]\n\n\n When using a tape with ``do_queue=False``, that tape will not be queued in a parent tape context.\n\n .. code-block:: python\n\n with qml.tape.QuantumTape() as tape1:\n with qml.tape.QuantumTape(do_queue=False) as tape2:\n qml.RX(0.123, wires=0)\n\n Here, tape2 records the RX gate, but tape1 doesn't record tape2.\n\n >>> tape1.operations\n []\n >>> tape2.operations\n [RX(0.123, wires=[0])]\n\n This is useful for when you want to transform a tape first before applying it.\n \"\"\"\n\n _lock = RLock()\n \"\"\"threading.RLock: Used to synchronize appending to/popping from global QueueingContext.\"\"\"\n\n def __init__(self, name=None, do_queue=True):\n super().__init__()\n self.name = name\n self.do_queue = do_queue\n self._prep = []\n \"\"\"list[.Operation]: Tape state preparations.\"\"\"\n\n self._ops = []\n \"\"\"list[.Operation]: quantum operations recorded by the tape.\"\"\"\n\n self._measurements = []\n \"\"\"list[.MeasurementProcess]: measurement processes recorded by the tape.\"\"\"\n\n self._par_info = {}\n \"\"\"dict[int, dict[str, Operation or int]]: Parameter information. Keys are\n parameter indices (in the order they appear on the tape), and values are a\n dictionary containing the corresponding operation and operation parameter index.\"\"\"\n\n self._trainable_params = set()\n self._graph = None\n self._resources = None\n self._depth = None\n self._output_dim = 0\n\n self.wires = qml.wires.Wires([])\n self.num_wires = 0\n\n self.is_sampled = False\n self.all_sampled = False\n self.inverse = False\n\n self._obs_sharing_wires = []\n \"\"\"list[.Observable]: subset of the observables that share wires with another observable,\n i.e., that do not have their own unique set of wires.\"\"\"\n self._obs_sharing_wires_id = []\n\n def __repr__(self):\n return f\"<{self.__class__.__name__}: wires={self.wires.tolist()}, params={self.num_params}>\"\n\n def __enter__(self):\n QuantumTape._lock.acquire()\n try:\n if self.do_queue:\n QueuingContext.append(self)\n return super().__enter__()\n except Exception as _:\n QuantumTape._lock.release()\n raise\n\n def __exit__(self, exception_type, exception_value, traceback):\n try:\n super().__exit__(exception_type, exception_value, traceback)\n self._process_queue()\n finally:\n QuantumTape._lock.release()\n\n @property\n def interface(self):\n \"\"\"str, None: automatic differentiation interface used by the quantum tape (if any)\"\"\"\n return None\n\n @contextlib.contextmanager\n def stop_recording(self):\n \"\"\"Context manager to temporarily stop recording operations\n onto the tape. This is useful is scratch space is needed.\n\n **Example**\n\n >>> with qml.tape.QuantumTape() as tape:\n ... qml.RX(0, wires=0)\n ... with tape.stop_recording():\n ... qml.RY(1.0, wires=1)\n ... qml.RZ(2, wires=1)\n >>> tape.operations\n [RX(0, wires=[0]), RZ(2, wires=[1])]\n \"\"\"\n if QueuingContext.active_context() is not self:\n raise QueuingError(\n \"Cannot stop recording requested tape \" \"as it is not currently recording.\"\n )\n\n active_contexts = QueuingContext._active_contexts\n QueuingContext._active_contexts = deque()\n yield\n QueuingContext._active_contexts = active_contexts\n\n # ========================================================\n # construction methods\n # ========================================================\n\n def _process_queue(self):\n \"\"\"Process the annotated queue, creating a list of quantum\n operations and measurement processes.\n\n This method sets the following attributes:\n\n * ``_ops``\n * ``_measurements``\n * ``_par_info``\n * ``_output_dim``\n * ``_trainable_params``\n * ``is_sampled``\n \"\"\"\n self._prep = []\n self._ops = []\n self._measurements = []\n self._output_dim = 0\n\n for obj, info in self._queue.items():\n\n if isinstance(obj, QuantumTape):\n self._ops.append(obj)\n\n elif isinstance(obj, qml.operation.Operation) and not info.get(\"owner\", False):\n # operation objects with no owners\n\n if self._measurements:\n raise ValueError(\n f\"Quantum operation {obj} must occur prior to any measurements.\"\n )\n\n # invert the operation if required\n obj.inverse = info.get(\"inverse\", False)\n\n if isinstance(obj, STATE_PREP_OPS):\n if self._ops:\n raise ValueError(\n f\"State preparation operation {obj} must occur prior to any quantum operations.\"\n )\n\n self._prep.append(obj)\n else:\n self._ops.append(obj)\n\n elif isinstance(obj, qml.measure.MeasurementProcess):\n # measurement process\n self._measurements.append(obj)\n\n # attempt to infer the output dimension\n if obj.return_type is qml.operation.Probability:\n self._output_dim += 2 ** len(obj.wires)\n elif obj.return_type is qml.operation.State:\n continue # the output_dim is worked out automatically\n else:\n self._output_dim += 1\n\n # check if any sampling is occuring\n if obj.return_type is qml.operation.Sample:\n self.is_sampled = True\n\n elif isinstance(obj, qml.operation.Observable) and \"owner\" not in info:\n raise ValueError(f\"Observable {obj} does not have a measurement type specified.\")\n\n self._update()\n\n def _update_circuit_info(self):\n \"\"\"Update circuit metadata\"\"\"\n self.wires = qml.wires.Wires.all_wires(\n [op.wires for op in self.operations + self.observables]\n )\n self.num_wires = len(self.wires)\n\n self.is_sampled = any(m.return_type is Sample for m in self.measurements)\n self.all_sampled = all(m.return_type is Sample for m in self.measurements)\n self.is_sampled = any(m.return_type is Sample for m in self.measurements)\n\n def _update_observables(self):\n \"\"\"Update information about observables, including the wires that are acted upon and\n identifying any observables that share wires\"\"\"\n obs_wires = [wire for m in self.measurements for wire in m.wires if m.obs is not None]\n self._obs_sharing_wires = []\n self._obs_sharing_wires_id = []\n\n if len(obs_wires) != len(set(obs_wires)):\n c = Counter(obs_wires)\n repeated_wires = {w for w in obs_wires if c[w] > 1}\n\n for i, m in enumerate(self.measurements):\n if m.obs is not None:\n if len(set(m.wires) & repeated_wires) > 0:\n self._obs_sharing_wires.append(m.obs)\n self._obs_sharing_wires_id.append(i)\n\n def _update_par_info(self):\n \"\"\"Update the parameter information dictionary\"\"\"\n param_count = 0\n\n for obj in self.operations + self.observables:\n\n for p in range(len(obj.data)):\n info = self._par_info.get(param_count, {})\n info.update({\"op\": obj, \"p_idx\": p})\n\n self._par_info[param_count] = info\n param_count += 1\n\n def _update_trainable_params(self):\n \"\"\"Set the trainable parameters\"\"\"\n self._trainable_params = set(self._par_info)\n\n def _update(self):\n \"\"\"Update all internal tape metadata regarding processed operations and observables\"\"\"\n self._graph = None\n self._resources = None\n self._depth = None\n self._update_circuit_info()\n self._update_par_info()\n self._update_trainable_params()\n self._update_observables()\n\n def expand(self, depth=1, stop_at=None, expand_measurements=False):\n \"\"\"Expand all operations in the processed queue to a specific depth.\n\n Args:\n depth (int): the depth the tape should be expanded\n stop_at (Callable): A function which accepts a queue object,\n and returns ``True`` if this object should *not* be expanded.\n If not provided, all objects that support expansion will be expanded.\n expand_measurements (bool): If ``True``, measurements will be expanded\n to basis rotations and computational basis measurements.\n\n **Example**\n\n Consider the following nested tape:\n\n .. code-block:: python\n\n with JacobianTape() as tape:\n qml.BasisState(np.array([1, 1]), wires=[0, 'a'])\n\n with JacobianTape() as tape2:\n qml.Rot(0.543, 0.1, 0.4, wires=0)\n\n qml.CNOT(wires=[0, 'a'])\n qml.RY(0.2, wires='a')\n qml.probs(wires=0), qml.probs(wires='a')\n\n The nested structure is preserved:\n\n >>> tape.operations\n [BasisState(array([1, 1]), wires=[0, 'a']),\n <JacobianTape: wires=[0], params=3>,\n CNOT(wires=[0, 'a']),\n RY(0.2, wires=['a'])]\n\n Calling ``.expand`` will return a tape with all nested tapes\n expanded, resulting in a single tape of quantum operations:\n\n >>> new_tape = tape.expand()\n >>> new_tape.operations\n [PauliX(wires=[0]),\n PauliX(wires=['a']),\n Rot(0.543, 0.1, 0.4, wires=[0]),\n CNOT(wires=[0, 'a']),\n RY(0.2, wires=['a'])]\n \"\"\"\n new_tape = expand_tape(\n self, depth=depth, stop_at=stop_at, expand_measurements=expand_measurements\n )\n new_tape._update()\n return new_tape\n\n def inv(self):\n \"\"\"Inverts the processed operations.\n\n Inversion is performed in-place.\n\n .. note::\n\n This method only inverts the quantum operations/unitary recorded\n by the quantum tape; state preparations and measurements are left unchanged.\n\n **Example**\n\n .. code-block:: python\n\n with JacobianTape() as tape:\n qml.BasisState(np.array([1, 1]), wires=[0, 'a'])\n qml.RX(0.432, wires=0)\n qml.Rot(0.543, 0.1, 0.4, wires=0).inv()\n qml.CNOT(wires=[0, 'a'])\n qml.probs(wires=0), qml.probs(wires='a')\n\n This tape has the following properties:\n\n >>> tape.operations\n [BasisState(array([1, 1]), wires=[0, 'a']),\n RX(0.432, wires=[0]),\n Rot.inv(0.543, 0.1, 0.4, wires=[0]),\n CNOT(wires=[0, 'a'])]\n >>> tape.get_parameters()\n [array([1, 1]), 0.432, 0.543, 0.1, 0.4]\n\n Here, let's set some trainable parameters:\n\n >>> tape.trainable_params = {1, 2}\n >>> tape.get_parameters()\n [0.432, 0.543]\n\n Inverting the tape:\n\n >>> tape.inv()\n >>> tape.operations\n [BasisState(array([1, 1]), wires=[0, 'a']),\n CNOT.inv(wires=[0, 'a']),\n Rot(0.543, 0.1, 0.4, wires=[0]),\n RX.inv(0.432, wires=[0])]\n\n Tape inversion also modifies the order of tape parameters:\n\n >>> tape.get_parameters(trainable_only=False)\n [array([1, 1]), 0.543, 0.1, 0.4, 0.432]\n >>> tape.get_parameters(trainable_only=True)\n [0.543, 0.432]\n >>> tape.trainable_params\n {1, 4}\n \"\"\"\n # we must remap the old parameter\n # indices to the new ones after the operation order is reversed.\n parameter_indices = []\n param_count = 0\n\n for queue in [self._prep, self._ops, self.observables]:\n # iterate through all queues\n\n obj_params = []\n\n for obj in queue:\n # index the number of parameters on each operation\n num_obj_params = len(obj.data)\n obj_params.append(list(range(param_count, param_count + num_obj_params)))\n\n # keep track of the total number of parameters encountered so far\n param_count += num_obj_params\n\n if queue == self._ops:\n # reverse the list representing operator parameters\n obj_params = obj_params[::-1]\n\n parameter_indices.extend(obj_params)\n\n # flatten the list of parameter indices after the reversal\n parameter_indices = [item for sublist in parameter_indices for item in sublist]\n parameter_mapping = dict(zip(parameter_indices, range(len(parameter_indices))))\n\n # map the params\n self.trainable_params = {parameter_mapping[i] for i in self.trainable_params}\n self._par_info = {parameter_mapping[k]: v for k, v in self._par_info.items()}\n\n for op in self._ops:\n op.inverse = not op.inverse\n\n self._ops = list(reversed(self._ops))\n\n # ========================================================\n # Parameter handling\n # ========================================================\n\n @property\n def trainable_params(self):\n \"\"\"Store or return a set containing the indices of parameters that support\n differentiability. The indices provided match the order of appearence in the\n quantum circuit.\n\n Setting this property can help reduce the number of quantum evaluations needed\n to compute the Jacobian; parameters not marked as trainable will be\n automatically excluded from the Jacobian computation.\n\n The number of trainable parameters determines the number of parameters passed to\n :meth:`~.set_parameters`, :meth:`~.execute`, and :meth:`~.JacobianTape.jacobian`,\n and changes the default output size of methods :meth:`~.JacobianTape.jacobian` and\n :meth:`~.get_parameters()`.\n\n .. note::\n\n Since the :meth:`~.JacobianTape.jacobian` method is not called for devices that support\n native backpropagation (such as ``default.qubit.tf`` and ``default.qubit.autograd``),\n this property contains no relevant information when using backpropagation to compute gradients.\n\n **Example**\n\n .. code-block:: python\n\n with JacobianTape() as tape:\n qml.RX(0.432, wires=0)\n qml.RY(0.543, wires=0)\n qml.CNOT(wires=[0, 'a'])\n qml.RX(0.133, wires='a')\n qml.expval(qml.PauliZ(wires=[0]))\n\n >>> tape.trainable_params\n {0, 1, 2}\n >>> tape.trainable_params = {0} # set only the first parameter as free\n >>> tape.get_parameters()\n [0.432]\n\n Args:\n param_indices (set[int]): parameter indices\n \"\"\"\n return self._trainable_params\n\n @trainable_params.setter\n def trainable_params(self, param_indices):\n \"\"\"Store the indices of parameters that support differentiability.\n\n Args:\n param_indices (set[int]): parameter indices\n \"\"\"\n if any(not isinstance(i, int) or i < 0 for i in param_indices):\n raise ValueError(\"Argument indices must be positive integers.\")\n\n if any(i > len(self._par_info) for i in param_indices):\n raise ValueError(f\"Tape has at most {self.num_params} parameters.\")\n\n self._trainable_params = param_indices\n\n def get_parameters(self, trainable_only=True, **kwargs): # pylint:disable=unused-argument\n \"\"\"Return the parameters incident on the tape operations.\n\n The returned parameters are provided in order of appearance\n on the tape.\n\n Args:\n trainable_only (bool): if True, returns only trainable parameters\n\n **Example**\n\n .. code-block:: python\n\n with JacobianTape() as tape:\n qml.RX(0.432, wires=0)\n qml.RY(0.543, wires=0)\n qml.CNOT(wires=[0, 'a'])\n qml.RX(0.133, wires='a')\n qml.expval(qml.PauliZ(wires=[0]))\n\n By default, all parameters are trainable and will be returned:\n\n >>> tape.get_parameters()\n [0.432, 0.543, 0.133]\n\n Setting the trainable parameter indices will result in only the specified\n parameters being returned:\n\n >>> tape.trainable_params = {1} # set the second parameter as free\n >>> tape.get_parameters()\n [0.543]\n\n The ``trainable_only`` argument can be set to ``False`` to instead return\n all parameters:\n\n >>> tape.get_parameters(trainable_only=False)\n [0.432, 0.543, 0.133]\n \"\"\"\n params = []\n iterator = self.trainable_params if trainable_only else self._par_info\n\n for p_idx in iterator:\n op = self._par_info[p_idx][\"op\"]\n op_idx = self._par_info[p_idx][\"p_idx\"]\n params.append(op.data[op_idx])\n\n return params\n\n def set_parameters(self, params, trainable_only=True):\n \"\"\"Set the parameters incident on the tape operations.\n\n Args:\n params (list[float]): A list of real numbers representing the\n parameters of the quantum operations. The parameters should be\n provided in order of appearance in the quantum tape.\n trainable_only (bool): if True, set only trainable parameters\n\n **Example**\n\n .. code-block:: python\n\n with JacobianTape() as tape:\n qml.RX(0.432, wires=0)\n qml.RY(0.543, wires=0)\n qml.CNOT(wires=[0, 'a'])\n qml.RX(0.133, wires='a')\n qml.expval(qml.PauliZ(wires=[0]))\n\n By default, all parameters are trainable and can be modified:\n\n >>> tape.set_parameters([0.1, 0.2, 0.3])\n >>> tape.get_parameters()\n [0.1, 0.2, 0.3]\n\n Setting the trainable parameter indices will result in only the specified\n parameters being modifiable. Note that this only modifies the number of\n parameters that must be passed.\n\n >>> tape.trainable_params = {0, 2} # set the first and third parameter as free\n >>> tape.set_parameters([-0.1, 0.5])\n >>> tape.get_parameters(trainable_only=False)\n [-0.1, 0.2, 0.5]\n\n The ``trainable_only`` argument can be set to ``False`` to instead set\n all parameters:\n\n >>> tape.set_parameters([4, 1, 6], trainable_only=False)\n >>> tape.get_parameters(trainable_only=False)\n [4, 1, 6]\n \"\"\"\n if trainable_only:\n iterator = zip(self.trainable_params, params)\n required_length = self.num_params\n else:\n iterator = enumerate(params)\n required_length = len(self._par_info)\n\n if len(params) != required_length:\n raise ValueError(\"Number of provided parameters does not match.\")\n\n for idx, p in iterator:\n op = self._par_info[idx][\"op\"]\n op.data[self._par_info[idx][\"p_idx\"]] = p\n\n # ========================================================\n # Tape properties\n # ========================================================\n\n @property\n def operations(self):\n \"\"\"Returns the operations on the quantum tape.\n\n Returns:\n list[.Operation]: recorded quantum operations\n\n **Example**\n\n .. code-block:: python\n\n with JacobianTape() as tape:\n qml.RX(0.432, wires=0)\n qml.RY(0.543, wires=0)\n qml.CNOT(wires=[0, 'a'])\n qml.RX(0.133, wires='a')\n qml.expval(qml.PauliZ(wires=[0]))\n\n >>> tape.operations\n [RX(0.432, wires=[0]), RY(0.543, wires=[0]), CNOT(wires=[0, 'a']), RX(0.133, wires=['a'])]\n \"\"\"\n return self._prep + self._ops\n\n @property\n def observables(self):\n \"\"\"Returns the observables on the quantum tape.\n\n Returns:\n list[.Observable]: list of recorded quantum operations\n\n **Example**\n\n .. code-block:: python\n\n with JacobianTape() as tape:\n qml.RX(0.432, wires=0)\n qml.RY(0.543, wires=0)\n qml.CNOT(wires=[0, 'a'])\n qml.RX(0.133, wires='a')\n qml.expval(qml.PauliZ(wires=[0]))\n\n >>> tape.observables\n [expval(PauliZ(wires=[0]))]\n \"\"\"\n # TODO: modify this property once devices\n # have been refactored to accept and understand recieving\n # measurement processes rather than specific observables.\n obs = []\n\n for m in self._measurements:\n if m.obs is not None:\n m.obs.return_type = m.return_type\n obs.append(m.obs)\n else:\n obs.append(m)\n\n return obs\n\n @property\n def measurements(self):\n \"\"\"Returns the measurements on the quantum tape.\n\n Returns:\n list[.MeasurementProcess]: list of recorded measurement processess\n\n **Example**\n\n .. code-block:: python\n\n with JacobianTape() as tape:\n qml.RX(0.432, wires=0)\n qml.RY(0.543, wires=0)\n qml.CNOT(wires=[0, 'a'])\n qml.RX(0.133, wires='a')\n qml.expval(qml.PauliZ(wires=[0]))\n\n >>> tape.measurements\n [<pennylane.tape.measure.MeasurementProcess object at 0x7f10b2150c10>]\n \"\"\"\n return self._measurements\n\n @property\n def num_params(self):\n \"\"\"Returns the number of trainable parameters on the quantum tape.\"\"\"\n return len(self.trainable_params)\n\n @property\n def output_dim(self):\n \"\"\"The (inferred) output dimension of the quantum tape.\"\"\"\n return self._output_dim\n\n @property\n def diagonalizing_gates(self):\n \"\"\"Returns the gates that diagonalize the measured wires such that they\n are in the eigenbasis of the circuit observables.\n\n Returns:\n List[~.Operation]: the operations that diagonalize the observables\n \"\"\"\n rotation_gates = []\n\n for observable in self.observables:\n rotation_gates.extend(observable.diagonalizing_gates())\n\n return rotation_gates\n\n @property\n def graph(self):\n \"\"\"Returns a directed acyclic graph representation of the recorded\n quantum circuit:\n\n >>> tape.graph\n <pennylane.circuit_graph.CircuitGraph object at 0x7fcc0433a690>\n\n Note that the circuit graph is only constructed once, on first call to this property,\n and cached for future use.\n\n Returns:\n .CircuitGraph: the circuit graph object\n \"\"\"\n if self._graph is None:\n self._graph = qml.CircuitGraph(\n self.operations, self.observables, self.wires, self._par_info, self.trainable_params\n )\n\n return self._graph\n\n def get_resources(self):\n \"\"\"Resource requirements of a quantum circuit.\n\n Returns:\n dict[str, int]: how many times constituent operations are applied\n\n **Example**\n\n .. code-block:: python3\n\n with qml.tape.QuantumTape() as tape:\n qml.Hadamard(wires=0)\n qml.RZ(0.26, wires=1)\n qml.CNOT(wires=[1, 0])\n qml.Rot(1.8, -2.7, 0.2, wires=0)\n qml.Hadamard(wires=1)\n qml.CNOT(wires=[0, 1])\n qml.expval(qml.PauliZ(0) @ qml.PauliZ(1))\n\n Asking for the resources produces a dictionary as shown below:\n\n >>> tape.get_resources()\n {'Hadamard': 2, 'RZ': 1, 'CNOT': 2, 'Rot': 1}\n \"\"\"\n if self._resources is None:\n self._resources = {}\n\n for op in self.operations:\n if op.name not in self._resources.keys():\n self._resources[op.name] = 1\n else:\n self._resources[op.name] += 1\n\n return self._resources\n\n def get_depth(self):\n \"\"\"Depth of the quantum circuit.\n\n Returns:\n int: Circuit depth, computed as the longest path in the circuit's directed acyclic graph representation.\n\n **Example**\n\n .. code-block:: python3\n\n with QuantumTape() as tape:\n qml.Hadamard(wires=0)\n qml.PauliX(wires=1)\n qml.CRX(2.3, wires=[0, 1])\n qml.Rot(1.2, 3.2, 0.7, wires=[1])\n qml.CRX(-2.3, wires=[0, 1])\n qml.expval(qml.PauliZ(0) @ qml.PauliZ(1))\n\n The depth can be obtained like so:\n\n >>> tape.get_depth()\n 4\n \"\"\"\n if self._depth is None:\n self._depth = self.graph.get_depth()\n\n return self._depth\n\n def draw(self, charset=\"unicode\", wire_order=None, show_all_wires=False):\n \"\"\"Draw the quantum tape as a circuit diagram.\n\n Consider the following circuit as an example:\n\n .. code-block:: python3\n\n with QuantumTape() as tape:\n qml.Hadamard(0)\n qml.CRX(2.3, wires=[0, 1])\n qml.Rot(1.2, 3.2, 0.7, wires=[1])\n qml.CRX(-2.3, wires=[0, 1])\n qml.expval(qml.PauliZ(0) @ qml.PauliZ(1))\n\n We can draw the tape after construction:\n\n >>> print(tape.draw())\n 0: ──H──╭C────────────────────────────╭C─────────╭┤ ⟨Z ⊗ Z⟩\n 1: ─────╰RX(2.3)──Rot(1.2, 3.2, 0.7)──╰RX(-2.3)──╰┤ ⟨Z ⊗ Z⟩\n >>> print(tape.draw(charset=\"ascii\"))\n 0: --H--+C----------------------------+C---------+| <Z @ Z>\n 1: -----+RX(2.3)--Rot(1.2, 3.2, 0.7)--+RX(-2.3)--+| <Z @ Z>\n\n Args:\n charset (str, optional): The charset that should be used. Currently, \"unicode\" and\n \"ascii\" are supported.\n wire_order (Sequence[Any]): the order (from top to bottom) to print the wires of the circuit\n show_all_wires (bool): If True, all wires, including empty wires, are printed.\n\n Raises:\n ValueError: if the given charset is not supported\n\n Returns:\n str: the circuit representation of the tape\n \"\"\"\n return self.graph.draw(\n charset=charset,\n wire_order=wire_order,\n show_all_wires=show_all_wires,\n )\n\n def to_openqasm(self, wires=None, rotations=True):\n \"\"\"Serialize the circuit as an OpenQASM 2.0 program.\n\n Only operations are serialized; all measurements\n are assumed to take place in the computational basis.\n\n .. note::\n\n The serialized OpenQASM program assumes that gate definitions\n in ``qelib1.inc`` are available.\n\n Args:\n wires (Wires or None): the wires to use when serializing the circuit\n rotations (bool): in addition to serializing user-specified\n operations, also include the gates that diagonalize the\n measured wires such that they are in the eigenbasis of the circuit observables.\n\n Returns:\n str: OpenQASM serialization of the circuit\n \"\"\"\n # We import decompose_queue here to avoid a circular import\n wires = wires or self.wires\n\n # add the QASM headers\n qasm_str = \"OPENQASM 2.0;\\n\"\n qasm_str += 'include \"qelib1.inc\";\\n'\n\n if self.num_wires == 0:\n # empty circuit\n return qasm_str\n\n # create the quantum and classical registers\n qasm_str += \"qreg q[{}];\\n\".format(len(wires))\n qasm_str += \"creg c[{}];\\n\".format(len(wires))\n\n # get the user applied circuit operations\n operations = self.operations\n\n if rotations:\n # if requested, append diagonalizing gates corresponding\n # to circuit observables\n operations += self.diagonalizing_gates\n\n with QuantumTape() as tape:\n for op in operations:\n op.queue()\n\n if op.inverse:\n op.inv()\n\n # decompose the queue\n operations = tape.expand(depth=2, stop_at=lambda obj: obj.name in OPENQASM_GATES).operations\n\n # create the QASM code representing the operations\n for op in operations:\n try:\n gate = OPENQASM_GATES[op.name]\n except KeyError as e:\n raise ValueError(f\"Operation {op.name} not supported by the QASM serializer\") from e\n\n wire_labels = \",\".join([f\"q[{wires.index(w)}]\" for w in op.wires.tolist()])\n params = \"\"\n\n if op.num_params > 0:\n # If the operation takes parameters, construct a string\n # with parameter values.\n params = \"(\" + \",\".join([str(p) for p in op.parameters]) + \")\"\n\n qasm_str += \"{name}{params} {wires};\\n\".format(\n name=gate, params=params, wires=wire_labels\n )\n\n # apply computational basis measurements to each quantum register\n # NOTE: This is not strictly necessary, we could inspect self.observables,\n # and then only measure wires which are requested by the user. However,\n # some devices which consume QASM require all registers be measured, so\n # measure all wires to be safe.\n for wire in range(len(wires)):\n qasm_str += \"measure q[{wire}] -> c[{wire}];\\n\".format(wire=wire)\n\n return qasm_str\n\n @property\n def data(self):\n \"\"\"Alias to :meth:`~.get_parameters` and :meth:`~.set_parameters`\n for backwards compatibilities with operations.\"\"\"\n return self.get_parameters(trainable_only=False)\n\n @data.setter\n def data(self, params):\n self.set_parameters(params, trainable_only=False)\n\n def copy(self, copy_operations=False, tape_cls=None):\n \"\"\"Returns a shallow copy of the quantum tape.\n\n Args:\n copy_operations (bool): If True, the tape operations are also shallow copied.\n Otherwise, if False, the copied tape operations will simply be references\n to the original tape operations; changing the parameters of one tape will likewise\n change the parameters of all copies.\n tape_cls (.QuantumTape): Cast the copied tape to a specific quantum tape subclass.\n If not provided, the same subclass is used as the original tape.\n\n Returns:\n .QuantumTape: a shallow copy of the tape\n \"\"\"\n if tape_cls is None:\n tape = self.__class__()\n else:\n tape = tape_cls()\n\n if copy_operations:\n # Perform a shallow copy of all operations in the state prep, operation, and measurement\n # queues. The operations will continue to share data with the original tape operations\n # unless modified.\n tape._prep = [copy.copy(op) for op in self._prep]\n tape._ops = [copy.copy(op) for op in self._ops]\n tape._measurements = [copy.copy(op) for op in self._measurements]\n else:\n # Perform a shallow copy of the state prep, operation, and measurement queues. The\n # operations within the queues will be references to the original tape operations;\n # changing the original operations will always alter the operations on the copied tape.\n tape._prep = self._prep.copy()\n tape._ops = self._ops.copy()\n tape._measurements = self._measurements.copy()\n\n tape._update()\n tape.trainable_params = self.trainable_params.copy()\n\n return tape\n\n def __copy__(self):\n return self.copy(copy_operations=True)\n\n # ========================================================\n # execution methods\n # ========================================================\n\n def execute(self, device, params=None):\n \"\"\"Execute the tape on a quantum device.\n\n Args:\n device (.Device): a PennyLane device\n that can execute quantum operations and return measurement statistics\n params (list[Any]): The quantum tape operation parameters. If not provided,\n the current tape parameters are used (via :meth:`~.get_parameters`).\n\n **Example**\n\n .. code-block:: python\n\n with JacobianTape() as tape:\n qml.RX(0.432, wires=0)\n qml.RY(0.543, wires=0)\n qml.CNOT(wires=[0, 'a'])\n qml.RX(0.133, wires='a')\n qml.probs(wires=[0, 'a'])\n\n If parameters are not provided, the existing tape parameters are used:\n\n >>> dev = qml.device(\"default.qubit\", wires=[0, 'a'])\n >>> tape.execute(dev)\n array([[8.84828969e-01, 3.92449987e-03, 4.91235209e-04, 1.10755296e-01]])\n\n Parameters can be optionally passed during execution:\n\n >>> tape.execute(dev, params=[1.0, 0.0, 1.0])\n array([[0.5931328 , 0.17701835, 0.05283049, 0.17701835]])\n\n Parameters provided for execution are temporary, and do not affect\n the tapes' parameters in-place:\n\n >>> tape.get_parameters()\n [0.432, 0.543, 0.133]\n \"\"\"\n if params is None:\n params = self.get_parameters()\n\n return self._execute(params, device=device)\n\n def execute_device(self, params, device):\n \"\"\"Execute the tape on a quantum device.\n\n This is a low-level method, intended to be called by an interface,\n and does not support autodifferentiation.\n\n For more details on differentiable tape execution, see :meth:`~.execute`.\n\n Args:\n device (~.Device): a PennyLane device\n that can execute quantum operations and return measurement statistics\n params (list[Any]): The quantum tape operation parameters. If not provided,\n the current tape parameter values are used (via :meth:`~.get_parameters`).\n \"\"\"\n if not all(len(o.diagonalizing_gates()) == 0 for o in self._obs_sharing_wires):\n raise qml.QuantumFunctionError(\n \"Multiple observables are being evaluated on the same wire. Call tape.expand() \"\n \"prior to execution to support this.\"\n )\n\n device.reset()\n\n # backup the current parameters\n saved_parameters = self.get_parameters()\n\n # temporarily mutate the in-place parameters\n self.set_parameters(params)\n\n if isinstance(device, qml.QubitDevice):\n res = device.execute(self)\n else:\n res = device.execute(self.operations, self.observables, {})\n\n # Update output dim if incorrect.\n # Note that we cannot assume the type of `res`, so\n # we use duck typing to catch any 'array like' object.\n try:\n if isinstance(res, np.ndarray) and res.dtype is np.dtype(\"object\"):\n output_dim = sum([len(i) for i in res])\n else:\n output_dim = np.prod(res.shape)\n\n if self.output_dim != output_dim:\n # update the inferred output dimension with the correct value\n self._output_dim = output_dim\n\n except (AttributeError, TypeError):\n # unable to determine the output dimension\n pass\n\n # restore original parameters\n self.set_parameters(saved_parameters)\n\n return res\n\n # interfaces can optionally override the _execute method\n # if they need to perform any logic in between the user's\n # call to tape.execute and the internal call to tape.execute_device.\n _execute = execute_device\n","path":"pennylane/tape/tape.py"}],"string":"[\n {\n \"content\": \"# Copyright 2018-2021 Xanadu Quantum Technologies Inc.\\n\\n# Licensed under the Apache License, Version 2.0 (the \\\"License\\\");\\n# you may not use this file except in compliance with the License.\\n# You may obtain a copy of the License at\\n\\n# http://www.apache.org/licenses/LICENSE-2.0\\n\\n# Unless required by applicable law or agreed to in writing, software\\n# distributed under the License is distributed on an \\\"AS IS\\\" BASIS,\\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\\n# See the License for the specific language governing permissions and\\n# limitations under the License.\\n\\\"\\\"\\\"\\nThis module contains the base quantum tape.\\n\\\"\\\"\\\"\\n# pylint: disable=too-many-instance-attributes,protected-access,too-many-branches,too-many-public-methods\\nfrom collections import Counter, deque\\nimport contextlib\\nimport copy\\nfrom threading import RLock\\n\\nimport numpy as np\\n\\nimport pennylane as qml\\nfrom pennylane.queuing import AnnotatedQueue, QueuingContext, QueuingError\\nfrom pennylane.operation import Sample\\n\\n# CV ops still need to support state preparation operations prior to any\\n# other operation for PennyLane-SF tests to pass.\\nSTATE_PREP_OPS = (\\n qml.BasisState,\\n qml.QubitStateVector,\\n # qml.CatState,\\n # qml.CoherentState,\\n # qml.FockDensityMatrix,\\n # qml.DisplacedSqueezedState,\\n # qml.FockState,\\n # qml.FockStateVector,\\n # qml.ThermalState,\\n # qml.GaussianState,\\n)\\n\\n\\nOPENQASM_GATES = {\\n \\\"CNOT\\\": \\\"cx\\\",\\n \\\"CZ\\\": \\\"cz\\\",\\n \\\"U3\\\": \\\"u3\\\",\\n \\\"U2\\\": \\\"u2\\\",\\n \\\"U1\\\": \\\"u1\\\",\\n \\\"Identity\\\": \\\"id\\\",\\n \\\"PauliX\\\": \\\"x\\\",\\n \\\"PauliY\\\": \\\"y\\\",\\n \\\"PauliZ\\\": \\\"z\\\",\\n \\\"Hadamard\\\": \\\"h\\\",\\n \\\"S\\\": \\\"s\\\",\\n \\\"S.inv\\\": \\\"sdg\\\",\\n \\\"T\\\": \\\"t\\\",\\n \\\"T.inv\\\": \\\"tdg\\\",\\n \\\"RX\\\": \\\"rx\\\",\\n \\\"RY\\\": \\\"ry\\\",\\n \\\"RZ\\\": \\\"rz\\\",\\n \\\"CRX\\\": \\\"crx\\\",\\n \\\"CRY\\\": \\\"cry\\\",\\n \\\"CRZ\\\": \\\"crz\\\",\\n \\\"SWAP\\\": \\\"swap\\\",\\n \\\"Toffoli\\\": \\\"ccx\\\",\\n \\\"CSWAP\\\": \\\"cswap\\\",\\n \\\"PhaseShift\\\": \\\"u1\\\",\\n}\\n\\\"\\\"\\\"\\ndict[str, str]: Maps PennyLane gate names to equivalent QASM gate names.\\n\\nNote that QASM has two native gates:\\n\\n- ``U`` (equivalent to :class:`~.U3`)\\n- ``CX`` (equivalent to :class:`~.CNOT`)\\n\\nAll other gates are defined in the file stdgates.inc:\\nhttps://github.com/Qiskit/openqasm/blob/master/examples/stdgates.inc\\n\\\"\\\"\\\"\\n\\n\\ndef get_active_tape():\\n \\\"\\\"\\\"Returns the currently recording tape.\\n If no tape is currently recording, ``None`` is returned.\\n\\n **Example**\\n\\n >>> with qml.tape.QuantumTape():\\n ... qml.RX(0.2, wires=\\\"a\\\")\\n ... tape = qml.get_active_tape()\\n ... qml.RY(0.1, wires=\\\"b\\\")\\n >>> print(tape)\\n <QuantumTape: wires=['a', 'b'], params=2>\\n >>> print(qml.tape.get_active_tape())\\n None\\n \\\"\\\"\\\"\\n return QueuingContext.active_context()\\n\\n\\ndef expand_tape(tape, depth=1, stop_at=None, expand_measurements=False):\\n \\\"\\\"\\\"Expand all objects in a tape to a specific depth.\\n\\n Args:\\n depth (int): the depth the tape should be expanded\\n stop_at (Callable): A function which accepts a queue object,\\n and returns ``True`` if this object should *not* be expanded.\\n If not provided, all objects that support expansion will be expanded.\\n expand_measurements (bool): If ``True``, measurements will be expanded\\n to basis rotations and computational basis measurements.\\n\\n **Example**\\n\\n Consider the following nested tape:\\n\\n .. code-block:: python\\n\\n with JacobianTape() as tape:\\n qml.BasisState(np.array([1, 1]), wires=[0, 'a'])\\n\\n with JacobianTape() as tape2:\\n qml.Rot(0.543, 0.1, 0.4, wires=0)\\n\\n qml.CNOT(wires=[0, 'a'])\\n qml.RY(0.2, wires='a')\\n qml.probs(wires=0), qml.probs(wires='a')\\n\\n The nested structure is preserved:\\n\\n >>> tape.operations\\n [BasisState(array([1, 1]), wires=[0, 'a']),\\n <JacobianTape: wires=[0], params=3>,\\n CNOT(wires=[0, 'a']),\\n RY(0.2, wires=['a'])]\\n\\n Calling ``expand_tape`` will return a tape with all nested tapes\\n expanded, resulting in a single tape of quantum operations:\\n\\n >>> new_tape = expand_tape(tape)\\n >>> new_tape.operations\\n [PauliX(wires=[0]),\\n PauliX(wires=['a']),\\n Rot(0.543, 0.1, 0.4, wires=[0]),\\n CNOT(wires=[0, 'a']),\\n RY(0.2, wires=['a'])]\\n \\\"\\\"\\\"\\n if depth == 0:\\n return tape\\n\\n if stop_at is None:\\n # by default expand all objects\\n stop_at = lambda obj: False\\n\\n new_tape = tape.__class__()\\n\\n # Check for observables acting on the same wire. If present, observables must be\\n # qubit-wise commuting Pauli words. In this case, the tape is expanded with joint\\n # rotations and the observables updated to the computational basis. Note that this\\n # expansion acts on the original tape in place.\\n if tape._obs_sharing_wires:\\n try:\\n rotations, diag_obs = qml.grouping.diagonalize_qwc_pauli_words(tape._obs_sharing_wires)\\n except ValueError as e:\\n raise qml.QuantumFunctionError(\\n \\\"Only observables that are qubit-wise commuting \\\"\\n \\\"Pauli words can be returned on the same wire\\\"\\n ) from e\\n\\n tape._ops.extend(rotations)\\n\\n for o, i in zip(diag_obs, tape._obs_sharing_wires_id):\\n new_m = qml.measure.MeasurementProcess(tape.measurements[i].return_type, obs=o)\\n tape._measurements[i] = new_m\\n\\n for queue in (\\\"_prep\\\", \\\"_ops\\\", \\\"_measurements\\\"):\\n for obj in getattr(tape, queue):\\n\\n stop = stop_at(obj)\\n\\n if not expand_measurements:\\n # Measurements should not be expanded; treat measurements\\n # as a stopping condition\\n stop = stop or isinstance(obj, qml.measure.MeasurementProcess)\\n\\n if stop:\\n # do not expand out the object; append it to the\\n # new tape, and continue to the next object in the queue\\n getattr(new_tape, queue).append(obj)\\n continue\\n\\n if isinstance(obj, (qml.operation.Operation, qml.measure.MeasurementProcess)):\\n # Object is an operation; query it for its expansion\\n try:\\n obj = obj.expand()\\n except NotImplementedError:\\n # Object does not define an expansion; treat this as\\n # a stopping condition.\\n getattr(new_tape, queue).append(obj)\\n continue\\n\\n # recursively expand out the newly created tape\\n expanded_tape = expand_tape(obj, stop_at=stop_at, depth=depth - 1)\\n\\n new_tape._prep += expanded_tape._prep\\n new_tape._ops += expanded_tape._ops\\n new_tape._measurements += expanded_tape._measurements\\n\\n # Update circuit info\\n new_tape._update_circuit_info()\\n return new_tape\\n\\n\\n# pylint: disable=too-many-public-methods\\nclass QuantumTape(AnnotatedQueue):\\n \\\"\\\"\\\"A quantum tape recorder, that records, validates and executes variational quantum programs.\\n\\n Args:\\n name (str): a name given to the quantum tape\\n do_queue (bool): Whether to queue this tape in a parent tape context.\\n\\n **Example**\\n\\n .. code-block:: python\\n\\n import pennylane.tape\\n\\n with qml.tape.QuantumTape() as tape:\\n qml.RX(0.432, wires=0)\\n qml.RY(0.543, wires=0)\\n qml.CNOT(wires=[0, 'a'])\\n qml.RX(0.133, wires='a')\\n qml.expval(qml.PauliZ(wires=[0]))\\n\\n Once constructed, information about the quantum circuit can be queried:\\n\\n >>> tape.operations\\n [RX(0.432, wires=[0]), RY(0.543, wires=[0]), CNOT(wires=[0, 'a']), RX(0.133, wires=['a'])]\\n >>> tape.observables\\n [expval(PauliZ(wires=[0]))]\\n >>> tape.get_parameters()\\n [0.432, 0.543, 0.133]\\n >>> tape.wires\\n <Wires = [0, 'a']>\\n >>> tape.num_params\\n 3\\n\\n The :class:`~.CircuitGraph` can also be accessed:\\n\\n >>> tape.graph\\n <pennylane.circuit_graph.CircuitGraph object at 0x7fcc0433a690>\\n\\n Once constructed, the quantum tape can be executed directly on a supported\\n device:\\n\\n >>> dev = qml.device(\\\"default.qubit\\\", wires=[0, 'a'])\\n\\n Execution can take place either using the in-place constructed parameters,\\n\\n >>> tape.execute(dev)\\n [0.77750694]\\n\\n or by providing parameters at run time:\\n\\n >>> tape.execute(dev, params=[0.1, 0.1, 0.1])\\n [0.99003329]\\n\\n The trainable parameters of the tape can be explicitly set, and the values of\\n the parameters modified in-place:\\n\\n >>> tape.trainable_params = {0} # set only the first parameter as free\\n >>> tape.set_parameters(0.56)\\n >>> tape.get_parameters()\\n [0.56]\\n >>> tape.get_parameters(trainable_only=False)\\n [0.56, 0.543, 0.133]\\n\\n\\n When using a tape with ``do_queue=False``, that tape will not be queued in a parent tape context.\\n\\n .. code-block:: python\\n\\n with qml.tape.QuantumTape() as tape1:\\n with qml.tape.QuantumTape(do_queue=False) as tape2:\\n qml.RX(0.123, wires=0)\\n\\n Here, tape2 records the RX gate, but tape1 doesn't record tape2.\\n\\n >>> tape1.operations\\n []\\n >>> tape2.operations\\n [RX(0.123, wires=[0])]\\n\\n This is useful for when you want to transform a tape first before applying it.\\n \\\"\\\"\\\"\\n\\n _lock = RLock()\\n \\\"\\\"\\\"threading.RLock: Used to synchronize appending to/popping from global QueueingContext.\\\"\\\"\\\"\\n\\n def __init__(self, name=None, do_queue=True):\\n super().__init__()\\n self.name = name\\n self.do_queue = do_queue\\n self._prep = []\\n \\\"\\\"\\\"list[.Operation]: Tape state preparations.\\\"\\\"\\\"\\n\\n self._ops = []\\n \\\"\\\"\\\"list[.Operation]: quantum operations recorded by the tape.\\\"\\\"\\\"\\n\\n self._measurements = []\\n \\\"\\\"\\\"list[.MeasurementProcess]: measurement processes recorded by the tape.\\\"\\\"\\\"\\n\\n self._par_info = {}\\n \\\"\\\"\\\"dict[int, dict[str, Operation or int]]: Parameter information. Keys are\\n parameter indices (in the order they appear on the tape), and values are a\\n dictionary containing the corresponding operation and operation parameter index.\\\"\\\"\\\"\\n\\n self._trainable_params = set()\\n self._graph = None\\n self._resources = None\\n self._depth = None\\n self._output_dim = 0\\n\\n self.wires = qml.wires.Wires([])\\n self.num_wires = 0\\n\\n self.is_sampled = False\\n self.all_sampled = False\\n self.inverse = False\\n\\n self._obs_sharing_wires = []\\n \\\"\\\"\\\"list[.Observable]: subset of the observables that share wires with another observable,\\n i.e., that do not have their own unique set of wires.\\\"\\\"\\\"\\n self._obs_sharing_wires_id = []\\n\\n def __repr__(self):\\n return f\\\"<{self.__class__.__name__}: wires={self.wires.tolist()}, params={self.num_params}>\\\"\\n\\n def __enter__(self):\\n QuantumTape._lock.acquire()\\n try:\\n if self.do_queue:\\n QueuingContext.append(self)\\n return super().__enter__()\\n except Exception as _:\\n QuantumTape._lock.release()\\n raise\\n\\n def __exit__(self, exception_type, exception_value, traceback):\\n try:\\n super().__exit__(exception_type, exception_value, traceback)\\n self._process_queue()\\n finally:\\n QuantumTape._lock.release()\\n\\n @property\\n def interface(self):\\n \\\"\\\"\\\"str, None: automatic differentiation interface used by the quantum tape (if any)\\\"\\\"\\\"\\n return None\\n\\n @contextlib.contextmanager\\n def stop_recording(self):\\n \\\"\\\"\\\"Context manager to temporarily stop recording operations\\n onto the tape. This is useful is scratch space is needed.\\n\\n **Example**\\n\\n >>> with qml.tape.QuantumTape() as tape:\\n ... qml.RX(0, wires=0)\\n ... with tape.stop_recording():\\n ... qml.RY(1.0, wires=1)\\n ... qml.RZ(2, wires=1)\\n >>> tape.operations\\n [RX(0, wires=[0]), RZ(2, wires=[1])]\\n \\\"\\\"\\\"\\n if QueuingContext.active_context() is not self:\\n raise QueuingError(\\n \\\"Cannot stop recording requested tape \\\" \\\"as it is not currently recording.\\\"\\n )\\n\\n active_contexts = QueuingContext._active_contexts\\n QueuingContext._active_contexts = deque()\\n yield\\n QueuingContext._active_contexts = active_contexts\\n\\n # ========================================================\\n # construction methods\\n # ========================================================\\n\\n def _process_queue(self):\\n \\\"\\\"\\\"Process the annotated queue, creating a list of quantum\\n operations and measurement processes.\\n\\n This method sets the following attributes:\\n\\n * ``_ops``\\n * ``_measurements``\\n * ``_par_info``\\n * ``_output_dim``\\n * ``_trainable_params``\\n * ``is_sampled``\\n \\\"\\\"\\\"\\n self._prep = []\\n self._ops = []\\n self._measurements = []\\n self._output_dim = 0\\n\\n for obj, info in self._queue.items():\\n\\n if isinstance(obj, QuantumTape):\\n self._ops.append(obj)\\n\\n elif isinstance(obj, qml.operation.Operation) and not info.get(\\\"owner\\\", False):\\n # operation objects with no owners\\n\\n if self._measurements:\\n raise ValueError(\\n f\\\"Quantum operation {obj} must occur prior to any measurements.\\\"\\n )\\n\\n # invert the operation if required\\n obj.inverse = info.get(\\\"inverse\\\", False)\\n\\n if isinstance(obj, STATE_PREP_OPS):\\n if self._ops:\\n raise ValueError(\\n f\\\"State preparation operation {obj} must occur prior to any quantum operations.\\\"\\n )\\n\\n self._prep.append(obj)\\n else:\\n self._ops.append(obj)\\n\\n elif isinstance(obj, qml.measure.MeasurementProcess):\\n # measurement process\\n self._measurements.append(obj)\\n\\n # attempt to infer the output dimension\\n if obj.return_type is qml.operation.Probability:\\n self._output_dim += 2 ** len(obj.wires)\\n elif obj.return_type is qml.operation.State:\\n continue # the output_dim is worked out automatically\\n else:\\n self._output_dim += 1\\n\\n # check if any sampling is occuring\\n if obj.return_type is qml.operation.Sample:\\n self.is_sampled = True\\n\\n elif isinstance(obj, qml.operation.Observable) and \\\"owner\\\" not in info:\\n raise ValueError(f\\\"Observable {obj} does not have a measurement type specified.\\\")\\n\\n self._update()\\n\\n def _update_circuit_info(self):\\n \\\"\\\"\\\"Update circuit metadata\\\"\\\"\\\"\\n self.wires = qml.wires.Wires.all_wires(\\n [op.wires for op in self.operations + self.observables]\\n )\\n self.num_wires = len(self.wires)\\n\\n self.is_sampled = any(m.return_type is Sample for m in self.measurements)\\n self.all_sampled = all(m.return_type is Sample for m in self.measurements)\\n self.is_sampled = any(m.return_type is Sample for m in self.measurements)\\n\\n def _update_observables(self):\\n \\\"\\\"\\\"Update information about observables, including the wires that are acted upon and\\n identifying any observables that share wires\\\"\\\"\\\"\\n obs_wires = [wire for m in self.measurements for wire in m.wires if m.obs is not None]\\n self._obs_sharing_wires = []\\n self._obs_sharing_wires_id = []\\n\\n if len(obs_wires) != len(set(obs_wires)):\\n c = Counter(obs_wires)\\n repeated_wires = {w for w in obs_wires if c[w] > 1}\\n\\n for i, m in enumerate(self.measurements):\\n if m.obs is not None:\\n if len(set(m.wires) & repeated_wires) > 0:\\n self._obs_sharing_wires.append(m.obs)\\n self._obs_sharing_wires_id.append(i)\\n\\n def _update_par_info(self):\\n \\\"\\\"\\\"Update the parameter information dictionary\\\"\\\"\\\"\\n param_count = 0\\n\\n for obj in self.operations + self.observables:\\n\\n for p in range(len(obj.data)):\\n info = self._par_info.get(param_count, {})\\n info.update({\\\"op\\\": obj, \\\"p_idx\\\": p})\\n\\n self._par_info[param_count] = info\\n param_count += 1\\n\\n def _update_trainable_params(self):\\n \\\"\\\"\\\"Set the trainable parameters\\\"\\\"\\\"\\n self._trainable_params = set(self._par_info)\\n\\n def _update(self):\\n \\\"\\\"\\\"Update all internal tape metadata regarding processed operations and observables\\\"\\\"\\\"\\n self._graph = None\\n self._resources = None\\n self._depth = None\\n self._update_circuit_info()\\n self._update_par_info()\\n self._update_trainable_params()\\n self._update_observables()\\n\\n def expand(self, depth=1, stop_at=None, expand_measurements=False):\\n \\\"\\\"\\\"Expand all operations in the processed queue to a specific depth.\\n\\n Args:\\n depth (int): the depth the tape should be expanded\\n stop_at (Callable): A function which accepts a queue object,\\n and returns ``True`` if this object should *not* be expanded.\\n If not provided, all objects that support expansion will be expanded.\\n expand_measurements (bool): If ``True``, measurements will be expanded\\n to basis rotations and computational basis measurements.\\n\\n **Example**\\n\\n Consider the following nested tape:\\n\\n .. code-block:: python\\n\\n with JacobianTape() as tape:\\n qml.BasisState(np.array([1, 1]), wires=[0, 'a'])\\n\\n with JacobianTape() as tape2:\\n qml.Rot(0.543, 0.1, 0.4, wires=0)\\n\\n qml.CNOT(wires=[0, 'a'])\\n qml.RY(0.2, wires='a')\\n qml.probs(wires=0), qml.probs(wires='a')\\n\\n The nested structure is preserved:\\n\\n >>> tape.operations\\n [BasisState(array([1, 1]), wires=[0, 'a']),\\n <JacobianTape: wires=[0], params=3>,\\n CNOT(wires=[0, 'a']),\\n RY(0.2, wires=['a'])]\\n\\n Calling ``.expand`` will return a tape with all nested tapes\\n expanded, resulting in a single tape of quantum operations:\\n\\n >>> new_tape = tape.expand()\\n >>> new_tape.operations\\n [PauliX(wires=[0]),\\n PauliX(wires=['a']),\\n Rot(0.543, 0.1, 0.4, wires=[0]),\\n CNOT(wires=[0, 'a']),\\n RY(0.2, wires=['a'])]\\n \\\"\\\"\\\"\\n new_tape = expand_tape(\\n self, depth=depth, stop_at=stop_at, expand_measurements=expand_measurements\\n )\\n new_tape._update()\\n return new_tape\\n\\n def inv(self):\\n \\\"\\\"\\\"Inverts the processed operations.\\n\\n Inversion is performed in-place.\\n\\n .. note::\\n\\n This method only inverts the quantum operations/unitary recorded\\n by the quantum tape; state preparations and measurements are left unchanged.\\n\\n **Example**\\n\\n .. code-block:: python\\n\\n with JacobianTape() as tape:\\n qml.BasisState(np.array([1, 1]), wires=[0, 'a'])\\n qml.RX(0.432, wires=0)\\n qml.Rot(0.543, 0.1, 0.4, wires=0).inv()\\n qml.CNOT(wires=[0, 'a'])\\n qml.probs(wires=0), qml.probs(wires='a')\\n\\n This tape has the following properties:\\n\\n >>> tape.operations\\n [BasisState(array([1, 1]), wires=[0, 'a']),\\n RX(0.432, wires=[0]),\\n Rot.inv(0.543, 0.1, 0.4, wires=[0]),\\n CNOT(wires=[0, 'a'])]\\n >>> tape.get_parameters()\\n [array([1, 1]), 0.432, 0.543, 0.1, 0.4]\\n\\n Here, let's set some trainable parameters:\\n\\n >>> tape.trainable_params = {1, 2}\\n >>> tape.get_parameters()\\n [0.432, 0.543]\\n\\n Inverting the tape:\\n\\n >>> tape.inv()\\n >>> tape.operations\\n [BasisState(array([1, 1]), wires=[0, 'a']),\\n CNOT.inv(wires=[0, 'a']),\\n Rot(0.543, 0.1, 0.4, wires=[0]),\\n RX.inv(0.432, wires=[0])]\\n\\n Tape inversion also modifies the order of tape parameters:\\n\\n >>> tape.get_parameters(trainable_only=False)\\n [array([1, 1]), 0.543, 0.1, 0.4, 0.432]\\n >>> tape.get_parameters(trainable_only=True)\\n [0.543, 0.432]\\n >>> tape.trainable_params\\n {1, 4}\\n \\\"\\\"\\\"\\n # we must remap the old parameter\\n # indices to the new ones after the operation order is reversed.\\n parameter_indices = []\\n param_count = 0\\n\\n for queue in [self._prep, self._ops, self.observables]:\\n # iterate through all queues\\n\\n obj_params = []\\n\\n for obj in queue:\\n # index the number of parameters on each operation\\n num_obj_params = len(obj.data)\\n obj_params.append(list(range(param_count, param_count + num_obj_params)))\\n\\n # keep track of the total number of parameters encountered so far\\n param_count += num_obj_params\\n\\n if queue == self._ops:\\n # reverse the list representing operator parameters\\n obj_params = obj_params[::-1]\\n\\n parameter_indices.extend(obj_params)\\n\\n # flatten the list of parameter indices after the reversal\\n parameter_indices = [item for sublist in parameter_indices for item in sublist]\\n parameter_mapping = dict(zip(parameter_indices, range(len(parameter_indices))))\\n\\n # map the params\\n self.trainable_params = {parameter_mapping[i] for i in self.trainable_params}\\n self._par_info = {parameter_mapping[k]: v for k, v in self._par_info.items()}\\n\\n for op in self._ops:\\n op.inverse = not op.inverse\\n\\n self._ops = list(reversed(self._ops))\\n\\n # ========================================================\\n # Parameter handling\\n # ========================================================\\n\\n @property\\n def trainable_params(self):\\n \\\"\\\"\\\"Store or return a set containing the indices of parameters that support\\n differentiability. The indices provided match the order of appearence in the\\n quantum circuit.\\n\\n Setting this property can help reduce the number of quantum evaluations needed\\n to compute the Jacobian; parameters not marked as trainable will be\\n automatically excluded from the Jacobian computation.\\n\\n The number of trainable parameters determines the number of parameters passed to\\n :meth:`~.set_parameters`, :meth:`~.execute`, and :meth:`~.JacobianTape.jacobian`,\\n and changes the default output size of methods :meth:`~.JacobianTape.jacobian` and\\n :meth:`~.get_parameters()`.\\n\\n .. note::\\n\\n Since the :meth:`~.JacobianTape.jacobian` method is not called for devices that support\\n native backpropagation (such as ``default.qubit.tf`` and ``default.qubit.autograd``),\\n this property contains no relevant information when using backpropagation to compute gradients.\\n\\n **Example**\\n\\n .. code-block:: python\\n\\n with JacobianTape() as tape:\\n qml.RX(0.432, wires=0)\\n qml.RY(0.543, wires=0)\\n qml.CNOT(wires=[0, 'a'])\\n qml.RX(0.133, wires='a')\\n qml.expval(qml.PauliZ(wires=[0]))\\n\\n >>> tape.trainable_params\\n {0, 1, 2}\\n >>> tape.trainable_params = {0} # set only the first parameter as free\\n >>> tape.get_parameters()\\n [0.432]\\n\\n Args:\\n param_indices (set[int]): parameter indices\\n \\\"\\\"\\\"\\n return self._trainable_params\\n\\n @trainable_params.setter\\n def trainable_params(self, param_indices):\\n \\\"\\\"\\\"Store the indices of parameters that support differentiability.\\n\\n Args:\\n param_indices (set[int]): parameter indices\\n \\\"\\\"\\\"\\n if any(not isinstance(i, int) or i < 0 for i in param_indices):\\n raise ValueError(\\\"Argument indices must be positive integers.\\\")\\n\\n if any(i > len(self._par_info) for i in param_indices):\\n raise ValueError(f\\\"Tape has at most {self.num_params} parameters.\\\")\\n\\n self._trainable_params = param_indices\\n\\n def get_parameters(self, trainable_only=True, **kwargs): # pylint:disable=unused-argument\\n \\\"\\\"\\\"Return the parameters incident on the tape operations.\\n\\n The returned parameters are provided in order of appearance\\n on the tape.\\n\\n Args:\\n trainable_only (bool): if True, returns only trainable parameters\\n\\n **Example**\\n\\n .. code-block:: python\\n\\n with JacobianTape() as tape:\\n qml.RX(0.432, wires=0)\\n qml.RY(0.543, wires=0)\\n qml.CNOT(wires=[0, 'a'])\\n qml.RX(0.133, wires='a')\\n qml.expval(qml.PauliZ(wires=[0]))\\n\\n By default, all parameters are trainable and will be returned:\\n\\n >>> tape.get_parameters()\\n [0.432, 0.543, 0.133]\\n\\n Setting the trainable parameter indices will result in only the specified\\n parameters being returned:\\n\\n >>> tape.trainable_params = {1} # set the second parameter as free\\n >>> tape.get_parameters()\\n [0.543]\\n\\n The ``trainable_only`` argument can be set to ``False`` to instead return\\n all parameters:\\n\\n >>> tape.get_parameters(trainable_only=False)\\n [0.432, 0.543, 0.133]\\n \\\"\\\"\\\"\\n params = []\\n iterator = self.trainable_params if trainable_only else self._par_info\\n\\n for p_idx in iterator:\\n op = self._par_info[p_idx][\\\"op\\\"]\\n op_idx = self._par_info[p_idx][\\\"p_idx\\\"]\\n params.append(op.data[op_idx])\\n\\n return params\\n\\n def set_parameters(self, params, trainable_only=True):\\n \\\"\\\"\\\"Set the parameters incident on the tape operations.\\n\\n Args:\\n params (list[float]): A list of real numbers representing the\\n parameters of the quantum operations. The parameters should be\\n provided in order of appearance in the quantum tape.\\n trainable_only (bool): if True, set only trainable parameters\\n\\n **Example**\\n\\n .. code-block:: python\\n\\n with JacobianTape() as tape:\\n qml.RX(0.432, wires=0)\\n qml.RY(0.543, wires=0)\\n qml.CNOT(wires=[0, 'a'])\\n qml.RX(0.133, wires='a')\\n qml.expval(qml.PauliZ(wires=[0]))\\n\\n By default, all parameters are trainable and can be modified:\\n\\n >>> tape.set_parameters([0.1, 0.2, 0.3])\\n >>> tape.get_parameters()\\n [0.1, 0.2, 0.3]\\n\\n Setting the trainable parameter indices will result in only the specified\\n parameters being modifiable. Note that this only modifies the number of\\n parameters that must be passed.\\n\\n >>> tape.trainable_params = {0, 2} # set the first and third parameter as free\\n >>> tape.set_parameters([-0.1, 0.5])\\n >>> tape.get_parameters(trainable_only=False)\\n [-0.1, 0.2, 0.5]\\n\\n The ``trainable_only`` argument can be set to ``False`` to instead set\\n all parameters:\\n\\n >>> tape.set_parameters([4, 1, 6], trainable_only=False)\\n >>> tape.get_parameters(trainable_only=False)\\n [4, 1, 6]\\n \\\"\\\"\\\"\\n if trainable_only:\\n iterator = zip(self.trainable_params, params)\\n required_length = self.num_params\\n else:\\n iterator = enumerate(params)\\n required_length = len(self._par_info)\\n\\n if len(params) != required_length:\\n raise ValueError(\\\"Number of provided parameters does not match.\\\")\\n\\n for idx, p in iterator:\\n op = self._par_info[idx][\\\"op\\\"]\\n op.data[self._par_info[idx][\\\"p_idx\\\"]] = p\\n\\n # ========================================================\\n # Tape properties\\n # ========================================================\\n\\n @property\\n def operations(self):\\n \\\"\\\"\\\"Returns the operations on the quantum tape.\\n\\n Returns:\\n list[.Operation]: recorded quantum operations\\n\\n **Example**\\n\\n .. code-block:: python\\n\\n with JacobianTape() as tape:\\n qml.RX(0.432, wires=0)\\n qml.RY(0.543, wires=0)\\n qml.CNOT(wires=[0, 'a'])\\n qml.RX(0.133, wires='a')\\n qml.expval(qml.PauliZ(wires=[0]))\\n\\n >>> tape.operations\\n [RX(0.432, wires=[0]), RY(0.543, wires=[0]), CNOT(wires=[0, 'a']), RX(0.133, wires=['a'])]\\n \\\"\\\"\\\"\\n return self._prep + self._ops\\n\\n @property\\n def observables(self):\\n \\\"\\\"\\\"Returns the observables on the quantum tape.\\n\\n Returns:\\n list[.Observable]: list of recorded quantum operations\\n\\n **Example**\\n\\n .. code-block:: python\\n\\n with JacobianTape() as tape:\\n qml.RX(0.432, wires=0)\\n qml.RY(0.543, wires=0)\\n qml.CNOT(wires=[0, 'a'])\\n qml.RX(0.133, wires='a')\\n qml.expval(qml.PauliZ(wires=[0]))\\n\\n >>> tape.observables\\n [expval(PauliZ(wires=[0]))]\\n \\\"\\\"\\\"\\n # TODO: modify this property once devices\\n # have been refactored to accept and understand recieving\\n # measurement processes rather than specific observables.\\n obs = []\\n\\n for m in self._measurements:\\n if m.obs is not None:\\n m.obs.return_type = m.return_type\\n obs.append(m.obs)\\n else:\\n obs.append(m)\\n\\n return obs\\n\\n @property\\n def measurements(self):\\n \\\"\\\"\\\"Returns the measurements on the quantum tape.\\n\\n Returns:\\n list[.MeasurementProcess]: list of recorded measurement processess\\n\\n **Example**\\n\\n .. code-block:: python\\n\\n with JacobianTape() as tape:\\n qml.RX(0.432, wires=0)\\n qml.RY(0.543, wires=0)\\n qml.CNOT(wires=[0, 'a'])\\n qml.RX(0.133, wires='a')\\n qml.expval(qml.PauliZ(wires=[0]))\\n\\n >>> tape.measurements\\n [<pennylane.tape.measure.MeasurementProcess object at 0x7f10b2150c10>]\\n \\\"\\\"\\\"\\n return self._measurements\\n\\n @property\\n def num_params(self):\\n \\\"\\\"\\\"Returns the number of trainable parameters on the quantum tape.\\\"\\\"\\\"\\n return len(self.trainable_params)\\n\\n @property\\n def output_dim(self):\\n \\\"\\\"\\\"The (inferred) output dimension of the quantum tape.\\\"\\\"\\\"\\n return self._output_dim\\n\\n @property\\n def diagonalizing_gates(self):\\n \\\"\\\"\\\"Returns the gates that diagonalize the measured wires such that they\\n are in the eigenbasis of the circuit observables.\\n\\n Returns:\\n List[~.Operation]: the operations that diagonalize the observables\\n \\\"\\\"\\\"\\n rotation_gates = []\\n\\n for observable in self.observables:\\n rotation_gates.extend(observable.diagonalizing_gates())\\n\\n return rotation_gates\\n\\n @property\\n def graph(self):\\n \\\"\\\"\\\"Returns a directed acyclic graph representation of the recorded\\n quantum circuit:\\n\\n >>> tape.graph\\n <pennylane.circuit_graph.CircuitGraph object at 0x7fcc0433a690>\\n\\n Note that the circuit graph is only constructed once, on first call to this property,\\n and cached for future use.\\n\\n Returns:\\n .CircuitGraph: the circuit graph object\\n \\\"\\\"\\\"\\n if self._graph is None:\\n self._graph = qml.CircuitGraph(\\n self.operations, self.observables, self.wires, self._par_info, self.trainable_params\\n )\\n\\n return self._graph\\n\\n def get_resources(self):\\n \\\"\\\"\\\"Resource requirements of a quantum circuit.\\n\\n Returns:\\n dict[str, int]: how many times constituent operations are applied\\n\\n **Example**\\n\\n .. code-block:: python3\\n\\n with qml.tape.QuantumTape() as tape:\\n qml.Hadamard(wires=0)\\n qml.RZ(0.26, wires=1)\\n qml.CNOT(wires=[1, 0])\\n qml.Rot(1.8, -2.7, 0.2, wires=0)\\n qml.Hadamard(wires=1)\\n qml.CNOT(wires=[0, 1])\\n qml.expval(qml.PauliZ(0) @ qml.PauliZ(1))\\n\\n Asking for the resources produces a dictionary as shown below:\\n\\n >>> tape.get_resources()\\n {'Hadamard': 2, 'RZ': 1, 'CNOT': 2, 'Rot': 1}\\n \\\"\\\"\\\"\\n if self._resources is None:\\n self._resources = {}\\n\\n for op in self.operations:\\n if op.name not in self._resources.keys():\\n self._resources[op.name] = 1\\n else:\\n self._resources[op.name] += 1\\n\\n return self._resources\\n\\n def get_depth(self):\\n \\\"\\\"\\\"Depth of the quantum circuit.\\n\\n Returns:\\n int: Circuit depth, computed as the longest path in the circuit's directed acyclic graph representation.\\n\\n **Example**\\n\\n .. code-block:: python3\\n\\n with QuantumTape() as tape:\\n qml.Hadamard(wires=0)\\n qml.PauliX(wires=1)\\n qml.CRX(2.3, wires=[0, 1])\\n qml.Rot(1.2, 3.2, 0.7, wires=[1])\\n qml.CRX(-2.3, wires=[0, 1])\\n qml.expval(qml.PauliZ(0) @ qml.PauliZ(1))\\n\\n The depth can be obtained like so:\\n\\n >>> tape.get_depth()\\n 4\\n \\\"\\\"\\\"\\n if self._depth is None:\\n self._depth = self.graph.get_depth()\\n\\n return self._depth\\n\\n def draw(self, charset=\\\"unicode\\\", wire_order=None, show_all_wires=False):\\n \\\"\\\"\\\"Draw the quantum tape as a circuit diagram.\\n\\n Consider the following circuit as an example:\\n\\n .. code-block:: python3\\n\\n with QuantumTape() as tape:\\n qml.Hadamard(0)\\n qml.CRX(2.3, wires=[0, 1])\\n qml.Rot(1.2, 3.2, 0.7, wires=[1])\\n qml.CRX(-2.3, wires=[0, 1])\\n qml.expval(qml.PauliZ(0) @ qml.PauliZ(1))\\n\\n We can draw the tape after construction:\\n\\n >>> print(tape.draw())\\n 0: ──H──╭C────────────────────────────╭C─────────╭┤ ⟨Z ⊗ Z⟩\\n 1: ─────╰RX(2.3)──Rot(1.2, 3.2, 0.7)──╰RX(-2.3)──╰┤ ⟨Z ⊗ Z⟩\\n >>> print(tape.draw(charset=\\\"ascii\\\"))\\n 0: --H--+C----------------------------+C---------+| <Z @ Z>\\n 1: -----+RX(2.3)--Rot(1.2, 3.2, 0.7)--+RX(-2.3)--+| <Z @ Z>\\n\\n Args:\\n charset (str, optional): The charset that should be used. Currently, \\\"unicode\\\" and\\n \\\"ascii\\\" are supported.\\n wire_order (Sequence[Any]): the order (from top to bottom) to print the wires of the circuit\\n show_all_wires (bool): If True, all wires, including empty wires, are printed.\\n\\n Raises:\\n ValueError: if the given charset is not supported\\n\\n Returns:\\n str: the circuit representation of the tape\\n \\\"\\\"\\\"\\n return self.graph.draw(\\n charset=charset,\\n wire_order=wire_order,\\n show_all_wires=show_all_wires,\\n )\\n\\n def to_openqasm(self, wires=None, rotations=True):\\n \\\"\\\"\\\"Serialize the circuit as an OpenQASM 2.0 program.\\n\\n Only operations are serialized; all measurements\\n are assumed to take place in the computational basis.\\n\\n .. note::\\n\\n The serialized OpenQASM program assumes that gate definitions\\n in ``qelib1.inc`` are available.\\n\\n Args:\\n wires (Wires or None): the wires to use when serializing the circuit\\n rotations (bool): in addition to serializing user-specified\\n operations, also include the gates that diagonalize the\\n measured wires such that they are in the eigenbasis of the circuit observables.\\n\\n Returns:\\n str: OpenQASM serialization of the circuit\\n \\\"\\\"\\\"\\n # We import decompose_queue here to avoid a circular import\\n wires = wires or self.wires\\n\\n # add the QASM headers\\n qasm_str = \\\"OPENQASM 2.0;\\\\n\\\"\\n qasm_str += 'include \\\"qelib1.inc\\\";\\\\n'\\n\\n if self.num_wires == 0:\\n # empty circuit\\n return qasm_str\\n\\n # create the quantum and classical registers\\n qasm_str += \\\"qreg q[{}];\\\\n\\\".format(len(wires))\\n qasm_str += \\\"creg c[{}];\\\\n\\\".format(len(wires))\\n\\n # get the user applied circuit operations\\n operations = self.operations\\n\\n if rotations:\\n # if requested, append diagonalizing gates corresponding\\n # to circuit observables\\n operations += self.diagonalizing_gates\\n\\n with QuantumTape() as tape:\\n for op in operations:\\n op.queue()\\n\\n if op.inverse:\\n op.inv()\\n\\n # decompose the queue\\n operations = tape.expand(depth=2, stop_at=lambda obj: obj.name in OPENQASM_GATES).operations\\n\\n # create the QASM code representing the operations\\n for op in operations:\\n try:\\n gate = OPENQASM_GATES[op.name]\\n except KeyError as e:\\n raise ValueError(f\\\"Operation {op.name} not supported by the QASM serializer\\\") from e\\n\\n wire_labels = \\\",\\\".join([f\\\"q[{wires.index(w)}]\\\" for w in op.wires.tolist()])\\n params = \\\"\\\"\\n\\n if op.num_params > 0:\\n # If the operation takes parameters, construct a string\\n # with parameter values.\\n params = \\\"(\\\" + \\\",\\\".join([str(p) for p in op.parameters]) + \\\")\\\"\\n\\n qasm_str += \\\"{name}{params} {wires};\\\\n\\\".format(\\n name=gate, params=params, wires=wire_labels\\n )\\n\\n # apply computational basis measurements to each quantum register\\n # NOTE: This is not strictly necessary, we could inspect self.observables,\\n # and then only measure wires which are requested by the user. However,\\n # some devices which consume QASM require all registers be measured, so\\n # measure all wires to be safe.\\n for wire in range(len(wires)):\\n qasm_str += \\\"measure q[{wire}] -> c[{wire}];\\\\n\\\".format(wire=wire)\\n\\n return qasm_str\\n\\n @property\\n def data(self):\\n \\\"\\\"\\\"Alias to :meth:`~.get_parameters` and :meth:`~.set_parameters`\\n for backwards compatibilities with operations.\\\"\\\"\\\"\\n return self.get_parameters(trainable_only=False)\\n\\n @data.setter\\n def data(self, params):\\n self.set_parameters(params, trainable_only=False)\\n\\n def copy(self, copy_operations=False, tape_cls=None):\\n \\\"\\\"\\\"Returns a shallow copy of the quantum tape.\\n\\n Args:\\n copy_operations (bool): If True, the tape operations are also shallow copied.\\n Otherwise, if False, the copied tape operations will simply be references\\n to the original tape operations; changing the parameters of one tape will likewise\\n change the parameters of all copies.\\n tape_cls (.QuantumTape): Cast the copied tape to a specific quantum tape subclass.\\n If not provided, the same subclass is used as the original tape.\\n\\n Returns:\\n .QuantumTape: a shallow copy of the tape\\n \\\"\\\"\\\"\\n if tape_cls is None:\\n tape = self.__class__()\\n else:\\n tape = tape_cls()\\n\\n if copy_operations:\\n # Perform a shallow copy of all operations in the state prep, operation, and measurement\\n # queues. The operations will continue to share data with the original tape operations\\n # unless modified.\\n tape._prep = [copy.copy(op) for op in self._prep]\\n tape._ops = [copy.copy(op) for op in self._ops]\\n tape._measurements = [copy.copy(op) for op in self._measurements]\\n else:\\n # Perform a shallow copy of the state prep, operation, and measurement queues. The\\n # operations within the queues will be references to the original tape operations;\\n # changing the original operations will always alter the operations on the copied tape.\\n tape._prep = self._prep.copy()\\n tape._ops = self._ops.copy()\\n tape._measurements = self._measurements.copy()\\n\\n tape._update()\\n tape.trainable_params = self.trainable_params.copy()\\n\\n return tape\\n\\n def __copy__(self):\\n return self.copy(copy_operations=True)\\n\\n # ========================================================\\n # execution methods\\n # ========================================================\\n\\n def execute(self, device, params=None):\\n \\\"\\\"\\\"Execute the tape on a quantum device.\\n\\n Args:\\n device (.Device): a PennyLane device\\n that can execute quantum operations and return measurement statistics\\n params (list[Any]): The quantum tape operation parameters. If not provided,\\n the current tape parameters are used (via :meth:`~.get_parameters`).\\n\\n **Example**\\n\\n .. code-block:: python\\n\\n with JacobianTape() as tape:\\n qml.RX(0.432, wires=0)\\n qml.RY(0.543, wires=0)\\n qml.CNOT(wires=[0, 'a'])\\n qml.RX(0.133, wires='a')\\n qml.probs(wires=[0, 'a'])\\n\\n If parameters are not provided, the existing tape parameters are used:\\n\\n >>> dev = qml.device(\\\"default.qubit\\\", wires=[0, 'a'])\\n >>> tape.execute(dev)\\n array([[8.84828969e-01, 3.92449987e-03, 4.91235209e-04, 1.10755296e-01]])\\n\\n Parameters can be optionally passed during execution:\\n\\n >>> tape.execute(dev, params=[1.0, 0.0, 1.0])\\n array([[0.5931328 , 0.17701835, 0.05283049, 0.17701835]])\\n\\n Parameters provided for execution are temporary, and do not affect\\n the tapes' parameters in-place:\\n\\n >>> tape.get_parameters()\\n [0.432, 0.543, 0.133]\\n \\\"\\\"\\\"\\n if params is None:\\n params = self.get_parameters()\\n\\n return self._execute(params, device=device)\\n\\n def execute_device(self, params, device):\\n \\\"\\\"\\\"Execute the tape on a quantum device.\\n\\n This is a low-level method, intended to be called by an interface,\\n and does not support autodifferentiation.\\n\\n For more details on differentiable tape execution, see :meth:`~.execute`.\\n\\n Args:\\n device (~.Device): a PennyLane device\\n that can execute quantum operations and return measurement statistics\\n params (list[Any]): The quantum tape operation parameters. If not provided,\\n the current tape parameter values are used (via :meth:`~.get_parameters`).\\n \\\"\\\"\\\"\\n if not all(len(o.diagonalizing_gates()) == 0 for o in self._obs_sharing_wires):\\n raise qml.QuantumFunctionError(\\n \\\"Multiple observables are being evaluated on the same wire. Call tape.expand() \\\"\\n \\\"prior to execution to support this.\\\"\\n )\\n\\n device.reset()\\n\\n # backup the current parameters\\n saved_parameters = self.get_parameters()\\n\\n # temporarily mutate the in-place parameters\\n self.set_parameters(params)\\n\\n if isinstance(device, qml.QubitDevice):\\n res = device.execute(self)\\n else:\\n res = device.execute(self.operations, self.observables, {})\\n\\n # Update output dim if incorrect.\\n # Note that we cannot assume the type of `res`, so\\n # we use duck typing to catch any 'array like' object.\\n try:\\n if isinstance(res, np.ndarray) and res.dtype is np.dtype(\\\"object\\\"):\\n output_dim = sum([len(i) for i in res])\\n else:\\n output_dim = np.prod(res.shape)\\n\\n if self.output_dim != output_dim:\\n # update the inferred output dimension with the correct value\\n self._output_dim = output_dim\\n\\n except (AttributeError, TypeError):\\n # unable to determine the output dimension\\n pass\\n\\n # restore original parameters\\n self.set_parameters(saved_parameters)\\n\\n return res\\n\\n # interfaces can optionally override the _execute method\\n # if they need to perform any logic in between the user's\\n # call to tape.execute and the internal call to tape.execute_device.\\n _execute = execute_device\\n\",\n \"path\": \"pennylane/tape/tape.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"# Copyright 2018-2021 Xanadu Quantum Technologies Inc.\n\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n\n# http://www.apache.org/licenses/LICENSE-2.0\n\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\"\"\"\nThis module contains the base quantum tape.\n\"\"\"\n# pylint: disable=too-many-instance-attributes,protected-access,too-many-branches,too-many-public-methods\nfrom collections import Counter, deque\nimport contextlib\nimport copy\nfrom threading import RLock\n\nimport numpy as np\n\nimport pennylane as qml\nfrom pennylane.queuing import AnnotatedQueue, QueuingContext, QueuingError\nfrom pennylane.operation import Sample\n\n# CV ops still need to support state preparation operations prior to any\n# other operation for PennyLane-SF tests to pass.\nSTATE_PREP_OPS = (\n qml.BasisState,\n qml.QubitStateVector,\n # qml.CatState,\n # qml.CoherentState,\n # qml.FockDensityMatrix,\n # qml.DisplacedSqueezedState,\n # qml.FockState,\n # qml.FockStateVector,\n # qml.ThermalState,\n # qml.GaussianState,\n)\n\n\nOPENQASM_GATES = {\n \"CNOT\": \"cx\",\n \"CZ\": \"cz\",\n \"U3\": \"u3\",\n \"U2\": \"u2\",\n \"U1\": \"u1\",\n \"Identity\": \"id\",\n \"PauliX\": \"x\",\n \"PauliY\": \"y\",\n \"PauliZ\": \"z\",\n \"Hadamard\": \"h\",\n \"S\": \"s\",\n \"S.inv\": \"sdg\",\n \"T\": \"t\",\n \"T.inv\": \"tdg\",\n \"RX\": \"rx\",\n \"RY\": \"ry\",\n \"RZ\": \"rz\",\n \"CRX\": \"crx\",\n \"CRY\": \"cry\",\n \"CRZ\": \"crz\",\n \"SWAP\": \"swap\",\n \"Toffoli\": \"ccx\",\n \"CSWAP\": \"cswap\",\n \"PhaseShift\": \"u1\",\n}\n\"\"\"\ndict[str, str]: Maps PennyLane gate names to equivalent QASM gate names.\n\nNote that QASM has two native gates:\n\n- ``U`` (equivalent to :class:`~.U3`)\n- ``CX`` (equivalent to :class:`~.CNOT`)\n\nAll other gates are defined in the file stdgates.inc:\nhttps://github.com/Qiskit/openqasm/blob/master/examples/stdgates.inc\n\"\"\"\n\n\ndef get_active_tape():\n \"\"\"Returns the currently recording tape.\n If no tape is currently recording, ``None`` is returned.\n\n **Example**\n\n >>> with qml.tape.QuantumTape():\n ... qml.RX(0.2, wires=\"a\")\n ... tape = qml.get_active_tape()\n ... qml.RY(0.1, wires=\"b\")\n >>> print(tape)\n <QuantumTape: wires=['a', 'b'], params=2>\n >>> print(qml.tape.get_active_tape())\n None\n \"\"\"\n return QueuingContext.active_context()\n\n\ndef expand_tape(tape, depth=1, stop_at=None, expand_measurements=False):\n \"\"\"Expand all objects in a tape to a specific depth.\n\n Args:\n depth (int): the depth the tape should be expanded\n stop_at (Callable): A function which accepts a queue object,\n and returns ``True`` if this object should *not* be expanded.\n If not provided, all objects that support expansion will be expanded.\n expand_measurements (bool): If ``True``, measurements will be expanded\n to basis rotations and computational basis measurements.\n\n **Example**\n\n Consider the following nested tape:\n\n .. code-block:: python\n\n with JacobianTape() as tape:\n qml.BasisState(np.array([1, 1]), wires=[0, 'a'])\n\n with JacobianTape() as tape2:\n qml.Rot(0.543, 0.1, 0.4, wires=0)\n\n qml.CNOT(wires=[0, 'a'])\n qml.RY(0.2, wires='a')\n qml.probs(wires=0), qml.probs(wires='a')\n\n The nested structure is preserved:\n\n >>> tape.operations\n [BasisState(array([1, 1]), wires=[0, 'a']),\n <JacobianTape: wires=[0], params=3>,\n CNOT(wires=[0, 'a']),\n RY(0.2, wires=['a'])]\n\n Calling ``expand_tape`` will return a tape with all nested tapes\n expanded, resulting in a single tape of quantum operations:\n\n >>> new_tape = expand_tape(tape)\n >>> new_tape.operations\n [PauliX(wires=[0]),\n PauliX(wires=['a']),\n Rot(0.543, 0.1, 0.4, wires=[0]),\n CNOT(wires=[0, 'a']),\n RY(0.2, wires=['a'])]\n \"\"\"\n if depth == 0:\n return tape\n\n if stop_at is None:\n # by default expand all objects\n stop_at = lambda obj: False\n\n new_tape = tape.__class__()\n new_tape.__bare__ = getattr(tape, \"__bare__\", tape.__class__)\n\n # Check for observables acting on the same wire. If present, observables must be\n # qubit-wise commuting Pauli words. In this case, the tape is expanded with joint\n # rotations and the observables updated to the computational basis. Note that this\n # expansion acts on the original tape in place.\n if tape._obs_sharing_wires:\n try:\n rotations, diag_obs = qml.grouping.diagonalize_qwc_pauli_words(tape._obs_sharing_wires)\n except ValueError as e:\n raise qml.QuantumFunctionError(\n \"Only observables that are qubit-wise commuting \"\n \"Pauli words can be returned on the same wire\"\n ) from e\n\n tape._ops.extend(rotations)\n\n for o, i in zip(diag_obs, tape._obs_sharing_wires_id):\n new_m = qml.measure.MeasurementProcess(tape.measurements[i].return_type, obs=o)\n tape._measurements[i] = new_m\n\n for queue in (\"_prep\", \"_ops\", \"_measurements\"):\n for obj in getattr(tape, queue):\n\n stop = stop_at(obj)\n\n if not expand_measurements:\n # Measurements should not be expanded; treat measurements\n # as a stopping condition\n stop = stop or isinstance(obj, qml.measure.MeasurementProcess)\n\n if stop:\n # do not expand out the object; append it to the\n # new tape, and continue to the next object in the queue\n getattr(new_tape, queue).append(obj)\n continue\n\n if isinstance(obj, (qml.operation.Operation, qml.measure.MeasurementProcess)):\n # Object is an operation; query it for its expansion\n try:\n obj = obj.expand()\n except NotImplementedError:\n # Object does not define an expansion; treat this as\n # a stopping condition.\n getattr(new_tape, queue).append(obj)\n continue\n\n # recursively expand out the newly created tape\n expanded_tape = expand_tape(obj, stop_at=stop_at, depth=depth - 1)\n\n new_tape._prep += expanded_tape._prep\n new_tape._ops += expanded_tape._ops\n new_tape._measurements += expanded_tape._measurements\n\n # Update circuit info\n new_tape._update_circuit_info()\n return new_tape\n\n\n# pylint: disable=too-many-public-methods\nclass QuantumTape(AnnotatedQueue):\n \"\"\"A quantum tape recorder, that records, validates and executes variational quantum programs.\n\n Args:\n name (str): a name given to the quantum tape\n do_queue (bool): Whether to queue this tape in a parent tape context.\n\n **Example**\n\n .. code-block:: python\n\n import pennylane.tape\n\n with qml.tape.QuantumTape() as tape:\n qml.RX(0.432, wires=0)\n qml.RY(0.543, wires=0)\n qml.CNOT(wires=[0, 'a'])\n qml.RX(0.133, wires='a')\n qml.expval(qml.PauliZ(wires=[0]))\n\n Once constructed, information about the quantum circuit can be queried:\n\n >>> tape.operations\n [RX(0.432, wires=[0]), RY(0.543, wires=[0]), CNOT(wires=[0, 'a']), RX(0.133, wires=['a'])]\n >>> tape.observables\n [expval(PauliZ(wires=[0]))]\n >>> tape.get_parameters()\n [0.432, 0.543, 0.133]\n >>> tape.wires\n <Wires = [0, 'a']>\n >>> tape.num_params\n 3\n\n The :class:`~.CircuitGraph` can also be accessed:\n\n >>> tape.graph\n <pennylane.circuit_graph.CircuitGraph object at 0x7fcc0433a690>\n\n Once constructed, the quantum tape can be executed directly on a supported\n device:\n\n >>> dev = qml.device(\"default.qubit\", wires=[0, 'a'])\n\n Execution can take place either using the in-place constructed parameters,\n\n >>> tape.execute(dev)\n [0.77750694]\n\n or by providing parameters at run time:\n\n >>> tape.execute(dev, params=[0.1, 0.1, 0.1])\n [0.99003329]\n\n The trainable parameters of the tape can be explicitly set, and the values of\n the parameters modified in-place:\n\n >>> tape.trainable_params = {0} # set only the first parameter as free\n >>> tape.set_parameters(0.56)\n >>> tape.get_parameters()\n [0.56]\n >>> tape.get_parameters(trainable_only=False)\n [0.56, 0.543, 0.133]\n\n\n When using a tape with ``do_queue=False``, that tape will not be queued in a parent tape context.\n\n .. code-block:: python\n\n with qml.tape.QuantumTape() as tape1:\n with qml.tape.QuantumTape(do_queue=False) as tape2:\n qml.RX(0.123, wires=0)\n\n Here, tape2 records the RX gate, but tape1 doesn't record tape2.\n\n >>> tape1.operations\n []\n >>> tape2.operations\n [RX(0.123, wires=[0])]\n\n This is useful for when you want to transform a tape first before applying it.\n \"\"\"\n\n _lock = RLock()\n \"\"\"threading.RLock: Used to synchronize appending to/popping from global QueueingContext.\"\"\"\n\n def __init__(self, name=None, do_queue=True):\n super().__init__()\n self.name = name\n self.do_queue = do_queue\n self._prep = []\n \"\"\"list[.Operation]: Tape state preparations.\"\"\"\n\n self._ops = []\n \"\"\"list[.Operation]: quantum operations recorded by the tape.\"\"\"\n\n self._measurements = []\n \"\"\"list[.MeasurementProcess]: measurement processes recorded by the tape.\"\"\"\n\n self._par_info = {}\n \"\"\"dict[int, dict[str, Operation or int]]: Parameter information. Keys are\n parameter indices (in the order they appear on the tape), and values are a\n dictionary containing the corresponding operation and operation parameter index.\"\"\"\n\n self._trainable_params = set()\n self._graph = None\n self._resources = None\n self._depth = None\n self._output_dim = 0\n\n self.wires = qml.wires.Wires([])\n self.num_wires = 0\n\n self.is_sampled = False\n self.all_sampled = False\n self.inverse = False\n\n self._obs_sharing_wires = []\n \"\"\"list[.Observable]: subset of the observables that share wires with another observable,\n i.e., that do not have their own unique set of wires.\"\"\"\n self._obs_sharing_wires_id = []\n\n def __repr__(self):\n return f\"<{self.__class__.__name__}: wires={self.wires.tolist()}, params={self.num_params}>\"\n\n def __enter__(self):\n QuantumTape._lock.acquire()\n try:\n if self.do_queue:\n QueuingContext.append(self)\n return super().__enter__()\n except Exception as _:\n QuantumTape._lock.release()\n raise\n\n def __exit__(self, exception_type, exception_value, traceback):\n try:\n super().__exit__(exception_type, exception_value, traceback)\n self._process_queue()\n finally:\n QuantumTape._lock.release()\n\n @property\n def interface(self):\n \"\"\"str, None: automatic differentiation interface used by the quantum tape (if any)\"\"\"\n return None\n\n @contextlib.contextmanager\n def stop_recording(self):\n \"\"\"Context manager to temporarily stop recording operations\n onto the tape. This is useful is scratch space is needed.\n\n **Example**\n\n >>> with qml.tape.QuantumTape() as tape:\n ... qml.RX(0, wires=0)\n ... with tape.stop_recording():\n ... qml.RY(1.0, wires=1)\n ... qml.RZ(2, wires=1)\n >>> tape.operations\n [RX(0, wires=[0]), RZ(2, wires=[1])]\n \"\"\"\n if QueuingContext.active_context() is not self:\n raise QueuingError(\n \"Cannot stop recording requested tape \" \"as it is not currently recording.\"\n )\n\n active_contexts = QueuingContext._active_contexts\n QueuingContext._active_contexts = deque()\n yield\n QueuingContext._active_contexts = active_contexts\n\n # ========================================================\n # construction methods\n # ========================================================\n\n def _process_queue(self):\n \"\"\"Process the annotated queue, creating a list of quantum\n operations and measurement processes.\n\n This method sets the following attributes:\n\n * ``_ops``\n * ``_measurements``\n * ``_par_info``\n * ``_output_dim``\n * ``_trainable_params``\n * ``is_sampled``\n \"\"\"\n self._prep = []\n self._ops = []\n self._measurements = []\n self._output_dim = 0\n\n for obj, info in self._queue.items():\n\n if isinstance(obj, QuantumTape):\n self._ops.append(obj)\n\n elif isinstance(obj, qml.operation.Operation) and not info.get(\"owner\", False):\n # operation objects with no owners\n\n if self._measurements:\n raise ValueError(\n f\"Quantum operation {obj} must occur prior to any measurements.\"\n )\n\n # invert the operation if required\n obj.inverse = info.get(\"inverse\", False)\n\n if isinstance(obj, STATE_PREP_OPS):\n if self._ops:\n raise ValueError(\n f\"State preparation operation {obj} must occur prior to any quantum operations.\"\n )\n\n self._prep.append(obj)\n else:\n self._ops.append(obj)\n\n elif isinstance(obj, qml.measure.MeasurementProcess):\n # measurement process\n self._measurements.append(obj)\n\n # attempt to infer the output dimension\n if obj.return_type is qml.operation.Probability:\n self._output_dim += 2 ** len(obj.wires)\n elif obj.return_type is qml.operation.State:\n continue # the output_dim is worked out automatically\n else:\n self._output_dim += 1\n\n # check if any sampling is occuring\n if obj.return_type is qml.operation.Sample:\n self.is_sampled = True\n\n elif isinstance(obj, qml.operation.Observable) and \"owner\" not in info:\n raise ValueError(f\"Observable {obj} does not have a measurement type specified.\")\n\n self._update()\n\n def _update_circuit_info(self):\n \"\"\"Update circuit metadata\"\"\"\n self.wires = qml.wires.Wires.all_wires(\n [op.wires for op in self.operations + self.observables]\n )\n self.num_wires = len(self.wires)\n\n self.is_sampled = any(m.return_type is Sample for m in self.measurements)\n self.all_sampled = all(m.return_type is Sample for m in self.measurements)\n self.is_sampled = any(m.return_type is Sample for m in self.measurements)\n\n def _update_observables(self):\n \"\"\"Update information about observables, including the wires that are acted upon and\n identifying any observables that share wires\"\"\"\n obs_wires = [wire for m in self.measurements for wire in m.wires if m.obs is not None]\n self._obs_sharing_wires = []\n self._obs_sharing_wires_id = []\n\n if len(obs_wires) != len(set(obs_wires)):\n c = Counter(obs_wires)\n repeated_wires = {w for w in obs_wires if c[w] > 1}\n\n for i, m in enumerate(self.measurements):\n if m.obs is not None:\n if len(set(m.wires) & repeated_wires) > 0:\n self._obs_sharing_wires.append(m.obs)\n self._obs_sharing_wires_id.append(i)\n\n def _update_par_info(self):\n \"\"\"Update the parameter information dictionary\"\"\"\n param_count = 0\n\n for obj in self.operations + self.observables:\n\n for p in range(len(obj.data)):\n info = self._par_info.get(param_count, {})\n info.update({\"op\": obj, \"p_idx\": p})\n\n self._par_info[param_count] = info\n param_count += 1\n\n def _update_trainable_params(self):\n \"\"\"Set the trainable parameters\"\"\"\n self._trainable_params = set(self._par_info)\n\n def _update(self):\n \"\"\"Update all internal tape metadata regarding processed operations and observables\"\"\"\n self._graph = None\n self._resources = None\n self._depth = None\n self._update_circuit_info()\n self._update_par_info()\n self._update_trainable_params()\n self._update_observables()\n\n def expand(self, depth=1, stop_at=None, expand_measurements=False):\n \"\"\"Expand all operations in the processed queue to a specific depth.\n\n Args:\n depth (int): the depth the tape should be expanded\n stop_at (Callable): A function which accepts a queue object,\n and returns ``True`` if this object should *not* be expanded.\n If not provided, all objects that support expansion will be expanded.\n expand_measurements (bool): If ``True``, measurements will be expanded\n to basis rotations and computational basis measurements.\n\n **Example**\n\n Consider the following nested tape:\n\n .. code-block:: python\n\n with JacobianTape() as tape:\n qml.BasisState(np.array([1, 1]), wires=[0, 'a'])\n\n with JacobianTape() as tape2:\n qml.Rot(0.543, 0.1, 0.4, wires=0)\n\n qml.CNOT(wires=[0, 'a'])\n qml.RY(0.2, wires='a')\n qml.probs(wires=0), qml.probs(wires='a')\n\n The nested structure is preserved:\n\n >>> tape.operations\n [BasisState(array([1, 1]), wires=[0, 'a']),\n <JacobianTape: wires=[0], params=3>,\n CNOT(wires=[0, 'a']),\n RY(0.2, wires=['a'])]\n\n Calling ``.expand`` will return a tape with all nested tapes\n expanded, resulting in a single tape of quantum operations:\n\n >>> new_tape = tape.expand()\n >>> new_tape.operations\n [PauliX(wires=[0]),\n PauliX(wires=['a']),\n Rot(0.543, 0.1, 0.4, wires=[0]),\n CNOT(wires=[0, 'a']),\n RY(0.2, wires=['a'])]\n \"\"\"\n new_tape = expand_tape(\n self, depth=depth, stop_at=stop_at, expand_measurements=expand_measurements\n )\n new_tape._update()\n return new_tape\n\n def inv(self):\n \"\"\"Inverts the processed operations.\n\n Inversion is performed in-place.\n\n .. note::\n\n This method only inverts the quantum operations/unitary recorded\n by the quantum tape; state preparations and measurements are left unchanged.\n\n **Example**\n\n .. code-block:: python\n\n with JacobianTape() as tape:\n qml.BasisState(np.array([1, 1]), wires=[0, 'a'])\n qml.RX(0.432, wires=0)\n qml.Rot(0.543, 0.1, 0.4, wires=0).inv()\n qml.CNOT(wires=[0, 'a'])\n qml.probs(wires=0), qml.probs(wires='a')\n\n This tape has the following properties:\n\n >>> tape.operations\n [BasisState(array([1, 1]), wires=[0, 'a']),\n RX(0.432, wires=[0]),\n Rot.inv(0.543, 0.1, 0.4, wires=[0]),\n CNOT(wires=[0, 'a'])]\n >>> tape.get_parameters()\n [array([1, 1]), 0.432, 0.543, 0.1, 0.4]\n\n Here, let's set some trainable parameters:\n\n >>> tape.trainable_params = {1, 2}\n >>> tape.get_parameters()\n [0.432, 0.543]\n\n Inverting the tape:\n\n >>> tape.inv()\n >>> tape.operations\n [BasisState(array([1, 1]), wires=[0, 'a']),\n CNOT.inv(wires=[0, 'a']),\n Rot(0.543, 0.1, 0.4, wires=[0]),\n RX.inv(0.432, wires=[0])]\n\n Tape inversion also modifies the order of tape parameters:\n\n >>> tape.get_parameters(trainable_only=False)\n [array([1, 1]), 0.543, 0.1, 0.4, 0.432]\n >>> tape.get_parameters(trainable_only=True)\n [0.543, 0.432]\n >>> tape.trainable_params\n {1, 4}\n \"\"\"\n # we must remap the old parameter\n # indices to the new ones after the operation order is reversed.\n parameter_indices = []\n param_count = 0\n\n for queue in [self._prep, self._ops, self.observables]:\n # iterate through all queues\n\n obj_params = []\n\n for obj in queue:\n # index the number of parameters on each operation\n num_obj_params = len(obj.data)\n obj_params.append(list(range(param_count, param_count + num_obj_params)))\n\n # keep track of the total number of parameters encountered so far\n param_count += num_obj_params\n\n if queue == self._ops:\n # reverse the list representing operator parameters\n obj_params = obj_params[::-1]\n\n parameter_indices.extend(obj_params)\n\n # flatten the list of parameter indices after the reversal\n parameter_indices = [item for sublist in parameter_indices for item in sublist]\n parameter_mapping = dict(zip(parameter_indices, range(len(parameter_indices))))\n\n # map the params\n self.trainable_params = {parameter_mapping[i] for i in self.trainable_params}\n self._par_info = {parameter_mapping[k]: v for k, v in self._par_info.items()}\n\n for op in self._ops:\n op.inverse = not op.inverse\n\n self._ops = list(reversed(self._ops))\n\n # ========================================================\n # Parameter handling\n # ========================================================\n\n @property\n def trainable_params(self):\n \"\"\"Store or return a set containing the indices of parameters that support\n differentiability. The indices provided match the order of appearence in the\n quantum circuit.\n\n Setting this property can help reduce the number of quantum evaluations needed\n to compute the Jacobian; parameters not marked as trainable will be\n automatically excluded from the Jacobian computation.\n\n The number of trainable parameters determines the number of parameters passed to\n :meth:`~.set_parameters`, :meth:`~.execute`, and :meth:`~.JacobianTape.jacobian`,\n and changes the default output size of methods :meth:`~.JacobianTape.jacobian` and\n :meth:`~.get_parameters()`.\n\n .. note::\n\n Since the :meth:`~.JacobianTape.jacobian` method is not called for devices that support\n native backpropagation (such as ``default.qubit.tf`` and ``default.qubit.autograd``),\n this property contains no relevant information when using backpropagation to compute gradients.\n\n **Example**\n\n .. code-block:: python\n\n with JacobianTape() as tape:\n qml.RX(0.432, wires=0)\n qml.RY(0.543, wires=0)\n qml.CNOT(wires=[0, 'a'])\n qml.RX(0.133, wires='a')\n qml.expval(qml.PauliZ(wires=[0]))\n\n >>> tape.trainable_params\n {0, 1, 2}\n >>> tape.trainable_params = {0} # set only the first parameter as free\n >>> tape.get_parameters()\n [0.432]\n\n Args:\n param_indices (set[int]): parameter indices\n \"\"\"\n return self._trainable_params\n\n @trainable_params.setter\n def trainable_params(self, param_indices):\n \"\"\"Store the indices of parameters that support differentiability.\n\n Args:\n param_indices (set[int]): parameter indices\n \"\"\"\n if any(not isinstance(i, int) or i < 0 for i in param_indices):\n raise ValueError(\"Argument indices must be positive integers.\")\n\n if any(i > len(self._par_info) for i in param_indices):\n raise ValueError(f\"Tape has at most {self.num_params} parameters.\")\n\n self._trainable_params = param_indices\n\n def get_parameters(self, trainable_only=True, **kwargs): # pylint:disable=unused-argument\n \"\"\"Return the parameters incident on the tape operations.\n\n The returned parameters are provided in order of appearance\n on the tape.\n\n Args:\n trainable_only (bool): if True, returns only trainable parameters\n\n **Example**\n\n .. code-block:: python\n\n with JacobianTape() as tape:\n qml.RX(0.432, wires=0)\n qml.RY(0.543, wires=0)\n qml.CNOT(wires=[0, 'a'])\n qml.RX(0.133, wires='a')\n qml.expval(qml.PauliZ(wires=[0]))\n\n By default, all parameters are trainable and will be returned:\n\n >>> tape.get_parameters()\n [0.432, 0.543, 0.133]\n\n Setting the trainable parameter indices will result in only the specified\n parameters being returned:\n\n >>> tape.trainable_params = {1} # set the second parameter as free\n >>> tape.get_parameters()\n [0.543]\n\n The ``trainable_only`` argument can be set to ``False`` to instead return\n all parameters:\n\n >>> tape.get_parameters(trainable_only=False)\n [0.432, 0.543, 0.133]\n \"\"\"\n params = []\n iterator = self.trainable_params if trainable_only else self._par_info\n\n for p_idx in iterator:\n op = self._par_info[p_idx][\"op\"]\n op_idx = self._par_info[p_idx][\"p_idx\"]\n params.append(op.data[op_idx])\n\n return params\n\n def set_parameters(self, params, trainable_only=True):\n \"\"\"Set the parameters incident on the tape operations.\n\n Args:\n params (list[float]): A list of real numbers representing the\n parameters of the quantum operations. The parameters should be\n provided in order of appearance in the quantum tape.\n trainable_only (bool): if True, set only trainable parameters\n\n **Example**\n\n .. code-block:: python\n\n with JacobianTape() as tape:\n qml.RX(0.432, wires=0)\n qml.RY(0.543, wires=0)\n qml.CNOT(wires=[0, 'a'])\n qml.RX(0.133, wires='a')\n qml.expval(qml.PauliZ(wires=[0]))\n\n By default, all parameters are trainable and can be modified:\n\n >>> tape.set_parameters([0.1, 0.2, 0.3])\n >>> tape.get_parameters()\n [0.1, 0.2, 0.3]\n\n Setting the trainable parameter indices will result in only the specified\n parameters being modifiable. Note that this only modifies the number of\n parameters that must be passed.\n\n >>> tape.trainable_params = {0, 2} # set the first and third parameter as free\n >>> tape.set_parameters([-0.1, 0.5])\n >>> tape.get_parameters(trainable_only=False)\n [-0.1, 0.2, 0.5]\n\n The ``trainable_only`` argument can be set to ``False`` to instead set\n all parameters:\n\n >>> tape.set_parameters([4, 1, 6], trainable_only=False)\n >>> tape.get_parameters(trainable_only=False)\n [4, 1, 6]\n \"\"\"\n if trainable_only:\n iterator = zip(self.trainable_params, params)\n required_length = self.num_params\n else:\n iterator = enumerate(params)\n required_length = len(self._par_info)\n\n if len(params) != required_length:\n raise ValueError(\"Number of provided parameters does not match.\")\n\n for idx, p in iterator:\n op = self._par_info[idx][\"op\"]\n op.data[self._par_info[idx][\"p_idx\"]] = p\n\n # ========================================================\n # Tape properties\n # ========================================================\n\n @property\n def operations(self):\n \"\"\"Returns the operations on the quantum tape.\n\n Returns:\n list[.Operation]: recorded quantum operations\n\n **Example**\n\n .. code-block:: python\n\n with JacobianTape() as tape:\n qml.RX(0.432, wires=0)\n qml.RY(0.543, wires=0)\n qml.CNOT(wires=[0, 'a'])\n qml.RX(0.133, wires='a')\n qml.expval(qml.PauliZ(wires=[0]))\n\n >>> tape.operations\n [RX(0.432, wires=[0]), RY(0.543, wires=[0]), CNOT(wires=[0, 'a']), RX(0.133, wires=['a'])]\n \"\"\"\n return self._prep + self._ops\n\n @property\n def observables(self):\n \"\"\"Returns the observables on the quantum tape.\n\n Returns:\n list[.Observable]: list of recorded quantum operations\n\n **Example**\n\n .. code-block:: python\n\n with JacobianTape() as tape:\n qml.RX(0.432, wires=0)\n qml.RY(0.543, wires=0)\n qml.CNOT(wires=[0, 'a'])\n qml.RX(0.133, wires='a')\n qml.expval(qml.PauliZ(wires=[0]))\n\n >>> tape.observables\n [expval(PauliZ(wires=[0]))]\n \"\"\"\n # TODO: modify this property once devices\n # have been refactored to accept and understand recieving\n # measurement processes rather than specific observables.\n obs = []\n\n for m in self._measurements:\n if m.obs is not None:\n m.obs.return_type = m.return_type\n obs.append(m.obs)\n else:\n obs.append(m)\n\n return obs\n\n @property\n def measurements(self):\n \"\"\"Returns the measurements on the quantum tape.\n\n Returns:\n list[.MeasurementProcess]: list of recorded measurement processess\n\n **Example**\n\n .. code-block:: python\n\n with JacobianTape() as tape:\n qml.RX(0.432, wires=0)\n qml.RY(0.543, wires=0)\n qml.CNOT(wires=[0, 'a'])\n qml.RX(0.133, wires='a')\n qml.expval(qml.PauliZ(wires=[0]))\n\n >>> tape.measurements\n [<pennylane.tape.measure.MeasurementProcess object at 0x7f10b2150c10>]\n \"\"\"\n return self._measurements\n\n @property\n def num_params(self):\n \"\"\"Returns the number of trainable parameters on the quantum tape.\"\"\"\n return len(self.trainable_params)\n\n @property\n def output_dim(self):\n \"\"\"The (inferred) output dimension of the quantum tape.\"\"\"\n return self._output_dim\n\n @property\n def diagonalizing_gates(self):\n \"\"\"Returns the gates that diagonalize the measured wires such that they\n are in the eigenbasis of the circuit observables.\n\n Returns:\n List[~.Operation]: the operations that diagonalize the observables\n \"\"\"\n rotation_gates = []\n\n for observable in self.observables:\n rotation_gates.extend(observable.diagonalizing_gates())\n\n return rotation_gates\n\n @property\n def graph(self):\n \"\"\"Returns a directed acyclic graph representation of the recorded\n quantum circuit:\n\n >>> tape.graph\n <pennylane.circuit_graph.CircuitGraph object at 0x7fcc0433a690>\n\n Note that the circuit graph is only constructed once, on first call to this property,\n and cached for future use.\n\n Returns:\n .CircuitGraph: the circuit graph object\n \"\"\"\n if self._graph is None:\n self._graph = qml.CircuitGraph(\n self.operations, self.observables, self.wires, self._par_info, self.trainable_params\n )\n\n return self._graph\n\n def get_resources(self):\n \"\"\"Resource requirements of a quantum circuit.\n\n Returns:\n dict[str, int]: how many times constituent operations are applied\n\n **Example**\n\n .. code-block:: python3\n\n with qml.tape.QuantumTape() as tape:\n qml.Hadamard(wires=0)\n qml.RZ(0.26, wires=1)\n qml.CNOT(wires=[1, 0])\n qml.Rot(1.8, -2.7, 0.2, wires=0)\n qml.Hadamard(wires=1)\n qml.CNOT(wires=[0, 1])\n qml.expval(qml.PauliZ(0) @ qml.PauliZ(1))\n\n Asking for the resources produces a dictionary as shown below:\n\n >>> tape.get_resources()\n {'Hadamard': 2, 'RZ': 1, 'CNOT': 2, 'Rot': 1}\n \"\"\"\n if self._resources is None:\n self._resources = {}\n\n for op in self.operations:\n if op.name not in self._resources.keys():\n self._resources[op.name] = 1\n else:\n self._resources[op.name] += 1\n\n return self._resources\n\n def get_depth(self):\n \"\"\"Depth of the quantum circuit.\n\n Returns:\n int: Circuit depth, computed as the longest path in the circuit's directed acyclic graph representation.\n\n **Example**\n\n .. code-block:: python3\n\n with QuantumTape() as tape:\n qml.Hadamard(wires=0)\n qml.PauliX(wires=1)\n qml.CRX(2.3, wires=[0, 1])\n qml.Rot(1.2, 3.2, 0.7, wires=[1])\n qml.CRX(-2.3, wires=[0, 1])\n qml.expval(qml.PauliZ(0) @ qml.PauliZ(1))\n\n The depth can be obtained like so:\n\n >>> tape.get_depth()\n 4\n \"\"\"\n if self._depth is None:\n self._depth = self.graph.get_depth()\n\n return self._depth\n\n def draw(self, charset=\"unicode\", wire_order=None, show_all_wires=False):\n \"\"\"Draw the quantum tape as a circuit diagram.\n\n Consider the following circuit as an example:\n\n .. code-block:: python3\n\n with QuantumTape() as tape:\n qml.Hadamard(0)\n qml.CRX(2.3, wires=[0, 1])\n qml.Rot(1.2, 3.2, 0.7, wires=[1])\n qml.CRX(-2.3, wires=[0, 1])\n qml.expval(qml.PauliZ(0) @ qml.PauliZ(1))\n\n We can draw the tape after construction:\n\n >>> print(tape.draw())\n 0: ──H──╭C────────────────────────────╭C─────────╭┤ ⟨Z ⊗ Z⟩\n 1: ─────╰RX(2.3)──Rot(1.2, 3.2, 0.7)──╰RX(-2.3)──╰┤ ⟨Z ⊗ Z⟩\n >>> print(tape.draw(charset=\"ascii\"))\n 0: --H--+C----------------------------+C---------+| <Z @ Z>\n 1: -----+RX(2.3)--Rot(1.2, 3.2, 0.7)--+RX(-2.3)--+| <Z @ Z>\n\n Args:\n charset (str, optional): The charset that should be used. Currently, \"unicode\" and\n \"ascii\" are supported.\n wire_order (Sequence[Any]): the order (from top to bottom) to print the wires of the circuit\n show_all_wires (bool): If True, all wires, including empty wires, are printed.\n\n Raises:\n ValueError: if the given charset is not supported\n\n Returns:\n str: the circuit representation of the tape\n \"\"\"\n return self.graph.draw(\n charset=charset,\n wire_order=wire_order,\n show_all_wires=show_all_wires,\n )\n\n def to_openqasm(self, wires=None, rotations=True):\n \"\"\"Serialize the circuit as an OpenQASM 2.0 program.\n\n Only operations are serialized; all measurements\n are assumed to take place in the computational basis.\n\n .. note::\n\n The serialized OpenQASM program assumes that gate definitions\n in ``qelib1.inc`` are available.\n\n Args:\n wires (Wires or None): the wires to use when serializing the circuit\n rotations (bool): in addition to serializing user-specified\n operations, also include the gates that diagonalize the\n measured wires such that they are in the eigenbasis of the circuit observables.\n\n Returns:\n str: OpenQASM serialization of the circuit\n \"\"\"\n # We import decompose_queue here to avoid a circular import\n wires = wires or self.wires\n\n # add the QASM headers\n qasm_str = \"OPENQASM 2.0;\\n\"\n qasm_str += 'include \"qelib1.inc\";\\n'\n\n if self.num_wires == 0:\n # empty circuit\n return qasm_str\n\n # create the quantum and classical registers\n qasm_str += \"qreg q[{}];\\n\".format(len(wires))\n qasm_str += \"creg c[{}];\\n\".format(len(wires))\n\n # get the user applied circuit operations\n operations = self.operations\n\n if rotations:\n # if requested, append diagonalizing gates corresponding\n # to circuit observables\n operations += self.diagonalizing_gates\n\n with QuantumTape() as tape:\n for op in operations:\n op.queue()\n\n if op.inverse:\n op.inv()\n\n # decompose the queue\n operations = tape.expand(depth=2, stop_at=lambda obj: obj.name in OPENQASM_GATES).operations\n\n # create the QASM code representing the operations\n for op in operations:\n try:\n gate = OPENQASM_GATES[op.name]\n except KeyError as e:\n raise ValueError(f\"Operation {op.name} not supported by the QASM serializer\") from e\n\n wire_labels = \",\".join([f\"q[{wires.index(w)}]\" for w in op.wires.tolist()])\n params = \"\"\n\n if op.num_params > 0:\n # If the operation takes parameters, construct a string\n # with parameter values.\n params = \"(\" + \",\".join([str(p) for p in op.parameters]) + \")\"\n\n qasm_str += \"{name}{params} {wires};\\n\".format(\n name=gate, params=params, wires=wire_labels\n )\n\n # apply computational basis measurements to each quantum register\n # NOTE: This is not strictly necessary, we could inspect self.observables,\n # and then only measure wires which are requested by the user. However,\n # some devices which consume QASM require all registers be measured, so\n # measure all wires to be safe.\n for wire in range(len(wires)):\n qasm_str += \"measure q[{wire}] -> c[{wire}];\\n\".format(wire=wire)\n\n return qasm_str\n\n @property\n def data(self):\n \"\"\"Alias to :meth:`~.get_parameters` and :meth:`~.set_parameters`\n for backwards compatibilities with operations.\"\"\"\n return self.get_parameters(trainable_only=False)\n\n @data.setter\n def data(self, params):\n self.set_parameters(params, trainable_only=False)\n\n def copy(self, copy_operations=False, tape_cls=None):\n \"\"\"Returns a shallow copy of the quantum tape.\n\n Args:\n copy_operations (bool): If True, the tape operations are also shallow copied.\n Otherwise, if False, the copied tape operations will simply be references\n to the original tape operations; changing the parameters of one tape will likewise\n change the parameters of all copies.\n tape_cls (.QuantumTape): Cast the copied tape to a specific quantum tape subclass.\n If not provided, the same subclass is used as the original tape.\n\n Returns:\n .QuantumTape: a shallow copy of the tape\n \"\"\"\n if tape_cls is None:\n tape = self.__class__()\n else:\n tape = tape_cls()\n\n if copy_operations:\n # Perform a shallow copy of all operations in the state prep, operation, and measurement\n # queues. The operations will continue to share data with the original tape operations\n # unless modified.\n tape._prep = [copy.copy(op) for op in self._prep]\n tape._ops = [copy.copy(op) for op in self._ops]\n tape._measurements = [copy.copy(op) for op in self._measurements]\n else:\n # Perform a shallow copy of the state prep, operation, and measurement queues. The\n # operations within the queues will be references to the original tape operations;\n # changing the original operations will always alter the operations on the copied tape.\n tape._prep = self._prep.copy()\n tape._ops = self._ops.copy()\n tape._measurements = self._measurements.copy()\n\n tape._update()\n tape.trainable_params = self.trainable_params.copy()\n\n return tape\n\n def __copy__(self):\n return self.copy(copy_operations=True)\n\n # ========================================================\n # execution methods\n # ========================================================\n\n def execute(self, device, params=None):\n \"\"\"Execute the tape on a quantum device.\n\n Args:\n device (.Device): a PennyLane device\n that can execute quantum operations and return measurement statistics\n params (list[Any]): The quantum tape operation parameters. If not provided,\n the current tape parameters are used (via :meth:`~.get_parameters`).\n\n **Example**\n\n .. code-block:: python\n\n with JacobianTape() as tape:\n qml.RX(0.432, wires=0)\n qml.RY(0.543, wires=0)\n qml.CNOT(wires=[0, 'a'])\n qml.RX(0.133, wires='a')\n qml.probs(wires=[0, 'a'])\n\n If parameters are not provided, the existing tape parameters are used:\n\n >>> dev = qml.device(\"default.qubit\", wires=[0, 'a'])\n >>> tape.execute(dev)\n array([[8.84828969e-01, 3.92449987e-03, 4.91235209e-04, 1.10755296e-01]])\n\n Parameters can be optionally passed during execution:\n\n >>> tape.execute(dev, params=[1.0, 0.0, 1.0])\n array([[0.5931328 , 0.17701835, 0.05283049, 0.17701835]])\n\n Parameters provided for execution are temporary, and do not affect\n the tapes' parameters in-place:\n\n >>> tape.get_parameters()\n [0.432, 0.543, 0.133]\n \"\"\"\n if params is None:\n params = self.get_parameters()\n\n return self._execute(params, device=device)\n\n def execute_device(self, params, device):\n \"\"\"Execute the tape on a quantum device.\n\n This is a low-level method, intended to be called by an interface,\n and does not support autodifferentiation.\n\n For more details on differentiable tape execution, see :meth:`~.execute`.\n\n Args:\n device (~.Device): a PennyLane device\n that can execute quantum operations and return measurement statistics\n params (list[Any]): The quantum tape operation parameters. If not provided,\n the current tape parameter values are used (via :meth:`~.get_parameters`).\n \"\"\"\n if not all(len(o.diagonalizing_gates()) == 0 for o in self._obs_sharing_wires):\n raise qml.QuantumFunctionError(\n \"Multiple observables are being evaluated on the same wire. Call tape.expand() \"\n \"prior to execution to support this.\"\n )\n\n device.reset()\n\n # backup the current parameters\n saved_parameters = self.get_parameters()\n\n # temporarily mutate the in-place parameters\n self.set_parameters(params)\n\n if isinstance(device, qml.QubitDevice):\n res = device.execute(self)\n else:\n res = device.execute(self.operations, self.observables, {})\n\n # Update output dim if incorrect.\n # Note that we cannot assume the type of `res`, so\n # we use duck typing to catch any 'array like' object.\n try:\n if isinstance(res, np.ndarray) and res.dtype is np.dtype(\"object\"):\n output_dim = sum([len(i) for i in res])\n else:\n output_dim = np.prod(res.shape)\n\n if self.output_dim != output_dim:\n # update the inferred output dimension with the correct value\n self._output_dim = output_dim\n\n except (AttributeError, TypeError):\n # unable to determine the output dimension\n pass\n\n # restore original parameters\n self.set_parameters(saved_parameters)\n\n return res\n\n # interfaces can optionally override the _execute method\n # if they need to perform any logic in between the user's\n # call to tape.execute and the internal call to tape.execute_device.\n _execute = execute_device\n","path":"pennylane/tape/tape.py"}],"string":"[\n {\n \"content\": \"# Copyright 2018-2021 Xanadu Quantum Technologies Inc.\\n\\n# Licensed under the Apache License, Version 2.0 (the \\\"License\\\");\\n# you may not use this file except in compliance with the License.\\n# You may obtain a copy of the License at\\n\\n# http://www.apache.org/licenses/LICENSE-2.0\\n\\n# Unless required by applicable law or agreed to in writing, software\\n# distributed under the License is distributed on an \\\"AS IS\\\" BASIS,\\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\\n# See the License for the specific language governing permissions and\\n# limitations under the License.\\n\\\"\\\"\\\"\\nThis module contains the base quantum tape.\\n\\\"\\\"\\\"\\n# pylint: disable=too-many-instance-attributes,protected-access,too-many-branches,too-many-public-methods\\nfrom collections import Counter, deque\\nimport contextlib\\nimport copy\\nfrom threading import RLock\\n\\nimport numpy as np\\n\\nimport pennylane as qml\\nfrom pennylane.queuing import AnnotatedQueue, QueuingContext, QueuingError\\nfrom pennylane.operation import Sample\\n\\n# CV ops still need to support state preparation operations prior to any\\n# other operation for PennyLane-SF tests to pass.\\nSTATE_PREP_OPS = (\\n qml.BasisState,\\n qml.QubitStateVector,\\n # qml.CatState,\\n # qml.CoherentState,\\n # qml.FockDensityMatrix,\\n # qml.DisplacedSqueezedState,\\n # qml.FockState,\\n # qml.FockStateVector,\\n # qml.ThermalState,\\n # qml.GaussianState,\\n)\\n\\n\\nOPENQASM_GATES = {\\n \\\"CNOT\\\": \\\"cx\\\",\\n \\\"CZ\\\": \\\"cz\\\",\\n \\\"U3\\\": \\\"u3\\\",\\n \\\"U2\\\": \\\"u2\\\",\\n \\\"U1\\\": \\\"u1\\\",\\n \\\"Identity\\\": \\\"id\\\",\\n \\\"PauliX\\\": \\\"x\\\",\\n \\\"PauliY\\\": \\\"y\\\",\\n \\\"PauliZ\\\": \\\"z\\\",\\n \\\"Hadamard\\\": \\\"h\\\",\\n \\\"S\\\": \\\"s\\\",\\n \\\"S.inv\\\": \\\"sdg\\\",\\n \\\"T\\\": \\\"t\\\",\\n \\\"T.inv\\\": \\\"tdg\\\",\\n \\\"RX\\\": \\\"rx\\\",\\n \\\"RY\\\": \\\"ry\\\",\\n \\\"RZ\\\": \\\"rz\\\",\\n \\\"CRX\\\": \\\"crx\\\",\\n \\\"CRY\\\": \\\"cry\\\",\\n \\\"CRZ\\\": \\\"crz\\\",\\n \\\"SWAP\\\": \\\"swap\\\",\\n \\\"Toffoli\\\": \\\"ccx\\\",\\n \\\"CSWAP\\\": \\\"cswap\\\",\\n \\\"PhaseShift\\\": \\\"u1\\\",\\n}\\n\\\"\\\"\\\"\\ndict[str, str]: Maps PennyLane gate names to equivalent QASM gate names.\\n\\nNote that QASM has two native gates:\\n\\n- ``U`` (equivalent to :class:`~.U3`)\\n- ``CX`` (equivalent to :class:`~.CNOT`)\\n\\nAll other gates are defined in the file stdgates.inc:\\nhttps://github.com/Qiskit/openqasm/blob/master/examples/stdgates.inc\\n\\\"\\\"\\\"\\n\\n\\ndef get_active_tape():\\n \\\"\\\"\\\"Returns the currently recording tape.\\n If no tape is currently recording, ``None`` is returned.\\n\\n **Example**\\n\\n >>> with qml.tape.QuantumTape():\\n ... qml.RX(0.2, wires=\\\"a\\\")\\n ... tape = qml.get_active_tape()\\n ... qml.RY(0.1, wires=\\\"b\\\")\\n >>> print(tape)\\n <QuantumTape: wires=['a', 'b'], params=2>\\n >>> print(qml.tape.get_active_tape())\\n None\\n \\\"\\\"\\\"\\n return QueuingContext.active_context()\\n\\n\\ndef expand_tape(tape, depth=1, stop_at=None, expand_measurements=False):\\n \\\"\\\"\\\"Expand all objects in a tape to a specific depth.\\n\\n Args:\\n depth (int): the depth the tape should be expanded\\n stop_at (Callable): A function which accepts a queue object,\\n and returns ``True`` if this object should *not* be expanded.\\n If not provided, all objects that support expansion will be expanded.\\n expand_measurements (bool): If ``True``, measurements will be expanded\\n to basis rotations and computational basis measurements.\\n\\n **Example**\\n\\n Consider the following nested tape:\\n\\n .. code-block:: python\\n\\n with JacobianTape() as tape:\\n qml.BasisState(np.array([1, 1]), wires=[0, 'a'])\\n\\n with JacobianTape() as tape2:\\n qml.Rot(0.543, 0.1, 0.4, wires=0)\\n\\n qml.CNOT(wires=[0, 'a'])\\n qml.RY(0.2, wires='a')\\n qml.probs(wires=0), qml.probs(wires='a')\\n\\n The nested structure is preserved:\\n\\n >>> tape.operations\\n [BasisState(array([1, 1]), wires=[0, 'a']),\\n <JacobianTape: wires=[0], params=3>,\\n CNOT(wires=[0, 'a']),\\n RY(0.2, wires=['a'])]\\n\\n Calling ``expand_tape`` will return a tape with all nested tapes\\n expanded, resulting in a single tape of quantum operations:\\n\\n >>> new_tape = expand_tape(tape)\\n >>> new_tape.operations\\n [PauliX(wires=[0]),\\n PauliX(wires=['a']),\\n Rot(0.543, 0.1, 0.4, wires=[0]),\\n CNOT(wires=[0, 'a']),\\n RY(0.2, wires=['a'])]\\n \\\"\\\"\\\"\\n if depth == 0:\\n return tape\\n\\n if stop_at is None:\\n # by default expand all objects\\n stop_at = lambda obj: False\\n\\n new_tape = tape.__class__()\\n new_tape.__bare__ = getattr(tape, \\\"__bare__\\\", tape.__class__)\\n\\n # Check for observables acting on the same wire. If present, observables must be\\n # qubit-wise commuting Pauli words. In this case, the tape is expanded with joint\\n # rotations and the observables updated to the computational basis. Note that this\\n # expansion acts on the original tape in place.\\n if tape._obs_sharing_wires:\\n try:\\n rotations, diag_obs = qml.grouping.diagonalize_qwc_pauli_words(tape._obs_sharing_wires)\\n except ValueError as e:\\n raise qml.QuantumFunctionError(\\n \\\"Only observables that are qubit-wise commuting \\\"\\n \\\"Pauli words can be returned on the same wire\\\"\\n ) from e\\n\\n tape._ops.extend(rotations)\\n\\n for o, i in zip(diag_obs, tape._obs_sharing_wires_id):\\n new_m = qml.measure.MeasurementProcess(tape.measurements[i].return_type, obs=o)\\n tape._measurements[i] = new_m\\n\\n for queue in (\\\"_prep\\\", \\\"_ops\\\", \\\"_measurements\\\"):\\n for obj in getattr(tape, queue):\\n\\n stop = stop_at(obj)\\n\\n if not expand_measurements:\\n # Measurements should not be expanded; treat measurements\\n # as a stopping condition\\n stop = stop or isinstance(obj, qml.measure.MeasurementProcess)\\n\\n if stop:\\n # do not expand out the object; append it to the\\n # new tape, and continue to the next object in the queue\\n getattr(new_tape, queue).append(obj)\\n continue\\n\\n if isinstance(obj, (qml.operation.Operation, qml.measure.MeasurementProcess)):\\n # Object is an operation; query it for its expansion\\n try:\\n obj = obj.expand()\\n except NotImplementedError:\\n # Object does not define an expansion; treat this as\\n # a stopping condition.\\n getattr(new_tape, queue).append(obj)\\n continue\\n\\n # recursively expand out the newly created tape\\n expanded_tape = expand_tape(obj, stop_at=stop_at, depth=depth - 1)\\n\\n new_tape._prep += expanded_tape._prep\\n new_tape._ops += expanded_tape._ops\\n new_tape._measurements += expanded_tape._measurements\\n\\n # Update circuit info\\n new_tape._update_circuit_info()\\n return new_tape\\n\\n\\n# pylint: disable=too-many-public-methods\\nclass QuantumTape(AnnotatedQueue):\\n \\\"\\\"\\\"A quantum tape recorder, that records, validates and executes variational quantum programs.\\n\\n Args:\\n name (str): a name given to the quantum tape\\n do_queue (bool): Whether to queue this tape in a parent tape context.\\n\\n **Example**\\n\\n .. code-block:: python\\n\\n import pennylane.tape\\n\\n with qml.tape.QuantumTape() as tape:\\n qml.RX(0.432, wires=0)\\n qml.RY(0.543, wires=0)\\n qml.CNOT(wires=[0, 'a'])\\n qml.RX(0.133, wires='a')\\n qml.expval(qml.PauliZ(wires=[0]))\\n\\n Once constructed, information about the quantum circuit can be queried:\\n\\n >>> tape.operations\\n [RX(0.432, wires=[0]), RY(0.543, wires=[0]), CNOT(wires=[0, 'a']), RX(0.133, wires=['a'])]\\n >>> tape.observables\\n [expval(PauliZ(wires=[0]))]\\n >>> tape.get_parameters()\\n [0.432, 0.543, 0.133]\\n >>> tape.wires\\n <Wires = [0, 'a']>\\n >>> tape.num_params\\n 3\\n\\n The :class:`~.CircuitGraph` can also be accessed:\\n\\n >>> tape.graph\\n <pennylane.circuit_graph.CircuitGraph object at 0x7fcc0433a690>\\n\\n Once constructed, the quantum tape can be executed directly on a supported\\n device:\\n\\n >>> dev = qml.device(\\\"default.qubit\\\", wires=[0, 'a'])\\n\\n Execution can take place either using the in-place constructed parameters,\\n\\n >>> tape.execute(dev)\\n [0.77750694]\\n\\n or by providing parameters at run time:\\n\\n >>> tape.execute(dev, params=[0.1, 0.1, 0.1])\\n [0.99003329]\\n\\n The trainable parameters of the tape can be explicitly set, and the values of\\n the parameters modified in-place:\\n\\n >>> tape.trainable_params = {0} # set only the first parameter as free\\n >>> tape.set_parameters(0.56)\\n >>> tape.get_parameters()\\n [0.56]\\n >>> tape.get_parameters(trainable_only=False)\\n [0.56, 0.543, 0.133]\\n\\n\\n When using a tape with ``do_queue=False``, that tape will not be queued in a parent tape context.\\n\\n .. code-block:: python\\n\\n with qml.tape.QuantumTape() as tape1:\\n with qml.tape.QuantumTape(do_queue=False) as tape2:\\n qml.RX(0.123, wires=0)\\n\\n Here, tape2 records the RX gate, but tape1 doesn't record tape2.\\n\\n >>> tape1.operations\\n []\\n >>> tape2.operations\\n [RX(0.123, wires=[0])]\\n\\n This is useful for when you want to transform a tape first before applying it.\\n \\\"\\\"\\\"\\n\\n _lock = RLock()\\n \\\"\\\"\\\"threading.RLock: Used to synchronize appending to/popping from global QueueingContext.\\\"\\\"\\\"\\n\\n def __init__(self, name=None, do_queue=True):\\n super().__init__()\\n self.name = name\\n self.do_queue = do_queue\\n self._prep = []\\n \\\"\\\"\\\"list[.Operation]: Tape state preparations.\\\"\\\"\\\"\\n\\n self._ops = []\\n \\\"\\\"\\\"list[.Operation]: quantum operations recorded by the tape.\\\"\\\"\\\"\\n\\n self._measurements = []\\n \\\"\\\"\\\"list[.MeasurementProcess]: measurement processes recorded by the tape.\\\"\\\"\\\"\\n\\n self._par_info = {}\\n \\\"\\\"\\\"dict[int, dict[str, Operation or int]]: Parameter information. Keys are\\n parameter indices (in the order they appear on the tape), and values are a\\n dictionary containing the corresponding operation and operation parameter index.\\\"\\\"\\\"\\n\\n self._trainable_params = set()\\n self._graph = None\\n self._resources = None\\n self._depth = None\\n self._output_dim = 0\\n\\n self.wires = qml.wires.Wires([])\\n self.num_wires = 0\\n\\n self.is_sampled = False\\n self.all_sampled = False\\n self.inverse = False\\n\\n self._obs_sharing_wires = []\\n \\\"\\\"\\\"list[.Observable]: subset of the observables that share wires with another observable,\\n i.e., that do not have their own unique set of wires.\\\"\\\"\\\"\\n self._obs_sharing_wires_id = []\\n\\n def __repr__(self):\\n return f\\\"<{self.__class__.__name__}: wires={self.wires.tolist()}, params={self.num_params}>\\\"\\n\\n def __enter__(self):\\n QuantumTape._lock.acquire()\\n try:\\n if self.do_queue:\\n QueuingContext.append(self)\\n return super().__enter__()\\n except Exception as _:\\n QuantumTape._lock.release()\\n raise\\n\\n def __exit__(self, exception_type, exception_value, traceback):\\n try:\\n super().__exit__(exception_type, exception_value, traceback)\\n self._process_queue()\\n finally:\\n QuantumTape._lock.release()\\n\\n @property\\n def interface(self):\\n \\\"\\\"\\\"str, None: automatic differentiation interface used by the quantum tape (if any)\\\"\\\"\\\"\\n return None\\n\\n @contextlib.contextmanager\\n def stop_recording(self):\\n \\\"\\\"\\\"Context manager to temporarily stop recording operations\\n onto the tape. This is useful is scratch space is needed.\\n\\n **Example**\\n\\n >>> with qml.tape.QuantumTape() as tape:\\n ... qml.RX(0, wires=0)\\n ... with tape.stop_recording():\\n ... qml.RY(1.0, wires=1)\\n ... qml.RZ(2, wires=1)\\n >>> tape.operations\\n [RX(0, wires=[0]), RZ(2, wires=[1])]\\n \\\"\\\"\\\"\\n if QueuingContext.active_context() is not self:\\n raise QueuingError(\\n \\\"Cannot stop recording requested tape \\\" \\\"as it is not currently recording.\\\"\\n )\\n\\n active_contexts = QueuingContext._active_contexts\\n QueuingContext._active_contexts = deque()\\n yield\\n QueuingContext._active_contexts = active_contexts\\n\\n # ========================================================\\n # construction methods\\n # ========================================================\\n\\n def _process_queue(self):\\n \\\"\\\"\\\"Process the annotated queue, creating a list of quantum\\n operations and measurement processes.\\n\\n This method sets the following attributes:\\n\\n * ``_ops``\\n * ``_measurements``\\n * ``_par_info``\\n * ``_output_dim``\\n * ``_trainable_params``\\n * ``is_sampled``\\n \\\"\\\"\\\"\\n self._prep = []\\n self._ops = []\\n self._measurements = []\\n self._output_dim = 0\\n\\n for obj, info in self._queue.items():\\n\\n if isinstance(obj, QuantumTape):\\n self._ops.append(obj)\\n\\n elif isinstance(obj, qml.operation.Operation) and not info.get(\\\"owner\\\", False):\\n # operation objects with no owners\\n\\n if self._measurements:\\n raise ValueError(\\n f\\\"Quantum operation {obj} must occur prior to any measurements.\\\"\\n )\\n\\n # invert the operation if required\\n obj.inverse = info.get(\\\"inverse\\\", False)\\n\\n if isinstance(obj, STATE_PREP_OPS):\\n if self._ops:\\n raise ValueError(\\n f\\\"State preparation operation {obj} must occur prior to any quantum operations.\\\"\\n )\\n\\n self._prep.append(obj)\\n else:\\n self._ops.append(obj)\\n\\n elif isinstance(obj, qml.measure.MeasurementProcess):\\n # measurement process\\n self._measurements.append(obj)\\n\\n # attempt to infer the output dimension\\n if obj.return_type is qml.operation.Probability:\\n self._output_dim += 2 ** len(obj.wires)\\n elif obj.return_type is qml.operation.State:\\n continue # the output_dim is worked out automatically\\n else:\\n self._output_dim += 1\\n\\n # check if any sampling is occuring\\n if obj.return_type is qml.operation.Sample:\\n self.is_sampled = True\\n\\n elif isinstance(obj, qml.operation.Observable) and \\\"owner\\\" not in info:\\n raise ValueError(f\\\"Observable {obj} does not have a measurement type specified.\\\")\\n\\n self._update()\\n\\n def _update_circuit_info(self):\\n \\\"\\\"\\\"Update circuit metadata\\\"\\\"\\\"\\n self.wires = qml.wires.Wires.all_wires(\\n [op.wires for op in self.operations + self.observables]\\n )\\n self.num_wires = len(self.wires)\\n\\n self.is_sampled = any(m.return_type is Sample for m in self.measurements)\\n self.all_sampled = all(m.return_type is Sample for m in self.measurements)\\n self.is_sampled = any(m.return_type is Sample for m in self.measurements)\\n\\n def _update_observables(self):\\n \\\"\\\"\\\"Update information about observables, including the wires that are acted upon and\\n identifying any observables that share wires\\\"\\\"\\\"\\n obs_wires = [wire for m in self.measurements for wire in m.wires if m.obs is not None]\\n self._obs_sharing_wires = []\\n self._obs_sharing_wires_id = []\\n\\n if len(obs_wires) != len(set(obs_wires)):\\n c = Counter(obs_wires)\\n repeated_wires = {w for w in obs_wires if c[w] > 1}\\n\\n for i, m in enumerate(self.measurements):\\n if m.obs is not None:\\n if len(set(m.wires) & repeated_wires) > 0:\\n self._obs_sharing_wires.append(m.obs)\\n self._obs_sharing_wires_id.append(i)\\n\\n def _update_par_info(self):\\n \\\"\\\"\\\"Update the parameter information dictionary\\\"\\\"\\\"\\n param_count = 0\\n\\n for obj in self.operations + self.observables:\\n\\n for p in range(len(obj.data)):\\n info = self._par_info.get(param_count, {})\\n info.update({\\\"op\\\": obj, \\\"p_idx\\\": p})\\n\\n self._par_info[param_count] = info\\n param_count += 1\\n\\n def _update_trainable_params(self):\\n \\\"\\\"\\\"Set the trainable parameters\\\"\\\"\\\"\\n self._trainable_params = set(self._par_info)\\n\\n def _update(self):\\n \\\"\\\"\\\"Update all internal tape metadata regarding processed operations and observables\\\"\\\"\\\"\\n self._graph = None\\n self._resources = None\\n self._depth = None\\n self._update_circuit_info()\\n self._update_par_info()\\n self._update_trainable_params()\\n self._update_observables()\\n\\n def expand(self, depth=1, stop_at=None, expand_measurements=False):\\n \\\"\\\"\\\"Expand all operations in the processed queue to a specific depth.\\n\\n Args:\\n depth (int): the depth the tape should be expanded\\n stop_at (Callable): A function which accepts a queue object,\\n and returns ``True`` if this object should *not* be expanded.\\n If not provided, all objects that support expansion will be expanded.\\n expand_measurements (bool): If ``True``, measurements will be expanded\\n to basis rotations and computational basis measurements.\\n\\n **Example**\\n\\n Consider the following nested tape:\\n\\n .. code-block:: python\\n\\n with JacobianTape() as tape:\\n qml.BasisState(np.array([1, 1]), wires=[0, 'a'])\\n\\n with JacobianTape() as tape2:\\n qml.Rot(0.543, 0.1, 0.4, wires=0)\\n\\n qml.CNOT(wires=[0, 'a'])\\n qml.RY(0.2, wires='a')\\n qml.probs(wires=0), qml.probs(wires='a')\\n\\n The nested structure is preserved:\\n\\n >>> tape.operations\\n [BasisState(array([1, 1]), wires=[0, 'a']),\\n <JacobianTape: wires=[0], params=3>,\\n CNOT(wires=[0, 'a']),\\n RY(0.2, wires=['a'])]\\n\\n Calling ``.expand`` will return a tape with all nested tapes\\n expanded, resulting in a single tape of quantum operations:\\n\\n >>> new_tape = tape.expand()\\n >>> new_tape.operations\\n [PauliX(wires=[0]),\\n PauliX(wires=['a']),\\n Rot(0.543, 0.1, 0.4, wires=[0]),\\n CNOT(wires=[0, 'a']),\\n RY(0.2, wires=['a'])]\\n \\\"\\\"\\\"\\n new_tape = expand_tape(\\n self, depth=depth, stop_at=stop_at, expand_measurements=expand_measurements\\n )\\n new_tape._update()\\n return new_tape\\n\\n def inv(self):\\n \\\"\\\"\\\"Inverts the processed operations.\\n\\n Inversion is performed in-place.\\n\\n .. note::\\n\\n This method only inverts the quantum operations/unitary recorded\\n by the quantum tape; state preparations and measurements are left unchanged.\\n\\n **Example**\\n\\n .. code-block:: python\\n\\n with JacobianTape() as tape:\\n qml.BasisState(np.array([1, 1]), wires=[0, 'a'])\\n qml.RX(0.432, wires=0)\\n qml.Rot(0.543, 0.1, 0.4, wires=0).inv()\\n qml.CNOT(wires=[0, 'a'])\\n qml.probs(wires=0), qml.probs(wires='a')\\n\\n This tape has the following properties:\\n\\n >>> tape.operations\\n [BasisState(array([1, 1]), wires=[0, 'a']),\\n RX(0.432, wires=[0]),\\n Rot.inv(0.543, 0.1, 0.4, wires=[0]),\\n CNOT(wires=[0, 'a'])]\\n >>> tape.get_parameters()\\n [array([1, 1]), 0.432, 0.543, 0.1, 0.4]\\n\\n Here, let's set some trainable parameters:\\n\\n >>> tape.trainable_params = {1, 2}\\n >>> tape.get_parameters()\\n [0.432, 0.543]\\n\\n Inverting the tape:\\n\\n >>> tape.inv()\\n >>> tape.operations\\n [BasisState(array([1, 1]), wires=[0, 'a']),\\n CNOT.inv(wires=[0, 'a']),\\n Rot(0.543, 0.1, 0.4, wires=[0]),\\n RX.inv(0.432, wires=[0])]\\n\\n Tape inversion also modifies the order of tape parameters:\\n\\n >>> tape.get_parameters(trainable_only=False)\\n [array([1, 1]), 0.543, 0.1, 0.4, 0.432]\\n >>> tape.get_parameters(trainable_only=True)\\n [0.543, 0.432]\\n >>> tape.trainable_params\\n {1, 4}\\n \\\"\\\"\\\"\\n # we must remap the old parameter\\n # indices to the new ones after the operation order is reversed.\\n parameter_indices = []\\n param_count = 0\\n\\n for queue in [self._prep, self._ops, self.observables]:\\n # iterate through all queues\\n\\n obj_params = []\\n\\n for obj in queue:\\n # index the number of parameters on each operation\\n num_obj_params = len(obj.data)\\n obj_params.append(list(range(param_count, param_count + num_obj_params)))\\n\\n # keep track of the total number of parameters encountered so far\\n param_count += num_obj_params\\n\\n if queue == self._ops:\\n # reverse the list representing operator parameters\\n obj_params = obj_params[::-1]\\n\\n parameter_indices.extend(obj_params)\\n\\n # flatten the list of parameter indices after the reversal\\n parameter_indices = [item for sublist in parameter_indices for item in sublist]\\n parameter_mapping = dict(zip(parameter_indices, range(len(parameter_indices))))\\n\\n # map the params\\n self.trainable_params = {parameter_mapping[i] for i in self.trainable_params}\\n self._par_info = {parameter_mapping[k]: v for k, v in self._par_info.items()}\\n\\n for op in self._ops:\\n op.inverse = not op.inverse\\n\\n self._ops = list(reversed(self._ops))\\n\\n # ========================================================\\n # Parameter handling\\n # ========================================================\\n\\n @property\\n def trainable_params(self):\\n \\\"\\\"\\\"Store or return a set containing the indices of parameters that support\\n differentiability. The indices provided match the order of appearence in the\\n quantum circuit.\\n\\n Setting this property can help reduce the number of quantum evaluations needed\\n to compute the Jacobian; parameters not marked as trainable will be\\n automatically excluded from the Jacobian computation.\\n\\n The number of trainable parameters determines the number of parameters passed to\\n :meth:`~.set_parameters`, :meth:`~.execute`, and :meth:`~.JacobianTape.jacobian`,\\n and changes the default output size of methods :meth:`~.JacobianTape.jacobian` and\\n :meth:`~.get_parameters()`.\\n\\n .. note::\\n\\n Since the :meth:`~.JacobianTape.jacobian` method is not called for devices that support\\n native backpropagation (such as ``default.qubit.tf`` and ``default.qubit.autograd``),\\n this property contains no relevant information when using backpropagation to compute gradients.\\n\\n **Example**\\n\\n .. code-block:: python\\n\\n with JacobianTape() as tape:\\n qml.RX(0.432, wires=0)\\n qml.RY(0.543, wires=0)\\n qml.CNOT(wires=[0, 'a'])\\n qml.RX(0.133, wires='a')\\n qml.expval(qml.PauliZ(wires=[0]))\\n\\n >>> tape.trainable_params\\n {0, 1, 2}\\n >>> tape.trainable_params = {0} # set only the first parameter as free\\n >>> tape.get_parameters()\\n [0.432]\\n\\n Args:\\n param_indices (set[int]): parameter indices\\n \\\"\\\"\\\"\\n return self._trainable_params\\n\\n @trainable_params.setter\\n def trainable_params(self, param_indices):\\n \\\"\\\"\\\"Store the indices of parameters that support differentiability.\\n\\n Args:\\n param_indices (set[int]): parameter indices\\n \\\"\\\"\\\"\\n if any(not isinstance(i, int) or i < 0 for i in param_indices):\\n raise ValueError(\\\"Argument indices must be positive integers.\\\")\\n\\n if any(i > len(self._par_info) for i in param_indices):\\n raise ValueError(f\\\"Tape has at most {self.num_params} parameters.\\\")\\n\\n self._trainable_params = param_indices\\n\\n def get_parameters(self, trainable_only=True, **kwargs): # pylint:disable=unused-argument\\n \\\"\\\"\\\"Return the parameters incident on the tape operations.\\n\\n The returned parameters are provided in order of appearance\\n on the tape.\\n\\n Args:\\n trainable_only (bool): if True, returns only trainable parameters\\n\\n **Example**\\n\\n .. code-block:: python\\n\\n with JacobianTape() as tape:\\n qml.RX(0.432, wires=0)\\n qml.RY(0.543, wires=0)\\n qml.CNOT(wires=[0, 'a'])\\n qml.RX(0.133, wires='a')\\n qml.expval(qml.PauliZ(wires=[0]))\\n\\n By default, all parameters are trainable and will be returned:\\n\\n >>> tape.get_parameters()\\n [0.432, 0.543, 0.133]\\n\\n Setting the trainable parameter indices will result in only the specified\\n parameters being returned:\\n\\n >>> tape.trainable_params = {1} # set the second parameter as free\\n >>> tape.get_parameters()\\n [0.543]\\n\\n The ``trainable_only`` argument can be set to ``False`` to instead return\\n all parameters:\\n\\n >>> tape.get_parameters(trainable_only=False)\\n [0.432, 0.543, 0.133]\\n \\\"\\\"\\\"\\n params = []\\n iterator = self.trainable_params if trainable_only else self._par_info\\n\\n for p_idx in iterator:\\n op = self._par_info[p_idx][\\\"op\\\"]\\n op_idx = self._par_info[p_idx][\\\"p_idx\\\"]\\n params.append(op.data[op_idx])\\n\\n return params\\n\\n def set_parameters(self, params, trainable_only=True):\\n \\\"\\\"\\\"Set the parameters incident on the tape operations.\\n\\n Args:\\n params (list[float]): A list of real numbers representing the\\n parameters of the quantum operations. The parameters should be\\n provided in order of appearance in the quantum tape.\\n trainable_only (bool): if True, set only trainable parameters\\n\\n **Example**\\n\\n .. code-block:: python\\n\\n with JacobianTape() as tape:\\n qml.RX(0.432, wires=0)\\n qml.RY(0.543, wires=0)\\n qml.CNOT(wires=[0, 'a'])\\n qml.RX(0.133, wires='a')\\n qml.expval(qml.PauliZ(wires=[0]))\\n\\n By default, all parameters are trainable and can be modified:\\n\\n >>> tape.set_parameters([0.1, 0.2, 0.3])\\n >>> tape.get_parameters()\\n [0.1, 0.2, 0.3]\\n\\n Setting the trainable parameter indices will result in only the specified\\n parameters being modifiable. Note that this only modifies the number of\\n parameters that must be passed.\\n\\n >>> tape.trainable_params = {0, 2} # set the first and third parameter as free\\n >>> tape.set_parameters([-0.1, 0.5])\\n >>> tape.get_parameters(trainable_only=False)\\n [-0.1, 0.2, 0.5]\\n\\n The ``trainable_only`` argument can be set to ``False`` to instead set\\n all parameters:\\n\\n >>> tape.set_parameters([4, 1, 6], trainable_only=False)\\n >>> tape.get_parameters(trainable_only=False)\\n [4, 1, 6]\\n \\\"\\\"\\\"\\n if trainable_only:\\n iterator = zip(self.trainable_params, params)\\n required_length = self.num_params\\n else:\\n iterator = enumerate(params)\\n required_length = len(self._par_info)\\n\\n if len(params) != required_length:\\n raise ValueError(\\\"Number of provided parameters does not match.\\\")\\n\\n for idx, p in iterator:\\n op = self._par_info[idx][\\\"op\\\"]\\n op.data[self._par_info[idx][\\\"p_idx\\\"]] = p\\n\\n # ========================================================\\n # Tape properties\\n # ========================================================\\n\\n @property\\n def operations(self):\\n \\\"\\\"\\\"Returns the operations on the quantum tape.\\n\\n Returns:\\n list[.Operation]: recorded quantum operations\\n\\n **Example**\\n\\n .. code-block:: python\\n\\n with JacobianTape() as tape:\\n qml.RX(0.432, wires=0)\\n qml.RY(0.543, wires=0)\\n qml.CNOT(wires=[0, 'a'])\\n qml.RX(0.133, wires='a')\\n qml.expval(qml.PauliZ(wires=[0]))\\n\\n >>> tape.operations\\n [RX(0.432, wires=[0]), RY(0.543, wires=[0]), CNOT(wires=[0, 'a']), RX(0.133, wires=['a'])]\\n \\\"\\\"\\\"\\n return self._prep + self._ops\\n\\n @property\\n def observables(self):\\n \\\"\\\"\\\"Returns the observables on the quantum tape.\\n\\n Returns:\\n list[.Observable]: list of recorded quantum operations\\n\\n **Example**\\n\\n .. code-block:: python\\n\\n with JacobianTape() as tape:\\n qml.RX(0.432, wires=0)\\n qml.RY(0.543, wires=0)\\n qml.CNOT(wires=[0, 'a'])\\n qml.RX(0.133, wires='a')\\n qml.expval(qml.PauliZ(wires=[0]))\\n\\n >>> tape.observables\\n [expval(PauliZ(wires=[0]))]\\n \\\"\\\"\\\"\\n # TODO: modify this property once devices\\n # have been refactored to accept and understand recieving\\n # measurement processes rather than specific observables.\\n obs = []\\n\\n for m in self._measurements:\\n if m.obs is not None:\\n m.obs.return_type = m.return_type\\n obs.append(m.obs)\\n else:\\n obs.append(m)\\n\\n return obs\\n\\n @property\\n def measurements(self):\\n \\\"\\\"\\\"Returns the measurements on the quantum tape.\\n\\n Returns:\\n list[.MeasurementProcess]: list of recorded measurement processess\\n\\n **Example**\\n\\n .. code-block:: python\\n\\n with JacobianTape() as tape:\\n qml.RX(0.432, wires=0)\\n qml.RY(0.543, wires=0)\\n qml.CNOT(wires=[0, 'a'])\\n qml.RX(0.133, wires='a')\\n qml.expval(qml.PauliZ(wires=[0]))\\n\\n >>> tape.measurements\\n [<pennylane.tape.measure.MeasurementProcess object at 0x7f10b2150c10>]\\n \\\"\\\"\\\"\\n return self._measurements\\n\\n @property\\n def num_params(self):\\n \\\"\\\"\\\"Returns the number of trainable parameters on the quantum tape.\\\"\\\"\\\"\\n return len(self.trainable_params)\\n\\n @property\\n def output_dim(self):\\n \\\"\\\"\\\"The (inferred) output dimension of the quantum tape.\\\"\\\"\\\"\\n return self._output_dim\\n\\n @property\\n def diagonalizing_gates(self):\\n \\\"\\\"\\\"Returns the gates that diagonalize the measured wires such that they\\n are in the eigenbasis of the circuit observables.\\n\\n Returns:\\n List[~.Operation]: the operations that diagonalize the observables\\n \\\"\\\"\\\"\\n rotation_gates = []\\n\\n for observable in self.observables:\\n rotation_gates.extend(observable.diagonalizing_gates())\\n\\n return rotation_gates\\n\\n @property\\n def graph(self):\\n \\\"\\\"\\\"Returns a directed acyclic graph representation of the recorded\\n quantum circuit:\\n\\n >>> tape.graph\\n <pennylane.circuit_graph.CircuitGraph object at 0x7fcc0433a690>\\n\\n Note that the circuit graph is only constructed once, on first call to this property,\\n and cached for future use.\\n\\n Returns:\\n .CircuitGraph: the circuit graph object\\n \\\"\\\"\\\"\\n if self._graph is None:\\n self._graph = qml.CircuitGraph(\\n self.operations, self.observables, self.wires, self._par_info, self.trainable_params\\n )\\n\\n return self._graph\\n\\n def get_resources(self):\\n \\\"\\\"\\\"Resource requirements of a quantum circuit.\\n\\n Returns:\\n dict[str, int]: how many times constituent operations are applied\\n\\n **Example**\\n\\n .. code-block:: python3\\n\\n with qml.tape.QuantumTape() as tape:\\n qml.Hadamard(wires=0)\\n qml.RZ(0.26, wires=1)\\n qml.CNOT(wires=[1, 0])\\n qml.Rot(1.8, -2.7, 0.2, wires=0)\\n qml.Hadamard(wires=1)\\n qml.CNOT(wires=[0, 1])\\n qml.expval(qml.PauliZ(0) @ qml.PauliZ(1))\\n\\n Asking for the resources produces a dictionary as shown below:\\n\\n >>> tape.get_resources()\\n {'Hadamard': 2, 'RZ': 1, 'CNOT': 2, 'Rot': 1}\\n \\\"\\\"\\\"\\n if self._resources is None:\\n self._resources = {}\\n\\n for op in self.operations:\\n if op.name not in self._resources.keys():\\n self._resources[op.name] = 1\\n else:\\n self._resources[op.name] += 1\\n\\n return self._resources\\n\\n def get_depth(self):\\n \\\"\\\"\\\"Depth of the quantum circuit.\\n\\n Returns:\\n int: Circuit depth, computed as the longest path in the circuit's directed acyclic graph representation.\\n\\n **Example**\\n\\n .. code-block:: python3\\n\\n with QuantumTape() as tape:\\n qml.Hadamard(wires=0)\\n qml.PauliX(wires=1)\\n qml.CRX(2.3, wires=[0, 1])\\n qml.Rot(1.2, 3.2, 0.7, wires=[1])\\n qml.CRX(-2.3, wires=[0, 1])\\n qml.expval(qml.PauliZ(0) @ qml.PauliZ(1))\\n\\n The depth can be obtained like so:\\n\\n >>> tape.get_depth()\\n 4\\n \\\"\\\"\\\"\\n if self._depth is None:\\n self._depth = self.graph.get_depth()\\n\\n return self._depth\\n\\n def draw(self, charset=\\\"unicode\\\", wire_order=None, show_all_wires=False):\\n \\\"\\\"\\\"Draw the quantum tape as a circuit diagram.\\n\\n Consider the following circuit as an example:\\n\\n .. code-block:: python3\\n\\n with QuantumTape() as tape:\\n qml.Hadamard(0)\\n qml.CRX(2.3, wires=[0, 1])\\n qml.Rot(1.2, 3.2, 0.7, wires=[1])\\n qml.CRX(-2.3, wires=[0, 1])\\n qml.expval(qml.PauliZ(0) @ qml.PauliZ(1))\\n\\n We can draw the tape after construction:\\n\\n >>> print(tape.draw())\\n 0: ──H──╭C────────────────────────────╭C─────────╭┤ ⟨Z ⊗ Z⟩\\n 1: ─────╰RX(2.3)──Rot(1.2, 3.2, 0.7)──╰RX(-2.3)──╰┤ ⟨Z ⊗ Z⟩\\n >>> print(tape.draw(charset=\\\"ascii\\\"))\\n 0: --H--+C----------------------------+C---------+| <Z @ Z>\\n 1: -----+RX(2.3)--Rot(1.2, 3.2, 0.7)--+RX(-2.3)--+| <Z @ Z>\\n\\n Args:\\n charset (str, optional): The charset that should be used. Currently, \\\"unicode\\\" and\\n \\\"ascii\\\" are supported.\\n wire_order (Sequence[Any]): the order (from top to bottom) to print the wires of the circuit\\n show_all_wires (bool): If True, all wires, including empty wires, are printed.\\n\\n Raises:\\n ValueError: if the given charset is not supported\\n\\n Returns:\\n str: the circuit representation of the tape\\n \\\"\\\"\\\"\\n return self.graph.draw(\\n charset=charset,\\n wire_order=wire_order,\\n show_all_wires=show_all_wires,\\n )\\n\\n def to_openqasm(self, wires=None, rotations=True):\\n \\\"\\\"\\\"Serialize the circuit as an OpenQASM 2.0 program.\\n\\n Only operations are serialized; all measurements\\n are assumed to take place in the computational basis.\\n\\n .. note::\\n\\n The serialized OpenQASM program assumes that gate definitions\\n in ``qelib1.inc`` are available.\\n\\n Args:\\n wires (Wires or None): the wires to use when serializing the circuit\\n rotations (bool): in addition to serializing user-specified\\n operations, also include the gates that diagonalize the\\n measured wires such that they are in the eigenbasis of the circuit observables.\\n\\n Returns:\\n str: OpenQASM serialization of the circuit\\n \\\"\\\"\\\"\\n # We import decompose_queue here to avoid a circular import\\n wires = wires or self.wires\\n\\n # add the QASM headers\\n qasm_str = \\\"OPENQASM 2.0;\\\\n\\\"\\n qasm_str += 'include \\\"qelib1.inc\\\";\\\\n'\\n\\n if self.num_wires == 0:\\n # empty circuit\\n return qasm_str\\n\\n # create the quantum and classical registers\\n qasm_str += \\\"qreg q[{}];\\\\n\\\".format(len(wires))\\n qasm_str += \\\"creg c[{}];\\\\n\\\".format(len(wires))\\n\\n # get the user applied circuit operations\\n operations = self.operations\\n\\n if rotations:\\n # if requested, append diagonalizing gates corresponding\\n # to circuit observables\\n operations += self.diagonalizing_gates\\n\\n with QuantumTape() as tape:\\n for op in operations:\\n op.queue()\\n\\n if op.inverse:\\n op.inv()\\n\\n # decompose the queue\\n operations = tape.expand(depth=2, stop_at=lambda obj: obj.name in OPENQASM_GATES).operations\\n\\n # create the QASM code representing the operations\\n for op in operations:\\n try:\\n gate = OPENQASM_GATES[op.name]\\n except KeyError as e:\\n raise ValueError(f\\\"Operation {op.name} not supported by the QASM serializer\\\") from e\\n\\n wire_labels = \\\",\\\".join([f\\\"q[{wires.index(w)}]\\\" for w in op.wires.tolist()])\\n params = \\\"\\\"\\n\\n if op.num_params > 0:\\n # If the operation takes parameters, construct a string\\n # with parameter values.\\n params = \\\"(\\\" + \\\",\\\".join([str(p) for p in op.parameters]) + \\\")\\\"\\n\\n qasm_str += \\\"{name}{params} {wires};\\\\n\\\".format(\\n name=gate, params=params, wires=wire_labels\\n )\\n\\n # apply computational basis measurements to each quantum register\\n # NOTE: This is not strictly necessary, we could inspect self.observables,\\n # and then only measure wires which are requested by the user. However,\\n # some devices which consume QASM require all registers be measured, so\\n # measure all wires to be safe.\\n for wire in range(len(wires)):\\n qasm_str += \\\"measure q[{wire}] -> c[{wire}];\\\\n\\\".format(wire=wire)\\n\\n return qasm_str\\n\\n @property\\n def data(self):\\n \\\"\\\"\\\"Alias to :meth:`~.get_parameters` and :meth:`~.set_parameters`\\n for backwards compatibilities with operations.\\\"\\\"\\\"\\n return self.get_parameters(trainable_only=False)\\n\\n @data.setter\\n def data(self, params):\\n self.set_parameters(params, trainable_only=False)\\n\\n def copy(self, copy_operations=False, tape_cls=None):\\n \\\"\\\"\\\"Returns a shallow copy of the quantum tape.\\n\\n Args:\\n copy_operations (bool): If True, the tape operations are also shallow copied.\\n Otherwise, if False, the copied tape operations will simply be references\\n to the original tape operations; changing the parameters of one tape will likewise\\n change the parameters of all copies.\\n tape_cls (.QuantumTape): Cast the copied tape to a specific quantum tape subclass.\\n If not provided, the same subclass is used as the original tape.\\n\\n Returns:\\n .QuantumTape: a shallow copy of the tape\\n \\\"\\\"\\\"\\n if tape_cls is None:\\n tape = self.__class__()\\n else:\\n tape = tape_cls()\\n\\n if copy_operations:\\n # Perform a shallow copy of all operations in the state prep, operation, and measurement\\n # queues. The operations will continue to share data with the original tape operations\\n # unless modified.\\n tape._prep = [copy.copy(op) for op in self._prep]\\n tape._ops = [copy.copy(op) for op in self._ops]\\n tape._measurements = [copy.copy(op) for op in self._measurements]\\n else:\\n # Perform a shallow copy of the state prep, operation, and measurement queues. The\\n # operations within the queues will be references to the original tape operations;\\n # changing the original operations will always alter the operations on the copied tape.\\n tape._prep = self._prep.copy()\\n tape._ops = self._ops.copy()\\n tape._measurements = self._measurements.copy()\\n\\n tape._update()\\n tape.trainable_params = self.trainable_params.copy()\\n\\n return tape\\n\\n def __copy__(self):\\n return self.copy(copy_operations=True)\\n\\n # ========================================================\\n # execution methods\\n # ========================================================\\n\\n def execute(self, device, params=None):\\n \\\"\\\"\\\"Execute the tape on a quantum device.\\n\\n Args:\\n device (.Device): a PennyLane device\\n that can execute quantum operations and return measurement statistics\\n params (list[Any]): The quantum tape operation parameters. If not provided,\\n the current tape parameters are used (via :meth:`~.get_parameters`).\\n\\n **Example**\\n\\n .. code-block:: python\\n\\n with JacobianTape() as tape:\\n qml.RX(0.432, wires=0)\\n qml.RY(0.543, wires=0)\\n qml.CNOT(wires=[0, 'a'])\\n qml.RX(0.133, wires='a')\\n qml.probs(wires=[0, 'a'])\\n\\n If parameters are not provided, the existing tape parameters are used:\\n\\n >>> dev = qml.device(\\\"default.qubit\\\", wires=[0, 'a'])\\n >>> tape.execute(dev)\\n array([[8.84828969e-01, 3.92449987e-03, 4.91235209e-04, 1.10755296e-01]])\\n\\n Parameters can be optionally passed during execution:\\n\\n >>> tape.execute(dev, params=[1.0, 0.0, 1.0])\\n array([[0.5931328 , 0.17701835, 0.05283049, 0.17701835]])\\n\\n Parameters provided for execution are temporary, and do not affect\\n the tapes' parameters in-place:\\n\\n >>> tape.get_parameters()\\n [0.432, 0.543, 0.133]\\n \\\"\\\"\\\"\\n if params is None:\\n params = self.get_parameters()\\n\\n return self._execute(params, device=device)\\n\\n def execute_device(self, params, device):\\n \\\"\\\"\\\"Execute the tape on a quantum device.\\n\\n This is a low-level method, intended to be called by an interface,\\n and does not support autodifferentiation.\\n\\n For more details on differentiable tape execution, see :meth:`~.execute`.\\n\\n Args:\\n device (~.Device): a PennyLane device\\n that can execute quantum operations and return measurement statistics\\n params (list[Any]): The quantum tape operation parameters. If not provided,\\n the current tape parameter values are used (via :meth:`~.get_parameters`).\\n \\\"\\\"\\\"\\n if not all(len(o.diagonalizing_gates()) == 0 for o in self._obs_sharing_wires):\\n raise qml.QuantumFunctionError(\\n \\\"Multiple observables are being evaluated on the same wire. Call tape.expand() \\\"\\n \\\"prior to execution to support this.\\\"\\n )\\n\\n device.reset()\\n\\n # backup the current parameters\\n saved_parameters = self.get_parameters()\\n\\n # temporarily mutate the in-place parameters\\n self.set_parameters(params)\\n\\n if isinstance(device, qml.QubitDevice):\\n res = device.execute(self)\\n else:\\n res = device.execute(self.operations, self.observables, {})\\n\\n # Update output dim if incorrect.\\n # Note that we cannot assume the type of `res`, so\\n # we use duck typing to catch any 'array like' object.\\n try:\\n if isinstance(res, np.ndarray) and res.dtype is np.dtype(\\\"object\\\"):\\n output_dim = sum([len(i) for i in res])\\n else:\\n output_dim = np.prod(res.shape)\\n\\n if self.output_dim != output_dim:\\n # update the inferred output dimension with the correct value\\n self._output_dim = output_dim\\n\\n except (AttributeError, TypeError):\\n # unable to determine the output dimension\\n pass\\n\\n # restore original parameters\\n self.set_parameters(saved_parameters)\\n\\n return res\\n\\n # interfaces can optionally override the _execute method\\n # if they need to perform any logic in between the user's\\n # call to tape.execute and the internal call to tape.execute_device.\\n _execute = execute_device\\n\",\n \"path\": \"pennylane/tape/tape.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/.github/CHANGELOG.md b/.github/CHANGELOG.md\nindex 456e825913d..adfa21c146c 100644\n--- a/.github/CHANGELOG.md\n+++ b/.github/CHANGELOG.md\n@@ -773,6 +773,9 @@\n second-order observable.\n [(#1197)](https://github.com/PennyLaneAI/pennylane/pull/1197)\n \n+* Fixes a bug where repeated Torch interface applications after expansion caused an error.\n+ [(#1223)](https://github.com/PennyLaneAI/pennylane/pull/1223)\n+\n <h3>Documentation</h3>\n \n - Typos addressed in templates documentation.\ndiff --git a/pennylane/tape/tape.py b/pennylane/tape/tape.py\nindex 60764fcf6d7..674575d1b0c 100644\n--- a/pennylane/tape/tape.py\n+++ b/pennylane/tape/tape.py\n@@ -153,6 +153,7 @@ def expand_tape(tape, depth=1, stop_at=None, expand_measurements=False):\n stop_at = lambda obj: False\n \n new_tape = tape.__class__()\n+ new_tape.__bare__ = getattr(tape, \"__bare__\", tape.__class__)\n \n # Check for observables acting on the same wire. If present, observables must be\n # qubit-wise commuting Pauli words. In this case, the tape is expanded with joint\ndiff --git a/tests/interfaces/test_tape_torch.py b/tests/interfaces/test_tape_torch.py\nindex 144104e1d78..8e9963d1876 100644\n--- a/tests/interfaces/test_tape_torch.py\n+++ b/tests/interfaces/test_tape_torch.py\n@@ -453,3 +453,24 @@ def test_complex_min_version(self, monkeypatch):\n m.setattr(qml.interfaces.torch, \"COMPLEX_SUPPORT\", False)\r\n with pytest.raises(qml.QuantumFunctionError, match=r\"Version 1\\.6\\.0 or above of PyTorch\"):\r\n TorchInterface.apply(JacobianTape(), dtype=torch.complex128)\r\n+\r\n+ def test_repeated_application_after_expand(self, tol):\r\n+ \"\"\"Test that the Torch interface continues to work after\r\n+ tape expansions, and repeated torch application\"\"\"\r\n+ n_qubits = 2\r\n+ dev = qml.device(\"default.qubit\", wires=n_qubits)\r\n+\r\n+ weights = torch.ones((3,))\r\n+\r\n+ with TorchInterface.apply(qml.tape.QuantumTape()) as tape:\r\n+ qml.U3(*weights, wires=0)\r\n+ qml.expval(qml.PauliZ(wires=0))\r\n+\r\n+ tape = tape.expand()\r\n+\r\n+ res1 = tape.execute(dev)\r\n+\r\n+ TorchInterface.apply(tape)\r\n+ res2 = tape.execute(dev)\r\n+\r\n+ assert np.allclose(res1, res2, atol=tol, rtol=0)\r\n"}}},{"rowIdx":5497,"cells":{"in_source_id":{"kind":"string","value":"certbot__certbot-5192"},"issue":{"kind":"string","value":"We shouldn't be adding a commented out renewal block during the same run as adding an uncommented one when deploying certs with multiple domains\n\n"},"before_files":{"kind":"list like","value":[{"content":"\"\"\"Nginx Configuration\"\"\"\nimport logging\nimport os\nimport re\nimport socket\nimport subprocess\nimport tempfile\nimport time\n\nimport OpenSSL\nimport six\nimport zope.interface\n\nfrom acme import challenges\nfrom acme import crypto_util as acme_crypto_util\n\nfrom certbot import constants as core_constants\nfrom certbot import crypto_util\nfrom certbot import errors\nfrom certbot import interfaces\nfrom certbot import util\n\nfrom certbot.plugins import common\n\nfrom certbot_nginx import constants\nfrom certbot_nginx import tls_sni_01\nfrom certbot_nginx import parser\n\n\nlogger = logging.getLogger(__name__)\n\nREDIRECT_BLOCK = [[\n ['\\n ', 'if', ' ', '($scheme', ' ', '!=', ' ', '\"https\") '],\n [['\\n ', 'return', ' ', '301', ' ', 'https://$host$request_uri'],\n '\\n ']\n], ['\\n']]\n\nTEST_REDIRECT_BLOCK = [\n [\n ['if', '($scheme', '!=', '\"https\")'],\n [\n ['return', '301', 'https://$host$request_uri']\n ]\n ],\n ['#', ' managed by Certbot']\n]\n\nREDIRECT_COMMENT_BLOCK = [\n ['\\n ', '#', ' Redirect non-https traffic to https'],\n ['\\n ', '#', ' if ($scheme != \"https\") {'],\n ['\\n ', '#', \" return 301 https://$host$request_uri;\"],\n ['\\n ', '#', \" } # managed by Certbot\"],\n ['\\n']\n]\n\nTEST_REDIRECT_COMMENT_BLOCK = [\n ['#', ' Redirect non-https traffic to https'],\n ['#', ' if ($scheme != \"https\") {'],\n ['#', \" return 301 https://$host$request_uri;\"],\n ['#', \" } # managed by Certbot\"],\n]\n\n@zope.interface.implementer(interfaces.IAuthenticator, interfaces.IInstaller)\n@zope.interface.provider(interfaces.IPluginFactory)\nclass NginxConfigurator(common.Installer):\n # pylint: disable=too-many-instance-attributes,too-many-public-methods\n \"\"\"Nginx configurator.\n\n .. todo:: Add proper support for comments in the config. Currently,\n config files modified by the configurator will lose all their comments.\n\n :ivar config: Configuration.\n :type config: :class:`~certbot.interfaces.IConfig`\n\n :ivar parser: Handles low level parsing\n :type parser: :class:`~certbot_nginx.parser`\n\n :ivar str save_notes: Human-readable config change notes\n\n :ivar reverter: saves and reverts checkpoints\n :type reverter: :class:`certbot.reverter.Reverter`\n\n :ivar tup version: version of Nginx\n\n \"\"\"\n\n description = \"Nginx Web Server plugin - Alpha\"\n\n DEFAULT_LISTEN_PORT = '80'\n\n @classmethod\n def add_parser_arguments(cls, add):\n add(\"server-root\", default=constants.CLI_DEFAULTS[\"server_root\"],\n help=\"Nginx server root directory.\")\n add(\"ctl\", default=constants.CLI_DEFAULTS[\"ctl\"], help=\"Path to the \"\n \"'nginx' binary, used for 'configtest' and retrieving nginx \"\n \"version number.\")\n\n @property\n def nginx_conf(self):\n \"\"\"Nginx config file path.\"\"\"\n return os.path.join(self.conf(\"server_root\"), \"nginx.conf\")\n\n def __init__(self, *args, **kwargs):\n \"\"\"Initialize an Nginx Configurator.\n\n :param tup version: version of Nginx as a tuple (1, 4, 7)\n (used mostly for unittesting)\n\n \"\"\"\n version = kwargs.pop(\"version\", None)\n super(NginxConfigurator, self).__init__(*args, **kwargs)\n\n # Verify that all directories and files exist with proper permissions\n self._verify_setup()\n\n # Files to save\n self.save_notes = \"\"\n\n # For creating new vhosts if no names match\n self.new_vhost = None\n\n # Add number of outstanding challenges\n self._chall_out = 0\n\n # These will be set in the prepare function\n self.parser = None\n self.version = version\n self._enhance_func = {\"redirect\": self._enable_redirect,\n \"staple-ocsp\": self._enable_ocsp_stapling}\n\n self.reverter.recovery_routine()\n\n @property\n def mod_ssl_conf(self):\n \"\"\"Full absolute path to SSL configuration file.\"\"\"\n return os.path.join(self.config.config_dir, constants.MOD_SSL_CONF_DEST)\n\n @property\n def updated_mod_ssl_conf_digest(self):\n \"\"\"Full absolute path to digest of updated SSL configuration file.\"\"\"\n return os.path.join(self.config.config_dir, constants.UPDATED_MOD_SSL_CONF_DIGEST)\n\n # This is called in determine_authenticator and determine_installer\n def prepare(self):\n \"\"\"Prepare the authenticator/installer.\n\n :raises .errors.NoInstallationError: If Nginx ctl cannot be found\n :raises .errors.MisconfigurationError: If Nginx is misconfigured\n \"\"\"\n # Verify Nginx is installed\n if not util.exe_exists(self.conf('ctl')):\n raise errors.NoInstallationError\n\n # Make sure configuration is valid\n self.config_test()\n\n\n self.parser = parser.NginxParser(self.conf('server-root'))\n\n install_ssl_options_conf(self.mod_ssl_conf, self.updated_mod_ssl_conf_digest)\n\n self.install_ssl_dhparams()\n\n # Set Version\n if self.version is None:\n self.version = self.get_version()\n\n # Prevent two Nginx plugins from modifying a config at once\n try:\n util.lock_dir_until_exit(self.conf('server-root'))\n except (OSError, errors.LockError):\n logger.debug('Encountered error:', exc_info=True)\n raise errors.PluginError(\n 'Unable to lock %s', self.conf('server-root'))\n\n # Entry point in main.py for installing cert\n def deploy_cert(self, domain, cert_path, key_path,\n chain_path=None, fullchain_path=None):\n # pylint: disable=unused-argument\n \"\"\"Deploys certificate to specified virtual host.\n\n .. note:: Aborts if the vhost is missing ssl_certificate or\n ssl_certificate_key.\n\n .. note:: This doesn't save the config files!\n\n :raises errors.PluginError: When unable to deploy certificate due to\n a lack of directives or configuration\n\n \"\"\"\n if not fullchain_path:\n raise errors.PluginError(\n \"The nginx plugin currently requires --fullchain-path to \"\n \"install a cert.\")\n\n vhost = self.choose_vhost(domain, raise_if_no_match=False)\n if vhost is None:\n vhost = self._vhost_from_duplicated_default(domain)\n cert_directives = [['\\n ', 'ssl_certificate', ' ', fullchain_path],\n ['\\n ', 'ssl_certificate_key', ' ', key_path]]\n\n self.parser.add_server_directives(vhost,\n cert_directives, replace=True)\n logger.info(\"Deployed Certificate to VirtualHost %s for %s\",\n vhost.filep, vhost.names)\n\n self.save_notes += (\"Changed vhost at %s with addresses of %s\\n\" %\n (vhost.filep,\n \", \".join(str(addr) for addr in vhost.addrs)))\n self.save_notes += \"\\tssl_certificate %s\\n\" % fullchain_path\n self.save_notes += \"\\tssl_certificate_key %s\\n\" % key_path\n\n #######################\n # Vhost parsing methods\n #######################\n def choose_vhost(self, target_name, raise_if_no_match=True):\n \"\"\"Chooses a virtual host based on the given domain name.\n\n .. note:: This makes the vhost SSL-enabled if it isn't already. Follows\n Nginx's server block selection rules preferring blocks that are\n already SSL.\n\n .. todo:: This should maybe return list if no obvious answer\n is presented.\n\n .. todo:: The special name \"$hostname\" corresponds to the machine's\n hostname. Currently we just ignore this.\n\n :param str target_name: domain name\n :param bool raise_if_no_match: True iff not finding a match is an error;\n otherwise, return None\n\n :returns: ssl vhost associated with name\n :rtype: :class:`~certbot_nginx.obj.VirtualHost`\n\n \"\"\"\n vhost = None\n\n matches = self._get_ranked_matches(target_name)\n vhost = self._select_best_name_match(matches)\n if not vhost:\n if raise_if_no_match:\n # No matches. Raise a misconfiguration error.\n raise errors.MisconfigurationError(\n (\"Cannot find a VirtualHost matching domain %s. \"\n \"In order for Certbot to correctly perform the challenge \"\n \"please add a corresponding server_name directive to your \"\n \"nginx configuration: \"\n \"https://nginx.org/en/docs/http/server_names.html\") % (target_name))\n else:\n return None\n else:\n # Note: if we are enhancing with ocsp, vhost should already be ssl.\n if not vhost.ssl:\n self._make_server_ssl(vhost)\n\n return vhost\n\n def _vhost_from_duplicated_default(self, domain):\n if self.new_vhost is None:\n default_vhost = self._get_default_vhost()\n self.new_vhost = self.parser.create_new_vhost_from_default(default_vhost)\n if not self.new_vhost.ssl:\n self._make_server_ssl(self.new_vhost)\n self.new_vhost.names = set()\n\n self.new_vhost.names.add(domain)\n name_block = [['\\n ', 'server_name', ' ', ' '.join(self.new_vhost.names)]]\n self.parser.add_server_directives(self.new_vhost, name_block, replace=True)\n return self.new_vhost\n\n def _get_default_vhost(self):\n vhost_list = self.parser.get_vhosts()\n # if one has default_server set, return that one\n default_vhosts = []\n for vhost in vhost_list:\n for addr in vhost.addrs:\n if addr.default:\n default_vhosts.append(vhost)\n break\n\n if len(default_vhosts) == 1:\n return default_vhosts[0]\n\n # TODO: present a list of vhosts for user to choose from\n\n raise errors.MisconfigurationError(\"Could not automatically find a matching server\"\n \" block. Set the `server_name` directive to use the Nginx installer.\")\n\n def _get_ranked_matches(self, target_name):\n \"\"\"Returns a ranked list of vhosts that match target_name.\n The ranking gives preference to SSL vhosts.\n\n :param str target_name: The name to match\n :returns: list of dicts containing the vhost, the matching name, and\n the numerical rank\n :rtype: list\n\n \"\"\"\n vhost_list = self.parser.get_vhosts()\n return self._rank_matches_by_name_and_ssl(vhost_list, target_name)\n\n def _select_best_name_match(self, matches):\n \"\"\"Returns the best name match of a ranked list of vhosts.\n\n :param list matches: list of dicts containing the vhost, the matching name,\n and the numerical rank\n :returns: the most matching vhost\n :rtype: :class:`~certbot_nginx.obj.VirtualHost`\n\n \"\"\"\n if not matches:\n return None\n elif matches[0]['rank'] in six.moves.range(2, 6):\n # Wildcard match - need to find the longest one\n rank = matches[0]['rank']\n wildcards = [x for x in matches if x['rank'] == rank]\n return max(wildcards, key=lambda x: len(x['name']))['vhost']\n else:\n # Exact or regex match\n return matches[0]['vhost']\n\n\n def _rank_matches_by_name_and_ssl(self, vhost_list, target_name):\n \"\"\"Returns a ranked list of vhosts from vhost_list that match target_name.\n The ranking gives preference to SSL vhosts.\n\n :param list vhost_list: list of vhosts to filter and rank\n :param str target_name: The name to match\n :returns: list of dicts containing the vhost, the matching name, and\n the numerical rank\n :rtype: list\n\n \"\"\"\n # Nginx chooses a matching server name for a request with precedence:\n # 1. exact name match\n # 2. longest wildcard name starting with *\n # 3. longest wildcard name ending with *\n # 4. first matching regex in order of appearance in the file\n matches = []\n for vhost in vhost_list:\n name_type, name = parser.get_best_match(target_name, vhost.names)\n if name_type == 'exact':\n matches.append({'vhost': vhost,\n 'name': name,\n 'rank': 0 if vhost.ssl else 1})\n elif name_type == 'wildcard_start':\n matches.append({'vhost': vhost,\n 'name': name,\n 'rank': 2 if vhost.ssl else 3})\n elif name_type == 'wildcard_end':\n matches.append({'vhost': vhost,\n 'name': name,\n 'rank': 4 if vhost.ssl else 5})\n elif name_type == 'regex':\n matches.append({'vhost': vhost,\n 'name': name,\n 'rank': 6 if vhost.ssl else 7})\n return sorted(matches, key=lambda x: x['rank'])\n\n\n def choose_redirect_vhost(self, target_name, port):\n \"\"\"Chooses a single virtual host for redirect enhancement.\n\n Chooses the vhost most closely matching target_name that is\n listening to port without using ssl.\n\n .. todo:: This should maybe return list if no obvious answer\n is presented.\n\n .. todo:: The special name \"$hostname\" corresponds to the machine's\n hostname. Currently we just ignore this.\n\n :param str target_name: domain name\n :param str port: port number\n :returns: vhost associated with name\n :rtype: :class:`~certbot_nginx.obj.VirtualHost`\n\n \"\"\"\n matches = self._get_redirect_ranked_matches(target_name, port)\n return self._select_best_name_match(matches)\n\n def _get_redirect_ranked_matches(self, target_name, port):\n \"\"\"Gets a ranked list of plaintextish port-listening vhosts matching target_name\n\n Filter all hosts for those listening on port without using ssl.\n Rank by how well these match target_name.\n\n :param str target_name: The name to match\n :param str port: port number\n :returns: list of dicts containing the vhost, the matching name, and\n the numerical rank\n :rtype: list\n\n \"\"\"\n all_vhosts = self.parser.get_vhosts()\n def _port_matches(test_port, matching_port):\n # test_port is a number, matching is a number or \"\" or None\n if matching_port == \"\" or matching_port is None:\n # if no port is specified, Nginx defaults to listening on port 80.\n return test_port == self.DEFAULT_LISTEN_PORT\n else:\n return test_port == matching_port\n\n def _vhost_matches(vhost, port):\n found_matching_port = False\n if len(vhost.addrs) == 0:\n # if there are no listen directives at all, Nginx defaults to\n # listening on port 80.\n found_matching_port = (port == self.DEFAULT_LISTEN_PORT)\n else:\n for addr in vhost.addrs:\n if _port_matches(port, addr.get_port()) and addr.ssl == False:\n found_matching_port = True\n\n if found_matching_port:\n # make sure we don't have an 'ssl on' directive\n return not self.parser.has_ssl_on_directive(vhost)\n else:\n return False\n\n matching_vhosts = [vhost for vhost in all_vhosts if _vhost_matches(vhost, port)]\n\n # We can use this ranking function because sslishness doesn't matter to us, and\n # there shouldn't be conflicting plaintextish servers listening on 80.\n return self._rank_matches_by_name_and_ssl(matching_vhosts, target_name)\n\n def get_all_names(self):\n \"\"\"Returns all names found in the Nginx Configuration.\n\n :returns: All ServerNames, ServerAliases, and reverse DNS entries for\n virtual host addresses\n :rtype: set\n\n \"\"\"\n all_names = set()\n\n for vhost in self.parser.get_vhosts():\n all_names.update(vhost.names)\n\n for addr in vhost.addrs:\n host = addr.get_addr()\n if common.hostname_regex.match(host):\n # If it's a hostname, add it to the names.\n all_names.add(host)\n elif not common.private_ips_regex.match(host):\n # If it isn't a private IP, do a reverse DNS lookup\n # TODO: IPv6 support\n try:\n socket.inet_aton(host)\n all_names.add(socket.gethostbyaddr(host)[0])\n except (socket.error, socket.herror, socket.timeout):\n continue\n\n return util.get_filtered_names(all_names)\n\n def _get_snakeoil_paths(self):\n # TODO: generate only once\n tmp_dir = os.path.join(self.config.work_dir, \"snakeoil\")\n le_key = crypto_util.init_save_key(\n key_size=1024, key_dir=tmp_dir, keyname=\"key.pem\")\n key = OpenSSL.crypto.load_privatekey(\n OpenSSL.crypto.FILETYPE_PEM, le_key.pem)\n cert = acme_crypto_util.gen_ss_cert(key, domains=[socket.gethostname()])\n cert_pem = OpenSSL.crypto.dump_certificate(\n OpenSSL.crypto.FILETYPE_PEM, cert)\n cert_file, cert_path = util.unique_file(\n os.path.join(tmp_dir, \"cert.pem\"), mode=\"wb\")\n with cert_file:\n cert_file.write(cert_pem)\n return cert_path, le_key.file\n\n def _make_server_ssl(self, vhost):\n \"\"\"Make a server SSL.\n\n Make a server SSL based on server_name and filename by adding a\n ``listen IConfig.tls_sni_01_port ssl`` directive to the server block.\n\n .. todo:: Maybe this should create a new block instead of modifying\n the existing one?\n\n :param vhost: The vhost to add SSL to.\n :type vhost: :class:`~certbot_nginx.obj.VirtualHost`\n\n \"\"\"\n # If the vhost was implicitly listening on the default Nginx port,\n # have it continue to do so.\n if len(vhost.addrs) == 0:\n listen_block = [['\\n ', 'listen', ' ', self.DEFAULT_LISTEN_PORT]]\n self.parser.add_server_directives(vhost, listen_block, replace=False)\n\n snakeoil_cert, snakeoil_key = self._get_snakeoil_paths()\n\n ssl_block = ([\n ['\\n ', 'listen', ' ', '{0} ssl'.format(self.config.tls_sni_01_port)],\n ['\\n ', 'ssl_certificate', ' ', snakeoil_cert],\n ['\\n ', 'ssl_certificate_key', ' ', snakeoil_key],\n ['\\n ', 'include', ' ', self.mod_ssl_conf],\n ['\\n ', 'ssl_dhparam', ' ', self.ssl_dhparams],\n ])\n\n self.parser.add_server_directives(\n vhost, ssl_block, replace=False)\n\n ##################################\n # enhancement methods (IInstaller)\n ##################################\n def supported_enhancements(self): # pylint: disable=no-self-use\n \"\"\"Returns currently supported enhancements.\"\"\"\n return ['redirect', 'staple-ocsp']\n\n def enhance(self, domain, enhancement, options=None):\n \"\"\"Enhance configuration.\n\n :param str domain: domain to enhance\n :param str enhancement: enhancement type defined in\n :const:`~certbot.constants.ENHANCEMENTS`\n :param options: options for the enhancement\n See :const:`~certbot.constants.ENHANCEMENTS`\n documentation for appropriate parameter.\n\n \"\"\"\n try:\n return self._enhance_func[enhancement](domain, options)\n except (KeyError, ValueError):\n raise errors.PluginError(\n \"Unsupported enhancement: {0}\".format(enhancement))\n except errors.PluginError:\n logger.warning(\"Failed %s for %s\", enhancement, domain)\n raise\n\n def _has_certbot_redirect(self, vhost):\n return vhost.contains_list(TEST_REDIRECT_BLOCK)\n\n def _has_certbot_redirect_comment(self, vhost):\n return vhost.contains_list(TEST_REDIRECT_COMMENT_BLOCK)\n\n def _add_redirect_block(self, vhost, active=True):\n \"\"\"Add redirect directive to vhost\n \"\"\"\n if active:\n redirect_block = REDIRECT_BLOCK\n else:\n redirect_block = REDIRECT_COMMENT_BLOCK\n\n self.parser.add_server_directives(\n vhost, redirect_block, replace=False)\n\n def _enable_redirect(self, domain, unused_options):\n \"\"\"Redirect all equivalent HTTP traffic to ssl_vhost.\n\n Add rewrite directive to non https traffic\n\n .. note:: This function saves the configuration\n\n :param str domain: domain to enable redirect for\n :param unused_options: Not currently used\n :type unused_options: Not Available\n \"\"\"\n\n port = self.DEFAULT_LISTEN_PORT\n vhost = None\n # If there are blocks listening plaintextishly on self.DEFAULT_LISTEN_PORT,\n # choose the most name-matching one.\n vhost = self.choose_redirect_vhost(domain, port)\n\n if vhost is None:\n logger.info(\"No matching insecure server blocks listening on port %s found.\",\n self.DEFAULT_LISTEN_PORT)\n else:\n if self._has_certbot_redirect(vhost):\n logger.info(\"Traffic on port %s already redirecting to ssl in %s\",\n self.DEFAULT_LISTEN_PORT, vhost.filep)\n elif vhost.has_redirect():\n if not self._has_certbot_redirect_comment(vhost):\n self._add_redirect_block(vhost, active=False)\n logger.info(\"The appropriate server block is already redirecting \"\n \"traffic. To enable redirect anyway, uncomment the \"\n \"redirect lines in %s.\", vhost.filep)\n else:\n # Redirect plaintextish host to https\n self._add_redirect_block(vhost, active=True)\n logger.info(\"Redirecting all traffic on port %s to ssl in %s\",\n self.DEFAULT_LISTEN_PORT, vhost.filep)\n\n def _enable_ocsp_stapling(self, domain, chain_path):\n \"\"\"Include OCSP response in TLS handshake\n\n :param str domain: domain to enable OCSP response for\n :param chain_path: chain file path\n :type chain_path: `str` or `None`\n\n \"\"\"\n vhost = self.choose_vhost(domain)\n if self.version < (1, 3, 7):\n raise errors.PluginError(\"Version 1.3.7 or greater of nginx \"\n \"is needed to enable OCSP stapling\")\n\n if chain_path is None:\n raise errors.PluginError(\n \"--chain-path is required to enable \"\n \"Online Certificate Status Protocol (OCSP) stapling \"\n \"on nginx >= 1.3.7.\")\n\n stapling_directives = [\n ['\\n ', 'ssl_trusted_certificate', ' ', chain_path],\n ['\\n ', 'ssl_stapling', ' ', 'on'],\n ['\\n ', 'ssl_stapling_verify', ' ', 'on'], ['\\n']]\n\n try:\n self.parser.add_server_directives(vhost,\n stapling_directives, replace=False)\n except errors.MisconfigurationError as error:\n logger.debug(error)\n raise errors.PluginError(\"An error occurred while enabling OCSP \"\n \"stapling for {0}.\".format(vhost.names))\n\n self.save_notes += (\"OCSP Stapling was enabled \"\n \"on SSL Vhost: {0}.\\n\".format(vhost.filep))\n self.save_notes += \"\\tssl_trusted_certificate {0}\\n\".format(chain_path)\n self.save_notes += \"\\tssl_stapling on\\n\"\n self.save_notes += \"\\tssl_stapling_verify on\\n\"\n\n ######################################\n # Nginx server management (IInstaller)\n ######################################\n def restart(self):\n \"\"\"Restarts nginx server.\n\n :raises .errors.MisconfigurationError: If either the reload fails.\n\n \"\"\"\n nginx_restart(self.conf('ctl'), self.nginx_conf)\n\n def config_test(self): # pylint: disable=no-self-use\n \"\"\"Check the configuration of Nginx for errors.\n\n :raises .errors.MisconfigurationError: If config_test fails\n\n \"\"\"\n try:\n util.run_script([self.conf('ctl'), \"-c\", self.nginx_conf, \"-t\"])\n except errors.SubprocessError as err:\n raise errors.MisconfigurationError(str(err))\n\n def _verify_setup(self):\n \"\"\"Verify the setup to ensure safe operating environment.\n\n Make sure that files/directories are setup with appropriate permissions\n Aim for defensive coding... make sure all input files\n have permissions of root.\n\n \"\"\"\n uid = os.geteuid()\n util.make_or_verify_dir(\n self.config.work_dir, core_constants.CONFIG_DIRS_MODE, uid)\n util.make_or_verify_dir(\n self.config.backup_dir, core_constants.CONFIG_DIRS_MODE, uid)\n util.make_or_verify_dir(\n self.config.config_dir, core_constants.CONFIG_DIRS_MODE, uid)\n\n def get_version(self):\n \"\"\"Return version of Nginx Server.\n\n Version is returned as tuple. (ie. 2.4.7 = (2, 4, 7))\n\n :returns: version\n :rtype: tuple\n\n :raises .PluginError:\n Unable to find Nginx version or version is unsupported\n\n \"\"\"\n try:\n proc = subprocess.Popen(\n [self.conf('ctl'), \"-c\", self.nginx_conf, \"-V\"],\n stdout=subprocess.PIPE,\n stderr=subprocess.PIPE,\n universal_newlines=True)\n text = proc.communicate()[1] # nginx prints output to stderr\n except (OSError, ValueError) as error:\n logger.debug(error, exc_info=True)\n raise errors.PluginError(\n \"Unable to run %s -V\" % self.conf('ctl'))\n\n version_regex = re.compile(r\"nginx/([0-9\\.]*)\", re.IGNORECASE)\n version_matches = version_regex.findall(text)\n\n sni_regex = re.compile(r\"TLS SNI support enabled\", re.IGNORECASE)\n sni_matches = sni_regex.findall(text)\n\n ssl_regex = re.compile(r\" --with-http_ssl_module\")\n ssl_matches = ssl_regex.findall(text)\n\n if not version_matches:\n raise errors.PluginError(\"Unable to find Nginx version\")\n if not ssl_matches:\n raise errors.PluginError(\n \"Nginx build is missing SSL module (--with-http_ssl_module).\")\n if not sni_matches:\n raise errors.PluginError(\"Nginx build doesn't support SNI\")\n\n nginx_version = tuple([int(i) for i in version_matches[0].split(\".\")])\n\n # nginx < 0.8.48 uses machine hostname as default server_name instead of\n # the empty string\n if nginx_version < (0, 8, 48):\n raise errors.NotSupportedError(\"Nginx version must be 0.8.48+\")\n\n return nginx_version\n\n def more_info(self):\n \"\"\"Human-readable string to help understand the module\"\"\"\n return (\n \"Configures Nginx to authenticate and install HTTPS.{0}\"\n \"Server root: {root}{0}\"\n \"Version: {version}\".format(\n os.linesep, root=self.parser.config_root,\n version=\".\".join(str(i) for i in self.version))\n )\n\n ###################################################\n # Wrapper functions for Reverter class (IInstaller)\n ###################################################\n def save(self, title=None, temporary=False):\n \"\"\"Saves all changes to the configuration files.\n\n :param str title: The title of the save. If a title is given, the\n configuration will be saved as a new checkpoint and put in a\n timestamped directory.\n\n :param bool temporary: Indicates whether the changes made will\n be quickly reversed in the future (ie. challenges)\n\n :raises .errors.PluginError: If there was an error in\n an attempt to save the configuration, or an error creating a\n checkpoint\n\n \"\"\"\n save_files = set(self.parser.parsed.keys())\n self.add_to_checkpoint(save_files, self.save_notes, temporary)\n self.save_notes = \"\"\n\n # Change 'ext' to something else to not override existing conf files\n self.parser.filedump(ext='')\n if title and not temporary:\n self.finalize_checkpoint(title)\n\n def recovery_routine(self):\n \"\"\"Revert all previously modified files.\n\n Reverts all modified files that have not been saved as a checkpoint\n\n :raises .errors.PluginError: If unable to recover the configuration\n\n \"\"\"\n super(NginxConfigurator, self).recovery_routine()\n self.parser.load()\n\n def revert_challenge_config(self):\n \"\"\"Used to cleanup challenge configurations.\n\n :raises .errors.PluginError: If unable to revert the challenge config.\n\n \"\"\"\n self.revert_temporary_config()\n self.parser.load()\n\n def rollback_checkpoints(self, rollback=1):\n \"\"\"Rollback saved checkpoints.\n\n :param int rollback: Number of checkpoints to revert\n\n :raises .errors.PluginError: If there is a problem with the input or\n the function is unable to correctly revert the configuration\n\n \"\"\"\n super(NginxConfigurator, self).rollback_checkpoints(rollback)\n self.parser.load()\n\n ###########################################################################\n # Challenges Section for IAuthenticator\n ###########################################################################\n def get_chall_pref(self, unused_domain): # pylint: disable=no-self-use\n \"\"\"Return list of challenge preferences.\"\"\"\n return [challenges.TLSSNI01]\n\n # Entry point in main.py for performing challenges\n def perform(self, achalls):\n \"\"\"Perform the configuration related challenge.\n\n This function currently assumes all challenges will be fulfilled.\n If this turns out not to be the case in the future. Cleanup and\n outstanding challenges will have to be designed better.\n\n \"\"\"\n self._chall_out += len(achalls)\n responses = [None] * len(achalls)\n chall_doer = tls_sni_01.NginxTlsSni01(self)\n\n for i, achall in enumerate(achalls):\n # Currently also have chall_doer hold associated index of the\n # challenge. This helps to put all of the responses back together\n # when they are all complete.\n chall_doer.add_chall(achall, i)\n\n sni_response = chall_doer.perform()\n # Must restart in order to activate the challenges.\n # Handled here because we may be able to load up other challenge types\n self.restart()\n\n # Go through all of the challenges and assign them to the proper place\n # in the responses return value. All responses must be in the same order\n # as the original challenges.\n for i, resp in enumerate(sni_response):\n responses[chall_doer.indices[i]] = resp\n\n return responses\n\n # called after challenges are performed\n def cleanup(self, achalls):\n \"\"\"Revert all challenges.\"\"\"\n self._chall_out -= len(achalls)\n\n # If all of the challenges have been finished, clean up everything\n if self._chall_out <= 0:\n self.revert_challenge_config()\n self.restart()\n\n\ndef nginx_restart(nginx_ctl, nginx_conf):\n \"\"\"Restarts the Nginx Server.\n\n .. todo:: Nginx restart is fatal if the configuration references\n non-existent SSL cert/key files. Remove references to /etc/letsencrypt\n before restart.\n\n :param str nginx_ctl: Path to the Nginx binary.\n\n \"\"\"\n try:\n proc = subprocess.Popen([nginx_ctl, \"-c\", nginx_conf, \"-s\", \"reload\"])\n proc.communicate()\n\n if proc.returncode != 0:\n # Maybe Nginx isn't running\n # Write to temporary files instead of piping because of communication issues on Arch\n # https://github.com/certbot/certbot/issues/4324\n with tempfile.TemporaryFile() as out:\n with tempfile.TemporaryFile() as err:\n nginx_proc = subprocess.Popen([nginx_ctl, \"-c\", nginx_conf],\n stdout=out, stderr=err)\n nginx_proc.communicate()\n if nginx_proc.returncode != 0:\n # Enter recovery routine...\n raise errors.MisconfigurationError(\n \"nginx restart failed:\\n%s\\n%s\" % (out.read(), err.read()))\n\n except (OSError, ValueError):\n raise errors.MisconfigurationError(\"nginx restart failed\")\n # Nginx can take a moment to recognize a newly added TLS SNI servername, so sleep\n # for a second. TODO: Check for expected servername and loop until it\n # appears or return an error if looping too long.\n time.sleep(1)\n\n\ndef install_ssl_options_conf(options_ssl, options_ssl_digest):\n \"\"\"Copy Certbot's SSL options file into the system's config dir if required.\"\"\"\n return common.install_version_controlled_file(options_ssl, options_ssl_digest,\n constants.MOD_SSL_CONF_SRC, constants.ALL_SSL_OPTIONS_HASHES)\n","path":"certbot-nginx/certbot_nginx/configurator.py"}],"string":"[\n {\n \"content\": \"\\\"\\\"\\\"Nginx Configuration\\\"\\\"\\\"\\nimport logging\\nimport os\\nimport re\\nimport socket\\nimport subprocess\\nimport tempfile\\nimport time\\n\\nimport OpenSSL\\nimport six\\nimport zope.interface\\n\\nfrom acme import challenges\\nfrom acme import crypto_util as acme_crypto_util\\n\\nfrom certbot import constants as core_constants\\nfrom certbot import crypto_util\\nfrom certbot import errors\\nfrom certbot import interfaces\\nfrom certbot import util\\n\\nfrom certbot.plugins import common\\n\\nfrom certbot_nginx import constants\\nfrom certbot_nginx import tls_sni_01\\nfrom certbot_nginx import parser\\n\\n\\nlogger = logging.getLogger(__name__)\\n\\nREDIRECT_BLOCK = [[\\n ['\\\\n ', 'if', ' ', '($scheme', ' ', '!=', ' ', '\\\"https\\\") '],\\n [['\\\\n ', 'return', ' ', '301', ' ', 'https://$host$request_uri'],\\n '\\\\n ']\\n], ['\\\\n']]\\n\\nTEST_REDIRECT_BLOCK = [\\n [\\n ['if', '($scheme', '!=', '\\\"https\\\")'],\\n [\\n ['return', '301', 'https://$host$request_uri']\\n ]\\n ],\\n ['#', ' managed by Certbot']\\n]\\n\\nREDIRECT_COMMENT_BLOCK = [\\n ['\\\\n ', '#', ' Redirect non-https traffic to https'],\\n ['\\\\n ', '#', ' if ($scheme != \\\"https\\\") {'],\\n ['\\\\n ', '#', \\\" return 301 https://$host$request_uri;\\\"],\\n ['\\\\n ', '#', \\\" } # managed by Certbot\\\"],\\n ['\\\\n']\\n]\\n\\nTEST_REDIRECT_COMMENT_BLOCK = [\\n ['#', ' Redirect non-https traffic to https'],\\n ['#', ' if ($scheme != \\\"https\\\") {'],\\n ['#', \\\" return 301 https://$host$request_uri;\\\"],\\n ['#', \\\" } # managed by Certbot\\\"],\\n]\\n\\n@zope.interface.implementer(interfaces.IAuthenticator, interfaces.IInstaller)\\n@zope.interface.provider(interfaces.IPluginFactory)\\nclass NginxConfigurator(common.Installer):\\n # pylint: disable=too-many-instance-attributes,too-many-public-methods\\n \\\"\\\"\\\"Nginx configurator.\\n\\n .. todo:: Add proper support for comments in the config. Currently,\\n config files modified by the configurator will lose all their comments.\\n\\n :ivar config: Configuration.\\n :type config: :class:`~certbot.interfaces.IConfig`\\n\\n :ivar parser: Handles low level parsing\\n :type parser: :class:`~certbot_nginx.parser`\\n\\n :ivar str save_notes: Human-readable config change notes\\n\\n :ivar reverter: saves and reverts checkpoints\\n :type reverter: :class:`certbot.reverter.Reverter`\\n\\n :ivar tup version: version of Nginx\\n\\n \\\"\\\"\\\"\\n\\n description = \\\"Nginx Web Server plugin - Alpha\\\"\\n\\n DEFAULT_LISTEN_PORT = '80'\\n\\n @classmethod\\n def add_parser_arguments(cls, add):\\n add(\\\"server-root\\\", default=constants.CLI_DEFAULTS[\\\"server_root\\\"],\\n help=\\\"Nginx server root directory.\\\")\\n add(\\\"ctl\\\", default=constants.CLI_DEFAULTS[\\\"ctl\\\"], help=\\\"Path to the \\\"\\n \\\"'nginx' binary, used for 'configtest' and retrieving nginx \\\"\\n \\\"version number.\\\")\\n\\n @property\\n def nginx_conf(self):\\n \\\"\\\"\\\"Nginx config file path.\\\"\\\"\\\"\\n return os.path.join(self.conf(\\\"server_root\\\"), \\\"nginx.conf\\\")\\n\\n def __init__(self, *args, **kwargs):\\n \\\"\\\"\\\"Initialize an Nginx Configurator.\\n\\n :param tup version: version of Nginx as a tuple (1, 4, 7)\\n (used mostly for unittesting)\\n\\n \\\"\\\"\\\"\\n version = kwargs.pop(\\\"version\\\", None)\\n super(NginxConfigurator, self).__init__(*args, **kwargs)\\n\\n # Verify that all directories and files exist with proper permissions\\n self._verify_setup()\\n\\n # Files to save\\n self.save_notes = \\\"\\\"\\n\\n # For creating new vhosts if no names match\\n self.new_vhost = None\\n\\n # Add number of outstanding challenges\\n self._chall_out = 0\\n\\n # These will be set in the prepare function\\n self.parser = None\\n self.version = version\\n self._enhance_func = {\\\"redirect\\\": self._enable_redirect,\\n \\\"staple-ocsp\\\": self._enable_ocsp_stapling}\\n\\n self.reverter.recovery_routine()\\n\\n @property\\n def mod_ssl_conf(self):\\n \\\"\\\"\\\"Full absolute path to SSL configuration file.\\\"\\\"\\\"\\n return os.path.join(self.config.config_dir, constants.MOD_SSL_CONF_DEST)\\n\\n @property\\n def updated_mod_ssl_conf_digest(self):\\n \\\"\\\"\\\"Full absolute path to digest of updated SSL configuration file.\\\"\\\"\\\"\\n return os.path.join(self.config.config_dir, constants.UPDATED_MOD_SSL_CONF_DIGEST)\\n\\n # This is called in determine_authenticator and determine_installer\\n def prepare(self):\\n \\\"\\\"\\\"Prepare the authenticator/installer.\\n\\n :raises .errors.NoInstallationError: If Nginx ctl cannot be found\\n :raises .errors.MisconfigurationError: If Nginx is misconfigured\\n \\\"\\\"\\\"\\n # Verify Nginx is installed\\n if not util.exe_exists(self.conf('ctl')):\\n raise errors.NoInstallationError\\n\\n # Make sure configuration is valid\\n self.config_test()\\n\\n\\n self.parser = parser.NginxParser(self.conf('server-root'))\\n\\n install_ssl_options_conf(self.mod_ssl_conf, self.updated_mod_ssl_conf_digest)\\n\\n self.install_ssl_dhparams()\\n\\n # Set Version\\n if self.version is None:\\n self.version = self.get_version()\\n\\n # Prevent two Nginx plugins from modifying a config at once\\n try:\\n util.lock_dir_until_exit(self.conf('server-root'))\\n except (OSError, errors.LockError):\\n logger.debug('Encountered error:', exc_info=True)\\n raise errors.PluginError(\\n 'Unable to lock %s', self.conf('server-root'))\\n\\n # Entry point in main.py for installing cert\\n def deploy_cert(self, domain, cert_path, key_path,\\n chain_path=None, fullchain_path=None):\\n # pylint: disable=unused-argument\\n \\\"\\\"\\\"Deploys certificate to specified virtual host.\\n\\n .. note:: Aborts if the vhost is missing ssl_certificate or\\n ssl_certificate_key.\\n\\n .. note:: This doesn't save the config files!\\n\\n :raises errors.PluginError: When unable to deploy certificate due to\\n a lack of directives or configuration\\n\\n \\\"\\\"\\\"\\n if not fullchain_path:\\n raise errors.PluginError(\\n \\\"The nginx plugin currently requires --fullchain-path to \\\"\\n \\\"install a cert.\\\")\\n\\n vhost = self.choose_vhost(domain, raise_if_no_match=False)\\n if vhost is None:\\n vhost = self._vhost_from_duplicated_default(domain)\\n cert_directives = [['\\\\n ', 'ssl_certificate', ' ', fullchain_path],\\n ['\\\\n ', 'ssl_certificate_key', ' ', key_path]]\\n\\n self.parser.add_server_directives(vhost,\\n cert_directives, replace=True)\\n logger.info(\\\"Deployed Certificate to VirtualHost %s for %s\\\",\\n vhost.filep, vhost.names)\\n\\n self.save_notes += (\\\"Changed vhost at %s with addresses of %s\\\\n\\\" %\\n (vhost.filep,\\n \\\", \\\".join(str(addr) for addr in vhost.addrs)))\\n self.save_notes += \\\"\\\\tssl_certificate %s\\\\n\\\" % fullchain_path\\n self.save_notes += \\\"\\\\tssl_certificate_key %s\\\\n\\\" % key_path\\n\\n #######################\\n # Vhost parsing methods\\n #######################\\n def choose_vhost(self, target_name, raise_if_no_match=True):\\n \\\"\\\"\\\"Chooses a virtual host based on the given domain name.\\n\\n .. note:: This makes the vhost SSL-enabled if it isn't already. Follows\\n Nginx's server block selection rules preferring blocks that are\\n already SSL.\\n\\n .. todo:: This should maybe return list if no obvious answer\\n is presented.\\n\\n .. todo:: The special name \\\"$hostname\\\" corresponds to the machine's\\n hostname. Currently we just ignore this.\\n\\n :param str target_name: domain name\\n :param bool raise_if_no_match: True iff not finding a match is an error;\\n otherwise, return None\\n\\n :returns: ssl vhost associated with name\\n :rtype: :class:`~certbot_nginx.obj.VirtualHost`\\n\\n \\\"\\\"\\\"\\n vhost = None\\n\\n matches = self._get_ranked_matches(target_name)\\n vhost = self._select_best_name_match(matches)\\n if not vhost:\\n if raise_if_no_match:\\n # No matches. Raise a misconfiguration error.\\n raise errors.MisconfigurationError(\\n (\\\"Cannot find a VirtualHost matching domain %s. \\\"\\n \\\"In order for Certbot to correctly perform the challenge \\\"\\n \\\"please add a corresponding server_name directive to your \\\"\\n \\\"nginx configuration: \\\"\\n \\\"https://nginx.org/en/docs/http/server_names.html\\\") % (target_name))\\n else:\\n return None\\n else:\\n # Note: if we are enhancing with ocsp, vhost should already be ssl.\\n if not vhost.ssl:\\n self._make_server_ssl(vhost)\\n\\n return vhost\\n\\n def _vhost_from_duplicated_default(self, domain):\\n if self.new_vhost is None:\\n default_vhost = self._get_default_vhost()\\n self.new_vhost = self.parser.create_new_vhost_from_default(default_vhost)\\n if not self.new_vhost.ssl:\\n self._make_server_ssl(self.new_vhost)\\n self.new_vhost.names = set()\\n\\n self.new_vhost.names.add(domain)\\n name_block = [['\\\\n ', 'server_name', ' ', ' '.join(self.new_vhost.names)]]\\n self.parser.add_server_directives(self.new_vhost, name_block, replace=True)\\n return self.new_vhost\\n\\n def _get_default_vhost(self):\\n vhost_list = self.parser.get_vhosts()\\n # if one has default_server set, return that one\\n default_vhosts = []\\n for vhost in vhost_list:\\n for addr in vhost.addrs:\\n if addr.default:\\n default_vhosts.append(vhost)\\n break\\n\\n if len(default_vhosts) == 1:\\n return default_vhosts[0]\\n\\n # TODO: present a list of vhosts for user to choose from\\n\\n raise errors.MisconfigurationError(\\\"Could not automatically find a matching server\\\"\\n \\\" block. Set the `server_name` directive to use the Nginx installer.\\\")\\n\\n def _get_ranked_matches(self, target_name):\\n \\\"\\\"\\\"Returns a ranked list of vhosts that match target_name.\\n The ranking gives preference to SSL vhosts.\\n\\n :param str target_name: The name to match\\n :returns: list of dicts containing the vhost, the matching name, and\\n the numerical rank\\n :rtype: list\\n\\n \\\"\\\"\\\"\\n vhost_list = self.parser.get_vhosts()\\n return self._rank_matches_by_name_and_ssl(vhost_list, target_name)\\n\\n def _select_best_name_match(self, matches):\\n \\\"\\\"\\\"Returns the best name match of a ranked list of vhosts.\\n\\n :param list matches: list of dicts containing the vhost, the matching name,\\n and the numerical rank\\n :returns: the most matching vhost\\n :rtype: :class:`~certbot_nginx.obj.VirtualHost`\\n\\n \\\"\\\"\\\"\\n if not matches:\\n return None\\n elif matches[0]['rank'] in six.moves.range(2, 6):\\n # Wildcard match - need to find the longest one\\n rank = matches[0]['rank']\\n wildcards = [x for x in matches if x['rank'] == rank]\\n return max(wildcards, key=lambda x: len(x['name']))['vhost']\\n else:\\n # Exact or regex match\\n return matches[0]['vhost']\\n\\n\\n def _rank_matches_by_name_and_ssl(self, vhost_list, target_name):\\n \\\"\\\"\\\"Returns a ranked list of vhosts from vhost_list that match target_name.\\n The ranking gives preference to SSL vhosts.\\n\\n :param list vhost_list: list of vhosts to filter and rank\\n :param str target_name: The name to match\\n :returns: list of dicts containing the vhost, the matching name, and\\n the numerical rank\\n :rtype: list\\n\\n \\\"\\\"\\\"\\n # Nginx chooses a matching server name for a request with precedence:\\n # 1. exact name match\\n # 2. longest wildcard name starting with *\\n # 3. longest wildcard name ending with *\\n # 4. first matching regex in order of appearance in the file\\n matches = []\\n for vhost in vhost_list:\\n name_type, name = parser.get_best_match(target_name, vhost.names)\\n if name_type == 'exact':\\n matches.append({'vhost': vhost,\\n 'name': name,\\n 'rank': 0 if vhost.ssl else 1})\\n elif name_type == 'wildcard_start':\\n matches.append({'vhost': vhost,\\n 'name': name,\\n 'rank': 2 if vhost.ssl else 3})\\n elif name_type == 'wildcard_end':\\n matches.append({'vhost': vhost,\\n 'name': name,\\n 'rank': 4 if vhost.ssl else 5})\\n elif name_type == 'regex':\\n matches.append({'vhost': vhost,\\n 'name': name,\\n 'rank': 6 if vhost.ssl else 7})\\n return sorted(matches, key=lambda x: x['rank'])\\n\\n\\n def choose_redirect_vhost(self, target_name, port):\\n \\\"\\\"\\\"Chooses a single virtual host for redirect enhancement.\\n\\n Chooses the vhost most closely matching target_name that is\\n listening to port without using ssl.\\n\\n .. todo:: This should maybe return list if no obvious answer\\n is presented.\\n\\n .. todo:: The special name \\\"$hostname\\\" corresponds to the machine's\\n hostname. Currently we just ignore this.\\n\\n :param str target_name: domain name\\n :param str port: port number\\n :returns: vhost associated with name\\n :rtype: :class:`~certbot_nginx.obj.VirtualHost`\\n\\n \\\"\\\"\\\"\\n matches = self._get_redirect_ranked_matches(target_name, port)\\n return self._select_best_name_match(matches)\\n\\n def _get_redirect_ranked_matches(self, target_name, port):\\n \\\"\\\"\\\"Gets a ranked list of plaintextish port-listening vhosts matching target_name\\n\\n Filter all hosts for those listening on port without using ssl.\\n Rank by how well these match target_name.\\n\\n :param str target_name: The name to match\\n :param str port: port number\\n :returns: list of dicts containing the vhost, the matching name, and\\n the numerical rank\\n :rtype: list\\n\\n \\\"\\\"\\\"\\n all_vhosts = self.parser.get_vhosts()\\n def _port_matches(test_port, matching_port):\\n # test_port is a number, matching is a number or \\\"\\\" or None\\n if matching_port == \\\"\\\" or matching_port is None:\\n # if no port is specified, Nginx defaults to listening on port 80.\\n return test_port == self.DEFAULT_LISTEN_PORT\\n else:\\n return test_port == matching_port\\n\\n def _vhost_matches(vhost, port):\\n found_matching_port = False\\n if len(vhost.addrs) == 0:\\n # if there are no listen directives at all, Nginx defaults to\\n # listening on port 80.\\n found_matching_port = (port == self.DEFAULT_LISTEN_PORT)\\n else:\\n for addr in vhost.addrs:\\n if _port_matches(port, addr.get_port()) and addr.ssl == False:\\n found_matching_port = True\\n\\n if found_matching_port:\\n # make sure we don't have an 'ssl on' directive\\n return not self.parser.has_ssl_on_directive(vhost)\\n else:\\n return False\\n\\n matching_vhosts = [vhost for vhost in all_vhosts if _vhost_matches(vhost, port)]\\n\\n # We can use this ranking function because sslishness doesn't matter to us, and\\n # there shouldn't be conflicting plaintextish servers listening on 80.\\n return self._rank_matches_by_name_and_ssl(matching_vhosts, target_name)\\n\\n def get_all_names(self):\\n \\\"\\\"\\\"Returns all names found in the Nginx Configuration.\\n\\n :returns: All ServerNames, ServerAliases, and reverse DNS entries for\\n virtual host addresses\\n :rtype: set\\n\\n \\\"\\\"\\\"\\n all_names = set()\\n\\n for vhost in self.parser.get_vhosts():\\n all_names.update(vhost.names)\\n\\n for addr in vhost.addrs:\\n host = addr.get_addr()\\n if common.hostname_regex.match(host):\\n # If it's a hostname, add it to the names.\\n all_names.add(host)\\n elif not common.private_ips_regex.match(host):\\n # If it isn't a private IP, do a reverse DNS lookup\\n # TODO: IPv6 support\\n try:\\n socket.inet_aton(host)\\n all_names.add(socket.gethostbyaddr(host)[0])\\n except (socket.error, socket.herror, socket.timeout):\\n continue\\n\\n return util.get_filtered_names(all_names)\\n\\n def _get_snakeoil_paths(self):\\n # TODO: generate only once\\n tmp_dir = os.path.join(self.config.work_dir, \\\"snakeoil\\\")\\n le_key = crypto_util.init_save_key(\\n key_size=1024, key_dir=tmp_dir, keyname=\\\"key.pem\\\")\\n key = OpenSSL.crypto.load_privatekey(\\n OpenSSL.crypto.FILETYPE_PEM, le_key.pem)\\n cert = acme_crypto_util.gen_ss_cert(key, domains=[socket.gethostname()])\\n cert_pem = OpenSSL.crypto.dump_certificate(\\n OpenSSL.crypto.FILETYPE_PEM, cert)\\n cert_file, cert_path = util.unique_file(\\n os.path.join(tmp_dir, \\\"cert.pem\\\"), mode=\\\"wb\\\")\\n with cert_file:\\n cert_file.write(cert_pem)\\n return cert_path, le_key.file\\n\\n def _make_server_ssl(self, vhost):\\n \\\"\\\"\\\"Make a server SSL.\\n\\n Make a server SSL based on server_name and filename by adding a\\n ``listen IConfig.tls_sni_01_port ssl`` directive to the server block.\\n\\n .. todo:: Maybe this should create a new block instead of modifying\\n the existing one?\\n\\n :param vhost: The vhost to add SSL to.\\n :type vhost: :class:`~certbot_nginx.obj.VirtualHost`\\n\\n \\\"\\\"\\\"\\n # If the vhost was implicitly listening on the default Nginx port,\\n # have it continue to do so.\\n if len(vhost.addrs) == 0:\\n listen_block = [['\\\\n ', 'listen', ' ', self.DEFAULT_LISTEN_PORT]]\\n self.parser.add_server_directives(vhost, listen_block, replace=False)\\n\\n snakeoil_cert, snakeoil_key = self._get_snakeoil_paths()\\n\\n ssl_block = ([\\n ['\\\\n ', 'listen', ' ', '{0} ssl'.format(self.config.tls_sni_01_port)],\\n ['\\\\n ', 'ssl_certificate', ' ', snakeoil_cert],\\n ['\\\\n ', 'ssl_certificate_key', ' ', snakeoil_key],\\n ['\\\\n ', 'include', ' ', self.mod_ssl_conf],\\n ['\\\\n ', 'ssl_dhparam', ' ', self.ssl_dhparams],\\n ])\\n\\n self.parser.add_server_directives(\\n vhost, ssl_block, replace=False)\\n\\n ##################################\\n # enhancement methods (IInstaller)\\n ##################################\\n def supported_enhancements(self): # pylint: disable=no-self-use\\n \\\"\\\"\\\"Returns currently supported enhancements.\\\"\\\"\\\"\\n return ['redirect', 'staple-ocsp']\\n\\n def enhance(self, domain, enhancement, options=None):\\n \\\"\\\"\\\"Enhance configuration.\\n\\n :param str domain: domain to enhance\\n :param str enhancement: enhancement type defined in\\n :const:`~certbot.constants.ENHANCEMENTS`\\n :param options: options for the enhancement\\n See :const:`~certbot.constants.ENHANCEMENTS`\\n documentation for appropriate parameter.\\n\\n \\\"\\\"\\\"\\n try:\\n return self._enhance_func[enhancement](domain, options)\\n except (KeyError, ValueError):\\n raise errors.PluginError(\\n \\\"Unsupported enhancement: {0}\\\".format(enhancement))\\n except errors.PluginError:\\n logger.warning(\\\"Failed %s for %s\\\", enhancement, domain)\\n raise\\n\\n def _has_certbot_redirect(self, vhost):\\n return vhost.contains_list(TEST_REDIRECT_BLOCK)\\n\\n def _has_certbot_redirect_comment(self, vhost):\\n return vhost.contains_list(TEST_REDIRECT_COMMENT_BLOCK)\\n\\n def _add_redirect_block(self, vhost, active=True):\\n \\\"\\\"\\\"Add redirect directive to vhost\\n \\\"\\\"\\\"\\n if active:\\n redirect_block = REDIRECT_BLOCK\\n else:\\n redirect_block = REDIRECT_COMMENT_BLOCK\\n\\n self.parser.add_server_directives(\\n vhost, redirect_block, replace=False)\\n\\n def _enable_redirect(self, domain, unused_options):\\n \\\"\\\"\\\"Redirect all equivalent HTTP traffic to ssl_vhost.\\n\\n Add rewrite directive to non https traffic\\n\\n .. note:: This function saves the configuration\\n\\n :param str domain: domain to enable redirect for\\n :param unused_options: Not currently used\\n :type unused_options: Not Available\\n \\\"\\\"\\\"\\n\\n port = self.DEFAULT_LISTEN_PORT\\n vhost = None\\n # If there are blocks listening plaintextishly on self.DEFAULT_LISTEN_PORT,\\n # choose the most name-matching one.\\n vhost = self.choose_redirect_vhost(domain, port)\\n\\n if vhost is None:\\n logger.info(\\\"No matching insecure server blocks listening on port %s found.\\\",\\n self.DEFAULT_LISTEN_PORT)\\n else:\\n if self._has_certbot_redirect(vhost):\\n logger.info(\\\"Traffic on port %s already redirecting to ssl in %s\\\",\\n self.DEFAULT_LISTEN_PORT, vhost.filep)\\n elif vhost.has_redirect():\\n if not self._has_certbot_redirect_comment(vhost):\\n self._add_redirect_block(vhost, active=False)\\n logger.info(\\\"The appropriate server block is already redirecting \\\"\\n \\\"traffic. To enable redirect anyway, uncomment the \\\"\\n \\\"redirect lines in %s.\\\", vhost.filep)\\n else:\\n # Redirect plaintextish host to https\\n self._add_redirect_block(vhost, active=True)\\n logger.info(\\\"Redirecting all traffic on port %s to ssl in %s\\\",\\n self.DEFAULT_LISTEN_PORT, vhost.filep)\\n\\n def _enable_ocsp_stapling(self, domain, chain_path):\\n \\\"\\\"\\\"Include OCSP response in TLS handshake\\n\\n :param str domain: domain to enable OCSP response for\\n :param chain_path: chain file path\\n :type chain_path: `str` or `None`\\n\\n \\\"\\\"\\\"\\n vhost = self.choose_vhost(domain)\\n if self.version < (1, 3, 7):\\n raise errors.PluginError(\\\"Version 1.3.7 or greater of nginx \\\"\\n \\\"is needed to enable OCSP stapling\\\")\\n\\n if chain_path is None:\\n raise errors.PluginError(\\n \\\"--chain-path is required to enable \\\"\\n \\\"Online Certificate Status Protocol (OCSP) stapling \\\"\\n \\\"on nginx >= 1.3.7.\\\")\\n\\n stapling_directives = [\\n ['\\\\n ', 'ssl_trusted_certificate', ' ', chain_path],\\n ['\\\\n ', 'ssl_stapling', ' ', 'on'],\\n ['\\\\n ', 'ssl_stapling_verify', ' ', 'on'], ['\\\\n']]\\n\\n try:\\n self.parser.add_server_directives(vhost,\\n stapling_directives, replace=False)\\n except errors.MisconfigurationError as error:\\n logger.debug(error)\\n raise errors.PluginError(\\\"An error occurred while enabling OCSP \\\"\\n \\\"stapling for {0}.\\\".format(vhost.names))\\n\\n self.save_notes += (\\\"OCSP Stapling was enabled \\\"\\n \\\"on SSL Vhost: {0}.\\\\n\\\".format(vhost.filep))\\n self.save_notes += \\\"\\\\tssl_trusted_certificate {0}\\\\n\\\".format(chain_path)\\n self.save_notes += \\\"\\\\tssl_stapling on\\\\n\\\"\\n self.save_notes += \\\"\\\\tssl_stapling_verify on\\\\n\\\"\\n\\n ######################################\\n # Nginx server management (IInstaller)\\n ######################################\\n def restart(self):\\n \\\"\\\"\\\"Restarts nginx server.\\n\\n :raises .errors.MisconfigurationError: If either the reload fails.\\n\\n \\\"\\\"\\\"\\n nginx_restart(self.conf('ctl'), self.nginx_conf)\\n\\n def config_test(self): # pylint: disable=no-self-use\\n \\\"\\\"\\\"Check the configuration of Nginx for errors.\\n\\n :raises .errors.MisconfigurationError: If config_test fails\\n\\n \\\"\\\"\\\"\\n try:\\n util.run_script([self.conf('ctl'), \\\"-c\\\", self.nginx_conf, \\\"-t\\\"])\\n except errors.SubprocessError as err:\\n raise errors.MisconfigurationError(str(err))\\n\\n def _verify_setup(self):\\n \\\"\\\"\\\"Verify the setup to ensure safe operating environment.\\n\\n Make sure that files/directories are setup with appropriate permissions\\n Aim for defensive coding... make sure all input files\\n have permissions of root.\\n\\n \\\"\\\"\\\"\\n uid = os.geteuid()\\n util.make_or_verify_dir(\\n self.config.work_dir, core_constants.CONFIG_DIRS_MODE, uid)\\n util.make_or_verify_dir(\\n self.config.backup_dir, core_constants.CONFIG_DIRS_MODE, uid)\\n util.make_or_verify_dir(\\n self.config.config_dir, core_constants.CONFIG_DIRS_MODE, uid)\\n\\n def get_version(self):\\n \\\"\\\"\\\"Return version of Nginx Server.\\n\\n Version is returned as tuple. (ie. 2.4.7 = (2, 4, 7))\\n\\n :returns: version\\n :rtype: tuple\\n\\n :raises .PluginError:\\n Unable to find Nginx version or version is unsupported\\n\\n \\\"\\\"\\\"\\n try:\\n proc = subprocess.Popen(\\n [self.conf('ctl'), \\\"-c\\\", self.nginx_conf, \\\"-V\\\"],\\n stdout=subprocess.PIPE,\\n stderr=subprocess.PIPE,\\n universal_newlines=True)\\n text = proc.communicate()[1] # nginx prints output to stderr\\n except (OSError, ValueError) as error:\\n logger.debug(error, exc_info=True)\\n raise errors.PluginError(\\n \\\"Unable to run %s -V\\\" % self.conf('ctl'))\\n\\n version_regex = re.compile(r\\\"nginx/([0-9\\\\.]*)\\\", re.IGNORECASE)\\n version_matches = version_regex.findall(text)\\n\\n sni_regex = re.compile(r\\\"TLS SNI support enabled\\\", re.IGNORECASE)\\n sni_matches = sni_regex.findall(text)\\n\\n ssl_regex = re.compile(r\\\" --with-http_ssl_module\\\")\\n ssl_matches = ssl_regex.findall(text)\\n\\n if not version_matches:\\n raise errors.PluginError(\\\"Unable to find Nginx version\\\")\\n if not ssl_matches:\\n raise errors.PluginError(\\n \\\"Nginx build is missing SSL module (--with-http_ssl_module).\\\")\\n if not sni_matches:\\n raise errors.PluginError(\\\"Nginx build doesn't support SNI\\\")\\n\\n nginx_version = tuple([int(i) for i in version_matches[0].split(\\\".\\\")])\\n\\n # nginx < 0.8.48 uses machine hostname as default server_name instead of\\n # the empty string\\n if nginx_version < (0, 8, 48):\\n raise errors.NotSupportedError(\\\"Nginx version must be 0.8.48+\\\")\\n\\n return nginx_version\\n\\n def more_info(self):\\n \\\"\\\"\\\"Human-readable string to help understand the module\\\"\\\"\\\"\\n return (\\n \\\"Configures Nginx to authenticate and install HTTPS.{0}\\\"\\n \\\"Server root: {root}{0}\\\"\\n \\\"Version: {version}\\\".format(\\n os.linesep, root=self.parser.config_root,\\n version=\\\".\\\".join(str(i) for i in self.version))\\n )\\n\\n ###################################################\\n # Wrapper functions for Reverter class (IInstaller)\\n ###################################################\\n def save(self, title=None, temporary=False):\\n \\\"\\\"\\\"Saves all changes to the configuration files.\\n\\n :param str title: The title of the save. If a title is given, the\\n configuration will be saved as a new checkpoint and put in a\\n timestamped directory.\\n\\n :param bool temporary: Indicates whether the changes made will\\n be quickly reversed in the future (ie. challenges)\\n\\n :raises .errors.PluginError: If there was an error in\\n an attempt to save the configuration, or an error creating a\\n checkpoint\\n\\n \\\"\\\"\\\"\\n save_files = set(self.parser.parsed.keys())\\n self.add_to_checkpoint(save_files, self.save_notes, temporary)\\n self.save_notes = \\\"\\\"\\n\\n # Change 'ext' to something else to not override existing conf files\\n self.parser.filedump(ext='')\\n if title and not temporary:\\n self.finalize_checkpoint(title)\\n\\n def recovery_routine(self):\\n \\\"\\\"\\\"Revert all previously modified files.\\n\\n Reverts all modified files that have not been saved as a checkpoint\\n\\n :raises .errors.PluginError: If unable to recover the configuration\\n\\n \\\"\\\"\\\"\\n super(NginxConfigurator, self).recovery_routine()\\n self.parser.load()\\n\\n def revert_challenge_config(self):\\n \\\"\\\"\\\"Used to cleanup challenge configurations.\\n\\n :raises .errors.PluginError: If unable to revert the challenge config.\\n\\n \\\"\\\"\\\"\\n self.revert_temporary_config()\\n self.parser.load()\\n\\n def rollback_checkpoints(self, rollback=1):\\n \\\"\\\"\\\"Rollback saved checkpoints.\\n\\n :param int rollback: Number of checkpoints to revert\\n\\n :raises .errors.PluginError: If there is a problem with the input or\\n the function is unable to correctly revert the configuration\\n\\n \\\"\\\"\\\"\\n super(NginxConfigurator, self).rollback_checkpoints(rollback)\\n self.parser.load()\\n\\n ###########################################################################\\n # Challenges Section for IAuthenticator\\n ###########################################################################\\n def get_chall_pref(self, unused_domain): # pylint: disable=no-self-use\\n \\\"\\\"\\\"Return list of challenge preferences.\\\"\\\"\\\"\\n return [challenges.TLSSNI01]\\n\\n # Entry point in main.py for performing challenges\\n def perform(self, achalls):\\n \\\"\\\"\\\"Perform the configuration related challenge.\\n\\n This function currently assumes all challenges will be fulfilled.\\n If this turns out not to be the case in the future. Cleanup and\\n outstanding challenges will have to be designed better.\\n\\n \\\"\\\"\\\"\\n self._chall_out += len(achalls)\\n responses = [None] * len(achalls)\\n chall_doer = tls_sni_01.NginxTlsSni01(self)\\n\\n for i, achall in enumerate(achalls):\\n # Currently also have chall_doer hold associated index of the\\n # challenge. This helps to put all of the responses back together\\n # when they are all complete.\\n chall_doer.add_chall(achall, i)\\n\\n sni_response = chall_doer.perform()\\n # Must restart in order to activate the challenges.\\n # Handled here because we may be able to load up other challenge types\\n self.restart()\\n\\n # Go through all of the challenges and assign them to the proper place\\n # in the responses return value. All responses must be in the same order\\n # as the original challenges.\\n for i, resp in enumerate(sni_response):\\n responses[chall_doer.indices[i]] = resp\\n\\n return responses\\n\\n # called after challenges are performed\\n def cleanup(self, achalls):\\n \\\"\\\"\\\"Revert all challenges.\\\"\\\"\\\"\\n self._chall_out -= len(achalls)\\n\\n # If all of the challenges have been finished, clean up everything\\n if self._chall_out <= 0:\\n self.revert_challenge_config()\\n self.restart()\\n\\n\\ndef nginx_restart(nginx_ctl, nginx_conf):\\n \\\"\\\"\\\"Restarts the Nginx Server.\\n\\n .. todo:: Nginx restart is fatal if the configuration references\\n non-existent SSL cert/key files. Remove references to /etc/letsencrypt\\n before restart.\\n\\n :param str nginx_ctl: Path to the Nginx binary.\\n\\n \\\"\\\"\\\"\\n try:\\n proc = subprocess.Popen([nginx_ctl, \\\"-c\\\", nginx_conf, \\\"-s\\\", \\\"reload\\\"])\\n proc.communicate()\\n\\n if proc.returncode != 0:\\n # Maybe Nginx isn't running\\n # Write to temporary files instead of piping because of communication issues on Arch\\n # https://github.com/certbot/certbot/issues/4324\\n with tempfile.TemporaryFile() as out:\\n with tempfile.TemporaryFile() as err:\\n nginx_proc = subprocess.Popen([nginx_ctl, \\\"-c\\\", nginx_conf],\\n stdout=out, stderr=err)\\n nginx_proc.communicate()\\n if nginx_proc.returncode != 0:\\n # Enter recovery routine...\\n raise errors.MisconfigurationError(\\n \\\"nginx restart failed:\\\\n%s\\\\n%s\\\" % (out.read(), err.read()))\\n\\n except (OSError, ValueError):\\n raise errors.MisconfigurationError(\\\"nginx restart failed\\\")\\n # Nginx can take a moment to recognize a newly added TLS SNI servername, so sleep\\n # for a second. TODO: Check for expected servername and loop until it\\n # appears or return an error if looping too long.\\n time.sleep(1)\\n\\n\\ndef install_ssl_options_conf(options_ssl, options_ssl_digest):\\n \\\"\\\"\\\"Copy Certbot's SSL options file into the system's config dir if required.\\\"\\\"\\\"\\n return common.install_version_controlled_file(options_ssl, options_ssl_digest,\\n constants.MOD_SSL_CONF_SRC, constants.ALL_SSL_OPTIONS_HASHES)\\n\",\n \"path\": \"certbot-nginx/certbot_nginx/configurator.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"\"\"\"Nginx Configuration\"\"\"\nimport logging\nimport os\nimport re\nimport socket\nimport subprocess\nimport tempfile\nimport time\n\nimport OpenSSL\nimport six\nimport zope.interface\n\nfrom acme import challenges\nfrom acme import crypto_util as acme_crypto_util\n\nfrom certbot import constants as core_constants\nfrom certbot import crypto_util\nfrom certbot import errors\nfrom certbot import interfaces\nfrom certbot import util\n\nfrom certbot.plugins import common\n\nfrom certbot_nginx import constants\nfrom certbot_nginx import tls_sni_01\nfrom certbot_nginx import parser\n\n\nlogger = logging.getLogger(__name__)\n\nREDIRECT_BLOCK = [[\n ['\\n ', 'if', ' ', '($scheme', ' ', '!=', ' ', '\"https\")'],\n [['\\n ', 'return', ' ', '301', ' ', 'https://$host$request_uri'],\n '\\n ']\n], ['\\n']]\n\nTEST_REDIRECT_BLOCK = [\n [\n ['if', '($scheme', '!=', '\"https\")'],\n [\n ['return', '301', 'https://$host$request_uri']\n ]\n ],\n ['#', ' managed by Certbot']\n]\n\nREDIRECT_COMMENT_BLOCK = [\n ['\\n ', '#', ' Redirect non-https traffic to https'],\n ['\\n ', '#', ' if ($scheme != \"https\") {'],\n ['\\n ', '#', \" return 301 https://$host$request_uri;\"],\n ['\\n ', '#', \" } # managed by Certbot\"],\n ['\\n']\n]\n\nTEST_REDIRECT_COMMENT_BLOCK = [\n ['#', ' Redirect non-https traffic to https'],\n ['#', ' if ($scheme != \"https\") {'],\n ['#', \" return 301 https://$host$request_uri;\"],\n ['#', \" } # managed by Certbot\"],\n]\n\n@zope.interface.implementer(interfaces.IAuthenticator, interfaces.IInstaller)\n@zope.interface.provider(interfaces.IPluginFactory)\nclass NginxConfigurator(common.Installer):\n # pylint: disable=too-many-instance-attributes,too-many-public-methods\n \"\"\"Nginx configurator.\n\n .. todo:: Add proper support for comments in the config. Currently,\n config files modified by the configurator will lose all their comments.\n\n :ivar config: Configuration.\n :type config: :class:`~certbot.interfaces.IConfig`\n\n :ivar parser: Handles low level parsing\n :type parser: :class:`~certbot_nginx.parser`\n\n :ivar str save_notes: Human-readable config change notes\n\n :ivar reverter: saves and reverts checkpoints\n :type reverter: :class:`certbot.reverter.Reverter`\n\n :ivar tup version: version of Nginx\n\n \"\"\"\n\n description = \"Nginx Web Server plugin - Alpha\"\n\n DEFAULT_LISTEN_PORT = '80'\n\n @classmethod\n def add_parser_arguments(cls, add):\n add(\"server-root\", default=constants.CLI_DEFAULTS[\"server_root\"],\n help=\"Nginx server root directory.\")\n add(\"ctl\", default=constants.CLI_DEFAULTS[\"ctl\"], help=\"Path to the \"\n \"'nginx' binary, used for 'configtest' and retrieving nginx \"\n \"version number.\")\n\n @property\n def nginx_conf(self):\n \"\"\"Nginx config file path.\"\"\"\n return os.path.join(self.conf(\"server_root\"), \"nginx.conf\")\n\n def __init__(self, *args, **kwargs):\n \"\"\"Initialize an Nginx Configurator.\n\n :param tup version: version of Nginx as a tuple (1, 4, 7)\n (used mostly for unittesting)\n\n \"\"\"\n version = kwargs.pop(\"version\", None)\n super(NginxConfigurator, self).__init__(*args, **kwargs)\n\n # Verify that all directories and files exist with proper permissions\n self._verify_setup()\n\n # Files to save\n self.save_notes = \"\"\n\n # For creating new vhosts if no names match\n self.new_vhost = None\n\n # Add number of outstanding challenges\n self._chall_out = 0\n\n # These will be set in the prepare function\n self.parser = None\n self.version = version\n self._enhance_func = {\"redirect\": self._enable_redirect,\n \"staple-ocsp\": self._enable_ocsp_stapling}\n\n self.reverter.recovery_routine()\n\n @property\n def mod_ssl_conf(self):\n \"\"\"Full absolute path to SSL configuration file.\"\"\"\n return os.path.join(self.config.config_dir, constants.MOD_SSL_CONF_DEST)\n\n @property\n def updated_mod_ssl_conf_digest(self):\n \"\"\"Full absolute path to digest of updated SSL configuration file.\"\"\"\n return os.path.join(self.config.config_dir, constants.UPDATED_MOD_SSL_CONF_DIGEST)\n\n # This is called in determine_authenticator and determine_installer\n def prepare(self):\n \"\"\"Prepare the authenticator/installer.\n\n :raises .errors.NoInstallationError: If Nginx ctl cannot be found\n :raises .errors.MisconfigurationError: If Nginx is misconfigured\n \"\"\"\n # Verify Nginx is installed\n if not util.exe_exists(self.conf('ctl')):\n raise errors.NoInstallationError\n\n # Make sure configuration is valid\n self.config_test()\n\n\n self.parser = parser.NginxParser(self.conf('server-root'))\n\n install_ssl_options_conf(self.mod_ssl_conf, self.updated_mod_ssl_conf_digest)\n\n self.install_ssl_dhparams()\n\n # Set Version\n if self.version is None:\n self.version = self.get_version()\n\n # Prevent two Nginx plugins from modifying a config at once\n try:\n util.lock_dir_until_exit(self.conf('server-root'))\n except (OSError, errors.LockError):\n logger.debug('Encountered error:', exc_info=True)\n raise errors.PluginError(\n 'Unable to lock %s', self.conf('server-root'))\n\n # Entry point in main.py for installing cert\n def deploy_cert(self, domain, cert_path, key_path,\n chain_path=None, fullchain_path=None):\n # pylint: disable=unused-argument\n \"\"\"Deploys certificate to specified virtual host.\n\n .. note:: Aborts if the vhost is missing ssl_certificate or\n ssl_certificate_key.\n\n .. note:: This doesn't save the config files!\n\n :raises errors.PluginError: When unable to deploy certificate due to\n a lack of directives or configuration\n\n \"\"\"\n if not fullchain_path:\n raise errors.PluginError(\n \"The nginx plugin currently requires --fullchain-path to \"\n \"install a cert.\")\n\n vhost = self.choose_vhost(domain, raise_if_no_match=False)\n if vhost is None:\n vhost = self._vhost_from_duplicated_default(domain)\n cert_directives = [['\\n ', 'ssl_certificate', ' ', fullchain_path],\n ['\\n ', 'ssl_certificate_key', ' ', key_path]]\n\n self.parser.add_server_directives(vhost,\n cert_directives, replace=True)\n logger.info(\"Deployed Certificate to VirtualHost %s for %s\",\n vhost.filep, vhost.names)\n\n self.save_notes += (\"Changed vhost at %s with addresses of %s\\n\" %\n (vhost.filep,\n \", \".join(str(addr) for addr in vhost.addrs)))\n self.save_notes += \"\\tssl_certificate %s\\n\" % fullchain_path\n self.save_notes += \"\\tssl_certificate_key %s\\n\" % key_path\n\n #######################\n # Vhost parsing methods\n #######################\n def choose_vhost(self, target_name, raise_if_no_match=True):\n \"\"\"Chooses a virtual host based on the given domain name.\n\n .. note:: This makes the vhost SSL-enabled if it isn't already. Follows\n Nginx's server block selection rules preferring blocks that are\n already SSL.\n\n .. todo:: This should maybe return list if no obvious answer\n is presented.\n\n .. todo:: The special name \"$hostname\" corresponds to the machine's\n hostname. Currently we just ignore this.\n\n :param str target_name: domain name\n :param bool raise_if_no_match: True iff not finding a match is an error;\n otherwise, return None\n\n :returns: ssl vhost associated with name\n :rtype: :class:`~certbot_nginx.obj.VirtualHost`\n\n \"\"\"\n vhost = None\n\n matches = self._get_ranked_matches(target_name)\n vhost = self._select_best_name_match(matches)\n if not vhost:\n if raise_if_no_match:\n # No matches. Raise a misconfiguration error.\n raise errors.MisconfigurationError(\n (\"Cannot find a VirtualHost matching domain %s. \"\n \"In order for Certbot to correctly perform the challenge \"\n \"please add a corresponding server_name directive to your \"\n \"nginx configuration: \"\n \"https://nginx.org/en/docs/http/server_names.html\") % (target_name))\n else:\n return None\n else:\n # Note: if we are enhancing with ocsp, vhost should already be ssl.\n if not vhost.ssl:\n self._make_server_ssl(vhost)\n\n return vhost\n\n def _vhost_from_duplicated_default(self, domain):\n if self.new_vhost is None:\n default_vhost = self._get_default_vhost()\n self.new_vhost = self.parser.create_new_vhost_from_default(default_vhost)\n if not self.new_vhost.ssl:\n self._make_server_ssl(self.new_vhost)\n self.new_vhost.names = set()\n\n self.new_vhost.names.add(domain)\n name_block = [['\\n ', 'server_name', ' ', ' '.join(self.new_vhost.names)]]\n self.parser.add_server_directives(self.new_vhost, name_block, replace=True)\n return self.new_vhost\n\n def _get_default_vhost(self):\n vhost_list = self.parser.get_vhosts()\n # if one has default_server set, return that one\n default_vhosts = []\n for vhost in vhost_list:\n for addr in vhost.addrs:\n if addr.default:\n default_vhosts.append(vhost)\n break\n\n if len(default_vhosts) == 1:\n return default_vhosts[0]\n\n # TODO: present a list of vhosts for user to choose from\n\n raise errors.MisconfigurationError(\"Could not automatically find a matching server\"\n \" block. Set the `server_name` directive to use the Nginx installer.\")\n\n def _get_ranked_matches(self, target_name):\n \"\"\"Returns a ranked list of vhosts that match target_name.\n The ranking gives preference to SSL vhosts.\n\n :param str target_name: The name to match\n :returns: list of dicts containing the vhost, the matching name, and\n the numerical rank\n :rtype: list\n\n \"\"\"\n vhost_list = self.parser.get_vhosts()\n return self._rank_matches_by_name_and_ssl(vhost_list, target_name)\n\n def _select_best_name_match(self, matches):\n \"\"\"Returns the best name match of a ranked list of vhosts.\n\n :param list matches: list of dicts containing the vhost, the matching name,\n and the numerical rank\n :returns: the most matching vhost\n :rtype: :class:`~certbot_nginx.obj.VirtualHost`\n\n \"\"\"\n if not matches:\n return None\n elif matches[0]['rank'] in six.moves.range(2, 6):\n # Wildcard match - need to find the longest one\n rank = matches[0]['rank']\n wildcards = [x for x in matches if x['rank'] == rank]\n return max(wildcards, key=lambda x: len(x['name']))['vhost']\n else:\n # Exact or regex match\n return matches[0]['vhost']\n\n\n def _rank_matches_by_name_and_ssl(self, vhost_list, target_name):\n \"\"\"Returns a ranked list of vhosts from vhost_list that match target_name.\n The ranking gives preference to SSL vhosts.\n\n :param list vhost_list: list of vhosts to filter and rank\n :param str target_name: The name to match\n :returns: list of dicts containing the vhost, the matching name, and\n the numerical rank\n :rtype: list\n\n \"\"\"\n # Nginx chooses a matching server name for a request with precedence:\n # 1. exact name match\n # 2. longest wildcard name starting with *\n # 3. longest wildcard name ending with *\n # 4. first matching regex in order of appearance in the file\n matches = []\n for vhost in vhost_list:\n name_type, name = parser.get_best_match(target_name, vhost.names)\n if name_type == 'exact':\n matches.append({'vhost': vhost,\n 'name': name,\n 'rank': 0 if vhost.ssl else 1})\n elif name_type == 'wildcard_start':\n matches.append({'vhost': vhost,\n 'name': name,\n 'rank': 2 if vhost.ssl else 3})\n elif name_type == 'wildcard_end':\n matches.append({'vhost': vhost,\n 'name': name,\n 'rank': 4 if vhost.ssl else 5})\n elif name_type == 'regex':\n matches.append({'vhost': vhost,\n 'name': name,\n 'rank': 6 if vhost.ssl else 7})\n return sorted(matches, key=lambda x: x['rank'])\n\n\n def choose_redirect_vhost(self, target_name, port):\n \"\"\"Chooses a single virtual host for redirect enhancement.\n\n Chooses the vhost most closely matching target_name that is\n listening to port without using ssl.\n\n .. todo:: This should maybe return list if no obvious answer\n is presented.\n\n .. todo:: The special name \"$hostname\" corresponds to the machine's\n hostname. Currently we just ignore this.\n\n :param str target_name: domain name\n :param str port: port number\n :returns: vhost associated with name\n :rtype: :class:`~certbot_nginx.obj.VirtualHost`\n\n \"\"\"\n matches = self._get_redirect_ranked_matches(target_name, port)\n return self._select_best_name_match(matches)\n\n def _get_redirect_ranked_matches(self, target_name, port):\n \"\"\"Gets a ranked list of plaintextish port-listening vhosts matching target_name\n\n Filter all hosts for those listening on port without using ssl.\n Rank by how well these match target_name.\n\n :param str target_name: The name to match\n :param str port: port number\n :returns: list of dicts containing the vhost, the matching name, and\n the numerical rank\n :rtype: list\n\n \"\"\"\n all_vhosts = self.parser.get_vhosts()\n def _port_matches(test_port, matching_port):\n # test_port is a number, matching is a number or \"\" or None\n if matching_port == \"\" or matching_port is None:\n # if no port is specified, Nginx defaults to listening on port 80.\n return test_port == self.DEFAULT_LISTEN_PORT\n else:\n return test_port == matching_port\n\n def _vhost_matches(vhost, port):\n found_matching_port = False\n if len(vhost.addrs) == 0:\n # if there are no listen directives at all, Nginx defaults to\n # listening on port 80.\n found_matching_port = (port == self.DEFAULT_LISTEN_PORT)\n else:\n for addr in vhost.addrs:\n if _port_matches(port, addr.get_port()) and addr.ssl == False:\n found_matching_port = True\n\n if found_matching_port:\n # make sure we don't have an 'ssl on' directive\n return not self.parser.has_ssl_on_directive(vhost)\n else:\n return False\n\n matching_vhosts = [vhost for vhost in all_vhosts if _vhost_matches(vhost, port)]\n\n # We can use this ranking function because sslishness doesn't matter to us, and\n # there shouldn't be conflicting plaintextish servers listening on 80.\n return self._rank_matches_by_name_and_ssl(matching_vhosts, target_name)\n\n def get_all_names(self):\n \"\"\"Returns all names found in the Nginx Configuration.\n\n :returns: All ServerNames, ServerAliases, and reverse DNS entries for\n virtual host addresses\n :rtype: set\n\n \"\"\"\n all_names = set()\n\n for vhost in self.parser.get_vhosts():\n all_names.update(vhost.names)\n\n for addr in vhost.addrs:\n host = addr.get_addr()\n if common.hostname_regex.match(host):\n # If it's a hostname, add it to the names.\n all_names.add(host)\n elif not common.private_ips_regex.match(host):\n # If it isn't a private IP, do a reverse DNS lookup\n # TODO: IPv6 support\n try:\n socket.inet_aton(host)\n all_names.add(socket.gethostbyaddr(host)[0])\n except (socket.error, socket.herror, socket.timeout):\n continue\n\n return util.get_filtered_names(all_names)\n\n def _get_snakeoil_paths(self):\n # TODO: generate only once\n tmp_dir = os.path.join(self.config.work_dir, \"snakeoil\")\n le_key = crypto_util.init_save_key(\n key_size=1024, key_dir=tmp_dir, keyname=\"key.pem\")\n key = OpenSSL.crypto.load_privatekey(\n OpenSSL.crypto.FILETYPE_PEM, le_key.pem)\n cert = acme_crypto_util.gen_ss_cert(key, domains=[socket.gethostname()])\n cert_pem = OpenSSL.crypto.dump_certificate(\n OpenSSL.crypto.FILETYPE_PEM, cert)\n cert_file, cert_path = util.unique_file(\n os.path.join(tmp_dir, \"cert.pem\"), mode=\"wb\")\n with cert_file:\n cert_file.write(cert_pem)\n return cert_path, le_key.file\n\n def _make_server_ssl(self, vhost):\n \"\"\"Make a server SSL.\n\n Make a server SSL based on server_name and filename by adding a\n ``listen IConfig.tls_sni_01_port ssl`` directive to the server block.\n\n .. todo:: Maybe this should create a new block instead of modifying\n the existing one?\n\n :param vhost: The vhost to add SSL to.\n :type vhost: :class:`~certbot_nginx.obj.VirtualHost`\n\n \"\"\"\n # If the vhost was implicitly listening on the default Nginx port,\n # have it continue to do so.\n if len(vhost.addrs) == 0:\n listen_block = [['\\n ', 'listen', ' ', self.DEFAULT_LISTEN_PORT]]\n self.parser.add_server_directives(vhost, listen_block, replace=False)\n\n snakeoil_cert, snakeoil_key = self._get_snakeoil_paths()\n\n ssl_block = ([\n ['\\n ', 'listen', ' ', '{0} ssl'.format(self.config.tls_sni_01_port)],\n ['\\n ', 'ssl_certificate', ' ', snakeoil_cert],\n ['\\n ', 'ssl_certificate_key', ' ', snakeoil_key],\n ['\\n ', 'include', ' ', self.mod_ssl_conf],\n ['\\n ', 'ssl_dhparam', ' ', self.ssl_dhparams],\n ])\n\n self.parser.add_server_directives(\n vhost, ssl_block, replace=False)\n\n ##################################\n # enhancement methods (IInstaller)\n ##################################\n def supported_enhancements(self): # pylint: disable=no-self-use\n \"\"\"Returns currently supported enhancements.\"\"\"\n return ['redirect', 'staple-ocsp']\n\n def enhance(self, domain, enhancement, options=None):\n \"\"\"Enhance configuration.\n\n :param str domain: domain to enhance\n :param str enhancement: enhancement type defined in\n :const:`~certbot.constants.ENHANCEMENTS`\n :param options: options for the enhancement\n See :const:`~certbot.constants.ENHANCEMENTS`\n documentation for appropriate parameter.\n\n \"\"\"\n try:\n return self._enhance_func[enhancement](domain, options)\n except (KeyError, ValueError):\n raise errors.PluginError(\n \"Unsupported enhancement: {0}\".format(enhancement))\n except errors.PluginError:\n logger.warning(\"Failed %s for %s\", enhancement, domain)\n raise\n\n def _has_certbot_redirect(self, vhost):\n return vhost.contains_list(TEST_REDIRECT_BLOCK)\n\n def _has_certbot_redirect_comment(self, vhost):\n return vhost.contains_list(TEST_REDIRECT_COMMENT_BLOCK)\n\n def _add_redirect_block(self, vhost, active=True):\n \"\"\"Add redirect directive to vhost\n \"\"\"\n if active:\n redirect_block = REDIRECT_BLOCK\n else:\n redirect_block = REDIRECT_COMMENT_BLOCK\n\n self.parser.add_server_directives(\n vhost, redirect_block, replace=False)\n\n def _enable_redirect(self, domain, unused_options):\n \"\"\"Redirect all equivalent HTTP traffic to ssl_vhost.\n\n Add rewrite directive to non https traffic\n\n .. note:: This function saves the configuration\n\n :param str domain: domain to enable redirect for\n :param unused_options: Not currently used\n :type unused_options: Not Available\n \"\"\"\n\n port = self.DEFAULT_LISTEN_PORT\n vhost = None\n # If there are blocks listening plaintextishly on self.DEFAULT_LISTEN_PORT,\n # choose the most name-matching one.\n vhost = self.choose_redirect_vhost(domain, port)\n\n if vhost is None:\n logger.info(\"No matching insecure server blocks listening on port %s found.\",\n self.DEFAULT_LISTEN_PORT)\n else:\n if self._has_certbot_redirect(vhost):\n logger.info(\"Traffic on port %s already redirecting to ssl in %s\",\n self.DEFAULT_LISTEN_PORT, vhost.filep)\n elif vhost.has_redirect():\n if not self._has_certbot_redirect_comment(vhost):\n self._add_redirect_block(vhost, active=False)\n logger.info(\"The appropriate server block is already redirecting \"\n \"traffic. To enable redirect anyway, uncomment the \"\n \"redirect lines in %s.\", vhost.filep)\n else:\n # Redirect plaintextish host to https\n self._add_redirect_block(vhost, active=True)\n logger.info(\"Redirecting all traffic on port %s to ssl in %s\",\n self.DEFAULT_LISTEN_PORT, vhost.filep)\n\n def _enable_ocsp_stapling(self, domain, chain_path):\n \"\"\"Include OCSP response in TLS handshake\n\n :param str domain: domain to enable OCSP response for\n :param chain_path: chain file path\n :type chain_path: `str` or `None`\n\n \"\"\"\n vhost = self.choose_vhost(domain)\n if self.version < (1, 3, 7):\n raise errors.PluginError(\"Version 1.3.7 or greater of nginx \"\n \"is needed to enable OCSP stapling\")\n\n if chain_path is None:\n raise errors.PluginError(\n \"--chain-path is required to enable \"\n \"Online Certificate Status Protocol (OCSP) stapling \"\n \"on nginx >= 1.3.7.\")\n\n stapling_directives = [\n ['\\n ', 'ssl_trusted_certificate', ' ', chain_path],\n ['\\n ', 'ssl_stapling', ' ', 'on'],\n ['\\n ', 'ssl_stapling_verify', ' ', 'on'], ['\\n']]\n\n try:\n self.parser.add_server_directives(vhost,\n stapling_directives, replace=False)\n except errors.MisconfigurationError as error:\n logger.debug(error)\n raise errors.PluginError(\"An error occurred while enabling OCSP \"\n \"stapling for {0}.\".format(vhost.names))\n\n self.save_notes += (\"OCSP Stapling was enabled \"\n \"on SSL Vhost: {0}.\\n\".format(vhost.filep))\n self.save_notes += \"\\tssl_trusted_certificate {0}\\n\".format(chain_path)\n self.save_notes += \"\\tssl_stapling on\\n\"\n self.save_notes += \"\\tssl_stapling_verify on\\n\"\n\n ######################################\n # Nginx server management (IInstaller)\n ######################################\n def restart(self):\n \"\"\"Restarts nginx server.\n\n :raises .errors.MisconfigurationError: If either the reload fails.\n\n \"\"\"\n nginx_restart(self.conf('ctl'), self.nginx_conf)\n\n def config_test(self): # pylint: disable=no-self-use\n \"\"\"Check the configuration of Nginx for errors.\n\n :raises .errors.MisconfigurationError: If config_test fails\n\n \"\"\"\n try:\n util.run_script([self.conf('ctl'), \"-c\", self.nginx_conf, \"-t\"])\n except errors.SubprocessError as err:\n raise errors.MisconfigurationError(str(err))\n\n def _verify_setup(self):\n \"\"\"Verify the setup to ensure safe operating environment.\n\n Make sure that files/directories are setup with appropriate permissions\n Aim for defensive coding... make sure all input files\n have permissions of root.\n\n \"\"\"\n uid = os.geteuid()\n util.make_or_verify_dir(\n self.config.work_dir, core_constants.CONFIG_DIRS_MODE, uid)\n util.make_or_verify_dir(\n self.config.backup_dir, core_constants.CONFIG_DIRS_MODE, uid)\n util.make_or_verify_dir(\n self.config.config_dir, core_constants.CONFIG_DIRS_MODE, uid)\n\n def get_version(self):\n \"\"\"Return version of Nginx Server.\n\n Version is returned as tuple. (ie. 2.4.7 = (2, 4, 7))\n\n :returns: version\n :rtype: tuple\n\n :raises .PluginError:\n Unable to find Nginx version or version is unsupported\n\n \"\"\"\n try:\n proc = subprocess.Popen(\n [self.conf('ctl'), \"-c\", self.nginx_conf, \"-V\"],\n stdout=subprocess.PIPE,\n stderr=subprocess.PIPE,\n universal_newlines=True)\n text = proc.communicate()[1] # nginx prints output to stderr\n except (OSError, ValueError) as error:\n logger.debug(error, exc_info=True)\n raise errors.PluginError(\n \"Unable to run %s -V\" % self.conf('ctl'))\n\n version_regex = re.compile(r\"nginx/([0-9\\.]*)\", re.IGNORECASE)\n version_matches = version_regex.findall(text)\n\n sni_regex = re.compile(r\"TLS SNI support enabled\", re.IGNORECASE)\n sni_matches = sni_regex.findall(text)\n\n ssl_regex = re.compile(r\" --with-http_ssl_module\")\n ssl_matches = ssl_regex.findall(text)\n\n if not version_matches:\n raise errors.PluginError(\"Unable to find Nginx version\")\n if not ssl_matches:\n raise errors.PluginError(\n \"Nginx build is missing SSL module (--with-http_ssl_module).\")\n if not sni_matches:\n raise errors.PluginError(\"Nginx build doesn't support SNI\")\n\n nginx_version = tuple([int(i) for i in version_matches[0].split(\".\")])\n\n # nginx < 0.8.48 uses machine hostname as default server_name instead of\n # the empty string\n if nginx_version < (0, 8, 48):\n raise errors.NotSupportedError(\"Nginx version must be 0.8.48+\")\n\n return nginx_version\n\n def more_info(self):\n \"\"\"Human-readable string to help understand the module\"\"\"\n return (\n \"Configures Nginx to authenticate and install HTTPS.{0}\"\n \"Server root: {root}{0}\"\n \"Version: {version}\".format(\n os.linesep, root=self.parser.config_root,\n version=\".\".join(str(i) for i in self.version))\n )\n\n ###################################################\n # Wrapper functions for Reverter class (IInstaller)\n ###################################################\n def save(self, title=None, temporary=False):\n \"\"\"Saves all changes to the configuration files.\n\n :param str title: The title of the save. If a title is given, the\n configuration will be saved as a new checkpoint and put in a\n timestamped directory.\n\n :param bool temporary: Indicates whether the changes made will\n be quickly reversed in the future (ie. challenges)\n\n :raises .errors.PluginError: If there was an error in\n an attempt to save the configuration, or an error creating a\n checkpoint\n\n \"\"\"\n save_files = set(self.parser.parsed.keys())\n self.add_to_checkpoint(save_files, self.save_notes, temporary)\n self.save_notes = \"\"\n\n # Change 'ext' to something else to not override existing conf files\n self.parser.filedump(ext='')\n if title and not temporary:\n self.finalize_checkpoint(title)\n\n def recovery_routine(self):\n \"\"\"Revert all previously modified files.\n\n Reverts all modified files that have not been saved as a checkpoint\n\n :raises .errors.PluginError: If unable to recover the configuration\n\n \"\"\"\n super(NginxConfigurator, self).recovery_routine()\n self.parser.load()\n\n def revert_challenge_config(self):\n \"\"\"Used to cleanup challenge configurations.\n\n :raises .errors.PluginError: If unable to revert the challenge config.\n\n \"\"\"\n self.revert_temporary_config()\n self.parser.load()\n\n def rollback_checkpoints(self, rollback=1):\n \"\"\"Rollback saved checkpoints.\n\n :param int rollback: Number of checkpoints to revert\n\n :raises .errors.PluginError: If there is a problem with the input or\n the function is unable to correctly revert the configuration\n\n \"\"\"\n super(NginxConfigurator, self).rollback_checkpoints(rollback)\n self.parser.load()\n\n ###########################################################################\n # Challenges Section for IAuthenticator\n ###########################################################################\n def get_chall_pref(self, unused_domain): # pylint: disable=no-self-use\n \"\"\"Return list of challenge preferences.\"\"\"\n return [challenges.TLSSNI01]\n\n # Entry point in main.py for performing challenges\n def perform(self, achalls):\n \"\"\"Perform the configuration related challenge.\n\n This function currently assumes all challenges will be fulfilled.\n If this turns out not to be the case in the future. Cleanup and\n outstanding challenges will have to be designed better.\n\n \"\"\"\n self._chall_out += len(achalls)\n responses = [None] * len(achalls)\n chall_doer = tls_sni_01.NginxTlsSni01(self)\n\n for i, achall in enumerate(achalls):\n # Currently also have chall_doer hold associated index of the\n # challenge. This helps to put all of the responses back together\n # when they are all complete.\n chall_doer.add_chall(achall, i)\n\n sni_response = chall_doer.perform()\n # Must restart in order to activate the challenges.\n # Handled here because we may be able to load up other challenge types\n self.restart()\n\n # Go through all of the challenges and assign them to the proper place\n # in the responses return value. All responses must be in the same order\n # as the original challenges.\n for i, resp in enumerate(sni_response):\n responses[chall_doer.indices[i]] = resp\n\n return responses\n\n # called after challenges are performed\n def cleanup(self, achalls):\n \"\"\"Revert all challenges.\"\"\"\n self._chall_out -= len(achalls)\n\n # If all of the challenges have been finished, clean up everything\n if self._chall_out <= 0:\n self.revert_challenge_config()\n self.restart()\n\n\ndef nginx_restart(nginx_ctl, nginx_conf):\n \"\"\"Restarts the Nginx Server.\n\n .. todo:: Nginx restart is fatal if the configuration references\n non-existent SSL cert/key files. Remove references to /etc/letsencrypt\n before restart.\n\n :param str nginx_ctl: Path to the Nginx binary.\n\n \"\"\"\n try:\n proc = subprocess.Popen([nginx_ctl, \"-c\", nginx_conf, \"-s\", \"reload\"])\n proc.communicate()\n\n if proc.returncode != 0:\n # Maybe Nginx isn't running\n # Write to temporary files instead of piping because of communication issues on Arch\n # https://github.com/certbot/certbot/issues/4324\n with tempfile.TemporaryFile() as out:\n with tempfile.TemporaryFile() as err:\n nginx_proc = subprocess.Popen([nginx_ctl, \"-c\", nginx_conf],\n stdout=out, stderr=err)\n nginx_proc.communicate()\n if nginx_proc.returncode != 0:\n # Enter recovery routine...\n raise errors.MisconfigurationError(\n \"nginx restart failed:\\n%s\\n%s\" % (out.read(), err.read()))\n\n except (OSError, ValueError):\n raise errors.MisconfigurationError(\"nginx restart failed\")\n # Nginx can take a moment to recognize a newly added TLS SNI servername, so sleep\n # for a second. TODO: Check for expected servername and loop until it\n # appears or return an error if looping too long.\n time.sleep(1)\n\n\ndef install_ssl_options_conf(options_ssl, options_ssl_digest):\n \"\"\"Copy Certbot's SSL options file into the system's config dir if required.\"\"\"\n return common.install_version_controlled_file(options_ssl, options_ssl_digest,\n constants.MOD_SSL_CONF_SRC, constants.ALL_SSL_OPTIONS_HASHES)\n","path":"certbot-nginx/certbot_nginx/configurator.py"}],"string":"[\n {\n \"content\": \"\\\"\\\"\\\"Nginx Configuration\\\"\\\"\\\"\\nimport logging\\nimport os\\nimport re\\nimport socket\\nimport subprocess\\nimport tempfile\\nimport time\\n\\nimport OpenSSL\\nimport six\\nimport zope.interface\\n\\nfrom acme import challenges\\nfrom acme import crypto_util as acme_crypto_util\\n\\nfrom certbot import constants as core_constants\\nfrom certbot import crypto_util\\nfrom certbot import errors\\nfrom certbot import interfaces\\nfrom certbot import util\\n\\nfrom certbot.plugins import common\\n\\nfrom certbot_nginx import constants\\nfrom certbot_nginx import tls_sni_01\\nfrom certbot_nginx import parser\\n\\n\\nlogger = logging.getLogger(__name__)\\n\\nREDIRECT_BLOCK = [[\\n ['\\\\n ', 'if', ' ', '($scheme', ' ', '!=', ' ', '\\\"https\\\")'],\\n [['\\\\n ', 'return', ' ', '301', ' ', 'https://$host$request_uri'],\\n '\\\\n ']\\n], ['\\\\n']]\\n\\nTEST_REDIRECT_BLOCK = [\\n [\\n ['if', '($scheme', '!=', '\\\"https\\\")'],\\n [\\n ['return', '301', 'https://$host$request_uri']\\n ]\\n ],\\n ['#', ' managed by Certbot']\\n]\\n\\nREDIRECT_COMMENT_BLOCK = [\\n ['\\\\n ', '#', ' Redirect non-https traffic to https'],\\n ['\\\\n ', '#', ' if ($scheme != \\\"https\\\") {'],\\n ['\\\\n ', '#', \\\" return 301 https://$host$request_uri;\\\"],\\n ['\\\\n ', '#', \\\" } # managed by Certbot\\\"],\\n ['\\\\n']\\n]\\n\\nTEST_REDIRECT_COMMENT_BLOCK = [\\n ['#', ' Redirect non-https traffic to https'],\\n ['#', ' if ($scheme != \\\"https\\\") {'],\\n ['#', \\\" return 301 https://$host$request_uri;\\\"],\\n ['#', \\\" } # managed by Certbot\\\"],\\n]\\n\\n@zope.interface.implementer(interfaces.IAuthenticator, interfaces.IInstaller)\\n@zope.interface.provider(interfaces.IPluginFactory)\\nclass NginxConfigurator(common.Installer):\\n # pylint: disable=too-many-instance-attributes,too-many-public-methods\\n \\\"\\\"\\\"Nginx configurator.\\n\\n .. todo:: Add proper support for comments in the config. Currently,\\n config files modified by the configurator will lose all their comments.\\n\\n :ivar config: Configuration.\\n :type config: :class:`~certbot.interfaces.IConfig`\\n\\n :ivar parser: Handles low level parsing\\n :type parser: :class:`~certbot_nginx.parser`\\n\\n :ivar str save_notes: Human-readable config change notes\\n\\n :ivar reverter: saves and reverts checkpoints\\n :type reverter: :class:`certbot.reverter.Reverter`\\n\\n :ivar tup version: version of Nginx\\n\\n \\\"\\\"\\\"\\n\\n description = \\\"Nginx Web Server plugin - Alpha\\\"\\n\\n DEFAULT_LISTEN_PORT = '80'\\n\\n @classmethod\\n def add_parser_arguments(cls, add):\\n add(\\\"server-root\\\", default=constants.CLI_DEFAULTS[\\\"server_root\\\"],\\n help=\\\"Nginx server root directory.\\\")\\n add(\\\"ctl\\\", default=constants.CLI_DEFAULTS[\\\"ctl\\\"], help=\\\"Path to the \\\"\\n \\\"'nginx' binary, used for 'configtest' and retrieving nginx \\\"\\n \\\"version number.\\\")\\n\\n @property\\n def nginx_conf(self):\\n \\\"\\\"\\\"Nginx config file path.\\\"\\\"\\\"\\n return os.path.join(self.conf(\\\"server_root\\\"), \\\"nginx.conf\\\")\\n\\n def __init__(self, *args, **kwargs):\\n \\\"\\\"\\\"Initialize an Nginx Configurator.\\n\\n :param tup version: version of Nginx as a tuple (1, 4, 7)\\n (used mostly for unittesting)\\n\\n \\\"\\\"\\\"\\n version = kwargs.pop(\\\"version\\\", None)\\n super(NginxConfigurator, self).__init__(*args, **kwargs)\\n\\n # Verify that all directories and files exist with proper permissions\\n self._verify_setup()\\n\\n # Files to save\\n self.save_notes = \\\"\\\"\\n\\n # For creating new vhosts if no names match\\n self.new_vhost = None\\n\\n # Add number of outstanding challenges\\n self._chall_out = 0\\n\\n # These will be set in the prepare function\\n self.parser = None\\n self.version = version\\n self._enhance_func = {\\\"redirect\\\": self._enable_redirect,\\n \\\"staple-ocsp\\\": self._enable_ocsp_stapling}\\n\\n self.reverter.recovery_routine()\\n\\n @property\\n def mod_ssl_conf(self):\\n \\\"\\\"\\\"Full absolute path to SSL configuration file.\\\"\\\"\\\"\\n return os.path.join(self.config.config_dir, constants.MOD_SSL_CONF_DEST)\\n\\n @property\\n def updated_mod_ssl_conf_digest(self):\\n \\\"\\\"\\\"Full absolute path to digest of updated SSL configuration file.\\\"\\\"\\\"\\n return os.path.join(self.config.config_dir, constants.UPDATED_MOD_SSL_CONF_DIGEST)\\n\\n # This is called in determine_authenticator and determine_installer\\n def prepare(self):\\n \\\"\\\"\\\"Prepare the authenticator/installer.\\n\\n :raises .errors.NoInstallationError: If Nginx ctl cannot be found\\n :raises .errors.MisconfigurationError: If Nginx is misconfigured\\n \\\"\\\"\\\"\\n # Verify Nginx is installed\\n if not util.exe_exists(self.conf('ctl')):\\n raise errors.NoInstallationError\\n\\n # Make sure configuration is valid\\n self.config_test()\\n\\n\\n self.parser = parser.NginxParser(self.conf('server-root'))\\n\\n install_ssl_options_conf(self.mod_ssl_conf, self.updated_mod_ssl_conf_digest)\\n\\n self.install_ssl_dhparams()\\n\\n # Set Version\\n if self.version is None:\\n self.version = self.get_version()\\n\\n # Prevent two Nginx plugins from modifying a config at once\\n try:\\n util.lock_dir_until_exit(self.conf('server-root'))\\n except (OSError, errors.LockError):\\n logger.debug('Encountered error:', exc_info=True)\\n raise errors.PluginError(\\n 'Unable to lock %s', self.conf('server-root'))\\n\\n # Entry point in main.py for installing cert\\n def deploy_cert(self, domain, cert_path, key_path,\\n chain_path=None, fullchain_path=None):\\n # pylint: disable=unused-argument\\n \\\"\\\"\\\"Deploys certificate to specified virtual host.\\n\\n .. note:: Aborts if the vhost is missing ssl_certificate or\\n ssl_certificate_key.\\n\\n .. note:: This doesn't save the config files!\\n\\n :raises errors.PluginError: When unable to deploy certificate due to\\n a lack of directives or configuration\\n\\n \\\"\\\"\\\"\\n if not fullchain_path:\\n raise errors.PluginError(\\n \\\"The nginx plugin currently requires --fullchain-path to \\\"\\n \\\"install a cert.\\\")\\n\\n vhost = self.choose_vhost(domain, raise_if_no_match=False)\\n if vhost is None:\\n vhost = self._vhost_from_duplicated_default(domain)\\n cert_directives = [['\\\\n ', 'ssl_certificate', ' ', fullchain_path],\\n ['\\\\n ', 'ssl_certificate_key', ' ', key_path]]\\n\\n self.parser.add_server_directives(vhost,\\n cert_directives, replace=True)\\n logger.info(\\\"Deployed Certificate to VirtualHost %s for %s\\\",\\n vhost.filep, vhost.names)\\n\\n self.save_notes += (\\\"Changed vhost at %s with addresses of %s\\\\n\\\" %\\n (vhost.filep,\\n \\\", \\\".join(str(addr) for addr in vhost.addrs)))\\n self.save_notes += \\\"\\\\tssl_certificate %s\\\\n\\\" % fullchain_path\\n self.save_notes += \\\"\\\\tssl_certificate_key %s\\\\n\\\" % key_path\\n\\n #######################\\n # Vhost parsing methods\\n #######################\\n def choose_vhost(self, target_name, raise_if_no_match=True):\\n \\\"\\\"\\\"Chooses a virtual host based on the given domain name.\\n\\n .. note:: This makes the vhost SSL-enabled if it isn't already. Follows\\n Nginx's server block selection rules preferring blocks that are\\n already SSL.\\n\\n .. todo:: This should maybe return list if no obvious answer\\n is presented.\\n\\n .. todo:: The special name \\\"$hostname\\\" corresponds to the machine's\\n hostname. Currently we just ignore this.\\n\\n :param str target_name: domain name\\n :param bool raise_if_no_match: True iff not finding a match is an error;\\n otherwise, return None\\n\\n :returns: ssl vhost associated with name\\n :rtype: :class:`~certbot_nginx.obj.VirtualHost`\\n\\n \\\"\\\"\\\"\\n vhost = None\\n\\n matches = self._get_ranked_matches(target_name)\\n vhost = self._select_best_name_match(matches)\\n if not vhost:\\n if raise_if_no_match:\\n # No matches. Raise a misconfiguration error.\\n raise errors.MisconfigurationError(\\n (\\\"Cannot find a VirtualHost matching domain %s. \\\"\\n \\\"In order for Certbot to correctly perform the challenge \\\"\\n \\\"please add a corresponding server_name directive to your \\\"\\n \\\"nginx configuration: \\\"\\n \\\"https://nginx.org/en/docs/http/server_names.html\\\") % (target_name))\\n else:\\n return None\\n else:\\n # Note: if we are enhancing with ocsp, vhost should already be ssl.\\n if not vhost.ssl:\\n self._make_server_ssl(vhost)\\n\\n return vhost\\n\\n def _vhost_from_duplicated_default(self, domain):\\n if self.new_vhost is None:\\n default_vhost = self._get_default_vhost()\\n self.new_vhost = self.parser.create_new_vhost_from_default(default_vhost)\\n if not self.new_vhost.ssl:\\n self._make_server_ssl(self.new_vhost)\\n self.new_vhost.names = set()\\n\\n self.new_vhost.names.add(domain)\\n name_block = [['\\\\n ', 'server_name', ' ', ' '.join(self.new_vhost.names)]]\\n self.parser.add_server_directives(self.new_vhost, name_block, replace=True)\\n return self.new_vhost\\n\\n def _get_default_vhost(self):\\n vhost_list = self.parser.get_vhosts()\\n # if one has default_server set, return that one\\n default_vhosts = []\\n for vhost in vhost_list:\\n for addr in vhost.addrs:\\n if addr.default:\\n default_vhosts.append(vhost)\\n break\\n\\n if len(default_vhosts) == 1:\\n return default_vhosts[0]\\n\\n # TODO: present a list of vhosts for user to choose from\\n\\n raise errors.MisconfigurationError(\\\"Could not automatically find a matching server\\\"\\n \\\" block. Set the `server_name` directive to use the Nginx installer.\\\")\\n\\n def _get_ranked_matches(self, target_name):\\n \\\"\\\"\\\"Returns a ranked list of vhosts that match target_name.\\n The ranking gives preference to SSL vhosts.\\n\\n :param str target_name: The name to match\\n :returns: list of dicts containing the vhost, the matching name, and\\n the numerical rank\\n :rtype: list\\n\\n \\\"\\\"\\\"\\n vhost_list = self.parser.get_vhosts()\\n return self._rank_matches_by_name_and_ssl(vhost_list, target_name)\\n\\n def _select_best_name_match(self, matches):\\n \\\"\\\"\\\"Returns the best name match of a ranked list of vhosts.\\n\\n :param list matches: list of dicts containing the vhost, the matching name,\\n and the numerical rank\\n :returns: the most matching vhost\\n :rtype: :class:`~certbot_nginx.obj.VirtualHost`\\n\\n \\\"\\\"\\\"\\n if not matches:\\n return None\\n elif matches[0]['rank'] in six.moves.range(2, 6):\\n # Wildcard match - need to find the longest one\\n rank = matches[0]['rank']\\n wildcards = [x for x in matches if x['rank'] == rank]\\n return max(wildcards, key=lambda x: len(x['name']))['vhost']\\n else:\\n # Exact or regex match\\n return matches[0]['vhost']\\n\\n\\n def _rank_matches_by_name_and_ssl(self, vhost_list, target_name):\\n \\\"\\\"\\\"Returns a ranked list of vhosts from vhost_list that match target_name.\\n The ranking gives preference to SSL vhosts.\\n\\n :param list vhost_list: list of vhosts to filter and rank\\n :param str target_name: The name to match\\n :returns: list of dicts containing the vhost, the matching name, and\\n the numerical rank\\n :rtype: list\\n\\n \\\"\\\"\\\"\\n # Nginx chooses a matching server name for a request with precedence:\\n # 1. exact name match\\n # 2. longest wildcard name starting with *\\n # 3. longest wildcard name ending with *\\n # 4. first matching regex in order of appearance in the file\\n matches = []\\n for vhost in vhost_list:\\n name_type, name = parser.get_best_match(target_name, vhost.names)\\n if name_type == 'exact':\\n matches.append({'vhost': vhost,\\n 'name': name,\\n 'rank': 0 if vhost.ssl else 1})\\n elif name_type == 'wildcard_start':\\n matches.append({'vhost': vhost,\\n 'name': name,\\n 'rank': 2 if vhost.ssl else 3})\\n elif name_type == 'wildcard_end':\\n matches.append({'vhost': vhost,\\n 'name': name,\\n 'rank': 4 if vhost.ssl else 5})\\n elif name_type == 'regex':\\n matches.append({'vhost': vhost,\\n 'name': name,\\n 'rank': 6 if vhost.ssl else 7})\\n return sorted(matches, key=lambda x: x['rank'])\\n\\n\\n def choose_redirect_vhost(self, target_name, port):\\n \\\"\\\"\\\"Chooses a single virtual host for redirect enhancement.\\n\\n Chooses the vhost most closely matching target_name that is\\n listening to port without using ssl.\\n\\n .. todo:: This should maybe return list if no obvious answer\\n is presented.\\n\\n .. todo:: The special name \\\"$hostname\\\" corresponds to the machine's\\n hostname. Currently we just ignore this.\\n\\n :param str target_name: domain name\\n :param str port: port number\\n :returns: vhost associated with name\\n :rtype: :class:`~certbot_nginx.obj.VirtualHost`\\n\\n \\\"\\\"\\\"\\n matches = self._get_redirect_ranked_matches(target_name, port)\\n return self._select_best_name_match(matches)\\n\\n def _get_redirect_ranked_matches(self, target_name, port):\\n \\\"\\\"\\\"Gets a ranked list of plaintextish port-listening vhosts matching target_name\\n\\n Filter all hosts for those listening on port without using ssl.\\n Rank by how well these match target_name.\\n\\n :param str target_name: The name to match\\n :param str port: port number\\n :returns: list of dicts containing the vhost, the matching name, and\\n the numerical rank\\n :rtype: list\\n\\n \\\"\\\"\\\"\\n all_vhosts = self.parser.get_vhosts()\\n def _port_matches(test_port, matching_port):\\n # test_port is a number, matching is a number or \\\"\\\" or None\\n if matching_port == \\\"\\\" or matching_port is None:\\n # if no port is specified, Nginx defaults to listening on port 80.\\n return test_port == self.DEFAULT_LISTEN_PORT\\n else:\\n return test_port == matching_port\\n\\n def _vhost_matches(vhost, port):\\n found_matching_port = False\\n if len(vhost.addrs) == 0:\\n # if there are no listen directives at all, Nginx defaults to\\n # listening on port 80.\\n found_matching_port = (port == self.DEFAULT_LISTEN_PORT)\\n else:\\n for addr in vhost.addrs:\\n if _port_matches(port, addr.get_port()) and addr.ssl == False:\\n found_matching_port = True\\n\\n if found_matching_port:\\n # make sure we don't have an 'ssl on' directive\\n return not self.parser.has_ssl_on_directive(vhost)\\n else:\\n return False\\n\\n matching_vhosts = [vhost for vhost in all_vhosts if _vhost_matches(vhost, port)]\\n\\n # We can use this ranking function because sslishness doesn't matter to us, and\\n # there shouldn't be conflicting plaintextish servers listening on 80.\\n return self._rank_matches_by_name_and_ssl(matching_vhosts, target_name)\\n\\n def get_all_names(self):\\n \\\"\\\"\\\"Returns all names found in the Nginx Configuration.\\n\\n :returns: All ServerNames, ServerAliases, and reverse DNS entries for\\n virtual host addresses\\n :rtype: set\\n\\n \\\"\\\"\\\"\\n all_names = set()\\n\\n for vhost in self.parser.get_vhosts():\\n all_names.update(vhost.names)\\n\\n for addr in vhost.addrs:\\n host = addr.get_addr()\\n if common.hostname_regex.match(host):\\n # If it's a hostname, add it to the names.\\n all_names.add(host)\\n elif not common.private_ips_regex.match(host):\\n # If it isn't a private IP, do a reverse DNS lookup\\n # TODO: IPv6 support\\n try:\\n socket.inet_aton(host)\\n all_names.add(socket.gethostbyaddr(host)[0])\\n except (socket.error, socket.herror, socket.timeout):\\n continue\\n\\n return util.get_filtered_names(all_names)\\n\\n def _get_snakeoil_paths(self):\\n # TODO: generate only once\\n tmp_dir = os.path.join(self.config.work_dir, \\\"snakeoil\\\")\\n le_key = crypto_util.init_save_key(\\n key_size=1024, key_dir=tmp_dir, keyname=\\\"key.pem\\\")\\n key = OpenSSL.crypto.load_privatekey(\\n OpenSSL.crypto.FILETYPE_PEM, le_key.pem)\\n cert = acme_crypto_util.gen_ss_cert(key, domains=[socket.gethostname()])\\n cert_pem = OpenSSL.crypto.dump_certificate(\\n OpenSSL.crypto.FILETYPE_PEM, cert)\\n cert_file, cert_path = util.unique_file(\\n os.path.join(tmp_dir, \\\"cert.pem\\\"), mode=\\\"wb\\\")\\n with cert_file:\\n cert_file.write(cert_pem)\\n return cert_path, le_key.file\\n\\n def _make_server_ssl(self, vhost):\\n \\\"\\\"\\\"Make a server SSL.\\n\\n Make a server SSL based on server_name and filename by adding a\\n ``listen IConfig.tls_sni_01_port ssl`` directive to the server block.\\n\\n .. todo:: Maybe this should create a new block instead of modifying\\n the existing one?\\n\\n :param vhost: The vhost to add SSL to.\\n :type vhost: :class:`~certbot_nginx.obj.VirtualHost`\\n\\n \\\"\\\"\\\"\\n # If the vhost was implicitly listening on the default Nginx port,\\n # have it continue to do so.\\n if len(vhost.addrs) == 0:\\n listen_block = [['\\\\n ', 'listen', ' ', self.DEFAULT_LISTEN_PORT]]\\n self.parser.add_server_directives(vhost, listen_block, replace=False)\\n\\n snakeoil_cert, snakeoil_key = self._get_snakeoil_paths()\\n\\n ssl_block = ([\\n ['\\\\n ', 'listen', ' ', '{0} ssl'.format(self.config.tls_sni_01_port)],\\n ['\\\\n ', 'ssl_certificate', ' ', snakeoil_cert],\\n ['\\\\n ', 'ssl_certificate_key', ' ', snakeoil_key],\\n ['\\\\n ', 'include', ' ', self.mod_ssl_conf],\\n ['\\\\n ', 'ssl_dhparam', ' ', self.ssl_dhparams],\\n ])\\n\\n self.parser.add_server_directives(\\n vhost, ssl_block, replace=False)\\n\\n ##################################\\n # enhancement methods (IInstaller)\\n ##################################\\n def supported_enhancements(self): # pylint: disable=no-self-use\\n \\\"\\\"\\\"Returns currently supported enhancements.\\\"\\\"\\\"\\n return ['redirect', 'staple-ocsp']\\n\\n def enhance(self, domain, enhancement, options=None):\\n \\\"\\\"\\\"Enhance configuration.\\n\\n :param str domain: domain to enhance\\n :param str enhancement: enhancement type defined in\\n :const:`~certbot.constants.ENHANCEMENTS`\\n :param options: options for the enhancement\\n See :const:`~certbot.constants.ENHANCEMENTS`\\n documentation for appropriate parameter.\\n\\n \\\"\\\"\\\"\\n try:\\n return self._enhance_func[enhancement](domain, options)\\n except (KeyError, ValueError):\\n raise errors.PluginError(\\n \\\"Unsupported enhancement: {0}\\\".format(enhancement))\\n except errors.PluginError:\\n logger.warning(\\\"Failed %s for %s\\\", enhancement, domain)\\n raise\\n\\n def _has_certbot_redirect(self, vhost):\\n return vhost.contains_list(TEST_REDIRECT_BLOCK)\\n\\n def _has_certbot_redirect_comment(self, vhost):\\n return vhost.contains_list(TEST_REDIRECT_COMMENT_BLOCK)\\n\\n def _add_redirect_block(self, vhost, active=True):\\n \\\"\\\"\\\"Add redirect directive to vhost\\n \\\"\\\"\\\"\\n if active:\\n redirect_block = REDIRECT_BLOCK\\n else:\\n redirect_block = REDIRECT_COMMENT_BLOCK\\n\\n self.parser.add_server_directives(\\n vhost, redirect_block, replace=False)\\n\\n def _enable_redirect(self, domain, unused_options):\\n \\\"\\\"\\\"Redirect all equivalent HTTP traffic to ssl_vhost.\\n\\n Add rewrite directive to non https traffic\\n\\n .. note:: This function saves the configuration\\n\\n :param str domain: domain to enable redirect for\\n :param unused_options: Not currently used\\n :type unused_options: Not Available\\n \\\"\\\"\\\"\\n\\n port = self.DEFAULT_LISTEN_PORT\\n vhost = None\\n # If there are blocks listening plaintextishly on self.DEFAULT_LISTEN_PORT,\\n # choose the most name-matching one.\\n vhost = self.choose_redirect_vhost(domain, port)\\n\\n if vhost is None:\\n logger.info(\\\"No matching insecure server blocks listening on port %s found.\\\",\\n self.DEFAULT_LISTEN_PORT)\\n else:\\n if self._has_certbot_redirect(vhost):\\n logger.info(\\\"Traffic on port %s already redirecting to ssl in %s\\\",\\n self.DEFAULT_LISTEN_PORT, vhost.filep)\\n elif vhost.has_redirect():\\n if not self._has_certbot_redirect_comment(vhost):\\n self._add_redirect_block(vhost, active=False)\\n logger.info(\\\"The appropriate server block is already redirecting \\\"\\n \\\"traffic. To enable redirect anyway, uncomment the \\\"\\n \\\"redirect lines in %s.\\\", vhost.filep)\\n else:\\n # Redirect plaintextish host to https\\n self._add_redirect_block(vhost, active=True)\\n logger.info(\\\"Redirecting all traffic on port %s to ssl in %s\\\",\\n self.DEFAULT_LISTEN_PORT, vhost.filep)\\n\\n def _enable_ocsp_stapling(self, domain, chain_path):\\n \\\"\\\"\\\"Include OCSP response in TLS handshake\\n\\n :param str domain: domain to enable OCSP response for\\n :param chain_path: chain file path\\n :type chain_path: `str` or `None`\\n\\n \\\"\\\"\\\"\\n vhost = self.choose_vhost(domain)\\n if self.version < (1, 3, 7):\\n raise errors.PluginError(\\\"Version 1.3.7 or greater of nginx \\\"\\n \\\"is needed to enable OCSP stapling\\\")\\n\\n if chain_path is None:\\n raise errors.PluginError(\\n \\\"--chain-path is required to enable \\\"\\n \\\"Online Certificate Status Protocol (OCSP) stapling \\\"\\n \\\"on nginx >= 1.3.7.\\\")\\n\\n stapling_directives = [\\n ['\\\\n ', 'ssl_trusted_certificate', ' ', chain_path],\\n ['\\\\n ', 'ssl_stapling', ' ', 'on'],\\n ['\\\\n ', 'ssl_stapling_verify', ' ', 'on'], ['\\\\n']]\\n\\n try:\\n self.parser.add_server_directives(vhost,\\n stapling_directives, replace=False)\\n except errors.MisconfigurationError as error:\\n logger.debug(error)\\n raise errors.PluginError(\\\"An error occurred while enabling OCSP \\\"\\n \\\"stapling for {0}.\\\".format(vhost.names))\\n\\n self.save_notes += (\\\"OCSP Stapling was enabled \\\"\\n \\\"on SSL Vhost: {0}.\\\\n\\\".format(vhost.filep))\\n self.save_notes += \\\"\\\\tssl_trusted_certificate {0}\\\\n\\\".format(chain_path)\\n self.save_notes += \\\"\\\\tssl_stapling on\\\\n\\\"\\n self.save_notes += \\\"\\\\tssl_stapling_verify on\\\\n\\\"\\n\\n ######################################\\n # Nginx server management (IInstaller)\\n ######################################\\n def restart(self):\\n \\\"\\\"\\\"Restarts nginx server.\\n\\n :raises .errors.MisconfigurationError: If either the reload fails.\\n\\n \\\"\\\"\\\"\\n nginx_restart(self.conf('ctl'), self.nginx_conf)\\n\\n def config_test(self): # pylint: disable=no-self-use\\n \\\"\\\"\\\"Check the configuration of Nginx for errors.\\n\\n :raises .errors.MisconfigurationError: If config_test fails\\n\\n \\\"\\\"\\\"\\n try:\\n util.run_script([self.conf('ctl'), \\\"-c\\\", self.nginx_conf, \\\"-t\\\"])\\n except errors.SubprocessError as err:\\n raise errors.MisconfigurationError(str(err))\\n\\n def _verify_setup(self):\\n \\\"\\\"\\\"Verify the setup to ensure safe operating environment.\\n\\n Make sure that files/directories are setup with appropriate permissions\\n Aim for defensive coding... make sure all input files\\n have permissions of root.\\n\\n \\\"\\\"\\\"\\n uid = os.geteuid()\\n util.make_or_verify_dir(\\n self.config.work_dir, core_constants.CONFIG_DIRS_MODE, uid)\\n util.make_or_verify_dir(\\n self.config.backup_dir, core_constants.CONFIG_DIRS_MODE, uid)\\n util.make_or_verify_dir(\\n self.config.config_dir, core_constants.CONFIG_DIRS_MODE, uid)\\n\\n def get_version(self):\\n \\\"\\\"\\\"Return version of Nginx Server.\\n\\n Version is returned as tuple. (ie. 2.4.7 = (2, 4, 7))\\n\\n :returns: version\\n :rtype: tuple\\n\\n :raises .PluginError:\\n Unable to find Nginx version or version is unsupported\\n\\n \\\"\\\"\\\"\\n try:\\n proc = subprocess.Popen(\\n [self.conf('ctl'), \\\"-c\\\", self.nginx_conf, \\\"-V\\\"],\\n stdout=subprocess.PIPE,\\n stderr=subprocess.PIPE,\\n universal_newlines=True)\\n text = proc.communicate()[1] # nginx prints output to stderr\\n except (OSError, ValueError) as error:\\n logger.debug(error, exc_info=True)\\n raise errors.PluginError(\\n \\\"Unable to run %s -V\\\" % self.conf('ctl'))\\n\\n version_regex = re.compile(r\\\"nginx/([0-9\\\\.]*)\\\", re.IGNORECASE)\\n version_matches = version_regex.findall(text)\\n\\n sni_regex = re.compile(r\\\"TLS SNI support enabled\\\", re.IGNORECASE)\\n sni_matches = sni_regex.findall(text)\\n\\n ssl_regex = re.compile(r\\\" --with-http_ssl_module\\\")\\n ssl_matches = ssl_regex.findall(text)\\n\\n if not version_matches:\\n raise errors.PluginError(\\\"Unable to find Nginx version\\\")\\n if not ssl_matches:\\n raise errors.PluginError(\\n \\\"Nginx build is missing SSL module (--with-http_ssl_module).\\\")\\n if not sni_matches:\\n raise errors.PluginError(\\\"Nginx build doesn't support SNI\\\")\\n\\n nginx_version = tuple([int(i) for i in version_matches[0].split(\\\".\\\")])\\n\\n # nginx < 0.8.48 uses machine hostname as default server_name instead of\\n # the empty string\\n if nginx_version < (0, 8, 48):\\n raise errors.NotSupportedError(\\\"Nginx version must be 0.8.48+\\\")\\n\\n return nginx_version\\n\\n def more_info(self):\\n \\\"\\\"\\\"Human-readable string to help understand the module\\\"\\\"\\\"\\n return (\\n \\\"Configures Nginx to authenticate and install HTTPS.{0}\\\"\\n \\\"Server root: {root}{0}\\\"\\n \\\"Version: {version}\\\".format(\\n os.linesep, root=self.parser.config_root,\\n version=\\\".\\\".join(str(i) for i in self.version))\\n )\\n\\n ###################################################\\n # Wrapper functions for Reverter class (IInstaller)\\n ###################################################\\n def save(self, title=None, temporary=False):\\n \\\"\\\"\\\"Saves all changes to the configuration files.\\n\\n :param str title: The title of the save. If a title is given, the\\n configuration will be saved as a new checkpoint and put in a\\n timestamped directory.\\n\\n :param bool temporary: Indicates whether the changes made will\\n be quickly reversed in the future (ie. challenges)\\n\\n :raises .errors.PluginError: If there was an error in\\n an attempt to save the configuration, or an error creating a\\n checkpoint\\n\\n \\\"\\\"\\\"\\n save_files = set(self.parser.parsed.keys())\\n self.add_to_checkpoint(save_files, self.save_notes, temporary)\\n self.save_notes = \\\"\\\"\\n\\n # Change 'ext' to something else to not override existing conf files\\n self.parser.filedump(ext='')\\n if title and not temporary:\\n self.finalize_checkpoint(title)\\n\\n def recovery_routine(self):\\n \\\"\\\"\\\"Revert all previously modified files.\\n\\n Reverts all modified files that have not been saved as a checkpoint\\n\\n :raises .errors.PluginError: If unable to recover the configuration\\n\\n \\\"\\\"\\\"\\n super(NginxConfigurator, self).recovery_routine()\\n self.parser.load()\\n\\n def revert_challenge_config(self):\\n \\\"\\\"\\\"Used to cleanup challenge configurations.\\n\\n :raises .errors.PluginError: If unable to revert the challenge config.\\n\\n \\\"\\\"\\\"\\n self.revert_temporary_config()\\n self.parser.load()\\n\\n def rollback_checkpoints(self, rollback=1):\\n \\\"\\\"\\\"Rollback saved checkpoints.\\n\\n :param int rollback: Number of checkpoints to revert\\n\\n :raises .errors.PluginError: If there is a problem with the input or\\n the function is unable to correctly revert the configuration\\n\\n \\\"\\\"\\\"\\n super(NginxConfigurator, self).rollback_checkpoints(rollback)\\n self.parser.load()\\n\\n ###########################################################################\\n # Challenges Section for IAuthenticator\\n ###########################################################################\\n def get_chall_pref(self, unused_domain): # pylint: disable=no-self-use\\n \\\"\\\"\\\"Return list of challenge preferences.\\\"\\\"\\\"\\n return [challenges.TLSSNI01]\\n\\n # Entry point in main.py for performing challenges\\n def perform(self, achalls):\\n \\\"\\\"\\\"Perform the configuration related challenge.\\n\\n This function currently assumes all challenges will be fulfilled.\\n If this turns out not to be the case in the future. Cleanup and\\n outstanding challenges will have to be designed better.\\n\\n \\\"\\\"\\\"\\n self._chall_out += len(achalls)\\n responses = [None] * len(achalls)\\n chall_doer = tls_sni_01.NginxTlsSni01(self)\\n\\n for i, achall in enumerate(achalls):\\n # Currently also have chall_doer hold associated index of the\\n # challenge. This helps to put all of the responses back together\\n # when they are all complete.\\n chall_doer.add_chall(achall, i)\\n\\n sni_response = chall_doer.perform()\\n # Must restart in order to activate the challenges.\\n # Handled here because we may be able to load up other challenge types\\n self.restart()\\n\\n # Go through all of the challenges and assign them to the proper place\\n # in the responses return value. All responses must be in the same order\\n # as the original challenges.\\n for i, resp in enumerate(sni_response):\\n responses[chall_doer.indices[i]] = resp\\n\\n return responses\\n\\n # called after challenges are performed\\n def cleanup(self, achalls):\\n \\\"\\\"\\\"Revert all challenges.\\\"\\\"\\\"\\n self._chall_out -= len(achalls)\\n\\n # If all of the challenges have been finished, clean up everything\\n if self._chall_out <= 0:\\n self.revert_challenge_config()\\n self.restart()\\n\\n\\ndef nginx_restart(nginx_ctl, nginx_conf):\\n \\\"\\\"\\\"Restarts the Nginx Server.\\n\\n .. todo:: Nginx restart is fatal if the configuration references\\n non-existent SSL cert/key files. Remove references to /etc/letsencrypt\\n before restart.\\n\\n :param str nginx_ctl: Path to the Nginx binary.\\n\\n \\\"\\\"\\\"\\n try:\\n proc = subprocess.Popen([nginx_ctl, \\\"-c\\\", nginx_conf, \\\"-s\\\", \\\"reload\\\"])\\n proc.communicate()\\n\\n if proc.returncode != 0:\\n # Maybe Nginx isn't running\\n # Write to temporary files instead of piping because of communication issues on Arch\\n # https://github.com/certbot/certbot/issues/4324\\n with tempfile.TemporaryFile() as out:\\n with tempfile.TemporaryFile() as err:\\n nginx_proc = subprocess.Popen([nginx_ctl, \\\"-c\\\", nginx_conf],\\n stdout=out, stderr=err)\\n nginx_proc.communicate()\\n if nginx_proc.returncode != 0:\\n # Enter recovery routine...\\n raise errors.MisconfigurationError(\\n \\\"nginx restart failed:\\\\n%s\\\\n%s\\\" % (out.read(), err.read()))\\n\\n except (OSError, ValueError):\\n raise errors.MisconfigurationError(\\\"nginx restart failed\\\")\\n # Nginx can take a moment to recognize a newly added TLS SNI servername, so sleep\\n # for a second. TODO: Check for expected servername and loop until it\\n # appears or return an error if looping too long.\\n time.sleep(1)\\n\\n\\ndef install_ssl_options_conf(options_ssl, options_ssl_digest):\\n \\\"\\\"\\\"Copy Certbot's SSL options file into the system's config dir if required.\\\"\\\"\\\"\\n return common.install_version_controlled_file(options_ssl, options_ssl_digest,\\n constants.MOD_SSL_CONF_SRC, constants.ALL_SSL_OPTIONS_HASHES)\\n\",\n \"path\": \"certbot-nginx/certbot_nginx/configurator.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/certbot-nginx/certbot_nginx/configurator.py b/certbot-nginx/certbot_nginx/configurator.py\nindex ba6c565c0fb..4857942a1a6 100644\n--- a/certbot-nginx/certbot_nginx/configurator.py\n+++ b/certbot-nginx/certbot_nginx/configurator.py\n@@ -30,7 +30,7 @@\n logger = logging.getLogger(__name__)\n \n REDIRECT_BLOCK = [[\n- ['\\n ', 'if', ' ', '($scheme', ' ', '!=', ' ', '\"https\") '],\n+ ['\\n ', 'if', ' ', '($scheme', ' ', '!=', ' ', '\"https\")'],\n [['\\n ', 'return', ' ', '301', ' ', 'https://$host$request_uri'],\n '\\n ']\n ], ['\\n']]\ndiff --git a/certbot-nginx/certbot_nginx/tests/configurator_test.py b/certbot-nginx/certbot_nginx/tests/configurator_test.py\nindex 8601866930a..4f9f685c25e 100644\n--- a/certbot-nginx/certbot_nginx/tests/configurator_test.py\n+++ b/certbot-nginx/certbot_nginx/tests/configurator_test.py\n@@ -429,7 +429,7 @@ def test_redirect_enhance(self):\n # Test that we successfully add a redirect when there is\n # a listen directive\n expected = [\n- ['if', '($scheme', '!=', '\"https\") '],\n+ ['if', '($scheme', '!=', '\"https\")'],\n [['return', '301', 'https://$host$request_uri']]\n ]\n \n@@ -512,6 +512,23 @@ def test_redirect_dont_enhance(self):\n self.assertEqual(mock_logger.info.call_args[0][0],\n 'No matching insecure server blocks listening on port %s found.')\n \n+ def test_no_double_redirect(self):\n+ # Test that we don't also add the commented redirect if we've just added\n+ # a redirect to that vhost this run\n+ example_conf = self.config.parser.abs_path('sites-enabled/example.com')\n+ self.config.enhance(\"example.com\", \"redirect\")\n+ self.config.enhance(\"example.org\", \"redirect\")\n+\n+ unexpected = [\n+ ['#', ' Redirect non-https traffic to https'],\n+ ['#', ' if ($scheme != \"https\") {'],\n+ ['#', ' return 301 https://$host$request_uri;'],\n+ ['#', ' } # managed by Certbot']\n+ ]\n+ generated_conf = self.config.parser.parsed[example_conf]\n+ for line in unexpected:\n+ self.assertFalse(util.contains_at_depth(generated_conf, line, 2))\n+\n def test_staple_ocsp_bad_version(self):\n self.config.version = (1, 3, 1)\n self.assertRaises(errors.PluginError, self.config.enhance,\n"}}},{"rowIdx":5498,"cells":{"in_source_id":{"kind":"string","value":"pytorch__ignite-1978"},"issue":{"kind":"string","value":"Improve Accumulation metric on tensors to work with Apex\n## 🚀 Feature Request\r\nIt seems that the ignite is not compatible with apex. When i am trying to use the (automatic mixed precision)amp from the Apex for the GPU Acceleration, I have encountered the following error. Look around the Ignite source code and I find that it uses the original torch.Tensor. Is there any timeline for Ignite to be compatible with Apex?\r\n```\r\nm.update(loss)\r\n--\r\nFile \"/usr/local/lib/python3.6/site-packages/ignite/metrics/metric.py\", line 575, in wrapper\r\nfunc(self, *args, **kwargs)\r\nFile \"/usr/local/lib/python3.6/site-packages/ignite/metrics/accumulation.py\", line 73, in update\r\nself.accumulator = self._op(self.accumulator, output)\r\nFile \"/usr/local/lib/python3.6/site-packages/ignite/metrics/accumulation.py\", line 130, in _mean_op\r\nreturn a + x\r\nFile \"/usr/local/lib64/python3.6/site-packages/apex/amp/wrap.py\", line 62, in wrapper\r\n.format(types))\r\nNotImplementedError: Do not know how to handle these types to promote: {'FloatTensor', 'DoubleTensor'}\r\n```\r\nApex: https://github.com/NVIDIA/apex\r\n\r\n## Environment\r\n\r\n- PyTorch Version (1.4.0):\r\n- Ignite Version (0.4.4):\r\n- OS (Linux):\r\n- Python version: python 3.6\r\n- Apex Version (0.1)\n"},"before_files":{"kind":"list like","value":[{"content":"import numbers\nfrom typing import Callable, Tuple, Union\n\nimport torch\n\nfrom ignite.exceptions import NotComputableError\nfrom ignite.metrics.metric import Metric, reinit__is_reduced, sync_all_reduce\n\n__all__ = [\"VariableAccumulation\", \"GeometricAverage\", \"Average\"]\n\n\nclass VariableAccumulation(Metric):\n \"\"\"Single variable accumulator helper to compute (arithmetic, geometric, harmonic) average of a single variable.\n\n - ``update`` must receive output of the form `x`.\n - `x` can be a number or `torch.Tensor`.\n\n Note:\n\n The class stores input into two public variables: `accumulator` and `num_examples`.\n Number of samples is updated following the rule:\n\n - `+1` if input is a number\n - `+1` if input is a 1D `torch.Tensor`\n - `+batch_size` if input is a ND `torch.Tensor`. Batch size is the first dimension (`shape[0]`).\n\n Args:\n op: a callable to update accumulator. Method's signature is `(accumulator, output)`.\n For example, to compute arithmetic mean value, `op = lambda a, x: a + x`.\n output_transform: a callable that is used to transform the\n :class:`~ignite.engine.engine.Engine`'s ``process_function``'s output into the\n form expected by the metric. This can be useful if, for example, you have a multi-output model and\n you want to compute the metric with respect to one of the outputs.\n device: specifies which device updates are accumulated on. Setting the metric's\n device to be the same as your ``update`` arguments ensures the ``update`` method is non-blocking. By\n default, CPU.\n\n \"\"\"\n\n required_output_keys = None\n\n def __init__(\n self,\n op: Callable,\n output_transform: Callable = lambda x: x,\n device: Union[str, torch.device] = torch.device(\"cpu\"),\n ):\n if not callable(op):\n raise TypeError(f\"Argument op should be a callable, but given {type(op)}\")\n\n self._op = op\n\n super(VariableAccumulation, self).__init__(output_transform=output_transform, device=device)\n\n @reinit__is_reduced\n def reset(self) -> None:\n self.accumulator = torch.tensor(0.0, dtype=torch.float64, device=self._device)\n self.num_examples = 0\n\n def _check_output_type(self, output: Union[float, torch.Tensor]) -> None:\n if not (isinstance(output, numbers.Number) or isinstance(output, torch.Tensor)):\n raise TypeError(f\"Output should be a number or torch.Tensor, but given {type(output)}\")\n\n @reinit__is_reduced\n def update(self, output: Union[float, torch.Tensor]) -> None:\n self._check_output_type(output)\n\n if isinstance(output, torch.Tensor):\n output = output.detach()\n if output.device != self._device:\n output = output.to(self._device)\n\n self.accumulator = self._op(self.accumulator, output)\n\n if isinstance(output, torch.Tensor):\n self.num_examples += output.shape[0] if len(output.shape) > 1 else 1\n else:\n self.num_examples += 1\n\n @sync_all_reduce(\"accumulator\", \"num_examples\")\n def compute(self) -> Tuple[torch.Tensor, int]:\n return self.accumulator, self.num_examples\n\n\nclass Average(VariableAccumulation):\n \"\"\"Helper class to compute arithmetic average of a single variable.\n\n - ``update`` must receive output of the form `x`.\n - `x` can be a number or `torch.Tensor`.\n\n Note:\n\n Number of samples is updated following the rule:\n\n - `+1` if input is a number\n - `+1` if input is a 1D `torch.Tensor`\n - `+batch_size` if input is an ND `torch.Tensor`. Batch size is the first dimension (`shape[0]`).\n\n For input `x` being an ND `torch.Tensor` with N > 1, the first dimension is seen as the number of samples and\n is summed up and added to the accumulator: `accumulator += x.sum(dim=0)`\n\n Examples:\n\n .. code-block:: python\n\n evaluator = ...\n\n custom_var_mean = Average(output_transform=lambda output: output['custom_var'])\n custom_var_mean.attach(evaluator, 'mean_custom_var')\n\n state = evaluator.run(dataset)\n # state.metrics['mean_custom_var'] -> average of output['custom_var']\n\n Args:\n output_transform: a callable that is used to transform the\n :class:`~ignite.engine.engine.Engine`'s ``process_function``'s output into the\n form expected by the metric. This can be useful if, for example, you have a multi-output model and\n you want to compute the metric with respect to one of the outputs.\n device: specifies which device updates are accumulated on. Setting the metric's\n device to be the same as your ``update`` arguments ensures the ``update`` method is non-blocking. By\n default, CPU.\n \"\"\"\n\n def __init__(\n self, output_transform: Callable = lambda x: x, device: Union[str, torch.device] = torch.device(\"cpu\")\n ):\n def _mean_op(a: Union[float, torch.Tensor], x: Union[float, torch.Tensor]) -> Union[float, torch.Tensor]:\n if isinstance(x, torch.Tensor) and x.ndim > 1:\n x = x.sum(dim=0)\n return a + x\n\n super(Average, self).__init__(op=_mean_op, output_transform=output_transform, device=device)\n\n @sync_all_reduce(\"accumulator\", \"num_examples\")\n def compute(self) -> Union[float, torch.Tensor]:\n if self.num_examples < 1:\n raise NotComputableError(\n f\"{self.__class__.__name__} must have at least one example before it can be computed.\"\n )\n\n return self.accumulator / self.num_examples\n\n\nclass GeometricAverage(VariableAccumulation):\n \"\"\"Helper class to compute geometric average of a single variable.\n\n - ``update`` must receive output of the form `x`.\n - `x` can be a positive number or a positive `torch.Tensor`, such that ``torch.log(x)`` is not `nan`.\n\n Note:\n\n Number of samples is updated following the rule:\n\n - `+1` if input is a number\n - `+1` if input is a 1D `torch.Tensor`\n - `+batch_size` if input is a ND `torch.Tensor`. Batch size is the first dimension (`shape[0]`).\n\n For input `x` being an ND `torch.Tensor` with N > 1, the first dimension is seen as the number of samples and\n is aggregated and added to the accumulator: `accumulator *= prod(x, dim=0)`\n\n Args:\n output_transform: a callable that is used to transform the\n :class:`~ignite.engine.engine.Engine`'s ``process_function``'s output into the\n form expected by the metric. This can be useful if, for example, you have a multi-output model and\n you want to compute the metric with respect to one of the outputs.\n device: specifies which device updates are accumulated on. Setting the metric's\n device to be the same as your ``update`` arguments ensures the ``update`` method is non-blocking. By\n default, CPU.\n\n \"\"\"\n\n def __init__(\n self, output_transform: Callable = lambda x: x, device: Union[str, torch.device] = torch.device(\"cpu\")\n ):\n def _geom_op(a: torch.Tensor, x: Union[float, torch.Tensor]) -> torch.Tensor:\n if not isinstance(x, torch.Tensor):\n x = torch.tensor(x)\n x = torch.log(x)\n if x.ndim > 1:\n x = x.sum(dim=0)\n return a + x\n\n super(GeometricAverage, self).__init__(op=_geom_op, output_transform=output_transform, device=device)\n\n @sync_all_reduce(\"accumulator\", \"num_examples\")\n def compute(self) -> Union[float, torch.Tensor]:\n if self.num_examples < 1:\n raise NotComputableError(\n f\"{self.__class__.__name__} must have at least one example before it can be computed.\"\n )\n\n tensor = torch.exp(self.accumulator / self.num_examples)\n\n if tensor.numel() == 1:\n return tensor.item()\n\n return tensor\n","path":"ignite/metrics/accumulation.py"}],"string":"[\n {\n \"content\": \"import numbers\\nfrom typing import Callable, Tuple, Union\\n\\nimport torch\\n\\nfrom ignite.exceptions import NotComputableError\\nfrom ignite.metrics.metric import Metric, reinit__is_reduced, sync_all_reduce\\n\\n__all__ = [\\\"VariableAccumulation\\\", \\\"GeometricAverage\\\", \\\"Average\\\"]\\n\\n\\nclass VariableAccumulation(Metric):\\n \\\"\\\"\\\"Single variable accumulator helper to compute (arithmetic, geometric, harmonic) average of a single variable.\\n\\n - ``update`` must receive output of the form `x`.\\n - `x` can be a number or `torch.Tensor`.\\n\\n Note:\\n\\n The class stores input into two public variables: `accumulator` and `num_examples`.\\n Number of samples is updated following the rule:\\n\\n - `+1` if input is a number\\n - `+1` if input is a 1D `torch.Tensor`\\n - `+batch_size` if input is a ND `torch.Tensor`. Batch size is the first dimension (`shape[0]`).\\n\\n Args:\\n op: a callable to update accumulator. Method's signature is `(accumulator, output)`.\\n For example, to compute arithmetic mean value, `op = lambda a, x: a + x`.\\n output_transform: a callable that is used to transform the\\n :class:`~ignite.engine.engine.Engine`'s ``process_function``'s output into the\\n form expected by the metric. This can be useful if, for example, you have a multi-output model and\\n you want to compute the metric with respect to one of the outputs.\\n device: specifies which device updates are accumulated on. Setting the metric's\\n device to be the same as your ``update`` arguments ensures the ``update`` method is non-blocking. By\\n default, CPU.\\n\\n \\\"\\\"\\\"\\n\\n required_output_keys = None\\n\\n def __init__(\\n self,\\n op: Callable,\\n output_transform: Callable = lambda x: x,\\n device: Union[str, torch.device] = torch.device(\\\"cpu\\\"),\\n ):\\n if not callable(op):\\n raise TypeError(f\\\"Argument op should be a callable, but given {type(op)}\\\")\\n\\n self._op = op\\n\\n super(VariableAccumulation, self).__init__(output_transform=output_transform, device=device)\\n\\n @reinit__is_reduced\\n def reset(self) -> None:\\n self.accumulator = torch.tensor(0.0, dtype=torch.float64, device=self._device)\\n self.num_examples = 0\\n\\n def _check_output_type(self, output: Union[float, torch.Tensor]) -> None:\\n if not (isinstance(output, numbers.Number) or isinstance(output, torch.Tensor)):\\n raise TypeError(f\\\"Output should be a number or torch.Tensor, but given {type(output)}\\\")\\n\\n @reinit__is_reduced\\n def update(self, output: Union[float, torch.Tensor]) -> None:\\n self._check_output_type(output)\\n\\n if isinstance(output, torch.Tensor):\\n output = output.detach()\\n if output.device != self._device:\\n output = output.to(self._device)\\n\\n self.accumulator = self._op(self.accumulator, output)\\n\\n if isinstance(output, torch.Tensor):\\n self.num_examples += output.shape[0] if len(output.shape) > 1 else 1\\n else:\\n self.num_examples += 1\\n\\n @sync_all_reduce(\\\"accumulator\\\", \\\"num_examples\\\")\\n def compute(self) -> Tuple[torch.Tensor, int]:\\n return self.accumulator, self.num_examples\\n\\n\\nclass Average(VariableAccumulation):\\n \\\"\\\"\\\"Helper class to compute arithmetic average of a single variable.\\n\\n - ``update`` must receive output of the form `x`.\\n - `x` can be a number or `torch.Tensor`.\\n\\n Note:\\n\\n Number of samples is updated following the rule:\\n\\n - `+1` if input is a number\\n - `+1` if input is a 1D `torch.Tensor`\\n - `+batch_size` if input is an ND `torch.Tensor`. Batch size is the first dimension (`shape[0]`).\\n\\n For input `x` being an ND `torch.Tensor` with N > 1, the first dimension is seen as the number of samples and\\n is summed up and added to the accumulator: `accumulator += x.sum(dim=0)`\\n\\n Examples:\\n\\n .. code-block:: python\\n\\n evaluator = ...\\n\\n custom_var_mean = Average(output_transform=lambda output: output['custom_var'])\\n custom_var_mean.attach(evaluator, 'mean_custom_var')\\n\\n state = evaluator.run(dataset)\\n # state.metrics['mean_custom_var'] -> average of output['custom_var']\\n\\n Args:\\n output_transform: a callable that is used to transform the\\n :class:`~ignite.engine.engine.Engine`'s ``process_function``'s output into the\\n form expected by the metric. This can be useful if, for example, you have a multi-output model and\\n you want to compute the metric with respect to one of the outputs.\\n device: specifies which device updates are accumulated on. Setting the metric's\\n device to be the same as your ``update`` arguments ensures the ``update`` method is non-blocking. By\\n default, CPU.\\n \\\"\\\"\\\"\\n\\n def __init__(\\n self, output_transform: Callable = lambda x: x, device: Union[str, torch.device] = torch.device(\\\"cpu\\\")\\n ):\\n def _mean_op(a: Union[float, torch.Tensor], x: Union[float, torch.Tensor]) -> Union[float, torch.Tensor]:\\n if isinstance(x, torch.Tensor) and x.ndim > 1:\\n x = x.sum(dim=0)\\n return a + x\\n\\n super(Average, self).__init__(op=_mean_op, output_transform=output_transform, device=device)\\n\\n @sync_all_reduce(\\\"accumulator\\\", \\\"num_examples\\\")\\n def compute(self) -> Union[float, torch.Tensor]:\\n if self.num_examples < 1:\\n raise NotComputableError(\\n f\\\"{self.__class__.__name__} must have at least one example before it can be computed.\\\"\\n )\\n\\n return self.accumulator / self.num_examples\\n\\n\\nclass GeometricAverage(VariableAccumulation):\\n \\\"\\\"\\\"Helper class to compute geometric average of a single variable.\\n\\n - ``update`` must receive output of the form `x`.\\n - `x` can be a positive number or a positive `torch.Tensor`, such that ``torch.log(x)`` is not `nan`.\\n\\n Note:\\n\\n Number of samples is updated following the rule:\\n\\n - `+1` if input is a number\\n - `+1` if input is a 1D `torch.Tensor`\\n - `+batch_size` if input is a ND `torch.Tensor`. Batch size is the first dimension (`shape[0]`).\\n\\n For input `x` being an ND `torch.Tensor` with N > 1, the first dimension is seen as the number of samples and\\n is aggregated and added to the accumulator: `accumulator *= prod(x, dim=0)`\\n\\n Args:\\n output_transform: a callable that is used to transform the\\n :class:`~ignite.engine.engine.Engine`'s ``process_function``'s output into the\\n form expected by the metric. This can be useful if, for example, you have a multi-output model and\\n you want to compute the metric with respect to one of the outputs.\\n device: specifies which device updates are accumulated on. Setting the metric's\\n device to be the same as your ``update`` arguments ensures the ``update`` method is non-blocking. By\\n default, CPU.\\n\\n \\\"\\\"\\\"\\n\\n def __init__(\\n self, output_transform: Callable = lambda x: x, device: Union[str, torch.device] = torch.device(\\\"cpu\\\")\\n ):\\n def _geom_op(a: torch.Tensor, x: Union[float, torch.Tensor]) -> torch.Tensor:\\n if not isinstance(x, torch.Tensor):\\n x = torch.tensor(x)\\n x = torch.log(x)\\n if x.ndim > 1:\\n x = x.sum(dim=0)\\n return a + x\\n\\n super(GeometricAverage, self).__init__(op=_geom_op, output_transform=output_transform, device=device)\\n\\n @sync_all_reduce(\\\"accumulator\\\", \\\"num_examples\\\")\\n def compute(self) -> Union[float, torch.Tensor]:\\n if self.num_examples < 1:\\n raise NotComputableError(\\n f\\\"{self.__class__.__name__} must have at least one example before it can be computed.\\\"\\n )\\n\\n tensor = torch.exp(self.accumulator / self.num_examples)\\n\\n if tensor.numel() == 1:\\n return tensor.item()\\n\\n return tensor\\n\",\n \"path\": \"ignite/metrics/accumulation.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"import numbers\nfrom typing import Callable, Tuple, Union\n\nimport torch\n\nfrom ignite.exceptions import NotComputableError\nfrom ignite.metrics.metric import Metric, reinit__is_reduced, sync_all_reduce\n\n__all__ = [\"VariableAccumulation\", \"GeometricAverage\", \"Average\"]\n\n\nclass VariableAccumulation(Metric):\n \"\"\"Single variable accumulator helper to compute (arithmetic, geometric, harmonic) average of a single variable.\n\n - ``update`` must receive output of the form `x`.\n - `x` can be a number or `torch.Tensor`.\n\n Note:\n\n The class stores input into two public variables: `accumulator` and `num_examples`.\n Number of samples is updated following the rule:\n\n - `+1` if input is a number\n - `+1` if input is a 1D `torch.Tensor`\n - `+batch_size` if input is a ND `torch.Tensor`. Batch size is the first dimension (`shape[0]`).\n\n Args:\n op: a callable to update accumulator. Method's signature is `(accumulator, output)`.\n For example, to compute arithmetic mean value, `op = lambda a, x: a + x`.\n output_transform: a callable that is used to transform the\n :class:`~ignite.engine.engine.Engine`'s ``process_function``'s output into the\n form expected by the metric. This can be useful if, for example, you have a multi-output model and\n you want to compute the metric with respect to one of the outputs.\n device: specifies which device updates are accumulated on. Setting the metric's\n device to be the same as your ``update`` arguments ensures the ``update`` method is non-blocking. By\n default, CPU.\n\n \"\"\"\n\n required_output_keys = None\n\n def __init__(\n self,\n op: Callable,\n output_transform: Callable = lambda x: x,\n device: Union[str, torch.device] = torch.device(\"cpu\"),\n ):\n if not callable(op):\n raise TypeError(f\"Argument op should be a callable, but given {type(op)}\")\n\n self._op = op\n\n super(VariableAccumulation, self).__init__(output_transform=output_transform, device=device)\n\n @reinit__is_reduced\n def reset(self) -> None:\n self.accumulator = torch.tensor(0.0, dtype=torch.float64, device=self._device)\n self.num_examples = 0\n\n def _check_output_type(self, output: Union[float, torch.Tensor]) -> None:\n if not (isinstance(output, numbers.Number) or isinstance(output, torch.Tensor)):\n raise TypeError(f\"Output should be a number or torch.Tensor, but given {type(output)}\")\n\n @reinit__is_reduced\n def update(self, output: Union[float, torch.Tensor]) -> None:\n self._check_output_type(output)\n\n if isinstance(output, torch.Tensor):\n output = output.detach()\n if not (output.device == self._device and output.dtype == self.accumulator.dtype):\n output = output.to(self.accumulator)\n\n self.accumulator = self._op(self.accumulator, output)\n\n if isinstance(output, torch.Tensor):\n self.num_examples += output.shape[0] if len(output.shape) > 1 else 1\n else:\n self.num_examples += 1\n\n @sync_all_reduce(\"accumulator\", \"num_examples\")\n def compute(self) -> Tuple[torch.Tensor, int]:\n return self.accumulator, self.num_examples\n\n\nclass Average(VariableAccumulation):\n \"\"\"Helper class to compute arithmetic average of a single variable.\n\n - ``update`` must receive output of the form `x`.\n - `x` can be a number or `torch.Tensor`.\n\n Note:\n\n Number of samples is updated following the rule:\n\n - `+1` if input is a number\n - `+1` if input is a 1D `torch.Tensor`\n - `+batch_size` if input is an ND `torch.Tensor`. Batch size is the first dimension (`shape[0]`).\n\n For input `x` being an ND `torch.Tensor` with N > 1, the first dimension is seen as the number of samples and\n is summed up and added to the accumulator: `accumulator += x.sum(dim=0)`\n\n Examples:\n\n .. code-block:: python\n\n evaluator = ...\n\n custom_var_mean = Average(output_transform=lambda output: output['custom_var'])\n custom_var_mean.attach(evaluator, 'mean_custom_var')\n\n state = evaluator.run(dataset)\n # state.metrics['mean_custom_var'] -> average of output['custom_var']\n\n Args:\n output_transform: a callable that is used to transform the\n :class:`~ignite.engine.engine.Engine`'s ``process_function``'s output into the\n form expected by the metric. This can be useful if, for example, you have a multi-output model and\n you want to compute the metric with respect to one of the outputs.\n device: specifies which device updates are accumulated on. Setting the metric's\n device to be the same as your ``update`` arguments ensures the ``update`` method is non-blocking. By\n default, CPU.\n \"\"\"\n\n def __init__(\n self, output_transform: Callable = lambda x: x, device: Union[str, torch.device] = torch.device(\"cpu\")\n ):\n def _mean_op(a: Union[float, torch.Tensor], x: Union[float, torch.Tensor]) -> Union[float, torch.Tensor]:\n if isinstance(x, torch.Tensor) and x.ndim > 1:\n x = x.sum(dim=0)\n return a + x\n\n super(Average, self).__init__(op=_mean_op, output_transform=output_transform, device=device)\n\n @sync_all_reduce(\"accumulator\", \"num_examples\")\n def compute(self) -> Union[float, torch.Tensor]:\n if self.num_examples < 1:\n raise NotComputableError(\n f\"{self.__class__.__name__} must have at least one example before it can be computed.\"\n )\n\n return self.accumulator / self.num_examples\n\n\nclass GeometricAverage(VariableAccumulation):\n \"\"\"Helper class to compute geometric average of a single variable.\n\n - ``update`` must receive output of the form `x`.\n - `x` can be a positive number or a positive `torch.Tensor`, such that ``torch.log(x)`` is not `nan`.\n\n Note:\n\n Number of samples is updated following the rule:\n\n - `+1` if input is a number\n - `+1` if input is a 1D `torch.Tensor`\n - `+batch_size` if input is a ND `torch.Tensor`. Batch size is the first dimension (`shape[0]`).\n\n For input `x` being an ND `torch.Tensor` with N > 1, the first dimension is seen as the number of samples and\n is aggregated and added to the accumulator: `accumulator *= prod(x, dim=0)`\n\n Args:\n output_transform: a callable that is used to transform the\n :class:`~ignite.engine.engine.Engine`'s ``process_function``'s output into the\n form expected by the metric. This can be useful if, for example, you have a multi-output model and\n you want to compute the metric with respect to one of the outputs.\n device: specifies which device updates are accumulated on. Setting the metric's\n device to be the same as your ``update`` arguments ensures the ``update`` method is non-blocking. By\n default, CPU.\n\n \"\"\"\n\n def __init__(\n self, output_transform: Callable = lambda x: x, device: Union[str, torch.device] = torch.device(\"cpu\")\n ):\n def _geom_op(a: torch.Tensor, x: Union[float, torch.Tensor]) -> torch.Tensor:\n if not isinstance(x, torch.Tensor):\n x = torch.tensor(x)\n x = torch.log(x)\n if x.ndim > 1:\n x = x.sum(dim=0)\n return a + x\n\n super(GeometricAverage, self).__init__(op=_geom_op, output_transform=output_transform, device=device)\n\n @sync_all_reduce(\"accumulator\", \"num_examples\")\n def compute(self) -> Union[float, torch.Tensor]:\n if self.num_examples < 1:\n raise NotComputableError(\n f\"{self.__class__.__name__} must have at least one example before it can be computed.\"\n )\n\n tensor = torch.exp(self.accumulator / self.num_examples)\n\n if tensor.numel() == 1:\n return tensor.item()\n\n return tensor\n","path":"ignite/metrics/accumulation.py"}],"string":"[\n {\n \"content\": \"import numbers\\nfrom typing import Callable, Tuple, Union\\n\\nimport torch\\n\\nfrom ignite.exceptions import NotComputableError\\nfrom ignite.metrics.metric import Metric, reinit__is_reduced, sync_all_reduce\\n\\n__all__ = [\\\"VariableAccumulation\\\", \\\"GeometricAverage\\\", \\\"Average\\\"]\\n\\n\\nclass VariableAccumulation(Metric):\\n \\\"\\\"\\\"Single variable accumulator helper to compute (arithmetic, geometric, harmonic) average of a single variable.\\n\\n - ``update`` must receive output of the form `x`.\\n - `x` can be a number or `torch.Tensor`.\\n\\n Note:\\n\\n The class stores input into two public variables: `accumulator` and `num_examples`.\\n Number of samples is updated following the rule:\\n\\n - `+1` if input is a number\\n - `+1` if input is a 1D `torch.Tensor`\\n - `+batch_size` if input is a ND `torch.Tensor`. Batch size is the first dimension (`shape[0]`).\\n\\n Args:\\n op: a callable to update accumulator. Method's signature is `(accumulator, output)`.\\n For example, to compute arithmetic mean value, `op = lambda a, x: a + x`.\\n output_transform: a callable that is used to transform the\\n :class:`~ignite.engine.engine.Engine`'s ``process_function``'s output into the\\n form expected by the metric. This can be useful if, for example, you have a multi-output model and\\n you want to compute the metric with respect to one of the outputs.\\n device: specifies which device updates are accumulated on. Setting the metric's\\n device to be the same as your ``update`` arguments ensures the ``update`` method is non-blocking. By\\n default, CPU.\\n\\n \\\"\\\"\\\"\\n\\n required_output_keys = None\\n\\n def __init__(\\n self,\\n op: Callable,\\n output_transform: Callable = lambda x: x,\\n device: Union[str, torch.device] = torch.device(\\\"cpu\\\"),\\n ):\\n if not callable(op):\\n raise TypeError(f\\\"Argument op should be a callable, but given {type(op)}\\\")\\n\\n self._op = op\\n\\n super(VariableAccumulation, self).__init__(output_transform=output_transform, device=device)\\n\\n @reinit__is_reduced\\n def reset(self) -> None:\\n self.accumulator = torch.tensor(0.0, dtype=torch.float64, device=self._device)\\n self.num_examples = 0\\n\\n def _check_output_type(self, output: Union[float, torch.Tensor]) -> None:\\n if not (isinstance(output, numbers.Number) or isinstance(output, torch.Tensor)):\\n raise TypeError(f\\\"Output should be a number or torch.Tensor, but given {type(output)}\\\")\\n\\n @reinit__is_reduced\\n def update(self, output: Union[float, torch.Tensor]) -> None:\\n self._check_output_type(output)\\n\\n if isinstance(output, torch.Tensor):\\n output = output.detach()\\n if not (output.device == self._device and output.dtype == self.accumulator.dtype):\\n output = output.to(self.accumulator)\\n\\n self.accumulator = self._op(self.accumulator, output)\\n\\n if isinstance(output, torch.Tensor):\\n self.num_examples += output.shape[0] if len(output.shape) > 1 else 1\\n else:\\n self.num_examples += 1\\n\\n @sync_all_reduce(\\\"accumulator\\\", \\\"num_examples\\\")\\n def compute(self) -> Tuple[torch.Tensor, int]:\\n return self.accumulator, self.num_examples\\n\\n\\nclass Average(VariableAccumulation):\\n \\\"\\\"\\\"Helper class to compute arithmetic average of a single variable.\\n\\n - ``update`` must receive output of the form `x`.\\n - `x` can be a number or `torch.Tensor`.\\n\\n Note:\\n\\n Number of samples is updated following the rule:\\n\\n - `+1` if input is a number\\n - `+1` if input is a 1D `torch.Tensor`\\n - `+batch_size` if input is an ND `torch.Tensor`. Batch size is the first dimension (`shape[0]`).\\n\\n For input `x` being an ND `torch.Tensor` with N > 1, the first dimension is seen as the number of samples and\\n is summed up and added to the accumulator: `accumulator += x.sum(dim=0)`\\n\\n Examples:\\n\\n .. code-block:: python\\n\\n evaluator = ...\\n\\n custom_var_mean = Average(output_transform=lambda output: output['custom_var'])\\n custom_var_mean.attach(evaluator, 'mean_custom_var')\\n\\n state = evaluator.run(dataset)\\n # state.metrics['mean_custom_var'] -> average of output['custom_var']\\n\\n Args:\\n output_transform: a callable that is used to transform the\\n :class:`~ignite.engine.engine.Engine`'s ``process_function``'s output into the\\n form expected by the metric. This can be useful if, for example, you have a multi-output model and\\n you want to compute the metric with respect to one of the outputs.\\n device: specifies which device updates are accumulated on. Setting the metric's\\n device to be the same as your ``update`` arguments ensures the ``update`` method is non-blocking. By\\n default, CPU.\\n \\\"\\\"\\\"\\n\\n def __init__(\\n self, output_transform: Callable = lambda x: x, device: Union[str, torch.device] = torch.device(\\\"cpu\\\")\\n ):\\n def _mean_op(a: Union[float, torch.Tensor], x: Union[float, torch.Tensor]) -> Union[float, torch.Tensor]:\\n if isinstance(x, torch.Tensor) and x.ndim > 1:\\n x = x.sum(dim=0)\\n return a + x\\n\\n super(Average, self).__init__(op=_mean_op, output_transform=output_transform, device=device)\\n\\n @sync_all_reduce(\\\"accumulator\\\", \\\"num_examples\\\")\\n def compute(self) -> Union[float, torch.Tensor]:\\n if self.num_examples < 1:\\n raise NotComputableError(\\n f\\\"{self.__class__.__name__} must have at least one example before it can be computed.\\\"\\n )\\n\\n return self.accumulator / self.num_examples\\n\\n\\nclass GeometricAverage(VariableAccumulation):\\n \\\"\\\"\\\"Helper class to compute geometric average of a single variable.\\n\\n - ``update`` must receive output of the form `x`.\\n - `x` can be a positive number or a positive `torch.Tensor`, such that ``torch.log(x)`` is not `nan`.\\n\\n Note:\\n\\n Number of samples is updated following the rule:\\n\\n - `+1` if input is a number\\n - `+1` if input is a 1D `torch.Tensor`\\n - `+batch_size` if input is a ND `torch.Tensor`. Batch size is the first dimension (`shape[0]`).\\n\\n For input `x` being an ND `torch.Tensor` with N > 1, the first dimension is seen as the number of samples and\\n is aggregated and added to the accumulator: `accumulator *= prod(x, dim=0)`\\n\\n Args:\\n output_transform: a callable that is used to transform the\\n :class:`~ignite.engine.engine.Engine`'s ``process_function``'s output into the\\n form expected by the metric. This can be useful if, for example, you have a multi-output model and\\n you want to compute the metric with respect to one of the outputs.\\n device: specifies which device updates are accumulated on. Setting the metric's\\n device to be the same as your ``update`` arguments ensures the ``update`` method is non-blocking. By\\n default, CPU.\\n\\n \\\"\\\"\\\"\\n\\n def __init__(\\n self, output_transform: Callable = lambda x: x, device: Union[str, torch.device] = torch.device(\\\"cpu\\\")\\n ):\\n def _geom_op(a: torch.Tensor, x: Union[float, torch.Tensor]) -> torch.Tensor:\\n if not isinstance(x, torch.Tensor):\\n x = torch.tensor(x)\\n x = torch.log(x)\\n if x.ndim > 1:\\n x = x.sum(dim=0)\\n return a + x\\n\\n super(GeometricAverage, self).__init__(op=_geom_op, output_transform=output_transform, device=device)\\n\\n @sync_all_reduce(\\\"accumulator\\\", \\\"num_examples\\\")\\n def compute(self) -> Union[float, torch.Tensor]:\\n if self.num_examples < 1:\\n raise NotComputableError(\\n f\\\"{self.__class__.__name__} must have at least one example before it can be computed.\\\"\\n )\\n\\n tensor = torch.exp(self.accumulator / self.num_examples)\\n\\n if tensor.numel() == 1:\\n return tensor.item()\\n\\n return tensor\\n\",\n \"path\": \"ignite/metrics/accumulation.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/ignite/metrics/accumulation.py b/ignite/metrics/accumulation.py\nindex 8b00a92410d1..c9e85aa464c2 100644\n--- a/ignite/metrics/accumulation.py\n+++ b/ignite/metrics/accumulation.py\n@@ -67,8 +67,8 @@ def update(self, output: Union[float, torch.Tensor]) -> None:\n \n if isinstance(output, torch.Tensor):\n output = output.detach()\n- if output.device != self._device:\n- output = output.to(self._device)\n+ if not (output.device == self._device and output.dtype == self.accumulator.dtype):\n+ output = output.to(self.accumulator)\n \n self.accumulator = self._op(self.accumulator, output)\n \ndiff --git a/tests/ignite/metrics/test_accumulation.py b/tests/ignite/metrics/test_accumulation.py\nindex 8b29f2477949..e47a9273e583 100644\n--- a/tests/ignite/metrics/test_accumulation.py\n+++ b/tests/ignite/metrics/test_accumulation.py\n@@ -1,8 +1,11 @@\n import os\n+from importlib.util import find_spec\n \n import numpy as np\n import pytest\n import torch\n+from torch.nn import Linear\n+from torch.optim import SGD\n \n import ignite.distributed as idist\n from ignite.engine import Engine\n@@ -391,6 +394,34 @@ def _test_distrib_accumulator_device(device):\n ), f\"{type(m.accumulator.device)}:{m.accumulator.device} vs {type(metric_device)}:{metric_device}\"\n \n \n+def _test_apex_average(device, amp_mode, opt_level):\n+ assert amp_mode == \"apex\"\n+ assert device == \"cuda\"\n+\n+ model = Linear(1, 1)\n+\n+ if device:\n+ model.to(device)\n+\n+ model.weight.data.zero_()\n+ model.bias.data.zero_()\n+ optimizer = SGD(model.parameters(), 0.1)\n+\n+ from apex import amp\n+\n+ model, optimizer = amp.initialize(model, optimizer, opt_level=opt_level)\n+\n+ mean_var = VariableAccumulation(lambda a, x: a + x)\n+ y_true = torch.rand(100).float().to(device)\n+\n+ for y in y_true:\n+ mean_var.update(y)\n+\n+ a, n = mean_var.compute()\n+ assert a.item() == pytest.approx(y_true.sum().item())\n+ assert n == len(y_true)\n+\n+\n @pytest.mark.distributed\n @pytest.mark.skipif(not idist.has_native_dist_support, reason=\"Skip if no native dist support\")\n @pytest.mark.skipif(torch.cuda.device_count() < 1, reason=\"Skip if no GPU\")\n@@ -482,3 +513,13 @@ def _test_distrib_xla_nprocs(index):\n def test_distrib_xla_nprocs(xmp_executor):\n n = int(os.environ[\"NUM_TPU_WORKERS\"])\n xmp_executor(_test_distrib_xla_nprocs, args=(), nprocs=n)\n+\n+\n+@pytest.mark.skipif(not torch.cuda.is_available(), reason=\"Skip if no GPU\")\n+@pytest.mark.skipif(not find_spec(\"apex\"), reason=\"Skip if no APEX\")\n+def test_apex_average_on_cuda():\n+ device = \"cuda\"\n+ _test_apex_average(device, amp_mode=\"apex\", opt_level=\"O0\")\n+ _test_apex_average(device, amp_mode=\"apex\", opt_level=\"O1\")\n+ _test_apex_average(device, amp_mode=\"apex\", opt_level=\"O2\")\n+ _test_apex_average(device, amp_mode=\"apex\", opt_level=\"O3\")\n"}}},{"rowIdx":5499,"cells":{"in_source_id":{"kind":"string","value":"mindsdb__mindsdb-855"},"issue":{"kind":"string","value":"Add update argument to executable function\nAdd optional boolean argument update to [make_executable](https://github.com/mindsdb/mindsdb/blob/staging/mindsdb/utilities/wizards.py#L230)() function, so if it's set to true then the executable should run \r\n```\r\npy -m pip install mindsdb --upgrade \r\n```\r\nbefore \r\n```\r\npy -m mindsdb\r\n```\r\n\n"},"before_files":{"kind":"list like","value":[{"content":"import os\nimport json\nfrom datetime import datetime, timedelta\n\n\ndef _in(ask, default, use_default):\n if use_default:\n return default\n\n user_input = input(f'{ask} (Default: {default})')\n if user_input is None or user_input == '':\n user_input = default\n\n if type(default) == int:\n user_input = int(user_input)\n\n if type(default) == bool:\n user_input = int(user_input)\n\n return user_input\n\n\ndef auto_config(python_path, pip_path, storage_dir):\n config = {\n \"debug\": False,\n \"config_version\": \"1.3\",\n \"api\": {\n },\n \"integrations\": {\n \"default_clickhouse\": {\n \"enabled\": False,\n \"type\": 'clickhouse'\n },\n \"default_mariadb\": {\n \"enabled\": False,\n \"type\": 'mariadb'\n },\n \"default_mysql\": {\n \"enabled\": False,\n \"type\": 'mysql'\n },\n \"default_postgres\": {\n \"enabled\": False,\n \"type\": 'postgres',\n \"database\": 'postgres'\n },\n \"default_mssql\": {\n \"enabled\": False,\n \"type\": 'mssql'\n },\n \"default_mongodb\": {\n \"enabled\": False,\n \"type\": 'mongodb'\n }\n },\n 'storage_dir': storage_dir\n }\n\n if isinstance(python_path, str):\n config['python_interpreter'] = python_path\n\n if isinstance(pip_path, str):\n config['pip_path'] = python_path\n\n return config\n\n\ndef make_ssl_cert(file_path):\n from cryptography import x509\n from cryptography.x509.oid import NameOID\n from cryptography.hazmat.backends import default_backend\n from cryptography.hazmat.primitives import hashes\n from cryptography.hazmat.primitives import serialization\n from cryptography.hazmat.primitives.asymmetric import rsa\n\n key = rsa.generate_private_key(\n public_exponent=65537,\n key_size=2048,\n backend=default_backend(),\n )\n\n name = x509.Name([\n x509.NameAttribute(NameOID.COMMON_NAME, 'mdb_autogen'),\n x509.NameAttribute(NameOID.COUNTRY_NAME, 'US'),\n x509.NameAttribute(NameOID.STATE_OR_PROVINCE_NAME, 'California'),\n x509.NameAttribute(NameOID.LOCALITY_NAME, 'Berkeley'),\n x509.NameAttribute(NameOID.ORGANIZATION_NAME, 'MindsDB')\n ])\n\n now = datetime.utcnow()\n cert = (\n x509.CertificateBuilder()\n .subject_name(name)\n .issuer_name(name)\n .public_key(key.public_key())\n .serial_number(1)\n .not_valid_before(now - timedelta(days=10 * 365))\n .not_valid_after(now + timedelta(days=10 * 365))\n .add_extension(\n x509.BasicConstraints(ca=True, path_length=0),\n False\n )\n .sign(key, hashes.SHA256(), default_backend())\n )\n cert_pem = cert.public_bytes(encoding=serialization.Encoding.PEM)\n key_pem = key.private_bytes(\n encoding=serialization.Encoding.PEM,\n format=serialization.PrivateFormat.TraditionalOpenSSL,\n encryption_algorithm=serialization.NoEncryption(),\n )\n\n with open(file_path, 'wb') as f:\n f.write(key_pem + cert_pem)\n\n\ndef cli_config(python_path, pip_path, storage_dir, config_dir, use_default=False):\n config = auto_config(python_path, pip_path, storage_dir)\n\n http = _in('Enable HTTP API ? [Y/N]', 'Y', use_default)\n if http in ['Y', 'y']:\n config['api']['http'] = {}\n config['api']['http']['host'] = _in('HTTP interface host: ', '127.0.0.1', use_default)\n config['api']['http']['port'] = _in('HTTP interface port: ', '47334', use_default)\n\n mysql = _in('Enable MYSQL API ? [Y/N]', 'Y', use_default)\n if mysql in ['Y', 'y']:\n config['api']['mysql'] = {}\n config['api']['mysql']['host'] = _in('MYSQL interface host', '127.0.0.1', use_default)\n config['api']['mysql']['port'] = _in('MYSQL interface port', '47335', use_default)\n config['api']['mysql']['user'] = _in('MYSQL interface user', 'mindsdb', use_default)\n config['api']['mysql']['password'] = _in('MYSQL interface password', '', use_default)\n\n mongodb = _in('Enable Mongo API ? [Y/N]', 'Y', use_default)\n if mongodb in ['Y', 'y']:\n config['api']['mongodb'] = {}\n config['api']['mongodb']['host'] = _in('Mongo interface host: ', '127.0.0.1', use_default)\n config['api']['mongodb']['port'] = _in('Mongo interface port: ', '47336', use_default)\n\n clickhouse = _in('Connect to clickhouse ? [Y/N]', 'Y', use_default)\n if clickhouse in ['Y', 'y']:\n config['integrations']['default_clickhouse']['enabled'] = _in('Enable Clickhouse integration?: ', False, use_default)\n config['integrations']['default_clickhouse']['host'] = _in('Clickhouse host: ', '127.0.0.1', use_default)\n config['integrations']['default_clickhouse']['port'] = _in('Clickhouse port: ', 8123, use_default)\n config['integrations']['default_clickhouse']['user'] = _in('Clickhouse user: ', 'default', use_default)\n config['integrations']['default_clickhouse']['password'] = _in('Clickhouse password: ', '', use_default)\n config['integrations']['default_clickhouse']['type'] = 'clickhouse'\n\n mariadb = _in('Connect to Mariadb ? [Y/N]', 'Y', use_default)\n if mariadb in ['Y', 'y']:\n config['integrations']['default_mariadb']['enabled'] = _in('Enable Mariadb integration?: ', False, use_default)\n config['integrations']['default_mariadb']['host'] = _in('Mariadb host: ', '127.0.0.1', use_default)\n config['integrations']['default_mariadb']['port'] = _in('Mariadb port: ', 3306, use_default)\n config['integrations']['default_mariadb']['user'] = _in('Mariadb user: ', 'root', use_default)\n config['integrations']['default_mariadb']['password'] = _in('Mariadb password: ', '', use_default)\n config['integrations']['default_mariadb']['type'] = 'mariadb'\n\n mysql = _in('Connect to MySQL ? [Y/N]', 'Y', use_default)\n if mysql in ['Y', 'y']:\n config['integrations']['default_mysql']['enabled'] = _in('Enable MySQL integration?: ', False, use_default)\n config['integrations']['default_mysql']['host'] = _in('MySQL host: ', '127.0.0.1', use_default)\n config['integrations']['default_mysql']['port'] = _in('MySQL port: ', 3306, use_default)\n config['integrations']['default_mysql']['user'] = _in('MySQL user: ', 'root', use_default)\n config['integrations']['default_mysql']['password'] = _in('MySQL password: ', '', use_default)\n config['integrations']['default_mysql']['type'] = 'mysql'\n\n mysql = _in('Connect to PostgreSQL ? [Y/N]', 'Y', use_default)\n if mysql in ['Y', 'y']:\n config['integrations']['default_postgres']['enabled'] = _in('Enable PostgreSQL integration?: ', False, use_default)\n config['integrations']['default_postgres']['host'] = _in('PostgreSQL host: ', '127.0.0.1', use_default)\n config['integrations']['default_postgres']['port'] = _in('PostgreSQL port: ', 5432, use_default)\n config['integrations']['default_postgres']['user'] = _in('PostgreSQL user: ', 'postgres', use_default)\n config['integrations']['default_postgres']['password'] = _in('PostgreSQL password: ', '', use_default)\n config['integrations']['default_postgres']['database'] = _in('PostgreSQL database: ', 'postgres', use_default)\n config['integrations']['default_postgres']['type'] = 'postgres'\n\n mssql = _in('Connect to MSSQL ? [Y/N]', 'Y', use_default)\n if mssql in ['Y', 'y']:\n config['integrations']['default_mssql']['enabled'] = _in('Enable MSSQL integration?: ', False, use_default)\n config['integrations']['default_mssql']['host'] = _in('MSSQL host: ', '127.0.0.1', use_default)\n config['integrations']['default_mssql']['port'] = _in('MSSQL port: ', 1433, use_default)\n config['integrations']['default_mssql']['user'] = _in('MSSQL user: ', 'sa', use_default)\n config['integrations']['default_mssql']['password'] = _in('MSSQL password: ', '', use_default)\n config['integrations']['default_mssql']['odbc_driver_name'] = _in('MySQL ODBC driver name: ', 'MySQL ODBC 8.0 Unicode Driver', use_default)\n config['integrations']['default_mssql']['type'] = 'mssql'\n\n mongodb = _in('Connect to MongoDB ? [Y/N]', 'Y', use_default)\n if mongodb in ['Y', 'y']:\n config['integrations']['default_mongodb']['enabled'] = _in('Enable MongoDB integration?: ', False, use_default)\n config['integrations']['default_mongodb']['host'] = _in('MongoDB host: ', '127.0.0.1', use_default)\n config['integrations']['default_mongodb']['port'] = _in('MongoDB port: ', 27017, use_default)\n config['integrations']['default_mongodb']['user'] = _in('MongoDB user: ', '', use_default)\n config['integrations']['default_mongodb']['password'] = _in('MongoDB password: ', '', use_default)\n config['integrations']['default_mongodb']['type'] = 'mongodb'\n\n for db_name in list(config['integrations'].keys()):\n if not config['integrations'][db_name]['enabled']:\n del config['integrations'][db_name]\n\n\n config_path = os.path.join(config_dir, 'config.json')\n with open(config_path, 'w') as fp:\n json.dump(config, fp, indent=4, sort_keys=True)\n\n return config_path\n\n\ndef daemon_creator(python_path, config_path=None):\n daemon_path = '/etc/systemd/system/mindsdb.service'\n service_txt = f\"\"\"[Unit]\n Description=Mindsdb\n [Service]\n ExecStart={python_path} -m mindsdb { \"--config=\"+config_path if config_path else \"\"}\n [Install]\n WantedBy=multi-user.target\n \"\"\".strip(' ')\n\n try:\n with open(daemon_path, 'w') as fp:\n fp.write(service_txt)\n except Exception as e:\n print(f'Failed to create daemon, error: {e}')\n\n try:\n os.system('systemctl daemon-reload')\n except Exception as e:\n print(f'Failed to load daemon, error: {e}')\n return daemon_path\n\n\ndef make_executable(python_path, exec_path, config_path=None):\n text = f\"\"\"#!/bin/bash\n{python_path} -m mindsdb { \"--config=\"+config_path if config_path else \"\"}\n\"\"\"\n\n with open(exec_path, 'w') as fp:\n fp.write(text)\n\n os.system(f'chmod +x {exec_path}')\n","path":"mindsdb/utilities/wizards.py"}],"string":"[\n {\n \"content\": \"import os\\nimport json\\nfrom datetime import datetime, timedelta\\n\\n\\ndef _in(ask, default, use_default):\\n if use_default:\\n return default\\n\\n user_input = input(f'{ask} (Default: {default})')\\n if user_input is None or user_input == '':\\n user_input = default\\n\\n if type(default) == int:\\n user_input = int(user_input)\\n\\n if type(default) == bool:\\n user_input = int(user_input)\\n\\n return user_input\\n\\n\\ndef auto_config(python_path, pip_path, storage_dir):\\n config = {\\n \\\"debug\\\": False,\\n \\\"config_version\\\": \\\"1.3\\\",\\n \\\"api\\\": {\\n },\\n \\\"integrations\\\": {\\n \\\"default_clickhouse\\\": {\\n \\\"enabled\\\": False,\\n \\\"type\\\": 'clickhouse'\\n },\\n \\\"default_mariadb\\\": {\\n \\\"enabled\\\": False,\\n \\\"type\\\": 'mariadb'\\n },\\n \\\"default_mysql\\\": {\\n \\\"enabled\\\": False,\\n \\\"type\\\": 'mysql'\\n },\\n \\\"default_postgres\\\": {\\n \\\"enabled\\\": False,\\n \\\"type\\\": 'postgres',\\n \\\"database\\\": 'postgres'\\n },\\n \\\"default_mssql\\\": {\\n \\\"enabled\\\": False,\\n \\\"type\\\": 'mssql'\\n },\\n \\\"default_mongodb\\\": {\\n \\\"enabled\\\": False,\\n \\\"type\\\": 'mongodb'\\n }\\n },\\n 'storage_dir': storage_dir\\n }\\n\\n if isinstance(python_path, str):\\n config['python_interpreter'] = python_path\\n\\n if isinstance(pip_path, str):\\n config['pip_path'] = python_path\\n\\n return config\\n\\n\\ndef make_ssl_cert(file_path):\\n from cryptography import x509\\n from cryptography.x509.oid import NameOID\\n from cryptography.hazmat.backends import default_backend\\n from cryptography.hazmat.primitives import hashes\\n from cryptography.hazmat.primitives import serialization\\n from cryptography.hazmat.primitives.asymmetric import rsa\\n\\n key = rsa.generate_private_key(\\n public_exponent=65537,\\n key_size=2048,\\n backend=default_backend(),\\n )\\n\\n name = x509.Name([\\n x509.NameAttribute(NameOID.COMMON_NAME, 'mdb_autogen'),\\n x509.NameAttribute(NameOID.COUNTRY_NAME, 'US'),\\n x509.NameAttribute(NameOID.STATE_OR_PROVINCE_NAME, 'California'),\\n x509.NameAttribute(NameOID.LOCALITY_NAME, 'Berkeley'),\\n x509.NameAttribute(NameOID.ORGANIZATION_NAME, 'MindsDB')\\n ])\\n\\n now = datetime.utcnow()\\n cert = (\\n x509.CertificateBuilder()\\n .subject_name(name)\\n .issuer_name(name)\\n .public_key(key.public_key())\\n .serial_number(1)\\n .not_valid_before(now - timedelta(days=10 * 365))\\n .not_valid_after(now + timedelta(days=10 * 365))\\n .add_extension(\\n x509.BasicConstraints(ca=True, path_length=0),\\n False\\n )\\n .sign(key, hashes.SHA256(), default_backend())\\n )\\n cert_pem = cert.public_bytes(encoding=serialization.Encoding.PEM)\\n key_pem = key.private_bytes(\\n encoding=serialization.Encoding.PEM,\\n format=serialization.PrivateFormat.TraditionalOpenSSL,\\n encryption_algorithm=serialization.NoEncryption(),\\n )\\n\\n with open(file_path, 'wb') as f:\\n f.write(key_pem + cert_pem)\\n\\n\\ndef cli_config(python_path, pip_path, storage_dir, config_dir, use_default=False):\\n config = auto_config(python_path, pip_path, storage_dir)\\n\\n http = _in('Enable HTTP API ? [Y/N]', 'Y', use_default)\\n if http in ['Y', 'y']:\\n config['api']['http'] = {}\\n config['api']['http']['host'] = _in('HTTP interface host: ', '127.0.0.1', use_default)\\n config['api']['http']['port'] = _in('HTTP interface port: ', '47334', use_default)\\n\\n mysql = _in('Enable MYSQL API ? [Y/N]', 'Y', use_default)\\n if mysql in ['Y', 'y']:\\n config['api']['mysql'] = {}\\n config['api']['mysql']['host'] = _in('MYSQL interface host', '127.0.0.1', use_default)\\n config['api']['mysql']['port'] = _in('MYSQL interface port', '47335', use_default)\\n config['api']['mysql']['user'] = _in('MYSQL interface user', 'mindsdb', use_default)\\n config['api']['mysql']['password'] = _in('MYSQL interface password', '', use_default)\\n\\n mongodb = _in('Enable Mongo API ? [Y/N]', 'Y', use_default)\\n if mongodb in ['Y', 'y']:\\n config['api']['mongodb'] = {}\\n config['api']['mongodb']['host'] = _in('Mongo interface host: ', '127.0.0.1', use_default)\\n config['api']['mongodb']['port'] = _in('Mongo interface port: ', '47336', use_default)\\n\\n clickhouse = _in('Connect to clickhouse ? [Y/N]', 'Y', use_default)\\n if clickhouse in ['Y', 'y']:\\n config['integrations']['default_clickhouse']['enabled'] = _in('Enable Clickhouse integration?: ', False, use_default)\\n config['integrations']['default_clickhouse']['host'] = _in('Clickhouse host: ', '127.0.0.1', use_default)\\n config['integrations']['default_clickhouse']['port'] = _in('Clickhouse port: ', 8123, use_default)\\n config['integrations']['default_clickhouse']['user'] = _in('Clickhouse user: ', 'default', use_default)\\n config['integrations']['default_clickhouse']['password'] = _in('Clickhouse password: ', '', use_default)\\n config['integrations']['default_clickhouse']['type'] = 'clickhouse'\\n\\n mariadb = _in('Connect to Mariadb ? [Y/N]', 'Y', use_default)\\n if mariadb in ['Y', 'y']:\\n config['integrations']['default_mariadb']['enabled'] = _in('Enable Mariadb integration?: ', False, use_default)\\n config['integrations']['default_mariadb']['host'] = _in('Mariadb host: ', '127.0.0.1', use_default)\\n config['integrations']['default_mariadb']['port'] = _in('Mariadb port: ', 3306, use_default)\\n config['integrations']['default_mariadb']['user'] = _in('Mariadb user: ', 'root', use_default)\\n config['integrations']['default_mariadb']['password'] = _in('Mariadb password: ', '', use_default)\\n config['integrations']['default_mariadb']['type'] = 'mariadb'\\n\\n mysql = _in('Connect to MySQL ? [Y/N]', 'Y', use_default)\\n if mysql in ['Y', 'y']:\\n config['integrations']['default_mysql']['enabled'] = _in('Enable MySQL integration?: ', False, use_default)\\n config['integrations']['default_mysql']['host'] = _in('MySQL host: ', '127.0.0.1', use_default)\\n config['integrations']['default_mysql']['port'] = _in('MySQL port: ', 3306, use_default)\\n config['integrations']['default_mysql']['user'] = _in('MySQL user: ', 'root', use_default)\\n config['integrations']['default_mysql']['password'] = _in('MySQL password: ', '', use_default)\\n config['integrations']['default_mysql']['type'] = 'mysql'\\n\\n mysql = _in('Connect to PostgreSQL ? [Y/N]', 'Y', use_default)\\n if mysql in ['Y', 'y']:\\n config['integrations']['default_postgres']['enabled'] = _in('Enable PostgreSQL integration?: ', False, use_default)\\n config['integrations']['default_postgres']['host'] = _in('PostgreSQL host: ', '127.0.0.1', use_default)\\n config['integrations']['default_postgres']['port'] = _in('PostgreSQL port: ', 5432, use_default)\\n config['integrations']['default_postgres']['user'] = _in('PostgreSQL user: ', 'postgres', use_default)\\n config['integrations']['default_postgres']['password'] = _in('PostgreSQL password: ', '', use_default)\\n config['integrations']['default_postgres']['database'] = _in('PostgreSQL database: ', 'postgres', use_default)\\n config['integrations']['default_postgres']['type'] = 'postgres'\\n\\n mssql = _in('Connect to MSSQL ? [Y/N]', 'Y', use_default)\\n if mssql in ['Y', 'y']:\\n config['integrations']['default_mssql']['enabled'] = _in('Enable MSSQL integration?: ', False, use_default)\\n config['integrations']['default_mssql']['host'] = _in('MSSQL host: ', '127.0.0.1', use_default)\\n config['integrations']['default_mssql']['port'] = _in('MSSQL port: ', 1433, use_default)\\n config['integrations']['default_mssql']['user'] = _in('MSSQL user: ', 'sa', use_default)\\n config['integrations']['default_mssql']['password'] = _in('MSSQL password: ', '', use_default)\\n config['integrations']['default_mssql']['odbc_driver_name'] = _in('MySQL ODBC driver name: ', 'MySQL ODBC 8.0 Unicode Driver', use_default)\\n config['integrations']['default_mssql']['type'] = 'mssql'\\n\\n mongodb = _in('Connect to MongoDB ? [Y/N]', 'Y', use_default)\\n if mongodb in ['Y', 'y']:\\n config['integrations']['default_mongodb']['enabled'] = _in('Enable MongoDB integration?: ', False, use_default)\\n config['integrations']['default_mongodb']['host'] = _in('MongoDB host: ', '127.0.0.1', use_default)\\n config['integrations']['default_mongodb']['port'] = _in('MongoDB port: ', 27017, use_default)\\n config['integrations']['default_mongodb']['user'] = _in('MongoDB user: ', '', use_default)\\n config['integrations']['default_mongodb']['password'] = _in('MongoDB password: ', '', use_default)\\n config['integrations']['default_mongodb']['type'] = 'mongodb'\\n\\n for db_name in list(config['integrations'].keys()):\\n if not config['integrations'][db_name]['enabled']:\\n del config['integrations'][db_name]\\n\\n\\n config_path = os.path.join(config_dir, 'config.json')\\n with open(config_path, 'w') as fp:\\n json.dump(config, fp, indent=4, sort_keys=True)\\n\\n return config_path\\n\\n\\ndef daemon_creator(python_path, config_path=None):\\n daemon_path = '/etc/systemd/system/mindsdb.service'\\n service_txt = f\\\"\\\"\\\"[Unit]\\n Description=Mindsdb\\n [Service]\\n ExecStart={python_path} -m mindsdb { \\\"--config=\\\"+config_path if config_path else \\\"\\\"}\\n [Install]\\n WantedBy=multi-user.target\\n \\\"\\\"\\\".strip(' ')\\n\\n try:\\n with open(daemon_path, 'w') as fp:\\n fp.write(service_txt)\\n except Exception as e:\\n print(f'Failed to create daemon, error: {e}')\\n\\n try:\\n os.system('systemctl daemon-reload')\\n except Exception as e:\\n print(f'Failed to load daemon, error: {e}')\\n return daemon_path\\n\\n\\ndef make_executable(python_path, exec_path, config_path=None):\\n text = f\\\"\\\"\\\"#!/bin/bash\\n{python_path} -m mindsdb { \\\"--config=\\\"+config_path if config_path else \\\"\\\"}\\n\\\"\\\"\\\"\\n\\n with open(exec_path, 'w') as fp:\\n fp.write(text)\\n\\n os.system(f'chmod +x {exec_path}')\\n\",\n \"path\": \"mindsdb/utilities/wizards.py\"\n }\n]","isConversational":false},"after_files":{"kind":"list like","value":[{"content":"import os\nimport json\nfrom datetime import datetime, timedelta\n\n\ndef _in(ask, default, use_default):\n if use_default:\n return default\n\n user_input = input(f'{ask} (Default: {default})')\n if user_input is None or user_input == '':\n user_input = default\n\n if type(default) == int:\n user_input = int(user_input)\n\n if type(default) == bool:\n user_input = int(user_input)\n\n return user_input\n\n\ndef auto_config(python_path, pip_path, storage_dir):\n config = {\n \"debug\": False,\n \"config_version\": \"1.3\",\n \"api\": {\n },\n \"integrations\": {\n \"default_clickhouse\": {\n \"enabled\": False,\n \"type\": 'clickhouse'\n },\n \"default_mariadb\": {\n \"enabled\": False,\n \"type\": 'mariadb'\n },\n \"default_mysql\": {\n \"enabled\": False,\n \"type\": 'mysql'\n },\n \"default_postgres\": {\n \"enabled\": False,\n \"type\": 'postgres',\n \"database\": 'postgres'\n },\n \"default_mssql\": {\n \"enabled\": False,\n \"type\": 'mssql'\n },\n \"default_mongodb\": {\n \"enabled\": False,\n \"type\": 'mongodb'\n }\n },\n 'storage_dir': storage_dir\n }\n\n if isinstance(python_path, str):\n config['python_interpreter'] = python_path\n\n if isinstance(pip_path, str):\n config['pip_path'] = python_path\n\n return config\n\n\ndef make_ssl_cert(file_path):\n from cryptography import x509\n from cryptography.x509.oid import NameOID\n from cryptography.hazmat.backends import default_backend\n from cryptography.hazmat.primitives import hashes\n from cryptography.hazmat.primitives import serialization\n from cryptography.hazmat.primitives.asymmetric import rsa\n\n key = rsa.generate_private_key(\n public_exponent=65537,\n key_size=2048,\n backend=default_backend(),\n )\n\n name = x509.Name([\n x509.NameAttribute(NameOID.COMMON_NAME, 'mdb_autogen'),\n x509.NameAttribute(NameOID.COUNTRY_NAME, 'US'),\n x509.NameAttribute(NameOID.STATE_OR_PROVINCE_NAME, 'California'),\n x509.NameAttribute(NameOID.LOCALITY_NAME, 'Berkeley'),\n x509.NameAttribute(NameOID.ORGANIZATION_NAME, 'MindsDB')\n ])\n\n now = datetime.utcnow()\n cert = (\n x509.CertificateBuilder()\n .subject_name(name)\n .issuer_name(name)\n .public_key(key.public_key())\n .serial_number(1)\n .not_valid_before(now - timedelta(days=10 * 365))\n .not_valid_after(now + timedelta(days=10 * 365))\n .add_extension(\n x509.BasicConstraints(ca=True, path_length=0),\n False\n )\n .sign(key, hashes.SHA256(), default_backend())\n )\n cert_pem = cert.public_bytes(encoding=serialization.Encoding.PEM)\n key_pem = key.private_bytes(\n encoding=serialization.Encoding.PEM,\n format=serialization.PrivateFormat.TraditionalOpenSSL,\n encryption_algorithm=serialization.NoEncryption(),\n )\n\n with open(file_path, 'wb') as f:\n f.write(key_pem + cert_pem)\n\n\ndef cli_config(python_path, pip_path, storage_dir, config_dir, use_default=False):\n config = auto_config(python_path, pip_path, storage_dir)\n\n http = _in('Enable HTTP API ? [Y/N]', 'Y', use_default)\n if http in ['Y', 'y']:\n config['api']['http'] = {}\n config['api']['http']['host'] = _in('HTTP interface host: ', '127.0.0.1', use_default)\n config['api']['http']['port'] = _in('HTTP interface port: ', '47334', use_default)\n\n mysql = _in('Enable MYSQL API ? [Y/N]', 'Y', use_default)\n if mysql in ['Y', 'y']:\n config['api']['mysql'] = {}\n config['api']['mysql']['host'] = _in('MYSQL interface host', '127.0.0.1', use_default)\n config['api']['mysql']['port'] = _in('MYSQL interface port', '47335', use_default)\n config['api']['mysql']['user'] = _in('MYSQL interface user', 'mindsdb', use_default)\n config['api']['mysql']['password'] = _in('MYSQL interface password', '', use_default)\n\n mongodb = _in('Enable Mongo API ? [Y/N]', 'Y', use_default)\n if mongodb in ['Y', 'y']:\n config['api']['mongodb'] = {}\n config['api']['mongodb']['host'] = _in('Mongo interface host: ', '127.0.0.1', use_default)\n config['api']['mongodb']['port'] = _in('Mongo interface port: ', '47336', use_default)\n\n clickhouse = _in('Connect to clickhouse ? [Y/N]', 'Y', use_default)\n if clickhouse in ['Y', 'y']:\n config['integrations']['default_clickhouse']['enabled'] = _in('Enable Clickhouse integration?: ', False, use_default)\n config['integrations']['default_clickhouse']['host'] = _in('Clickhouse host: ', '127.0.0.1', use_default)\n config['integrations']['default_clickhouse']['port'] = _in('Clickhouse port: ', 8123, use_default)\n config['integrations']['default_clickhouse']['user'] = _in('Clickhouse user: ', 'default', use_default)\n config['integrations']['default_clickhouse']['password'] = _in('Clickhouse password: ', '', use_default)\n config['integrations']['default_clickhouse']['type'] = 'clickhouse'\n\n mariadb = _in('Connect to Mariadb ? [Y/N]', 'Y', use_default)\n if mariadb in ['Y', 'y']:\n config['integrations']['default_mariadb']['enabled'] = _in('Enable Mariadb integration?: ', False, use_default)\n config['integrations']['default_mariadb']['host'] = _in('Mariadb host: ', '127.0.0.1', use_default)\n config['integrations']['default_mariadb']['port'] = _in('Mariadb port: ', 3306, use_default)\n config['integrations']['default_mariadb']['user'] = _in('Mariadb user: ', 'root', use_default)\n config['integrations']['default_mariadb']['password'] = _in('Mariadb password: ', '', use_default)\n config['integrations']['default_mariadb']['type'] = 'mariadb'\n\n mysql = _in('Connect to MySQL ? [Y/N]', 'Y', use_default)\n if mysql in ['Y', 'y']:\n config['integrations']['default_mysql']['enabled'] = _in('Enable MySQL integration?: ', False, use_default)\n config['integrations']['default_mysql']['host'] = _in('MySQL host: ', '127.0.0.1', use_default)\n config['integrations']['default_mysql']['port'] = _in('MySQL port: ', 3306, use_default)\n config['integrations']['default_mysql']['user'] = _in('MySQL user: ', 'root', use_default)\n config['integrations']['default_mysql']['password'] = _in('MySQL password: ', '', use_default)\n config['integrations']['default_mysql']['type'] = 'mysql'\n\n mysql = _in('Connect to PostgreSQL ? [Y/N]', 'Y', use_default)\n if mysql in ['Y', 'y']:\n config['integrations']['default_postgres']['enabled'] = _in('Enable PostgreSQL integration?: ', False, use_default)\n config['integrations']['default_postgres']['host'] = _in('PostgreSQL host: ', '127.0.0.1', use_default)\n config['integrations']['default_postgres']['port'] = _in('PostgreSQL port: ', 5432, use_default)\n config['integrations']['default_postgres']['user'] = _in('PostgreSQL user: ', 'postgres', use_default)\n config['integrations']['default_postgres']['password'] = _in('PostgreSQL password: ', '', use_default)\n config['integrations']['default_postgres']['database'] = _in('PostgreSQL database: ', 'postgres', use_default)\n config['integrations']['default_postgres']['type'] = 'postgres'\n\n mssql = _in('Connect to MSSQL ? [Y/N]', 'Y', use_default)\n if mssql in ['Y', 'y']:\n config['integrations']['default_mssql']['enabled'] = _in('Enable MSSQL integration?: ', False, use_default)\n config['integrations']['default_mssql']['host'] = _in('MSSQL host: ', '127.0.0.1', use_default)\n config['integrations']['default_mssql']['port'] = _in('MSSQL port: ', 1433, use_default)\n config['integrations']['default_mssql']['user'] = _in('MSSQL user: ', 'sa', use_default)\n config['integrations']['default_mssql']['password'] = _in('MSSQL password: ', '', use_default)\n config['integrations']['default_mssql']['odbc_driver_name'] = _in('MySQL ODBC driver name: ', 'MySQL ODBC 8.0 Unicode Driver', use_default)\n config['integrations']['default_mssql']['type'] = 'mssql'\n\n mongodb = _in('Connect to MongoDB ? [Y/N]', 'Y', use_default)\n if mongodb in ['Y', 'y']:\n config['integrations']['default_mongodb']['enabled'] = _in('Enable MongoDB integration?: ', False, use_default)\n config['integrations']['default_mongodb']['host'] = _in('MongoDB host: ', '127.0.0.1', use_default)\n config['integrations']['default_mongodb']['port'] = _in('MongoDB port: ', 27017, use_default)\n config['integrations']['default_mongodb']['user'] = _in('MongoDB user: ', '', use_default)\n config['integrations']['default_mongodb']['password'] = _in('MongoDB password: ', '', use_default)\n config['integrations']['default_mongodb']['type'] = 'mongodb'\n\n for db_name in list(config['integrations'].keys()):\n if not config['integrations'][db_name]['enabled']:\n del config['integrations'][db_name]\n\n\n config_path = os.path.join(config_dir, 'config.json')\n with open(config_path, 'w') as fp:\n json.dump(config, fp, indent=4, sort_keys=True)\n\n return config_path\n\n\ndef daemon_creator(python_path, config_path=None):\n daemon_path = '/etc/systemd/system/mindsdb.service'\n service_txt = f\"\"\"[Unit]\n Description=Mindsdb\n [Service]\n ExecStart={python_path} -m mindsdb { \"--config=\"+config_path if config_path else \"\"}\n [Install]\n WantedBy=multi-user.target\n \"\"\".strip(' ')\n\n try:\n with open(daemon_path, 'w') as fp:\n fp.write(service_txt)\n except Exception as e:\n print(f'Failed to create daemon, error: {e}')\n\n try:\n os.system('systemctl daemon-reload')\n except Exception as e:\n print(f'Failed to load daemon, error: {e}')\n return daemon_path\n\n\ndef make_executable(python_path, exec_path, config_path=None, update=False):\n text = f\"\"\"#!/bin/bash\nupdate={str(update).lower()}\n\nif [ \"$update\" = true ] \n then\n {python_path} -m pip install mindsdb --upgrade \nfi\n{python_path} -m mindsdb { \"--config=\"+config_path if config_path else \"\"}\n\"\"\"\n\n with open(exec_path, 'w') as fp:\n fp.write(text)\n\n os.system(f'chmod +x {exec_path}')\n","path":"mindsdb/utilities/wizards.py"}],"string":"[\n {\n \"content\": \"import os\\nimport json\\nfrom datetime import datetime, timedelta\\n\\n\\ndef _in(ask, default, use_default):\\n if use_default:\\n return default\\n\\n user_input = input(f'{ask} (Default: {default})')\\n if user_input is None or user_input == '':\\n user_input = default\\n\\n if type(default) == int:\\n user_input = int(user_input)\\n\\n if type(default) == bool:\\n user_input = int(user_input)\\n\\n return user_input\\n\\n\\ndef auto_config(python_path, pip_path, storage_dir):\\n config = {\\n \\\"debug\\\": False,\\n \\\"config_version\\\": \\\"1.3\\\",\\n \\\"api\\\": {\\n },\\n \\\"integrations\\\": {\\n \\\"default_clickhouse\\\": {\\n \\\"enabled\\\": False,\\n \\\"type\\\": 'clickhouse'\\n },\\n \\\"default_mariadb\\\": {\\n \\\"enabled\\\": False,\\n \\\"type\\\": 'mariadb'\\n },\\n \\\"default_mysql\\\": {\\n \\\"enabled\\\": False,\\n \\\"type\\\": 'mysql'\\n },\\n \\\"default_postgres\\\": {\\n \\\"enabled\\\": False,\\n \\\"type\\\": 'postgres',\\n \\\"database\\\": 'postgres'\\n },\\n \\\"default_mssql\\\": {\\n \\\"enabled\\\": False,\\n \\\"type\\\": 'mssql'\\n },\\n \\\"default_mongodb\\\": {\\n \\\"enabled\\\": False,\\n \\\"type\\\": 'mongodb'\\n }\\n },\\n 'storage_dir': storage_dir\\n }\\n\\n if isinstance(python_path, str):\\n config['python_interpreter'] = python_path\\n\\n if isinstance(pip_path, str):\\n config['pip_path'] = python_path\\n\\n return config\\n\\n\\ndef make_ssl_cert(file_path):\\n from cryptography import x509\\n from cryptography.x509.oid import NameOID\\n from cryptography.hazmat.backends import default_backend\\n from cryptography.hazmat.primitives import hashes\\n from cryptography.hazmat.primitives import serialization\\n from cryptography.hazmat.primitives.asymmetric import rsa\\n\\n key = rsa.generate_private_key(\\n public_exponent=65537,\\n key_size=2048,\\n backend=default_backend(),\\n )\\n\\n name = x509.Name([\\n x509.NameAttribute(NameOID.COMMON_NAME, 'mdb_autogen'),\\n x509.NameAttribute(NameOID.COUNTRY_NAME, 'US'),\\n x509.NameAttribute(NameOID.STATE_OR_PROVINCE_NAME, 'California'),\\n x509.NameAttribute(NameOID.LOCALITY_NAME, 'Berkeley'),\\n x509.NameAttribute(NameOID.ORGANIZATION_NAME, 'MindsDB')\\n ])\\n\\n now = datetime.utcnow()\\n cert = (\\n x509.CertificateBuilder()\\n .subject_name(name)\\n .issuer_name(name)\\n .public_key(key.public_key())\\n .serial_number(1)\\n .not_valid_before(now - timedelta(days=10 * 365))\\n .not_valid_after(now + timedelta(days=10 * 365))\\n .add_extension(\\n x509.BasicConstraints(ca=True, path_length=0),\\n False\\n )\\n .sign(key, hashes.SHA256(), default_backend())\\n )\\n cert_pem = cert.public_bytes(encoding=serialization.Encoding.PEM)\\n key_pem = key.private_bytes(\\n encoding=serialization.Encoding.PEM,\\n format=serialization.PrivateFormat.TraditionalOpenSSL,\\n encryption_algorithm=serialization.NoEncryption(),\\n )\\n\\n with open(file_path, 'wb') as f:\\n f.write(key_pem + cert_pem)\\n\\n\\ndef cli_config(python_path, pip_path, storage_dir, config_dir, use_default=False):\\n config = auto_config(python_path, pip_path, storage_dir)\\n\\n http = _in('Enable HTTP API ? [Y/N]', 'Y', use_default)\\n if http in ['Y', 'y']:\\n config['api']['http'] = {}\\n config['api']['http']['host'] = _in('HTTP interface host: ', '127.0.0.1', use_default)\\n config['api']['http']['port'] = _in('HTTP interface port: ', '47334', use_default)\\n\\n mysql = _in('Enable MYSQL API ? [Y/N]', 'Y', use_default)\\n if mysql in ['Y', 'y']:\\n config['api']['mysql'] = {}\\n config['api']['mysql']['host'] = _in('MYSQL interface host', '127.0.0.1', use_default)\\n config['api']['mysql']['port'] = _in('MYSQL interface port', '47335', use_default)\\n config['api']['mysql']['user'] = _in('MYSQL interface user', 'mindsdb', use_default)\\n config['api']['mysql']['password'] = _in('MYSQL interface password', '', use_default)\\n\\n mongodb = _in('Enable Mongo API ? [Y/N]', 'Y', use_default)\\n if mongodb in ['Y', 'y']:\\n config['api']['mongodb'] = {}\\n config['api']['mongodb']['host'] = _in('Mongo interface host: ', '127.0.0.1', use_default)\\n config['api']['mongodb']['port'] = _in('Mongo interface port: ', '47336', use_default)\\n\\n clickhouse = _in('Connect to clickhouse ? [Y/N]', 'Y', use_default)\\n if clickhouse in ['Y', 'y']:\\n config['integrations']['default_clickhouse']['enabled'] = _in('Enable Clickhouse integration?: ', False, use_default)\\n config['integrations']['default_clickhouse']['host'] = _in('Clickhouse host: ', '127.0.0.1', use_default)\\n config['integrations']['default_clickhouse']['port'] = _in('Clickhouse port: ', 8123, use_default)\\n config['integrations']['default_clickhouse']['user'] = _in('Clickhouse user: ', 'default', use_default)\\n config['integrations']['default_clickhouse']['password'] = _in('Clickhouse password: ', '', use_default)\\n config['integrations']['default_clickhouse']['type'] = 'clickhouse'\\n\\n mariadb = _in('Connect to Mariadb ? [Y/N]', 'Y', use_default)\\n if mariadb in ['Y', 'y']:\\n config['integrations']['default_mariadb']['enabled'] = _in('Enable Mariadb integration?: ', False, use_default)\\n config['integrations']['default_mariadb']['host'] = _in('Mariadb host: ', '127.0.0.1', use_default)\\n config['integrations']['default_mariadb']['port'] = _in('Mariadb port: ', 3306, use_default)\\n config['integrations']['default_mariadb']['user'] = _in('Mariadb user: ', 'root', use_default)\\n config['integrations']['default_mariadb']['password'] = _in('Mariadb password: ', '', use_default)\\n config['integrations']['default_mariadb']['type'] = 'mariadb'\\n\\n mysql = _in('Connect to MySQL ? [Y/N]', 'Y', use_default)\\n if mysql in ['Y', 'y']:\\n config['integrations']['default_mysql']['enabled'] = _in('Enable MySQL integration?: ', False, use_default)\\n config['integrations']['default_mysql']['host'] = _in('MySQL host: ', '127.0.0.1', use_default)\\n config['integrations']['default_mysql']['port'] = _in('MySQL port: ', 3306, use_default)\\n config['integrations']['default_mysql']['user'] = _in('MySQL user: ', 'root', use_default)\\n config['integrations']['default_mysql']['password'] = _in('MySQL password: ', '', use_default)\\n config['integrations']['default_mysql']['type'] = 'mysql'\\n\\n mysql = _in('Connect to PostgreSQL ? [Y/N]', 'Y', use_default)\\n if mysql in ['Y', 'y']:\\n config['integrations']['default_postgres']['enabled'] = _in('Enable PostgreSQL integration?: ', False, use_default)\\n config['integrations']['default_postgres']['host'] = _in('PostgreSQL host: ', '127.0.0.1', use_default)\\n config['integrations']['default_postgres']['port'] = _in('PostgreSQL port: ', 5432, use_default)\\n config['integrations']['default_postgres']['user'] = _in('PostgreSQL user: ', 'postgres', use_default)\\n config['integrations']['default_postgres']['password'] = _in('PostgreSQL password: ', '', use_default)\\n config['integrations']['default_postgres']['database'] = _in('PostgreSQL database: ', 'postgres', use_default)\\n config['integrations']['default_postgres']['type'] = 'postgres'\\n\\n mssql = _in('Connect to MSSQL ? [Y/N]', 'Y', use_default)\\n if mssql in ['Y', 'y']:\\n config['integrations']['default_mssql']['enabled'] = _in('Enable MSSQL integration?: ', False, use_default)\\n config['integrations']['default_mssql']['host'] = _in('MSSQL host: ', '127.0.0.1', use_default)\\n config['integrations']['default_mssql']['port'] = _in('MSSQL port: ', 1433, use_default)\\n config['integrations']['default_mssql']['user'] = _in('MSSQL user: ', 'sa', use_default)\\n config['integrations']['default_mssql']['password'] = _in('MSSQL password: ', '', use_default)\\n config['integrations']['default_mssql']['odbc_driver_name'] = _in('MySQL ODBC driver name: ', 'MySQL ODBC 8.0 Unicode Driver', use_default)\\n config['integrations']['default_mssql']['type'] = 'mssql'\\n\\n mongodb = _in('Connect to MongoDB ? [Y/N]', 'Y', use_default)\\n if mongodb in ['Y', 'y']:\\n config['integrations']['default_mongodb']['enabled'] = _in('Enable MongoDB integration?: ', False, use_default)\\n config['integrations']['default_mongodb']['host'] = _in('MongoDB host: ', '127.0.0.1', use_default)\\n config['integrations']['default_mongodb']['port'] = _in('MongoDB port: ', 27017, use_default)\\n config['integrations']['default_mongodb']['user'] = _in('MongoDB user: ', '', use_default)\\n config['integrations']['default_mongodb']['password'] = _in('MongoDB password: ', '', use_default)\\n config['integrations']['default_mongodb']['type'] = 'mongodb'\\n\\n for db_name in list(config['integrations'].keys()):\\n if not config['integrations'][db_name]['enabled']:\\n del config['integrations'][db_name]\\n\\n\\n config_path = os.path.join(config_dir, 'config.json')\\n with open(config_path, 'w') as fp:\\n json.dump(config, fp, indent=4, sort_keys=True)\\n\\n return config_path\\n\\n\\ndef daemon_creator(python_path, config_path=None):\\n daemon_path = '/etc/systemd/system/mindsdb.service'\\n service_txt = f\\\"\\\"\\\"[Unit]\\n Description=Mindsdb\\n [Service]\\n ExecStart={python_path} -m mindsdb { \\\"--config=\\\"+config_path if config_path else \\\"\\\"}\\n [Install]\\n WantedBy=multi-user.target\\n \\\"\\\"\\\".strip(' ')\\n\\n try:\\n with open(daemon_path, 'w') as fp:\\n fp.write(service_txt)\\n except Exception as e:\\n print(f'Failed to create daemon, error: {e}')\\n\\n try:\\n os.system('systemctl daemon-reload')\\n except Exception as e:\\n print(f'Failed to load daemon, error: {e}')\\n return daemon_path\\n\\n\\ndef make_executable(python_path, exec_path, config_path=None, update=False):\\n text = f\\\"\\\"\\\"#!/bin/bash\\nupdate={str(update).lower()}\\n\\nif [ \\\"$update\\\" = true ] \\n then\\n {python_path} -m pip install mindsdb --upgrade \\nfi\\n{python_path} -m mindsdb { \\\"--config=\\\"+config_path if config_path else \\\"\\\"}\\n\\\"\\\"\\\"\\n\\n with open(exec_path, 'w') as fp:\\n fp.write(text)\\n\\n os.system(f'chmod +x {exec_path}')\\n\",\n \"path\": \"mindsdb/utilities/wizards.py\"\n }\n]","isConversational":false},"pr_diff":{"kind":"string","value":"diff --git a/mindsdb/utilities/wizards.py b/mindsdb/utilities/wizards.py\nindex 7a8d653634d..fc4225b3271 100644\n--- a/mindsdb/utilities/wizards.py\n+++ b/mindsdb/utilities/wizards.py\n@@ -227,8 +227,14 @@ def daemon_creator(python_path, config_path=None):\n return daemon_path\n \n \n-def make_executable(python_path, exec_path, config_path=None):\n+def make_executable(python_path, exec_path, config_path=None, update=False):\n text = f\"\"\"#!/bin/bash\n+update={str(update).lower()}\n+\n+if [ \"$update\" = true ] \n+ then\n+ {python_path} -m pip install mindsdb --upgrade \n+fi\n {python_path} -m mindsdb { \"--config=\"+config_path if config_path else \"\"}\n \"\"\"\n \n"}}}],"truncated":false,"partial":false},"paginationData":{"pageIndex":54,"numItemsPerPage":100,"numTotalItems":69711,"offset":5400,"length":100}},"jwt":"eyJhbGciOiJFZERTQSIsImtpZCI6IjVHZDBvd0g5MTM2eDZjc1FvbE1zcktNWUZoRVFoUm5PVVVybEpjOUhaUEEifQ.eyJyZWFkIjp0cnVlLCJwZXJtaXNzaW9ucyI6eyJyZXBvLmNvbnRlbnQucmVhZCI6dHJ1ZX0sInJlcG9JZHMiOlsiNjg0NmRhMzM3MjA0OTNlYWQ1ZGVlOTBkIl0sImlhdCI6MTc5MzI3MDIyNiwianRpIjoiNjI5MGRjYWUtZDFiMi00ZDlkLTkxZjUtZGIwZmYxZWZjYzJlIiwic3ViIjoiL2RhdGFzZXRzL3Jhc2RhbmkvZ2l0aHViLXBhdGNoZXMiLCJleHAiOjE3OTMyNzM4MjYsImlzcyI6Imh0dHBzOi8vaHVnZ2luZ2ZhY2UuY28ifQ.abuJjc_IjyBBAWouqIg56jW6yvryaFAuNBGf8jk-9Vxfw-xCIZ09muZN9y3BC3HL7k4KyXUc8uzcHZHMFgPNBw","displayUrls":true,"splitSizeSummaries":[{"config":"default","split":"train","numRows":69711,"numBytesParquet":2677201019}]},"discussionsStats":{"closed":0,"open":1,"total":1},"fullWidth":true,"hasGatedAccess":true,"hasFullAccess":true,"isEmbedded":false,"savedQueries":{"community":[],"user":[]}}">
in_source_id stringlengths 13 58 | issue stringlengths 3 241k | before_files listlengths 0 3 | after_files listlengths 0 3 | pr_diff stringlengths 109 107M ⌀ |
|---|---|---|---|---|
DataBiosphere__toil-2834 | Example script duplicated
`examples/hello.py` and `src/toil/test/docs/scripts/tutorial_arguments.py` are duplicate scripts with the same contents.
┆Issue is synchronized with this [Jira Task](https://ucsc-cgl.atlassian.net/browse/TOIL-443)
┆Issue Number: TOIL-443
| [
{
"content": "from toil.common import Toil\nfrom toil.job import Job\n\nclass HelloWorld(Job):\n def __init__(self, message):\n Job.__init__(self, memory=\"1G\", cores=2, disk=\"2G\")\n self.message = message\n\n def run(self, fileStore):\n return \"Hello, world!, here's a message: %... | [
{
"content": null,
"path": "examples/hello.py"
}
] | diff --git a/examples b/examples
new file mode 120000
index 0000000000..475efb5a79
--- /dev/null
+++ b/examples
@@ -0,0 +1 @@
+src/toil/test/docs/scripts/
\ No newline at end of file
diff --git a/examples/hello.py b/examples/hello.py
deleted file mode 100644
index 6ca4b13734..0000000000
--- a/examples/hello.py
+++ /dev... |
python__peps-2090 | "PEP numbers never change" verbiage is not in PEP 1
## Problem
The introduction to PEP 0 references PEP 1 as a source for
> PEP numbers are assigned by the PEP editors, and once assigned are never changed [1].
But PEP 1 doesn't say anything about PEP numbers never changing.
## Research
While skimming PEP... | [
{
"content": "# -*- coding: utf-8 -*-\ntext_type = str\ntitle_length = 55\nauthor_length = 40\ntable_separator = \"== ==== \" + \"=\"*title_length + \" \" + \"=\"*author_length\ncolumn_format = (\n '%(type)1s%(status)1s %(number)4s %(title)-{title_length}s %(authors)-s'\n).format(title_length=title_length)... | [
{
"content": "# -*- coding: utf-8 -*-\ntext_type = str\ntitle_length = 55\nauthor_length = 40\ntable_separator = \"== ==== \" + \"=\"*title_length + \" \" + \"=\"*author_length\ncolumn_format = (\n '%(type)1s%(status)1s %(number)4s %(title)-{title_length}s %(authors)-s'\n).format(title_length=title_length)... | diff --git a/pep0/constants.py b/pep0/constants.py
index e40293f44a9..108710d0927 100644
--- a/pep0/constants.py
+++ b/pep0/constants.py
@@ -21,8 +21,8 @@
intro = """\
This PEP contains the index of all Python Enhancement Proposals,
-known as PEPs. PEP numbers are assigned by the PEP editors, and
-once assigned ar... |
DjangoGirls__djangogirls-409 | [Check-in emails] Wait at least a week before sending an email
I've just deployed an event that will happen in March: 5 min after that, the organizer received a check-in email :smile:
We should at least wait a week before sending a check-in emails.
| [
{
"content": "\"\"\"Management command for handling of automatic emails.\n\nThis is run via a scheduled task every hour and checks if there are any emails that need sending.\n\n\"\"\"\nimport logging\nfrom smtplib import SMTPException\n\nimport djclick as click\nfrom django.conf import settings\nfrom django.cor... | [
{
"content": "\"\"\"Management command for handling of automatic emails.\n\nThis is run via a scheduled task every hour and checks if there are any emails that need sending.\n\n\"\"\"\nimport logging\nfrom smtplib import SMTPException\n\nimport djclick as click\nfrom django.conf import settings\nfrom django.cor... | diff --git a/core/management/commands/handle_emails.py b/core/management/commands/handle_emails.py
index 8229647ee..aea4d0a57 100644
--- a/core/management/commands/handle_emails.py
+++ b/core/management/commands/handle_emails.py
@@ -104,6 +104,7 @@ def send_offer_help_emails():
is_on_homepage=True,
da... |
voxel51__fiftyone-1859 | [BUG] tfrecord shard enumeration starting from 1 instead of 0
### System information
- **OS Platform and Distribution (e.g., Linux Ubuntu 16.04)**: Arch Linux
- **FiftyOne installed from (pip or source)**: pip
- **FiftyOne version (run `fiftyone --version`)**: v0.16.2
- **Python version**: 3.10.4
### C... | [
{
"content": "\"\"\"\nTensorFlow utilities.\n\n| Copyright 2017-2022, Voxel51, Inc.\n| `voxel51.com <https://voxel51.com/>`_\n|\n\"\"\"\nimport contextlib\nimport logging\nimport multiprocessing\nimport os\nimport warnings\n\nimport cv2\nimport numpy as np\nfrom skimage.color import rgba2rgb\n\nimport eta.core.... | [
{
"content": "\"\"\"\nTensorFlow utilities.\n\n| Copyright 2017-2022, Voxel51, Inc.\n| `voxel51.com <https://voxel51.com/>`_\n|\n\"\"\"\nimport contextlib\nimport logging\nimport multiprocessing\nimport os\nimport warnings\n\nimport cv2\nimport numpy as np\nfrom skimage.color import rgba2rgb\n\nimport eta.core.... | diff --git a/fiftyone/utils/tf.py b/fiftyone/utils/tf.py
index 13c55e644c0..58e755cc75b 100644
--- a/fiftyone/utils/tf.py
+++ b/fiftyone/utils/tf.py
@@ -249,7 +249,7 @@ def __enter__(self):
tf_records_patt = self.tf_records_path + "-%05d-of-%05d"
tf_records_paths = [
tf_record... |
vyperlang__vyper-3010 | CBOR section at end should include length indicator like in Solidity
## Simple Summary
PR #2860 introduced a CBOR section at the end of Vyper bytecode, like Solidity has. However, unlike in Solidity, there's nothing to indicate the length of this CBOR section. While it's easy enough to recognize the fixed format u... | [
{
"content": "import copy\nimport functools\nimport math\n\nfrom vyper.codegen.ir_node import IRnode\nfrom vyper.evm.opcodes import get_opcodes\nfrom vyper.exceptions import CodegenPanic, CompilerPanic\nfrom vyper.utils import MemoryPositions\nfrom vyper.version import version_tuple\n\nPUSH_OFFSET = 0x5F\nDUP_O... | [
{
"content": "import copy\nimport functools\nimport math\n\nfrom vyper.codegen.ir_node import IRnode\nfrom vyper.evm.opcodes import get_opcodes\nfrom vyper.exceptions import CodegenPanic, CompilerPanic\nfrom vyper.utils import MemoryPositions\nfrom vyper.version import version_tuple\n\nPUSH_OFFSET = 0x5F\nDUP_O... | diff --git a/vyper/ir/compile_ir.py b/vyper/ir/compile_ir.py
index 9a2661fe6b..dd1a0b45d3 100644
--- a/vyper/ir/compile_ir.py
+++ b/vyper/ir/compile_ir.py
@@ -994,6 +994,7 @@ def assembly_to_evm(assembly, pc_ofst=0, insert_vyper_signature=False):
if insert_vyper_signature:
# CBOR encoded: {"vyper": [major... |
hpcaitech__ColossalAI-5342 | [tensor] fix some unittests
[tensor] fix some unittests
[tensor] fix some unittests
| [
{
"content": "import importlib\nimport os\nimport time\nfrom abc import abstractmethod\nfrom pathlib import Path\nfrom typing import List\n\nfrom .base_extension import _Extension\n\n__all__ = [\"_CppExtension\"]\n\n\nclass _CppExtension(_Extension):\n def __init__(self, name: str, priority: int = 1):\n ... | [
{
"content": "import importlib\nimport os\nimport time\nfrom abc import abstractmethod\nfrom pathlib import Path\nfrom typing import List\n\nfrom .base_extension import _Extension\n\n__all__ = [\"_CppExtension\"]\n\n\nclass _CppExtension(_Extension):\n def __init__(self, name: str, priority: int = 1):\n ... | diff --git a/extensions/cpp_extension.py b/extensions/cpp_extension.py
index b4c40c9f1105..3adb65fb8f4e 100644
--- a/extensions/cpp_extension.py
+++ b/extensions/cpp_extension.py
@@ -126,7 +126,7 @@ def cxx_flags(self) -> List[str]:
def load(self):
try:
op_kernel = self.import_op()
- e... |
kubeflow__pipelines-6683 | [sdk] dependency conflict with tensorflow 2.6.0 and seldon-core
### Environment
* KFP version: 1.7
* KFP SDK version: 1.8.3
* All dependencies version:
```
[~]$ pip list | grep kfp
kfp 1.8.3
kfp-pipeline-spec 0.1.11
kfp-server-api 1.7.0
... | [
{
"content": "# Copyright 2018 The Kubeflow Authors\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required b... | [
{
"content": "# Copyright 2018 The Kubeflow Authors\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required b... | diff --git a/sdk/RELEASE.md b/sdk/RELEASE.md
index 4ed40322a2a..3018a2e86d9 100644
--- a/sdk/RELEASE.md
+++ b/sdk/RELEASE.md
@@ -13,6 +13,7 @@
## Bug Fixes and Other Changes
* Fix executor getting None as value when float 0 is passed in. [\#6682](https://github.com/kubeflow/pipelines/pull/6682)
+* Depends on `typin... |
pretix__pretix-558 | Voucher not being counted correctly
In the voucher by tag overview, the number sometimes just don't add up ;-)
So the progressbar is showing nothing, because it's class is set to 200%. Okay, that's kinda e... | [
{
"content": "import csv\nimport io\n\nfrom django.conf import settings\nfrom django.contrib import messages\nfrom django.core.urlresolvers import resolve, reverse\nfrom django.db import transaction\nfrom django.db.models import Count, Q, Sum\nfrom django.http import (\n Http404, HttpResponse, HttpResponseBa... | [
{
"content": "import csv\nimport io\n\nfrom django.conf import settings\nfrom django.contrib import messages\nfrom django.core.urlresolvers import resolve, reverse\nfrom django.db import transaction\nfrom django.db.models import Count, Q, Sum\nfrom django.http import (\n Http404, HttpResponse, HttpResponseBa... | diff --git a/src/pretix/control/views/vouchers.py b/src/pretix/control/views/vouchers.py
index 511e5301ae4..45d567f3e3b 100644
--- a/src/pretix/control/views/vouchers.py
+++ b/src/pretix/control/views/vouchers.py
@@ -101,7 +101,7 @@ def get_context_data(self, **kwargs):
ctx = super().get_context_data(**kwargs)... |
ESMCI__cime-1462 | test for -- options does not handle -- in quotes
example CLM_OPTIONS="-dothis -dothat" causes problems (replace this with a better example)
| [
{
"content": "\"\"\"\nCommon functions used by cime python scripts\nWarning: you cannot use CIME Classes in this module as it causes circular dependencies\n\"\"\"\nimport logging, gzip, sys, os, time, re, shutil, glob, string, random\nimport stat as statlib\nimport warnings\n# Return this error code if the scri... | [
{
"content": "\"\"\"\nCommon functions used by cime python scripts\nWarning: you cannot use CIME Classes in this module as it causes circular dependencies\n\"\"\"\nimport logging, gzip, sys, os, time, re, shutil, glob, string, random\nimport stat as statlib\nimport warnings\n# Return this error code if the scri... | diff --git a/scripts/lib/CIME/utils.py b/scripts/lib/CIME/utils.py
index 6d79bce0543..c6a74877adb 100644
--- a/scripts/lib/CIME/utils.py
+++ b/scripts/lib/CIME/utils.py
@@ -1238,7 +1238,8 @@ def run_and_log_case_status(func, phase, caseroot='.'):
def _check_for_invalid_args(args):
for arg in args:
- if a... |
sktime__sktime-3208 | [BUG] Error in `inverse-variance` method of `AutoEnsembleForecaster`
**Describe the bug**
When fitting the `AutoEnsembleForecaster` forecaster with exogenous data using the `inverse-variance` method, an error is raised. This is because `X` is passed to the internal forecasters instead of `X_test` when a prediction is ... | [
{
"content": "#!/usr/bin/env python3 -u\n# -*- coding: utf-8 -*-\n# copyright: sktime developers, BSD-3-Clause License (see LICENSE file).\n\"\"\"Implements ensemble forecasters.\n\nCreates univariate (optionally weighted)\ncombination of the predictions from underlying forecasts.\n\"\"\"\n\n__author__ = [\"mlo... | [
{
"content": "#!/usr/bin/env python3 -u\n# -*- coding: utf-8 -*-\n# copyright: sktime developers, BSD-3-Clause License (see LICENSE file).\n\"\"\"Implements ensemble forecasters.\n\nCreates univariate (optionally weighted)\ncombination of the predictions from underlying forecasts.\n\"\"\"\n\n__author__ = [\"mlo... | diff --git a/.all-contributorsrc b/.all-contributorsrc
index fd30624a60b..8aca5c8e5f4 100644
--- a/.all-contributorsrc
+++ b/.all-contributorsrc
@@ -1739,6 +1739,14 @@
"contributions": [
"code",
]
+ },
+ {
+ "login": "AnH0ang",
+ "name": "An Hoang",
+ "profile": "https://gith... |
scikit-image__scikit-image-5256 | skimage.transform.rescale fails for scale < 0.2
## Description
The function `skimage.transform.rescale` throws an error for for `scale < 0.2`, which is quite unexpected if you're just trying to use the `rescale` function. I get following error messages for these small scale factors:
```
SOME_PATH\skimage\transform... | [
{
"content": "import numpy as np\nfrom numpy.lib import NumpyVersion\nimport scipy\nfrom scipy import ndimage as ndi\n\nfrom ._geometric import (SimilarityTransform, AffineTransform,\n ProjectiveTransform)\nfrom ._warps_cy import _warp_fast\nfrom ..measure import block_reduce\n\nfrom .._... | [
{
"content": "import numpy as np\nfrom numpy.lib import NumpyVersion\nimport scipy\nfrom scipy import ndimage as ndi\n\nfrom ._geometric import (SimilarityTransform, AffineTransform,\n ProjectiveTransform)\nfrom ._warps_cy import _warp_fast\nfrom ..measure import block_reduce\n\nfrom .._... | diff --git a/skimage/transform/_warps.py b/skimage/transform/_warps.py
index 02acefa75ac..a9bac740481 100644
--- a/skimage/transform/_warps.py
+++ b/skimage/transform/_warps.py
@@ -281,7 +281,7 @@ def rescale(image, scale, order=None, mode='reflect', cval=0, clip=True,
if multichannel:
scale = np.... |
pytorch__pytorch-1934 | torch.is_tensor(torch.HalfTensor()) returns False.
The problem is [here](https://github.com/pytorch/pytorch/blob/master/torch/__init__.py#L274).
| [
{
"content": "\"\"\"\nThe torch package contains data structures for multi-dimensional\ntensors and mathematical operations over these are defined.\nAdditionally, it provides many utilities for efficient serializing of\nTensors and arbitrary types, and other useful utilities.\n\nIt has a CUDA counterpart, that ... | [
{
"content": "\"\"\"\nThe torch package contains data structures for multi-dimensional\ntensors and mathematical operations over these are defined.\nAdditionally, it provides many utilities for efficient serializing of\nTensors and arbitrary types, and other useful utilities.\n\nIt has a CUDA counterpart, that ... | diff --git a/test/test_torch.py b/test/test_torch.py
index 25a9fdf2c68a0d..0bda5c7bfeb5aa 100644
--- a/test/test_torch.py
+++ b/test/test_torch.py
@@ -3590,12 +3590,12 @@ def test_half_tensor(self):
torch.save(xh, f)
f.seek(0)
xh2 = torch.load(f)
- self.assertEqual(xh, ... |
Lightning-Universe__lightning-flash-97 | FilePathDataset does not apply transform to image.
## 🐛 Bug
<!-- A clear and concise description of what the bug is. -->
### To Reproduce
Steps to reproduce the behavior:
1. Go to '...'
2. Run '....'
3. Scroll down to '....'
4. See error
<!-- If you have a code sample, error messages, stack traces, p... | [
{
"content": "# Copyright The PyTorch Lightning team.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required ... | [
{
"content": "# Copyright The PyTorch Lightning team.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required ... | diff --git a/flash/vision/classification/data.py b/flash/vision/classification/data.py
index 4080909c14..d5bde69ef1 100644
--- a/flash/vision/classification/data.py
+++ b/flash/vision/classification/data.py
@@ -68,6 +68,8 @@ def __len__(self) -> int:
def __getitem__(self, index: int) -> Tuple[Any, Optional[int]]:
... |
ivy-llc__ivy-13695 | poisson
| [
{
"content": "# local\nimport ivy\nfrom ivy.func_wrapper import with_unsupported_dtypes\nfrom ivy.functional.frontends.jax.func_wrapper import (\n to_ivy_arrays_and_back,\n handle_jax_dtype,\n)\n\n\n@to_ivy_arrays_and_back\ndef PRNGKey(seed):\n return ivy.array([0, seed % 4294967295 - (seed // 42949672... | [
{
"content": "# local\nimport ivy\nfrom ivy.func_wrapper import with_unsupported_dtypes\nfrom ivy.functional.frontends.jax.func_wrapper import (\n to_ivy_arrays_and_back,\n handle_jax_dtype,\n)\n\n\n@to_ivy_arrays_and_back\ndef PRNGKey(seed):\n return ivy.array([0, seed % 4294967295 - (seed // 42949672... | diff --git a/ivy/functional/frontends/jax/random.py b/ivy/functional/frontends/jax/random.py
index e3966bb2dd41e..7c8f351682784 100644
--- a/ivy/functional/frontends/jax/random.py
+++ b/ivy/functional/frontends/jax/random.py
@@ -62,3 +62,14 @@ def dirichlet(key, alpha, shape=None, dtype="float32"):
seed = _get_see... |
streamlink__streamlink-4075 | dash plugin: MPDParsingError: root tag did not match the expected tag: MPD
### Checklist
- [X] This is a plugin issue and not a different kind of issue
- [X] [I have read the contribution guidelines](https://github.com/streamlink/streamlink/blob/master/CONTRIBUTING.md#contributing-to-streamlink)
- [X] [I have chec... | [
{
"content": "import json\nimport re\nfrom urllib.parse import parse_qsl\n\nfrom lxml.etree import HTML, XML\n\nfrom streamlink.plugin import PluginError\n\n\ndef _parse(parser, data, name, exception, schema, *args, **kwargs):\n try:\n parsed = parser(data, *args, **kwargs)\n except Exception as er... | [
{
"content": "import json\nimport re\nfrom urllib.parse import parse_qsl\n\nfrom lxml.etree import HTML, XML\n\nfrom streamlink.plugin import PluginError\n\n\ndef _parse(parser, data, name, exception, schema, *args, **kwargs):\n try:\n parsed = parser(data, *args, **kwargs)\n except Exception as er... | diff --git a/src/streamlink/utils/parse.py b/src/streamlink/utils/parse.py
index 8165a2c3a00..2a4de948ef3 100644
--- a/src/streamlink/utils/parse.py
+++ b/src/streamlink/utils/parse.py
@@ -76,7 +76,7 @@ def parse_xml(
if isinstance(data, str):
data = bytes(data, "utf8")
if ignore_ns:
- data = ... |
mitmproxy__mitmproxy-2781 | Traceback appears in Status Bar, when trying to replay live flow
##### Steps to reproduce the problem:
1. Run **pathod** : `pathod -a "/=200:p0,10"`
2. Run mitmproxy.
3. Send _get request_ to pathod through mitmproxy using **pathoc**:
`pathoc -c localhost:9999 localhost:8080 'get:/'`
4. Try to replay the corres... | [
{
"content": "from mitmproxy import exceptions\nfrom mitmproxy import ctx\nfrom mitmproxy import io\nfrom mitmproxy import flow\nfrom mitmproxy import command\nimport mitmproxy.types\n\nimport typing\n\n\nclass ClientPlayback:\n def __init__(self):\n self.flows = [] # type: typing.List[flow.Flow]\n ... | [
{
"content": "from mitmproxy import exceptions\nfrom mitmproxy import ctx\nfrom mitmproxy import io\nfrom mitmproxy import flow\nfrom mitmproxy import command\nimport mitmproxy.types\n\nimport typing\n\n\nclass ClientPlayback:\n def __init__(self):\n self.flows = [] # type: typing.List[flow.Flow]\n ... | diff --git a/mitmproxy/addons/clientplayback.py b/mitmproxy/addons/clientplayback.py
index 3fd96669b4..2dd488b9ea 100644
--- a/mitmproxy/addons/clientplayback.py
+++ b/mitmproxy/addons/clientplayback.py
@@ -35,6 +35,9 @@ def start_replay(self, flows: typing.Sequence[flow.Flow]) -> None:
"""
Replay... |
strawberry-graphql__strawberry-2581 | Missing type annotation in `strawberry.fastapi.BaseContext` causes mypy to trip
## Describe the Bug
I built a custom context based on [the guide in the docs](https://strawberry.rocks/docs/guides/authentication):
```python
from strawberry.fastapi import BaseContext
class CustomContext(BaseContext):
@prope... | [
{
"content": "from typing import Any, Dict, Optional, Union\n\nfrom starlette.background import BackgroundTasks\nfrom starlette.requests import Request\nfrom starlette.responses import Response\nfrom starlette.websockets import WebSocket\n\nCustomContext = Union[\"BaseContext\", Dict[str, Any]]\nMergedContext =... | [
{
"content": "from typing import Any, Dict, Optional, Union\n\nfrom starlette.background import BackgroundTasks\nfrom starlette.requests import Request\nfrom starlette.responses import Response\nfrom starlette.websockets import WebSocket\n\nCustomContext = Union[\"BaseContext\", Dict[str, Any]]\nMergedContext =... | diff --git a/RELEASE.md b/RELEASE.md
new file mode 100644
index 0000000000..cfd7f1d88f
--- /dev/null
+++ b/RELEASE.md
@@ -0,0 +1,4 @@
+Release type: patch
+
+Add a type annotation to `strawberry.fastapi.BaseContext`'s `__init__` method so that
+it can be used without `mypy` raising an error.
diff --git a/strawberry/fas... |
yt-project__yt-4776 | BUG: modifications through matplotlib engine cannot be properly displayed
<!--To help us understand and resolve your issue, please fill out the form to
the best of your ability.-->
<!--You can feel free to delete the sections that do not apply.-->
### Bug report
**Bug summary**
The Modifications through Matp... | [
{
"content": "import numpy as np\n\nimport yt\n\n# Load the dataset.\nds = yt.load(\"GasSloshing/sloshing_nomag2_hdf5_plt_cnt_0150\")\n\n# Create a slice object\nslc = yt.SlicePlot(ds, \"x\", (\"gas\", \"density\"), width=(800.0, \"kpc\"))\n\n# Get a reference to the matplotlib axes object for the plot\nax = sl... | [
{
"content": "import numpy as np\n\nimport yt\n\n# Load the dataset.\nds = yt.load(\"GasSloshing/sloshing_nomag2_hdf5_plt_cnt_0150\")\n\n# Create a slice object\nslc = yt.SlicePlot(ds, \"x\", (\"gas\", \"density\"), width=(800.0, \"kpc\"))\n\n# Rendering should be performed explicitly *before* any modification ... | diff --git a/doc/source/cookbook/simple_slice_matplotlib_example.py b/doc/source/cookbook/simple_slice_matplotlib_example.py
index 24594dd024d..6db55cbb66c 100644
--- a/doc/source/cookbook/simple_slice_matplotlib_example.py
+++ b/doc/source/cookbook/simple_slice_matplotlib_example.py
@@ -8,6 +8,10 @@
# Create a slice ... |
celery__celery-5737 | disable_sync_subtasks setting not being respected while using ResultSet
<!--
Please fill this template entirely and do not erase parts of it.
We reserve the right to close without a response
bug reports which are incomplete.
-->
# Checklist
<!--
To check an item on the list replace [ ] with [x].
-->
- [x] I ... | [
{
"content": "# -*- coding: utf-8 -*-\n\"\"\"Task results/state and results for groups of tasks.\"\"\"\nfrom __future__ import absolute_import, unicode_literals\n\nimport time\nimport datetime\nfrom collections import OrderedDict, deque\nfrom contextlib import contextmanager\nfrom copy import copy\n\nfrom kombu... | [
{
"content": "# -*- coding: utf-8 -*-\n\"\"\"Task results/state and results for groups of tasks.\"\"\"\nfrom __future__ import absolute_import, unicode_literals\n\nimport time\nimport datetime\nfrom collections import OrderedDict, deque\nfrom contextlib import contextmanager\nfrom copy import copy\n\nfrom kombu... | diff --git a/celery/result.py b/celery/result.py
index e76225bd156..717438bae18 100644
--- a/celery/result.py
+++ b/celery/result.py
@@ -769,6 +769,7 @@ def join(self, timeout=None, propagate=True, interval=0.5,
value = result.get(
timeout=remaining, propagate=propagate,
i... |
obspy__obspy-1783 | Change nlloc signature format
### What does this PR do?
fix the problem to read the "signature" in nlloc phase-hyp file line. It allows to recognize between old version (<6) and new nlloc version
### Why was it initiated? Any relevant Issues?
### PR Checklist
- [x] This PR is not directly related to an exis... | [
{
"content": "#!/usr/bin/env python\n# -*- coding: utf-8 -*-\n\"\"\"\nNonLinLoc file format support for ObsPy\n\n:copyright:\n The ObsPy Development Team (devs@obspy.org)\n:license:\n GNU Lesser General Public License, Version 3\n (https://www.gnu.org/copyleft/lesser.html)\n\"\"\"\nfrom __future__ impo... | [
{
"content": "#!/usr/bin/env python\n# -*- coding: utf-8 -*-\n\"\"\"\nNonLinLoc file format support for ObsPy\n\n:copyright:\n The ObsPy Development Team (devs@obspy.org)\n:license:\n GNU Lesser General Public License, Version 3\n (https://www.gnu.org/copyleft/lesser.html)\n\"\"\"\nfrom __future__ impo... | diff --git a/CHANGELOG.txt b/CHANGELOG.txt
index bebaabdee34..703d11f9733 100644
--- a/CHANGELOG.txt
+++ b/CHANGELOG.txt
@@ -78,6 +78,8 @@ master: (doi: 10.5281/zenodo.165135)
* Read support for GSE2.0 bulletin (see #1528)
- obspy.io.nlloc:
* Also parse author information and COMMENT line (see #1484)
+ *... |
feast-dev__feast-3717 | Saved Datasets breaks CLI registry-dump
## Expected Behavior
After creating a saved dataset, the CLI command `feast registry-dump` should dump the contents of the registry to the terminal.
## Current Behavior
After creating a saved dataset, the CLI command `feast registry-dump` breaks, with the following error... | [
{
"content": "import uuid\nfrom typing import List, Optional\n\nfrom feast import usage\nfrom feast.data_source import DataSource\nfrom feast.entity import Entity\nfrom feast.errors import (\n DataSourceObjectNotFoundException,\n EntityNotFoundException,\n FeatureServiceNotFoundException,\n FeatureV... | [
{
"content": "import uuid\nfrom typing import List, Optional\n\nfrom feast import usage\nfrom feast.data_source import DataSource\nfrom feast.entity import Entity\nfrom feast.errors import (\n DataSourceObjectNotFoundException,\n EntityNotFoundException,\n FeatureServiceNotFoundException,\n FeatureV... | diff --git a/sdk/python/feast/infra/registry/proto_registry_utils.py b/sdk/python/feast/infra/registry/proto_registry_utils.py
index 2a275703dbb..c7eeea0f822 100644
--- a/sdk/python/feast/infra/registry/proto_registry_utils.py
+++ b/sdk/python/feast/infra/registry/proto_registry_utils.py
@@ -214,7 +214,7 @@ def list_sa... |
internetarchive__openlibrary-4305 | Account Creation: 1st login OL redirects you to IA (referer)
<!-- What problem are we solving? What does the experience look like today? What are the symptoms? -->
### Evidence / Screenshot (if possible)
### Relevant url?
<!-- `https://openlibrary.org/...` -->
### Steps to Reproduce
<!-- What steps caused yo... | [
{
"content": "import json\n\nimport web\nimport logging\nimport simplejson\nimport re\n\nfrom infogami.utils import delegate\nfrom infogami import config\nfrom infogami.utils.view import (\n require_login, render, render_template, add_flash_message\n)\n\nfrom infogami.infobase.client import ClientException\n... | [
{
"content": "import json\n\nimport web\nimport logging\nimport simplejson\nimport re\n\nfrom infogami.utils import delegate\nfrom infogami import config\nfrom infogami.utils.view import (\n require_login, render, render_template, add_flash_message\n)\n\nfrom infogami.infobase.client import ClientException\n... | diff --git a/openlibrary/plugins/upstream/account.py b/openlibrary/plugins/upstream/account.py
index d9adf4e67b7..69e5f21dfc1 100644
--- a/openlibrary/plugins/upstream/account.py
+++ b/openlibrary/plugins/upstream/account.py
@@ -307,7 +307,7 @@ def render_error(self, error_key, i):
def GET(self):
referer ... |
lutris__lutris-1538 | Do not show message about missing gamemode in terminal output
This may confuse users and make them believe it's some kind of essential library.
```
2019-01-08 05:39:36,869: i386 libgamemodeauto.so missing (needed by gamemode)
2019-01-08 05:39:36,869: x86_64 libgamemodeauto.so missing (needed by gamemode)
```
| [
{
"content": "\"\"\"System utilities\"\"\"\n# pylint: disable=inconsistent-return-statements\nimport platform\nimport resource\nimport hashlib\nimport signal\nimport os\nimport re\nimport shutil\nimport string\nimport subprocess\nimport sys\nimport traceback\nfrom collections import defaultdict\n\nfrom lutris.u... | [
{
"content": "\"\"\"System utilities\"\"\"\n# pylint: disable=inconsistent-return-statements\nimport platform\nimport resource\nimport hashlib\nimport signal\nimport os\nimport re\nimport shutil\nimport string\nimport subprocess\nimport sys\nimport traceback\nfrom collections import defaultdict\n\nfrom lutris.u... | diff --git a/lutris/util/system.py b/lutris/util/system.py
index dfbbdbdf21..3a396375e1 100644
--- a/lutris/util/system.py
+++ b/lutris/util/system.py
@@ -170,7 +170,7 @@ def critical_requirements(self):
def get_requirements(self, include_optional=True):
"""Return used system requirements"""
- _r... |
django-import-export__django-import-export-1790 | Remove support for django3.2
Django 3.2 reaches EOL on [30 April 2024](https://endoflife.date/django).
- Remove from project definition
- Remove test code which refers to code pre 4.2
| [
{
"content": "import logging\nimport warnings\n\nimport django\nfrom django.conf import settings\nfrom django.contrib import admin, messages\nfrom django.contrib.admin.models import ADDITION, CHANGE, DELETION, LogEntry\nfrom django.contrib.auth import get_permission_codename\nfrom django.contrib.contenttypes.mo... | [
{
"content": "import logging\nimport warnings\n\nimport django\nfrom django.conf import settings\nfrom django.contrib import admin, messages\nfrom django.contrib.admin.models import ADDITION, CHANGE, DELETION, LogEntry\nfrom django.contrib.auth import get_permission_codename\nfrom django.contrib.contenttypes.mo... | diff --git a/.github/workflows/pre-commit.yml b/.github/workflows/pre-commit.yml
index d8f34ed5d..2d5c2dab6 100644
--- a/.github/workflows/pre-commit.yml
+++ b/.github/workflows/pre-commit.yml
@@ -8,8 +8,8 @@ jobs:
main:
runs-on: ubuntu-latest
steps:
- - uses: actions/checkout@v3
- - uses: actions/se... |
pytorch__pytorch-1087 | ProgressMonitor (Trainer plugin) prints incorrect progress value and percentage
Code to replicate behaviour, extract of [jupyter notebook](https://github.com/recastrodiaz/courses/blob/master/deeplearning1/nbs/lesson1-pytorch.ipynb) In [9]:
```PYTHON
t = trainer.Trainer(model, criterion, optimizer, train_loader)
t.... | [
{
"content": "from .plugin import Plugin\n\n\nclass ProgressMonitor(Plugin):\n stat_name = 'progress'\n\n def __init__(self):\n super(ProgressMonitor, self).__init__([(1, 'iteration'), (1, 'epoch')])\n\n def register(self, trainer):\n self.trainer = trainer\n stats = self.trainer.s... | [
{
"content": "from .plugin import Plugin\n\n\nclass ProgressMonitor(Plugin):\n stat_name = 'progress'\n\n def __init__(self):\n super(ProgressMonitor, self).__init__([(1, 'iteration'), (1, 'epoch')])\n\n def register(self, trainer):\n self.trainer = trainer\n stats = self.trainer.s... | diff --git a/torch/utils/trainer/plugins/progress.py b/torch/utils/trainer/plugins/progress.py
index 06a3c3f92d4fd1..5b0dc2e03c12b8 100644
--- a/torch/utils/trainer/plugins/progress.py
+++ b/torch/utils/trainer/plugins/progress.py
@@ -19,7 +19,7 @@ def register(self, trainer):
def iteration(self, iteration, inpu... |
lutris__lutris-2653 | Impossible login to GOG.com: invalid cookie ?
**Describe the bug**
I can't connect Lutris with my GOG.com account: the GOG.com credentials window is here, I can fill it, but when I confirm this form, the window closes and… nothing more. My account isn't connected, and if I close the "Import games" window, I can't re... | [
{
"content": "import time\nfrom http.cookiejar import MozillaCookieJar, Cookie, _warn_unhandled_exception\n\n\nclass WebkitCookieJar(MozillaCookieJar):\n \"\"\"Subclass of MozillaCookieJar for compatibility with cookies\n coming from Webkit2.\n This disables the magic_re header which is not present and... | [
{
"content": "import time\nfrom http.cookiejar import MozillaCookieJar, Cookie, _warn_unhandled_exception\n\n\nclass WebkitCookieJar(MozillaCookieJar):\n \"\"\"Subclass of MozillaCookieJar for compatibility with cookies\n coming from Webkit2.\n This disables the magic_re header which is not present and... | diff --git a/lutris/util/cookies.py b/lutris/util/cookies.py
index f7f58eebab..e473a76a52 100644
--- a/lutris/util/cookies.py
+++ b/lutris/util/cookies.py
@@ -28,7 +28,7 @@ def _really_load(self, f, filename, ignore_discard, ignore_expires):
elif sline.startswith("#") or sline == "":
... |
oppia__oppia-7075 | Add the practice session experience to the topic viewer
Add an option in the topic viewer page that can start the practice session, based on the skills that are part of the topic.
Add the practice session experience to the topic viewer
Add an option in the topic viewer page that can start the practice session, based on... | [
{
"content": "# Copyright 2018 The Oppia Authors. All Rights Reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n... | [
{
"content": "# Copyright 2018 The Oppia Authors. All Rights Reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n... | diff --git a/core/controllers/topic_viewer.py b/core/controllers/topic_viewer.py
index a78d4341caad5..d1336a3b064b9 100644
--- a/core/controllers/topic_viewer.py
+++ b/core/controllers/topic_viewer.py
@@ -73,6 +73,7 @@ def get(self, topic_name):
self.values.update({
'topic_name': topic.name,
+ ... |
sql-machine-learning__elasticdl-1067 | Fix lookup_embedding call in embedding layer
elasticdl.layers.Embedding.lookup_embedding still uses old worker.lookup_embedding method.
We need to update it to the revised version.
| [
{
"content": "import tensorflow as tf\nfrom tensorflow.python.keras.utils import tf_utils\n\n\nclass Embedding(tf.keras.layers.Layer):\n \"\"\"\n Input: indexes for the embedding entries with a shape of\n (batch_size, input_length). Input can be either dense tensor\n or SparseTensor.\n Output... | [
{
"content": "import tensorflow as tf\nfrom tensorflow.python.keras.utils import tf_utils\n\n\nclass Embedding(tf.keras.layers.Layer):\n \"\"\"\n Input: indexes for the embedding entries with a shape of\n (batch_size, input_length). Input can be either dense tensor\n or SparseTensor.\n Output... | diff --git a/elasticdl/python/elasticdl/layers/embedding.py b/elasticdl/python/elasticdl/layers/embedding.py
index 06c6e5ea4..91cf08518 100644
--- a/elasticdl/python/elasticdl/layers/embedding.py
+++ b/elasticdl/python/elasticdl/layers/embedding.py
@@ -87,8 +87,8 @@ def get_key(name_list):
return "-".join(map(... |
Gallopsled__pwntools-1852 | `atexit.register` does not work
### What I did
```python3
from pwn import *
atexit.register(print, "hello world")
exit()
```
### What I expected to see
```python3 test.py
hello world
```
### What I saw
Nothing
I noticed this because `asm()`, which adds an `atexit` handler to remove the `/tmp/pwn-asm-XXXXX... | [
{
"content": "\"\"\"\nReplacement for the Python standard library's atexit.py.\n\nWhereas the standard :mod:`atexit` module only defines :func:`atexit.register`,\nthis replacement module also defines :func:`unregister`.\n\nThis module also fixes a the issue that exceptions raised by an exit handler is\nprinted ... | [
{
"content": "\"\"\"\nReplacement for the Python standard library's atexit.py.\n\nWhereas the standard :mod:`atexit` module only defines :func:`atexit.register`,\nthis replacement module also defines :func:`unregister`.\n\nThis module also fixes a the issue that exceptions raised by an exit handler is\nprinted ... | diff --git a/CHANGELOG.md b/CHANGELOG.md
index 281422a6c..87d367fe9 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -151,6 +151,7 @@ The table below shows which release corresponds to each branch, and what date th
## 4.3.1
+- [#1852][1852] Fix `atexit` on Python 3
- [#1732][1732] Fix shellcraft SSTI vulnerability... |
Project-MONAI__MONAI-7612 | Inaccurate error message in regression.py
**Describe the bug**
On line 306 of monai.metrics.regression, the printed error message states that y_pred should have 4 dimensions when in fact the surrounding if-statement is looking for the case where y_pred should have 5 dimensions. This confused me because I got an erro... | [
{
"content": "# Copyright (c) MONAI Consortium\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n# http://www.apache.org/licenses/LICENSE-2.0\n# Unless required by applicable la... | [
{
"content": "# Copyright (c) MONAI Consortium\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n# http://www.apache.org/licenses/LICENSE-2.0\n# Unless required by applicable la... | diff --git a/monai/metrics/regression.py b/monai/metrics/regression.py
index 9d29654ee3..4c8b8aa71b 100644
--- a/monai/metrics/regression.py
+++ b/monai/metrics/regression.py
@@ -303,7 +303,7 @@ def _compute_metric(self, y_pred: torch.Tensor, y: torch.Tensor) -> torch.Tensor
if self.spatial_dims == 3 and dim... |
googleapis__python-bigquery-51 | BigQuery: TypeError: from_arrays() takes at least 2 positional arguments (1 given)
Hi all, i tried bq client in python with the default example. Since i moved from 1.23.1 to 1.24.0 last week i get the following issue.
Its related to pyarrow but i was not upgrading pyarrow (worked with it before)
#### Environment ... | [
{
"content": "# Copyright 2018 Google LLC\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicabl... | [
{
"content": "# Copyright 2018 Google LLC\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicabl... | diff --git a/setup.py b/setup.py
index 6324c8b25..0e920a04e 100644
--- a/setup.py
+++ b/setup.py
@@ -40,9 +40,7 @@
extras = {
"bqstorage": [
"google-cloud-bigquery-storage >= 0.6.0, <2.0.0dev",
- # Bad Linux release for 0.14.0.
- # https://issues.apache.org/jira/browse/ARROW-5868
- "... |
pypa__pipenv-5920 | If --skip-lock is used that python_version marker is not respected
Be sure to check the existing issues (both open and closed!), and make sure you are running the latest version of Pipenv.
Check the [diagnose documentation](https://pipenv.pypa.io/en/latest/diagnose/) for common issues before posting! We may close yo... | [
{
"content": "import os\nimport queue\nimport sys\nimport warnings\nfrom collections import defaultdict\nfrom tempfile import NamedTemporaryFile\n\nfrom pipenv import environments, exceptions\nfrom pipenv.patched.pip._internal.exceptions import PipError\nfrom pipenv.routines.lock import do_lock\nfrom pipenv.uti... | [
{
"content": "import os\nimport queue\nimport sys\nimport warnings\nfrom collections import defaultdict\nfrom tempfile import NamedTemporaryFile\n\nfrom pipenv import environments, exceptions\nfrom pipenv.patched.pip._internal.exceptions import PipError\nfrom pipenv.routines.lock import do_lock\nfrom pipenv.uti... | diff --git a/news/5920.bugfix.rst b/news/5920.bugfix.rst
new file mode 100644
index 0000000000..c3f1374237
--- /dev/null
+++ b/news/5920.bugfix.rst
@@ -0,0 +1 @@
+Include the Pipfile markers in the install phase when using ``--skip-lock``.
diff --git a/pipenv/routines/install.py b/pipenv/routines/install.py
index 1bb06... |
talonhub__community-861 | formatter accuracy
This has come up a couple of times. I suspect you'll improve formatter accuracy if you make these changes:
"allcaps" -> "all cap"
"alldown" -> "all down"
The reason for this is e.g. "alldown" is not an english word, D sounds like T, so "alld" sounds like alt, and you get "alt down".
Same for ... | [
{
"content": "from talon import Module, Context, actions, ui, imgui, app\nfrom talon.grammar import Phrase\nfrom typing import List, Union\nimport logging\nimport re\n\nctx = Context()\nkey = actions.key\nedit = actions.edit\n\nwords_to_keep_lowercase = \"a an the at by for in is of on to up and as but or nor\"... | [
{
"content": "from talon import Module, Context, actions, ui, imgui, app\nfrom talon.grammar import Phrase\nfrom typing import List, Union\nimport logging\nimport re\n\nctx = Context()\nkey = actions.key\nedit = actions.edit\n\nwords_to_keep_lowercase = \"a an the at by for in is of on to up and as but or nor\"... | diff --git a/code/formatters.py b/code/formatters.py
index 5636e0f3b9..5a01143492 100644
--- a/code/formatters.py
+++ b/code/formatters.py
@@ -124,7 +124,7 @@ def every_word(word_func):
# This is the mapping from spoken phrases to formatters
formatters_words = {
- "all caps": formatters_dict["ALL_CAPS"],
+ "a... |
pytorch__rl-515 | [BUG] importing `dm_control` environments when the library is not installed does not display the right error message
## Describe the bug
We allow users to load the file `envs/libs/dm_control.py` even if `dm-control` is not installes. When creating an object in this situation, the error message now is that the enviro... | [
{
"content": "# Copyright (c) Meta Platforms, Inc. and affiliates.\n#\n# This source code is licensed under the MIT license found in the\n# LICENSE file in the root directory of this source tree.\nfrom __future__ import annotations\n\nimport collections\nimport os\nfrom typing import Optional, Tuple, Union, Dic... | [
{
"content": "# Copyright (c) Meta Platforms, Inc. and affiliates.\n#\n# This source code is licensed under the MIT license found in the\n# LICENSE file in the root directory of this source tree.\nfrom __future__ import annotations\n\nimport collections\nimport os\nfrom typing import Optional, Tuple, Union, Dic... | diff --git a/torchrl/envs/libs/dm_control.py b/torchrl/envs/libs/dm_control.py
index c2494ce7160..6267b8880e2 100644
--- a/torchrl/envs/libs/dm_control.py
+++ b/torchrl/envs/libs/dm_control.py
@@ -272,6 +272,11 @@ class DMControlEnv(DMControlWrapper):
"""
def __init__(self, env_name, task_name, **kwargs):
+... |
Lightning-Universe__lightning-flash-104 | Download Data Fails if Content Length Not Defined in Header
## 🐛 Bug
When I try to download a zip file using download_data from flash.core.data it fails because the response header does not contain a value for 'Content Length' this should be check for and handled in the code.
### To Reproduce
Steps to reprod... | [
{
"content": "# Copyright The PyTorch Lightning team.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required ... | [
{
"content": "# Copyright The PyTorch Lightning team.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required ... | diff --git a/flash/core/data/utils.py b/flash/core/data/utils.py
index 320ff86499..a497b5f7b4 100644
--- a/flash/core/data/utils.py
+++ b/flash/core/data/utils.py
@@ -35,7 +35,7 @@ def download_file(url: str, path: str, verbose: bool = False) -> None:
os.makedirs(path)
local_filename = os.path.join(path, ... |
jupyterhub__jupyterhub-3715 | Empty Admin page when base_url is set
### Bug description
<!-- Use this section to clearly and concisely describe the bug. -->
If `JupyterHub.base_url` is set in `jupyterhub_config.py`, visitig the Admin tab on jupyterhub v.2.0.0 shows the empty page.
#### Expected behaviour
<!-- Tell us what you thought would... | [
{
"content": "\"\"\"Basic html-rendering handlers.\"\"\"\n# Copyright (c) Jupyter Development Team.\n# Distributed under the terms of the Modified BSD License.\nimport asyncio\nimport time\nfrom collections import defaultdict\nfrom datetime import datetime\nfrom http.client import responses\n\nfrom jinja2 impor... | [
{
"content": "\"\"\"Basic html-rendering handlers.\"\"\"\n# Copyright (c) Jupyter Development Team.\n# Distributed under the terms of the Modified BSD License.\nimport asyncio\nimport time\nfrom collections import defaultdict\nfrom datetime import datetime\nfrom http.client import responses\n\nfrom jinja2 impor... | diff --git a/jsx/src/components/GroupEdit/GroupEdit.jsx b/jsx/src/components/GroupEdit/GroupEdit.jsx
index 605cb7c653..f1ad550994 100644
--- a/jsx/src/components/GroupEdit/GroupEdit.jsx
+++ b/jsx/src/components/GroupEdit/GroupEdit.jsx
@@ -110,13 +110,21 @@ const GroupEdit = (props) => {
Promise.all(pro... |
wagtail__wagtail-4648 | PageTypeField API serializer should gracefully handle missing page models
### Issue Summary
If a page model is deleted while pages of that type still exist, any API calls for page listings that include that page type will fail with `AttributeError: 'NoneType' object has no attribute '_meta'`. This results in a serve... | [
{
"content": "from collections import OrderedDict\n\nfrom django.urls.exceptions import NoReverseMatch\nfrom modelcluster.models import get_all_child_relations\nfrom rest_framework import relations, serializers\nfrom rest_framework.fields import Field, SkipField\nfrom taggit.managers import _TaggableManager\n\n... | [
{
"content": "from collections import OrderedDict\n\nfrom django.urls.exceptions import NoReverseMatch\nfrom modelcluster.models import get_all_child_relations\nfrom rest_framework import relations, serializers\nfrom rest_framework.fields import Field, SkipField\nfrom taggit.managers import _TaggableManager\n\n... | diff --git a/wagtail/api/v2/serializers.py b/wagtail/api/v2/serializers.py
index 08425e61b6e8..e966dd82eecd 100644
--- a/wagtail/api/v2/serializers.py
+++ b/wagtail/api/v2/serializers.py
@@ -79,6 +79,8 @@ def get_attribute(self, instance):
return instance
def to_representation(self, page):
+ if p... |
nf-core__tools-1333 | Space missing in tip message for --fix files_unchanged
<!--
# nf-core/tools bug report
Hi there!
Thanks for telling us about a problem with the nf-core/tools package.
Please delete this text and anything that's not relevant from the template below:
-->
## Description of the bug
a space is missing before ... | [
{
"content": "import rich\nfrom rich.console import Console\nfrom rich.table import Table\nimport logging\n\nimport nf_core.utils\n\nlog = logging.getLogger(__name__)\n\n# Create a console used by all lint tests\nconsole = Console(force_terminal=nf_core.utils.rich_force_colors())\n\n\ndef print_joint_summary(li... | [
{
"content": "import rich\nfrom rich.console import Console\nfrom rich.table import Table\nimport logging\n\nimport nf_core.utils\n\nlog = logging.getLogger(__name__)\n\n# Create a console used by all lint tests\nconsole = Console(force_terminal=nf_core.utils.rich_force_colors())\n\n\ndef print_joint_summary(li... | diff --git a/README.md b/README.md
index e440979bde..be4ff5afd0 100644
--- a/README.md
+++ b/README.md
@@ -194,7 +194,7 @@ $ nf-core list
| \| | \__, \__/ | \ |___ \`-._,-`-,
`._,._,'
- nf-core/tools version 2.0
+ nf-core/tools version 2.2
┏━━━━━━━━━... |
django-wiki__django-wiki-565 | Possible memory leak in markdown extensions
When looking at an error log from our project using django-wiki, we noticed a kind of _possibly longer than necessary_ value of django setting WIKI_MARKDOWN_KWARGS..
It seems that each of the extension is appended to the 'extensions' array multiple times and I think that it... | [
{
"content": "from __future__ import absolute_import, unicode_literals\n\nfrom wiki.conf import settings\nfrom wiki.core.markdown.mdx.previewlinks import PreviewLinksExtension\nfrom wiki.core.markdown.mdx.responsivetable import ResponsiveTableExtension\nfrom wiki.core.plugins import registry as plugin_registry\... | [
{
"content": "from __future__ import absolute_import, unicode_literals\n\nfrom wiki.conf import settings\nfrom wiki.core.markdown.mdx.previewlinks import PreviewLinksExtension\nfrom wiki.core.markdown.mdx.responsivetable import ResponsiveTableExtension\nfrom wiki.core.plugins import registry as plugin_registry\... | diff --git a/tox.ini b/tox.ini
index 43490cf54..4d9556abe 100644
--- a/tox.ini
+++ b/tox.ini
@@ -12,7 +12,8 @@ deps =
pytest
Pillow==2.3.0
django-classy-tags==0.4
- six==1.6.1
+ six>=1.9
+ mock>=2.0
django_nyt==0.9.8
django15: Django==1.5.12
django16: Django==1.6.11
diff ... |
cowrie__cowrie-1421 | $UID not spitting out UID
**Describe the bug**
A hacker found a way to get inside the cowrie box and executed "echo $UID". The reply that came back was empty, and the hacker disconnected. My normal box returned the UID.
**To Reproduce**
Steps to reproduce the behavior:
1. Connect to linux machine
2. Type in "Ech... | [
{
"content": "# Copyright (c) 2009-2014 Upi Tamminen <desaster@gmail.com>\n# See the COPYRIGHT file for more information\n\nfrom __future__ import absolute_import, division\n\nfrom twisted.conch.interfaces import ISession\nfrom twisted.conch.ssh import session\nfrom twisted.python import log\n\nfrom zope.interf... | [
{
"content": "# Copyright (c) 2009-2014 Upi Tamminen <desaster@gmail.com>\n# See the COPYRIGHT file for more information\n\nfrom __future__ import absolute_import, division\n\nfrom twisted.conch.interfaces import ISession\nfrom twisted.conch.ssh import session\nfrom twisted.python import log\n\nfrom zope.interf... | diff --git a/src/cowrie/shell/session.py b/src/cowrie/shell/session.py
index d9ae12e0df..666323c490 100644
--- a/src/cowrie/shell/session.py
+++ b/src/cowrie/shell/session.py
@@ -36,7 +36,7 @@ def __init__(self, avatar, reactor=None):
'USER': self.username,
'HOME': self.avatar.home,
... |
mozmeao__snippets-service-1161 | Make Job Ids searchable in snippet admin
For Snippets, we can search using snippet ids. It doesn't work when in jobs.
| [
{
"content": "import copy\nimport re\n\nfrom django.contrib import admin, messages\nfrom django.db.models import TextField, Q\nfrom django.http import HttpResponseRedirect\nfrom django.template.loader import get_template\nfrom django.urls import reverse\nfrom django.utils.safestring import mark_safe\n\nfrom dja... | [
{
"content": "import copy\nimport re\n\nfrom django.contrib import admin, messages\nfrom django.db.models import TextField, Q\nfrom django.http import HttpResponseRedirect\nfrom django.template.loader import get_template\nfrom django.urls import reverse\nfrom django.utils.safestring import mark_safe\n\nfrom dja... | diff --git a/snippets/base/admin/adminmodels.py b/snippets/base/admin/adminmodels.py
index 1b7071746..8c3121092 100644
--- a/snippets/base/admin/adminmodels.py
+++ b/snippets/base/admin/adminmodels.py
@@ -975,10 +975,11 @@ class JobAdmin(admin.ModelAdmin):
('targets', RelatedOnlyDropdownFilter),
('sni... |
typeddjango__django-stubs-1239 | mypy 0.990 breaks mypy_django_plugin
mypy 0.990 was released today. When I have mypy 0.990 and `mypy_django_plugin` enabled, it fails with `AssertionError` on code that uses the `django_cas_ng` package.
The problematic code appears to be:
```python
from django.conf import settings as django_settings
# ...
def ge... | [
{
"content": "from mypy.nodes import MemberExpr\nfrom mypy.plugin import AttributeContext, FunctionContext\nfrom mypy.types import AnyType, Instance\nfrom mypy.types import Type as MypyType\nfrom mypy.types import TypeOfAny, TypeType\n\nfrom mypy_django_plugin.django.context import DjangoContext\nfrom mypy_djan... | [
{
"content": "from mypy.nodes import MemberExpr\nfrom mypy.plugin import AttributeContext, FunctionContext\nfrom mypy.types import AnyType, Instance\nfrom mypy.types import Type as MypyType\nfrom mypy.types import TypeOfAny, TypeType\n\nfrom mypy_django_plugin.django.context import DjangoContext\nfrom mypy_djan... | diff --git a/mypy_django_plugin/transformers/settings.py b/mypy_django_plugin/transformers/settings.py
index e86a3e97d..b598450a9 100644
--- a/mypy_django_plugin/transformers/settings.py
+++ b/mypy_django_plugin/transformers/settings.py
@@ -21,7 +21,9 @@ def get_user_model_hook(ctx: FunctionContext, django_context: Dja... |
ipython__ipython-11087 | Error in IPython 5.6: MPLBACKEND=PS and importing matplotlib.pyplot
There's seems to be a problem if `MPLBACKEND=PS` and if an IPython script imports `matplotlib.pyplot` (`import matplotlib` is still fine). This arises starting with IPython 5.6 (5.5 is fine), so my best guess is that it was caused by #10868 -- at least... | [
{
"content": "# -*- coding: utf-8 -*-\n\"\"\"Pylab (matplotlib) support utilities.\"\"\"\n\n# Copyright (c) IPython Development Team.\n# Distributed under the terms of the Modified BSD License.\n\nfrom io import BytesIO\n\nfrom IPython.core.display import _pngxy\nfrom IPython.utils.decorators import flag_calls\... | [
{
"content": "# -*- coding: utf-8 -*-\n\"\"\"Pylab (matplotlib) support utilities.\"\"\"\n\n# Copyright (c) IPython Development Team.\n# Distributed under the terms of the Modified BSD License.\n\nfrom io import BytesIO\n\nfrom IPython.core.display import _pngxy\nfrom IPython.utils.decorators import flag_calls\... | diff --git a/IPython/core/pylabtools.py b/IPython/core/pylabtools.py
index 7f275a92a04..4423ed5d408 100644
--- a/IPython/core/pylabtools.py
+++ b/IPython/core/pylabtools.py
@@ -46,6 +46,9 @@
# And some backends that don't need GUI integration
del backend2gui['nbAgg']
del backend2gui['agg']
+del backend2gui['svg']
+d... |
DataDog__dd-trace-py-384 | Incorrect render patching in pyramid.
https://github.com/DataDog/dd-trace-py/blob/261136e112b23862a78308a2423e15364ae4aaa6/ddtrace/contrib/pyramid/trace.py#L31
Here we're removing request from kwargs but pyramid's render has a request kwarg so we need to keep it.
| [
{
"content": "\n# 3p\nimport logging\nimport pyramid.renderers\nfrom pyramid.settings import asbool\nimport wrapt\n\n# project\nimport ddtrace\nfrom ...ext import http, AppTypes\nfrom .constants import SETTINGS_SERVICE, SETTINGS_TRACE_ENABLED, SETTINGS_TRACER\n\nlog = logging.getLogger(__name__)\n\nDD_TWEEN_NAM... | [
{
"content": "\n# 3p\nimport logging\nimport pyramid.renderers\nfrom pyramid.settings import asbool\nimport wrapt\n\n# project\nimport ddtrace\nfrom ...ext import http, AppTypes\nfrom .constants import SETTINGS_SERVICE, SETTINGS_TRACE_ENABLED, SETTINGS_TRACER\n\nlog = logging.getLogger(__name__)\n\nDD_TWEEN_NAM... | diff --git a/ddtrace/contrib/pyramid/trace.py b/ddtrace/contrib/pyramid/trace.py
index 2d203ab14ce..800f53302ce 100644
--- a/ddtrace/contrib/pyramid/trace.py
+++ b/ddtrace/contrib/pyramid/trace.py
@@ -28,7 +28,7 @@ def includeme(config):
def trace_render(func, instance, args, kwargs):
# If the request is not tr... |
vyperlang__vyper-2821 | Dynamic arrays are not allocated properly in storage, overlap with following variables
### Version Information
* vyper Version (output of `vyper --version`): 0.3.2
* OS: Release Linux Mint 20.3 Una 64-bit
* Python Version (output of `python --version`): Python 3.8.10
### What's your issue about?
Dynamic arra... | [
{
"content": "from typing import Optional, Tuple, Union\n\nfrom vyper import ast as vy_ast\nfrom vyper.abi_types import ABI_DynamicArray, ABI_StaticArray, ABI_Tuple, ABIType\nfrom vyper.exceptions import ArrayIndexException, InvalidType, StructureException\nfrom vyper.semantics import validation\nfrom vyper.sem... | [
{
"content": "from typing import Optional, Tuple, Union\n\nfrom vyper import ast as vy_ast\nfrom vyper.abi_types import ABI_DynamicArray, ABI_StaticArray, ABI_Tuple, ABIType\nfrom vyper.exceptions import ArrayIndexException, InvalidType, StructureException\nfrom vyper.semantics import validation\nfrom vyper.sem... | diff --git a/tests/cli/outputs/test_storage_layout.py b/tests/cli/outputs/test_storage_layout.py
index 7ed2ca7a03..e419d2f470 100644
--- a/tests/cli/outputs/test_storage_layout.py
+++ b/tests/cli/outputs/test_storage_layout.py
@@ -21,6 +21,8 @@ def public_foo2():
def _bar():
pass
+arr: DynArray[uint256, 3]
+
#... |
optuna__optuna-1966 | Metric MAPE direction should be reversed with reference to MAP
https://github.com/optuna/optuna/blob/9fc26c2277b347788d5554dad66dba81585716b2/optuna/integration/_lightgbm_tuner/optimize.py#L146
| [
{
"content": "import abc\nimport copy\nimport json\nimport os\nimport pickle\nimport time\nfrom typing import Any\nfrom typing import Callable\nfrom typing import Dict\nfrom typing import Generator\nfrom typing import Iterator\nfrom typing import List\nfrom typing import Optional\nfrom typing import Tuple\nfrom... | [
{
"content": "import abc\nimport copy\nimport json\nimport os\nimport pickle\nimport time\nfrom typing import Any\nfrom typing import Callable\nfrom typing import Dict\nfrom typing import Generator\nfrom typing import Iterator\nfrom typing import List\nfrom typing import Optional\nfrom typing import Tuple\nfrom... | diff --git a/optuna/integration/_lightgbm_tuner/optimize.py b/optuna/integration/_lightgbm_tuner/optimize.py
index 565a3ee25d..a28b77d631 100644
--- a/optuna/integration/_lightgbm_tuner/optimize.py
+++ b/optuna/integration/_lightgbm_tuner/optimize.py
@@ -144,7 +144,7 @@ def _metric_with_eval_at(self, metric: str) -> st... |
pyqtgraph__pyqtgraph-1048 | Line Labels not visible for small graph values
Hey Everyone,
I found a bug where InfLinLables attached to InfiniteLines are not properly shown, if the total y-range of the graph is too small. Simple example below.
If the label position is big enough (e.g. 0.5) the label sometimes comes into view. But this is not ... | [
{
"content": "from ..Qt import QtGui, QtCore\nfrom ..Point import Point\nfrom .GraphicsObject import GraphicsObject\nfrom .TextItem import TextItem\nfrom .ViewBox import ViewBox\nfrom .. import functions as fn\nimport numpy as np\nimport weakref\n\n\n__all__ = ['InfiniteLine', 'InfLineLabel']\n\n\nclass Infinit... | [
{
"content": "from ..Qt import QtGui, QtCore\nfrom ..Point import Point\nfrom .GraphicsObject import GraphicsObject\nfrom .TextItem import TextItem\nfrom .ViewBox import ViewBox\nfrom .. import functions as fn\nimport numpy as np\nimport weakref\n\n\n__all__ = ['InfiniteLine', 'InfLineLabel']\n\n\nclass Infinit... | diff --git a/pyqtgraph/graphicsItems/InfiniteLine.py b/pyqtgraph/graphicsItems/InfiniteLine.py
index 7aeb1620b2..3650502605 100644
--- a/pyqtgraph/graphicsItems/InfiniteLine.py
+++ b/pyqtgraph/graphicsItems/InfiniteLine.py
@@ -314,8 +314,8 @@ def _computeBoundingRect(self):
length = br.width()
left = ... |
PrefectHQ__prefect-1165 | Cannot raise a skip signal with a result
I am filing an issue by suggestion of @cicdw after a conversation on gitter.
I came up with the following use case: a task that raises a skip signal with a result because its logic has detected that there is no work to do and the result is already calculated somewhere. I could ... | [
{
"content": "\"\"\"\nThese Exceptions, when raised, are used to signal state changes when tasks or flows are running. Signals\nare used in TaskRunners and FlowRunners as a way of communicating the changes in states.\n\"\"\"\n\nfrom prefect.engine import state\nfrom prefect.utilities.exceptions import PrefectEr... | [
{
"content": "\"\"\"\nThese Exceptions, when raised, are used to signal state changes when tasks or flows are running. Signals\nare used in TaskRunners and FlowRunners as a way of communicating the changes in states.\n\"\"\"\n\nfrom prefect.engine import state\nfrom prefect.utilities.exceptions import PrefectEr... | diff --git a/CHANGELOG.md b/CHANGELOG.md
index 5970e79df841..90eaaf422210 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -26,6 +26,7 @@ These changes are available in the [master branch](https://github.com/PrefectHQ/
- Fix issue with mapped caching in Prefect Cloud - [#1096](https://github.com/PrefectHQ/prefect/pull/... |
pydantic__pydantic-3646 | Color comparison is always false
# Bug
Output of `python -c "import pydantic.utils; print(pydantic.utils.version_info())"`:
```
pydantic version: 1.9.0
pydantic compiled: True
install path: /home/xxxxxxx/xxxxxxx/xxxxxxx/venv310/lib/python3.10/site-packages/pydantic
... | [
{
"content": "\"\"\"\nColor definitions are used as per CSS3 specification:\nhttp://www.w3.org/TR/css3-color/#svg-color\n\nA few colors have multiple names referring to the sames colors, eg. `grey` and `gray` or `aqua` and `cyan`.\n\nIn these cases the LAST color when sorted alphabetically takes preferences,\n... | [
{
"content": "\"\"\"\nColor definitions are used as per CSS3 specification:\nhttp://www.w3.org/TR/css3-color/#svg-color\n\nA few colors have multiple names referring to the sames colors, eg. `grey` and `gray` or `aqua` and `cyan`.\n\nIn these cases the LAST color when sorted alphabetically takes preferences,\n... | diff --git a/changes/3646-aminalaee.md b/changes/3646-aminalaee.md
new file mode 100644
index 00000000000..68c8084075f
--- /dev/null
+++ b/changes/3646-aminalaee.md
@@ -0,0 +1 @@
+Add comparison method for `Color` class.
diff --git a/pydantic/color.py b/pydantic/color.py
index 269aff52712..6ea2c53f802 100644
--- a/pyda... |
elastic__apm-agent-python-1783 | [META 739] Add "s3/"-prefix to S3 destination.service.resource
See meta issue for the description and details:
- Meta issue: https://github.com/elastic/apm/issues/739
[META 739] Add "s3/"-prefix to S3 destination.service.resource
See meta issue for the description and details:
- Meta issue: https://github.com/elast... | [
{
"content": "# BSD 3-Clause License\n#\n# Copyright (c) 2019, Elasticsearch BV\n# All rights reserved.\n#\n# Redistribution and use in source and binary forms, with or without\n# modification, are permitted provided that the following conditions are met:\n#\n# * Redistributions of source code must retain... | [
{
"content": "# BSD 3-Clause License\n#\n# Copyright (c) 2019, Elasticsearch BV\n# All rights reserved.\n#\n# Redistribution and use in source and binary forms, with or without\n# modification, are permitted provided that the following conditions are met:\n#\n# * Redistributions of source code must retain... | diff --git a/CHANGELOG.asciidoc b/CHANGELOG.asciidoc
index 0118c4c45..b90dfd30b 100644
--- a/CHANGELOG.asciidoc
+++ b/CHANGELOG.asciidoc
@@ -43,7 +43,14 @@ endif::[]
* Fix spans being dropped if they don't have a name {pull}1770[#1770]
* Fix AWS Lambda support when `event` is not a dict {pull}1775[#1775]
* Fix depre... |
encode__django-rest-framework-5872 | wrong schema generation for UUIDField
## Checklist
- [x] I have verified that that issue exists against the `master` branch of Django REST framework.
- [x] I have searched for similar issues in both open and closed tickets and cannot find a duplicate.
- [x] This is not a usage question. (Those should be directed t... | [
{
"content": "\"\"\"\nThe metadata API is used to allow customization of how `OPTIONS` requests\nare handled. We currently provide a single default implementation that returns\nsome fairly ad-hoc information about the view.\n\nFuture implementations might use JSON schema or other definitions in order\nto return... | [
{
"content": "\"\"\"\nThe metadata API is used to allow customization of how `OPTIONS` requests\nare handled. We currently provide a single default implementation that returns\nsome fairly ad-hoc information about the view.\n\nFuture implementations might use JSON schema or other definitions in order\nto return... | diff --git a/rest_framework/metadata.py b/rest_framework/metadata.py
index 410acd0e2f..994c6cb774 100644
--- a/rest_framework/metadata.py
+++ b/rest_framework/metadata.py
@@ -40,6 +40,7 @@ class SimpleMetadata(BaseMetadata):
serializers.BooleanField: 'boolean',
serializers.NullBooleanField: 'boolean',... |
ESMCI__cime-3948 | Charting a path towards dropping python2 support
This question came up in yesterday's CESM Software Engineering Group meeting (raised by @gold2718 , also relevant to @alperaltuntas ): We have some python code coming into CESM that will assume python3. Some of this code will be invoked by cime scripts (buildnml / buildl... | [
{
"content": "#!/usr/bin/env python\n\n\"\"\"\nSimple script to populate CESM test database with test results.\n\"\"\"\n\nfrom standard_script_setup import *\n\nfrom CIME.XML.env_build import EnvBuild\nfrom CIME.XML.env_case import EnvCase\nfrom CIME.XML.env_test import Env... | [
{
"content": "#!/usr/bin/env python3\n\n\"\"\"\nSimple script to populate CESM test database with test results.\n\"\"\"\n\nfrom standard_script_setup import *\n\nfrom CIME.XML.env_build import EnvBuild\nfrom CIME.XML.env_case import EnvCase\nfrom CIME.XML.env_test import En... | diff --git a/.github/workflows/srt.yml b/.github/workflows/srt.yml
index db5f3a40523..040edf0e2d6 100644
--- a/.github/workflows/srt.yml
+++ b/.github/workflows/srt.yml
@@ -18,14 +18,14 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
- python-version: [2.7, 3.8]
+ python-version: [3.8, ... |
beetbox__beets-3784 | Fetch art is pixelated
### Setup
* OS: Docker image (`linuxserver/docker-beets:nightly`)
* Python version: `3.8.5`
* beets version: `HEAD`
* Turning off plugins made problem go away (yes/no): N/A
### Problem
Seems like `fetchart` is pixelating the images when resizing. Not sure if this is a `Pillow` problem... | [
{
"content": "# -*- coding: utf-8 -*-\n# This file is part of beets.\n# Copyright 2016, Fabrice Laporte\n#\n# Permission is hereby granted, free of charge, to any person obtaining\n# a copy of this software and associated documentation files (the\n# \"Software\"), to deal in the Software without restriction, in... | [
{
"content": "# -*- coding: utf-8 -*-\n# This file is part of beets.\n# Copyright 2016, Fabrice Laporte\n#\n# Permission is hereby granted, free of charge, to any person obtaining\n# a copy of this software and associated documentation files (the\n# \"Software\"), to deal in the Software without restriction, in... | diff --git a/beets/util/artresizer.py b/beets/util/artresizer.py
index 8f14c8baf2..c57918f16b 100644
--- a/beets/util/artresizer.py
+++ b/beets/util/artresizer.py
@@ -77,6 +77,11 @@ def pil_resize(maxwidth, path_in, path_out=None, quality=0):
im = Image.open(util.syspath(path_in))
size = maxwidth, max... |
spack__spack-5239 | Unable to build LLVM on CentOS 7
I'm trying to build LLVM on CentOS 7 with GCC 7.1.0. I'm seeing the following error message:
```
In file included from /blues/gpfs/home/ajstewart/spack/var/spack/stage/llvm-4.0.0-iwr5xsmpa2scpclnuhevp4od7pa3j7mq/llvm-4.0.0.src/tools/lldb/source/Utility/TaskPool.cpp:10:0:
/blues/gpfs/... | [
{
"content": "##############################################################################\n# Copyright (c) 2013-2016, Lawrence Livermore National Security, LLC.\n# Produced at the Lawrence Livermore National Laboratory.\n#\n# This file is part of Spack.\n# Created by Todd Gamblin, tgamblin@llnl.gov, All righ... | [
{
"content": "##############################################################################\n# Copyright (c) 2013-2016, Lawrence Livermore National Security, LLC.\n# Produced at the Lawrence Livermore National Laboratory.\n#\n# This file is part of Spack.\n# Created by Todd Gamblin, tgamblin@llnl.gov, All righ... | diff --git a/var/spack/repos/builtin/packages/llvm/llvm_gcc7.patch b/var/spack/repos/builtin/packages/llvm/llvm_gcc7.patch
new file mode 100644
index 00000000000000..e3bb8a14ad0851
--- /dev/null
+++ b/var/spack/repos/builtin/packages/llvm/llvm_gcc7.patch
@@ -0,0 +1,10 @@
+--- a/tools/lldb/include/lldb/Utility/TaskPool.... |
sanic-org__sanic-2666 | Deprecate __blueprintname__
This code no longer seems like it is necessary: https://github.com/sanic-org/sanic/blob/5d683c6ea4b615e80c51d80189436437b824cce6/sanic/blueprints.py#L309
Since you can get access to the name of the blueprint from the request object, the route object, and the blueprint object, I do not thi... | [
{
"content": "from __future__ import annotations\n\nimport asyncio\n\nfrom collections import defaultdict\nfrom copy import deepcopy\nfrom functools import wraps\nfrom inspect import isfunction\nfrom itertools import chain\nfrom types import SimpleNamespace\nfrom typing import (\n TYPE_CHECKING,\n Any,\n ... | [
{
"content": "from __future__ import annotations\n\nimport asyncio\n\nfrom collections import defaultdict\nfrom copy import deepcopy\nfrom functools import wraps\nfrom inspect import isfunction\nfrom itertools import chain\nfrom types import SimpleNamespace\nfrom typing import (\n TYPE_CHECKING,\n Any,\n ... | diff --git a/sanic/blueprints.py b/sanic/blueprints.py
index 5699d4bcb0..8050e1f615 100644
--- a/sanic/blueprints.py
+++ b/sanic/blueprints.py
@@ -304,9 +304,6 @@ def register(self, app, options):
# Routes
for future in self._future_routes:
- # attach the blueprint name to the handler so ... |
psf__black-3392 | black cli show loaded configuration.
**Is your feature request related to a problem? Please describe.**
Sometimes when dealing with multiple environment settings, IDEs, and pyproject.toml files etc. etc. is beneficial for a project team to have a confirmation about the actual applied black-settings ("line length") i... | [
{
"content": "import io\nimport json\nimport platform\nimport re\nimport sys\nimport tokenize\nimport traceback\nfrom contextlib import contextmanager\nfrom dataclasses import replace\nfrom datetime import datetime\nfrom enum import Enum\nfrom json.decoder import JSONDecodeError\nfrom pathlib import Path\nfrom ... | [
{
"content": "import io\nimport json\nimport platform\nimport re\nimport sys\nimport tokenize\nimport traceback\nfrom contextlib import contextmanager\nfrom dataclasses import replace\nfrom datetime import datetime\nfrom enum import Enum\nfrom json.decoder import JSONDecodeError\nfrom pathlib import Path\nfrom ... | diff --git a/CHANGES.md b/CHANGES.md
index c84feb04934..e781cbd523e 100644
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -36,6 +36,9 @@
<!-- Changes to Black's terminal output and error messages -->
+- Verbose logging now shows the values of `pyproject.toml` configuration variables
+ (#3392)
+
### _Blackd_
<!-- Change... |
pytorch__ignite-3219 | Add python 3.12 to CI
## 🚀 Feature
Add python 3.12 to CI: https://github.com/pytorch/ignite/blob/master/.github/workflows/unit-tests.yml
| [
{
"content": "from argparse import ArgumentParser\n\nimport torch\nimport torch.nn.functional as F\nfrom torch import nn\nfrom torch.optim import SGD\nfrom torch.utils.data import DataLoader\nfrom torchvision.datasets import MNIST\nfrom torchvision.transforms import Compose, Normalize, ToTensor\nfrom tqdm impor... | [
{
"content": "from argparse import ArgumentParser\n\nimport torch\nimport torch.nn.functional as F\nfrom torch import nn\nfrom torch.optim import SGD\nfrom torch.utils.data import DataLoader\nfrom torchvision.datasets import MNIST\nfrom torchvision.transforms import Compose, Normalize, ToTensor\nfrom tqdm impor... | diff --git a/.github/workflows/unit-tests.yml b/.github/workflows/unit-tests.yml
index 7673b79f792f..a4b697255699 100644
--- a/.github/workflows/unit-tests.yml
+++ b/.github/workflows/unit-tests.yml
@@ -40,7 +40,7 @@ jobs:
fail-fast: false
matrix:
os: [ubuntu-latest]
- python-version: [3.8... |
ansible__ansible-11146 | CLI become options are ultimately ignored
At this point I am not exactly sure where this is happening, however the become options provided on the CLI are ultimately ignored.
I have however determined that when `ConnectionInformation` is initiated, that the attributes are properly set via the 'set_options`method. Imme... | [
{
"content": "# (c) 2012-2014, Michael DeHaan <michael.dehaan@gmail.com>\n#\n# This file is part of Ansible\n#\n# Ansible is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the Licen... | [
{
"content": "# (c) 2012-2014, Michael DeHaan <michael.dehaan@gmail.com>\n#\n# This file is part of Ansible\n#\n# Ansible is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the Licen... | diff --git a/lib/ansible/playbook/become.py b/lib/ansible/playbook/become.py
index daa8c80ba943ac..fca28538585917 100644
--- a/lib/ansible/playbook/become.py
+++ b/lib/ansible/playbook/become.py
@@ -27,7 +27,7 @@
class Become:
# Privlege escalation
- _become = FieldAttribute(isa='bool', default=... |
huggingface__accelerate-370 | AttributeErrorAttributeError: : 'DeepSpeedEngineWrapper' object has no attribute '_zero3_consolidated_fp16_state_dict'
Accelerator with Deepspeed stage 3 when saving the model giving following error
Code I used:
import torch
import torch.nn.functional as F
from datasets import load_dataset
... | [
{
"content": "# Copyright 2021 The HuggingFace Team. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#... | [
{
"content": "# Copyright 2021 The HuggingFace Team. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#... | diff --git a/src/accelerate/accelerator.py b/src/accelerate/accelerator.py
index 6fd24c32191..b9780330a98 100644
--- a/src/accelerate/accelerator.py
+++ b/src/accelerate/accelerator.py
@@ -881,7 +881,7 @@ def get_state_dict(self, model):
is_zero_3 = self.state.deepspeed_plugin.zero_stage == 3
... |
fedora-infra__bodhi-3464 | Greenwave consumer should not process the compose results
Currently the greenwave consumer consumes all the messages from `topic=org.fedoraproject.prod.greenwave.decision.update` but some messages on this topic are related to compose results and not koji build.
The consumer should filter the messages based on the `s... | [
{
"content": "# Copyright © 2019 Red Hat, Inc.\n#\n# This file is part of Bodhi.\n#\n# This program is free software; you can redistribute it and/or\n# modify it under the terms of the GNU General Public License\n# as published by the Free Software Foundation; either version 2\n# of the License, or (at your opt... | [
{
"content": "# Copyright © 2019 Red Hat, Inc.\n#\n# This file is part of Bodhi.\n#\n# This program is free software; you can redistribute it and/or\n# modify it under the terms of the GNU General Public License\n# as published by the Free Software Foundation; either version 2\n# of the License, or (at your opt... | diff --git a/bodhi/server/consumers/greenwave.py b/bodhi/server/consumers/greenwave.py
index b072dcbd7a..51e0e3c034 100644
--- a/bodhi/server/consumers/greenwave.py
+++ b/bodhi/server/consumers/greenwave.py
@@ -56,6 +56,11 @@ def __call__(self, message: fedora_messaging.api.Message):
log.debug("Couldn't fi... |
ipython__ipython-14027 | Proposal: re-trigger autosuggestion with `right` key (and similar)
Once auto-suggestion was discarded it is not currently possible to re-trigger hinting in place (user needs to to type another character and press backspace, or to delete last character and type it again). This is a proposal to re-trigger the suggestions... | [
{
"content": "\"\"\"\nModule to define and register Terminal IPython shortcuts with\n:mod:`prompt_toolkit`\n\"\"\"\n\n# Copyright (c) IPython Development Team.\n# Distributed under the terms of the Modified BSD License.\n\nimport os\nimport signal\nimport sys\nimport warnings\nfrom dataclasses import dataclass\... | [
{
"content": "\"\"\"\nModule to define and register Terminal IPython shortcuts with\n:mod:`prompt_toolkit`\n\"\"\"\n\n# Copyright (c) IPython Development Team.\n# Distributed under the terms of the Modified BSD License.\n\nimport os\nimport signal\nimport sys\nimport warnings\nfrom dataclasses import dataclass\... | diff --git a/IPython/terminal/shortcuts/__init__.py b/IPython/terminal/shortcuts/__init__.py
index 8189326b4bc..3a39ac3e73b 100644
--- a/IPython/terminal/shortcuts/__init__.py
+++ b/IPython/terminal/shortcuts/__init__.py
@@ -277,10 +277,7 @@ def create_identifier(handler: Callable):
Binding(
auto_suggest.... |
flask-admin__flask-admin-1924 | Small typo in flask_admin.base
Should be provided rather than povided.
| [
{
"content": "import os.path as op\nimport warnings\n\nfrom functools import wraps\n\nfrom flask import Blueprint, current_app, render_template, abort, g, url_for\nfrom flask_admin import babel\nfrom flask_admin._compat import with_metaclass, as_unicode\nfrom flask_admin import helpers as h\n\n# For compatibili... | [
{
"content": "import os.path as op\nimport warnings\n\nfrom functools import wraps\n\nfrom flask import Blueprint, current_app, render_template, abort, g, url_for\nfrom flask_admin import babel\nfrom flask_admin._compat import with_metaclass, as_unicode\nfrom flask_admin import helpers as h\n\n# For compatibili... | diff --git a/flask_admin/base.py b/flask_admin/base.py
index a863ed32f..d2fad7bf8 100644
--- a/flask_admin/base.py
+++ b/flask_admin/base.py
@@ -257,7 +257,7 @@ def create_blueprint(self, admin):
self.static_folder = 'static'
self.static_url_path = '/static/admin'
- # If name ... |
Parsl__parsl-3153 | Bad string templating in deprecation message
**Describe the bug**
PR #3117 changed the name of the max_workers parameter, and introduced a deprecation message if someone still tries to use the old max_workers name.
That message prints out like this:
```
python3 -X dev
>>> import parsl as p
>>> p.HighThrough... | [
{
"content": "import typing\nfrom concurrent.futures import Future\nimport typeguard\nimport logging\nimport threading\nimport queue\nimport datetime\nimport pickle\nfrom dataclasses import dataclass\nfrom multiprocessing import Process, Queue\nfrom typing import Dict, Sequence\nfrom typing import List, Optiona... | [
{
"content": "import typing\nfrom concurrent.futures import Future\nimport typeguard\nimport logging\nimport threading\nimport queue\nimport datetime\nimport pickle\nfrom dataclasses import dataclass\nfrom multiprocessing import Process, Queue\nfrom typing import Dict, Sequence\nfrom typing import List, Optiona... | diff --git a/parsl/executors/high_throughput/executor.py b/parsl/executors/high_throughput/executor.py
index 3084a4165e..ee326c5f66 100644
--- a/parsl/executors/high_throughput/executor.py
+++ b/parsl/executors/high_throughput/executor.py
@@ -328,7 +328,7 @@ def __init__(self,
def _warn_deprecated(self, old: str, ... |
ultralytics__ultralytics-8600 | Possible typo in `select_highest_overlaps` function doc
https://github.com/ultralytics/ultralytics/blob/2d75f72598d5ce80786be61f140673a6d1dd7e57/ultralytics/utils/tal.py#L234
The doc states:
> ...the highest **IoI** will be selected
Shouldn't this be IOU?
| [
{
"content": "# Ultralytics YOLO 🚀, AGPL-3.0 license\n\nimport torch\nimport torch.nn as nn\n\nfrom .checks import check_version\nfrom .metrics import bbox_iou, probiou\nfrom .ops import xywhr2xyxyxyxy\n\nTORCH_1_10 = check_version(torch.__version__, \"1.10.0\")\n\n\nclass TaskAlignedAssigner(nn.Module):\n ... | [
{
"content": "# Ultralytics YOLO 🚀, AGPL-3.0 license\n\nimport torch\nimport torch.nn as nn\n\nfrom .checks import check_version\nfrom .metrics import bbox_iou, probiou\nfrom .ops import xywhr2xyxyxyxy\n\nTORCH_1_10 = check_version(torch.__version__, \"1.10.0\")\n\n\nclass TaskAlignedAssigner(nn.Module):\n ... | diff --git a/ultralytics/utils/tal.py b/ultralytics/utils/tal.py
index 80fee091de5..8e9c8b3a9f1 100644
--- a/ultralytics/utils/tal.py
+++ b/ultralytics/utils/tal.py
@@ -231,7 +231,7 @@ def select_candidates_in_gts(xy_centers, gt_bboxes, eps=1e-9):
@staticmethod
def select_highest_overlaps(mask_pos, overlaps, ... |
Textualize__textual-4280 | `Select` `OptionHighlighted` message leakage
The `Select` widget makes use of `OptionList`; when the user opens the `Select` to pick a value, `OptionHighlighted` messages "leak" out of the `Select`. This could result in unexpected messages for the developer who has an `OptionList` and a `Select` in their DOM and who do... | [
{
"content": "from __future__ import annotations\n\nfrom dataclasses import dataclass\nfrom typing import TYPE_CHECKING, Generic, Iterable, TypeVar, Union\n\nfrom rich.console import RenderableType\nfrom rich.text import Text\n\nfrom .. import events, on\nfrom ..containers import Horizontal, Vertical\nfrom ..cs... | [
{
"content": "from __future__ import annotations\n\nfrom dataclasses import dataclass\nfrom typing import TYPE_CHECKING, Generic, Iterable, TypeVar, Union\n\nfrom rich.console import RenderableType\nfrom rich.text import Text\n\nfrom .. import events, on\nfrom ..containers import Horizontal, Vertical\nfrom ..cs... | diff --git a/CHANGELOG.md b/CHANGELOG.md
index f300262eba..86899c5390 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -29,6 +29,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
- Rename `CollapsibleTitle.action_toggle` to `action_toggle_collapsible` to fix clash with `DOMNode.action_toggle` ... |
biolab__orange3-5964 | Distributions: changing bin width
<!--
Thanks for taking the time to report a bug!
If you're raising an issue about an add-on (i.e., installed via Options > Add-ons), raise an issue in the relevant add-on's issue tracker instead. See: https://github.com/biolab?q=orange3
To fix the bug, we need to be able to reprodu... | [
{
"content": "from functools import partial, reduce\nfrom itertools import count, groupby, repeat\nfrom xml.sax.saxutils import escape\n\nimport numpy as np\nfrom scipy.stats import norm, rayleigh, beta, gamma, pareto, expon\n\nfrom AnyQt.QtWidgets import QGraphicsRectItem\nfrom AnyQt.QtGui import QColor, QPen,... | [
{
"content": "from functools import partial, reduce\nfrom itertools import count, groupby, repeat\nfrom xml.sax.saxutils import escape\n\nimport numpy as np\nfrom scipy.stats import norm, rayleigh, beta, gamma, pareto, expon\n\nfrom AnyQt.QtWidgets import QGraphicsRectItem\nfrom AnyQt.QtGui import QColor, QPen,... | diff --git a/Orange/widgets/visualize/owdistributions.py b/Orange/widgets/visualize/owdistributions.py
index 492d11e153c..17e8e3f8254 100644
--- a/Orange/widgets/visualize/owdistributions.py
+++ b/Orange/widgets/visualize/owdistributions.py
@@ -903,6 +903,7 @@ def recompute_binnings(self):
self.controls.number... |
OpenMined__PySyft-7110 | Redundant white spaces in message on tensor creation
## Description
<img width="1018" alt="Screenshot 2022-11-24 at 3 46 54 PM" src="https://user-images.githubusercontent.com/6521018/203723732-ecae0e8c-d724-4860-ad71-6d1d8a6e2caf.png">
## How to Reproduce
Create any `sy.Tensor`
## Expected Behavior
A clear a... | [
{
"content": "# future\nfrom __future__ import annotations\n\n# stdlib\nimport secrets\nfrom typing import Any\nfrom typing import Callable\nfrom typing import Dict\nfrom typing import List\nfrom typing import Optional\nfrom typing import Tuple\nfrom typing import Union\n\n# third party\nimport numpy as np\nimp... | [
{
"content": "# future\nfrom __future__ import annotations\n\n# stdlib\nimport secrets\nfrom typing import Any\nfrom typing import Callable\nfrom typing import Dict\nfrom typing import List\nfrom typing import Optional\nfrom typing import Tuple\nfrom typing import Union\n\n# third party\nimport numpy as np\nimp... | diff --git a/packages/syft/src/syft/core/tensor/tensor.py b/packages/syft/src/syft/core/tensor/tensor.py
index 7e6a8dadbc5..29c76a0e701 100644
--- a/packages/syft/src/syft/core/tensor/tensor.py
+++ b/packages/syft/src/syft/core/tensor/tensor.py
@@ -517,8 +517,8 @@ def __init__(
self.public_dtype = public_dtype... |
mozilla__pontoon-2984 | Rename Firefox accounts in Mozilla accounts
There are a few references in the documentation, we should update them.
I think renaming internal references (e.g. fxa) goes beyond the scope, as most products will keep that for the time being.
We also need to make sure to update whatever package is responsible for the t... | [
{
"content": "\"\"\"Django settings for Pontoon.\"\"\"\nimport re\nimport os\nimport socket\n\nfrom django.utils.functional import lazy\n\nimport dj_database_url\n\n\n_dirname = os.path.dirname\n\nROOT = _dirname(_dirname(_dirname(os.path.abspath(__file__))))\n\n\ndef path(*args):\n return os.path.join(ROOT,... | [
{
"content": "\"\"\"Django settings for Pontoon.\"\"\"\nimport re\nimport os\nimport socket\n\nfrom django.utils.functional import lazy\n\nimport dj_database_url\n\n\n_dirname = os.path.dirname\n\nROOT = _dirname(_dirname(_dirname(os.path.abspath(__file__))))\n\n\ndef path(*args):\n return os.path.join(ROOT,... | diff --git a/docs/admin/deployment.rst b/docs/admin/deployment.rst
index e8cd731d2c..0c1f56164a 100644
--- a/docs/admin/deployment.rst
+++ b/docs/admin/deployment.rst
@@ -67,7 +67,7 @@ you create:
``AUTHENTICATION_METHOD``
The default value is `django`, which allows you to log in via accounts created using `mana... |
googleapis__google-cloud-python-7297 | BigQuery: KeyError inserting data with missing value into table with nullable field
I recently updated the google-cloud-bigquery python package and I am getting a **KeyError** when trying to insert a row with a **missing value** into a table with a **nullable field**.
In previous version (I tested it on version 1.5.0)... | [
{
"content": "# Copyright 2015 Google LLC\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicabl... | [
{
"content": "# Copyright 2015 Google LLC\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicabl... | diff --git a/bigquery/google/cloud/bigquery/_helpers.py b/bigquery/google/cloud/bigquery/_helpers.py
index 10753cfc998b..72e1fa276dd7 100644
--- a/bigquery/google/cloud/bigquery/_helpers.py
+++ b/bigquery/google/cloud/bigquery/_helpers.py
@@ -398,7 +398,10 @@ def _record_field_to_json(fields, row_value):
for sub... |
benoitc__gunicorn-2687 | WSGI sendfile does not respect file current offset
Hi,
on Linux, I need to stream a regular file from the disk starting from a specific offset.
According to Django doc, when you use a FileReponse you can seek your file to a specific offset and only the remaining part of the file will be streamed from this offset ... | [
{
"content": "# -*- coding: utf-8 -\n#\n# This file is part of gunicorn released under the MIT license.\n# See the NOTICE for more information.\n\nimport io\nimport logging\nimport os\nimport re\nimport sys\n\nfrom gunicorn.http.message import HEADER_RE\nfrom gunicorn.http.errors import InvalidHeader, InvalidHe... | [
{
"content": "# -*- coding: utf-8 -\n#\n# This file is part of gunicorn released under the MIT license.\n# See the NOTICE for more information.\n\nimport io\nimport logging\nimport os\nimport re\nimport sys\n\nfrom gunicorn.http.message import HEADER_RE\nfrom gunicorn.http.errors import InvalidHeader, InvalidHe... | diff --git a/gunicorn/http/wsgi.py b/gunicorn/http/wsgi.py
index 0fcff5a24..5d91706c1 100644
--- a/gunicorn/http/wsgi.py
+++ b/gunicorn/http/wsgi.py
@@ -372,7 +372,7 @@ def sendfile(self, respiter):
chunk_size = "%X\r\n" % nbytes
self.sock.sendall(chunk_size.encode('utf-8'))
if nbytes... |
borgbackup__borg-1459 | per archive total item count limit
the archive item (which has a list of "item metadata stream" chunks) is currently stored as a single object.
we limit size of repo objects to MAX_OBJ_SIZE (20MB).
note: we did only enforce the limit on get() - not on put().
each list entry takes ~40 bytes (32 sha256 id + 2 \* 4... | [
{
"content": "from binascii import hexlify\nfrom contextlib import contextmanager\nfrom datetime import datetime, timezone\nfrom getpass import getuser\nfrom itertools import groupby\nimport errno\n\nfrom .logger import create_logger\nlogger = create_logger()\nfrom .key import key_factory\nfrom .remote import c... | [
{
"content": "from binascii import hexlify\nfrom contextlib import contextmanager\nfrom datetime import datetime, timezone\nfrom getpass import getuser\nfrom itertools import groupby\nimport errno\n\nfrom .logger import create_logger\nlogger = create_logger()\nfrom .key import key_factory\nfrom .remote import c... | diff --git a/borg/archive.py b/borg/archive.py
index 653e2dd1c2..4498c72a3b 100644
--- a/borg/archive.py
+++ b/borg/archive.py
@@ -39,7 +39,7 @@
CHUNKER_PARAMS = (CHUNK_MIN_EXP, CHUNK_MAX_EXP, HASH_MASK_BITS, HASH_WINDOW_SIZE)
# chunker params for the items metadata stream, finer granularity
-ITEMS_CHUNKER_PARAMS =... |
jazzband__django-oauth-toolkit-1288 | Allow Authorization Code flow without a client_secret - Initial commit with Patch & testcases
Hello @n2ygk
Here's the PR
<!-- See https://django-oauth-toolkit.readthedocs.io/en/latest/contributing.html#pull-requests -->
<!-- If there's already an issue that this PR fixes, add that issue number below after 'Fixes... | [
{
"content": "import base64\nimport binascii\nimport http.client\nimport inspect\nimport json\nimport logging\nimport uuid\nfrom collections import OrderedDict\nfrom datetime import datetime, timedelta\nfrom urllib.parse import unquote_plus\n\nimport requests\nfrom django.conf import settings\nfrom django.contr... | [
{
"content": "import base64\nimport binascii\nimport http.client\nimport inspect\nimport json\nimport logging\nimport uuid\nfrom collections import OrderedDict\nfrom datetime import datetime, timedelta\nfrom urllib.parse import unquote_plus\n\nimport requests\nfrom django.conf import settings\nfrom django.contr... | diff --git a/AUTHORS b/AUTHORS
index 4afedcbfa..048085a11 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -55,6 +55,7 @@ Federico Dolce
Florian Demmer
Frederico Vieira
Gaël Utard
+Glauco Junior
Hasan Ramezani
Hiroki Kiyohara
Hossein Shakiba
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 216ea20f6..dfe72e91d 100644
--- a/CH... |
saulpw__visidata-1011 | vds: cannot export sheets containing a date column
**Small description**
It's not possible to save a sheet to a .vds file if said sheet contains a date column.
This results in the error below.
**Expected result**
It should just work(tm).
**Actual result with screenshot**
```stacktrace
Traceback (most r... | [
{
"content": "'Custom VisiData save format'\n\nimport json\nfrom visidata import *\n\nNL='\\n'\n\n@VisiData.api\ndef open_vds(vd, p):\n return VdsIndexSheet(p.name, source=p)\n\n\n@VisiData.api\ndef save_vds(vd, p, *sheets):\n 'Save in custom VisiData format, preserving columns and their attributes.'\n\n ... | [
{
"content": "'Custom VisiData save format'\n\nimport json\nfrom visidata import *\n\nNL='\\n'\n\n@VisiData.api\ndef open_vds(vd, p):\n return VdsIndexSheet(p.name, source=p)\n\n\n@VisiData.api\ndef save_vds(vd, p, *sheets):\n 'Save in custom VisiData format, preserving columns and their attributes.'\n\n ... | diff --git a/visidata/loaders/vds.py b/visidata/loaders/vds.py
index 589424e84..ae9178741 100644
--- a/visidata/loaders/vds.py
+++ b/visidata/loaders/vds.py
@@ -29,7 +29,7 @@ def save_vds(vd, p, *sheets):
with Progress(gerund='saving'):
for row in vs.iterdispvals(*vs.visibleCols, format=Fa... |
huggingface__transformers-4098 | run_language_modeling, RuntimeError: expected scalar type Half but found Float
# 🐛 Bug
## Information
CUDA: 10.1
Python 3.6.8 (default, Oct 7 2019, 12:59:55)
Installed transformers from source.
Trying to train **gpt2-medium**
Command Line:
```
export TRAIN_FILE=dataset/wiki.train.raw
export TEST_FILE=d... | [
{
"content": "# coding=utf-8\n# Copyright 2018 The OpenAI Team Authors and HuggingFace Inc. team.\n# Copyright (c) 2018, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You ma... | [
{
"content": "# coding=utf-8\n# Copyright 2018 The OpenAI Team Authors and HuggingFace Inc. team.\n# Copyright (c) 2018, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You ma... | diff --git a/notebooks/trainer/01_text_classification.ipynb b/notebooks/trainer/01_text_classification.ipynb
new file mode 100644
index 000000000000..39ca03a250d2
--- /dev/null
+++ b/notebooks/trainer/01_text_classification.ipynb
@@ -0,0 +1,726 @@
+{
+ "nbformat": 4,
+ "nbformat_minor": 0,
+ "metadata": {
+ "cola... |
facebookresearch__ParlAI-2649 | Throw error if bool is used in add_argument?
in our `ParlaiParser.add_argument`, if the type argument is a literal bool, we should either throw an error or maybe smartly switch to `'bool'` with a warning?
| [
{
"content": "#!/usr/bin/env python3\n\n# Copyright (c) Facebook, Inc. and its affiliates.\n# This source code is licensed under the MIT license found in the\n# LICENSE file in the root directory of this source tree.\n\"\"\"\nProvide an argument parser and default command line options for using ParlAI.\n\"\"\"\... | [
{
"content": "#!/usr/bin/env python3\n\n# Copyright (c) Facebook, Inc. and its affiliates.\n# This source code is licensed under the MIT license found in the\n# LICENSE file in the root directory of this source tree.\n\"\"\"\nProvide an argument parser and default command line options for using ParlAI.\n\"\"\"\... | diff --git a/parlai/core/params.py b/parlai/core/params.py
index 12d5bf7a67c..3740da152c7 100644
--- a/parlai/core/params.py
+++ b/parlai/core/params.py
@@ -1162,6 +1162,9 @@ def _handle_custom_options(self, kwargs):
hidden = kwargs.pop('hidden')
if hidden:
kwargs['help'] = ar... |
scoutapp__scout_apm_python-146 | PyYAML security alert
Our application is getting a GitHub security alert from PyYAML, and this is the only package that has it as a dependency in our graph. It looks like this package no longer uses that package, but it is still declared as a dependency.
If this assessment is correct, the dependency should be remove... | [
{
"content": "import os\nimport sys\nfrom glob import glob\n\nfrom setuptools import Extension, find_packages, setup\n\nlong_description = (\n \"Scout Application Performance Monitoring Agent - https://scoutapp.com\"\n)\nif os.path.exists(\"README.md\"):\n long_description = open(\"README.md\").read()\n\n... | [
{
"content": "import os\nimport sys\nfrom glob import glob\n\nfrom setuptools import Extension, find_packages, setup\n\nlong_description = (\n \"Scout Application Performance Monitoring Agent - https://scoutapp.com\"\n)\nif os.path.exists(\"README.md\"):\n long_description = open(\"README.md\").read()\n\n... | diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
index 7901ca54..501be101 100644
--- a/DEVELOPMENT.md
+++ b/DEVELOPMENT.md
@@ -89,7 +89,7 @@ for example 2.7 and 3.7. In that case, do the whole setup for each virtualenv.
Install all test dependencies:
- $ pip install bottle celery Django elasticsearch flask flask-sq... |
fidals__shopelectro-462 | dc-volumes.yml:27-28: Repair npm container reusing at...
The puzzle `449-27d8c19e` from #449 has to be resolved:
https://github.com/fidals/shopelectro/blob/f8ce85246c00411fcb21d025b0fb42abab81c7d5/docker/dc-volumes.yml#L27-L28
The puzzle was created by duker33 on 28-Jul-18.
Estimate: 60 minutes,
If you have a... | [
{
"content": "import glob\nimport logging\nimport math\nimport os\nimport shutil\nimport subprocess\nimport time\nfrom contextlib import contextmanager\nfrom itertools import chain\nfrom typing import Iterator, Dict\nfrom uuid import UUID\nfrom xml.etree import ElementTree\n\nimport requests\nfrom django.conf i... | [
{
"content": "import glob\nimport logging\nimport math\nimport os\nimport shutil\nimport subprocess\nimport time\nfrom contextlib import contextmanager\nfrom itertools import chain\nfrom typing import Iterator, Dict\nfrom uuid import UUID\nfrom xml.etree import ElementTree\n\nimport requests\nfrom django.conf i... | diff --git a/.drone.yml b/.drone.yml
index 389a46eb..de4ee2c8 100644
--- a/.drone.yml
+++ b/.drone.yml
@@ -19,39 +19,32 @@ pipeline:
when:
event: [push, pull_request]
- npm: # old `npm install`
- image: node:slim
+ nodejs-build: # with `npm install` inside
+ image: docker/compose:1.22.0
env... |
saleor__saleor-3059 | [Backend] [Cosmetics] CELERY_TASK_ALWAYS_EAGER strange set value
In settings present strange code:
`CELERY_TASK_ALWAYS_EAGER = False if CELERY_BROKER_URL else True`
can easy rewrite to:
`CELERY_TASK_ALWAYS_EAGER = not CELERY_BROKER_URL`
| [
{
"content": "import ast\nimport os.path\n\nimport dj_database_url\nimport dj_email_url\nimport django_cache_url\nfrom django.contrib.messages import constants as messages\nfrom django.utils.translation import gettext_lazy as _, pgettext_lazy\nfrom django_prices.templatetags.prices_i18n import get_currency_frac... | [
{
"content": "import ast\nimport os.path\n\nimport dj_database_url\nimport dj_email_url\nimport django_cache_url\nfrom django.contrib.messages import constants as messages\nfrom django.utils.translation import gettext_lazy as _, pgettext_lazy\nfrom django_prices.templatetags.prices_i18n import get_currency_frac... | diff --git a/saleor/settings.py b/saleor/settings.py
index 834500eb05e..319799bb02d 100644
--- a/saleor/settings.py
+++ b/saleor/settings.py
@@ -480,7 +480,7 @@ def get_host():
# CELERY SETTINGS
CELERY_BROKER_URL = os.environ.get(
'CELERY_BROKER_URL', os.environ.get('CLOUDAMQP_URL')) or ''
-CELERY_TASK_ALWAYS_EA... |
Gallopsled__pwntools-1057 | DynELF._find_linkmap bug
https://github.com/Gallopsled/pwntools/blob/b53e58a840c890340fa755a2229c3ff774c5f81e/pwnlib/dynelf.py#L450
Bug after commit bb25140807a4d
Must be:
```python
w.status("r_debug.linkmap %#x" % linkmap)
```
| [
{
"content": "\"\"\"\nResolve symbols in loaded, dynamically-linked ELF binaries.\nGiven a function which can leak data at an arbitrary address,\nany symbol in any loaded library can be resolved.\n\nExample\n^^^^^^^^\n\n::\n\n # Assume a process or remote connection\n p = process('./pwnme')\n\n # Decla... | [
{
"content": "\"\"\"\nResolve symbols in loaded, dynamically-linked ELF binaries.\nGiven a function which can leak data at an arbitrary address,\nany symbol in any loaded library can be resolved.\n\nExample\n^^^^^^^^\n\n::\n\n # Assume a process or remote connection\n p = process('./pwnme')\n\n # Decla... | diff --git a/pwnlib/dynelf.py b/pwnlib/dynelf.py
index b3f502647..83714496e 100644
--- a/pwnlib/dynelf.py
+++ b/pwnlib/dynelf.py
@@ -447,7 +447,7 @@ def _find_linkmap(self, pltgot=None, debug=None):
if debug:
w.status("r_debug.linkmap")
linkmap = self.leak.field(debug, r_d... |
pyodide__pyodide-3074 | Export version from pyodide JS module
## 🚀 Feature
In `pyodide.d.ts` I see `declare let version: string;` but it's not exported. It'd be great if it was exported so that I can do this:
```ts
import {version} from "pyodide";
```
### Motivation
I have [some code](https://github.com/alexmojaki/pyodide-worke... | [
{
"content": "#!/usr/bin/env python3\n\nimport argparse\nimport difflib\nimport functools\nimport itertools\nimport pathlib\nimport re\nfrom ast import Str\nfrom collections import namedtuple\nfrom collections.abc import Callable\n\nCORE_VERSION_REGEX = r\"(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)\"\n... | [
{
"content": "#!/usr/bin/env python3\n\nimport argparse\nimport difflib\nimport functools\nimport itertools\nimport pathlib\nimport re\nfrom ast import Str\nfrom collections import namedtuple\nfrom collections.abc import Callable\n\nCORE_VERSION_REGEX = r\"(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)\"\n... | diff --git a/docs/project/changelog.md b/docs/project/changelog.md
index 22d5ba5b90d..effae95b349 100644
--- a/docs/project/changelog.md
+++ b/docs/project/changelog.md
@@ -67,6 +67,10 @@ substitutions:
{pr}`3015` included in 0.21.2) and if there is a variable in top level scope
called `__dirname` we use that for... |
google__personfinder-457 | dmp_csv cron job should not be run for deactivated repos
| [
{
"content": "#!/usr/bin/python2.7\n# Copyright 2010 Google Inc.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unle... | [
{
"content": "#!/usr/bin/python2.7\n# Copyright 2010 Google Inc.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unle... | diff --git a/app/tasks.py b/app/tasks.py
index 2bb2a6c2ca..72f537c07f 100644
--- a/app/tasks.py
+++ b/app/tasks.py
@@ -522,7 +522,7 @@ def get(self):
# just a convenient place to call it.
self.storage.set_objects_lifetime(lifetime_days=2)
- for repo in model.Repo.list():
+ ... |
mozilla__bugbug-3721 | MEI: Have a measure of incoming/closed defects vs. existing open
Based on [this doc](https://docs.google.com/document/d/1nWP3DtSWneYT8ietXuBa6uPszMKMgICXf3b2dwMVXYk/edit#heading=h.9joq5dbpnw41).
```
Incoming(TimeInterval) := NumOpenedDefects(TimeInterval) / NumOpenDefects(Start(TimeInterval))
Closed(TimeInterval) ... | [
{
"content": "# -*- coding: utf-8 -*-\n# This Source Code Form is subject to the terms of the Mozilla Public\n# License, v. 2.0. If a copy of the MPL was not distributed with this file,\n# You can obtain one at http://mozilla.org/MPL/2.0/.\n\nimport collections\nimport csv\nimport math\nimport re\nfrom datetime... | [
{
"content": "# -*- coding: utf-8 -*-\n# This Source Code Form is subject to the terms of the Mozilla Public\n# License, v. 2.0. If a copy of the MPL was not distributed with this file,\n# You can obtain one at http://mozilla.org/MPL/2.0/.\n\nimport collections\nimport csv\nimport math\nimport re\nfrom datetime... | diff --git a/bugbug/bugzilla.py b/bugbug/bugzilla.py
index a2bb9e271f..41ba51d1ea 100644
--- a/bugbug/bugzilla.py
+++ b/bugbug/bugzilla.py
@@ -557,8 +557,14 @@ def calculate_maintenance_effectiveness_indicator(
else:
wbdtime = math.inf
+ estimated_start_open_defects = open_defects + closed_defects - ... |
pyqtgraph__pyqtgraph-1168 | Hiding nested group parameters
Hiding groups nested in groups does not work after the widget is shown. Look at this minimal example:
```
import os
import pyqtgraph.parametertree.ParameterTree as ParameterTree
from pyqtgraph.parametertree import Parameter, parameterTypes
from pyqtgraph.Qt import QtCore, QtGui
... | [
{
"content": "from ..Qt import QtCore, QtGui\nfrom ..python2_3 import asUnicode\nfrom .Parameter import Parameter, registerParameterType\nfrom .ParameterItem import ParameterItem\nfrom ..widgets.SpinBox import SpinBox\nfrom ..widgets.ColorButton import ColorButton\nfrom ..colormap import ColorMap\n#from ..widge... | [
{
"content": "from ..Qt import QtCore, QtGui\nfrom ..python2_3 import asUnicode\nfrom .Parameter import Parameter, registerParameterType\nfrom .ParameterItem import ParameterItem\nfrom ..widgets.SpinBox import SpinBox\nfrom ..widgets.ColorButton import ColorButton\nfrom ..colormap import ColorMap\n#from ..widge... | diff --git a/pyqtgraph/parametertree/parameterTypes.py b/pyqtgraph/parametertree/parameterTypes.py
index b728fb8edb..a8e3781dc8 100644
--- a/pyqtgraph/parametertree/parameterTypes.py
+++ b/pyqtgraph/parametertree/parameterTypes.py
@@ -437,8 +437,10 @@ def addChild(self, child): ## make sure added childs are actually i... |
ckan__ckan-5937 | sqlalchemy setting "pool_pre_ping"
**CKAN version**
Introduced in commit https://github.com/ckan/ckan/commit/ae9eb1360028a77b35506716eed2768349827806 which is related at least to 2.9.0, 2.9.1, 2.9.2.
**Describe the bug**
This is the ckan code:
```python
# Enable pessimistic disconnect handling (added in... | [
{
"content": "# encoding: utf-8\n\n'''CKAN environment configuration'''\nimport os\nimport logging\nimport warnings\nimport pytz\n\nimport six\nimport sqlalchemy\n\nfrom six.moves.urllib.parse import urlparse\n\nimport ckan.model as model\nimport ckan.plugins as p\nimport ckan.lib.plugins as lib_plugins\nimport... | [
{
"content": "# encoding: utf-8\n\n'''CKAN environment configuration'''\nimport os\nimport logging\nimport warnings\nimport pytz\n\nimport six\nimport sqlalchemy\n\nfrom six.moves.urllib.parse import urlparse\n\nimport ckan.model as model\nimport ckan.plugins as p\nimport ckan.lib.plugins as lib_plugins\nimport... | diff --git a/ckan/config/environment.py b/ckan/config/environment.py
index a6be2cc0f91..6af279e5ffe 100644
--- a/ckan/config/environment.py
+++ b/ckan/config/environment.py
@@ -286,7 +286,7 @@ def update_config():
# Enable pessimistic disconnect handling (added in SQLAlchemy 1.2)
# to eliminate database err... |
pallets__werkzeug-2103 | LocalStack class has strange behavior under asyncio
The new `LocalStack` implementation based on the contextvars module has a strange behavior when used under asyncio. The problem appears to be related to the inheritance of contexts that occur between a parent and children async tasks, combined with the fact that the s... | [
{
"content": "import copy\nimport math\nimport operator\nimport sys\nimport typing as t\nimport warnings\nfrom functools import partial\nfrom functools import update_wrapper\n\nfrom .wsgi import ClosingIterator\n\nif t.TYPE_CHECKING:\n from wsgiref.types import WSGIApplication\n\ntry:\n from greenlet impo... | [
{
"content": "import copy\nimport math\nimport operator\nimport sys\nimport typing as t\nimport warnings\nfrom functools import partial\nfrom functools import update_wrapper\n\nfrom .wsgi import ClosingIterator\n\nif t.TYPE_CHECKING:\n from wsgiref.types import WSGIApplication\n\ntry:\n from greenlet impo... | diff --git a/src/werkzeug/local.py b/src/werkzeug/local.py
index 9e9fdd615..e1773a838 100644
--- a/src/werkzeug/local.py
+++ b/src/werkzeug/local.py
@@ -219,10 +219,9 @@ def _lookup():
def push(self, obj: t.Any) -> t.List[t.Any]:
"""Pushes a new item to the stack"""
- rv = getattr(self._local, "s... |
zulip__zulip-20148 | Clear `prefers_web_public_view` cookie when logging in or registering an account
In #19902, we added functionality to remember who had accessed Zulip as a spectator and immediately take them to the spectator experience. We probably want to clear the `prefers_web_public_view` cookie when logging in via `do_login` or re... | [
{
"content": "import logging\nimport secrets\nfrom typing import List, Optional, Tuple\n\nfrom django.conf import settings\nfrom django.http import HttpRequest, HttpResponse\nfrom django.shortcuts import redirect, render\nfrom django.utils.cache import patch_cache_control\n\nfrom zerver.context_processors impor... | [
{
"content": "import logging\nimport secrets\nfrom typing import List, Optional, Tuple\n\nfrom django.conf import settings\nfrom django.http import HttpRequest, HttpResponse\nfrom django.shortcuts import redirect, render\nfrom django.utils.cache import patch_cache_control\n\nfrom zerver.context_processors impor... | diff --git a/zerver/tests/test_home.py b/zerver/tests/test_home.py
index 7b74a8ba7f38f..c346468ff3799 100644
--- a/zerver/tests/test_home.py
+++ b/zerver/tests/test_home.py
@@ -330,6 +330,12 @@ def test_logged_out_home(self) -> None:
]
expected_keys = [i for i in self.expected_page_params_keys if i no... |
rasterio__rasterio-618 | YCbCr JPEG-in-TIFF breaks rio-info
One creates a YCbCr JPEG-in-TIFF with GDAL using `photometric=YCbCr` and `compress=JPEG` options. But reading the TIFFs tags to get the compression method returns "YCbCr JPEG", a value that's not in `rasterio.enums.Compression`.
Reference: http://www.gdal.org/frmt_gtiff.html
Solutio... | [
{
"content": "\nfrom enum import Enum, IntEnum\n\n\nclass ColorInterp(IntEnum):\n undefined=0\n grey=1\n gray=1\n palette=2\n red=3\n green=4\n blue=5\n alpha=6\n hue=7\n saturation=8\n lightness=9\n cyan=10\n magenta=11\n yellow=12\n black=13\n\n\nclass Resampling(E... | [
{
"content": "\nfrom enum import Enum, IntEnum\n\n\nclass ColorInterp(IntEnum):\n undefined=0\n grey=1\n gray=1\n palette=2\n red=3\n green=4\n blue=5\n alpha=6\n hue=7\n saturation=8\n lightness=9\n cyan=10\n magenta=11\n yellow=12\n black=13\n Y=14\n Cb=15\n ... | diff --git a/README.rst b/README.rst
index 8cc6fc760..eaac96cf0 100644
--- a/README.rst
+++ b/README.rst
@@ -7,8 +7,8 @@ Rasterio reads and writes geospatial raster datasets.
.. image:: https://travis-ci.org/mapbox/rasterio.png?branch=master
:target: https://travis-ci.org/mapbox/rasterio
-.. image:: https://cove... |
internetarchive__openlibrary-9322 | add a failing author name test
<!-- What issue does this PR close? -->
Demonstrates a bug in #9003
<!-- What does this PR achieve? [feature|hotfix|fix|refactor] -->
`Drini` -> `ini`
**Expected:**
`Drini` -> `Drini`
😉
### Technical
<!-- What should be noted about the implementation? -->
### Testin... | [
{
"content": "from typing import TYPE_CHECKING, Any, Final\nimport web\nfrom openlibrary.catalog.utils import flip_name, author_dates_match, key_int\nfrom openlibrary.core.helpers import extract_year\n\n\nif TYPE_CHECKING:\n from openlibrary.plugins.upstream.models import Author\n\n\n# Sort by descending len... | [
{
"content": "from typing import TYPE_CHECKING, Any, Final\nimport web\nfrom openlibrary.catalog.utils import flip_name, author_dates_match, key_int\nfrom openlibrary.core.helpers import extract_year\n\n\nif TYPE_CHECKING:\n from openlibrary.plugins.upstream.models import Author\n\n\n# Sort by descending len... | diff --git a/openlibrary/catalog/add_book/load_book.py b/openlibrary/catalog/add_book/load_book.py
index e47cb6e7792..958dcafb952 100644
--- a/openlibrary/catalog/add_book/load_book.py
+++ b/openlibrary/catalog/add_book/load_book.py
@@ -236,11 +236,11 @@ def remove_author_honorifics(name: str) -> str:
(
... |
readthedocs__readthedocs.org-5034 | Setting default branch uses Version.slug instead of identifier
## Details
* Read the Docs project URL: https://readthedocs.org/projects/test-builds/
* Build URL (if applicable): https://readthedocs.org/projects/test-builds/builds/8319150/
* Read the Docs username (if applicable): humitos
## Expected Result
B... | [
{
"content": "# -*- coding: utf-8 -*-\n\"\"\"Project forms.\"\"\"\n\nfrom __future__ import (\n absolute_import,\n division,\n print_function,\n unicode_literals,\n)\n\nfrom random import choice\n\nfrom builtins import object\nfrom django import forms\nfrom django.conf import settings\nfrom django.c... | [
{
"content": "# -*- coding: utf-8 -*-\n\"\"\"Project forms.\"\"\"\n\nfrom __future__ import (\n absolute_import,\n division,\n print_function,\n unicode_literals,\n)\n\nfrom random import choice\n\nfrom builtins import object\nfrom django import forms\nfrom django.conf import settings\nfrom django.c... | diff --git a/readthedocs/projects/forms.py b/readthedocs/projects/forms.py
index e8bff7505f9..c21333e76d5 100644
--- a/readthedocs/projects/forms.py
+++ b/readthedocs/projects/forms.py
@@ -222,7 +222,7 @@ def __init__(self, *args, **kwargs):
default_choice = (None, '-' * 9)
all_versions = self.insta... |
cloud-custodian__cloud-custodian-4868 | c7n-org not respecting policy org region restrictions
Pushing two policy at org level to be deployed in separate regions. This is what I am doing:
c7n-org run -c AWS/base/provisioning/NonProd/accounts.yml -r all -s /tmp/out -u AWS/policies/nonprod/01-common/asg-off-hours.yml
Policies look like this:
policies:
... | [
{
"content": "# Copyright 2017 Capital One Services, LLC\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required b... | [
{
"content": "# Copyright 2017 Capital One Services, LLC\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required b... | diff --git a/tools/c7n_org/c7n_org/cli.py b/tools/c7n_org/c7n_org/cli.py
index 2541de52e25..25f7ccccaca 100644
--- a/tools/c7n_org/c7n_org/cli.py
+++ b/tools/c7n_org/c7n_org/cli.py
@@ -538,6 +538,9 @@ def run_account(account, region, policies_config, output_path,
p.expand_variables(p.get_variables(account.... |
CiviWiki__OpenCiviWiki-521 | Can't Publish New Thread
I attempted to make a new thread on Civiwiki.org. I was able to create the content, but when I hit publish it throws a server error.
| [
{
"content": "import json\nimport PIL\nimport urllib\nimport uuid\n\nfrom notifications.signals import notify\n\n# django packages\nfrom django.db.models.query import F\nfrom django.contrib.auth.models import User\nfrom django.http import (\n JsonResponse,\n HttpResponse,\n HttpResponseServerError,\n ... | [
{
"content": "import json\nimport PIL\nimport urllib\nimport uuid\n\nfrom notifications.signals import notify\n\n# django packages\nfrom django.db.models.query import F\nfrom django.contrib.auth.models import User\nfrom django.http import (\n JsonResponse,\n HttpResponse,\n HttpResponseServerError,\n ... | diff --git a/project/api/write.py b/project/api/write.py
index 2145dbb5a..795700ed9 100644
--- a/project/api/write.py
+++ b/project/api/write.py
@@ -263,7 +263,8 @@ def editThread(request):
if not thread_id:
return HttpResponseBadRequest(reason="Invalid Thread Reference")
- if not is_draft:
+ # fo... |
pytorch__vision-2159 | NMS returns different results on CPU & CUDA
## 🐛 Bug
Hi, I noticed that results of `torchvision.ops.nms` in CPU and CUDA have different value
## To Reproduce
Steps to reproduce the behavior:
1. `docker run --runtime=nvidia -it pytorch/pytorch:1.5-cuda10.1-cudnn7-devel bash`
2. run this script :
```
im... | [
{
"content": "import torch\nfrom torch.jit.annotations import Tuple\nfrom torch import Tensor\nimport torchvision\n\n\ndef nms(boxes, scores, iou_threshold):\n # type: (Tensor, Tensor, float)\n \"\"\"\n Performs non-maximum suppression (NMS) on the boxes according\n to their intersection-over-union ... | [
{
"content": "import torch\nfrom torch.jit.annotations import Tuple\nfrom torch import Tensor\nimport torchvision\n\n\ndef nms(boxes, scores, iou_threshold):\n # type: (Tensor, Tensor, float)\n \"\"\"\n Performs non-maximum suppression (NMS) on the boxes according\n to their intersection-over-union ... | diff --git a/torchvision/ops/boxes.py b/torchvision/ops/boxes.py
index 4bbc9c1fdad..686d6233354 100644
--- a/torchvision/ops/boxes.py
+++ b/torchvision/ops/boxes.py
@@ -14,6 +14,11 @@ def nms(boxes, scores, iou_threshold):
IoU greater than iou_threshold with another (higher scoring)
box.
+ If multiple bo... |
lutris__lutris-3941 | MicroM8 runner does not work
I installed the MicroM8 runner and tried to manually configure an Apple II game by selecting the runner and pointing it to an Apple II floppy. Debug output shows a “No game found in library” error, but no indication of specifically what file it is looking for that it can’t find.
```
~$ ... | [
{
"content": "\"\"\"Base module for runners\"\"\"\nimport os\nfrom gettext import gettext as _\n\nfrom gi.repository import Gtk\n\nfrom lutris import runtime, settings\nfrom lutris.command import MonitoredCommand\nfrom lutris.config import LutrisConfig\nfrom lutris.database.games import get_game_by_field\nfrom ... | [
{
"content": "\"\"\"Base module for runners\"\"\"\nimport os\nfrom gettext import gettext as _\n\nfrom gi.repository import Gtk\n\nfrom lutris import runtime, settings\nfrom lutris.command import MonitoredCommand\nfrom lutris.config import LutrisConfig\nfrom lutris.database.games import get_game_by_field\nfrom ... | diff --git a/lutris/runners/runner.py b/lutris/runners/runner.py
index 693433deb3..b855fb526c 100644
--- a/lutris/runners/runner.py
+++ b/lutris/runners/runner.py
@@ -411,6 +411,11 @@ def extract(self, archive=None, dest=None, merge_single=None, callback=None):
from lutris.util.wine.wine import get_wine_ve... |
wemake-services__wemake-python-styleguide-884 | Wrong and correct examples of nested annotations mixed up in docs for Union type
# Bug report
<!--
Hi, thanks for submitting a bug. We appreciate that.
But, we will need some information about what's wrong to help you.
-->
## What's wrong
From ``NestedAnnotationsViolation`` class docstring:
```
Example:... | [
{
"content": "# -*- coding: utf-8 -*-\n\n\"\"\"\nThese checks help to prevent incorrect usage of Python 3 typing annotations.\n\nWhile they maybe of a great help in writing clear\nand concise code, they still can be abused.\n\nOnce again, these rules are highly subjective. But, we love them.\n\n.. currentmodule... | [
{
"content": "# -*- coding: utf-8 -*-\n\n\"\"\"\nThese checks help to prevent incorrect usage of Python 3 typing annotations.\n\nWhile they maybe of a great help in writing clear\nand concise code, they still can be abused.\n\nOnce again, these rules are highly subjective. But, we love them.\n\n.. currentmodule... | diff --git a/wemake_python_styleguide/violations/annotations.py b/wemake_python_styleguide/violations/annotations.py
index 46c29c750..29a845f01 100644
--- a/wemake_python_styleguide/violations/annotations.py
+++ b/wemake_python_styleguide/violations/annotations.py
@@ -79,11 +79,11 @@ class NestedAnnotationsViolation(AS... |
biopython__biopython-4468 | HMMER Parser doesn't work with Windows
The regex defined here:
https://github.com/krdav/ANARCI_KD_copy/blob/5c4a17f6f0bc530b3e5154667e285eea1195a485/lib/python/anarci/Bio/SearchIO/HmmerIO/hmmer3_text.py#L24
Is unable to find any matches in this output banner from hmmscan:
'# C:\\msys64\\scr\\jou\\builds\\22-2\... | [
{
"content": "# Copyright 2012 by Wibowo Arindrarto. All rights reserved.\n# This file is part of the Biopython distribution and governed by your\n# choice of the \"Biopython License Agreement\" or the \"BSD 3-Clause License\".\n# Please see the LICENSE file that should have been included as part of this\n# pa... | [
{
"content": "# Copyright 2012 by Wibowo Arindrarto. All rights reserved.\n# This file is part of the Biopython distribution and governed by your\n# choice of the \"Biopython License Agreement\" or the \"BSD 3-Clause License\".\n# Please see the LICENSE file that should have been included as part of this\n# pa... | diff --git a/Bio/SearchIO/HmmerIO/hmmer3_text.py b/Bio/SearchIO/HmmerIO/hmmer3_text.py
index d564bed58b8..3cb88601f92 100644
--- a/Bio/SearchIO/HmmerIO/hmmer3_text.py
+++ b/Bio/SearchIO/HmmerIO/hmmer3_text.py
@@ -17,7 +17,7 @@
# precompile regex patterns for faster processing
# regex for program name capture
-_RE_P... |
openshift__openshift-ansible-2358 | enable service-serving-cert-signer by default
Commands like `oadm router` want to take advantage of the service-serving-cert-signing controller. This requires that
``` yaml
controllerConfig:
serviceServingCert:
signer:
certFile: service-signer.crt
keyFile: service-signer.key
```
in the master-conf... | [
{
"content": "#!/usr/bin/python\n# -*- coding: utf-8 -*-\n# vim: expandtab:tabstop=4:shiftwidth=4\n'''\nCustom filters for use in openshift-master\n'''\nimport copy\nimport sys\nimport yaml\n\nfrom ansible import errors\nfrom distutils.version import LooseVersion\n\n# pylint: disable=no-name-in-module,import-er... | [
{
"content": "#!/usr/bin/python\n# -*- coding: utf-8 -*-\n# vim: expandtab:tabstop=4:shiftwidth=4\n'''\nCustom filters for use in openshift-master\n'''\nimport copy\nimport sys\nimport yaml\n\nfrom ansible import errors\nfrom distutils.version import LooseVersion\n\n# pylint: disable=no-name-in-module,import-er... | diff --git a/filter_plugins/openshift_master.py b/filter_plugins/openshift_master.py
index d196d6c1f88..ee6a62ba55e 100644
--- a/filter_plugins/openshift_master.py
+++ b/filter_plugins/openshift_master.py
@@ -550,6 +550,9 @@ def certificates_to_synchronize(hostvars, include_keys=True):
certs += ['openshift... |
PennyLaneAI__pennylane-1223 | Repeated applications of the torch interface result in an error when using templates
Consider the following code:
```python
import torch
import pennylane as qml
n_qubits = 2
dev = qml.device("default.qubit", wires=n_qubits)
def circuit(weights):
qml.templates.BasicEntanglerLayers(weights, wires=range(n... | [
{
"content": "# Copyright 2018-2021 Xanadu Quantum Technologies Inc.\n\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n\n# http://www.apache.org/licenses/LICENSE-2.0\n\n# Unle... | [
{
"content": "# Copyright 2018-2021 Xanadu Quantum Technologies Inc.\n\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n\n# http://www.apache.org/licenses/LICENSE-2.0\n\n# Unle... | diff --git a/.github/CHANGELOG.md b/.github/CHANGELOG.md
index 456e825913d..adfa21c146c 100644
--- a/.github/CHANGELOG.md
+++ b/.github/CHANGELOG.md
@@ -773,6 +773,9 @@
second-order observable.
[(#1197)](https://github.com/PennyLaneAI/pennylane/pull/1197)
+* Fixes a bug where repeated Torch interface applicatio... |
certbot__certbot-5192 | We shouldn't be adding a commented out renewal block during the same run as adding an uncommented one when deploying certs with multiple domains
| [
{
"content": "\"\"\"Nginx Configuration\"\"\"\nimport logging\nimport os\nimport re\nimport socket\nimport subprocess\nimport tempfile\nimport time\n\nimport OpenSSL\nimport six\nimport zope.interface\n\nfrom acme import challenges\nfrom acme import crypto_util as acme_crypto_util\n\nfrom certbot import constan... | [
{
"content": "\"\"\"Nginx Configuration\"\"\"\nimport logging\nimport os\nimport re\nimport socket\nimport subprocess\nimport tempfile\nimport time\n\nimport OpenSSL\nimport six\nimport zope.interface\n\nfrom acme import challenges\nfrom acme import crypto_util as acme_crypto_util\n\nfrom certbot import constan... | diff --git a/certbot-nginx/certbot_nginx/configurator.py b/certbot-nginx/certbot_nginx/configurator.py
index ba6c565c0fb..4857942a1a6 100644
--- a/certbot-nginx/certbot_nginx/configurator.py
+++ b/certbot-nginx/certbot_nginx/configurator.py
@@ -30,7 +30,7 @@
logger = logging.getLogger(__name__)
REDIRECT_BLOCK = [[
... |
pytorch__ignite-1978 | Improve Accumulation metric on tensors to work with Apex
## 🚀 Feature Request
It seems that the ignite is not compatible with apex. When i am trying to use the (automatic mixed precision)amp from the Apex for the GPU Acceleration, I have encountered the following error. Look around the Ignite source code and I find t... | [
{
"content": "import numbers\nfrom typing import Callable, Tuple, Union\n\nimport torch\n\nfrom ignite.exceptions import NotComputableError\nfrom ignite.metrics.metric import Metric, reinit__is_reduced, sync_all_reduce\n\n__all__ = [\"VariableAccumulation\", \"GeometricAverage\", \"Average\"]\n\n\nclass Variabl... | [
{
"content": "import numbers\nfrom typing import Callable, Tuple, Union\n\nimport torch\n\nfrom ignite.exceptions import NotComputableError\nfrom ignite.metrics.metric import Metric, reinit__is_reduced, sync_all_reduce\n\n__all__ = [\"VariableAccumulation\", \"GeometricAverage\", \"Average\"]\n\n\nclass Variabl... | diff --git a/ignite/metrics/accumulation.py b/ignite/metrics/accumulation.py
index 8b00a92410d1..c9e85aa464c2 100644
--- a/ignite/metrics/accumulation.py
+++ b/ignite/metrics/accumulation.py
@@ -67,8 +67,8 @@ def update(self, output: Union[float, torch.Tensor]) -> None:
if isinstance(output, torch.Tensor):
... |
mindsdb__mindsdb-855 | Add update argument to executable function
Add optional boolean argument update to [make_executable](https://github.com/mindsdb/mindsdb/blob/staging/mindsdb/utilities/wizards.py#L230)() function, so if it's set to true then the executable should run
```
py -m pip install mindsdb --upgrade
```
before
```
py -... | [
{
"content": "import os\nimport json\nfrom datetime import datetime, timedelta\n\n\ndef _in(ask, default, use_default):\n if use_default:\n return default\n\n user_input = input(f'{ask} (Default: {default})')\n if user_input is None or user_input == '':\n user_input = default\n\n if ty... | [
{
"content": "import os\nimport json\nfrom datetime import datetime, timedelta\n\n\ndef _in(ask, default, use_default):\n if use_default:\n return default\n\n user_input = input(f'{ask} (Default: {default})')\n if user_input is None or user_input == '':\n user_input = default\n\n if ty... | diff --git a/mindsdb/utilities/wizards.py b/mindsdb/utilities/wizards.py
index 7a8d653634d..fc4225b3271 100644
--- a/mindsdb/utilities/wizards.py
+++ b/mindsdb/utilities/wizards.py
@@ -227,8 +227,14 @@ def daemon_creator(python_path, config_path=None):
return daemon_path
-def make_executable(python_path, exec_... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.